NTMS_OBJECTINFORMATIONA structure (ntmsapi.h)

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

La structure NTMS_OBJECTINFORMATION définit les propriétés qu’une application peut obtenir et définir pour les appareils RSM, les médias et les contrôles système (tels que les bibliothèques, les lecteurs, les médias, les demandes d’opérateur). Il s’agit de la structure commune des objets dans la base de données RSM.

Syntaxe

typedef struct _NTMS_OBJECTINFORMATIONA {
  DWORD      dwSize;
  DWORD      dwType;
  SYSTEMTIME Created;
  SYSTEMTIME Modified;
  NTMS_GUID  ObjectGuid;
  BOOL       Enabled;
  DWORD      dwOperationalState;
  CHAR       szName[NTMS_OBJECTNAME_LENGTH];
  CHAR       szDescription[NTMS_DESCRIPTION_LENGTH];
#if ...
  union {
    NTMS_DRIVEINFORMATIONA       Drive;
    NTMS_DRIVETYPEINFORMATIONA   DriveType;
    NTMS_LIBRARYINFORMATION      Library;
    NTMS_CHANGERINFORMATIONA     Changer;
    NTMS_CHANGERTYPEINFORMATIONA ChangerType;
    NTMS_STORAGESLOTINFORMATION  StorageSlot;
    NTMS_IEDOORINFORMATION       IEDoor;
    NTMS_IEPORTINFORMATION       IEPort;
    NTMS_PMIDINFORMATIONA        PhysicalMedia;
    NTMS_LMIDINFORMATION         LogicalMedia;
    NTMS_PARTITIONINFORMATIONA   Partition;
    NTMS_MEDIAPOOLINFORMATION    MediaPool;
    NTMS_MEDIATYPEINFORMATION    MediaType;
    NTMS_LIBREQUESTINFORMATIONA  LibRequest;
    NTMS_OPREQUESTINFORMATIONA   OpRequest;
    NTMS_COMPUTERINFORMATION     Computer;
  } Info;
#else
  union {
    NTMS_DRIVEINFORMATIONA       Drive;
    NTMS_DRIVETYPEINFORMATIONA   DriveType;
    NTMS_LIBRARYINFORMATION      Library;
    NTMS_CHANGERINFORMATIONA     Changer;
    NTMS_CHANGERTYPEINFORMATIONA ChangerType;
    NTMS_STORAGESLOTINFORMATION  StorageSlot;
    NTMS_IEDOORINFORMATION       IEDoor;
    NTMS_IEPORTINFORMATION       IEPort;
    NTMS_PMIDINFORMATIONA        PhysicalMedia;
    NTMS_LMIDINFORMATION         LogicalMedia;
    NTMS_PARTITIONINFORMATIONA   Partition;
    NTMS_MEDIAPOOLINFORMATION    MediaPool;
    NTMS_MEDIATYPEINFORMATION    MediaType;
    NTMS_LIBREQUESTINFORMATIONA  LibRequest;
    NTMS_OPREQUESTINFORMATIONA   OpRequest;
    NTMS_COMPUTERINFORMATION     Computer;
  } Info;
#endif
} NTMS_OBJECTINFORMATIONA, *LPNTMS_OBJECTINFORMATIONA;

Membres

dwSize

Type : DWORD

Taille de la structure d’informations, en octets. Ce membre doit être défini sur la taille correcte de la structure avant d’utiliser la fonction GetNtmsObjectInformation ou la fonction SetNtmsObjectInformation .

dwType

Type : DWORD

Type d’appareil ou de contrôle système pour lequel obtenir/définir des informations. Ce membre doit être défini sur l’une des valeurs suivantes.

Valeur Signification
NTMS_CHANGER
Un objet changeur représente l’élément robotique d’une unité de bibliothèque. Le membre Info est un pointeur vers une structure NTMS_CHANGERINFORMATION .
NTMS_CHANGER_TYPE
Un objet de type de changeur est créé pour chaque type d’appareil de changeur unique attaché à un système. Le membre Info est un pointeur vers une structure NTMS_CHANGERTYPEINFORMATION .
NTMS_COMPUTER
Objet ordinateur actuel. Il n’existe aucune structure pour l’objet ordinateur. Le membre Info est un pointeur vers une structure NTMS_COMPUTERINFORMATION .
NTMS_DRIVE
Un objet de lecteur représente un lecteur de bande ou un lecteur de disque. Le membre Info est un pointeur vers une structure NTMS_DRIVEINFORMATION .
NTMS_DRIVE_TYPE
Un objet de type de lecteur est créé pour chaque type de périphérique de lecteur unique attaché à un système. Le membre Info est un pointeur vers une structure NTMS_DRIVETYPEINFORMATION .
NTMS_IEDOOR
Un objet NTMS_IEDOOR représente le mécanisme d’accès à la porte d’une unité de bibliothèque. Le membre Info est un pointeur vers une structure NTMS_IEDOORINFORMATION .
NTMS_IEPORT
Un objet NTMS_IEPORT représente le port d’insertion/éjection d’une unité de bibliothèque. Le membre Info est un pointeur vers une structure NTMS_IEPORTINFORMATION .
NTMS_LIBRARY
Un objet de bibliothèque représente une bibliothèque en ligne ou hors connexion. Le membre Info est un pointeur vers une structure NTMS_LIBRARYINFORMATION .
NTMS_LIBREQUEST
Un objet de requête de bibliothèque est créé pour chaque demande pour qu’une bibliothèque effectue une action. RSM tient à jour la liste des demandes de bibliothèque en tant que file d’attente du travail à effectuer. Le membre Info est un pointeur vers une structure NTMS_LIBREQUESTINFORMATION .
NTMS_LOGICAL_MEDIA
Handle principal utilisé par les applications pour accéder au support spécifié. Dans le cas d’un média multidimensionné, chaque côté est traité comme un élément physique individuel. Le membre Info est un pointeur vers une structure NTMS_LMIDINFORMATION .
NTMS_MEDIA_POOL
Un pool de médias est un regroupement logique de supports. Tous les médias d’un pool de médias doivent être du même type de média. Le membre Info est un pointeur vers une structure NTMS_MEDIAPOOLINFORMATION .
NTMS_MEDIA_TYPE
Un objet de type de média est créé pour chaque type de média unique dans un système. Le membre Info est un pointeur vers une structure NTMS_MEDIATYPEINFORMATION .
NTMS_OPREQUEST
Un objet de demande d’opérateur représente une demande RSM pour qu’un utilisateur obtienne les informations. Le membre Info est un pointeur vers une structure NTMS_OPREQUESTINFORMATION .
NTMS_PARTITION
Un objet latéral représente un côté d’un élément de média physique. Le membre Info est un pointeur vers une structure NTMS_PARTITIONINFORMATION .
NTMS_PHYSICAL_MEDIA
Un objet multimédia physique représente une bande magnétique ou un disque amovible. Un support physique peut contenir un ou plusieurs côtés. Le membre Info est un pointeur vers une structure NTMS_PMIDINFORMATION .
NTMS_STORAGESLOT
Un objet d’emplacement de stockage représente l’un des emplacements qui peuvent contenir le support spécifié dans une bibliothèque. Le membre Info est un pointeur vers une structure NTMS_STORAGESLOTINFORMATION .

Created

Type : SYSTEMTIME

Horodatage de date/heure de création de l’objet.

Modified

Type : SYSTEMTIME

Horodatage de date/heure de modification de l’objet.

ObjectGuid

Type : NTMS_GUID

GUID de l’objet .

Enabled

Type : BOOL

Indique si l’objet de contrôle de l’appareil ou du système est activé.

dwOperationalState

Type : DWORD

Définit l’état opérationnel actuel de l’objet . Il peut s’agir de l’une des valeurs suivantes.

Valeur Signification
NTMS_NOT_PRESENT
Cet appareil ou cet objet n’est pas présent actuellement.
NTMS_READY
Cet appareil ou objet est disponible et prêt.
NTMS_NEEDS_SERVICE
Cet appareil ou cet objet a échoué et a besoin d’un service.

szName[NTMS_OBJECTNAME_LENGTH]

Type : TCHAR[NTMS_OBJECTNAME_LENGTH]

Nom du média, de l’appareil ou de l’objet de contrôle système. Le pool de médias et les noms de médias logiques peuvent être modifiés à l’aide de la fonction SetNtmsObjectInformation . Tous les autres noms d’objets sont en lecture seule.

szDescription[NTMS_DESCRIPTION_LENGTH]

Type : TCHAR[NTMS_DESCRIPTION_LENGTH]

Description de l’appareil ou de l’objet de contrôle système. La description des objets de contrôle système et d’appareil peut être modifiée à l’aide de la fonction SetNtmsObjectInformation . (Accessible en écriture pour tous les objets)

Info

Informations spécifiques à l’objet de contrôle de l’appareil ou du système. Le format de ces informations dépend du membre dwType .

Info.Drive

Type : NTMS_DRIVEINFORMATION Ce format est utilisé si la valeur dwType est NTMS_DRIVE.

Info.DriveType

Type : NTMS_DRIVETYPEINFORMATION Ce format est utilisé si la valeur dwType est NTMS_DRIVE_TYPE.

Info.Library

Type : NTMS_LIBRARYINFORMATION Ce format est utilisé si la valeur dwType est NTMS_LIBRARY.

Info.Changer

Type : NTMS_CHANGERINFORMATION Ce format est utilisé si la valeur dwType est NTMS_CHANGER.

Info.ChangerType

Type : NTMS_CHANGERTYPEINFORMATION Ce format est utilisé si la valeur dwType est NTMS_CHANGER_TYPE.

Info.StorageSlot

Type : NTMS_STORAGESLOTINFORMATION Ce format est utilisé si la valeur dwType est NTMS_STORAGESLOT.

Info.IEDoor

Type : NTMS_IEDOORINFORMATION Ce format est utilisé si la valeur dwType est NTMS_IEDOOR.

Info.IEPort

Type : NTMS_IEPORTINFORMATION Ce format est utilisé si la valeur dwType est NTMS_IEPORT.

Info.PhysicalMedia

Type : NTMS_PMIDINFORMATION Ce format est utilisé si la valeur dwType est NTMS_PHYSICAL_MEDIA.

Info.LogicalMedia

Type : NTMS_LMIDINFORMATION Ce format est utilisé si la valeur dwType est NTMS_LOGICAL_MEDIA.

Info.Partition

Type : NTMS_PARTITIONINFORMATION Ce format est utilisé si la valeur dwType est NTMS_PARTITION.

Info.MediaPool

Type : NTMS_MEDIAPOOLINFORMATION Ce format est utilisé si la valeur dwType est NTMS_MEDIA_POOL.

Info.MediaType

Type : NTMS_MEDIATYPEINFORMATION Ce format est utilisé si la valeur dwType est NTMS_MEDIA_TYPE.

Info.LibRequest

Type : NTMS_LIBREQUESTINFORMATION Ce format est utilisé si la valeur dwType est NTMS_LIBREQUEST.

Info.OpRequest

Type : NTMS_OPREQUESTINFORMATION Ce format est utilisé si la valeur dwType est NTMS_OPREQUEST.

Info.Computer

Remarques

Tous les membres de la structure NTMS_OBJECTINFORMATION sont en lecture seule au niveau de la fonction RSM, sauf s’ils sont spécifiés comme WRITABLE dans la définition du membre.

Notes

L’en-tête ntmsapi.h définit NTMS_OBJECTINFORMATION en tant qu’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]
En-tête ntmsapi.h

Voir aussi

GetNtmsObjectInformation

SetNtmsObjectInformation