SetFormFieldChoiceSubA

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 SetFormFieldChoiceSub and string arguments are interpreted using the current SetAnsiMode code page

Sets the export and display values of an existing sub-field that is part of a choice form field. If the display value is an empty string then it will be set to the same string as the export value.

The AddFormFieldChoiceSub function can be used to change a sub-field entry in an existing choice form field.

Syntax

Delphi

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

DLL

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

Parameters

IndexThe index of the choice form field
SubIndexThe index of the sub-field. The first sub-field has an index of 1.
SubNameThe export value of the new sub-field.
DisplayNameThe display value of the new sub-field.

Return values

0The sub-field was not added; The specified form field may not have been a choice form field
1The form field was updated successfully.