共用方式為

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)

另請參閱

EXT_COMMAND

ExtExtension