ADSI PrintJob Object

ADSI PrintJob Object represents the information about a single print job request from a client represented by an ADSI PrintQueue Object on a network. Print job objects are not stored in the underlying directory and do not have a parent container. They are managed through the IADsCollection interface retrieved through IADsPrintQueueOperations::PrintJobs interface.

Interfaces typically supported on ADSI PrintJob Object Description
IUnknown Universal COM object management and interface query methods.
IDispatch Automation methods for late-bound access to an object's methods and properties.
IADs Standard Active Directory object management methods.
IADsPrintJob Management methods for a print job object and its properties.
IADsPrintJobOperations Management methods for a print job.

Properties accessed through IADsPrintJob Access Compiler Syntax
Description R/W HRESULT get_Description
([out] BSTR *pbstrDescription);

HRESULT put_Description
([in] BSTR bstrDescription);
HostPrintQueue R/O HRESULT get_HostPrintQueue ([out] BSTR *pbstrHostPrintQueue);
Notify R/W HRESULT get_Notify
([out] BSTR *pbstrNotify);

HRESULT put_Notify
([in] BSTR bstrNotify);
NotifyPath R/W HRESULT get_NotifyPath
([out] BSTR *pbstrNotifyPath);

HRESULT put_NotifyPath
([in] BSTR bstrNotifyPath);
Priority R/W HRESULT get_Priority
([out] long *plPriority);

HRESULT put_Priority
([in] long lPriority);
Size R/O HRESULT get_Size

([out] long *plSize);
StartTime R/W HRESULT get_StartTime
([out] DATE *pdateStartTime);

HRESULT put_StartTime
([in] DATE dateStartTime);
TimeSubmitted R/O HRESULT get_TimeSubmitted

([out] DATE *pdateTimeSubmitted);
TotalPages R/O HRESULT get_TotalPages

([out] long *plTotalPages);
UntilTime R/W HRESULT get_UntilTime
([out] DATE *pdateUntilTime);

HRESULT put_UntilTime
([in] DATE dateUntilTime);
User R/O HRESULT get_User

([out] BSTR *pbstrUser);
UserPath R/O HRESULT get_UserPath

([out] BSTR *pbstrUserPath);

Description
Gets and sets the description of the print job.
HostPrintQueue
Gets the ADsPath string that references the Print Queue which is processing the print job.
Notify
Gets and sets the user to notify when job processing is complete.
NotifyPath
Gets and sets the ADsPath for the user object of the user to notify when job processing is complete.
Priority
Gets and sets the priority of the print job.
Size
Gets the size of the print job in bytes.
StartTime
Gets and sets the earliest time the job should be printed.
TimeSubmitted
Gets the time that the job was submitted to the queue.
TotalPages
Gets the total number of pages in the print job.
UntilTime
Gets and sets the latest time the job should be printed.
User
Gets the name of user that submitted the print job.
UserPath
Gets the ADsPath of the user object for the user that submitted this print job.
Properties accessed through IADsPrintJobOperations Access Compiler Syntax
Status R/O HRESULT get_Status
([out] long *plStatus);
TimeElapsed R/O HRESULT get_TimeElapsed
([out] long *plTimeElapsed);
PagesPrinted R/O HRESULT get_PagesPrinted
([out] long *plPagesPrinted);
Position R/W HRESULT get_Position
([out] long *plPosition);

HRESULT put_Position
([in] long lPosition);

PagesPrinted
Gets the number of pages complete.
Position
Gets and sets the numeric position of the job in the queue.
Status
Integer value indicating current status of service. The following values are defined:
STATUS Hex Value
ADS_JOB_PAUSED 0x00000001
ADS_JOB_ERROR 0x00000002
ADS_JOB_DELETING 0x00000004
ADS_JOB_PRINTING 0x00000010
ADS_JOB_OFFLINE 0x00000020
ADS_JOB_PAPEROUT 0x00000040
ADS_JOB_PRINTED 0x00000080
ADS_JOB_DELETED 0x00000100

TimeElapsed
Gets the time elapsed, in seconds, since the job started printing.

QuickInfo

  Windows NT: Use version 4.0 and later.

See Also

IADsCollection, IADsPrintJob, IADsPrintJobOperations, IADsPrintQueue, IADsPrintQueueOperations, ADSI Collection Object, ADSI PrintQueue Object