Functions



free

Abstract: A member function to release all resources created or used by the OSString object.
protected:

virtual void free();

This function should not be called directly, use release() instead.


isEqualTo

Abstract: A member function which tests the equality between an OSSymbol object and a simple c-string.
public:

virtual bool isEqualTo(const char *aCString) const;

Parameters

NameDescription
aCStringThe c-string to be compared against the receiver.
Result: Returns true if the OSSymbol's internal string representation is equivalent to the c-string it is being compared against, false otherwise.

isEqualTo

Abstract: A member function which tests the equality between two OSSymbol objects. Two OSSymbol objects are only equivalent when their references are identical
public:

virtual bool isEqualTo(const OSSymbol *aSymbol) const;

Parameters

NameDescription
aSymbolThe OSSymbol object to be compared against the receiver.
Result: Returns true if the two objects are equivalent, false otherwise.

isEqualTo

Abstract: A member function which tests the equality between an OSSymbol object and and arbitrary OSObject derived object.
public:

virtual bool isEqualTo(const OSObject *obj) const;

Parameters

NameDescription
objThe OSObject derived object to be compared against the receiver.
Result: Returns true if the OSSymbol and the OSObject objects are equivalent.

withCString

Abstract: A static constructor function to create an OSSymbol instance from a simple c-string returns an existing OSSymbol object based on the string object given.
public:

static const OSSymbol *withCString(const char *cString);

Parameters

NameDescription
cStringA c-string.
Result: Returns a unique OSSymbol object for the string given.

withCStringNoCopy

Abstract: A static constructor function to create an OSSymbol instance from a simple c-string, but does not copy the string to the container.
public:

static const OSSymbol *withCStringNoCopy(const char *cString);

Parameters

NameDescription
cStringA c-string.
Result: Returns a unique OSSymbol object for the string given.

withString

Abstract: A static constructor function to create an OSSymbol instance from an OSString object or returns an existing OSSymbol object based on the OSString object given.
public:

static const OSSymbol *withString(const OSString *aString);

Parameters

NameDescription
aStringAn OSString object.
Result: Returns a unique OSSymbol object for the string given.

© 2000 Apple Computer, Inc. — (Last Updated 2/23/2000)