nn::uds::CTR::GetApplicationDataFromBeacon Function

Syntax

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

Arguments

Name Description
out pBuffer Data storage location.
out pDataSize Data size.
in bufferSize Buffer size. Specify NET_DESC_APPDATA_SIZE_MAX bytes for the most part; the amount of data that can be received can be changed as you like.

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 nn::uds::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 nn::uds::NET_DESC_APPDATA_SIZE_MAX.
ResultWirelessOff Transitioned to wireless OFF 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.

Revision History

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