Função RtmGetEnumRoutes (rtmv2.h)
A função RtmGetEnumRoutes recupera o próximo conjunto de rotas na enumeração especificada.
Sintaxe
DWORD RtmGetEnumRoutes(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_HANDLE EnumHandle,
[in, out] PUINT NumRoutes,
[out] PRTM_ROUTE_HANDLE RouteHandles
);
Parâmetros
[in] RtmRegHandle
Identificador para o cliente obtido de uma chamada anterior para RtmRegisterEntity.
[in] EnumHandle
Identificador para a enumeração de rota.
[in, out] NumRoutes
Na entrada, NumRoutes é um ponteiro para um valor UINT que especifica o número máximo de rotas que podem ser recebidas por RouteHandles.
Na saída, o NumRoutes recebe o número real de rotas recebidas por RouteHandles.
[out] RouteHandles
Na entrada, RouteHandles é um ponteiro para uma estrutura RTM_ROUTE_INFO .
Na saída, RouteHandles recebe uma matriz de identificadores para rotas.
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 códigos de erro a seguir.
| 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 rotas que o cliente tem permissão para recuperar com uma chamada. |
|
Não há mais rotas para enumerar. |
|
Não há memória suficiente para concluir essa operação. |
Comentários
Quando as rotas não forem mais necessárias, libere-as chamando RtmReleaseRoutes.
Para obter o código de exemplo que usa essa função, consulte Enumerar Todas as Rotas.
Requisitos
| Requisito | Valor |
|---|---|
| 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 |