NetMessageNameEnum, fonction (lmmsg.h)

Article
08/24/2023

[Cette fonction n’est pas prise en charge à partir de Windows Vista, car le service de messagerie n’est pas pris en charge.]

La fonction NetMessageNameEnum répertorie les alias de message qui reçoivent des messages sur un ordinateur spécifié. La fonction nécessite que le service de messagerie soit démarré.

Syntaxe

NET_API_STATUS NET_API_FUNCTION NetMessageNameEnum(
  [in]      LPCWSTR servername,
  [in]      DWORD   level,
  [out]     LPBYTE  *bufptr,
  [in]      DWORD   prefmaxlen,
  [out]     LPDWORD entriesread,
  [out]     LPDWORD totalentries,
  [in, out] LPDWORD resume_handle
);

Paramètres

[in] servername

Pointeur vers une chaîne constante qui spécifie le nom DNS ou NetBIOS du serveur distant sur lequel la fonction doit s’exécuter. Si ce paramètre a la valeur NULL, l’ordinateur local est utilisé.

[in] level

Spécifie le niveau d’informations des données. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
0	Retournez les alias de message. Le paramètre bufptr pointe vers un tableau de structures MSG_INFO_0 .
1	Retournez les alias de message. Le paramètre bufptr pointe vers un tableau de structures MSG_INFO_1 . Ce niveau existe uniquement pour la compatibilité. Le transfert de messages n’est pas pris en charge.

[out] bufptr

Pointeur vers la mémoire tampon qui reçoit les données. Le format de ces données dépend de la valeur du paramètre de niveau . Cette mémoire tampon est allouée par le système et doit être libérée à l’aide de la fonction NetApiBufferFree . Notez que vous devez libérer la mémoire tampon même si la fonction échoue avec ERROR_MORE_DATA.

[in] prefmaxlen

Spécifie la longueur maximale préférée des données retournées, en octets. Si vous spécifiez MAX_PREFERRED_LENGTH, la fonction alloue la quantité de mémoire requise pour les données. Si vous spécifiez une autre valeur dans ce paramètre, cela peut limiter le nombre d’octets retournés par la fonction. Si la taille de la mémoire tampon est insuffisante pour contenir toutes les entrées, la fonction retourne ERROR_MORE_DATA. Pour plus d’informations, consultez Mémoires tampons de fonction de gestion réseau et Longueurs de mémoire tampon des fonctions de gestion réseau.

[out] entriesread

Pointeur vers une valeur qui reçoit le nombre d’éléments réellement énumérés.

[out] totalentries

Pointeur vers une valeur qui reçoit le nombre total d’entrées qui auraient pu être énumérées à partir de la position actuelle du CV. Notez que les applications doivent considérer cette valeur uniquement comme un indicateur.

[in, out] resume_handle

Pointeur vers une valeur qui contient un handle de CV utilisé pour poursuivre une recherche d’alias de message existante. Le handle doit être égal à zéro lors du premier appel et rester inchangé pour les appels suivants. Si resume_handle a la valeur NULL, aucun handle de reprise n’est stocké.

Valeur retournée

Si la fonction réussit, la valeur de retour est NERR_Success.

Si la fonction échoue, la valeur de retour peut être l’un des codes d’erreur suivants.

Code de retour	Description
ERROR_ACCESS_DENIED	L’appelant n’a pas l’accès approprié pour terminer l’opération.
ERROR_INVALID_LEVEL	La valeur spécifiée pour le paramètre de niveau n’est pas valide.
ERROR_INVALID_PARAMETER	Un paramètre est incorrect.
ERROR_MORE_DATA	D’autres entrées sont disponibles. Spécifiez une mémoire tampon suffisamment grande pour recevoir toutes les entrées.
ERROR_NOT_ENOUGH_MEMORY	La mémoire disponible est insuffisante.
ERROR_NOT_SUPPORTED	Cette demande n’est pas prise en charge. Cette erreur est retournée sur Windows Vista et versions ultérieures.
NERR_BufTooSmall	La mémoire tampon fournie est trop petite.

Notes

Seuls les membres du groupe local Administrateurs peuvent exécuter correctement la fonction NetMessageNameEnum sur un serveur distant.

Pour récupérer des informations sur un alias de message particulier dans la table de nom de message, vous pouvez appeler la fonction NetMessageNameGetInfo .

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	lmmsg.h (inclure Lm.h)
Bibliothèque	Netapi32.lib
DLL	Netapi32.dll