Fungsi SetEnvironmentVariableW (processenv.h)

Mengatur konten variabel lingkungan yang ditentukan untuk proses saat ini.

Sintaksis

BOOL SetEnvironmentVariableW(
  [in]           LPCWSTR lpName,
  [in, optional] LPCWSTR lpValue
);

Parameter

[in] lpName

Nama variabel lingkungan. Sistem operasi membuat variabel lingkungan jika tidak ada dan lpValue bukan NULL.

[in, optional] lpValue

Konten variabel lingkungan.

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 .

Windows Server 2003 dan Windows XP: Ukuran total blok lingkungan untuk proses mungkin tidak melebihi 32.767 karakter.

Jika parameter ini NULL, variabel dihapus dari lingkungan proses saat ini.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, panggil GetLastError.

Komentar

Fungsi ini tidak berpengaruh pada variabel lingkungan sistem atau variabel lingkungan dari proses lain.

Contoh

Misalnya, lihat Mengubah Variabel Lingkungan.

Nota

Header processenv.h mendefinisikan SetEnvironmentVariable 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

GetEnvironmentVariable