Funzione RtmGetEnumDests (rtmv2.h)

Articolo
03/15/2023

La funzione RtmGetEnumDests recupera il set successivo di destinazioni nell'enumerazione specificata.

Sintassi

DWORD RtmGetEnumDests(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      RTM_ENUM_HANDLE   EnumHandle,
  [in, out] PUINT             NumDests,
  [out]     PRTM_DEST_INFO    DestInfos
);

Parametri

[in] RtmRegHandle

Gestire il client ottenuto da una chiamata precedente a RtmRegisterEntity.

[in] EnumHandle

Gestire l'enumerazione di destinazione.

[in, out] NumDests

In input NumDests è un puntatore a un valore UINT che specifica il numero massimo di destinazioni che possono essere ricevute da DestInfos. In output NumDests riceve il numero effettivo di destinazioni ricevute da DestInfos.

[out] DestInfos

In input, DestInfos è un puntatore a una struttura RTM_DEST_INFO .

In output, DestInfos riceve una matrice di handle alle destinazioni.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è NO_ERROR.

Se la funzione ha esito negativo, il valore restituito è uno dei codici di errore seguenti.

Valore	Significato
ERROR_INVALID_PARAMETER	Il valore a cui punta NumRoutes è maggiore del numero massimo di route consentite a un client. Controllare RTM_REGN_PROFILE per il numero massimo di destinazioni consentite al client di recuperare con una chiamata.
ERROR_NO_MORE_ITEMS	Non ci sono più destinazioni da enumerare.

Commenti

La struttura puntata da DestInfos è una struttura di dimensioni variabili. Se il client specifica più visualizzazioni con TargetViews, le dimensioni di DestInfos aumentano per ogni visualizzazione. Usare la macro RTM_SIZE_OF_DEST_INFO per determinare la quantità di una struttura DestInfos da allocare prima di chiamare questa funzione. Usare il valore specificato per TargetViews come parametro per RTM_SIZE_OF_DEST_INFO.

Quando le destinazioni non sono più necessarie, rilasciarle chiamando RtmReleaseDests.

Per codice di esempio usando questa funzione, vedere Enumerare tutte le destinazioni.

Requisiti


Client minimo supportato	Nessuno supportato
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	rtmv2.h
Libreria	Rtm.lib
DLL	Rtm.dll

Vedi anche

Condividi tramite