FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoDictionaryElement Class Reference

#include <DictionaryElement.h>

Inherits FdoDisposable.

Inherited by FdoXmlAttribute.

Inheritance diagram for FdoDictionaryElement:

[legend]
List of all members.

Detailed Description

FdoDictionaryElement is an element in a FdoDictionary. It consists of a name-value pair.

Definition at line 27 of file DictionaryElement.h.


Public Member Functions

virtual FDO_API_COMMON FdoBoolean CanSetName ()
 Indicates that this object does not allow its name to change. Not allowing name change allows more efficient random access to FdoDictionary.
virtual FDO_API_COMMON FdoStringGetName ()
 Gets the name of this element.
virtual FDO_API_COMMON FdoStringGetValue ()
 Gets the value of this dictionary element.
virtual FDO_API_COMMON void SetValue (FdoString *value)
 Sets the value of this dictionary element.

Static Public Member Functions

FDO_API_COMMON FdoDictionaryElementCreate (FdoString *name, FdoString *value)
 Constructs and initializes a a FdoDictionaryElement.

Protected Member Functions

FDO_API_COMMON FdoDictionaryElement (FdoString *name, FdoString *value)
 Constructs an instance of a FdoDictionaryElement using the specified arguments.
FDO_API_COMMON FdoDictionaryElement ()
 Constructs a default instance of a FdoDictionaryElement.
virtual FDO_API_COMMON ~FdoDictionaryElement ()

Friends

class FdoCommonInternal

Constructor & Destructor Documentation

FDO_API_COMMON FdoDictionaryElement::FdoDictionaryElement  )  [inline, protected]
 

Constructs a default instance of a FdoDictionaryElement.

Definition at line 86 of file DictionaryElement.h.

References FDO_API_COMMON.

FDO_API_COMMON FdoDictionaryElement::FdoDictionaryElement FdoString name,
FdoString value
[protected]
 

Constructs an instance of a FdoDictionaryElement using the specified arguments.

virtual FDO_API_COMMON FdoDictionaryElement::~FdoDictionaryElement  )  [inline, protected, virtual]
 

Definition at line 93 of file DictionaryElement.h.

References FDO_API_COMMON.


Member Function Documentation

virtual FDO_API_COMMON FdoBoolean FdoDictionaryElement::CanSetName  )  [inline, virtual]
 

Indicates that this object does not allow its name to change. Not allowing name change allows more efficient random access to FdoDictionary.

Returns:
Returns false

Definition at line 62 of file DictionaryElement.h.

References FDO_API_COMMON, and FdoBoolean.

FDO_API_COMMON FdoDictionaryElement* FdoDictionaryElement::Create FdoString name,
FdoString value
[static]
 

Constructs and initializes a a FdoDictionaryElement.

Parameters:
name Input the name of the element (required)
value Input the value of the element. Can be blank (L"")
Returns:
Returns FdoDictionaryElement

virtual FDO_API_COMMON FdoString* FdoDictionaryElement::GetName  )  [virtual]
 

Gets the name of this element.

Returns:
Returns the element name

virtual FDO_API_COMMON FdoString* FdoDictionaryElement::GetValue  )  [virtual]
 

Gets the value of this dictionary element.

Returns:
Returns the element value

virtual FDO_API_COMMON void FdoDictionaryElement::SetValue FdoString value  )  [virtual]
 

Sets the value of this dictionary element.

Parameters:
value Input the element value

Friends And Related Function Documentation

friend class FdoCommonInternal [friend]
 

Reimplemented in FdoXmlAttribute.

Definition at line 29 of file DictionaryElement.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.