TFormer_DeleteVar

Definition

Windows: ANSI; Unix: UTF-8

ERRCODE TFormer_DeleteVar(HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszVarName);

Windows only: UTF-16

ERRCODE TFormer_DeleteVarW(HTFORM pInstance, LPCWSTR pszProjectName, LPCWSTR pszVarName);

Deletes a DataField from the specified Project.

If no Project is specified, the DataField will be removed from the global Project.

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

Parameter / type	Description
`pInstance`HTFORM	The TFORMer instance provided by a previous call to TFormer_Init
`pszProjectName`LPCSTR / LPCWSTR	The name of the Project (may be `NULL` for global DataFields)
`pszVarName`LPCSTR / LPCWSTR	The name of the DataField to be deleted

Deleting a DataField which is still in use by FormLayouts will make these FormLayouts unusable!