a0DisposeFormat()

Disposes a format.


Syntax

a0tError a0DisposeFormat(
a0tFormat *formatp );

Arguments

Namerd/wrDescription
formatp write Format descriptor to dispose.

Description

This function disposes a previously created format. After being disposed, no other functions can access it, not even other formats that are constructed with it.


Return Values

If an error condition occurs, it returns the error code, otherwise it returns A0ErrOk. Possible values are as follows:
Error CodeDescription
A0ErrInvFormat The base format has an invalid type.
A0ErrOkSuccessful completion.

See Also

a0NewMapFormat() a0NewFunctionFormat()