Share via

3.2.5.2.1.14 INtmsLibraryControl1::GetNtmsRequestOrder (Opnum 17)

  • Article

The GetNtmsRequestOrder method retrieves the order in which a request will be processed in the library queue.

 HRESULT GetNtmsRequestOrder(
   [in] LPNTMS_GUID lpRequestId,
   [out] DWORD* lpdwOrderNumber
 );

lpRequestId: A pointer to the identifier of a library request.

lpdwOrderNumber:  A pointer to the order in the queue in which the request will be processed. This queue MUST start with order 1.

Return value/code

Description

0x00000000

S_OK

The call was successful.

0x80070005

ERROR_ACCESS_DENIED

NTMS_MODIFY_ACCESS to the library is denied; other security errors are possible but indicate a security subsystem error.

0x80070008

ERROR_NOT_ENOUGH_MEMORY

An allocation failure occurred during processing.

0x80070057

ERROR_INVALID_PARAMETER

The library identifier is missing.

0x800710D9

ERROR_DATABASE_FAILURE

The database is inaccessible or damaged.

Upon receiving this message, the server MUST verify that both lpRequestId and lpdwOrderNumber are not NULL. If parameter validation fails, the server MUST immediately fail the operation and return ERROR_INVALID_PARAMETER (0x80070057).

The server MUST search the request queue for the request ID that is pointed to by lpRequestId. If the server finds the entry for lpRequestId, it MUST return the order of that entry in lpdwOrderNumber; otherwise, it MUST return 0 in lpdwOrderNumber.