Main Content

cdflib.getAttrgEntry

Value of entry in global attribute

Syntax

value = cdflib.getAttrgEntry(cdfId,attrNum,entryNum)

Description

value = cdflib.getAttrgEntry(cdfId,attrNum,entryNum) returns the value of a global attribute entry in a Common Data Format (CDF) file.

Input Arguments

cdfId

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

attrNum

Numeric value that identifies the attribute. Attribute numbers are zero-based. The attribute must have global scope.

entryNum

Numeric value that specifies the entry in the attribute. Entry numbers are zero-based.

Output Arguments

Value

Value of the entry.

Examples

Open the example CDF, and then get the value of an entry associated with a global attribute in the file:

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

% All of the first three attributes have global scope
attrscope = cdflib.getAttrScope(cdfId,0)
attrscope =

    'GLOBAL_SCOPE'
% Get information about the first entry for global attribute
[dtype,numel] = cdflib.inquireAttrgEntry(cdfId,0,0)
dtype =

    'cdf_char'


numel =

    23
% Get the value of the first entry for this global attribute
value = cdflib.getAttrgEntry(cdfId,0,0)
value =

    'This is a sample entry.'
% Clean up
cdflib.close(cdfId)
clear cdfId

Tips

  • This function corresponds to the CDF library C API routine CDFgetAttrgEntry.

  • To use this function, you must be familiar with the CDF C interface. You can access the CDF documentation at the CDF website.

Version History

expand all