NetMessageNameEnum-Funktion (lmmsg.h)

Artikel
08/24/2023

[Diese Funktion wird ab Windows Vista nicht unterstützt, da der Messengerdienst nicht unterstützt wird.]

Die NetMessageNameEnum-Funktion listet die Nachrichtenaliasen auf, die Nachrichten auf einem angegebenen Computer empfangen. Die Funktion erfordert, dass der Messenger-Dienst gestartet wird.

Syntax

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
);

Parameter

[in] servername

Zeiger auf eine konstante Zeichenfolge, die den DNS- oder NetBIOS-Namen des Remoteservers angibt, auf dem die Funktion ausgeführt werden soll. Wenn dieser Parameter NULL ist, wird der lokale Computer verwendet.

[in] level

Gibt die Informationsebene der Daten an. Dieser Parameter kann einen der folgenden Werte annehmen.

Wert	Bedeutung
0	Zurückgeben von Nachrichtenaliasen. Der bufptr-Parameter verweist auf ein Array von MSG_INFO_0 Strukturen.
1	Zurückgeben von Nachrichtenaliasen. Der parameter bufptr verweist auf ein Array von MSG_INFO_1 Strukturen. Diese Ebene ist nur aus Kompatibilitätsgründen vorhanden. Die Nachrichtenweiterleitung wird nicht unterstützt.

[out] bufptr

Zeiger auf den Puffer, der die Daten empfängt. Das Format dieser Daten hängt vom Wert des level-Parameters ab. Dieser Puffer wird vom System zugeordnet und muss mithilfe der NetApiBufferFree-Funktion freigegeben werden. Beachten Sie, dass Sie den Puffer auch dann freigeben müssen, wenn die Funktion mit ERROR_MORE_DATA fehlschlägt.

[in] prefmaxlen

Gibt die bevorzugte maximale Länge der zurückgegebenen Daten in Bytes an. Wenn Sie MAX_PREFERRED_LENGTH angeben, ordnet die Funktion den für die Daten erforderlichen Arbeitsspeicher zu. Wenn Sie in diesem Parameter einen anderen Wert angeben, kann er die Anzahl der Bytes einschränken, die die Funktion zurückgibt. Wenn die Puffergröße nicht ausreicht, um alle Einträge aufzunehmen, gibt die Funktion ERROR_MORE_DATA zurück. Weitere Informationen finden Sie unter Netzwerkverwaltungsfunktionspuffer und Netzwerkverwaltungsfunktionspufferlängen.

[out] entriesread

Zeiger auf einen Wert, der die Anzahl der tatsächlich aufgezählten Elemente empfängt.

[out] totalentries

Zeiger auf einen Wert, der die Gesamtzahl der Einträge empfängt, die aus der aktuellen Position des Lebenslaufs hätten aufgezählt werden können. Beachten Sie, dass Anwendungen diesen Wert nur als Hinweis betrachten sollten.

[in, out] resume_handle

Zeiger auf einen Wert, der ein Resume-Handle enthält, das verwendet wird, um eine vorhandene Nachrichtenaliassuche fortzusetzen. Das Handle sollte beim ersten Aufruf null sein und für nachfolgende Aufrufe unverändert bleiben. Wenn resume_handleNULL ist, wird kein Resume-Handle gespeichert.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NERR_Success.

Wenn die Funktion fehlschlägt, kann der Rückgabewert einer der folgenden Fehlercodes sein.

Rückgabecode	Beschreibung
ERROR_ACCESS_DENIED	Der Aufrufer hat nicht den entsprechenden Zugriff, um den Vorgang abzuschließen.
ERROR_INVALID_LEVEL	Der für den level-Parameter angegebene Wert ist ungültig.
ERROR_INVALID_PARAMETER	Ein Parameter ist falsch.
ERROR_MORE_DATA	Weitere Einträge sind verfügbar. Geben Sie einen ausreichend großen Puffer an, um alle Einträge zu empfangen.
ERROR_NOT_ENOUGH_MEMORY	Nicht genügend Arbeitsspeicher ist verfügbar.
ERROR_NOT_SUPPORTED	Diese Anforderung wird nicht unterstützt. Dieser Fehler wird unter Windows Vista und höher zurückgegeben.
NERR_BufTooSmall	Der bereitgestellte Puffer ist zu klein.

Hinweise

Nur Mitglieder der lokalen Gruppe Administratoren können die NetMessageNameEnum-Funktion erfolgreich auf einem Remoteserver ausführen.

Um Informationen zu einem bestimmten Nachrichtenalias in der Nachrichtennamentabelle abzurufen, können Sie die NetMessageNameGetInfo-Funktion aufrufen.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	lmmsg.h (lm.h einschließen)
Bibliothek	Netapi32.lib
DLL	Netapi32.dll