hiGetFieldAttachments

hiGetFieldAttachments(
g_formOrRegion 
s_field 
) 
=> x_attachments | nil

Description

Returns the integer representing the combination of attachment bit values when the field is in an attachment form.

A form is an attachment form when the ?attachmentList argument has been specified.

Arguments

g_formOrRegion	A form, scroll region, or tab page.
s_field	Symbol name of the field.

Values Returned

x_attachments	An integer representing the combination of attachment bit values.
nil	The operation fails and an error message is also issued.

Examples

Consider an attachment form MyForm with the field MyCyclic that has the following attachments: "hicLeftPercentSet | hicTopPositionSet | hicRightPositionSet".

In this scenario, the following command:

hiGetFieldAttachments( MyForm 'MyCyclic )

Returns the integer 41 because the sum of the values of hicLeftPercentSet (1), hicTopPositionSet (8), and hicRightPositionSet (32) is 41 (32 + 8 + 1).

Related Topics

Form and Field Functions

Return to top