v2.21
IQuantityContainer Interface Reference

Represents a quantity container. More...

Inheritance diagram for IQuantityContainer:

Public Member Functions

HRESULT Contains ([in] GUID id, [out, retval] VARIANT_BOOL *pContains)
 Indicates whether the object supports the quantity specified by the identifier. More...
 
HRESULT Get ([in] GUID id, [out, retval] IQuantity **ppQuantity)
 Returns the quantity specified by the identifier. More...
 
HRESULT ContainsS ([in] BSTR id, [out, retval] VARIANT_BOOL *pContains)
 Same as IQuantityContainer::Contains, but accepting GUID as a string.
 
HRESULT GetS ([in] BSTR id, [out, retval] IQuantity **ppQuantity)
 Same as IQuantityContainer::Get, but accepting GUID as a string.
 

Detailed Description

Represents a quantity container.

A quantity container is basically any object type that has quantities. This interface can be obtained from model objects and layers.

See also
IModelObject, ILayer, Quantity identifiers

Member Function Documentation

◆ Contains()

HRESULT IQuantityContainer::Contains ( [in] GUID  id,
[out, retval] VARIANT_BOOL *  pContains 
)

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

Parameters
[in]idIdentifier of the quantity.
[out]pContainsTRUE if the object supports the quantity; otherwise returns FALSE.
See also
Quantity identifiers

◆ Get()

HRESULT IQuantityContainer::Get ( [in] GUID  id,
[out, retval] IQuantity **  ppQuantity 
)

Returns the quantity specified by the identifier.

Parameters
[in]idIdentifier of the quantity.
[out]ppQuantityThe requested quantity of the object, or nullptr if the quantity is not supported.
See also
Quantity identifiers