ARCGetValue

9/8/2008

Essa função consulta o Authentication Reset Component (ARC) para valores.

Syntax

LONG ARCGetValue(
  DWORD dwValueId,
  PVOID pInData,
  DWORD cbInData,
  PVOID pOutBuffer,
  DWORD* pcbOutBuffer
);

Parameters

• dwValueId
  [no] O valor para consulta.

• pInData
  [no] Ponteiro opcional para entrada dados. O tipo e o significado deste dados depende dwValueId. Pode ser NULL.

• cbInData
  [no] Tamanho da entrada de dados em bytes. Ignorado se for pInData NULL.

• pOutBuffer
  [out] Ponteiro para uma reserva que recebe o valor associado com dwValueId. O tipo e o significado desta reserva dependem dwValueId.

  Se estiver pOutBuffer NULL, essa função retorna ERROR_SUCCESS e armazena o tamanho do valor, em bytes, da variável apontado pelo pcbOutBuffer. Isso permite que um aplicativo para determinar a melhor maneira alocar uma reserva para dados do valor.

• pcbOutBuffer
  [in, Out] Ponteiro para uma variável que especifica o tamanho da reserva apontado pelo parâmetro de pOutBuffer, em bytes. Quando a função retorna, essa variável contém o tamanho dos dados copiados para pOutBuffer, incluindo qualquer NULL terminação caracteres.

  Se a reserva especificada no pOutBuffer não é grande o suficiente para armazenar os dados, a função retornará ERROR_MORE_DATA e armazena o exigido tamanho do buffer na variável apontado pelo pcbOutBuffer. Neste maiúsculas e minúsculas, o conteúdo de pOutBuffer é indefinido.

A seguinte tabela mostra a dwValueId Valores que podem ser consultados.

dwValueId	Descrição	pInData	pOutBuffer
AUTHRESET_VALUE_ SETUP_MESSAGE	Retorna a mensagem instalação do componente Reset de autenticação registrado. Em alguns casos, essa mensagem pode ser substituída ou aumentada pelo administrador de IT. Se o componente não fornecer uma mensagem instalação, pOutBuffer será um seqüência vazia. Esta mensagem apresenta o processo instalação Authentication Reset e alertas de usuário para qualquer requisitos (por exemplo, a parceria existente ActiveSync, conectividade rede, etc..).	Ignorado	Ponteiro de seqüência de caracteres. Pode ser uma seqüência vazia.
AUTHRESET_VALUE_ SETUPRESULT_ Mensagem	Retorna a mensagem resultado do componente Reset de autenticação registrado. Em alguns casos, essa mensagem pode ser substituída ou aumentada pelo administrador de IT. Se o componente não fornecer uma mensagem de resultados, pOutBuffer será um seqüência vazia.	HRESULT do AuthReset Setup()	Ponteiro de seqüência de caracteres. Pode ser uma seqüência vazia.
AUTHRESET_VALUE_ REQUEST_MESSAGE	Retorna a mensagem redefinir do componente Reset de autenticação registrado. Em alguns casos, essa mensagem pode ser substituída ou aumentada pelo administrador de IT. Se o componente não fornecer uma mensagem redefinir, pOutBuffer será um seqüência vazia. Esta mensagem apresenta o processo Authentication Reset e alertas de usuário para qualquer requisitos (por exemplo, a parceria existente ActiveSync, conectividade rede, etc..).	Ignorado	Ponteiro de seqüência de caracteres. Pode ser uma seqüência vazia.
AUTHRESET_VALUE_ REQUESTRESULT_ Mensagem	Retorna a mensagem resultado do componente Reset de autenticação registrado. Em alguns casos, essa mensagem pode ser substituída ou aumentada pelo administrador de IT. Se o componente não fornecer uma mensagem de resultados, pOutBuffer será um seqüência vazia.	HRESULT de Request() AuthReset	Ponteiro de seqüência de caracteres. Pode ser uma seqüência vazia.

Declaração da função com anotações

ARCGetValue extensa (DWORD dwValueId, pInData PVOID __in_bcount_opt(cbInData), cbInData DWORD, pOutBuffer PVOID __out_bcount_part_opt(*pcbOutBuffer, *pcbOutBuffer), __inout pcbOutBuffer DWORD *);

Return Value

Se a função tiver êxito, o valor de retorno será ERROR_SUCCESS.

Se a função falhar, o valor de retorno é um diferente de zero código de erro definidos no Winerror.h. Você pode usar a função FormatMessage com o sinalizador FORMAT_MESSAGE_FROM_SYSTEM para get um genérico descrição do erro. A seguinte tabela mostra the most comum códigos de erro:

• ERROR_INVALID_PARAMETER
  Um dos parâmetros contém um valor inválido. pInData pode ser o tamanho errado para entrada de dados exigido pelo dwValueId.

• ERROR_MORE_DATA
  A reserva especificada pelo parâmetro de pOutbuffer não é grande o suficiente para armazenar os dados retornados.

• ERROR_UNKNOWN_PROPERTY
  O parâmetro dwValueId não é um válido opção.

• ERROR_INVALID_DATA
  A solicitação não pôde ser atendida porque as dados subjacentes estão faltando ou inválido.

Remarks

Componentes Reset de autenticação poderá expor valores adicionais para uso por LAPs específicos (especialmente em de maiúsculas e minúsculas que o LAP e Authentication Reset Components são desenvolvidos pela mesma parte).

O usar como padrão Windows Mobile autenticação Reset componente tenta carregar seqüências de caracteres a partir de Registro. Isso permite que os administradores de TI para substituir o usar como padrão mensagens fornecido. Outros componentes Reset de autenticação pode fornecer funcionalidade semelhante.

Observação

Essa função é chamado pelo shell.Portanto, nenhuma biblioteca link é exposta.

Requirements

Header	aygshell.h
Windows Mobile	Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later, Windows Mobile 6 Standard and later
Note	This function is called by the Shell. Therefore, no link library is exposed.

See Also

Reference

Authentication Reset System Functions
Authentication Reset System Reference

Concepts

Authentication Reset System