ISCModelDirectory

The Model Directory encapsulates information on a single model directory entry. Examples of the Model Directory are a file system directory or a mart library.

The following table contains the methods for the ISCModelDirectory interface:

Method

Description

VARIANT_BOOL DirectoryExists( BSTR Locator)

Returns TRUE if a specified directory exists.

VARIANT_BOOL DirectoryUnitExists( BSTR Locator)

Returns TRUE if a specified directory unit exists.

SC_ModelDirectoryFlags Flags()

Model Directory flags. A 32-bit property flag word.

VARIANT_BOOL IsOfType( ISCModelDirectory * Directory)

Returns TRUE if Directory has the same type of connection as self.

For example, directory entries from the same mart and with the same login attributes, such as user, password, and so on, are considered of the same type.

ISCModelDirectory * LocateDirectory (BSTR Locator, VARIANT Filter [optional])

Starts enumeration over the directory sub-entries.

ISCModelDirectory * LocateDirectoryNext()

Locates the next sub-entry in the directory enumeration. Returns a NULL pointer if no more model directory entries can be found.

ISCModelDirectoryUnit * LocateDirectoryUnit (BSTR Locator, VARIANT Filter [optional])

Starts enumeration over the directory units.

ISCModelDirectoryUnit * LocateDirectoryUnitNext()

Locates the next unit in the directory enumeration.

BSTR Locator()

Location of the directory including the absolute path and parameters. Does not include password information.

BSTR Name()

Model Directory name. For example, the file system directory name without path information.

ISCPropertyBag* PropertyBag( VARIANT List [optional], VARIANT AsString [optional])

Returns a pointer on a property bag with the directory properties.

A directory property is present in the resulting bag only if it has a value. If the property does not have any value set, the property bag will not have the property listed.

void PropertyBag( VARIANT List [optional], VARIANT AsString [optional], ISCPropertyBag* Property Bag)

Accepts a pointer on a property bag with the directory properties.

SC_ModelDirectoryType Type()

Type of a directory.