Fungsi NetMessageNameEnum (lmmsg.h)

Artikel
03/14/2023

[Fungsi ini tidak didukung pada Windows Vista karena layanan messenger tidak didukung.]

Fungsi NetMessageNameEnum mencantumkan alias pesan yang menerima pesan di komputer tertentu. Fungsi ini mengharuskan layanan messenger dimulai.

Sintaks

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

Penunjuk ke string konstanta yang menentukan nama DNS atau NetBIOS dari server jarak jauh tempat fungsi akan dijalankan. Jika parameter ini NULL, komputer lokal akan digunakan.

[in] level

Menentukan tingkat informasi data. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Makna
0	Mengembalikan alias pesan. Parameter bufptr menunjuk ke array struktur MSG_INFO_0 .
1	Mengembalikan alias pesan. Parameter bufptr menunjuk ke array struktur MSG_INFO_1 . Tingkat ini hanya ada untuk kompatibilitas. Penerusan pesan tidak didukung.

[out] bufptr

Arahkan ke buffer yang menerima data. Format data ini tergantung pada nilai parameter tingkat . Buffer ini dialokasikan oleh sistem dan harus dibebaskan menggunakan fungsi NetApiBufferFree . Perhatikan bahwa Anda harus membebaskan buffer meskipun fungsi gagal dengan ERROR_MORE_DATA.

[in] prefmaxlen

Menentukan panjang maksimum yang diinginkan dari data yang dikembalikan, dalam byte. Jika Anda menentukan MAX_PREFERRED_LENGTH, fungsi mengalokasikan jumlah memori yang diperlukan untuk data. Jika Anda menentukan nilai lain dalam parameter ini, nilai tersebut dapat membatasi jumlah byte yang dikembalikan fungsi. Jika ukuran buffer tidak cukup untuk menahan semua entri, fungsi mengembalikan ERROR_MORE_DATA. Untuk informasi selengkapnya, lihat Buffer Fungsi Manajemen Jaringan dan Panjang Buffer Fungsi Manajemen Jaringan.

[out] entriesread

Penunjuk ke nilai yang menerima hitungan elemen yang benar-benar dijumlahkan.

[out] totalentries

Penunjuk ke nilai yang menerima jumlah total entri yang bisa dijumlahkan dari posisi resume saat ini. Perhatikan bahwa aplikasi harus mempertimbangkan nilai ini hanya sebagai petunjuk.

[in, out] resume_handle

Penunjuk ke nilai yang berisi handel resume yang digunakan untuk melanjutkan pencarian alias pesan yang sudah ada. Handel harus nol pada panggilan pertama dan dibiarkan tidak berubah untuk panggilan berikutnya. Jika resume_handleNULL, tidak ada handel resume yang disimpan.

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah NERR_Success.

Jika fungsi gagal, nilai yang dikembalikan dapat menjadi salah satu kode kesalahan berikut.

Menampilkan kode	Deskripsi
ERROR_ACCESS_DENIED	Pemanggil tidak memiliki akses yang sesuai untuk menyelesaikan operasi.
ERROR_INVALID_LEVEL	Nilai yang ditentukan untuk parameter tingkat tidak valid.
ERROR_INVALID_PARAMETER	Parameter salah.
ERROR_MORE_DATA	Entri lainnya tersedia. Tentukan buffer yang cukup besar untuk menerima semua entri.
ERROR_NOT_ENOUGH_MEMORY	Memori tidak cukup tersedia.
ERROR_NOT_SUPPORTED	Permintaan ini tidak didukung. Kesalahan ini dikembalikan pada Windows Vista dan yang lebih baru.
NERR_BufTooSmall	Buffer yang disediakan terlalu kecil.

Keterangan

Hanya anggota grup lokal Administrator yang berhasil menjalankan fungsi NetMessageNameEnum di server jarak jauh.

Untuk mengambil informasi tentang alias pesan tertentu dalam tabel nama pesan, Anda dapat memanggil fungsi NetMessageNameGetInfo .

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	lmmsg.h (termasuk Lm.h)
Pustaka	Netapi32.lib
DLL	Netapi32.dll