ExtExtension::SetArgStr 方法 (engextcpp.hpp)
SetArgStr 方法會設定目前表示式命令的具名字符串自變數。
語法
bool SetArgStr(
[in] PCSTR Name,
[in] PCSTR Arg,
[in] bool OnlyIfUnset
);
參數
[in] Name
指定自變數的名稱。 EXT_COMMAND 中使用的命令列描述必須指定此自變數的類型為字串。
[in] Arg
指定具名自變數值的字串。 第一個非空格字元的指標會儲存為 自變數。 在這裡情況下,Arg 不得 NULL。
[in] OnlyIfUnset
指定如果已經設定自變數,會發生什麼事。 如果 OnlyIfUnset 已 true
且已設定自變數,則不會變更自變數。 如果 OnlyIfUnset 已 false
且已設定自變數,則會變更自變數。
傳回值
SetArgStr 如果自變數已變更,則會傳回 true
;否則為 false
。
言論
如需 EngExtCpp 延伸模組架構中自變數剖析的概觀,請參閱 剖析擴充自變數。
只有在執行這個類別所提供的擴充功能命令時,才應該呼叫這個方法。
要求
要求 | 價值 |
---|---|
目標平臺 | 桌面 |
標頭 | engextcpp.hpp (包括 Engextcpp.hpp) |