Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

Function kcHttpGetPath

The function kcHttpGetPath returns the path of the HTTP request normalized with KC_HTTP_NORM_UNRESERVED.

This function may be called both in program unit and HTTP exit program.
In the program unit the function may only called in the first program unit run of a service.

Function declaration kcHttpGetPath
kc_http_retcode kcHttpGetPath( char *  httpPath,
                               int *   httpPathLth
                             );
This function has following function parameter:
<<httpPathThe pointer to a buffer in which the path of the HTTP request is returned. The length of the buffer must be at least httpPathLth bytes.
<>httpPathLthThe pointer to a variable in which the length of the buffer for the path of the HTTP request is passed and the actual length of the path is returned.
Description of returned value of function call:

KC_HTTP_OK

The function has successfully terminated.

KC_HTTP_FUNCTION_CALL_NOT_ALLOWED

The function was called by the KDCS program unit before the KDCS call INIT was executed or not in the first program unit run or outside an HTTP exit program.

KC_HTTP_NO_HTTP_CLIENT

The calling service was not initiated by an HTTP client.

KC_HTTP_PARAM_VALUE_NULL

The pointer to the buffer for the path httpPath or the pointer to the length of the path httpPathLth is NULL.

KC_HTTP_INVALID_LENGTH

The value of the length of path httpPathLth is lower or equal 0.

KC_HTTP_RESULT_TRUNCATED

The length of the buffer for the path is less than the actual length of the path. The path is truncated and the actual length is returned.