nn::boss::TaskActionBase::SetHttpProperty Member Function

Syntax

protected:
nn::Result SetHttpProperty(
     PropertyType type,
     const void * pValue,
     size_t size
);

Arguments

Name Description
in type Specifies the property identifier.
in pValue Specifies the value.
in size Specifies the value size.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
ResultSuccess Set successfully.
ResultInvalidPropertyValue The property value pointer is NULL.
ResultInvalidPropertyType The property type is not supported.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Sets a property value in the class. Call this function after allocating memory for the description's data type. It can be used for the following properties.
Identifier: Description
ACTION_URL: The target URL. It has a data type of char[MAX_URL_LENGTH].
ACTION_HTTP_HEADER: A structure for URL option request headers. It has a data type of struct httpRequestHeader[MAX_HTTP_HEADER].
ACTION_CLIENT_CERT: The built-in client certificate for HTTPS communication. It has a data type of nn::http::InternalClientCertId[MAX_CLIENT_CERT].
ACTION_CLIENT_CERT_NUM: The number of built-in client certificates that have been set. Data type is u32.
ACTION_ROOT_CA: The built-in root certificate for HTTPS communication. It has a data type of nn::http::InternalCaCertId.
ACTION_ROOT_CA_NUM: The number of built-in root certificates to specify. Data type is u32.
ACTION_PRIVATE_CLIENT_CERT: Flag for enabling a private client certificate. It has a data type of u8.
ACTION_PRIVATE_ROOT_CA: Flag for enabling a private root certificate. It has a data type of u8.
ACTION_AP_INFO: Type of access point information used for attaching AP information to an HTTP query. It has a data type of ApInfoType.
ACTION_LAST_MODIFIED_TIME: The "Last Modified" date and time to set in the HTTP request header. Data type is char[MAX_LASTMODIFIED_LENGTH].

Revision History

2010/09/16
Initial version.

CONFIDENTIAL