NAME

zkMalloc - a memory allocator

SYNOPSIS

#include "zkStdlib.h"

void* zkMalloc(size_t size);

DESCRIPTION

The zkMalloc() function allocates unused space for an object whose size in bytes is specified by size and whose value is indeterminate.

The order and contiguity of storage allocated by successive calls to zkMalloc() is unspecified. The pointer returned if the allocation succeeds is suitably aligned so that it may be assigned to a pointer to any type of object and then used to access such an object in the space allocated (until the space is explicitly freed or reallocated). Each such allocation will yield a pointer to an object disjoint from any other object. The pointer returned points to the start (lowest byte address) of the allocated space. If the space cannot be allocated, NULL is returned. If the size of the space requested is 0, the behaviour is implementation-dependent; the value returned will be either NULL or a unique pointer.

RETURN VALUE

Upon successful completion with size not equal to 0, zkMalloc() returns a pointer to the allocated space. If size is 0, either NULL or a unique pointer that can be successfully passed to zkFree() will be returned. Otherwise, it returns a null pointer and sets errno to indicate the error.

 ERRORS

The zkMalloc() function will fail if:

[ENOMEM]
Insufficient storage space is available.