GetSharedMemorySize

nn::swkbd::CTR::GetSharedMemorySize Function

Syntax

s32 GetSharedMemorySize(
     const Config * pConfig,
     const void * pInitialStatusData = NULL,
     const void * pInitialLearningData = NULL
);

Parameters

Name Description
in pConfig Config structure.
in pInitialStatusData The starting address of the initial operating status data at startup.
in pInitialLearningData The starting address of the initial predictive text learning data at startup.

Return Values

The size of the necessary shared memory region. It is a multiple of 4096. Returns 0 when no shared memory region is needed. Returns a negative value on failure.

Description

Calculates the size of the necessary shared memory region based on the settings in the Config structure.

Before calling this function, you must always call the nn::swkbd::CTR::InitializeConfig function to initialize the nn::swkbd::CTR::Config structure, and you must appropriately set the various member variables used for input.

For pInitialStatusData, specify the starting address of the operating status data to apply to the software keyboard's operating status when it is started.
If not specifying the operating status, specify NULL.

For pInitialLearningData, specify the starting address of the predictive text learning data to apply to the software keyboard's predictive text learning status when it is started.
If not specifying any predictive text learning data, specify NULL.

Revision History

2011/03/01
Initial version.

CONFIDENTIAL