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

Статья
03/08/2023

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

Функция SetNtmsUIOptions изменяет список имен компьютеров, на которые для данного объекта направляется указанный тип пользовательского интерфейса.

Синтаксис

DWORD SetNtmsUIOptionsW(
  [in]  HANDLE            hSession,
  [in]  const LPNTMS_GUID lpObjectId,
  [in]  DWORD             dwType,
  [in]  DWORD             dwOperation,
  [out] LPCWSTR           lpszDestination
);

Параметры

[in] hSession

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

[in] lpObjectId

Уникальный идентификатор объекта, пользовательский интерфейс которого перенаправляется. Объект должен быть контейнером, который может быть источником событий. Объект может быть приложением (запрос на подключение, инициированный приложением), библиотекой (запрос на открытие двери в ответ на извлечение) или компьютером (весь пользовательский интерфейс, относящийся к компьютеру).

Чтобы указать контейнер компьютера, установите указатель lpObjectId , указывающий на буфер с идентификатором GUID объекта компьютера диспетчера съемных носителей. Чтобы указать конкретную библиотеку, задайте для нее значение , указывая на буфер с помощью GUID библиотеки. Чтобы указать приложение, передайте указатель NULL . Идентификатор приложения определяется сеансом, используемым в hSession. Обратите внимание, что в приложении может быть одновременно открыто несколько сеансов. В этом случае набор значений применяется только к сеансу hSession . В случае с библиотекой или экземпляром компьютера параметры сохраняются до явного изменения. Строки приложения удаляются при закрытии сеанса.

[in] dwType

Этот параметр может иметь одно из следующих значений.

Значение	Значение
NTMS_UITYPE_INFO	Сообщения пользовательского интерфейса, предоставляющие сведения. К ним относятся элементы рабочей очереди, указывающие на ход выполнения. Например, запросы на подключение.
NTMS_UITYPE_REQ	Сообщения пользовательского интерфейса, которые являются запросами. К ним относятся запросы оператора, обрабатывающие мультимедиа. Например, запрос на внедрение нового носителя.
NTMS_UITYPE_ERR	Сообщения пользовательского интерфейса, предоставляющие сведения об ошибке. К ним относятся запросы операторов, связанные с уведомлением об ошибке. Например, запрос на очистку диска.

[in] dwOperation

Этот параметр может иметь одно из следующих значений.

Значение	Значение
NTMS_UIDEST_ADD	Добавьте в список новое назначение (имя компьютера).
NTMS_UIDEST_DELETE	Удаление назначения из списка.
NTMS_UIDEST_DELETEALL	Очистите все назначения из списка. Пользовательский интерфейс для объекта не создается. В этом случае аргумент назначения игнорируется.

[out] lpszDestination

Многостроковый, возвращающий имена компьютеров, на которые перенаправляется пользовательский интерфейс. Этот параметр не может иметь значение NULL.

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

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

Значение	Значение
ERROR_ACCESS_DENIED	Доступ к одному или нескольким объектам RSM запрещен.
ERROR_ALREADY_EXISTS	Указанное назначение уже существует в списке.
ERROR_INVALID_HANDLE	Дескриптор сеанса отсутствует или недопустим.
ERROR_INVALID_PARAMETER	Указатель lpdwSize или lpszDestination имеет значение NULL, или lpObjectId не является допустимым контейнером, либо dwType или dwOperation не является одним из трех допустимых значений.
ERROR_NOT_ENOUGH_MEMORY	Во время обработки произошел сбой выделения.
ERROR_OBJECT_NOT_FOUND	Идентификатор GUID, указанный lpObjectId , не является ИДЕНТИФИКАТОРом GUID любого компьютера или объекта библиотеки в базе данных.
ERROR_SUCCESS	Функция выполнена успешно.

	NTMS_UITYPE_INFO	NTMS_UITYPE_REQ	NTMS_UITYPE_ERR
Приложение	Отображение пользовательского интерфейса хода выполнения рабочего элемента для рабочих элементов, созданных этим приложением.	Отображение пользовательского интерфейса запроса оператора для запросов операторов, созданных действиями, выполняемыми этим приложением.	Не определено. Приложения не могут вызывать такого рода события ошибок.
Библиотека	Отображение пользовательского интерфейса хода выполнения рабочего элемента для рабочих элементов, связанных с этой библиотекой.	Отображение пользовательского интерфейса для запросов, связанных с этой библиотекой.	Отображение пользовательского интерфейса для ошибок, связанных с этой библиотекой.
Компьютер	Отображение информационного пользовательского интерфейса в этом экземпляре RSM, работающем на этом компьютере.	Отображение пользовательского интерфейса типа запроса в этом экземпляре RSM.	Отображение пользовательского интерфейса типа ошибки в этом экземпляре RSM.

Обратите внимание, что при вызове SetNtmsUIOptions выполняются проверки безопасности. При указании объекта-компьютера требуется доступ с разрешением на изменение компьютера. При изменении элемента пользовательского интерфейса библиотеки требуется доступ с разрешением на изменение объекта библиотеки.

Обратите внимание, что проверка конечных строк не выполняется. Вызов с именем назначения, недоступным с компьютера, на котором вызывается SetNtmsUIOptions , возвращает успешное выполнение. Указатель на пустую строку принимается в смысле локального компьютера.

Примечание

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

Требования

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

См. также раздел

GetNtmsUIOptions

Функции управления библиотекой