DTWAIN_GetNameFromCap

Top Previous Next

The DTWAIN_GetNameFromCap function gets the string version of the capability name.

LONG DTWAIN_GetNameFromCap (

LONG	Capability,
LPTSTR	szBuffer,
LONG	MaxLen );

Parameters

Capability

The capability that is to be retrieved.

szBuffer

Specifies the address of the character buffer to store the capability name, or NULL.

MaxLen

Specifies the maximum number of characters to copy to szBuffer.

Return Values

If the function succeeds, the length of the string stored in szBuffer, or if szBuffer is NULL, the length of the string required to store the entire capability name. If the function fails, DTWAIN_FAILURE1 is returned.

Character specific version

ANSI version:	DTWAIN_GetNameFromCapA
Unicode version:	DTWAIN_GetNameFromCapW

Comments

The DTWAIN_GetNameFromCap function fills szBuffer with the string version of the capability name that is equivalent to Capability. The Maxlen argument is the maximum number of characters to copy to szBuffer, including the trailing null character. For example, if Capability is DTWAIN_ICAP_BITDEPTH, szBuffer will be filled with "ICAP_BITDEPTH". If the capability is a custom capability, szBuffer is filled with the string "CAP_CUSTOMBASE + ", where " " is an integer denoting the custom capability value minus 32768.

If szBuffer is NULL, then the MaxLen argument is ignored, and the return value is the number of characters required to store the entire capability name, including the terminating NULL character. No characters are copied to szBuffer if szBuffer is NULL.

TWAIN State Transitions

None

Prerequisite Function Call(s)

DTWAIN_SysInitialize