Foundation 6

Other shared methods

20 shared methods.

aaa_Test_Fnd

aaa_Test_Fnd

A scratch method kept for trying things out from a host. The body is deliberately commented out, so calling it does nothing.

It is Shared, so a host can reach it, and it has a typing entry in Compiler_Fnd_MethodParameters for the object parameter its commented #DECLARE takes. Uncomment, experiment, and comment out again — do not build anything on it.

No parameters.

Alert2

Alert2 (message{; icon{; OK bttn{; window title}})

Allows an older Foundation based database to use the new Fnd_Dlg routines.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
messageTextinThe message to display
iconLongintinThe icon - 0, 1 or 2 (optional)
bttn1TextinThe OK button text (optional)
windowTitleTextinThe window title (optional)

BugAlert

BugAlert (routine name{; details})

Allows an older Foundation based database to use the new Fnd_Gen_BugAlert routine.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
methodNameTextinThe calling method name
optionalDetailsTextinMore information about the problem (optional)

CenterWindow

CenterWindow (width; height{; type{; title{; close method}}})

Allows an older Foundation based database to use the new Fnd_Gen_CenterWindow routine.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
widthLongintinDescription
ResultLongintoutDescription

ChoiceList

ChoiceList (dialog title; ->text array) --> Number

Reroutes ChoiceList calls to the new Fnd_List component.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
inDialogTitleTextinThe dialog title
arrayPointerinThe options to display
ResultLongintoutThe selected element

Confirm2

Confirm2 (message{; icon{; OK bttn; Cancel bttn{; window title}}})

Allows an older Foundation based database to use the new Fnd_Dlg routines.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
messageTextinThe message to display
inIconLongintinThe icon - 0, 1 or 2 (optional)
inBttn1TextinThe OK button text (optional)
inBttn2TextinThe Cancel button text (optional)
inWindowTitleTextinThe window title (optional)

Message2

Message2 (message text{; window title})

Allows an older Foundation based database to use the new Fnd_Dlg routines.

ParameterTypeDirectionDescription
messageTextTextinThe message to display
inWindowTitleTextinThe window title (optional)

Message2Close

Message2Close

Allows an older Foundation based database to use the new Fnd_Dlg routines.

No parameters.

OutputSort

OutputSort (column; ->field)

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
columnLongintinThe column number
fieldSortPointerinThe field to sort

PrefsGet

PrefsGet (pref name) --> Text

Allows an older Foundation based database to use the new Fnd_Pref routines.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
prefNameTextinThe preference name
ResultTextoutThe preference value

PrefsPut

PrefsPut (pref name; pref value)

Allows an older Foundation based database to use the new Fnd_Pref routines.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
prefNameTextinThe preference name
prefValueTextinThe value to set
ResultoutNone

ProgClose

ProgClose

Allows an older Foundation based database to use the new Fnd_Dlg routines.

Part of the Foundation Compatibility component.

No parameters.

ProgOpen

ProgOpen (total; message; {window title{; button text}})

Allows an older Foundation based database to use the new Fnd_Dlg routines.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
totalLongintinThe total to count up to
messageTextinThe message to display
inWindowTitleTextinThe window title (optional)
inButtonTextTextinThe button label (optional)

ProgReset

ProgReset

Part of the Foundation Compatibility component.

No parameters.

ProgUpdate

ProgUpdate (number)

Allows an older Foundation based database to use the new Fnd_Dlg routines.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
numberLongintinThe current progress

Request2

Request2 (message{; default{; icon{; OK bttn; Cancel bttn{; title}}}}) --> Text

Allows an older Foundation based database to use the new Fnd_Dlg routines.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
messageTextinThe message to display
inDefaultTextinThe default response
inIconLongintinThe icon - 0, 1 or 2 (optional)
inBttn1TextinThe OK button text (optional)
inBttn2TextinThe Cancel button text (optional)
inTitleTextinThe window title (optional)
ResultTextoutThe user's response

SelfStart

SelfStart (method name; process name)

Converts a call to Foundation 3's SelfStart routine to the new Fnd_Gen_LaunchAsNewProcess routine.

ParameterTypeDirectionDescription
methodNameTextinThe name of the calling method
processNameTextinThe process name
ResultBooleanoutTrue if we're in a new process

SetMenuBar

SetMenuBar

Doesn't do anything other than not cause errors.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
ignoredParameterLongintinAn ignored parameter

UTIL_CodeAvailable

UTIL_CodeAvailable (code) --> Boolean

Returns true if the component is installed.

ParameterTypeDirectionDescription
codeTextinThe name of a component or method
ResultBooleanoutTrue if the component or method is available

YesNoCancel

YesNoCancel (message{; window title}) --> Text

Allows an older Foundation based database to use the new Fnd_Dlg routines.

Part of the Foundation Compatibility component.

ParameterTypeDirectionDescription
messageTextinThe message to display
$5TextinThe window title (optional)