Explorer_Get_Field_As_String_From_Table

This procedure returns the string representation and the underlying data in the native datatype for a column. It is used when displaying data for additional columns added to core SmartList objects. It is also used in the iterative fallback searching code for SmartList objects that are not SQL-optimized.

The procedure must have the following parameters:

inout string IO_String;
in integer IN_Object_Dict_ID;
in integer IN_Object_Type;
in integer IN_Field_Dict_ID;
in integer IN_Field_ID;
in boolean IN_Searching;
in string IN_Master_ID;
inout integer IO_Datatype;
inout long IO_Long;
inout date IO_Date;
inout currency IO_Currency;
inout time IO_Time;

IO_String – A string that must be set by the procedure to indicate the string representation of the data in the specified field or column.

IN_Object_Dict_ID – An integer specifying the ID of the dictionary that defines the SmartList object.

IN_Object_Type – An integer specifying the type of SmartList object. For SmartLists defined in the core application, the value corresponds to one of the constants defined in SmartList objects.

IN_Field_Dict_ID – An integer specifying the ID of the dictionary that defines the field for which the string representation is being retrieved.

IN_Field_ID – An integer specifying the resource ID of the field for which the string representation is being retrieved.

IN_Searching – A boolean that indicates whether SmartList is calling this procedure as part of a search. The value true indicates SmartList is searching, while false indicates it is not. The string representation of a field may need to be different when a search is being performed.

IN_Master_ID – When additional columns are being added to a core SmartList object, this string field will contain the primary key values for the main table used for the SmartList object. Refer to SmartList objects for a list of the primary tables that correspond to the SmartList object types. The field values passed in though the IN_Master_ID parameter will be padded with spaces to each field’s specified length. For example, a field with the STR30 datatype will be padded to a length of 30. Your code must parse the string into the individual field values. Use the key values to retrieve the corresponding record that contains the additional columns you want to display.

IO_Datatype – An integer that must be set by the procedure that specifies the field or column’s underlying datatype. The value corresponds to one of the following:

IO_Long – If the underlying datatype of the column is an integer or long integer, the procedure should set this parameter to the field’s native integer or long integer value.

IO_Date – If the underlying datatype of the column is a date, the procedure should set this parameter to the field’s native date value.

IO_Currency – If the underlying datatype of the column is a currency, the procedure should set this parameter to the field’s native currency value.

IO_Time – If the underlying datatype of the column is a time, the procedure should set this parameter to the field’s native time value.

Documentation Feedback

---