Fonction InventoryNtmsLibrary (ntmsapi.h)

  • Article

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

La fonction InventoryNtmsLibrary met en file d’attente un inventaire de la bibliothèque spécifiée. Si la bibliothèque est occupée, RSM met en file d’attente InventoryNtmsLibrary et retourne success.

Syntaxe

DWORD InventoryNtmsLibrary(
  [in] HANDLE      hSession,
  [in] LPNTMS_GUID lpLibraryId,
  [in] DWORD       dwAction
);

Paramètres

[in] hSession

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

[in] lpLibraryId

Identificateur unique d’un objet de bibliothèque.

[in] dwAction

Action à effectuer. Ce paramètre peut prendre les valeurs suivantes.

Valeur Signification
NTMS_INVENTORY_OMID
 Un inventaire multimédia complet est effectué. Chaque côté de chaque support doit être monté dans un lecteur. Ce processus prend beaucoup de temps.
NTMS_INVENTORY_FAST
 Si un lecteur de code-barres est installé dans la bibliothèque, cet indicateur entraîne l’exécution d’un inventaire des codes barres. Si la bibliothèque n’a pas de lecteur de code-barres, cet indicateur entraîne l’exécution d’un inventaire différentiel (les emplacements sont classés).
NTMS_INVENTORY_DEFAULT
 Utilisez l’objet InventoryMethod spécifié dans l’objet de bibliothèque (voir NTMS_LIBRARYINFORMATION).
NTMS_INVENTORY_STOP
 Arrêtez l’inventaire actuel dans la bibliothèque spécifiée.

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_DEVICE_NOT_AVAILABLE
 La bibliothèque n’est actuellement pas connectée.
ERROR_INVALID_HANDLE
 La valeur spécifiée dans le paramètre hSession n’est pas valide.
ERROR_INVALID_LIBRARY
 La bibliothèque est la bibliothèque hors connexion.
ERROR_INVALID_PARAMETER
 L’ID de bibliothèque ou l’ID de session n’est pas valide.
ERROR_NOT_CONNECTED
 Impossible de se connecter au service RSM.
ERROR_SUCCESS
 La fonction a réussi.

Remarques

Les bibliothèques non présentes ne peuvent pas être inventoriés.

La fonction InventoryNtmsLibrary marque tous les emplacements qui contiennent actuellement un support dans la bibliothèque à des fins de classification/identification. La fonction InventoryNtmsLibrary retourne lorsque tous les médias sont marqués.

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

AccessNtmsLibraryDoor

Fonctions de contrôle de bibliothèque