SetNtmsRequestOrder

[This is preliminary documentation and subject to change.]

The SetNtmsRequestOrder function sets the order that the specified request will be processed in the library queue.

DWORD WINAPI SetNtmsRequestOrder(
  HANDLE hSession,
  LPNTMS_GUID lpRequestId,
  DWORD dwOrderNumber
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpRequestId

Specifies the unique identifier of a library request.

dwOrderNumber

Specifies the order that the 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

An insert is queued.

Remarks

Currently NTMS_LM_MOUNT requests are sorted using the order number.

The order number set by the SetNtmsRequestOrder function is specific to the type of request because the types are processed in a predetermined order. For example, an 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.

To process a request immediately, an application can set the order number to 1. To defer processing, an application should set the order number to a very large number or 0xFFFFFFFF. The order number of a request, which currently has an order number of 0, cannot be changed.

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