capGetDriverDescriptionA function (vfw.h)
The capGetDriverDescription function retrieves the version description of the capture driver.
Syntax
BOOL VFWAPI capGetDriverDescriptionA(
UINT wDriverIndex,
LPSTR lpszName,
int cbName,
LPSTR lpszVer,
int cbVer
);
Parameters
wDriverIndex
Index of the capture driver. The index can range from 0 through 9.
Plug-and-Play capture drivers are enumerated first, followed by capture drivers listed in the registry, which are then followed by capture drivers listed in SYSTEM.INI.
lpszName
Pointer to a buffer containing a null-terminated string corresponding to the capture driver name.
cbName
Length, in bytes, of the buffer pointed to by lpszName.
lpszVer
Pointer to a buffer containing a null-terminated string corresponding to the description of the capture driver.
cbVer
Length, in bytes, of the buffer pointed to by lpszVer.
Return value
Returns TRUE if successful or FALSE otherwise.
Remarks
If the information description is longer than its buffer, the description is truncated. The returned string is always null-terminated. If a buffer size is zero, its corresponding description is not copied.
Note
The vfw.h header defines capGetDriverDescription as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | vfw.h |
| Library | Vfw32.lib |
| DLL | Avicap32.dll |