Compartir a través de

Función EjectNtmsCleaner (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 EjectNtmsCleaner expulsa el cartucho de limpieza de la ranura de limpieza reservada actualmente.

Sintaxis

DWORD EjectNtmsCleaner(
  [in]      HANDLE      hSession,
  [in]      LPNTMS_GUID lpLibrary,
  [in, out] LPNTMS_GUID lpEjectOperation,
  [in]      DWORD       dwAction
);

Parámetros

[in] hSession

Identificador de la sesión devuelta por la función OpenNtmsSession .

[in] lpLibrary

Identificador único de un objeto de biblioteca.

[in, out] lpEjectOperation

GUID de la operación de biblioteca de procesos de expulsión. Si dwAction es NTMS_EJECT_START, este parámetro recibe el GUID de la operación. Si dwAction es NTMS_EJECT_STOP, este parámetro debe establecerse en el GUID para que se detenga la operación.

[in] dwAction

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

Valor Significado
NTMS_EJECT_START
 Inicia 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
 Solo para bibliotecas con objetos NTMS_IEPORT. Finaliza el proceso de expulsión especificado por lpEjectOperation antes de que se agote el tiempo de espera del evento.

Valor devuelto

Esta función devuelve uno de los valores siguientes.

Valor Significado
ERROR_ACCESS_DENIED
 Se deniega el acceso a uno o varios objetos RSM.
ERROR_INVALID_HANDLE
 El valor proporcionado en el parámetro hSession no es válido.
ERROR_INVALID_LIBRARY
 No se puede recuperar la definición de biblioteca de la base de datos.
ERROR_NO_SLOT_SET
 Esta biblioteca no tiene una ranura más limpia reservada.
ERROR_NOT_CONNECTED
 No se puede conectar al servicio RSM.
ERROR_SLOT_EMPTY
 Una ranura más limpia está reservada, pero ya está vacía.
ERROR_SLOT_NOT_PRESENT
 Una ranura más limpia está reservada, pero la ranura no está instalada actualmente en la biblioteca. Este error se produce cuando falta al menos una revista en la biblioteca.
ERROR_SUCCESS
 La función se realizó correctamente.

Comentarios

La función EjectNtmsCleaner vuelve a la aplicación en cuanto se pone en cola la solicitud de expulsión.

Si la biblioteca especificada en la función EjectNtmsCleaner tiene un objeto NTMS_IEPORT, RSM usa el objeto NTMS_IEPORT para expulsar el limpiador. Si no hay ningún objeto NTMS_IEPORT, se usa el objeto NTMS_IEDOOR para permitir que el operador obtenga acceso a la ranura más limpia.

No se realiza un seguimiento de los cartuchos de limpiador inyectados en la biblioteca sin conexión.

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP [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

CleanNtmsDrive

Funciones de administración de limpiadores

InjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot