スクリプト / オブジェクト リファレンスの表記

■オブジェクト リファレンスの表記

●オブジェクト メンバーの種類

オブジェクトのメンバーは以下の 3 種類に分けて説明されています。

プロパティ
オブジェクトの持つ変数。スカラーの数値、文字列、下位オブジェクト。読み出し専用や書き込み専用のものもあります。

配列的プロパティ
プロパティで複数の要素を持ち、要素の指定に添字を必要とするもの。添字は整数や文字列。Documents.Item プロパティ、Text.Item プロパティなど。

JScript の場合はプロパティの名前が Item だとすると、Item(0), Item(3, 5), Item("Name1") のような添字の付け方になるので、配列というよりもメソッド呼び出しと同じ書き方になります。

メソッド
オブジェクトの持つ関数または手続き。戻り値を返すものと返さないものがあります。

●プロパティやメソッドの型

オブジェクト リファレンスでは、プロパティの型、プロパティ添字の型、メソッドの引数/戻り値の型について、以下のような表記で説明をしています:

型の表記 説明
boolean true/false (真/偽) のどちらかの値のみを持つ
double 64 ビット浮動小数点数
int 32 ビット符号付き整数
object 各種のオブジェクト (へのリファレンス)。オブジェクトが存在しない場合の値は、JScript では null、VBScript では Nothing。
SAFEARRAY 配列。JScript では VBArray。配列添字の下限 (lower bound) は常に 0。
string 文字列
undefined 初期化されていない変数。VBScript では Empty 型。プロパティの値が存在しないことを、この型で示す場合があります。

●メソッドの省略可能引数

リファレンス中のメソッドの説明で、角カッコ [ ] でくくられている引数がありますが、これは省略可能な引数であることを示しています。例えば、Replace というメソッドの説明で

obj_var.Replace (snd_clip [, channel_mask] )

とあった場合、snd_clip は必ず与える引数、channel_mask は与えなくてもよい引数です。