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

Статья
08/25/2023

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

Функция GetNtmsUIOptions получает список имен компьютеров, на которые для данного объекта направляется указанный тип пользовательского интерфейса. Вызов Метода GetNtmsUIOptions возвращает список назначений для экземпляра, определенный параметрами lpObjectId и dwType .

Если в списке нет назначений для указанного экземпляра, функция возвращает ERROR_SUCCESS вместе с нулевой длиной списка.

Синтаксис

DWORD GetNtmsUIOptionsW(
  [in]      HANDLE            hSession,
  [in]      const LPNTMS_GUID lpObjectId,
  [in]      DWORD             dwType,
  [out]     LPWSTR            lpszDestination,
  [in, out] LPDWORD           lpdwBufSize
);

Параметры

[in] hSession

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

[in] lpObjectId

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

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

[in] dwType

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

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

[out] lpszDestination

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

[in, out] lpdwBufSize

Размер целевой строки в TCHARs.

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

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

Значение	Значение
ERROR_ACCESS_DENIED	Доступ к одному или нескольким объектам RSM запрещен.
ERROR_INSUFFICIENT_BUFFER	Размер буфера, заданный lpdwSize , слишком мал для найденных назначений. Функция возвращает фактический размер в lpdwSize.
ERROR_INVALID_HANDLE	Дескриптор сеанса отсутствует или недопустим.
ERROR_INVALID_PARAMETER	Параметр lpdwSize или lpszDestination имеет значение NULL, или lpObjectId не является допустимым контейнером, или dwType не является одним из трех допустимых значений.
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.

Примечание

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

Требования

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

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

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

SetNtmsUIOptions