CMapStringToString Class

Supports maps of CString objects keyed by CString objects.

class CMapStringToString : public CObject

The member functions of CMapStringToString are similar to the member functions of class CMapStringToOb. Because of this similarity, you can use the CMapStringToOb reference documentation for member function specifics. Wherever you see a CObject pointer as a return value or "output" function parameter, substitute a pointer to char. Wherever you see a CObject pointer as an "input" function parameter, substitute a pointer to char.

BOOL CMapStringToOb::Lookup(const char*<key>, CObject*&<rValue>) const;

for example, translates to

BOOL CMapStringToString::Lookup(LPCTSTR<key>, CString&<rValue>) const;

Name

Description

CMapStringToString::CPair

A nested structure containing a key value and the value of the associated string object.

Name

Description

CMapStringToOb::GetCount

Returns the number of elements in this map.

CMapStringToOb::GetHashTableSize

Determines the current number of elements in the hash table.

CMapStringToOb::GetNextAssoc

Gets the next element for iterating.

CMapStringToOb::GetSize

Returns the number of elements in this map.

CMapStringToOb::GetStartPosition

Returns the position of the first element.

CMapStringToOb::HashKey

Calculates the hash value of a specified key.

CMapStringToOb::InitHashTable

Initializes the hash table.

CMapStringToOb::IsEmpty

Tests for the empty-map condition (no elements).

CMapStringToOb::Lookup

Looks up a void pointer based on the void pointer key. The pointer value, not the entity it points to, is used for the key comparison.

CMapStringToOb::LookupKey

Returns a reference to the key associated with the specified key value.

CMapStringToString::PGetFirstAssoc

Gets a pointer to the first CString in the map.

CMapStringToString::PGetNextAssoc

Gets a pointer to the next CString for iterating.

CMapStringToString::PLookup

Returns a pointer to a CString whose value matches the specified value.

CMapStringToOb::RemoveAll

Removes all the elements from this map.

CMapStringToOb::RemoveKey

Removes an element specified by a key.

CMapStringToOb::SetAt

Inserts an element into the map; replaces an existing element if a matching key is found.

Name

Description

CMapStringToOb::operator [ ]

Inserts an element into the map — operator substitution for SetAt.

CMapStringToString incorporates the IMPLEMENT_SERIAL macro to support serialization and dumping of its elements. Each element is serialized in turn if a map is stored to an archive, either with the overloaded insertion (<<) operator or with the Serialize member function.

If you need a dump of individual CString-CString elements, you must set the depth of the dump context to 1 or greater.

When a CMapStringToString object is deleted, or when its elements are removed, the CString objects are removed as appropriate.

For more information on CMapStringToString, see the article Collections.

Header: afxcoll.h

Show: