Steinberg::IString Class Reference

Interface to a string of variable size and encoding. More...

#include "istringresult.h"

Inheritance diagram for Steinberg::IString:

Public Member Functions
virtual void PLUGIN_API	setText8 (const char8 *text)=0
	Assign ASCII string.
virtual void PLUGIN_API	setText16 (const char16 *text)=0
	Assign unicode string.
virtual const char8 *PLUGIN_API	getText8 ()=0
	Return ASCII string.
virtual const char16 *PLUGIN_API	getText16 ()=0
	Return unicode string.
virtual void PLUGIN_API	take (void *s, bool isWide)=0
	!Do not use this method! Early implementations take the given pointer as internal string and this will cause problems because 'free' will be used to delete the passed memory.
virtual bool PLUGIN_API	isWideString () const =0
	Returns true if the string is in unicode format, returns false if the string is ASCII.
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
	Query for a pointer to the specified interface.
virtual uint32 PLUGIN_API	addRef ()=0
	Adds a reference and returns the new reference count.
virtual uint32 PLUGIN_API	release ()=0
	Releases a reference and returns the new reference count.

Static Public Attributes
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Detailed Description

Interface to a string of variable size and encoding.

• [host imp] or [plug imp]
• [released: ]

Definition at line 49 of file istringresult.h.

Member Function Documentation

getText16()

virtual const char16 *PLUGIN_API Steinberg::IString::getText16 ( )

pure virtual

Return unicode string.

If the string is ASCII so far, it will be converted.

Implemented in Steinberg::StringObject.

getText8()

virtual const char8 *PLUGIN_API Steinberg::IString::getText8 ( )

pure virtual

Return ASCII string.

If the string is unicode so far, it will be converted. So you need to be careful, because the conversion can result in data loss. It is save though to call getText8 if isWideString() returns false

Implemented in Steinberg::StringObject.

isWideString()

virtual bool PLUGIN_API Steinberg::IString::isWideString ( ) const

pure virtual

Returns true if the string is in unicode format, returns false if the string is ASCII.

Implemented in Steinberg::StringObject.

setText16()

virtual void PLUGIN_API Steinberg::IString::setText16 ( const char16 *  text )

pure virtual

Assign unicode string.

Implemented in Steinberg::StringObject.

setText8()

virtual void PLUGIN_API Steinberg::IString::setText8 ( const char8 *  text )

pure virtual

Assign ASCII string.

Implemented in Steinberg::StringObject.

take()

virtual void PLUGIN_API Steinberg::IString::take ( void *  s, bool  isWide  )

pure virtual

!Do not use this method! Early implementations take the given pointer as internal string and this will cause problems because 'free' will be used to delete the passed memory.

Later implementations will redirect 'take' to setText8 and setText16

Implemented in Steinberg::StringObject.

Member Data Documentation

iid

const FUID Steinberg::IString::iid

static

Definition at line 74 of file istringresult.h.

---

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

• juce_audio_processors/format_types/VST3_SDK/pluginterfaces/base/istringresult.h