API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IVFSNODE_GETPROPERTY()

Brew Release
Brew MP 1.0.2
See Also
IVFSNODE_SetProperty() The inline accessor functions described below. IVFSCONTAINER_GetItemsInUse(), IVFSCONTAINER_GetMaxItems()
Description
Each IVfsNode has various properties associated with it. This function reads the values of the various properties.
Params
po
[]:
[in] Pointer to the IVfsNode interface object
prop
[]:
[in] The property to return
pV
[]:
[out] Address at which to store the requested value.
Interface
  • IVFSNODE
Prototype
  •    int IVFSNODE_GetProperty(IVfsNode * po,NodeProperty prop,void * pV)
    
Return
  •    SUCCESS, or standard error code.
    
Side Effect
  • None
Comments
You should normally use the inline accessor functions defined below (and in AEEVfsContainer.h) rather than IVFSNODE_GetProperty() so that type casting can be performed on the return value. All nodes support the readable properties: NODEPROPERTY_NAME NODEPROPERTY_PARENT NODEPROPERTY_MODEL NODEPROPERTY_OBJECT NODEPROPERTY_TYPE NODEPROPERTY_OBSERVED NODEPROPERTY_PERMANENT NODEPROPERTY_INUSE String and data nodes support the properties: NODEPROPERTY_BUFFER NODEPROPERTY_BUFFSIZE Container nodes additionally support the properties: NODEPROPERTY_MAXITEMS NODEPROPERTY_USEDITEMS