cdflib.inquire

Basic characteristics of Common Data Format (CDF) file

Syntax

info = cdflib.inquire(cdfId)

Description

info = cdflib.inquire(cdfId) returns basic information about a Common Data Format (CDF) file.

Input Arguments

cdfId

Identifier of a CDF file, returned by a call to cdflib.create or cdflib.open.

Output Arguments

info

A structure containing the following fields:

FieldDescription
encodingEncoding of the variable data and attribute entry data
majorityMajority of the variable data
maxRecMaximum record number written to a CDF variable
numVarsNumber of CDF variables
numvAttrsNumber of attributes with variable scope
numgAttrsNumber of attributes with global scope

Examples

Open the example CDF file, and then get basic information about the file:

cdfId = cdflib.open('example.cdf');

info = cdflib.inquire(cdfId)

info = 

     encoding: 'IBMPC_ENCODING'
     majority: 'ROW_MAJOR'
       maxRec: 23
      numVars: 5
    numvAttrs: 1
    numgAttrs: 3

References

This function corresponds to the CDF library C API routines CDFinquireCDF and CDFgetNumgAttributes.

To use this function, you must be familiar with the CDF C interface. Read the CDF documentation at the CDF Web site.

For copyright information, see the cdfcopyright.txt file.

Was this topic helpful?