Metode ExtExtension::SetArgStr (engextcpp.hpp)

Metode SetArgStr mengatur argumen string bernama untuk perintah ekspresi saat ini.

Sintaksis

bool SetArgStr(
  [in] PCSTR Name,
  [in] PCSTR Arg,
  [in] bool  OnlyIfUnset
);

Parameter

[in] Name

Menentukan nama argumen. Deskripsi baris perintah yang digunakan dalam EXT_COMMAND harus menentukan bahwa jenis argumen ini adalah string.

[in] Arg

String yang menentukan nilai argumen bernama. Penunjuk ke karakter non-spasi pertama disimpan sebagai argumen. Dalam hal ini, Arg tidak boleh 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

SetArgStr 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)

Lihat juga

EXT_COMMAND

ExtExtension