Função SetNtmsUIOptionsA (ntmsapi.h)

Artigo
11/20/2024

[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 SetNtmsUIOptions modifica a lista de nomes de computador para os quais o tipo especificado de interface do usuário está sendo direcionado para o objeto fornecido.

Sintaxe

DWORD SetNtmsUIOptionsA(
  [in]  HANDLE            hSession,
  [in]  const LPNTMS_GUID lpObjectId,
  [in]  DWORD             dwType,
  [in]  DWORD             dwOperation,
  [out] LPCSTR            lpszDestination
);

Parâmetros

[in] hSession

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

[in] lpObjectId

Identificador exclusivo do objeto cuja interface do usuário está sendo redirecionada. O objeto deve ser um contêiner que pode ser uma origem para eventos. O objeto pode ser um aplicativo (uma solicitação de montagem disparada pelo aplicativo), uma biblioteca (uma solicitação de abertura de porta em resposta a uma ejeção) ou um computador (toda a interface do usuário pertencente ao computador).

Para especificar o contêiner do computador, defina o ponteiro lpObjectId para apontar para um buffer com o GUID do objeto de computador do Gerenciador de Armazenamento Removível. Para especificar uma biblioteca específica, defina-a para apontar para um buffer com o GUID da biblioteca. Para especificar um aplicativo, passe um ponteiro NULL . A identidade do aplicativo é determinada pela sessão usada em hSession. Observe que um aplicativo pode ter várias sessões abertas simultaneamente. Nesse caso, o conjunto de valores se aplica somente à sessão de de hSession. No caso de uma biblioteca ou instância de computador, as configurações persistem até serem alteradas explicitamente. As linhas do aplicativo são excluídas quando a sessão é fechada.

[in] dwType

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

Valor	Significado
NTMS_UITYPE_INFO	Mensagens de interface do usuário que fornecem informações. Eles incluem os itens da fila de trabalho que indicam progresso. Por exemplo, montar solicitações.
NTMS_UITYPE_REQ	Mensagens de interface do usuário que são solicitações. Elas incluem as solicitações de operador que manipulam a mídia. Por exemplo, uma solicitação para injetar novas mídias.
NTMS_UITYPE_ERR	Mensagens de interface do usuário que fornecem informações de erro. Elas incluem solicitações de operador relacionadas à notificação de erro. Por exemplo, uma solicitação para limpar a unidade.

[in] dwOperation

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

Valor	Significado
NTMS_UIDEST_ADD	Adicione um novo destino (nome do computador) à lista.
NTMS_UIDEST_DELETE	Remova um destino da lista.
NTMS_UIDEST_DELETEALL	Desmarque todos os destinos da lista. Nenhuma interface do usuário para o objeto é gerada. Nesse caso, o argumento de destino é ignorado.

[out] lpszDestination

Várias cadeias de caracteres que retornam os nomes dos computadores para os quais a interface do usuário está sendo redirecionada. Esse parâmetro não pode ser NULL.

Valor de retorno

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

Valor	Significado
ERROR_ACCESS_DENIED	O acesso a um ou mais objetos RSM é negado.
ERROR_ALREADY_EXISTS	O destino determinado já existe na lista.
ERROR_INVALID_HANDLE	O identificador de sessão está ausente ou não é válido.
ERROR_INVALID_PARAMETER	ponteiro lpdwSize ou lpszDestination é NULL ou lpObjectId não é um contêiner válido ou dwType ou dwOperation não é um dos três valores válidos.
ERROR_NOT_ENOUGH_MEMORY	Ocorreu uma falha de alocação durante o processamento.
ERROR_OBJECT_NOT_FOUND	O GUID especificado por lpObjectId não é o GUID de nenhum objeto de computador ou biblioteca no banco de dados.
ERROR_SUCCESS	A função foi bem-sucedida.

Observações

Uma chamada para SetNtmsUIOptions adiciona ou remove um destino para uma instância específica determinada pelos parâmetros lpObjectId e dwType.

	NTMS_UITYPE_INFO	NTMS_UITYPE_REQ	NTMS_UITYPE_ERR
Aplicação	Exibir a interface do usuário de progresso do item de trabalho para itens de trabalho gerados por este aplicativo.	Exibir a interface do usuário da solicitação do operador para solicitações de operador geradas por ações executadas por este aplicativo.	Indefinido. Os aplicativos não podem causar esse tipo de evento de erro.
Biblioteca	Exibir a interface do usuário de progresso do item de trabalho para itens de trabalho associados a essa biblioteca.	Exibir a interface do usuário para solicitações associadas a essa biblioteca.	Exiba a interface do usuário para erros associados a essa biblioteca.
Computador	Exiba a interface do usuário informativa nesta instância do RSM em execução neste computador.	Exiba uma interface do usuário do tipo solicitação nesta instância do RSM.	Exibir a interface do usuário do tipo erro nesta instância do RSM.

Observe que as verificações de segurança são executadas ao chamar SetNtmsUIOptions. Quando o objeto do computador é especificado, você precisa ter acesso com permissão para modificar o computador. Ao modificar o elemento de interface do usuário de uma biblioteca, você precisa ter acesso com permissão para modificar o objeto de biblioteca.

Observe que não há verificação de cadeias de caracteres de destino. Uma chamada com um nome de destino que não é um computador acessível do computador no qual SetNtmsUIOptions chamado retorna êxito. Um ponteiro para uma cadeia de caracteres vazia é usado para significar o computador local.

Nota

O cabeçalho ntmsapi.h define SetNtmsUIOptions como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	ntmsapi.h
biblioteca	Ntmsapi.lib
de DLL	Ntmsapi.dll

Consulte também

GetNtmsUIOptions

Funções de controle de biblioteca

Compartilhar via