SetEnvironmentVariable 函式 (winbase.h)
設定目前進程的指定環境變數內容。
語法
BOOL SetEnvironmentVariable(
[in] LPCTSTR lpName,
[in, optional] LPCTSTR lpValue
);
參數
[in] lpName
環境變數的名稱。 如果環境變數不存在,且 lpValue 不是 NULL,則操作系統會建立環境變數。
[in, optional] lpValue
環境變數的內容。 使用者定義環境變數的大小上限為32,767個字元。 如需詳細資訊,請參閱 環境變數。
Windows Server 2003 和 Windows XP: 進程的環境區塊大小總計不能超過 32,767 個字元。
如果此參數為 NULL,變數會從目前進程的環境中刪除。
傳回值
如果函式成功,則傳回非零的值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
備註
此函式不會影響系統環境變數或其他進程的環境變數。
範例
如需範例,請參閱 變更環境變數。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2003 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | winbase.h (Windows Server 2003、Windows Vista、Windows 7、Windows Server 2008 Windows Server 2008 R2) |
程式庫 | Kernel32.lib |
DLL | Kernel32.dll |