beastapi/beaststring.h Source File

beaststring.h
Go to the documentation of this file.
1 /*
2 Copyright 2014 Autodesk, Inc. All rights reserved.
3 Use of this software is subject to the terms of the Autodesk license agreement
4 provided at the time of installation or download, or which otherwise
5 accompanies this software in either electronic or hard copy form.
6 */
7 
8 
13 #ifndef BEASTSTRING_H
14 #define BEASTSTRING_H
15 
16 #include "beastapitypes.h"
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif // __cplusplus
21 
35 ILB_DLL_FUNCTION ILBStatus ILBGetLength(ILBStringHandle string,
36  int32* length);
37 
48 ILB_DLL_FUNCTION ILBStatus ILBCopy(ILBStringHandle string,
49  ILBString target,
50  int32 length);
51 
59 ILB_DLL_FUNCTION ILBStatus ILBReleaseString(ILBStringHandle string);
60 
61 #ifdef __cplusplus
62 }
63 #endif // __cplusplus
64 
65 
66 #endif // BEASTSTRING_H
67 
ILBStatus ILBCopy(ILBStringHandle string, ILBString target, int32 length)
Copies the contained string to a buffer.
This header is the base for getting platform consistent types for the Beast API.
ILBStatus ILBReleaseString(ILBStringHandle string)
Releases a string object.
ILBCharType * ILBString
Beast api string type.
Definition: beastapitypes.h:238
ILBStatus ILBGetLength(ILBStringHandle string, int32 *length)
Returns the length of the string in number of characters.
ILBStatus
Status codes for Beast API calls.
Definition: beastapitypes.h:153
Handle for Beast strings Intentionally hidden implementation.
Definition: beastapitypes.h:471