ERRCODE TFormer_SetConfigFile ( HTFORM  pInstance,
LPCSTR  pszFilename 
)

Sets the configuration file for TFORMer Runtime.

Returns:
- ErrOk (0) in case of success
- Non-zero if error occurred
Parameters:
[in] pInstance The TFORMer-Instance provided by a previous call to TFormer_Init.
[in] pszFilename Path and filename of a TFORMer configuration file
Remarks:
TFORMer uses a system-wide configuration file named TFORMer.xml which defines general output options. This file is installed automatically by the setup application (usually into C:\Program Files\TEC-IT\TFORMer 6\Bin (Windows) or /usr/local/share/TFORMer (Linux)). TFormer_SetConfigFile enables you to use different or multiple configuration-files (e.g. on a per-user base). Please refer to the TFORMer Developer Manual and the file TFORMer.xml to get a detailed explanation regarding the following settings:
Option Overview
Output Type Description
All Output Types
PDF
  • Page setup (size, orientation, compression, margins, font-embedding)
  • Image compression method and JPEG-quality
  • Maximum resolution for images (so-called down-sampling)
PostScript
  • Page setup (size, orientation, color-mode)
  • Header and footer sequences, character encoding
HTML
  • Page setup (size, orientation, resolution)
  • Bar-code resolution
Images
  • Page setup (size, orientation, resolution)
  • Image compression method
  • Color mode, anti-aliasing
ZPL-II (ZEBRA)
  • Page setup (size, orientation, resolution)
  • Scaling, dithering, compression method
If no XML file is specified using this function, TFormer_Print will use the default configuration file.

Note:
The configuration file TFORMer.xml may be passed in the following ways:
  • Specify the filename directly.
  • Specify the filename of a ZIP-file (e.g. with WinZip) containing the required file.
  • BASE64-encode the content of the required file (see Convert class of .NET) and use this string instead of a filename.
  • BASE64-encode the content of a ZIP-file (see Convert class of .NET) containing the required file(s). Use this string instead of a filename.

Note:
BASE64 encoded strings must start with the sequence BASE64:. When passing a zipped file TFORMer expects a real WinZip compatible format. A zipped stream is not suitable! For more details please refer to the TFORMer Runtime DLL Programming Reference.
See also:
TFormer_Print


© 2006-2009 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Wed Sep 2 16:01:09 2009 for TFORMer Runtime DLL/Shared Library with doxygen 1.5.8