ExtExtension::SetArg 方法 (engextcpp.hpp)
SetArg 方法會設定目前延伸模組命令的具名自變數。
語法
bool SetArg(
[in] PCSTR Name,
[in, optional] PCSTR StrArg,
[in] ULONG64 NumArg,
[in] bool OnlyIfUnset
);
參數
[in] Name
指定自變數的名稱。
[in, optional] StrArg
指定具名自變數值的字串。
如果自變數的類型 字串,則會將第一個非空格字元的指標儲存為自變數。 在這裡情況下,StrArg 不得 NULL。
如果自變數的類型 表示式,StrArg 會使用預設表達式評估工具進行評估,而值會變成自變數的值。 在此情況下,StrArg 可以改為 NULL,並改用 NumArg。
如果自變數的類型為布林值 類型,則會忽略 StrArg,而且可以 NULL。
[in] NumArg
指定具名表達式自變數的值。 只有當自變數的類型是表達式 ,而且 strArgNULL時,才會使用 NumArg。
[in] OnlyIfUnset
指定如果已經設定自變數,會發生什麼事。 如果 OnlyIfUnset 已 true
且已設定自變數,則不會變更自變數。 如果 OnlyIfUnset 已 false
且已設定自變數,則會變更自變數。
傳回值
SetArg 如果自變數已變更,則會傳回 true
;否則為 false
。
言論
如需 EngExtCpp 延伸模組架構中自變數剖析的概觀,請參閱 剖析擴充自變數。
只有在執行這個類別所提供的擴充功能命令時,才應該呼叫這個方法。
要求
要求 | 價值 |
---|---|
目標平臺 | 桌面 |
標頭 | engextcpp.hpp (包括 Engextcpp.hpp) |