GetNtmsUIOptionsA, fonction (ntmsapi.h)

  • Article

[Le Gestionnaire de stockage amovible n’est plus disponible depuis Windows 7 et Windows Server 2008 R2.]

La fonction GetNtmsUIOptions obtient la liste des noms d’ordinateurs vers lesquels le type d’interface utilisateur spécifié est dirigé pour l’objet donné. Un appel à GetNtmsUIOptions renvoie la liste des destinations pour le instance déterminé par les paramètres lpObjectId et dwType.

S’il n’y a aucune destination dans la liste pour le instance spécifié, la fonction retourne ERROR_SUCCESS avec une longueur de liste de zéro.

Syntaxe

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

Paramètres

[in] hSession

Handle à la session retournée par la fonction OpenNtmsSession .

[in] lpObjectId

Identificateur unique de l’objet dont l’interface utilisateur est redirigée. L’objet doit être un conteneur qui peut être une source d’événements. L’objet peut être une application (une demande de montage déclenchée par l’application), une bibliothèque (une demande d’ouverture de porte en réponse à un éjection) ou un ordinateur (toute l’interface utilisateur relative à l’ordinateur).

Pour spécifier le conteneur d’ordinateur, définissez le pointeur lpObjectId pour qu’il pointe vers une mémoire tampon avec le GUID de l’objet ordinateur du Gestionnaire de stockage amovible. Pour spécifier une bibliothèque particulière, définissez-la pour qu’elle pointe vers une mémoire tampon avec le GUID de la bibliothèque. Pour spécifier une application, transmettez un pointeur NULL . L’identité de l’application est déterminée par la session utilisée dans hSession. Notez qu’une application peut avoir plusieurs sessions ouvertes simultanément. Dans ce cas, le jeu de valeurs s’applique uniquement à la session hSession .

[in] dwType

Ce paramètre peut avoir l’une des valeurs suivantes.

Valeur Signification
NTMS_UITYPE_INFO
 Messages d’interface utilisateur qui fournissent des informations. Il s’agit notamment des éléments de file d’attente de travail qui indiquent la progression. Par exemple, les demandes de montage.
NTMS_UITYPE_REQ
 Messages d’interface utilisateur qui sont des demandes. Il s’agit notamment des demandes d’opérateur qui gèrent les médias. Par exemple, une demande d’injection de nouveaux médias.
NTMS_UITYPE_ERR
 Messages d’interface utilisateur qui fournissent des informations d’erreur. Il s’agit notamment des demandes d’opérateur liées à la notification d’erreur. Par exemple, une demande de propre le lecteur.

[out] lpszDestination

Chaîne multiple qui retourne les noms des machines vers lesquelles l’interface utilisateur est redirigée. Ce paramètre ne peut pas être NULL.

[in, out] lpdwBufSize

Taille de la chaîne de destination, en TCHAR.

Valeur retournée

Cette fonction retourne l’une des valeurs suivantes.

Valeur Signification
ERROR_ACCESS_DENIED
 L’accès à un ou plusieurs objets RSM est refusé.
ERROR_INSUFFICIENT_BUFFER
 La taille de la mémoire tampon spécifiée par lpdwSize est trop petite pour les destinations trouvées. La fonction retourne la taille réelle dans lpdwSize.
ERROR_INVALID_HANDLE
 Le handle de session est manquant ou n’est pas valide.
ERROR_INVALID_PARAMETER
 Le paramètre lpdwSize ou lpszDestination est NULL, ou lpObjectId n’est pas un conteneur valide, ou dwType n’est pas l’une des trois valeurs valides.
ERROR_NOT_ENOUGH_MEMORY
 Un échec d’allocation s’est produit pendant le traitement.
ERROR_OBJECT_NOT_FOUND
 Le GUID spécifié par lpObjectId n’est pas le GUID d’un objet d’ordinateur ou de bibliothèque dans la base de données.
ERROR_SUCCESS
 La fonction a réussi.

Remarques

Un appel à GetNtmsUIOptions renvoie une liste de destinations pour un instance particulier déterminé par les paramètres lpObjectId et dwType.

  NTMS_UITYPE_INFO NTMS_UITYPE_REQ NTMS_UITYPE_ERR
Application Afficher l’interface utilisateur de progression de l’élément de travail pour les éléments de travail générés par cette application. Interface utilisateur de demande d’opérateur d’affichage pour les demandes d’opérateur générées par les actions effectuées par cette application. Non défini. Les applications ne peuvent pas provoquer ce type d’événement d’erreur.
Bibliothèque Afficher l’interface utilisateur de progression de l’élément de travail pour les éléments de travail associés à cette bibliothèque. Afficher l’interface utilisateur pour les demandes associées à cette bibliothèque. Afficher l’interface utilisateur pour les erreurs associées à cette bibliothèque.
Computer Affichez l’interface utilisateur d’informations dans cette instance de RSM en cours d’exécution sur cet ordinateur. Affichez une interface utilisateur de type requête dans cette instance de RSM. Affichez l’interface utilisateur de type d’erreur dans cette instance de RSM.
 

Notes

L’en-tête ntmsapi.h définit GetNtmsUIOptions comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. La combinaison de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête ntmsapi.h
Bibliothèque Ntmsapi.lib
DLL Ntmsapi.dll

Voir aussi

Fonctions de contrôle de bibliothèque

SetNtmsUIOptions