KCML_View_GetSymFnColumnList

Purpose

Return the column list of the view of the nth parameter typed to a view

Definition

DEFSUB 'KCML_View_GetSymFnColumnList(SymFn, BYREF ColList$, Parameter = ar_fdoub(1)) AS Numeric

Parameters

SymFnSYM of a callback function
ColListRedimmed to number of columns and filled with ordinals
ParameterOptional. Specifies the parameter. The first parameter is 1.

Return

Count if succeeds; 0 otherwise.

Description

Given the SYM of a callback function, this function will determine the nth parameter of the function typed to a view. It then returns the column list for that view in the array, redimming as necessary. Any previous parameters should be of the same form, namely BYREF param$_type. If the parameter is defined in terms of a record rather than a view then 0 is returned. If the function has not been declared as a CALLBACK or the sym does not represent a function then a run-time error will result. The function returns 1 if it succeeds, in which case the column list will be filled in; otherwise it will be unmodified.

See also

Internal KCML Functions, Internally defined structures and Internally defined enumerations and constants.