ADC Home > Reference Library > Reference > Darwin > Kernel Framework Reference

OSBoolean

Inherits from:	OSObject
Declared In:	OSBoolean.h

Overview

Container class for Boolean values.

Functions

getValue: Obtains the value of the OSBoolean object as the standard C++ type bool.
isEqualTo(const OSBoolean *): Tests the equality of two OSBoolean objects.
isEqualTo(const OSMetaClassBase *): Tests the equality between an arbitrary OSObject-derived object and an OSBoolean object.
isFalse: Tests if the Boolean object is false.
isTrue: A member function to test if the Boolean object is true.
serialize: Archives the receiver.

getValue

Obtains the value of the OSBoolean object as the standard C++ type bool.

public

virtual bool getValue() const;

Return Value

The value of the OSBoolean object.

isEqualTo(const OSBoolean *)

Tests the equality of two OSBoolean objects.

public

virtual bool isEqualTo(
    const OSBoolean *boolean) const;

Parameters

boolean: An OSBoolean object to be compared against the receiver.

Return Value

Returns true if the two objects are equivalent.

isEqualTo(const OSMetaClassBase *)

Tests the equality between an arbitrary OSObject-derived object and an OSBoolean object.

public

virtual bool isEqualTo(
    const OSMetaClassBase *obj) const;

Parameters

obj: An OSObject-derived object to be compared against the receiver.

Return Value

Returns true if the two objects are equivalent.

isFalse

Tests if the Boolean object is false.

public

virtual bool isFalse() const;

Return Value

Returns true if the OSBoolean object is false, false otherwise.

isTrue

A member function to test if the Boolean object is true.

public

virtual bool isTrue() const;

Return Value

Returns true if the OSBoolean object is true, false otherwise.

serialize

Archives the receiver.

public

virtual bool serialize(
    OSSerialize *s) const;

Parameters

s: The OSSerialize object.

Return Value

Returns true if serialization was successful, false if not.

Did this document help you?

Yes: Tell us what works for you.

It’s good, but: Report typos, inaccuracies, and so forth.

It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-12-19