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

Developer

API Reference

IACTORFRAME_CONVERTPATHTOSTRING()

Brew Release
Brew MP 1.0.2
See Also
None
Description
string.
Params
path
[in]:
VfsPath to convert
pBuf
[in]:
The address of a buffer at which to store the converted path
pSize
[inout]:
The address of an integer which specifies the size of the buffer at pBuf. If the integer is -1, it will be changed to the size of buffer required.
Interface
Prototype
  •    int IActorFrame_ConvertPathToString(
          ActorBase *pMe,
          VfsPath path,
          AECHAR *pBuf,
          int *pSize
       )
    
Return
  • SUCCESS - the call has been completed successfully. ENEEDMORE - The data size has been corrected by the call. EBUFFERTOOSMALL - the buffer supplied is too small to copy out the data. EMEMPTR - pSize or the buffer supplied is NULL.
Side Effect
  • None
Comments
If pSize is NULL, the call fails with EMEMPTR. If pBuf is NULL (size request), then *pSize will be set to the size in bytes of the associated data, and the call will fail with ENEEDMORE. If *pSize is less than the size of data held by the node, then the call will fail with EBUFFERTOOSMALL. If *pSize is valid but pBuf is NULL, the call fails with EMEMPTR.