Navigation:  ThinBASIC Modules > Core (thinBasic Core Engine) > Memory handling > Heap memory >

HEAP_AllocByStr

Previous pageReturn to chapter overviewNext page

 

Description

 

Allocates a block of memory from a heap.

The size of the block is the size of the passed string.

The passed string is copied into the new memory block.

If the function succeeds, the return value is a pointer to the allocated memory block.

 

Syntax

 

ptr = HEAP_AllocByStr(String [, AllowEmptyStringAllocation])

 

Returns

 

Number: pointer to the allocated memory area.

If returned value is zero, an error has occurred.

 

Parameters

 

Name

Type

Optional

Meaning

String

String

No

String data to allocate

AllowEmptyStringAllocation

Number

Yes

If this parameter is omitted or %FALSE, no memory allocation will take place if String is empty. In this case 0 (zero) will be returned.

If this parameter is %TRUE, a memory block will be allocated in any case even if String will be empty.

 

Remarks

 

Restrictions

 

If an empty string is passed, no memory allocation will take place unless AllowEmptyStringAllocation is %TRUE.

 

See also

 

Examples