Função RtmGetEnumDests (rtmv2.h)
A função RtmGetEnumDests recupera o próximo conjunto de destinos na enumeração especificada.
Sintaxe
DWORD RtmGetEnumDests(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_HANDLE EnumHandle,
[in, out] PUINT NumDests,
[out] PRTM_DEST_INFO DestInfos
);
Parâmetros
[in] RtmRegHandle
Manipule para o cliente obtido de uma chamada anterior para RtmRegisterEntity.
[in] EnumHandle
Manipule para a enumeração de destino.
[in, out] NumDests
Na entrada, NumDests é um ponteiro para um valor UINT que especifica o número máximo de destinos que podem ser recebidos pelo DestInfos. Na saída, o NumDests recebe o número real de destinos recebidos pelo DestInfos.
[out] DestInfos
Na entrada, DestInfos é um ponteiro para uma estrutura RTM_DEST_INFO .
Na saída, o DestInfos recebe uma matriz de identificadores para destinos.
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 |
|---|---|
|
O valor apontado por NumRoutes é maior do que o número máximo de rotas que um cliente tem permissão para recuperar com uma chamada. Verifique RTM_REGN_PROFILE o número máximo de destinos que o cliente tem permissão para recuperar com uma chamada. |
|
Não há mais destinos para enumerar. |
Comentários
A estrutura apontada por DestInfos é uma estrutura de tamanho variável. Se o cliente especificar mais de uma exibição com TargetViews, o tamanho de DestInfos aumentará para cada exibição. Use a macro RTM_SIZE_OF_DEST_INFO para determinar o tamanho de uma estrutura DestInfos a ser alocada antes de chamar essa função. Use o valor especificado para TargetViews como um parâmetro para RTM_SIZE_OF_DEST_INFO.
Quando os destinos não forem mais necessários, libere-os chamando RtmReleaseDests.
Para obter o código de exemplo que usa essa função, consulte Enumerar Todos os Destinos.
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 |