IADsPrintQueueOperations::Purge

The IADsPrintQueueOperations::Purge method clears the print queue of all print jobs without processing them.

HRESULT Purge();

Parameters

Return Values

This method supports the standard return values. For more information about other return values, see the ADSI Error Codes.

Example Code [Visual Basic]

The following code example removes all the print jobs from a printer.

Dim pqo As IADsPrintQueueOperations
On Error GoTo Cleanup

Set pqo = GetObject("WinNT://aMachine/aPrinter")
pqo.Purge

Cleanup:
	If (Err.Number<>0) Then
		MsgBox("An error has occurred. " & Err.Number)
	End If
	Set pqo = Nothing

Example Code [C++]

The following code example removes all the print jobs from a printer.

IADsPrintQueueOperations *pqo = NULL;
HRESULT hr = S_OK; 

hr = ADsGetObject(L"WinNT://aMachine/aPrinter",
		IID_IADsPrintQueueOperations,(void**)&pqo);

if(FAILED(hr)) {goto Cleanup;}
hr = pqo->Purge();

Cleanup:
	if(pqo) pqo->Release();

Requirements

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Header: Declared in Iads.h.

See Also

IADsPrintQueueOperations