Función InjectNtmsCleaner (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 InjectNtmsCleaner permite insertar un cartucho más limpio en la unidad de biblioteca especificada.

Sintaxis

DWORD InjectNtmsCleaner(
  [in]      HANDLE      hSession,
  [in]      LPNTMS_GUID lpLibrary,
  [in, out] LPNTMS_GUID lpInjectOperation,
  [out]     DWORD       dwNumberOfCleansLeft,
  [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] lpInjectOperation

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

[out] dwNumberOfCleansLeft

Número de ciclos de limpieza que quedan en el cartucho de limpieza insertado.

[in] dwAction

Este parámetro puede ser uno de los valores siguientes.

Valor Significado
NTMS_INJECT_START
 Inicie la inserción con el NTMS_IEPORT o el objeto NTMS_IEDOOR. Se debe insertar un cartucho más limpio. Si se usa el objeto NTMS_IEDOOR, no se realizará ningún inventario en la biblioteca.
NTMS_INJECT_STOP
 Finaliza la inserción antes de que se agote el tiempo de espera del evento. (Solo para bibliotecas con puertos).

Valor devuelto

Esta función devuelve uno de los valores siguientes.

Valor Significado
ERROR_ACCESS_DENIED
 Se deniega el acceso a al menos un objeto RSM.
ERROR_DEVICE_NOT_AVAILABLE
 La biblioteca no está conectada actualmente.
ERROR_INVALID_HANDLE
 El valor especificado 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_LIBRARY_OFFLINE
 La biblioteca debe estar en línea para que se inserte un cartucho más limpio.
ERROR_NO_SLOT_SET
 Esta biblioteca no tiene ranura reservada como ranura más limpia.
ERROR_SLOT_FULL
 Una ranura más limpia está reservada, pero ya tiene un cartucho más limpio. El cartucho más limpio debe expulsarse primero, utilizando la función EjectNtmsCleaner .
ERROR_SLOT_NOT_PRESENT
 Una ranura más limpia está reservada, pero la ranura especificada actualmente no está instalada en la biblioteca. Este error se produce si falta al menos una revista en la biblioteca.
ERROR_SUCCESS
 La función se realizó correctamente.

Comentarios

Esta función vuelve a la aplicación en cuanto se pone en cola la solicitud de inserción.

Para utilizar la función InjectNtmsCleaner , se debe especificar el número de ciclos de limpieza que permanecen en el cartucho más limpio para que RSM pueda realizar un seguimiento de él.

Si hay disponible un objeto NTMS_IEPORT, el objeto NTMS_IEPORT dirige el cartucho a la ranura de limpieza reservada actualmente.

Si no hay ningún objeto NTMS_IEPORT, se realiza un acceso a la puerta. En este caso, el operador se dirige a colocar el medio en la ranura reservada.

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

EjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot