関数の説明形式

OpenTP1のライブラリ関数の文法を，次の形式で説明します。

〈このページの構成〉

形式

OpenTP1のライブラリ関数の形式と，引数のデータ型を示します。

ANSI Cの形式，C++言語でコーディングする場合は「ANSI C ，C++の形式」に，ANSI準拠前のK&Rの形式でコーディングする場合は「K&R版 C の形式」に従ってください。

引数に値を設定するときは，ここで示すデータ型に従ってください。特に断りがないかぎり，引数には固有の名称を任意で付けられます。

ここで説明する関数の機能について説明します。

関数の実行時に，値を指定しておく引数を示します。各引数の説明に従って，値を設定してください。引数に値を設定する場合が限られているときは，その引数の説明に値を設定する場合を【　】で示します。

関数を実行したあとに，OpenTP1から値が返される引数です。関数の実行後にこの引数の内容を参照してください。引数にOpenTP1から値が返される場合が限られているときは，その引数の説明に値が返される場合を【　】で示します。

サービス関数の場合で，クライアントUAPから値が渡される引数です。この引数の内容を参照して，サービス関数の処理をしてください。

同期応答型RPC，非同期応答型RPCの場合に，サービス関数から値が返される引数です。dc_rpc_call関数，dc_rpc_poll_any_replies関数を呼び出したUAPでは，ここに示す引数の値を参照できます。

関数を実行したときに戻ってくる値を，表形式で説明します。このリターン値によって，関数が正常に実行されたかどうかがわかります。エラーが起こったときは，エラーの内容を示します。

UAPを作成するときは，互換性を保つために，必ずここで示す定数名でリターン値を使ってください。リターン値の定数名は，ヘッダファイルで定義されています。リターンされる値の情報が必要なときは，ヘッダファイルの定義を参照してください。

指定例が必要な関数には記述します。

関数を使うときの注意について記述します。