Filter
Top Products
Introduction
Version 1.10 12/01/02 1-13
1.8.3 Procedure Descriptions
A procedure description generally has the following format:
ProcedureName(): The formal name of the procedure.
Summary: A brief description of the procedure.
Prototype: A “C-style” procedure header defining the calling
sequence.
Parameters: The parameters defined in the template are described in
further detail.
Related Definitions: The type declarations and constants that are only used by
this procedure.
Description: A description of the functionality provided by the
interface including any limitations and caveats the caller
of which should be aware.
Status Codes Returned: A description of the codes returned by the interface.
Any status codes listed in this table are required to be
implemented by the procedure. Additional error codes
may be returned, but they will not be tested by standard
compliance tests, and any software that uses the
procedure cannot depend on any of the extended error
codes that an implementation may provide.
1.8.4 Instruction Descriptions
An instruction description for EBC instructions generally has the following format:
InstructionName The formal name of the EBC Instruction.
SYNTAX: A brief description of the EBC Instruction.
DESCRIPTION: A description of the functionality provided by the EBC
Instruction accompanied by a table that details the
instruction encoding.
OPERATION: Details the operations performed on operands.
BEHAVIORS AND RESTRICTIONS: An item by item description of the behavior
of each operand involved in the instruction
and any restrictions that apply to the
operands or the instruction.