Main Content

cdflib.getReadOnlyMode

Read-only mode

Syntax

mode = cdflib.getReadOnlyMode(cdfId)

Description

mode = cdflib.getReadOnlyMode(cdfId) returns the read-only mode of 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

mode

One of the following character vectors or its numeric equivalent.

'READONLYon'CDF is in read-only mode
'READONLYoff'CDF can be modified.

To get the numeric equivalent of the constants specified by these character vectors, use cdflib.getConstantValue.

Examples

Open the example CDF file and determine its current read-only status:

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

mode = cdflib.getReadOnlyMode(cdfId)

mode =

READONLYoff

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

References

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

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

For copyright information, see the cdfcopyright.txt file.