Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5a

Application v 5.23b

  

 

Chapter NineDialog Functions (continued)

DataControlComboFindString Function

Overview

The DataControlComboFindString function will search the comobox list section for a specified string or string portion..

Syntax/Parameters

Syntax

int = DataControlComboFindString ( int id, int row, int column,
                               string target, [dword flags] );

Parameters

id

An int containing the control ID of the data control.

row

A zero-based int specifying the row.

column

A zero-based int specifying the column.

target

A string to find in the list portion of the combobox.

flags

An optional dword specifying the start position and options. The default value is 0x00000000 which starts at zero, complete match and case sensitive.

Return Value

Returns an int as an index to the item located or a formatted error code on failure. Common error codes are as follows: ERROR_EOD if the item is not found, ERROR_RANGE if id is an invalid control ID for the open dialog, or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information.

Remarks

Since the combobox list allowed duplicates, the flags parameter allows for the specification of a zero-based start index.

The flags parameter option bits are as follows:

  Definition   Bitwise   Description  
  DCC_LBC_FIND_INDEX_MASK   0x0000FFFF   Starting Index of Search (mask)  
  DCC_LBC_FIND_PARTIAL   0x10000000   Match Any Segment of Field  
  DCC_LBC_FIND_NO_CASE   0x20000000   Not Case Sensitive  

 

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

Page revised 2024-08-19