Name

 
videoGetErrorText --- Retrieve a text description of the error identified by the error code
 
 

Syntax

 #include <mme/mme_api.h>
 MMRESULT videoGetErrorText(HVIDEO hVideo,
                           UINT wError,
                           LPSTR lpText,
                           UINT uSize);
 

Arguments

 
HVIDEO hVideo
Specifies a handle to a video device channel.

 
UINT wError
Specifies the error code.

 
LPSTR lpText
Specifies a pointer to a buffer that is filled with a null-terminated string corresponding to the error code. Memory for lpText must be allocated with the mmeAllocMem function. 

 
UINT uSize
Specifies the length in bytes of the buffer pointed to by lpText. 
 
 

Description

 
The videoGetErrorText function retrieves a description of the error identified by the error code.  All error descriptions are fewer than MAXERRORLENGTH characters long.  If the error description is longer than the buffer, the description is truncated.  The returned error string is always null terminated.  If uSize is zero, nothing is copied and the function returns DV_ERR_OK. 
 

Extensions

 
None.
 
 

Return Values

 
Returns DV_ERR_OK if the function is successful; otherwise, it returns one of the following error codes:
 
 

 
DV_ERR_INVALHANDLE@T{ The specified device handle is invalid. T} DV_ERR_BADERRNUM@T{ The specified error number is out of range. T}

See Also

 
None.