InjectNtmsCleaner, fonction (ntmsapi.h)

Article
08/25/2023

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

La fonction InjectNtmsCleaner permet d’insérer une cartouche plus propre dans l’unité de bibliothèque spécifiée.

Syntaxe

DWORD InjectNtmsCleaner(
  [in]      HANDLE      hSession,
  [in]      LPNTMS_GUID lpLibrary,
  [in, out] LPNTMS_GUID lpInjectOperation,
  [out]     DWORD       dwNumberOfCleansLeft,
  [in]      DWORD       dwAction
);

Paramètres

[in] hSession

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

[in] lpLibrary

Identificateur unique d’un objet de bibliothèque.

[in, out] lpInjectOperation

GUID de l’opération d’insertion de bibliothèque de processus. Si dwAction est NTMS_INJECT_START, ce paramètre reçoit le GUID de l’opération. Si dwAction est NTMS_INJECT_STOP, ce paramètre doit être défini sur le GUID pour que l’opération soit arrêtée.

[out] dwNumberOfCleansLeft

Nombre de cycles de nettoyage restants sur la cartouche de nettoyage insérée.

[in] dwAction

Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
NTMS_INJECT_START	Démarrez l’insertion avec l’objet NTMS_IEPORT ou NTMS_IEDOOR. Une seule cartouche plus propre doit être insérée. Si l’objet NTMS_IEDOOR est utilisé, aucun inventaire n’est effectué sur la bibliothèque.
NTMS_INJECT_STOP	Met fin à l’insertion avant le délai d’attente de l’événement. (Pour les bibliothèques avec des ports uniquement.)

Valeur retournée

Cette fonction retourne l’une des valeurs suivantes.

Valeur	Signification
ERROR_ACCESS_DENIED	L’accès à au moins un objet 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	Impossible de récupérer la définition de bibliothèque à partir de la base de données.
ERROR_LIBRARY_OFFLINE	La bibliothèque doit être en ligne pour qu’une cartouche plus propre soit insérée.
ERROR_NO_SLOT_SET	Cette bibliothèque n’a aucun emplacement réservé en tant qu’emplacement plus propre.
ERROR_SLOT_FULL	Un emplacement plus propre est réservé, mais a déjà une cartouche plus propre. La cartouche de nettoyage doit d’abord être éjectée à l’aide de la fonction EjectNtmsCleaner .
ERROR_SLOT_NOT_PRESENT	Un emplacement plus propre est réservé, mais l’emplacement spécifié n’est actuellement pas installé dans la bibliothèque. Cette erreur se produit si au moins un magazine est manquant dans la bibliothèque.
ERROR_SUCCESS	La fonction a réussi.

Remarques

Cette fonction retourne à l’application dès que la demande d’insertion est mise en file d’attente.

Pour utiliser la fonction InjectNtmsCleaner , le nombre de cycles de nettoyage qui restent sur la cartouche de nettoyage doit être spécifié afin que RSM puisse effectuer le suivi de celle-ci.

Si un objet NTMS_IEPORT est disponible, l’objet NTMS_IEPORT dirige la cartouche vers l’emplacement de nettoyage actuellement réservé.

S’il n’y a pas d’objet NTMS_IEPORT, un accès à la porte est effectué. Dans ce cas, l’opérateur est dirigé pour placer le média dans l’emplacement réservé.

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

CleanNtmsDrive

Fonctions de gestion plus propres

EjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot

Partager via