プライマリ・コンテンツに移動

Oracle® Application Express APIリファレンス リリース5.1 E85937-02 |
| 目次 | 索引

前 | 次 |

# 21.15 GET_DISPLAY_DATAファンクションのシグネチャ1

このファンクションは、`p_search_string`に指定される値の表示参照値を取得します。

構文

    APEX_PLUGIN_UTIL.GET_DISPLAY_DATA (
        p_sql_statement    IN VARCHAR2,
        p_min_columns      IN NUMBER,
        p_max_columns      IN NUMBER,
        p_component_name   IN VARCHAR2,
        p_display_column_no IN BINARY_INTEGER DEFAULT 1,
        p_search_column_no  IN BINARY_INTEGER DEFAULT 2,
        p_search_string    IN VARCHAR2 DEFAULT NULL,
        p_display_extra    IN BOOLEAN DEFAULT TRUE)
    RETURN VARCHAR2;

パラメータ

表21-18 GET_DISPLAY_DATAのシグネチャ1のパラメータ

パラメータ | 説明
--- | ---
`p_sql_statement` | 参照に使用されるSQL文。
`p_min_columns` | 戻り列の最小数。
`p_max_columns` | 戻り列の最大数。
`p_component_name` | エラーが戻される場合、エラー・メッセージが表示される際のページ・アイテムまたはレポート列の名前として、この値が使用されます。
`p_display_column_no` | SQL文から戻される列の数。`p_min_columns`から`p_max_columns`の範囲内である必要があります。
`p_search_column_no` | SQL文を制限するために使用する列の数。`p_min_columns`から`p_max_columns`の範囲内である必要があります。
`p_search_string` | 問合せを制限するために使用する値。
`p_display_extra` | `TRUE`を設定すると、値が見つからなかい場合に、かわりに検索値が結果に追加されます。

戻り値

表21-19 GET_DISPLAY_DATAのシグネチャ1の戻り値

戻り値 | 説明
--- | ---
VARCHAR2 | `p_display_column_no`で指定した列の最初のレコードの値。パラメータ`p_display_extra`にTRUEが設定されていると、レコードが見つからない場合に`p_search_string`の値が含まれます。そうでない場合は、NULLが戻されます。

例

次の例では、p_valueで提供された値で参照を実行し、LOV問合せの表示列を戻します。

    function render_value (
        p_item                in apex_plugin.t_page_item,
        p_value               in varchar2,
        p_is_readonly         in boolean,
        p_is_printer_friendly in boolean )
        return apex_plugin.t_page_item_render_result
    is
    begin
        sys.htp.p(sys.htf.escape_sc(
            apex_plugin_util.get_display_data (
                p_sql_statement     => p_item.lov_definition,
                p_min_columns       => 2,
                p_max_columns       => 2,
                p_component_name    => p_item.name,
                p_display_column_no => 1,
                p_search_column_no  => 2,
                p_search_string     => p_value )));
    end render_value;