リファレンスの使い方

フレーム構成

関数リファレンスは 4 つのフレームから構成されています。

フレーム構成

フレーム A

フレーム A
ボタン 説明
トップページ クリックすると、フレーム D に関数リファレンスのトップページが表示されます。
機能別 クリックすると、フレーム B と C に機能別インデックスが表示されます。
フレーム C には、機能名以外に、概要、サンプルデモ、改訂履歴といった項目も表示されます。
機能名から関数などを探したい場合だけでなく、関数リファレンスの目次を知りたい場合にクリックしてください。
A~Z 順 クリックすると、フレーム B と C にアルファベット順インデックスが表示されます。アルファベット名から関数などを探したいときにクリックしてください。

フレーム B

フレーム A で選択した機能別またはアルファベット順のインデックスが表示されます。 調べたい項目をクリックすると、さらに詳しいインデックスがフレーム C に表示されます。

フレーム B

フレーム C

フレーム A で選択した機能別またはアルファベット順のインデックスが表示されます。 調べたい項目をクリックすると、その内容がフレーム D に表示されます。

フレーム C

機能別インデックスには、[一覧]と[全リスト]という項目があります。 [一覧]をクリックするとフレーム D に名前空間の一覧のページが表示され、[全リスト]をクリックすると、フレーム C 内にその名前空間のクラスや関数名などが表示されます。 [全リスト]は、1つの名前空間のクラスや関数を見比べたい場合に活用してください。クラスや関数名をクリックすると、フレーム D に説明のページが表示されます。

フレーム C

フレーム D

フレームCで選択した名前空間の機能一覧、クラス、メンバ関数などの説明ページが表示されます。

フレーム D

クラス説明ページの構成

フレーム D
構成要素 説明
構文 関数を使用するための宣言です。
テンプレート引数 引数に指定する値の説明です。
説明 クラスについての説明です。注意事項や補足事項もまとめて掲載しています。
型定義 型定義の説明です。
メンバ定数 メンバ定数の説明です。
メンバ変数 メンバ変数の説明です。
メンバ関数 メンバ関数の説明です。最初の列ではメンバ関数の属性をマークで示しています。属性は、○○○○、○○○、○○○があります。
継承階層 継承階層の説明です
参照 関連するほかの関数や構造体などの名称を列挙しています。
履歴 この関数説明ページの改訂履歴です。

関数説明ページの構成

フレーム D
構成要素 説明
構文 関数を使用するための宣言です。
引数 引数に指定する値の説明です。
返り値 関数からの返り値についての説明です。
説明 関数についての説明です。注意事項や補足事項もまとめて掲載しています。
参照 関連するほかの関数や構造体などの名称を列挙しています。
履歴 この関数説明ページの改訂履歴です。

履歴

2011/12/22
初版。