ExtExtension::Metode SetArg (engextcpp.hpp)

Metode SetArg menetapkan argumen bernama untuk perintah ekstensi saat ini.

Sintaksis

bool SetArg(
  [in]           PCSTR   Name,
  [in, optional] PCSTR   StrArg,
  [in]           ULONG64 NumArg,
  [in]           bool    OnlyIfUnset
);

Parameter

[in] Name

Menentukan nama argumen.

[in, optional] StrArg

String yang menentukan nilai argumen bernama.

Jika argumen berjenis string, penunjuk ke karakter non-spasi pertama disimpan sebagai argumen. Dalam hal ini, StrArg tidak boleh NULL.

Jika argumen berjenis ekspresi , StrArg dievaluasi menggunakan evaluator ekspresi default dan nilainya menjadi nilai argumen. Dalam hal ini, StrArg dapat NULL dan NumArg digunakan sebagai gantinya.

Jika argumen berjenis boolean, StrArg diabaikan dan dapat NULL.

[in] NumArg

Menentukan nilai argumen ekspresi bernama. NumArg hanya digunakan jika jenis argumen adalah ekspresi dan StrArg null.

[in] OnlyIfUnset

Menentukan apa yang terjadi jika argumen sudah diatur. Jika OnlyIfUnset true dan argumen telah ditetapkan, argumen tidak akan diubah. Jika OnlyIfUnset false dan argumen telah ditetapkan, argumen akan diubah.

Mengembalikan nilai

SetArg mengembalikan true jika argumen diubah; false sebaliknya.

Komentar

Untuk gambaran umum penguraian argumen dalam kerangka kerja ekstensi EngExtCpp, lihat Mengurai Argumen Ekstensi.

Metode ini hanya boleh dipanggil selama eksekusi perintah ekstensi yang disediakan oleh kelas ini.

Persyaratan

Syarat	Nilai
Platform Target	Desktop
Header	engextcpp.hpp (termasuk Engextcpp.hpp)