Repository Access
[DLL]

Access and modify Repositories or stand-alone FormLayouts. More...

Collaboration diagram for Repository Access:

Functions

ERRCODE TFormer_AddNewProject (HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszProjectDesc)
 Creates and adds a new Project to the Repository.
ERRCODE TFormer_DeleteProject (HTFORM pInstance, LPCSTR pszProjectName)
 Deletes a Project from the Repository.
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_DeleteForm (HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszFormName)
 Deletes a FormLayout from the specified Project.
ERRCODE TFormer_AddNewVar (HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszVarName, EVarType eVType)
 Adds a new DataField to the specified Project.
ERRCODE TFormer_DeleteVar (HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszVarName)
 Deletes a DataField from the specified Project.
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.
LPCSTR TFormer_ProjectItGetDescription (HPROJECT_ITERATOR hProjectIt, ERRCODE *peCode)
 Returns the description of the Project the iterator is pointing to.
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.
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.
LPCSTR TFormer_FormItGetDescription (HFORM_ITERATOR hFormIt, ERRCODE *peCode)
 Returns the description of the FormLayout the iterator is pointing to.
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.
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.
LPCSTR TFormer_ProjectVarItGetDescription (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
 Returns the description of the DataField the iterator is pointing to.
LPCSTR TFormer_ProjectVarItGetCaption (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
 Returns the caption of the DataField the iterator is pointing to.
LPCSTR TFormer_ProjectVarItGetDisplayOrder (HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE *peCode)
 Returns the display-order of the DataField the iterator is pointing to.
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.
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.
HDATASOURCE_ITERATOR TFormer_GetFirstDatasourceIt (HTFORM pInstance, LPCSTR pszProjectName, ERRCODE *peCode)
 Returns an iterator pointing to the first DataSource in the specified Project.
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.
LPCSTR TFormer_DatasourceItGetDescription (HDATASOURCE_ITERATOR hDatasourceIt, ERRCODE *peCode)
 Returns the description of the DataSource the iterator is pointing to.
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.
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.
LPCSTR TFormer_DSParameterItGetDescription (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
 Returns the description of the DataSource-Parameter the iterator is pointing to.
LPCSTR TFormer_DSParameterItGetCaption (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
 Returns the caption of the DataSource-Parameter the iterator is pointing to.
LPCSTR TFormer_DSParameterItGetDisplayOrder (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
 Returns the display-order of the DataSource-Parameter the iterator is pointing to.
LPCSTR TFormer_DSParameterItGetDefValue (HDSPARAMETER_ITERATOR hIt, ERRCODE *peCode)
 Returns the default-value of the DataSource-Parameter the iterator is pointing to.
void TFormer_FreeDSParameterIt (HDSPARAMETER_ITERATOR hIt)
 Releases the DataSource-Parameter iterator and frees any resources associated with it.

Detailed Description

Access and modify Repositories or stand-alone FormLayouts.

Repository based FormLayouts:
A Repository is a data-structure which references an arbitrary number of FormLayout-objects. User-defined Project-objects are used to divide a Repository into logical areas.

Each FormLayout referenced from within a Repository is a member of exactly one Project. DataFields defined within a Project are only usable by FormLayouts which are member of this Project.

The so-called GlobalProject is allocated by default and is exclusively used to define DataFields which are available for all FormLayouts (regardless of their actual Project-membership). It can not store references to a FormLayout.

The Repository also stores JobTrayControl-objects. They may be used whenever printing any FormLayout referenced by this Repository (see TFormer_SetJobTrayControlName).

When printing a specific FormLayout within a Repository 3 parameters must be specified to identify the FormLayout:

Remarks:
A Repository uses the file extension *.tfr. A sample Repository is usually installed in
  • Windows Vista: C:/Program Data/TEC-IT/TFORMer/6.0/Examples/Demo Repository/Demos.tfr
  • Other versions of Microsoft Windows: C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/6.0/Examples/Demo Repository

Stand-alone FormLayouts:
A stand-alone FormLayout can be used on its own. It can be imagined like a very simple type of Repository which contains exactly one GlobalProject which stores the DataField-definitions as well as the FormLayout itself.

A stand-alone FormLayout is not able to share DataField-definitions with other FormLayouts and can not contain user-defined Project-objects.

The stand-alone FormLayout also stores JobTrayControl-objects. They may be used whenever printing this FormLayout (see TFormer_SetJobTrayControlName).

When printing a Job using a stand-alone FormLayout 1 parameter must be specified:
Note:
Do not use TFormer_SetProjectName and TFormer_SetFormName when using a stand-alone FormLayout!
Remarks:
A stand-alone FormLayout uses the file extension *.tff. Sample FormLayouts are usually installed in
  • Windows Vista: C:/Program Data/TEC-IT/TFORMer/6.0/Examples/Command Line
  • Other versions of Microsoft Windows: C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/6.0/Examples/Command Line

© 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