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

Developer

API Reference

IACTORCONTEXT_CREATESTRING()

Brew Release
Brew MP 1.0.2
See Also
IVFSNODE_DataBuffer() IVFSNODE_DataBufferSize() IVFSNODE_SetDataBuffer() IVFSNODE_SetDataBufferSize()
Description
This function creates a new 'standard' object with an IVfsNode interface. The object can hold string values (i.e. a number of AECHAR characters).
Params
po
[]:
pointer to the IActorContext interface object
name
[]:
The name to give to the new IVfsNode object
maxChars
[]:
The number of characters to be reserved for the data of this object
parent
[]:
The container which is to contain the new IVfsNode object
flags
[]:
Options for the node - see "Flags values for the CreateXxx calls" above
pN
[]:
[out] Address at which to store a pointer to the new node.
Interface
  • IACTORCONTEXT
Prototype
  •    int IACTORCONTEXT_CreateString(IActorContext * po,VfsPathElement name,uint32 maxChars,IVfsContainer * parent,uint32 flags,IVfsNode ** pN)
    
Return
  •    SUCCESS, or standard BREW error code.
    
Side Effect
  • None
Comments
The new node needs to be added to its parent container after creation. Unless ACTORCONTEXT_CREATE_PRIVATE_VTABLE is specified in the flags argument, the node shares its VTable with other nodes created using this method; therefore the VTable may NOT be modified. Note that it is possible to create a node of zero size, and then to use IVFSNODE_SetDataBuffer (and IVFSNODE_SetDataBufferSize) to reserve space for the data. The IActorContext COPIES the name into the new node (so name may be a local variable).