nn::uds::CTR::SetApplicationDataToBeacon Function

Syntax

nn::Result SetApplicationDataToBeacon(
     const void * pData,
     size_t dataSize
);

Arguments

Name Description
in pData Pointer to the data to set.
in dataSize Size of the data to set. Specify a value up to NET_DESC_APPDATA_SIZE_MAX.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
ResultSuccess Process was successful.
ResultNotInitialized The library is not initialized. Execute the Initialize function.
ResultInvalidState Not in an executable state. Returned when executed in a state other than master.
ResultTooLarge The dataSize exceeds NET_DESC_APPDATA_SIZE_MAX.
ResultWirelessOff Transitioned to wireless-disabled mode. Re-initialization is required.
A value other than the above Failed for reasons other than those given above.

Description

Sets optional data in the beacon.

Sets any data up to a maximum of NET_DESC_APPDATA_SIZE_MAX bytes. Since it is not encrypted, note that it can be collected by any general device such as a computer. Other devices can obtain this data by calling Scan while they are connected as clients or spectators. Only the master can run this function.

Revision History

2011/03/08
Added a link to Initialize in Return Values. Added a link to NET_DESC_APPDATA_SIZE_MAX in Return Values.
2010/10/15
Expanded the information on the return values. Revised the Description to make it easier to understand. Indicated that the data is not encrypted wirelessly.
2010/06/14
Initial version.

CONFIDENTIAL