TFormer_OpenDesigner

Miscellaneous · String encodings

Definition

Windows only: ANSI

ERRCODE TFormer_OpenDesigner(HTFORM pInstance, LPCSTR pszDesignExe, BOOL bShowSplash, BOOL bMaximize, BOOL bUseExistingInstance, LPCSTR pszExtraParameters);

Windows only: UTF-16

ERRCODE TFormer_OpenDesignerW(HTFORM pInstance, LPCWSTR pszDesignExe, BOOL bShowSplash, BOOL bMaximize, BOOL bUseExistingInstance, LPCWSTR pszExtraParameters);

Contract

Opens the currently selected FormLayout with TFORMer Designer.


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

pszDesignExeLPCSTR / LPCWSTR


If NULL the function tries to locate TFORMer Designer by itself

bShowSplashBOOL


Show the splash screen of TFORMer Designer?

bMaximizeBOOL


Open TFORMer Designer maximized?

bUseExistingInstanceBOOL

Try to use an existing TFORMer Designer instance? This parameter avoids multiple TFORMer Designer windows. A new instance of TFORMer Designer is opened if no existing instance is found or no existing instance can be used.

pszExtraParametersLPCSTR / LPCWSTR


Parameters which should be sent to TFORMer Designer (Default: NULL). These parameters are used for branding of TFORMer Designer via the command-line (see below).

Remark

TFORMer SDK on its own cannot be used for editing a FormLayout. Use this method to invoke TFORMer Designer.

Remark

  • If there is no given EXE file (parameter pszDesignExe), then this function uses a value in the System Registry ([HKCU|HKLM]\TEC-IT\TEC-IT Datenverarbeitung GmbH\9\TFormerApp) to determine the location of TFORMer.exe.

  • If this key is not found or the file does not exist, then TFORMer.exe will be searched in the directory where TFORMer SDK is installed.

  • If TFORMer.exe is not found here too, then it will search TFORMer.exe in the current directory.

  • Finally - if TFORMer.exe was still not found it checks the complete path (environment variable PATH).

Note

Make sure that your purchased license model fits your requirements. If you are creating applications which are distributed to 3rd party you may need to redistribute TFORMer Designer as well.

Note

TFormer_SetFormName has to be called prior to calling this function.

Note

For branding TFORMer Designer there are two different possibilities:

  • Provide Splash-Screen and About Box bitmaps in the same directory as TFORMer Designer is installed. The required filenames are TFSS.mbp (Splash-Screen) and TFAb.mbp (About Box)

  • Via command-line parameters (these parameters overrule the file-system):
    /Splash [SplashPicture.bmp]
    /AboutBox [AboutboxPicture.bmp]

Search documentation

Search in
More scopes
Additional scopes

All contents