SetNtmsUIOptionsA, fonction (ntmsapi.h)

Article
11/20/2024

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

La fonction SetNtmsUIOptions modifie la liste des noms d’ordinateurs auxquels le type d’interface utilisateur spécifié est dirigé pour l’objet donné.

Syntaxe

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

Paramètres

[in] hSession

Gérez 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 pour les événements. L’objet peut être une application (une demande de montage déclenchée par l’application), une bibliothèque (une demande ouverte de porte en réponse à un éjection) ou un ordinateur (toute l’interface utilisateur relative à l’ordinateur).

Pour spécifier le conteneur d’ordinateurs, définissez le pointeur lpObjectId pour pointer 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, elle doit pointer 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. Dans le cas d’une instance de bibliothèque ou d’ordinateur, les paramètres persistent jusqu’à ce qu’ils changent explicitement. Les lignes d’application sont supprimées lorsque la session est fermée.

[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. Celles-ci incluent les éléments de file d’attente de travail qui indiquent la progression. Par exemple, monter des demandes.
NTMS_UITYPE_REQ	Messages d’interface utilisateur qui sont des demandes. Il s’agit notamment des demandes d’opérateur qui gèrent les supports. Par exemple, une demande d’injection de nouveaux supports.
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 nettoyage du lecteur.

[in] dwOperation

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

Valeur	Signification
NTMS_UIDEST_ADD	Ajoutez une nouvelle destination (nom d’ordinateur) à la liste.
NTMS_UIDEST_DELETE	Supprimez une destination de la liste.
NTMS_UIDEST_DELETEALL	Effacez toutes les destinations de la liste. Aucune interface utilisateur de l’objet n’est générée. Dans ce cas, l’argument de destination est ignoré.

[out] lpszDestination

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

Valeur de retour

Cette fonction retourne l’une des valeurs suivantes.

Valeur	Signification
ERROR_ACCESS_DENIED	L’accès à un ou plusieurs objets RSM est refusé.
ERROR_ALREADY_EXISTS	La destination donnée existe déjà dans la liste.
ERROR_INVALID_HANDLE	Le handle de session est manquant ou n’est pas valide.
ERROR_INVALID_PARAMETER	lpdwSize ou pointeur lpszDestination est NULL, ou lpObjectId n’est pas un conteneur valide, ou dwType ou dwOperation 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 ordinateur ou d’un objet de bibliothèque dans la base de données.
ERROR_SUCCESS	La fonction a réussi.

Remarques

Un appel à SetNtmsUIOptions ajoute ou supprime une destination pour une instance particulière déterminée par les paramètres lpObjectId et dwType.

	NTMS_UITYPE_INFO	NTMS_UITYPE_REQ	NTMS_UITYPE_ERR
Application	Affichez l’interface utilisateur de progression des éléments 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.	Indéfini. Les applications ne peuvent pas provoquer ce type d’événement d’erreur.
Bibliothèque	Affichez l’interface utilisateur de progression des éléments de travail pour les éléments de travail associés à cette bibliothèque.	Affichez l’interface utilisateur pour les demandes associées à cette bibliothèque.	Afficher l’interface utilisateur pour les erreurs associées à cette bibliothèque.
Ordinateur	Affichez l’interface utilisateur d’information dans cette instance de RSM s’exécutant 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.

Notez que les vérifications de sécurité sont effectuées lors de l’appel SetNtmsUIOptions. Lorsque l’objet ordinateur est spécifié, vous devez avoir accès avec l’autorisation de modifier l’ordinateur. Lors de la modification de l’élément d’interface utilisateur d’une bibliothèque, vous devez avoir accès avec l’autorisation de modifier l’objet de bibliothèque.

Notez qu’il n’existe aucune vérification des chaînes de destination. Un appel à un nom de destination qui n’est pas accessible à partir de l’ordinateur sur lequel SetNtmsUIOptions appelé renvoie la réussite. Un pointeur vers une chaîne vide est pris pour signifier l’ordinateur local.

Note

L’en-tête ntmsapi.h définit SetNtmsUIOptions 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. Le mélange 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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows XP [applications de bureau uniquement]
serveur minimum pris en charge	Windows Server 2003 [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	ntmsapi.h
bibliothèque	Ntmsapi.lib
DLL	Ntmsapi.dll

Voir aussi

GetNtmsUIOptions

fonctions de contrôle de bibliothèque

Partager via