ExtExtension::SetUnnamedArgStr 方法 (engextcpp.hpp)
SetUnnamedArgStr 方法會設定目前擴充命令的未命名字符串自變數。
語法
bool SetUnnamedArgStr(
[in] ULONG Index,
[in] PCSTR Arg,
[in] bool OnlyIfUnset
);
參數
[in] Index
指定自變數的索引。 EXT_COMMAND中使用的命令列描述必須指定此自變數的類型為字串。 索引 應該介於零與未命名的自變數數目之間,如EXT_COMMAND中使用的命令行描述中所指定 - 減一。
[in] Arg
指定未命名自變數值的字串。 第一個非空格字元的指標會儲存為自變數。
[in] OnlyIfUnset
指定如果已經設定自變數,會發生什麼事。 如果 OnlyIfUnset 為 true
且自變數已經設定,則不會變更自變數。 如果 OnlyIfUnset 為 false
且自變數已設定,則會變更自變數。
傳回值
如果自變數已變更,SetUnnamedArgStr 會傳回 ,false
否則傳回 true
。
備註
如需 EngExtCpp 延伸模組架構中自變數剖析的概觀,請參閱 剖析延伸模組自變數。
只有在執行這個類別所提供的擴充命令期間,才應該呼叫這個方法。
規格需求
需求 | 值 |
---|---|
目標平台 | 桌面 |
標頭 | engextcpp.hpp (包含 Engextcpp.hpp) |