Função RtmGetRegisteredEntities (rtmv2.h)

A função RtmGetRegisteredEntities retorna informações sobre todos os clientes registrados com a instância especificada do gerenciador de tabelas de roteamento e a família de endereços especificada.

Sintaxe

DWORD RtmGetRegisteredEntities(
  [in]      RTM_ENTITY_HANDLE  RtmRegHandle,
  [in, out] PUINT              NumEntities,
  [out]     PRTM_ENTITY_HANDLE EntityHandles,
  [out]     PRTM_ENTITY_INFO   EntityInfos
);

Parâmetros

[in] RtmRegHandle

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

[in, out] NumEntities

Na entrada, NumEntities é um ponteiro para um valor UINT , que especifica o número máximo de clientes que podem ser recebidos por EntityInfos. Na saída, NumEntities recebe o número real de clientes recebidos pelo EntityInfos.

[out] EntityHandles

Se os identificadores precisarem ser retornados: na entrada, EntityHandles será um ponteiro para NULL. Na saída, EntityHandles recebe um ponteiro para uma matriz de identificador de entidade; caso contrário, EntityHandles permanecerá inalterado.

Se os identificadores não precisarem ser retornados: na entrada, EntityHandles será NULL.

[out] EntityInfos

Se um ponteiro precisar ser retornado: na entrada, EntityInfos será um ponteiro para NULL. Na saída, EntityInfos recebe um ponteiro para uma matriz de estruturas de RTM_ENTITY_INFO ; caso contrário, EntityInfos permanecerá inalterado.

Se um ponteiro não precisar ser retornado: na entrada, EntityInfos será NULL.

Retornar valor

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.

Comentários

Se ERROR_INSUFFICIENT_BUFFER for retornado, poderá haver alguns dados em EntityHandles. O parâmetro NumEntities especifica quantas entidades foram realmente retornadas.

A função RtmGetRegisteredEntities pode ser usada por protocolos de roteamento para verificar quais outros protocolos estão sendo executados para essa família de endereços e a instância do gerenciador de tabelas de roteamento. Com base nas informações retornadas, um cliente pode executar o processamento específico do protocolo.

A API RTMv2 dá suporte a apenas uma instância do gerenciador de tabelas de roteamento.

Quando as entidades não forem mais necessárias, libere-as chamando RtmReleaseEntities.

Para obter o código de exemplo que usa essa função, consulte Enumerar as Entidades Registradas.

Requisitos

Confira também

RTM_ENTITY_INFO

RtmReleaseEntities