HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UT_WorkBuffer::AutoLock Class Reference

#include <UT_WorkBuffer.h>

Public Member Functions

SYS_FORCE_INLINE AutoLock (UT_WorkBuffer &buf)
 
SYS_FORCE_INLINE ~AutoLock ()
 
SYS_FORCE_INLINE void release (bool recompute_length=false)
 You can manually release the buffer. More...
 
SYS_FORCE_INLINE void relock ()
 If you've manually released the lock, you can relock the buffer. More...
 
SYS_FORCE_INLINE char * operator* () const
 
SYS_FORCE_INLINE char * string () const
 

Detailed Description

Class to handle auto-locking of the UT_WorkBuffer. This is not related to multi-threading, but to the lock/release methods above.

You should never append data to a locked buffer.

Definition at line 174 of file UT_WorkBuffer.h.

Constructor & Destructor Documentation

SYS_FORCE_INLINE UT_WorkBuffer::AutoLock::AutoLock ( UT_WorkBuffer buf)
inline

Definition at line 178 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE UT_WorkBuffer::AutoLock::~AutoLock ( )
inline

Definition at line 184 of file UT_WorkBuffer.h.

Member Function Documentation

SYS_FORCE_INLINE char* UT_WorkBuffer::AutoLock::operator* ( void  ) const
inline

Get access to the non-const buffer. This may return nullptr if the lock has been released.

Definition at line 192 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::AutoLock::release ( bool  recompute_length = false)
inline

You can manually release the buffer.

Definition at line 199 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE void UT_WorkBuffer::AutoLock::relock ( )
inline

If you've manually released the lock, you can relock the buffer.

Definition at line 209 of file UT_WorkBuffer.h.

SYS_FORCE_INLINE char* UT_WorkBuffer::AutoLock::string ( ) const
inline

Get access to the non-const buffer. This may return nullptr if the lock has been released.

Definition at line 194 of file UT_WorkBuffer.h.


The documentation for this class was generated from the following file: