SetEnvironmentVariableW 函式 (processenv.h)
設定目前進程的指定環境變數內容。
語法
BOOL SetEnvironmentVariableW(
[in] LPCWSTR lpName,
[in, optional] LPCWSTR lpValue
);
參數
[in] lpName
環境變數的名稱。 如果環境變數不存在,且 lpValue 不是 NULL,則操作系統會建立環境變數。
[in, optional] lpValue
環境變數的內容。
使用者定義環境變數的大小上限為32,767個字元。 環境區塊的大小沒有技術限制。 不過,根據用來存取區塊的機制,有實際限制。 例如,批處理檔無法設定超過命令行長度上限的變數。 如需詳細資訊,請參閱 環境變數。
Windows Server 2003 和 Windows XP:進程的環境區塊大小總計不得超過 32,767 個字元。
如果此參數為 NULL,變數會從目前的進程環境中刪除。
傳回值
如果函式成功,則傳回值為非零值。
如果函式失敗,傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
言論
此函式不會影響系統環境變數或其他進程的環境變數。
例子
如需範例,請參閱 變更環境變數。
注意
processenv.h 標頭會根據 UNICODE 預處理器常數的定義,將 SetEnvironmentVariable 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows XP [傳統型應用程式 |UWP 應用程式] |
支援的最低伺服器 | Windows Server 2003 [傳統型應用程式 |UWP 應用程式] |
目標平臺 | 窗戶 |
標頭 | processenv.h (包括 Windows Server 2003、Windows Vista、Windows 7、Windows Server 2008 Windows Server 2008 R2 上的 Windows.h) |
連結庫 | Kernel32.lib |
DLL | Kernel32.dll |