Função EjetarNtmsCleaner (ntmsapi.h)

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

A função EjectNtmsCleaner ejeta o cartucho de limpeza do slot de limpeza atualmente reservado.

Sintaxe

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

Parâmetros

[in] hSession

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

[in] lpLibrary

Identificador exclusivo de um objeto de biblioteca.

[in, out] lpEjectOperation

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

[in] dwAction

Ação a ser executada. Esse parâmetro pode ser um dos valores a seguir.

Valor	Significado
NTMS_EJECT_START	Inicia a operação de ejeção com uma porta. O meio especificado é ejetado até que o evento de tempo limite ocorra ou a função seja chamada novamente com NTMS_EJECT_STOP. O valor de tempo limite é especificado no objeto de biblioteca e é aplicado a todas as ejeções na biblioteca.
NTMS_EJECT_STOP	Somente para bibliotecas com objetos NTMS_IEPORT. Encerra o processo de ejeção especificado por lpEjectOperation antes do tempo limite do evento.

Retornar valor

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

Valor	Significado
ERROR_ACCESS_DENIED	O acesso a um ou mais objetos RSM foi negado.
ERROR_INVALID_HANDLE	O valor fornecido 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_NO_SLOT_SET	Esta biblioteca não tem um slot mais limpo reservado.
ERROR_NOT_CONNECTED	Não é possível se conectar ao serviço RSM.
ERROR_SLOT_EMPTY	Um slot mais limpo é reservado, mas já está vazio.
ERROR_SLOT_NOT_PRESENT	Um slot mais limpo é reservado, mas o slot atualmente não está instalado na biblioteca. Esse erro ocorre quando pelo menos uma revista está ausente da biblioteca.
ERROR_SUCCESS	A função foi bem-sucedida.

Comentários

A função EjectNtmsCleaner retorna ao aplicativo assim que a solicitação de ejeção é enfileirada.

Se a biblioteca especificada na função EjectNtmsCleaner tiver um objeto NTMS_IEPORT, o RSM usará o objeto NTMS_IEPORT para ejetar o limpador. Se não houver nenhum objeto NTMS_IEPORT, o objeto NTMS_IEDOOR será usado para permitir que o operador obtenha acesso ao slot mais limpo.

Cartuchos mais limpos ejetados não são rastreados na biblioteca offline.

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

InjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot