Fungsi NetApiBufferFree (lmapibuf.h)

Artikel
03/14/2023

Fungsi NetApiBufferFree membebaskan memori yang dialokasikan oleh fungsi NetApiBufferAllocate . Aplikasi juga harus memanggil NetApiBufferFree untuk membebaskan memori yang digunakan fungsi manajemen jaringan lain secara internal untuk mengembalikan informasi.

Sintaks

NET_API_STATUS NET_API_FUNCTION NetApiBufferFree(
  [in] _Frees_ptr_opt_ LPVOID Buffer
);

Parameter

[in] Buffer

Penunjuk ke buffer yang dikembalikan sebelumnya oleh fungsi manajemen jaringan atau memori lain yang dialokasikan dengan memanggil fungsi NetApiBufferAllocate .

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah NERR_Success.

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

Keterangan

Fungsi NetApiBufferFree digunakan untuk membebaskan memori yang digunakan oleh fungsi manajemen jaringan. Fungsi ini digunakan dalam dua kasus:

Untuk membebaskan memori secara eksplisit dialokasikan oleh panggilan dalam aplikasi ke fungsi NetApiBufferAllocate ketika memori tidak lagi diperlukan.
Untuk membebaskan memori yang dialokasikan secara internal dengan panggilan dalam aplikasi ke fungsi manajemen jaringan yang dapat dimodifikasi yang mengembalikan informasi ke pemanggil. Pustaka run-time RPC secara internal mengalokasikan buffer yang berisi informasi pengembalian.

Banyak fungsi manajemen jaringan mengambil informasi dan mengembalikan informasi ini sebagai buffer yang mungkin berisi struktur kompleks, array struktur, atau array struktur berlapis. Fungsi-fungsi ini menggunakan pustaka run-time RPC untuk mengalokasikan buffer yang berisi informasi pengembalian secara internal, baik panggilan ke komputer lokal atau server jarak jauh. Misalnya, fungsi NetServerEnum mengambil daftar server dan mengembalikan informasi ini sebagai array struktur yang diacu oleh parameter bufptr . Ketika fungsi berhasil, memori dialokasikan secara internal oleh fungsi NetServerEnum untuk menyimpan array struktur yang dikembalikan dalam parameter bufptr ke aplikasi. Ketika array struktur ini tidak lagi diperlukan, fungsi NetApiBufferFree harus dipanggil oleh aplikasi dengan parameter Buffer yang diatur ke parameter bufptr yang dikembalikan oleh NetServerEnum untuk membebaskan memori internal yang digunakan ini. Dalam kasus ini, fungsi NetApiBufferFree membebaskan semua memori internal yang dialokasikan untuk buffer termasuk memori untuk struktur berlapis, pointer ke string, dan data lainnya.

Tidak ada keanggotaan grup khusus yang diperlukan untuk berhasil menjalankan fungsi NetApiBufferFree atau fungsi ApiBuffer lainnya.

Untuk sampel kode yang menunjukkan cara menggunakan fungsi NetApiBufferFree untuk membebaskan memori yang dialokasikan secara eksplisit oleh aplikasi, lihat fungsi NetApiBufferAllocate .

Untuk sampel kode yang menunjukkan cara menggunakan fungsi NetApiBufferFree untuk membebaskan memori yang dialokasikan secara internal oleh fungsi manajemen jaringan untuk mengembalikan informasi, lihat fungsi NetServerEnum .

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