All Frameworks Class Hierarchy This Framework Indexes Previous Next

DataCommonProtocolUse Interface CATINavigateProvider

SystemTS.IUnknown

System.IDispatch

System.CATBaseUnknown

CATINavigateProvider

Usage: you can freely reimplement this interface.

interface CATINavigateProvider

Interface used to delegate to application the addition of children in CATINavigateObject implementation.
Role: the provider algorithm handles the applicative children in order to display them in the navigation tree.

See also:: CATINavigateObject

Method Index

o GetChildren(CATBaseUnknown*,CATLISTP(CATBaseUnknown)**): Returns a list of the children of a base object.

Methods

o GetChildren

public virtual HRESULT GetChildren(	CATBaseUnknown*	`iObj`,
	CATLISTP(CATBaseUnknown)**	`ioProvidedChildren`) = 0

Returns a list of the children of a base object.

Parameters:

iObj: The base feature object.
Legal values: it must not be NULL.
ioProvidedChildren: The list of the children of the base object known by applicative code.
Legal values: ioProvidedChildren must not be NULL. *ioProvidedChildren may be NULL or a pointer to a valid CATLISTP(CATBaseUnknown).
Lifecycle rules deviation When *ioProvidedChildren is not NULL, it has to be kept by callee as input argument.

Returns:

The code error.

S_OK: the method is successful
E_FAIL: otherwise

This object is included in the file: CATINavigateProvider.h
If needed, your Imakefile.mk should include the module: CATProviderItf