SetFormFieldDescription

Form fields

Description

Sets the description of the specified form field.

Syntax

Delphi

Function TPDFlib.SetFormFieldDescription(Index: Integer; Const NewDescription: WideString): Integer;

ActiveX

Function PDFlib::SetFormFieldDescription(Index As Long, NewDescription As String) As Long

DLL

int DLSetFormFieldDescription(int InstanceID, int Index, const wchar_t * NewDescription);

Parameters

IndexThe index of the form field to change
NewDescriptionThe new description.

Return values

0The form field could not be found
1The specified form field's description was set successfully