Fungsi GetEnvironmentVariable (winbase.h)

Mengambil konten variabel yang ditentukan dari blok lingkungan proses panggilan.

Sintaks

DWORD GetEnvironmentVariable(
  [in, optional]  LPCTSTR lpName,
  [out, optional] LPTSTR  lpBuffer,
  [in]            DWORD   nSize
);

Parameter

[in, optional] lpName

Nama variabel lingkungan.

[out, optional] lpBuffer

Penunjuk ke buffer yang menerima konten variabel lingkungan yang ditentukan sebagai string yang dihentikan null. Variabel lingkungan memiliki batas ukuran maksimum 32.767 karakter, termasuk karakter null-terminating.

[in] nSize

Ukuran buffer yang diacu oleh parameter lpBuffer , termasuk karakter null-terminating, dalam karakter.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan adalah jumlah karakter yang disimpan dalam buffer yang diacu oleh lpBuffer, tidak termasuk karakter null yang mengakhiri.

Jika lpBuffer tidak cukup besar untuk menyimpan data, nilai yang dikembalikan adalah ukuran buffer, dalam karakter, diperlukan untuk menahan string dan karakter null yang mengakhirinya dan konten lpBuffer tidak ditentukan.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Jika variabel lingkungan yang ditentukan tidak ditemukan di blok lingkungan, GetLastError mengembalikan ERROR_ENVVAR_NOT_FOUND.

Keterangan

Fungsi ini dapat mengambil variabel lingkungan sistem atau variabel lingkungan pengguna.

Contoh

Misalnya, lihat Mengubah Variabel Lingkungan.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows XP [aplikasi desktop | Aplikasi UWP]
Server minimum yang didukung	Windows Server 2003 [aplikasi desktop | Aplikasi UWP]
Target Platform	Windows
Header	winbase.h (termasuk Windows.h pada Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Pustaka	Kernel32.lib
DLL	Kernel32.dll

Lihat juga

Variabel Lingkungan

GetEnvironmentStrings

SetEnvironmentVariable