The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Global Functions in Global Namespace C++
in Sourcefile alloc.h


rtl_allocateMemory
extern "C"
void * rtl_allocateMemory(
sal_Size Bytes );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Allocate memory.
Description
A call to this function will return NULL upon the requested memory size being either zero or larger than currently allocatable.
Parameters
Bytes
memory size.
Return
pointer to allocated memory.

rtl_allocateZeroMemory
extern "C"
void * rtl_allocateZeroMemory(
sal_Size Bytes );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Allocate and zero memory.
Description
A call to this function will return NULL upon the requested memory size being either zero or larger than currently allocatable.
Parameters
Bytes
memory size.
Return
pointer to allocated and zero'ed memory.

rtl_arena_alloc
extern "C"
void * rtl_arena_alloc(
rtl_arena_type * pArena,
sal_Size * pBytes );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
rtl_arena_alloc() * *
Parameters
pArena
arena from which resource is allocated.
*  
pBytes
size of resource to allocate.
*
*  
Return
allocated resource, or NULL upon failure. * *
See Also
rtl_arena_free()

rtl_arena_destroy
extern "C"
void rtl_arena_destroy(
rtl_arena_type * pArena );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
rtl_arena_destroy() * *
Parameters
pArena
the arena to destroy.
*  
Return
None * *
See Also
rtl_arena_create()

rtl_arena_free
extern "C"
void rtl_arena_free(
rtl_arena_type * pArena,
void * pAddr,
sal_Size nBytes );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
rtl_arena_free() * *
Parameters
pArena
arena from which resource was allocated.
*  
pAddr
resource to free.
*  
nBytes
size of resource.
*
*  
Return
None. * *
See Also
rtl_arena_alloc()

rtl_cache_alloc
extern "C"
void * rtl_cache_alloc(
rtl_cache_type * pCache );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
rtl_cache_alloc() * *
Parameters
pCache
cache from which object is allocated.
*
*  
Return
pointer to allocated object, or NULL upon failure.

rtl_cache_destroy
extern "C"
void rtl_cache_destroy(
rtl_cache_type * pCache );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
rtl_cache_destroy() * *
Parameters
pCache
the cache to destroy.
*
*  
Return
None. * *
See Also
rtl_cache_create()

rtl_cache_free
extern "C"
void rtl_cache_free(
rtl_cache_type * pCache,
void * pObj );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
rtl_cache_free() * *
Parameters
pCache
cache from which object was allocated.
*  
pObj
object to free.
*
*  
Return
None. * *
See Also
rtl_cache_alloc()

rtl_freeMemory
extern "C"
void rtl_freeMemory(
void * Ptr );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Free memory.
Parameters
Ptr
pointer to previously allocated memory.
Return
none. Memory is released. Ptr is invalid.

rtl_freeZeroMemory
extern "C"
void rtl_freeZeroMemory(
void * Ptr,
sal_Size Bytes );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Zero and free memory.
Parameters
Ptr
pointer to previously allocated memory.
Bytes
memory size.
Return
none. Memory is zero'ed and released. Ptr is invalid.

rtl_reallocateMemory
extern "C"
void * rtl_reallocateMemory(
void * Ptr,
sal_Size Bytes );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Reallocate memory.
Description
A call to this function with parameter 'Ptr' being NULL is equivalent to a rtl_allocateMemory() call. A call to this function with parameter 'Bytes' being 0 is equivalent to a rtl_freeMemory() call.
See Also
rtl_allocateMemory()
rtl_freeMemory()
Parameters
Ptr
pointer to previously allocated memory.
Bytes
new memory size.
Return
pointer to reallocated memory. May differ from Ptr.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.