PrintGetPrinterName Method (GdViewer)

In This Topic

Returns the name of the printer according to the index you have specified.

You can use the PrintGetPrintersCount method to determine the number of all available printers. The printer index is simply an integer value from 1 to PrintGetPrintersCount.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function PrintGetPrinterName( _
   ByVal PrinterNo As Integer _
) As String

public string PrintGetPrinterName( 
   int PrinterNo
)

public function PrintGetPrinterName( 
    PrinterNo: Integer
): String;

public function PrintGetPrinterName( 
   PrinterNo : int
) : String;

public: string* PrintGetPrinterName( 
   int PrinterNo
)

public:
String^ PrintGetPrinterName( 
   int PrinterNo
)

Parameters

PrinterNo: The printer index. It must be a value from 1 to PrintGetPrintersCount.

Return Value

The name of the specified printer. The GetStat method can be subsequently used or the PrintGetStat method to determine if this method has been successful.

Remarks

It is recommend to use the GetStat method or the PrintGetStat method to identify the specific reason for the method's failure, if any.

Example

How to find out the printer's name and how to use it further.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
Dim message As String = ""
Dim CurPrinter As String = GdViewer1.PrintGetActivePrinter()
If GdViewer1.GetStat() = GdPictureStatus.OK Then
    Dim PrintersCount As Integer = GdViewer1.PrintGetPrintersCount()
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        For i As Integer = 1 To PrintersCount
            Dim PrinterName As String = GdViewer1.PrintGetPrinterName(i)
            If GdViewer1.GetStat() = GdPictureStatus.OK Then
                If GdViewer1.PrintSetActivePrinter(PrinterName) = True Then
                    Dim prnSettings As System.Drawing.Printing.PrinterSettings
                    prnSettings = GdViewer1.PrintGetPrinterSettings()
                    If GdViewer1.GetStat() = GdPictureStatus.OK Then
                        message = message + "Printer: " + PrinterName + vbCrLf + "Settings: " + prnSettings.ToString() + vbCrLf + vbCrLf
                    Else
                        message = message + "Printer: " + PrinterName + "    Error getting settings: " + GdViewer1.PrintGetStat().ToString() + vbCrLf
                    End If
                Else
                    Exit For
                End If
            Else
                Exit For
            End If
        Next
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            MessageBox.Show(message, "GdViewer.PrintGetPrinterName")
        Else
            MessageBox.Show("The example has NOT been followed successfully. The last status: " + GdViewer1.PrintGetStat(), "GdViewer.PrintGetPrinterName")
        End If
        If GdViewer1.PrintSetActivePrinter(CurPrinter) = False Then MessageBox.Show("The PrintSetActivePrinter() method has failed with the status: " + GdViewer1.PrintGetStat(), "GdViewer.PrintGetPrinterName")
    Else
        MessageBox.Show("The PrintGetPrintersCount() method has failed with the status: " + GdViewer1.PrintGetStat(), "GdViewer.PrintGetPrinterName")
    End If
Else
    MessageBox.Show("The PrintGetActivePrinter() method has failed with the status: " + GdViewer1.PrintGetStat(), "GdViewer.PrintGetPrinterName")
End If

//We assume that the GdViewer1 control has been properly integrated.
string message = "";
string CurPrinter = GdViewer1.PrintGetActivePrinter();
if (GdViewer1.GetStat() == GdPictureStatus.OK)
{
    int PrintersCount = GdViewer1.PrintGetPrintersCount();
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
    {
        for (int i = 1; i <= PrintersCount; i++)
        {
            string PrinterName = GdViewer1.PrintGetPrinterName(i);
            if (GdViewer1.GetStat() == GdPictureStatus.OK)
            {
                if (GdViewer1.PrintSetActivePrinter(PrinterName) == true)
                {
                    System.Drawing.Printing.PrinterSettings prnSettings;
                    prnSettings = GdViewer1.PrintGetPrinterSettings();
                    if (GdViewer1.GetStat() == GdPictureStatus.OK)
                        message = message + "Printer: " + PrinterName + "\nSettings: " + prnSettings.ToString() + "\n\n";
                    else
                        message = message + "Printer: " + PrinterName + "    Error getting settings: " + GdViewer1.PrintGetStat().ToString() + "\n";
                }
                else
                    break;
            }
            else
                break;
        }
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
            MessageBox.Show(message, "GdViewer.PrintGetPrinterName");
        else
            MessageBox.Show("The example has NOT been followed successfully. The last status: " + GdViewer1.PrintGetStat(), "GdViewer.PrintGetPrinterName");
        if (GdViewer1.PrintSetActivePrinter(CurPrinter) == false)
            MessageBox.Show("The PrintSetActivePrinter() method has failed with the status: " + GdViewer1.PrintGetStat(), "GdViewer.PrintGetPrinterName");
    }
    else
        MessageBox.Show("The PrintGetPrintersCount() method has failed with the status: " + GdViewer1.PrintGetStat(), "GdViewer.PrintGetPrinterName");
}
else
    MessageBox.Show("The PrintGetActivePrinter() method has failed with the status: " + GdViewer1.PrintGetStat(), "GdViewer.PrintGetPrinterName");

Reference

GdViewer Class
GdViewer Members
PrintGetPrintersCount Method
PrintGetActivePrinter Method
PrintSetActivePrinter Method
PrintGetStat Method
Print Method