LTwain::OpenTemplateFile

#include "ltwrappr.h"

virtual L_INT LTwain::OpenTemplateFile (phFile, lpszTemplateFile, uAccess)

HTWAINTEMPLATEFILE * phFile;

/* handle to an existing template file */

L_TCHAR * lpszTemplateFile;

/* pointer to a character string */

L_UINT uAccess;

/* optional flag */

Opens the specified template file for loading or saving data.

Parameter

Description

phFile

Pointer to a HTWAINTEMPLATEFILE file handle.

lpszTemplateFile

Character string that contains the name of the template file to open. A LEADTOOLS template files extension is .ltt.

uAccess

Flag that indicates the access type for opening the file.  Possible values are:

 

Value

Meaning

 

LTWAIN_TEMPLATE_OPEN_READ

[0] Open the template file for reading. This should be used to load data from an existing template file.

 

LTWAIN_TEMPLATE_OPEN_WRITE

[1] Open the template file for writing. This should be used to save data to a template file.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

A template file can be opened for either reading or writing, but not both.

For more information on template files, refer to Handling Template Files.

When a file is opened for writing, a new file is created.

Required DLLs and Libraries

LTTWN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LTwain::TemplateDlg, LTwain::AddCapabilityToFile, LTwain::GetCapabilityFromFile, LTwain::GetNumOfCapsInFile, LTwain::CloseTemplateFile, LTwain::InitSession, LTwain::EndSession

Topics:

Handling Template Files

 

TWAIN Functionality: Template File Functions.

Example

For an example, refer to LTwain::AddCapabilityToFile.