Función EjectDiskFromSADriveA (ntmsapi.h)

  • Artículo

[El Administrador de almacenamiento extraíble ya no está disponible a partir de Windows 7 y Windows Server 2008 R2.]

La función EjectDiskFromSADrive expulsa el medio que se encuentra en una unidad extraíble independiente.

Sintaxis

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

Parámetros

[in] lpComputerName

Nombre del servidor del Administrador de almacenamiento extraíble (RSM). Si este parámetro es NULL, se usa el nombre de equipo actual.

[in] lpAppName

Cadena de caracteres única que identifica la aplicación. Este nombre identifica los recursos y las solicitudes de operador. Este parámetro es opcional y puede ser NULL.

[in] lpDeviceName

Nombre del dispositivo que se va a expulsar. Por ejemplo, \.\Cdrom0 o \.\PhysicalDriveX (donde X es el número de la unidad a la que se accede).

[in] hWnd

Identificador de una ventana de cuadro de diálogo para la confirmación del usuario.

[in] lpTitle

Título que se muestra en un cuadro de diálogo para obtener la entrada del usuario.

[in] lpMessage

Mensaje que se muestra en un cuadro de diálogo para obtener la entrada del usuario.

[in] dwOptions

Acción que se va a realizar. Este parámetro puede ser uno de los valores siguientes.

Valor Significado
NTMS_EJECT_START
 Inicie la operación de expulsión con un puerto. El medio especificado se expulsa hasta que se produce el evento de tiempo de espera o se vuelve a llamar a la función con NTMS_EJECT_STOP. El valor de tiempo de espera se especifica en el objeto de biblioteca y se aplica a todas las ejecciones de la biblioteca.
NTMS_EJECT_STOP
 Finalice el proceso de expulsión antes de que expire el evento de tiempo de espera.
NTMS_EJECT_QUEUE
 Permitir que el eject sea asincrónico. La función pone en cola el medio especificado para la ejección y, a continuación, devuelve.
NTMS_EJECT_FORCE
 Forzar la salida de los medios. Por ejemplo, NTFS puede contener bloqueos en los medios y esta opción hará que los medios se expulsen a pesar de ese bloqueo.
NTMS_EJECT_IMMEDIATE
 Expulse los medios de forma inmediata y sincrónica. La función no devolverá hasta que se complete el eject. No pone en cola los medios especificados para la ejección.
NTMS_EJECT_ASK_USER
 Expulse los medios de forma inmediata y sincrónica. La función no devolverá hasta que se complete el eject. No pone en cola los medios especificados para la ejección. Si se produce un error en la operación de expulsión, pida al usuario que cancele o fuerce la operación.

Valor devuelto

Esta función devuelve uno de los valores siguientes.

Valor Significado
ERROR_ACCESS_DENIED
 NTMS_CONTROL_ACCESS a la biblioteca se deniega. Otros errores de seguridad también son posibles, pero indicarían un error de subsistema de seguridad.
ERROR_DATABASE_FAILURE
 La base de datos es inaccesible o está dañada.
ERROR_DATABASE_FULL
 La base de datos está llena.
ERROR_DEVICE_NOT_AVAILABLE
 La biblioteca está deshabilitada.
ERROR_INVALID_HANDLE
 Falta el identificador de sesión o no es válido.
ERROR_INVALID_OPERATION
 Se realizó una detención en un identificador de operación que no era válido.
ERROR_INVALID_PARAMETER
 Falta un identificador de biblioteca o un puntero de identificador de operación.
ERROR_LIBRARY_OFFLINE
 El identificador de biblioteca hace referencia a una biblioteca sin conexión que no puede expulsar medios.
ERROR_MEDIA_NOT_AVAILABLE
 El medio está deshabilitado.
ERROR_NOT_ENOUGH_MEMORY
 Se produjo un error de asignación durante el procesamiento.
ERROR_SUCCESS
 La operación de expulsión se realizó correctamente.

Comentarios

Aunque EjectNtmsMedia puede, en algunos casos, usarse para lograr la misma funcionalidad, EjectDiskFromSADrive proporciona una manera cómoda de expulsar medios de un dispositivo independiente, especificando su nombre de unidad en lugar de su nombre de RSM. En algunos casos es la única manera de superar los bloqueos del sistema de archivos en los medios para expulsar ese medio.

La función EjectDiskFromSADrive vuelve a la aplicación tan pronto como se pone en cola la solicitud de eject, a menos que se especifique NTMS_EJECT_IMMEDIATE opción.

Los medios que se expulsan mediante la función EjectDiskFromSADrive se mueven a la biblioteca sin conexión o se eliminan de la base de datos. Los medios de importación, los medios no reconocidos y los medios incompatibles se eliminan cuando se expulsan.

La función EjectDiskFromSADrive no funciona con la biblioteca sin conexión.

Nota:

El encabezado ntmsapi.h define EjectDiskFromSADrive como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

   
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado ntmsapi.h
Library Ntmsapi.lib
Archivo DLL Ntmsapi.dll

Consulte también

EjectNtmsMedia

InjectNtmsMedia

Funciones de control de biblioteca