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

Статья
11/20/2024

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

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

Синтаксис

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

Параметры

[in] hSession

Обработка сеанса, возвращаемого функцией OpenNtmsSess ion.

[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	Функция была успешной.

Замечания

Вызов SetNtmsUIOptions добавляет или удаляет назначение для определенного экземпляра, определенного параметрами lpObjectId и dw Type.

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

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

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

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows Server 2003 [только классические приложения]
целевая платформа	Виндоус
заголовка	ntmsapi.h
библиотеки	Ntmsapi.lib
DLL	Ntmsapi.dll

См. также

GetNtmsUIOptions

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

Поделиться через