共用方式為


ExtExtension::SetUnnamedArg 方法 (engextcpp.hpp)

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

如果自變數的類型為 Boolean則會忽略 StrArg ,而且可以是 NULL

[in] NumArg

指定未命名表示式自變數的值。 只有在自變數的類型為表達式StrArgNULL 時,才會使用 NumArg

[in] OnlyIfUnset

指定如果已經設定自變數,會發生什麼事。 如果 OnlyIfUnsettrue 且已設定自變數,則不會變更自變數。 如果 OnlyIfUnsetfalse 且已設定自變數,則會變更自變數。

傳回值

如果自變數已變更,SetUnnamedArgtrue傳回 ,false否則傳回 。

備註

如需 EngExtCpp 延伸模組架構中自變數剖析的概觀,請參閱剖析 擴充功能自變數

只有在執行這個類別所提供的擴充命令時,才應該呼叫這個方法。

規格需求

需求
目標平台 桌面
標頭 engextcpp.hpp (包括 Engextcpp.hpp)

另請參閱

EXT_COMMAND

ExtExtension