针对函数、编译器内在函数或宏的条目的通用格式。

对 function_name() 的作用的简短描述。

概要

为 function_name() 提供原型。

<return_type> function_name(
                 <type_1> parameter_1,
                 <type_2> parameter_2,
                 <type_n> parameter_n
                           )

参数

parameter_1 [in]            Type details of parameter_1 
parameter_2 [out]           Type details of parameter_2 
parameter_n [in/out]        Type details of parameter_3

参数传递分类如下：

• in：表示该函数使用提供的参数中的一个或多个值而不保存任何更改。
• out：表示该函数将一个或多个值保存在提供的参数中。您可以检查保存的值从而找出有关您的应用程序的有用信息。
• in/out：表示函数更改提供的参数中的一个或多个值并保存结果。您可以检查保存的值从而找出有关您的应用程序的有用信息。

说明

描述了该函数。本节还描述了可能适用的任何特殊特性或限制：

• 在某些情况下，该函数阻止或可能阻止所请求的操作
• 函数有预设条件，但可能不明显
• 函数有限制或特殊行为

限制

指定使用该函数时的任何限制。

返回值

指定该函数返回的任何一个或多个值。

另请参见

列出了与该函数相关的其他函数或数据类型。

实现示例

提供了演示函数用法的示例（或对示例的引用）。除了闪存 API 函数之外，此类示例还可以使用 C2000Ware 中提供的 device_support 文件夹或 driverlib 文件夹中的函数来演示在应用程序环境中如何使用给定的闪存 API 函数。