GetNtmsRequestOrder

[This is preliminary documentation and subject to change.]

The GetNtmsRequestOrder function gets the order that the specified request will be processed in the library queue.

DWORD WINAPI GetNtmsRequestOrder(
  HANDLE hSession,
  LPNTMS_GUID lpRequestId,
  LPDWORD lpdwOrderNumber
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpRequestId

Specifies the unique identifier of a library request.

lpdwOrderNumber

Specifies the order in which this request will be processed in the queue.

Return Values

ERROR_ACCESS_DENIED

NTMS_CONTROL_ACCESS to the library is denied. Other security errors are also possible, but they would indicate a security subsystem error.

ERROR_DATABASE_FAILURE

The database is inaccessible or damaged.

ERROR_INVALID_HANDLE

The request ID is invalid or missing.

ERROR_INVALID_PARAMETER

The library ID or operation ID pointer is missing.

ERROR_SUCCESS

The insert is queued.

Remarks

If the GetNtmsRequestOrder function returns zero, ordering is not available for this request. The order number is specific to the type of request because the types are processed in a predetermined order.

For example, the NTMS_LM_DISMOUNT request is processed prior to an NTMS_LM_MOUNT request. Within a specific class of requests the queue can be ordered, however. The lower-ordered requests are processed first, for example, 1 is the first request processed, 2 is the next request processed, and so forth.

You can use this order number, the request type, the submission time, and the submission date to help view the queue in sorted order. Request type, order number, and submission time should perform sorting.

Currently on NTMS_LM_MOUNT, requests are sorted using the order number.

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, SetNtmsRequestOrder