Funzione RtmGetRegisteredEntities (rtmv2.h)
La funzione RtmGetRegisteredEntities restituisce informazioni su tutti i client registrati con l'istanza specificata della gestione tabelle di routing e della famiglia di indirizzi specificata.
Sintassi
DWORD RtmGetRegisteredEntities(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in, out] PUINT NumEntities,
[out] PRTM_ENTITY_HANDLE EntityHandles,
[out] PRTM_ENTITY_INFO EntityInfos
);
Parametri
[in] RtmRegHandle
Gestire il client ottenuto da una chiamata precedente a RtmRegisterEntity.
[in, out] NumEntities
In input NumEntities è un puntatore a un valore UINT , che specifica il numero massimo di client che possono essere ricevuti da EntityInfos. Nell'output NumEntities riceve il numero effettivo di client ricevuti da EntityInfos.
[out] EntityHandles
Se gli handle devono essere restituiti: in input EntityHandles è un puntatore a NULL. Nell'output , EntityHandles riceve un puntatore a una matrice di handle di entità; in caso contrario, EntityHandles rimane invariato.
Se gli handle non devono essere restituiti: in input EntityHandles è NULL.
[out] EntityInfos
Se un puntatore deve essere restituito: in input EntityInfos è un puntatore a NULL. Nell'output EntityInfos riceve un puntatore a una matrice di strutture RTM_ENTITY_INFO ; in caso contrario, EntityInfos rimane invariato.
Se non è necessario restituire un puntatore: in input EntityInfos è NULL.
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 |
|---|---|
|
Il buffer fornito non è abbastanza grande per contenere tutte le informazioni richieste. |
Commenti
Se ERROR_INSUFFICIENT_BUFFER viene restituito, potrebbero essere presenti alcuni dati in EntityHandles. Il parametro NumEntities specifica il numero di entità effettivamente restituite.
La funzione RtmGetRegisteredEntities può essere usata dai protocolli di routing per verificare quali altri protocolli sono in esecuzione per tale istanza di gestione tabelle e famiglia di indirizzi. In base alle informazioni restituite, un client può quindi eseguire un'elaborazione specifica del protocollo.
L'API RTMv2 supporta solo un'istanza della gestione tabelle di routing.
Quando le entità non sono più necessarie, rilasciarle chiamando RtmReleaseEntities.
Per codice di esempio usando questa funzione, vedere Enumerare le entità registrate.
Requisiti
| Requisito | Valore |
|---|---|
| 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 |