WBSV gate, PEEK_HEADERS function
The PEEK_HEADERS function peeks the HTTP headers.
Input parameters
- SESSION_TOKEN
- This is the Web server session token.
- HEADER1_NAME
- Optional parameter. This is the name of the first additional HTTP header to be sent with the HTTP message.
- HEADER2_NAME
- Optional parameter. This is the name of the second HTTP header to be sent with the HTTP message.
- HEADER3_NAME
- Optional parameter. This is the name of the third HTTP header to be sent with the HTTP message.
- HEADER_NAME_LIST
- Optional parameter. This is the list of header names to be sent with the HTTP message.
- HEADER_VALUE_LIST
- This is the list of header values to be sent with the HTTP message.
- HEADERS_OPTIONAL
- Optional parameter. This specifies whether an exception response should
be suppressed if specified headers are missing. Values for the parameter are:
- YES
- NO
Output parameters
- HEADER1_VALUE_SETBUF
- Optional parameter. This is the block for HEADER1_VALUE_SETDATA. It sets the buffer to be returned to the caller.
- HEADER2_VALUE_SETBUF
- Optional parameter. This is the block for HEADER2_VALUE_SETDATA. It sets the buffer to be returned to the caller.
- HEADER3_VALUE_SETBUF
- Optional parameter. This is the block for HEADER3_VALUE_SETDATA. It sets the buffer to be returned to the caller.
- CONTENT_LENGTH
- This is the length in the HTTP Content-Length header.
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- SCHEDULED
- HEADERS_MAXLEN_EXCEEDED
- NO_CONTENT_LENGTH
- NO_CONTENT_TYPE
- FIRST_LINE_INVALID
- NO_STORAGE_AVAILABLE
- HEADER1_TOO_LONG
- HEADER2_TOO_LONG
- HEADER3_TOO_LONG
- UNSUPPORTED_VERSION
- INVALID_CONTENT_LENGTH
- NO_HEADER1
- NO_HEADER2
- NO_HEADER3
- METHOD_NOT_SUPPORTED
- HEADER1_INVALID
- HEADER2_INVALID
- HEADER3_INVALID
- HEADER1_EQ_HEADER2
- LAST_BODY_NOT_RECEIVED
- INVALID_SESSION_TOKEN
- CONNECTION_CLOSED
- CONNECTION_CLOSED_ASYNC0
- SOCKET_ERROR
- SOCKET_ERROR_ASYNC0
- INVALID_PARAMETERS
- LIST_HEADER_MISSING
- HEADER_NAME_TOO_LONG
- HEADER_INVALID
- The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- LOOP
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces