Función RtmGetEnumDests (rtmv2.h)
La función RtmGetEnumDests recupera el siguiente conjunto de destinos de la enumeración especificada.
Sintaxis
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
Identificador del cliente obtenido de una llamada anterior a RtmRegisterEntity.
[in] EnumHandle
Identificador de la enumeración de destino.
[in, out] NumDests
En la entrada, NumDests es un puntero a un valor UINT que especifica el número máximo de destinos que Puede recibir DestInfos. En la salida, NumDests recibe el número real de destinos recibidos por DestInfos.
[out] DestInfos
En la entrada, DestInfos es un puntero a una estructura RTM_DEST_INFO .
En la salida, DestInfos recibe una matriz de identificadores a destinos.
Valor devuelto
Si la función se realiza correctamente, el valor devuelto es NO_ERROR.
Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.
| Valor | Significado |
|---|---|
|
El valor al que apunta NumRoutes es mayor que el número máximo de rutas que un cliente puede recuperar con una llamada. Compruebe RTM_REGN_PROFILE el número máximo de destinos que el cliente puede recuperar con una llamada. |
|
No hay más destinos para enumerar. |
Comentarios
La estructura a la que apunta DestInfos es una estructura de tamaño variable. Si el cliente especifica más de una vista con TargetViews, el tamaño de DestInfos aumenta para cada vista. Use la macro RTM_SIZE_OF_DEST_INFO para determinar el tamaño de una estructura DestInfos que se va a asignar antes de llamar a esta función. Use el valor especificado para TargetViews como parámetro para RTM_SIZE_OF_DEST_INFO.
Cuando los destinos ya no sean necesarios, suéltelos llamando a RtmReleaseDests.
Para obtener código de ejemplo con esta función, vea Enumerar todos los destinos.
Requisitos
| Cliente mínimo compatible | No se admite ninguno |
| Servidor mínimo compatible | Windows 2000 Server [solo aplicaciones de escritorio] |
| Plataforma de destino | Windows |
| Encabezado | rtmv2.h |
| Library | Rtm.lib |
| Archivo DLL | Rtm.dll |