CancelNtmsOperatorRequest

[This is preliminary documentation and subject to change.]

The CancelNtmsOperatorRequest function cancels the specified RSM operator request.

DWORD WINAPI CancelNtmsOperatorRequest(
  HANDLE hSession,
  LPNTMS_GUID lpRequestId
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpRequestId

Specifies the operator request object ID

Return Values

ERROR_ACCESS_DENIED

The user that tried to execute this function does not have administrator privileges. Only an administrator of the RSM server can cancel operator requests.

ERROR_OBJECT_NOT_FOUND

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

ERROR_SUCCESS

The operator request has been canceled.

Remarks

For a list of the existing requests to cancel with the CancelNtmsOperatorRequest function, see the EnumerateNtmsObject function or use the ID passed back by the SubmitNtmsOperatorRequest function.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in ntmsapi.h.
  Import Library: Use ntmsapi.lib.

See Also

Operator Request Functions, SatisfyNtmsOperatorRequest, SubmitNtmsOperatorRequest