IString Struct Reference

Inheritance diagram for IString:

Collaboration diagram for IString:

Detailed Description

Represents string variable as IString interface. Use this interface to wrap string variable when you need to add the variable to lists, dictionaries and other containers which accept IBaseObject and derived interfaces.

Available factories:

// Creates a new String object. Throws exception if not successful.
IString* String_Create(ConstCharPtr value)
 
// Creates a new String object with predefined length. Returns error code if not successful.
ErrCode createString(IString** obj, ConstCharPtr value)
 
// Creates a new String object with predefined length. Throws exception if not successful.
IString* StringN_Create(ConstCharPtr data, SizeT length)
 
// Creates a new String object. Returns error code if not successful.
ErrCode createStringN(IString** obj, ConstCharPtr data, SizeT length)

Public Member Functions
virtual ErrCode INTERFACE_FUNC	getCharPtr (ConstCharPtr *value)=0
	Gets a string value stored in the object. More...
virtual ErrCode INTERFACE_FUNC	getLength (SizeT *size)=0
	Gets length of string. More...
Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...
virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...
virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...
virtual ErrCode INTERFACE_FUNC	equals (IBaseObject *other, Bool *equal) const =0
	Compares object to another object for equality. More...
virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...
Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...
virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...
virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

getCharPtr()

virtual ErrCode INTERFACE_FUNC getCharPtr ( ConstCharPtr *  value )

pure virtual

Gets a string value stored in the object.

Parameters

[out]

value

Stored string value.

Returns

OPENDAQ_SUCCESS if succeeded, error code otherwise.

Call this method to extract the string value that is stored in the object. Method extracts the value as a pointer to 8-bit char type.

getLength()

virtual ErrCode INTERFACE_FUNC getLength ( SizeT *  size )

pure virtual

Gets length of string.

Parameters

[out]

size

The size of the string.

Returns

OPENDAQ_SUCCESS if succeeded, error code otherwise.

Call this method to get the length of the string. Null char terminator is not included in the size of the string.