11.1.1 IADsPrintQueue

The IADsPrintQueue interface is used to get and set the properties of the Print Queue object. The interface definition is as follows:

[ object, uuid(IID_IADsPrintQueue), oleautomation, dual ]

interface IADsPrintQueue: IADs

{

// Read/write properties

[propget]

HRESULT PrinterPath ([out, retval]BSTR *pbstrPrinterPath);

[propput]

HRESULT PrinterPath ([in]BSTR bstrPrinterPath);

[propget]

HRESULT Model ([out, retval]BSTR *pbstrModel);

[propput]

HRESULT Model ([in]BSTR bstrModel);

[propget]

HRESULT Datatype ([out, retval]BSTR *pbstrDatatype);

[propput]

HRESULT Datatype ([in]BSTR bstrDatatype);

[propget]

HRESULT PrintProcessor ([out, retval]BSTR *pbstrPrintProcessor);

[propput]

HRESULT PrintProcessor ([in]BSTR bstrPrintProcessor);

[propget]

HRESULT Description ([out, retval]BSTR *pbstrDescription);

[propput]

HRESULT Description ([in]BSTR bstrDescription);

[propget]

HRESULT Location ([out, retval]BSTR *pbstrLocation);

[propput]

HRESULT Location ([in]BSTR bstrLocation);

[propget]

HRESULT StartTime ([out, retval]DATE *pdateStartTime);

[propput]

HRESULT StartTime ([in]DATE dateStartTime);

[propget]

HRESULT UntilTime ([out, retval]DATE *pdateUntilTime);

[propput]

HRESULT UntilTime ([in]DATE dateUntilTime);

[propget]

HRESULT DefaultJobPriority ([out, retval]long *plDefaultJobPriority);

[propput]

HRESULT DefaultJobPriority ([in]long lDefaultJobPriority);

[propget]

HRESULT Priority ([out, retval]long *plPriority);

[propput]

HRESULT Priority ([in]long lPriority);

[propget]

HRESULT BannerPage ([out, retval]BSTR *pbstrBannerPage);

[propput]

HRESULT BannerPage ([in]BSTR bstrBannerPage);

[propget]

HRESULT PrintDevices ([out, retval]VARIANT *pvPrintDevices

[propput]

HRESULT PrintDevices ([in]VARIANT vPrintDevices

[propget]

HRESULT NetAddresses ([out, retval]VARIANT *pvNetAddresses);

[propput]

HRESULT NetAddresses ([in]VARIANT vNetAddresses);

};

Method

Syntax

Description

PrinterPath

String

Gets and sets the string that references the path by which a shared printer may be accessed

Model

String

Gets and sets the name of driver used by this print queue.

Datatype

String

Gets and sets the data type that can be processed by this queue.

PrintProcessor

String

Gets and Sets the Print Processor associated with this Queue

Description

String

Gets and sets the text description of this print queue.

Location

String

Gets and sets the location of the queue as described by an administrator.

StartTime

Time

Gets and sets the time at which the queue should begin processing jobs. The date portion of the time is ignored.

UntilTime

Time

Gets and sets the time at which the queue should stop processing jobs.

DefaultJobPriority

Integer

Gets and sets the default priority assigned to each print job.

Priority

Integer

Gets and sets the priority of this Printer object's job queue for any connected devices. All jobs in higher priority Print Queue objects will be processed before those in lower priority Print Queue objects.

BannerPage

Path

Gets and sets the file system path that points to the banner page used to separate print jobs. If NULL no banner page is used.

PrintDevices

VARIANT

Gets and Sets a SAFEARRAY of BSTR containing the names of the print devices to which this print queue spools jobs.

NetAddresses

List

Gets and sets an array of NetAddress fields that represent the binding information for an object. The NetAddress syntax is discussed in Chapter 6, "Object Extensions".