CancelNtmsLibraryRequest

[This is preliminary documentation and subject to change.]

The CancelNtmsLibraryRequest function cancels outstanding RSM requests, such as calls to the CleanNtmsDrive function. If the library is busy, RSM queues the CancelNtmsLibraryRequest function and returns success.

DWORD WINAPI CancelNtmsLibraryRequest(
  HANDLE hSession,
  LPNTMS_GUID lpRequestId
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpRequestId

Specifies the RSM request object ID. To get a list of the existing library requests (or work items) to cancel, see the EnumerateNtmsObject function.

Return Values

ERROR_ACCESS_DENIED

Only an administrator of the RSM server can cancel library requests.

ERROR_OBJECT_NOT_FOUND

The library request object ID was not found. This error occurs if the request is completed prior to issuing the cancel or when an invalid request ID is specified.

ERROR_SUCCESS

The library request has been queued for cancelation.

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

Library Control Functions, EnumerateNtmsObject