IParameterContainer Interface Reference

Represents a parameter container. More...

Inheritance diagram for IParameterContainer:

Public Member Functions
HRESULT	Contains ([in] GUID id, [out, retval] VARIANT_BOOL *pResult)
	Indicates whether the object supports the parameter specified by the identifier.
HRESULT	ContainsS ([in] BSTR id, [out, retval] VARIANT_BOOL *pContains)
	Same as IParameterContainer::Contains, but accepting GUID as a string.
HRESULT	Get ([in] GUID id, [out, retval] IParameter **ppParameter)
	Gets a parameter by it's id.
HRESULT	GetIds ([out, retval] IGuidCollection **ppIds)
	Gets the identifiers of parameters in the collection.
HRESULT	GetS ([in] BSTR id, [out, retval] IParameter **ppParameter)
	Same as IParameterContainer::Get, but accepting GUID as a string.

Detailed Description

Represents a parameter container.

This interface can be obtained from a model object via the IModelObject::GetParameters() method or as an additional interface from IEntity interface.

See also

IParameter

Member Function Documentation

Contains()

HRESULT Contains	(	[in] GUID	id,
		[out, retval] VARIANT_BOOL *	pResult )

Indicates whether the object supports the parameter specified by the identifier.

Parameters

[in]	id	Identifier of the parameter.
[out]	pResult	TRUE if the object supports the parameter; otherwise returns FALSE.

Get()

HRESULT Get	(	[in] GUID	id,
		[out, retval] IParameter **	ppParameter )

Gets a parameter by it's id.

Returns

The parameter.

GetIds()

HRESULT GetIds

(

[out, retval] IGuidCollection **

ppIds

)

Gets the identifiers of parameters in the collection.

Returns

The collection of guids.