The HDF Group

HDF Reference Manual


Table of Contents


1.1 Overview of the HDF Interfaces 1-1
1.2 Low-Level Interface 1-1
1.3 Multifile Application Interfaces 1-2
1.3.1 Scientific Data Sets: SD Interface 1-2
1.3.2 Annotations: AN Interface 1-2
1.3.3 General Raster Images: GR Interface 1-2
1.3.4 Vdata: The VS Interface 1-2
1.3.5 Vdata Query: VSQ Interface 1-2
1.3.6 Vdata Fields: VF Interface 1-3
1.3.7 Vgroups: V Interface 1-3
1.3.8 Vdata/Vgroups: VH Interface 1-3
1.3.9 Vgroup Inquiry: VQ Interface 1-3
1.4 Single-File Application Interfaces 1-3
1.4.1 24-bit Raster Image Sets: DF24 Interface 1-3
1.4.2 8-bit Raster Image Sets: DFR8 Interface 1-3
1.4.3 Palettes: DFP Interface 1-4
1.4.4 Scientific Data Sets: DFSD Interface 1-4
1.4.5 Annotations: DFAN Interface 1-4
1.5 FORTRAN-77 and C Language Issues 1-4
1.5.1 FORTRAN-77-to-C Translation 1-4
1.5.2 Case Sensitivity 1-4
1.5.3 Name Length 1-5
1.5.4 Header Files 1-5
1.5.5 Data Type Specifications 1-5
1.5.6 String and Array Specifications 1-6
1.5.7 FORTRAN-77, ANSI C and K&R C 1-6
1.6 Error Codes 1-6
2.1 Reference Section Overview 2-13
ANannlen/afannlen 2-15
ANannlist/afannlist 2-16
ANatype2tag/afatypetag 2-17
ANcreate/afcreate 2-18
ANcreatef/affcreate 2-19
ANend/afend 2-20
ANendaccess/afendaccess 2-21
ANfileinfo/affileinfo 2-22
ANgetdatainfo 2-23
ANget_tagref/afgettagref 2-24
ANid2tagref/afidtagref 2-25
ANnumann/afnumann 2-26
ANreadann/afreadann 2-27
ANselect/afselect 2-28
ANstart/afstart 2-29
ANtag2atype/aftagatype 2-30
ANtagref2id/aftagrefid 2-31
ANwriteann/afwriteann 2-32
GRattrinfo/mgatinf 2-35
GRcreate/mgcreat 2-36
GRend/mgend 2-38
GRendaccess/mgendac 2-39
GRfileinfo/mgfinfo 2-40
GRfindattr/mgfndat 2-41
GRgetattdatainfo 2-42
GRgetattr/mggnatt/mggcatt 2-43
GRgetchunkinfo/mggichnk 2-44
GRgetcompinfo/mggcompress 2-46
GRgetdatainfo 2-47
GRgetiminfo/mggiinf 2-48
GRgetlutid/mggltid 2-49
GRgetlutinfo/mgglinf 2-50
GRgetnluts/mggnluts 2-51
GRidtoref/mgid2rf 2-52
GRluttoref/mglt2rf 2-53
GRnametoindex/mgn2ndx 2-54
GRreadchunk/mgrchnk/mgrcchnk 2-55
GRreadimage/mgrdimg/mgrcimg 2-56
GRreadlut/mgrdlut/mgrclut 2-58
GRreftoindex/mgr2idx 2-59
GRreqimageil/mgrimil 2-60
GRreqlutil/mgrltil 2-61
GRselect/mgselct 2-62
GRsetaccesstype/mgsactp 2-63
GRsetattr/mgsnatt/mgscatt 2-64
GRsetchunk/mgschnk 2-66
GRsetchunkcache/mgscchnk 2-68
GRsetcompress/mgscompress 2-69
GRsetexternalfile/mgsxfil 2-71
GRstart/mgstart 2-72
GRwritechunk/mgwchnk/mgwcchnk 2-73
GRwriteimage/mgwrimg/mgwcimg 2-74
GRwritelut/mgwrlut/mgwclut 2-76
GR2bmapped 2-78
Hclose/hclose 2-79
Hgetfileversion/hgfilver 2-80
Hgetlibversion/hglibver 2-81
Hgetntinfo 2-82
Hishdf/hishdff 2-83
Hopen/hopen 2-84
HCget_config_info 2-85
HDdont_atexit/hddontatexit 2-87
HXsetcreatedir/hxiscdir 2-88
HXsetdir/hxisdir 2-89
SDattrinfo/sfgainfo 2-91
SDcheckempty/sfchempty 2-92
SDcreate/sfcreate 2-93
SDdiminfo/sfgdinfo 2-95
SDend/sfend 2-96
SDendaccess/sfendacc 2-97
SDfileinfo/sffinfo 2-98
SDfindattr/sffattr 2-99
SDgetanndatainfo 2-100
SDgetattdatainfo 2-101
SDgetcal/sfgcal 2-102
SDgetchunkinfo/sfgichnk 2-103
SDgetcompinfo/sfgcompress 2-105
SDgetdatainfo 2-107
SDgetdatastrs/sfgdtstr 2-108
SDgetdimid/sfdimid 2-109
SDgetdimscale/sfgdscale 2-110
SDgetdimstrs/sfgdmstr 2-111
SDgetexternalfile 2-112
SDgetfilename 2-113
SDgetfillvalue/sfgfill/sfgcfill 2-114
SDgetinfo/sfginfo 2-115
SDgetnamelen 2-116
SDgetnumvars_byname 2-117
SDgetoldattdatainfo 2-118
SDgetrange/sfgrange 2-120
SDget_maxopenfiles 2-121
SDget_numopenfiles 2-122
SDidtoref/sfid2ref 2-123
SDidtype 2-124
SDiscoordvar/sfiscvar 2-125
SDisdimval_bwcomp/sfisdmvc 2-126
SDisrecord/sfisrcrd 2-127
SDnametoindex/sfn2index 2-128
SDnametoindices 2-129
SDreadattr/sfrnatt/sfrcatt 2-130
SDreadchunk/sfrchnk/sfrcchnk 2-131
SDreaddata/sfrdata/sfrcdata 2-132
SDreftoindex/sfref2index 2-135
SDreset_maxopenfiles 2-136
SDselect/sfselect 2-137
SDsetaccesstype/sdfsacct 2-138
SDsetattr/sfsnatt/sfscatt 2-139
SDsetblocksize/sfsblsz 2-141
SDsetcal/sfscal 2-142
SDsetchunk/sfschnk 2-143
SDsetchunkcache/sfscchnk 2-146
SDsetcompress/sfscompress 2-147
SDsetdatastrs/sfsdtstr 2-150
SDsetdimname/sfsdmname 2-151
SDsetdimscale/sfsdscale 2-152
SDsetdimstrs/sfsdmstr 2-153
SDsetdimval_comp/sfsdmvc 2-154
SDsetexternalfile/sfsextf 2-155
SDsetfillmode/sfsflmd 2-156
SDsetfillvalue/sfsfill/sfscfill 2-157
SDsetnbitdataset/sfsnbit 2-158
SDsetrange/sfsrange 2-160
SDstart/sfstart 2-161
SDwritechunk/sfwchnk/sfwcchnk 2-162
SDwritedata/sfwdata/sfwcdata 2-164
Vaddtagref/vfadtr 2-167
Vattach/vfatch 2-168
Vattrinfo/vfainfo 2-169
Vattrinfo2 2-170
Vdelete/vdelete 2-172
Vdeletetagref/vfdtr 2-173
Vdetach/vfdtch 2-174
Vend/vfend 2-175
Vfind/vfind 2-176
Vfindattr/vffdatt 2-177
Vfindclass/vfndcls 2-178
Vflocate/vffloc 2-179
Vgetattdatainfo 2-180
Vgetattr/vfgnatt/vfgcatt 2-181
Vgetattr2 2-182
Vgetclass/vfgcls 2-183
Vgetclassnamelen 2-184
Vgetid/vfgid 2-185
Vgetname/vfgnam 2-186
Vgetnamelen 2-187
Vgetnext/vfgnxt 2-188
Vgettagref/vfgttr 2-189
Vgettagrefs/vfgttrs 2-190
Vgetversion/vfgver 2-191
Vgetvgroups 2-192
·Vinqtagref/vfinqtr 2-193
·Vinquire/vfinq 2-194
·Vinsert/vfinsrt 2-195
·Visvg/vfisvg 2-196
·Visvs/vfisvs 2-197
·Vlone/vflone 2-198
·Vnattrs/vfnatts 2-199
·Vnattrs2 2-200
·Vnrefs/vnrefs 2-201
·Vntagrefs/vfntr 2-202
·Vsetattr/vfsnatt/vfscatt 2-203
·Vsetclass/vfscls 2-204
·Vsetname/vfsnam 2-205
·Vstart/vfstart 2-206
·VHmakegroup/vhfmkgp 2-207
·VQueryref/vqref 2-208
·VQuerytag/vqtag 2-209
VFfieldesize/vffesiz 2-211
VFfieldisize/vffisiz 2-212
VFfieldname/vffname 2-213
VFfieldorder/vffordr 2-214
VFfieldtype/vfftype 2-215
VFnfields/vfnflds 2-216
VSQuerycount/vsqfnelt 2-217
VSQueryfields/vsqfflds 2-218
VSQueryinterlace/vsqfintr 2-219
VSQueryname/vsqfname 2-220
VSQueryref/vsqref 2-221
VSQuerytag/vsqtag 2-222
VSQueryvsize/vsqfvsiz 2-223
VHstoredata/vhfsd/vhfscd 2-225
VHstoredatam/vhfsdm/vhfscdm 2-227
VSappendable/vsapp (Obsolete) 2-229
VSattach/vsfatch 2-230
VSattrinfo/vsfainf 2-231
VSdelete/vsfdlte 2-232
VSdetach/vsfdtch 2-233
VSelts/vsfelts 2-234
VSfdefine/vsffdef 2-235
VSfexist/vsfex 2-236
VSfind/vsffnd 2-237
VSfindattr/vsffdat 2-238
VSfindclass/vffcls 2-239
VSfindex/vsffidx 2-240
VSfnattrs/vsffnas 2-241
VSfpack/vsfcpak/vsfnpak 2-242
VSgetattdatainfo 2-244
VSgetattr/vsfgnat/vsfgcat 2-245
VSgetblockinfo/vsfgetblinfo 2-246
VSgetclass/vsfgcls 2-247
VSgetdatainfo 2-248
·VSgetexternalfile 2-249
·VSgetfields/vsfgfld 2-250
·VSgetid/vsfgid 2-251
·VSgetinterlace/vsfgint 2-252
·VSgetname/vsfgnam 2-253
·VSgetvdatas 2-254
·VSgetversion/vsgver 2-255
·VSinquire/vsfinq 2-256
·VSisattr/vsfisat 2-257
·VSlone/vsflone 2-258
·VSnattrs/vsfnats 2-259
·VSofclass 2-260
·VSread/vsfrd/vsfrdc/vsfread 2-261
·VSseek/vsfseek 2-263
·VSsetattr/vsfsnat/vsfscat 2-264
·VSsetblocksize/vsfsetblsz 2-265
·VSsetclass/vsfscls 2-266
·VSsetexternalfile/vsfsextf 2-267
·VSsetfields/vsfsfld 2-268
·VSsetinterlace/vsfsint 2-269
·VSsetname/vsfsnam 2-270
·VSsetnumblocks/vsfsetnmbl 2-271
·VSsizeof/vsfsiz 2-272
·VSwrite/vsfwrt/vsfwrtc/vsfwrit 2-273
DF24addimage/d2aimg 2-275
DF24getdims/d2gdims 2-276
DF24getimage/d2gimg 2-277
DF24lastref/d2lref 2-278
DF24nimages/d2nimg 2-279
DF24putimage/d2pimg 2-280
DF24readref/d2rref 2-281
DF24reqil/d2reqil 2-282
DF24restart/d2first 2-283
DF24setcompress/d2scomp 2-284
d2scomp 2-286
d2sjpeg 2-287
DF24setdims/d2sdims 2-288
DF24setil/d2setil 2-289
DFR8addimage/d8aimg 2-291
DFR8getdims/d8gdims 2-292
DFR8getimage/d8gimg 2-293
DFR8getpalref 2-294
DFR8lastref/d8lref 2-295
DFR8nimages/d8nims 2-296
DFR8putimage/d8pimg 2-297
DFR8readref/d8rref 2-298
DFR8restart/d8first 2-299
DFR8setcompress/d8scomp 2-300
d8scomp 2-302
d8sjpeg 2-303
DFR8setpalette/d8spal 2-304
DFR8writeref/d8wref 2-305
DFPaddpal/dpapal 2-307
DFPgetpal/dpgpal 2-308
DFPlastref/dplref 2-309
DFPnpals/dpnpals 2-310
DFPputpal/dpppal 2-311
DFPreadref/dprref 2-312
DFPrestart/dprest 2-313
DFPwriteref/dpwref 2-314
DFKNTsize 2-315
DFUfptoimage/duf2im 2-317
DFANaddfds/daafds 2-319
DFANaddfid/daafid 2-320
DFANclear/daclear 2-321
DFANgetdesc/dagdesc 2-322
DFANgetdesclen/dagdlen 2-323
DFANgetfds/dagfds 2-324
DFANgetfdslen/dagfdsl 2-325
DFANgetfid/dagfid 2-326
DFANgetfidlen/dagfidl 2-327
DFANgetlabel/daglab 2-328
DFANgetlablen/dagllen 2-329
DFANlablist/dallist 2-330
DFANlastref/dalref 2-331
DFANputdesc/dapdesc 2-332
DFANputlabel/daplab 2-333
DFSDadddata/dsadata 2-335
DFSDclear/dsclear 2-336
DFSDendslab/dseslab 2-337
DFSDendslice/dseslc 2-338
DFSDgetcal/dsgcal 2-339
DFSDgetdata/dsgdata 2-340
DFSDgetdatalen/dsgdaln 2-341
DFSDgetdatastrs/dsgdast 2-342
DFSDgetdimlen/dsgdiln 2-343
DFSDgetdims/dsgdims 2-344
DFSDgetdimscale/dsgdisc 2-345
DFSDgetdimstrs/dsgdist 2-346
DFSDgetfillvalue/dsgfill 2-347
DFSDgetNT/dsgnt 2-348
DFSDgetrange/dsgrang 2-349
DFSDgetslice/dsgslc 2-350
DFSDlastref/dslref 2-351
DFSDndatasets/dsnum 2-352
DFSDpre32sdg/dsp32sd 2-353
DFSDputdata/dspdata 2-354
DFSDputslice/dspslc 2-355
DFSDreadref/dsrref 2-356
DFSDreadslab/dsrslab 2-357
DFSDrestart/dsfirst 2-358
DFSDsetcal/dsscal 2-359
DFSDsetdatastrs/dssdast 2-361
DFSDsetdims/dssdims 2-362
DFSDsetdimscale/dssdisc 2-363
DFSDsetdimstrs/dssdist 2-364
DFSDsetfillvalue/dssfill 2-365
DFSDsetlengths/dsslens 2-366
DFSDsetNT/dssnt 2-367
DFSDsetrange/dssrang 2-368
DFSDstartslab/dssslab 2-369
DFSDstartslice/dssslc 2-370
DFSDwriteref/dswref 2-371
DFSDwriteslab/dswslab 2-372
Happendable 2-373
Hcache 2-374
Hdeldd 2-375
Hendaccess 2-376
Hendbitaccess 2-377
Hexist 2-378
Hfidinquire 2-379
Hfind 2-380
Hgetbit 2-381
Hgetelement 2-382
Hinquire 2-383
Hlength 2-384
Hnewref 2-385
Hnextread 2-386
Hnumber/hnumber 2-387
Hoffset 2-388
Hputbit 2-389
Hputelement 2-390
Hread 2-391
Hseek 2-392
Hsetlength 2-393
Hshutdown 2-394
Htagnewref 2-395
Htrunc 2-396
Hwrite 2-397
HDFclose/hdfclose 2-399
HDFopen/hdfopen 2-400
HEclear 2-401
HEprint/heprntf/heprnt 2-402
HEpush 2-403
HEreport 2-404
HEstring/hestringf 2-405
HEvalue 2-406
3.1 Definition List Overview 3-407

HDF 4.2.6 - June 2011
Copyright
The HDF Group
www.hdfgroup.org
The HDF Group