TFormer6.h File Reference

Header File for TFormer6.0
Include this header file in your modules to access the TFORMer Runtime API. More...

Include dependency graph for TFormer6.h:

Defines

#define ERRCODE   LONG
#define ErrOk   S_OK
#define LICKIND_WORKSTATION   1
 The license types for the TFORMer Runtime (see TFormer_License).
#define LICKIND_SITE   2
 Site license (up to 250 installations or users (whichever is higher) within one site are allowed).
#define LICKIND_DEVELOPER   3
 Developer license (for client-applications only, up to 10000 redistributions per developer license).
#define LICKIND_OFFICE   4
 Office license (up to 100 installations or users (whichever is higher) within one site are allowed).
#define LICKIND_WORKGROUP   5
 Workgroup license (up to 10 installations or users (whichever is higher) within one site are allowed).
#define LICKIND_SERVER   6
 Server license (installation on one (web-)server for up to 10000 users).
#define TFormer_LicenseT   TFormer_License
 Defines for UNICODE/ANSI Independence.
#define TFormer_SetRepositoryNameT   TFormer_SetRepositoryName
#define TFormer_SetPrinterNameT   TFormer_SetPrinterName
#define TFormer_SetOutputNameT   TFormer_SetOutputName
#define TFormer_SetJobTrayControlNameT   TFormer_SetJobTrayControlName
#define TFormer_SetProjectNameT   TFormer_SetProjectName
#define TFormer_SetFormNameT   TFormer_SetFormName
#define TFormer_SetDataSourceNameT   TFormer_SetDatasourceName
#define TFormer_SetDSParameterValueT   TFormer_SetDSParameterValue
#define TFormer_GetDataSourceNameT   TFormer_GetDatasourceName
#define TFormer_SetConfigFileT   TFormer_SetConfigFile
#define TFormer_SetDataFileT   TFormer_SetDataFile
#define TFormer_SetVarValueT   TFormer_SetVarValue
#define TFormer_OpenDesignerT   TFormer_OpenDesigner
#define TFormer_SetImportFieldForRecordCopyT   TFormer_SetImportFieldForRecordCopy
#define TFormer_SetTxtDataFileT   TFormer_SetTxtDataFile
#define TFormer_SetODBCDataT   TFormer_SetODBCData
#define TFormer_SetXmlDataFileT   TFormer_SetXmlDataFile
#define TFormer_SetXmlDataFileExT   TFormer_SetXmlDataFileEx
#define TFormer_SaveXmlT   TFormer_SaveXml
#define TFormer_GetLastErrorDescriptionT   TFormer_GetLastErrorDescription
#define TFormer_GetLastErrorInformationT   TFormer_GetLastErrorInformation
#define TFormer_GetLastErrorSourceT   TFormer_GetLastErrorSource
#define TFormer_AddNewProjectT   TFormer_AddNewProject
#define TFormer_DeleteProjectT   TFormer_DeleteProject
#define TFormer_AddNewFormT   TFormer_AddNewForm
#define TFormer_DeleteFormT   TFormer_DeleteForm
#define TFormer_AddNewVarT   TFormer_AddNewVar
#define TFormer_DeleteVarT   TFormer_DeleteVar
#define TFormer_ProjectItGetNameT   TFormer_ProjectItGetName
#define TFormer_ProjectItGetDescriptionT   TFormer_ProjectItGetDescription
#define TFormer_GetFirstFormItT   TFormer_GetFirstFormIt
#define TFormer_FormItGetNameT   TFormer_FormItGetName
#define TFormer_FormItGetDescriptionT   TFormer_FormItGetDescription
#define TFormer_GetFirstProjectVarItT   TFormer_GetFirstProjectVarIt
#define TFormer_ProjectVarItGetNameT   TFormer_ProjectVarItGetName
#define TFormer_ProjectVarItGetDescriptionT   TFormer_ProjectVarItGetDescription
#define TFormer_ProjectVarItGetCaptionT   TFormer_ProjectVarItGetCaption
#define TFormer_ProjectVarItGetDisplayOrderT   TFormer_ProjectVarItGetDisplayOrder
#define TFormer_ProjectVarItGetDefValueT   TFormer_ProjectVarItGetDefValue
#define TFormer_GetVarUsageT   TFormer_GetVarUsage
#define TFormer_GetOSPrinterT   TFormer_GetOSPrinter
#define TFormer_GetOSDefaultPrinterT   TFormer_GetOSDefaultPrinter
#define TFormer_GetFirstDatasourceItT   TFormer_GetFirstDatasourceIt
#define TFormer_DatasourceItGetNameT   TFormer_DatasourceItGetName
#define TFormer_DatasourceItGetDescriptionT   TFormer_DatasourceItGetDescription
#define TFormer_GetFirstDSParameterItT   TFormer_GetFirstDSParameterIt
#define TFormer_DSParameterItGetNameT   TFormer_DSParameterItGetName
#define TFormer_DSParameterItGetDescriptionT   TFormer_DSParameterItGetDescription
#define TFormer_DSParameterItGetCaptionT   TFormer_DSParameterItGetCaption
#define TFormer_DSParameterItGetDisplayOrderT   TFormer_DSParameterItGetDisplayOrder
#define TFormer_DSParameterItGetDefValueT   TFormer_DSParameterItGetDefValue
#define TecUnzipper_AllocT   TecUnzipper_Alloc
#define TecUnzipper_ExtractT   TecUnzipper_Extract
#define TecUnzipper_GetFileT   TecUnzipper_GetFile
#define TecUnzipper_GetFilenameT   TecUnzipper_GetFilename
#define TecUnzipper_FindFileByExtT   TecUnzipper_FindFileByExt

Typedefs

typedef enum EVarType_tag EVarType
 Defines the type of a DataField.
typedef enum EPrinterType_tag EPrinterType
 Enumeration for the type of the output device.
typedef enum EVarUsage_tag EVarUsage
 Describes the usage of a DataField within a FormLayout.
typedef void * HTFRepository
typedef struct TTFORMerInstance_tag TTFORMerInstance
typedef struct
TPROJECTVAR_ITERATOR_tag 
TPROJECTVAR_ITERATOR
typedef struct TFORM_ITERATOR_tag TFORM_ITERATOR
typedef struct
TPROJECT_ITERATOR_tag 
TPROJECT_ITERATOR
typedef struct
TDATASOURCE_ITERATOR_tag 
TDATASOURCE_ITERATOR
typedef struct
TDSPARAM_ITERATOR_tag 
TDSPARAMETER_ITERATOR
typedef TTFORMerInstanceHTFORM
 Declaration of TFORMer-Instance handle.
typedef TPROJECTVAR_ITERATORHPROJECTVAR_ITERATOR
 Declaration of the DataField iterator.
typedef TFORM_ITERATORHFORM_ITERATOR
 Declaration of the FormLayout iterator.
typedef TPROJECT_ITERATORHPROJECT_ITERATOR
 Declaration of the Project iterator.
typedef TDATASOURCE_ITERATORHDATASOURCE_ITERATOR
 Declaration of the DataSource iterator ****.
typedef TDSPARAMETER_ITERATORHDSPARAMETER_ITERATOR
 Declaration of the DataSource-Parameter iterator ****.
typedef void * HTUNZIPPER
 Declaration of the Unzipper.

Enumerations

enum  EVarType_tag { eVarType_Text = 0, eVarType_Long = 1, eVarType_Float = 2, eVarType_Invalid }
 Defines the type of a DataField. More...
enum  EPrinterType_tag {
  ePrinterType_Default = 0, ePrinterType_Win32, ePrinterType_Repository, ePrinterType_Cups,
  ePrinterType_PSFile, ePrinterType_HTML, ePrinterType_PDFFile, ePrinterType_PSPrinter,
  ePrinterType_TxtPrinter, ePrinterType_TxtFile, ePrinterType_ImageBmp, ePrinterType_ImageGif,
  ePrinterType_ImageJpg, ePrinterType_ImagePcx, ePrinterType_ImagePng, ePrinterType_ImageTga,
  ePrinterType_ImageTifSingle, ePrinterType_ImageTifMultiPage, ePrinterType_ZPLPrinter, ePrinterType_ZPLFile,
  ePrinterType_Invalid
}
 Enumeration for the type of the output device. More...
enum  EVarUsage_tag {
  eVarUsage_NotUsed = 0, eVarUsage_Normal, eVarUsage_Calculated, eVarUsage_Parameter,
  eVarUsage_Invalid
}
 Describes the usage of a DataField within a FormLayout. More...

Functions

HTFORM TFormer_Init (HTFRepository hRepository)
 Allocates and initializes internal memory.
ERRCODE TFormer_Exit (HTFORM pInstance)
 Frees system resources previously allocated with TFormer_Init.
ERRCODE TFormer_SetRepositoryName (HTFORM pInstance, LPCSTR pszFileName)
 Sets the filename of the Repository or the stand-alone FormLayout.
ERRCODE TFormer_SetRepositoryNameW (HTFORM pInstance, LPCWSTR pszFileName)
ERRCODE TFormer_SetPrinterType (HTFORM pInstance, EPrinterType ePrinterType)
 Sets the type of the generated output.
ERRCODE TFormer_SetPrinterName (HTFORM pInstance, LPCSTR pszPrinterName, DEVMODE *pDevMode)
 Sets type and name of the output device.
ERRCODE TFormer_SetPrinterNameW (HTFORM pInstance, LPCWSTR pszPrinterName, DEVMODE *pDevMode)
ERRCODE TFormer_SetJobTrayControlName (HTFORM pInstance, LPCSTR pszTrayControlName)
 Specifies the name of the JobTrayControl to be used for this Job.
ERRCODE TFormer_SetJobTrayControlNameW (HTFORM pInstance, LPCWSTR pszTrayControlName)
ERRCODE TFormer_SetProjectName (HTFORM pInstance, LPCSTR pszProjectName)
 Specifies the Project-name for printing a Repository-based FormLayout.
ERRCODE TFormer_SetProjectNameW (HTFORM pInstance, LPCWSTR pszProjectName)
ERRCODE TFormer_SetFormName (HTFORM pInstance, LPCSTR pszFormName)
 Specifies the name of the Repository-based FormLayout.
ERRCODE TFormer_SetFormNameW (HTFORM pInstance, LPCWSTR pszFormName)
ERRCODE TFormer_SetDatasourceName (HTFORM pInstance, LPCSTR pszDatasourceName)
 Specifies the name of the user-defined DataSource.
ERRCODE TFormer_SetDatasourceNameW (HTFORM pInstance, LPCWSTR pszDatasourceName)
LPCSTR TFormer_GetDatasourceName (HTFORM pInstance, ERRCODE *peCode)
 Provides the name of the active DataSource of the current FormLayout.
LPCWSTR TFormer_GetDatasourceNameW (HTFORM pInstance, ERRCODE *peCode)
ERRCODE TFormer_SetDSParameterValue (HTFORM pInstance, LPCSTR pszParameterName, LPCSTR pszValue)
 Specifies the value of a DataSource-Parameter.
ERRCODE TFormer_SetDSParameterValueW (HTFORM pInstance, LPCWSTR pszParameterName, LPCWSTR pszValue)
ERRCODE TFormer_SetDataFile (HTFORM pInstance, LPCSTR pszFileName)
 Sets a XML file in internal TFORMer format as DataSource.
ERRCODE TFormer_SetDataFileW (HTFORM pInstance, LPCWSTR pszFileName)
ERRCODE TFormer_ResetData (HTFORM pInstance)
 Resets the data-cache.
ERRCODE TFormer_NewRecord (HTFORM pInstance)
 Appends a new Record to the DataSource.
ERRCODE TFormer_SetRecordCopy (HTFORM pInstance, UINT nRecordCopy)
 Sets the number of copies for the actual Record.
ERRCODE TFormer_SetVarValue (HTFORM pInstance, LPCSTR szVarName, LPCSTR szVarValue)
 Sets the value of a DataField.
ERRCODE TFormer_SetVarValueW (HTFORM pInstance, LPCWSTR szVarName, LPCWSTR szVarValue)
ERRCODE TFormer_SetReuseValues (HTFORM pInstance, BOOL bReuse)
 Selects if DataField-values should be reused in consecutive Records.
ERRCODE TFormer_SetHandleEscapeSequences (HTFORM pInstance, BOOL bOn)
 Selects whether escape sequences like \n or \x40 should be translated by TFORMer.
ERRCODE TFormer_SetNumberOfCopies (HTFORM pInstance, INT nCopies)
 Sets the number of document copies which should be printed.
ERRCODE TFormer_SetStartRowColumn (HTFORM pInstance, INT nStartCol, INT nStartRow)
 Selects the starting cell of the first label to be printed.
ERRCODE TFormer_SetOutputName (HTFORM pInstance, LPCSTR pszOutputName)
 This method is used for adjusting the output filename or the name of the spool-job (on Microsoft Windows printers).
ERRCODE TFormer_SetOutputNameW (HTFORM pInstance, LPCWSTR pszOutputName)
ERRCODE TFormer_SetPageFromTo (HTFORM pInstance, UINT nPageFrom, UINT nPageTo)
 Sets the range of page-numbers to be the printed.
void TFormer_License (LPCSTR pszLicensee, DWORD dwKind, LONG nLicenses, LPCSTR pszLicenseKey)
 Licenses this TFORMer Runtime instance.
void TFormer_LicenseW (LPCWSTR pszLicensee, DWORD dwKind, LONG nLicenses, LPCWSTR pszLicenseKey)
BOOL TFormer_IsDesignerAvailable ()
 Determines if the TFORMer Designer is available on the local machine and can be invoked by the method TFormer_OpenDesigner.
ERRCODE TFormer_OpenDesigner (HTFORM pInstance, LPCSTR pszDesignExe, BOOL bShowSplash, BOOL bMaximize, BOOL bUseExistingInstance, LPCSTR pszExtraParameters)
 Opens the currently selected FormLayout with TFORMer Designer.
ERRCODE TFormer_OpenDesignerW (HTFORM pInstance, LPCWSTR pszDesignExe, BOOL bShowSplash, BOOL bMaximize, BOOL bUseExistingInstance, LPCWSTR pszExtraParameters)
ERRCODE TFormer_SetImportFieldForRecordCopy (HTFORM pInstance, LPCSTR pszFieldName, BOOL bIsAttribute)
 Specifies which DataField in the input controls the number of Record copies.
ERRCODE TFormer_SetImportFieldForRecordCopyW (HTFORM pInstance, LPCWSTR pszFieldName, BOOL bIsAttribute)
ERRCODE TFormer_SetTxtDataFile (HTFORM pInstance, LPCSTR pszFileName, CHAR cSeparator, CHAR cTextQualifier)
 Specifies a text-file as DataSource.
ERRCODE TFormer_SetTxtDataFileW (HTFORM pInstance, LPCWSTR pszFileName, WCHAR cSeparator, WCHAR cTextQualifier)
ERRCODE TFormer_SetODBCData (HTFORM pInstance, LPCSTR pszDSN, LPCSTR pszUser, LPCSTR pszPwd, LPCSTR pszSQLSelect)
 Specifies an ODBC DataSource.
ERRCODE TFormer_SetODBCDataW (HTFORM pInstance, LPCWSTR pszDSN, LPCWSTR pszUser, LPCWSTR pszPwd, LPCWSTR pszSQLSelect)
ERRCODE TFormer_SetXmlDataFile (HTFORM pInstance, LPCSTR pszFileName)
 Specifies a XML-File as DataSource.
ERRCODE TFormer_SetXmlDataFileW (HTFORM pInstance, LPCWSTR pszFileName)
ERRCODE TFormer_SetXmlDataFileEx (HTFORM pInstance, LPCSTR pszFileName, LPCSTR pszXsltFileName, LPCSTR pszXsltTFC)
 Specifies a XML-File as DataSource and transforms it with the given XSLT.
ERRCODE TFormer_SetXmlDataFileExW (HTFORM pInstance, LPCWSTR pszFileName, LPCWSTR pszXsltFileName, LPCWSTR pszXsltTFC)
ERRCODE TFormer_SaveXml (HTFORM pInstance, LPCSTR pszFileName)
 Saves the actual data as XML File in the internal TFORMer format.
ERRCODE TFormer_SaveXmlW (HTFORM pInstance, LPCWSTR pszFileName)
ERRCODE TFormer_SetConfigFile (HTFORM pInstance, LPCSTR pszFilename)
 Sets the configuration file for TFORMer Runtime.
ERRCODE TFormer_SetConfigFileW (HTFORM pInstance, LPCWSTR pszFilename)
ERRCODE TFormer_Print (HTFORM pInstance)
 Prints the current FormLayout using the adjusted DataSource.
LPCSTR TFormer_GetLastErrorDescription (HTFORM pInstance)
 Returns the last error description as string.
LPCWSTR TFormer_GetLastErrorDescriptionW (HTFORM pInstance)
LPCSTR TFormer_GetLastErrorInformation (HTFORM pInstance)
 Returns the last error information as string.
LPCWSTR TFormer_GetLastErrorInformationW (HTFORM pInstance)
LPCSTR TFormer_GetLastErrorSource (HTFORM pInstance)
 Returns the last error source as string.
LPCWSTR TFormer_GetLastErrorSourceW (HTFORM pInstance)
LONG TFormer_RefreshOSPrinters (HTFORM pInstance)
 Refreshes the internal list of (operating system) printers available for the current user.
LONG TFormer_GetOSPrintersCount (HTFORM pInstance)
 Returns the number of (operating system) printers available for the current user.
LPCSTR TFormer_GetOSPrinter (HTFORM pInstance, LONG nIndex)
 Returns the name of the (operating system) printer with the specified index.
LPCWSTR TFormer_GetOSPrinterW (HTFORM pInstance, LONG nIndex)
LPCSTR TFormer_GetOSDefaultPrinter (HTFORM pInstance)
 Returns the name of the default (operating system) printer of the current user.
LPCWSTR TFormer_GetOSDefaultPrinterW (HTFORM pInstance)
ERRCODE TFormer_AddNewProject (HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszProjectDesc)
 Creates and adds a new Project to the Repository.
ERRCODE TFormer_AddNewProjectW (HTFORM pInstance, LPCWSTR pszProjectName, LPCWSTR pszProjectDesc)
ERRCODE TFormer_DeleteProject (HTFORM pInstance, LPCSTR pszProjectName)
 Deletes a Project from the Repository.
ERRCODE TFormer_DeleteProjectW (HTFORM pInstance, LPCWSTR pszProjectName)
ERRCODE TFormer_AddNewForm (HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszFormName, LPCSTR pszFormDesc, LPCSTR pszFormDesign, LPCSTR pszFormFile)
 Adds a new Form to the given Project.
ERRCODE TFormer_AddNewFormW (HTFORM pInstance, LPCWSTR pszProjectName, LPCWSTR pszFormName, LPCWSTR pszFormDesc, LPCWSTR pszFormDesign, LPCWSTR pszFormFile)
ERRCODE TFormer_DeleteForm (HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszFormName)
 Deletes a FormLayout from the specified Project.
ERRCODE TFormer_DeleteFormW (HTFORM pInstance, LPCWSTR pszProjectName, LPCWSTR pszFormName)
ERRCODE TFormer_AddNewVar (HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszVarName, EVarType eVType)
 Adds a new DataField to the specified Project.
ERRCODE TFormer_AddNewVarW (HTFORM pInstance, LPCWSTR pszProjectName, LPCWSTR pszVarName, EVarType eVType)
ERRCODE TFormer_DeleteVar (HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszVarName)
 Deletes a DataField from the specified Project.
ERRCODE TFormer_DeleteVarW (HTFORM pInstance, LPCWSTR pszProjectName, LPCWSTR pszVarName)
HPROJECT_ITERATOR TFormer_GetFirstProjectIt (HTFORM pInstance, ERRCODE *peCode)
 Creates a new iterator and sets its position to the first Project within the Repository.
ERRCODE TFormer_GetNextProjectIt (HPROJECT_ITERATOR hProjectIt)
 Moves the iterator to the next Project within the Repository.
LPCSTR TFormer_ProjectItGetName (HPROJECT_ITERATOR hProjectIt, ERRCODE *peCode)
 Returns the name of the Project the iterator is pointing to.
LPCWSTR TFormer_ProjectItGetNameW (HPROJECT_ITERATOR hProjectIt, ERRCODE *peCode)
LPCSTR TFormer_ProjectItGetDescription (HPROJECT_ITERATOR hProjectIt, ERRCODE *peCode)
 Returns the description of the Project the iterator is pointing to.
LPCWSTR TFormer_ProjectItGetDescriptionW (HPROJECT_ITERATOR hProjectIt, ERRCODE *peCode)
void TFormer_FreeProjectIt (HPROJECT_ITERATOR hProjectIt)
 Releases the Project iterator and frees any resources associated with it.
HFORM_ITERATOR TFormer_GetFirstFormIt (HTFORM pInstance, LPCSTR pszProjectName, ERRCODE *peCode)
 Returns an iterator pointing to the first FormLayout in the specified Project.
HFORM_ITERATOR TFormer_GetFirstFormItW (HTFORM pInstance, LPCWSTR pszProjectName, ERRCODE *peCode)
ERRCODE TFormer_GetNextFormIt (HFORM_ITERATOR hFormIt)
 Move the iterator to the next FormLayout within the Project.
LPCSTR TFormer_FormItGetName (HFORM_ITERATOR hFormIt, ERRCODE *peCode)
 Returns the name of the FormLayout the iterator is pointing to.
LPCWSTR TFormer_FormItGetNameW (HFORM_ITERATOR hFormIt, ERRCODE *peCode)
LPCSTR TFormer_FormItGetDescription (HFORM_ITERATOR hFormIt, ERRCODE *peCode)
 Returns the description of the FormLayout the iterator is pointing to.
LPCWSTR TFormer_FormItGetDescriptionW (HFORM_ITERATOR hFormIt, ERRCODE *peCode)
void TFormer_FreeFormIt (HFORM_ITERATOR hFormIt)
 Releases the FormLayout iterator and frees any resources associated with it.
HPROJECTVAR_ITERATOR TFormer_GetFirstProjectVarIt (HTFORM pInstance, LPCSTR pszProjectName, ERRCODE *peCode)
 Returns an iterator pointing to the first DataField in the specified Project.
HPROJECTVAR_ITERATOR TFormer_GetFirstProjectVarItW (HTFORM pInstance, LPCWSTR pszProjectName, ERRCODE *peCode)
ERRCODE TFormer_GetNextProjectVarIt (HPROJECTVAR_ITERATOR hProjectVarIt)
 Move the iterator to the next DataField within the Project.
LPCSTR TFormer_ProjectVarItGetName (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
 Returns the name of the DataField the iterator is pointing to.
LPCWSTR TFormer_ProjectVarItGetNameW (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
LPCSTR TFormer_ProjectVarItGetDescription (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
 Returns the description of the DataField the iterator is pointing to.
LPCWSTR TFormer_ProjectVarItGetDescriptionW (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
LPCSTR TFormer_ProjectVarItGetCaption (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
 Returns the caption of the DataField the iterator is pointing to.
LPCWSTR TFormer_ProjectVarItGetCaptionW (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
LPCSTR TFormer_ProjectVarItGetDisplayOrder (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
 Returns the display-order of the DataField the iterator is pointing to.
LPCWSTR TFormer_ProjectVarItGetDisplayOrderW (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
void TFormer_FreeProjectVarIt (HPROJECTVAR_ITERATOR hProjectVarIt)
 Releases the DataField iterator and frees any resources associated with it.
LPCSTR TFormer_ProjectVarItGetDefValue (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
 Returns the default-value of the DataField the iterator is pointing to.
LPCWSTR TFormer_ProjectVarItGetDefValueW (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
EVarType TFormer_ProjectVarItGetType (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
 Returns the data-type of the DataField the iterator is pointing to.
EVarUsage TFormer_ProjectVarItGetUsage (HTFORM pInstance, HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
 Returns the usage of the DataField specified with the iterator.
EVarUsage TFormer_GetVarUsage (HTFORM pInstance, LPCSTR pszVarName, ERRCODE *peCode)
 Retrieves the usage of the DataField specified by its name.
EVarUsage TFormer_GetVarUsageW (HTFORM pInstance, LPCWSTR pszVarName, ERRCODE *peCode)
HDATASOURCE_ITERATOR TFormer_GetFirstDatasourceIt (HTFORM pInstance, LPCSTR pszProjectName, ERRCODE *peCode)
 Returns an iterator pointing to the first DataSource in the specified Project.
HDATASOURCE_ITERATOR TFormer_GetFirstDatasourceItW (HTFORM pInstance, LPCWSTR pszProjectName, ERRCODE *peCode)
ERRCODE TFormer_GetNextDatasourceIt (HDATASOURCE_ITERATOR hDatasourceIt)
 Move the iterator to the next DataSource within the Project.
LPCSTR TFormer_DatasourceItGetName (HDATASOURCE_ITERATOR hDatasourceIt, ERRCODE *peCode)
 Returns the name of the DataSource the iterator is pointing to.
LPCWSTR TFormer_DatasourceItGetNameW (HDATASOURCE_ITERATOR hDatasourceIt, ERRCODE *peCode)
LPCSTR TFormer_DatasourceItGetDescription (HDATASOURCE_ITERATOR hDatasourceIt, ERRCODE *peCode)
 Returns the description of the DataSource the iterator is pointing to.
LPCWSTR TFormer_DatasourceItGetDescriptionW (HDATASOURCE_ITERATOR hDatasourceIt, ERRCODE *peCode)
void TFormer_FreeDatasourceIt (HDATASOURCE_ITERATOR hDatasourceIt)
 Releases the DataSource iterator and frees any resources associated with it.
HDSPARAMETER_ITERATOR TFormer_GetFirstDSParameterIt (HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszDatasourceName, ERRCODE *peCode)
 Returns an iterator pointing to the first DataSource-Parameter of the specified DataSource in the specified Project.
HDSPARAMETER_ITERATOR TFormer_GetFirstDSParameterItW (HTFORM pInstance, LPCWSTR pszProjectName, LPCWSTR pszDatasourceName, ERRCODE *peCode)
ERRCODE TFormer_GetNextDSParameterIt (HDSPARAMETER_ITERATOR hIt)
 Move the iterator to the next DataSource-Parameter within the DataSource.
LPCSTR TFormer_DSParameterItGetName (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
 Returns the name of the DataSource-Parameter the iterator is pointing to.
LPCWSTR TFormer_DSParameterItGetNameW (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
LPCSTR TFormer_DSParameterItGetDescription (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
 Returns the description of the DataSource-Parameter the iterator is pointing to.
LPCWSTR TFormer_DSParameterItGetDescriptionW (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
LPCSTR TFormer_DSParameterItGetCaption (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
 Returns the caption of the DataSource-Parameter the iterator is pointing to.
LPCWSTR TFormer_DSParameterItGetCaptionW (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
LPCSTR TFormer_DSParameterItGetDisplayOrder (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
 Returns the display-order of the DataSource-Parameter the iterator is pointing to.
LPCWSTR TFormer_DSParameterItGetDisplayOrderW (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
LPCSTR TFormer_DSParameterItGetDefValue (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
 Returns the default-value of the DataSource-Parameter the iterator is pointing to.
LPCWSTR TFormer_DSParameterItGetDefValueW (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
void TFormer_FreeDSParameterIt (HDSPARAMETER_ITERATOR hIt)
 Releases the DataSource-Parameter iterator and frees any resources associated with it.
HTUNZIPPER TecUnzipper_Alloc (LPCSTR pszFilename)
 Allocated memory for a new unzipper handle.
HTUNZIPPER TecUnzipper_AllocW (LPCWSTR pszFilename)
 Allocated memory for a new unzipper handle.
VOID TecUnzipper_Free (HTUNZIPPER htUnzipper)
 Deallocates memory allocated by TecUnzipper_Alloc.
ERRCODE TecUnzipper_DeleteAllFiles (HTUNZIPPER htUnzipper)
 Deletes all files and directories on disk that have been created by TecUnzipper_Extract.
ERRCODE TecUnzipper_Base64Decode (HTUNZIPPER htUnzipper)
 Tests if the passed to TecUnzipper_Alloc is a BASE64 encoded string and decodes it to a temporary file.
ERRCODE TecUnzipper_Extract (HTUNZIPPER htUnzipper, LPCSTR pszDirectory)
 Extracts a ZIP file into a temporary directory.
ERRCODE TecUnzipper_ExtractW (HTUNZIPPER htUnzipper, LPCWSTR pszDirectory)
 Extracts a ZIP file into a temporary directory.
INT TecUnzipper_GetFileCount (HTUNZIPPER htUnzipper)
 Returns the number of files that have been extracted.
LPCSTR TecUnzipper_GetFile (HTUNZIPPER htUnzipper, INT nIndex)
 Returns the filename with the specified index (0.
LPCWSTR TecUnzipper_GetFileW (HTUNZIPPER htUnzipper, INT nIndex)
INT TecUnzipper_FindFileByExt (HTUNZIPPER htUnzipper, LPCSTR pszExtension, INT nStartIndex, BOOL bCaseInsensitiveSearch)
 Finds the first file in the set of extracted files that matches the specified file extension.
INT TecUnzipper_FindFileByExtW (HTUNZIPPER htUnzipper, LPCWSTR pszExtension, INT nStartIndex, BOOL bCaseInsensitiveSearch)
 Finds the first file in the set of extracted files that matches the specified file extension.
LPSTR TecUnzipper_Base64_Encode (LPCSTR szData, LONG lLen)
 Creates a BASE64 encoded string.
VOID TecUnzipper_Base64_Free (LPSTR szStr)
 Free a BASE64 encoded string created with TecUnzipper_Base64_Encode.
LPCSTR TecUnzipper_GetFilename (HTUNZIPPER htUnzipper)
 Returns the filename of the zip file being used or of the temp file created by TecUnzipper_Base64Decode.
LPCWSTR TecUnzipper_GetFilenameW (HTUNZIPPER htUnzipper)

Detailed Description

Header File for TFormer6.0
Include this header file in your modules to access the TFORMer Runtime API.

Attention:
Do not forget to define TECIT_DLLIMPORT before including this header file!
 #define TECIT_DLLIMPORT
 #include "TFormer6.h"
 #undef  TECIT_DLLIMPORT


Author:
TEC-IT Datenverarbeitung GmbH

Hans-Wagner Str. 6, A-4400 Steyr, AUSTRIA/EUROPE

http://www.tec-it.com

Copyright© by TEC-IT Datenverarbeitung GmbH

Date:
1996-2009
Version:
6.0
Note:
For support requests please send an email to support@tec-it.com

© 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