PrintGetPrinterName Method (GdPicturePDF)

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#

Dim caption As String = "Example: PrintGetPrinterName"

Using gdpicturePDF As New GdPicturePDF()

    Dim message As String = ""

    Dim CurPrinter As String = gdpicturePDF.PrintGetActivePrinter()

    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

        Dim PrintersCount As Integer = gdpicturePDF.PrintGetPrintersCount()

        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

            For i As Integer = 1 To PrintersCount

                Dim PrinterName As String = gdpicturePDF.PrintGetPrinterName(i)

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    If gdpicturePDF.PrintSetActivePrinter(PrinterName) = True Then

                        Dim prnSettings As System.Drawing.Printing.PrinterSettings

                        prnSettings = gdpicturePDF.PrintGetPrinterSettings()

                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                            message = message + "Printer: " + PrinterName + vbCrLf + "Settings: " + prnSettings.ToString() + vbCrLf + vbCrLf

                        Else

                            message = message + "Printer: " + PrinterName + "    Error getting settings: " + gdpicturePDF.PrintGetStat().ToString() + vbCrLf

                        End If

                    Else

                        Exit For

                    End If

                Else

                    Exit For

                End If

            Next

            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                MessageBox.Show(message, caption)

            Else

                MessageBox.Show("The example has NOT been followed successfully. The last status: " + gdpicturePDF.PrintGetStat(), caption)

            End If

            If gdpicturePDF.PrintSetActivePrinter(CurPrinter) = False Then

                MessageBox.Show("The PrintSetActivePrinter() method has failed with the status: " + gdpicturePDF.PrintGetStat(), caption)

            End If

        Else

            MessageBox.Show("The PrintGetPrintersCount() method has failed with the status: " + gdpicturePDF.PrintGetStat(), caption)

        End If

    Else

        MessageBox.Show("The PrintGetActivePrinter() method has failed with the status: " + gdpicturePDF.PrintGetStat(), caption)

    End If

End Using

string caption = "Example: PrintGetPrinterName";

using (GdPicturePDF gdpicturePDF = new GdPicturePDF())

{

    string message = "";

    string CurPrinter = gdpicturePDF.PrintGetActivePrinter();

    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

    {

        int PrintersCount = gdpicturePDF.PrintGetPrintersCount();

        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

        {

            for (int i = 1; i <= PrintersCount; i++)

            {

                string PrinterName = gdpicturePDF.PrintGetPrinterName(i);

                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

                {

                    if (gdpicturePDF.PrintSetActivePrinter(PrinterName) == true)

                    {

                        System.Drawing.Printing.PrinterSettings prnSettings;

                        prnSettings = gdpicturePDF.PrintGetPrinterSettings();

                        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

                            message = message + "Printer: " + PrinterName + "\nSettings: " + prnSettings.ToString() + "\n\n";

                        else

                            message = message + "Printer: " + PrinterName + "    Error getting settings: " + gdpicturePDF.PrintGetStat().ToString() + "\n";

                    }

                    else

                        break;

                }

                else

                    break;

            }

            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

                MessageBox.Show(message, caption);

            else

                MessageBox.Show("The example has NOT been followed successfully. The last status: " + gdpicturePDF.PrintGetStat(), caption);

            if (gdpicturePDF.PrintSetActivePrinter(CurPrinter) == false)

                MessageBox.Show("The PrintSetActivePrinter() method has failed with the status: " + gdpicturePDF.PrintGetStat(), caption);

        }

        else

            MessageBox.Show("The PrintGetPrintersCount() method has failed with the status: " + gdpicturePDF.PrintGetStat(), caption);

    }

    else

        MessageBox.Show("The PrintGetActivePrinter() method has failed with the status: " + gdpicturePDF.PrintGetStat(), caption);

}

Reference

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