ObjectScript 関数

関数は演算を実行し、値を返します。この値は、演算結果になる場合と、演算の成功または失敗を表すインジケータになる場合とがあります。規約によって、値に変数を設定する Caché 関数は、変数を設定してから、演算が実行される前のその変数の値を返します。

このドキュメントでは、システム関数 (内部関数とも呼ばれます) について説明します。システム関数は、関数名の接頭語である $ 文字と、名前の後の括弧によって識別されます。ドキュメントでは関数を参照する際、括弧は指定されていません。ユーザ指定関数 (外部関数とも呼ばれます) を作成することで、これらのシステム関数を補完できます。ユーザ指定関数は、接頭語 $$ で識別されます。

ObjectScript の特殊変数名も $ 文字で始まりますが、特殊変数には括弧がありません。

ObjectScript の $ZUTIL ($ZU) 関数は非推奨となっているため、ドキュメントには記載されなくなりました。$ZUTIL 置換リストで適切な代替機能を見つけてください。

非推奨の ObjectScript 関数は、従来の関数として別個にリストされています。これらの関数は、新しいコーディングには使用しないでください。

ObjectScript 関数に関する全般的な詳細は、"ObjectScript の使用法" の “ObjectScript の概要” の章にある "関数" の説明を参照してください。ユーザ独自の関数の定義方法の詳細は、"ObjectScript の使用法" の "ユーザ定義コード" を参照してください。

システム関数を呼び出すには、以下の形式を使用します。

$name(parameters)

name

関数名。先頭にドル記号 ($) を付けます。ここでは、関数名はすべて大文字で表記されていますが、実際は大文字と小文字は区別されません。ほとんどの関数名には省略形があります。各関数の説明では、最初に完全名を使用した構文が示され、その下に略名を使用した構文が示されます (略名がある場合)。

parameters

1 つ以上の値が関数に渡されます。関数引数、つまりパラメータは、常に括弧で囲まれ、関数名の後に記述します。関数にパラメータがない場合も括弧は必要です。

複数のパラメータは、コンマで区切られています。パラメータは定位置にあり、関数で予期されるパラメータと同じ順序で記述する必要があります。適切な数のコンマを提供することで、リスト内にパラメータが不足していることを示すことができます。パラメータ・リストの最後のパラメータを指定しない場合は、末尾のコンマは不要です。

スペースは、パラメータ・リストの任意の場所で許可されます。name と開き括弧文字の間には、スペースは許可されません。

各関数の説明には、実際に構文に使用される句読点文字のみが含まれます。構文中のオプション・パラメータを明確にするなど、形式規約のための句読点は使用されていません。その種の情報は、説明の直後にあるパラメータのテーブルで説明されます。

1 つの例外は省略記号 (...) です。コンマの後の省略記号は、コンマの前のパラメータ (またはパラメータ・グループ) が、コンマ区切りリストとして複数回繰り返し可能であることを示します。

プラットフォーム固有の関数は、関数をサポートするプラットフォーム名と共に示します。関数がプラットフォーム略語と共に示されていない時は、すべての Caché プラットフォームによってサポートされます。

$ASCII – 文字を数値コードに変換します。
$BIT – $BIT は、ビット文字列内の指定された位置のビット値を返すか、または設定します。
$BITCOUNT – bitstring のビット数を返します。
$BITFIND – ビット文字列内の指定されたビット値の位置を返します。
$BITLOGIC – ビット文字列でビット演算を実行します。
$CASE – expression を比較し、最初に一致した case に関連する値を返します。
$CHAR – 式の整数値を、対応した ASCII または Unicode に変換します。
$CLASSMETHOD – 指定されたクラスにある指定クラス・メソッドを実行します。
$CLASSNAME – クラス名を返します。
$COMPILE – ソース・コードをコンパイルし、実行可能なオブジェクト・コードを生成します。
$DATA – variable にデータがあるか否かを調べます。
$DECIMAL – Caché の浮動小数点値に変換された数値を返します。
$DOUBLE – 64 ビットの浮動小数点値に変換された数値を返します。
$EXTRACT – 指定された位置にある部分文字列を文字列から取り出します。または指定された位置にある部分文字列を置換します。
$FACTOR – 整数を $BIT ビット文字列に変換します。
$FIND – 値により部分文字列を検索し、文字列の最終位置を指定する整数を返します。
$FNUMBER – 指定された形式で数値をフォーマットします。オプションで、指定された精度まで丸めるか、またはゼロで埋めます。
$GET – 指定した変数のデータ値を返します。
$INCREMENT – 変数の数値に、指定されたインクリメントを加えます。
$INUMBER – 数値を検証し、内部形式に変換します。
$ISOBJECT – expression がオブジェクト参照 (OREF) であるか否かを返します。
$ISVALIDDOUBLE – $DOUBLE 数値を検証し、ブーリアン値を返します。オプションで、範囲のチェックも行います。
$ISVALIDNUM – 数値を検証し、ブーリアン値を返します。オプションで、範囲のチェックも行います。
$JUSTIFY – 指定された幅の範囲内で式を右に寄せる関数です。指定された小数桁数に丸めます。
$LENGTH – 文字列内の文字数または区切られた部分文字列の数を返します。
$LIST – リストの要素を返すか、置換します。
$LISTBUILD – 指定した式から要素のリストを作成します。
$LISTDATA – 指定した要素が存在してデータ値を持つかを示します。
$LISTFIND – 値を要求して指定した list を検索します。
$LISTFROMSTRING – 文字列からリストを作成します。
$LISTGET – list の要素、または要求された要素が未定義の場合は指定した既定値を返します。
$LISTLENGTH – 指定したリストにある要素の数を返します。
$LISTNEXT – リストから要素を順番に取得します。
$LISTSAME – 2 つのリストを比較し、ブーリアン値を返します。
$LISTTOSTRING – リストから文字列を作成します。
$LISTUPDATE – オプションで、指定された 1 つのリスト要素または一連の要素を置き換えることにより、リストを更新します。
$LISTVALID – 式がリストかどうかを判別します。
$LOCATE – 文字列で、正規表現の最初の一致を検索します。
$MATCH – 正規表現と文字列を一致させます。
$METHOD – インスタンス・メソッドへの呼び出しをサポートします。
$NAME – 変数の名前値、もしくは添え字参照部分を返します。
$NCONVERT – 数値を、8 ビット文字の文字列でエンコードされた 2 進数値に変換します。
$NEXT – 添え字付き変数内の次の添え字の値を返します。
$NORMALIZE – 数値を検証して返し、指定された小数桁数に丸めます。
$NOW – 現在のプロセスのローカルの日付と時刻を、秒の小数部を含めて返します。
$NUMBER – 数値を検証し、返します。オプションで数の丸めや範囲チェックを行います。
$ORDER – 次のローカル変数、またはローカル変数やグローバル変数の添え字を返します。
$PARAMETER – 指定されたクラス・パラメータの値を返します。
$PIECE – 区切り文字を使用して、部分文字列を返すか、置換します。
$PREFETCHOFF – グローバルの事前フェッチを終了します。
$PREFETCHON – 指定されたグローバルの事前フェッチを確立します。
$PROPERTY – インスタンスの特定プロパティへの参照をサポートします。
$QLENGTH – 変数内の添え字レベルの数を返します。
$QSUBSCRIPT – 変数名または添え字名を返します。
$QUERY – ローカル配列とグローバル配列の物理的スキャンを行います。
$RANDOM – 指定した範囲での擬似ランダム整数値を返します。
$REPLACE – 入力文字列の文字列単位の部分文字列の置換で構成される新しい文字列を返します。
$REVERSE – 文字列にある文字を逆の順に返します。
$SCONVERT – バイナリでエンコードされた値を数値に変換します。
$SELECT – 最初の True の式に関連した値を返します。
$SEQUENCE – 複数のプロセスで共有されているグローバル変数をインクリメントします。
$SORTBEGIN – ソート・モードを開始し、グローバルに対する複数セットのパフォーマンスを向上させます。
$SORTEND – $SORTBEGIN で開始されたソート・モードを終了します。
$STACK – プロセス・コール・スタックに保存されている、アクティブ・コンテキストの情報を返します。
$TEXT – 指定した位置で見つかったソース・コード行を返します。
$TRANSLATE – ソース文字列の文字列単位の置換で構成される新しい文字列を返します。
$VIEW – メモリ位置のコンテンツを返します。
$WASCII – サロゲート・ペアを認識して、文字に対応する数値コードを返します。
$WCHAR – サロゲート・ペアを認識して、数値コードに対応する文字を返します。
$WEXTRACT – 指定された位置にある部分文字列を文字列から取り出すか、または指定された位置にある部分文字列を置換し、サロゲート・ペアを認識します。
$WFIND – サロゲート・ペアを認識して、値を基準に部分文字列を検索し、文字列の最終位置を指定する整数を返します。
$WISWIDE – 文字列にサロゲート・ペアが含まれているかどうかを示すフラグを返します。
$WLENGTH – サロゲート・ペアを認識して、文字列の文字数を返します。
$WREVERSE – サロゲート・ペアを認識して、文字列にある文字を逆の順に返します。
$XECUTE – 指定されたコマンド行を実行します。
$ZABS – 絶対値の関数です。
$ZARCCOS – 逆 (アーク) コサイン関数です。
$ZARCSIN – 逆 (アーク) サイン関数です。
$ZARCTAN – 逆 (アーク) タンジェント関数です。
$ZBOOLEAN – ビット単位論理演算関数
$ZCONVERT – 文字列変換関数
$ZCOS – コサイン関数です。
$ZCOT – コタンジェント関数です。
$ZCRC – チェックサム関数
$ZCSC – コセカント関数です。
$ZCYC – データ整合性の冗長巡回検査
$ZDASCII – 8 バイト文字列を $DOUBLE 浮動小数点数に変換します。
$ZDATE – 日付を検証し、これを内部形式から指定の表示形式に変換します。
$ZDATEH – 日付を検証し、これを表示形式から Caché の内部形式に変換します。
$ZDATETIME – 日付と時刻を検証し、これを内部形式から指定の表示形式に変換します。
$ZDATETIMEH – 日付と時刻を検証し、これを表示形式から Caché の内部形式に変換します。
$ZDCHAR – $DOUBLE 浮動小数点数を 8 バイト文字列に変換します。
$ZEXP – 指数関数 (自然対数の逆関数)
$ZF – ObjectScript ルーチンから関数または非 ObjectScript プログラムを呼び出します。
$ZF(-1) – オペレーティング・システム・コマンドまたはプログラムを子プロセスとして同期的に実行します。(非推奨)
$ZF(-2) – オペレーティング・システム・コマンドまたはプログラムを子プロセスとして非同期的に実行します。 (非推奨)
$ZF(-3) – DLL (ダイナミック・リンク・ライブラリ) をロードし、ライブラリ関数を実行します。
$ZF(-4) – $ZF(-5) および $ZF(-6) で使用されるユーティリティ関数を提供します。
$ZF(-5) – $ZF(-4) を使用してロードされた DLL 関数を実行します。
$ZF(-6) – $ZF(-4) を使用してインデックス作成された DLL 関数を実行します。
$ZF(-100) – オペレーティング・システム・コマンドまたはプログラムを子プロセスとして実行します。
$ZHEX – 16 進数文字列を 10 進数値に、あるいは 10 進数値を 16 進数値に変換します。
$ZISWIDE – 文字列に 16 ビットの文字が含まれているか否かをチェックします。
$ZLASCII – 4 バイト文字列を数値に変換します。
$ZLCHAR – 数値を 4 バイト文字列に変換します。
$ZLN – 指定された数の自然対数を返します。
$ZLOG – 指定された正の数の式の、常用対数の値を返します。
$ZNAME – 指定された名前文字列を、正当な識別子として検証します。
$ZPOSITION – 式の中で、指定されたフィールド幅に収まる文字数を返します。
$ZPOWER – 数値の指定した累乗の値を返します。
$ZQASCII – 8 バイト文字列を数値に変換します。
$ZQCHAR – 数値を 8 バイト文字列に変換します。
$ZSEARCH – 指定したターゲット・ファイルの完全なファイル指定 (パス名とファイル名) を返します。
$ZSEC – 指定された角度の三角関数のセカントを返します。
$ZSEEK – 現在のシーケンシャル・ファイルに新しいオフセットを確立します。
$ZSIN – 指定された角度の三角関数のサインを返します。
$ZSQR – 指定された数の平方根の値を返します。
$ZSTRIP – 指定された文字列から、文字のタイプと文字を削除します。
$ZTAN – 指定された角度の三角関数のタンジェントを返します。
$ZTIME – 時刻を検証し、これを内部形式から指定の表示形式に変換します。
$ZTIMEH – 時刻を検証し、これを表示形式から Caché の内部形式に変換します。
$ZVERSION(1) – オペレーティング・システムの種類を返します。
$ZWASCII – 2 バイト文字列を数値に変換します。
$ZWCHAR – 数値を 2 バイト文字列に変換します。
$ZWIDTH – 式で文字の合計幅を返します。
$ZWPACK と $ZWBPACK – 2 つの 8 ビット文字を 1 つの 16 ビット文字にパックします。
$ZWUNPACK と $ZWBUNPACK – 1 つの 16 ビット文字を 2 つの 8 ビット文字にアンパックします。
$ZZENKAKU – 日本語のカタカナを半角から全角に変換します。