AddFormFieldChoiceSubA

Form fields

Description

The trailing A denotes the ANSI (char) DLL entry point; the ActiveX/COM surface exposes only the Unicode form. Behaviour is identical to AddFormFieldChoiceSub and string arguments are interpreted using the current SetAnsiMode code page

Similar to the AddFormFieldSub function but allows a choice field item's export value and display value to be set

The function returns a temporary form field Index which can be used with the

SetFormFieldBounds, SetFormFieldCheckStyle and other functions

Syntax

Delphi

Function DLAddFormFieldChoiceSubA(InstanceID, Index: Integer; SubName, DisplayName: PAnsiChar): Integer;

DLL

int DLAddFormFieldChoiceSubA(int InstanceID, int Index, const char * SubName, const char * DisplayName);

Parameters

IndexThe index of the form field to work with; The first form field has an index of 1; The form field must be a choice field
SubNameThe export value of the new sub-field; The value of the form field could be set to this name using the SetFormFieldValue function; The display name of the new sub-field
DisplayName

Return values

0The sub-field was not added; The specified form field may not have been a choice form field
Non-zeroA temporary field Index