pCDLPickList

Display a pick list window for user selection.

Syntax

pCDLPickList ( out vlStatus,
               inout vlNumRecords,
               in vlTitle,
               in vlSetSpec,
               in vlWhere,
               in vlSort,
               in vlFieldName,
               in vlKeyFieldName,
               inout vlRecordKey )

Parameters

vlStatus

The output parameter indicating the success or failure of the program.

vlNumRecords

The number of records selected.

vlTitle

The window caption to use for the pick list window.

vlSetSpec

The set specification to search for a specific value.

vlWhere

An optional WHERE clause to append to vlSetSpec.

vlSort

An optional SORT clause to append to vlSetSpec.

vlFieldName

The name of a field in the set specification that is displayed in the pick list.

vlKeyFieldName

The name of a field of the "set specification" that is returned from the procedure as a result of a record selection.

vlRecordKey

The value of the specific pick list entry selected.

Comments

pCDLPickList displays a window with a list of values from the specified set specification. If there are no records from which to pick, pCDLPickList returns immediately with vlStatus set to "EMPTY". Otherwise, vlStatus is set to "OK" and vlNumRecords is set to 1 (if the user picked an item) or 0 (the user selected the Cancel button). The selected value is returned in vlRecordKey.

Example

pCDLPickList( vlStatus,                              \
               vlNumRec                         \
               "Select a Message",              \
               "ApplMessages",                  \
               "",                              \  %No Where Clause
               "",                              \  %No Sort Clause
                "ApplMessage",                  \
                "ApplMessCode",                 \
                vlCode )