nn::boss::GetOptoutFlag Function

Syntax

nn::Result GetOptoutFlag(
     bool * pFlag
);

Parameters

Name Description
out pFlag Returns the OptOut flag.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Retrieval successful.
ResultInvalidOptoutFlag The pointer to the OptOut flag is NULL.
ResultStorageNotFound The BOSS storage corresponding to the appropriate application ID is not registered. Please check if the BOSS storage is registered.
ResultIpcNotSessionInitialized The session has not been initialized.
This Result is returned if this function is called before the Initialize function is called. Always call the Initialize function before using the BOSS library.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Gets the OptOut flag.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL