PWB Extensions Help (ext.hlp) (Table of Contents; Topic list)
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.
GetEditorObject
                                             Up Contents Index Back
─────PWB Extensions─────────────────────────────────────────────────────────
 
  Syntax:  flagType GetEditorObject( unsigned info, unsigned qual,
                                     void far *pDest);
           flagType SetEditorObject( unsigned info, unsigned qual,
                                     void far *pSrc );
 
  Returns: True for successful copy of data, otherwise false.
 
  See:     Using Colors in Extensions Using Files Using Windows
 
     GetEditorObject gets information about files, windows, and other
     PWB data. SetEditorObject modifies the corresponding PWB objects.
 
     Argument    Description
 
     <info>      Constant specifying the kind of data to access.
 
     <qual>      Additional qualification of the request. For some
                 requests, <qual> is ignored and can be zero. For
                 others, <qual> is the index number or handle for the
                 object to access.
 
     <pDest>     Address of source or result variable.
 
     The <info> varies, based on the type of data required. There
     are three general cases:
 
     To get:                    Do this:
 
     General or current data    Use <info> constant and a <qual> of 0.
 
     Data by index number       Combine the index number with the <info>
                                constant using the bitwise OR operator
                                (|) and use a <qual> of 0.
 
     Data by handle             Combine the <info> constant with 0xff
                                using the bitwise OR operator (|) and
                                put the handle in <qual>.
 
     The <info> constants can be combined with <qual> and <pDest> to
     access different data. The information you access get falls into
     the following categories:
 
     Category          Description
 
     File History    Files on the list of files in the current window.
     All Files       Files on the global list of files open in PWB.
     Windows         Information about windows.
     Miscellaneous   The color table, the type of text on the clipboard,
                       the PFILE of TOOLS.INI, the name of PWB, the size
                       of the screen, and the current find and find-and-
                       replace data.
                                    -♦-