IProvQueue::Delete

Deletes a queued request. Used on requests submitted to the Provisioning Queue Manager Service of Microsoft. Provisioning Framework (MPF).

This operation can be performed only on suspended requests.

Syntax

C++
HRESULT Delete ( BSTR bstrQueueID );
Visual Basic
Sub Delete ( _ bstrQueueID As String _ )

Parameters

bstrQueueID

Identifier for the queued request to delete. Returned by SubmitRequest or SubmitTrustedRequest.

Return Codes

Zero indicates success; a non-zero value represents an error. For a list of error codes, see MPF Errors.

C++ Example

IProvQueue *pProvQueue = NULL;
BSTR bstrRequest = NULL;
BSTR bstrQueueID = NULL;
BOOL fRequestMustGo = FALSE;
HRESULT hr = E_OUTOFMEMORY;

// The code for creating the queue manager client and the request string was skipped
...

// Create a suspended request
hr = pProvQueue->SubmitTrustedRequest(bstrRequest, TRUE, &bstrQueueID);
if(FAILED(hr)) goto LocalCleanup;

// Do something; set fRequestMustGo on success
...

if(fRequestMustGo)
{
	// Everything is OK; activate the request
	hr = pProvQueue->Activate(bstrQueueID);
}
else
{
	// An error occured; delete the request
	hr = pProvQueue->Delete(bstrQueueID);
}

// Clean up
LocalCleanup:
	if(pProvQueue)
		pProvQueue->Release();
	::SysFreeString(bstrRequest);
	::SysFreeString(bstrQueueID);

Visual Basic Example

Dim objProvQueue
Dim strRequest
Dim strQueueID
Dim fRequestMustGo

fRequestMustGo = False

' The code for creating the queue manager client and the request string was skipped
...

' Create a suspended request
strQueueID = objProvQueue.SubmitTrustedRequest(strRequest, True)

' Do something; set fRequestMustGo on success
...

If fRequestMustGo Then
	' Everything is OK; activate the request
	objProvQueue.Activate(strQueueID)
Else
	' An error occured; delete the request
	objProvQueue.Delete(strQueueID)
End If