CreateDefaultViewRecord() -- Options

Examples


The CreateDefaultViewRecord() function defined in the syListViewOptionsObj form is used to create the default view option information for a list.

Syntax

CreateDefaultViewRecord(list_dict_ID, list_ID {, list_option}{, date_restriction)

Parameters

list_dict_ID – An integer specifying the ID of the product that defines the list.

list_ID – An integer specifying the unique ID assigned to the list.

list_option – An optional long integer that allows specifying which records are displayed in the list. The default value is indicated by the constant LISTOPTION_ALLRECORDS, which specifies that all records are displayed.

date_restriction – An optional long integer that allows specifying the date range of the records displayed in the list. The default value is indicated by the constant DATERESTRICT_NONE, which indicates that no date restriction is applied.

Return value

An integer indicating whether the default view option information was created. The constant OKAY indicates the information was created. Any other value indicates an error occurred.


Documentation Feedback