Función GetNtmsUIOptionsA (ntmsapi.h)

  • Artículo

[El Administrador de almacenamiento extraíble ya no está disponible a partir de Windows 7 y Windows Server 2008 R2.]

La función GetNtmsUIOptions obtiene la lista de nombres de equipo a los que se dirige el tipo especificado de interfaz de usuario para el objeto especificado. Una llamada a GetNtmsUIOptions devuelve la lista de destinos de la instancia determinada por los parámetros lpObjectId y dwType .

Si no hay destinos en la lista para la instancia especificada, la función devuelve ERROR_SUCCESS junto con una longitud de lista de cero.

Sintaxis

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

Parámetros

[in] hSession

Identificador de la sesión devuelta por la función OpenNtmsSession .

[in] lpObjectId

Identificador único del objeto cuya interfaz de usuario se redirige. El objeto debe ser un contenedor que puede ser un origen para los eventos. El objeto puede ser una aplicación (una solicitud de montaje desencadenada por la aplicación), una biblioteca (una solicitud abierta de puerta en respuesta a un eject) o un equipo (toda la interfaz de usuario que pertenece al equipo).

Para especificar el contenedor de equipos, establezca el puntero lpObjectId para que apunte a un búfer con el GUID del objeto de equipo del Administrador de almacenamiento extraíble. Para especificar una biblioteca determinada, establézquela para que apunte a un búfer con el GUID de la biblioteca. Para especificar una aplicación, pase un puntero NULL . La identidad de la aplicación viene determinada por la sesión usada en hSession. Tenga en cuenta que una aplicación puede tener varias sesiones abiertas simultáneamente. En este caso, el conjunto de valores solo se aplica a la sesión de hSession .

[in] dwType

Este parámetro puede tener uno de los siguientes valores.

Valor Significado
NTMS_UITYPE_INFO
 Mensajes de interfaz de usuario que proporcionan información. Estos incluyen los elementos de la cola de trabajo que indican el progreso. Por ejemplo, monte las solicitudes.
NTMS_UITYPE_REQ
 Mensajes de interfaz de usuario que son solicitudes. Entre ellas se incluyen las solicitudes de operador que controlan los medios. Por ejemplo, una solicitud para insertar nuevos medios.
NTMS_UITYPE_ERR
 Mensajes de interfaz de usuario que proporcionan información de error. Entre ellas se incluyen las solicitudes de operador relacionadas con la notificación de errores. Por ejemplo, una solicitud para limpiar la unidad.

[out] lpszDestination

Cadena múltiple que devuelve los nombres de las máquinas a las que se redirige la interfaz de usuario. Este parámetro no puede ser NULL.

[in, out] lpdwBufSize

Tamaño de la cadena de destino, en TCHAR.

Valor devuelto

Esta función devuelve uno de los valores siguientes.

Valor Significado
ERROR_ACCESS_DENIED
 Se deniega el acceso a uno o varios objetos RSM.
ERROR_INSUFFICIENT_BUFFER
 El tamaño del búfer especificado por lpdwSize es demasiado pequeño para los destinos encontrados. La función devuelve el tamaño real en lpdwSize.
ERROR_INVALID_HANDLE
 Falta el identificador de sesión o no es válido.
ERROR_INVALID_PARAMETER
 El parámetro lpdwSize o lpszDestination es NULL, o lpObjectId no es un contenedor válido o dwType no es uno de los tres valores válidos.
ERROR_NOT_ENOUGH_MEMORY
 Error de asignación durante el procesamiento.
ERROR_OBJECT_NOT_FOUND
 El GUID especificado por lpObjectId no es el GUID de ningún equipo o objeto de biblioteca en la base de datos.
ERROR_SUCCESS
 La función se realizó correctamente.

Comentarios

Una llamada a GetNtmsUIOptions devuelve una lista de destinos para una instancia determinada determinada determinada por los parámetros lpObjectId y dwType .

  NTMS_UITYPE_INFO NTMS_UITYPE_REQ NTMS_UITYPE_ERR
Application Muestra la interfaz de usuario de progreso del elemento de trabajo para los elementos de trabajo generados por esta aplicación. Muestra la interfaz de usuario de solicitud de operador para las solicitudes de operador generadas por las acciones realizadas por esta aplicación. Sin definir. Las aplicaciones no pueden provocar este tipo de evento de error.
Biblioteca Mostrar la interfaz de usuario de progreso del elemento de trabajo para los elementos de trabajo asociados a esta biblioteca. Mostrar la interfaz de usuario para las solicitudes asociadas a esta biblioteca. Mostrar la interfaz de usuario para ver los errores asociados a esta biblioteca.
Computer Mostrar la interfaz de usuario informativa en esta instancia de RSM que se ejecuta en esta máquina. Muestra una interfaz de usuario de tipo de solicitud en esta instancia de RSM. Muestra la interfaz de usuario de tipo error en esta instancia de RSM.
 

Nota

El encabezado ntmsapi.h define GetNtmsUIOptions como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado ntmsapi.h
Library Ntmsapi.lib
Archivo DLL Ntmsapi.dll

Consulte también

Funciones de control de biblioteca

SetNtmsUIOptions