pCDLFind

Locate a record within a set.

Syntax

pCDLFind ( out   vlStatus,
           in    vlOperation,
           inout vlNumRecords,
           in    vlTitle,
           in    vlSetName,
           in    vlNumEntSets,
           in    vlFieldName )

Parameters

vlStatus

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

vlOperation

The parameter indicating if pCDLFind should enable a find operation or close the window.

vlNumRecords

The number of records selected in the resulting set.

vlTitle

The caption to use for the find window.

vlSetName

The name of a set to be searched.

vlNumEntSets

The number of components in the set.

vlFieldName

The initial field name to be displayed in the field list.

Comments

The pCDLFind command displays a window containing a list of fields in the target set, a list of possible comparison operations (equal, less than, and so on) and a comparison value. The list of fields is taken either from a variable vFieldList or from a set called sFieldList that must be a set defined on Fields. (Both vFieldList and sFieldList are defined in $DeployServices). If vFieldList is neither blank nor $NULL, it is assumed to contain a list of field names, delimited by a semicolon (e.g. "LastName;FirstName;DepartmentNum"). If vFieldList is either blank or $NULL, then sFieldList is used. In all cases, when pCDLFind returns, vFieldList is set to $NULL.

The field names are shown with their owner's name if vlNumEntSets is greater than one. If vlFieldName is specified, it becomes the initial field in the list. When Find First or Find Next is selected, the combination of a selected field name, a comparison operator, and a value are combined with vlSetName to locate a record in the set satisfying the comparison. Find First starts searching at the first record in the set. Find Next starts at the current member. The located record becomes the current member of the set.

On the first call to pCDLFind, vlOperation should be set to "FIND". If a selection is made, pCDLFind returns with vlStatus equal to "OK" but the window remains open. Another call to pCDLFind should be made with vlOperation set to "CLOSE" or "FIND". For "CLOSE", the window is closed and vlStatus is returned as "COMPLETE". For "FIND", the user can decide to perform either another Find First or Find Next operation or the Find window can be closed by selecting the Close button. In the latter case, vlStatus is set to "COMPLETE".

Shown below is the window for specifying the comparison.