Method AddErrorToSMLResponse

Core/ConnectionSML/src/sml_Connection.cpp:1014–1053

* @brief Adds an tag and an error message to a response message. * * @param pResponse The response message we are adding an error to. * @param pErrorMsg A description of the error in a form presentable to the user * @param errorCode An optional numeric code for the error (to support programmatic responses to the error) *************************************************************/

* @param errorCode  An optional numeric code for the error (to support programmatic responses to the error)
*************************************************************/
void Connection::AddErrorToSMLResponse(ElementXML* pResponse, char const* pErrorMsg, int errorCode /* = -1 */)
{
    ClearError() ;
    
#ifdef DEBUG
    if (!pResponse || !pErrorMsg)
    {
        SetError(Error::kNullArgument) ;
        return ;
    }
    
    if (!pResponse->IsTag(sml_Names::kTagSML))
    {
        SetError(Error::kArgumentIsNotSML) ;
        return ;
    }
#endif
    // Create a result tag so if you only
    // check for results you still get an error message.
    // Also add an error tag, so we can distinguish between
    // errors and success based on message structure.
    TagResult* pTag = new TagResult() ;
    
    pTag->SetCharacterData(pErrorMsg) ;
    pTag->AddAttributeFastFast(sml_Names::kCommandOutput, sml_Names::kRawOutput) ;
    
    pResponse->AddChild(pTag) ;
    
    // Create the error tag
    TagError* pError = new TagError() ;
    
    pError->SetDescription(pErrorMsg) ;
    
    if (errorCode != -1)
    {
        pError->SetErrorCode(errorCode) ;
    }
    
    pResponse->AddChild(pError) ;
}

/*************************************************************
* @brief Adds a <result> tag and fills in character data for that result.