Fungsi ExpandEnvironmentStringsW (processenv.h)

Artikel
06/27/2024

Memperluas string variabel lingkungan dan menggantinya dengan nilai yang ditentukan untuk pengguna saat ini.

Untuk menentukan blok lingkungan untuk pengguna atau sistem tertentu, gunakan fungsi ExpandEnvironmentStringsForUser.

Sintaksis

DWORD ExpandEnvironmentStringsW(
  [in]            LPCWSTR lpSrc,
  [out, optional] LPWSTR  lpDst,
  [in]            DWORD   nSize
);

Parameter

[in] lpSrc

Buffer yang berisi satu atau beberapa string variabel lingkungan dalam formulir: %variableName%. Untuk setiap referensi tersebut, bagian% %variableName diganti dengan nilai variabel lingkungan saat ini.

Kasus diabaikan saat mencari nama variabel lingkungan. Jika nama tidak ditemukan, bagian% %variableName dibiarkan tidak terlampaui.

Perhatikan bahwa fungsi ini tidak mendukung semua fitur yang didukung Cmd.exe. Misalnya, ini tidak mendukung%variableName :str1str2% atau %variableName:~offset,panjang%.

[out, optional] lpDst

Penunjuk ke buffer yang menerima hasil perluasan string variabel lingkungan di buffer lpSrc . Perhatikan bahwa buffer ini tidak boleh sama dengan buffer lpSrc .

[in] nSize

Jumlah maksimum karakter yang dapat disimpan dalam buffer yang ditujukkan oleh parameter lpDst . Saat menggunakan string ANSI, ukuran buffer harus panjang string, ditambah mengakhiri karakter null, ditambah satu. Saat menggunakan string Unicode, ukuran buffer harus panjang string ditambah karakter null yang mengakhiri.

Mengembalikan nilai

Jika fungsi berhasil, nilai pengembalian adalah jumlah TCHAR disimpan dalam buffer tujuan, termasuk karakter null yang mengakhiri. Jika buffer tujuan terlalu kecil untuk menahan string yang diperluas, nilai yang dikembalikan adalah ukuran buffer yang diperlukan, dalam karakter.

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

Komentar

Windows Server 2003 dan Windows XP: Ukuran lpSrc dan buffer lpDst dibatasi hingga 32K.

Untuk mengganti nama folder dalam jalur yang sepenuhnya memenuhi syarat dengan string variabel lingkungan terkait, gunakan fungsi PathUnExpandEnvStrings.

Untuk mengambil daftar variabel lingkungan untuk proses, gunakan fungsi GetEnvironmentStrings.

Contoh

Misalnya, lihat Mendapatkan Informasi Sistem.

Nota

Header processenv.h mendefinisikan ExpandEnvironmentStrings 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 2000 Professional [aplikasi desktop \| Aplikasi UWP]
server minimum yang didukung	Windows 2000 Server [aplikasi desktop \| Aplikasi UWP]
Platform Target	Windows
Header	processenv.h (termasuk Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll

Lihat juga

Variabel Lingkungan

Fungsi Informasi Sistem

Bagikan melalui