DBReadMetaData()

  DBReadMetaData and DBWriteMetaData

Description

DBReadMetaData() is used to read the string value associated with a particular meta data item name in the indicated layer of the indicated file.

Call Signatures

string DBReadMetaData ( int/string filespec, string layer_type, int layer_index, string item_name )

mstring DBReadMetaData ( int/string filespec, string layer_type, int layer_index )

Return Value

string/mstring

If the item_name argument is present, then the value of the meta data item is returned as a string. If the item doesn't exist, an empty string is returned. If the item_name argument is missing, then the names of all the meta data values that actually exist in that layer will be returned as an mstring.

Arguments

int/string filespec:

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

string layer_type:

The name of the type of layer. This is either "FIL" for the overall file, "IMG" for an image channel or one of the segment types listed in DBNextSeg().

int layer_index:

The channel, or segment number. Ignored if layer_type is "FIL".

string item_name:

If this argument is present, this is the meta data item being searched for and the value of it is returned. If this argument is missing then all the meta data item names are returned.

Remarks

If the layer doesn't exist a fatal error will be generated.

See also

GDB file functions

DBWriteMetaData()

© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.