WaitForNtmsOperatorRequest function (ntmsapi.h)
[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]
The WaitForNtmsOperatorRequest function waits for the specified RSM operator request.
Syntax
DWORD WaitForNtmsOperatorRequest(
[in] HANDLE hSession,
[in] LPNTMS_GUID lpRequestId,
[in] DWORD dwTimeout
);
Parameters
[in] hSession
Handle to the session returned by the OpenNtmsSession function.
[in] lpRequestId
Operator request identifier created by the SubmitNtmsOperatorRequest function.
[in] dwTimeout
Number of milliseconds to wait. To check for an operator request, pass a time-out value of zero. If you specify a value of INFINITE, this function does not time-out.
Return value
This function returns one of the following values.
Value | Meaning |
---|---|
|
The operator request was canceled by an administrator. |
|
The value specified in the hSession parameter is NULL or is not valid. |
|
One of the parameter values is not valid. |
|
Unable to connect to the RSM service. |
|
Unable to find the operator request object. Object requests are flushed from the database. Application should call a function like AllocateNtmsMedia if RSM returns this error. |
|
The function was successful. |
|
The time specified in the dwTimeout parameter elapsed before the completion of the operator request. |
Remarks
Operator requests specified with the WaitForNtmsOperatorRequest function are used to request media, to request that the medium be moved from one library to another, or to request RSM device service.
An application uses WaitForNtmsOperatorRequest to wait for resolution of an operator request. The request can be satisfied, rejected, deleted, or timed out.
Typically, applications use the SubmitNtmsOperatorRequest function to submit operator requests and use the WaitForNtmsOperatorRequest function to wait for their resolution.
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 |