Функция SubmitNtmsOperatorRequestA (ntmsapi.h)

Статья
08/25/2023

[Диспетчер съемных носителей больше недоступен в Windows 7 и Windows Server 2008 R2.]

Функция SubmitNtmsOperatorRequest отправляет запрос оператора RSM.

Синтаксис

DWORD SubmitNtmsOperatorRequestA(
  [in]  HANDLE      hSession,
  [in]  DWORD       dwRequest,
  [in]  LPCSTR      lpMessage,
  [in]  LPNTMS_GUID lpArg1Id,
  [in]  LPNTMS_GUID lpArg2Id,
  [out] LPNTMS_GUID lpRequestId
);

Параметры

[in] hSession

Дескриптор сеанса, возвращаемого функцией OpenNtmsSession .

[in] dwRequest

Тип запроса оператора. Этот параметр может принимать одно из указанных ниже значений.

Значение	Значение
NTMS_OPREQ_CLEANER	RSM отправляет оператору запрос на вставку очистки, если чистая операция поставлена в очередь, а очистка не доступна для диска. Параметр lpArg1Id может быть идентификатором библиотеки или слота. Требуется NTMS_CONTROL_ACCESS в библиотеку. Windows XP: Права доступа не требуются.
NTMS_OPREQ_DEVICESERVICE	Приложение или RSM отправляет оператору запрос на службу диска при возникновении проблем с устройством смены или диском. Параметр lpArg1Id указывает устройство, которое требует обслуживания. Этот параметр может быть идентификатором iedoor, библиотекой, физическим носителем или идентификатором диска. Требуется NTMS_CONTROL_ACCESS в библиотеку. Windows XP: Права доступа не требуются.
NTMS_OPREQ_MESSAGE	Только сообщение приложения. Требуется NTMS_USE_ACCESS на компьютер. Windows XP: Права доступа не требуются.
NTMS_OPREQ_MOVEMEDIA	Приложение или RSM отправляет оператору запрос на перемещение мультимедиа из одной библиотеки в другую для подключения автономного носителя или извлечения существующего носителя в автономную библиотеку. Параметр lpArg1Id указывает часть физического носителя, который необходимо переместить, а параметр lpArg2Id указывает целевую библиотеку. Требуется NTMS_CONTROL_ACCESS в пул носителей. Windows XP: Права доступа не требуются.
NTMS_OPREQ_NEWMEDIA	Приложение или RSM отправляет оператору запрос на новый носитель, если он недоступен. Параметр lpArg1Id указывает объект пула мультимедиа, а параметр lpArg2Id является необязательным идентификатором библиотеки, к которому добавляется новый носитель. Требуется NTMS_CONTROL_ACCESS в пул носителей. Windows XP: Права доступа не требуются.

[in] lpMessage

Необязательная строка сообщения, отправляемая пользователю.

[in] lpArg1Id

Идентификатор объекта для запроса оператора. Описание того, какой тип объекта необходимо передать для этого параметра, см. в описании значений в параметре dwRequest .

[in] lpArg2Id

Идентификатор объекта для запроса оператора. Дополнительные сведения о том, какой тип объекта необходимо передать для этого параметра, см. в описании значений в параметре dwRequest .

[out] lpRequestId

Указатель на буфер, получающий идентификатор созданного запроса оператора.

Возвращаемое значение

Эта функция возвращает одно из следующих значений.

Значение	Значение
ERROR_ACCESS_DENIED	Доступ к одному или нескольким объектам RSM запрещен.
ERROR_DATABASE_FAILURE	Сбой запроса или обновления базы данных.
ERROR_INVALID_HANDLE	Значение, указанное в параметре hSession , равно NULL или недопустимо.
ERROR_INVALID_PARAMETER	Одно из значений параметра является недопустимым.
ERROR_NOT_CONNECTED	Не удается подключиться к службе RSM.
ERROR_OBJECT_NOT_FOUND	Не удается найти исходный или целевой объект.
ERROR_SUCCESS	Функция выполнена успешно.

Функция SubmitNtmsOperatorRequest отправляет запрос оператора и возвращает состояние запроса (Выполнено или Отменено) или время ожидания (если оператор не выполняет действия по запросу). Запросы операторов используются для запроса носителя, перемещения указанного носителя из одной библиотеки в другую или для запроса службы устройств RSM.

Значение NTMS_OPEREQ_MESSAGE (в параметре dwRequest ) является типом запроса, который чаще всего используется приложениями. RSM не может использовать NTMS_OPEREQ_MESSAGE. RSM использует другие типы запросов по мере необходимости.

Примечание

Заголовок ntmsapi.h определяет SubmitNtmsOperatorRequest в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	ntmsapi.h
Библиотека	Ntmsapi.lib
DLL	Ntmsapi.dll