Fungsi NetUseEnum (lmuse.h)

Artikel
03/14/2023

Fungsi NetUseEnum mencantumkan semua koneksi saat ini antara komputer lokal dan sumber daya pada server jarak jauh.

Anda juga dapat menggunakan fungsi WNetOpenEnum dan WNetEnumResource untuk menghitung sumber daya atau koneksi jaringan.

Sintaks

NET_API_STATUS NET_API_FUNCTION NetUseEnum(
  [in]      LMSTR   UncServerName,
  [in]      DWORD   LevelFlags,
  [out]     LPBYTE  *BufPtr,
  [in]      DWORD   PreferedMaximumSize,
  [out]     LPDWORD EntriesRead,
  [out]     LPDWORD TotalEntries,
  [in, out] LPDWORD ResumeHandle
);

Parameter

[in] UncServerName

Nama UNC komputer untuk menjalankan fungsi ini. Jika ini adalah parameter NULL, maka komputer lokal digunakan. Jika parameter UncServerName yang ditentukan adalah komputer jarak jauh, komputer jarak jauh harus mendukung panggilan RPC jarak jauh menggunakan mekanisme Protokol Akses Jarak Jauh warisan.

String ini adalah Unicode jika _WIN32_WINNT atau FORCE_UNICODE ditentukan.

[in] LevelFlags

Tingkat informasi data yang diminta. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Makna
0	Menentukan nama perangkat lokal dan nama berbagi sumber daya jarak jauh. Parameter BufPtr menunjuk ke array struktur USE_INFO_0 .
1	Menentukan informasi tentang koneksi antara perangkat lokal dan sumber daya bersama, termasuk status dan jenis koneksi. Parameter BufPtr menunjuk ke array struktur USE_INFO_1 .
2	Menentukan informasi tentang koneksi antara perangkat lokal dan sumber daya bersama. Informasi mencakup status koneksi, jenis koneksi, nama pengguna, dan nama domain. Parameter BufPtr menunjuk ke array struktur USE_INFO_2 .

[out] BufPtr

Penunjuk ke buffer yang menerima struktur informasi. Format data ini tergantung pada nilai parameter Tingkat . Buffer ini dialokasikan oleh sistem dan harus dikosongkan menggunakan fungsi NetApiBufferFree ketika informasi tidak lagi diperlukan. Perhatikan bahwa Anda harus membebaskan buffer meskipun fungsi gagal dengan ERROR_MORE_DATA.

[in] PreferedMaximumSize

Panjang maksimum yang disukai, dalam byte, dari data yang akan dikembalikan. Jika MAX_PREFERRED_LENGTH ditentukan, fungsi mengalokasikan jumlah memori yang diperlukan untuk data. Jika nilai lain ditentukan dalam parameter ini, nilai tersebut dapat membatasi jumlah byte yang dikembalikan fungsi. Jika ukuran buffer tidak cukup untuk menahan semua entri, fungsi akan 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] ResumeHandle

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

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan NERR_Success.

Jika fungsi gagal, nilai yang dikembalikan adalah kode kesalahan sistem. Untuk daftar kode kesalahan, lihat Kode Kesalahan Sistem.

Menampilkan kode	Deskripsi
ERROR_INVALID_PARAMETER	Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika pointer NULL diteruskan dalam parameter BufPtr atau entriesread .
ERROR_MORE_DATA	Ada lebih banyak data untuk dikembalikan. Kesalahan ini dikembalikan jika ukuran buffer tidak cukup untuk menahan semua entri.
ERROR_NOT_SUPPORTED	Permintaan tidak didukung. Kesalahan ini dikembalikan jika parameter UncServerName bukan NULL dan server jarak jauh tidak mendukung panggilan RPC jarak jauh menggunakan mekanisme Protokol Akses Jarak Jauh warisan.
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Tidak ada keanggotaan grup khusus yang diperlukan untuk memanggil fungsi NetUseEnum . Fungsi ini tidak dapat dijalankan pada server jarak jauh kecuali dalam kasus kompatibilitas tingkat bawah menggunakan Protokol Akses Jarak Jauh warisan.

Untuk mengambil informasi tentang satu koneksi jaringan, Anda dapat memanggil fungsi NetUseGetInfo .

Fungsi ini hanya berlaku untuk klien Blok Pesan Server (Stasiun Kerja Manajer LAN). Fungsi NetUseEnum tidak mendukung berbagi Sistem File Terdistribusi (DFS). Untuk menghitung berbagi menggunakan penyedia jaringan yang berbeda (WebDAV atau berbagi DFS, misalnya), gunakan fungsi WNetOpenEnum, WNetEnumResource, dan WNetCloseEnum .

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	lmuse.h (termasuk Lm.h, Lmcons.h)
Pustaka	Netapi32.lib
DLL	Netapi32.dll