この章では、SQLによって使用されるルーチンについて説明します。 この章で説明するすべてのルーチンは、SQLモジュールをコールするホスト言語プログラムか、任意のSQLプリコンパイルされたプログラムからコールできます。これらのルーチンは、SQLモジュールからはコールできません。
SQLでは、OpenVMSでのすべてのルーチンは大文字で定義されます。アプリケーション・プログラムは、言語コンパイラの大/小文字の区別に関するルールに準拠し、プログラムによってルーチンが正しくコールされるようにする必要があります。 |
表5-1は、次のルーチン・セクションに表示される情報のタイプと、情報の表示に使用される形式を示しています。
セクション | 説明 |
---|---|
ルーチン名 | ページの上部に表示される。 |
概要 | ルーチン名の下に表示され、通常は1つまたは2つのセンテンスでルーチンの処理内容を説明する。 |
形式 | ルーチンのエントリ・ポイント名とルーチンの引数リストを示すとともに、引数が必須であるかオプションであるかを示す。 |
戻り値 | ルーチンから返される値を示す。 |
引数 | 各パラメータに関する詳細情報を示す。 |
説明 | ルーチンによって実行される特定のアクション、ルーチンの引数間の相互作用、特定のオペレーティング・システムのコンテキストにおけるルーチンの操作、ルーチンによって使用されるリソースに関する情報が含まれる。 |
使用方法 | アプリケーション・プログラミングに関する情報の追加部分が含まれる。 |
関連ルーチン | 関連ルーチンがリストされる。 |
例 | ルーチンを使用した例を示す。 |