Documentation Center

  • Trial Software
  • Product Updates

cdflib.getVarBlockingFactor

Blocking factor for variable

Syntax

blockingFactor = cdflib.getVarBlockingFactor(cdfId,varNum)

Description

blockingFactor = cdflib.getVarBlockingFactor(cdfId,varNum) returns the blocking factor for a variable in a Common Data Format (CDF) file. A variable's blocking factor specifies the minimum number of records the library allocates when you write to an unallocated record.

cdfId identifies the CDF file. varNum is a numeric value that identifies the variable. Variable numbers are zero-based.

Examples

Open the example CDF and determine the blocking factor of a variable.

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

cdflib.getVarBlockingFactor(cdfid,0)

ans =

     0

%  Clean up
cdflib.close(cdfid)
clear cdfid

References

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

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?