Description

The GetErrorDescription method returns a text description of an xcdCompressionError enumeration member.

This method is particularly useful in order to translate an error code into English text in order to display a more detailed error than just an error code value.

For example, to assign the description of the xceInvalidPassword (value 1004) error to a string, do this:

DescribeError = XceedCompression1.GetErrorDescription(1004);

or

DescribeError = XceedCompression1.GetErrorDescription(xceInvalidPassword); 

Method GetErrorDescription(lValue As Long) As String                    

UINT XcGetErrorDescription( HXCEEDCMP hComp, int nCode, TCHAR* pszBuffer, UINT uMaxLength )                    

Parameters

Return values

Returns the string containing the text description. If a non-existent member value is passed in the lValue parameter, an empty string will be returned.