Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄CObject►                                     ◄Up► ◄Contents► ◄Index► ◄Back►
──Microsoft Foundation Classes──────────────────────────────────────────────
 
  Description
 
  The CMapStringToPtr class supports maps of void pointers keyed by
  CString objects.
 
  The member functions of CMapStringToPtr 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 function parameter or
  return value, substitute a pointer to void.
 
  BOOL CMapStringToOb::Lookup( const char* <key>,
                               CObject*& <rValue> ) const;
 
  for example, translates to
 
  BOOL CMapStringToPtr::Lookup( const char* <key>, void*& <rValue> ) const;
 
  CMapStringToPtr incorporates the IMPLEMENT_DYNAMIC macro to support
  run-time type access and dumping to a CDumpContext object. If you need a
  dump of individual map elements, you must set the depth of the dump
  context to 1 or greater.
 
  String-to-pointer maps may not be serialized.
 
  When a CMapStringToPtr object is deleted, or when its elements are
  removed, the CString key objects and the words are removed.
 
  #include <afxcoll.h>
 
  Public Members
 
  Construction/Destruction
 
  ◄CMapStringToPtr►   Constructs a collection that maps CString objects to
                      void pointers.
 
  ◄~CMapStringToPtr►   Destroys a CMapStringToPtr object.
 
  Operations
 
  ◄Lookup►             Returns a void pointer, based on a CString value.
 
  ◄SetAt►              Inserts an element into the map; replaces an
                       existing element if a matching key is found.
 
  ◄operator []►        Inserts an element into the map──operator
                       substitution for SetAt.
 
  ◄RemoveKey►          Removes an element specified by a key.
 
  ◄RemoveAll►          Removes all the elements from this map.
 
  ◄GetStartPosition►   Returns the position of the first element.
 
  ◄GetNextAssoc►       Gets the next element for iterating.
 
  Status
 
  ◄GetCount►   Returns the number of elements in this map.
 
  ◄IsEmpty►    Tests for the empty-map condition (no elements).
 
 
                                     -♦-