Função RtmGetOpaqueInformationPointer (rtmv2.h)

  • Artigo

A função RtmGetOpaqueInformationPointer retorna um ponteiro para o campo de informações opacas em um destino reservado para esse cliente. O ponteiro permite que o cliente armazene informações específicas do cliente com o destino na tabela de roteamento.

Sintaxe

DWORD RtmGetOpaqueInformationPointer(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_DEST_HANDLE   DestHandle,
  [out] PVOID             *OpaqueInfoPointer
);

Parâmetros

[in] RtmRegHandle

Manipule para o cliente obtido de uma chamada anterior para RtmRegisterEntity.

[in] DestHandle

Manipule para o destino.

[out] OpaqueInfoPointer

Na entrada, OpaqueInfoPointer é um ponteiro para NULL.

Na saída, OpaqueInfoPointer recebe um ponteiro para o ponteiro de informações opaco. Se um cliente não tiver reservado um ponteiro opaco durante o registro, esse parâmetro permanecerá inalterado.

Valor retornado

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro.

Valor Significado
ERROR_INVALID_HANDLE
 O manipulador é inválido.
ERROR_NOT_FOUND
 Nenhum ponteiro opaco foi reservado pelo cliente.
 
 

Comentários

Para obter o código de exemplo que usa essa função, consulte Acessar o ponteiro opaco em um destino.

Requisitos

   
Cliente mínimo com suporte Nenhum compatível
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho rtmv2.h
Biblioteca Rtm.lib
DLL Rtm.dll

Confira também

RtmLockDestination