Main Content

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");

blockingFactor = cdflib.getVarBlockingFactor(cdfId,0)
blockingFactor =

     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. You can access the CDF documentation at the CDF website.