Compartilhar via

Função RtmCreateRouteListEnum (rtmv2.h)

  • Artigo

A função RtmCreateRouteListEnum cria uma enumeração de rotas na lista de rotas especificada.

Sintaxe

DWORD RtmCreateRouteListEnum(
  [in]  RTM_ENTITY_HANDLE     RtmRegHandle,
  [in]  RTM_ROUTE_LIST_HANDLE RouteListHandle,
  [out] PRTM_ENUM_HANDLE      RtmEnumHandle
);

Parâmetros

[in] RtmRegHandle

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

[in] RouteListHandle

Manipule para a lista de rotas a ser enumerada obtida de uma chamada anterior para RtmCreateRouteList.

[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 funções que enumeram a lista de 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 seguintes códigos de erro.

Valor Significado
ERROR_NOT_ENOUGH_MEMORY
 Não há memória suficiente para concluir essa operação.
 
 

Comentários

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

Para obter o código de exemplo que usa essa função, consulte Usar uma lista de rotas Client-Specific.

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

Confira também

RtmDeleteEnumHandle

RtmGetListEnumRoutes