IDL Reference Guide: iTools Object Classes

IDLitDataContainer::GetIdentifiers

The IDLitDataContainer::GetIdentifiers function method retrieves the object identifiers for all data and data container objects contained in the data container object.

Syntax

Result = Obj->[IDLitDataContainer::]GetIdentifiers([Pattern] [, /LEAF])

Return Value

Returns an array of strings containing the object identifiers for all data and data container objects contained by the data container object. If the container is empty, or if the Pattern argument is supplied and no object identifiers are matched, the function returns a scalar null string.

Arguments

Pattern

A string specifying a search pattern to be used for filtering the returned object identifiers. Only object identifiers that match Pattern are returned. See STRMATCH for a description of the rules used when matching patterns.

Keywords

LEAF

Set this keyword to return only object identifiers whose final node is not a container object.

Version History

  IDL Online Help (March 06, 2007)