|
DTWAIN_GetExtImageInfoData |
Top Previous Next |
|
The DTWAIN_GetExtImageInfoData function returns the extended image information for a Source when a successful acquisition has been done.
DTWAIN_BOOL DTWAIN_GetExtImageInfoData (
Parameters Source Specifies a TWAIN Source.
ExtInfoType One of the DTWAIN Extended Image Info types.
pArray Address of a DTWAIN_ARRAY that will store the returned data.
Return Values If the function succeeds, TRUE is returned. If the function fails, FALSE is returned.
Comments The DTWAIN_GetExtImageInfoData function returns the Extended Image Information from the Source, Source. The Extended Image Information can only be retrieved when the DTWAIN_TN_TRANSFERDONE notification is sent to your application (see DTWAIN notification processing). If this function is called at any other time, the return value will be FALSE. Call DTWAIN_GetLastError to determine the actual error if FALSE is returned.
The ExtInfoType is the desired extended information, and must be one of the DTWAIN Extended Image Info constants. The Extended Image Information contains extra information concerning bar codes, shading, endorser text, etc.
The pArray argument is a pointer to a DTWAIN_ARRAY. On return of DTWAIN_GetExtImageInfoData, pArray will be populated by DTWAIN with the values. You must make sure that when retrieving the values from the DTWAIN_ARRAY, that your application knows the type of data that is stored there. The DTWAIN Extended Image Info constants also contain the data types of the values stored for the particular extended image information type.
Alternately, you can call DTWAIN_ArrayGetType to determine the type of values stored in the DTWAIN_ARRAY when DTWAIN_GetExtImageInfoData returns.
TWAIN State Transitions The Source must be in State 7.
Prerequisite Function Call(s)
|