CancelNtmsLibraryRequest function (ntmsapi.h)
[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]
The CancelNtmsLibraryRequest function cancels outstanding RSM requests, such as calls to the CleanNtmsDrive function. If the library is busy, RSM queues the cancellation and returns success.
Syntax
DWORD CancelNtmsLibraryRequest(
[in] HANDLE hSession,
[in] LPNTMS_GUID lpRequestId
);
Parameters
[in] hSession
Handle to the session returned by the OpenNtmsSession function.
[in] lpRequestId
Unique identifier of the library request to be canceled.
To retrieve the list of existing library requests, use the EnumerateNtmsObject function.
Return value
This function returns one of the following values.
| Value | Meaning |
|---|---|
|
Only an administrator of the RSM server can cancel library requests. This error is also returned if the request is currently being handled and cannot be deleted. |
|
The session handle is missing or is not valid. |
|
There was an allocation failure during processing. |
|
The library request object ID was not found. This error occurs if the request is completed prior to issuing the cancel or when a request ID that is not valid is specified. |
|
The library request has been queued for cancellation. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | ntmsapi.h |
| Library | Ntmsapi.lib |
| DLL | Ntmsapi.dll |