DTWAIN_GetSaveFileName

The DTWAIN_GetSaveFileName function gets the full path name of the file that will be saved on acquisition.  This function can only be used during the acquisition process.

LONG  DTWAIN_GetSaveFileName (

Parameters

Source

An open TWAIN Source.

lpFilename

String buffer.  On return, this is filled in with the current file name.  Ignored if value is NULL.

MaxLen

Maximum number of characters to write to lpFilename.  This argument is ignored if lpResolution is NULL.

Return Values

The return value is the total number of characters copied to lpFilename, or if lpFileName is NULL, the total number of characters that make up the file name.

Character specific version

Comments

The DTWAIN_GetSaveFileName returns the name of the file that will be saved when DTWAIN_AcquireFile or DTWAIN_AcquireFileEx is used.  This function can only be used during the acquisition process, thus it will only return a valid name during DTWAIN Notification Processing

.

The notification that the DTWAIN_GetSaveFileName is most used for is DTWAIN_TN_FILENAMECHANGING.  If an application desires to change the name of the file during the acquisition process, the DTWAIN_GetSaveFileName can be used to retrieve the current file name, and a subsequent call to DTWAIN_SetSaveFileName can be used to change the name of the file during these notifications.

TWAIN State Transitions

The Source must be in State 4. or higher

Prerequisite Function Call(s)

DTWAIN_SysInitialize.

DTWAIN Source Selection Function