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 CMapWordToOb class supports maps of CObject pointers keyed by 16-bit
  words.
 
  The member functions of CMapWordToOb 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 CString or a const pointer to char as a function
  parameter or return value, substitute WORD.
 
  BOOL CMapStringToOb::Lookup( const char* <key>,
                               CObject*& <rValue> ) const;
 
  for example, translates to
 
  BOOL CMapWordToOb::Lookup( WORD <key>, CObject*& <rValue> ) const;
 
  CMapWordToOb incorporates the IMPLEMENT_SERIAL macro to support
  serialization and dumping of its elements. If a map is stored to an
  archive, either with the overloaded insertion operator or with the
  Serialize member function, each element is, in turn, serialized.
 
  If you need a dump of individual WORD-CObject elements, you must set the
  depth of the dump context to 1 or greater.
 
  When a CMapWordToOb object is deleted, or when its elements are removed,
  the CObject objects are deleted as appropriate.
 
  #include <afxcoll.h>
 
  Public Members
 
  Construction/Destruction
 
  ◄CMapWordToOb►   Constructs a collection that maps words to CObject
                   pointers.
 
  ◄~CMapWordToOb►   Destroys a CMapWordToOb object.
 
  Operations
 
  ◄Lookup►             Returns a CObject pointer, using a word value as a
                       key.
 
  ◄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).
 
 
                                     -♦-