_SbgString Struct Reference

#include <sbgString.h>

Data Fields
char	internalBuffer [SBG_CONFIG_STRING_INTERNAL_BUFFER_SIZE]
char *	pBuffer
size_t	capacity
size_t	length
bool	readOnly
bool	isStatic
SbgErrorCode	errorCode

Detailed Description

String.

The buffer contains a C null-terminated string. The null-terminating character is not considered to be part of the string content.

Attempts to modify a read-only string lead to undefined behavior.

Attempts to modify a string while the last modification operation error is set are canceled and return the last error code.

Field Documentation

internalBuffer

char _SbgString::internalBuffer[SBG_CONFIG_STRING_INTERNAL_BUFFER_SIZE]

Internal buffer.

The internal buffer is used for small strings to avoid dynamic allocation.

pBuffer

char* _SbgString::pBuffer

Buffer.

capacity

size_t _SbgString::capacity

Capacity of the buffer, in bytes.

length

size_t _SbgString::length

Length of the string (not including the terminating null character), in bytes.

readOnly

bool _SbgString::readOnly

True if the string is read-only.

isStatic

bool _SbgString::isStatic

True if the buffer is statically allocated.

errorCode

SbgErrorCode _SbgString::errorCode

Error code of the last modification operation.

---

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

• common/string/sbgString.h