EjectDiskFromSADriveA, 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 EjectDiskFromSADrive éjecte le média qui se trouve dans un lecteur amovible autonome.

Syntaxe

DWORD EjectDiskFromSADriveA(
  [in] LPCSTR lpComputerName,
  [in] LPCSTR lpAppName,
  [in] LPCSTR lpDeviceName,
  [in] HWND   hWnd,
  [in] LPCSTR lpTitle,
  [in] LPCSTR lpMessage,
  [in] DWORD  dwOptions
);

Paramètres

[in] lpComputerName

Nom du serveur RSM (Gestionnaire de stockage amovible). Si ce paramètre est NULL, le nom de l’ordinateur actuel est utilisé.

[in] lpAppName

Chaîne de caractères unique qui identifie l’application. Ce nom identifie les ressources et les demandes d’opérateur. Ce paramètre est facultatif et peut être NULL.

[in] lpDeviceName

Nom de l’appareil à éjecter. Par exemple, \.\Cdrom0 ou \.\PhysicalDriveX (où X correspond au nombre du lecteur accessible).

[in] hWnd

Gérer vers une fenêtre de boîte de dialogue pour la confirmation de l’utilisateur.

[in] lpTitle

Titre affiché dans une boîte de dialogue pour obtenir une entrée utilisateur.

[in] lpMessage

Message affiché dans une boîte de dialogue pour obtenir l’entrée utilisateur.

[in] dwOptions

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

Valeur	Signification
NTMS_EJECT_START	Démarrez 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	Terminez le processus d’éjection avant l’expiration de l’événement de délai d’attente.
NTMS_EJECT_QUEUE	Autorisez l’éjection à être asynchrone. La fonction met en file d’attente le média spécifié pour l’éjection, puis retourne.
NTMS_EJECT_FORCE	Forcez le média à éjecter. Par exemple, NTFS peut contenir des verrous sur des supports, et cette option entraîne l’éjection du média malgré ce verrou.
NTMS_EJECT_IMMEDIATE	Éjectez le média immédiatement et de façon synchrone. La fonction ne retourne pas tant que l’éjection n’est pas terminée. Ne met pas en file d’attente le média spécifié pour l’éjection.
NTMS_EJECT_ASK_USER	Éjectez le média immédiatement et de façon synchrone. La fonction ne retourne pas tant que l’éjection n’est pas terminée. Ne met pas en file d’attente le média spécifié pour l’éjection. Si l’opération d’éjection échoue, invitez l’utilisateur à annuler ou à forcer l’opération.

Valeur de retour

Cette fonction retourne l’une des valeurs suivantes.

Valeur	Signification
ERROR_ACCESS_DENIED	NTMS_CONTROL_ACCESS à la bibliothèque est refusée. D’autres erreurs de sécurité sont également possibles, mais elles indiquent une erreur de sous-système de sécurité.
ERROR_DATABASE_FAILURE	La base de données est inaccessible ou endommagée.
ERROR_DATABASE_FULL	La base de données est complète.
ERROR_DEVICE_NOT_AVAILABLE	La bibliothèque est désactivée.
ERROR_INVALID_HANDLE	L’ID de session est manquant ou n’est pas valide.
ERROR_INVALID_OPERATION	Un arrêt a été effectué sur un ID d’opération qui n’était pas valide.
ERROR_INVALID_PARAMETER	Un ID de bibliothèque ou un pointeur d’ID d’opération est manquant.
ERROR_LIBRARY_OFFLINE	L’ID de bibliothèque fait référence à une bibliothèque hors connexion qui ne peut pas éjecter un média.
ERROR_MEDIA_NOT_AVAILABLE	Le média est désactivé.
ERROR_NOT_ENOUGH_MEMORY	Un échec d’allocation s’est produit pendant le traitement.
ERROR_SUCCESS	L’opération d’éjection a réussi.

Remarques

Bien que ejectNtmsMedia puisse, dans certains cas, être utilisé pour accomplir les mêmes fonctionnalités, EjectDiskFromSADrive offre un moyen pratique d’éjecter les médias à partir d’un appareil autonome, en spécifiant son nom de lecteur au lieu de son nom RSM. Dans certains cas, il s’agit de la seule façon de surmonter les verrous du système de fichiers sur le support afin d’éjecter ce média.

La fonction ejectDiskFromSADrive retourne à l’application dès que la demande d’éjection est mise en file d’attente, sauf si NTMS_EJECT_IMMEDIATE option est spécifiée.

Le média éjecté à l’aide de la fonction EjectDiskFromSADrive est déplacé vers la bibliothèque hors connexion ou supprimé de la base de données. Les médias d’importation, les médias non reconnus et les supports incompatibles sont supprimés lorsqu’ils sont éjectés.

La fonction EjectDiskFromSADrive ne fonctionne pas avec la bibliothèque hors connexion.

Note

L’en-tête ntmsapi.h définit EjectDiskFromSADrive 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 Vista [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

EjectNtmsMedia

InjectNtmsMedia

fonctions de contrôle de bibliothèque

Partager via