XFusion API v1.3.0
载入中...
搜索中...
未找到
xf_template_header_detail.h 文件参考

文件模板。 更多...

#include "xf_utils.h"
xf_template_header_detail.h 的引用(Include)关系图:

浏览源代码.

宏定义

#define __XF_TEMPLATE_HEADER_DETAIL_H__
 
#define XF_TEMPLATE_VERSION_MAJOR   (1)
 extern "C" 的位置通常在 include 后面。
 
#define XF_TEMPLATE_VERSION_MINOR   (0)
 
#define XF_TEMPLATE_VERSION_PATCH   (0)
 
#define XF_TEMPLATE_VERSION_CHECK(major, minor, patch)    ((major * 10000) + (minor * 100) + patch)
 将版本号转换为整数。与 XF_VERSION_VAL 不同。
 
#define XF_TEMPLATE_VERSION
 当前模板版本号整数。
 

类型定义

typedef xf_err_t xf_templ_err_t
 整形错误类型。
 
typedef enum _xf_templ_err_code_t xf_templ_err_code_t
 模板中的错误类型。
 

枚举

enum  _xf_templ_err_code_t { XF_TEMPL_FAIL = XF_FAIL , XF_TEMPL_OK = XF_OK , XF_TEMPL_ERR_MAX }
 模板中的错误类型。 更多...
 

函数

xf_templ_err_t xf_template_init (void)
 一个初始化函数。
 
xf_templ_err_t xf_template_another_func (void)
 一个函数,函数定义在 xf_template_another.c。
 

变量

int g_xf_templ_global_data1_in_head
 全局变量: [Global Variables].
 

详细描述

文件模板。

作者
你的名字 (你的邮箱@.nosp@m.doma.nosp@m.in.co.nosp@m.m)
版本
0.1
日期
2023-08-01

在文件 xf_template_header_detail.h 中定义.

宏定义说明

◆ __XF_TEMPLATE_HEADER_DETAIL_H__

#define __XF_TEMPLATE_HEADER_DETAIL_H__

< 格式为大写,且以双下划线开头结尾

在文件 xf_template_header_detail.h13 行定义.

◆ XF_TEMPLATE_VERSION_MAJOR

#define XF_TEMPLATE_VERSION_MAJOR   (1)

extern "C" 的位置通常在 include 后面。

模板版本号。

在文件 xf_template_header_detail.h31 行定义.

◆ XF_TEMPLATE_VERSION_MINOR

#define XF_TEMPLATE_VERSION_MINOR   (0)

在文件 xf_template_header_detail.h32 行定义.

◆ XF_TEMPLATE_VERSION_PATCH

#define XF_TEMPLATE_VERSION_PATCH   (0)

在文件 xf_template_header_detail.h33 行定义.

◆ XF_TEMPLATE_VERSION_CHECK

#define XF_TEMPLATE_VERSION_CHECK (   major,
  minor,
  patch 
)     ((major * 10000) + (minor * 100) + patch)

将版本号转换为整数。与 XF_VERSION_VAL 不同。

在文件 xf_template_header_detail.h84 行定义.

◆ XF_TEMPLATE_VERSION

#define XF_TEMPLATE_VERSION
值:
#define XF_TEMPLATE_VERSION_MINOR
#define XF_TEMPLATE_VERSION_PATCH
#define XF_TEMPLATE_VERSION_MAJOR
extern "C" 的位置通常在 include 后面。
#define XF_TEMPLATE_VERSION_CHECK(major, minor, patch)
将版本号转换为整数。与 XF_VERSION_VAL 不同。

当前模板版本号整数。

在文件 xf_template_header_detail.h90 行定义.

类型定义说明

◆ xf_templ_err_t

整形错误类型。

在文件 xf_template_header_detail.h40 行定义.

◆ xf_templ_err_code_t

模板中的错误类型。

枚举类型说明

◆ _xf_templ_err_code_t

模板中的错误类型。

枚举值
XF_TEMPL_FAIL 

通用错误(执行失败)

XF_TEMPL_OK 

通用成功(执行成功)

XF_TEMPL_ERR_MAX 

错误类型最大值

在文件 xf_template_header_detail.h46 行定义.

函数说明

◆ xf_template_init()

xf_templ_err_t xf_template_init ( void  )

一个初始化函数。

返回
xf_templ_err_t
  • XF_TEMPL_OK 成功

在文件 xf_template_source_detail.c404 行定义.

◆ xf_template_another_func()

xf_templ_err_t xf_template_another_func ( void  )

一个函数,函数定义在 xf_template_another.c。

返回
xf_templ_err_t
  • XF_TEMPL_OK 成功

在文件 xf_template_source_detail_another.c28 行定义.

变量说明

◆ g_xf_templ_global_data1_in_head

int g_xf_templ_global_data1_in_head
extern

全局变量: [Global Variables].

警告
一般**不允许**有全局变量,此处是为了演示必须有全局变量时, 内容标识 [Global Variables] 所在位置。
  1. 有可能会在别的源文件(.c 文件)内调用的变量。
  2. 必须用g_前缀标识全局变量。
  3. 通常**禁止**使用全局变量,如需使用,可以封装获取和修改该变量的函数。
警告
通常**禁止**使用全局变量。 有在头文件中声明的全局变量

在文件 xf_template_source_detail.c275 行定义.