Dialogic 6.2 - Manual (Page 34)

The Bfv API Functions
November 2009 34
Structures and Return Values
The Bfv API uses argument structures to pass values to and from
functions. The application declares the argument structure and
passes a pointer to it to the function. The argument structure type is
named args_...; for example, struct args_speech. The same
argument structure type is used for functions that are related or in
the same category.
Contained within the argument structure are structure fields that
are used for input and/or output. Each function that uses an
argument structure has marked the fields that are used for each
purpose. Not all fields are used by all functions taking any particular
argument structure type.
Result structures are the most commonly used structures to return
information to the function. They are:
RES
Returns status information in res.status and some additional
information in res.line_status.
CALL_RES
Returns information about a call such as its type and destination. If
applicable, ISDN information such as called party and redirect
information are returned as well.