mcorest_api_failure

Record details of a handler failure.

For an overview see page Web Services

Prototypes

 
    MCOREST_API void mcorest_api_failure(mcohs_request_h req, 
                            const char *file, 
                            int line, 
                            int is_internal);
 

Arguments

req Failed MCO EWS HTTP request
file Name of the file where the failure was detected
line Line of code where the failure was detected
is_internal Set to non-zero to indicate that the error is internal to the service and was not caused by an invalid request

Description

This function records details of a handler failure. This information will be returned to the REST API caller. No data should be written into the request after this function is called. Subsequent calls are ignored. The is_internal flag indicates that the failure is internal to the service, as opposed to being caused by an invalid request. Internal errors are reported to the REST API client using HTTP status code 500; external ones are reported using HTTP status code 400.

Return Codes

void No value returned

Files

Header file:
mcorestapi.h
Source file:
mcorestapi.c
Library:
libmcorest.a