DBGetChanInfo()

Description

DBGetChanInfo() is used to retrieve a the channel layout info structure.

Call Signature

int DBGetChanInfo ( int/string filespec, int channel_num )

Return Value

int

Non-zero is returned for success, 0 for failure. Note:If the input channel number is wrong the process stops execution with an error of type "ES_ILLEGAL", unless the programmer uses a TRY/ONERROR handler to avoid the abnormal termination.

Arguments

int/string filespec:

This can either be the handle returned by DBOpen(), or the name of an open file.

int channel_num:

The channel to read the layout information from.

ChanLayoutInfo ptr info:

The structure to place the information in.

Remarks

The caller must pass a ChanLayoutInfo structure into DBGetChanInfo(). See IMAGELN for a description of the disk file image layout. Note that ChanType is one of 8U, 16U, 16S, or 32R. SwapFlag is 1 if the data is in little endian (PC) byte order, or 0 if it is in big endian (or Sun/Motorola) byte order.

 define structure ChanLayoutInfo
  string       Filename
  string       ChanType
  int          ImageOffset
  int          PixelOffset
  int          LineOffset
  int          SwapFlag
 enddefine

See also GDB file functions

DBSetChanInfo()