Library resapp_lib: Class AppAttributeData

All Classes, All Libraries

Index: A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z

AppAttributeData objects contain various data about attributes of built-in application objects. These are statically defined alongside ResidentApplication objects, and should never be freed.

#include <resapp/appattr.h>

• Class Data and Methods
  • Inherited Data and Methods
• Ancestors
• Descendants
• Descriptions of Class Data and Methods

Class Data and Methods

Back to the top of AppAttributeData

Ancestors

Back to the top of AppAttributeData

Descendants

Back to the top of AppAttributeData

Constructor for AppAttributeData class. This constructor automatically adds this attribute to the supplied ResidentApplication object.

Parameters:

in app

The ResidentApplication object this data is associated with.

in attr

The AppAttribute this object encapsulates.

in attrSize

The size of the data held by this object (in bytes).

in data

A pointer to the data itself.

Prototype:

    AppAttributeData(ResidentApplication *app,
                     AppAttribute attr,
                     uint16 attrSize,
                     const void *data);

Back to the top of AppAttributeData

AppAttribute GetAttrType(void) const;

Returns the AppAttribute associated with this object.

Return value: The AppAttribute whose data is referenced by this object.

See also: GetAttrData()

Prototype:

    AppAttribute GetAttrType(void) const;

Back to the top of AppAttributeData

uint16 GetAttrDataSize(void) const;

Returns the size of the data whose pointer is stored in this object.

Return value: The size of the data.

See also: GetAttrData()

Prototype:

    uint16 GetAttrDataSize(void) const;

Back to the top of AppAttributeData

const void *GetAttrData(void) const;

Returns a pointer to the data associated with this object.

Return value: A pointer to the data associated with this object.

See also: GetAttrDataSize()

Prototype:

    const void *GetAttrData(void) const;

Back to the top of AppAttributeData