nn::uds::CTR::GetApplicationDataFromBeacon Function

Syntax

nn::Result GetApplicationDataFromBeacon(
     void * pBuffer,
     size_t * pDataSize,
     size_t bufferSize
);

Parameters

Name Description
out pBuffer Data storage location.
out pDataSize Data size.
in bufferSize Buffer size. The sender can freely change the size of the data you get, so specify NET_DESC_APPDATA_SIZE_MAX bytes in general.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Process was successful.
ResultNotInitialized The library is not initialized. Execute the Initialize function.
ResultInvalidState Not in an executable state. Returns that it was executed in a state where it was not connected to the network.
ResultTooLarge Returns that the bufferSize was smaller than the received data. The desired size is NET_DESC_APPDATA_SIZE_MAX.
ResultWirelessOff Entered wireless-disabled mode. Re-initialization is required.
A value other than the above Failed for reasons other than those given above.

Description

Gets the data set to the beacon.

The master gets the data set using the SetApplicationDataToBeacon function. This can only be run when connected to network. Note that there is no notification if the data is updated.

This function is thread-safe.

Revision History

2011/09/07
Standardized notation for wireless-disabled mode.
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.
2010/06/14
Initial version.

CONFIDENTIAL