API 概述

应使用 API 的人员

API 旨在供经验丰富的应用程序员开发系统级应用程序和其他 IBM i 应用程序。 API 信息仅提供参考。 它既不是 IBM i 简介，也不是编写 IBM i 应用程序的指南。

API 信息的组织方式

可以通过 API 查找程序通过 API 名称找到 API 信息，也可以通过 API 类别页面通过类别找到 API 信息。

在 API 查找程序中，可以按类别，按 API 名称，按描述性名称或按部分名称搜索 API。 您还可以搜索新的 API ，已更改的 API 和出口程序。

API 类别是主要功能类别，例如备份和恢复，对象和工作管理。 在各个类别中， API 按字母顺序组织，如下所示:

• 通过基于程序的 API ，基于服务程序的 API 和 Integrated Language Environment ® (ILE) Common Execution Environment (CEE) API 的拼写名称。
• 按 UNIX 类型 API 的函数名。

与未来发行版的兼容性

IBM 计划 API 将继续按最初的工作方式工作，并且使用 API 的任何现有应用程序将继续工作，而不会进行任何不兼容的更改。 但是，重大的体系结构更改可能需要进行不兼容的更改。

此外，某些 API 定义 (例如 UNIX 类型的 API 定义) 由行业标准组织建立，其中兼容性程度由组织确定。

在未来发行版中， IBM 还打算满足下列其中一个条件:

• 如果为任何 API 提供了其他输入或输出参数，那么新参数将放在当前参数之后，并且将是可选参数。 现有 API 将继续工作而不进行任何更改。
• 如果提供了其他数据结构，那么将创建新的格式 (该数据结构的布局)。
• 可以将新信息添加到现有格式的末尾。

要确保与未来发行版更好地兼容，请在使用由列表 API 生成的用户空间时检索并使用以下所有值:

• 列表数据部分的偏移值
• 列表数据部分的大小
• 列表条目数
• 每个条目的大小

系统 API 或 CL 命令-何时使用每个

API 设计为用作编程接口，而 CL 命令旨在以交互方式或在 CL 程序中输入。

在系统上提供系统 API 之前，您必须使用相应的 CL 命令对单独的 CL 程序进行编码以执行所需的功能，或者对程序中的 Execute Command (QCMDEXC) API 调用进行编码。 这两种方法都使得在系统上对应用程序进行编码变得更繁琐 (不太直接，也不会尽可能快)。

将始终需要 CL 命令; 它们是交互式用户和正在执行基本任务的 CL 应用程序的理想选择。 它们提供了系统上的完整功能集。

虽然在许多情况下可能存在执行相同功能的 API 和 CL 命令，但未提供 API 作为 CL 命令的替代。 如果 CL 命令和 API 提供相同的功能，那么有时 API 会提供更多灵活性和信息。

某些 API 没有等效的 CL 命令。 这些 API 是在客户和业务合作伙伴表示需要高级语言 (HLL) 访问的领域提供的。

API 的操作和系统功能

API 可以按其执行的操作类型以及与其相关的系统功能进行分类。

此处列出了一些执行操作的 API 类型; 在后续主题中更详细地讨论了这些 API 的几个示例。

• 列出 API ，用于返回有关系统上某些内容的信息列表。
• 检索将信息返回到应用程序的 API。
• 创建，更改和删除 API ，这些 API 用于处理系统上指定类型的对象。
• 其他 API ，在系统上执行各种操作。

虽然许多 API 单独使用，但某些 API 可以一起用于执行任务或功能，如以下示例中所示:

• 定义，创建，分发和维护您自己的软件产品。
• 控制系统和网络，包括配置，假脱机文件，网络管理和问题管理。
• 处理对象，包括在系统上创建，更改，复制，删除，移动和重命名对象。