3.2.5.2.1.16 INtmsLibraryControl1::DeleteNtmsRequests (Opnum 19)

The DeleteNtmsRequests method deletes a request or a list of requests. Requests that have already been submitted or are queued, waiting, or in progress MUST NOT be deleted.

 HRESULT DeleteNtmsRequests(
   [in, size_is(dwCount)] LPNTMS_GUID lpRequestId,
   [in] DWORD dwType,
   [in] DWORD dwCount
 );

lpRequestId: An array of library or operator request identifiers to delete.

dwType:  One of the NTMS_LIBREQUEST or NTMS_OPREQUEST values from the NtmsObjectsTypes (section 2.2.1.6) enumeration, specifying the type of operation to cancel.

dwCount:  The number of elements in the lpRequestId array.

Return value/code	Description
0x00000000 S_OK	The call was successful.
0x80070005 ERROR_ACCESS_DENIED	Access to the object is denied; other security errors are possible but indicate a security subsystem error.
0x80070057 ERROR_INVALID_PARAMETER	The parameter is invalid.
0x800710D9 ERROR_DATABASE_FAILURE	The database query or update failed.

Upon receiving this message, the server MUST verify that lpRequestId is not NULL. If it is NULL, the server MUST immediately fail the operation and return ERROR_INVALID_PARAMETER (0x80070057).

If parameter validation succeeds, the server MUST verify that the user has the required access rights. If the client does not have the required access rights, NTMS_MODIFY_ACCESS to the library is denied and the server MUST return ERROR_ACCESS_DENIED (0x80070005).

The action taken by the server depends on the value of dwType. The following table lists all possible values for dwType.

The DeleteNtmsRequests method deletes a request or a list of requests from the server database. Library or operator requests that are in a completed, failed, refused, or canceled state are removed. Submitted requests, queued requests, waiting requests, and in-progress requests are not deleted.

An error is not returned if a request or list of requests is not found.