Documentation Center

  • Trial Software
  • Product Updates

cdflib.getFormat

Format of Common Data Format (CDF) file

Syntax

format = cdflib.setFormat(cdfId)

Description

format = cdflib.setFormat(cdfId) returns the format of the CDF file.

Input Arguments

cdfId

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

Output Arguments

format

Either of the following text strings, or its numeric equivalent.

'SINGLE_FILE'The CDF is stored in a single file.
'MULTI_FILE'The CDF is made up of multiple files.

To get the numeric equivalent of these text strings, use cdflib.getConstantValue.

Examples

Open the example CDF file and determine its file format:

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

format = cdflib.getFormat(cdfId)

format =

	  'SINGLE_FILE'

% Clean up.
cdflib.close(cdfId)
clear cdfId

References

This function corresponds to the CDF library C API routine CDFgetFormat.

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.

See Also

|

Tutorials

Was this topic helpful?