v2.47
IQuantityContainer Interface Reference

Represents a quantity container. More...

Public Member Functions

HRESULT Contains ([in] GUID id, [out, retval] VARIANT_BOOL *pContains)
 Indicates whether the object supports the quantity specified by the identifier.
HRESULT ContainsS ([in] BSTR id, [out, retval] VARIANT_BOOL *pContains)
 Same as Contains, but accepting GUID as a string.
HRESULT Get ([in] GUID id, [out, retval] IQuantity **ppQuantity)
 Returns the quantity specified by the identifier.
HRESULT GetS ([in] BSTR id, [out, retval] IQuantity **ppQuantity)
 Same as 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, layers, rebar usages and reinforcement unit usages.

To find out what quantities an entity has, see this page.

See also
Quantities, IModelObject, ILayer, IRebarUsage, IReinforcementUnitUsage

Member Function Documentation

◆ Contains()

HRESULT 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
Quantities

◆ Get()

HRESULT 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
Quantities