3.2.5.2.1.7 INtmsLibraryControl1::CancelNtmsLibraryRequest (Opnum 10)

  • Article

The CancelNtmsLibraryRequest method cancels outstanding library requests.

 HRESULT CancelNtmsLibraryRequest(
   [in] LPNTMS_GUID lpRequestId
 );

lpRequestId: A pointer to the identifier of the request to cancel.

Return value/code

Description

0x00000000

S_OK

Method completed successfully.

0x80070005

ERROR_ACCESS_DENIED

Access to object is denied; only an administrator of the server can cancel library requests.

0x80070057

ERROR_INVALID_PARAMETER

 Input parameter is invalid.

0x800710D8

ERROR_OBJECT_NOT_FOUND

The identifier of the library request object was not found.

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 lpRequestId is an outstanding request identifier. If the request identifier is not outstanding, the server MUST return ERROR_OBJECT_NOT_FOUND (0x8000710D8) and take no further action.

If the library is busy, the server MUST queue the cancellation and return success (S_OK); otherwise, the server MUST cancel the specified library request and return success (S_OK).

On completion of an asynchronous operation, notification will be sent with the identifier lpRequestId.