LTwain::TemplateDlg

#include "ltwrappr.h"

virtual L_INT LTwain::TemplateDlg (lpszTemplateFile)

L_TCHAR * lpszTemplateFile;

/* pointer to a character string */

Displays the TWAIN source manufacturer's template dialog, without actually acquiring an image.

Parameter	Description
lpsztemplateFile	A character string that contains the name of the template file used in the saving the capability values.

Returns

SUCCESS	The function was successful.
<1	An error occurred. Refer to Return Codes.

Comments

This function saves the current values of all the supported capabilities to the specified file.

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::SaveCapCallBack, LTwain::SaveErrorCallBack, LTwain::OpenTemplateFile, LTwain::AddCapabilityToFile, LTwain::GetCapabilityFromFile, LTwain::GetNumOfCapsInFile, LTwain::CloseTemplateFile, LTwain::InitSession, LTwain::EndSession.
Topics:	Handling Template Files
	TWAIN Functionality: Template File Functions.

Example

class CMyTwain : public LTwain
{
public:
   L_INT SaveCapCallBack(pTW_CAPABILITY pCapability);
   L_INT SaveErrorCallBack(pTW_CAPABILITY pCapability, L_UINT uError);
};

L_INT CMyTwain::SaveCapCallBack(pTW_CAPABILITY pCapability)
{
   // Do pre operations on data to save
   return SUCCESS;
}

L_INT CMyTwain::SaveErrorCallBack(pTW_CAPABILITY pCapability, L_UINT uError)
{
   // Do the error handling
   return SUCCESS;
}

void TestTemplateDlg(L_TCHAR L_FAR * pszFileName, CMyTwain *MyClass)
{
   MyClass->EnableCallBack(TRUE);
   L_INT nRet = MyClass->TemplateDlg (pszFileName);
   if (nRet != SUCCESS)
   {
      // Error check procedure
   }
}