1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7<title>SetHttpProperty</title> 8 </head> 9 <body> 10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/boss/Overview.html">boss</a>::<a href="../../../nn/boss/TaskActionBase/Overview.html">TaskActionBase</a>::SetHttpProperty</CODE> Member Function</h1> 11<h2>Syntax</h2> 12 <div class="section"> 13 <pre class="definition"> 14protected: 15<a href="../../../nn/Result/Overview.html">nn::Result</a> SetHttpProperty( 16 <a href="../../../nn/boss/PropertyType.html">PropertyType</a> type, 17 const void * pValue, 18 size_t size 19); 20</pre> 21 </div> 22<h2>Parameters</h2> 23 <div class="section"> 24 <table class="arguments"> 25 <thead> 26 <tr> 27 <td width="15" /> 28<th>Name</th> 29<td>Description</td> 30 </tr> 31 </thead> 32 <tr> 33<td>in</td> 34<th>type</th> 35<td>Specifies the property identifier.</td> 36 </tr> 37 <tr> 38<td>in</td> 39<th>pValue</th> 40<td>Specifies the value.</td> 41 </tr> 42 <tr> 43<td>in</td> 44<th>size</th> 45<td>Specifies the value size.</td> 46 </tr> </table> 47 </div> 48<h2>Return Values</h2> 49<div class="section">Returns the function's result. Returns one of the <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below.<br /> <br /> 50 <table class="arguments"> 51 <thead> 52 <tr> 53<th>Value</th> 54<td>Description</td> 55 </tr> 56 </thead> 57 <tr> 58<th><CODE>Result::IsSuccess</CODE></th> 59<td>Set successfully.</td> 60 </tr> 61 <tr> 62<th><CODE>ResultInvalidPropertyValue</CODE></th> 63<td>The property value pointer is <CODE>NULL</CODE>.</td> 64 </tr> 65 <tr> 66<th><CODE>ResultInvalidPropertyType</CODE></th> 67<td>The property type is not supported.</td> 68 </tr> 69 <tr> 70<th>A value other than the above.</th> 71<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td> 72 </tr> 73 </table> </div> 74<h2>Description</h2> 75 <div class="section"> 76<p>Sets a property value in the class.</p><p>It can be used for the following properties. Call this function after allocating memory for the description's data type.<br /><br /><B>Identifier</B>: <B>Description</B><br /><CODE>ACTION_URL</CODE>: The target URL. The data type is <CODE>char[MAX_URL_LENGTH]</CODE>. <br /><CODE>ACTION_HTTP_HEADER</CODE>: A structure for URL option request headers. The data type is <CODE>struct httpRequestHeader[MAX_HTTP_HEADER]</CODE>. <br /><CODE>ACTION_CLIENT_CERT</CODE>: The built-in client certificate for HTTPS communication. The data type is <CODE>u32[MAX_CLIENT_CERT]</CODE>. This setting is not normally required. Contact <A href="mailto:support@noa.com">Nintendo</A> if you want to use a built-in client certificate, such as with an independent server. When contacting, provide the setting values and other details.<br /> <CODE>ACTION_CLIENT_CERT_NUM</CODE>: The number of built-in client certificates that have been set. The data type is <CODE>u32</CODE>. <br /><CODE>ACTION_ROOT_CA</CODE>: The built-in root certificate for HTTPS communication. The data type is <CODE>u32[MAX_ROOT_CA]</CODE>. This setting is not normally required. Contact <A href="mailto:support@noa.com">Nintendo</A> if you want to use a built-in root certificate, such as with an independent server. When contacting, provide the setting values and other details.<br /> <CODE>ACTION_ROOT_CA_NUM</CODE>: The number of built-in root certificates to specify. The data type is <CODE>u32</CODE>. <br /><CODE>ACTION_PRIVATE_CLIENT_CERT</CODE>: Flag for enabling a private client certificate. Data type is <CODE>u8</CODE>. <br /><CODE>ACTION_PRIVATE_ROOT_CA</CODE>: Flag for enabling a private root certificate. The data type is <CODE>u8</CODE>.<br /> <CODE>ACTION_AP_INFO</CODE>: Type of access point information used for attaching AP information to an HTTP query. The data type is <CODE>ApInfoType</CODE>. <BR><CODE>ACTION_CFG_INFO</CODE>: System information type used to return system configuration information in response to HTTP queries. The data type is <CODE>CfgInfoType</CODE>. <br /><CODE>ACTION_LAST_MODIFIED_TIME</CODE>: The "Last Modified" date and time to set in the HTTP request header. Data type is <CODE>char[MAX_LASTMODIFIED_LENGTH]</CODE>. <br /></p><!-- write here --></div> 77<h2>Revision History</h2> 78 <div class="section"> 79 <dl class="history"> 80 <dt>2010/09/16</dt> 81<dd>Initial version.<br /> 82 </dd> 83 </dl> 84 </div> 85 <hr><p>CONFIDENTIAL</p></body> 86</html>