Fungsi GetEnvironmentVariableW (processenv.h)

Mengambil konten variabel yang ditentukan dari blok lingkungan proses panggilan.

Sintaksis

DWORD GetEnvironmentVariableW(
  [in, optional]  LPCWSTR lpName,
  [out, optional] LPWSTR  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 null-terminated.

Ukuran maksimum variabel lingkungan yang ditentukan pengguna adalah 32.767 karakter. Tidak ada batasan teknis pada ukuran blok lingkungan. Namun, ada batas praktis tergantung pada mekanisme yang digunakan untuk mengakses blok. Misalnya, file batch tidak dapat mengatur variabel yang lebih panjang dari panjang baris perintah maksimum. Untuk informasi selengkapnya, lihat variabel lingkungan .

[in] nSize

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

Mengembalikan nilai

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

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

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

Komentar

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

Contoh

Misalnya, lihat Mengubah Variabel Lingkungan.

Nota

Header processenv.h mendefinisikan GetEnvironmentVariable sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Syarat	Nilai
klien minimum yang didukung	Windows XP [aplikasi desktop | Aplikasi UWP]
server minimum yang didukung	Windows Server 2003 [aplikasi desktop | Aplikasi UWP]
Platform Target	Windows
Header	processenv.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