SubmitNtmsOperatorRequest

[This is preliminary documentation and subject to change.]

The SubmitNtmsOperatorRequest function submits an RSM operator request.

DWORD WINAPI SubmitNtmsOperatorRequest(
  HANDLE hSession,
  DWORD dwRequest,
  LPCTSTR lpMessage,
  LPNTMS_GUID lpArg1Id,
  LPNTMS_GUID lpArg2Id,
  LPNTMS_GUID lpRequestId
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

dwRequest

Specifies the type of operator request. This parameter can be one of the following values.

Value	Meaning
NTMS_OPREQ_CLEANER	RSM sends an operator request to insert a cleaner when a clean operation is queued and no cleaner is available to the drive.
NTMS_OPREQ_DEVICESERVICE	An application or RSM sends an operator request for drive service when a changer device or drive is experiencing problems. The lpArg1Id parameter specifies the device that needs service.
NTMS_OPREQ_MESSAGE	Application message only.
NTMS_OPREQ_MOVEMEDIA	An application or RSM sends an operator request to move media from one library to another for a mount of offline media or to eject existing media to the offline library. The lpArg1Id parameter specifies the piece of physical media that must be moved and the lpArg2Id parameter specifies the target library.
NTMS_OPREQ_NEWMEDIA	An application or RSM sends an operator request for new media when no media is available. The lpArg1Id parameter specifies the media pool object and the lpArg2Id parameter is the optional library identifier to which to add the new medium.

lpMessage

Specifies an optional message string sent to the user.

lpArg1Id

Specifies an object identifier for the operator request. Refer to the descriptions of the values in the dwRequest parameter for a description of what type of object must be passed for this argument.

lpArg2Id

Specifies an object identifier for the operator request. Refer to the descriptions of the values in the dwRequest parameter for details on what type of object must be passed for this argument.

lpRequestId

Pointer to an NTMS_GUID to receive the identifier of the operator request that was created.

Return Values

ERROR_ACCESS_DENIED

Access to one or more RSM objects is denied.

ERROR_DATABASE_FAILURE

The database query or update failed.

ERROR_INVALID_HANDLE

The value specified in the hSession parameter is NULL or invalid.

ERROR_INVALID_PARAMETER

Invalid parameters were passed to the function.

ERROR_NOT_CONNECTED

Unable to connect to the RSM service.

ERROR_OBJECT_NOT_FOUND

Unable to find the source or destination object.

ERROR_SUCCESS

The function was successful.

Remarks

Operator requests specified in the SubmitNtmsOperatorRequest function are used to request media, to request that the specified medium be moved from one library to another, or to request RSM device service.

The NTMS_OPEREQ_MESSAGE value is the request type most often used by applications. RSM cannot use NTMS_OPEREQ_MESSAGE. RSM uses the other request types as needed.

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

Operator Request Functions, AllocateNtmsMedia, MountNtmsMedia, CancelNtmsOperatorRequest, SatisfyNtmsOperatorRequest, WaitForNtmsOperatorRequest