Initialize

nn::os::StackMemory::Initialize Member Function

Syntax

void Initialize(
     void * pMem,
     size_t size
);

Parameters

Name Description
in pMem Pointer to the beginning of the memory region to partition. Must be 4096-byte aligned.
in size Size of memory region to partition. The size argument must be a multiple of 4096.

Return Values

None.

Description

Partitions a memory region.

The function internally calls TryInitialize, and if that process fails the function stops the program. (In the retail product environment, this is handled as a fatal error.)

This function can only partition memory allocated from the heap region. It cannot partition buffers allocated statically from the code region, and it cannot partition regions in device memory.

To read about other causes of failure, see TryInitialize.

Revision History

2011/12/19
Noted that memory must be allocated from the heap region.
2011/06/22
Changed the description in line with the addition of TryInitialize.
2010/08/18
Initial version.

CONFIDENTIAL