EjectNtmsCleaner, fonction (ntmsapi.h)

  • Article

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

La fonction EjectNtmsCleaner éjecte la cartouche de nettoyage de l’emplacement de nettoyage actuellement réservé.

Syntaxe

DWORD EjectNtmsCleaner(
  [in]      HANDLE      hSession,
  [in]      LPNTMS_GUID lpLibrary,
  [in, out] LPNTMS_GUID lpEjectOperation,
  [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] lpEjectOperation

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

[in] dwAction

Action à effectuer. Ce paramètre peut être l’une des valeurs suivantes.

Valeur Signification
NTMS_EJECT_START
 Démarre l’opération d’éjection avec un port. Le support spécifié est éjecté jusqu’à ce que l’événement de délai d’attente se produise ou que la fonction soit appelée à nouveau avec NTMS_EJECT_STOP. La valeur de délai d’attente est spécifiée dans l’objet de bibliothèque et est appliquée à toutes les éjections de la bibliothèque.
NTMS_EJECT_STOP
 Pour les bibliothèques avec des objets NTMS_IEPORT uniquement. Termine le processus d’éjection spécifié par lpEjectOperation avant laps de temps d’attente de l’événement.

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_INVALID_HANDLE
 La valeur fournie 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_NO_SLOT_SET
 Cette bibliothèque n’a pas d’emplacement plus propre réservé.
ERROR_NOT_CONNECTED
 Impossible de se connecter au service RSM.
ERROR_SLOT_EMPTY
 Un emplacement plus propre est réservé, mais il est déjà vide.
ERROR_SLOT_NOT_PRESENT
 Un emplacement plus propre est réservé, mais l’emplacement n’est actuellement pas installé dans la bibliothèque. Cette erreur se produit quand au moins un magazine est manquant dans la bibliothèque.
ERROR_SUCCESS
 La fonction a réussi.

Remarques

La fonction EjectNtmsCleaner retourne à l’application dès que la demande d’éjection est mise en file d’attente.

Si la bibliothèque spécifiée dans la fonction EjectNtmsCleaner a un objet NTMS_IEPORT, RSM utilise l’objet NTMS_IEPORT pour éjecter le nettoyeur. S’il n’existe aucun objet NTMS_IEPORT, l’objet NTMS_IEDOOR est utilisé pour permettre à l’opérateur d’accéder à l’emplacement plus propre.

Les cartouches de nettoyage éjectées ne sont pas suivies dans la bibliothèque hors connexion.

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

InjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot