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