TFormer_SetJobTrayControlName

Printing and Output · String encodings

Definition

Windows: ANSI; Unix: UTF-8

ERRCODE TFormer_SetJobTrayControlName(HTFORM pInstance, LPCSTR pszTrayControlName);

Windows only: UTF-16

ERRCODE TFormer_SetJobTrayControlNameW(HTFORM pInstance, LPCWSTR pszTrayControlName);

Contract

Sets the name of the JobTrayControl to be used for this Job.

Specify the JobTrayControl for the current Job. If this property is not set then the Job is generated with the JobTrayControl named _Default_.

This function must be called before TFormer_Print.

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

pszTrayControlNameLPCSTR / LPCWSTR

Name of the JobTrayControl as defined with TFORMer Designer - use NULL or "" to use the _Default_ JobTrayControl

Note

TFORMer uses a configuration file named TFORMer.xml for adjusting output options and paper format names. Since paper format names are also used in JobTrayControl please check out TFormer_SetConfigFile too.

Search documentation

Search in
More scopes
Additional scopes

All contents