`nn::boss::DataStoreUploadAction::AddDstPrincipalId` Member Function

Syntax

nn::Result AddDstPrincipalId(
     u32 principalId
);

Parameters

	Name	Description
in	`principalId`	Specifies the data send destination ID.

Return Values

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

Value	Description
`Result::IsSuccess`	Set successfully.
`ResultInvalidMaxDataStoreDst`	The `DataStore` data transmission destination registration count exceeds the maximum.
A value other than the above.	Unexpected error (see `boss_Result.h` for error details).

Description

Adds a destination to send data.

Specify the principal ID used by friend presence features as the recipient for data sent with DataStore. (For more details, see the documentation in the NEX library.)
You cannot register more than the number of recipients defined by nn::boss::MAX_DST_PRINCIPAL_ID.

When nn::boss::DSTKIND_FRIEND is specified as dstKind to the DataStoreUploadAction::Initialize function, data is uploaded to all friends regardless of the recipients added by this function.

Revision History

2011/10/27: Initial version.