3.2.5.2.5.7 INtmsSession1::CancelNtmsOperatorRequest (Opnum 9)

The CancelNtmsOperatorRequest method cancels an operator request.

 HRESULT CancelNtmsOperatorRequest(
   [in] LPNTMS_GUID lpRequestId
 );

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

Return value/code

Description

0x00000000

S_OK

The call was successful.

0x80070005

ERROR_ACCESS_DENIED

The user who tried to execute this method does not have administrator privileges. Only a server administrator can cancel operator requests.

0x80070057

ERROR_INVALID_PARAMETER

A parameter is missing.

0x800710D8

ERROR_OBJECT_NOT_FOUND

The operator request object identifier was not found. This error occurs if the request is completed prior to cancellation of the operation, or when an invalid request identifier is supplied.

0x8007139F

ERROR_INVALID_STATE

The request has already been completed or cancelled.

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

This method MUST cancel the given operator request by setting the request state to NTMS_OPSTATE_REFUSED.