Main Content

hdfan

HDF 多文件注释 (AN) 接口的入口

语法

[out1,...,outN] = hdfan(funcstr,input1,...,inputN)

说明

hdfan 是 HDF 多文件注释 (AN) 接口的 MATLAB® 入口。

[out1,...,outN] = hdfan(funcstr,input1,...,inputN) 返回与 HDF 库中由 functstr 指定的 AN 函数对应的一个或多个输出。

HDF 库中的 AN 函数与 funcstr 的有效值之间存在一对一的对应关系。例如,hdfan('endaccess',annot_id) 对应于 C 库调用 ANendaccess(annot_id)

访问函数

访问函数初始化接口以及提供和终止对注释的访问。

funcstr 的值函数语法描述
'start'AN_id = hdfan('start',file_id)

初始化多文件注释接口。

'select'annot_id = hdfan('select',AN_id, index,annot_type)

选择并返回给定索引值和注释类型标识的注释的标识符。

'end'status = hdfan('end',AN_id)

终止对多文件注释接口的访问。

'create'annot_id = hdfan('create',AN_id,tag,ref,annot_type)

为由指定的标记和引用编号标识的对象创建数据注释。annot_type 可以是 'data_label''data_desc'

'createf'annot_id = hdfan('createf',AN_id,annot_type)

创建文件标签或文件说明注释。annot_type 可以是 'file_label''file_desc'

'endaccess'status = hdfan('endaccess',annot_id)

终止对注释的访问。

读取/写入函数

读取/写入函数读取和写入文件或对象注释。

funcstr 的值函数语法描述
'writeann'status = hdfan('writeann',annot_id,annot_string)

写入与给定注释标识符对应的注释。

'readann'[annot_string,status] = hdfan('readann',annot_id)

读取对应于给定注释标识符的注释。

[annot_string,status] = hdfan('readann',annot_id,max_str_length)

读取对应于给定注释标识符的注释。annot_string 将不再长于 max_str_length

常规查询函数

常规查询函数返回有关文件中的注释的信息。

funcstr 的值函数语法描述
'numann'num_annot = hdfan('numann',AN_id,annot_type,tag,ref)

获取对应于给定标记/参考对组的指定类型的注释数目。

'annlist'[ann_list,status] = hdfan('annlist',AN_id,annot_type,tag,ref)

获取文件中对应于给定标记/参考对组的给定类型的注释列表。

'annlen'length = hdfan('annlen',annot_id)

获取对应于给定注释标识符的注释的长度。

'fileinfo'[nfl,nfd,ndl,ndd,status] = hdfan('fileinfo',AN_id)

获取文件中对应于 AN_id 的文件标签、文件说明、数据标签和数据说明注释的编号。

'get_tagref'[tag,ref,status] = hdfan('get_tagref',AN_id,index,annot_type)

获取指定的注释类型和索引的标记/参考对组。

'id2tagref'[tag,ref,status] = hdfan('id2tagref',annot_id)

获取对应于指定注释标识符的标记/参考对组。

'tagref2id'annot_id = hdfan('tagref2id',AN_id,tag,ref)

获取对应于指定的标记/参考对组的注释标识符。

'atype2tag'tag = hdfan('atype2tag',annot_type)

获取对应于指定注释类型的标记。

'tag2atype'annot_type = hdfan('tag2atype',tag)

获取对应于指定的标记的注释类型。

输入/输出参数

status 或标识符输出为 -1 表示操作失败。

通常,输入参数 annot_type 可以是下列值之一:

  • 'file_label'

  • 'file_desc'

  • 'data_label'

  • 'data_desc'

AN_id 表示多文件注释接口标识符。

annot_id 表示单个注释标识符。

您必须使用 hdfan('end',AN_id)hdfan('endaccess',annot_id) 终止对所有打开的标识符的访问。否则,HDF 库可能无法正确将所有数据写入到文件。

版本历史记录

在 R2006a 之前推出