Ets_Output_Table_Value_Register_With_Type()
Abstract
Creates a registered value handler object and registers it in the global cache for use by Ets_Output_Obj_Value_Get().
Syntax
Ets_Output_Table_Value_Register_With_Type (value_name, result_source, obj_type, table_name, column_name, hot_link_column_name, value_type, value_func_ptr)
| Argument | Type | Description |
|---|---|---|
value_name |
char * |
Name of the output value as it will be known to callers of Ets_Output_Obj_Value_Get(). |
result_source |
EtsT_Output_Source |
Mode for which this operation is valid. Must be one of the symbolic constants listed in Table 171 Output Package Symbolic Constants. |
obj_type |
“EtsT_Obj_Type“ |
Type of object for which this operation applies. Symbolic constants for valid object types are listed in Table 33 “General Sub-Package Symbolic Constants“ on page 1046. |
table_name |
char * |
Name of the OT table to get the data from. |
column_name |
char * |
Name of the column tag to get the data. |
hot_link_column_name |
char * |
Name of the column tag to get the corresponding hot link object that owns the data value. |
value_type |
EtsT_Output_Value_Type |
Whether the cell value obtained is the raw value in the cell or the value of the hot link (if one exists). Must be one of the symbolic constants listed in Table 171 Output Package Symbolic Constants. |
value_func_ptr |
EtsT_Output_Reg_Function |
Function that is dispatched to get the value. The prototype for this function is given in EtsT_Output_Reg_Function. |
Return Type
EtsT_Output_Reg_Value *
Read-only pointer to the registered value; PRGC_NIL if unsuccessful.
Header
ets_api_output.h
Details
This function creates the EtsT_Output_Reg_Value object, puts it in the cache, and returns the object to the caller. The cache owns the object. The caller should use the object as read-only.
Note: The form of this function is for registered values that are stored in output tables. Other forms might be needed to access output values in other data stores.