The property methods of the IADsPrintQueue interface get or set the properties described in the following table. For more information, see Interface Property Methods.
Properties
BannerPage
The file system path that points to the banner page used to separate print jobs. If NULL, no banner page is used.
Access type: Read/write
Scripting data type: BSTR
// C++ method syntax
HRESULT get_BannerPage(
[out] BSTR* pbstrBannerPage
);
HRESULT put_BannerPage(
[in] BSTR bstrBannerPage
);
Datatype
The data type that can be processed by this queue.
Access type: Read/write
Scripting data type: BSTR
// C++ method syntax
HRESULT get_Datatype(
[out] BSTR* pbstrDatatype
);
HRESULT put_Datatype(
[in] BSTR bstrDatatype
);
DefaultJobPriority
The default priority assigned to each print job.
Access type: Read/write
Scripting data type: BSTR
// C++ method syntax
HRESULT get_DefaultJobPriority(
[out] LONG* plDefaultJobPriority
);
HRESULT put_DefaultJobPriority(
[in] BSTR lDefaultJobPriority
);
Description
The text description of this print queue.
Access type: Read/write
Scripting data type: BSTR
// C++ method syntax
HRESULT get_Description(
[out] BSTR* pbstrDescription
);
HRESULT put_Description(
[in] BSTR bstrDescription
);
HostComputer
The ADsPath string that references the host computer.
Access type: Read/write
Scripting data type: BSTR
// C++ method syntax
HRESULT get_HostComputer(
[out] BSTR* pbstrHostComputer
);
HRESULT put_HostComputer(
[in] BSTR bstrHostComputer
);
Location
The location of the queue as described by an administrator.
Access type: Read/write
Scripting data type: BSTR
// C++ method syntax
HRESULT get_Location(
[out] BSTR* pbstrLocation
);
HRESULT put_Location(
[in] BSTR bstrLocation
);
Model
The name of the driver used by this print queue.
Access type: Read/write
Scripting data type: BSTR
// C++ method syntax
HRESULT get_Model(
[out] BSTR* pbstrModel
);
HRESULT put_Model(
[in] BSTR bstrModel
);
PrintDevices
A SAFEARRAY of BSTR that contains the names of the print devices to which this print queue spools jobs.
Access type: Read/write
Scripting data type: VARIANT
// C++ method syntax
HRESULT get_PrintDevices(
[out] VARIANT* pvPrintDevices
);
HRESULT put_PrintDevices(
[in] VARIANT vPrintDevices
);
PrinterPath
The string that references the path by which a shared printer can be accessed.
Access type: Read/write
Scripting data type: BSTR
// C++ method syntax
HRESULT get_PrinterPath(
[out] BSTR* pbstrPrinterPath
);
HRESULT put_PrinterPath(
[in] BSTR bstrPrinterPath
);
PrintProcessor
The print processor associated with this queue.
Access type: Read/write
Scripting data type: BSTR
// C++ method syntax
HRESULT get_PrintProcessor(
[out] BSTR* pbstrPrintProcessor
);
HRESULT put_PrintProcessor(
[in] BSTR bstrPrintProcessor
);
Priority
The priority of this printer object job queue for any connected devices. All jobs in higher priority print queue objects will be processed first.
Access type: Read/write
Scripting data type: LONG
// C++ method syntax
HRESULT get_Priority(
[out] LONG* plPriority
);
HRESULT put_Priority(
[in] LONG lPriority
);
StartTime
The time when the queue should begin processing jobs. The date portion of the time is ignored.
Access type: Read/write
Scripting data type: DATE
// C++ method syntax
HRESULT get_StartTime(
[out] DATE* pdateStartTime
);
HRESULT put_StartTime(
[in] DATE dateStartTime
);
UntilTime
The time when the queue should stop processing jobs.
Access type: Read/write
Scripting data type: DATE
// C++ method syntax
HRESULT get_UntilTime(
[out] DATE* pdateUntilTime
);
HRESULT put_UntilTime(
[in] DATE dateUntilTime
);
Examples
The following code example shows how to determine if a specified printer is online or offline.
Dim pq As IADsPrintQueue
Dim pqo As IADsPrintQueueOperations
On Error GoTo Cleanup
Set pq = GetObject("WinNT://aMachine/aPrinter")
Set pqo = pq
If pqo.status = ADS_PRINTER_OFFLINE Then
MsgBox pq.Model & "@" & pq.Location & is offline."
Else
MsgBox pq.Model & "@" & pq.Location & is online."
End If
Cleanup:
If (Err.Number<>0) Then
MsgBox("An error has occurred. " & Err.Number)
End If
Set pq = Nothing
Set pqo = Nothing
The following code example shows how to determine if a specified printer is online or offline.
IADsPrintQueue *pq = NULL;
HRESULT hr = S_OK;
IADsPrintQueueOperations *pqo = NULL;
BSTR model = NULL;
BSTR location = NULL;
LPWSTR adsPath = L"WinNT://aMachine/aPrinter";
hr = ADsGetObject(adsPath,
IID_IADsPrintQueue,
(void**)&pq);
if(FAILED(hr)) {goto Cleanup;}
hr = pq->QueryInterface(IID_IADsPrintQueueOperations,(void**)&pqo);
if(FAILED(hr)) {goto Cleanup;}
long status;
hr = pqo->get_Status(&status);
if(FAILED(hr)) {goto Cleanup;}
hr = pq->get_Model(&model);
if(FAILED(hr)) {goto Cleanup;}
hr =pq->get_Location(&location);
if(FAILED(hr)) {goto Cleanup;}
if(status == ADS_PRINTER_OFFLINE)
{
printf("%S @ %S is offline.\n",model,location);
}
else
{
printf("%S @ %S is online.\n",model,location);
}
Cleanup:
SysFreeString(model);
SysFreeString(location);
if(pq) pq->Release();
if(pqo) pqo->Release();
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Minimum supported server | Windows Server 2008 |
| Header | Iads.h |
| DLL | Activeds.dll |
| IID | IID_IADsPrintQueue is defined as B15160D0-1226-11CF-A985-00AA006BC149 |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
