TFormer_SetFormName

Printing and Output · String encodings

Definition

Windows: ANSI; Unix: UTF-8

ERRCODE TFormer_SetFormName(HTFORM pInstance, LPCSTR pszFormName);

Windows only: UTF-16

ERRCODE TFormer_SetFormNameW(HTFORM pInstance, LPCWSTR pszFormName);

Contract

Specifies the name of the Repository-based FormLayout.

Use this function to specify the name of the FormLayout which is referenced from within a Project of a Repository. Do not use this property for a stand-alone FormLayout.

Returns

- ErrOk (0) in case of success, non-zero if an error occurred

Parameters

Parameter / typeDescription
pInstanceHTFORM


The TFORMer instance provided by a previous call to TFormer_Init

pszFormNameLPCSTR / LPCWSTR


The name of the FormLayout as defined using TFORMer Designer.

Note

Must be called before TFormer_Print. This call is mandatory if used with a Repository. Cached data (set with TFormer_NewRecord and TFormer_SetVarValue or by importing data-files) as well as the already loaded FormLayout are discarded.

Search documentation

Search in
More scopes
Additional scopes

All contents