IPXCControlEx Object

<< Click to Display Table of Contents >>

Navigation:  Drivers API >

IPXCControlEx Object


 

PRO SDK Icon IPXCControlEx Object

 


 

The IPXCControlEx Object is used to create a new PDF-XChange Drivers API virtual printer instance and then returns the IPXCPrinter object. This allows the host application to control the properties of the printer instance and print the relevant documents. When the operation is complete the virtual printer instance is deleted.

 

IPXCControlEx.Printer

 

This property enables the creation of a new printer instance from the PDF-XChange Drivers API and returns the printed IPXCPrinter object. Please note that declarations and parameters are case-sensitive:

 

Declaration

 

C#

 

object get_Printer(string pServerName,

string pPrinterName,

string pRegKey,

string pDevCode);

 

C++

 

HRESULT get_Printer([inBSTR pServerName,

[inBSTR pPrinterName,

[inBSTR pRegKey,

[inBSTR pDevCode,

[outretvalVARIANTppPrinter);

 

VB

 

Property Printer(pServerName As String,

pPrinterName As String,

pRegKey As String,

pDevCode As String)

 

Parameters

 

pServerName

This argument is reserved for future usage and should be a NULL or empty string.

 

pPrinterName

Specifies the name of the created printer. If a printer of the same name already exists then a suffix will be generated for the new printer.

 

pRegKey

This is the string that contains the developer registration key. If this parameter is absent/invalid then demo labels will be added to all generated pages.*

 

pDevCode

This is the string that contains the developer code. If this parameter is absent/invalid, then demo labels will be added to all generated pages. Please note that pDevCode is only needed when the older style license keys are used. If a new style of key is being used then the pDevCode parameter should be NULL or just an empty string. This is because the new style keys include the information necessary for the pDevCode parameter, but we must retain the property as there are still users who have the older style license keys.

 

* This item is provided when a license is purchased. If projects are developed in evaluation mode then they must be recompiled in order to include the license strings. All output created in evaluation mode will need to be recreated.

 

Return Value

 

If the function fails then the return value is a NULL.

 

If the function succeeds then the return value is an IPXCPrinter object.

 

Example (VB)

 

Dim PDFPFactory As New PXCComLib5.CPXCControlEx

Dim WithEvents PDFPrinter As PXCComLib5.CPXCPrinter

 

Public Sub Form_Load()

Set PDFPrinter = PDFPFactory.Printer("", "PDF-XChange 2012 Sample", "<reg>", "<dev>");

End Sub

 

Public Sub Form_Unload(Cancel As Integer)

Set PDFPrinter = Nothing

End Sub

</dev></reg>