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 OLE Classes──────────────────────────────────────────
 
  Description
 
  COleServerDoc is the Microsoft Foundation Class Library base class for
  Object Linking and Embedding (OLE) server documents. In a Single
  Document Interface (SDI) Windows application, a server document normally
  contains a single embedded or linked item. Multiple instances of the
  application can support multiple clients or multiple items per client.
 
  Note: Windows 3.1 OLE documentation refers to client items as "objects."
  This reference uses the term "item" to differentiate the OLE entity from
  the corresponding C++ class object.
 
  #include <afxole.h>
 
  See Also
 
      ◄COleServer►, ◄COleServerItem►
 
  Public Members
 
  Data Members
 
  ◄m_hPalette►   The client document color-scheme identifier.
 
  Construction/Destruction
 
  ◄COleServerDoc►   Constructs a COleServerDoc object.
 
  ◄~COleServerDoc►   Destroys the object.
 
  Registration/Revocation
 
  ◄Register►   Registers the document and informs OLESVR.DLL that it is
               ready for communication.
 
  ◄Revoke►     Revokes the server document registration and waits to
               finish.
 
  Status
 
  ◄IsOpen►   Indicates whether a server document is registered.
 
  Operations
 
  ◄NotifyRename►       To be called after the server document is renamed.
 
  ◄NotifyRevert►       To be called after the server document reverts to
                       its original state.
 
  ◄NotifySaved►        To be called after the server document is saved.
 
  ◄NotifyAllClients►   To be used as a general notification to all
                       clients.
 
  ◄NotifyClosed►       To be called to inform all clients that a document
                       has been closed.
 
  ◄NotifyChanged►      To be called to inform all clients of a document
                       change.
 
  Protected Members
 
  Overridables (callbacks)
 
  ◄OnGetDocument►        Returns a newly allocated OLE server item object
                         that represents the entire document
                         (implementation required).
 
  ◄OnGetItem►            Given an item name, returns a newly allocated OLE
                         server item object (implementation required).
 
  ◄GetNextItem►          Returns the next item in the iteration
                         (implementation required).
 
  ◄OnClose►              Called on a client's request to close the
                         document.
 
  ◄OnExecute►            Called on a client's request to execute DDE
                         Execute strings.
 
  ◄OnSetDocDimensions►   Called on a client's request to change the
                         document dimensions.
 
  ◄OnSetHostNames►       Called on a client's request to change the host
                         name of the document.
 
  ◄OnSetColorScheme►     Called on a client's request to change the color
                         scheme of the document.
 
 
                                     -♦-