The function kcHttpGetScheme returns the scheme of the HTTP request. The scheme is returned in the form in which it is contained in the URL, e.g. 'https'.
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.
kc_http_retcode kcHttpGetScheme( char * scheme,
int * schemeLth
);
This function has following function parameter:
| << | scheme | The pointer to a buffer in which the scheme of the HTTP request is returned. The length of the buffer must be at least schemeLth bytes. |
| <> | schemeLth | The pointer to a variable in which the length of the buffer for the scheme of the HTTP request is passed and the actual length of the scheme 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 scheme scheme or the pointer to the length of the scheme schemeLth is NULL.
KC_HTTP_INVALID_LENGTH
The value of the length of scheme schemeLth is lower or equal 0.
KC_HTTP_RESULT_TRUNCATED
The length of the buffer for the scheme is less than the actual length of the scheme. The scheme is truncated and the actual length is returned.