CREATE FUNCTION

name	作成する関数の名前。識別子です。この関数名には、修飾されていない場合 (StoreName) と修飾されている場合 (Patient.StoreName) があります。
parameter_list	オプション — 値を関数に渡すために使用されるパラメータのリスト。パラメータのリストは括弧で囲み、パラメータはコンマで区切られます。
characteristics	オプション — 関数の特性を指定する 1 つ以上のキーワード。使用可能なキーワードは、FOR、FINAL、PRIVATE、PROCEDURE、RETURNS、SELECTMODE です。特性は、空白で区切られ、任意の順序で指定できます。
LANGUAGE OBJECTSCRIPT LANGUAGE SQL	オプション — code_body に使用されるプログラミング言語。LANGUAGE OBJECTSCRIPT (Caché ObjectScript の場合) または LANGUAGE SQL を指定します。LANGUAGE 節が省略される場合は、SQL が既定です。
code_body	メソッドのプログラム・コード。メソッドは関数として指定されるため、コードで値を返します。

CREATE FUNCTION 文は、クラスのメソッドとして関数を生成します。このクラス・メソッドは、SQL ストアド・プロシージャとして投影されます。CREATE PROCEDURE 文は、SQL ストアド・プロシージャとして投影されるメソッドの生成にも使用できます。メソッドで値を返すときには CREATE FUNCTION を使用する必要がありますが、値を返さないメソッドの生成にも使用できます。

値を関数に渡すために使用されるパラメータのリストです。パラメータのリストは括弧で囲み、リストのパラメータ宣言はコンマで区切られます。リストの各パラメータ宣言は、(順に) パラメータ・モードが IN (入力値) か OUT (出力値) か INOUT (入力と変更と出力) かを指定するキーワード、パラメータ名、パラメータのデータタイプ、そしてオプションとして、一重引用符で囲まれた指定された文字列としてのパラメータの既定値に続くキーワードの DEFAULT から成り立ちます。例えば以下のようになります。

このメソッドは、プロシージャ・コンテキスト・ハンドラを使用して、プロシージャとその呼び出し元 (ODBC サーバなど) 間でプロシージャ・コンテキストの受け渡しを行います。このプロシージャ・コンテキスト・ハンドラは、Caché によって (%qHandle:%SQLProcContext として) %sqlcontext オブジェクトを使用して自動生成されます。

FOR classname	メソッドを生成するクラス名を指定します。そのクラスが存在しない場合は新規作成します。関数名を認証することによりクラス名を指定することもできます。FOR 節で指定されたクラス名の方が、関数名の認証により指定されたクラス名よりも優先されます。
FINAL	サブクラスがメソッドの上書きを行えないことを指定します。既定では、メソッドは最終ではありません。FINAL キーワードはサブクラスによって継承されます。
PRIVATE	メソッドがそれ自身のクラス、またはサブクラスの他のメソッドによってのみ起動できることを指定します。既定ではメソッドはパブリックで、制限なしに起動できます。この制限はサブクラスによって継承されます。
PROCEDURE	メソッドが SQL ストアド・プロシージャとして投影されることを指定します。ストアド・プロシージャはサブクラスに継承されます。CREATE FUNCTION は常に SQL ストアド・プロシージャを投影するため、このキーワードはオプションです。このキーワードは、PROC と略すことができます。
RETURNS datatype	メソッドに対する呼び出しによって返される値のデータ型を指定します。RETURNS が省略されると、メソッドは値を返すことができません。この仕様はサブクラスによって継承されます。
SELECTMODE mode	メソッドのコンパイルに使用されるモードを指定します。使用可能な値は、LOGICAL、ODBC、RUNTIME、DISPLAY です。既定は LOGICAL です。

SELECTMODE はデータを返すモードを指定します。mode 値が LOGICAL の場合は、論理 (内部保存) 値が返されます。例えば、日付は $HOROLOG 形式で返されます。mode 値が ODBC の場合、論理と ODBC 間の変換が適用され、ODBC 形式値が返されます。mode 値が DISPLAY の場合、論理と表示間の変換が適用され、表示形式値が返されます。mode 値が RUNTIME の場合、ローカル変数 %Runtime を設定して、実行時にモードを LOGICAL、ODBC、DISPLAY のいずれかに設定できます。これは、%Library.ResultSet RuntimeMode プロパティを使用して設定できます。RUNTIME モードの既定は LOGICAL です。

Caché は、メソッドの実際のコードを生成するために提供されたコードを使用します。指定するコードが SQL の場合、Caché はメソッドを生成する際に追加のコード行を提供します。追加されるコードは、SQL を Caché ObjectScript “ラッパ” に組み込み、(必要に応じて) プロシージャ・コンテキスト・ハンドラを提供し、返り値を処理します。以下はこの Caché から生成されたラッパ・コードの例です。

CREATE FUNCTION Sample_Employee.GetTitle
     ( INOUT pHandle %SQLProcContext, 
       SSN VARCHAR(11), 
       INOUT Title VARCHAR(50) )
    PROCEDURE
    RETURNS VARCHAR(30)
    FOR Sample.Employee
    LANGUAGE OBJECTSCRIPT
    {
        NEW SQLCODE,%ROWCOUNT
        &sql(SELECT Title INTO :Title FROM Sample.Employee 
             WHERE SSN = :SSN)
        IF $GET(pHandle)'=$$$NULLOREF {
           SET pHandle.SQLCode=SQLCODE
           SET pHandle.RowCount=%ROWCOUNT }
           QUIT
     }