Função RtmCreateNextHopEnum (rtmv2.h)

O RtmCreateNextHopEnum enumera os próximos saltos na lista do próximo salto.

Sintaxe

DWORD RtmCreateNextHopEnum(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_ENUM_FLAGS    EnumFlags,
  [in]  PRTM_NET_ADDRESS  NetAddress,
  [out] PRTM_ENUM_HANDLE  RtmEnumHandle
);

Parâmetros

[in] RtmRegHandle

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

[in] EnumFlags

Especifica quais próximos saltos incluir na enumeração. Os sinalizadores a seguir são usados.

[in] NetAddress

Ponteiro para uma estrutura RTM_NET_ADDRESS que contém o endereço inicial da enumeração. Especifique NULL se EnumFlags contiver RTM_ENUM_START.

[out] RtmEnumHandle

Na entrada, RtmEnumHandle é um ponteiro para NULL.

Na saída, RtmEnumHandle recebe um ponteiro para um identificador para a enumeração. Use esse identificador em todas as chamadas subsequentes para RtmGetEnumNextHops, RtmReleaseNextHops e RtmDeleteEnumHandle.

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 códigos de erro a seguir.

Comentários

Se EnumFlags contiver RTM_ENUM_RANGE, use NetAddress para especificar o intervalo da tabela de roteamento a ser enumerada. Por exemplo, se um cliente definir NetAddress como 10/8, os próximos saltos no intervalo 10.0.0.0/8 como 10.255.255.255/32 serão retornados.

Quando o identificador de enumeração não for mais necessário, libere-o chamando RtmDeleteEnumHandle.

Requisitos

Confira também

RTM_NET_ADDRESS

RtmDeleteEnumHandle

RtmGetEnumNextHops

RtmReleaseNextHops