2 description of each api – Renesas M16C/62P Group User Manual
Page 17

Rev.1.00 2007.11.1
REC10B0002-0100
15
4.2 Description of Each API
This section describes each API and explains how to use them, showing a program
example for each.
The description of each API is divided into the following items.
• Synopsis
: Outlines the content of processing performed by the function. It
also shows the syntax of the function, followed by a brief
explanation of arguments.
• Description
:
Describes the function and how to use it in detail.
• Return value
:
Explains the returned value of the function.
• Functionality
:
Indicates the functional classification of the function.
• Reference
:
Indicates the related functions.
• Remark
:
Describes the precautions to be taken when using the API.
• Program example
:
Presents a program showing how to use the function.