L_TwainOpenTemplateFile

Summary

Opens the specified template file for loading or saving data.

Syntax

#include "lttwn.h"

L_LTTWN_API L_INT L_TwainOpenTemplateFile (hSession, phFile, lpszTemplateFile, uAccess)

Parameters

HTWAINSESSION hSession

Handle to an existing TWAIN session. This handle is obtained by calling the L_TwainInitSession or L_TwainInitSession2 function.

HTWAINTEMPLATEFILE * phFile

Pointer to a HTWAINTEMPLATEFILE file handle.

L_TCHAR * lpszTemplateFile

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

L_UINT 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

Value Meaning
SUCCESS The function was successful.
! = SUCCESS An error occurred. Refer to Return Codes.

Comments

Slight rewording.

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

See Also

Functions

Topics

Example

For an example, refer to L_TwainAddCapabilityToFile.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS TWAIN C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.