ObjectScript 関数
関数は演算を実行し、値を返します。この値は、演算結果になる場合と、演算の成功または失敗を表すインジケータになる場合とがあります。規約によって、値に変数を設定する InterSystems IRIS® 関数は、変数を設定してから、演算が実行される前のその変数の値を返します。
このドキュメントでは、システム関数 (内部関数とも呼ばれます) について説明します。システム関数は、関数名の接頭語である $ 文字と、名前の後の括弧によって識別されます。ドキュメントでは関数を参照する際、括弧は指定されていません。ユーザ指定関数 (外部関数とも呼ばれます) を作成することで、これらのシステム関数を補完できます。ユーザ指定関数は、接頭語 $$ で識別されます。
ObjectScript の特殊変数名も $ 文字で始まりますが、特殊変数には括弧がありません。
ObjectScript 関数に関する全般的な詳細は、"ObjectScript の使用法" の “ObjectScript の概要” の章にある "関数" の説明を参照してください。ユーザ独自の関数の定義方法の詳細は、"ObjectScript の使用法" の "ユーザ定義コード" を参照してください。
システム関数を呼び出すには、以下の形式を使用します。
$name(arguments)
| 引数 |
説明 |
| name |
関数名。先頭にドル記号 ($) を付けます。ここでは、関数名はすべて大文字で表記されていますが、実際は大文字と小文字は区別されません。ほとんどの関数名には省略形があります。各関数の説明では、最初に完全名を使用した構文が示され、その下に略名を使用した構文が示されます (略名がある場合)。 |
| arguments |
1 つ以上の値が関数に渡されます。関数引数は、常に括弧で囲まれ、関数名の後に記述します。関数に引数がない場合も括弧は必要です。
複数の引数は、コンマで区切られています。引数は定位置にあり、関数で予期される引数と同じ順序で記述する必要があります。適切な数のコンマを提供することで、リスト内に引数が不足していることを示すことができます。引数リストの最後の引数を指定しない場合は、末尾のコンマは不要です。
スペースは、引数リストの任意の場所で許可されます。name と開き括弧文字の間には、スペースは許可されません。 |
各関数の説明には、実際に構文に使用される句読点文字のみが含まれます。構文中のオプション引数を明確にするなど、形式規約のための句読点は使用されていません。その種の情報は、説明の直後にある引数のテーブルで説明されます。
1 つの例外は省略記号 (...) です。コンマの後の省略記号は、コンマの前の引数 (または引数のグループ) が、コンマ区切りリストとして複数回繰り返し可能であることを示します。
プラットフォーム固有の関数は、関数をサポートするプラットフォーム名と共に示します。関数がプラットフォーム略語と共に示されていないときは、すべての InterSystems IRIS® プラットフォームによってサポートされます。
