Component Architecture Debug Interface v2.0 Developer Guide
Home > Class Reference > The CADI class > CADI::CADIXfaceGetError()

A.8.5. CADI::CADIXfaceGetError()

If an error is detected, this routine is called to get the error message.

virtual CADIReturn_t CADI::CADIXfaceGetError(uint32_t maxMessageLength, 
                                             uint32_t * actualMessageLength,
                                             char * errorMessage) =0;

where:

maxMessageLength

is the max length of errorMessage array. The target must not fill more than this number of characters in the array.

actualMessageLength

is the max length of errorMessage array. The target must set this to the actual number of chars written into the errorMessage buffer.

errorMessage

is the actual error message text. The target writes the text into this character buffer. The length of this buffer is exactly maxMessageLength.

Copyright © 2008-2011 ARM. All rights reserved.ARM DUI 0444H
Non-ConfidentialID010512
PDF file icon  PDF version
Home > Class Reference > The CADI class > CADI::CADIXfaceGetError()