nn::boss::TaskActionBase::GetHttpProperty Member Function

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

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

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

Value	Description
Result::IsSuccess	Retrieval successful.
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).

Gets a property value from the class.

It can be used for the following properties. Call this function after allocating memory for the description's data type.

Identifier: Description
ACTION_URL: The target URL. The data type is char[MAX_URL_LENGTH].
ACTION_HTTP_HEADER: A structure for URL option request headers. The data type is struct httpRequestHeader[MAX_HTTP_HEADER].
ACTION_CLIENT_CERT: The built-in client certificate for HTTPS communication. The data type is u32[MAX_CLIENT_CERT].
ACTION_CLIENT_CERT_NUM: The number of built-in client certificates that have been set. The data type is u32.
ACTION_ROOT_CA: The built-in root certificate for HTTPS communication. The data type is u32[MAX_ROOT_CA].
ACTION_ROOT_CA_NUM: The number of built-in root certificates to specify. The data type is u32.
ACTION_PRIVATE_CLIENT_CERT: Flag for enabling a private client certificate. The data type is u8.
ACTION_PRIVATE_ROOT_CA: Flag for enabling a private root certificate. The data type is u8.
ACTION_AP_INFO: Type of access point information used for attaching AP information to an HTTP query. The data type is ApInfoType.
ACTION_CFG_INFO: System information type used to return system configuration information in response to HTTP queries. The data type is CfgInfoType.

2010/09/16

Initial version.