list_colaux

Gets/sets the auxilary string of a column in a list.

Available in:

Apps (win) Apps (char) Reportwriter RPC Standalone PL
X X X X X

Syntax

string list_colaux(list-name,col-index[,col-aux])
list               list-name
expr               col-index
string             col-aux

Description

Returns the auxilary string of a column specified by index. If the specified list does not contain auxilary column strings, list_colaux() returns a NULL. If col-aux is specified, this function attaches the auxilary string to the column and returns the new string.
list-name specifies the list to search.
col-index specifies the column to assign or return the string.
col-aux (optional) specifies an auxilary string for the column. If the column has an auxilary string, it is replaced. Valid formatting strings are listed at
http://msdn.microsoft.com/en-us/library/26etazsy.aspx.

Notes

The auxilary strings are currently only used by list_view3.

Example

Set the display format of the specified columns in the list.
{
list LL;

LL = list_open("10 10 10 10",0,"Aux test!!");

list_mod(LL,1,"Niklas",1958,125000,SYSDATE+0);
list_mod(LL,1,"Paul",  1960,140000,SYSDATE+100);
list_mod(LL,1,"Johan", 1959,150000,SYSDATE+200);

list_colnam(LL,0,"Name");
list_colnam(LL,1,"Year");   list_colaux(LL,1,"00000000");
list_colnam(LL,2,"Salary"); list_colaux(LL,2,"C");
list_colnam(LL,3,"When");   list_colaux(LL,3,"F");

list_view3(LL,5,10,15,key_quit,opt_report,0);
}
The numbers in the second column will have leading zeroes and the date values in the third and fourth columns will have the "C" and "F" formatting applied, respectively.