Documentation from dynamic.h

Introduction	[top]

ROV - Easy applications from C

Copyright - © Jason Tribbeck / 7th ARM 1994-2001

Contributing authors - Jason Tribbeck

File - dynamic.h

Type - helper

Description

The dynamic helper maintains dynamic areas for storage with RISC OS 3.5+ machines.

dynamicarea_create	[top]

Create a dynamic area.

Parameters:

 - char *name - the name given in the Task Window.
 - int size - the size of the area to allocate.
 - int max - the maximum size this will be (-1 for as large as possible).

Returns:

 -  a handle for the dynamic area

int dynamicarea_create(char *name,
		       int size,
		       int max);

See also: dynamicarea_address(), dynamicarea_destroy()

dynamicarea_destroy	[top]

Destroy a dynamic area.

Parameters:

 - int handle - the handle of the dynamic area.

void dynamicarea_destroy(int handle);

See also: dynamicarea_create()

dynamicarea_extend	[top]

Extend a dunamic area.

Parameters:

 - int handle - the handle of the dynamic area.
 - int new_size - the new size of the dynamic area.

Returns:

 -  a flag indicating success (non-zero means success).

int dynamicarea_extend(int handle,
		       int new_size);

See also: dynamicarea_create(), dynamicarea_size()

dynamicarea_size	[top]

Get the size of a dynamic area.

Parameters:

 - int handle - the handle of the dynamic area.

Returns:

 -  the size of the dynamic area.

int dynamicarea_size(int handle);

See also: dynamicarea_address()

dynamicarea_address	[top]

Get the base address of a dynamic area.

Parameters:

 - int handle - the handle of the dynamic area.

Returns:

 -  the base address of the dynamic area.

void *dynamicarea_address(int handle);

See also: dynamicarea_size()

Generated Thu Feb 7 23:22:51 2002