Documentation Center

  • Trial Software
  • Product Updates

cdflib.getAttrScope

Scope of attribute

Syntax

scope = cdflib.getAttrScope(cdfId,attrNum)

Description

scope = cdflib.getAttrScope(cdfId,attrNum) returns the scope of an attribute 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 specifies the attribute. Attribute numbers are zero-based.

Output Arguments

scope

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

Text StringDescription
'GLOBAL_SCOPE'Attribute applies to the CDF as a whole.
'VARIABLE_SCOPE'Attribute applies only to the variable.

To get the numeric equivalent of these text string constants, use the cdflib.getConstantValue function.

Examples

Open example CDF and get the scope of the first attribute in the file:

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

attrScope = cdflib.getAttrScope(cdfid,0)

attrScope =

GLOBAL_SCOPE

% Clean up
cdflib.close(cdfid);

clear cdfid

References

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

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?