Sun Java System Access Manager 7.1 C API Reference

am_web_set_header_in_request_func_t

Sets an HTTP header in a request.

Details

If a header of the same name already exists it should be replaced with this header.

Syntax

#include "am_web.h"
typedef am_status_t (*am_web_set_header_in_request_func_t)(
                     void **args, 
                     const char *name, 
                     const char *val);

Parameters

This function takes the following parameter:

args

Pointer to a pointer to agent defined parameters.

name

Pointer to the name of the header.

val

Pointer to the value of the header.

Returns

This function returns one of the following values of the am_status_t enumeration (defined in the <am_types.h> header file):

AM_SUCCESS

If header was successfully added.

Warning

If not successfully freed, the status will be logged as a warning but ignored.