ShiAttributes.h File Reference

Attributes. More...

#include "ShiResults.h"
#include "ShiTypes.h"
#include "ShiInterfaces.h"

Go to the source code of this file.

Data Structures
struct	SHI_Resource
	Typed resource. More...
union	SHI_AttributeValue
	Attribute value. More...

Macros
#define	SHI_ATTRIBUTE_FLAG_VALUE_IS_CRITICAL   1
	This flag indicates that the attribute value is a critical value. More...
#define	SHI_ATTRIBUTE_FLAG_VALUE_IS_HUMAN_READABLE   2
	This flag indicates that the attribute value is a human-readable value that is suitable to display in a user interface. More...

Typedefs
typedef struct SHI_Attribute	SHI_Attribute
	SHI_Attribute objects represent named values that can be arranged in a tree structure. More...

Enumerations
enum	SHI_AttributeType {   SHI_ATTRIBUTE_TYPE_UNKNOWN,   SHI_ATTRIBUTE_TYPE_INTEGER,   SHI_ATTRIBUTE_TYPE_FLOAT,   SHI_ATTRIBUTE_TYPE_STRING,   SHI_ATTRIBUTE_TYPE_DATE,   SHI_ATTRIBUTE_TYPE_RESOURCE,   SHI_ATTRIBUTE_TYPE_LIST,   SHI_ATTRIBUTE_TYPE_BYTE_ARRAY }
	Attribute type. More...

Functions
SHI_PUBLIC_API SHI_Result	SHI_Attribute_Release (SHI_Attribute *self)
	Releases this attribute object. More...
SHI_PUBLIC_API const char *	SHI_Attribute_GetName (SHI_Attribute *self)
	Returns the name of this attribute. More...
SHI_PUBLIC_API SHI_AttributeType	SHI_Attribute_GetType (SHI_Attribute *self)
	Returns the type of this attribute. More...
SHI_PUBLIC_API SHI_Flags	SHI_Attribute_GetFlags (SHI_Attribute *self)
	Returns the flags of this attribute. More...
SHI_PUBLIC_API SHI_Result	SHI_Attribute_GetValue (SHI_Attribute *self, SHI_AttributeValue *value)
	Gets the value of this attribute. More...
SHI_PUBLIC_API SHI_Cardinal	SHI_Attribute_GetChildCount (SHI_Attribute *self)
	Returns the number of children of this attribute. More...
SHI_PUBLIC_API SHI_Result	SHI_Attribute_GetChildByName (SHI_Attribute *self, const char *name, SHI_Attribute **child)
	Gets a child of this attribute by name. More...
SHI_PUBLIC_API SHI_Result	SHI_Attribute_GetChildByIndex (SHI_Attribute *self, SHI_Ordinal indx, SHI_Attribute **child)
	Gets a child of this attribute by index. More...

Detailed Description

Attributes.

Macro Definition Documentation

SHI_ATTRIBUTE_FLAG_VALUE_IS_CRITICAL

#define SHI_ATTRIBUTE_FLAG_VALUE_IS_CRITICAL   1

This flag indicates that the attribute value is a critical value.

Attributes with this flag are the ones that an application must understand before accepting the consequences of what is described by the attribute. For example, attributes found in the details obtained by SHI_ActionResult_GetDetails() may contain critical attributes.

SHI_ATTRIBUTE_FLAG_VALUE_IS_HUMAN_READABLE

#define SHI_ATTRIBUTE_FLAG_VALUE_IS_HUMAN_READABLE   2

This flag indicates that the attribute value is a human-readable value that is suitable to display in a user interface.

Enumeration Type Documentation

SHI_AttributeType

enum SHI_AttributeType

Attribute type.

Enumerator
SHI_ATTRIBUTE_TYPE_UNKNOWN	The attribute value type is unknown.
SHI_ATTRIBUTE_TYPE_INTEGER	The attribute value is a SHI_Int32.
SHI_ATTRIBUTE_TYPE_FLOAT	The attribute value is a SHI_Float.
SHI_ATTRIBUTE_TYPE_STRING	The attribute value is a const char*.
SHI_ATTRIBUTE_TYPE_DATE	The attribute value is a SHI_DateTime.
SHI_ATTRIBUTE_TYPE_RESOURCE	The attribute value is a SHI_Resource.
SHI_ATTRIBUTE_TYPE_LIST	The attribute contains a list of attributes.
SHI_ATTRIBUTE_TYPE_BYTE_ARRAY	The attribute value is a SHI_ByteArray.