• 
• 
• 
• 

Global functions in the support kit
[Support Kit]

Typedefs
typedef BArchivable *(*)	instantiation_func (BMessage *)
	Internal definition of a function that can instantiate objects that have been created with the BArchivable API.
Functions
status_t	add_system_beep_event (const char *eventName, uint32 flags=0)
	Adds an event to the media server.
int32	atomic_add (vint32 *value, int32 addValue)
	Undocumented.
int64	atomic_add64 (vint64 *value, int64 addValue)
	Undocumented.
int32	atomic_and (vint32 *value, int32 andValue)
	Undocumented.
int64	atomic_and64 (vint64 *value, int64 andValue)
	Undocumented.
int32	atomic_get (vint32 *value)
	Undocumented.
int64	atomic_get64 (vint64 *value)
	Undocumented.
int32	atomic_or (vint32 *value, int32 orValue)
	Undocumented.
int64	atomic_or64 (vint64 *value, int64 orValue)
	Undocumented.
int32	atomic_set (vint32 *value, int32 newValue)
	Undocumented.
int64	atomic_set64 (vint64 *value, int64 newValue)
	Undocumented.
int32	atomic_test_and_set (vint32 *value, int32 newValue, int32 testAgainst)
	Undocumented.
int64	atomic_test_and_set64 (vint64 *value, int64 newValue, int64 testAgainst)
	Undocumented.
status_t	beep ()
	Invoke the standard system beep to alert users.
int	Compare (const BString *a, const BString *b)
	Lexographically compare two strings.
int	Compare (const BString &a, const BString &b)
	Lexographically compare two strings.
instantiation_func	find_instantiation_func (BMessage *archive)
	Internal function that searches for the instantiation func that works on the specified archive. Use instantiate_object() instead.
instantiation_func	find_instantiation_func (const char *className)
	Internal function that searches for the instantiation func of a specific class. Use instantiate_object() instead.
instantiation_func	find_instantiation_func (const char *className, const char *signature)
	Internal function that searches for the instantiation func with a specific signature. Use instantiate_object() instead.
int	ICompare (const BString *a, const BString *b)
	Lexographically compare two strings in a case insensitive way.
int	ICompare (const BString &a, const BString &b)
	Lexographically compare two strings in a case insensitive way.
BArchivable *	instantiate_object (BMessage *from)
	Instantiate an archived object.
BArchivable *	instantiate_object (BMessage *from, image_id *id)
	Instantiate an archived object with the object being defined in a different application or library.
bool	operator!= (const char *a, const BString &b)
	Lexographically compare if a is not equal to given BString.
bool	operator< (const char *a, const BString &b)
	Lexographically compare if a is less than a given BString.
bool	operator<= (const char *a, const BString &b)
	Lexographically compare if a is less than or equal to a given BString.
bool	operator== (const char *a, const BString &b)
	Lexographically compare if a is equal to a given BString.
bool	operator> (const char *a, const BString &b)
	Lexographically compare if a is more than a given BString.
bool	operator>= (const char *a, const BString &b)
	Lexographically compare if a is more than or equal to a given BString.
status_t	system_beep (const char *eventName)
	Invokes the sound for event eventName.
bool	validate_instantiation (BMessage *from, const char *className)
	Internal function that checks if the className is the same as the one stored in the from message.

---

Function Documentation

status_t add_system_beep_event	(	const char *	eventName,
		uint32	flags = 0
	)

Adds an event to the media server.

Call this method to add a specific event to the media server.

From Beep.h and in libbe.so.

Parameters:

	eventName	The name of the event.
	flags	Currently unused. Pass 0.

int32 atomic_add	(	vint32 *	value,
		int32	addValue
	)

Undocumented.

See also:

atomic_add64() for a version that works on long long

atomic_set(), atomic_test_and_set(), atomic_and(), atomic_or(), atomic_get()

int64 atomic_add64	(	vint64 *	value,
		int64	addValue
	)

Undocumented.

See also:

atomic_add() for a version that works on an int32

atomic_set64(), atomic_test_and_set64(), atomic_and64(), atomic_or64(), atomic_get64()

int32 atomic_and	(	vint32 *	value,
		int32	andValue
	)

Undocumented.

See also:

atomic_and64() for a version that works on long long

atomic_set(), atomic_test_and_set(), atomic_add(), atomic_or(), atomic_get()

int64 atomic_and64	(	vint64 *	value,
		int64	andValue
	)

Undocumented.

See also:

atomic_and() for a version that works on an int32

atomic_set64(), atomic_test_and_set64(), atomic_add64(), atomic_or64(), atomic_get64()

int32 atomic_get

(

vint32 *

value

)

Undocumented.

See also:

atomic_get64() for a version that works on long long

atomic_set(), atomic_test_and_set(), atomic_add(), atomic_and(), atomic_or()

int64 atomic_get64

(

vint64 *

value

)

Undocumented.

See also:

atomic_get() for a version that works on an int32

atomic_set64(), atomic_test_and_set64(), atomic_add64(), atomic_and64(), atomic_or64()

int32 atomic_or	(	vint32 *	value,
		int32	orValue
	)

Undocumented.

See also:

atomic_or64() for a version that works on long long

atomic_set(), atomic_test_and_set(), atomic_add(), atomic_and(), atomic_get()

int64 atomic_or64	(	vint64 *	value,
		int64	orValue
	)

Undocumented.

See also:

atomic_or() for a version that works on an int32

atomic_set64(), atomic_test_and_set64(), atomic_add64(), atomic_and64(), atomic_get64()

int32 atomic_set	(	vint32 *	value,
		int32	newValue
	)

Undocumented.

See also:

atomic_set64() for a version that works on long long

atomic_test_and_set(), atomic_add(), atomic_and(), atomic_or(), atomic_get()

int64 atomic_set64	(	vint64 *	value,
		int64	newValue
	)

Undocumented.

See also:

atomic_set() for a version that works on an int32

atomic_test_and_set64(), atomic_add64(), atomic_and64(), atomic_or64(), atomic_get64()

int32 atomic_test_and_set	(	vint32 *	value,
		int32	newValue,
		int32	testAgainst
	)

Undocumented.

See also:

atomic_test_and_set64() for a version that works on long long

atomic_set(), atomic_add(), atomic_and(), atomic_or(), atomic_get()

int64 atomic_test_and_set64	(	vint64 *	value,
		int64	newValue,
		int64	testAgainst
	)

Undocumented.

See also:

atomic_test_and_set() for a version that works on an int32

atomic_set64(), atomic_add64(), atomic_and64(), atomic_or64(), atomic_get64()

status_t beep

(

)

Invoke the standard system beep to alert users.

From Beep.h and in libbe.so.

See also:

system_beep() and add_system_beep_event()

int Compare	(	const BString *	a,
		const BString *	b
	)

Lexographically compare two strings.

This function is useful if you need a global compare function to feed to BList::SortItems() for example.

From String.h and in libbe.so.

See also:

BString::Compare(const BString &string) const

int Compare	(	const BString &	a,
		const BString &	b
	)

Lexographically compare two strings.

This function is useful if you need a global compare function to feed to BList::SortItems() for example.

From String.h and in libbe.so.

See also:

BString::Compare(const BString &string) const

int ICompare	(	const BString *	a,
		const BString *	b
	)

Lexographically compare two strings in a case insensitive way.

This function is useful if you need a global compare function to feed to BList::SortItems() for example.

From String.h and in libbe.so.

See also:

BString::Compare(const BString &string) const

int ICompare	(	const BString &	a,
		const BString &	b
	)

Lexographically compare two strings in a case insensitive way.

This function is useful if you need a global compare function to feed to BList::SortItems() for example.

From String.h and in libbe.so.

See also:

BString::Compare(const BString &string) const

BArchivable * instantiate_object

(

BMessage *

from

)

Instantiate an archived object.

This global function will determine the base class, based on the from argument, and it will call the Instantiate() function of that object to restore it.

Parameters:

from

The archived object.

Returns:

The object returns a pointer to the instantiated object, or NULL if the instantiation failed. The global errno variable will contain the reason why it failed.

See also:

instantiate_object(BMessage *from, image_id *id)

BArchivable * instantiate_object	(	BMessage *	from,
		image_id *	id
	)

Instantiate an archived object with the object being defined in a different application or library.

This function is similar to instantiate_object(BMessage *from), except that it takes the id argument referring to an image where the object might be stored.

Note:

Images are names for executable files. Image id's refer to these executable files that have been loaded by your application. Have a look at the kernel API for further information.

bool operator!=	(	const char *	a,
		const BString &	b
	)			[inline]

Lexographically compare if a is not equal to given BString.

From String.h and in libbe.so.

See also:

BString::operator!=(const char *string) const

bool operator<	(	const char *	a,
		const BString &	b
	)			[inline]

Lexographically compare if a is less than a given BString.

From String.h and in libbe.so.

See also:

BString::operator<(const char *string) const

bool operator<=	(	const char *	a,
		const BString &	b
	)			[inline]

Lexographically compare if a is less than or equal to a given BString.

From String.h and in libbe.so.

See also:

BString::operator<=(const char *string) const

bool operator==	(	const char *	a,
		const BString &	b
	)			[inline]

Lexographically compare if a is equal to a given BString.

From String.h and in libbe.so.

See also:

BString::operator==(const char *string) const

bool operator>	(	const char *	a,
		const BString &	b
	)			[inline]

Lexographically compare if a is more than a given BString.

From String.h and in libbe.so.

See also:

BString::operator>(const char *string) const

bool operator>=	(	const char *	a,
		const BString &	b
	)			[inline]

Lexographically compare if a is more than or equal to a given BString.

From String.h and in libbe.so.

See also:

BString::operator>=(const char *string) const

status_t system_beep

(

const char *

eventName

)

Invokes the sound for event eventName.

You can add the events using add_system_beep_event().

From Beep.h and in libbe.so.

---

The Haiku Book pre-R1 - Global functions in the support kit
Generated on 14 Feb 2008