Developer

API Reference

ITRIGMLELEMENT_GetStringAttribute()

deprecated
Items marked as deprecated have been replaced by a more powerful, alternative feature. Deprecated interfaces include a reference to the replacement interface, which should be used for all new application development. Deprecated features are still supported for backward compatibility, but should be avoided when developing new applications.
Brew Release
Brew MP 1.0.2
See Also
ITRIGMLELEMENT_GetAttribute() ITRIGMLELEMENT_SetAttribute() ITRIGMLELEMENT_GetAttributeNoResolve()
Description
Resolves and returns the wide string value of the given attribute on the given element.
Parameters
  • po
    []:
    The element for which to get the attribute.
  • classId
    []:
    The class ID of the attribute to get. This should be a KTrigml*ExtensionClassId constant from an extension metadata header.
  • id
    []:
    The attribute ID of the attribute to get. This should be a KTrigml*Attr* constant from an extension metadata header.
  • ppStringValue
    []:
    A pointer to the resolved wide string. The memory pointed to is owned by the Trigplayer; do not free it.
Interface
ITRIGMLELEMENT
Prototype
   int ITRIGMLELEMENT_GetStringAttribute(ITrigmlElement* po, AEECLSID classId, uint16 id, const AECHAR** ppStringValue)
Return
   If the attribute exists on the element and its value was successfully
   resolved, the function will return SUCCESS and *ppValue will point to the
   resolved value of the attribute.
   If the attribute does not exist on the element, the function will return
   SUCCESS and *ppValue will be NULL.
   If the attribute exists on the element but the return value is not a string type,
   the function will return ENOTYPE.
   If the attribute exists on the element but could not be resolved, the
   function will return an appropriate non-SUCCESS error code.
Side Effect
Any observers of the attribute value will be notified with the new resolved attribute value. Attribute resolution can therefore be an expensive operation. Do not call ITRIGMLELEMENT_GetAttribute more often than is necessary.
Comment
This function does not do any type conversion, it simply casts the returned value to a const AECHAR *, it is the callers responsibility to call this function only on attributes of the appropriate type.
  • Follow