Routines (alphabetical) > Routines: H > HDF Routines > HDF_DF24_NIMAGES

HDF_DF24_NIMAGES

The HDF_DF24_NIMAGES function returns the number of 24-bit images in an HDF file.

Syntax

Result = HDF_DF24_NIMAGES(Filename)

Return Value

Returns the number of images in the file or -1 if the specified file is invalid or damaged

Arguments

Filename

A string containing the name of the file to be searched.

Keywords

None

Examples

; Open HDF file:

h = HDF_OPEN('myhdf.hdf')

; Return the number of 24-bit images in the file:

number = HDF_DF24_NIMAGES('myhdf.hdf')

; Print information about the returned value. If there were five

; images in the file, IDL would print NUMBER LONG = 5

HELP, number

; Close the HDF file:

HDF_CLOSE, h

Version History

 

4.0

Introduced

See Also

HDF_DF24_GETIMAGE, HDF_DF24_GETINFO, HDF_DF24_READREF, HDF_DF24_RESTART, HDF_DFR8_NIMAGES