Função InjectNtmsCleaner (ntmsapi.h)

  • Artigo

[O Gerenciador de Armazenamento Removível não está mais disponível a partir do Windows 7 e do Windows Server 2008 R2.]

A função InjectNtmsCleaner permite que um cartucho mais limpo seja inserido na unidade de biblioteca especificada.

Sintaxe

DWORD InjectNtmsCleaner(
  [in]      HANDLE      hSession,
  [in]      LPNTMS_GUID lpLibrary,
  [in, out] LPNTMS_GUID lpInjectOperation,
  [out]     DWORD       dwNumberOfCleansLeft,
  [in]      DWORD       dwAction
);

Parâmetros

[in] hSession

Manipule para a sessão retornada pela função OpenNtmsSession .

[in] lpLibrary

Identificador exclusivo de um objeto de biblioteca.

[in, out] lpInjectOperation

GUID da operação inserir biblioteca de processos. Se dwAction for NTMS_INJECT_START, esse parâmetro receberá o GUID da operação. Se dwAction for NTMS_INJECT_STOP, esse parâmetro deverá ser definido como GUID para que a operação seja interrompida.

[out] dwNumberOfCleansLeft

Número de ciclos de limpeza restantes no cartucho de limpeza inserido.

[in] dwAction

Esse parâmetro pode usar um dos valores a seguir.

Valor Significado
NTMS_INJECT_START
 Inicie a inserção com o NTMS_IEPORT ou o objeto NTMS_IEDOOR. Um único cartucho de limpeza deve ser inserido. Se o objeto NTMS_IEDOOR for usado, nenhum inventário será executado na biblioteca.
NTMS_INJECT_STOP
 Encerra a inserção antes da volta do evento de tempo limite. (Somente para bibliotecas com portas.)

Retornar valor

Essa função retorna um dos valores a seguir.

Valor Significado
ERROR_ACCESS_DENIED
 O acesso a pelo menos um objeto RSM é negado.
ERROR_DEVICE_NOT_AVAILABLE
 No momento, a biblioteca não está conectada.
ERROR_INVALID_HANDLE
 O valor especificado no parâmetro hSession não é válido.
ERROR_INVALID_LIBRARY
 Não é possível recuperar a definição de biblioteca do banco de dados.
ERROR_LIBRARY_OFFLINE
 A biblioteca deve estar online para que um cartucho mais limpo seja inserido.
ERROR_NO_SLOT_SET
 Essa biblioteca não tem nenhum slot reservado como um slot mais limpo.
ERROR_SLOT_FULL
 Um slot mais limpo é reservado, mas já tem um cartucho mais limpo. O cartucho mais limpo deve ser ejetado primeiro, usando a função EjectNtmsCleaner .
ERROR_SLOT_NOT_PRESENT
 Um slot mais limpo é reservado, mas o slot especificado atualmente não está instalado na biblioteca. Esse erro ocorrerá se pelo menos uma revista estiver ausente na biblioteca.
ERROR_SUCCESS
 A função foi bem-sucedida.

Comentários

Essa função retorna ao aplicativo assim que a solicitação de inserção é enfileirada.

Para usar a função InjectNtmsCleaner , o número de ciclos de limpeza que permanecem no cartucho mais limpo deve ser especificado para que o RSM possa controlá-lo.

Se um objeto NTMS_IEPORT estiver disponível, o objeto NTMS_IEPORT direcionará o cartucho para o slot de limpeza reservado no momento.

Se não houver nenhum objeto NTMS_IEPORT, um acesso à porta será executado. Nesse caso, o operador é direcionado para colocar a mídia no slot reservado.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho ntmsapi.h
Biblioteca Ntmsapi.lib
DLL Ntmsapi.dll

Confira também

CleanNtmsDrive

Funções de gerenciamento mais limpas

EjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot