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

Developer

API Reference

IBTFTPSERVER_GETPATHNAME()

Brew Release
Brew MP 1.0.2
See Also
IBTFTPServer_GetEvent()
Description
Retrieves the name of the file or directory associated with the operation request being processed.
Params
_me
[in]:
the object
pathName
[out]:
destination for object name
pathNameLen
[in]:
number of chars pathName can hold
pathNameLenReq
[out]:
number of chars pathName must be able to hold
Return
AEE_SUCCESS
[]:
path name successfully retrieved
AEE_EBADPARM
[]:
invalid input parameters
AEE_EBUFFERTOOSMALL
[]:
pathName can't hold the entire name string
AEE_ENOSUCH
[]:
no path name available
Interface
Prototype
  •    AEEResult IBTFTPServer_GetPathName(IBTFTPServer* _me, 
                                          char* pathName, 
                                          int pathNameLen, 
                                          int* pathNameLenReq);
    
Side Effect
  • None
Comments
None