# Synopsis

(macro) PDX_MSGT mda_FormatFile(long option, int model, char *file, MDA_ENT_FUNC *func)

# Purpose

Format a model into a file.

# Description

The formatter function for the specified model is invoked against a file. The format function is defined by setting the formatter field in the MODEL_INFO structure returned from the function mda_GetModelDefaults. The func argument specifies a function to be called for each entity as it is formatted and may be set to NULL. If specified, this function must have declared as:

.RS 3 PDX_MSGT foo (MDA_PTR db_ptr, void *entity) .RE When called, the entity with database pointer db_ptr will be locked at the address specified by entity. Any changes made to the entity will be formatted. The function should return a value of MDA_NOERR. Not all interface formatters support a function being called from the formatter, see the xxxx_FormatFile man page for a specific interface for more information.

# Input

## option

Options to be passed to formatter

## model

Model to format

## file

File to be formatted

## func

Function to be invoked for each entity or NULL

# Return

Error code from the formatter