API Reference for a_v4_extfn

Reference information for a_v4_extfn functions, methods, and attributes.

• Blob (a_v4_extfn_blob)
  Use the a_v4_extfn_blob structure to represent a free-standing blob object.
• Blob Input Stream (a_v4_extfn_blob_istream)
  Use the a_v4_extfn_blob_istream structure to read blob data for a LOB or CLOB scalar input column, or LOB or CLOB column in an input table.
• Column Data (a_v4_extfn_column_data)
  The structure a_v4_extfn_column_data represents a single column's worth of data. This is used by the producer when generating result set data, or by the consumer when reading input table column data.
• Column List (a_v4_extfn_column_list)
  Use the a_v4_extfn_column_list structure to provide a list of columns when describing PARTITION BY or to provide a list of columns when describing TABLE_UNUSED_COLUMNS.
• Column Order (a_v4_extfn_order_el)
  Use the a_v4_extfn_order_el structure to describe the element order in a column.
• Column Subset (a_v4_extfn_col_subset_of_input)
  Use the a_v4_extfn_col_subset_of_input structure to declare that an output column has a value that is always taken from a particular input column to the UDF.
• Describe API
  The _describe_extfn function is a member of a_v4_extfn_proc. A UDF gets and sets logical properties using the describe_column, describe_parameter, and describe_udf properties in the a_v4_extfn_proc_context object.
• Describe Column Type (a_v4_extfn_describe_col_type)
  The a_v4_extfn_describe_col_type enumerated type selects the column property retrieved or set by the UDF.
• Describe Parameter Type (a_v4_extfn_describe_parm_type)
  The a_v4_extfn_describe_parm_type enumerated type selects the parameter property retrieved or set by the UDF.
• Describe Return (a_v4_extfn_describe_return)
  The a_v4_extfn_describe_return enumerated type provides a return value, when a_v4_extfn_proc_context.describe_xxx_get() or a_v4_extfn_proc_context.describe_xxx_set() does not succeed.
• Describe UDF Type (a_v4_extfn_describe_udf_type)
  Use the a_v4_extfn_describe_udf_type enumerated type to select the logical property the UDF retrieves or sets.
• Execution State (a_v4_extfn_state)
  The a_v4_extfn_state enumerated type represents the query processing state of a UDF.
• External Function (a_v4_extfn_proc)
  The server uses the a_v4_extfn_proc structure to call into the various entry points in the UDF. The server passes an instance of a_v4_extfn_proc_context to each of the functions.
• External Procedure Context (a_v4_extfn_proc_context)
  Use the a_v4_extfn_proc_context structure to retain context information from the server and from the UDF.
• License Information (a_v4_extfn_license_info)
  If you are a Sybase design partner, use the a_v4_extfn_license_info structure to define library-level license validations for your UDFs, including your company name, library version information, and a Sybase-supplied license key.
• Optimizer Estimate (a_v4_extfn_estimate)
  Use the a_v4_extfn_estimate structure to describe an estimate, which includes a value and a confidence level.
• Order By List (a_v4_extfn_orderby_list)
  Use the a_v4_extfn_orderby_list structure to describe the ORDER BY property of a table.
• Partition By Column Number (a_v4_extfn_partitionby_col_num)
  The a_v4_extfn_partitionby_col_num enumerated type represents the column number to allow the UDF to express PARTITION BY support similar to that of SQL support.
• Row (a_v4_extfn_row)
  Use the a_v4_extfn_row structure to represent the data in a single row.
• Row Block (a_v4_extfn_row_block)
  Use the a_v4_extfn_row_block structure to represent the data in a block of rows.
• Table (a_v4_extfn_table)
  Use the a_v4_extfn_table structure to represent how data is stored in a table and how the consumer fetches that data.
• Table Context (a_v4_extfn_table_context)
  The a_v4_extfn_table_context structure represents an open result set over a table.
• Table Functions (a_v4_extfn_table_func)
  The consumer uses the a_v4_extfn_table_func structure to retrieve results from the producer.