Get()

Examples


The Get() function of the syHomePage form retrieves the settings for the specified item from the Home Page table.

Syntax

Get( HomePageState, Operation)

Parameters

HomePageState – A composite parameter of the type syHomePageState that is used to maintain state information for the Home Page.

Operation – An integer that specifies the operation to perform. The value corresponds to one of the following constant expressions:

[spacer]

Constant expression

Description

GET + EQUAL

Read the specific item from the table specified by the HomePageState composite.

GET + FIRST

Read the first item from the table specified by the HomePageState composite.

GET + LAST

Read the last item from the table specified by the HomePageState composite.

GET + PREV

Read the previous item from the table specified by the HomePageState composite.

GET + NEXT

Read the next item from the table specified by the HomePageState composite.

CHG + EQUAL

Read and lock the specific item from the table specified by the HomePageState composite.

CHG + FIRST

Read and lock the first item from the table specified by the HomePageState composite.

CHG + LAST

Read and lock the last item from the table specified by the HomePageState composite.

CHG + PREV

Read and lock the previous item from the table specified by the HomePageState composite.

CHG + NEXT

Read and lock the next item from the table specified by the HomePageState composite.

ADDNEW + EQUAL

Create the specific item in the table specified by the HomePageState composite.


Return value

An integer indicating the result of the operation. The value corresponds to one of the following constants:

[spacer]

Constant

Error type

OKAY

No Error

LOCKED

Locked Record

EOF

End of File

DUPLICATE

Duplicate Record

MISSING

Missing

RECORDCHANGED

Changed Record



Documentation Feedback