nn::http::Connection::AddHeaderField Member Function

Syntax

nn::Result AddHeaderField(
     const char * pLabel,
     const char * pValue
);

Arguments

Name Description
in pLabel Label name of the field.
in pValue Content of the field.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.


Value Description
Result::IsSuccess Process was successful.
ResultConnectionStatusErr Error indicating an invalid state. This function cannot be called in the current communication state. (For example, the function returns this error if the system is already connected. You must call this function before calling Connect.)
ResultInvalidParamErr Error indicating an invalid parameter. Specify valid values for all parameters and call this function again.
ResultNotConnectedErr Error indicating that no target URL was assigned to the Connection object. No action is performed because the Connection object has not been initialized by a successful call of Initialize.
ResultNotInitializedErr Error indicating that the library is not initialized. None of this library's functions can be used until you first call nn::http::Initialize.
A value other than the above. Unexpected error (See http_Result.h for details).

Description

Adds a field to the message header to be sent through an HTTP request.

Revision History

2010/06/14
Initial version.

CONFIDENTIAL