The Developer Connection…ice Driver Kit for OS/2 3/DEV3-D1.ISO/docs/pmfun.inf

OS/2 Help File | 1994-02-27 | 611.0 KB | 25,568 lines

ΓòÉΓòÉΓòÉ 1. IBM Trademarks ΓòÉΓòÉΓòÉ

The following are trademarks of the IBM Corporation.

CUA
Common User Access
IBM
IBM C/2
Operating System/2
OS/2
Presentation Manager
SAA
Systems Application Architecture
Workplace Shell


ΓòÉΓòÉΓòÉ 2. Non-IBM Trademarks ΓòÉΓòÉΓòÉ

Adobe is a trademark of Adobe Systems Incorporated.
Helvetica is a trademark of Linotype.
Intel is a trademark of the Intel Corporation.
Microsoft and Windows are trademarks of the Microsoft Corporation.
Postscript is a trademark of Adobe Systems Incorporated.
Times New Roman is a trademark of Monotype.
80386 is a trademark of the Intel Corporation.
80386SX is a trademark of the Intel Corporation.
80387 is a trademark of the Intel Corporation.
80387 NPX is a trademark of the Intel Corporation.


ΓòÉΓòÉΓòÉ 3. How to Use the PM Reference ΓòÉΓòÉΓòÉ

The OS/2* Presentation Manager Reference is a detailed technical reference for
application programmers.  It gives reference information and code examples to
enable you to write source code using Presentation Manager* (PM) functions.

Before you begin to use this information, it would be helpful to understand how
you can:

o Expand the Contents to see all available topics
o Obtain additional information for a highlighted word or phrase
o Use action bar choices
o Use the programming information.

How to Use the Contents

When the Contents window first appears, some topics have a plus (+) sign beside
them. The plus sign indicates that additional topics are available.

To expand the Contents if you are using a mouse, click on the plus sign. If you
are using the keyboard, use the Up or Down Arrow key to highlight the topic,
and press the plus (+) key. For example, Code Pages has a plus sign beside it.
To see additional topics for that heading, click on the plus sign or highlight
that topic and press the plus (+) key.

To view a topic, double-click on the topic (or press the Up or Down Arrow key
to highlight the topic, and then press the Enter key).

How to Obtain Additional Information

After you select a topic, the information for that topic appears in a window.
Highlighted words or phrases indicate that additional information is available.
You will notice that certain words and phrases are highlighted in green
letters, or in white letters on a black background. These are called hypertext
terms. If you are using a mouse, double-click on the highlighted word.  If you
are using a keyboard, press the Tab key to move to the highlighted word, and
then press the Enter key. Additional information then appears in a window.

How to Use Action Bar Choices

Several choices are available for managing information presented in the OS/2*
Presentation Manager Reference.  There are three pull-down menus on the action
bar:  the Services menu, the Options menu, and the Help menu.

The actions that are selectable from the Services menu operate on the active
window currently displayed on the screen. These actions include the following:

Bookmark
   Allows you to set a placeholder so you can retrieve information of interest
   to you.

   When you place a bookmark on a topic, it is added to a list of bookmarks you
   have previously set.  You can view the list, and you can remove one or all
   bookmarks from the list. If you have not set any bookmarks, the list is
   empty.

   To set a bookmark, do the following:

    1. Select a topic from the Contents.

    2. When that topic appears, choose the Bookmark option from the Services
       pull-down.

    3. If you want to change the name used for the bookmark, type the new name
       in the field.

    4. Click on the Place radio button (or press the Up or Down Arrow key to
       select it).

    5. Click on OK (or select it and press Enter). The bookmark is then added
       to the bookmark list.

Search
   Allows you to find occurrences of a word or phrase in the current topic,
   selected topics, or all topics.

   You can specify a word or phrase to be searched. You can also limit the
   search to a set of topics by first marking the topics in the Contents list.

   To search for a word or phrase in all topics, do the following:

    1. Choose the Search option from the Services pull-down.

    2. Type the word or words to be searched for.

    3. Click on All sections (or press the Up or Down Arrow keys to select it).

    4. Click on Search (or select it and press Enter) to begin the search.

    5. The list of topics where the word or phrase appears is displayed.

Print
   Allows you to print one or more topics.  You can also print a set of topics
   by first marking the topics in the Contents list.

   To print the document Contents list, do the following:

    1. Choose Print from the Services pull-down.

    2. Click on Contents (or press the Up or Down Arrow key to select it).

    3. Click on Print (or select it and press Enter).

    4. The Contents list is printed on your printer.

Copy
   Allows you to copy a topic that you are viewing to the System Clipboard or
   to a file that you can edit. You will find this particularly useful for
   copying syntax definitions and program samples into the application that you
   are developing.

   You can copy a topic that you are viewing in two ways:

   o Copy copies the topic that you are viewing into the System Clipboard.  If
     you are using a Presentation Manager* (PM) editor (for example, the System
     Editor) that copies or cuts (or both) to the System Clipboard, and pastes
     to the System Clipboard, you can easily add the copied information to your
     program source module.

   o Copy to file copies the topic that you are viewing into a temporary file
     named TEXT.TMP. You can later edit that file by using any editor.  You
     will find TEXT.TMP in the directory where your viewable document resides.

     To copy a topic, do the following:

       1. Expand the Contents list and select a topic.

       2. When the topic appears, choose Copy to file from the Services
          pull-down.

       3. The system puts the text pertaining to that topic into the temporary
          file named TEXT.TMP.

   For information on one of the other choices in the Services pull-down,
   highlight the choice and press the F1 key.

The actions that are selectable from the Options menu allow you to change the
way your Contents list is displayed. To expand the Contents and show all levels
for all topics, choose Expand all from the Options pull-down. You can also
press the Ctrl and * keys together. For information on one of the other choices
in the Options pull-down, highlight the choice and press the F1 key.

The actions that are selectable from the Help menu allow you to select
different types of help information. You can also press the F1 key for help
information about the Information Presentation Facility (IPF).

How to Use the Programming Information

The Presentation Manager Reference consists of reference information that
provides a detailed description of each function, message, constant, and data
type. It provides language-dependent information about the functions which
enable the user to generate call statements in the C Language.

Presentation Manager* programming information is presented by component, such
as Device Functions, Direct Manipulation Functions, and Font-File format, for
example:

     ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
     Γöé            Contents                     Γöé
     Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
     Γöé                                         Γöé
     Γöé  + Device Functions                     Γöé
     Γöé  + Direct Manipulation Functions        Γöé
     Γöé  + Font-File Format                     Γöé
     Γöé                                         Γöé
     ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ

By clicking on the plus sign beside "Device Functions", you see an alphabetic
list of the Presentation Manager Device functions. Selecting a function takes
you directly into the reference information for that function.

Units of reference information are presented in selectable multiple windows or
viewports. A viewport is a Presentation Manager* window that can be sized,
moved, minimized, maximized, or closed.  By selecting a unit (in this case, an
entry on the Contents list), you will see two windows displayed:

   ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
   Γöé Unit Title         Γöé      Selection Title     Γöé
   Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
   Γöé Select an item     Γöé                          Γöé
   Γöé                    Γöé                          Γöé
   Γöé Function Syntax    Γöé                          Γöé
   Γöé Parameters         Γöé                          Γöé
   Γöé Return Values      Γöé                          Γöé
   Γöé Notes              Γöé                          Γöé
   Γöé Example            Γöé                          Γöé
   Γöé Related Functions  Γöé                          Γöé
   Γöé Glossary           Γöé                          Γöé
   Γöé                    Γöé                          Γöé
   ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ

The window on the left is the primary window.  It contains a list of items that
are always available to you.  The window on the right is the secondary window.
It contains a "snapshot" of the unit information. For reference units (that is,
function descriptions), this window contains the Function Syntax.

All of the information needed to understand a reference unit (or topic) is
readily available to you through the primary window. The information is divided
into discrete information groups, and only the appropriate information group
appears for the topic that you are viewing.

The information groups for a reference unit (that is, a function description)
can include all or some of the following:

o Function Syntax
o Parameters
o Return Values
o Errors
o Notes
o Example
o Related Functions
o Graphic Elements and Orders
o Glossary

This list may vary. Some topics may be omitted when they do not apply.

Information groups are displayed in separate viewports that are stacked in a
third window location that overlaps the secondary window. By selecting an item
(information group) in the primary window, the item is displayed in the third
window location, as follows:

 ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
 Γöé Unit Title     Γöé   Selection Γöé   Glossary       Γöé
 Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
 Γöé Select an item Γöé             Γöé Select a startingΓöé
 Γöé                Γöé             Γöé letter of        Γöé
 Γöé    .           Γöé             Γöé glossary terms   Γöé
 Γöé    .           Γöé             Γöé                  Γöé
 Γöé    .           Γöé             Γöé A    N           Γöé
 Γöé    .           Γöé             Γöé B    O           Γöé
 Γöé    .           Γöé             Γöé C    P           Γöé
 Γöé Glossary       Γöé             Γöé .    .           Γöé
 Γöé                Γöé             Γöé .    .           Γöé
 Γöé                Γöé             Γöé .    .           Γöé
 Γöé                Γöé             Γöé M    Z           Γöé
 ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ

By selecting successive items from the primary window, additional windows are
displayed on top of the previous windows displayed in the third window
location.  For example, in a function description, Parameters and Return Values
are items listed in the primary window.  When selected, they appear one on top
of the other in the third window location. Because of this, you may move the
first selected (topmost) window to the left before selecting the next item.
This allows simultaneous display of two related pieces of information from the
"stack" of windows in the third window location, as follows:

 ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
 Γöé Unit Title     Γöé  Parameters  Γöé  Return Values  Γöé
 Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
 Γöé Select an item Γöé              Γöé                 Γöé
 Γöé    .           Γöé              Γöé                 Γöé
 Γöé    .           Γöé              Γöé                 Γöé
 Γöé    .           Γöé              Γöé                 Γöé
 Γöé Parameters     Γöé              Γöé                 Γöé
 Γöé Return Values  Γöé              Γöé                 Γöé
 Γöé    .           Γöé              Γöé                 Γöé
 Γöé    .           Γöé              Γöé                 Γöé
 Γöé    .           Γöé              Γöé                 Γöé
 Γöé                Γöé              Γöé                 Γöé
 ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ

Each window can be individually closed from its system menu. All windows are
closed when you close the primary window.

Some secondary windows may have the appearance of a split screen. For example,
an illustration may appear in the left half of the window, and scrollable,
explanatory information may appear in the right half of the window. Because
illustrations may not necessarily fit into the small window size on your
screen, you may maximize the secondary window for better readability.


ΓòÉΓòÉΓòÉ 3.1. Notices ΓòÉΓòÉΓòÉ

References in this publication to IBM* products, programs, or services do not
imply that IBM intends to make these available in all countries in which IBM
operates. Any reference to an IBM product, program, or service is not intended
to state or imply that only IBM's product, program, or service may be used. Any
functionally equivalent product, program, or service that does not infringe any
of IBM's intellectual property rights or other legally protectible rights may
be used instead of the IBM product, program, or service. Evaluation and
verification of operation in conjunction with other products, programs, or
services, except those expressly designated by IBM, are the user's
responsibility.


ΓòÉΓòÉΓòÉ 3.2. Trademarks ΓòÉΓòÉΓòÉ

The following terms, denoted by an asterisk (*) in this publication, are
trademarks of the IBM* Corporation in the United States or other countries or
both:

Common User Access
CUA
IBM
Operating System/2
OS/2
Presentation Manager
SAA
Systems Application Architecture

The following terms, denoted by a double asterisk (**) in this publication, are
trademarks of another company as follows:

Adobe is a trademark of Adobe Systems Incorporated.
Helvetica is a trademark of Linotype.
Intel is a trademark of the Intel Corporation.
Microsoft and Windows are trademarks of the Microsoft Corporation.
Postscript is a trademark of Adobe Systems Incorporated.
Times New Roman is a trademark of Monotype.
80386 is a trademark of the Intel Corporation.
80386SX is a trademark of the Intel Corporation.
80387 is a trademark of the Intel Corporation.
80387 NPX is a trademark of the Intel Corporation.


ΓòÉΓòÉΓòÉ 3.3. Copyright ΓòÉΓòÉΓòÉ

Copyright International Business Machines Corporation 1986, 1991. All rights
reserved.

Note to U.S. Government Users - Documentation related to restricted rights -
Use, duplication, or disclosure is subject to restrictions set forth in GSA ADP
Schedule Contract with IBM* Corp.


ΓòÉΓòÉΓòÉ 3.4. Conventions Used in this Reference ΓòÉΓòÉΓòÉ

The purpose of this reference is to give important information about functions,
messages, constants, and data types. It provides language-dependent information
about the functions which enables the user to generate call statements in C
Language.

The following information is provided:

o The parameter list for each function.
o The syntax of each data type and structure

Notation Conventions

The following notation conventions are used in this reference:

NULL
   The term NULL applied to a parameter is used to indicate the presence of the
   pointer parameter, but with no value.

NULLHANDLE
   The term NULLHANDLE applied to a parameter is used to indicate the presence
   of the handle parameter, but with no value.

Implicit Pointer
   If no entry for a data type "Pxxxxxxx" is found in Data Types, then it is
   implicitly a pointer to the data type "xxxxxxx". See Implicit Pointer Data
   Types.

Constant Names
   All constants are written in uppercase.  Where applicable, constant names
   have a prefix derived from the name of a function, message, or idea
   associated with the constant.  For example:

   WM_CREATE        Window message
   SV_CXICON        System value
   CF_TEXT          Clipboard format.

   In this reference, a set of constants with the same prefix is written as in
   these examples:

   Window message   WM_*
   System value     SV_*


ΓòÉΓòÉΓòÉ 3.4.1. Conventions used in Function Descriptions ΓòÉΓòÉΓòÉ

The documentation of each function contains these sections:

Function name
   The function name, listed in alphabetic order of C (long) name together with
   the English name.  This is at the top of each page followed by the name of
   the define that calls the correct header files to be included, the function
   prototype, and a brief description of the function.

Parameters
   Each parameter is listed with its data type and a brief description.

   There are four kinds of parameters:

   Input            Specified by the programmer.

   Output           Returned by the Presentation Manager* (PM) interface.

   Input/Output     Specified by the programmer and modified by PM.

   Return           The return values are shown, together with possible errors,
                    or TRUE/FALSE indicators if a Boolean function.

                    A list of possible errors (where appropriate) is included
                    in this section.  Some functions do not have error
                    messages.

   Note:  Data types are given in C.

Remarks
   Additional information about the function, where required.

Related Functions
   Functions that can be used with the described function.

Example Code
   Example of how the function can be used.

Note:  The functions in this book are named in mixed-case for readability, but
       are known to the system as uppercase character strings.  For example,
       the function "GpiBeginArea" is actually the external name
       "GPIBEGINAREA".

If you are using a compiler that generates a mixed-case external name, you
should code the OS/2 functions in uppercase.

Message Queues

For some functions, the Remarks section of the function description includes a
statement that the function requires a message queue.  This means that, before
issuing the call, WinCreateMsgQueue must be issued by the same thread.  For
other functions, no previous WinCreateMsgQueue is required, and it is only
necessary to issue WinInitialize from the same thread.


ΓòÉΓòÉΓòÉ 3.5. Error Severities ΓòÉΓòÉΓòÉ

Each of the error conditions given in the list of errors for each call falls
into one of these areas:

Warning
   The function detected a problem, but took some remedial action that enabled
   the function to complete successfully. The return code in this case
   indicates that the function completed successfully.

Error
   The function detected a problem for which it could not take any sensible
   remedial action. The system has recovered from the problem, and the state of
   the system with respect to the application remains the same as at the time
   when the function was requested. The system has not even partially executed
   the function (other than reporting the error).

Severe Error
   The function detected a problem from which the system could not reestablish
   its state, with respect to the application, at the time when that function
   was requested; that is, the system partially executed the function. This,
   therefore, necessitates the application performing some corrective activity
   to restore the system to some known state.

Unrecoverable Error
   The function detected some problem from which the system could not
   re-establish its state, with respect to the application, at the time when
   that call was issued. It is possible that the application cannot perform
   some corrective action to restore the system to some known state.

The WinGetLastError and WinGetErrorInfo functions can be used to find out more
about an error (or warning) that occurs as a result of executing a call.


ΓòÉΓòÉΓòÉ 3.6. Header Files ΓòÉΓòÉΓòÉ

All functions require an "include" for the system header file OS2.H:

#include  <OS2.H>

Also, most functions require a "define" to select an appropriate (conditional)
section of the header file, and hence, the required entry point. Where this is
necessary, it is shown at the head of the function definition in the form:

#define   INCL_name

Note:  These "#defines" must precede the "#include <OS2.H>".


ΓòÉΓòÉΓòÉ 3.7. Helper Macros ΓòÉΓòÉΓòÉ

A series of macros is defined for packing data into, and extracting data from,
variables of MPARAM and MRESULT data types. They are used in conjunction with
the WinSendMsg and the other message functions, and also inside window and
dialog procedures.

These macros always cast their arguments to the specified type, so values of
any of the types specified for each macro may be passed without additional
casting.  NULL may be used to pass unused parameter data.

Macros for packing data into a MPARAM variable:


/* Used to pass any pointer type: */
#define MPFROMP(p)            ((MPARAM)(VOID *)(p))

/* Used to pass a window handle: */
#define MPFROMHWND(hwnd)      ((MPARAM)(HWND)(hwnd))

/* Used to pass a CHAR, UCHAR, or BYTE: */
#define MPFROMCHAR(ch)        ((MPARAM)(USHORT)(ch))

/* Used to pass a SHORT, USHORT, or BOOL: */
#define MPFROMSHORT(s)        ((MPARAM)(USHORT)(s))

/* Used to pass two SHORTs or USHORTs: */
#define MPFROM2SHORT(s1, s2)  ((MPARAM)MAKELONG(s1, s2))

/* Used to pass a SHORT and 2 UCHARs: (WM_CHAR msg)*/
#define MPFROMSH2CH(s, uch1, uch2)
 ((MPARAM)MAKELONG(s, MAKESHORT(uch1, uch2)))

/* Used to pass a LONG or ULONG: */
#define MPFROMLONG(l)         ((MPARAM)(ULONG)(l))

Macros for extracting data from a MPARAM variable:


/* Used to get any pointer type: */
#define PVOIDFROMMP(mp)     ((VOID *)(mp))

/* Used to get a window handle: */
#define HWNDFROMMP(mp)      ((HWND)(mp))

/* Used to get CHAR, UCHAR, or BYTE: */
#define CHAR1FROMMP(mp)     ((UCHAR)(mp))
#define CHAR2FROMMP(mp)     ((UCHAR)((ULONG)mp >> 8))
#define CHAR3FROMMP(mp)     ((UCHAR)((ULONG)mp >> 16))
#define CHAR4FROMMP(mp)     ((UCHAR)((ULONG)mp >> 24))

/* Used to get a SHORT, USHORT, or BOOL: */
#define SHORT1FROMMP(mp)    ((USHORT)(ULONG)(mp))
#define SHORT2FROMMP(mp)    ((USHORT)((ULONG)mp >> 16))

/* Used to get a LONG or ULONG: */
#define LONGFROMMP(mp)      ((ULONG)(mp))

Macros for packing data into a MRESULT variable:


/* Used to pass any pointer type: */
#define MRFROMP(p)            ((MRESULT)(VOID *)(p))

/* Used to pass a SHORT, USHORT, or BOOL: */
#define MRFROMSHORT(s)        ((MRESULT)(USHORT)(s))

/* Used to pass two SHORTs or USHORTs: */
#define MRFROM2SHORT(s1, s2)  ((MRESULT)MAKELONG(s1, s2))

/* Used to pass a LONG or ULONG: */
#define MRFROMLONG(l)         ((MRESULT)(ULONG)(l))

Macros for extracting data from a MRESULT variable:


/* Used to get any pointer type: */
#define PVOIDFROMMR(mr)     ((VOID *)(mr))

/* Used to get a SHORT, USHORT, or BOOL: */
#define SHORT1FROMMR(mr)    ((USHORT)((ULONG)mr))
#define SHORT2FROMMR(mr)    ((USHORT)((ULONG)mr >> 16))

/* Used to get a LONG or ULONG: */
#define LONGFROMMR(mr)      ((ULONG)(mr))

The following macros are for use with DDESTRUCT and DDEINIT structures:


/* Used to return a PSZ pointing to the DDE item name: */
#define DDES_PSZITEMNAME(pddes) \
        (((PSZ)pddes) + ((PDDESTRUCT)pddes)->offszItemName)

/* Used to return a PBYTE pointing to the DDE data: */
#define DDES_PABDATA(pddes)       \
        (((PBYTE)pddes) + ((PDDESTRUCT)pddes)->offabData)

/* Used to convert a selector to a PDDESTRUCT: */
#define SELTOPDDES(sel)             ((PDDESTRUCT)MAKEP(sel, 0))

/* Used to PDDESTRUCT to a selector for freeing / reallocating: */
#define PDDESTOSEL(pddes)           (SELECTOROF(pddes))

/* Used to PDDEINIT to a selector for freeing: */
#define PDDEITOSEL(pddei)           (SELECTOROF(pddei))


ΓòÉΓòÉΓòÉ 3.8. Addressing Elements in Arrays ΓòÉΓòÉΓòÉ

Constants defining array elements are given values that are zero-based in C;
that is, the numbering of the array elements starts at zero, not one.

For example, in the DevQueryCaps function, the sixth element of the alArray
parameter is CAPS_HEIGHT, which is equated to 5.

Count parameters related to such arrays always mean the actual number of
elements available.  Therefore, again using the DevQueryCaps function as an
example, if all elements up to and including CAPS_HEIGHT are provided for,
lCount could be set to (CAPS_HEIGHT+1).

In functions for which the starting array element can be specified, this is
always zero-based, and so the C element number constants can be used directly.
For example, to start with the CAPS_HEIGHT element, the lStart parameter can be
set to CAPS_HEIGHT.


ΓòÉΓòÉΓòÉ 3.9. Implicit Pointer Data Types ΓòÉΓòÉΓòÉ

A data type name beginning with "P" (for example, PERRORCODE) is likely to be a
pointer to another data type (in this instance, ERRORCODE).

In the data type summary, Data Types, no explicit "typedefs" are shown for
pointers. Therefore, if no data type definition can be found in the summary for
a data type name "Pxxxxxx", it becomes a pointer to the data type "xxxxxx", for
which a definition should be found in the summary.

The implicit type definition needed for such a pointer "Pxxxxxx" is:

typedef xxxxxx *Pxxxxxx;

Such definitions are provided by means of the system header file OS2.H.


ΓòÉΓòÉΓòÉ 3.10. Storage Mapping of Data Types ΓòÉΓòÉΓòÉ

The storage mapping of the data types is dependent on the machine architecture.
To be portable, applications must access the data types using the definitions
supplied for that environment.


ΓòÉΓòÉΓòÉ 3.11. Double-Byte Character Set (DBCS) ΓòÉΓòÉΓòÉ

Throughout this publication, you will see references to specific values for
character strings.  The values are for single-byte character set (SBCS).  If
you use the double-byte character set (DBCS), note that one DBCS character
equals two SBCS characters.


ΓòÉΓòÉΓòÉ 4. Data Types ΓòÉΓòÉΓòÉ

This section describes data types in C language.


ΓòÉΓòÉΓòÉ 4.1. ACCEL ΓòÉΓòÉΓòÉ

ACCEL Accelerator structure.

typedef struct _ACCEL {
USHORT    fs;   /* Options  */
USHORT    key;  /* Key  */
USHORT    cmd;  /* Command code  */
 } ACCEL;


ΓòÉΓòÉΓòÉ <hidden> fs ΓòÉΓòÉΓòÉ

fs (USHORT)
   Options.


ΓòÉΓòÉΓòÉ <hidden> key ΓòÉΓòÉΓòÉ

key (USHORT)
   Key.


ΓòÉΓòÉΓòÉ <hidden> cmd ΓòÉΓòÉΓòÉ

cmd (USHORT)
   Command code.

   The value to be placed in the uscmd parameter of a WM_HELP, a WM_COMMAND, or
   a WM_SYSCOMMAND.


ΓòÉΓòÉΓòÉ 4.2. ACCELTABLE ΓòÉΓòÉΓòÉ

ACCELTABLE Accelerator-table structure.

typedef struct _ACCELTABLE {
USHORT    cAccel;     /* Number of accelerator entries  */
USHORT    codepage;   /* Code page for accelerator entries  */
ACCEL     aaccel[1];  /* Accelerator entries  */
 } ACCELTABLE;


ΓòÉΓòÉΓòÉ <hidden> cAccel ΓòÉΓòÉΓòÉ

cAccel (USHORT)
   Number of accelerator entries.


ΓòÉΓòÉΓòÉ <hidden> codepage ΓòÉΓòÉΓòÉ

codepage (USHORT)
   Code page for accelerator entries.


ΓòÉΓòÉΓòÉ <hidden> aaccel[1] ΓòÉΓòÉΓòÉ

aaccel[1] (ACCEL)
   Accelerator entries.


   The default accelerator table has the following 16 entries:

      Options                           Key           Command

      HELP                VIRTUALKEY    VK_F1         0
      SYSCOMMAND ALT      VIRTUALKEY    VK_F4         SC_CLOSE
      SYSCOMMAND ALT      VIRTUALKEY    VK_ENTER      SC_RESTORE
      SYSCOMMAND ALT      VIRTUALKEY    VK_NEWLINE    SC_RESTORE
      SYSCOMMAND ALT      VIRTUALKEY    VK_F5         SC_RESTORE
      SYSCOMMAND ALT      VIRTUALKEY    VK_F6         SC_NEXTFRAME
      SYSCOMMAND ALT      VIRTUALKEY    VK_F7         SC_MOVE
      SYSCOMMAND ALT      VIRTUALKEY    VK_F8         SC_SIZE
      SYSCOMMAND ALT      VIRTUALKEY    VK_F9         SC_MINIMIZE
      SYSCOMMAND ALT      VIRTUALKEY    VK_F10        SC_MAXIMIZE
      SYSCOMMAND          VIRTUALKEY    VK_F10        SC_APPMENU
      SYSCOMMAND LONEKEY  VIRTUALKEY    VK_ALT        SC_APPMENU
      SYSCOMMAND LONEKEY  VIRTUALKEY    VK_ALTGRAF    SC_APPMENU
      SYSCOMMAND ALT      VIRTUALKEY    VK_SPACE      SC_SYSMENU
      SYSCOMMAND SHIFT    VIRTUALKEY    VK_ESC        SC_SYSMENU
      SYSCOMMAND CONTROL  VIRTUALKEY    VK_ESC        SC_TASKMANAGER


ΓòÉΓòÉΓòÉ 4.3. APSZ ΓòÉΓòÉΓòÉ

APSZ Array of pointers to NULL-terminated strings.

typedef PSZ APSZ[1];


ΓòÉΓòÉΓòÉ 4.4. ARCPARAMS ΓòÉΓòÉΓòÉ

ARCPARAMS Arc-parameters structure.

typedef struct _ARCPARAMS {
LONG    lP;  /* P coefficient  */
LONG    lQ;  /* Q coefficient  */
LONG    lR;  /* R coefficient  */
LONG    lS;  /* S coefficient  */
 } ARCPARAMS;


ΓòÉΓòÉΓòÉ <hidden> lP ΓòÉΓòÉΓòÉ

lP (LONG)
   P coefficient.


ΓòÉΓòÉΓòÉ <hidden> lQ ΓòÉΓòÉΓòÉ

lQ (LONG)
   Q coefficient.


ΓòÉΓòÉΓòÉ <hidden> lR ΓòÉΓòÉΓòÉ

lR (LONG)
   R coefficient.


ΓòÉΓòÉΓòÉ <hidden> lS ΓòÉΓòÉΓòÉ

lS (LONG)
   S coefficient.


ΓòÉΓòÉΓòÉ 4.5. AREABUNDLE ΓòÉΓòÉΓòÉ

AREABUNDLE Area-attributes bundle structure.

typedef struct _AREABUNDLE {
LONG      lColor;         /* Area foreground color  */
LONG      lBackColor;     /* Area background color  */
USHORT    usMixMode;      /* Area foreground-mix mode  */
USHORT    usBackMixMode;  /* Area background-mix mode  */
USHORT    usSet;          /* Pattern set  */
USHORT    usSymbol;       /* Pattern symbol  */
POINTL    ptlRefPoint;    /* Pattern reference point  */
 } AREABUNDLE;


ΓòÉΓòÉΓòÉ <hidden> lColor ΓòÉΓòÉΓòÉ

lColor (LONG)
   Area foreground color.


ΓòÉΓòÉΓòÉ <hidden> lBackColor ΓòÉΓòÉΓòÉ

lBackColor (LONG)
   Area background color.


ΓòÉΓòÉΓòÉ <hidden> usMixMode ΓòÉΓòÉΓòÉ

usMixMode (USHORT)
   Area foreground-mix mode.


ΓòÉΓòÉΓòÉ <hidden> usBackMixMode ΓòÉΓòÉΓòÉ

usBackMixMode (USHORT)
   Area background-mix mode.


ΓòÉΓòÉΓòÉ <hidden> usSet ΓòÉΓòÉΓòÉ

usSet (USHORT)
   Pattern set.


ΓòÉΓòÉΓòÉ <hidden> usSymbol ΓòÉΓòÉΓòÉ

usSymbol (USHORT)
   Pattern symbol.


ΓòÉΓòÉΓòÉ <hidden> ptlRefPoint ΓòÉΓòÉΓòÉ

ptlRefPoint (POINTL)
   Pattern reference point.


ΓòÉΓòÉΓòÉ 4.6. ATOM ΓòÉΓòÉΓòÉ

ATOM Atom identity.

typedef ULONG ATOM;


ΓòÉΓòÉΓòÉ 4.7. BANDRECT ΓòÉΓòÉΓòÉ

BANDRECT Rectangle structure, used for the coordinates of an output band (see
DevEscape).

An empty rectangle is one for which xleft is greater than xright, or ybottom is
greater than ytop.

typedef struct _BANDRECT {
LONG    xleft;    /* X-coordinate of left edge of rectangle  */
LONG    ybottom;  /* Y-coordinate of bottom edge of rectangle  */
LONG    xright;   /* X-coordinate of right edge of rectangle  */
LONG    ytop;     /* Y-coordinate of top edge of rectangle  */
 } BANDRECT;


ΓòÉΓòÉΓòÉ <hidden> xleft ΓòÉΓòÉΓòÉ

xleft (LONG)
   X-coordinate of left edge of rectangle.


ΓòÉΓòÉΓòÉ <hidden> ybottom ΓòÉΓòÉΓòÉ

ybottom (LONG)
   Y-coordinate of bottom edge of rectangle.


ΓòÉΓòÉΓòÉ <hidden> xright ΓòÉΓòÉΓòÉ

xright (LONG)
   X-coordinate of right edge of rectangle.


ΓòÉΓòÉΓòÉ <hidden> ytop ΓòÉΓòÉΓòÉ

ytop (LONG)
   Y-coordinate of top edge of rectangle.


ΓòÉΓòÉΓòÉ 4.8. BITMAPARRAYFILEHEADER ΓòÉΓòÉΓòÉ

See Bit-Map File Format for the format and description of this structure.


ΓòÉΓòÉΓòÉ 4.9. BITMAPARRAYFILEHEADER2 ΓòÉΓòÉΓòÉ

See Bit-Map File Format for the format and description of this structure.


ΓòÉΓòÉΓòÉ 4.10. BITMAPFILEHEADER ΓòÉΓòÉΓòÉ

See Bit-Map File Format for the format and description of this structure.


ΓòÉΓòÉΓòÉ 4.11. BITMAPFILEHEADER2 ΓòÉΓòÉΓòÉ

See Bit-Map File Format for the format and description of this structure.


ΓòÉΓòÉΓòÉ 4.12. BITMAPINFO ΓòÉΓòÉΓòÉ

BITMAPINFO Bit-map information structure.

Each bit plane logically contains (cx * cy * cBitCount) bits, although the
actual length can be greater because of padding.

See also BITMAPINFO2, which is preferred.

typedef struct _BITMAPINFO {
ULONG     cbFix;         /* Length of fixed portion of structure  */
USHORT    cx;            /* Bit-map width in pels  */
USHORT    cy;            /* Bit-map height in pels  */
USHORT    cPlanes;       /* Number of bit planes  */
USHORT    cBitCount;     /* Number of bits per pel within a plane  */
RGB       argbColor[1];  /* Array of RGB values  */
 } BITMAPINFO;


ΓòÉΓòÉΓòÉ <hidden> cbFix ΓòÉΓòÉΓòÉ

cbFix (ULONG)
   Length of fixed portion of structure.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (USHORT)
   Bit-map width in pels.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (USHORT)
   Bit-map height in pels.


ΓòÉΓòÉΓòÉ <hidden> cPlanes ΓòÉΓòÉΓòÉ

cPlanes (USHORT)
   Number of bit planes.


ΓòÉΓòÉΓòÉ <hidden> cBitCount ΓòÉΓòÉΓòÉ

cBitCount (USHORT)
   Number of bits per pel within a plane.


ΓòÉΓòÉΓòÉ <hidden> argbColor[1] ΓòÉΓòÉΓòÉ

argbColor[1] (RGB)
   Array of RGB values.

   This is a packed array of 24-bit RGB values.  If there are N bits per pel (N
   = cPlanes* cBitCount), the array contains 2**N RGB values.  However, if N =
   24 the bit map does not need the color array because the standard-format bit
   map, with 24 bits per pel, is assumed to contain RGB values.


ΓòÉΓòÉΓòÉ 4.13. BITMAPINFO2 ΓòÉΓòÉΓòÉ

BITMAPINFO2 Bit-map information structure.

Each bit plane logically contains (cx * cy * cBitCount) bits, although the
actual length can be greater because of padding.

Note:  Many functions can accept either this structure or the BITMAPINFO
structure. Where possible, BITMAPINFO2 should be used.

The cbFix field is used to find the color table, if any, that goes with the
information in this structure. A color table is an array of color (RGB2)
values. If there are N bits per pel (N = cPlanes* cBitCount), the array
contains 2**N color values. However, if N = 24, the color table is not required
(because the standard-format bit map, with 24 bits per pel, is assumed to
contain RGB values), unless either cclrUsed or cclrImportant is non-zero.

typedef struct _BITMAPINFO2 {
ULONG     cbFix;            /* Length of fixed portion of structure  */
ULONG     cx;               /* Bit-map width in pels  */
ULONG     cy;               /* Bit-map height in pels  */
USHORT    cPlanes;          /* Number of bit planes  */
USHORT    cBitCount;        /* Number of bits per pel within a plane  */
ULONG     ulCompression;    /* Compression scheme used to store the bit map  */
ULONG     cbImage;          /* Length of bit-map storage data, in bytes  */
ULONG     cxResolution;     /* Horizontal component of the resolution of target device  */
ULONG     cyResolution;     /* Vertical component of the resolution of target device  */
ULONG     cclrUsed;         /* Number of color indexes used  */
ULONG     cclrImportant;    /* Minimum number of color indexes for satisfactory appearance of the bit map  */
USHORT    usUnits;          /* Units of measure  */
USHORT    usReserved;       /* Reserved  */
USHORT    usRecording;      /* Recording algorithm  */
USHORT    usRendering;      /* Halftoning algorithm  */
ULONG     cSize1;           /* Size value 1  */
ULONG     cSize2;           /* Size value 2  */
ULONG     ulColorEncoding;  /* Color encoding  */
ULONG     ulIdentifier;     /* Reserved for application use  */
RGB2      argbColor[1];     /* Array of RGB values  */
 } BITMAPINFO2;


ΓòÉΓòÉΓòÉ <hidden> cbFix ΓòÉΓòÉΓòÉ

cbFix (ULONG)
   Length of fixed portion of structure.


   The structure can be truncated after cBitCount or any subsequent field.
   The length does not include the length of the color table. Where the color
   table is present, it is at an offset of cbFix from the start of the
   BITMAPINFO2 structure.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (ULONG)
   Bit-map width in pels.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (ULONG)
   Bit-map height in pels.


ΓòÉΓòÉΓòÉ <hidden> cPlanes ΓòÉΓòÉΓòÉ

cPlanes (USHORT)
   Number of bit planes.


ΓòÉΓòÉΓòÉ <hidden> cBitCount ΓòÉΓòÉΓòÉ

cBitCount (USHORT)
   Number of bits per pel within a plane.


ΓòÉΓòÉΓòÉ <hidden> ulCompression ΓòÉΓòÉΓòÉ

ulCompression (ULONG)
   Compression scheme used to store the bit map.

   BCA_UNCOMP
      Bit map is uncompressed.

   BCA_HUFFMAN1D
      The bit map is compressed by a modified Huffman encoding. This is valid
      for a bi-level (one bit per pel) bit map.

   BCA_RLE4
      The bit map is a 4-bit per pel run-length encoded bit map. See below for
      a description of the format of the compressed data.

   BCA_RLE8
      The bit map is a 8-bit per pel run-length encoded bit map. See below for
      a description of the format of the compressed data.

   BCA_RLE24
      The bit map is a 24-bit per pel run-length encoded bit map. See below for
      a description of the format of the compressed data.
      Format of Compressed Data
      Encoding a runlength:
      Run length encoded bit maps are encoded in the buffer in a controlled
      format. In all cases, if the first byte is non-zero, it is the length of
      a run of Pels of a particular color or, in the case of a BCA_RLE4 bit
      map, a run of a length of pels of alternating colors.

            1st-byte       pel repetition count >= 1
            2nd-4th bytes  (BCA_RLE24 only) RGB value of pel.
            2nd-byte       (BCA_RLE8) color index of pel to be repeated
                           (BCA_RLE4) the second byte contains 2 4-bit
                           color indices.  The repetition count is
                           completed by alternately choosing the high-order
                           nibble followed by the low-order nibble for the
                           succeeding Pels until the count is exhausted.


      Unencoded run:
      An unencoded run is a string of pels to be placed in consecutive
      positions in the destination bit map.

            1st-byte     0
            2nd-byte     COUNT = a multiple of 3 for BCA_RLE24 bit maps, or
                         COUNT >= 3 (for BCA_RLE4 and BCA_RLE8 bit maps).


      followed by the bytes as follows:

      BCA_RLE24
         A string of bytes specifying the RGB color values of succeeding pels.
         If COUNT is odd, it must be padded by a zero byte for an even length
         overall.

      BCA_RLE8
         A string of bytes specifying color indices for succeeding pels. If
         COUNT is odd it must be padded by a zero byte for an even length
         overall.

      BCA_RLE4
         A string of bytes, each byte providing two color indices, with the
         high order nibble specifying the index of the pel preceding the low
         order nibble.  The COUNT specifies the number of indices.  The overall
         length of the string must be an even number of bytes, and thus may be
         padded with a zero byte, and the low order nibble of the last
         significant byte may also be zero and not used.
      Delta record:
      A delta record indicates a shift in position in the destination bit map
      before the next record is decoded.

            1st-byte        0
            2nd-byte        2
            3rd-byte        Delta-x (unsigned)
            4th-byte        Delta-y (unsigned)

      This is a relative jump record.  It implies that the next record is to be
      decoded into a position in the destination bit map at an offset from the
      current position, determined by changing the horizontal and vertical
      positions by Delta-x and Delta-y, respectively.
      End-of-line record: The end-of-line record signifies that the data for
      the current scan line is complete and that decoding of the next record
      should begin at the start of the next scan line.

            1st-byte        0
            2nd-byte        0

      End-of-RLE record:
      The end-of-RLE record signifies the end of the data in the RLE compressed
      bit map.

            1st-byte        0
            2nd-byte        1


ΓòÉΓòÉΓòÉ <hidden> cbImage ΓòÉΓòÉΓòÉ

cbImage (ULONG)
   Length of bit-map storage data, in bytes.

   If the bit map is uncompressed, zero (default) can be specified for this.


ΓòÉΓòÉΓòÉ <hidden> cxResolution ΓòÉΓòÉΓòÉ

cxResolution (ULONG)
   Horizontal component of the resolution of target device.

   The resolution of the device the bit map is intended for, in the units
   specified by usUnits. This information enables an application to select from
   a resource group the bit map that best matches the characteristics of the
   current output device.


ΓòÉΓòÉΓòÉ <hidden> cyResolution ΓòÉΓòÉΓòÉ

cyResolution (ULONG)
   Vertical component of the resolution of target device.

   See the description of cxResolution.


ΓòÉΓòÉΓòÉ <hidden> cclrUsed ΓòÉΓòÉΓòÉ

cclrUsed (ULONG)
   Number of color indexes used.

   The number of color indexes from the color table that are used by the bit
   map. If it is zero (the default), all the indexes are used. If it is
   non-zero, only the first cclrUsed entries in the table are accessed by the
   system, and further entries can be omitted.
   For the standard formats with a cBitCount of 1, 4, or 8 (and cPlanes equal
   to 1), any indexes beyond cclrUsed are not valid. For example, a bit map
   with 64 colors can use the 8-bitcount format without having to supply the
   other 192 entries in the color table. For the 24-bitcount standard format,
   cclrUsed is the number of colors used by the bit map.


ΓòÉΓòÉΓòÉ <hidden> cclrImportant ΓòÉΓòÉΓòÉ

cclrImportant (ULONG)
   Minimum number of color indexes for satisfactory appearance of the bit map.

   More colors may be used in the bit map, but it is not necessary to assign
   them to the device palette. These additional colors may be mapped to the
   nearest colors available.
   Zero (the default) means that all entries are important.
   For a 24-bitcount standard format bit map, the cclrImportant colors are also
   listed in the color table following the BITMAPINFO2 structure.


ΓòÉΓòÉΓòÉ <hidden> usUnits ΓòÉΓòÉΓòÉ

usUnits (USHORT)
   Units of measure.

   Units of measure of the horizontal and vertical components of resolution,
   cxResolution and cyResolution.

   BRU_METRIC
      pels per meter. This is the default value.


ΓòÉΓòÉΓòÉ <hidden> usReserved ΓòÉΓòÉΓòÉ

usReserved (USHORT)
   Reserved.

   This is a reserved field.


ΓòÉΓòÉΓòÉ <hidden> usRecording ΓòÉΓòÉΓòÉ

usRecording (USHORT)
   Recording algorithm.

   The format in which the bit map data is recorded.

   BRA_BOTTOMUP
      Scan lines are recorded bottom-to-top. This is the default value.


ΓòÉΓòÉΓòÉ <hidden> usRendering ΓòÉΓòÉΓòÉ

usRendering (USHORT)
   Halftoning algorithm.

   The algorithm used to record bit map data that has been digitally halftoned.

   BRH_NOTHALFTONED
      Bit-map data is not halftoned. This is the default value.
   BRH_ERRORDIFFUSION
      Error Diffusion or Damped Error Diffusion algorithm.
   BRH_PANDA
      Processing Algorithm for Non-coded Document Acquisition.
   BRH_SUPERCIRCLE
      Super Circle algorithm.


ΓòÉΓòÉΓòÉ <hidden> cSize1 ΓòÉΓòÉΓòÉ

cSize1 (ULONG)
   Size value 1.

   If BRH_ERRORDIFFUSION is specified in usRendering, cSize1 is the error
   damping as a percentage in the range 0 through 100. A value of 100%
   indicates no damping, and a value of 0% indicates that any errors are not
   diffused.
   If BRH_PANDA or BRH_SUPERCIRCLE is specified, cSize1 is the x dimension of
   the pattern used, in pels.


ΓòÉΓòÉΓòÉ <hidden> cSize2 ΓòÉΓòÉΓòÉ

cSize2 (ULONG)
   Size value 2.

   If BRH_ERRORDIFFUSION is specified in usRendering, this parameter is
   ignored.
   If BRH_PANDA or BRH_SUPERCIRCLE is specified, cSize2 is the y dimension of
   the pattern used, in pels.


ΓòÉΓòÉΓòÉ <hidden> ulColorEncoding ΓòÉΓòÉΓòÉ

ulColorEncoding (ULONG)
   Color encoding.

   BCE_RGB
      Each element in the color array is an RGB2 datatype. This is the default
      value.


ΓòÉΓòÉΓòÉ <hidden> ulIdentifier ΓòÉΓòÉΓòÉ

ulIdentifier (ULONG)
   Reserved for application use.


ΓòÉΓòÉΓòÉ <hidden> argbColor[1] ΓòÉΓòÉΓòÉ

argbColor[1] (RGB2)
   Array of RGB values.

   This is a packed array of 24-bit RGB values.  If there are N bits per pel (N
   = the array contains 2**N RGB values.  However, if N = 24 the bit map does
   not need the color array because the standard-format bit map, with 24 bits
   per pel, is assumed to contain RGB values.


ΓòÉΓòÉΓòÉ 4.14. BITMAPINFOHEADER ΓòÉΓòÉΓòÉ

BITMAPINFOHEADER Bit-map information header structure.

Each bit plane logically contains (cx * cy * cBitCount) bits, although the
actual length can be greater because of padding.

See also BITMAPINFOHEADER2, which is preferred.

typedef struct _BITMAPINFOHEADER {
ULONG     cbFix;      /* Length of structure  */
USHORT    cx;         /* Bit-map width in pels  */
USHORT    cy;         /* Bit-map height in pels  */
USHORT    cPlanes;    /* Number of bit planes  */
USHORT    cBitCount;  /* Number of bits per pel within a plane  */
 } BITMAPINFOHEADER;


ΓòÉΓòÉΓòÉ <hidden> cbFix ΓòÉΓòÉΓòÉ

cbFix (ULONG)
   Length of structure.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (USHORT)
   Bit-map width in pels.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (USHORT)
   Bit-map height in pels.


ΓòÉΓòÉΓòÉ <hidden> cPlanes ΓòÉΓòÉΓòÉ

cPlanes (USHORT)
   Number of bit planes.


ΓòÉΓòÉΓòÉ <hidden> cBitCount ΓòÉΓòÉΓòÉ

cBitCount (USHORT)
   Number of bits per pel within a plane.


ΓòÉΓòÉΓòÉ 4.15. BITMAPINFOHEADER2 ΓòÉΓòÉΓòÉ

BITMAPINFOHEADER2 Bit-map information header structure.

Each bit plane logically contains (cx * cy * cBitCount) bits, although the
actual length can be greater because of padding.

Note:  Many functions can accept either this structure or the BITMAPINFOHEADER
structure. Where possible, use BITMAPINFOHEADER2.

typedef struct _BITMAPINFOHEADER2 {
ULONG     cbFix;            /* Length of structure  */
ULONG     cx;               /* Bit-map width in pels  */
ULONG     cy;               /* Bit-map height in pels  */
USHORT    cPlanes;          /* Number of bit planes  */
USHORT    cBitCount;        /* Number of bits per pel within a plane  */
ULONG     ulCompression;    /* Compression scheme used to store the bit map  */
ULONG     cbImage;          /* Length of bit-map storage data, in bytes  */
ULONG     cxResolution;     /* Horizontal component of the resolution of target device  */
ULONG     cyResolution;     /* Vertical component of the resolution of target device  */
ULONG     cclrUsed;         /* Number of color indexes used  */
ULONG     cclrImportant;    /* Minimum number of color indexes for satisfactory appearance of the bit map  */
USHORT    usUnits;          /* Units of measure  */
USHORT    usReserved;       /* Reserved  */
USHORT    usRecording;      /* Recording algorithm  */
USHORT    usRendering;      /* Halftoning algorithm  */
ULONG     cSize1;           /* Size value 1  */
ULONG     cSize2;           /* Size value 2  */
ULONG     ulColorEncoding;  /* Color encoding  */
ULONG     ulIdentifier;     /* Reserved for application use  */
 } BITMAPINFOHEADER2;


ΓòÉΓòÉΓòÉ <hidden> cbFix ΓòÉΓòÉΓòÉ

cbFix (ULONG)
   Length of structure.


   The structure can be truncated after cBitCount or any subsequent field.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (ULONG)
   Bit-map width in pels.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (ULONG)
   Bit-map height in pels.


ΓòÉΓòÉΓòÉ <hidden> cPlanes ΓòÉΓòÉΓòÉ

cPlanes (USHORT)
   Number of bit planes.


ΓòÉΓòÉΓòÉ <hidden> cBitCount ΓòÉΓòÉΓòÉ

cBitCount (USHORT)
   Number of bits per pel within a plane.


ΓòÉΓòÉΓòÉ <hidden> ulCompression ΓòÉΓòÉΓòÉ

ulCompression (ULONG)
   Compression scheme used to store the bit map.

   BCA_UNCOMP
      Bit map is uncompressed.

   BCA_HUFFMAN1D
      The bit map is compressed by a modified Huffman encoding. This is valid
      for a bi-level (one bit per pel) bit map.

   BCA_RLE4
      The bit map is a 4-bit per pel run-length encoded bit map. See below for
      a description of the format of the compressed data.

   BCA_RLE8
      The bit map is a 8-bit per pel run-length encoded bit map. See below for
      a description of the format of the compressed data.

   BCA_RLE24
      The bit map is a 24-bit per pel run-length encoded bit map. See below for
      a description of the format of the compressed data.
      Format of Compressed Data
      Encoding a runlength:
      Run length encoded bit maps are encoded in the buffer in a controlled
      format. In all cases, if the first byte is non-zero, it is the length of
      a run of Pels of a particular color or, in the case of a BCA_RLE4 bit
      map, a run of a length of pels of alternating colors.

            1st-byte       pel repetition count >= 1
            2nd-4th bytes  (BCA_RLE24 only) RGB value of pel.
            2nd-byte       (BCA_RLE8) color index of pel to be repeated
                           (BCA_RLE4) the second byte contains 2 4-bit
                           color indices.  The repetition count is
                           completed by alternately choosing the high-order
                           nibble followed by the low-order nibble for the
                           succeeding Pels until the count is exhausted.


      Unencoded run:
      An unencoded run is a string of pels to be placed in consecutive
      positions in the destination bit map.

            1st-byte     0
            2nd-byte     COUNT = a multiple of 3 for BCA_RLE24 bit maps, or
                         COUNT >= 3 (for BCA_RLE4 and BCA_RLE8 bit maps).


      followed by the bytes as follows:

      BCA_RLE24
         A string of bytes specifying the RGB color values of succeeding pels.
         If COUNT is odd, it must be padded by a zero byte for an even length
         overall.

      BCA_RLE8
         A string of bytes specifying color indices for succeeding pels. If
         COUNT is odd it must be padded by a zero byte for an even length
         overall.

      BCA_RLE4
         A string of bytes, each byte providing two color indices, with the
         high order nibble specifying the index of the pel preceding the low
         order nibble.  The COUNT specifies the number of indices.  The overall
         length of the string must be an even number of bytes, and thus may be
         padded with a zero byte, and the low order nibble of the last
         significant byte may also be zero and not used.
      Delta record:
      A delta record indicates a shift in position in the destination bit map
      before the next record is decoded.

            1st-byte        0
            2nd-byte        2
            3rd-byte        Delta-x (unsigned)
            4th-byte        Delta-y (unsigned)

      This is a relative jump record.  It implies that the next record is to be
      decoded into a position in the destination bit map at an offset from the
      current position, determined by changing the horizontal and vertical
      positions by Delta-x and Delta-y, respectively.
      End-of-line record: The end-of-line record signifies that the data for
      the current scan line is complete and that decoding of the next record
      should begin at the start of the next scan line.

            1st-byte        0
            2nd-byte        0

      End-of-RLE record:
      The end-of-RLE record signifies the end of the data in the RLE compressed
      bit map.

            1st-byte        0
            2nd-byte        1


ΓòÉΓòÉΓòÉ <hidden> cbImage ΓòÉΓòÉΓòÉ

cbImage (ULONG)
   Length of bit-map storage data, in bytes.

   If the bit map is uncompressed, zero (the default) can be specified for
   this.


ΓòÉΓòÉΓòÉ <hidden> cxResolution ΓòÉΓòÉΓòÉ

cxResolution (ULONG)
   Horizontal component of the resolution of target device.

   The resolution of the device the bit map is intended for, in the units
   specified by usUnits. This information enables applications to select from a
   resource group the bit map that best matches the characteristics of the
   current output device.


ΓòÉΓòÉΓòÉ <hidden> cyResolution ΓòÉΓòÉΓòÉ

cyResolution (ULONG)
   Vertical component of the resolution of target device.

   See the description of cxResolution.


ΓòÉΓòÉΓòÉ <hidden> cclrUsed ΓòÉΓòÉΓòÉ

cclrUsed (ULONG)
   Number of color indexes used.

   The number of color indexes from the color table that are used by the bit
   map. If this is zero (the default), all the indexes are used. If it is
   non-zero, only the first cclrUsed entries in the table are accessed by the
   system, and further entries can be omitted.
   For the standard formats with a cBitCount of 1, 4, or 8 (and cPlanes equal
   to 1), any indexes beyond cclrUsed are invalid. For example, a bit map with
   64 colors can use the 8-bitcount format without having to supply the other
   192 entries in the color table. For the 24-bitcount standard format,
   cclrUsed is the number of colors used by the bit map.


ΓòÉΓòÉΓòÉ <hidden> cclrImportant ΓòÉΓòÉΓòÉ

cclrImportant (ULONG)
   Minimum number of color indexes for satisfactory appearance of the bit map.

   More colors may be used in the bit map, but it is not necessary to assign
   them to the device palette. These additional colors may be mapped to the
   nearest colors available.
   Zero (the default) means that all entries are important.
   For a 24-bitcount standard format bit map, the cclrImportant colors are also
   listed in the color table relating to this bit map.


ΓòÉΓòÉΓòÉ <hidden> usUnits ΓòÉΓòÉΓòÉ

usUnits (USHORT)
   Units of measure.

   Units of measure of the horizontal and vertical resolution, cxResolution and
   cyResolution.

   BRU_METRIC
      pels per meter. This is the default value.


ΓòÉΓòÉΓòÉ <hidden> usReserved ΓòÉΓòÉΓòÉ

usReserved (USHORT)
   Reserved.

   This is a reserved field. If present, it must be zero.


ΓòÉΓòÉΓòÉ <hidden> usRecording ΓòÉΓòÉΓòÉ

usRecording (USHORT)
   Recording algorithm.

   The format in which the bit-map data is recorded.

   BRA_BOTTOMUP
      Scan lines are recorded bottom-to-top. This is the default value.


ΓòÉΓòÉΓòÉ <hidden> usRendering ΓòÉΓòÉΓòÉ

usRendering (USHORT)
   Halftoning algorithm.

   The algorithm used to record bit-map data that has been digitally halftoned.

   BRH_NOTHALFTONED
      Bit-map data is not halftoned. This is the default value.
   BRH_ERRORDIFFUSION
      Error Diffusion or Damped Error Diffusion algorithm.
   BRH_PANDA
      Processing Algorithm for Non-coded Document Acquisition.
   BRH_SUPERCIRCLE
      Super Circle algorithm.


ΓòÉΓòÉΓòÉ <hidden> cSize1 ΓòÉΓòÉΓòÉ

cSize1 (ULONG)
   Size value 1.

   If BRH_ERRORDIFFUSION is specified in usRendering, cSize1 is the error
   damping as a percentage in the range 0 through 100. A value of 100%
   indicates no damping, and a value of 0% indicates that any errors are not
   diffused.
   If BRH_PANDA or BRH_SUPERCIRCLE is specified, cSize1 is the x dimension of
   the pattern used, in pels.


ΓòÉΓòÉΓòÉ <hidden> cSize2 ΓòÉΓòÉΓòÉ

cSize2 (ULONG)
   Size value 2.

   If BRH_ERRORDIFFUSION is specified in usRendering, this parameter is
   ignored.
   If BRH_PANDA or BRH_SUPERCIRCLE is specified, cSize2 is the y dimension of
   the pattern used, in pels.


ΓòÉΓòÉΓòÉ <hidden> ulColorEncoding ΓòÉΓòÉΓòÉ

ulColorEncoding (ULONG)
   Color encoding.

   BCE_RGB
      Each element in the color array is an RGB2 datatype. This is the default
      value.


ΓòÉΓòÉΓòÉ <hidden> ulIdentifier ΓòÉΓòÉΓòÉ

ulIdentifier (ULONG)
   Reserved for application use.


ΓòÉΓòÉΓòÉ 4.16. BOOKTEXT ΓòÉΓòÉΓòÉ

BOOKTEXT Notebook data structure that contains text strings for notebook status
lines and tabs. This data structure is used with the BKM_QUERYSTATUSLINETEXT
and the BKM_QUERYTABTEXT messages only.

typedef struct _BOOKTEXT {
PSZ      pString;  /* Pointer to a string buffer  */
ULONG    textLen;  /* String length  */
 } BOOKTEXT;


ΓòÉΓòÉΓòÉ <hidden> pString ΓòÉΓòÉΓòÉ

pString (PSZ)
   Pointer to a string buffer

   Buffer in which the text string is to be placed. For the
   BKM_QUERYSTATUSLINETEXT message, this is the buffer in which the status line
   text is placed.
   For the BKM_QUERYTABTEXT message, this is the buffer in which the tab text
   is placed.


ΓòÉΓòÉΓòÉ <hidden> textLen ΓòÉΓòÉΓòÉ

textLen (ULONG)
   String length.

   Length of the text string. For the BKM_QUERYSTATUSLINETEXT message, this is
   the length of the status line text string.
   For the BKM_QUERYTABTEXT message, this is the length of the tab text string.


ΓòÉΓòÉΓòÉ 4.17. BOOL ΓòÉΓòÉΓòÉ

BOOL Boolean.

Valid values are FALSE, which is 0, and TRUE, which is 1.

typedef unsigned long BOOL;


ΓòÉΓòÉΓòÉ 4.18. BTNCDATA ΓòÉΓòÉΓòÉ

BTNCDATA Button-control-data structure.

typedef struct _BTNCDATA {
USHORT     cb;             /* Length of the control data in bytes  */
USHORT     fsCheckState;   /* Check state of button  */
USHORT     fsHiliteState;  /* Highlighting state of button  */
LHANDLE    hImage;         /* Resource handle for icon or bit map  */
 } BTNCDATA;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (USHORT)
   Length of the control data in bytes.

   This is the length of the control data for a button control.


ΓòÉΓòÉΓòÉ <hidden> fsCheckState ΓòÉΓòÉΓòÉ

fsCheckState (USHORT)
   Check state of button.

   This is the same value as returned by the BM_QUERYCHECK message and passed
   to the BM_SETCHECK message.


ΓòÉΓòÉΓòÉ <hidden> fsHiliteState ΓòÉΓòÉΓòÉ

fsHiliteState (USHORT)
   Highlighting state of button.

   This is the same value as returned by the BM_QUERYHILITE message and passed
   to the BM_SETHILITE message.


ΓòÉΓòÉΓòÉ <hidden> hImage ΓòÉΓòÉΓòÉ

hImage (LHANDLE)
   Resource handle for icon or bit map.


ΓòÉΓòÉΓòÉ 4.19. BYTE ΓòÉΓòÉΓòÉ

BYTE Byte.

typedef unsigned char BYTE;


ΓòÉΓòÉΓòÉ 4.20. CATCHBUF ΓòÉΓòÉΓòÉ

CATCHBUF Saved execution environment buffer.

typedef struct _CATCHBUF {
ULONG    reserved[4];  /* Save area  */
 } CATCHBUF;


ΓòÉΓòÉΓòÉ <hidden> reserved[7] ΓòÉΓòÉΓòÉ

reserved[7] (ULONG)
   Save area.


ΓòÉΓòÉΓòÉ 4.21. CDATE ΓòÉΓòÉΓòÉ

CDATE Structure that contains date information for a data element in the
details view of a container control.

typedef struct _CDATE {
UCHAR     day;    /* Current day  */
UCHAR     month;  /* Current month  */
USHORT    year;   /* Current year  */
 } CDATE;


ΓòÉΓòÉΓòÉ <hidden> day ΓòÉΓòÉΓòÉ

day (UCHAR)
   Current day.


ΓòÉΓòÉΓòÉ <hidden> month ΓòÉΓòÉΓòÉ

month (UCHAR)
   Current month.


ΓòÉΓòÉΓòÉ <hidden> year ΓòÉΓòÉΓòÉ

year (USHORT)
   Current year.


ΓòÉΓòÉΓòÉ 4.22. CELL ΓòÉΓòÉΓòÉ

CELL Class specific cell data follows immediately afterwards.

typedef struct _CELL {
ULONG    cbData;  /* Size of the data that follows  */
 } CELL;


ΓòÉΓòÉΓòÉ <hidden> cbData ΓòÉΓòÉΓòÉ

cbData (ULONG)
   Size of the data that follows.

   Class specific cell data follows immediately afterwards. For example the
   font palette would store the ASCII name of the font, and the color palette
   would store the RGB color of the cell.


ΓòÉΓòÉΓòÉ 4.23. CHAR ΓòÉΓòÉΓòÉ

CHAR Single-byte character.

#define CHAR char


ΓòÉΓòÉΓòÉ 4.24. CHARBUNDLE ΓòÉΓòÉΓòÉ

CHARBUNDLE Character-attributes bundle structure.

typedef struct _CHARBUNDLE {
LONG      lColor;         /* Character foreground color  */
LONG      lBackColor;     /* Character background color  */
USHORT    usMixMode;      /* Character foreground-mix mode  */
USHORT    usBackMixMode;  /* Character background-mix mode  */
USHORT    usSet;          /* Character set  */
USHORT    usPrecision;    /* Character precision  */
SIZEF     sizfxCell;      /* Character cell size  */
POINTL    ptlAngle;       /* Character angle  */
POINTL    ptlShear;       /* Character shear  */
USHORT    usDirection;    /* Character direction  */
USHORT    usTextAlign;    /* Text alignment  */
FIXED     fxExtra;        /* Character extra  */
FIXED     fxBreakExtra;   /* Character break extra  */
 } CHARBUNDLE;


ΓòÉΓòÉΓòÉ <hidden> lColor ΓòÉΓòÉΓòÉ

lColor (LONG)
   Character foreground color.


ΓòÉΓòÉΓòÉ <hidden> lBackColor ΓòÉΓòÉΓòÉ

lBackColor (LONG)
   Character background color.


ΓòÉΓòÉΓòÉ <hidden> usMixMode ΓòÉΓòÉΓòÉ

usMixMode (USHORT)
   Character foreground-mix mode.


ΓòÉΓòÉΓòÉ <hidden> usBackMixMode ΓòÉΓòÉΓòÉ

usBackMixMode (USHORT)
   Character background-mix mode.


ΓòÉΓòÉΓòÉ <hidden> usSet ΓòÉΓòÉΓòÉ

usSet (USHORT)
   Character set.


ΓòÉΓòÉΓòÉ <hidden> usPrecision ΓòÉΓòÉΓòÉ

usPrecision (USHORT)
   Character precision.


ΓòÉΓòÉΓòÉ <hidden> sizfxCell ΓòÉΓòÉΓòÉ

sizfxCell (SIZEF)
   Character cell size.


ΓòÉΓòÉΓòÉ <hidden> ptlAngle ΓòÉΓòÉΓòÉ

ptlAngle (POINTL)
   Character angle.


ΓòÉΓòÉΓòÉ <hidden> ptlShear ΓòÉΓòÉΓòÉ

ptlShear (POINTL)
   Character shear.


ΓòÉΓòÉΓòÉ <hidden> usDirection ΓòÉΓòÉΓòÉ

usDirection (USHORT)
   Character direction.


ΓòÉΓòÉΓòÉ <hidden> usTextAlign ΓòÉΓòÉΓòÉ

usTextAlign (USHORT)
   Text alignment.


ΓòÉΓòÉΓòÉ <hidden> fxExtra ΓòÉΓòÉΓòÉ

fxExtra (FIXED)
   Character extra.


ΓòÉΓòÉΓòÉ <hidden> fxBreakExtra ΓòÉΓòÉΓòÉ

fxBreakExtra (FIXED)
   Character break extra.


ΓòÉΓòÉΓòÉ 4.25. CHRMSG ΓòÉΓòÉΓòÉ

CHRMSG This data structure and an associated macro (CHARMSG) are used to access
the WM_CHAR message parameters.

The macro associated with this data structure, CHARMSG, is defined as follows:

#define CHARMSG(pmsg)   ((PCHRMSG)((PBYTE)pmsg + sizeof(MPARAM) ))

The structure and macro are both defined in PMWIN.H.

typedef struct _CHARMSG {
USHORT    fs;        /* Keyboard control codes  */
UCHAR     cRepeat;   /* Repeat count  */
UCHAR     scancode;  /* Hardware scan code  */
USHORT    chr;       /* Character code  */
USHORT    vkey;      /* Virtual key code  */
 } CHRMSG;


ΓòÉΓòÉΓòÉ <hidden> fs ΓòÉΓòÉΓòÉ

fs (USHORT)
   Keyboard control codes.

   This field is from the first message parameter (mp1).


ΓòÉΓòÉΓòÉ <hidden> cRepeat ΓòÉΓòÉΓòÉ

cRepeat (UCHAR)
   Repeat count.

   This field is from the first message parameter (mp1).


ΓòÉΓòÉΓòÉ <hidden> scancode ΓòÉΓòÉΓòÉ

scancode (UCHAR)
   Hardware scan code.

   This field is from the first message parameter (mp1).


ΓòÉΓòÉΓòÉ <hidden> chr ΓòÉΓòÉΓòÉ

chr (USHORT)
   Character code.

   This field is from the second message parameter (mp2).


ΓòÉΓòÉΓòÉ <hidden> vkey ΓòÉΓòÉΓòÉ

vkey (USHORT)
   Virtual key code.

   This field is from the second message parameter (mp2).


ΓòÉΓòÉΓòÉ 4.26. CLASS ΓòÉΓòÉΓòÉ

CLASS An array of class objects. The final element of the array should be NULL.

typedef M_WPObject *CLASS;


ΓòÉΓòÉΓòÉ 4.27. CLASSDETAILS ΓòÉΓòÉΓòÉ

CLASSDETAILS Class details data structure.

typedef struct _CLASSDETAILS {
PSZ      pszAttribute;   /* Translatable string */
PVOID    pSortRecord;    /* Function pointer */
 } CLASSDETAILS;


ΓòÉΓòÉΓòÉ <hidden> pAttribute ΓòÉΓòÉΓòÉ

pAttribute (PSZ)

   Translatable string for a class attribute.


ΓòÉΓòÉΓòÉ <hidden> pSortRecord ΓòÉΓòÉΓòÉ

pSortRecord (PVOID)

   Function pointer for sort function for attribute.


ΓòÉΓòÉΓòÉ 4.28. CLASSINFO ΓòÉΓòÉΓòÉ

CLASSINFO Class-information structure.

typedef struct _CLASSINFO {
ULONG    flClassStyle;   /* Class-style flags  */
PFNWP    pfnWindowProc;  /* Window procedure  */
ULONG    cbWindowData;   /* Number of additional window words  */
 } CLASSINFO;


ΓòÉΓòÉΓòÉ <hidden> flClassStyle ΓòÉΓòÉΓòÉ

flClassStyle (ULONG)
   Class-style flags.


ΓòÉΓòÉΓòÉ <hidden> pfnWindowProc ΓòÉΓòÉΓòÉ

pfnWindowProc (PFNWP)
   Window procedure.


ΓòÉΓòÉΓòÉ <hidden> cbWindowData ΓòÉΓòÉΓòÉ

cbWindowData (ULONG)
   Number of additional window words.


ΓòÉΓòÉΓòÉ 4.29. CMDMSG ΓòÉΓòÉΓòÉ

CMDMSG This data structure and an associated macro (COMMANDMSG) are used to
access the WM_COMMAND, WM_HELP, and WM_SYSCOMMAND message parameters.

The macro associated with this data structure, COMMANDMSG, is defined as
follows:

#define COMMANDMSG(pmsg) ((PCMDMSG)((PBYTE)pmsg + sizeof(MPARAM) ))

The structure and macro are both defined in PMWIN.H.

typedef struct _COMMANDMSG {
USHORT    cmd;     /* Command value  */
USHORT    unused;  /* Not used  */
USHORT    source;  /* Source type  */
USHORT    fMouse;  /* Pointer-device indicator  */
 } CMDMSG;


ΓòÉΓòÉΓòÉ <hidden> cmd ΓòÉΓòÉΓòÉ

cmd (USHORT)
   Command value.

   This field is from the first message parameter (mp1).


ΓòÉΓòÉΓòÉ <hidden> unused ΓòÉΓòÉΓòÉ

unused (USHORT)
   Not used.


ΓòÉΓòÉΓòÉ <hidden> source ΓòÉΓòÉΓòÉ

source (USHORT)
   Source type.

   Identifies the type of control that was the source of the command.
   This field is from the second message parameter (mp2).


ΓòÉΓòÉΓòÉ <hidden> fMouse ΓòÉΓòÉΓòÉ

fMouse (USHORT)
   Pointer-device indicator.

   If TRUE, the message was posted as a result of a pointer-device operation.
   If FALSE, the message was posted as a result of a keyboard operation.
   This field is from the second message parameter (mp2).


ΓòÉΓòÉΓòÉ 4.30. CNRDRAGINFO ΓòÉΓòÉΓòÉ

CNRDRAGINFO Structure that contains information about a direct manipulation
event that is occurring over the container. The information specified for this
structure depends on the container notification code with which it is used. The
differences are specified in the following field descriptions. The applicable
notification codes are:

o CN_DRAGAFTER
o CN_DRAGLEAVE
o CN_DRAGOVER
o CN_DROP
o CN_DROPHELP

typedef struct _CNRDRAGINFO {
PDRAGINFO      pDragInfo;  /* Pointer  */
PRECORDCORE    pRecord;    /* Pointer  */
 } CNRDRAGINFO;


ΓòÉΓòÉΓòÉ <hidden> pDragInfo ΓòÉΓòÉΓòÉ

pDragInfo (PDRAGINFO)
   Pointer to a DRAGINFO structure.


ΓòÉΓòÉΓòÉ <hidden> pRecord ΓòÉΓòÉΓòÉ

pRecord (PRECORDCORE)
   Pointer to a RECORDCORE structure. The structure that is pointed to depends
   on the notification code being used.

   Note:  If the CCS_MINIRECORDCORE style bit is specified when a container is
   created, then MINIRECORDCORE should be used instead of RECORDCORE and
   PMINIRECORDCORE should be used instead of PRECORDCORE in all applicable data
   structures and messages. For the CN_DRAGAFTER notification code, this field
   contains a pointer to the RECORDCORE structure after which ordered target
   emphasis is drawn. If ordered target emphasis is applied above the first
   record in item order, the CMA_FIRST attribute is returned.
   For the CN_DRAGLEAVE notification code, this field is NULL.
   For the CN_DRAGOVER, CN_DROP, and CN_DROPHELP notification codes, this field
   contains a pointer to a container record over which direct manipulation
   occurred. This field has a value of NULL if the direct manipulation event
   occurs over white space.


ΓòÉΓòÉΓòÉ 4.31. CNRDRAGINIT ΓòÉΓòÉΓòÉ

CNRDRAGINIT Structure that contains information about a direct manipulation
event that is initiated in a container. This structure is used with the
CN_INITDRAG notification code only.

typedef struct _CNRDRAGINIT {
HWND           hwndCnr;  /* Container control handle  */
PRECORDCORE    pRecord;  /* Pointer  */
LONG           x;        /* X-coordinate  */
LONG           y;        /* Y-coordinate  */
LONG           cx;       /* X-offset  */
LONG           cy;       /* Y-offset  */
 } CNRDRAGINIT;


ΓòÉΓòÉΓòÉ <hidden> hwndCnr ΓòÉΓòÉΓòÉ

hwndCnr (HWND)
   Container control handle.


ΓòÉΓòÉΓòÉ <hidden> pRecord ΓòÉΓòÉΓòÉ

pRecord (PRECORDCORE)
   Pointer.

   Pointer to the RECORDCORE where direct manipulation started.

   Note:  If the CCS_MINIRECORDCORE style bit is specified when a container is
   created, then MINIRECORDCORE should be used instead of RECORDCORE and
   PMINIRECORDCORE should be used instead of PRECORDCORE in all applicable data
   structures and messages.
   The pRecord field can have one of the following values:

   NULL
      Direct manipulation started over white space.
   Other
      Container record over which direct manipulation started.


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (LONG)
   X-coordinate.

   X-coordinate of the pointer of the pointing device in desktop coordinates.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (LONG)
   Y-coordinate.

   Y-coordinate of the pointer of the pointing device in desktop coordinates.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (LONG)
   X-offset.

   X-offset from the hot spot of the pointer of the pointing device (in pels)
   to the record origin.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (LONG)
   Y-offset.

   Y-offset from the hot spot of the pointer of the pointing device (in pels)
   to the record origin.


ΓòÉΓòÉΓòÉ 4.32. CNRDRAWITEMINFO ΓòÉΓòÉΓòÉ

CNRDRAWITEMINFO Structure that contains information about the container item
being drawn. This structure is used with the WM_DRAWITEM (in Container
Controls) message only.

typedef struct _CNRDRAWITEMINFO {
PRECORDCORE    pRecord;     /* Pointer  */
PFIELDINFO     pFieldInfo;  /* Pointer  */
 } CNRDRAWITEMINFO;


ΓòÉΓòÉΓòÉ <hidden> pRecord ΓòÉΓòÉΓòÉ

pRecord (PRECORDCORE)
   Pointer to the RECORDCORE structure for the record that is being drawn.

   Note:  If the CCS_MINIRECORDCORE style bit is specified when a container is
   created, then MINIRECORDCORE should be used instead of RECORDCORE and
   PMINIRECORDCORE should be used instead of PRECORDCORE in all applicable data
   structures and messages.


ΓòÉΓòÉΓòÉ <hidden> pFieldInfo ΓòÉΓòÉΓòÉ

pFieldInfo (PFIELDINFO)
   Pointer to the FIELDINFO structure for the container column that is being
   drawn in the details view. For all other views, this field is NULL.


ΓòÉΓòÉΓòÉ 4.33. CNREDITDATA ΓòÉΓòÉΓòÉ

CNREDITDATA Structure that contains information about the direct editing of
container text. The information specified for this structure depends on the
container notification code or message with which it is used. The differences
are specified in the following field descriptions. The applicable notification
codes and message are:

o CN_BEGINEDIT
o CN_ENDEDIT
o CN_REALLOCPSZ
o CM_OPENEDIT

typedef struct _CNREDITDATA {
ULONG          cb;          /* Structure size  */
HWND           hwndCnr;     /* Container window handle  */
PRECORDCORE    pRecord;     /* Pointer or NULL  */
PFIELDINFO     pFieldInfo;  /* Pointer or NULL  */
PSZ           *ppszText;    /* Pointer or NULL  */
ULONG          cbText;      /* Number of bytes  */
ULONG          id;          /* Window ID  */
 } CNREDITDATA;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   The size (in bytes) of the CNREDITDATA data structure.


ΓòÉΓòÉΓòÉ <hidden> hwndCnr ΓòÉΓòÉΓòÉ

hwndCnr (HWND)
   Container window handle.


ΓòÉΓòÉΓòÉ <hidden> pRecord ΓòÉΓòÉΓòÉ

pRecord (PRECORDCORE)
   Pointer to a RECORDCORE data structure. This field is NULL if container
   titles are to be edited.

   Note:  If the CCS_MINIRECORDCORE style bit is specified when a container is
   created, then MINIRECORDCORE should be used instead of RECORDCORE and
   PMINIRECORDCORE should be used instead of PRECORDCORE in all applicable data
   structures and messages.
   For the CN_BEGINEDIT, CN_ENDEDIT, and CN_REALLOCPSZ notification codes, this
   field is a pointer to the edited RECORDCORE data structure.
   For the CM_OPENEDIT message, this field is a pointer to the RECORDCORE data
   structure to be edited.


ΓòÉΓòÉΓòÉ <hidden> pFieldInfo ΓòÉΓòÉΓòÉ

pFieldInfo (PFIELDINFO)
   Pointer to a FIELDINFO data structure if the current view is the details
   view and the user is not editing the container title. Otherwise, this field
   is NULL.
   If the current view is the details view:

   o For the CN_BEGINEDIT, CN_ENDEDIT, and CN_REALLOCPSZ notification codes,
     this field contains a pointer to the FIELDINFO structure being edited.

   o For the CM_OPENEDIT message, this field is a pointer to the FIELDINFO data
     structure to be edited.


ΓòÉΓòÉΓòÉ <hidden> ppszText ΓòÉΓòÉΓòÉ

ppszText (PPSZ)
   Pointer to a PSZ text string. For the CN_BEGINEDIT and CN_REALLOCPSZ
   notification codes, this field is a pointer to the current PSZ text string.
   For the CN_ENDEDIT notification code, this field is a pointer to the new PSZ
   text string.
   For the CM_OPENEDIT message, this field is NULL.


ΓòÉΓòÉΓòÉ <hidden> cbText ΓòÉΓòÉΓòÉ

cbText (ULONG)
   Number of bytes.

   Number of bytes in the text string. For the CN_BEGINEDIT notification code,
   this field is 0.
   For the CN_ENDEDIT and CN_REALLOCPSZ notification codes, this field is the
   number of bytes in the new text string.
   For the CM_OPENEDIT message, this field is 0.


ΓòÉΓòÉΓòÉ <hidden> id ΓòÉΓòÉΓòÉ

id (ULONG)
   Window ID.

   ID of the window to be edited. The ID can be one of the following:

   application-defined container identifier
      Container window.
   CID_CNRTITLEWND
      Title window.
   CID_LEFTDVWND
      Left details view window; default if unsplit window.
   CID_RIGHTDVWND
      Right details view window.
   CID_LEFTCOLTITLEWND
      Left details view column headings window; default if unsplit window.
   CID_RIGHTCOLTITLEWND
      Right details view column headings window.


ΓòÉΓòÉΓòÉ 4.34. CNRINFO ΓòÉΓòÉΓòÉ

CNRINFO Structure that contains information about the container.

typedef struct _CNRINFO {
ULONG         cb;                  /* Structure size  */
PVOID         pSortRecord;         /* Pointer or NULL  */
PFIELDINFO    pFieldInfoLast;      /* Pointer or NULL  */
PFIELDINFO    pFieldInfoObject;    /* Pointer  */
PSZ           pszCnrTitle;         /* Title text or NULL  */
ULONG         flWindowAttr;        /* Window attributes  */
POINTL        ptlOrigin;           /* Workspace origin  */
ULONG         cDelta;              /* Threshold  */
ULONG         cRecords;            /* Number of records  */
SIZEL         slBitmapOrIcon;      /* Icon/bit-map size  */
SIZEL         slTreeBitmapOrIcon;  /* Icon/bit-map size  */
HBITMAP       hbmExpanded;         /* Bit-map handle  */
HBITMAP       hbmCollapsed;        /* Bit-map handle  */
HPOINTER      hptrExpanded;        /* Icon handle  */
HPOINTER      hptrCollapsed;       /* Icon handle  */
LONG          cyLineSpacing;       /* Vertical space  */
LONG          cxTreeIndent;        /* Horizontal space  */
LONG          cxTreeLine;          /* Line width  */
ULONG         cFields;             /* Number of columns  */
LONG          xVertSplitbar;       /* Split bar position  */
 } CNRINFO;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   The size (in bytes) of the CNRINFO data structure.


ΓòÉΓòÉΓòÉ <hidden> pSortRecord ΓòÉΓòÉΓòÉ

pSortRecord (PVOID)
   Pointer or NULL.

   Pointer to the comparison function for sorting container records. If NULL,
   which is the default condition, no sorting is performed. Sorting only occurs
   during record insertion and when changing the value of this field. The third
   parameter of the comparison function, pStorage, must be NULL. See
   CM_SORTRECORD for a further description of the comparison function.


ΓòÉΓòÉΓòÉ <hidden> pFieldInfoLast ΓòÉΓòÉΓòÉ

pFieldInfoLast (PFIELDINFO)
   Pointer or NULL.

   Pointer to last column in the left window of the split details view. The
   default is NULL, causing all columns to be positioned in the left window.


ΓòÉΓòÉΓòÉ <hidden> pFieldInfoObject ΓòÉΓòÉΓòÉ

pFieldInfoObject (PFIELDINFO)
   Pointer.

   Pointer to a column that represents an object in the details view. The data
   for this FIELDINFO structure must contain icons or bit maps. In-use emphasis
   is applied to this column of icons or bit maps only. The default is the
   leftmost column in the unsplit details view, or the leftmost column in the
   left window of the split details view.


ΓòÉΓòÉΓòÉ <hidden> pszCnrTitle ΓòÉΓòÉΓòÉ

pszCnrTitle (PSZ)
   Title text or NULL.

   Text for the container title. The default is NULL.


ΓòÉΓòÉΓòÉ <hidden> flWindowAttr ΓòÉΓòÉΓòÉ

flWindowAttr (ULONG)
   Window attributes.

   Consists of container window attributes.

   o Specify one of the following container views, which determine the
     presentation format of items in a container:

      CV_ICON
         In the icon view, the container items are represented as icon/text or
         bit-map/text pairs, with text beneath the icons or bit maps. This is
         the default view. This view can be combined with the CV_MINI style bit
         by using an OR operator (|).
      CV_NAME
         In the name view, the container items are represented as icon/text or
         bit-map/text pairs, with text to the right of the icons or bit maps.
         This view can be combined with the CV_MINI and CV_FLOW style bits by
         using OR operators (|).
      CV_TEXT
         In the text view, the container items are displayed as a list of text
         strings. This view can be combined with the CV_FLOW style bit by using
         an OR operator (|).
      CV_TREE
         In the tree view, the container items are represented in a
         hierarchical manner. The tree view has three forms, which are defined
         in the following list. If you specify CV_TREE by itself, the tree icon
         view is used.

         - Tree icon view
           The tree icon view is specified by using a logical OR operator to
           combine the tree view with the icon view (CV_TREE | CV_ICON).
           Container items in this view are represented as icon/text pairs or
           bit-map/text pairs, with text to the right of the icons or bit maps.
           Also, a collapsed or expanded icon or bit map is displayed to the
           left of parent items. If this icon or bit map is a collapsed icon or
           bit map, selecting it will cause the parent item to be expanded so
           that its child items are displayed below it. If this icon or bit map
           is an expanded icon or bit map, selecting it will cause the parent's
           child items to be removed from the display. The default collapsed
           and expanded bit maps provided by the container use a plus sign (+)
           and a minus sign (-), respectively, to indicate that items can be
           added to or subtracted from the display.

         - Tree name view
           The tree name view is specified by using a logical OR operator to
           combine the tree view with the name view (CV_TREE | CV_NAME).
           Container items in this view are displayed as either icon/text pairs
           or bit-map/text pairs, with text to the right of the icons or bit
           maps. However, the indicator that represents whether an item can be
           collapsed or expanded, such as a plus or minus sign, is included in
           the icon or bit map that represents that item, not in a separate
           icon or bit map as in the tree icon and tree text views. The
           container control does not provide default collapsed and expanded
           bit maps for the tree name view.

         - Tree text view
           The tree text view is specified by using a logical OR operator to
           combine the tree view with the text view (CV_TREE | CV_TEXT).
           Container items in this view are displayed as a list of text
           strings. As in the tree icon view, a collapsed or expanded icon or
           bit map is displayed to the left of parent items.
      CV_DETAIL
         In the details view, the container items are presented in columns.
         Each column can contain icons or bit maps, text, numbers, dates, or
         times.

   o Specify one or both of the following view styles by using an OR operator
     (|) to combine them with the specified view. These view styles are
     optional.

      CV_MINI
         Produces a mini-icon whose size is based on the Presentation Manager
         (PM) SV_CYMENU system value to produce a device-dependent mini-icon.
         The CV_MINI view style bit is ignored when:

         - The text view (CV_TEXT), tree view (CV_TREE), or details view
           (CV_DETAIL) are displayed

         - The CCS_MINIRECORDCORE style bit is specified.
         If this style bit is not specified and the icon view (CV_ICON) or name
         view (CV_NAME) is used, the default, regular-sized icon is used. The
         size of regular-sized icons is based on the value in the
         slBitmapOrIcon field of the CNRINFO data structure. If this field is
         equal to 0, the PM SV_CXICON and SV_CYICON system values for width and
         height, respectively, are used. Icon sizes are consistent with
         PM-defined icon sizes for all devices.
      CV_FLOW
         Dynamically arranges container items in columns in the name and text
         views. These are called flowed name and flowed text views. If this
         style bit is set for the name view (CV_NAME) or text view (CV_TEXT),
         the container items are placed in a single column until the bottom of
         the client area is reached. The next container item is placed in the
         adjacent column to the right of the filled column. This process is
         repeated until all of the container items are positioned in the
         container. The width of each column is determined by the longest text
         string in that column. The size of the window determines the depth of
         the client area.
         If this style bit is not specified, the default condition for the name
         and text views is to vertically fill the container in a single column
         without flowing the container items. If this style bit is set for the
         icon view (CV_ICON) or details view (CV_DETAIL), it is ignored.

   o Specify either of the following to indicate whether the container will
     display icons or bit maps:

      CA_DRAWICON
         Icons are used for the icon, name, tree, or details views. This is the
         default. This container attribute should be used with the hptrIcon and
         hptrMiniIcon fields of the RECORDCORE data structure.
      CA_DRAWBITMAP
         Bit maps are used for the icon, name, tree, or details views. This
         container attribute can be used with the hbmBitmap and hbmMiniBitmap
         fields of the RECORDCORE data structure.
         Notes

          1. If both the CA_DRAWICON and CA_DRAWBITMAP attributes are
             specified, the CA_DRAWICON attribute is used.

          2. If the CCS_MINIRECORDCORE style bit is specified when a container
             is created, the hptrIcon field of the MINIRECORDCORE data
             structure is used.

   o Specify one of the following attributes to provide target emphasis for the
     name, text, and details views. If neither ordered nor mixed target
     emphasis is specified, the emphasis is drawn around the record.

      CA_ORDEREDTARGETEMPH
         Shows where a container record can be dropped during direct
         manipulation by drawing a line beneath the record. Ordered target
         emphasis does not apply to the icon and tree views.
      CA_MIXEDTARGETEMPH
         Shows where a container record can be dropped during direct
         manipulation either by drawing a line between two items or by drawing
         lines around the container record. Mixed target emphasis does not
         apply to the icon and tree views.

   o Specify the following attribute to draw lines that show the relationship
     between items in the tree view.

      CA_TREELINE
         Shows the relationship between all items in the tree view.

   o Specify the following to draw container records, paint the background of
     the container, or both:

      CA_OWNERDRAW
         Ownerdraw for the container, which allows the application to draw
         container records.
      CA_OWNERPAINTBACKGROUND
         Allows the application to subclass the container and paint the
         background. If specified, and the container is subclassed, the
         application receives the CM_PAINTBACKGROUND message in the subclass
         procedure. Otherwise, the container paints the background using the
         color specified by SYSCLR_WINDOW, which can be changed by using the
         PP_BACKGROUNDCOLOR or PP_BACKGROUNDCOLORINDEX presentation parameter
         in the WM_PRESPARAMCHANGED (in Container Controls) message.

   o Specify the following if the container is to have a title:

      CA_CONTAINERTITLE
         Allows you to include a container title. The default is no container
         title.

   o Specify one or both of the following container title attributes. These are
     valid only if the CA_CONTAINERTITLE attribute is specified.

      CA_TITLEREADONLY
         Prevents the container title from being edited directly. The default
         is to allow the container title to be edited.
      CA_TITLESEPARATOR
         Puts a separator line between the container title and the records
         beneath it. The default is no separator line.

   o Specify one of the following to position the container title. These are
     valid only if the CA_CONTAINERTITLE attribute is specified.

      CA_TITLECENTER
         Centers the container title. This is the default.
      CA_TITLELEFT
         Left-justifies the container title.
      CA_TITLERIGHT
         Right-justifies the container title.

   o Specify the following to display column headings in the details view:

      CA_DETAILSVIEWTITLES
         Allows you to include column headings in the details view. The default
         is no column headings.


ΓòÉΓòÉΓòÉ <hidden> ptlOrigin ΓòÉΓòÉΓòÉ

ptlOrigin (POINTL)
   Workspace origin.

   Lower-left origin of the workspace in virtual coordinates, used in the icon
   view. The default origin is (0,0).


ΓòÉΓòÉΓòÉ <hidden> cDelta ΓòÉΓòÉΓòÉ

cDelta (ULONG)
   Threshold

   An application-defined threshold, or number of records, from either end of
   the list of available records. Used when a container needs to handle large
   amounts of data. The default is 0. Refer to the OS/2 Programming Guide for
   more information about specifying deltas.


ΓòÉΓòÉΓòÉ <hidden> cRecords ΓòÉΓòÉΓòÉ

cRecords (ULONG)
   Number of records.

   The number of records in the container. Initially this field is 0.


ΓòÉΓòÉΓòÉ <hidden> slBitmapOrIcon ΓòÉΓòÉΓòÉ

slBitmapOrIcon (SIZEL)
   Icon/bit-map size.

   The size (in pels) of icons or bit maps. The default is the system size.


ΓòÉΓòÉΓòÉ <hidden> slTreeBitmapOrIcon ΓòÉΓòÉΓòÉ

slTreeBitmapOrIcon (SIZEL)
   Icon/bit-map size.

   The size (in pels) of the expanded and collapsed icons or bit maps used in
   the tree icon and tree text views.


ΓòÉΓòÉΓòÉ <hidden> hbmExpanded ΓòÉΓòÉΓòÉ

hbmExpanded (HBITMAP)
   Bit-map handle.

   The handle of the bit map to be used to represent an expanded parent item in
   the tree icon and tree text views. If neither an icon handle (see
   hptrExpanded) nor a bit-map handle is specified, a default bit map with a
   minus sign (-) is provided.


ΓòÉΓòÉΓòÉ <hidden> hbmCollapsed ΓòÉΓòÉΓòÉ

hbmCollapsed (HBITMAP)
   Bit-map handle.

   The handle of the bit map to be used to represent a collapsed parent item in
   the tree icon and tree text views. If neither an icon handle (see
   hptrCollapsed) nor a bit-map handle is specified, a default bit map with a
   plus sign (+) is provided.


ΓòÉΓòÉΓòÉ <hidden> hptrExpanded ΓòÉΓòÉΓòÉ

hptrExpanded (HPOINTER)
   Icon handle.

   The handle of the icon to be used to represent an expanded parent item in
   the tree icon and tree text views. If neither an icon handle nor a bit-map
   handle (see hbmExpanded) is specified, a default bit map with a minus sign
   (-) is provided.


ΓòÉΓòÉΓòÉ <hidden> hptrCollapsed ΓòÉΓòÉΓòÉ

hptrCollapsed (HPOINTER)
   Icon handle.

   The handle of the icon to be used to represent a collapsed parent item in
   the tree icon and tree text views. If neither an icon handle nor a bit-map
   handle (see hbmCollapsed) is specified, a default bit map with a plus sign
   (+) is provided.


ΓòÉΓòÉΓòÉ <hidden> cyLineSpacing ΓòÉΓòÉΓòÉ

cyLineSpacing (LONG)
   Vertical space.

   The amount of vertical space (in pels) between the records. If you specify a
   value that is less than 0, a default value is used.


ΓòÉΓòÉΓòÉ <hidden> cxTreeIndent ΓòÉΓòÉΓòÉ

cxTreeIndent (LONG)
   Horizontal space.

   The amount of horizontal space (in pels) between levels in the tree view. If
   you specify a value that is less than 0, a default value is used.


ΓòÉΓòÉΓòÉ <hidden> cxTreeLine ΓòÉΓòÉΓòÉ

cxTreeLine (LONG)
   Line width.

   The width of the lines (in pels) that show the relationship between tree
   items. If you specify a value that is less than 0, a default value is used.
   Also, if the CA_TREELINE container attribute of the flWindowAttr field is
   not specified, these lines are not drawn.


ΓòÉΓòÉΓòÉ <hidden> cFields ΓòÉΓòÉΓòÉ

cFields (ULONG)
   Number of columns.

   The number of FIELDINFO structures in the container. Initially this field is
   0.


ΓòÉΓòÉΓòÉ <hidden> xVertSplitbar ΓòÉΓòÉΓòÉ

xVertSplitbar (LONG)
   Split bar position.

   The initial position of the split bar relative to the container, used in the
   details view. If this value is less than 0, the split bar is not used. The
   default value is negative one (-1).


ΓòÉΓòÉΓòÉ 4.35. COLOR ΓòÉΓòÉΓòÉ

COLOR Color value.

typedef LONG COLOR;


ΓòÉΓòÉΓòÉ 4.36. CONVCONTEXT ΓòÉΓòÉΓòÉ

CONVCONTEXT Dynamic-data-exchange conversation context structure.

typedef struct _CONVCONTEXT {
ULONG    cb;           /* Length of structure  */
ULONG    fsContext;    /* Options  */
ULONG    idCountry;    /* Country code  */
ULONG    usCodepage;   /* Code-page identity  */
ULONG    usLangID;     /* Language  */
ULONG    usSubLangID;  /* Sub-language  */
 } CONVCONTEXT;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Length of structure.

   This must be set to the length of the CONVCONTEXT structure.


ΓòÉΓòÉΓòÉ <hidden> fsContext ΓòÉΓòÉΓòÉ

fsContext (ULONG)
   Options.

   DDECTXT_CASESENSITIVE
      All strings in this conversation are case sensitive.


ΓòÉΓòÉΓòÉ <hidden> idCountry ΓòÉΓòÉΓòÉ

idCountry (ULONG)
   Country code.


ΓòÉΓòÉΓòÉ <hidden> usCodepage ΓòÉΓòÉΓòÉ

usCodepage (ULONG)
   Code-page identity.


ΓòÉΓòÉΓòÉ <hidden> usLangID ΓòÉΓòÉΓòÉ

usLangID (ULONG)
   Language.

   Zero is valid and means no language information.


ΓòÉΓòÉΓòÉ <hidden> usSubLangID ΓòÉΓòÉΓòÉ

usSubLangID (ULONG)
   Sub-language.

   Zero is valid and means no sub-language information.


ΓòÉΓòÉΓòÉ 4.37. CPTEXT ΓòÉΓòÉΓòÉ

CPTEXT String structure containing the code-page and language of the string.

typedef struct _CPTEXT {
USHORT    idCountry;    /* Country code  */
USHORT    usCodepage;   /* Code-page identity  */
USHORT    usLangID;     /* Language  */
USHORT    usSubLangID;  /* Sub-language  */
BYTE      abText[1];    /* Zero-terminated text string  */
 } CPTEXT;


ΓòÉΓòÉΓòÉ <hidden> idCountry ΓòÉΓòÉΓòÉ

idCountry (USHORT)
   Country code.


ΓòÉΓòÉΓòÉ <hidden> usCodepage ΓòÉΓòÉΓòÉ

usCodepage (USHORT)
   Code-page identity.


ΓòÉΓòÉΓòÉ <hidden> usLangID ΓòÉΓòÉΓòÉ

usLangID (USHORT)
   Language.

   Zero is valid and means no language information.


ΓòÉΓòÉΓòÉ <hidden> usSubLangID ΓòÉΓòÉΓòÉ

usSubLangID (USHORT)
   Sub-language.

   Zero is valid and means no sub-language information.


ΓòÉΓòÉΓòÉ <hidden> abText[1] ΓòÉΓòÉΓòÉ

abText[1] (BYTE)
   Zero-terminated text string.


ΓòÉΓòÉΓòÉ 4.38. CREATESTRUCT ΓòÉΓòÉΓòÉ

CREATESTRUCT Create-window data structure.

typedef struct _CREATESTRUCT {
PVOID    pPresParams;       /* Presentation parameters  */
PVOID    pCtlData;          /* Control data  */
ULONG    id;                /* Window identifier  */
HWND     hwndInsertBehind;  /* Window behind which the window is to be placed  */
HWND     hwndOwner;         /* Window owner  */
LONG     cy;                /* Window height  */
LONG     cx;                /* Window width  */
LONG     y;                 /* y-coordinate of origin  */
LONG     x;                 /* x coordinate of origin  */
ULONG    flStyle;           /* Window style  */
PSZ      pszText;           /* Window text  */
PSZ      pszClass;          /* Registered window class name  */
HWND     hwndParent;        /* Parent window handle  */
 } CREATESTRUCT;


ΓòÉΓòÉΓòÉ <hidden> pPresParams ΓòÉΓòÉΓòÉ

pPresParams (PVOID)
   Presentation parameters.


ΓòÉΓòÉΓòÉ <hidden> pCtlData ΓòÉΓòÉΓòÉ

pCtlData (PVOID)
   Control data.


ΓòÉΓòÉΓòÉ <hidden> id ΓòÉΓòÉΓòÉ

id (ULONG)
   Window identifier.


ΓòÉΓòÉΓòÉ <hidden> hwndInsertBehind ΓòÉΓòÉΓòÉ

hwndInsertBehind (HWND)
   Window behind which the window is to be placed.


ΓòÉΓòÉΓòÉ <hidden> hwndOwner ΓòÉΓòÉΓòÉ

hwndOwner (HWND)
   Window owner.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (LONG)
   Window height.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (LONG)
   Window width.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (LONG)
   y-coordinate of origin.


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (LONG)
   x coordinate of origin.


ΓòÉΓòÉΓòÉ <hidden> flStyle ΓòÉΓòÉΓòÉ

flStyle (ULONG)
   Window style.


ΓòÉΓòÉΓòÉ <hidden> pszText ΓòÉΓòÉΓòÉ

pszText (PSZ)
   Window text.


ΓòÉΓòÉΓòÉ <hidden> pszClass ΓòÉΓòÉΓòÉ

pszClass (PSZ)
   Registered window class name.


ΓòÉΓòÉΓòÉ <hidden> hwndParent ΓòÉΓòÉΓòÉ

hwndParent (HWND)
   Parent window handle.


ΓòÉΓòÉΓòÉ 4.39. CTIME ΓòÉΓòÉΓòÉ

CTIME Structure that contains time information for a data element in the
details view of a container control.

typedef struct _CTIME {
UCHAR    hours;       /* Current hour  */
UCHAR    minutes;     /* Current minute  */
UCHAR    seconds;     /* Current second  */
UCHAR    ucReserved;  /* Reserved  */
 } CTIME;


ΓòÉΓòÉΓòÉ <hidden> hours ΓòÉΓòÉΓòÉ

hours (UCHAR)
   Current hour.


ΓòÉΓòÉΓòÉ <hidden> minutes ΓòÉΓòÉΓòÉ

minutes (UCHAR)
   Current minute.


ΓòÉΓòÉΓòÉ <hidden> seconds ΓòÉΓòÉΓòÉ

seconds (UCHAR)
   Current second.


ΓòÉΓòÉΓòÉ <hidden> ucReserved ΓòÉΓòÉΓòÉ

ucReserved (UCHAR)
   Reserved.


ΓòÉΓòÉΓòÉ 4.40. CURSORINFO ΓòÉΓòÉΓòÉ

CURSORINFO Cursor-information structure.

typedef struct _CURSORINFO {
HWND     hwnd;     /* Window handle  */
LONG     x;        /* x coordinate  */
LONG     y;        /* y coordinate  */
LONG     cx;       /* Cursor width  */
LONG     cy;       /* Cursor height  */
ULONG    fs;       /* Options  */
RECTL    rclClip;  /* Cursor box  */
 } CURSORINFO;


ΓòÉΓòÉΓòÉ <hidden> hwnd ΓòÉΓòÉΓòÉ

hwnd (HWND)
   Window handle.


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (LONG)
   x coordinate.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (LONG)
   y coordinate.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (LONG)
   Cursor width.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (LONG)
   Cursor height.


ΓòÉΓòÉΓòÉ <hidden> fs ΓòÉΓòÉΓòÉ

fs (ULONG)
   Options.


ΓòÉΓòÉΓòÉ <hidden> rclClip ΓòÉΓòÉΓòÉ

rclClip (RECTL)
   Cursor box.


ΓòÉΓòÉΓòÉ 4.41. DDEINIT ΓòÉΓòÉΓòÉ

DDEINIT Dynamic-data-exchange initiation structure.

typedef struct _DDEINIT {
ULONG    cb;              /* Length of structure  */
PSZ      pszAppName;      /* Application name  */
PSZ      pszTopic;        /* Topic  */
ULONG    offConvContext;  /* Conversation context  */
 } DDEINIT;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Length of structure.

   This must be set to the length of the DDEINIT structure.


ΓòÉΓòÉΓòÉ <hidden> pszAppName ΓòÉΓòÉΓòÉ

pszAppName (PSZ)
   Application name.

   Pointer to name of the server application.
   Application names must not contain slashes or backslashes. These characters
   are reserved for future use in network implementations.


ΓòÉΓòÉΓòÉ <hidden> pszTopic ΓòÉΓòÉΓòÉ

pszTopic (PSZ)
   Topic.

   Pointer to name of the topic.


ΓòÉΓòÉΓòÉ <hidden> offConvContext ΓòÉΓòÉΓòÉ

offConvContext (ULONG)
   Conversation context.

   Offset to a CONVCONTEXT structure.


ΓòÉΓòÉΓòÉ 4.42. DDESTRUCT ΓòÉΓòÉΓòÉ

DDESTRUCT Dynamic-data-exchange control structure.

typedef struct _DDESTRUCT {
ULONG     cbData;         /* Length of data  */
USHORT    fsStatus;       /* Status  */
USHORT    usFormat;       /* Data format  */
USHORT    offszItemName;  /* Offset to item name  */
USHORT    offabData;      /* Offset to beginning of data  */
 } DDESTRUCT;


ΓòÉΓòÉΓòÉ <hidden> cbData ΓòÉΓòÉΓòÉ

cbData (ULONG)
   Length of data.

   This is the length of data that occurs after the offabData parameter. If no
   data exists, this field should contain a zero (0).


ΓòÉΓòÉΓòÉ <hidden> fsStatus ΓòÉΓòÉΓòÉ

fsStatus (USHORT)
   Status of the data exchange.

   DDE_FACK
      Positive acknowledgement
   DDE_FBUSY
      Application is busy
   DDE_FNODATA
      No data transfer for advise
   DDE_FACKREQ
      Acknowledgements are requested
   DDE_FRESPONSE
      Response to WM_DDE_REQUEST
   DDE_NOTPROCESSED
      DDE message not understood
   DDE_FAPPSTATUS
      A 1-byte field of bits that are reserved for application-specific
      returns.


ΓòÉΓòÉΓòÉ <hidden> usFormat ΓòÉΓòÉΓòÉ

usFormat (USHORT)
   Data format.

   One of the DDE data formats.

   DDEFMT_TEXT
      Text format.
   Other
      DDE format registered with the atom manager, using the system atom table.
      The predefined DDE formats are guaranteed not to conflict with the values
      returned by the atom manager.


ΓòÉΓòÉΓòÉ <hidden> offszItemName ΓòÉΓòÉΓòÉ

offszItemName (USHORT)
   Offset to item name.

   This is the offset to the item name from the start of this structure. Item
   name is a null (0x00) terminated string. If no item name exists, there must
   be a single null (0x00) character in this position. (That is, ItemName is
   ALWAYS a null terminated string.)


ΓòÉΓòÉΓòÉ <hidden> offabData ΓòÉΓòÉΓòÉ

offabData (USHORT)
   Offset to beginning of data.

   This is the offset to the data, from the start of this structure. This field
   should be calculated regardless of the presence of data. If no data exists,
   cbData must be zero (0).
   For compatibility reasons, this data should not contain embedded pointers.
   Offsets should be used instead.


ΓòÉΓòÉΓòÉ 4.43. DELETENOTIFY ΓòÉΓòÉΓòÉ

DELETENOTIFY Structure that contains information about the application page
that is being deleted from a notebook.

typedef struct _DELETENOTIFY {
HWND       hwndBook;       /* Notebook window handle  */
HWND       hwndPage;       /* Application page window handle  */
ULONG      ulAppPageData;  /* Application-specified page data  */
HBITMAP    hbmTab;         /* Application-specified tab bit map  */
 } DELETENOTIFY;


ΓòÉΓòÉΓòÉ <hidden> hwndBook ΓòÉΓòÉΓòÉ

hwndBook (HWND)
   Notebook window handle.


ΓòÉΓòÉΓòÉ <hidden> hwndPage ΓòÉΓòÉΓòÉ

hwndPage (HWND)
   Application page window handle.


ΓòÉΓòÉΓòÉ <hidden> ulAppPageData ΓòÉΓòÉΓòÉ

ulAppPageData (ULONG)
   Application-specified page data.


ΓòÉΓòÉΓòÉ <hidden> hbmTab ΓòÉΓòÉΓòÉ

hbmTab (HBITMAP)
   Application-specified tab bit map.


ΓòÉΓòÉΓòÉ 4.44. DESKTOP ΓòÉΓòÉΓòÉ

DESKTOP Desktop background state structure.

typedef struct _DESKTOP {
ULONG      cbSize;           /* Length of structure  */
HBITMAP    hbm;              /* Bit-map handle of desktop background  */
LONG       x;                /* x desktop coordinate of the origin of the bit map  */
LONG       y;                /* y desktop coordinate of the origin of the bit map  */
ULONG      fl;               /* Desktop background state indicators or setting options  */
LONG       lTileCount;       /* Number of images of the bit map to be tiled  */
CHAR       szFile[260];      /* Zero-terminated name of the file containing the bit map  */
 } DESKTOP;


ΓòÉΓòÉΓòÉ <hidden> cbSize ΓòÉΓòÉΓòÉ

cbSize (ULONG)
   Length of structure.


ΓòÉΓòÉΓòÉ <hidden> hbm ΓòÉΓòÉΓòÉ

hbm (HBITMAP)
   Bit-map handle of desktop background.


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (LONG)
   x desktop coordinate of the origin of the bit map.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (LONG)
   y desktop coordinate of the origin of the bit map.


ΓòÉΓòÉΓòÉ <hidden> fl ΓòÉΓòÉΓòÉ

fl (ULONG)
   Desktop background state indicators or setting options:

   SDT_CENTER
      The desktop background bit map is, or is to be, centered on the screen.
      If this option is specified, then the values of the x the y parameters
      are inapplicable.
   SDT_DESTROY
      Any existing desktop background bit map is to be destroyed. The setting
      of this option is not returned on the WinQueryDesktopBkgnd function.
   SDT_NOBKGND
      There is no desktop background bit map, that is the desktop background i
      a solid color. For the WinQueryDesktopBkgnd function the existing
      background is to be left unmodified unless SDT_DESTROY is also specified.
   SDT_PATTERN
      The bit map represents a fill pattern.
   SDT_RETAIN
      The szFile[260] is, or is to be, remembered for use when the system is
      started.
   SDT_SCALE
      The bit map is, or is to be, scaled to fill the desktop. If this option
      is specified, then the values of the x and y parameters are inapplicable.
   SDT_TILE
      The bit map is, or is to be, tiled to fill the desktop.
   SDT_LOADFILE
      For the WinSetDesktopBkgnd function the bit map is to be loaded from the
      filename specified. If the SDT_NOBKGND flag is also set then the bit map
      is loaded but the background is not set. Tiling and scaling may be
      performed at load time or later when setting the bit map.


ΓòÉΓòÉΓòÉ <hidden> lTileCount ΓòÉΓòÉΓòÉ

lTileCount (LONG)
   Number of images of the bit map to be tiled.

   The tile count is the number of images to be drawn in the vertical and
   horizontal direction when tiling the desktop background.


ΓòÉΓòÉΓòÉ <hidden> szFile[260] ΓòÉΓòÉΓòÉ

szFile[260] (CHAR)
   Zero-terminated name of the file containing the bit map.


ΓòÉΓòÉΓòÉ 4.45. DEVOPENSTRUC ΓòÉΓòÉΓòÉ

DEVOPENSTRUC Open-device data structure.

typedef struct _DEVOPENSTRUC {
PSZ          pszLogAddress;       /* Logical address  */
PSZ          pszDriverName;       /* Driver name  */
PDRIVDATA    pdriv;               /* Driver data  */
PSZ          pszDataType;         /* Data type  */
PSZ          pszComment;          /* Comment  */
PSZ          pszQueueProcName;    /* Queue-processor name  */
PSZ          pszQueueProcParams;  /* Queue-processor parameters  */
PSZ          pszSpoolerParams;    /* Spooler parameters  */
PSZ          pszNetworkParams;    /* Network parameters  */
 } DEVOPENSTRUC;


ΓòÉΓòÉΓòÉ <hidden> pszLogAddress ΓòÉΓòÉΓòÉ

pszLogAddress (PSZ)
   Logical address.

   This is required for an OD_DIRECT device being opened with DevOpenDC; it is
   the logical device address, such as "LPT1" on OS/2. Some drivers may accept
   a file name for this parameter, or even a named pipe.  A driver can restrict
   the logical address to certain names because special hardware is involved;
   for example a printer driver that uses shared memory to access the memory of
   a laser printer.
   Where output is to be queued (for an OD_QUEUED device), this is the name of
   the queue for the output device, and must always be supplied if it is not
   available from pszToken. The queue name can be a UNC name.


ΓòÉΓòÉΓòÉ <hidden> pszDriverName ΓòÉΓòÉΓòÉ

pszDriverName (PSZ)
   Driver name.

   A string containing the name of the Presentation Manager* (PM) device driver
   (for example, "IBM4019"). This information must always be supplied if it is
   not available from pszToken.


ΓòÉΓòÉΓòÉ <hidden> pdriv ΓòÉΓòÉΓòÉ

pdriv (PDRIVDATA)
   Driver data.

   Data that is to be passed directly to the PM device driver. Whether any of
   this is required depends upon the device driver.


ΓòÉΓòÉΓòÉ <hidden> pszDataType ΓòÉΓòÉΓòÉ

pszDataType (PSZ)
   Data type.

   For a OD_QUEUED or OD_DIRECT device, this parameter defines the type of data
   that is to be (or was) queued as follows:

   PM_Q_STD Standard format
   PM_Q_RAW Raw format.
   Note that a device driver can define other data types.
   With DevOpenDC, for both of the above device types the default is supplied
   by the device driver if pszDataType is not specified. For any other device
   type, pszDataType is ignored.


ΓòÉΓòÉΓòÉ <hidden> pszComment ΓòÉΓòÉΓòÉ

pszComment (PSZ)
   Comment.

   This is a natural language description of the file for queued output, For
   example, this can be displayed by the spooler to the user, and is optional.


ΓòÉΓòÉΓòÉ <hidden> pszQueueProcName ΓòÉΓòÉΓòÉ

pszQueueProcName (PSZ)
   Queue-processor name.

   This is the name of the queue processor for queued output, and is usually
   the default.


ΓòÉΓòÉΓòÉ <hidden> pszQueueProcParams ΓòÉΓòÉΓòÉ

pszQueueProcParams (PSZ)
   Queue-processor parameters.

   This is a parameter string for the queue processor, for queued output, and
   is optional.


ΓòÉΓòÉΓòÉ <hidden> pszSpoolerParams ΓòÉΓòÉΓòÉ

pszSpoolerParams (PSZ)
   Spooler parameters.

   This is a parameter string for the spooler for queued output, and is
   optional. It has the following options, which must be separated by one or
   more blanks:

   FORM=f Specifies a form name `f'. This must be a valid form name for the
         printer. If more than one form is needed for the job, all of the
         required form names are supplied, separated by commas, as
         FORM=aaaa,bbbb,cccc; the first one is the one that is to be used
         first. See HCINFO.
         A form name can be enclosed in double quotes to permit form names to
         contain the characters ',' ';' or '='. For example,

                  FORM="A","A4 with heading","C,D"
         calls for three forms: 'A', 'A4 with heading' and 'C,D'. If a double
         quote is part of a form name, it should be supplied twice.
         If this option is not specified, the data is printed on the forms in
         use, when this print job is ready to be printed.

   PRTY=n Specifies a priority in the range 1 through 99, with 99 being the
         highest. If it is not specified, a default priority of 50 is used.


ΓòÉΓòÉΓòÉ <hidden> pszNetworkParams ΓòÉΓòÉΓòÉ

pszNetworkParams (PSZ)
   Network parameters.

   This is a parameter string for the network program for queued output, and is
   optional. The format of the parameter string is keyword=value, and the
   following keyword is defined (additional ones can be defined by the network
   program):

   USER=u Specifies the user identifier `u'. If it is not specified, a null
         user identifier is used.


ΓòÉΓòÉΓòÉ 4.46. DLGTEMPLATE ΓòÉΓòÉΓòÉ

DLGTEMPLATE Dialog-template structure.

typedef struct _DLGTEMPLATE {
USHORT      cbTemplate;        /* Length of template  */
USHORT      type;              /* Template format type  */
USHORT      codepage;          /* Code page  */
USHORT      offadlgti;         /* Offset to dialog items  */
USHORT      fsTemplateStatus;  /* Template status  */
USHORT      iItemFocus;        /* Index of item to receive focus initially  */
USHORT      coffPresParams;    /* Count of presentation-parameter offsets  */
DLGTITEM    adlgti[1];         /* Start of dialog items  */
 } DLGTEMPLATE;


ΓòÉΓòÉΓòÉ <hidden> cbTemplate ΓòÉΓòÉΓòÉ

cbTemplate (USHORT)
   Length of template.


ΓòÉΓòÉΓòÉ <hidden> type ΓòÉΓòÉΓòÉ

type (USHORT)
   Template format type.


ΓòÉΓòÉΓòÉ <hidden> codepage ΓòÉΓòÉΓòÉ

codepage (USHORT)
   Code page.


ΓòÉΓòÉΓòÉ <hidden> offadlgti ΓòÉΓòÉΓòÉ

offadlgti (USHORT)
   Offset to dialog items.


ΓòÉΓòÉΓòÉ <hidden> fsTemplateStatus ΓòÉΓòÉΓòÉ

fsTemplateStatus (USHORT)
   Template status.


ΓòÉΓòÉΓòÉ <hidden> iItemFocus ΓòÉΓòÉΓòÉ

iItemFocus (USHORT)
   Index of item to receive focus initially.


ΓòÉΓòÉΓòÉ <hidden> coffPresParams ΓòÉΓòÉΓòÉ

coffPresParams (USHORT)
   Count of presentation-parameter offsets.


ΓòÉΓòÉΓòÉ <hidden> adlgti[1] ΓòÉΓòÉΓòÉ

adlgti[1] (DLGTITEM)
   Start of dialog items.


ΓòÉΓòÉΓòÉ 4.47. DLGTITEM ΓòÉΓòÉΓòÉ

DLGTITEM Dialog-item structure.

typedef struct _DLGTITEM {
USHORT    fsItemStatus;   /* Status  */
USHORT    cChildren;      /* Count of children to this dialog item  */
USHORT    cchClassName;   /* Length of class name  */
USHORT    offClassName;   /* Offset to class name  */
USHORT    cchText;        /* Length of text  */
USHORT    offText;        /* Offset to text  */
ULONG     flStyle;        /* Dialog item window style  */
SHORT     x;              /* X-coordinate of origin of dialog-item window  */
SHORT     y;              /* Y-coordinate of origin of dialog-item window  */
SHORT     cx;             /* Dialog-item window width  */
SHORT     cy;             /* Dialog-item window height  */
USHORT    id;             /* Identity  */
USHORT    offPresParams;  /* Reserved  */
USHORT    offCtlData;     /* Offset to control data  */
 } DLGTITEM;


ΓòÉΓòÉΓòÉ <hidden> fsItemStatus ΓòÉΓòÉΓòÉ

fsItemStatus (USHORT)
   Status.


ΓòÉΓòÉΓòÉ <hidden> cChildren ΓòÉΓòÉΓòÉ

cChildren (USHORT)
   Count of children to this dialog item.


ΓòÉΓòÉΓòÉ <hidden> cchClassName ΓòÉΓòÉΓòÉ

cchClassName (USHORT)
   Length of class name.

   If zero, offClassName contains the hexadecimal equivalent of a preregistered
   class name.


ΓòÉΓòÉΓòÉ <hidden> offClassName ΓòÉΓòÉΓòÉ

offClassName (USHORT)
   Offset to class name.

   If cchClassName is nonzero, this is the offset to a NULL-terminated ASCII
   string that contains the classname. If cchClassName is zero, this is of the
   form 0xhhhh, where hhhh is the hexadecimal equivalent of the preregistered
   class name.


ΓòÉΓòÉΓòÉ <hidden> cchText ΓòÉΓòÉΓòÉ

cchText (USHORT)
   Length of text.


ΓòÉΓòÉΓòÉ <hidden> offText ΓòÉΓòÉΓòÉ

offText (USHORT)
   Offset to text.


ΓòÉΓòÉΓòÉ <hidden> flStyle ΓòÉΓòÉΓòÉ

flStyle (ULONG)
   Dialog item window style.

   The high-order 16 bits are the standard WS_* style bits. The low-order 16
   bits are available for class-specific use.


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (SHORT)
   X-coordinate of origin of dialog-item window.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (SHORT)
   Y-coordinate of origin of dialog-item window.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (SHORT)
   Dialog-item window width.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (SHORT)
   Dialog-item window height.


ΓòÉΓòÉΓòÉ <hidden> id ΓòÉΓòÉΓòÉ

id (USHORT)
   Identity.


ΓòÉΓòÉΓòÉ <hidden> offPresParams ΓòÉΓòÉΓòÉ

offPresParams (USHORT)
   Reserved.


ΓòÉΓòÉΓòÉ <hidden> offCtlData ΓòÉΓòÉΓòÉ

offCtlData (USHORT)
   Offset to control data.


ΓòÉΓòÉΓòÉ 4.48. DRAGIMAGE ΓòÉΓòÉΓòÉ

DRAGIMAGE Dragged-object-image structure.

typedef struct _DRAGIMAGE {
USHORT     cb;           /* Structure size  */
USHORT     cptl;         /* Number of points  */
LHANDLE    hImage;       /* Image handle  */
SIZEL      sizlStretch;  /* Dimensions for stretching  */
ULONG      fl;           /* Flags  */
SHORT      cxOffset;     /* X-offset  */
SHORT      cyOffset;     /* Y-offset  */
 } DRAGIMAGE;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (USHORT)
   Structure size.

   Size, in bytes, of the DRAGIMAGE structure.


ΓòÉΓòÉΓòÉ <hidden> cptl ΓòÉΓòÉΓòÉ

cptl (USHORT)
   Number of points.

   The number of points in the point array if fl is specified as DRG_POLYGON.


ΓòÉΓòÉΓòÉ <hidden> hImage ΓòÉΓòÉΓòÉ

hImage (LHANDLE)
   Image handle.

   Handle representing the image to display. The type is determined by fl.


ΓòÉΓòÉΓòÉ <hidden> sizlStretch ΓòÉΓòÉΓòÉ

sizlStretch (SIZEL)
   Dimensions for stretching.

   Specifies the dimensions for stretching when fl is specified as DRG_STRETCH.


ΓòÉΓòÉΓòÉ <hidden> fl ΓòÉΓòÉΓòÉ

fl (ULONG)
   Flags.

   DRG_ICON
      hImage is an HPOINTER.
   DRG_BITMAP
      hImage is an HBITMAP.
   DRG_POLYGON
      hImage is a pointer to an array of points that will be connected with
      GpiPolyLine to form a polygon.  The first point of the array should be
      (0,0), and the other points should be placed relative to this position.
   DRG_STRETCH
      If DRG_ICON or DRG_BITMAP is specified, the image is expanded or
      compressed to the dimensions specified by sizlStretch.
   DRG_TRANSPARENT
      If DRG_ICON is specified, an outline of the icon is generated and
      displayed instead of the original icon.
   DRG_CLOSED
      If DRG_POLYGON is specified, a closed polygon is formed by moving the
      current position to the last point in the array before calling
      GpiPolyLine.


ΓòÉΓòÉΓòÉ <hidden> cxOffset ΓòÉΓòÉΓòÉ

cxOffset (SHORT)
   X-offset.

   X-offset from the pointer hot spot to the origin of the image.


ΓòÉΓòÉΓòÉ <hidden> cyOffset ΓòÉΓòÉΓòÉ

cyOffset (SHORT)
   Y-offset.

   Y-offset from the pointer hot spot to the origin of the image.


ΓòÉΓòÉΓòÉ 4.49. DRAGINFO ΓòÉΓòÉΓòÉ

DRAGINFO Drag-information structure.

typedef struct _DRAGINFO {
ULONG     cbDraginfo;   /* Structure size  */
USHORT    cbDragitem;   /* DRAGITEM structures sizes  */
USHORT    usOperation;  /* Modified drag operations  */
HWND      hwndSource;   /* Window handle  */
SHORT     xDrop;        /* X-coordinate  */
SHORT     yDrop;        /* Y-coordinate  */
USHORT    cditem;       /* Count of DRAGITEM structures  */
USHORT    usReserved;   /* Reserved  */
 } DRAGINFO;


ΓòÉΓòÉΓòÉ <hidden> cbDraginfo ΓòÉΓòÉΓòÉ

cbDraginfo (ULONG)
   Structure size.

   Size, in bytes, of the structure. The size includes the array of DRAGITEM
   structures.


ΓòÉΓòÉΓòÉ <hidden> cbDragitem ΓòÉΓòÉΓòÉ

cbDragitem (USHORT)
   DRAGITEM structures sizes.

   Size, in bytes, of each DRAGITEM structure.


ΓòÉΓòÉΓòÉ <hidden> usOperation ΓòÉΓòÉΓòÉ

usOperation (USHORT)
   Modified drag operations.

   An application can define its own modified drag operations for use when
   simulating a drop. These operations must have a value greater than
   DO_UNKNOWN.

   DO_DEFAULT
      Execute the default drag operation. No modifier keys are pressed.
   DO_COPY
      Execute a copy operation. The Ctrl key is pressed.
   DO_LINK
      Execute a link operation. The Ctrl+Shift keys are pressed.
   DO_MOVE
      Execute a move operation. The Shift key is pressed.
   DO_UNKNOWN
      An undefined combination of modifier keys is pressed.


ΓòÉΓòÉΓòÉ <hidden> hwndSource ΓòÉΓòÉΓòÉ

hwndSource (HWND)
   Window handle.

   Window handle of the source of the drag operation.


ΓòÉΓòÉΓòÉ <hidden> xDrop ΓòÉΓòÉΓòÉ

xDrop (SHORT)
   X-coordinate.

   X-coordinate of drop point expressed in desktop coordinates.


ΓòÉΓòÉΓòÉ <hidden> yDrop ΓòÉΓòÉΓòÉ

yDrop (SHORT)
   Y-coordinate.

   Y-coordinate of drop point expressed in desktop coordinates.


ΓòÉΓòÉΓòÉ <hidden> cditem ΓòÉΓòÉΓòÉ

cditem (USHORT)
   Count of DRAGITEM structures.


ΓòÉΓòÉΓòÉ <hidden> usReserved ΓòÉΓòÉΓòÉ

usReserved (USHORT)
   Reserved.


ΓòÉΓòÉΓòÉ 4.50. DRAGITEM ΓòÉΓòÉΓòÉ

DRAGITEM Drag-object structure.

typedef struct _DRAGITEM {
HWND      hwndItem;           /* Window handle  */
ULONG     ulItemID;           /* Item information  */
HSTR      hstrType;           /* String handle  */
HSTR      hstrRMF;            /* String handle  */
HSTR      hstrContainerName;  /* String handle  */
HSTR      hstrSourceName;     /* String handle  */
HSTR      hstrTargetName;     /* String handle  */
SHORT     cxOffset;           /* X-offset  */
SHORT     cyOffset;           /* Y-offset  */
USHORT    fsControl;          /* Source-object control flags  */
USHORT    fsSupportedOps;     /* Supported operations  */
 } DRAGITEM;


ΓòÉΓòÉΓòÉ <hidden> hwndItem ΓòÉΓòÉΓòÉ

hwndItem (HWND)
   Window handle.

   Window handle of the source of the drag operation.


ΓòÉΓòÉΓòÉ <hidden> ulItemID ΓòÉΓòÉΓòÉ

ulItemID (ULONG)
   Item information.

   Information used by the source to identify the object being dragged.


ΓòÉΓòÉΓòÉ <hidden> hstrType ΓòÉΓòÉΓòÉ

hstrType (HSTR)
   String handle.

   String handle of the object type. The string handle must be created using
   the DrgAddStrHandle function. The string is of the form: type[,type...] .
   The first type in the list must be the true type of the object.

   The following types are used by the OS/2* shell:

   DRT_ASM
      Assembler code
   DRT_BASIC
      BASIC code
   DRT_BINDATA
      Binary data
   DRT_BITMAP
      Bit map
   DRT_C
      C code
   DRT_COBOL
      COBOL code
   DRT_DLL
      Dynamic link library
   DRT_DOSCMD
      DOS command file
   DRT_EXE
      Executable file
   DRT_FONT
      Font
   DRT_FORTRAN
      FORTRAN code
   DRT_ICON
      Icon
   DRT_LIB
      Library
   DRT_METAFILE
      Metafile
   DRT_OS2CMD
      OS/2 command file
   DRT_PASCAL
      Pascal code
   DRT_RESOURCE
      Resource file
   DRT_TEXT
      Text
   DRT_UNKNOWN
      Unknown type.


ΓòÉΓòÉΓòÉ <hidden> hstrRMF ΓòÉΓòÉΓòÉ

hstrRMF (HSTR)
   String handle.

   String handle of the rendering mechanism and format. The string handle must
   be created using the DrgAddStrHandle function. The string is of the form:
   mechfmt[,mechfmt...] , where mechfmt can be in either of the following
   formats:

    1. <mechanism(1),format(1)>
    2. (mechanism(1)[, mechanism(n)...]) x (format(1)[,format(n)...])
   The first mechanism/format pair must be the native rendering mechanism and
   format of the object.

   Valid mechanisms are:

   "DRM_DDE"
      Dynamic data exchange
   "DRM_OBJECT"
      Item being dragged is a workplace object.
   "DRM_OS2FILE"
      OS/2 file
   "DRM_PRINT"
      Object can be printed using direct manipulation.

      Valid formats are:
   "DRF_BITMAP"
      OS/2 bit map
   "DRF_DIB"
      DIB
   "DRF_DIF"
      DIF
   "DRF_DSPBITMAP"
      Stream of bit-map bits
   "DRF_METAFILE"
      Metafile
   "DRF_OEMTEXT"
      OEM text
   "DRF_OWNERDISPLAY"
      Bit stream
   "DRF_PTRPICT"
      Printer picture
   "DRF_RTF"
      Rich text
   "DRF_SYLK"
      SYLK
   "DRF_TEXT"
      NULL-terminated string
   "DRF_TIFF"
      TIFF
   "DRF_UNKNOWN"
      Unknown format.


ΓòÉΓòÉΓòÉ <hidden> hstrContainerName ΓòÉΓòÉΓòÉ

hstrContainerName (HSTR)
   String handle.

   String handle of the name of the container holding the source object. The
   string handle must be created using the DrgAddStrHandle function.


ΓòÉΓòÉΓòÉ <hidden> hstrSourceName ΓòÉΓòÉΓòÉ

hstrSourceName (HSTR)
   String handle.

   String handle of the name of the source object. The string handle must be
   created using the DrgAddStrHandle function.


ΓòÉΓòÉΓòÉ <hidden> hstrTargetName ΓòÉΓòÉΓòÉ

hstrTargetName (HSTR)
   String handle.

   String handle of the suggested name of the object at the target. It is the
   responsibility of the source of the drag operation to create this string
   handle before calling DrgDrag.


ΓòÉΓòÉΓòÉ <hidden> cxOffset ΓòÉΓòÉΓòÉ

cxOffset (SHORT)
   X-offset.

   X-offset from the pointer hot spot to the origin of the image that
   represents this object. This value is copied from cxOffset in the DRAGIMAGE
   structure by DrgDrag.


ΓòÉΓòÉΓòÉ <hidden> cyOffset ΓòÉΓòÉΓòÉ

cyOffset (SHORT)
   Y-offset.

   Y-offset from the pointer hot spot to the origin of the image that
   represents this object. This value is copied from cyOffset in the DRAGIMAGE
   structure by DrgDrag.


ΓòÉΓòÉΓòÉ <hidden> fsControl ΓòÉΓòÉΓòÉ

fsControl (USHORT)
   Source-object control flags.

   DC_OPEN
      Object is open
   DC_REF
      Reference to another object
   DC_GROUP
      Group of objects
   DC_CONTAINER
      Container of other objects
   DC_PREPARE
      Source requires a DM_RENDERPREPARE message before it establishes a data
      transfer conversation
   DC_REMOVEABLEMEDIA
      Object is on removable media, or object cannot be recovered after a move
      operation.


ΓòÉΓòÉΓòÉ <hidden> fsSupportedOps ΓòÉΓòÉΓòÉ

fsSupportedOps (USHORT)
   Supported operations.

   Direct manipulation operations supported by the source object:

   DO_COPYABLE
      Source supports DO_COPY
   DO_LINKABLE
      Source supports DO_LINK
   DO_MOVEABLE
      Source supports DO_MOVE.


ΓòÉΓòÉΓòÉ 4.51. DRAGTRANSFER ΓòÉΓòÉΓòÉ

DRAGTRANSFER Drag-conversation structure.

typedef struct _DRAGTRANSFER {
ULONG        cb;                /* Structure size  */
HWND         hwndClient;        /* Window handle  */
PDRAGITEM    pditem;            /* Pointer  */
HSTR         hstrSelectedRMF;   /* String handle  */
HSTR         hstrRenderToName;  /* String handle  */
ULONG        ulTargetInfo;      /* Reserved  */
USHORT       usOperation;       /* The operation  */
USHORT       fsReply;           /* Reply flags  */
 } DRAGTRANSFER;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   Size, in bytes, of the structure.


ΓòÉΓòÉΓòÉ <hidden> hwndClient ΓòÉΓòÉΓòÉ

hwndClient (HWND)
   Window handle.

   Handle of the client window. This can be the target window or a window that
   represents an object in a container that was dropped on.


ΓòÉΓòÉΓòÉ <hidden> pditem ΓòÉΓòÉΓòÉ

pditem (PDRAGITEM)
   Pointer.

   Pointer to the DRAGITEM structure that is to be rendered. This structure
   must exist within the DRAGINFO structure that was passed in the DM_DROP
   message.


ΓòÉΓòÉΓòÉ <hidden> hstrSelectedRMF ΓòÉΓòÉΓòÉ

hstrSelectedRMF (HSTR)
   String handle.

   The string handle for the selected rendering mechanism and format for the
   transfer operation. This handle must be created using DrgAddStrHandle. The
   target is responsible for deleting this handle when the conversation is
   complete. The string is in the format:  <mechanism,format>.


ΓòÉΓòÉΓòÉ <hidden> hstrRenderToName ΓòÉΓòÉΓòÉ

hstrRenderToName (HSTR)
   String handle.

   A string handle representing the name where the source will place, and the
   target will find, the data that is rendered. The target is responsible for
   deleting this string handle when the conversation terminates.  The contents
   of this field vary according to the rendering mechanism.  See hstrRMF in
   DRAGITEM.

   OS/2 File
      The string handle represents the fully qualified name of the file where
      the rendering will be placed.
   DDE
      This field is not used.
   Print
      This field is not used.


ΓòÉΓòÉΓòÉ <hidden> ulTargetInfo ΓòÉΓòÉΓòÉ

ulTargetInfo (ULONG)
   Reserved.

   Reserved for use by the target. The target can use this field for
   information about the object and rendering operation.


ΓòÉΓòÉΓòÉ <hidden> usOperation ΓòÉΓòÉΓòÉ

usOperation (USHORT)
   The operation.

   Values are:

   DO_COPY
      Execute a copy operation.
   DO_LINK
      Execute a link operation.
   DO_MOVE
      Execute a move operation.
   OTHER
      Execute an application-defined operation.


ΓòÉΓòÉΓòÉ <hidden> fsReply ΓòÉΓòÉΓòÉ

fsReply (USHORT)
   Reply flags.

   Replay flags for the message. These flags can be set as follows:

   DMFL_NATIVERENDER
      The source does not support rendering for this object.  A source should
      not set this flag unless it provides sufficient information at the time
      of the drop for the target to perform the rendering operation. The target
      must send DM_ENDCONVERSATION to the source after carrying out the
      rendering operation, or when it elects not to do a native rendering.
   DMFL_RENDERRETRY
      The source supports rendering for the object, but does not support the
      selected rendering mechanism and format.  The target can try another
      mechanism and format by sending another DM_RENDER message.  If the target
      does not retry, it must send a DM_RENDERCOMPLETE message to the source.
      This flag is set in conjunction with the DMFL_NATIVERENDER flag.


ΓòÉΓòÉΓòÉ 4.52. DRIVDATA ΓòÉΓòÉΓòÉ

DRIVDATA Driver-data structure.

typedef struct _DRIVDATA {
LONG    cb;                /* Length  */
LONG    lVersion;          /* Version  */
CHAR    szDeviceName[32];  /* Device name  */
CHAR    abGeneralData[1];  /* General data  */
 } DRIVDATA;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (LONG)
   Length.

   The length of the structure.


ΓòÉΓòÉΓòÉ <hidden> lVersion ΓòÉΓòÉΓòÉ

lVersion (LONG)
   Version.

   The version number of the data. Version numbers are defined by particular PM
   device drivers.


ΓòÉΓòÉΓòÉ <hidden> szDeviceName[32] ΓòÉΓòÉΓòÉ

szDeviceName[32] (CHAR)
   Device name.

   A string in a 32-byte field, identifying the particular device (model
   number, and so on). Again, valid values are defined by PM device drivers.


ΓòÉΓòÉΓòÉ <hidden> abGeneralData[1] ΓòÉΓòÉΓòÉ

abGeneralData[1] (CHAR)
   General data.

   Data as defined by the Presentation Manager device driver.
   The data type of this field is defined by the Presentation Manager device
   driver. It does not contain pointers, as these are not necessarily valid
   when passed to the device driver.


ΓòÉΓòÉΓòÉ 4.53. DRIVPROPS ΓòÉΓòÉΓòÉ

DRIVPROPS Printer driver property structure.

typedef struct _DRIVPROPS {
PSZ      pszKeyName;  /* key name  */
ULONG    cbBuf;       /* The length of the key data  */
PVOID    pBuf;        /* The key data  */
 } DRIVPROPS;


ΓòÉΓòÉΓòÉ <hidden> pszKeyName ΓòÉΓòÉΓòÉ

pszKeyName (PSZ)
   key name

   This is the key name for an individual property. For example "FORMS".


ΓòÉΓòÉΓòÉ <hidden> cbBuf ΓòÉΓòÉΓòÉ

cbBuf (ULONG)
   The length of the key data.


ΓòÉΓòÉΓòÉ <hidden> pBuf ΓòÉΓòÉΓòÉ

pBuf (PVOID)
   The key data.

   This is the data associated with the key name. For example "LETTER, LEGAL,
   LEDGER".


ΓòÉΓòÉΓòÉ 4.54. ENTRYFDATA ΓòÉΓòÉΓòÉ

ENTRYFDATA Entry-field control data structure.

typedef struct _ENTRYFDATA {
USHORT    cb;            /* Length of control data in bytes  */
USHORT    cchEditLimit;  /* Edit limit  */
USHORT    ichMinSel;     /* Minimum selection  */
USHORT    ichMaxSel;     /* Maximum selection  */
 } ENTRYFDATA;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (USHORT)
   Length of control data in bytes.

   The length of the control data for an entry field control.


ΓòÉΓòÉΓòÉ <hidden> cchEditLimit ΓòÉΓòÉΓòÉ

cchEditLimit (USHORT)
   Edit limit.

   This is the maximum number of characters that can be entered into the entry
   field control.
   If the operator tries to enter more text into an entry field control than is
   specified by the text limit set by the EM_SETTEXTLIMIT message, the entry
   field control indicates the error by sounding the alarm and does not accept
   the characters.


ΓòÉΓòÉΓòÉ <hidden> ichMinSel ΓòÉΓòÉΓòÉ

ichMinSel (USHORT)
   Minimum selection.


ΓòÉΓòÉΓòÉ <hidden> ichMaxSel ΓòÉΓòÉΓòÉ

ichMaxSel (USHORT)
   Maximum selection.

   The ichMinSel and ichMaxSel parameters identify the current selection within
   the entry field control. Characters within the text with byte offsets less
   than the ichMaxSel parameter and greater than or equal to the ichMinSel
   parameter are the current selection. The cursor is positioned immediately
   before the character identified by the ichMaxSel parameter.
   If the ichMinSel parameter is equal to the ichMaxSel parameter, the current
   selection becomes the insertion point.
   If the ichMinSel parameter is equal to 0 and the ichMaxSel is greater than
   or equal to text limit set by the EM_SETTEXTLIMIT message, the entire text
   is selected.


ΓòÉΓòÉΓòÉ 4.55. ERRINFO ΓòÉΓòÉΓòÉ

ERRINFO Error-information structure.

typedef struct _ERRINFO {
ULONG      cbFixedErrInfo;  /* Length of fixed data to this structure  */
ERRORID    idError;         /* Error identity  */
ULONG      cDetailLevel;    /* Number of levels of detail  */
ULONG      offaoffszMsg;    /* Offset to the array of message offsets  */
ULONG      offBinaryData;   /* Offset to the binary data  */
 } ERRINFO;


ΓòÉΓòÉΓòÉ <hidden> cbFixedErrInfo ΓòÉΓòÉΓòÉ

cbFixedErrInfo (ULONG)
   Length of fixed data to this structure.


ΓòÉΓòÉΓòÉ <hidden> idError ΓòÉΓòÉΓòÉ

idError (ERRORID)
   Error identity.

   This is identical to the value returned by the WinGetLastError function.


ΓòÉΓòÉΓòÉ <hidden> cDetailLevel ΓòÉΓòÉΓòÉ

cDetailLevel (ULONG)
   Number of levels of detail.

   This is the number of entries in the array of words pointed to by the
   following field. One level of detail is provided.


ΓòÉΓòÉΓòÉ <hidden> offaoffszMsg ΓòÉΓòÉΓòÉ

offaoffszMsg (ULONG)
   Offset to the array of message offsets.


ΓòÉΓòÉΓòÉ <hidden> offBinaryData ΓòÉΓòÉΓòÉ

offBinaryData (ULONG)
   Offset to the binary data.

   This can contain additional information relating to the error.


ΓòÉΓòÉΓòÉ 4.56. ERRORID ΓòÉΓòÉΓòÉ

ERRORID Error identity.

typedef ULONG ERRORID;


ΓòÉΓòÉΓòÉ 4.57. ESCSETMODE ΓòÉΓòÉΓòÉ

ESCSETMODE Structure for setting printer mode. See DevEscape (DEVESC_SETMODE).

typedef struct _ESCSETMODE {
ULONG     mode;      /* Mode  */
USHORT    codepage;  /* Code page  */
 } ESCSETMODE;


ΓòÉΓòÉΓòÉ <hidden> mode ΓòÉΓòÉΓòÉ

mode (ULONG)
   Mode

   Mode to be set.

   0
      Set mode to specified code page. Any font can be used.


ΓòÉΓòÉΓòÉ <hidden> codepage ΓòÉΓòÉΓòÉ

codepage (USHORT)
   Code page.

   If zero is specified for the code page, the printer is set to the hardware
   default.


ΓòÉΓòÉΓòÉ 4.58. FACENAMEDESC ΓòÉΓòÉΓòÉ

FACENAMEDESC Face-name description structure. See GpiQueryFaceString.

typedef struct _FACENAMEDESC {
USHORT    usSize;         /* Length of structure  */
USHORT    usWeightClass;  /* Weight class  */
USHORT    usWidthClass;   /* Width class  */
USHORT    usReserved;     /* Reserved  */
ULONG     flOptions;      /* Other characteristics of the font  */
 } FACENAMEDESC;


ΓòÉΓòÉΓòÉ <hidden> usSize ΓòÉΓòÉΓòÉ

usSize (USHORT)
   Length of structure.


ΓòÉΓòÉΓòÉ <hidden> usWeightClass ΓòÉΓòÉΓòÉ

usWeightClass (USHORT)
   Weight class.

   Indicates the visual weight (thickness of strokes) of the characters in the
   font:

   FWEIGHT_DONT_CARE
      Any font weight satisfies the request.
   FWEIGHT_ULTRA_LIGHT
      Ultra-light.
   FWEIGHT_EXTRA_LIGHT
      Extra-light.
   FWEIGHT_LIGHT
      Light.
   FWEIGHT_SEMI_LIGHT
      Semi-light.
   FWEIGHT_NORMAL
      Medium (normal) weight.
   FWEIGHT_SEMI_BOLD
      Semi-bold.
   FWEIGHT_BOLD
      Bold.
   FWEIGHT_EXTRA_BOLD
      Extra-bold.
   FWEIGHT_ULTRA_BOLD
      Ultra-bold.


ΓòÉΓòÉΓòÉ <hidden> usWidthClass ΓòÉΓòÉΓòÉ

usWidthClass (USHORT)
   Width class.

   Indicates the relative aspect ratio of the characters of the font in
   relation to the normal aspect ratio for this type of font:

   FWIDTH_DONT_CARE
      Any font width satisfies the request.
   FWIDTH_ULTRA_CONDENSED
      Ultra-condensed (50% of normal).
   FWIDTH_EXTRA_CONDENSED
      Extra-condensed (62.5% of normal).
   FWIDTH_CONDENSED
      Condensed (75% of normal).
   FWIDTH_SEMI_CONDENSED
      Semi-condensed (87.5% of normal).
   FWIDTH_NORMAL
      Medium (normal).
   FWIDTH_SEMI_EXPANDED
      Semi-expanded (112.5% of normal).
   FWIDTH_EXPANDED
      Expanded (125% of normal).
   FWIDTH_EXTRA_EXPANDED
      Extra-expanded (150% of normal).
   FWIDTH_ULTRA_EXPANDED
      Ultra-expanded (200% of normal).


ΓòÉΓòÉΓòÉ <hidden> usReserved ΓòÉΓòÉΓòÉ

usReserved (USHORT)
   Reserved.


ΓòÉΓòÉΓòÉ <hidden> flOptions ΓòÉΓòÉΓòÉ

flOptions (ULONG)
   Other characteristics of the font.

   FTYPE_ITALIC
      Italic font required. If not specified, non-italic font required.
   FTYPE_ITALIC_DONT_CARE
      Italic and non-italic fonts can satisfy the request. If this option is
      specified, FTYPE_ITALIC is ignored.
   FTYPE_OBLIQUE
      Oblique font required. If not specified, non-oblique font required.
   FTYPE_OBLIQUE_DONT_CARE
      Oblique and non-oblique fonts can satisfy the request. If this option is
      specified, FTYPE_OBLIQUE is ignored.
   FTYPE_ROUNDED
      Rounded font required. If not specified, non-rounded font required.
   FTYPE_ROUNDED_DONT_CARE
      Rounded and non-rounded fonts can satisfy the request. If this option is
      specified, FTYPE_ROUNDED is ignored.


ΓòÉΓòÉΓòÉ 4.59. FATTRS ΓòÉΓòÉΓòÉ

FATTRS Font-attributes structure.

typedef struct _FATTRS {
USHORT    usRecordLength;        /* Length of record  */
USHORT    fsSelection;           /* Selection indicators  */
LONG      lMatch;                /* Matched-font identity  */
CHAR      szFacename[FACESIZE];  /* Typeface name  */
USHORT    idRegistry;            /* Registry identifier  */
USHORT    usCodePage;            /* Code page  */
LONG      lMaxBaselineExt;       /* Maximum baseline extension  */
LONG      lAveCharWidth;         /* Average character width  */
USHORT    fsType;                /* Type indicators  */
USHORT    fsFontUse;             /* Font-use indicators  */
 } FATTRS;


ΓòÉΓòÉΓòÉ <hidden> usRecordLength ΓòÉΓòÉΓòÉ

usRecordLength (USHORT)
   Length of record.


ΓòÉΓòÉΓòÉ <hidden> fsSelection ΓòÉΓòÉΓòÉ

fsSelection (USHORT)
   Selection indicators.

   Flags causing the following features to be simulated by the system.

   Note:  If an italic flag is applied to a font that is itself defined as
          italic, the font is slanted further by italic simulation.
          Underscore or strikeout lines are drawn using the appropriate
          attributes (for example, color) from the character bundle (see the
          CHARBUNDLE datatype), not the line bundle (see LINEBUNDLE). The width
          of the line, and the vertical position of the line in font space, are
          determined by the font. Horizontally, the line starts from a point in
          font space directly above or below the start point of each character,
          and extends to a point directly above or below the escapement point
          for that character. For this purpose, the start and escapement points
          are those applicable to left-to-right or right-to-left character
          directions (see GpiSetCharDirection), even if the string is currently
          being drawn in a top-to-bottom or bottom-to-top direction. For
          left-to-right or right-to-left directions (only), any white space
          generated by the character extra and character break extra attributes
          (see GpiSetCharExtra and GpiSetCharBreakExtra), as well as increments
          provided by the vector of increments on GpiCharStringPos and
          GpiCharStringPosAt, is also underlined/overstruck, so that in these
          cases the line is continuous for the string.

   FATTR_SEL_ITALIC
      Generate italic font.
   FATTR_SEL_UNDERSCORE
      Generate underscored font.
   FATTR_SEL_BOLD
      Generate bold font. (Note that the resulting characters are wider than
      those in the original font.)
   FATTR_SEL_STRIKEOUT
      Generate font with overstruck characters.
   FATTR_SEL_OUTLINE
      Use an outline font with hollow characters.

      If this flag is not set, outline font characters are filled. Setting this
      flag normally gives better performance, and for sufficiently small
      characters there may be little visual difference.


ΓòÉΓòÉΓòÉ <hidden> lMatch ΓòÉΓòÉΓòÉ

lMatch (LONG)
   Matched-font identity.


ΓòÉΓòÉΓòÉ <hidden> szFacename[FACESIZE] ΓòÉΓòÉΓòÉ

szFacename[FACESIZE] (CHAR)
   Typeface name.

   The typeface name of the font, for example, Tms Rmn.


ΓòÉΓòÉΓòÉ <hidden> idRegistry ΓòÉΓòÉΓòÉ

idRegistry (USHORT)
   Registry identifier.

   Font registry identifier (zero if unknown).


ΓòÉΓòÉΓòÉ <hidden> usCodePage ΓòÉΓòÉΓòÉ

usCodePage (USHORT)
   Code page.

   If zero, the current Gpi code page (see GpiSetCp) is used. A subsequent
   GpiSetCp function changes the code page used for this logical font.


ΓòÉΓòÉΓòÉ <hidden> lMaxBaselineExt ΓòÉΓòÉΓòÉ

lMaxBaselineExt (LONG)
   Maximum baseline extension.

   For raster fonts, this should be the height of the required font, in world
   coordinates.
   For outline fonts, this should be zero.


ΓòÉΓòÉΓòÉ <hidden> lAveCharWidth ΓòÉΓòÉΓòÉ

lAveCharWidth (LONG)
   Average character width.

   For raster fonts, this should be the width of the required font, in world
   coordinates.
   For outline fonts, this should be zero.


ΓòÉΓòÉΓòÉ <hidden> fsType ΓòÉΓòÉΓòÉ

fsType (USHORT)
   Type indicators.

   FATTR_TYPE_KERNING
      Enable kerning (PostScript only).
   FATTR_TYPE_MBCS
      Font for mixed single/double-byte code pages.
   FATTR_TYPE_DBCS
      Font for double-byte code pages.
   FATTR_TYPE_ANTIALIASED
      Antialiased font required. Only valid if supported by the device driver.


ΓòÉΓòÉΓòÉ <hidden> fsFontUse ΓòÉΓòÉΓòÉ

fsFontUse (USHORT)
   Font-use indicators.

   These flags indicate how the font is to be used. They affect presentation
   speed and font quality.

   FATTR_FONTUSE_NOMIX
      Text is not mixed with graphics and can be written without regard to any
      interaction with graphics objects.
   FATTR_FONTUSE_OUTLINE
      Select an outline (vector) font. The font characters can be used as part
      of a path definition.

      If this flag is not set, an outline font might or might not be selected.
      If an outline font is selected, however, character widths are rounded to
      an integral number of pels.
   FATTR_FONTUSE_TRANSFORMABLE
      Characters can be transformed (for example, scaled, rotated, or sheared).


ΓòÉΓòÉΓòÉ 4.60. FDATE ΓòÉΓòÉΓòÉ

FDATE Date data structure for file-system functions.

typedef struct _FDATE {
USHORT    day:5;          /* Day */
USHORT    month:4;        /* Month */
USHORT    year:7;         /* Years since 1980 */
 } FDATE;


ΓòÉΓòÉΓòÉ <hidden> day:5 ΓòÉΓòÉΓòÉ

day:5 (USHORT)

   Binary day for directory entry.


ΓòÉΓòÉΓòÉ <hidden> month:4 ΓòÉΓòÉΓòÉ

month:4 (USHORT)

   Binary month for directory entry.


ΓòÉΓòÉΓòÉ <hidden> year:7 ΓòÉΓòÉΓòÉ

year:7 (USHORT)

   The number of years since 1980 for this directory entry.


ΓòÉΓòÉΓòÉ 4.61. FFDESCS ΓòÉΓòÉΓòÉ

FFDESCS Font-file descriptor.

typedef CHAR FFDESCS[2][FACESIZE];


ΓòÉΓòÉΓòÉ 4.62. FFDESCS2 ΓòÉΓòÉΓòÉ

FFDESCS2 Font-file descriptor.

typedef struct _FFDESCS2 {
ULONG    cbLength;          /* Structure length  */
ULONG    cbFacenameOffset;  /* Offset of Facename in the structure  */
BYTE     abFamilyName[1];   /* Family name  */
 } FFDESCS2;


ΓòÉΓòÉΓòÉ <hidden> cbLength ΓòÉΓòÉΓòÉ

cbLength (ULONG)
   Structure length.

   cbLength is the overall length of the FFDESCS2 structure. It is always
   rounded up to a multiple of four.


ΓòÉΓòÉΓòÉ <hidden> cbFacenameOffset ΓòÉΓòÉΓòÉ

cbFacenameOffset (ULONG)
   Offset of Facename in the structure.

   The facename is a null terminated string. It starts at cbFacenameOffset
   bytes offset into FFDESCS2.


ΓòÉΓòÉΓòÉ <hidden> abFamilyName[1] ΓòÉΓòÉΓòÉ

abFamilyName[1] (BYTE)
   Family name.

   abFamilyName[1] is a null terminated string.


ΓòÉΓòÉΓòÉ 4.63. FIELDINFO ΓòÉΓòÉΓòÉ

FIELDINFO Structure that contains information about column data in the details
view of the container control. The details view displays each FIELDINFO
structure as a column of data that contains specific information about each
container record. For example, one FIELDINFO structure, or column, might
contain icons or bit maps that represent each container record. Another
FIELDINFO structure might contain the date or time that each container record
was created.

typedef struct _FIELDINFO {
ULONG              cb;              /* Structure size  */
ULONG              flData;          /* Data attributes  */
ULONG              flTitle;         /* Attributes of column headings  */
PVOID              pTitleData;      /* Column heading data  */
ULONG              offStruct;       /* Structure offset  */
PVOID              pUserData;       /* Pointer  */
struct _FIELDINFO *pNextFieldInfo;  /* Pointer  */
ULONG              cxWidth;         /* Column width  */
 } FIELDINFO;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   The size (in bytes) of the FIELDINFO structure.


ΓòÉΓòÉΓòÉ <hidden> flData ΓòÉΓòÉΓòÉ

flData (ULONG)
   Data attributes.

   Attributes of the data in a field.

   o Specify one of the following for each column to choose the type of data
     that is displayed in each column:

      CFA_BITMAPORICON
         The column contains bit-map or icon data.
      CFA_STRING
         Character or text data is displayed in this column.
      CFA_ULONG
         Unsigned number data is displayed in this column. National Language
         Support (NLS) is enabled for number format.
      CFA_DATE
         The data in the column is displayed in date format. National Language
         Support (NLS) is enabled for date format. Use the data structure
         described in CDATE.
      CFA_TIME
         The data in the column is displayed in time format. National Language
         Support (NLS) is enabled for time format. Use the data structure
         described in CTIME.

   o Specify any or all of the following column attributes:

      CFA_HORZSEPARATOR
         A horizontal separator is provided beneath column headings.
      CFA_SEPARATOR
         A vertical separator is drawn after this column.
      CFA_OWNER
         Ownerdraw is enabled for this container column.
      CFA_INVISIBLE
         Invisible container column. The default is visible.
      CFA_FIREADONLY
         Prevents text in a FIELDINFO data structure (text in a column) from
         being edited directly. This attribute applies only to columns for
         which the CFA_STRING attribute has been specified.

   o Specify one of the following for each column to vertically position data
     in that column:

      CFA_TOP
         Top-justifies field data.
      CFA_BOTTOM
         Bottom-justifies field data.
      CFA_VCENTER
         Vertically centers field data. This is the default.

   o Specify one of the following for each column to horizontally position data
     in that column. These attributes can be combined with the attributes used
     for vertical positioning of column data by using an OR operator (|).

      CFA_CENTER
         Horizontally centers field data.
      CFA_LEFT
         Left-justifies field data. This is the default.
      CFA_RIGHT
         Right-justifies field data.


ΓòÉΓòÉΓòÉ <hidden> flTitle ΓòÉΓòÉΓòÉ

flTitle (ULONG)
   Attributes of column headings.

   o Specify the following if icon or bit-map data is to be displayed in the
     column heading:

      CFA_BITMAPORICON
         The column heading contains icon or bit-map data. If CFA_BITMAPORICON
         is not specified, any data that is assigned to a column heading is
         assumed to be character or text data.

   o Specify the following to prevent direct editing of a column heading:

      CFA_FITITLEREADONLY
         Prevents a column heading from being edited directly.

   o Specify one of the following for each column heading to vertically
     position data in that column heading:

      CFA_TOP
         Top-justifies column headings.
      CFA_BOTTOM
         Bottom-justifies column headings.
      CFA_VCENTER
         Vertically centers column headings. This is the default.

   o Specify one of the following for each column heading to horizontally
     position data in that column heading. These attributes can be combined
     with the attributes used for vertical positioning of column heading data
     by using an OR operator (|).

      CFA_CENTER
         Horizontally centers column headings.
      CFA_LEFT
         Left-justifies column headings. This is the default.
      CFA_RIGHT
         Right-justifies column headings.


ΓòÉΓòÉΓòÉ <hidden> pTitleData ΓòÉΓòÉΓòÉ

pTitleData (PVOID)
   Column heading data.

   Column heading data, which can be a text string, or an icon or bit map. The
   default is a text string. If the flTitle field is set to the
   CFA_BITMAPORICON attribute, this must be an icon or bit map.


ΓòÉΓòÉΓòÉ <hidden> offStruct ΓòÉΓòÉΓòÉ

offStruct (ULONG)
   Structure offset.

   Offset from the beginning of a RECORDCORE structure to the data that is
   displayed in this column.

   Note:  If the CCS_MINIRECORDCORE style bit is specified when a container is
   created, then MINIRECORDCORE should be used instead of RECORDCORE and
   PMINIRECORDCORE should be used instead of PRECORDCORE in all applicable data
   structures and messages.


ΓòÉΓòÉΓòÉ <hidden> pUserData ΓòÉΓòÉΓòÉ

pUserData (PVOID)
   Pointer.

   Pointer to user data.


ΓòÉΓòÉΓòÉ <hidden> pNextFieldInfo ΓòÉΓòÉΓòÉ

pNextFieldInfo (struct _FIELDINFO *)
   Pointer to the next linked FIELDINFO data structure.


ΓòÉΓòÉΓòÉ <hidden> cxWidth ΓòÉΓòÉΓòÉ

cxWidth (ULONG)
   Column width.

   Used to specify the width of a column. The default is an automatically sized
   column that is always the width of its widest element. If this field is set
   and the data is too wide, the data is truncated.


ΓòÉΓòÉΓòÉ 4.64. FIELDINFOINSERT ΓòÉΓòÉΓòÉ

FIELDINFOINSERT Structure that contains information about the FIELDINFO
structure or structures that are being inserted into a container. This
structure is used in the CM_INSERTDETAILFIELDINFO container message only.

typedef struct _FIELDINFOINSERT {
ULONG         cb;                    /* Structure size  */
PFIELDINFO    pFieldInfoOrder;       /* Column order  */
ULONG         fInvalidateFieldInfo;  /* Update flag  */
ULONG         cFieldInfoInsert;      /* Number of columns  */
 } FIELDINFOINSERT;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   The size (in bytes) of the FIELDINFOINSERT structure.


ΓòÉΓòÉΓòÉ <hidden> pFieldInfoOrder ΓòÉΓòÉΓòÉ

pFieldInfoOrder (PFIELDINFO)
   Column order.

   Orders the FIELDINFO structure or structures relative to other FIELDINFO
   structures in the container. The values can be:

   CMA_FIRST
      Places a FIELDINFO structure, or list of FIELDINFO structures, at the
      front of the list of columns.
   CMA_END
      Places a FIELDINFO structure, or list of FIELDINFO structures, at the end
      of the list of columns.
   Other
      Pointer to a FIELDINFO structure that this structure, or list of
      structures, is to be inserted after.


ΓòÉΓòÉΓòÉ <hidden> fInvalidateFieldInfo ΓòÉΓòÉΓòÉ

fInvalidateFieldInfo (ULONG)
   Update flag.

   Flag that indicates an automatic display update after the FIELDINFO
   structures are inserted.

   TRUE
      The display is automatically updated after FIELDINFO structures are
      inserted.
   FALSE
      The application must send the CM_INVALIDATEDETAILFIELDINFO message after
      the FIELDINFO structures are inserted.


ΓòÉΓòÉΓòÉ <hidden> cFieldInfoInsert ΓòÉΓòÉΓòÉ

cFieldInfoInsert (ULONG)
   Number of columns.

   The number of FIELDINFO structures to be inserted. The cFieldInfoInsert
   field value must be greater than 0.


ΓòÉΓòÉΓòÉ 4.65. FILEDLG ΓòÉΓòÉΓòÉ

FILEDLG File-dialog structure.

typedef struct _FILEDLG {
ULONG      cbSize;                            /* Structure size  */
ULONG      fl;                                /* FDS_* flags  */
ULONG      ulUser;                            /* Used by the application  */
LONG       lReturn;                           /* Result code  */
LONG       lSRC;                              /* System return code  */
PSZ        pszTitle;                          /* Dialog title string  */
PSZ        pszOKButton;                       /* OK push button text  */
PFNWP      pfnDlgProc;                        /* Custom dialog procedure  */
PSZ        pszIType;                          /* Extended-attribute type filter  */
PAPSZ      papszITypeList;                    /* Pointer  */
PSZ        pszIDrive;                         /* The initial drive  */
PAPSZ      papszIDriveList;                   /* Pointer  */
HMODULE    hMod;                              /* Module for custom dialog resources  */
CHAR       szFullFile[CCHMAXPATH];            /* Character array  */
PAPSZ      papszFQFilename;                   /* Pointer  */
ULONG      ulFQFCount;                        /* Number of file names  */
USHORT     usDlgId;                           /* Custom dialog ID  */
SHORT      x;                                 /* X-axis dialog position  */
SHORT      y;                                 /* Y-axis dialog position  */
SHORT      sEAType;                           /* Selected extended-attribute type  */
 } FILEDLG;


ΓòÉΓòÉΓòÉ <hidden> cbSize ΓòÉΓòÉΓòÉ

cbSize (ULONG)
   Structure size.

   Size of the structure. This field allows future expansion of the structure
   and must be initialized with the size of the FILEDLG structure.


ΓòÉΓòÉΓòÉ <hidden> fl ΓòÉΓòÉΓòÉ

fl (ULONG)
   FDS_* flags.

   Several flags can be specified to alter the behavior of the dialog.

   Note:  The dialog must be either an "Open" or a "Save As" dialog. If neither
          the FDS_OPEN_DIALOG nor the FDS_SAVEAS_DIALOG flag is set, or if both
          are set, the dialog will return an error.

   FDS_APPLYBUTTON
      An Apply push button is added to the dialog. This is useful in a modeless
      dialog.
   FDS_CENTER
      The dialog is positioned in the center of its parent window, overriding
      any specified x, y position.
   FDS_CUSTOM
      A custom dialog template is used to create the dialog. The hMod and
      usDlgId fields must be initialized.
   FDS_ENABLEFILELB
      When this flag is set, the Files list box on a Save As dialog is enabled.
      When this flag is not set, the Files list box is not enabled for a Save
      As dialog. This is the default.
   FDS_FILTERUNION
      When this flag is set, the dialog uses the union of the string filter and
      the extended-attribute type filter when filtering files for the Files
      list box. When this flag is not set, the list box, by default, uses the
      intersection of the two.
   FDS_HELPBUTTON
      A Help push button of style (BS_HELP|BS_NOPOINTERFOCUS) with an ID of
      DID_HELP_PB is added to the dialog. When this push button is pressed, a
      WM_HELP message is sent to hwndO.
   FDS_INCLUDE_EAS
      If this flag is set, the dialog will always query extended attribute
      information for files as it fills the Files list box. The default is to
      not query the information unless an extended attribute type filter has
      been selected.
   FDS_MODELESS
      When this flag is set, the dialog is modeless; WinFileDlg returns
      immediately after creating the dialog window and returns the window
      handle to the application. The application should treat the dialog as if
      it were created with WinLoadDlg. As in the modal (default) dialog case,
      the return value is found in the lReturn field of the FILEDLG structure
      passed to WinFileDlg.
   FDS_MULTIPLESEL
      When this flag is set, the Files list box for the dialog is a multiple
      selection list box. When this flag is not set, the default is a
      single-selection list box.
   FDS_OPEN_DIALOG
      The dialog is an "Open" dialog when this flag is set.
   FDS_PRELOAD_VOLINFO
      If this flag is set, the dialog will preload the volume information for
      the drives and will preset the current default directory for each drive.
      The default behavior is for the volume label to be blank and the initial
      directory will be the root directory for each drive.
   FDS_SAVEAS_DIALOG
      The dialog is a "Save As" dialog when this flag is set.


ΓòÉΓòÉΓòÉ <hidden> ulUser ΓòÉΓòÉΓòÉ

ulUser (ULONG)
   Used by the application.

   This field can be used by an application that is subclassing the file dialog
   to store its own state information.


ΓòÉΓòÉΓòÉ <hidden> lReturn ΓòÉΓòÉΓòÉ

lReturn (LONG)
   Result code.

   Result code from dialog dismissal. This field contains the ID of the push
   button pressed to dismiss the dialog, DID_OK or DID_CANCEL, unless the
   application supplies additional push buttons in its template. If an error
   occurs on dialog invocation, this field is set to zero.


ΓòÉΓòÉΓòÉ <hidden> lSRC ΓòÉΓòÉΓòÉ

lSRC (LONG)
   System return code.

   This field contains an FDS_ERR return code. When a dialog fails, this field
   is used to tell the application the reason for the failure.


ΓòÉΓòÉΓòÉ <hidden> pszTitle ΓòÉΓòÉΓòÉ

pszTitle (PSZ)
   Dialog title string.

   When this field is NULL, the dialog title defaults to the name of the dialog
   currently running.


ΓòÉΓòÉΓòÉ <hidden> pszOKButton ΓòÉΓòÉΓòÉ

pszOKButton (PSZ)
   OK push button text.

   This string is used to set the text of the OK push button. The default text
   is OK.


ΓòÉΓòÉΓòÉ <hidden> pfnDlgProc ΓòÉΓòÉΓòÉ

pfnDlgProc (PFNWP)
   Custom dialog procedure.

   NULL unless the caller is subclassing the file dialog. When non-NULL, it
   points to the dialog procedure of the application.


ΓòÉΓòÉΓòÉ <hidden> pszIType ΓòÉΓòÉΓòÉ

pszIType (PSZ)
   Extended-attribute type filter.

   This field contains a pointer to the initial extended-attribute type filter
   that is applied to the initial dialog screen. This filter is not required to
   be in papszITypeList.


ΓòÉΓòÉΓòÉ <hidden> papszITypeList ΓòÉΓòÉΓòÉ

papszITypeList (PAPSZ)
   Pointer.

   Pointer to a table of pointers to extended-attribute types. Each pointer in
   the table points to a NULL-terminated string, and each string is an
   extended-attribute type. These types are sorted in ascending order in the
   Type drop-down box. The end of the table is marked by a null pointer. To
   specify an empty table, the application sets this field to NULL, or it
   specifies a table containing only a null pointer.


ΓòÉΓòÉΓòÉ <hidden> pszIDrive ΓòÉΓòÉΓòÉ

pszIDrive (PSZ)
   The initial drive.

   This field contains a pointer to a string that specifies the initial drive
   applied to the initial dialog screen. This drive is not required to be in
   papszIDriveList.


ΓòÉΓòÉΓòÉ <hidden> papszIDriveList ΓòÉΓòÉΓòÉ

papszIDriveList (PAPSZ)
   Pointer.

   Pointer to a table of pointers to drives. Each pointer in the table points
   to a NULL-terminated string, and each string is a valid drive or network
   identifier. These drives and network IDs will be sorted in ascending order
   in the Drive drop-down box. The end of the table is marked by a null
   pointer. To specify an empty table, the application sets this field to NULL,
   or it specifies a table containing only a null pointer.


ΓòÉΓòÉΓòÉ <hidden> hMod ΓòÉΓòÉΓòÉ

hMod (HMODULE)
   Module for custom dialog resources.

   If FDS_CUSTOM is set, this is the HMODULE from which the custom file dialog
   template is loaded. NULLHANDLE causes the dialog resource to be pulled from
   the module of the current EXE.


ΓòÉΓòÉΓòÉ <hidden> szFullFile[CCHMAXPATH] ΓòÉΓòÉΓòÉ

szFullFile[CCHMAXPATH] (CHAR)
   Character array.

   An array of characters where CCHMAXPATH is a system-defined constant. On
   initialization, this field contains the initial fully-qualified path and
   file name. On completion, this field contains the selected fully-qualified
   path and file name. The simple file name can be replaced with a string
   filter, such as *.DAT. When the dialog is invoked, all drive and path
   information is stripped from the entry and moved to the corresponding fields
   in the dialog.
   When a file name is specified, the Files list box is scrolled to the
   matching file name. When there is no exact match, the closest match is used.
   When a string filter is specified, the dialog is initially refreshed using
   the results of this filter intersected with the results of pszIType. After
   the dialog is initially shown, the string filter remains in the file name
   field until a file is selected, or the user overtypes the value.
   When a file is selected, szFullFile is returned to the calling application
   and is set to the selected fully-qualified file name.
   When more than one file is selected in a multiple file selection dialog,
   only the topmost selected file name is returned in this field.


ΓòÉΓòÉΓòÉ <hidden> papszFQFilename ΓòÉΓòÉΓòÉ

papszFQFilename (PAPSZ)
   Pointer.

   Pointer to a table of pointers to fully-qualified file names. Returned to
   multiple file selection dialogs when the user selects one or more files from
   the list box. If the user types the file name in the file name entry field,
   the file name will be in szFullFile and this pointer will be NULL. When one
   or more selections are made, the count of items in this array will be
   returned in ulFQFCount.
   This table of pointers is storage allocated by the file dialog. When the
   application completes opening or saving all of the files specified, the
   application must call WinFreeFileDlgList to free the storage allocated by
   the file dialog.


ΓòÉΓòÉΓòÉ <hidden> ulFQFCount ΓòÉΓòÉΓòÉ

ulFQFCount (ULONG)
   Number of file names.

   Number of file names selected in the dialog. In a single file selection
   dialog, this value is 1. In a multiple file selection dialog, this value
   will be the number of files selected by the user.


ΓòÉΓòÉΓòÉ <hidden> usDlgId ΓòÉΓòÉΓòÉ

usDlgId (USHORT)
   Custom dialog ID.

   The ID of the dialog window. When FDS_CUSTOM is set, this field contains the
   ID of the resource containing the custom dialog template.


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (SHORT)
   X-axis dialog position.

   This, along with y and hwndP, is used to position the dialog. It is updated
   in the structure if the user moves the dialog to a new position. If the
   FILEDLG structure is reused, the dialog appears in the position at which it
   was left each time it is invoked. The FDS_CENTER flag overrides this
   position and automatically centers the dialog in its parent.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (SHORT)
   Y-axis dialog position.

   This, along with x and hwndP, is used to position the dialog. It is updated
   in the structure if the user moves the dialog to a new position. If the
   FILEDLG structure is reused, the dialog appears in the position at which it
   was left each time it is invoked. The FDS_CENTER flag overrides this
   position and automatically centers the dialog in its parent.


ΓòÉΓòÉΓòÉ <hidden> sEAType ΓòÉΓòÉΓòÉ

sEAType (SHORT)
   Selected extended-attribute type.

   Returns a selected extended-attribute type to assign to the file name
   returned in szFullFile. This field is a zero-based offset into the
   papszITypeList and is returned only when the Save As dialog is used. A -1
   value is returned when the Open dialog is used.


ΓòÉΓòÉΓòÉ 4.66. FIXED ΓòÉΓòÉΓòÉ

FIXED Signed-integer fraction (16:16). This can be treated as a LONG where the
value has been multiplied by 65 536.

typedef LONG FIXED;


ΓòÉΓòÉΓòÉ 4.67. FONTDLG ΓòÉΓòÉΓòÉ

FONTDLG Font-dialog structure.

typedef struct _FONTDLG {
ULONG      cbSize;             /* Structure size  */
HPS        hpsScreen;          /* Screen presentation space  */
HPS        hpsPrinter;         /* Printer presentation space  */
PSZ        pszTitle;           /* Dialog title string  */
PSZ        pszPreview;         /* Font-preview window string  */
PSZ        pszPtSizeList;      /* Application-provided point size list  */
PFNWP      pfnDlgProc;         /* Custom dialog procedure  */
PSZ        pszFamilyname;      /* Family name buffer  */
FIXED      fxPointSize;        /* Point size of the font  */
ULONG      fl;                 /* FNTS_* flags  */
ULONG      flFlags;            /* FNTF_* flags  */
ULONG      flType;             /* The selected type bits  */
ULONG      flTypeMask;         /* Mask of type bits to use  */
ULONG      flStyle;            /* Selected style bits  */
ULONG      flStyleMask;        /* Mask of style bits to use  */
LONG       clrFore;            /* Font foreground color  */
LONG       clrBack;            /* Font background color  */
ULONG      ulUser;             /* Application-defined  */
LONG       lReturn;            /* Return value  */
LONG       lSRC;               /* System return code  */
LONG       lEmHeight;          /* Em height  */
LONG       lXHeight;           /* X height  */
LONG       lExternalLeading;   /* External leading  */
HMODULE    hMod;               /* Module for custom dialog resources  */
FATTRS     fAttrs;             /* Font-attribute structure  */
SHORT      sNominalPointSize;  /* Font point size  */
USHORT     usWeight;           /* Font weight  */
USHORT     usWidth;            /* Font width  */
SHORT      x;                  /* The x-axis dialog position  */
SHORT      y;                  /* The y-axis dialog position  */
USHORT     usDlgId;            /* Dialog ID  */
USHORT     usFamilyBufLen;     /* Buffersize  */
USHORT     usReserved;         /* Reserved  */
 } FONTDLG;


ΓòÉΓòÉΓòÉ <hidden> cbSize ΓòÉΓòÉΓòÉ

cbSize (ULONG)
   Structure size.

   Size of structure. This field allows for future expansion of the structure,
   and must be initialized with the size of the FONTDLG structure.


ΓòÉΓòÉΓòÉ <hidden> hpsScreen ΓòÉΓòÉΓòÉ

hpsScreen (HPS)
   Screen presentation space.

   If not NULLHANDLE, the screen presentation space from which screen fonts are
   queried.


ΓòÉΓòÉΓòÉ <hidden> hpsPrinter ΓòÉΓòÉΓòÉ

hpsPrinter (HPS)
   Printer presentation space.

   If not NULLHANDLE, the printer presentation space from which printer font
   are queried.


ΓòÉΓòÉΓòÉ <hidden> pszTitle ΓòÉΓòÉΓòÉ

pszTitle (PSZ)
   Dialog title string.

   Application-provided dialog title. If NULL, it defaults to "Font".


ΓòÉΓòÉΓòÉ <hidden> pszPreview ΓòÉΓòÉΓòÉ

pszPreview (PSZ)
   Font-preview window string.

   String to show in font-preview window. If NULL, it defaults to "abcdABCD".

   Note:  Take care when choosing the string to put in this field. Using many
          different characters causes excess memory to be used by the font
          cache.


ΓòÉΓòÉΓòÉ <hidden> pszPtSizeList ΓòÉΓòÉΓòÉ

pszPtSizeList (PSZ)
   Application-provided point size list.

   String which contains a list of point sizes to be used as the default list
   for outline fonts in the point-size drop-down area. Point sizes are
   separated by spaces. If NULL, the point size drop down defaults to 8, 10,
   12, 14, 18, and 24.


ΓòÉΓòÉΓòÉ <hidden> pfnDlgProc ΓòÉΓòÉΓòÉ

pfnDlgProc (PFNWP)
   Custom dialog procedure.

   NULL unless the caller is subclassing the font dialog. When non-NULL, it
   points to the dialog procedure of the application.


ΓòÉΓòÉΓòÉ <hidden> pszFamilyname ΓòÉΓòÉΓòÉ

pszFamilyname (PSZ)
   Family name buffer.

   Buffer provided by the application for passing the family name of the font.
   The font family name used by the application to select a font. When the
   first character in this string is NULL, no family name was initially
   selected, and the dialog defaults to the system font.
   A buffer must be passed to the font dialog to allow the dialog to return the
   selected font family name. The size of this buffer is placed in the
   usFamilyBufLen field.


ΓòÉΓòÉΓòÉ <hidden> fxPointSize ΓòÉΓòÉΓòÉ

fxPointSize (FIXED)
   Point size of the font.

   If FNTS_OWNERDRAWPREVIEW is set, 0 means the user wants to leave the font
   size unchanged and the application must update the preview area.


ΓòÉΓòÉΓòÉ <hidden> fl ΓòÉΓòÉΓòÉ

fl (ULONG)
   FNTS_* flags.

   FNTS_APPLYBUTTON
      An Apply push button is added to the dialog. This is useful in a modeless
      dialog.
   FNTS_BITMAPONLY
      The dialog presents bit-map fonts only. An application that changes fonts
      by using the presentation parameters (PP_* values) could use this flag.
   FNTS_CENTER
      The dialog is positioned in the center of its parent window, overriding
      any specified x,y position.
   FNTS_CUSTOM
      A custom dialog template is used to create the dialog. The hMod and
      usDlgId fields must be initialized.
   FNTS_FIXEDWIDTHONLY
      The dialog presents fixed-width (monospace) fonts only.
   FNTS_HELPBUTTON
      A Help push button of style (BS_HELP|BS_NOPOINTERFOCUS) with an ID of
      DID_HELP_BUTTON is added to the dialog. If the push button is pressed, a
      WM_HELP message is sent to the hwndO parameter of the WinFontDlg function
      call.
   FNTS_INITFROMFATTRS
      The dialog initializes itself from the font attribute structure (FATTRS)
      that is passed.
   FNTS_MODELESS
      The dialog is modeless; WinFontDlg returns immediately after creating the
      dialog window and returns the window handle to the application. The
      application should treat the dialog as if it were created with
      WinLoadDlg. As in the modal (default) dialog case, the return value is
      found in the lReturn field of the FONTDLG structure passed to WinFontDlg.
   FNTS_NOSYNTHESIZEDFONTS
      The dialog does not synthesize any fonts.
   FNTS_OWNERDRAWPREVIEW
      This flag makes the check boxes in the font dialog three-state check
      boxes, enabling the user to leave certain style attributes unchanged.
      Additionally, a WM_DRAWITEM message will be sent to the owner, providing
      the owner an opportunity to draw the preview window itself.
   FNTS_PROPORTIONALONLY
      The dialog presents proportionally spaced fonts only.
   FNTS_RESETBUTTON
      A Reset push button is added to the dialog. When this push button is
      pressed, the values for the dialog are restored to their initial values.
   FNTS_VECTORONLY
      The dialog presents vector fonts only.


ΓòÉΓòÉΓòÉ <hidden> flFlags ΓòÉΓòÉΓòÉ

flFlags (ULONG)
   FNTF_* flags.

   FNTF_NOVIEWPRINTERFONTS
      This flag is initialized only when both hpsScreen and hpsPrinter are not
      NULLHANDLE. On input, this parameter determines whether the printer fonts
      are to be included in the font list box. The user controls this with a
      check box.
   FNTF_NOVIEWSCREENFONTS
      This flag is initialized only when both hpsScreen and hpsPrinter are not
      NULLHANDLE. On input, this parameter determines whether the screen fonts
      should be included in the font list box. The user controls this with a
      check box.
   FNTF_PRINTERFONTSELECTED
      This determines if a printer-specific font is selected by the user. The
      application should make an approximation of this printer font when
      outputting to the screen. This is an output-only flag and is ignored on
      input.
   FNTF_SCREENFONTSELECTED
      This determines if a screen-specific font is selected by the user. The
      application should make an approximation of this screen font when
      outputting to the screen. This is an output-only flag and is ignored on
      input.


ΓòÉΓòÉΓòÉ <hidden> flType ΓòÉΓòÉΓòÉ

flType (ULONG)
   The selected type bits.

   These flags specify what additional attributes the user specified for the
   font. This field is used as the flOptions field in the FACENAMEDESC
   structure for GpiQueryFaceString.


ΓòÉΓòÉΓòÉ <hidden> flTypeMask ΓòÉΓòÉΓòÉ

flTypeMask (ULONG)
   Mask of type bits to use.

   This field is used only if FNTS_OWNERDRAWPREVIEW is specified. It tells
   which flags of the flTypeMask field the user wants to change, and is
   relevant only if the text for which the font is selected has different faces
   and styles.


ΓòÉΓòÉΓòÉ <hidden> flStyle ΓòÉΓòÉΓòÉ

flStyle (ULONG)
   Selected style bits.

   Flags for any additional selections the user specified for the font. This
   field is used as the fsSelection field in the FATTRS structure passed to
   GpiCreateLogFont.


ΓòÉΓòÉΓòÉ <hidden> flStyleMask ΓòÉΓòÉΓòÉ

flStyleMask (ULONG)
   Mask of style bits to use.

   This field is used only if FNTS_OWNERDRAWPREVIEW is specified. It tells
   which flags of the flStyle field the user wants to change and is relevant
   only if the text for which the font is selected has different faces and
   styles.


ΓòÉΓòÉΓòÉ <hidden> clrFore ΓòÉΓòÉΓòÉ

clrFore (LONG)
   Font foreground color.

   Foreground color of the font. This color is a value used for the color mode
   that hpsScreen is in. If FNTS_OWNERDRAWPREVIEW is specified, this value can
   be CLR_NOINDEX, leaving the foreground color "as is".


ΓòÉΓòÉΓòÉ <hidden> clrBack ΓòÉΓòÉΓòÉ

clrBack (LONG)
   Font background color.

   Background color of the font. This color is a value used for the color mode
   that hpsScreen is in. If FNTS_OWNERDRAWPREVIEW is specified, this value can
   be CLR_NOINDEX leaving the background color "as is".


ΓòÉΓòÉΓòÉ <hidden> ulUser ΓòÉΓòÉΓòÉ

ulUser (ULONG)
   Application-defined.

   A ULONG that an application uses to store its state information when it is
   subclassing the font dialog.


ΓòÉΓòÉΓòÉ <hidden> lReturn ΓòÉΓòÉΓòÉ

lReturn (LONG)
   Return value.

   Return value from WinFontDlg. This value is the ID of the push button
   pressed to dismiss the dialog, DID_OK or DID_CANCEL, unless the application
   supplied additional push buttons in its template.


ΓòÉΓòÉΓòÉ <hidden> lSRC ΓòÉΓòÉΓòÉ

lSRC (LONG)
   System return code.

   This field contains an FNTS_ERR return code. When a dialog fails, this field
   is used to tell the application the reason for the failure.


ΓòÉΓòÉΓòÉ <hidden> lEmHeight ΓòÉΓòÉΓòÉ

lEmHeight (LONG)
   Em height.

   The Em height of the current font. This is the same as in the FONTMETRICS
   structure. It is an output-only parameter and its value has no effect on the
   behavior of the font dialog, but is updated when the user dismisses the
   dialog.


ΓòÉΓòÉΓòÉ <hidden> lXHeight ΓòÉΓòÉΓòÉ

lXHeight (LONG)
   X height.

   The x height of the current font. This is the same as in the FONTMETRICS
   structure. It is an output-only parameter and its value has no effect on the
   behavior of the font dialog, but is updated when the user dismisses the
   dialog.


ΓòÉΓòÉΓòÉ <hidden> lExternalLeading ΓòÉΓòÉΓòÉ

lExternalLeading (LONG)
   External leading.

   The external leading of the font. This is the same as in the FONTMETRICS
   structure. It is an output-only parameter and its value has no effect on the
   behavior of the font dialog, but is updated when the user dismisses the
   dialog.


ΓòÉΓòÉΓòÉ <hidden> hMod ΓòÉΓòÉΓòÉ

hMod (HMODULE)
   Module for custom dialog resources.

   If FNTS_CUSTOM is set, this is the HMODULE from which the custom font dialog
   template is loaded. NULLHANDLE causes the dialog resource to be pulled from
   the module of the current EXE.


ΓòÉΓòÉΓòÉ <hidden> fAttrs ΓòÉΓòÉΓòÉ

fAttrs (FATTRS)
   Font-attribute structure.

   Font-attribute structure of selected font. The FATTRS for the selected font.
   This is output-only for all fields except usCodePage, which is input/output,
   and the initial code page value passed is used for font selection. The value
   returned is the one for the matching font.


ΓòÉΓòÉΓòÉ <hidden> sNominalPointSize ΓòÉΓòÉΓòÉ

sNominalPointSize (SHORT)
   Font point size.

   The nominal point size of the font. This is the same as in the FONTMETRICS
   structure. It is an output-only parameter and its value has no effect on the
   behavior of the font dialog, but is updated when the user dismisses the
   dialog.


ΓòÉΓòÉΓòÉ <hidden> usWeight ΓòÉΓòÉΓòÉ

usWeight (USHORT)
   Font weight.

   The weight of the font. This is the weight-class/boldness the user selects
   for the font. This field is used as the usWeightClass field in the
   FACENAMEDESC structure for GpiQueryFaceString. When FNTS_OWNERDRAWPREVIEW is
   set, 0 causes the application to leave the font weight "as is" and the
   application must update the preview area.


ΓòÉΓòÉΓòÉ <hidden> usWidth ΓòÉΓòÉΓòÉ

usWidth (USHORT)
   Font width.

   The width of the font. This is the width-class the user selects for the
   font. This field is used as the usWidthClass field in the FACENAMEDESC
   structure for GpiQueryFaceString. When FNTS_OWNERDRAWPREVIEW is set, 0
   causes the application to leave the font width "as is" and the application
   must update the preview area.


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (SHORT)
   The x-axis dialog position.

   This, along with y and hwndP, is used to position the dialog. It is updated
   in the structure if the user moves the dialog to a new position. This way,
   the dialog appears in the position at which it was left each time it is
   invoked. The FNTS_CENTER flag overrides this position and automatically
   centers the dialog in its parent.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (SHORT)
   The y-axis dialog position.

   This, along with x and hwndP, is used to position the dialog. It is updated
   in the structure if the user moves the dialog to a new position. This way,
   the dialog appears in the position at which it was left each time it is
   invoked. The FNTS_CENTER flag overrides this position and automatically
   centers the dialog in its parent.


ΓòÉΓòÉΓòÉ <hidden> usDlgId ΓòÉΓòÉΓòÉ

usDlgId (USHORT)
   Dialog ID.

   This sets the ID of the dialog window. If FNTS_CUSTOM is set, this is the ID
   of the resource that contains the custom dialog template.


ΓòÉΓòÉΓòÉ <hidden> usFamilyBufLen ΓòÉΓòÉΓòÉ

usFamilyBufLen (USHORT)
   Buffersize.

   Size of the buffer passed in the pszFamilyname resource that contains the
   custom dialog template.


ΓòÉΓòÉΓòÉ <hidden> usReserved ΓòÉΓòÉΓòÉ

usReserved (USHORT)
   Reserved.

   This is a reserved field.


ΓòÉΓòÉΓòÉ 4.68. FONTMETRICS ΓòÉΓòÉΓòÉ

FONTMETRICS Font-metrics structure.

This structure is returned to applications on the GpiQueryFonts and
GpiQueryFontMetrics calls and conveys information from the font creator to the
application.

typedef struct _FONTMETRICS {
CHAR      szFamilyname[FACESIZE];  /* Family name  */
CHAR      szFacename[FACESIZE];    /* Face name  */
USHORT    idRegistry;              /* Registry identifier  */
USHORT    usCodePage;              /* Code page  */
LONG      lEmHeight;               /* Em height  */
LONG      lXHeight;                /* x height  */
LONG      lMaxAscender;            /* Maximum ascender  */
LONG      lMaxDescender;           /* Maximum descender  */
LONG      lLowerCaseAscent;        /* Lowercase ascent  */
LONG      lLowerCaseDescent;       /* Lowercase descent  */
LONG      lInternalLeading;        /* Internal leading  */
LONG      lExternalLeading;        /* External leading  */
LONG      lAveCharWidth;           /* Average character width  */
LONG      lMaxCharInc;             /* Maximum character increment  */
LONG      lEmInc;                  /* Em increment  */
LONG      lMaxBaselineExt;         /* Maximum baseline extent  */
SHORT     sCharSlope;              /* Character slope  */
SHORT     sInlineDir;              /* Inline direction  */
SHORT     sCharRot;                /* Character rotation  */
USHORT    usWeightClass;           /* Weight class  */
USHORT    usWidthClass;            /* Width class  */
SHORT     sXDeviceRes;             /* x-device resolution  */
SHORT     sYDeviceRes;             /* y-device resolution  */
SHORT     sFirstChar;              /* First character  */
SHORT     sLastChar;               /* Last character  */
SHORT     sDefaultChar;            /* Default character  */
SHORT     sBreakChar;              /* Break character  */
SHORT     sNominalPointSize;       /* Nominal point size  */
SHORT     sMinimumPointSize;       /* Minimum point size  */
SHORT     sMaximumPointSize;       /* Maximum point size  */
USHORT    fsType;                  /* Type indicators  */
USHORT    fsDefn;                  /* Definition indicators  */
USHORT    fsSelection;             /* Selection indicators  */
USHORT    fsCapabilities;          /* Capabilities  */
LONG      lSubscriptXSize;         /* Subscript x-size  */
LONG      lSubscriptYSize;         /* Subscript y-size  */
LONG      lSubscriptXOffset;       /* Subscript x-offset  */
LONG      lSubscriptYOffset;       /* Subscript y-offset  */
LONG      lSuperscriptXSize;       /* Superscript x-size  */
LONG      lSuperscriptYSize;       /* Superscript y-size  */
LONG      lSuperscriptXOffset;     /* Superscript x-offset  */
LONG      lSuperscriptYOffset;     /* Superscript y-offset  */
LONG      lUnderscoreSize;         /* Underscore size  */
LONG      lUnderscorePosition;     /* Underscore position  */
LONG      lStrikeoutSize;          /* Strikeout size  */
LONG      lStrikeoutPosition;      /* Strikeout position  */
SHORT     sKerningPairs;           /* Kerning pairs  */
SHORT     sFamilyClass;            /* Font family design classification  */
LONG      lMatch;                  /* Matched font identity  */
LONG      FamilyNameAtom;          /* Font family name atom  */
LONG      FaceNameAtom;            /* Font facename atom  */
PANOSE    panose;                  /* Panose font descriptor  */
 } FONTMETRICS;


ΓòÉΓòÉΓòÉ <hidden> szFamilyname[FACESIZE] ΓòÉΓòÉΓòÉ

szFamilyname[FACESIZE] (CHAR)
   Family name.

   The family name of the font that describes the basic appearance of the font,
   for example, Times New Roman** This string is null terminated, and is thus
   limited to 31 characters in length. Longer names may be retrieved by using
   the FamilyNameAtom field to retrieve the full name from the System Atom
   table.


ΓòÉΓòÉΓòÉ <hidden> szFacename[FACESIZE] ΓòÉΓòÉΓòÉ

szFacename[FACESIZE] (CHAR)
   Face name.

   The typeface name that defines the particular font, for example, Times New
   Roman Bold Italic. This string is null terminated, and is thus limited to 31
   characters in length. Longer names may be retrieved by using the
   FaceNameAtom field to retrieve the full name from the System Atom table.


ΓòÉΓòÉΓòÉ <hidden> idRegistry ΓòÉΓòÉΓòÉ

idRegistry (USHORT)
   Registry identifier.

   The IBM registered number (or zero).


ΓòÉΓòÉΓòÉ <hidden> usCodePage ΓòÉΓòÉΓòÉ

usCodePage (USHORT)
   Code page.

   Defines the registered code page supported by the font. For example, the
   original IBM PC code page is 437. A value of 0 implies that the font may be
   used with any of the OS/2* supported code pages.
   Where a font contains special symbols for which there is no registered code
   page, then code page 65400 is used.


ΓòÉΓòÉΓòÉ <hidden> lEmHeight ΓòÉΓòÉΓòÉ

lEmHeight (LONG)
   Em height.

   The height of the Em square in world coordinate units. This corresponds to
   the point size for the font.


ΓòÉΓòÉΓòÉ <hidden> lXHeight ΓòÉΓòÉΓòÉ

lXHeight (LONG)
   x height.

   The nominal height above the baseline for lowercase characters (ignoring
   ascenders) in world coordinate units.


ΓòÉΓòÉΓòÉ <hidden> lMaxAscender ΓòÉΓòÉΓòÉ

lMaxAscender (LONG)
   Maximum ascender.

   The maximum height above the baseline reached by any part of any symbol in
   the font in world coordinate units. This field may exceed lEmHeight.


ΓòÉΓòÉΓòÉ <hidden> lMaxDescender ΓòÉΓòÉΓòÉ

lMaxDescender (LONG)
   Maximum descender.

   The maximum depth below the baseline reached by any part of any symbol in
   the font in world coordinate units. This field may exceed lEmHeight.


ΓòÉΓòÉΓòÉ <hidden> lLowerCaseAscent ΓòÉΓòÉΓòÉ

lLowerCaseAscent (LONG)
   Lowercase ascent.

   The maximum height above the baseline reached by any part of any lowercase
   (Latin unaccented "a" through "z") symbol in the font in world coordinate
   units.


ΓòÉΓòÉΓòÉ <hidden> lLowerCaseDescent ΓòÉΓòÉΓòÉ

lLowerCaseDescent (LONG)
   Lowercase descent.

   The maximum depth below the baseline reached by any part of any lowercase
   (Latin unaccented "a" through "z") symbol in the font in world coordinate
   units.


ΓòÉΓòÉΓòÉ <hidden> lInternalLeading ΓòÉΓòÉΓòÉ

lInternalLeading (LONG)
   Internal leading.


   The amount of space which, when subtracted from lMaxAscender, gives a
   font-design dependent, but glyph-set independent, measure of the distance
   above the baseline that characters extend.  This calculation thus
   approximates the visual top to a row of characters without actually looking
   at the characters in the row.
   The recommended use of this field by applications is to position the first
   line of a block of text by subtracting it from lMaxAscender and positioning
   the baseline that distance below whatever is above the text.

   Note:  This does not guarantee that characters will not overwrite things
          above them, but does give a font designer's view of where to place
          the text.  Collision should be tested for, and additional space
          allocated if necessary.


ΓòÉΓòÉΓòÉ <hidden> lExternalLeading ΓòÉΓòÉΓòÉ

lExternalLeading (LONG)
   External leading.


   The amount of guaranteed white space advised by the font designer to appear
   between adjacent rows of text.  This value may be zero.

   Note:  The fonts built in to Presentation Manager have zero in this field.


ΓòÉΓòÉΓòÉ <hidden> lAveCharWidth ΓòÉΓòÉΓòÉ

lAveCharWidth (LONG)
   Average character width.


   This is determined by multiplying the width of each lowercase character by a
   constant, adding the products, and then dividing by 1000. The letters
   involved in this, plus their constants, are as follows:

   Letter    Constant
   a         64
   b         14
   c         27
   d         35
   e         100
   f         20
   g         14
   h         42
   i         63
   j         3
   k         6
   l         35
   m         20
   n         56
   o         56
   p         17
   q         4
   r         49
   s         56
   t         71
   u         31
   v         10
   w         18
   x         3
   y         18
   z         2
   space     166

   Note:  For fixed pitch fonts this value will be the same as the (A width + B
          width + C width) escapement of each character.


ΓòÉΓòÉΓòÉ <hidden> lMaxCharInc ΓòÉΓòÉΓòÉ

lMaxCharInc (LONG)
   Maximum character increment.

   The maximum character increment for the font in world coordinate units.


ΓòÉΓòÉΓòÉ <hidden> lEmInc ΓòÉΓòÉΓòÉ

lEmInc (LONG)
   Em increment.

   The width of the Em square in world coordinate units. This corresponds to
   the point size of the font.  When the horizontal device resolution equals
   the vertical device resolution this is equal to the em height.


ΓòÉΓòÉΓòÉ <hidden> lMaxBaselineExt ΓòÉΓòÉΓòÉ

lMaxBaselineExt (LONG)
   Maximum baseline extent.

   The maximum vertical space occupied by the font, in world coordinate units.
   This is the sum of lMaxAscender and lMaxDescender if both are positive. It
   is also the sum of lInternalLeading and lEmHeight.
   One possible line spacing can be computed by adding lMaxBaselineExt to
   lExternalLeading. Such a line spacing, however, would be dependent on the
   glyph set included in the font. If a new version of the font should be made
   available, with new glyphs, then it is possible that this value will change
   because one of the new glyphs has gone above the previous lMaxAscender or
   below the previous lMaxDescender. More sophisticated applications will base
   line spacing on the point size (lEmHeight) of the font, which is an
   invariant of the font, multiplied by some factor (say 120%) plus any
   external leading.
   This field may exceed lEmHeight.


ΓòÉΓòÉΓòÉ <hidden> sCharSlope ΓòÉΓòÉΓòÉ

sCharSlope (SHORT)
   Character slope.

   Defines the nominal slope for the characters of a font.  The slope is
   defined in degrees increasing clockwise from the vertical. An Italic font is
   an example of a font with a nonzero slope.

   Note:  The units for this metric are degrees and minutes, encoded as shown
          in the following example:

                    180 degrees 59 minutes would be represented as :

                    |  < byte 1 >   |  < byte 2 >   |

                    | | <Minutes> |  <  Degrees  >  |

                    |0|1 1 1 0 1 1|0 1 0 1 1 0 1 0 0|

                      |  59 min   |   180 degrees   |


ΓòÉΓòÉΓòÉ <hidden> sInlineDir ΓòÉΓòÉΓòÉ

sInlineDir (SHORT)
   Inline direction.

   The direction in which the characters in the font are designed for viewing,
   in degrees increasing clockwise from the horizontal (left-to-right).
   Characters are added to a line of text in the inline direction.

   Note:  The units for this metric are degrees and minutes, encoded as shown
          in sCharSlope.


ΓòÉΓòÉΓòÉ <hidden> sCharRot ΓòÉΓòÉΓòÉ

sCharRot (SHORT)
   Character rotation.

   The rotation of the character glyphs with respect to the baseline, the angle
   increasing counter clockwise.  This is the angle assigned by the font
   designer.

   Note:  The units for this metric are degrees and minutes, encoded as shown
          in sCharSlope.


ΓòÉΓòÉΓòÉ <hidden> usWeightClass ΓòÉΓòÉΓòÉ

usWeightClass (USHORT)
   Weight class.

   Indicates the visual weight (thickness of strokes) of the characters in the
   font:

   Value   Description
   1       Ultra-light
   2       Extra-light
   3       Light
   4       Semi-light
   5       Medium (normal)
   6       Semi-bold
   7       Bold
   8       Extra-bold
   9       Ultra-bold


ΓòÉΓòÉΓòÉ <hidden> usWidthClass ΓòÉΓòÉΓòÉ

usWidthClass (USHORT)
   Width class.

   Indicates the relative aspect ratio of the characters of the font in
   relation to the normal aspect ratio for this type of font:


       Value   Description        % of normal width

       1       Ultra-condensed    50

       2       Extra-condensed    62.5

       3       Condensed          75

       4       Semi-condensed     87.5

       5       Medium (normal)    100

       6       Semi-expanded      112.5

       7       Expanded           125

       8       Extra-expanded     150

       9       Ultra-expanded     200


ΓòÉΓòÉΓòÉ <hidden> sXDeviceRes ΓòÉΓòÉΓòÉ

sXDeviceRes (SHORT)
   x-device resolution.


   For bit-map fonts this is the resolution in the X direction of the intended
   target device, measured in Pels per inch.
   For outline fonts this is the number of notional units in the X direction of
   the Em square, measured in notional units per Em.  (Notional units are the
   units in which the outline is defined.


ΓòÉΓòÉΓòÉ <hidden> sYDeviceRes ΓòÉΓòÉΓòÉ

sYDeviceRes (SHORT)
   y-device resolution.


   For bit-map fonts this is the resolution in the Y direction of the intended
   target device, measured in Pels per inch.
   For outline fonts this is the number of notional units in the Y direction of
   the Em square, measured in notional units per Em.  (Notional units are the
   units in which the outline is defined.


ΓòÉΓòÉΓòÉ <hidden> sFirstChar ΓòÉΓòÉΓòÉ

sFirstChar (SHORT)
   First character.

   The code point of the first character in the font.


ΓòÉΓòÉΓòÉ <hidden> sLastChar ΓòÉΓòÉΓòÉ

sLastChar (SHORT)
   Last character.

   The code point of the last character in the font, expressed as an offset
   from sFirstChar.
   All code points between the first and last character specified must be
   supported by the font.


ΓòÉΓòÉΓòÉ <hidden> sDefaultChar ΓòÉΓòÉΓòÉ

sDefaultChar (SHORT)
   Default character.

   The code point that is used if a code point outside the range supported by
   the font is used, expressed as an offset from sFirstChar.


ΓòÉΓòÉΓòÉ <hidden> sBreakChar ΓòÉΓòÉΓòÉ

sBreakChar (SHORT)
   Break character.

   The code point that represents the "space" or "break" character for this
   font, expressed as an offset from sFirstChar. For example, if the first
   character is the space in code page 850, sFirstChar = 32, and sBreakChar =
   0.


ΓòÉΓòÉΓòÉ <hidden> sNominalPointSize ΓòÉΓòÉΓòÉ

sNominalPointSize (SHORT)
   Nominal point size.


   For a bit-map font this field contains the height of the font.
   For an outline font, this field contains the height the font designer had in
   mind for this font.  For example some fonts are designed for text use in
   which case a value of 120 (12 point) would probably be placed in this field,
   whereas other fonts are designed for "display" use ("display" is
   typographer's terminology for larger sizes). This is not the only size the
   font can be used at.
   Measured in decipoints (a decipoint is 1/720th of an inch).


ΓòÉΓòÉΓòÉ <hidden> sMinimumPointSize ΓòÉΓòÉΓòÉ

sMinimumPointSize (SHORT)
   Minimum point size.


   For a bit-map font, this field is meaningless.
   For an outline font, this field contains the minimum height the font
   designer had in mind for this font. Note that this is not a restriction on
   the size the font can be used at.
   Measured in decipoints (a decipoint is 1/720th of an inch).


ΓòÉΓòÉΓòÉ <hidden> sMaximumPointSize ΓòÉΓòÉΓòÉ

sMaximumPointSize (SHORT)
   Maximum point size.


   For a bit-map font, this field is meaningless.
   For an outline font, this field contains the maximum height the font
   designer had in mind for this font. Note that this is not a restriction on
   the size the font can be used at.
   Measured in decipoints (a decipoint is 1/720th of an inch).


ΓòÉΓòÉΓòÉ <hidden> fsType ΓòÉΓòÉΓòÉ

fsType (USHORT)
   Type indicators.

   Contains this information:

   FM_TYPE_FIXED
      Characters in the font have the same fixed width.
   FM_TYPE_LICENSED
      Licensed (protected) font.
   FM_TYPE_KERNING
      Font contains kerning information.
   FM_TYPE_64K
      Font is larger than 64KB (KB equals 1024 bytes) in size. If the following
      two bits are false, the font is for single-byte code pages.  One of the
      bits may be set.
   FM_TYPE_DBCS
      Font is for double-byte code pages.
   FM_TYPE_MBCS
      Font is for mixed single/double-byte code pages.
   FM_TYPE_FACETRUNC
      Font szFacename[FACESIZE] has been truncated.
   FM_TYPE_FAMTRUNC
      Font szFamilyname[FACESIZE] has been truncated.
   FM_TYPE_ATOMS
      The System Atom table atom values in FamilyNameAtom and in FaceNameAtom
      are valid.


ΓòÉΓòÉΓòÉ <hidden> fsDefn ΓòÉΓòÉΓòÉ

fsDefn (USHORT)
   Definition indicators.

   Contains the following font definition data:

   FM_DEFN_OUTLINE
      Font is a vector (outline) font, otherwise it is a bit-map font.
   FM_DEFN_GENERIC
      Font is in a format that can be used by the GPI, otherwise it is a device
      font.


ΓòÉΓòÉΓòÉ <hidden> fsSelection ΓòÉΓòÉΓòÉ

fsSelection (USHORT)
   Selection indicators.

   Contains information about the font patterns in the physical font.

   Note:  The flags do not reflect simulations applied to the physical font.

   FM_SEL_ITALIC
      True indicates that this font is designed as an italic font.
   FM_SEL_UNDERSCORE
      TRUE indicates that this font is designed with underscores included in
      each character.
   FM_SEL_NEGATIVE
      TRUE indicates that this font is designed with the background and
      foreground reversed.
   FM_SEL_OUTLINE
      TRUE indicates that this font is designed with outline (hollow)
      characters.
   FM_SEL_STRIKEOUT
      TRUE indicates that this font is designed with an overstrike through each
      character.
   FM_SEL_BOLD
      TRUE indicates that this font is designed with bold characters.
   FM_SEL_ISO9241_TESTED
      This flag indicates that the font has been tested for compliance to ISO
      9241.  The presence of this flag doesn't indicate whether the font passed
      or failed, only that it was tested.

      Note:  While the fonts were primarily tested for meeting the ISO
             standard, they have also been designed to meet the German standard
             DIN 66 234. Where the two standards differ, the fonts have been
             designed to meet the stricter requirement.


ΓòÉΓòÉΓòÉ <hidden> fsCapabilities ΓòÉΓòÉΓòÉ

fsCapabilities (USHORT)
   Capabilities.

   This attribute applies only to device fonts.

   FM_CAP_NOMIX
      Characters may not be mixed with graphics.
   QUALITY
      The most significant byte may contain the following numeric value:

      0    Undefined
      1    DP quality
      2    DP draft
      3    Near Letter Quality
      4    Letter Quality


ΓòÉΓòÉΓòÉ <hidden> lSubscriptXSize ΓòÉΓòÉΓòÉ

lSubscriptXSize (LONG)
   Subscript x-size.

   The recommended horizontal size for subscripts for this font in world
   coordinate units.


ΓòÉΓòÉΓòÉ <hidden> lSubscriptYSize ΓòÉΓòÉΓòÉ

lSubscriptYSize (LONG)
   Subscript y-size.

   The recommended vertical size for subscripts for this font in world
   coordinate units.


ΓòÉΓòÉΓòÉ <hidden> lSubscriptXOffset ΓòÉΓòÉΓòÉ

lSubscriptXOffset (LONG)
   Subscript x-offset.

   The recommended baseline x-offset for subscripts for this font in world
   coordinate units.


ΓòÉΓòÉΓòÉ <hidden> lSubscriptYOffset ΓòÉΓòÉΓòÉ

lSubscriptYOffset (LONG)
   Subscript y-offset.

   The recommended baseline y-offset for subscripts for this font in world
   coordinate units.

   Note:  Positive numbers mean below the baseline.


ΓòÉΓòÉΓòÉ <hidden> lSuperscriptXSize ΓòÉΓòÉΓòÉ

lSuperscriptXSize (LONG)
   Superscript x-size.

   The recommended horizontal size for superscripts for this font in world
   coordinate units.


ΓòÉΓòÉΓòÉ <hidden> lSuperscriptYSize ΓòÉΓòÉΓòÉ

lSuperscriptYSize (LONG)
   Superscript y-size.

   The recommended vertical point size for superscripts for this font in world
   coordinate units.


ΓòÉΓòÉΓòÉ <hidden> lSuperscriptXOffset ΓòÉΓòÉΓòÉ

lSuperscriptXOffset (LONG)
   Superscript x-offset.

   The recommended baseline x-offset for superscripts for this font in world
   coordinate units.


ΓòÉΓòÉΓòÉ <hidden> lSuperscriptYOffset ΓòÉΓòÉΓòÉ

lSuperscriptYOffset (LONG)
   Superscript y-offset.

   The recommended baseline y-offset for superscripts for this font in world
   coordinate units.


ΓòÉΓòÉΓòÉ <hidden> lUnderscoreSize ΓòÉΓòÉΓòÉ

lUnderscoreSize (LONG)
   Underscore size.

   The width (thickness) of the underscore stroke in world coordinate units
   This describes the actual underscore in the font if FM_SEL_UNDERSCORE is
   also set.  Otherwise it describes what the engine will simulate if
   underscore is requested in GpiCreateLogFont.


ΓòÉΓòÉΓòÉ <hidden> lUnderscorePosition ΓòÉΓòÉΓòÉ

lUnderscorePosition (LONG)
   Underscore position.

   The position of the underscore stroke from the baseline in world coordinate
   units. This describes the actual underscore in the font if FM_SEL_UNDERSCORE
   is also set.  Otherwise it describes what the engine will simulate if
   underscore is requested in GpiCreateLogFont.

   Note:  Positive values mean below the baseline.


ΓòÉΓòÉΓòÉ <hidden> lStrikeoutSize ΓòÉΓòÉΓòÉ

lStrikeoutSize (LONG)
   Strikeout size.

   The width of the strikeout stroke in world coordinate units. This describes
   the actual underscore in the font if FM_SEL_STRIKEOUT is also set.
   Otherwise it describes what the engine will simulate if overstrike is
   requested in GpiCreateLogFont.


ΓòÉΓòÉΓòÉ <hidden> lStrikeoutPosition ΓòÉΓòÉΓòÉ

lStrikeoutPosition (LONG)
   Strikeout position.

   The position of the strikeout stroke relative to the baseline in world
   coordinate units. This describes the actual underscore in the font if
   FM_SEL_STRIKEOUT is also set.  Otherwise it describes what the engine will
   simulate if overstrike is requested in GpiCreateLogFont.


ΓòÉΓòÉΓòÉ <hidden> sKerningPairs ΓòÉΓòÉΓòÉ

sKerningPairs (SHORT)
   Kerning pairs.

   The number of kerning pairs in the kerning pair table.


ΓòÉΓòÉΓòÉ <hidden> sFamilyClass ΓòÉΓòÉΓòÉ

sFamilyClass (SHORT)
   Font family design classification.

   This value contains a font class and its subclass.


ΓòÉΓòÉΓòÉ <hidden> lMatch ΓòÉΓòÉΓòÉ

lMatch (LONG)
   Matched font identity.

   This uniquely identifies the font for a given device/device driver
   combination. A positive match number signifies that the font is a generic
   (engine) font while a negative number indicates a device font (a native or
   downloadable font). This value should not be used to identify a font across
   system boundaries.


ΓòÉΓòÉΓòÉ <hidden> FamilyNameAtom ΓòÉΓòÉΓòÉ

FamilyNameAtom (LONG)
   Font family name atom.

   This value contains the atom identifier for the font family name in the
   System Atom Table.


ΓòÉΓòÉΓòÉ <hidden> FaceNameAtom ΓòÉΓòÉΓòÉ

FaceNameAtom (LONG)
   Font facename atom.

   This value contains the atom identifier for the font face name in the System
   Atom Table.


ΓòÉΓòÉΓòÉ <hidden> panose ΓòÉΓòÉΓòÉ

panose (PANOSE)
   Panose font descriptor.

   This is the panose descriptor identifying the visual characteristics of the
   font.


ΓòÉΓòÉΓòÉ 4.69. FRAMECDATA ΓòÉΓòÉΓòÉ

FRAMECDATA Frame-control data structure.

typedef struct _FRAMECDATA {
USHORT    cb;             /* Length  */
ULONG     flCreateFlags;  /* Frame-creation flags  */
USHORT    hmodResources;  /* Identifier of required resource  */
USHORT    idResources;    /* Resource identifier  */
 } FRAMECDATA;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (USHORT)
   Length.


ΓòÉΓòÉΓòÉ <hidden> flCreateFlags ΓòÉΓòÉΓòÉ

flCreateFlags (ULONG)
   Frame-creation flags.


ΓòÉΓòÉΓòÉ <hidden> hmodResources ΓòÉΓòÉΓòÉ

hmodResources (USHORT)
   Identifier of required resource.

   This is supplied in an environment-dependent manner.


ΓòÉΓòÉΓòÉ <hidden> idResources ΓòÉΓòÉΓòÉ

idResources (USHORT)
   Resource identifier.


ΓòÉΓòÉΓòÉ 4.70. FTIME ΓòÉΓòÉΓòÉ

FTIME Time data structure for file-system functions.

typedef struct _FTIME {
USHORT    twosecs:5;        /* Binary number of two-second increments  */
USHORT    minutes:6;        /* Binary number of minutes  */
USHORT    hours:5;          /* Binary number of hours  */
 } FTIME;


ΓòÉΓòÉΓòÉ <hidden> twosecs:5 ΓòÉΓòÉΓòÉ

twosecs:5 (USHORT)
   Binary number of two-second increments


ΓòÉΓòÉΓòÉ <hidden> minutes:6 ΓòÉΓòÉΓòÉ

minutes:6 (USHORT)
   Binary number of minutes


ΓòÉΓòÉΓòÉ <hidden> hours:5 ΓòÉΓòÉΓòÉ

hours:5 (USHORT)
   Binary number of hours


ΓòÉΓòÉΓòÉ 4.71. GRADIENTL ΓòÉΓòÉΓòÉ

GRADIENTL Direction-vector structure.

typedef struct _GRADIENTL {
LONG    x;  /* x-component of direction  */
LONG    y;  /* y-component of direction  */
 } GRADIENTL;


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (LONG)
   x-component of direction.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (LONG)
   y-component of direction.


ΓòÉΓòÉΓòÉ 4.72. HAB ΓòÉΓòÉΓòÉ

HAB Anchor-block handle.

typedef LHANDLE HAB;


ΓòÉΓòÉΓòÉ 4.73. HACCEL ΓòÉΓòÉΓòÉ

HACCEL Accelerator-table handle.

typedef LHANDLE HACCEL;


ΓòÉΓòÉΓòÉ 4.74. HAPP ΓòÉΓòÉΓòÉ

HAPP Handle of an application.

typedef LHANDLE HAPP;


ΓòÉΓòÉΓòÉ 4.75. HATOMTBL ΓòÉΓòÉΓòÉ

HATOMTBL Atom-table handle.

typedef LHANDLE HATOMTBL;


ΓòÉΓòÉΓòÉ 4.76. HBITMAP ΓòÉΓòÉΓòÉ

HBITMAP Bit-map handle.

typedef LHANDLE HBITMAP;


ΓòÉΓòÉΓòÉ 4.77. HCINFO ΓòÉΓòÉΓòÉ

HCINFO Hardcopy-capabilities structure.

typedef struct _HCINFO {
CHAR    szFormname[32];  /* Form name  */
LONG    cx;              /* Width (left-to-right) in millimeters  */
LONG    cy;              /* Height (top-to-bottom) in millimeters  */
LONG    xLeftClip;       /* Left clip limit in millimeters  */
LONG    yBottomClip;     /* Bottom clip limit in millimeters  */
LONG    xRightClip;      /* Right clip limit in millimeters  */
LONG    yTopClip;        /* Top clip limit in millimeters  */
LONG    xPels;           /* Number of pels between left and right clip limits  */
LONG    yPels;           /* Number of pels between bottom and top clip limits  */
LONG    flAttributes;    /* Attributes of the form identifier  */
 } HCINFO;


ΓòÉΓòÉΓòÉ <hidden> szFormname[32] ΓòÉΓòÉΓòÉ

szFormname[32] (CHAR)
   Form name.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (LONG)
   Width (left-to-right) in millimeters.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (LONG)
   Height (top-to-bottom) in millimeters.


ΓòÉΓòÉΓòÉ <hidden> xLeftClip ΓòÉΓòÉΓòÉ

xLeftClip (LONG)
   Left clip limit in millimeters.


ΓòÉΓòÉΓòÉ <hidden> yBottomClip ΓòÉΓòÉΓòÉ

yBottomClip (LONG)
   Bottom clip limit in millimeters.


ΓòÉΓòÉΓòÉ <hidden> xRightClip ΓòÉΓòÉΓòÉ

xRightClip (LONG)
   Right clip limit in millimeters.


ΓòÉΓòÉΓòÉ <hidden> yTopClip ΓòÉΓòÉΓòÉ

yTopClip (LONG)
   Top clip limit in millimeters.


ΓòÉΓòÉΓòÉ <hidden> xPels ΓòÉΓòÉΓòÉ

xPels (LONG)
   Number of pels between left and right clip limits.


ΓòÉΓòÉΓòÉ <hidden> yPels ΓòÉΓòÉΓòÉ

yPels (LONG)
   Number of pels between bottom and top clip limits.


ΓòÉΓòÉΓòÉ <hidden> flAttributes ΓòÉΓòÉΓòÉ

flAttributes (LONG)
   Attributes of the form identifier.

   HCAPS_SELECTABLE
      The form is installed on the printer as given by the printer properties
      dialog. It is available from an alternate form source without operator
      intervention. If the form does not have this bit set, and is used (if the
      user selects it), a "forms mismatch" error is generated by the printer
      object.
   HCAPS_CURRENT
      The form is the one currently selected by the DevOpenDC DEVOPENSTRUC
      pdriv field (the job properties).


ΓòÉΓòÉΓòÉ 4.78. HDC ΓòÉΓòÉΓòÉ

HDC Device-context handle.

typedef LHANDLE HDC;


ΓòÉΓòÉΓòÉ 4.79. HDDF ΓòÉΓòÉΓòÉ

HDDF Dynamic data formatting handle.

typedef VOID *HDDF;


ΓòÉΓòÉΓòÉ 4.80. HELPINIT ΓòÉΓòÉΓòÉ

HELPINIT Help Manager initialization structure.

typedef struct _HELPINIT {
ULONG        cb;                        /* Count of bytes of the initialization structure  */
ULONG        ulReturnCode;              /* Value returned by the Help Manager from initialization  */
PSZ          pszTutorialName;           /* indicates to the Help Manager that the application has a tutorial program  */
HELPTABLE    htHelpTable;               /* Help table  */
HMODULE      hmodHelpTableModule;       /* Resource file identity  */
HMODULE      hmodAccelActionBarModule;  /* Handle of the containing DLL  */
ULONG        idAccelTable;              /* Identity of the accelerator table  */
ULONG        idActionBar;               /* Identity of the action bar template used by the  e Help Manager  */
PSZ          pszHelpWindowTitle;        /* Window title for the main help window of this help instance  */
ULONG        fShowPanelId;              /* Show panel identity indicator  */
PSZ          pszHelpLibraryName;        /* Help panel library names  */
 } HELPINIT;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Count of bytes of the initialization structure.


ΓòÉΓòÉΓòÉ <hidden> ulReturnCode ΓòÉΓòÉΓòÉ

ulReturnCode (ULONG)
   Value returned by the Help Manager from initialization.

   0
      Initialization was successful.


ΓòÉΓòÉΓòÉ <hidden> pszTutorialName ΓòÉΓòÉΓòÉ

pszTutorialName (PSZ)
   indicates to the Help Manager that the application has a tutorial program.

   NULL
      The application either does not have a tutorial program, or the tutorial
      name is specified in each help panel definition.
   Other
      Default tutorial name.


ΓòÉΓòÉΓòÉ <hidden> htHelpTable ΓòÉΓòÉΓòÉ

htHelpTable (HELPTABLE)
   Help table.

   The help table or the identity of the help table. If this is the identity of
   the help table in a resource file, the low-order word contains the identity
   of the table and the high-order word must be X'FFFF'.
   The help table associates each application window with its help subtable and
   the identity of its extended help panel.


ΓòÉΓòÉΓòÉ <hidden> hmodHelpTableModule ΓòÉΓòÉΓòÉ

hmodHelpTableModule (HMODULE)
   Resource file identity.

   If the htHelpTable contains the identity of the help table, this field
   identifies the module handle returned by the DosLoadModule call by which the
   application loaded the resource file.

   NULL
      The resource file containing the help table was appended to the
      application's .EXE file.
   Other
      Resource file identity.


ΓòÉΓòÉΓòÉ <hidden> hmodAccelActionBarModule ΓòÉΓòÉΓòÉ

hmodAccelActionBarModule (HMODULE)
   Handle of the containing DLL.

   The handle of the DLL which contains the accelerator table and action bar
   template to be used by the Help Manager.

   NULL
      Use the default action bar and accelerator table defined by the Help
      Manager.
   Other
      Handle of the DLL.


ΓòÉΓòÉΓòÉ <hidden> idAccelTable ΓòÉΓòÉΓòÉ

idAccelTable (ULONG)
   Identity of the accelerator table.

   The accelerator table resides in the DLL provided in the
   hmodAccelActionBarModule field.

   NULL
      Use the default accelerator table.
   Other
      Identity of the accelerator table.


ΓòÉΓòÉΓòÉ <hidden> idActionBar ΓòÉΓòÉΓòÉ

idActionBar (ULONG)
   Identity of the action bar template used by the  e Help Manager.

   The action bar template resides in the DLL provided in the
   hmodAccelActionBarModule field.

   NULL
      Use the default action bar.
   Other
      Identity of the action bar.


ΓòÉΓòÉΓòÉ <hidden> pszHelpWindowTitle ΓòÉΓòÉΓòÉ

pszHelpWindowTitle (PSZ)
   Window title for the main help window of this help instance.


ΓòÉΓòÉΓòÉ <hidden> fShowPanelId ΓòÉΓòÉΓòÉ

fShowPanelId (ULONG)
   Show panel identity indicator.

   The constants corresponding to the panel identity flags are in the PMHELP.H
   include file.

   CMIC_SHOW_PANEL_ID
      Show the panel identity on a help panel.
   CMIC_HIDE_PANEL_ID
      Do not show the panel identity on a help panel.


ΓòÉΓòÉΓòÉ <hidden> pszHelpLibraryName ΓòÉΓòÉΓòÉ

pszHelpLibraryName (PSZ)
   Help panel library names.

   The names of the help panel libraries that the Help Manager searches on each
   help request. The names must be separated by a blank.
   The Help Manager looks for the libraries in the path set by the HELP
   environment variable. If the library is not found, the Help Manager will
   look for the libraries in the current directory.


ΓòÉΓòÉΓòÉ 4.81. HELPTABLE ΓòÉΓòÉΓòÉ

HELPTABLE Help table.

This is a collection of help table entries, each of which has the structure
defined below, the last entry of the collection being a NULL structure.

typedef struct _HELPTABLE {
USHORT           idAppWindow;       /* Application window identity  */
PHELPSUBTABLE    phstHelpSubTable;  /* Help subtable for this application window  */
USHORT           idExtPanel;        /* Identity of the extended help panel for the application window  */
 } HELPTABLE;


ΓòÉΓòÉΓòÉ <hidden> idAppWindow ΓòÉΓòÉΓòÉ

idAppWindow (USHORT)
   Application window identity.


ΓòÉΓòÉΓòÉ <hidden> phstHelpSubTable ΓòÉΓòÉΓòÉ

phstHelpSubTable (PHELPSUBTABLE)
   Help subtable for this application window.


ΓòÉΓòÉΓòÉ <hidden> idExtPanel ΓòÉΓòÉΓòÉ

idExtPanel (USHORT)
   Identity of the extended help panel for the application window.


ΓòÉΓòÉΓòÉ 4.82. HENUM ΓòÉΓòÉΓòÉ

HENUM Window-enumeration handle.

typedef LHANDLE HENUM;


ΓòÉΓòÉΓòÉ 4.83. HEV ΓòÉΓòÉΓòÉ

HEV 32-bit value used as an event handle.

typedef ULONG HEV;


ΓòÉΓòÉΓòÉ 4.84. HFILE ΓòÉΓòÉΓòÉ

HFILE Resource handle.

typedef LHANDLE HFILE;


ΓòÉΓòÉΓòÉ 4.85. HFIND ΓòÉΓòÉΓòÉ

HFIND Handle associated to a wpclsFindObjectFirst request.

typedef LHANDLE HFIND;


ΓòÉΓòÉΓòÉ 4.86. HINI ΓòÉΓòÉΓòÉ

HINI Initialization-file handle.

typedef LHANDLE HINI;


ΓòÉΓòÉΓòÉ 4.87. HLIB ΓòÉΓòÉΓòÉ

HLIB Library handle.

typedef HMODULE HLIB;


ΓòÉΓòÉΓòÉ 4.88. HMF ΓòÉΓòÉΓòÉ

HMF Metafile handle.

typedef LHANDLE HMF;


ΓòÉΓòÉΓòÉ 4.89. HMODULE ΓòÉΓòÉΓòÉ

HMODULE Module handle.

typedef LHANDLE HMODULE;


ΓòÉΓòÉΓòÉ 4.90. HMQ ΓòÉΓòÉΓòÉ

HMQ Message-queue handle.

typedef LHANDLE HMQ;


ΓòÉΓòÉΓòÉ 4.91. HMTX ΓòÉΓòÉΓòÉ

HMTX 32-bit value used as a mutex-semaphore handle.

typedef ULONG HMTX;


ΓòÉΓòÉΓòÉ 4.92. HMUX ΓòÉΓòÉΓòÉ

HMUX 32-bit value used as a muxwait semaphore handle.

typedef ULONG HMUX;


ΓòÉΓòÉΓòÉ 4.93. HOBJECT ΓòÉΓòÉΓòÉ

HOBJECT Workplace object handle.

typedef LHANDLE HOBJECT;


ΓòÉΓòÉΓòÉ 4.94. HPAL ΓòÉΓòÉΓòÉ

HPAL Palette handle.

typedef LHANDLE HPAL;


ΓòÉΓòÉΓòÉ 4.95. HPOINTER ΓòÉΓòÉΓòÉ

HPOINTER Pointer handle.

typedef LHANDLE HPOINTER;


ΓòÉΓòÉΓòÉ 4.96. HPROC ΓòÉΓòÉΓòÉ

HPROC Processor handle.

typedef LHANDLE HPROC;


ΓòÉΓòÉΓòÉ 4.97. HPROGARRAY ΓòÉΓòÉΓòÉ

HPROGARRAY Array of program handles.

typedef struct _HPROGARRAY {
HPROGRAM    ahprog[1];  /* Program handle array  */
 } HPROGARRAY;


ΓòÉΓòÉΓòÉ <hidden> ahprog[1] ΓòÉΓòÉΓòÉ

ahprog[1] (HPROGRAM)
   Program handle array.


ΓòÉΓòÉΓòÉ 4.98. HPROGRAM ΓòÉΓòÉΓòÉ

HPROGRAM Program handle.

typedef LHANDLE HPROGRAM;


ΓòÉΓòÉΓòÉ 4.99. HPS ΓòÉΓòÉΓòÉ

HPS Presentation-space handle.

typedef LHANDLE HPS;


ΓòÉΓòÉΓòÉ 4.100. HRGN ΓòÉΓòÉΓòÉ

HRGN Region handle.

typedef LHANDLE HRGN;


ΓòÉΓòÉΓòÉ 4.101. HSAVEWP ΓòÉΓòÉΓòÉ

HSAVEWP Frame window-repositioning process handle.

typedef LHANDLE HSAVEWP;


ΓòÉΓòÉΓòÉ 4.102. HSEM ΓòÉΓòÉΓòÉ

HSEM Semaphore handle.

typedef VOID *HSEM;


ΓòÉΓòÉΓòÉ 4.103. HSPL ΓòÉΓòÉΓòÉ

HSPL Spooler handle.

typedef LHANDLE HSPL;


ΓòÉΓòÉΓòÉ 4.104. HSTR ΓòÉΓòÉΓòÉ

HSTR String handle.

typedef LHANDLE HSTR;


ΓòÉΓòÉΓòÉ 4.105. HSWITCH ΓòÉΓòÉΓòÉ

HSWITCH Switch-list entry handle.

typedef LHANDLE HSWITCH;


ΓòÉΓòÉΓòÉ 4.106. HWND ΓòÉΓòÉΓòÉ

HWND Window handle.

typedef LHANDLE HWND;


ΓòÉΓòÉΓòÉ 4.107. ICONINFO ΓòÉΓòÉΓòÉ

ICONINFO Icon information data structure.

typedef struct _ICONINFO {
ULONG      cb;            /* Length of ICONINFO structure */
ULONG      fFormat;       /* Indicates from where the icon resides */
PSZ        pszFileName;   /* Name of file containing icon data */
HMODULE    hmod;          /* Module containing the icon resource */
ULONG      resid;         /* Identity of icon resource */
ULONG      cbIconData;    /* Length of icon data in bytes */
PVOID      pIconData;     /* Pointer to buffer containing icon data */
 } ICONINFO;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Length of ICONINFO structure.


ΓòÉΓòÉΓòÉ <hidden> fFormat ΓòÉΓòÉΓòÉ

fFormat (ULONG)
   Indicates from where the icon resides.

   Possible values are:

   ICON_FILE
      Icon file supplied.
   ICON_RESOURCE
      Icon resource supplied.
   ICON_DATA
      Icon data supplied.
   ICON_CLEAR
      Go back to default icon.


ΓòÉΓòÉΓòÉ <hidden> pszFileName ΓòÉΓòÉΓòÉ

pszFileName (PSZ)
   Name of file containing icon data. This value is ignored if fFormat is not
   equal to to ICON_FILE.


ΓòÉΓòÉΓòÉ <hidden> hmod ΓòÉΓòÉΓòÉ

hmod (HMODULE)
   Module containing the icon resource. This value is ignored if fFormat is not
   equal to to ICON_RESOURCE.


ΓòÉΓòÉΓòÉ <hidden> resid ΓòÉΓòÉΓòÉ

resid (ULONG)
   Identity of icon resource. This value is ignored if fFormat is not equal to
   to ICON_RESOURCE.


ΓòÉΓòÉΓòÉ <hidden> cbIconData ΓòÉΓòÉΓòÉ

cbIconData (ULONG)
   Length of icon data in bytes. This value is ignored if fFormat is not equal
   to to ICON_DATA.


ΓòÉΓòÉΓòÉ <hidden> pIconData ΓòÉΓòÉΓòÉ

pIconData (PVOID)
   Pointer to buffer containing icon data. This value is ignored if fFormat is
   not equal to to ICON_DATA.


ΓòÉΓòÉΓòÉ 4.108. ICONPOS ΓòÉΓòÉΓòÉ

ICONPOS Icon position structure.

typedef struct _ICONPOS {
POINTL    ptlIcon;          /* Position of icon */
CHAR      szIdentity[1];    /* Object identity string */
 } ICONPOS;


ΓòÉΓòÉΓòÉ <hidden> ptlIcon ΓòÉΓòÉΓòÉ

ptlIcon (POINTL)
   Position of the icon.


ΓòÉΓòÉΓòÉ <hidden> szIdentity[1] ΓòÉΓòÉΓòÉ

szIdentity[1] (CHAR)
   Object identity string.


ΓòÉΓòÉΓòÉ 4.109. IMAGEBUNDLE ΓòÉΓòÉΓòÉ

IMAGEBUNDLE Image-attributes bundle structure.

typedef struct _IMAGEBUNDLE {
LONG      lColor;         /* Image foreground color  */
LONG      lBackColor;     /* Image background color  */
USHORT    usMixMode;      /* Image foreground-mix mode  */
USHORT    usBackMixMode;  /* Image background-mix mode  */
 } IMAGEBUNDLE;


ΓòÉΓòÉΓòÉ <hidden> lColor ΓòÉΓòÉΓòÉ

lColor (LONG)
   Image foreground color.


ΓòÉΓòÉΓòÉ <hidden> lBackColor ΓòÉΓòÉΓòÉ

lBackColor (LONG)
   Image background color.


ΓòÉΓòÉΓòÉ <hidden> usMixMode ΓòÉΓòÉΓòÉ

usMixMode (USHORT)
   Image foreground-mix mode.


ΓòÉΓòÉΓòÉ <hidden> usBackMixMode ΓòÉΓòÉΓòÉ

usBackMixMode (USHORT)
   Image background-mix mode.


ΓòÉΓòÉΓòÉ 4.110. IPT ΓòÉΓòÉΓòÉ

IPT Insertion point for multi-line entry field.

typedef LONG IPT;


ΓòÉΓòÉΓòÉ 4.111. KERNINGPAIRS ΓòÉΓòÉΓòÉ

KERNINGPAIRS Kerning-pair records structure.

typedef struct _KERNINGPAIRS {
SHORT    sFirstChar;      /* First character of pair  */
SHORT    sSecondChar;     /* Second character of pair  */
LONG     lKerningAmount;  /* Amount of kerning for this pair  */
 } KERNINGPAIRS;


ΓòÉΓòÉΓòÉ <hidden> sFirstChar ΓòÉΓòÉΓòÉ

sFirstChar (SHORT)
   First character of pair.


ΓòÉΓòÉΓòÉ <hidden> sSecondChar ΓòÉΓòÉΓòÉ

sSecondChar (SHORT)
   Second character of pair.


ΓòÉΓòÉΓòÉ <hidden> lKerningAmount ΓòÉΓòÉΓòÉ

lKerningAmount (LONG)
   Amount of kerning for this pair.


ΓòÉΓòÉΓòÉ 4.112. LHANDLE ΓòÉΓòÉΓòÉ

LHANDLE The handle of a resource.

typedef unsigned long LHANDLE;


ΓòÉΓòÉΓòÉ 4.113. LINEBUNDLE ΓòÉΓòÉΓòÉ

LINEBUNDLE Line-attributes bundle structure.

typedef struct _LINEBUNDLE {
LONG      lColor;         /* Line foreground color  */
LONG      lBackColor;     /* Line background color  */
USHORT    usMixMode;      /* Line foreground-mix mode  */
USHORT    usBackMixMode;  /* Line background-mix mode  */
FIXED     fxWidth;        /* Line width  */
LONG      lGeomWidth;     /* Geometric line width  */
USHORT    usType;         /* Line type  */
USHORT    usEnd;          /* Line end  */
USHORT    usJoin;         /* Line join  */
USHORT    usReserved;     /* Reserved  */
 } LINEBUNDLE;


ΓòÉΓòÉΓòÉ <hidden> lColor ΓòÉΓòÉΓòÉ

lColor (LONG)
   Line foreground color.


ΓòÉΓòÉΓòÉ <hidden> lBackColor ΓòÉΓòÉΓòÉ

lBackColor (LONG)
   Line background color.


ΓòÉΓòÉΓòÉ <hidden> usMixMode ΓòÉΓòÉΓòÉ

usMixMode (USHORT)
   Line foreground-mix mode.


ΓòÉΓòÉΓòÉ <hidden> usBackMixMode ΓòÉΓòÉΓòÉ

usBackMixMode (USHORT)
   Line background-mix mode.


ΓòÉΓòÉΓòÉ <hidden> fxWidth ΓòÉΓòÉΓòÉ

fxWidth (FIXED)
   Line width.


ΓòÉΓòÉΓòÉ <hidden> lGeomWidth ΓòÉΓòÉΓòÉ

lGeomWidth (LONG)
   Geometric line width.


ΓòÉΓòÉΓòÉ <hidden> usType ΓòÉΓòÉΓòÉ

usType (USHORT)
   Line type.


ΓòÉΓòÉΓòÉ <hidden> usEnd ΓòÉΓòÉΓòÉ

usEnd (USHORT)
   Line end.


ΓòÉΓòÉΓòÉ <hidden> usJoin ΓòÉΓòÉΓòÉ

usJoin (USHORT)
   Line join.


ΓòÉΓòÉΓòÉ <hidden> usReserved ΓòÉΓòÉΓòÉ

usReserved (USHORT)
   Reserved.


ΓòÉΓòÉΓòÉ 4.114. LINKITEM ΓòÉΓòÉΓòÉ

LINKITEM USAGE_LINK structure.

typedef struct _LINKITEM {
WPObject *LinkObj;  /* The link object  */
 } LINKITEM;


ΓòÉΓòÉΓòÉ <hidden> LinkObj ΓòÉΓòÉΓòÉ

LinkObj (WPObject *)
   The link object.


ΓòÉΓòÉΓòÉ 4.115. LONG ΓòÉΓòÉΓòÉ

LONG Signed integer in the range -2 147 483 648 through 2 147 483 647.

#define LONG long

Note:  Where this data type represents a graphic coordinate in world or model
       space, its value is restricted to -134 217 728 through 134 217 727.

A graphic coordinate in device or screen coordinates is restricted to -32 768
through 32 767.

The value of a graphic coordinate may be further restricted by any transforms
currently in force, including the positioning of the origin of the window on
the screen. In particular, coordinates in world or model space must not
generate coordinate values after transformation (that is, in device or screen
space) outside the range -32 768 through 32 767.


ΓòÉΓòÉΓòÉ 4.116. M_WPFileSystem * ΓòÉΓòÉΓòÉ

M_WPFileSystem *  Pointer to a WPFileSystem class object.


ΓòÉΓòÉΓòÉ 4.117. M_WPFolder * ΓòÉΓòÉΓòÉ

M_WPFolder *  Pointer to a WPFolder class object.


ΓòÉΓòÉΓòÉ 4.118. M_WPObject * ΓòÉΓòÉΓòÉ

M_WPObject *  Pointer to a WPObject class object.


ΓòÉΓòÉΓòÉ 4.119. M_WPPalette * ΓòÉΓòÉΓòÉ

M_WPPalette *  Pointer to a WPPalette class object.


ΓòÉΓòÉΓòÉ 4.120. MARKERBUNDLE ΓòÉΓòÉΓòÉ

MARKERBUNDLE Marker-attributes bundle structure.

typedef struct _MARKERBUNDLE {
LONG      lColor;         /* Marker foreground color  */
LONG      lBackColor;     /* Marker background color  */
USHORT    usMixMode;      /* Marker foreground-mix mode  */
USHORT    usBackMixMode;  /* Marker background-mix mode  */
USHORT    usSet;          /* Marker set  */
USHORT    usSymbol;       /* Marker symbol  */
SIZEF     sizfxCell;      /* Marker cell  */
 } MARKERBUNDLE;


ΓòÉΓòÉΓòÉ <hidden> lColor ΓòÉΓòÉΓòÉ

lColor (LONG)
   Marker foreground color.


ΓòÉΓòÉΓòÉ <hidden> lBackColor ΓòÉΓòÉΓòÉ

lBackColor (LONG)
   Marker background color.


ΓòÉΓòÉΓòÉ <hidden> usMixMode ΓòÉΓòÉΓòÉ

usMixMode (USHORT)
   Marker foreground-mix mode.


ΓòÉΓòÉΓòÉ <hidden> usBackMixMode ΓòÉΓòÉΓòÉ

usBackMixMode (USHORT)
   Marker background-mix mode.


ΓòÉΓòÉΓòÉ <hidden> usSet ΓòÉΓòÉΓòÉ

usSet (USHORT)
   Marker set.


ΓòÉΓòÉΓòÉ <hidden> usSymbol ΓòÉΓòÉΓòÉ

usSymbol (USHORT)
   Marker symbol.


ΓòÉΓòÉΓòÉ <hidden> sizfxCell ΓòÉΓòÉΓòÉ

sizfxCell (SIZEF)
   Marker cell.


ΓòÉΓòÉΓòÉ 4.121. MATRIXLF ΓòÉΓòÉΓòÉ

MATRIXLF Matrix-elements structure.

typedef struct _MATRIXLF {
FIXED    fxM11;  /* First element of first row  */
FIXED    fxM12;  /* Second element of first row  */
LONG     lM13;   /* Third element of first row  */
FIXED    fxM21;  /* First element of second row  */
FIXED    fxM22;  /* Second element of second row  */
LONG     lM23;   /* Third element of second row  */
LONG     lM31;   /* First element of third row  */
LONG     lM32;   /* Second element of third row  */
LONG     lM33;   /* Third element of third row  */
 } MATRIXLF;


ΓòÉΓòÉΓòÉ <hidden> fxM11 ΓòÉΓòÉΓòÉ

fxM11 (FIXED)
   First element of first row.


ΓòÉΓòÉΓòÉ <hidden> fxM12 ΓòÉΓòÉΓòÉ

fxM12 (FIXED)
   Second element of first row.


ΓòÉΓòÉΓòÉ <hidden> lM13 ΓòÉΓòÉΓòÉ

lM13 (LONG)
   Third element of first row.


ΓòÉΓòÉΓòÉ <hidden> fxM21 ΓòÉΓòÉΓòÉ

fxM21 (FIXED)
   First element of second row.


ΓòÉΓòÉΓòÉ <hidden> fxM22 ΓòÉΓòÉΓòÉ

fxM22 (FIXED)
   Second element of second row.


ΓòÉΓòÉΓòÉ <hidden> lM23 ΓòÉΓòÉΓòÉ

lM23 (LONG)
   Third element of second row.


ΓòÉΓòÉΓòÉ <hidden> lM31 ΓòÉΓòÉΓòÉ

lM31 (LONG)
   First element of third row.


ΓòÉΓòÉΓòÉ <hidden> lM32 ΓòÉΓòÉΓòÉ

lM32 (LONG)
   Second element of third row.


ΓòÉΓòÉΓòÉ <hidden> lM33 ΓòÉΓòÉΓòÉ

lM33 (LONG)
   Third element of third row.


ΓòÉΓòÉΓòÉ 4.122. MEMORYITEM ΓòÉΓòÉΓòÉ

MEMORYITEM USAGE_MEMORY structure.

typedef struct _MEMORYITEM {
ULONG    cbBuffer;  /* Number of bytes in memory block  */
 } MEMORYITEM;


ΓòÉΓòÉΓòÉ <hidden> cbBuffer ΓòÉΓòÉΓòÉ

cbBuffer (ULONG)
   Number of bytes in memory block.


ΓòÉΓòÉΓòÉ 4.123. MENUITEM ΓòÉΓòÉΓòÉ

MENUITEM Menu item.

typedef struct _MENUITEM {
SHORT     iPosition;    /* Position  */
USHORT    afStyle;      /* Style  */
USHORT    afAttribute;  /* Attribute  */
USHORT    id;           /* Identity  */
HWND      hwndSubMenu;  /* Submenu  */
ULONG     hItem;        /* Item  */
 } MENUITEM;


ΓòÉΓòÉΓòÉ <hidden> iPosition ΓòÉΓòÉΓòÉ

iPosition (SHORT)
   Position.


ΓòÉΓòÉΓòÉ <hidden> afStyle ΓòÉΓòÉΓòÉ

afStyle (USHORT)
   Style.


ΓòÉΓòÉΓòÉ <hidden> afAttribute ΓòÉΓòÉΓòÉ

afAttribute (USHORT)
   Attribute.


ΓòÉΓòÉΓòÉ <hidden> id ΓòÉΓòÉΓòÉ

id (USHORT)
   Identity.


ΓòÉΓòÉΓòÉ <hidden> hwndSubMenu ΓòÉΓòÉΓòÉ

hwndSubMenu (HWND)
   Submenu.


ΓòÉΓòÉΓòÉ <hidden> hItem ΓòÉΓòÉΓòÉ

hItem (ULONG)
   Item.


ΓòÉΓòÉΓòÉ 4.124. MFP ΓòÉΓòÉΓòÉ

MFP Structure to define metafile data being passed on the clipboard.

typedef struct _MFP {
POINTL    sizeBounds;  /* Metafile notational grid size  */
POINTL    sizeMM;      /* Metafile size high metric units  */
ULONG     cbLength;    /* Length of metafile data  */
USHORT    mapMode;     /* A PM metafile map mode  */
USHORT    reserved;    /* Reserved  */
BYTE      abData[1];   /* Metafile data  */
 } MFP;


ΓòÉΓòÉΓòÉ <hidden> sizeBounds ΓòÉΓòÉΓòÉ

sizeBounds (POINTL)
   Metafile notational grid size.


ΓòÉΓòÉΓòÉ <hidden> sizeMM ΓòÉΓòÉΓòÉ

sizeMM (POINTL)
   Metafile size high metric units.


ΓòÉΓòÉΓòÉ <hidden> cbLength ΓòÉΓòÉΓòÉ

cbLength (ULONG)
   Length of metafile data.


ΓòÉΓòÉΓòÉ <hidden> mapMode ΓòÉΓòÉΓòÉ

mapMode (USHORT)
   A PM metafile map mode.


ΓòÉΓòÉΓòÉ <hidden> reserved ΓòÉΓòÉΓòÉ

reserved (USHORT)
   Reserved.


ΓòÉΓòÉΓòÉ <hidden> abData[1] ΓòÉΓòÉΓòÉ

abData[1] (BYTE)
   Metafile data.


ΓòÉΓòÉΓòÉ 4.125. MINIRECORDCORE ΓòÉΓòÉΓòÉ

MINIRECORDCORE Structure that contains information for smaller records than
those defined by the RECORDCORE data structure. This data structure is used if
the CCS_MINIRECORDCORE style bit is specified when a container is created.

typedef struct _MINIRECORDCORE {
ULONG                      cb;               /* Structure size  */
ULONG                      flRecordAttr;     /* Attributes of container records  */
POINTL                     ptlIcon;          /* Record position  */
struct _MINIRECORDCORE    *preccNextRecord;  /* Pointer  */
PSZ                        pszIcon;          /* Record text  */
HPOINTER                   hptrIcon;         /* Record icon  */
 } MINIRECORDCORE;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   The size (in bytes) of the MINIRECORDCORE structure.


ΓòÉΓòÉΓòÉ <hidden> flRecordAttr ΓòÉΓòÉΓòÉ

flRecordAttr (ULONG)
   Attributes of container records.

   Contains any or all of the following:

   CRA_COLLAPSED
      Specifies that a record is collapsed.
   CRA_CURSORED
      Specifies that a record will be drawn with a selection cursor.
   CRA_DROPONABLE
      Specifies that a record can be a target for direct manipulation.
   CRA_EXPANDED
      Specifies that a record is expanded.
   CRA_FILTERED
      Specifies that a record is filtered, and therefore hidden from view.
   CRA_INUSE
      Specifies that a record will be drawn with in-use emphasis.
   CRA_RECORDREADONLY
      Prevents a record from being edited directly.
   CRA_SELECTED
      Specifies that a record will be drawn with selected-state emphasis.
   CRA_TARGET
      Specifies that a record will be drawn with target emphasis.


ΓòÉΓòÉΓòÉ <hidden> ptlIcon ΓòÉΓòÉΓòÉ

ptlIcon (POINTL)
   Record position.

   Position of a container record in the icon view.


ΓòÉΓòÉΓòÉ <hidden> preccNextRecord ΓòÉΓòÉΓòÉ

preccNextRecord (struct _MINIRECORDCORE *)
   Pointer.

   Pointer to the next linked record.


ΓòÉΓòÉΓòÉ <hidden> pszIcon ΓòÉΓòÉΓòÉ

pszIcon (PSZ)
   Record text.

   Text for the container record.


ΓòÉΓòÉΓòÉ <hidden> hptrIcon ΓòÉΓòÉΓòÉ

hptrIcon (HPOINTER)
   Record icon.

   Icon that is displayed for the container record.


ΓòÉΓòÉΓòÉ 4.126. MLECTLDATA ΓòÉΓòÉΓòÉ

MLECTLDATA Multiline entry-field (MLE) control data structure.

typedef struct _MLECTLDATA {
USHORT    cbCtlData;      /* Length of control data in bytes  */
USHORT    afIEFormat;     /* Import/export format  */
ULONG     cchText;        /* Text limit  */
IPT       iptAnchor;      /* Selection anchor point  */
IPT       iptCursor;      /* Selection cursor point  */
LONG      cxFormat;       /* Formatting-rectangle width in pels  */
LONG      cyFormat;       /* Formatting-rectangle height in pels  */
ULONG     afFormatFlags;  /* Format flags  */
 } MLECTLDATA;


ΓòÉΓòÉΓòÉ <hidden> cbCtlData ΓòÉΓòÉΓòÉ

cbCtlData (USHORT)
   Length of control data in bytes.


ΓòÉΓòÉΓòÉ <hidden> afIEFormat ΓòÉΓòÉΓòÉ

afIEFormat (USHORT)
   Import/export format.

   This sets the initial import/export format.  Setting this value via control
   data is considered identical to setting it through the MLM_FORMAT message.
   The same constants apply here. The default is MLE_CFTEXT.


ΓòÉΓòÉΓòÉ <hidden> cchText ΓòÉΓòÉΓòÉ

cchText (ULONG)
   Text limit.

   The maximum amount of text allowed in the MLE.  This value is interpreted
   identically to the parameter of MLM_SETTEXTLIMIT. A negative value indicates
   that the length is considered unbounded.


ΓòÉΓòÉΓòÉ <hidden> iptAnchor ΓòÉΓòÉΓòÉ

iptAnchor (IPT)
   Selection anchor point.


ΓòÉΓòÉΓòÉ <hidden> iptCursor ΓòÉΓòÉΓòÉ

iptCursor (IPT)
   Selection cursor point.

   The iptAnchor and iptCursor parameters identify the beginning and ending
   points, respectively, of the selection.  These values may range from 0
   through the length of the text. The default is 0,0 and can be indicated by
   entering 0,0.


ΓòÉΓòÉΓòÉ <hidden> cxFormat ΓòÉΓòÉΓòÉ

cxFormat (LONG)
   Formatting-rectangle width in pels.


ΓòÉΓòÉΓòÉ <hidden> cyFormat ΓòÉΓòÉΓòÉ

cyFormat (LONG)
   Formatting-rectangle height in pels.

   The cxFormat and cyFormat parameters identify the dimensions in pels of the
   formatting rectangle, as can be set by the MLM_SETFORMATRECT message. These
   values are considered identical to the two fields in the format rectangle
   structure referenced in that message, and the interpretation of the values
   in these fields is governed by the afFormatFlags field.
   The default is the window size in both dimensions, and can be indicated by 0
   values.


ΓòÉΓòÉΓòÉ <hidden> afFormatFlags ΓòÉΓòÉΓòÉ

afFormatFlags (ULONG)
   Format flags.

   These flags govern the interpretation of the cxFormat and cyFormat fields,
   just as in the MLM_SETFORMATRECT message. The flag values defined there are
   also valid in this field. The default is unlimited in both directions, and
   is of varying size to match the window size.


ΓòÉΓòÉΓòÉ 4.127. MLEMARGSTRUCT ΓòÉΓòÉΓòÉ

MLEMARGSTRUCT Multiline entry-field margin information.

typedef struct _MLEMARGSTRUCT {
USHORT    afMargins;  /* Margin in witch event occurred */
USHORT    usMouMsg;   /* Message identity of original mouse event */
IPT       iptNear;    /* Insertion point nearest to margin event */
 } MLEMARGSTRUCT;


ΓòÉΓòÉΓòÉ <hidden> afMargins ΓòÉΓòÉΓòÉ

afMargins (USHORT)
   This gives the margin in which the event occurred.
   The left and right margins are defined as including the corners at the top
   and bottom, and the top and bottom margins are contained between them.
   Therefore, the corners are included in the sides.

   MLFMARGIN_LEFT

   MLFMARGIN_RIGHT

   MLFMARGIN_TOP

   MLFMARGIN_BOTTOM


ΓòÉΓòÉΓòÉ <hidden> usMouMsg ΓòÉΓòÉΓòÉ

usMouMsg (USHORT)
   The message identity of the original mouse event.


ΓòÉΓòÉΓòÉ <hidden> iptNear ΓòÉΓòÉΓòÉ

iptNear (IPT)
   The insertion point nearest to the margin event.


ΓòÉΓòÉΓòÉ 4.128. MLEOVERFLOW ΓòÉΓòÉΓòÉ

MLEOVERFLOW Overflow error structure for multiline entry field.

typedef struct _MLEOVERFLOW {
ULONG    afErrInd;     /* One or more EFR_* flags  */
LONG     nBytesOver;   /* Number of bytes over the limit  */
LONG     pixHorzOver;  /* Number of pels over the horizontal limit  */
LONG     pixVertOver;  /* Number of pels over the vertical limit  */
 } MLEOVERFLOW;


ΓòÉΓòÉΓòÉ <hidden> afErrInd ΓòÉΓòÉΓòÉ

afErrInd (ULONG)
   One or more EFR_* flags.


ΓòÉΓòÉΓòÉ <hidden> nBytesOver ΓòÉΓòÉΓòÉ

nBytesOver (LONG)
   Number of bytes over the limit.


ΓòÉΓòÉΓòÉ <hidden> pixHorzOver ΓòÉΓòÉΓòÉ

pixHorzOver (LONG)
   Number of pels over the horizontal limit.


ΓòÉΓòÉΓòÉ <hidden> pixVertOver ΓòÉΓòÉΓòÉ

pixVertOver (LONG)
   Number of pels over the vertical limit.


ΓòÉΓòÉΓòÉ 4.129. MLE_SEARCHDATA ΓòÉΓòÉΓòÉ

MLE_SEARCHDATA Search structure for multiline entry field.

typedef struct _SEARCH {
USHORT    cb;          /* Size of structure  */
PCHAR     pchFind;     /* String to search for  */
PCHAR     pchReplace;  /* String to replace with  */
SHORT     cchFind;     /* Length of pchFind string  */
SHORT     cchReplace;  /* Length of pchReplace string  */
IPT       iptStart;    /* Point at which to start search, or point where string was found  */
IPT       iptStop;     /* Point at which to stop search  */
USHORT    cchFound;    /* Length of string found at iptStart  */
 } MLE_SEARCHDATA;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (USHORT)
   Size of MLE_SEARCHDATA structure.


ΓòÉΓòÉΓòÉ <hidden> pchFind ΓòÉΓòÉΓòÉ

pchFind (PCHAR)
   String to search for.


ΓòÉΓòÉΓòÉ <hidden> pchReplace ΓòÉΓòÉΓòÉ

pchReplace (PCHAR)
   String to replace with.


ΓòÉΓòÉΓòÉ <hidden> cchFind ΓòÉΓòÉΓòÉ

cchFind (SHORT)
   Length of pchFind string.


ΓòÉΓòÉΓòÉ <hidden> cchReplace ΓòÉΓòÉΓòÉ

cchReplace (SHORT)
   Length of pchReplace string.


ΓòÉΓòÉΓòÉ <hidden> iptStart ΓòÉΓòÉΓòÉ

iptStart (IPT)
   Point at which to start search, or point where string was found.

   non-negative
      Point at which to start search.
   negative
      Start search from current cursor location.


ΓòÉΓòÉΓòÉ <hidden> iptStop ΓòÉΓòÉΓòÉ

iptStop (IPT)
   Point at which to stop search.

   non-negative
      Point at which to stop search.
   negative
      Stop search at end of text.


ΓòÉΓòÉΓòÉ <hidden> cchFound ΓòÉΓòÉΓòÉ

cchFound (USHORT)
   Length of string found at iptStart.


ΓòÉΓòÉΓòÉ 4.130. MPARAM ΓòÉΓòÉΓòÉ

MPARAM 4-byte message-dependent parameter structure.

typedef VOID *MPARAM;

Certain elements of information, placed into the parameters of a message, have
data types that do not use all 4 bytes of this data type. The rules governing
these cases are:

BOOL      The value is contained in the low word and the high word is 0.
SHORT     The value is contained in the low word and its sign is extended into
          the high word.
USHORT    The value is contained in the low word and the high word is 0.
NULL      The entire 4 bytes are 0.


ΓòÉΓòÉΓòÉ 4.131. MQINFO ΓòÉΓòÉΓòÉ

MQINFO Message-queue information structure.

typedef struct _MQINFO {
ULONG    cb;         /* Length of structure  */
PID      pid;        /* Process identity  */
TID      tid;        /* Thread identity  */
ULONG    cmsgs;      /* Message count  */
PVOID    pReserved;  /* Reserved  */
 } MQINFO;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Length of structure.


ΓòÉΓòÉΓòÉ <hidden> pid ΓòÉΓòÉΓòÉ

pid (PID)
   Process identity.


ΓòÉΓòÉΓòÉ <hidden> tid ΓòÉΓòÉΓòÉ

tid (TID)
   Thread identity.


ΓòÉΓòÉΓòÉ <hidden> cmsgs ΓòÉΓòÉΓòÉ

cmsgs (ULONG)
   Message count.


ΓòÉΓòÉΓòÉ <hidden> pReserved ΓòÉΓòÉΓòÉ

pReserved (PVOID)
   Reserved.


ΓòÉΓòÉΓòÉ 4.132. MRESULT ΓòÉΓòÉΓòÉ

MRESULT 4-byte message-dependent reply parameter structure.

typedef VOID *MRESULT;

Certain elements of information, placed into the parameters of a message, have
data types that do not use all 4 bytes of this data type. The rules governing
these cases are:

BOOL      The value is contained in the low word and the high word is 0.
SHORT     The value is contained in the low word and its sign is extended into
          the high word.
USHORT    The value is contained in the low word and the high word is 0.
NULL      The entire 4 bytes are 0.


ΓòÉΓòÉΓòÉ 4.133. MSEMSG ΓòÉΓòÉΓòÉ

MSEMSG This data structure and an associated macro (MOUSEMSG) are used to
access the WM_MOUSEMOVE message parameters, as well as the message parameters
for the WM_BUTTON* messages involving button-up, button-down, and button-click
events.

The macro associated with this data structure, MOUSEMSG, is defined as follows:

#define MOUSEMSG(pmsg)   ((PMSEMSG)((PBYTE)pmsg + sizeof(MPARAM) ))

The structure and macro are both defined in PMWIN.H.

typedef struct _MOUSEMSG {
SHORT     x;            /* X-coordinate of the pointing device  */
SHORT     y;            /* Y-coordinate of the pointing device  */
USHORT    codeHitTest;  /* Hit test result  */
USHORT    fsInp;        /* Keyboard control flags  */
 } MSEMSG;


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (SHORT)
   X-coordinate of the pointing device.

   This field is from the first message parameter (mp1).


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (SHORT)
   Y-coordinate of the pointing device.

   This field is from the first message parameter (mp1).


ΓòÉΓòÉΓòÉ <hidden> codeHitTest ΓòÉΓòÉΓòÉ

codeHitTest (USHORT)
   Hit test result.

   This field is from the second message parameter (mp2).


ΓòÉΓòÉΓòÉ <hidden> fsInp ΓòÉΓòÉΓòÉ

fsInp (USHORT)
   Keyboard control flags.

   This field is from the second message parameter (mp2).


ΓòÉΓòÉΓòÉ 4.134. MT ΓòÉΓòÉΓòÉ

MT Menu template.

This data structure is specific to version 2.1, or higher, of the OS/2
operating system.

typedef struct _MT {
ULONG     len;       /* Length of template in bytes  */
USHORT    codepage;  /* Code page  */
USHORT    reserved;  /* Reserved  */
USHORT    cMti;      /* Count of template items  */
MTI       rgMti[1];  /* Menu items  */
 } MT;


ΓòÉΓòÉΓòÉ <hidden> len ΓòÉΓòÉΓòÉ

len (ULONG)
   Length of template in bytes.


ΓòÉΓòÉΓòÉ <hidden> codepage ΓòÉΓòÉΓòÉ

codepage (USHORT)
   Code page.


ΓòÉΓòÉΓòÉ <hidden> reserved ΓòÉΓòÉΓòÉ

reserved (USHORT)
   Reserved.


ΓòÉΓòÉΓòÉ <hidden> cMti ΓòÉΓòÉΓòÉ

cMti (USHORT)
   Count of template items.


ΓòÉΓòÉΓòÉ <hidden> rgMti[1] ΓòÉΓòÉΓòÉ

rgMti[1] (MTI)
   Menu items.


ΓòÉΓòÉΓòÉ 4.135. MTI ΓòÉΓòÉΓòÉ

MTI Menu template item.

typedef struct _MTI {
USHORT    afStyle;  /* Style flags  */
USHORT    pad;      /* Pad for template  */
USHORT    idItem;   /* Item identity  */
CHAR      c[2];     /* Item data  */
 } MTI;


ΓòÉΓòÉΓòÉ <hidden> afStyle ΓòÉΓòÉΓòÉ

afStyle (USHORT)
   Style flags


ΓòÉΓòÉΓòÉ <hidden> pad ΓòÉΓòÉΓòÉ

pad (USHORT)
   Pad for template.


ΓòÉΓòÉΓòÉ <hidden> idItem ΓòÉΓòÉΓòÉ

idItem (USHORT)
   Item identity.


ΓòÉΓòÉΓòÉ <hidden> c[2] ΓòÉΓòÉΓòÉ

c[2] (CHAR)
   Item data.

   The format and length of this depend upon the value of afStyle.


ΓòÉΓòÉΓòÉ 4.136. NOTIFYDELTA ΓòÉΓòÉΓòÉ

NOTIFYDELTA Structure that contains information about the placement of delta
information for a container. This structure is used in the CN_QUERYDELTA
container notification code only.

typedef struct _NOTIFYDELTA {
HWND     hwndCnr;  /* Container control handle  */
ULONG    fDelta;   /* Placement of delta information  */
 } NOTIFYDELTA;


ΓòÉΓòÉΓòÉ <hidden> hwndCnr ΓòÉΓòÉΓòÉ

hwndCnr (HWND)
   Container control handle.


ΓòÉΓòÉΓòÉ <hidden> fDelta ΓòÉΓòÉΓòÉ

fDelta (ULONG)
   Placement of delta information.

   The values can be:

   CMA_DELTATOP
      The record that represents the delta value scrolls into view at the top
      of the client area.
   CMA_DELTABOT
      The record that represents the delta value scrolls into view at the
      bottom of the client area.
   CMA_DELTAHOME
      The container scrolls to the beginning of the list of all container
      records that are available to be inserted into the container, such as the
      first record in a database.
   CMA_DELTAEND
      The container scrolls to the end of the list of all container records
      that are available to be inserted into the container, such as the last
      record in a database.


ΓòÉΓòÉΓòÉ 4.137. NOTIFYRECORDEMPHASIS ΓòÉΓòÉΓòÉ

NOTIFYRECORDEMPHASIS Structure that contains information about emphasis that is
being applied to a container record. This structure is used in the CN_EMPHASIS
container notification code only.

typedef struct _NOTIFYRECORDEMPHASIS {
HWND           hwndCnr;        /* Container control handle  */
PRECORDCORE    pRecord;        /* Pointer  */
ULONG          fEmphasisMask;  /* Changed emphasis attributes  */
 } NOTIFYRECORDEMPHASIS;


ΓòÉΓòÉΓòÉ <hidden> hwndCnr ΓòÉΓòÉΓòÉ

hwndCnr (HWND)
   Container control handle.


ΓòÉΓòÉΓòÉ <hidden> pRecord ΓòÉΓòÉΓòÉ

pRecord (PRECORDCORE)
   Pointer.

   Pointer to a RECORDCORE data structure whose emphasis attribute has been
   changed.

   Note:  If the CCS_MINIRECORDCORE style bit is specified when a container is
   created, then MINIRECORDCORE should be used instead of RECORDCORE and
   PMINIRECORDCORE should be used instead of PRECORDCORE in all applicable data
   structures and messages.


ΓòÉΓòÉΓòÉ <hidden> fEmphasisMask ΓòÉΓòÉΓòÉ

fEmphasisMask (ULONG)
   Changed emphasis attributes.

   Specifies the emphasis attribute or attributes that changed in the container
   record. The following states can be combined with a logical OR operator (|):

   o CRA_CURSORED
   o CRA_INUSE
   o CRA_SELECTED.


ΓòÉΓòÉΓòÉ 4.138. NOTIFYRECORDENTER ΓòÉΓòÉΓòÉ

NOTIFYRECORDENTER Structure that contains information about the input device
that is being used with the container control. This structure is used in the
CN_ENTER container notification code only.

typedef struct _NOTIFYRECORDENTER {
HWND           hwndCnr;  /* Container control handle  */
ULONG          fKey;     /* Flag  */
PRECORDCORE    pRecord;  /* Pointer  */
 } NOTIFYRECORDENTER;


ΓòÉΓòÉΓòÉ <hidden> hwndCnr ΓòÉΓòÉΓòÉ

hwndCnr (HWND)
   Container control handle.


ΓòÉΓòÉΓòÉ <hidden> fKey ΓòÉΓòÉΓòÉ

fKey (ULONG)
   Flag.

   Flag that determines whether the Enter key was pressed or the select button
   was double-clicked.

   TRUE
      The Enter key was pressed.
   FALSE
      The select button was double-clicked.


ΓòÉΓòÉΓòÉ <hidden> pRecord ΓòÉΓòÉΓòÉ

pRecord (PRECORDCORE)
   Pointer.

   Pointer to the RECORDCORE data structure over which an action occurred.

   Note:  If the CCS_MINIRECORDCORE style bit is specified when a container is
   created, then MINIRECORDCORE should be used instead of RECORDCORE and
   PMINIRECORDCORE should be used instead of PRECORDCORE in all applicable data
   structures and messages.

   o If a user presses the Enter key, a pointer to the record with the
     selection cursor is returned.

   o If a user double-clicks the select button when the pointer of the pointing
     device is over a record, a pointer to the record is returned.

   o If a user double-clicks the select button when the pointer of the pointing
     device is over white space, NULL is returned.


ΓòÉΓòÉΓòÉ 4.139. NOTIFYSCROLL ΓòÉΓòÉΓòÉ

NOTIFYSCROLL Structure that contains information about scrolling a container
control window. This structure is used in the CN_SCROLL container notification
code only.

typedef struct _NOTIFYSCROLL {
HWND     hwndCnr;     /* Container control handle  */
LONG     lScrollInc;  /* Scroll amount  */
ULONG    fScroll;     /* Scroll flags  */
 } NOTIFYSCROLL;


ΓòÉΓòÉΓòÉ <hidden> hwndCnr ΓòÉΓòÉΓòÉ

hwndCnr (HWND)
   Container control handle.


ΓòÉΓòÉΓòÉ <hidden> lScrollInc ΓòÉΓòÉΓòÉ

lScrollInc (LONG)
   Scroll amount.

   Amount (in pixels) by which the window scrolled.


ΓòÉΓòÉΓòÉ <hidden> fScroll ΓòÉΓòÉΓòÉ

fScroll (ULONG)
   Scroll flags.

   Flags that show the direction in which the window scrolled and the window
   that was scrolled.

   CMA_HORIZONTAL
      A window was scrolled horizontally. If the split details view window is
      scrolled, a logical OR operator (|) is used to combine the CMA_HORIZONTAL
      attribute with either the CMA_LEFT attribute or the CMA_RIGHT attribute
      to indicate which window was scrolled. If the unsplit details view window
      is scrolled, the CMA_HORIZONTAL attribute is combined with the CMA_LEFT
      attribute.
   CMA_VERTICAL
      The container window scrolled vertically. If the split details view
      window is scrolled, a logical OR operator (|) is used to combine the
      CMA_VERTICAL attribute with the CMA_LEFT attribute and the CMA_RIGHT
      attribute. If the unsplit details view window is scrolled, the
      CMA_VERTICAL attribute is combined with the CMA_LEFT attribute.


ΓòÉΓòÉΓòÉ 4.140. OBJCLASS ΓòÉΓòÉΓòÉ

OBJCLASS Object class structure.

typedef struct _OBJCLASS {
struct _OBJCLASS *pNext;             /* Pointer to the next object class structure. */
PSZ               pszClassName;      /* Class name  */
PSZ               pszModName;        /* Module name  */
 } OBJCLASS;


ΓòÉΓòÉΓòÉ <hidden> pNext ΓòÉΓòÉΓòÉ

pNext (struct _OBJCLASS *)
   Pointer to the next object class structure.


ΓòÉΓòÉΓòÉ <hidden> pszClassName ΓòÉΓòÉΓòÉ

pszClassName (PSZ)
   Class name.


ΓòÉΓòÉΓòÉ <hidden> pszModName ΓòÉΓòÉΓòÉ

pszModName (PSZ)
   Module name.


ΓòÉΓòÉΓòÉ 4.141. OBJDATA ΓòÉΓòÉΓòÉ

OBJDATA Object data structure.  Class specific information is contained in this
structure.

typedef struct _OBJDATA {
WPSRCLASSBLOCK   *CurrentClass;  /* Pointer to current save or restore class block  */
WPSRCLASSBLOCK   *First;         /* Pointer to first save or restore class block  */
PUCHAR            NextData;      /* Pointer to next block of data  */
USHORT            Length;        /* Length  */
 } OBJDATA;


ΓòÉΓòÉΓòÉ <hidden> CurrentClass ΓòÉΓòÉΓòÉ

*CurrentClass (WPSRCLASSBLOCK *)
   Pointer to current save or restore class block.


ΓòÉΓòÉΓòÉ <hidden> First ΓòÉΓòÉΓòÉ

*First (WPSRCLASSBLOCK *)
   Pointer to first save or restore    class block.


ΓòÉΓòÉΓòÉ <hidden> NextData ΓòÉΓòÉΓòÉ

NextData (PUCHAR)
   Pointer to next block of data.


ΓòÉΓòÉΓòÉ <hidden> Length ΓòÉΓòÉΓòÉ

Length (USHORT)
   Length.


ΓòÉΓòÉΓòÉ 4.142. OWNERBACKGROUND ΓòÉΓòÉΓòÉ

OWNERBACKGROUND Structure that contains information about painting the
container window's background by the container owner. This structure is used in
the CM_PAINTBACKGROUND container message only.

typedef struct _OWNERBACKGROUND {
HWND     hwnd;           /* Window handle  */
HPS      hps;            /* Presentation-space handle  */
RECTL    rclBackground;  /* Background rectangle  */
LONG     idWindow;       /* Window ID  */
 } OWNERBACKGROUND;


ΓòÉΓòÉΓòÉ <hidden> hwnd ΓòÉΓòÉΓòÉ

hwnd (HWND)
   Window handle.

   Handle of the window to be painted.


ΓòÉΓòÉΓòÉ <hidden> hps ΓòÉΓòÉΓòÉ

hps (HPS)
   Presentation-space handle.


ΓòÉΓòÉΓòÉ <hidden> rclBackground ΓòÉΓòÉΓòÉ

rclBackground (RECTL)
   Background rectangle.

   Background rectangle in window coordinates.


ΓòÉΓòÉΓòÉ <hidden> idWindow ΓòÉΓòÉΓòÉ

idWindow (LONG)
   Window ID.

   Identity of the window to be painted.


ΓòÉΓòÉΓòÉ 4.143. OWNERITEM ΓòÉΓòÉΓòÉ

OWNERITEM Owner item.

typedef struct _OWNERITEM {
HWND     hwnd;            /* Window handle  */
HPS      hps;             /* Presentation-space handle  */
ULONG    fsState;         /* State  */
ULONG    fsAttribute;     /* Attribute  */
ULONG    fsStateOld;      /* Old state  */
ULONG    fsAttributeOld;  /* Old attribute  */
RECTL    rclItem;         /* Item rectangle  */
LONG     idItem;          /* Item identity  */
ULONG    hItem;           /* Item  */
 } OWNERITEM;


ΓòÉΓòÉΓòÉ <hidden> hwnd ΓòÉΓòÉΓòÉ

hwnd (HWND)
   Window handle.


ΓòÉΓòÉΓòÉ <hidden> hps ΓòÉΓòÉΓòÉ

hps (HPS)
   Presentation-space handle.


ΓòÉΓòÉΓòÉ <hidden> fsState ΓòÉΓòÉΓòÉ

fsState (ULONG)
   State.


ΓòÉΓòÉΓòÉ <hidden> fsAttribute ΓòÉΓòÉΓòÉ

fsAttribute (ULONG)
   Attribute.


ΓòÉΓòÉΓòÉ <hidden> fsStateOld ΓòÉΓòÉΓòÉ

fsStateOld (ULONG)
   Old state.


ΓòÉΓòÉΓòÉ <hidden> fsAttributeOld ΓòÉΓòÉΓòÉ

fsAttributeOld (ULONG)
   Old attribute.


ΓòÉΓòÉΓòÉ <hidden> rclItem ΓòÉΓòÉΓòÉ

rclItem (RECTL)
   Item rectangle.


ΓòÉΓòÉΓòÉ <hidden> idItem ΓòÉΓòÉΓòÉ

idItem (LONG)
   Item identity.


ΓòÉΓòÉΓòÉ <hidden> hItem ΓòÉΓòÉΓòÉ

hItem (ULONG)
   Item.


ΓòÉΓòÉΓòÉ 4.144. PACCEL ΓòÉΓòÉΓòÉ

PACCEL Pointer to ACCEL.

typedef ACCEL *PACCEL;


ΓòÉΓòÉΓòÉ 4.145. PACCELTABLE ΓòÉΓòÉΓòÉ

PACCELTABLE Pointer to ACCELTABLE.

typedef ACCELTABLE *PACCELTABLE;


ΓòÉΓòÉΓòÉ 4.146. PAGEINFO ΓòÉΓòÉΓòÉ

PAGEINFO Settings page information structure.

typedef struct _PAGEINFO {
ULONG      cb;                  /* Length of PAGEINFO structure  */
HWND       hwndPage;            /* Handle of page  */
PFNWP      pfnwp;               /* Window procedure  */
ULONG      resid;               /* Resource identity  */
PVOID      pCreateParams;       /* Pointer to creation parameters  */
USHORT     dlgid;               /* Dialog identity  */
USHORT     usPageStyleFlags;    /* Notebook control page style flags  */
USHORT     usPageInsertFlags;   /* Notebook control page insertion flags  */
USHORT     usSettingsFlags;     /* Settings flag  */
PSZ        pszName;             /* Pointer to a string containing page name  */
USHORT     idDefaultHelpPanel;  /* Identity of default help panel  */
USHORT     usReserved2;         /* Reserved value must be zero  */
PSZ        pszHelpLibraryName;  /* Pointer to name of help file  */
PUSHORT    pHelpSubtable;       /* Pointer to help subtable  */
HMODULE    hmodHelpSubtable;    /* Module handle for help subtable  */
ULONG      ulPageInsertId;      /* Notebook control page identity  */
 } PAGEINFO;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Length of PAGEINFO structure.


ΓòÉΓòÉΓòÉ <hidden> hwndPage ΓòÉΓòÉΓòÉ

hwndPage (HWND)
   Handle of page.


ΓòÉΓòÉΓòÉ <hidden> pfnwp ΓòÉΓòÉΓòÉ

pfnwp (PFNWP)
   Window procedure.


ΓòÉΓòÉΓòÉ <hidden> resid ΓòÉΓòÉΓòÉ

resid (ULONG)
   Resource identity.


ΓòÉΓòÉΓòÉ <hidden> pCreateParams ΓòÉΓòÉΓòÉ

pCreateParams (PVOID)
   Pointer to creation parameters.


ΓòÉΓòÉΓòÉ <hidden> dlgid ΓòÉΓòÉΓòÉ

dlgid (USHORT)
   Dialog identity.


ΓòÉΓòÉΓòÉ <hidden> usPageStyleFlags ΓòÉΓòÉΓòÉ

usPageStyleFlags (USHORT)
   Notebook control page style flags.


ΓòÉΓòÉΓòÉ <hidden> usPageInsertFlags ΓòÉΓòÉΓòÉ

usPageInsertFlags (USHORT)
   Notebook control page insertion flags.


ΓòÉΓòÉΓòÉ <hidden> usSettingsFlags ΓòÉΓòÉΓòÉ

usSettingsFlags (USHORT)
   Settings flag.

   This flag must be set.

   0         You will not get page numbers.

   SETTINGS_PAGE_NUMBERS Page numbers will automatically be put on the status
             line for pages that have minor pages under the major tab page.
             If you want to use the page numbers, make sure ALL pages have this
             setting.


ΓòÉΓòÉΓòÉ <hidden> pszName ΓòÉΓòÉΓòÉ

pszName (PSZ)
   Pointer to a string containing page name.


ΓòÉΓòÉΓòÉ <hidden> idDefaultHelpPanel ΓòÉΓòÉΓòÉ

idDefaultHelpPanel (USHORT)
   Identity of default help panel.


ΓòÉΓòÉΓòÉ <hidden> usReserved2 ΓòÉΓòÉΓòÉ

usReserved2 (USHORT)
   Reserved value must be zero.


ΓòÉΓòÉΓòÉ <hidden> pszHelpLibraryName ΓòÉΓòÉΓòÉ

pszHelpLibraryName (PSZ)
   Pointer to name of help file.


ΓòÉΓòÉΓòÉ <hidden> pHelpSubtable ΓòÉΓòÉΓòÉ

pHelpSubtable (PUSHORT)
   Pointer to help subtable.


ΓòÉΓòÉΓòÉ <hidden> hmodHelpSubtable ΓòÉΓòÉΓòÉ

hmodHelpSubtable (HMODULE)
   Module handle for help subtable.


ΓòÉΓòÉΓòÉ <hidden> ulPageInsertId ΓòÉΓòÉΓòÉ

ulPageInsertId (ULONG)
   Notebook control page identity.


ΓòÉΓòÉΓòÉ 4.147. PAGESELECTNOTIFY ΓòÉΓòÉΓòÉ

PAGESELECTNOTIFY Structure that contains information about the application page
being selected.

typedef struct _PAGESELECTNOTIFY {
HWND     hwndBook;     /* Notebook window handle  */
ULONG    ulPageIdCur;  /* Current top page identifier  */
ULONG    ulPageIdNew;  /* New top page identifier  */
 } PAGESELECTNOTIFY;


ΓòÉΓòÉΓòÉ <hidden> hwndBook ΓòÉΓòÉΓòÉ

hwndBook (HWND)
   Notebook window handle.


ΓòÉΓòÉΓòÉ <hidden> ulPageIdCur ΓòÉΓòÉΓòÉ

ulPageIdCur (ULONG)
   Current top page identifier.


ΓòÉΓòÉΓòÉ <hidden> ulPageIdNew ΓòÉΓòÉΓòÉ

ulPageIdNew (ULONG)
   New top page identifier.


ΓòÉΓòÉΓòÉ 4.148. PALINFO ΓòÉΓòÉΓòÉ

PALINFO Class specific palette information data.

typedef struct _PALINFO {
ULONG    xCellCount;   /* Number of columns of palinfos  */
ULONG    yCellCount;   /* Number of rows of palinfos  */
ULONG    xCursor;      /* Cursor location (readonly)  */
ULONG    yCursor;      /* Cursor location (readonly)  */
ULONG    xCellWidth;   /* Width of each palinfo  */
ULONG    yCellHeight;  /* Height of each palinfo  */
ULONG    xGap;         /* X separation of palinfos  */
ULONG    yGap;         /* Y separation of palinfos  */
 } PALINFO;


ΓòÉΓòÉΓòÉ <hidden> xCellCount ΓòÉΓòÉΓòÉ

xCellCount (ULONG)
   Number of columns of palinfos.


ΓòÉΓòÉΓòÉ <hidden> yCellCount ΓòÉΓòÉΓòÉ

yCellCount (ULONG)
   Number of rows of palinfos.


ΓòÉΓòÉΓòÉ <hidden> xCursor ΓòÉΓòÉΓòÉ

xCursor (ULONG)
   Cursor location (readonly).


ΓòÉΓòÉΓòÉ <hidden> yCursor ΓòÉΓòÉΓòÉ

yCursor (ULONG)
   Cursor location (readonly).


ΓòÉΓòÉΓòÉ <hidden> xCellWidth ΓòÉΓòÉΓòÉ

xCellWidth (ULONG)
   Width of each palinfo.


ΓòÉΓòÉΓòÉ <hidden> yCellHeight ΓòÉΓòÉΓòÉ

yCellHeight (ULONG)
   Height of each palinfo.


ΓòÉΓòÉΓòÉ <hidden> xGap ΓòÉΓòÉΓòÉ

xGap (ULONG)
   X separation of palinfos.


ΓòÉΓòÉΓòÉ <hidden> yGap ΓòÉΓòÉΓòÉ

yGap (ULONG)
   Y separation of palinfos.


ΓòÉΓòÉΓòÉ 4.149. PANOSE ΓòÉΓòÉΓòÉ

PANOSE The Panose field in the font metrics will allow for quantitative
descriptions of the visual properties of font faces. The PANOSE definition
contains ten digits, each of which currently describes up to sixteen
variations.

typedef struct _PANOSE {
BYTE    bFamilyType;       /* Family kind  */
BYTE    bSerifStyle;       /* Serif style  */
BYTE    bWeight;           /* Weight  */
BYTE    bProportion;       /* Proportion  */
BYTE    bContrast;         /* Contrast  */
BYTE    bStrokeVariation;  /* Stroke Variation  */
BYTE    bArmStyle;         /* Arm Style  */
BYTE    bLetterform;       /* Letterform  */
BYTE    bMidline;          /* Midline  */
BYTE    bXHeight;          /* X-Height  */
BYTE    fbPassedISO;       /* Font passed ISO test  */
BYTE    fbFailedISO;       /* Font failed ISO test  */
 } PANOSE;


ΓòÉΓòÉΓòÉ <hidden> bFamilyType ΓòÉΓòÉΓòÉ

bFamilyType (BYTE)
   Family kind.

   0 Any

   1 No Fit

   2 Text and Display

   3 Script

   4 Decorative

   5 Pictorial


ΓòÉΓòÉΓòÉ <hidden> bSerifStyle ΓòÉΓòÉΓòÉ

bSerifStyle (BYTE)
   Serif style.

   0 Any

   1 No Fit

   2 Cove

   3 Obtuse Cove

   4 Square Cove

   5 Obtuse Square Cove

   6 Square

   7 Thin

   8 Bone

   9 Exaggerated

   10 Triangle

   11 Normal Sans

   12 Obtuse Sans

   13 Perp Sans

   14 Flared

   15 Rounded


ΓòÉΓòÉΓòÉ <hidden> bWeight ΓòÉΓòÉΓòÉ

bWeight (BYTE)
   Weight.

   0 Any

   1 No Fit

   2 Very Light

   3 Light

   4 Thin

   5 Book

   6 Medium

   7 Demi

   8 Bold

   9 Heavy

   10 Black

   11 Nord


ΓòÉΓòÉΓòÉ <hidden> bProportion ΓòÉΓòÉΓòÉ

bProportion (BYTE)
   Proportion.

   0 Any

   1 No Fit

   2 Old Style

   3 Modern

   4 Even Width

   5 Expanded

   6 Condensed

   7 Very Expanded

   8 Very Condensed

   9 Monospaced


ΓòÉΓòÉΓòÉ <hidden> bContrast ΓòÉΓòÉΓòÉ

bContrast (BYTE)
   Contrast.

   0 Any

   1 No Fit

   2 None

   3 Very Low

   4 Low

   5 Medium Low

   6 Medium

   7 Medium High

   8 High

   9 Very High


ΓòÉΓòÉΓòÉ <hidden> bStrokeVariation ΓòÉΓòÉΓòÉ

bStrokeVariation (BYTE)
   Stroke Variation.

   0 Any

   1 No Fit

   2 Gradual/Diagonal

   3 Gradual/Transitional

   4 Gradual/Vertical

   5 Gradual/Horizontal

   6 Rapid/Vertical

   7 Rapid/Horizontal

   8 Instant/Vertical


ΓòÉΓòÉΓòÉ <hidden> bArmStyle ΓòÉΓòÉΓòÉ

bArmStyle (BYTE)
   Arm Style.

   0 Any

   1 No Fit

   2 Straight Arms/Horizontal

   3 Straight Arms/Wedge

   4 Straight Arms/Vertical

   5 Straight Arms/Single Serif

   6 Straight Arms/Double Serif

   7 Non-Straight Arms/Horizontal

   8 Non-Straight Arms/Wedge

   9 Non-Straight Arms/Vertical

   10 Non-Straight Arms/Single Serif

   11 Non-Straight Arms/Double Serif


ΓòÉΓòÉΓòÉ <hidden> bLetterform ΓòÉΓòÉΓòÉ

bLetterform (BYTE)
   Letterform.

   0 Any

   1 No Fit

   2 Normal/Contact

   3 ONormal/Weighted

   4 ONormal/Boxed

   5 ONormal/Flattened

   6 ONormal/Rounded

   7 ONormal/Off Center

   8 ONormal/Square

   9 Oblique/Contact

   10 Oblique/Weighted

   11 Oblique/Boxed

   12 Oblique/Flattened

   13 Oblique/Rounded

   14 Oblique/Off Center

   15 Oblique/Square


ΓòÉΓòÉΓòÉ <hidden> bMidline ΓòÉΓòÉΓòÉ

bMidline (BYTE)
   Midline.

   0 Any

   1 No Fit

   2 Standard/Trimmed

   3 Standard/Pointed

   4 Standard/Serifed

   5 High/Trimmed

   6 High/Pointed

   7 High/Serifed

   8 Constant/Trimmed

   9 Constant/Pointed

   10 Constant/Serifed

   11 Low/Trimmed

   12 Low/Pointed

   13 Low/Serifed


ΓòÉΓòÉΓòÉ <hidden> bXHeight ΓòÉΓòÉΓòÉ

bXHeight (BYTE)
   X-Height.

   0 Any

   1 No Fit

   2 Constant/Small

   3 Constant/Standard

   4 Constant/Large

   5 Ducking/Small

   6 Ducking/Standard

   7 Ducking/Large


ΓòÉΓòÉΓòÉ <hidden> fbPassedISO ΓòÉΓòÉΓòÉ

fbPassedISO (BYTE)
   Font passed ISO test

   The following flags indicate those displays and resolutions at which the
   font complied with ISO 9241.

   FM_ISO_9518_640
   FM_ISO_9515_640
   FM_ISO_9515_1024
   FM_ISO_9517_640
   FM_ISO_9517_1024


ΓòÉΓòÉΓòÉ <hidden> fbFailedISO ΓòÉΓòÉΓòÉ

fbFailedISO (BYTE)
   Font failed ISO test

   The following flags indicate those displays and resolutions at which the
   font did not comply with ISO 9241.

   FM_ISO_9518_640
   FM_ISO_9515_640
   FM_ISO_9515_1024
   FM_ISO_9517_640
   FM_ISO_9517_1024


ΓòÉΓòÉΓòÉ 4.150. PAPSZ ΓòÉΓòÉΓòÉ

PAPSZ Pointer to an APSZ array of pointers to NULL-terminated strings.

typedef APSZ *PAPSZ;


ΓòÉΓòÉΓòÉ 4.151. PARAM ΓòÉΓòÉΓòÉ

PARAM Presentation parameter attribute definition.

typedef struct _PARAM {
ULONG    id;     /* Attribute type identity  */
ULONG    cb;     /* Byte count of the ab[1] parameter  */
BYTE     ab[1];  /* Attribute value  */
 } PARAM;


ΓòÉΓòÉΓòÉ <hidden> id ΓòÉΓòÉΓòÉ

id (ULONG)
   Attribute type identity.

   These identities are in the range of X'00000000' to X'FFFFFFFF'. The window
   manager uses values of this parameter in the range X'00000000' to PP_USER,
   therefore an application should not define private presentation parameter
   attribute identities in this range. An application should use the WinAddAtom
   call to guarantee obtaining a unique identity.

   PP_FOREGROUNDCOLOR
      Foreground color (in RGB) attribute.
   PP_BACKGROUNDCOLOR
      Background color (in RGB) attribute.
   PP_FOREGROUNDCOLORINDEX
      Foreground color index attribute.
   PP_BACKGROUNDCOLORINDEX
      Background color index attribute.
   PP_HILITEFOREGROUNDCOLOR
      Highlighted foreground color (in RGB) attribute, for example for selected
      menu items.
   PP_HILITEBACKGROUNDCOLOR
      Highlighted background color (in RGB) attribute.
   PP_HILITEFOREGROUNDCOLORINDEX
      Highlighted foreground color index attribute.
   PP_HILITEBACKGROUNDCOLORINDEX
      Highlighted background color index attribute.
   PP_DISABLEDFOREGROUNDCOLOR
      Disabled foreground color (in RGB) attribute.
   PP_DISABLEDBACKGROUNDCOLOR
      Disabled background color (in RGB) attribute.
   PP_DISABLEDFOREGROUNDCOLORINDEX
      Disabled foreground color index attribute.
   PP_DISABLEDBACKGROUNDCOLORINDEX
      Disabled background color index attribute.
   PP_BORDERCOLOR
      Border color (in RGB) attribute.
   PP_BORDERCOLORINDEX
      Border color index attribute.
   PP_FONTNAMESIZE
      Font name and size attribute.
   PP_ACTIVECOLOR
      Active color value of data type RGB.
   PP_ACTIVECOLORINDEX
      Active color index value of data type LONG.
   PP_INACTIVECOLOR
      Inactive color value of data type RGB.
   PP_INACTIVECOLORINDEX
      Inactive color index value of data type LONG.
   PP_ACTIVETEXTFGNDCOLOR
      Active text foreground color value of data type RGB.
   PP_ACTIVETEXTFGNDCOLORINDEX
      Active text foreground color index value of data type LONG.
   PP_ACTIVETEXTBGNDCOLOR
      Active text background color value of data type RGB.
   PP_ACTIVETEXTBGNDCOLORINDEX
      Active text background color index value of data type LONG.
   PP_INACTIVETEXTFGNDCOLOR
      Inactive text foreground color value of data type RGB.
   PP_INACTIVETEXTFGNDCOLORINDEX
      Inactive text foreground color index value of data type LONG.
   PP_INACTIVETEXTBGNDCOLOR
      Inactive text background color value of data type RGB.
   PP_INACTIVETEXTBGNDCOLORINDEX
      Inactive text background color index value of data type LONG.
   PP_SHADOW
      Changes the color used for drop shadows on certain controls.
   PP_USER
      This is a user-defined presentation parameter.


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Byte count of the ab[1] parameter.


ΓòÉΓòÉΓòÉ <hidden> ab[1] ΓòÉΓòÉΓòÉ

ab[1] (BYTE)
   Attribute value.

   The format of a value depends on the attribute type identity as follows:

   PP_FOREGROUNDCOLOR
      Foreground color value of data type RGB.
   PP_BACKGROUNDCOLOR
      Background color value of data type RGB.
   PP_FOREGROUNDCOLORINDEX
      Foreground color index value of data type LONG.
   PP_BACKGROUNDCOLORINDEX
      Background color index value of data type LONG.
   PP_HILITEFOREGROUNDCOLOR
      Highlighted foreground color value of data type RGB.
   PP_HILITEBACKGROUNDCOLOR
      Highlighted background color value of data type RGB.
   PP_HILITEFOREGROUNDCOLORINDEX
      Highlighted foreground color index value of data type LONG.
   PP_HILITEBACKGROUNDCOLORINDEX
      Highlighted background color index value of data type LONG.
   PP_DISABLEDFOREGROUNDCOLOR
      Disabled foreground color value of data type RGB.
   PP_DISABLEDBACKGROUNDCOLOR
      Disabled background color value of data type RGB.
   PP_DISABLEDFOREGROUNDCOLORINDEX
      Disabled foreground color index value of data type LONG.
   PP_DISABLEDBACKGROUNDCOLORINDEX
      Disabled background color index value of data type LONG.
   PP_BORDERCOLOR
      Border color value of data type RGB.
   PP_BORDERCOLORINDEX
      Border color index value of data type LONG.
   PP_FONTNAMESIZE
      Font name and size value of data type PSZ. The string is in two parts,
      separated by a period. The first part is the font point size and the
      second part is the font facename, for example, "12.Helv".


ΓòÉΓòÉΓòÉ 4.152. PARCPARAMS ΓòÉΓòÉΓòÉ

PARCPARAMS Pointer to ARCPARAMS.

typedef ARCPARAMS *PARCPARAMS;


ΓòÉΓòÉΓòÉ 4.153. PAREABUNDLE ΓòÉΓòÉΓòÉ

PAREABUNDLE Pointer to AREABUNDLE.

typedef AREABUNDLE *PAREABUNDLE;


ΓòÉΓòÉΓòÉ 4.154. PBANDRECT ΓòÉΓòÉΓòÉ

PBANDRECT Pointer to BANDRECT.

typedef BANDRECT *PBANDRECT;


ΓòÉΓòÉΓòÉ 4.155. PBITMAPINFO ΓòÉΓòÉΓòÉ

PBITMAPINFO Pointer to BITMAPINFO.

typedef BITMAPINFO *PBITMAPINFO;


ΓòÉΓòÉΓòÉ 4.156. PBITMAPINFO2 ΓòÉΓòÉΓòÉ

PBITMAPINFO2 Pointer to BITMAPINFO2.

typedef BITMAPINFO2 *PBITMAPINFO2;


ΓòÉΓòÉΓòÉ 4.157. PBITMAPINFOHEADER ΓòÉΓòÉΓòÉ

PBITMAPINFOHEADER Pointer to BITMAPINFOHEADER.

typedef BITMAPINFOHEADER *PBITMAPINFOHEADER;


ΓòÉΓòÉΓòÉ 4.158. PBITMAPINFOHEADER2 ΓòÉΓòÉΓòÉ

PBITMAPINFOHEADER2 Pointer to BITMAPINFOHEADER2.

typedef BITMAPINFOHEADER2 *PBITMAPINFOHEADER2;


ΓòÉΓòÉΓòÉ 4.159. PBOOKTEXT ΓòÉΓòÉΓòÉ

PBOOKTEXT Pointer to a BOOKTEXT data structure.

typedef BOOKTEXT *PBOOKTEXT;


ΓòÉΓòÉΓòÉ 4.160. PBOOL ΓòÉΓòÉΓòÉ

PBOOL Pointer to BOOL.

typedef BOOL *PBOOL;


ΓòÉΓòÉΓòÉ 4.161. PBUFFER ΓòÉΓòÉΓòÉ

PBUFFER Pointer to PBYTE.

typedef BUFFER *PBUFFER;


ΓòÉΓòÉΓòÉ 4.162. PBUNDLE ΓòÉΓòÉΓòÉ

PBUNDLE Points to a bundle data area.

typedef PVOID PBUNDLE;


ΓòÉΓòÉΓòÉ 4.163. PBYTE ΓòÉΓòÉΓòÉ

PBYTE Pointer to a data area.

typedef BYTE *PBYTE;


ΓòÉΓòÉΓòÉ 4.164. PCATCHBUF ΓòÉΓòÉΓòÉ

PCATCHBUF Pointer to CATCHBUF.

typedef CATCHBUF *PCATCHBUF;


ΓòÉΓòÉΓòÉ 4.165. PCDATE ΓòÉΓòÉΓòÉ

PCDATE Pointer to CDATE.

typedef CDATE *PCDATE;


ΓòÉΓòÉΓòÉ 4.166. PCELL ΓòÉΓòÉΓòÉ

PCELL Pointer to CELL.

typedef CELL *PCELL;


ΓòÉΓòÉΓòÉ 4.167. PCH ΓòÉΓòÉΓòÉ

PCH Pointer to a character string.

typedef unsigned char *PCH;


ΓòÉΓòÉΓòÉ 4.168. PCHAR ΓòÉΓòÉΓòÉ

PCHAR Pointer to CHAR.

typedef CHAR *PCHAR;


ΓòÉΓòÉΓòÉ 4.169. PCHARBUNDLE ΓòÉΓòÉΓòÉ

PCHARBUNDLE Pointer to CHARBUNDLE.

typedef CHARBUNDLE *PCHARBUNDLE;


ΓòÉΓòÉΓòÉ 4.170. PCHRMSG ΓòÉΓòÉΓòÉ

PCHRMSG Pointer to a CHRMSG data structure.

typedef CHRMSG *PCHRMSG;


ΓòÉΓòÉΓòÉ 4.171. PCLASS ΓòÉΓòÉΓòÉ

PCLASS Pointer to a CLASS.

typedef CLASS *PCLASS;


ΓòÉΓòÉΓòÉ 4.172. PCLASSDETAILS ΓòÉΓòÉΓòÉ

PCLASSDETAILS Pointer to an CLASSDETAILS data structure.

typedef CLASSDETAILS *PCLASSDETAILS;


ΓòÉΓòÉΓòÉ 4.173. PCLASSFIELDINFO ΓòÉΓòÉΓòÉ

PCLASSFIELDINFO Pointer to an ClassFieldInfo data structure.

typedef CLASSFIELDINFO *PCLASSFIELDINFO;


ΓòÉΓòÉΓòÉ 4.174. PCLASSINFO ΓòÉΓòÉΓòÉ

PCLASSINFO Pointer to CLASSINFO.

typedef CLASSINFO *PCLASSINFO;


ΓòÉΓòÉΓòÉ 4.175. PCMDMSG ΓòÉΓòÉΓòÉ

PCMDMSG Pointer to a CMDMSG data structure.

typedef CMDMSG *PCMDMSG;


ΓòÉΓòÉΓòÉ 4.176. PCNRDRAGINFO ΓòÉΓòÉΓòÉ

PCNRDRAGINFO Pointer to a CNRDRAGINFO data structure.

typedef CNRDRAGINFO *PCNRDRAGINFO;


ΓòÉΓòÉΓòÉ 4.177. PCNRDRAGINIT ΓòÉΓòÉΓòÉ

PCNRDRAGINIT Pointer to a CNRDRAGINIT data structure.

typedef CNRDRAGINIT *PCNRDRAGINIT;


ΓòÉΓòÉΓòÉ 4.178. PCNRDRAWITEMINFO ΓòÉΓòÉΓòÉ

PCNRDRAWITEMINFO Pointer to a CNRDRAWITEMINFO data structure.

typedef CNRDRAWITEMINFO *PCNRDRAWITEMINFO;


ΓòÉΓòÉΓòÉ 4.179. PCNREDITDATA ΓòÉΓòÉΓòÉ

PCNREDITDATA Pointer to a CNREDITDATA data structure.

typedef CNREDITDATA *PCNREDITDATA;


ΓòÉΓòÉΓòÉ 4.180. PCNRINFO ΓòÉΓòÉΓòÉ

PCNRINFO Pointer to a CNRINFO data structure.

typedef CNRINFO *PCNRINFO;


ΓòÉΓòÉΓòÉ 4.181. PCOLOR ΓòÉΓòÉΓòÉ

PCOLOR Pointer to COLOR.

typedef COLOR *PCOLOR;


ΓòÉΓòÉΓòÉ 4.182. PCONVCONTEXT ΓòÉΓòÉΓòÉ

PCONVCONTEXT Pointer to a CONVCONTEXT data structure.

typedef CONVCONTEXT *PCONVCONTEXT;


ΓòÉΓòÉΓòÉ 4.183. PCPTEXT ΓòÉΓòÉΓòÉ

PCPTEXT Pointer to CPTEXT.

typedef CPTEXT *PCPTEXT;


ΓòÉΓòÉΓòÉ 4.184. PCREATEPARAMS ΓòÉΓòÉΓòÉ

PCREATEPARAMS Pointer to PVOID.

typedef CREATEPARAMS *PCREATEPARAMS;


ΓòÉΓòÉΓòÉ 4.185. PCREATESTRUCT ΓòÉΓòÉΓòÉ

PCREATESTRUCT Pointer to a CREATESTRUCT data structure.

typedef CREATESTRUCT *PCREATESTRUCT;


ΓòÉΓòÉΓòÉ 4.186. PCSZ ΓòÉΓòÉΓòÉ

PCSZ Pointer to a constant NULL-terminated string.

typedef const char *PCSZ;


ΓòÉΓòÉΓòÉ 4.187. PCTIME ΓòÉΓòÉΓòÉ

PCTIME Pointer to CTIME.

typedef CTIME *PCTIME;


ΓòÉΓòÉΓòÉ 4.188. PCURSORINFO ΓòÉΓòÉΓòÉ

PCURSORINFO Pointer to CURSORINFO.

typedef CURSORINFO *PCURSORINFO;


ΓòÉΓòÉΓòÉ 4.189. PDDEINIT ΓòÉΓòÉΓòÉ

PDDEINIT Pointer to a DDEINIT data structure.

typedef DDEINIT *PDDEINIT;


ΓòÉΓòÉΓòÉ 4.190. PDDESTRUCT ΓòÉΓòÉΓòÉ

PDDESTRUCT Pointer to DDESTRUCT.

typedef DDESTRUCT *PDDESTRUCT;


ΓòÉΓòÉΓòÉ 4.191. PDELETENOTIFY ΓòÉΓòÉΓòÉ

PDELETENOTIFY Pointer to a DELETENOTIFY data structure.

typedef DELETENOTIFY *PDELETENOTIFY;


ΓòÉΓòÉΓòÉ 4.192. PDESKTOP ΓòÉΓòÉΓòÉ

PDESKTOP Pointer to a DESKTOP image data structure.

typedef DESKTOP *PDESKTOP;


ΓòÉΓòÉΓòÉ 4.193. PDEVOPENDATA ΓòÉΓòÉΓòÉ

PDEVOPENDATA Open-device-data array.

This data type points to data whose format is described by the DEVOPENSTRUC
data type.

typedef PSZ *PDEVOPENDATA;


ΓòÉΓòÉΓòÉ 4.194. PDEVOPENSTRUC ΓòÉΓòÉΓòÉ

PDEVOPENSTRUC Pointer to DEVOPENSTRUC.

typedef DEVOPENSTRUC *PDEVOPENSTRUC;


ΓòÉΓòÉΓòÉ 4.195. PDLGTEMPLATE ΓòÉΓòÉΓòÉ

PDLGTEMPLATE Pointer to DLGTEMPLATE.

typedef DLGTEMPLATE *PDLGTEMPLATE;


ΓòÉΓòÉΓòÉ 4.196. PDLGTITEM ΓòÉΓòÉΓòÉ

PDLGTITEM Pointer to DLGTITEM.

typedef DLGTITEM *PDLGTITEM;


ΓòÉΓòÉΓòÉ 4.197. PDRAGIMAGE ΓòÉΓòÉΓòÉ

PDRAGIMAGE Pointer to a DRAGIMAGE data structure.

typedef DRAGIMAGE *PDRAGIMAGE;


ΓòÉΓòÉΓòÉ 4.198. PDRAGINFO ΓòÉΓòÉΓòÉ

PDRAGINFO Pointer to a DRAGINFO data structure.

typedef DRAGINFO *PDRAGINFO;


ΓòÉΓòÉΓòÉ 4.199. PDRAGITEM ΓòÉΓòÉΓòÉ

PDRAGITEM Pointer to a DRAGITEM data structure.

typedef DRAGITEM *PDRAGITEM;


ΓòÉΓòÉΓòÉ 4.200. PDRAGTRANSFER ΓòÉΓòÉΓòÉ

PDRAGTRANSFER Pointer to a DRAGTRANSFER data structure.

typedef DRAGTRANSFER *PDRAGTRANSFER;


ΓòÉΓòÉΓòÉ 4.201. PDRIVDATA ΓòÉΓòÉΓòÉ

PDRIVDATA Driver-data structure.

This data type points to data whose format is described by the DRIVDATA data
type.

typedef DRIVDATA *PDRIVDATA;


ΓòÉΓòÉΓòÉ 4.202. PDRIVPROPS ΓòÉΓòÉΓòÉ

PDRIVPROPS Driver property structure.

This data type points to data whose format is described by the DRIVPROPS data
type.

typedef DRIVPROPS *PDRIVPROPS;


ΓòÉΓòÉΓòÉ 4.203. PENTRYFDATA ΓòÉΓòÉΓòÉ

PENTRYFDATA Pointer to ENTRYFDATA.

typedef ENTRYFDATA *PENTRYFDATA;


ΓòÉΓòÉΓòÉ 4.204. PERRINFO ΓòÉΓòÉΓòÉ

PERRINFO Pointer to ERRINFO.

typedef ERRINFO *PERRINFO;


ΓòÉΓòÉΓòÉ 4.205. PERRORID ΓòÉΓòÉΓòÉ

PERRORID Pointer to ERRORID.

typedef ERRORID *PERRORID;


ΓòÉΓòÉΓòÉ 4.206. PESCMODE ΓòÉΓòÉΓòÉ

PESCMODE Pointer to ESCSETMODE.

typedef ESCMODE *PESCMODE;


ΓòÉΓòÉΓòÉ 4.207. PFACENAMEDESC ΓòÉΓòÉΓòÉ

PFACENAMEDESC Pointer to FACENAMEDESC.

typedef FACENAMEDESC *PFACENAMEDESC;


ΓòÉΓòÉΓòÉ 4.208. PFATTRS ΓòÉΓòÉΓòÉ

PFATTRS Pointer to FATTRS.

typedef FATTRS *PFATTRS;


ΓòÉΓòÉΓòÉ 4.209. PFFDESCS ΓòÉΓòÉΓòÉ

PFFDESCS Pointer to a font file descriptor.

typedef FFDESCS *PFFDESCS;


ΓòÉΓòÉΓòÉ 4.210. PFIELDINFO ΓòÉΓòÉΓòÉ

PFIELDINFO Pointer to a FIELDINFO data structure.

typedef FIELDINFO *PFIELDINFO;


ΓòÉΓòÉΓòÉ 4.211. PFIELDINFOINSERT ΓòÉΓòÉΓòÉ

PFIELDINFOINSERT Pointer to a FIELDINFOINSERT data structure.

typedef FIELDINFOINSERT *PFIELDINFOINSERT;


ΓòÉΓòÉΓòÉ 4.212. PFILEDLG ΓòÉΓòÉΓòÉ

PFILEDLG Pointer to a FILEDLG data structure.

typedef FILEDLG *PFILEDLG;


ΓòÉΓòÉΓòÉ 4.213. PFIXED ΓòÉΓòÉΓòÉ

PFIXED Pointer to FIXED.

typedef FIXED *PFIXED;


ΓòÉΓòÉΓòÉ 4.214. PFN ΓòÉΓòÉΓòÉ

PFN A pointer to a procedure.

A two-part definition is shown here to match the header files.

typedef  int   (APIENTRY _PFN) ();
typedef _PFN  *PFN;


ΓòÉΓòÉΓòÉ 4.215. PFNWP ΓòÉΓòÉΓòÉ

PFNWP A pointer to a window procedure.

A two-part definition is shown here to match the header files.

typedef  MRESULT (EXPENTRY FNWP)(HWND, ULONG, MPARAM, MPARAM);
typedef  FNWP   *PFNWP;


ΓòÉΓòÉΓòÉ 4.216. PFONTDLG ΓòÉΓòÉΓòÉ

PFONTDLG Pointer to a FONTDLG data structure.

typedef FONTDLG *PFONTDLG;


ΓòÉΓòÉΓòÉ 4.217. PFONTMETRICS ΓòÉΓòÉΓòÉ

PFONTMETRICS Pointer to FONTMETRICS.

typedef FONTMETRICS *PFONTMETRICS;


ΓòÉΓòÉΓòÉ 4.218. PGRADIENTL ΓòÉΓòÉΓòÉ

PGRADIENTL Pointer to GRADIENTL.

typedef GRADIENTL *PGRADIENTL;


ΓòÉΓòÉΓòÉ 4.219. PHAB ΓòÉΓòÉΓòÉ

PHAB Pointer to HAB.

typedef HAB *PHAB;


ΓòÉΓòÉΓòÉ 4.220. PHBITMAP ΓòÉΓòÉΓòÉ

PHBITMAP Pointer to HBITMAP.

typedef HBITMAP *PHBITMAP;


ΓòÉΓòÉΓòÉ 4.221. PHCINFO ΓòÉΓòÉΓòÉ

PHCINFO Pointer to HCINFO.

typedef HCINFO *PHCINFO;


ΓòÉΓòÉΓòÉ 4.222. PHDC ΓòÉΓòÉΓòÉ

PHDC Pointer to HDC.

typedef HDC *PHDC;


ΓòÉΓòÉΓòÉ 4.223. PHELPINIT ΓòÉΓòÉΓòÉ

PHELPINIT Pointer to HELPINIT.

typedef HELPINIT *PHELPINIT;


ΓòÉΓòÉΓòÉ 4.224. PHELPSUBTABLE ΓòÉΓòÉΓòÉ

PHELPSUBTABLE Pointer to SHORT.

typedef HELPSUBTABLE *PHELPSUBTABLE;


ΓòÉΓòÉΓòÉ 4.225. PHELPTABLE ΓòÉΓòÉΓòÉ

PHELPTABLE Pointer to a HELPTABLE data structure.

typedef HELPTABLE *PHELPTABLE;


ΓòÉΓòÉΓòÉ 4.226. PHFIND ΓòÉΓòÉΓòÉ

PHFIND Pointer to HFIND.

typedef HFIND *PHFIND;


ΓòÉΓòÉΓòÉ 4.227. PHLIB ΓòÉΓòÉΓòÉ

PHLIB Pointer to a HLIB data structure.

typedef HLIB *PHLIB;


ΓòÉΓòÉΓòÉ 4.228. PHMF ΓòÉΓòÉΓòÉ

PHMF Pointer to HMF.

typedef HMF *PHMF;


ΓòÉΓòÉΓòÉ 4.229. PHMODULE ΓòÉΓòÉΓòÉ

PHMODULE Pointer to HMODULE.

typedef HMODULE *PHMODULE;


ΓòÉΓòÉΓòÉ 4.230. PHPAL ΓòÉΓòÉΓòÉ

PHPAL Pointer to HPAL.

typedef HPAL *PHPAL;


ΓòÉΓòÉΓòÉ 4.231. PHPROGARRAY ΓòÉΓòÉΓòÉ

PHPROGARRAY Pointer to HPROGARRAY.

typedef HPROGARRAY *PHPROGARRAY;


ΓòÉΓòÉΓòÉ 4.232. PHPROGRAM ΓòÉΓòÉΓòÉ

PHPROGRAM Pointer to HPROGRAM.

typedef HPROGRAM *PHPROGRAM;


ΓòÉΓòÉΓòÉ 4.233. PHPS ΓòÉΓòÉΓòÉ

PHPS Pointer to HPS.

typedef HPS *PHPS;


ΓòÉΓòÉΓòÉ 4.234. PHRGN ΓòÉΓòÉΓòÉ

PHRGN Pointer to HRGN.

typedef HRGN *PHRGN;


ΓòÉΓòÉΓòÉ 4.235. PHSEM ΓòÉΓòÉΓòÉ

PHSEM Pointer to HSEM.

typedef HSEM *PHSEM;


ΓòÉΓòÉΓòÉ 4.236. PHSWITCH ΓòÉΓòÉΓòÉ

PHSWITCH Pointer to HSWITCH.

typedef HSWITCH *PHSWITCH;


ΓòÉΓòÉΓòÉ 4.237. PHWND ΓòÉΓòÉΓòÉ

PHWND Pointer to HWND.

typedef HWND *PHWND;


ΓòÉΓòÉΓòÉ 4.238. PIBSTRUCT ΓòÉΓòÉΓòÉ

PIBSTRUCT Program-information-block structure.

typedef struct _PIBSTRUCT {
PROGTYPE     progt;                       /* Program type and visibility  */
CHAR         szTitle[MAXNAMEL+1];         /* Program title (NULL-terminated)  */
CHAR         szIconFileName[MAXPATHL+1];  /* Program icon filename (NULL-terminated)  */
CHAR         szExecutable[MAXPATHL+1];    /* Executable file name (NULL-terminated)  */
CHAR         szStartupDir[MAXPATHL+1];    /* Start-up directory (NULL-terminated)  */
XYWINSIZE    xywinInitial;                /* Initial window position and size  */
USHORT       res1;                        /* Reserved; must be 0  */
LHANDLE      res2;                        /* Reserved; must be NULLHANDLE  */
USHORT       cchEnvironmentVars;          /* Environment string length  */
PCH          pchEnvironmentVars;          /* Environment string  */
USHORT       cchProgramParameter;         /* Parameter string length  */
PCH          pchProgramParameter;         /* Parameter string  */
 } PIBSTRUCT;


ΓòÉΓòÉΓòÉ <hidden> progt ΓòÉΓòÉΓòÉ

progt (PROGTYPE)
   Program type and visibility.


ΓòÉΓòÉΓòÉ <hidden> szTitle[MAXNAMEL+1] ΓòÉΓòÉΓòÉ

szTitle[MAXNAMEL+1] (CHAR)
   Program title (NULL-terminated).


ΓòÉΓòÉΓòÉ <hidden> szIconFileName[MAXPATHL+1] ΓòÉΓòÉΓòÉ

szIconFileName[MAXPATHL+1] (CHAR)
   Program icon filename (NULL-terminated).


ΓòÉΓòÉΓòÉ <hidden> szExecutable[MAXPATHL+1] ΓòÉΓòÉΓòÉ

szExecutable[MAXPATHL+1] (CHAR)
   Executable file name (NULL-terminated).


ΓòÉΓòÉΓòÉ <hidden> szStartupDir[MAXPATHL+1] ΓòÉΓòÉΓòÉ

szStartupDir[MAXPATHL+1] (CHAR)
   Start-up directory (NULL-terminated).


ΓòÉΓòÉΓòÉ <hidden> xywinInitial ΓòÉΓòÉΓòÉ

xywinInitial (XYWINSIZE)
   Initial window position and size.


ΓòÉΓòÉΓòÉ <hidden> res1 ΓòÉΓòÉΓòÉ

res1 (USHORT)
   Reserved; must be 0.


ΓòÉΓòÉΓòÉ <hidden> res2 ΓòÉΓòÉΓòÉ

res2 (LHANDLE)
   Reserved; must be NULLHANDLE.


ΓòÉΓòÉΓòÉ <hidden> cchEnvironmentVars ΓòÉΓòÉΓòÉ

cchEnvironmentVars (USHORT)
   Environment string length.


ΓòÉΓòÉΓòÉ <hidden> pchEnvironmentVars ΓòÉΓòÉΓòÉ

pchEnvironmentVars (PCH)
   Environment string.


ΓòÉΓòÉΓòÉ <hidden> cchProgramParameter ΓòÉΓòÉΓòÉ

cchProgramParameter (USHORT)
   Parameter string length.


ΓòÉΓòÉΓòÉ <hidden> pchProgramParameter ΓòÉΓòÉΓòÉ

pchProgramParameter (PCH)
   Parameter string.


ΓòÉΓòÉΓòÉ 4.239. PICONINFO ΓòÉΓòÉΓòÉ

PICONINFO Pointer to ICONINFO structure.

typedef ICONINFO FAR *PICONINFO;


ΓòÉΓòÉΓòÉ 4.240. PICONPOS ΓòÉΓòÉΓòÉ

PICONPOS Pointer to ICONPOS data structure.

typedef ICONPOS *PICONPOS;


ΓòÉΓòÉΓòÉ 4.241. PID ΓòÉΓòÉΓòÉ

PID Process identity.

typedef LHANDLE PID;


ΓòÉΓòÉΓòÉ 4.242. PIMAGEBUNDLE ΓòÉΓòÉΓòÉ

PIMAGEBUNDLE Pointer to IMAGEBUNDLE.

typedef IMAGEBUNDLE *PIMAGEBUNDLE;


ΓòÉΓòÉΓòÉ 4.243. PIPT ΓòÉΓòÉΓòÉ

PIPT Pointer to IPT.

typedef PLONG *PIPT;


ΓòÉΓòÉΓòÉ 4.244. PIX ΓòÉΓòÉΓòÉ

PIX pel count for multi-line entry field.

typedef LONG PIX;


ΓòÉΓòÉΓòÉ 4.245. PKERNINGPAIRS ΓòÉΓòÉΓòÉ

PKERNINGPAIRS Pointer to KERNINGPAIRS.

typedef KERNINGPAIRS *PKERNINGPAIRS;


ΓòÉΓòÉΓòÉ 4.246. PLINEBUNDLE ΓòÉΓòÉΓòÉ

PLINEBUNDLE Pointer to LINEBUNDLE.

typedef LINEBUNDLE *PLINEBUNDLE;


ΓòÉΓòÉΓòÉ 4.247. PLINKITEM ΓòÉΓòÉΓòÉ

PLINKITEM Pointer to LINKITEM.

typedef LINKITEM *PLINKITEM;


ΓòÉΓòÉΓòÉ 4.248. PLONG ΓòÉΓòÉΓòÉ

PLONG Pointer to LONG.

typedef LONG *PLONG;


ΓòÉΓòÉΓòÉ 4.249. PMARGSTRUCT ΓòÉΓòÉΓòÉ

PMARGSTRUCT Pointer to a MLEMARGSTRUCT data structure.

typedef MLEMARGSTRUCT *PMARGSTRUCT;


ΓòÉΓòÉΓòÉ 4.250. PMARKERBUNDLE ΓòÉΓòÉΓòÉ

PMARKERBUNDLE Pointer to MARKERBUNDLE.

typedef MARKERBUNDLE *PMARKERBUNDLE;


ΓòÉΓòÉΓòÉ 4.251. PMATRIXLF ΓòÉΓòÉΓòÉ

PMATRIXLF Pointer to MATRIXLF.

typedef MATRIXLF *PMATRIXLF;


ΓòÉΓòÉΓòÉ 4.252. PMEMORYITEM ΓòÉΓòÉΓòÉ

PMEMORYITEM Pointer to MEMORYITEM.

typedef MEMORYITEM *PMEMORYITEM;


ΓòÉΓòÉΓòÉ 4.253. PMENUITEM ΓòÉΓòÉΓòÉ

PMENUITEM Pointer to a MENUITEM data structure.

typedef MENUITEM *PMENUITEM;


ΓòÉΓòÉΓòÉ 4.254. PMFP ΓòÉΓòÉΓòÉ

PMFP Pointer to MFP.

typedef MFP *PMFP;


ΓòÉΓòÉΓòÉ 4.255. PMINIRECORDCORE ΓòÉΓòÉΓòÉ

PMINIRECORDCORE Pointer to a MINIRECORDCORE data structure.

typedef MINIRECORDCORE *PMINIRECORDCORE;


ΓòÉΓòÉΓòÉ 4.256. PMLE_SEARCHDATA ΓòÉΓòÉΓòÉ

PMLE_SEARCHDATA Pointer to a MLE_SEARCHDATA data structure.

typedef MLE_SEARCHDATA *PMLE_SEARCHDATA;


ΓòÉΓòÉΓòÉ 4.257. PMPARAM ΓòÉΓòÉΓòÉ

PMPARAM Pointer to a 4-byte message-dependent parameter structure.

typedef MPARAM *PMPARAM;


ΓòÉΓòÉΓòÉ 4.258. PMQINFO ΓòÉΓòÉΓòÉ

PMQINFO Pointer to MQINFO.

typedef MQINFO *PMQINFO;


ΓòÉΓòÉΓòÉ 4.259. PMRESULT ΓòÉΓòÉΓòÉ

PMRESULT Pointer to a 4-byte message-dependent reply parameter structure.

typedef MRESULT *PMRESULT;


ΓòÉΓòÉΓòÉ 4.260. PMSEMSG ΓòÉΓòÉΓòÉ

PMSEMSG Pointer to a MSEMSG data structure.

typedef MSEMSG *PMSEMSG;


ΓòÉΓòÉΓòÉ 4.261. PNOTIFYDELTA ΓòÉΓòÉΓòÉ

PNOTIFYDELTA Pointer to a NOTIFYDELTA data structure.

typedef NOTIFYDELTA *PNOTIFYDELTA;


ΓòÉΓòÉΓòÉ 4.262. PNOTIFYRECORDEMPHASIS ΓòÉΓòÉΓòÉ

PNOTIFYRECORDEMPHASIS Pointer to a NOTIFYRECORDEMPHASIS data structure.

typedef NOTIFYRECORDEMPHASIS *PNOTIFYRECORDEMPHASIS;


ΓòÉΓòÉΓòÉ 4.263. PNOTIFYRECORDENTER ΓòÉΓòÉΓòÉ

PNOTIFYRECORDENTER Pointer to a NOTIFYRECORDENTER data structure.

typedef NOTIFYRECORDENTER *PNOTIFYRECORDENTER;


ΓòÉΓòÉΓòÉ 4.264. PNOTIFYSCROLL ΓòÉΓòÉΓòÉ

PNOTIFYSCROLL Pointer to a NOTIFYSCROLL data structure.

typedef NOTIFYSCROLL *PNOTIFYSCROLL;


ΓòÉΓòÉΓòÉ 4.265. POBJCLASS ΓòÉΓòÉΓòÉ

POBJCLASS Pointer to an OBJCLASS data structure.

typedef OBJCLASS *POBJCLASS;


ΓòÉΓòÉΓòÉ 4.266. POBJDATA ΓòÉΓòÉΓòÉ

POBJDATA Pointer to OBJDATA structure.

typedef OBJDATA *POBJDATA;


ΓòÉΓòÉΓòÉ 4.267. POBJECT ΓòÉΓòÉΓòÉ

POBJECT Pointer to WPObject *.

A two-part definition is shown here to match the header files.

typedef WPObject *OBJECT;
typedef OBJECT   *POBJECT;


ΓòÉΓòÉΓòÉ 4.268. POINTERINFO ΓòÉΓòÉΓòÉ

POINTERINFO Pointer-information structure.

typedef struct _POINTERINFO {
ULONG      fPointer;        /* Bit-map size indicator  */
LONG       xHotspot;        /* X-coordinate of action point  */
LONG       yHotspot;        /* Y-coordinate of action point  */
HBITMAP    hbmPointer;      /* Bit-map handle of pointer  */
HBITMAP    hbmColor;        /* Bit-map handle of color bit map  */
HBITMAP    hbmMiniPointer;  /* Bit-map handle of a pointer to a mini bit map  */
HBITMAP    hbmMiniColor;    /* Bit-map handle of mini color bit map  */
 } POINTERINFO;


ΓòÉΓòÉΓòÉ <hidden> fPointer ΓòÉΓòÉΓòÉ

fPointer (ULONG)
   Bit-map size indicator.

   TRUE
      Pointer-sized bit map
   FALSE
      Icon-sized bit map.


ΓòÉΓòÉΓòÉ <hidden> xHotspot ΓòÉΓòÉΓòÉ

xHotspot (LONG)
   X-coordinate of action point.


ΓòÉΓòÉΓòÉ <hidden> yHotspot ΓòÉΓòÉΓòÉ

yHotspot (LONG)
   Y-coordinate of action point.


ΓòÉΓòÉΓòÉ <hidden> hbmPointer ΓòÉΓòÉΓòÉ

hbmPointer (HBITMAP)
   Bit-map handle of pointer.


ΓòÉΓòÉΓòÉ <hidden> hbmColor ΓòÉΓòÉΓòÉ

hbmColor (HBITMAP)
   Bit-map handle of color bit map.


ΓòÉΓòÉΓòÉ <hidden> hbmMiniPointer ΓòÉΓòÉΓòÉ

hbmMiniPointer (HBITMAP)
   Bit-map handle of a pointer to a mini bit map.


ΓòÉΓòÉΓòÉ <hidden> hbmMiniColor ΓòÉΓòÉΓòÉ

hbmMiniColor (HBITMAP)
   Bit-map handle of mini color bit map.


ΓòÉΓòÉΓòÉ 4.269. POINTL ΓòÉΓòÉΓòÉ

POINTL Point structure (long integer).

typedef struct _POINTL {
LONG    x;  /* X-coordinate  */
LONG    y;  /* Y-coordinate  */
 } POINTL;


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (LONG)
   X-coordinate.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (LONG)
   Y-coordinate.


ΓòÉΓòÉΓòÉ 4.270. POINTS ΓòÉΓòÉΓòÉ

POINTS Point structure (short integer).

typedef struct _POINTS {
SHORT    x;  /* X-coordinate  */
SHORT    y;  /* Y-coordinate  */
 } POINTS;


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (SHORT)
   X-coordinate.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (SHORT)
   Y-coordinate.


ΓòÉΓòÉΓòÉ 4.271. POLYGON ΓòÉΓòÉΓòÉ

POLYGON Polygon structure.

typedef struct _POLYGON {
ULONG      ulPoints;  /* Number of points in array  */
PPOINTL    aPointl;   /* Array of points  */
 } POLYGON;


ΓòÉΓòÉΓòÉ <hidden> ulPoints ΓòÉΓòÉΓòÉ

ulPoints (ULONG)
   Number of points in array.


ΓòÉΓòÉΓòÉ <hidden> aPointl ΓòÉΓòÉΓòÉ

aPointl (PPOINTL)
   Array of points.


ΓòÉΓòÉΓòÉ 4.272. POVERFLOW ΓòÉΓòÉΓòÉ

POVERFLOW Pointer to a MLEOVERFLOW data structure.

typedef MLEOVERFLOW *POVERFLOW;


ΓòÉΓòÉΓòÉ 4.273. POWNERBACKGROUND ΓòÉΓòÉΓòÉ

POWNERBACKGROUND Pointer to an OWNERBACKGROUND data structure.

typedef OWNERBACKGROUND *POWNERBACKGROUND;


ΓòÉΓòÉΓòÉ 4.274. POWNERITEM ΓòÉΓòÉΓòÉ

POWNERITEM Pointer to a OWNERITEM data structure.

typedef OWNERITEM *POWNERITEM;


ΓòÉΓòÉΓòÉ 4.275. PPAGEINFO ΓòÉΓòÉΓòÉ

PPAGEINFO Pointer to PAGEINFO structure.

typedef PAGEINFO *PPAGEINFO;


ΓòÉΓòÉΓòÉ 4.276. PPAGESELECTNOTIFY ΓòÉΓòÉΓòÉ

PPAGESELECTNOTIFY Pointer to a PAGESELECTNOTIFY data structure.

typedef PAGESELECTNOTIFY *PPAGESELECTNOTIFY;


ΓòÉΓòÉΓòÉ 4.277. PPALINFO ΓòÉΓòÉΓòÉ

PPALINFO Pointer to PALINFO.

typedef PALINFO *PPALINFO;


ΓòÉΓòÉΓòÉ 4.278. PPIBSTRUCT ΓòÉΓòÉΓòÉ

PPIBSTRUCT Pointer to PIBSTRUCT.

typedef PIBSTRUCT *PPIBSTRUCT;


ΓòÉΓòÉΓòÉ 4.279. PPID ΓòÉΓòÉΓòÉ

PPID Pointer to PID.

typedef PID *PPID;


ΓòÉΓòÉΓòÉ 4.280. PPOINTL ΓòÉΓòÉΓòÉ

PPOINTL Pointer to a POINTL data structure.

typedef POINTL *PPOINTL;


ΓòÉΓòÉΓòÉ 4.281. PPOINTS ΓòÉΓòÉΓòÉ

PPOINTS Pointer to POINTS.

typedef POINTS *PPOINTS;


ΓòÉΓòÉΓòÉ 4.282. PPOLYGON ΓòÉΓòÉΓòÉ

PPOLYGON Pointer to POLYGON.

typedef POLYGON *PPOLYGON;


ΓòÉΓòÉΓòÉ 4.283. PPRDINFO3 ΓòÉΓòÉΓòÉ

PPRDINFO3 Pointer to PRDINFO3.

typedef PRDINFO3 *PPRDINFO3;


ΓòÉΓòÉΓòÉ 4.284. PPRDRIVINFO ΓòÉΓòÉΓòÉ

PPRDRIVINFO Pointer to PRDRIVINFO.

typedef PRDRIVINFO *PPRDRIVINFO;


ΓòÉΓòÉΓòÉ 4.285. PPRESPARAMS ΓòÉΓòÉΓòÉ

PPRESPARAMS Pointer to PRESPARAMS.

typedef PRESPARAMS *PPRESPARAMS;


ΓòÉΓòÉΓòÉ 4.286. PPRINTDEST ΓòÉΓòÉΓòÉ

PPRINTDEST Pointer to PRINTDEST structure.

typedef PRINTDEST *PPRINTDEST;


ΓòÉΓòÉΓòÉ 4.287. PPRINTERINFO ΓòÉΓòÉΓòÉ

PPRINTERINFO Pointer to PRINTERINFO.

typedef PRINTERINFO *PPRINTERINFO;


ΓòÉΓòÉΓòÉ 4.288. PPRJINFO2 ΓòÉΓòÉΓòÉ

PPRJINFO2 Pointer to PRJINFO2.

typedef PRJINFO2 *PPRJINFO2;


ΓòÉΓòÉΓòÉ 4.289. PPRJINFO3 ΓòÉΓòÉΓòÉ

PPRJINFO3 Pointer to PRJINFO3.

typedef PRJINFO3 *PPRJINFO3;


ΓòÉΓòÉΓòÉ 4.290. PPROGCATEGORY ΓòÉΓòÉΓòÉ

PPROGCATEGORY Pointer to PROGCATEGORY.

typedef PROGCATEGORY *PPROGCATEGORY;


ΓòÉΓòÉΓòÉ 4.291. PPROGDETAILS ΓòÉΓòÉΓòÉ

PPROGDETAILS Pointer to PROGDETAILS.

typedef PROGDETAILS *PPROGDETAILS;


ΓòÉΓòÉΓòÉ 4.292. PPROGRAMENTRY ΓòÉΓòÉΓòÉ

PPROGRAMENTRY Pointer to PROGRAMENTRY.

typedef PROGRAMENTRY FAR *PPROGRAMENTRY;


ΓòÉΓòÉΓòÉ 4.293. PPROGTITLE ΓòÉΓòÉΓòÉ

PPROGTITLE Pointer to PROGTITLE.

typedef PROGTITLE *PPROGTITLE;


ΓòÉΓòÉΓòÉ 4.294. PPROGTYPE ΓòÉΓòÉΓòÉ

PPROGTYPE Pointer to PROGTYPE.

typedef PROGTYPE *PPROGTYPE;


ΓòÉΓòÉΓòÉ 4.295. PPRPORTINFO ΓòÉΓòÉΓòÉ

PPRPORTINFO Pointer to PRPORTINFO.

typedef PRPORTINFO *PPRPORTINFO;


ΓòÉΓòÉΓòÉ 4.296. PPRPORTINFO1 ΓòÉΓòÉΓòÉ

PPRPORTINFO1 Pointer to PRPORTINFO1.

typedef PRPORTINFO1 *PPRPORTINFO1;


ΓòÉΓòÉΓòÉ 4.297. PPRQINFO3 ΓòÉΓòÉΓòÉ

PPRQINFO3 Pointer to PRQINFO3.

typedef PRQINFO3 *PPRQINFO3;


ΓòÉΓòÉΓòÉ 4.298. PPRQINFO6 ΓòÉΓòÉΓòÉ

PPRQINFO6 Pointer to PRQINFO6.

typedef PRQINFO6 *PPRQINFO6;


ΓòÉΓòÉΓòÉ 4.299. PPRQPROCINFO ΓòÉΓòÉΓòÉ

PPRQPROCINFO Pointer to PRQPROCINFO.

typedef PRQPROCINFO *PPRQPROCINFO;


ΓòÉΓòÉΓòÉ 4.300. PPSZ ΓòÉΓòÉΓòÉ

PPSZ Pointer to a PSZ pointer.

typedef PSZ *PPSZ;


ΓòÉΓòÉΓòÉ 4.301. PPVOID ΓòÉΓòÉΓòÉ

PPVOID Pointer to PVOID.

typedef PVOID *PPVOID;


ΓòÉΓòÉΓòÉ 4.302. PQMOPENDATA ΓòÉΓòÉΓòÉ

PQMOPENDATA Open queue-manager data array.

This data type points to data whose format is described by the DEVOPENSTRUC
data type.

typedef PSZ *PQMOPENDATA;


ΓòÉΓòÉΓòÉ 4.303. PQMSG ΓòÉΓòÉΓòÉ

PQMSG Pointer to a QMSG data structure.

typedef QMSG *PQMSG;


ΓòÉΓòÉΓòÉ 4.304. PQUERYRECFROMRECT ΓòÉΓòÉΓòÉ

PQUERYRECFROMRECT Pointer to a QUERYRECFROMRECT data structure.

typedef QUERYRECFROMRECT *PQUERYRECFROMRECT;


ΓòÉΓòÉΓòÉ 4.305. PQUERYRECORDRECT ΓòÉΓòÉΓòÉ

PQUERYRECORDRECT Pointer to a QUERYRECORDRECT data structure.

typedef QUERYRECORDRECT *PQUERYRECORDRECT;


ΓòÉΓòÉΓòÉ 4.306. PRDINFO3 ΓòÉΓòÉΓòÉ

PRDINFO3 Print device information structure (level 3).

typedef struct _PRDINFO3 {
PSZ       pszPrinterName;  /* Print device name  */
PSZ       pszUserName;     /* User who submitted job  */
PSZ       pszLogAddr;      /* Logical address (for example LPT1)  */
USHORT    uJobId;          /* Identity of current job  */
USHORT    fsStatus;        /* Print destination status  */
PSZ       pszStatus;       /* Print device comment while printing  */
PSZ       pszComment;      /* Print device description  */
PSZ       pszDrivers;      /* Drivers supported by print device  */
USHORT    time;            /* Time job has been printing (minutes)  */
USHORT    usTimeOut;       /* Device timeout (seconds)  */
 } PRDINFO3;


ΓòÉΓòÉΓòÉ <hidden> pszPrinterName ΓòÉΓòÉΓòÉ

pszPrinterName (PSZ)
   Print device name.


ΓòÉΓòÉΓòÉ <hidden> pszUserName ΓòÉΓòÉΓòÉ

pszUserName (PSZ)
   User who submitted job.

   This parameter is valid only while the job is printing. It is NULL for a job
   submitted locally.


ΓòÉΓòÉΓòÉ <hidden> pszLogAddr ΓòÉΓòÉΓòÉ

pszLogAddr (PSZ)
   Logical address (for example LPT1).

   If NULL or an empty string, the printer is not connected to a logical
   address.


ΓòÉΓòÉΓòÉ <hidden> uJobId ΓòÉΓòÉΓòÉ

uJobId (USHORT)
   Identity of current job.

   If 0, no job is printing.


ΓòÉΓòÉΓòÉ <hidden> fsStatus ΓòÉΓòÉΓòÉ

fsStatus (USHORT)
   Print destination status.

   Use the mask PRD_STATUS_MASK to determine the print job status:

   PRD_ACTIVE
      Processing
   PRD_PAUSED
      Not processing, or paused.

      Use the mask PRJ_DEVSTATUS for further information about print job
      status:
   PRJ_COMPLETE
      Job complete
   PRJ_INTERV
      Intervention required
   PRJ_ERROR
      Error occurred (in this case, pszStatus may contain a comment about the
      error)
   PRJ_DESTOFFLINE
      Print device offline
   PRJ_DESTPAUSED
      Print device paused
   PRJ_NOTIFY
      Raise alert
   PRJ_DESTNOPAPER
      Print device out of paper.


ΓòÉΓòÉΓòÉ <hidden> pszStatus ΓòÉΓòÉΓòÉ

pszStatus (PSZ)
   Print device comment while printing.

   A comment posted by the print processor of the print device. This parameter
   is valid only during printing.


ΓòÉΓòÉΓòÉ <hidden> pszComment ΓòÉΓòÉΓòÉ

pszComment (PSZ)
   Print device description.


ΓòÉΓòÉΓòÉ <hidden> pszDrivers ΓòÉΓòÉΓòÉ

pszDrivers (PSZ)
   Drivers supported by print device.

   List items are separated by commas. Each printer driver name may have a
   device name separated by a dot (for example, PLOTTER.HP7475A). The default
   printer is listed first.


ΓòÉΓòÉΓòÉ <hidden> time ΓòÉΓòÉΓòÉ

time (USHORT)
   Time job has been printing (minutes).

   This parameter applies only during printing.


ΓòÉΓòÉΓòÉ <hidden> usTimeOut ΓòÉΓòÉΓòÉ

usTimeOut (USHORT)
   Device timeout (seconds).

   The time that elapses before the device driver notifies the spooler that the
   print device has not responded.


ΓòÉΓòÉΓòÉ 4.307. PRDRIVINFO ΓòÉΓòÉΓòÉ

PRDRIVINFO Printer driver information structure (level 0).

typedef struct _PRDRIVINFO {
CHAR    szDrivName[DRIV_NAME_SIZE+DRIV_DEVICENAME_SIZE+2];            /* Name of printer driver  */
 } PRDRIVINFO;


ΓòÉΓòÉΓòÉ <hidden> szDrivName[DRIV_NAME_SIZE+DRIV_DEVICENAME_SIZE+2] ΓòÉΓòÉΓòÉ

szDrivName[DRIV_NAME_SIZE+DRIV_DEVICENAME_SIZE+2] (CHAR)
   Name of printer driver.

   This is the name of the printer driver and device is the format of
   DRIVER.DEVICE. For example "IBM4019.IBM Laserprinter E".


ΓòÉΓòÉΓòÉ 4.308. PRECORDCORE ΓòÉΓòÉΓòÉ

PRECORDCORE Pointer to a RECORDCORE data structure.

typedef RECORDCORE *PRECORDCORE;


ΓòÉΓòÉΓòÉ 4.309. PRECORDINSERT ΓòÉΓòÉΓòÉ

PRECORDINSERT Pointer to a RECORDINSERT data structure.

typedef RECORDINSERT *PRECORDINSERT;


ΓòÉΓòÉΓòÉ 4.310. PRECORDITEM ΓòÉΓòÉΓòÉ

PRECORDITEM Pointer to RECORDITEM.

typedef RECORDITEM *PRECORDITEM;


ΓòÉΓòÉΓòÉ 4.311. PRECTL ΓòÉΓòÉΓòÉ

PRECTL Pointer to a RECTL data structure.

typedef RECTL *PRECTL;


ΓòÉΓòÉΓòÉ 4.312. PRENDERFILE ΓòÉΓòÉΓòÉ

PRENDERFILE Pointer to RENDERFILE.

typedef RENDERFILE *PRENDERFILE;


ΓòÉΓòÉΓòÉ 4.313. PRESPARAMS ΓòÉΓòÉΓòÉ

PRESPARAMS Presentation parameter data.

typedef struct _PRESPARAMS {
ULONG    cb;         /* Byte count of the aparam[1] parameter  */
PARAM    aparam[1];  /* Array of attribute parameters  */
 } PRESPARAMS;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Byte count of the aparam[1] parameter.


ΓòÉΓòÉΓòÉ <hidden> aparam[1] ΓòÉΓòÉΓòÉ

aparam[1] (PARAM)
   Array of attribute parameters.


ΓòÉΓòÉΓòÉ 4.314. PRFPROFILE ΓòÉΓòÉΓòÉ

PRFPROFILE Profile structure.

typedef struct _PRFPROFILE {
ULONG    cchUserName;  /* Length of user profile name  */
PSZ      pszUserName;  /* User profile name  */
ULONG    cchSysName;   /* Length of system profile name  */
PSZ      pszSysName;   /* System profile name  */
 } PRFPROFILE;


ΓòÉΓòÉΓòÉ <hidden> cchUserName ΓòÉΓòÉΓòÉ

cchUserName (ULONG)
   Length of user profile name.


ΓòÉΓòÉΓòÉ <hidden> pszUserName ΓòÉΓòÉΓòÉ

pszUserName (PSZ)
   User profile name.


ΓòÉΓòÉΓòÉ <hidden> cchSysName ΓòÉΓòÉΓòÉ

cchSysName (ULONG)
   Length of system profile name.


ΓòÉΓòÉΓòÉ <hidden> pszSysName ΓòÉΓòÉΓòÉ

pszSysName (PSZ)
   System profile name.


ΓòÉΓòÉΓòÉ 4.315. PRGB2 ΓòÉΓòÉΓòÉ

PRGB2 Pointer to RGB2.

typedef RGB2 *PRGB2;


ΓòÉΓòÉΓòÉ 4.316. PRGNRECT ΓòÉΓòÉΓòÉ

PRGNRECT Pointer to RGNRECT.

typedef RGNRECT *PRGNRECT;


ΓòÉΓòÉΓòÉ 4.317. PRINTDEST ΓòÉΓòÉΓòÉ

PRINTDEST PRINTDEST data structure.

Contains all the parameters required to issue a DevPostDeviceModes and
DevOpenDC function calls.

typedef struct _PRINTDEST {
ULONG           cb;          /* Length of data structure, in bytes  */
LONG            lType;       /* Type of device context  */
PSZ             pszToken;    /* Device-information token  */
LONG            lCount;      /* Number of items  */
PDEVOPENDATA    pdopData;    /* Open device context data area  */
ULONG           fl;          /* Flags  */
PSZ             pszPrinter;  /* Name of Printer  */
 } PRINTDEST;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Length of data structure, in bytes.


ΓòÉΓòÉΓòÉ <hidden> lType ΓòÉΓòÉΓòÉ

lType (LONG)
   Type of device context.

   OD_QUEUED
      The device context is queued.
   OD_DIRECT
      The device context is direct.


ΓòÉΓòÉΓòÉ <hidden> pszToken ΓòÉΓòÉΓòÉ

pszToken (PSZ)
   Device-information token.

   This is always "*".


ΓòÉΓòÉΓòÉ <hidden> lCount ΓòÉΓòÉΓòÉ

lCount (LONG)
   Number of items.

   This is the number of items present in the pdopData field.


ΓòÉΓòÉΓòÉ <hidden> pdopData ΓòÉΓòÉΓòÉ

pdopData (PDEVOPENDATA)
   Open device context data area.

   See DEVOPENSTRUC for information on the format of pdopData.


ΓòÉΓòÉΓòÉ <hidden> fl ΓòÉΓòÉΓòÉ

fl (ULONG)
   Flags.

   PD_JOB_PROPERTY
      This flag indicates that DevPostDeviceModes should be called with
      DPDM_POSTJOBPROP before calling DevOpenDC.


ΓòÉΓòÉΓòÉ <hidden> pszPrinter ΓòÉΓòÉΓòÉ

pszPrinter (PSZ)
   Name of Printer.

   A name that specifies the device, for example "PRINTER1". The name is used
   for calling DevPostDeviceModes.


ΓòÉΓòÉΓòÉ 4.318. PRINTERINFO ΓòÉΓòÉΓòÉ

PRINTERINFO Print destination information structure.

This structure is used at information level 0.

typedef struct _PRINTERINFO {
ULONG    flType;                   /* Type of printer  */
PSZ      pszComputerName;          /* Computer name  */
PSZ      pszPrintDestinationName;  /* Name of Print Destination  */
PSZ      pszDescription;           /* Description of print destination  */
PSZ      pszLocalName;             /* Local name of remote print destination  */
 } PRINTERINFO;


ΓòÉΓòÉΓòÉ <hidden> flType ΓòÉΓòÉΓòÉ

flType (ULONG)
   Type of printer.

   This is a flag used to describe the type of print destination:

   SPL_PR_QUEUE
      Print destination is a queue
   SPL_PR_DIRECT_DEVICE
      Print destination is a direct print device
   SPL_PR_QUEUED_DEVICE
      Print destination is a queued print device


ΓòÉΓòÉΓòÉ <hidden> pszComputerName ΓòÉΓòÉΓòÉ

pszComputerName (PSZ)
   Computer name.

   A NULL string specifies the local workstation.


ΓòÉΓòÉΓòÉ <hidden> pszPrintDestinationName ΓòÉΓòÉΓòÉ

pszPrintDestinationName (PSZ)
   Name of Print Destination.

   It is either a queue name or a print device name depending upon the value of
   flType. The maximum length of the name in the network case is 256 (including
   one byte for the null terminator).


ΓòÉΓòÉΓòÉ <hidden> pszDescription ΓòÉΓòÉΓòÉ

pszDescription (PSZ)
   Description of print destination.

   The maximum length is 48 characters (including one byte for the null
   terminator).


ΓòÉΓòÉΓòÉ <hidden> pszLocalName ΓòÉΓòÉΓòÉ

pszLocalName (PSZ)
   Local name of remote print destination.

   This is a local port name (for instance "LPT4") that is connected to the
   remote print destination. A NULL string specifies that no connection exists.


ΓòÉΓòÉΓòÉ 4.319. PRJINFO2 ΓòÉΓòÉΓòÉ

PRJINFO2 Print-job information structure.

This structure provides a subset of the information supplied by PRJINFO3. It
minimizes the storage required for job-information retrieval, and is sufficient
for most uses.

typedef struct _PRJINFO2 {
USHORT    uJobId;       /* Job identification number  */
USHORT    uPriority;    /* Job priority  */
PSZ       pszUserName;  /* User who submitted the job  */
USHORT    uPosition;    /* Job position in queue  */
USHORT    fsStatus;     /* Job status  */
ULONG     ulSubmitted;  /* Time job submitted  */
ULONG     ulSize;       /* Print-job size (bytes)  */
PSZ       pszComment;   /* Comment string  */
PSZ       pszDocument;  /* Document name  */
 } PRJINFO2;


ΓòÉΓòÉΓòÉ <hidden> uJobId ΓòÉΓòÉΓòÉ

uJobId (USHORT)
   Job identification number.


ΓòÉΓòÉΓòÉ <hidden> uPriority ΓòÉΓòÉΓòÉ

uPriority (USHORT)
   Job priority.

   The job-priority range is 1 through 99, with 99 the highest job priority.
   (For queue priorities, 1 is the highest priority.)
   The job priority determines the order of jobs in the queue. If multiple
   queues print to the same printer, the job at the front of each queue is
   examined. The job with the highest priority is printed first; if there is
   more than one job with the highest priority, the oldest job with this
   priority is printed first.

   PRJ_MAX_PRIORITY
      Highest priority
   PRJ_MIN_PRIORITY
      Lowest priority
   PRJ_NO_PRIORITY
      No priority.


ΓòÉΓòÉΓòÉ <hidden> pszUserName ΓòÉΓòÉΓòÉ

pszUserName (PSZ)
   User who submitted the job.

   This parameter applies only to jobs created by a user and enqueued on a
   remote server. A NULL string signifies a local job.


ΓòÉΓòÉΓòÉ <hidden> uPosition ΓòÉΓòÉΓòÉ

uPosition (USHORT)
   Job position in queue.

   If 1, the job is scheduled to be the next job printed from this queue.


ΓòÉΓòÉΓòÉ <hidden> fsStatus ΓòÉΓòÉΓòÉ

fsStatus (USHORT)
   Job status.

   To find the job status, use the PRJ_QSTATUS mask:

   PRJ_QS_QUEUED
      Queued
   PRJ_QS_PAUSED
      Paused by a SplHoldJob function
   PRJ_QS_SPOOLING
      Job being created
   PRJ_QS_PRINTING
      Printing (bits 2 through 11 are valid).

      For further information, use the PRJ_DEVSTATUS mask:
   PRJ_COMPLETE
      Job complete
   PRJ_INTERV
      Intervention required
   PRJ_ERROR
      Error occurred.
   PRJ_DESTOFFLINE
      Print destination offline
   PRJ_DESTPAUSED
      Print destination paused
   PRJ_NOTIFY
      Alert should be raised
   PRJ_DESTNOPAPER
      Print destination out of paper
   PRJ_DESTFORMCHG
      Printer waiting for form change
   PRJ_DESTCRTCHG
      Printer waiting for cartridge change
   PRJ_DESTPENCHG
      Printer waiting for pen change.

      This bit indicates that the job is deleted:
   PRJ_DELETED
      Job deleted.


ΓòÉΓòÉΓòÉ <hidden> ulSubmitted ΓòÉΓòÉΓòÉ

ulSubmitted (ULONG)
   Time job submitted.

   Time format is the same as that stored in the global information segment.


ΓòÉΓòÉΓòÉ <hidden> ulSize ΓòÉΓòÉΓòÉ

ulSize (ULONG)
   Print-job size (bytes).


ΓòÉΓòÉΓòÉ <hidden> pszComment ΓòÉΓòÉΓòÉ

pszComment (PSZ)
   Comment string.

   Information about the print job. The maximum length of the string is 48
   characters( including one byte for the null terminator ).


ΓòÉΓòÉΓòÉ <hidden> pszDocument ΓòÉΓòÉΓòÉ

pszDocument (PSZ)
   Document name.

   The document name of the print job (set by the application that submitted
   the print job). The maximum length of the string is 260 characters.


ΓòÉΓòÉΓòÉ 4.320. PRJINFO3 ΓòÉΓòÉΓòÉ

PRJINFO3 Print-job information structure.

This structure is used when complete job details are required. A subset of this
information is supplied by PRJINFO2.

typedef struct _PRJINFO3 {
USHORT       uJobId;          /* Job identification number  */
USHORT       uPriority;       /* Job priority  */
PSZ          pszUserName;     /* User who submitted the job  */
USHORT       uPosition;       /* Job position in queue  */
USHORT       fsStatus;        /* Job status  */
ULONG        ulSubmitted;     /* Time job submitted  */
ULONG        ulSize;          /* Print-job size (bytes)  */
PSZ          pszComment;      /* Comment string  */
PSZ          pszDocument;     /* Document name  */
PSZ          pszNotifyName;   /* Messaging alias for print alert  */
PSZ          pszDataType;     /* Data type of submitted file  */
PSZ          pszParms;        /* Parameters  */
PSZ          pszStatus;       /* Status comment  */
PSZ          pszQueue;        /* Queue name  */
PSZ          pszQProcName;    /* Queue processor  */
PSZ          pszQProcParms;   /* Queue processor parameters  */
PSZ          pszDriverName;   /* Driver name  */
PDRIVDATA    pDriverData;     /* Job Properties (driver data)  */
PSZ          pszPrinterName;  /* Printer name  */
 } PRJINFO3;


ΓòÉΓòÉΓòÉ <hidden> uJobId ΓòÉΓòÉΓòÉ

uJobId (USHORT)
   Job identification number.


ΓòÉΓòÉΓòÉ <hidden> uPriority ΓòÉΓòÉΓòÉ

uPriority (USHORT)
   Job priority.

   The job-priority range is 1 through 99, with 99 the highest job priority.
   (For queue priorities, 1 is the highest priority.)
   The job priority determines the order of jobs in the queue. If multiple
   queues print to the same printer, the job on the front of each queue is
   examined. The job with the highest priority is printed first; if there is
   more than one job with the highest priority, the oldest job with this
   priority is printed first.

   PRJ_MAX_PRIORITY
      Highest priority
   PRJ_MIN_PRIORITY
      Lowest priority
   PRJ_NO_PRIORITY
      No priority.


ΓòÉΓòÉΓòÉ <hidden> pszUserName ΓòÉΓòÉΓòÉ

pszUserName (PSZ)
   User who submitted the job.

   This parameter applies only to jobs created by a user on a remote
   workstation and queued on a server. A NULL string signifies a local job.


ΓòÉΓòÉΓòÉ <hidden> uPosition ΓòÉΓòÉΓòÉ

uPosition (USHORT)
   Job position in queue.

   If 1, the job is scheduled to be the next job printed from this queue.


ΓòÉΓòÉΓòÉ <hidden> fsStatus ΓòÉΓòÉΓòÉ

fsStatus (USHORT)
   Job status.

   To find the job status, use the PRJ_QSTATUS mask:

   PRJ_QS_QUEUED
      Queued
   PRJ_QS_PAUSED
      Paused by a SplHoldJob function
   PRJ_QS_SPOOLING
      Job being created
   PRJ_QS_PRINTING
      Printing (bits 2 through 11 are valid).

      For further information, use the PRJ_DEVSTATUS mask:
   PRJ_COMPLETE
      Job complete
   PRJ_INTERV
      Intervention required
   PRJ_ERROR
      Error occurred. (In this case, pszStatus may contain a comment about the
      error)
   PRJ_DESTOFFLINE
      Print destination offline
   PRJ_DESTPAUSED
      Print destination paused
   PRJ_NOTIFY
      Alert should be raised
   PRJ_DESTNOPAPER
      Print destination out of paper
   PRJ_DESTFORMCHG
      Printer waiting for form change
   PRJ_DESTCRTCHG
      Printer waiting for cartridge change
   PRJ_DESTPENCHG
      Printer waiting for pen change.

      This bit indicates that the job is deleted:
   PRJ_DELETED
      Job deleted.


ΓòÉΓòÉΓòÉ <hidden> ulSubmitted ΓòÉΓòÉΓòÉ

ulSubmitted (ULONG)
   Time job submitted.

   Time format is the same as that stored in the global information segment.


ΓòÉΓòÉΓòÉ <hidden> ulSize ΓòÉΓòÉΓòÉ

ulSize (ULONG)
   Print-job size (bytes).


ΓòÉΓòÉΓòÉ <hidden> pszComment ΓòÉΓòÉΓòÉ

pszComment (PSZ)
   Comment string.

   Information about the print job.
   The maximum length of the string is 48 characters (including one byte for
   the null terminator).


ΓòÉΓòÉΓòÉ <hidden> pszDocument ΓòÉΓòÉΓòÉ

pszDocument (PSZ)
   Document name.

   The document name of the print job (set by the application that submitted
   the print job). The maximum length of the string is 260 characters.


ΓòÉΓòÉΓòÉ <hidden> pszNotifyName ΓòÉΓòÉΓòÉ

pszNotifyName (PSZ)
   Messaging alias for print alert.

   This parameter is a computer name and applies only to jobs on a remote
   server queue. A NULL string is returned for jobs on a local queue.


ΓòÉΓòÉΓòÉ <hidden> pszDataType ΓòÉΓòÉΓòÉ

pszDataType (PSZ)
   Data type of submitted file.

   This is specified by the pszDataType parameter in the DEVOPENSTRUC structure
   passed to the DevOpenDC call when the job is created. The name is truncated
   to fit the field if necessary, and contains a trailing NULL.


ΓòÉΓòÉΓòÉ <hidden> pszParms ΓòÉΓòÉΓòÉ

pszParms (PSZ)
   Parameters.

   The form of this string is:

      parm1=val1 parm2=val2 ...


ΓòÉΓòÉΓòÉ <hidden> pszStatus ΓòÉΓòÉΓòÉ

pszStatus (PSZ)
   Status comment.

   A text string, posted by the queue processor, that provides additional
   job-status information. The default string type is NULL.


ΓòÉΓòÉΓòÉ <hidden> pszQueue ΓòÉΓòÉΓòÉ

pszQueue (PSZ)
   Queue name.

   The name of the queue the job is on.


ΓòÉΓòÉΓòÉ <hidden> pszQProcName ΓòÉΓòÉΓòÉ

pszQProcName (PSZ)
   Queue processor.

   The name of the queue processor.


ΓòÉΓòÉΓòÉ <hidden> pszQProcParms ΓòÉΓòÉΓòÉ

pszQProcParms (PSZ)
   Queue processor parameters.

   Spaces are used to separate parameters.


ΓòÉΓòÉΓòÉ <hidden> pszDriverName ΓòÉΓòÉΓòÉ

pszDriverName (PSZ)
   Driver name.

   The name of the device driver (for example, "LASERJET"). The device name is
   part of pDriverData.


ΓòÉΓòÉΓòÉ <hidden> pDriverData ΓòÉΓòÉΓòÉ

pDriverData (PDRIVDATA)
   Job Properties (driver data).

   The contents are specific to the device driver.


ΓòÉΓòÉΓòÉ <hidden> pszPrinterName ΓòÉΓòÉΓòÉ

pszPrinterName (PSZ)
   Printer name.

   If the job is printing, the printer name, otherwise NULL.


ΓòÉΓòÉΓòÉ 4.321. PROGCATEGORY ΓòÉΓòÉΓòÉ

PROGCATEGORY Program category.

typedef ULONG PROGCATEGORY;


ΓòÉΓòÉΓòÉ 4.322. PROGDETAILS ΓòÉΓòÉΓòÉ

PROGDETAILS Program-details structure.

typedef struct _PROGDETAILS {
ULONG       Length;          /* Length of structure  */
PROGTYPE    progt;           /* Program type  */
PSZ         pszTitle;        /* Title  */
PSZ         pszExecutable;   /* Executable file name  */
PSZ         pszParameters;   /* Parameter string  */
PSZ         pszStartupDir;   /* Start-up directory  */
PSZ         pszIcon;         /* Icon-file name  */
PSZ         pszEnvironment;  /* Environment string  */
SWP         swpInitial;      /* Initial window position and size  */
 } PROGDETAILS;


ΓòÉΓòÉΓòÉ <hidden> Length ΓòÉΓòÉΓòÉ

Length (ULONG)
   Length of structure.


ΓòÉΓòÉΓòÉ <hidden> progt ΓòÉΓòÉΓòÉ

progt (PROGTYPE)
   Program type.


ΓòÉΓòÉΓòÉ <hidden> pszTitle ΓòÉΓòÉΓòÉ

pszTitle (PSZ)
   Title.


ΓòÉΓòÉΓòÉ <hidden> pszExecutable ΓòÉΓòÉΓòÉ

pszExecutable (PSZ)
   Executable file name.


ΓòÉΓòÉΓòÉ <hidden> pszParameters ΓòÉΓòÉΓòÉ

pszParameters (PSZ)
   Parameter string.


ΓòÉΓòÉΓòÉ <hidden> pszStartupDir ΓòÉΓòÉΓòÉ

pszStartupDir (PSZ)
   Start-up directory.


ΓòÉΓòÉΓòÉ <hidden> pszIcon ΓòÉΓòÉΓòÉ

pszIcon (PSZ)
   Icon-file name.


ΓòÉΓòÉΓòÉ <hidden> pszEnvironment ΓòÉΓòÉΓòÉ

pszEnvironment (PSZ)
   Environment string.

   A list of NULL-terminated strings, ending with an extra null.


ΓòÉΓòÉΓòÉ <hidden> swpInitial ΓòÉΓòÉΓòÉ

swpInitial (SWP)
   Initial window position and size.


ΓòÉΓòÉΓòÉ 4.323. PROGRAMENTRY ΓòÉΓòÉΓòÉ

PROGRAMENTRY Program-entry structure.

typedef struct _PROGRAMENTRY {
HPROGRAM    hprog;                /* Program handle  */
PROGTYPE    progt;                /* Program type  */
CHAR        szTitle[MAXNAMEL+1];  /* Program title (NULL-terminated)  */
 } PROGRAMENTRY;


ΓòÉΓòÉΓòÉ <hidden> hprog ΓòÉΓòÉΓòÉ

hprog (HPROGRAM)
   Program handle.


ΓòÉΓòÉΓòÉ <hidden> progt ΓòÉΓòÉΓòÉ

progt (PROGTYPE)
   Program type.


ΓòÉΓòÉΓòÉ <hidden> szTitle[MAXNAMEL+1] ΓòÉΓòÉΓòÉ

szTitle[MAXNAMEL+1] (CHAR)
   Program title (NULL-terminated).


ΓòÉΓòÉΓòÉ 4.324. PROGTITLE ΓòÉΓòÉΓòÉ

PROGTITLE Program-title structure.

typedef struct _PROGTITLE {
HPROGRAM    hprog;     /* Program handle  */
PROGTYPE    progt;     /* Program type  */
PSZ         pszTitle;  /* Program title  */
 } PROGTITLE;


ΓòÉΓòÉΓòÉ <hidden> hprog ΓòÉΓòÉΓòÉ

hprog (HPROGRAM)
   Program handle.


ΓòÉΓòÉΓòÉ <hidden> progt ΓòÉΓòÉΓòÉ

progt (PROGTYPE)
   Program type.


ΓòÉΓòÉΓòÉ <hidden> pszTitle ΓòÉΓòÉΓòÉ

pszTitle (PSZ)
   Program title.


ΓòÉΓòÉΓòÉ 4.325. PROGTYPE ΓòÉΓòÉΓòÉ

PROGTYPE Program-type structure.

typedef struct _PROGTYPE {
PROGCATEGORY    progc;      /* Program category  */
ULONG           fbVisible;  /* Visibility attribute  */
 } PROGTYPE;


ΓòÉΓòÉΓòÉ <hidden> progc ΓòÉΓòÉΓòÉ

progc (PROGCATEGORY)
   Program category:

   PROG_DEFAULT
      Default application.
   PROG_PM
      Presentation Manager application.
   PROG_WINDOWABLEVIO
      Text-windowed application.
   PROG_FULLSCREEN
      Full-screen application.
   PROG_WINDOWEDVDM
      PC DOS executable process (windowed).
   PROG_VDM
      PC DOS executable process (full screen).
   PROG_REAL
      PC DOS executable process (full screen). Same as PROG_VDM.
   PROG_31_STDSEAMLESSVDM
      Windows 3.1 program that will execute in its own windowed WINOS2 session.
   PROG_31_STDSEAMLESSCOMMON
      Windows 3.1 program that will execute in a common windowed WINOS2
      session.
   PROG_31_ENHSEAMLESSVDM
      Windows 3.1 program that will execute in enhanced compatibility mode in
      its own windowed WINOS2 session.
   PROG_31_ENHSEAMLESSCOMMON
      Windows 3.1 program that will execute in enhanced compatibility mode in a
      common windowed WINOS2 session.
   PROG_31_ENH
      Windows 3.1 program that will execute in enhanced compatibility mode in a
      full screen WINOS2 session.
   PROG_31_STD
      Windows 3.1 program that will execute in a full screen WINOS2 session.


ΓòÉΓòÉΓòÉ <hidden> fbVisible ΓòÉΓòÉΓòÉ

fbVisible (ULONG)
   Visibility attribute.

   When testing this field, allow for the possibility that other bits may be
   defined in the future. SHE_INVISIBLE and SHE_PROTECTED can be used to mask
   the visibility and protected flags, respectively.

   SHE_VISIBLE
      Visible
   SHE_INVISIBLE
      Invisible
   SHE_UNPROTECTED
      Unprotected
   SHE_PROTECTED
      Protected.


ΓòÉΓòÉΓòÉ 4.326. PRPORTINFO ΓòÉΓòÉΓòÉ

PRPORTINFO Port information structure (level 0).

typedef struct _PRPORTINFO {
CHAR    szPortName[PDLEN+1];       /* Name of the port  */
 } PRPORTINFO;


ΓòÉΓòÉΓòÉ <hidden> szPortName[PDLEN+1] ΓòÉΓòÉΓòÉ

szPortName[PDLEN+1] (CHAR)
   Name of the port.

   This is the name of the port. For example "LPT1".


ΓòÉΓòÉΓòÉ 4.327. PRPORTINFO1 ΓòÉΓòÉΓòÉ

PRPORTINFO1 Port information structure (level 1).

typedef struct _PRPORTINFO1 {
PSZ    pszPortName;            /* Name of the port  */
PSZ    pszPortDriverName;      /* Name of the port driver  */
PSZ    pszPortDriverPathName;  /* Full path name of the port driver  */
 } PRPORTINFO1;


ΓòÉΓòÉΓòÉ <hidden> pszPortName ΓòÉΓòÉΓòÉ

pszPortName (PSZ)
   Name of the port.

   This is the name of the port. For example "LPT1".


ΓòÉΓòÉΓòÉ <hidden> pszPortDriverName ΓòÉΓòÉΓòÉ

pszPortDriverName (PSZ)
   Name of the port driver.

   This is the name of the port driver. For example "PARALLEL".


ΓòÉΓòÉΓòÉ <hidden> pszPortDriverPathName ΓòÉΓòÉΓòÉ

pszPortDriverPathName (PSZ)
   Full path name of the port driver.

   This is the full path name of the port driver. For example
   "C:\OS2\DLL\PARALLEL.PDR".


ΓòÉΓòÉΓòÉ 4.328. PRQINFO3 ΓòÉΓòÉΓòÉ

PRQINFO3 Print-queue information structure.

This structure is used at information levels 3 and 4.

typedef struct _PRQINFO3 {
PSZ          pszName;        /* Queue name  */
USHORT       uPriority;      /* Queue priority  */
USHORT       uStartTime;     /* Minutes after midnight when queue becomes active  */
USHORT       uUntilTime;     /* Minutes after midnight when queue ceases to be active  */
USHORT       fsType;         /* Queue type  */
PSZ          pszSepFile;     /* Separator-page file  */
PSZ          pszPrProc;      /* Default queue-processor  */
PSZ          pszParms;       /* Queue parameters  */
PSZ          pszComment;     /* Queue description  */
USHORT       fsStatus;       /* Queue status  */
USHORT       cJobs;          /* Number of jobs in queue  */
PSZ          pszPrinters;    /* Print devices connected to queue  */
PSZ          pszDriverName;  /* Default device driver  */
PDRIVDATA    pDriverData;    /* Default queue job properties  */
 } PRQINFO3;


ΓòÉΓòÉΓòÉ <hidden> pszName ΓòÉΓòÉΓòÉ

pszName (PSZ)
   Queue name.

   The maximum length of the name in the network case is 256 (including one
   byte for zero termination).


ΓòÉΓòÉΓòÉ <hidden> uPriority ΓòÉΓòÉΓòÉ

uPriority (USHORT)
   Queue priority.

   The range is 1 through 9, with 1 being the highest queue priority.
   The default job priority (DefJobPrio) is determined from:
   DefJobPrio=100-(10* uPriority).

   If a job is added with PRJ_NO_PRIORITY specified, DefJobPrio is used. If a
   default priority higher than the default job priority is specified, the
   default job priority is used. If a default priority lower than the default
   is specified, the specified job priority is used.

   PRQ_DEF_PRIORITY
      Default priority
   PRQ_MAX_PRIORITY
      Highest priority
   PRQ_MIN_PRIORITY
      Minimum priority
   PRQ_NO_PRIORITY
      No priority.


ΓòÉΓòÉΓòÉ <hidden> uStartTime ΓòÉΓòÉΓòÉ

uStartTime (USHORT)
   Minutes after midnight when queue becomes active.

   For example, the value 75 represents 1:15 a.m.
   If uStartTime and uUntilTime are both 0, the print queue is always
   available.


ΓòÉΓòÉΓòÉ <hidden> uUntilTime ΓòÉΓòÉΓòÉ

uUntilTime (USHORT)
   Minutes after midnight when queue ceases to be active.

   For example, the value 1200 represents 8 p.m.
   If uUntilTime and uStartTime are both 0, the print queue is always
   available.


ΓòÉΓòÉΓòÉ <hidden> fsType ΓòÉΓòÉΓòÉ

fsType (USHORT)
   Queue type.

   PRQ3_TYPE_RAW
      Data is always enqueued in the device specific format.
   PRQ3_TYPE_BYPASS
      Allows the spooler to bypass the queue processor and send data directly
      to the Printer Driver. Setting this bit allows the spooler to print jobs
      of type PM_Q_RAW while they are still being spooled.
   PRQ3_TYPE_APPDEFAULT
      This bit is set for the application default queue only.


ΓòÉΓòÉΓòÉ <hidden> pszSepFile ΓòÉΓòÉΓòÉ

pszSepFile (PSZ)
   Separator-page file.

   The path and file name of a separator-page file on the target computer.
   This file contains formatting information for the page or pages to be used
   between print jobs. A relative path name is taken as relative to the current
   spool directory. A NULL string indicates no separator page.
   See IBM Operating System/2 Local Area Network Server Version 1.2: Network
   Administrator's Guide for information about the format of separator files.


ΓòÉΓòÉΓòÉ <hidden> pszPrProc ΓòÉΓòÉΓòÉ

pszPrProc (PSZ)
   Default queue-processor.


ΓòÉΓòÉΓòÉ <hidden> pszParms ΓòÉΓòÉΓòÉ

pszParms (PSZ)
   Queue parameters.

   This can be any text string or a NULL string.


ΓòÉΓòÉΓòÉ <hidden> pszComment ΓòÉΓòÉΓòÉ

pszComment (PSZ)
   Queue description.

   A NULL string results in no comment. The maximum length is 48 characters (
   including one byte for the null terminator ).


ΓòÉΓòÉΓòÉ <hidden> fsStatus ΓòÉΓòÉΓòÉ

fsStatus (USHORT)
   Queue status.

   PRQ3_PAUSED
      Queue is paused (held).
   PRQ3_PENDING
      Queue is pending deletion.


ΓòÉΓòÉΓòÉ <hidden> cJobs ΓòÉΓòÉΓòÉ

cJobs (USHORT)
   Number of jobs in queue.


ΓòÉΓòÉΓòÉ <hidden> pszPrinters ΓòÉΓòÉΓòÉ

pszPrinters (PSZ)
   Print devices connected to queue.

   This cannot be NULL.


ΓòÉΓòÉΓòÉ <hidden> pszDriverName ΓòÉΓòÉΓòÉ

pszDriverName (PSZ)
   Default device driver.


ΓòÉΓòÉΓòÉ <hidden> pDriverData ΓòÉΓòÉΓòÉ

pDriverData (PDRIVDATA)
   Default queue job properties.

   Note:  An application can use pszDriverName, pDriverData, pszPrProc, and
          pszParms to construct a valid DevOpenDC call based only on the queue
          name.


ΓòÉΓòÉΓòÉ 4.329. PRQINFO6 ΓòÉΓòÉΓòÉ

PRQINFO6 Print-queue information structure.

This structure is used at information level 6.

typedef struct _PRQINFO6 {
PSZ          pszName;                /* Queue name  */
USHORT       uPriority;              /* Queue priority  */
USHORT       uStartTime;             /* Minutes after midnight when queue becomes active  */
USHORT       uUntilTime;             /* Minutes after midnight when queue ceases to be active  */
USHORT       fsType;                 /* Queue type  */
PSZ          pszSepFile;             /* Separator-page file  */
PSZ          pszPrProc;              /* Default queue-processor  */
PSZ          pszParms;               /* Queue parameters  */
PSZ          pszComment;             /* Queue description  */
USHORT       fsStatus;               /* Queue status  */
USHORT       cJobs;                  /* Number of jobs in queue  */
PSZ          pszPrinters;            /* Print devices connected to queue  */
PSZ          pszDriverName;          /* Default device driver  */
PDRIVDATA    pDriverData;            /* Default queue job properties  */
PSZ          pszRemoteComputerName;  /* Remote computer name  */
PSZ          pszRemoteQueueName;     /* Remote queue name  */
 } PRQINFO6;


ΓòÉΓòÉΓòÉ <hidden> pszName ΓòÉΓòÉΓòÉ

pszName (PSZ)
   Queue name.

   The maximum length of the name in the network case is 256 (including one
   byte for zero termination).


ΓòÉΓòÉΓòÉ <hidden> uPriority ΓòÉΓòÉΓòÉ

uPriority (USHORT)
   Queue priority.

   The range is 1 through 9, with 1 being the highest queue priority.
   The default job priority (DefJobPrio) is determined from:
   DefJobPrio=100-(10* uPriority).

   If a job is added with PRJ_NO_PRIORITY specified, DefJobPrio is used. If a
   default priority higher than the default job priority is specified, the
   default job priority is used. If a default priority lower than the default
   is specified, the specified job priority is used.

   PRQ_DEF_PRIORITY
      Default priority
   PRQ_MAX_PRIORITY
      Highest priority
   PRQ_MIN_PRIORITY
      Minimum priority
   PRQ_NO_PRIORITY
      No priority.


ΓòÉΓòÉΓòÉ <hidden> uStartTime ΓòÉΓòÉΓòÉ

uStartTime (USHORT)
   Minutes after midnight when queue becomes active.

   For example, the value 75 represents 1:15 a.m.
   If uStartTime and uUntilTime are both 0, the print queue is always
   available.


ΓòÉΓòÉΓòÉ <hidden> uUntilTime ΓòÉΓòÉΓòÉ

uUntilTime (USHORT)
   Minutes after midnight when queue ceases to be active.

   For example, the value 1200 represents 8 p.m.
   If uUntilTime and uStartTime are both 0, the print queue is always
   available.


ΓòÉΓòÉΓòÉ <hidden> fsType ΓòÉΓòÉΓòÉ

fsType (USHORT)
   Queue type.

   PRQ3_TYPE_RAW
      Data is always enqueued in the device specific format.
   PRQ3_TYPE_BYPASS
      Allows the spooler to bypass the queue processor and send data directly
      to the Printer Driver. Setting this bit allows the spooler to print jobs
      of type PM_Q_RAW while they are still being spooled.
   PRQ3_TYPE_APPDEFAULT
      This bit is set for the application default queue only.


ΓòÉΓòÉΓòÉ <hidden> pszSepFile ΓòÉΓòÉΓòÉ

pszSepFile (PSZ)
   Separator-page file.

   The path and file name of a separator-page file on the target computer.
   This file contains formatting information for the page or pages to be used
   between print jobs. A relative path name is taken as relative to the current
   spool directory. A NULL string indicates no separator page.
   See IBM Operating System/2 Local Area Network Server Version 1.2: Network
   Administrator's Guide for information about the format of separator files.


ΓòÉΓòÉΓòÉ <hidden> pszPrProc ΓòÉΓòÉΓòÉ

pszPrProc (PSZ)
   Default queue-processor.


ΓòÉΓòÉΓòÉ <hidden> pszParms ΓòÉΓòÉΓòÉ

pszParms (PSZ)
   Queue parameters.

   This can be any text string or a NULL string.


ΓòÉΓòÉΓòÉ <hidden> pszComment ΓòÉΓòÉΓòÉ

pszComment (PSZ)
   Queue description.

   A NULL string results in no comment. The maximum length is 48 characters (
   including one byte for the null terminator ).


ΓòÉΓòÉΓòÉ <hidden> fsStatus ΓòÉΓòÉΓòÉ

fsStatus (USHORT)
   Queue status.

   PRQ3_PAUSED
      Queue is paused (held).
   PRQ3_PENDING
      Queue is pending deletion.


ΓòÉΓòÉΓòÉ <hidden> cJobs ΓòÉΓòÉΓòÉ

cJobs (USHORT)
   Number of jobs in queue.


ΓòÉΓòÉΓòÉ <hidden> pszPrinters ΓòÉΓòÉΓòÉ

pszPrinters (PSZ)
   Print devices connected to queue.

   This cannot be NULL.


ΓòÉΓòÉΓòÉ <hidden> pszDriverName ΓòÉΓòÉΓòÉ

pszDriverName (PSZ)
   Default device driver.


ΓòÉΓòÉΓòÉ <hidden> pDriverData ΓòÉΓòÉΓòÉ

pDriverData (PDRIVDATA)
   Default queue job properties.

   Note:  An application can use pszDriverName, pDriverData, pszPrProc, and
          pszParms to construct a valid DevOpenDC call based only on the queue
          name.


ΓòÉΓòÉΓòÉ <hidden> pszRemoteComputerName ΓòÉΓòÉΓòÉ

pszRemoteComputerName (PSZ)
   Remote computer name.

   The computer name part of a remote queue for which this queue is a local
   alias.


ΓòÉΓòÉΓòÉ <hidden> pszRemoteQueueName ΓòÉΓòÉΓòÉ

pszRemoteQueueName (PSZ)
   Remote queue name.

   The queue name part of a remote queue for which this queue is a local alias.


ΓòÉΓòÉΓòÉ 4.330. PRQPROCINFO ΓòÉΓòÉΓòÉ

PRQPROCINFO Queue processor information structure (level 0).

typedef struct _PRQPROCINFO {
CHAR    szQProcName[QNLEN+1];       /* Name of queue processor  */
 } PRQPROCINFO;


ΓòÉΓòÉΓòÉ <hidden> szQProcName[QNLEN+1] ΓòÉΓòÉΓòÉ

szQProcName[QNLEN+1] (CHAR)
   Name of queue processor.

   This is the name of the queue processor (driver). For example "PMPRINT".


ΓòÉΓòÉΓòÉ 4.331. PSBCDATA ΓòÉΓòÉΓòÉ

PSBCDATA Pointer to SBCDATA.

typedef SBCDATA *PSBCDATA;


ΓòÉΓòÉΓòÉ 4.332. PSEARCHSTRING ΓòÉΓòÉΓòÉ

PSEARCHSTRING Pointer to a SEARCHSTRING data structure.

typedef SEARCHSTRING *PSEARCHSTRING;


ΓòÉΓòÉΓòÉ 4.333. PSFACTORS ΓòÉΓòÉΓòÉ

PSFACTORS Pointer to SFACTORS.

typedef SFACTORS *PSFACTORS;


ΓòÉΓòÉΓòÉ 4.334. PSHORT ΓòÉΓòÉΓòÉ

PSHORT Pointer to SHORT.

typedef SHORT *PSHORT;


ΓòÉΓòÉΓòÉ 4.335. PSIZEF ΓòÉΓòÉΓòÉ

PSIZEF Pointer to SIZEF.

typedef SIZEF *PSIZEF;


ΓòÉΓòÉΓòÉ 4.336. PSIZEL ΓòÉΓòÉΓòÉ

PSIZEL Pointer to SIZEL.

typedef SIZEL *PSIZEL;


ΓòÉΓòÉΓòÉ 4.337. PSLDCDATA ΓòÉΓòÉΓòÉ

PSLDCDATA Pointer to a SLDCDATA data structure.

typedef SLDCDATA *PSLDCDATA;


ΓòÉΓòÉΓòÉ 4.338. PSMHSTRUCT ΓòÉΓòÉΓòÉ

PSMHSTRUCT Pointer to a SMHSTRUCT data structure.

typedef SMHSTRUCT *PSMHSTRUCT;


ΓòÉΓòÉΓòÉ 4.339. PSTRL ΓòÉΓòÉΓòÉ

PSTRL Pointer to PSZ.

typedef STRL *PSTRL;


ΓòÉΓòÉΓòÉ 4.340. PSTR8 ΓòÉΓòÉΓòÉ

PSTR8 Pointer to STR8.

typedef STR8 *PSTR8;


ΓòÉΓòÉΓòÉ 4.341. PSTR16 ΓòÉΓòÉΓòÉ

PSTR16 Pointer to STR16.

typedef STR16 *PSTR16;


ΓòÉΓòÉΓòÉ 4.342. PSTR32 ΓòÉΓòÉΓòÉ

PSTR32 Pointer to STR32.

typedef STR32 *PSTR32;


ΓòÉΓòÉΓòÉ 4.343. PSTR64 ΓòÉΓòÉΓòÉ

PSTR64 Pointer to STR64.

typedef STR64 *PSTR64;


ΓòÉΓòÉΓòÉ 4.344. PSTYLECHANGE ΓòÉΓòÉΓòÉ

PSTYLECHANGE Pointer to a STYLECHANGE data structure.

typedef STYLECHANGE *PSTYLECHANGE;


ΓòÉΓòÉΓòÉ 4.345. PSWBLOCK ΓòÉΓòÉΓòÉ

PSWBLOCK Pointer to a switch-list block structure.

typedef SWBLOCK *PSWBLOCK;


ΓòÉΓòÉΓòÉ 4.346. PSWCNTRL ΓòÉΓòÉΓòÉ

PSWCNTRL Pointer to a switch-list control block structure.

typedef SWCNTRL *PSWCNTRL;


ΓòÉΓòÉΓòÉ 4.347. PSWENTRY ΓòÉΓòÉΓòÉ

PSWENTRY Pointer to SWENTRY.

typedef SWENTRY *PSWENTRY;


ΓòÉΓòÉΓòÉ 4.348. PSWP ΓòÉΓòÉΓòÉ

PSWP Pointer to a SWP data structure.

typedef SWP *PSWP;


ΓòÉΓòÉΓòÉ 4.349. PSZ ΓòÉΓòÉΓòÉ

PSZ Pointer to a NULL-terminated string. If you are using C++, you may need to
use PCSZ See C++ Considerations for more information on C++ considerations.

typedef unsigned char *PSZ;


ΓòÉΓòÉΓòÉ 4.350. PTID ΓòÉΓòÉΓòÉ

PTID Pointer to TID.

typedef TID *PTID;


ΓòÉΓòÉΓòÉ 4.351. PTRACKINFO ΓòÉΓòÉΓòÉ

PTRACKINFO Pointer to a TRACKINFO data structure.

typedef TRACKINFO *PTRACKINFO;


ΓòÉΓòÉΓòÉ 4.352. PTREEITEMDESC ΓòÉΓòÉΓòÉ

PTREEITEMDESC Pointer to a TREEITEMDESC data structure.

typedef TREEITEMDESC *PTREEITEMDESC;


ΓòÉΓòÉΓòÉ 4.353. PUCHAR ΓòÉΓòÉΓòÉ

PUCHAR Pointer to UCHAR.

typedef UCHAR *PUCHAR;


ΓòÉΓòÉΓòÉ 4.354. PULONG ΓòÉΓòÉΓòÉ

PULONG Pointer to ULONG.

typedef ULONG *PULONG;


ΓòÉΓòÉΓòÉ 4.355. PUSEITEM ΓòÉΓòÉΓòÉ

PUSEITEM Pointer to USEITEM.

typedef USEITEM *PUSEITEM;


ΓòÉΓòÉΓòÉ 4.356. PUSERBUTTON ΓòÉΓòÉΓòÉ

PUSERBUTTON Pointer to USERBUTTON.

typedef USERBUTTON *PUSERBUTTON;


ΓòÉΓòÉΓòÉ 4.357. PUSHORT ΓòÉΓòÉΓòÉ

PUSHORT Pointer to USHORT.

typedef USHORT *PUSHORT;


ΓòÉΓòÉΓòÉ 4.358. PVIEWFILE ΓòÉΓòÉΓòÉ

PVIEWFILE Pointer to VIEWFILE.

typedef VIEWFILE *PVIEWFILE;


ΓòÉΓòÉΓòÉ 4.359. PVIEWITEM ΓòÉΓòÉΓòÉ

PVIEWITEM Pointer to VIEWITEM.

typedef VIEWITEM *PVIEWITEM;


ΓòÉΓòÉΓòÉ 4.360. PVIOFONTCELLSIZE ΓòÉΓòÉΓòÉ

PVIOFONTCELLSIZE Pointer to VIOFONTCELLSIZE.

typedef VIOFONTCELLSIZE *PVIOFONTCELLSIZE;


ΓòÉΓòÉΓòÉ 4.361. PVIOSIZECOUNT ΓòÉΓòÉΓòÉ

PVIOSIZECOUNT Pointer to VIOSIZECOUNT.

typedef VIOSIZECOUNT *PVIOSIZECOUNT;


ΓòÉΓòÉΓòÉ 4.362. PVOID ΓòÉΓòÉΓòÉ

PVOID Pointer to a data type of undefined format.

typedef VOID *PVOID;


ΓòÉΓòÉΓòÉ 4.363. PVSCDATA ΓòÉΓòÉΓòÉ

PVSCDATA Pointer to VSCDATA.

typedef VSCDATA *PVSCDATA;


ΓòÉΓòÉΓòÉ 4.364. PVSDRAGINFO ΓòÉΓòÉΓòÉ

PVSDRAGINFO Pointer to VSDRAGINFO.

typedef VSDRAGINFO *PVSDRAGINFO;


ΓòÉΓòÉΓòÉ 4.365. PVSDRAGINIT ΓòÉΓòÉΓòÉ

PVSDRAGINIT Pointer to VSDRAGINIT.

typedef VSDRAGINIT *PVSDRAGINIT;


ΓòÉΓòÉΓòÉ 4.366. PVSTEXT ΓòÉΓòÉΓòÉ

PVSTEXT Pointer to a VSTEXT data structure.

typedef VSTEXT *PVSTEXT;


ΓòÉΓòÉΓòÉ 4.367. PWNDPARAMS ΓòÉΓòÉΓòÉ

PWNDPARAMS Pointer to a WNDPARAMS data structure.

typedef WNDPARAMS *PWNDPARAMS;


ΓòÉΓòÉΓòÉ 4.368. PWPOINT ΓòÉΓòÉΓòÉ

PWPOINT Pointer to a WPOINT data structure.

#define PWPOINT PPOINTL


ΓòÉΓòÉΓòÉ 4.369. QMOPENSTRUC ΓòÉΓòÉΓòÉ

QMOPENSTRUC Open queue manager data structure.

typedef struct _QMOPENSTRUC {
PSZ         pszQueueName;        /* Queue name  */
PSZ         pszDriverName;       /* Driver name  */
DRIVDATA    drivDriverData;      /* Driver data  */
PSZ         pszDataType;         /* Data type  */
PSZ         pszComment;          /* Comment  */
PSZ         pszQueueProcName;    /* Queue processor name  */
PSZ         pszQueueProcParams;  /* Queue processor parameters  */
PSZ         pszSpoolerParams;    /* Spooler parameters  */
PSZ         pszNetworkParams;    /* Network parameters  */
 } QMOPENSTRUC;


ΓòÉΓòÉΓòÉ <hidden> pszQueueName ΓòÉΓòÉΓòÉ

pszQueueName (PSZ)
   Queue name.

   The name of the queue for the output device. The queue can be a UNC name.


ΓòÉΓòÉΓòÉ <hidden> pszDriverName ΓòÉΓòÉΓòÉ

pszDriverName (PSZ)
   Driver name.

   A string containing the name of the Presentation Manager Device Driver (for
   example, "IBM4019").


ΓòÉΓòÉΓòÉ <hidden> drivDriverData ΓòÉΓòÉΓòÉ

drivDriverData (DRIVDATA)
   Driver data.

   Data which is to be passed directly to the Presentation Manager Device
   Driver. Whether or not any of this is required depends upon the Device
   Driver.


ΓòÉΓòÉΓòÉ <hidden> pszDataType ΓòÉΓòÉΓòÉ

pszDataType (PSZ)
   Data type.

   This defines the type of data which is to be queued, as follows:

   o "PM_Q_STD" - standard format
   o "PM_Q_RAW" - raw format
   Note that a Presentation Manager device driver may define other datatypes
   and may not support all of these queued data types.


ΓòÉΓòÉΓòÉ <hidden> pszComment ΓòÉΓòÉΓòÉ

pszComment (PSZ)
   Comment.

   A natural language description of the file.  This may, for example, be
   displayed by the spooler to the end user. It is optional.


ΓòÉΓòÉΓòÉ <hidden> pszQueueProcName ΓòÉΓòÉΓòÉ

pszQueueProcName (PSZ)
   Queue processor name.

   The name of the queue processor.  This is normally the default.


ΓòÉΓòÉΓòÉ <hidden> pszQueueProcParams ΓòÉΓòÉΓòÉ

pszQueueProcParams (PSZ)
   Queue processor parameters.

   A parameter string for the queue processor. It is optional.


ΓòÉΓòÉΓòÉ <hidden> pszSpoolerParams ΓòÉΓòÉΓòÉ

pszSpoolerParams (PSZ)
   Spooler parameters.

   A parameter string for the spooler, which is optional. This has the
   following options, which must be separated by one or more blanks:

   o FORM=f
     Specifies a forms code `f'. This must be a valid forms code for the
     printer.
     If not specified, then the data is printed on the forms in use, when this
     print job is ready to be printed.

   o PRTY=n
     Specifies a priority in the range 0-99, with 99 being the highest. If not
     specified, then a priority of 50 is used.


ΓòÉΓòÉΓòÉ <hidden> pszNetworkParams ΓòÉΓòÉΓòÉ

pszNetworkParams (PSZ)
   Network parameters.

   The format of the parameter string is keyword=value, and the following
   keywords are defined (additional ones can be defined by the network
   program):

   o USER=u
     specifies the userid `u'.  If not specified, a null userid is used.


ΓòÉΓòÉΓòÉ 4.370. QMSG ΓòÉΓòÉΓòÉ

QMSG Message structure.

typedef struct _QMSG {
HWND      hwnd;      /* Window handle  */
ULONG     msg;       /* Message identity  */
MPARAM    mp1;       /* Parameter 1  */
MPARAM    mp2;       /* Parameter 2  */
ULONG     time;      /* Message time  */
POINTL    ptl;       /* Pointer position when message was generated  */
ULONG     reserved;  /* Reserved  */
 } QMSG;


ΓòÉΓòÉΓòÉ <hidden> hwnd ΓòÉΓòÉΓòÉ

hwnd (HWND)
   Window handle.


ΓòÉΓòÉΓòÉ <hidden> msg ΓòÉΓòÉΓòÉ

msg (ULONG)
   Message identity.


ΓòÉΓòÉΓòÉ <hidden> mp1 ΓòÉΓòÉΓòÉ

mp1 (MPARAM)
   Parameter 1.


ΓòÉΓòÉΓòÉ <hidden> mp2 ΓòÉΓòÉΓòÉ

mp2 (MPARAM)
   Parameter 2.


ΓòÉΓòÉΓòÉ <hidden> time ΓòÉΓòÉΓòÉ

time (ULONG)
   Message time.


ΓòÉΓòÉΓòÉ <hidden> ptl ΓòÉΓòÉΓòÉ

ptl (POINTL)
   Pointer position when message was generated.


ΓòÉΓòÉΓòÉ <hidden> reserved ΓòÉΓòÉΓòÉ

reserved (ULONG)
   Reserved.


ΓòÉΓòÉΓòÉ 4.371. QUERYRECFROMRECT ΓòÉΓòÉΓòÉ

QUERYRECFROMRECT Structure that contains information about a container record
that is bounded by a specified rectangle. This structure is used in the
CM_QUERYRECORDFROMRECT container message only.

typedef struct _QUERYRECFROMRECT {
ULONG    cb;        /* Structure size  */
RECTL    rect;      /* Rectangle  */
ULONG    fsSearch;  /* Search control flags  */
 } QUERYRECFROMRECT;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   The size (in bytes) of the QUERYRECFROMRECT data structure.


ΓòÉΓòÉΓòÉ <hidden> rect ΓòÉΓòÉΓòÉ

rect (RECTL)
   Rectangle.

   The rectangle to query, in virtual coordinates relative to the container
   window origin. If the details view (CV_DETAIL) is displayed, the
   x-coordinates of the rectangle are ignored.


ΓòÉΓòÉΓòÉ <hidden> fsSearch ΓòÉΓòÉΓòÉ

fsSearch (ULONG)
   Search control flags.

   One flag from each of the following groups can be specified:

   o Search sensitivity:

      CMA_COMPLETE
         Returns the container records that are completely within the bounding
         rectangle.
      CMA_PARTIAL
         Returns the container records that are completely or partially within
         the bounding rectangle.

   o Enumeration order:

      CMA_ITEMORDER
         Container records are enumerated in item order, lowest to highest.
      CMA_ZORDER
         Container records are enumerated by z-order, from top to bottom. This
         flag is valid for the icon view only.


ΓòÉΓòÉΓòÉ 4.372. QUERYRECORDRECT ΓòÉΓòÉΓòÉ

QUERYRECORDRECT Structure that contains information about the rectangle that
bounds a specified container record. This structure is used in the
CM_QUERYRECORDRECT container message only.

typedef struct _QUERYRECORDRECT {
ULONG          cb;                 /* Structure size  */
PRECORDCORE    pRecord;            /* Pointer  */
ULONG          fRightSplitWindow;  /* Window flag  */
ULONG          fsExtent;           /* Rectangle flags  */
 } QUERYRECORDRECT;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   The size (in bytes) of the QUERYRECORDRECT structure.


ΓòÉΓòÉΓòÉ <hidden> pRecord ΓòÉΓòÉΓòÉ

pRecord (PRECORDCORE)
   Pointer.

   Pointer to the specified RECORDCORE data structure.

   Note:  If the CCS_MINIRECORDCORE style bit is specified when a container is
   created, then MINIRECORDCORE should be used instead of RECORDCORE and
   PMINIRECORDCORE should be used instead of PRECORDCORE in all applicable data
   structures and messages.


ΓòÉΓòÉΓòÉ <hidden> fRightSplitWindow ΓòÉΓòÉΓòÉ

fRightSplitWindow (ULONG)
   Window flag.

   Flag that specifies the right or left window in the split details view.

   This flag is ignored if the view is not the split details view.

   TRUE
      Right split window is returned.
   FALSE
      Left split window is returned.


ΓòÉΓòÉΓòÉ <hidden> fsExtent ΓòÉΓòÉΓòÉ

fsExtent (ULONG)
   Rectangle flags.

   Flags that specify the extent of the desired rectangle.

   These flags can be combined by using a logical OR operator (|) to return the
   rectangle that bounds the icon, the expanded and collapsed icon or bit map,
   and the text.

   CMA_ICON
      Returns the icon rectangle.
   CMA_TEXT
      Returns the text rectangle.
   CMA_TREEICON
      Returns the rectangle of the expanded and collapsed icons or bit maps.
      This flag is valid for the tree icon and tree text views only.


ΓòÉΓòÉΓòÉ 4.373. RECORDCORE ΓòÉΓòÉΓòÉ

RECORDCORE Structure that contains information for records in a container
control. This data structure is used if the CCS_MINIRECORDCORE style bit is not
specified when a container is created.

typedef struct _RECORDCORE {
ULONG                 cb;               /* Structure size  */
ULONG                 flRecordAttr;     /* Record attributes  */
POINTL                ptlIcon;          /* Record position  */
struct _RECORDCORE   *preccNextRecord;  /* Pointer  */
PSZ                   pszIcon;          /* Text  */
HPOINTER              hptrIcon;         /* Icon  */
HPOINTER              hptrMiniIcon;     /* Mini-icon  */
HBITMAP               hbmBitmap;        /* Bit map  */
HBITMAP               hbmMiniBitmap;    /* Mini-bit map  */
PTREEITEMDESC         pTreeItemDesc;    /* Pointer  */
PSZ                   pszText;          /* Text view text  */
PSZ                   pszName;          /* Name view text  */
PSZ                   pszTree;          /* Tree view text  */
 } RECORDCORE;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   The size (in bytes) of the RECORDCORE structure.


ΓòÉΓòÉΓòÉ <hidden> flRecordAttr ΓòÉΓòÉΓòÉ

flRecordAttr (ULONG)
   Record attributes.

   Attributes of container records. Contains any or all of the following:

   CRA_COLLAPSED
      Specifies that a record is collapsed.
   CRA_CURSORED
      Specifies that a record will be drawn with a selection cursor.
   CRA_DROPONABLE
      Specifies that a record can be a target for direct manipulation.
   CRA_EXPANDED
      Specifies that a record is expanded.
   CRA_FILTERED
      Specifies that a record is filtered, and therefore hidden from view.
   CRA_INUSE
      Specifies that a record will be drawn with in-use emphasis.
   CRA_RECORDREADONLY
      Prevents a record from being edited directly.
   CRA_SELECTED
      Specifies that a record will be drawn with selected-state emphasis.
   CRA_TARGET
      Specifies that a record will be drawn with target emphasis.


ΓòÉΓòÉΓòÉ <hidden> ptlIcon ΓòÉΓòÉΓòÉ

ptlIcon (POINTL)
   Record position.

   Position of a container record in the icon view.


ΓòÉΓòÉΓòÉ <hidden> preccNextRecord ΓòÉΓòÉΓòÉ

preccNextRecord (struct _RECORDCORE *)
   Pointer.

   Pointer to the next linked record.


ΓòÉΓòÉΓòÉ <hidden> pszIcon ΓòÉΓòÉΓòÉ

pszIcon (PSZ)
   Text.

   Text for the icon view (CV_ICON).


ΓòÉΓòÉΓòÉ <hidden> hptrIcon ΓòÉΓòÉΓòÉ

hptrIcon (HPOINTER)
   Icon.

   Icon that is displayed when the CV_MINI style bit is not specified. This
   field is used when the CA_DRAWICON container attribute of the CNRINFO data
   structure is set.


ΓòÉΓòÉΓòÉ <hidden> hptrMiniIcon ΓòÉΓòÉΓòÉ

hptrMiniIcon (HPOINTER)
   Mini-icon.

   Icon that is displayed when the CV_MINI style bit is specified. This field
   is used when the CA_DRAWICON container attribute of the CNRINFO data
   structure is set.


ΓòÉΓòÉΓòÉ <hidden> hbmBitmap ΓòÉΓòÉΓòÉ

hbmBitmap (HBITMAP)
   Bit map.

   Bit map that is displayed when the CV_MINI style bit is not specified. This
   field is used when the CA_DRAWBITMAP container attribute of the CNRINFO data
   structure is set.


ΓòÉΓòÉΓòÉ <hidden> hbmMiniBitmap ΓòÉΓòÉΓòÉ

hbmMiniBitmap (HBITMAP)
   Mini-bit map.

   Bit map that is displayed when the CV_MINI style bit is specified. This
   field is used when the CA_DRAWBITMAP container attribute of the CNRINFO data
   structure is set.


ΓòÉΓòÉΓòÉ <hidden> pTreeItemDesc ΓòÉΓòÉΓòÉ

pTreeItemDesc (PTREEITEMDESC)
   Pointer.

   Pointer to a TREEITEMDESC structure, which contains the icons and bit maps
   used to represent the state of an expanded or collapsed parent item in the
   tree name view.


ΓòÉΓòÉΓòÉ <hidden> pszText ΓòÉΓòÉΓòÉ

pszText (PSZ)
   Text view text.

   Text for the text view (CV_TEXT).


ΓòÉΓòÉΓòÉ <hidden> pszName ΓòÉΓòÉΓòÉ

pszName (PSZ)
   Name view text.

   Text for the name view (CV_NAME).


ΓòÉΓòÉΓòÉ <hidden> pszTree ΓòÉΓòÉΓòÉ

pszTree (PSZ)
   Tree view text.

   Text for the tree view (CV_TREE).


ΓòÉΓòÉΓòÉ 4.374. RECORDINSERT ΓòÉΓòÉΓòÉ

RECORDINSERT Structure that contains information about the RECORDCORE structure
or structures that are being inserted into a container. The RECORDINSERT
structure is used in the CM_INSERTRECORD container message only.

Note:  If the CCS_MINIRECORDCORE style bit is specified when a container is
created, then MINIRECORDCORE should be used instead of RECORDCORE and
PMINIRECORDCORE should be used instead of PRECORDCORE in all applicable data
structures and messages.

typedef struct _RECORDINSERT {
ULONG          cb;                 /* Structure size  */
PRECORDCORE    pRecordOrder;       /* Record order  */
PRECORDCORE    pRecordParent;      /* Pointer  */
ULONG          fInvalidateRecord;  /* Update flag  */
ULONG          zOrder;             /* Record z-order  */
ULONG          cRecordsInsert;     /* Number of root level structures  */
 } RECORDINSERT;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   The size (in bytes) of the RECORDINSERT structure.


ΓòÉΓòÉΓòÉ <hidden> pRecordOrder ΓòÉΓòÉΓòÉ

pRecordOrder (PRECORDCORE)
   Record order.

   Orders the RECORDCORE structure or structures relative to other RECORDCORE
   structures in the container. The values can be:

   CMA_FIRST
      Places a RECORDCORE structure, or list of RECORDCORE structures, at the
      beginning of the list of structures.
   CMA_END
      Places a RECORDCORE structure, or list of RECORDCORE structures, at the
      end of the list of structures.
   Other
      Pointer to a RECORDCORE structure that this structure, or list of
      structures, is to be inserted after.


ΓòÉΓòÉΓòÉ <hidden> pRecordParent ΓòÉΓòÉΓòÉ

pRecordParent (PRECORDCORE)
   Pointer.

   Pointer to a RECORDCORE structure that is the parent of the record or
   records to be inserted. This field is used only with the CMA_FIRST or
   CMA_END attributes of the pRecordOrder field.


ΓòÉΓòÉΓòÉ <hidden> fInvalidateRecord ΓòÉΓòÉΓòÉ

fInvalidateRecord (ULONG)
   Update flag.

   Flag that indicates an automatic display update after RECORDCORE  structures
   are inserted.

   TRUE
      The display is automatically updated after a RECORDCORE structure is
      inserted.
   FALSE
      The application must send the CM_INVALIDATERECORD message after a
      RECORDCORE structure is inserted.


ΓòÉΓòÉΓòÉ <hidden> zOrder ΓòÉΓòÉΓòÉ

zOrder (ULONG)
   Record z-order.

   Positions the RECORDCORE structure in z-order, relative to other records in
   the container. The values can be:

   CMA_TOP
      Places a RECORDCORE structure at the top of the z-order. This is the
      default value.
   CMA_BOTTOM
      Places a RECORDCORE structure at the bottom of the z-order.


ΓòÉΓòÉΓòÉ <hidden> cRecordsInsert ΓòÉΓòÉΓòÉ

cRecordsInsert (ULONG)
   Number of root level structures.

   The number of root level RECORDCORE structures to be inserted. The
   cRecordsInsert field value must be greater than 0.


ΓòÉΓòÉΓòÉ 4.375. RECORDITEM ΓòÉΓòÉΓòÉ

RECORDITEM USAGE_RECORD structure.

typedef struct _RECORDITEM {
HWND               hwndCnr;  /* Container into which object is inserted  */
PMINIRECORDCORE    pRecord;  /* Record pointer within container  */
ULONG              ulUser;   /* For application use  */
 } RECORDITEM;


ΓòÉΓòÉΓòÉ <hidden> hwndCnr ΓòÉΓòÉΓòÉ

hwndCnr (HWND)
   Container into which object is inserted.


ΓòÉΓòÉΓòÉ <hidden> pRecord ΓòÉΓòÉΓòÉ

pRecord (PMINIRECORDCORE)
   Record pointer within container.


ΓòÉΓòÉΓòÉ <hidden> ulUser ΓòÉΓòÉΓòÉ

ulUser (ULONG)
   For application use.


ΓòÉΓòÉΓòÉ 4.376. RECTL ΓòÉΓòÉΓòÉ

RECTL Rectangle structure.

typedef struct _RECTL {
LONG    xLeft;    /* X-coordinate of left-hand edge of rectangle  */
LONG    yBottom;  /* Y-coordinate of bottom edge of rectangle  */
LONG    xRight;   /* X-coordinate of right-hand edge of rectangle  */
LONG    yTop;     /* Y-coordinate of top edge of rectangle  */
 } RECTL;


ΓòÉΓòÉΓòÉ <hidden> xLeft ΓòÉΓòÉΓòÉ

xLeft (LONG)
   X-coordinate of left-hand edge of rectangle.


ΓòÉΓòÉΓòÉ <hidden> yBottom ΓòÉΓòÉΓòÉ

yBottom (LONG)
   Y-coordinate of bottom edge of rectangle.


ΓòÉΓòÉΓòÉ <hidden> xRight ΓòÉΓòÉΓòÉ

xRight (LONG)
   X-coordinate of right-hand edge of rectangle.


ΓòÉΓòÉΓòÉ <hidden> yTop ΓòÉΓòÉΓòÉ

yTop (LONG)
   Y-coordinate of top edge of rectangle.


ΓòÉΓòÉΓòÉ 4.377. RENDERFILE ΓòÉΓòÉΓòÉ

RENDERFILE File-rendering structure.

typedef struct _RENDERFILE {
HWND      hwndDragFiles;  /* Conversation handle  */
HSTR      hstrSource;     /* Handle to source file name  */
HSTR      hstrTarget;     /* Handle to target file name  */
USHORT    fMove;          /* Operation  */
USHORT    usRsvd;         /* Reserved  */
 } RENDERFILE;


ΓòÉΓòÉΓòÉ <hidden> hwndDragFiles ΓòÉΓòÉΓòÉ

hwndDragFiles (HWND)
   Conversation handle.

   Created by DrgDragFiles.


ΓòÉΓòÉΓòÉ <hidden> hstrSource ΓòÉΓòÉΓòÉ

hstrSource (HSTR)
   Handle to source file name.


ΓòÉΓòÉΓòÉ <hidden> hstrTarget ΓòÉΓòÉΓòÉ

hstrTarget (HSTR)
   Handle to target file name.


ΓòÉΓòÉΓòÉ <hidden> fMove ΓòÉΓòÉΓòÉ

fMove (USHORT)
   Operation.

   TRUE
      Move the file.
   FALSE
      Copy the file.


ΓòÉΓòÉΓòÉ <hidden> usRsvd ΓòÉΓòÉΓòÉ

usRsvd (USHORT)
   Reserved.


ΓòÉΓòÉΓòÉ 4.378. RGB ΓòÉΓòÉΓòÉ

RGB RGB color value.

typedef struct _RGB {
BYTE    bBlue;   /* Blue component of the color definition  */
BYTE    bGreen;  /* Green component of the color definition  */
BYTE    bRed;    /* Red component of the color definition  */
 } RGB;


ΓòÉΓòÉΓòÉ <hidden> bBlue ΓòÉΓòÉΓòÉ

bBlue (BYTE)
   Blue component of the color definition.


ΓòÉΓòÉΓòÉ <hidden> bGreen ΓòÉΓòÉΓòÉ

bGreen (BYTE)
   Green component of the color definition.


ΓòÉΓòÉΓòÉ <hidden> bRed ΓòÉΓòÉΓòÉ

bRed (BYTE)
   Red component of the color definition.


ΓòÉΓòÉΓòÉ 4.379. RGB2 ΓòÉΓòÉΓòÉ

RGB2 RGB color value.

typedef struct _RGB2 {
BYTE    bBlue;      /* Blue component of the color definition  */
BYTE    bGreen;     /* Green component of the color definition  */
BYTE    bRed;       /* Red component of the color definition  */
BYTE    fcOptions;  /* Entry options  */
 } RGB2;


ΓòÉΓòÉΓòÉ <hidden> bBlue ΓòÉΓòÉΓòÉ

bBlue (BYTE)
   Blue component of the color definition.


ΓòÉΓòÉΓòÉ <hidden> bGreen ΓòÉΓòÉΓòÉ

bGreen (BYTE)
   Green component of the color definition.


ΓòÉΓòÉΓòÉ <hidden> bRed ΓòÉΓòÉΓòÉ

bRed (BYTE)
   Red component of the color definition.


ΓòÉΓòÉΓòÉ <hidden> fcOptions ΓòÉΓòÉΓòÉ

fcOptions (BYTE)
   Entry options.

   These can be ORed together if required:

   PC_RESERVED
      The color entry is reserved for animating color with the palette manager.
   PC_EXPLICIT
      The low-order word of the color table entry designates a physical palette
      slot.  This allows an application to show the actual contents of the
      device palette as realized for other logical palettes.  This does not
      prevent the color in the slot from being changed for any reason.


ΓòÉΓòÉΓòÉ 4.380. RGNRECT ΓòÉΓòÉΓòÉ

RGNRECT Region-rectangle structure.

typedef struct _RGNRECT {
ULONG    ircStart;     /* Rectangle number from which to start enumerating  */
ULONG    crc;          /* Number of rectangles that can be returned  */
ULONG    crcReturned;  /* Number of rectangles returned  */
ULONG    ulDirection;  /* Direction in which the returned rectangles are to be ordered  */
 } RGNRECT;


ΓòÉΓòÉΓòÉ <hidden> ircStart ΓòÉΓòÉΓòÉ

ircStart (ULONG)
   Rectangle number from which to start enumerating.

   Numbering starts from 1.


ΓòÉΓòÉΓòÉ <hidden> crc ΓòÉΓòÉΓòÉ

crc (ULONG)
   Number of rectangles that can be returned.

   This must be 1 or greater.


ΓòÉΓòÉΓòÉ <hidden> crcReturned ΓòÉΓòÉΓòÉ

crcReturned (ULONG)
   Number of rectangles returned.

   A value of less than crc indicates that there are no more rectangles to
   enumerate.


ΓòÉΓòÉΓòÉ <hidden> ulDirection ΓòÉΓòÉΓòÉ

ulDirection (ULONG)
   Direction in which the returned rectangles are to be ordered.

   This ordering uses the leading edge of a rectangle.

   RECTDIR_LFRT_TOPBOT
      Left-to-right, top-to-bottom
   RECTDIR_RTLF_TOPBOT
      Right-to-left, top-to-bottom
   RECTDIR_LFRT_BOTTOP
      Left-to-right, bottom-to-top
   RECTDIR_RTLF_BOTTOP
      Right-to-left, bottom-to-top.


ΓòÉΓòÉΓòÉ 4.381. SBCDATA ΓòÉΓòÉΓòÉ

SBCDATA Scroll-bar control data structure.

typedef struct _SBCDATA {
USHORT    cb;        /* Length of control data in bytes  */
USHORT    sHilite;   /* Highlighting code  */
SHORT     posFirst;  /* First bound of the scroll-bar range  */
SHORT     posLast;   /* Last bound of the scroll-bar range  */
SHORT     posThumb;  /* Slider position  */
SHORT     cVisible;  /* Number of data items visible  */
SHORT     cTotal;    /* Number of data items available  */
 } SBCDATA;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (USHORT)
   Length of control data in bytes.

   The length of the control data for a scroll-bar control.


ΓòÉΓòÉΓòÉ <hidden> sHilite ΓòÉΓòÉΓòÉ

sHilite (USHORT)
   Highlighting code.

   This indicates which part of the scroll bar is to be highlighted, if any.

   ZERO
      No highlighting
   SB_LINEUP
      Line up arrow
   SB_LINELEFT
      Line left arrow
   SB_LINEDOWN
      Line down arrow
   SB_LINERIGHT
      Line right arrow
   SB_PAGEUP
      Page up arrow
   SB_PAGELEFT
      Page left arrow
   SB_PAGEDOWN
      Page down arrow
   SB_PAGERIGHT
      Page right arrow
   SB_SLIDERTRACK
      Slider.


ΓòÉΓòÉΓòÉ <hidden> posFirst ΓòÉΓòÉΓòÉ

posFirst (SHORT)
   First bound of the scroll-bar range.


ΓòÉΓòÉΓòÉ <hidden> posLast ΓòÉΓòÉΓòÉ

posLast (SHORT)
   Last bound of the scroll-bar range.


ΓòÉΓòÉΓòÉ <hidden> posThumb ΓòÉΓòÉΓòÉ

posThumb (SHORT)
   Slider position.


ΓòÉΓòÉΓòÉ <hidden> cVisible ΓòÉΓòÉΓòÉ

cVisible (SHORT)
   Number of data items visible.


ΓòÉΓòÉΓòÉ <hidden> cTotal ΓòÉΓòÉΓòÉ

cTotal (SHORT)
   Number of data items available.


ΓòÉΓòÉΓòÉ 4.382. SEARCHSTRING ΓòÉΓòÉΓòÉ

SEARCHSTRING Structure that contains information about the container text
string that is the object of the search. This structure is used in the
CM_SEARCHSTRING container message only.

typedef struct _SEARCHSTRING {
ULONG    cb;               /* Structure size  */
PSZ      pszSearch;        /* Pointer  */
ULONG    fsPrefix;         /* Search flag  */
ULONG    fsCaseSensitive;  /* Case sensitivity  */
ULONG    usView;           /* View to search  */
 } SEARCHSTRING;


ΓòÉΓòÉΓòÉ <hidden> cb ΓòÉΓòÉΓòÉ

cb (ULONG)
   Structure size.

   The size (in bytes) of the SEARCHSTRING structure.


ΓòÉΓòÉΓòÉ <hidden> pszSearch ΓòÉΓòÉΓòÉ

pszSearch (PSZ)
   Pointer.

   Pointer to the search string.


ΓòÉΓòÉΓòÉ <hidden> fsPrefix ΓòÉΓòÉΓòÉ

fsPrefix (ULONG)
   Search flag.

   Search flag that defines the criteria by which the string specified by the
   pszSearch field is to be compared with the text of the container records to
   determine the pointer to the first matching record.

   TRUE
      Matching occurs if the leading characters of the container record are the
      characters specified by the pszSearch field.
   FALSE
      Matching occurs if the container record contains a substring of the
      characters specified by the pszSearch field.


ΓòÉΓòÉΓòÉ <hidden> fsCaseSensitive ΓòÉΓòÉΓòÉ

fsCaseSensitive (ULONG)
   Case sensitivity.

   Determines case sensitivity of the search.

   TRUE
      The search is case sensitive.
   FALSE
      The search is not case sensitive.


ΓòÉΓòÉΓòÉ <hidden> usView ΓòÉΓòÉΓòÉ

usView (ULONG)
   View to search.

   Search one of the container views for the string. Valid values are:

   o CV_ICON
   o CV_NAME
   o CV_TEXT
   o CV_TREE
   o CV_DETAIL.


ΓòÉΓòÉΓòÉ 4.383. SFACTORS ΓòÉΓòÉΓòÉ

SFACTORS Scaling factors, see DevEscape.

typedef struct _SFACTORS {
LONG    x;  /* x-scaling factor, as an exponent of 2  */
LONG    y;  /* y-scaling factor, as an exponent of 2  */
 } SFACTORS;


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (LONG)
   x-scaling factor, as an exponent of 2.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (LONG)
   y-scaling factor, as an exponent of 2.


ΓòÉΓòÉΓòÉ 4.384. SHANDLE ΓòÉΓòÉΓòÉ

SHANDLE The handle of a resource.

typedef unsigned short SHANDLE;


ΓòÉΓòÉΓòÉ 4.385. SHORT ΓòÉΓòÉΓòÉ

SHORT Signed integer in the range -32 768 through 32 767.

#define SHORT short


ΓòÉΓòÉΓòÉ 4.386. SIZEF ΓòÉΓòÉΓòÉ

SIZEF Size structure.

typedef struct _SIZEF {
FIXED    cx;  /* Width  */
FIXED    cy;  /* Height  */
 } SIZEF;


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (FIXED)
   Width.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (FIXED)
   Height.


ΓòÉΓòÉΓòÉ 4.387. SIZEL ΓòÉΓòÉΓòÉ

SIZEL Size structure.

typedef struct _SIZEL {
LONG    cx;  /* Width  */
LONG    cy;  /* Height  */
 } SIZEL;


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (LONG)
   Width.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (LONG)
   Height.


ΓòÉΓòÉΓòÉ 4.388. SLDCDATA ΓòÉΓòÉΓòÉ

SLDCDATA Slider control data structure.

typedef struct _SLDCDATA {
ULONG     cbSize;              /* Data length  */
USHORT    usScale1Increments;  /* Scale increments  */
USHORT    usScale1Spacing;     /* Scale spacing  */
USHORT    usScale2Increments;  /* Alternate scale increments  */
USHORT    usScale2Spacing;     /* Alternate scale spacing  */
 } SLDCDATA;


ΓòÉΓòÉΓòÉ <hidden> cbSize ΓòÉΓòÉΓòÉ

cbSize (ULONG)
   Data length.

   Length of the control data in bytes.


ΓòÉΓòÉΓòÉ <hidden> usScale1Increments ΓòÉΓòÉΓòÉ

usScale1Increments (USHORT)
   Scale increments.

   The number of increments to set for the slider control. This number
   represents the range of values that can be selected within the slider when
   the SLS_PRIMARYSCALE1 style bit is specified.


ΓòÉΓòÉΓòÉ <hidden> usScale1Spacing ΓòÉΓòÉΓòÉ

usScale1Spacing (USHORT)
   Scale spacing.

   The spacing between increments, expressed in pixels. It represents the unit
   that is the smallest division of the scale when the SLS_PRIMARYSCALE1 style
   bit is specified. If 0 is specified, the slider automatically calculates the
   spacing based on the window size and the number of increments specified.


ΓòÉΓòÉΓòÉ <hidden> usScale2Increments ΓòÉΓòÉΓòÉ

usScale2Increments (USHORT)
   Alternate scale increments.

   An alternate number of increments to set for the slider control. This number
   represents the range of values that can be selected within the slider when
   the SLS_PRIMARYSCALE2 style bit is specified.


ΓòÉΓòÉΓòÉ <hidden> usScale2Spacing ΓòÉΓòÉΓòÉ

usScale2Spacing (USHORT)
   Alternate scale spacing.

   An alternate spacing between increments, expressed in pixels. It represents
   the unit that is the smallest division of the scale when the
   SLS_PRIMARYSCALE2 style bit is specified. If 0 is specified, the slider
   automatically calculates the spacing based on the window size and the number
   of increments specified.


ΓòÉΓòÉΓòÉ 4.389. SMHSTRUCT ΓòÉΓòÉΓòÉ

SMHSTRUCT Send-message-hook structure.

typedef struct _SMHSTRUCT {
MPARAM    mp2;    /* Parameter 2  */
MPARAM    mp1;    /* Parameter 1  */
ULONG     msg;    /* Message identity  */
HWND      hwnd;   /* Window handle  */
ULONG     model;  /* Message identity  */
 } SMHSTRUCT;


ΓòÉΓòÉΓòÉ <hidden> mp2 ΓòÉΓòÉΓòÉ

mp2 (MPARAM)
   Parameter 2.


ΓòÉΓòÉΓòÉ <hidden> mp1 ΓòÉΓòÉΓòÉ

mp1 (MPARAM)
   Parameter 1.


ΓòÉΓòÉΓòÉ <hidden> msg ΓòÉΓòÉΓòÉ

msg (ULONG)
   Message identity.


ΓòÉΓòÉΓòÉ <hidden> hwnd ΓòÉΓòÉΓòÉ

hwnd (HWND)
   Window handle.


ΓòÉΓòÉΓòÉ <hidden> model ΓòÉΓòÉΓòÉ

model (ULONG)
   Message identity.


ΓòÉΓòÉΓòÉ 4.390. SPLERR ΓòÉΓòÉΓòÉ

SPLERR Error value in the range 0 to 65 535.

typedef unsigned long SPLERR;


ΓòÉΓòÉΓòÉ 4.391. STR8 ΓòÉΓòÉΓòÉ

STR8 String of 8 characters.

typedef CHAR STR8[8];


ΓòÉΓòÉΓòÉ 4.392. STR16 ΓòÉΓòÉΓòÉ

STR16 String of characters, with an implicit length, in a 16-byte field.

typedef CHAR STR16[16];


ΓòÉΓòÉΓòÉ 4.393. STR32 ΓòÉΓòÉΓòÉ

STR32 String of characters, with an implicit length, in a 32-byte field.

typedef CHAR STR32[32];


ΓòÉΓòÉΓòÉ 4.394. STR64 ΓòÉΓòÉΓòÉ

STR64 String of characters, with an implicit length, in a 64-byte field.

typedef CHAR STR64[64];


ΓòÉΓòÉΓòÉ 4.395. STYLECHANGE ΓòÉΓòÉΓòÉ

STYLECHANGE Style-change structure.  This structure is returned by the
FNTM_STYLECHANGED message.

All "old" fields describe the style attributes before the user made a change.
The other, or "new", parameters describe the style that will be in effect after
this is passed to WinDefFontDlgProc.  When the "old" and "new" values are the
same, the user made no change.

For further details of the parameters, see FONTDLG.

typedef struct _STYLECHANGE {
USHORT    usWeight;        /* New weight of font  */
USHORT    usWeightOld;     /* Old weight of font  */
USHORT    usWidth;         /* New width of font  */
USHORT    usWidthOld;      /* Old width of font  */
ULONG     flType;          /* New type of font  */
ULONG     flTypeOld;       /* Old type of font  */
ULONG     flTypeMask;      /* New type mask  */
ULONG     flTypeMaskOld;   /* Old type mask  */
ULONG     flStyle;         /* New selected style bits  */
ULONG     flStyleOld;      /* Old selected style bits  */
ULONG     flStyleMask;     /* New mask of style bits to use  */
ULONG     flStyleMaskOld;  /* Old mask of style bits to use  */
 } STYLECHANGE;


ΓòÉΓòÉΓòÉ <hidden> usWeight ΓòÉΓòÉΓòÉ

usWeight (USHORT)
   New weight of font.


ΓòÉΓòÉΓòÉ <hidden> usWeightOld ΓòÉΓòÉΓòÉ

usWeightOld (USHORT)
   Old weight of font.


ΓòÉΓòÉΓòÉ <hidden> usWidth ΓòÉΓòÉΓòÉ

usWidth (USHORT)
   New width of font.


ΓòÉΓòÉΓòÉ <hidden> usWidthOld ΓòÉΓòÉΓòÉ

usWidthOld (USHORT)
   Old width of font.


ΓòÉΓòÉΓòÉ <hidden> flType ΓòÉΓòÉΓòÉ

flType (ULONG)
   New type of font.


ΓòÉΓòÉΓòÉ <hidden> flTypeOld ΓòÉΓòÉΓòÉ

flTypeOld (ULONG)
   Old type of font.


ΓòÉΓòÉΓòÉ <hidden> flTypeMask ΓòÉΓòÉΓòÉ

flTypeMask (ULONG)
   New type mask.


ΓòÉΓòÉΓòÉ <hidden> flTypeMaskOld ΓòÉΓòÉΓòÉ

flTypeMaskOld (ULONG)
   Old type mask.


ΓòÉΓòÉΓòÉ <hidden> flStyle ΓòÉΓòÉΓòÉ

flStyle (ULONG)
   New selected style bits.


ΓòÉΓòÉΓòÉ <hidden> flStyleOld ΓòÉΓòÉΓòÉ

flStyleOld (ULONG)
   Old selected style bits.


ΓòÉΓòÉΓòÉ <hidden> flStyleMask ΓòÉΓòÉΓòÉ

flStyleMask (ULONG)
   New mask of style bits to use.


ΓòÉΓòÉΓòÉ <hidden> flStyleMaskOld ΓòÉΓòÉΓòÉ

flStyleMaskOld (ULONG)
   Old mask of style bits to use.


ΓòÉΓòÉΓòÉ 4.396. SWBLOCK ΓòÉΓòÉΓòÉ

SWBLOCK Switch-list block structure.

typedef struct _SWBLOCK {
ULONG      cswentry;     /* Count of switch list entries  */
SWENTRY    aswentry[1];  /* Switch list entries  */
 } SWBLOCK;


ΓòÉΓòÉΓòÉ <hidden> cswentry ΓòÉΓòÉΓòÉ

cswentry (ULONG)
   Count of switch list entries.


ΓòÉΓòÉΓòÉ <hidden> aswentry[1] ΓòÉΓòÉΓòÉ

aswentry[1] (SWENTRY)
   Switch list entries.


ΓòÉΓòÉΓòÉ 4.397. SWCNTRL ΓòÉΓòÉΓòÉ

SWCNTRL Switch-list control block structure.

typedef struct _SWCNTRL {
HWND        hwnd;                   /* Window handle  */
HWND        hwndIcon;               /* Window-handle icon  */
HPROGRAM    hprog;                  /* Program handle  */
PID         idProcess;              /* Process identity  */
ULONG       idSession;              /* Session identity  */
ULONG       uchVisibility;          /* Visibility  */
ULONG       fbJump;                 /* Jump indicator  */
CHAR        szSwtitle[MAXNAMEL+4];  /* Switch-list control block title (NULL-terminated)  */
ULONG       bProgType;              /* Program type  */
 } SWCNTRL;


ΓòÉΓòÉΓòÉ <hidden> hwnd ΓòÉΓòÉΓòÉ

hwnd (HWND)
   Window handle.


ΓòÉΓòÉΓòÉ <hidden> hwndIcon ΓòÉΓòÉΓòÉ

hwndIcon (HWND)
   Window-handle icon.


ΓòÉΓòÉΓòÉ <hidden> hprog ΓòÉΓòÉΓòÉ

hprog (HPROGRAM)
   Program handle.


ΓòÉΓòÉΓòÉ <hidden> idProcess ΓòÉΓòÉΓòÉ

idProcess (PID)
   Process identity.


ΓòÉΓòÉΓòÉ <hidden> idSession ΓòÉΓòÉΓòÉ

idSession (ULONG)
   Session identity.


ΓòÉΓòÉΓòÉ <hidden> uchVisibility ΓòÉΓòÉΓòÉ

uchVisibility (ULONG)
   Visibility:

   SWL_VISIBLE
      Visible in startup list
   SWL_INVISIBLE
      Invisible in startup list
   SWL_GRAYED
      Item cannot be switched to (note that it is not actually grayed in the
      list).


ΓòÉΓòÉΓòÉ <hidden> fbJump ΓòÉΓòÉΓòÉ

fbJump (ULONG)
   Jump indicator:

   SWL_JUMPABLE
      Participates in jump sequence
   SWL_NOTJUMPABLE
      Does not participate in jump sequence.


ΓòÉΓòÉΓòÉ <hidden> szSwtitle[MAXNAMEL+4] ΓòÉΓòÉΓòÉ

szSwtitle[MAXNAMEL+4] (CHAR)
   Switch-list control block title (NULL-terminated).


ΓòÉΓòÉΓòÉ <hidden> bProgType ΓòÉΓòÉΓòÉ

bProgType (ULONG)
   Program type.

   Possible values are:

   PROG_DEFAULT                  0
   PROG_FULLSCREEN               1
   PROG_WINDOWABLEVIO            2
   PROG_PM                       3
   PROG_VDM                      4
   PROG_WINDOWEDVDM              7
   Although there are several other program types for WIN-OS/2 programs, these
   do not show up in this structure. Instead, the PROG_VDM or PROG_WINDOWEDVDM
   program types are used. For instance, for PROG_31_STDSEAMLESSVDM,
   PROG_WINDOWEDVDM is used. This is because all the WIN-OS/2 programs run in
   DOS sessions. For example, if a program is a windowed WIN-OS/2 program, it
   runs in a PROG_WINDOWEDVDM session. Likewise, if it's a full-screen WIN-OS/2
   program, it runs in a PROG_VDM session.
   These values are contained in PMSHL.H.


ΓòÉΓòÉΓòÉ 4.398. SWENTRY ΓòÉΓòÉΓòÉ

SWENTRY Switch-list entry structure.

typedef struct _SWENTRY {
HSWITCH    hswitch;  /* Switch-list entry handle  */
SWCNTRL    swctl;    /* Switch-list control block structure  */
 } SWENTRY;


ΓòÉΓòÉΓòÉ <hidden> hswitch ΓòÉΓòÉΓòÉ

hswitch (HSWITCH)
   Switch-list entry handle.


ΓòÉΓòÉΓòÉ <hidden> swctl ΓòÉΓòÉΓòÉ

swctl (SWCNTRL)
   Switch-list control block structure.


ΓòÉΓòÉΓòÉ 4.399. SWP ΓòÉΓòÉΓòÉ

SWP Set-window-position structure.

typedef struct _SWP {
ULONG    fl;                /* Options  */
LONG     cy;                /* Window height  */
LONG     cx;                /* Window width  */
LONG     y;                 /* Y-coordinate of origin  */
LONG     x;                 /* X-coordinate of origin  */
HWND     hwndInsertBehind;  /* Window behind which this window is placed  */
HWND     hwnd;              /* Window handle  */
ULONG    ulReserved1;       /* Reserved.  This must be 0  */
ULONG    ulReserved2;       /* Reserved.  This must be 0  */
 } SWP;


ΓòÉΓòÉΓòÉ <hidden> fl ΓòÉΓòÉΓòÉ

fl (ULONG)
   Options.

   In alphabetic order:

   SWP_ACTIVATE

   SWP_DEACTIVATE

   SWP_HIDE

   SWP_MAXIMIZE

   SWP_MINIMIZE

   SWP_MOVE

   SWP_NOADJUST

   SWP_NOERASEWINDOW

   SWP_NOREDRAW

   SWP_RESTORE

   SWP_SHOW

   SWP_SIZE

   SWP_ZORDER


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (LONG)
   Window height.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (LONG)
   Window width.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (LONG)
   Y-coordinate of origin.


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (LONG)
   X-coordinate of origin.


ΓòÉΓòÉΓòÉ <hidden> hwndInsertBehind ΓòÉΓòÉΓòÉ

hwndInsertBehind (HWND)
   Window behind which this window is placed.


ΓòÉΓòÉΓòÉ <hidden> hwnd ΓòÉΓòÉΓòÉ

hwnd (HWND)
   Window handle.


ΓòÉΓòÉΓòÉ <hidden> ulReserved1 ΓòÉΓòÉΓòÉ

ulReserved1 (ULONG)
   Reserved.  This must be 0.


ΓòÉΓòÉΓòÉ <hidden> ulReserved2 ΓòÉΓòÉΓòÉ

ulReserved2 (ULONG)
   Reserved.  This must be 0.


ΓòÉΓòÉΓòÉ 4.400. TID ΓòÉΓòÉΓòÉ

TID Thread identity.

typedef LHANDLE TID;


ΓòÉΓòÉΓòÉ 4.401. TRACKINFO ΓòÉΓòÉΓòÉ

TRACKINFO Tracking-information structure.

typedef struct _TRACKINFO {
LONG      cxBorder;         /* Border width  */
LONG      cyBorder;         /* Border height  */
LONG      cxGrid;           /* Grid width  */
LONG      cyGrid;           /* Grid height  */
LONG      cxKeyboard;       /* Character cell width movement for arrow key  */
LONG      cyKeyboard;       /* Character cell height movement for arrow key  */
RECTL     rclTrack;         /* Starting tracking rectangle  */
RECTL     rclBoundary;      /* Boundary rectangle  */
POINTL    ptlMinTrackSize;  /* Minimum tracking size  */
POINTL    ptlMaxTrackSize;  /* Maximum tracking size  */
ULONG     fs;               /* Tracking options  */
 } TRACKINFO;


ΓòÉΓòÉΓòÉ <hidden> cxBorder ΓòÉΓòÉΓòÉ

cxBorder (LONG)
   Border width.

   The width of the left and right tracking sides.


ΓòÉΓòÉΓòÉ <hidden> cyBorder ΓòÉΓòÉΓòÉ

cyBorder (LONG)
   Border height.

   The height of the top and bottom tracking sides.


ΓòÉΓòÉΓòÉ <hidden> cxGrid ΓòÉΓòÉΓòÉ

cxGrid (LONG)
   Grid width.

   The horizontal bounds of the tracking movements.


ΓòÉΓòÉΓòÉ <hidden> cyGrid ΓòÉΓòÉΓòÉ

cyGrid (LONG)
   Grid height.

   The vertical bounds of the tracking movements.


ΓòÉΓòÉΓòÉ <hidden> cxKeyboard ΓòÉΓòÉΓòÉ

cxKeyboard (LONG)
   Character cell width movement for arrow key.


ΓòÉΓòÉΓòÉ <hidden> cyKeyboard ΓòÉΓòÉΓòÉ

cyKeyboard (LONG)
   Character cell height movement for arrow key.


ΓòÉΓòÉΓòÉ <hidden> rclTrack ΓòÉΓòÉΓòÉ

rclTrack (RECTL)
   Starting tracking rectangle.

   This is modified as the rectangle is tracked and holds the new tracking
   position, when tracking is complete.


ΓòÉΓòÉΓòÉ <hidden> rclBoundary ΓòÉΓòÉΓòÉ

rclBoundary (RECTL)
   Boundary rectangle.

   This is an absolute bounding rectangle that the tracking rectangle cannot
   extend; see also TF_ALLINBOUNDARY.


ΓòÉΓòÉΓòÉ <hidden> ptlMinTrackSize ΓòÉΓòÉΓòÉ

ptlMinTrackSize (POINTL)
   Minimum tracking size.


ΓòÉΓòÉΓòÉ <hidden> ptlMaxTrackSize ΓòÉΓòÉΓòÉ

ptlMaxTrackSize (POINTL)
   Maximum tracking size.


ΓòÉΓòÉΓòÉ <hidden> fs ΓòÉΓòÉΓòÉ

fs (ULONG)
   Tracking options.

   In alphabetic order:

   TF_ALLINBOUNDARY
      The default tracking is such that some part of the tracking rectangle is
      within the bounding rectangle defined by rclBoundary. This minimum size
      is defined by cxBorder and cyBorder.

      If TF_ALLINBOUNDARY is specified, the tracking is performed so that no
      part of the tracking rectangle ever falls outside of the bounding
      rectangle.
   TF_BOTTOM
      Track the bottom side of the rectangle.
   TF_GRID
      Tracking is restricted to the grid defined by cxGrid and cyGrid.
   TF_LEFT
      Track the left side of the rectangle.
   TF_MOVE
      Track all sides of the rectangle.
   TF_RIGHT
      Track the right side of the rectangle.
   TF_SETPOINTERPOS
      The pointer is repositioned according to other flags as follows:

      none         Pointer is centered in the tracking rectangle.
      TF_MOVE      Pointer is centered in the tracking rectangle.
      TF_LEFT      Pointer is vertically centered at the left of the tracking
                   rectangle.
      TF_TOP       Pointer is horizontally centered at the top of the tracking
                   rectangle.
      TF_RIGHT     Pointer is vertically centered at the right of the tracking
                   rectangle.
      TF_BOTTOM    Pointer is horizontally centered at the bottom of the
                   tracking rectangle.
   TF_STANDARD
      cx, cy, cxGrid, and cyGrid are all multiples of cxBorder and cyBorder.
   TF_TOP
      Track the top side of the rectangle.


ΓòÉΓòÉΓòÉ 4.402. TREEITEMDESC ΓòÉΓòÉΓòÉ

TREEITEMDESC Structure that contains icons and bit maps used to represent the
state of an expanded or collapsed parent item in the tree name view of a
container control.

typedef struct _TREEITEMDESC {
HBITMAP     hbmExpanded;    /* Expanded bit-map handle  */
HBITMAP     hbmCollapsed;   /* Collapsed bit-map handle  */
HPOINTER    hptrExpanded;   /* Expanded icon handle  */
HPOINTER    hptrCollapsed;  /* Collapsed icon handle  */
 } TREEITEMDESC;


ΓòÉΓòÉΓòÉ <hidden> hbmExpanded ΓòÉΓòÉΓòÉ

hbmExpanded (HBITMAP)
   Expanded bit-map handle.

   The handle of the bit map to be used to represent an expanded parent item in
   the tree name view.


ΓòÉΓòÉΓòÉ <hidden> hbmCollapsed ΓòÉΓòÉΓòÉ

hbmCollapsed (HBITMAP)
   Collapsed bit-map handle.

   The handle of the bit map to be used to represent a collapsed parent item in
   the tree name view.


ΓòÉΓòÉΓòÉ <hidden> hptrExpanded ΓòÉΓòÉΓòÉ

hptrExpanded (HPOINTER)
   Expanded icon handle.

   The handle of the icon to be used to represent an expanded parent item in
   the tree name view.


ΓòÉΓòÉΓòÉ <hidden> hptrCollapsed ΓòÉΓòÉΓòÉ

hptrCollapsed (HPOINTER)
   Collapsed icon handle.

   The handle of the icon to be used to represent a collapsed parent item in
   the tree name view.


ΓòÉΓòÉΓòÉ 4.403. UCHAR ΓòÉΓòÉΓòÉ

UCHAR Unsigned integer in the range 0 through 255.

typedef unsigned char UCHAR;


ΓòÉΓòÉΓòÉ 4.404. ULONG ΓòÉΓòÉΓòÉ

ULONG Unsigned integer in the range 0 through 4 294 967 295.

typedef unsigned long ULONG;


ΓòÉΓòÉΓòÉ 4.405. USEITEM ΓòÉΓòÉΓòÉ

USEITEM Use Item data structure.

The USEITEM structure is always followed by a type-specific structure.

Type                          Structure
USAGE_LINK                    LINKITEM
USAGE_MEMORY                  MEMORYITEM
USAGE_RECORD                  RECORDITEM
USAGE_OPENVIEW                VIEWITEM
USAGE_OPENFILE                VIEWFILE

typedef struct _USEITEM {
ULONG            type;      /* Type of this item  */
struct _USEITEM *pNext;     /* Next item in the Use list. */
 } USEITEM;


ΓòÉΓòÉΓòÉ <hidden> type ΓòÉΓòÉΓòÉ

type (ULONG)
   Type of this item.


ΓòÉΓòÉΓòÉ <hidden> pNext ΓòÉΓòÉΓòÉ

pNext (struct _USEITEM *)
   Next item in the Use list.


ΓòÉΓòÉΓòÉ 4.406. USERBUTTON ΓòÉΓòÉΓòÉ

USERBUTTON User-button data structure.

typedef struct _USERBUTTON {
HWND     hwnd;        /* Window handle  */
HPS      hps;         /* Presentation-space handle  */
ULONG    fsState;     /* New state of user button  */
ULONG    fsStateOld;  /* Old state of user button  */
 } USERBUTTON;


ΓòÉΓòÉΓòÉ <hidden> hwnd ΓòÉΓòÉΓòÉ

hwnd (HWND)
   Window handle.


ΓòÉΓòÉΓòÉ <hidden> hps ΓòÉΓòÉΓòÉ

hps (HPS)
   Presentation-space handle.


ΓòÉΓòÉΓòÉ <hidden> fsState ΓòÉΓòÉΓòÉ

fsState (ULONG)
   New state of user button.


ΓòÉΓòÉΓòÉ <hidden> fsStateOld ΓòÉΓòÉΓòÉ

fsStateOld (ULONG)
   Old state of user button.


ΓòÉΓòÉΓòÉ 4.407. USHORT ΓòÉΓòÉΓòÉ

USHORT Unsigned integer in the range 0 through 65 535.

typedef unsigned short USHORT;


ΓòÉΓòÉΓòÉ 4.408. VIEWFILE ΓòÉΓòÉΓòÉ

VIEWFILE USAGE_OPENFILE structure.

typedef struct _VIEWFILE {
ULONG              ulMenuId;  /* Menu ID, if association or menu page  */
LHANDLE            handle;    /* Open handle  */
HWND               hwndCnr;   /* System use only (window animation)  */
PMINIRECORDCORE    pRecord;   /* System use only (window animation)  */
 } VIEWFILE;


ΓòÉΓòÉΓòÉ <hidden> ulMenuId ΓòÉΓòÉΓòÉ

ulMenuId (ULONG)
   Menu ID, if association or menu page.


ΓòÉΓòÉΓòÉ <hidden> handle ΓòÉΓòÉΓòÉ

handle (LHANDLE)
   Open handle.

   This handle will be either a window handle or handle to an application.


ΓòÉΓòÉΓòÉ <hidden> hwndCnr ΓòÉΓòÉΓòÉ

hwndCnr (HWND)
   System use only (window animation).


ΓòÉΓòÉΓòÉ <hidden> pRecord ΓòÉΓòÉΓòÉ

pRecord (PMINIRECORDCORE)
   System use only (window animation) .


ΓòÉΓòÉΓòÉ 4.409. VIEWITEM ΓòÉΓòÉΓòÉ

VIEWITEM USAGE_OPENVIEW structure.

typedef struct _VIEWITEM {
ULONG              view;         /* Object view that this represents  */
LHANDLE            handle;       /* Open handle  */
ULONG              ulViewState;  /* View state flags  */
HWND               hwndCnr;      /* System use only (window animation)  */
PMINIRECORDCORE    pRecord;      /* System use only (window animation)  */
 } VIEWITEM;


ΓòÉΓòÉΓòÉ <hidden> view ΓòÉΓòÉΓòÉ

view (ULONG)
   Object view that this represents.


ΓòÉΓòÉΓòÉ <hidden> handle ΓòÉΓòÉΓòÉ

handle (LHANDLE)
   Open handle.

   This handle will be either a window handle or handle to an application.


ΓòÉΓòÉΓòÉ <hidden> ulViewState ΓòÉΓòÉΓòÉ

ulViewState (ULONG)
   View state flags.

   Possible values are:

   VIEWSTATE_OPENING
      The view is being opened.
   VIEWSTATE_OBJECTDELETED
      The object is being deleted.
   VIEWSTATE_USERHIDDEN
      The view was hidden by the user.
   VIEWSTATE_POPULATING
      The view is populating.


ΓòÉΓòÉΓòÉ <hidden> hwndCnr ΓòÉΓòÉΓòÉ

hwndCnr (HWND)
   System use only (window animation).


ΓòÉΓòÉΓòÉ <hidden> pRecord ΓòÉΓòÉΓòÉ

pRecord (PMINIRECORDCORE)
   System use only (window animation).


ΓòÉΓòÉΓòÉ 4.410. VIOFONTCELLSIZE ΓòÉΓòÉΓòÉ

VIOFONTCELLSIZE VIO cell size, see DevEscape.

typedef struct _VIOFONTCELLSIZE {
LONG    cx;  /* Cell width  */
LONG    cy;  /* Cell height  */
 } VIOFONTCELLSIZE;


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (LONG)
   Cell width.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (LONG)
   Cell height.


ΓòÉΓòÉΓòÉ 4.411. VIOSIZECOUNT ΓòÉΓòÉΓòÉ

VIOSIZECOUNT Count of VIO cell sizes, see DevEscape.

typedef struct _VIOSIZECOUNT {
LONG    maxcount;  /* Maximum number of VIO cell sizes supported  */
LONG    count;     /* Number of VIO cell sizes returned  */
 } VIOSIZECOUNT;


ΓòÉΓòÉΓòÉ <hidden> maxcount ΓòÉΓòÉΓòÉ

maxcount (LONG)
   Maximum number of VIO cell sizes supported.


ΓòÉΓòÉΓòÉ <hidden> count ΓòÉΓòÉΓòÉ

count (LONG)
   Number of VIO cell sizes returned.


ΓòÉΓòÉΓòÉ 4.412. VOID ΓòÉΓòÉΓòÉ

VOID A data area of undefined format.

#define VOID void


ΓòÉΓòÉΓòÉ 4.413. VSCDATA ΓòÉΓòÉΓòÉ

VSCDATA Structure that contains information about the value set control.

typedef struct _VSCDATA {
ULONG     cbSize;         /* Data length  */
USHORT    usRowCount;     /* Number of rows  */
USHORT    usColumnCount;  /* Number of columns  */
 } VSCDATA;


ΓòÉΓòÉΓòÉ <hidden> cbSize ΓòÉΓòÉΓòÉ

cbSize (ULONG)
   Data length.

   Length of the control data in bytes.


ΓòÉΓòÉΓòÉ <hidden> usRowCount ΓòÉΓòÉΓòÉ

usRowCount (USHORT)
   Number of rows.

   The number of rows in the value set control. The minimum number of rows is 1
   and the maximum number of rows is 65,535.


ΓòÉΓòÉΓòÉ <hidden> usColumnCount ΓòÉΓòÉΓòÉ

usColumnCount (USHORT)
   Number of columns.

   The number of columns in the value set control. The minimum number of
   columns is 1 and the maximum number of columns is 65,535.


ΓòÉΓòÉΓòÉ 4.414. VSDRAGINFO ΓòÉΓòÉΓòÉ

VSDRAGINFO Structure that contains information about direct manipulation
actions that occur over the value set control.

typedef struct _VSDRAGINFO {
PDRAGINFO    pDragInfo;  /* Pointer  */
USHORT       usRow;      /* Row index  */
USHORT       usColumn;   /* Column index  */
 } VSDRAGINFO;


ΓòÉΓòÉΓòÉ <hidden> pDragInfo ΓòÉΓòÉΓòÉ

pDragInfo (PDRAGINFO)
   Pointer.

   Pointer to a DRAGINFO structure.


ΓòÉΓòÉΓòÉ <hidden> usRow ΓòÉΓòÉΓòÉ

usRow (USHORT)
   Row index.

   The index of the row over which the direct manipulation action occurred.


ΓòÉΓòÉΓòÉ <hidden> usColumn ΓòÉΓòÉΓòÉ

usColumn (USHORT)
   Column index.

   The index of the column over which the direct manipulation action occurred.


ΓòÉΓòÉΓòÉ 4.415. VSDRAGINIT ΓòÉΓòÉΓòÉ

VSDRAGINIT Structure that contains information that is used to initialize a
direct manipulation action over the value set control.

typedef struct _VSDRAGINIT {
HWND      hwnd;      /* Value set window handle  */
LONG      x;         /* X-coordinate  */
LONG      y;         /* Y-coordinate  */
LONG      cx;        /* X-offset  */
LONG      cy;        /* Y-offset  */
USHORT    usRow;     /* Row index  */
USHORT    usColumn;  /* Column index  */
 } VSDRAGINIT;


ΓòÉΓòÉΓòÉ <hidden> hwnd ΓòÉΓòÉΓòÉ

hwnd (HWND)
   Value set window handle.

   Window handle of the value set control.


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (LONG)
   X-coordinate.

   X-coordinate of the pointing device pointer in desktop coordinates.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (LONG)
   Y-coordinate.

   Y-coordinate of the pointing device pointer in desktop coordinates.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (LONG)
   X-offset.

   X-offset from the hot spot of the pointing device pointer, in pels, to the
   item origin. The item origin is the lower left corner of the item.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (LONG)
   Y-offset.

   Y-offset from the hot spot of the pointing device pointer, in pels, to the
   item origin. The item origin is the lower left corner of the item.


ΓòÉΓòÉΓòÉ <hidden> usRow ΓòÉΓòÉΓòÉ

usRow (USHORT)
   Row index.

   The index of the row over which the direct manipulation action occurred.


ΓòÉΓòÉΓòÉ <hidden> usColumn ΓòÉΓòÉΓòÉ

usColumn (USHORT)
   Column index.

   The index of the column over which the direct manipulation action occurred.


ΓòÉΓòÉΓòÉ 4.416. VSTEXT ΓòÉΓòÉΓòÉ

VSTEXT Value set text structure. This structure is used with the VM_QUERYITEM
message only.

typedef struct _VSTEXT {
PSZ      pszItemText;  /* Pointer  */
ULONG    ulBufLen;     /* Buffer size  */
 } VSTEXT;


ΓòÉΓòÉΓòÉ <hidden> pszItemText ΓòÉΓòÉΓòÉ

pszItemText (PSZ)
   Pointer.

   Pointer to a buffer to copy the string into.


ΓòÉΓòÉΓòÉ <hidden> ulBufLen ΓòÉΓòÉΓòÉ

ulBufLen (ULONG)
   Buffer size.

   Size of the buffer pointed to by the pszItemText field.


ΓòÉΓòÉΓòÉ 4.417. WNDPARAMS ΓòÉΓòÉΓòÉ

WNDPARAMS Window parameters.

typedef struct _WNDPARAMS {
ULONG    fsStatus;      /* Window parameter selection  */
ULONG    cchText;       /* Length of window text  */
PSZ      pszText;       /* Window text  */
ULONG    cbPresParams;  /* Length of presentation parameters  */
PVOID    pPresParams;   /* Presentation parameters  */
ULONG    cbCtlData;     /* Length of window class specific data  */
PVOID    pCtlData;      /* Window class specific data  */
 } WNDPARAMS;


ΓòÉΓòÉΓòÉ <hidden> fsStatus ΓòÉΓòÉΓòÉ

fsStatus (ULONG)
   Window parameter selection.

   Identifies the window parameters that are to be set or queried:

   WPM_CBCTLDATA
      Window control data length
   WPM_CCHTEXT
      Window text length
   WPM_CTLDATA
      Window control data
   WPM_PRESPARAMS
      Presentation parameters
   WPM_TEXT
      Window text.


ΓòÉΓòÉΓòÉ <hidden> cchText ΓòÉΓòÉΓòÉ

cchText (ULONG)
   Length of window text.


ΓòÉΓòÉΓòÉ <hidden> pszText ΓòÉΓòÉΓòÉ

pszText (PSZ)
   Window text.


ΓòÉΓòÉΓòÉ <hidden> cbPresParams ΓòÉΓòÉΓòÉ

cbPresParams (ULONG)
   Length of presentation parameters.


ΓòÉΓòÉΓòÉ <hidden> pPresParams ΓòÉΓòÉΓòÉ

pPresParams (PVOID)
   Presentation parameters.


ΓòÉΓòÉΓòÉ <hidden> cbCtlData ΓòÉΓòÉΓòÉ

cbCtlData (ULONG)
   Length of window class specific data.


ΓòÉΓòÉΓòÉ <hidden> pCtlData ΓòÉΓòÉΓòÉ

pCtlData (PVOID)
   Window class specific data.


ΓòÉΓòÉΓòÉ 4.418. WPClock * ΓòÉΓòÉΓòÉ

WPClock *  Pointer to an object of class WPClock.


ΓòÉΓòÉΓòÉ 4.419. WPCountry * ΓòÉΓòÉΓòÉ

WPCountry *  Pointer to an object of class WPCountry.


ΓòÉΓòÉΓòÉ 4.420. WPDataFile * ΓòÉΓòÉΓòÉ

WPDataFile *  Pointer to an object of class WPDataFile.


ΓòÉΓòÉΓòÉ 4.421. WPDesktop * ΓòÉΓòÉΓòÉ

WPDesktop *  Pointer to an object of class WPDesktop.


ΓòÉΓòÉΓòÉ 4.422. WPDisk * ΓòÉΓòÉΓòÉ

WPDisk *  Pointer to an object of class WPDisk.


ΓòÉΓòÉΓòÉ 4.423. WPFileSystem * ΓòÉΓòÉΓòÉ

WPFileSystem *  Pointer to an object of class WPFileSystem.


ΓòÉΓòÉΓòÉ 4.424. WPFolder * ΓòÉΓòÉΓòÉ

WPFolder *  Pointer to an object of class WPFolder.


ΓòÉΓòÉΓòÉ 4.425. WPJob * ΓòÉΓòÉΓòÉ

WPJob *  Pointer to an object of class WPJob.


ΓòÉΓòÉΓòÉ 4.426. WPKeyboard * ΓòÉΓòÉΓòÉ

WPKeyboard *  Pointer to an object of class WPKeyboard.


ΓòÉΓòÉΓòÉ 4.427. WPMouse * ΓòÉΓòÉΓòÉ

WPMouse *  Pointer to an object of class WPMouse.


ΓòÉΓòÉΓòÉ 4.428. WPObject * ΓòÉΓòÉΓòÉ

WPObject *  Pointer to an object of class WPObject.


ΓòÉΓòÉΓòÉ 4.429. WPOINT ΓòÉΓòÉΓòÉ

WPOINT Window-point structure (integer).

#define WPOINT POINTL


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (LONG)
   X-coordinate.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (LONG)
   Y-coordinate.


ΓòÉΓòÉΓòÉ 4.430. WPPalette * ΓòÉΓòÉΓòÉ

WPPalette *  Pointer to an object of class WPPalette.


ΓòÉΓòÉΓòÉ 4.431. WPPower * ΓòÉΓòÉΓòÉ

WPPower *  Pointer to an object of class WPPower.

This data structure is specific to version 2.1, or higher, of the OS/2
operating system.


ΓòÉΓòÉΓòÉ 4.432. WPPrinter * ΓòÉΓòÉΓòÉ

WPPrinter *  Pointer to an object of class WPPrinter.


ΓòÉΓòÉΓòÉ 4.433. WPProgram * ΓòÉΓòÉΓòÉ

WPProgram *  Pointer to an object of class WPProgram.


ΓòÉΓòÉΓòÉ 4.434. WPProgramGroup * ΓòÉΓòÉΓòÉ

WPProgramGroup *  Pointer to an object of class WPProgramGroup.


ΓòÉΓòÉΓòÉ 4.435. WPProgramFile * ΓòÉΓòÉΓòÉ

WPProgramFile *  Pointer to an object of class WPProgramFile.


ΓòÉΓòÉΓòÉ 4.436. WPRootFolder * ΓòÉΓòÉΓòÉ

WPRootFolder *  Pointer to an object of class WPRootFolder.


ΓòÉΓòÉΓòÉ 4.437. WPShadow * ΓòÉΓòÉΓòÉ

WPShadow *  Pointer to an object of class WPShadow.


ΓòÉΓòÉΓòÉ 4.438. WPSound * ΓòÉΓòÉΓòÉ

WPSound *  Pointer to an object of class WPSound.


ΓòÉΓòÉΓòÉ 4.439. WPSpool * ΓòÉΓòÉΓòÉ

WPSpool *  Pointer to an object of class WPSpool.


ΓòÉΓòÉΓòÉ 4.440. WPSRCLASSBLOCK ΓòÉΓòÉΓòÉ

WPSRCLASSBLOCK Save or restore class block structure.

typedef struct _WPSRCLASSBLOCK {
SHORT     ClassNameLength;  /* Length of class name  */
USHORT    IVarLength;       /* Length of instance variable information  */
 } WPSRCLASSBLOCK;


ΓòÉΓòÉΓòÉ <hidden> ClassNameLength ΓòÉΓòÉΓòÉ

ClassNameLength (SHORT)
   Length of class name.

   Includes the null terminator. This must be a short and must be at the
   beginning of the structure.  The class name immediately follows the control
   block. The first instance variable control block immediately follows this.


ΓòÉΓòÉΓòÉ <hidden> IVarLength ΓòÉΓòÉΓòÉ

IVarLength (USHORT)
   Length of instance variable information.

   Includes the two-byte null terminator.


ΓòÉΓòÉΓòÉ 4.441. WPSystem * ΓòÉΓòÉΓòÉ

WPSystem *  Pointer to an object of class WPSystem.


ΓòÉΓòÉΓòÉ 4.442. WRECT ΓòÉΓòÉΓòÉ

WRECT Window-rectangle structure (integer).

#define WRECT RECTL


ΓòÉΓòÉΓòÉ <hidden> xLeft ΓòÉΓòÉΓòÉ

xLeft (SHORT)
   X-coordinate of left-hand edge of rectangle.


ΓòÉΓòÉΓòÉ <hidden> dummy1 ΓòÉΓòÉΓòÉ

dummy1 (SHORT)
   Reserved.


ΓòÉΓòÉΓòÉ <hidden> yBottom ΓòÉΓòÉΓòÉ

yBottom (SHORT)
   Y-coordinate of bottom edge of rectangle.


ΓòÉΓòÉΓòÉ <hidden> dummy2 ΓòÉΓòÉΓòÉ

dummy2 (SHORT)
   Reserved.


ΓòÉΓòÉΓòÉ <hidden> xRight ΓòÉΓòÉΓòÉ

xRight (SHORT)
   X-coordinate of right-hand edge of rectangle.


ΓòÉΓòÉΓòÉ <hidden> dummy3 ΓòÉΓòÉΓòÉ

dummy3 (SHORT)
   Reserved.


ΓòÉΓòÉΓòÉ <hidden> yTop ΓòÉΓòÉΓòÉ

yTop (SHORT)
   Y-coordinate of top edge of rectangle.


ΓòÉΓòÉΓòÉ <hidden> dummy4 ΓòÉΓòÉΓòÉ

dummy4 (SHORT)
   Reserved.


ΓòÉΓòÉΓòÉ 4.443. XYWINSIZE ΓòÉΓòÉΓòÉ

XYWINSIZE Window position and size structure.

typedef struct _XYWINSIZE {
SHORT     x;         /* X-coordinate of window origin  */
SHORT     y;         /* Y-coordinate of window origin  */
SHORT     cx;        /* Window width  */
SHORT     cy;        /* Window height  */
USHORT    fsWindow;  /* Window options  */
 } XYWINSIZE;


ΓòÉΓòÉΓòÉ <hidden> x ΓòÉΓòÉΓòÉ

x (SHORT)
   X-coordinate of window origin.


ΓòÉΓòÉΓòÉ <hidden> y ΓòÉΓòÉΓòÉ

y (SHORT)
   Y-coordinate of window origin.


ΓòÉΓòÉΓòÉ <hidden> cx ΓòÉΓòÉΓòÉ

cx (SHORT)
   Window width.


ΓòÉΓòÉΓòÉ <hidden> cy ΓòÉΓòÉΓòÉ

cy (SHORT)
   Window height.


ΓòÉΓòÉΓòÉ <hidden> fsWindow ΓòÉΓòÉΓòÉ

fsWindow (USHORT)
   Window options.

   The values may be ORed together. For example, an invisible iconic window can
   be created. Note that if both XYF_MINIMIZED and XYF_MAXIMIZED are specified,
   the window is created in a maximized state.

   XYF_INVISIBLE
      Create the window initially invisible.
   XYF_MAXIMIZED
      Show the window initially maximized.
   XYF_MINIMIZED
      Show the window initially iconic.
   XYF_NOAUTOCLOSE
      Do not close the window automatically when the VIO application
      terminates. This parameter is ignored unless the program is a
      VIO-windowed application.
   XYF_NORMAL
      Create the window visible, with a size and position as specified. This is
      the default.


ΓòÉΓòÉΓòÉ 5. Device Functions ΓòÉΓòÉΓòÉ

This section describes functions that an application would use to query or
access devices.


ΓòÉΓòÉΓòÉ 5.1. DevCloseDC ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DevCloseDC ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DevCloseDC ΓòÉΓòÉΓòÉ

hdc (HDC) - input
   Device-context handle.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DevCloseDC ΓòÉΓòÉΓòÉ

hmf (HMF) - return
   Error indicator metafile handle (for a metafile device context)

   DEV_ERROR
      Error occurred.

   DEV_OK
      Device closed, but not a metafile device context.

   Other
      Device closed, a metafile device context whose metafile handle is
      returned.


ΓòÉΓòÉΓòÉ <hidden> Errors - DevCloseDC ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_NOT_CREATED_BY_DEVOPENDC
   An attempt has been made to destroy a device context using DevCloseDC that
   was not created using DevOpenDC.

PMERR_DC_IS_ASSOCIATED
   An attempt was made to associate a presentation space with a device context
   that was already associated or to destroy a device context that was
   associated.

PMERR_INV_HDC
   An invalid device-context handle or (micro presentation space)
   presentation-space handle was specified.


ΓòÉΓòÉΓòÉ <hidden> Notes - DevCloseDC ΓòÉΓòÉΓòÉ

If the device context is currently associated with a presentation space, or if
it is created with the WinOpenWindowDC call (that is, it is a screen device
context), an error is raised, and the device context is not closed.

If the device context being closed is a memory device context that has a bit
map currently selected into it (see the GpiSetBitmap function), the bit map is
automatically deselected before the device context is closed.

Any clip region currently in use for this device context is deleted.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DevCloseDC ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function closes a device context.  */
/*******************************************/

#define INCL_DEV   /* Or use INCL_PM. Also in COMMON section */
#include <os2.h>

HDC  hdc;/* Device-context handle */
HMF  hmf;/* Error indicator metafile handle (for a metafile device context) */

hmf = DevCloseDC(hdc);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DevCloseDC ΓòÉΓòÉΓòÉ

Prerequisite Functions

o DevOpenDC

Related Functions

o WinOpenWindowDC


ΓòÉΓòÉΓòÉ <hidden> Example Code - DevCloseDC ΓòÉΓòÉΓòÉ

 This example calls DevCloseDC to close a device context based on the handle
returned from DevOpenDC.


#define INCL_DEV                /* Device Function definitions  */
#include <os2.h>

HDC hdc;                /* Device-context handle                */
HMF hmf;                /* error code (or metafile handle if
                           metafile device context)             */

/* close the device context associated with handle hdc */
hmf = DevCloseDC(hdc);


ΓòÉΓòÉΓòÉ 5.2. DevEscape ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DevEscape ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Graphic Elements and Orders
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DevEscape ΓòÉΓòÉΓòÉ

hdc (HDC) - input
   Device-context handle.

lCode (LONG) - input
   Escape code. If the device context is of type OD_QUEUED with a PM_Q_STD
   spool file, some escapes are sent to the presentation driver and others are
   recorded in the spool file (depending on the escape code). If the device
   context is of type OD_METAFILE, all escapes are metafiled. If the device
   context is of any type other than OD_QUEUED (with a PM_Q_STD spool file) or
   OD_METAFILE, all escapes are sent to the presentation driver.

   The description for each standard escape specifies which of these categories
   the escape falls into.

   Devices can define additional escape functions using user lCode values, that
   have the following ranges:

   32 768 through 40 959
      Not metafiled and not recorded (sent to presentation driver for PM_Q_STD)
   40 960 through 49 151
      Metafiled only (sent to presentation driver for PM_Q_STD)
   49 152 through 57 343
      Metafiled and recorded (not sent to presentation driver) for PM_Q_STD
   57 344 through 65 535
      Recorded only (not sent to presentation driver for PM_Q_STD).

   The following escapes are defined:

   DEVESC_QUERYESCSUPPORT

   DEVESC_GETSCALINGFACTOR

   DEVESC_STARTDOC

   DEVESC_ENDDOC

   DEVESC_ABORTDOC

   DEVESC_NEWFRAME

   DEVESC_RAWDATA

   DEVESC_QUERYVIOCELLSIZES

   DEVESC_SETMODE

lInCount (LONG) - input
   Input data count. Number of bytes of data in the pbInData buffer.

pbInData (PBYTE) - input
   The input data required for this escape.

plOutCount (PLONG) - input/output
   Output data count. plOutCount is the number of bytes of data in the
   pbOutData buffer.

   If data is returned in pbOutData, plOutCount is updated to the number of
   bytes of data returned.

pbOutData (PBYTE) - output
   Output data. pbOutData is a buffer that receives the output from this
   escape.  If plOutCount is null, no data is returned.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DevEscape ΓòÉΓòÉΓòÉ

lResult (LONG) - return
   Implementation error indicator:

   DEVESC_ERROR                       Error
   DEVESC_NOTIMPLEMENTED              Escape not implemented for specified code
   DEV_OK                             OK.


ΓòÉΓòÉΓòÉ <hidden> Errors - DevEscape ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INV_ESCAPE_CODE
   An invalid code parameter was specified with DevEscape.

PMERR_INV_HDC
   An invalid device-context handle or (micro presentation space)
   presentation-space handle was specified.

PMERR_INV_LENGTH_OR_COUNT
   An invalid length or count parameter was specified.

PMERR_ESC_CODE_NOT_SUPPORTED
   The code specified with DevEscape is not supported by the target device
   driver.

PMERR_INV_ESCAPE_DATA
   An invalid data parameter was specified with DevEscape.


ΓòÉΓòÉΓòÉ <hidden> Notes - DevEscape ΓòÉΓòÉΓòÉ

The data fields for standard escapes are:

DEVESC_QUERYESCSUPPORT
   Queries whether a particular escape is implemented by the presentation
   driver.  The return value gives the result.

   This escape is not metafiled or recorded.

   lInCount
      Number of bytes pointed to by pbInData.

   pbInData
      The buffer contains an escape code value specifying the escape function
      to be checked.

   plOutCount
      Not used; can be set to 0.

   pbOutData
      Not used; can be set to null.

DEVESC_GETSCALINGFACTOR
   Returns the scaling factors for the x and y axes of a printing device.  For
   each scaling factor, an exponent of two is put in pbOutData.  Thus, the
   value 3 is used if the scaling factor is 8.

   Scaling factors are used by devices that cannot support graphics at the same
   resolution as the device resolution.

   This escape is not metafiled or recorded.

   lInCount Not used; can be set to 0.

   pbInData Not used; can be set to null.

   plOutCount The number of bytes of data pointed to by pbOutData. On return,
      this is updated to the number of bytes returned.

   pbOutData The address of a SFACTORS structure, which on return contains the
      scaling factors for the x and y axes.

DEVESC_STARTDOC
   Indicates that a new print job is starting. All subsequent output to the
   device context is spooled under the same job identifier until a
   DEVESC_ENDDOC occurs.

   A GpiAssociate function must be issued to associate the presentation space
   with the device context before issuing this escape.

   This escape is metafiled but not recorded.

   lInCount Number of bytes pointed to by pbInData.

   pbInData The buffer contains a null-terminated string, specifying the name
      of the document.

   plOutCount Not used; can be set to 0.

   pbOutData Not used; can be set to null.

DEVESC_ENDDOC
   Ends a print job started by DEVESC_STARTDOC.

   This escape is metafiled but not recorded.

   lInCount Not used; can be set to 0.

   pbInData Not used; can be set to null.

   plOutCount Set equal to 2.

   pbOutData The buffer contains a USHORT specifying the job identifier if a
      spooler print job is created.

DEVESC_ABORTDOC
   Aborts the current job, erasing everything the application has written to
   the device since the last DEVESC_STARTDOC, including the DEVESC_STARTDOC.

   This escape is metafiled but not recorded.

   lInCount Not used; can be set to 0

   pbInData Not used; can be set to null

   plOutCount Not used; can be set to 0

   pbOutData Not used; can be set to null.

DEVESC_NEWFRAME
   Signals when an application has finished writing to a page and wants to
   start a new page. It is similar to GpiErase processing for a screen device
   context, and causes a reset of the attributes. This escape is used with a
   printer device to advance to a new page.

   This escape is metafiled and recorded.

   lInCount Not used; can be set to 0

   pbInData Not used; can be set to null

   plOutCount Not used; can be set to 0

   pbOutData Not used; can be set to null.

DEVESC_RAWDATA
   Allows an application to send data directly to a presentation driver. For
   example, in the case of a printer driver, this could be a printer data
   stream.

   If DEVESC_RAWDATA is mixed with other data (such as GPI data) being sent to
   the same page of a device context, the results are unpredictable and depend
   upon the action taken by the presentation driver. For example, a
   presentation driver might ignore GPI data if DEVESC_RAWDATA is mixed with it
   on the same page. In general, DEVESC_RAWDATA should be sent either to a
   separate page (using the DEVESC_NEWFRAME escape to obtain a new page) or to
   a separate document (using the DEVESC_STARTDOC and DEVESC_ENDDOC escapes to
   create a new document).

   This escape is metafiled and recorded.

   lInCount Number of bytes pointed to by pbInData

   pbInData Pointer to the raw data

   plOutCount Not used; can be set to 0

   pbOutData Not used; can be set to null.

DEVESC_QUERYVIOCELLSIZES
   Returns the VIO cell sizes supported by the presentation driver.

   This escape is not metafiled or recorded.

   lInCount Not used; can be set to 0

   pbInData Not used; can be set to null.

   plOutCount The number of bytes of data pointed to by pbOutData. It must be
      an even multiple of the size in bytes of the LONG data type. On return,
      this is updated to the number of bytes returned.

   pbOutData The address of a buffer, which on return contains a VIOSIZECOUNT
      structure, immediately followed by count copies of a VIOFONTCELLSIZE
      structure.

      If plOutCount is less than the size of a LONG data type, plOutCount is
      updated to zero, and nothing is returned in the buffer pointed to by
      pbOutData.

      If plOutCount is equal to the size of a LONG data type, pbOutData returns
      the number of VIO cell sizes that can be returned by this escape. The
      buffer pointed to by pbOutData is updated so that maxcount is the number
      of VIO cell sizes that can be returned.

      If plOutCount is greater than the size of a LONG data type, pbOutData
      returns the VIO cell sizes that are supported. The buffer pointed to by
      pbOutData is updated so that:

      o maxcount is the number of VIO cell sizes that can be returned

      o count is the number of VIO cell sizes returned (may be zero if
        plOutCount is equal to twice the size of a LONG data type)

      o count copies of a VIOFONTCELLSIZE structure are returned.

DEVESC_SETMODE
   Sets the printer into a particular mode. It is optional for printer drivers
   to support this escape, but those that do support it need to be aware of the
   code page of any built-in fonts. For example, if only code page 437 is built
   in, it is used if 437 is requested by DEVESC_SETMODE. However, if code page
   865 is requested, a suitable code page/font could be downloaded.

   This escape is metafiled and recorded.

   lInCount Number of bytes pointed to by pbInData
   pbInData Buffer contains an ESCSETMODE structure
   plOutCount Not used; can be set to 0
   pbOutData Not used; can be set to null.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DevEscape ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function allows applications to    */
/* access facilities of a device not       */
/* otherwise available through the API.    */
/* Escapes are, in general, sent to the    */
/* presentation driver and must be         */
/* understood by it.                       */
/*******************************************/

#define INCL_DEV   /* Or use INCL_PM */
#include <os2.h>

HDC    hdc;         /* Device-context handle */
LONG   lCode;       /* Escape code */
LONG   lInCount;    /* Input data count */
PBYTE  pbInData;    /* The input data required for this escape */
PLONG  plOutCount;  /* Output data count */
PBYTE  pbOutData;   /* Output data */
LONG   lResult;     /* Implementation error indicator */

lResult = DevEscape(hdc, lCode, lInCount,
            pbInData, plOutCount, pbOutData);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DevEscape ΓòÉΓòÉΓòÉ

Prerequisite Functions

o DevOpenDC

Related Functions

o GpiAssociate(for DEVESC_STARTDOC)
o GpiErase(for DEVESC_NEWFRAME)


ΓòÉΓòÉΓòÉ <hidden> Graphic Elements and Orders - DevEscape ΓòÉΓòÉΓòÉ

DevEscape functions generate orders only when metafiling.

Order: Extended Escape


ΓòÉΓòÉΓòÉ <hidden> Example Code - DevEscape ΓòÉΓòÉΓòÉ

 This example uses DevEscape to access facilities of a device that would
otherwise be unavailable through the normal Device API set.  Here, a new page
in a print job is started.


#define INCL_DEV        /* Device Function definitions  */
#include <os2.h>

LONG  lResult;          /* Error code or not implemented
                           warning code                         */
HDC   hdc;              /* Device-context handle                */
LONG  plOutCount;       /* length of output buffer(input),
                           number of bytes returned(output)     */
PBYTE pbOutData;        /* output buffer                        */

/* for the NEWFRAME, input and output buffers are not used,
   so set the buffer lengths to zero(0) and set the buffers to
   NULL */
plOutCount = 0;
pbOutData = NULL;

lResult = DevEscape(hdc, DEVESC_NEWFRAME, 0L, NULL, &plOutCount,
                    pbOutData);


ΓòÉΓòÉΓòÉ 5.3. DevOpenDC ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DevOpenDC ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DevOpenDC ΓòÉΓòÉΓòÉ

hab (HAB) - input
   Anchor-block handle.

lType (LONG) - input
   Type of device context:

   OD_QUEUED
      A device, such as a printer or plotter, for which output is to be queued.

      Certain restrictions apply for this device type; see Metafile
      Restrictions.

   OD_DIRECT
      A device, such as a printer or plotter, for which output is not to be
      queued.

   OD_INFO
      A device, such as a printer or plotter, but the device context is used
      only to retrieve information (for example, font metrics). Drawing can be
      performed to a presentation space associated with such a device context,
      but no output medium is updated.

   OD_METAFILE
      The device context is used to write a metafile. The presentation page
      defines the area of interest within the picture in the metafile. See
      OD_METAFILE_NOQUERY.

      Certain restrictions apply for this device type; see Metafile
      Restrictions.

   OD_METAFILE_NOQUERY
      The device context is used to write a metafile.

      Functionally, this device type is the same as OD_METAFILE, except that
      querying of attributes is not allowed with a presentation space while it
      is associated with an OD_METAFILE_NOQUERY device context. If querying of
      attributes is not required, OD_METAFILE_NOQUERY should be used in
      preference to OD_METAFILE, since it gives improved performance.

      Certain restrictions apply for this device type; see Metafile
      Restrictions.

   OD_MEMORY
      A device context that is used to contain a bit map. The hdcComp parameter
      identifies a device with which the memory device context is to be
      compatible.

pszToken (PSZ) - input
   Device-information token. This identifies the device information, held in
   the initialization file. This information is the same as that which may be
   pointed to by pdopData; any information that is obtained from pdopData
   overrides the information obtained by using this parameter.

   If pszToken is specified as "*", no device information is taken from the
   initialization file.

   OS/2 behaves as if "*" is specified, but it allows any string.

lCount (LONG) - input
   Number of items. This is the number of items present in the pdopData
   parameter. This can be less than the full list if omitted items are
   irrelevant, or are supplied from pszToken or elsewhere.

pdopData (PDEVOPENDATA) - input
   Open-device-context data area.

hdcComp (HDC) - input
   Compatible-device-context handle. When lType is OD_MEMORY, this parameter is
   a handle to a device context compatible with bit maps that are to be used
   with this device context.

   If hdcComp is NULLHANDLE, compatibility with the screen is assumed.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DevOpenDC ΓòÉΓòÉΓòÉ

hdc (HDC) - return
   Device-context handle:

   DEV_ERROR
      Error

   <>0
      Device-context handle.


ΓòÉΓòÉΓòÉ <hidden> Errors - DevOpenDC ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INV_DC_TYPE
   An invalid type parameter was specified with DevOpenDC, or a function was
   issued that is invalid for a OD_METAFILE_NOQUERY device context.

PMERR_INV_LENGTH_OR_COUNT
   An invalid length or count parameter was specified.

PMERR_INV_DC_DATA
   An invalid data parameter was specified with DevOpenDC.

PMERR_INV_HDC
   An invalid device-context handle or (micro presentation space)
   presentation-space handle was specified.

PMERR_INV_DRIVER_NAME
   A driver name was specified which has not been installed.

PMERR_INV_LOGICAL_ADDRESS
   An invalid device logical address was specified.


ΓòÉΓòÉΓòÉ <hidden> Notes - DevOpenDC ΓòÉΓòÉΓòÉ

A device context is a means of writing to a particular device. Before using GPI
functions to cause output to be directed to the device context, the
GpiAssociate function call must be issued (or the GPIA_ASSOC option specified
on GpiCreatePS).

DevOpenDC cannot be used to open a device context for a screen window; use
WinOpenWindowDC instead.

The device context is owned by the process from which DevOpenDC is issued. It
cannot be accessed directly from any other process. If it still exists when the
process terminates, it is automatically deleted by the system. When using a
device context type of OD_METAFILE_NOQUERY the querying of attributes is not
allowed. To improve performance of this type of metafile no error checking is
performed to ensure that such API calls are not attempted. Query calls are
accepted but the results returned are undefined.

This function requires the existence of a message queue.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DevOpenDC ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function creates a device context. */
/*******************************************/

#define INCL_DEV   /* Or use INCL_PM. Also in COMMON section */
#include <os2.h>

HAB           hab;              /* Anchor-block handle */
LONG          lType;            /* Type of device context */
PSZ           pszToken;         /* Device-information token */
LONG          lCount;           /* Number of items */
PDEVOPENDATA  pdopData;         /* Open-device-context data area */
HDC           hdcComp;          /* Compatible-device-context handle */
HDC           hdc;              /* Device-context handle */

hdc = DevOpenDC(hab, lType, pszToken,
        lCount, pdopData, hdcComp);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DevOpenDC ΓòÉΓòÉΓòÉ

Prerequisite Functions

o WinInitialize

Related Functions

o DevCloseDC
o GpiAssociate(for the output of GPI data)
o PrfQueryProfileString
o WinOpenWindowDC
o WinQueryWindow


ΓòÉΓòÉΓòÉ <hidden> Example Code - DevOpenDC ΓòÉΓòÉΓòÉ

 This example calls DevOpenDC to create a memory device context with screen
compatibility and then associates that context with a newly created
presentation space.


#define INCL_DEV                /* Device Function definitions  */
#define INCL_GPICONTROL         /* GPI control Functions        */
#include <os2.h>

HDC   hdc;              /* Device-context handle                */
HAB   hab;              /* Anchor-block handle                  */
 /* context data structure */
DEVOPENSTRUC dop = {NULL, "DISPLAY", NULL, NULL, NULL, NULL,
                    NULL, NULL, NULL};
HPS    hps;             /* presentation-space handle            */
SIZEL  sizl={0, 0};     /* use same page size as device        */

/* create memory device context */
hdc = DevOpenDC(hab, OD_MEMORY, "*", 5L, (PDEVOPENDATA)&dop, NULLHANDLE);

/* create a presentation space associated with the context */
hps = GpiCreatePS(hab, hdc, &sizl, GPIA_ASSOC | PU_PELS);


ΓòÉΓòÉΓòÉ 5.4. DevPostDeviceModes ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DevPostDeviceModes ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DevPostDeviceModes ΓòÉΓòÉΓòÉ

hab (HAB) - input
   Anchor-block handle.

pdrivDriverData (PDRIVDATA) - input/output
   Driver data. A data area that, on return, contains device data defined by
   the presentation driver. If the pointer to the area is NULL, this function
   returns the required size of the data area.

   The format of the data is the same as that which occurs within the
   DEVOPENSTRUC structure, passed on the pdopData parameter of DevOpenDC.

pszDriverName (PSZ) - input
   Device-driver name. A string containing the name of the presentation driver;

pszDeviceName (PSZ) - input
   Device-type name. Null-terminated string in a 32-byte field, identifying the
   device type; for example, "HP LaserJet IID" (model number). Valid names are
   defined by device drivers.

   Note:  This parameter always overrides the data in the szDeviceName[32]
          field of the DRIVDATA structure, passed in the pdrivDriverData
          parameter.

pszName (PSZ) - input
   Device name. A name that identifies the device; for example, "PRINTER1". If
   DPDM_POSTJOBPROP is specified in the flOptions parameter, the pszName
   parameter can be NULL.

flOptions (ULONG) - input
   Dialog options. Options that control whether a dialog is displayed.

   DPDM_POSTJOBPROP
             This function allows the user to set properties for the print job
             by displaying a dialog and returning the updated job properties.
             Examples of job properties are paper size, paper orientation, and
             single-sided or duplex.

             The printer is configured in the shell using a dialog provided by
             the presentation driver. The configuration describes the actual
             printer setup such as number of paper bins, available paper sizes,
             and any installed hardware fonts.

             Before the job properties dialog is displayed the presentation
             driver merges any changes in the printer configuration with the
             data passed in the pdrivDriverData parameter. This allows, for
             example new paper sizes to be added into the job properties
             dialog. The parameter pszName can be specified as NULL although
             this is not recommended because the presentation driver cannot
             easily find the printer configuration to merge.

             It is the responsibility of the application to retrieve and store
             job properties. An application can choose to store job properties
             either on a per document or per application basis. The job
             properties can then be passed into DevOpenDC. Initial (default)
             job properties can be retrieved using DPDM_QUERYJOBPROP option.

             The application cannot tell if the user modified the job
             properties or just cancelled the dialog. Hence the job properties
             returned in the pdrivDriverData parameter must always be stored.

             The shell allows users to specify default job properties for a
             printer. The spooler API SplQueryQueue can be used to retrieve
             these defaults. The spooler automatically adds the default job
             properties for a printer to any jobs that are submitted without
             job properties.

   DPDM_QUERYJOBPROP
             Do not display a dialog.  Return the default job properties. These
             defaults are derived from the defaults for the chosen device; for
             example, "HP Laserjet IID" and the printer setup specified via the
             shell printer driver configuration dialog.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DevPostDeviceModes ΓòÉΓòÉΓòÉ

lDriverCount (LONG) - return
   Size/error indicator. Value depends on what was passed as the pointer to
   pdrivDriverData:

   NULL

      DPDM_ERROR  Error
      DPDM_NONE   No settable options
      >0          Size in bytes required for pdrivDriverData.

   Other

      DPDM_ERROR  Error
      DPDM_NONE   No settable options
      DEV_OK      OK.


ΓòÉΓòÉΓòÉ <hidden> Errors - DevPostDeviceModes ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INV_DRIVER_DATA
   Invalid driver data was specified.

PMERR_DRIVER_NOT_FOUND
   The device driver specified with DevPostDeviceModes was not found.

PMERR_INV_DEVICE_NAME
   An invalid devicename parameter was specified with DevPostDeviceModes.

PMERR_INV_LOGICAL_ADDRESS
   An invalid device logical address was specified.


ΓòÉΓòÉΓòÉ <hidden> Notes - DevPostDeviceModes ΓòÉΓòÉΓòÉ

An application can first call this function with a NULL data pointer to find
out how much storage is needed for the data area. Having allocated the storage,
the application can then make the call a second time for the data to be
entered. The returned data can then be passed in DevOpenDC as pdrivDriverData
within the pdopData parameter.

Calling this function requires the existence of a message queue.

Use SplEnumDevice or SplEnumPrinter with flType set to SPL_PR_DIRECT_DEVICE or
SPL_PR_QUEUED_DEVICE to get a list of all the devices.

To get information about a specific device use SplQueryDevice.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DevPostDeviceModes ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function returns, and optionally   */
/* sets job properties.                    */
/*******************************************/

#define INCL_DEV   /* Or use INCL_PM */
#include <os2.h>

HAB        hab;                  /* Anchor-block handle */
PDRIVDATA  pdrivDriverData;      /* Driver data */
PSZ        pszDriverName;        /* Device-driver name. A string containing the name of the presentation driver; for example, "LASERJET" */
PSZ        pszDeviceName;        /* Device-type name */
PSZ        pszName;              /* Device name */
ULONG      flOptions;            /* Dialog options */
LONG       lDriverCount;         /* Size/error indicator */

lDriverCount = DevPostDeviceModes(hab,
                 pdrivDriverData,
                 pszDriverName,
                 pszDeviceName, pszName,
                 flOptions);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DevPostDeviceModes ΓòÉΓòÉΓòÉ

Related Functions

o DevOpenDC


ΓòÉΓòÉΓòÉ <hidden> Example Code - DevPostDeviceModes ΓòÉΓòÉΓòÉ

This example shows how to call DevPostDeviceModes and allocate a new buffer, if
necessary, for the larger job properties (DRIVDATA structure).

#define INCL_DEV
#define INCL_DOS
#include <os2.h>
#include <memory.h>

{
    ULONG         devrc=FALSE;
    HAB           hab;
    PSZ           pszPrinter;
    HDC           hdc=NULL;
    PDRIVDATA     pOldDrivData;
    PDRIVDATA     pNewDrivData=NULL;
    PDEVOPENSTRUC dops;
    LONG          buflen;

/* check size of buffer required for job properties */
    buflen = DevPostDeviceModes( hab,
                                 NULL,
                                 dops->pszDriverName,
                                 dops->pdriv->szDeviceName,
                                 pszPrinter,
                                 DPDM_POSTJOBPROP
                               );

/* return error to caller */
    if (buflen<=0)
        return(buflen);

/* allocate some memory for larger job properties and */
/* return error to caller */

    if (buflen != dops->pdriv->cb)
    {
        if (DosAllocMem((PPVOID)&pNewDrivData,buflen,fALLOC))
            return(DPDM_ERROR);
    }

/* copy over old data so driver can use old job */
/* properties as base for job properties dialog */
    pOldDrivData = dops->pdriv;
    dops->pdriv = pNewDrivData;
    memcpy( (PSZ)pNewDrivData, (PSZ)pOldDrivData, pOldDrivData->cb );

/* display job properties dialog and get updated */
/* job properties from driver */

    devrc = DevPostDeviceModes( hab,
                                dops->pdriv,
                                dops->pszDriverName,
                                dops->pdriv->szDeviceName,
                                pszPrinter,
                                DPDM_POSTJOBPROP
                              );
    return(devrc);
}


ΓòÉΓòÉΓòÉ 5.5. DevQueryCaps ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DevQueryCaps ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DevQueryCaps ΓòÉΓòÉΓòÉ

hdc (HDC) - input
   Device-context handle.

lStart (LONG) - input
   First item of information. The number of the first item of information to be
   returned in alArray, counting from zero.

lCount (LONG) - input
   Count of items of information. This is the count to be returned in alArray.
   It must be greater than zero.

alArray (PLONG) - output
   Device capabilities. Array of lCount elements, starting with lStart. The
   array elements are numbered consecutively, starting with CAPS_FAMILY. The
   element number constants start with 0.

   If lStart + lCount -1 exceeds the current highest-defined element number,
   elements beyond the highest are returned as 0.

   CAPS_FAMILY
      Device type (values as for lType in DevOpenDC).

   CAPS_IO_CAPS
      Device input/output capability:

      CAPS_IO_DUMMY Dummy device
      CAPS_SUPPORTS_OP Device supports output
      CAPS_SUPPORTS_IP Device supports input
      CAPS_SUPPORTS_IO Device supports output and input.

   CAPS_TECHNOLOGY
      Technology:

      CAPS_TECH_UNKNOWN Unknown
      CAPS_TECH_VECTOR_PLOTTER Vector plotter
      CAPS_TECH_RASTER_DISPLAY Raster display
      CAPS_TECH_RASTER_PRINTER Raster printer
      CAPS_TECH_RASTER_CAMERA Raster camera
      CAPS_TECH_POSTSCRIPT PostScript device.

   CAPS_DRIVER_VERSION
      Version identifier of the presentation driver.

      The high order word of the version identifier is 0.  The low order word
      identifies the release, for example 0x0120 is release 1.2.

   CAPS_WIDTH
      Media width (for a full screen, maximized window for displays) in pels.

   CAPS_HEIGHT
      Media depth (for a full screen, maximized window for displays) in pels.
      (For a plotter, a pel is defined as the smallest possible displacement of
      the pen and can be smaller than a pen width.)

   CAPS_WIDTH_IN_CHARS
      Media width (for a full screen, maximized window for displays) in default
      character columns.

   CAPS_HEIGHT_IN_CHARS
      Media depth (for a full screen, maximized window for displays) in default
      character rows.

   CAPS_HORIZONTAL_RESOLUTION
      Horizontal resolution of device in pels per meter.

   CAPS_VERTICAL_RESOLUTION
      Vertical resolution of device in pels per meter.

   CAPS_CHAR_WIDTH
      Default character-box width in pels for VIO.

   CAPS_CHAR_HEIGHT
      Default character-box height in pels for VIO.

   CAPS_SMALL_CHAR_WIDTH
      Default small-character box width in pels for VIO. This is 0 if there is
      only one character-box size.

   CAPS_SMALL_CHAR_HEIGHT
      Default small-character box height in pels for VIO. This is 0 if there is
      only one character-box size.

   CAPS_COLORS
      Number of distinct colors supported at the same time, including reset
      (gray scales count as distinct colors). If loadable color tables are
      supported, this is the number of entries in the device color table.  For
      plotters, the value returned is the number of pens plus one (for the
      background).

   CAPS_COLOR_PLANES
      Number of color planes.

   CAPS_COLOR_BITCOUNT
      Number of adjacent color bits for each pel (within one plane).

   CAPS_COLOR_TABLE_SUPPORT
      Loadable color table support:

      CAPS_COLTABL_RGB_8 1 if RGB color table can be loaded, with a minimum
                support of 8 bits each for red, green, and blue.
      CAPS_COLTABL_RGB_8_PLUS 1 if color table with other than 8 bits for each
                primary color can be loaded.
      CAPS_COLTABL_TRUE_MIX 1 if true mixing occurs when the logical color
                table has been realized, providing that the size of the logical
                color table is not greater than the number of distinct colors
                supported (see element CAPS_COLORS).
      CAPS_COLTABL_REALIZE 1 if a loaded color table can be realized.

   CAPS_MOUSE_BUTTONS
      The number of pointing device buttons that are available. A returned
      value of 0 indicates that there are no pointing device buttons available.

   CAPS_FOREGROUND_MIX_SUPPORT
      Foreground mix support:

      CAPS_FM_OR Logical OR.
      CAPS_FM_OVERPAINT Overpaint.
      CAPS_FM_XOR Logical XOR.
      CAPS_FM_LEAVEALONE Leave alone.
      CAPS_FM_AND Logical AND.
      CAPS_FM_GENERAL_BOOLEAN All other mix modes; see GpiSetMix.

      The value returned is the sum of the values appropriate to the mixes
      supported. A device capable of supporting OR must, as a minimum, return
      CAPS_FM_OR + CAPS_FM_OVERPAINT + CAPS_FM_LEAVEALONE, signifying support
      for the mandatory mixes OR, overpaint, and leave-alone.

      Note that these numbers correspond to the decimal representation of a bit
      string that is six bits long, with each bit set to 1 if the appropriate
      mode is supported.

      Those mixes returned as supported are guaranteed for all primitive types.
      For more information, see GpiSetMix.

   CAPS_BACKGROUND_MIX_SUPPORT
      Background mix support:

      CAPS_BM_OR Logical OR.
      CAPS_BM_OVERPAINT Overpaint.
      CAPS_BM_XOR Logical XOR.
      CAPS_BM_LEAVEALONE Leave alone.
      CAPS_BM_AND Logical AND.
      CAPS_BM_GENERAL_BOOLEAN All other mix modes; see GpiSetBackMix.
      CAPS_BM_SRCTRANSPARENT Provides a transparent overlay function by not
                copying pels from the source bit map to the output bit map if
                they match the presentation space background color.
      CAPS_BM_DESTTRANSPARENT Provides a transparent underlay function by
                copying only the pels that match the presentation space
                background color from the source bit map to the output bit map.

      The value returned is the sum of the values appropriate to the mixes
      supported. A device must, as a minimum, return CAPS_BM_OVERPAINT +
      CAPS_BM_LEAVEALONE, signifying support for the mandatory background mixes
      overpaint, and leave-alone.

      Note that these numbers correspond to the decimal representation of a bit
      string that is four bits long, with each bit set to 1 if the appropriate
      mode is supported.

      Those mixes returned as supported are guaranteed for all primitive types.
      For more information, see GpiSetBackMix.

   CAPS_VIO_LOADABLE_FONTS
      Number of fonts that can be loaded for VIO.

   CAPS_WINDOW_BYTE_ALIGNMENT
      Whether or not the client area of VIO windows should be byte-aligned:

      CAPS_BYTE_ALIGN_REQUIRED Must be byte-aligned.
      CAPS_BYTE_ALIGN_RECOMMENDED More efficient if byte-aligned, but not
                required.
      CAPS_BYTE_ALIGN_NOT_REQUIRED Does not matter whether byte-aligned.

   CAPS_BITMAP_FORMATS
      Number of bit-map formats supported by device.

   CAPS_RASTER_CAPS
      Capability for device raster operations:

      CAPS_RASTER_BITBLT 1 if GpiBitBlt and GpiWCBitBlt supported
      CAPS_RASTER_BANDING 1 if banding is supported
      CAPS_RASTER_BITBLT_SCALING 1 if GpiBitBlt and GpiWCBitBlt with scaling
                supported.
      CAPS_RASTER_SET_PEL 1 if GpiSetPel supported.
      CAPS_RASTER_FONTS 1 if this device can draw raster fonts.
      CAPS_RASTER_FLOOD_FILL 1 if GpiFloodFill is supported.

   CAPS_MARKER_HEIGHT
      Default marker-box height in pels.

   CAPS_MARKER_WIDTH
      Default marker-box width in pels.

   CAPS_DEVICE_FONTS
      Number of device-specific fonts.

   CAPS_GRAPHICS_SUBSET
      Graphics drawing subset supported. (3 indicates GOCA DR/3)

   CAPS_GRAPHICS_VERSION
      Graphics architecture version number supported. (1 indicates Version 1)

   CAPS_GRAPHICS_VECTOR_SUBSET
      Graphics vector drawing subset supported. (2 indicates GOCA VS/2)

   CAPS_DEVICE_WINDOWING
      Device windowing support:

      CAPS_DEV_WINDOWING_SUPPORT 1 if device supports windowing.

                Other bits are reserved 0.

   CAPS_ADDITIONAL_GRAPHICS
      Additional graphics support:

      CAPS_GRAPHICS_KERNING_SUPPORT 1 if device supports kerning.
      CAPS_FONT_OUTLINE_DEFAULT 1 if device has a default outline font.
      CAPS_FONT_IMAGE_DEFAULT 1 if device has a default image font.
      CAPS_SCALED_DEFAULT_MARKERS 1 if default markers are to be scaled by the
                marker-box attribute.
      CAPS_COLOR_CURSOR_SUPPORT 1 if device supports colored cursors.
      CAPS_PALETTE_MANAGER 1 if device supports palette functions (see
                GpiCreatePalette).
      CAPS_COSMETIC_WIDELINE_SUPPORT 1 if device supports cosmetic thick lines
                (see GpiSetLineWidth).
      CAPS_ENHANCED_TEXT 1 if device supports full font file description and
                text alignment.

                Other bits are reserved 0.

   CAPS_PHYS_COLORS
      Maximum number of distinct colors available on the device.

   CAPS_COLOR_INDEX
      Maximum logical color-table index supported for this device. For the EGA
      and VGA drivers, the value is 63.

   CAPS_GRAPHICS_CHAR_WIDTH
      Default graphics character-box width, in pels.

   CAPS_GRAPHICS_CHAR_HEIGHT
      Default graphics character-box height, in pels.

   CAPS_HORIZONTAL_FONT_RES
      Effective horizontal device resolution in pels per inch, for the purpose
      of selecting fonts.

      For printers, this is the actual device resolution, but for displays it
      may differ from the actual resolution for reasons of legibility.

   CAPS_VERTICAL_FONT_RES
      Effective vertical device resolution in pels per inch, for the purpose of
      selecting fonts.

   CAPS_DEVICE_FONT_SIM
      Identifies which simulations are valid on device fonts.

      Valid flags are:

      CAPS_DEV_FONT_SIM_BOLD
      CAPS_DEV_FONT_SIM_ITALIC
      CAPS_DEV_FONT_SIM_UNDERSCORE
      CAPS_DEV_FONT_SIM_STRIKEOUT

   CAPS_LINEWIDTH_THICK
      Cosmetic thickness of lines and arcs on this device, when fxLineWidth is
      LINEWIDTH_THICK (see GpiSetLineWidth). The units are pels.  A value of 0
      is interpreted as 2 pels.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DevQueryCaps ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator:

   TRUE
      Successful completion

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DevQueryCaps ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INV_HDC
   An invalid device-context handle or (micro presentation space)
   presentation-space handle was specified.

PMERR_INV_QUERY_ELEMENT_NO
   An invalid start parameter was specified with DevQueryCaps.

PMERR_INV_LENGTH_OR_COUNT
   An invalid length or count parameter was specified.


ΓòÉΓòÉΓòÉ <hidden> Notes - DevQueryCaps ΓòÉΓòÉΓòÉ

GpiQueryDevice can be used to find the handle of the currently associated
device context.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DevQueryCaps ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function queries the device        */
/* characteristics.                        */
/*******************************************/

#define INCL_DEV   /* Or use INCL_PM. Also in COMMON section */
#include <os2.h>

HDC    hdc;       /* Device-context handle */
LONG   lStart;    /* First item of information */
LONG   lCount;    /* Count of items of information */
PLONG  alArray;   /* Device capabilities */
BOOL   fSuccess;  /* Success indicator */

fSuccess = DevQueryCaps(hdc, lStart, lCount,
             alArray);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DevQueryCaps ΓòÉΓòÉΓòÉ

Prerequisite Functions

o DevOpenDC(for CAPS_FAMILY)

Related Functions

o DevQueryDeviceNames
o DevQueryHardcopyCaps
o GpiQueryDevice
o GpiSetBackMix (for CAPS_BACKGROUND_MIX_SUPPORT)
o GpiSetMix (for CAPS_FOREGROUND_MIX_SUPPORT)


ΓòÉΓòÉΓòÉ <hidden> Example Code - DevQueryCaps ΓòÉΓòÉΓòÉ

In this example the driver is queried to see if it supports input, output, or
both. Note that a valid device context handle must be passed. This example
assumes a DevOpenDC call has been made to obtain the device context handle.

#define INCL_DEV
#include <OS2.H>

HDC hdc;
LONG lStart;
LONG lCount;
BOOL flreturn;
LONG alArray[CAPS_TECHNOLOGY];
lCount = CAPS_TECHNOLOGY;
lStart = CAPS_FAMILY;

flreturn = DevQueryCaps(hdc,        /* device context handle */
                       lStart,      /* number of first item  */
                       lCount,      /* count of items        */
                       alArray);    /* array of longs which  */
                                    /* will contain the return */
                                    /* information.            */

switch(alArray[CAPS_IO_CAPS])       /* we test the CAPS_IO_CAPS */
                                    /* element of the array to  */
                                    /* find out which options   */
{                                   /* are supported.           */
 case CAPS_IO_SUPPORTS_OP:             /* device supports output.*/

 break;
 case CAPS_IO_SUPPORTS_IP:            /* device supports input. */

 break;
 case CAPS_IO_SUPPORTS_IO:            /* device supports both  */
                                    /* input and output.       */
 break;
 default:
 break;
}


ΓòÉΓòÉΓòÉ 5.6. DevQueryDeviceNames ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DevQueryDeviceNames ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DevQueryDeviceNames ΓòÉΓòÉΓòÉ

hab (HAB) - input
   Anchor-block handle.

pszDriverName (PSZ) - input
   Fully-qualified name of the file containing the presentation driver. The
   file-name extension is DRV.

pldn (PLONG) - input/output
   Maximum number of device names and descriptions that can be returned. pldn
   can have the following values:

   Zero
      The number of device names and descriptions supported is returned;
      aDeviceName and aDeviceDesc are not updated.

   Nonzero
      pldn is updated to the number returned in aDeviceName and aDeviceDesc;
      aDeviceName and aDeviceDesc are updated.

aDeviceName (PSTR32) - output
   Device-name array. An array of null-terminated strings, each element of
   which identifies a particular device. Valid names are defined by
   presentation drivers.

aDeviceDesc (PSTR64) - output
   Device-description array. An array of null-terminated strings, each element
   of which is a description of a particular device. Valid descriptions are
   defined by presentation drivers.

pldt (PLONG) - input/output
   Maximum number of data types that can be returned. pldt can have the
   following values:

   Zero
      The number of data types supported is returned, and aDataType is not
      updated.

   Nonzero
      pldt is updated to the number returned, and aDataType is updated.

aDataType (PSTR16) - output
   Data type array. An array of null-terminated strings, each element of which
   identifies a data type. Valid data types are defined by presentation
   drivers.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DevQueryDeviceNames ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator:

   TRUE
      Successful completion

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DevQueryDeviceNames ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INV_LENGTH_OR_COUNT
   An invalid length or count parameter was specified.


ΓòÉΓòÉΓòÉ <hidden> Notes - DevQueryDeviceNames ΓòÉΓòÉΓòÉ

An application can first call this function with pldn and pldt set to 0 to find
how much storage is needed for the data areas. Having allocated the storage,
the application calls the function a second time for the data to be entered.

'HP Laserjet IID' is an example of a device name, 'Hewlett-Packard Laserjet
IID' is an example of a device description, and 'PM_Q_STD' is an example of a
data type.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DevQueryDeviceNames ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function causes a presentation     */
/* driver to return the names,             */
/* descriptions, and data types of the     */
/* devices it supports.                    */
/*******************************************/

#define INCL_DEV   /* Or use INCL_PM */
#include <os2.h>

HAB     hab;             /* Anchor-block handle */
PSZ     pszDriverName;   /* Fully-qualified name of the file containing the presentation driver */
PLONG   pldn;            /* Maximum number of device names and descriptions that can be returned */
PSTR32  aDeviceName;     /* Device-name array */
PSTR64  aDeviceDesc;     /* Device-description array */
PLONG   pldt;            /* Maximum number of data types that can be returned */
PSTR16  aDataType;       /* Data type array */
BOOL    fSuccess;        /* Success indicator */

fSuccess = DevQueryDeviceNames(hab,
             pszDriverName, pldn,
             aDeviceName, aDeviceDesc, pldt,
             aDataType);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DevQueryDeviceNames ΓòÉΓòÉΓòÉ

Related Functions

o DevQueryCaps
o DevQueryHardcopyCaps


ΓòÉΓòÉΓòÉ <hidden> Example Code - DevQueryDeviceNames ΓòÉΓòÉΓòÉ

 This example uses DevQueryDeviceNames to return the names, descriptions, and
data types of supported devices for a presentation driver.  The first call to
DevQueryDeviceNames determines the number of names, description, and data types
available; after allocating the arrays, the second call actually returns the
information in the arrays.


#define INCL_DEV                /* Device Function definitions  */
#define INCL_DOSMEMMGR          /* DOS Memory Manager Functions */
#include <os2.h>

BOOL  fSuccess;         /* success indicator                    */
HAB   hab;              /* Anchor-block handle                  */
LONG  pldn = 0L;        /* number of device names/descriptions  */
LONG  pldt = 0L;        /* number of data types                 */
PSTR32 aDeviceName;     /* array of device names                */
PSTR64 aDeviceDesc;     /* array of device descriptions         */
PSTR16 aDataType;       /* array of data types                  */

/* query number of supported names/descriptions/data types
   (pldn & pldt both 0) */
fSuccess = DevQueryDeviceNames(hab, "IBM4201.DRV", &pldn,
                               aDeviceName, aDeviceDesc, &pldt,
                               aDataType);

if (fSuccess)
   {
   /* allocate arrays */
   DosAllocMem((VOID *)aDeviceName, (ULONG)pldn*sizeof(STR32),
               PAG_COMMIT | PAG_WRITE);
   DosAllocMem((VOID *)aDeviceDesc, (ULONG)pldn*sizeof(STR64),
               PAG_COMMIT | PAG_WRITE);
   DosAllocMem((VOID *)aDataType, (ULONG)pldt*sizeof(STR16),
               PAG_COMMIT | PAG_WRITE);

   /* query supported device information */
   fSuccess = DevQueryDeviceNames(hab, "IBM4201.DRV", &pldn,
                                  aDeviceName, aDeviceDesc, &pldt,
                                  aDataType);
   }


ΓòÉΓòÉΓòÉ 5.7. DevQueryHardcopyCaps ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DevQueryHardcopyCaps ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DevQueryHardcopyCaps ΓòÉΓòÉΓòÉ

hdc (HDC) - input
   Device-context handle.

lStartForm (LONG) - input
   Start-forms code. Forms-code number from which the query is to start.  The
   first forms code has the value 0. lStartForm is used with lForms.

lForms (LONG) - input
   Number of forms to query. If 0, the number of forms codes defined is
   returned.  If greater than zero, this function returns the number of forms
   codes for which information is returned.

   For example, if there are five forms codes defined, and lStartForm = 2 and
   lForms  = 3, a query is performed for forms codes 2, 3, and 4. The result is
   returned in the buffer pointed to by phciHcInfo.

phciHcInfo (PHCINFO) - output
   Hard-copy capabilities information. A buffer containing the results of the
   query.  The result consists of lForms copies of the HCINFO structure.

   At least one of the defined forms codes must have the HCAPS_CURRENT bit set.
   There might be more than one with either the HCAPS_CURRENT or the
   HCAPS_SELECTABLE bits set.

   For a job to be selected by the spooler for printing, each one of the forms
   specified in the FORM spooler parameter (see pszSpoolerParams in
   DEVOPENSTRUC) must be either HCAPS_CURRENT or HCAPS_SELECTABLE. In other
   cases, the spooler holds the job with a "forms mismatch" error.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DevQueryHardcopyCaps ΓòÉΓòÉΓòÉ

lFormsReturned (LONG) - return
   Details of forms:

   DQHC_ERROR
                  Error.

   >=0
                  If lForms equals 0, number of forms available.
                  If lForms does not equal 0, number of forms returned.


ΓòÉΓòÉΓòÉ <hidden> Errors - DevQueryHardcopyCaps ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INV_HDC
   An invalid device-context handle or (micro presentation space)
   presentation-space handle was specified.

PMERR_INV_FORMS_CODE
   An invalid forms code parameter was specified with DevQueryHardcopyCaps.

PMERR_INV_LENGTH_OR_COUNT
   An invalid length or count parameter was specified.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DevQueryHardcopyCaps ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function queries the hard-copy     */
/* capabilities of a device.               */
/*******************************************/

#define INCL_DEV   /* Or use INCL_PM */
#include <os2.h>

HDC      hdc;               /* Device-context handle */
LONG     lStartForm;        /* Start-forms code */
LONG     lForms;            /* Number of forms to query */
PHCINFO  phciHcInfo;        /* Hard-copy capabilities information */
LONG     lFormsReturned;    /* Details of forms */

lFormsReturned = DevQueryHardcopyCaps(hdc,
                   lStartForm, lForms,
                   phciHcInfo);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DevQueryHardcopyCaps ΓòÉΓòÉΓòÉ

Prerequisite Functions

o DevOpenDC

Related Functions

o DevQueryCaps
o DevQueryDeviceNames


ΓòÉΓòÉΓòÉ <hidden> Example Code - DevQueryHardcopyCaps ΓòÉΓòÉΓòÉ

The height and width of the capability of the output device is queried for each
form code available. Note that a valid device context handle must be passed.
This example assumes a DevOpenDC call has been made to obtain the device
context handle of a say a printer.

#define INCL_DEV
#include <OS2.H>

HDC hdc;
LONG lStartForm;      /* Form code number from which the query */
                      /* is to start                           */
LONG lForms;          /* number of forms to query              */
/* array of structures containing return information. */
HCINFO ahciHcInfo[5];
LONG lreturn;
int i;
HCINFO height[5];
HCINFO width[5];

lStartForm = 0L;
lForms = 0L;           /* the actual number of forms codes is */
                       /* returned. There will be lreturn      */
                       /* copies of the HINFO structure.       */

lreturn = DevQueryHardcopyCaps(hdc,
                               lStartForm,
                               lForms,
                               ahciHcInfo);
if (lreturn > 5)
{
 lreturn = 5L;        /* we only want the first five form codes */
}                     /* if there are more than five            */

for(i = 0; i < lreturn; i++)
{
 width[lreturn].cx = ahciHcInfo[lreturn].cx;
 height[lreturn].cy = ahciHcInfo[lreturn].cy;
}


ΓòÉΓòÉΓòÉ 6. Direct Manipulation Functions ΓòÉΓòÉΓòÉ

This section describes functions that an application would use to initiate or
participate in a direct manipulation operation.


ΓòÉΓòÉΓòÉ 6.1. DrgAcceptDroppedFiles ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgAcceptDroppedFiles ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgAcceptDroppedFiles ΓòÉΓòÉΓòÉ

Hwnd (HWND) - input
   Window handle. Handle of calling window.

pPath (PSZ) - input
   Directory. Directory in which to place the dropped files. If NULL, the files
   are placed in the current directory.

pTypes (PSZ) - input
   List of types. A list of types that are acceptable to the drop. This string
   is of the form: type[,type...].

   When this pointer is NULL, any type of file will be accepted.

ulDefaultOp (ULONG) - input
   Default drag operation. Default drag operation for this window. The
   operation is either DO_MOVE or DO_COPY.

ulReserved (ULONG) - input
   Reserved.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgAcceptDroppedFiles ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgAcceptDroppedFiles ΓòÉΓòÉΓòÉ

This function handles the file direct manipulation protocol for a given window.
The window responds (DOR_DROP, usDefaultOp) to DM_DRAGOVER messages for items
with a type matching the acceptable type string and with a rendering mechanism
and format of <DRM_OS2FILE,DRF_UNKNOWN>. Not all dragged objects must match
this criteria for the drop to be acceptable.

After the drop occurs, this function handles the conversation required to
complete the direct manipulation operation for all acceptable objects. A
DM_ENDCONVERSATION (DMFL_TARGETFAIL) message is sent to the source when an
object is unacceptable.

When an error occurs during a move or copy, the caller is sent a DM_DRAGERROR
message.  The caller can take corrective action.

As the move or copy operation is successfully completed for each file, a
DM_DRAGFILECOMPLETE message is sent to the caller. No message is sent when the
operation fails.

The function returns TRUE if the operation is successful and FALSE if an error
occurs.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgAcceptDroppedFiles ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function handles the file direct   */
/* manipulation protocol for a given       */
/* window.                                 */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

HWND   Hwnd;         /* Window handle */
PSZ    pPath;        /* Directory */
PSZ    pTypes;       /* List of types */
ULONG  ulDefaultOp;  /* Default drag operation */
ULONG  ulReserved;   /* Reserved */
BOOL   fSuccess;     /* Success indicator */

fSuccess = DrgAcceptDroppedFiles(Hwnd,
             pPath, pTypes, ulDefaultOp,
             ulReserved);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgAcceptDroppedFiles ΓòÉΓòÉΓòÉ

Related Functions

o DrgDragFiles


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgAcceptDroppedFiles ΓòÉΓòÉΓòÉ

This example uses the DrgAcceptDroppedFiles function to define the direct
manipulation protocol of the given window, accept all file types, and use the
current directory as the drop directory.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>

BOOL   fSuccess;        /* Indicate success or failure          */
HWND   Hwnd;            /* Handle of calling window             */
PSZ    pszPath;         /* Directory in which to place the      */
                        /* dropped files                        */
PSZ    pszTypes;        /* A list of types that are acceptable  */
ULONG  ulDefaultOp;     /* Default drag operation               */

pszPath = NULL;         /* Drop file in current directory       */
pszTypes = NULL;        /* Accept any file type                 */
ulDefaultOp = DO_MOVE;  /* Default drag operation is move       */

fSuccess = DrgAcceptDroppedFiles(Hwnd, pszPath, pszTypes,
                                 ulDefaultOp, 0);


ΓòÉΓòÉΓòÉ 6.2. DrgAccessDraginfo ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgAccessDraginfo ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgAccessDraginfo ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - input
   Pointer. Pointer to the DRAGINFO structure.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgAccessDraginfo ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgAccessDraginfo ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_ACCESS_DENIED
   The memory block was not allocated properly.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgAccessDraginfo ΓòÉΓòÉΓòÉ

This function is used by the target of a drag operation to access a DRAGINFO
structure. The address of the structure is passed in a drag message
(DM_DRAGOVER, DM_DROP, or DM_DROPHELP).

To release the structure, use the DrgFreeDraginfo function.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgAccessDraginfo ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function accesses a DRAGINFO       */
/* structure.                              */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGINFO  pDraginfo;      /* Pointer */
BOOL       fSuccess;       /* Success indicator */

fSuccess = DrgAccessDraginfo(pDraginfo);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgAccessDraginfo ΓòÉΓòÉΓòÉ

Related Functions

o DrgAllocDraginfo
o DrgDrag
o DrgFreeDraginfo
o DrgPushDraginfo


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgAccessDraginfo ΓòÉΓòÉΓòÉ

This example uses the DrgAccessDraginfo function to make an existing drag
information structure (created by the DrgAllocDraginfo function) available.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <os2.h>

BOOL      fSuccess;      /* Indicate success or failure          */
DRAGINFO  Draginfo;      /* Drag-information structure           */

fSuccess = DrgAccessDraginfo(&Draginfo);


ΓòÉΓòÉΓòÉ 6.3. DrgAddStrHandle ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgAddStrHandle ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgAddStrHandle ΓòÉΓòÉΓòÉ

pString (PSZ) - input
   String. String for which a handle is to be created.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgAddStrHandle ΓòÉΓòÉΓòÉ

Hstr (HSTR) - return
   String handle.

   NULLHANDLE
      Error occurred.

   Other
      String handle created.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgAddStrHandle ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.

PMERR_RESOURCE_DEPLETION
   An internal resource depletion error has occurred.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgAddStrHandle ΓòÉΓòÉΓòÉ

The handle can be used by any application to reference the input string.

This function must be called by the source of a drag whenever a string is to be
passed in a DRAGINFO structure.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgAddStrHandle ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function creates a handle to a     */
/* string.                                 */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PSZ   pString; /* String */
HSTR  Hstr;    /* String handle */

Hstr = DrgAddStrHandle(pString);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgAddStrHandle ΓòÉΓòÉΓòÉ

Related Functions

o DrgDeleteStrHandle
o DrgQueryStrName


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgAddStrHandle ΓòÉΓòÉΓòÉ

This example calls the DrgAddStrHandle function to create handles for strings
that are used in a DRAGITEM structure.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions  */
#include <os2.h>

USHORT   ID_ITEM = 1;   /* Drag item identifier                  */
HWND     hwnd;          /* Window handle                         */
DRAGITEM ditem;         /* DRAGITEM structure                    */

                        /* Initialize the DRAGITEM structure     */
ditem.hwndItem = hwnd;          /* Conversation partner          */
ditem.ulItemID = ID_ITEM;       /* Identifies item being dragged */
ditem.hstrType = DrgAddStrHandle(DRT_TEXT);     /*  Item is text */
ditem.hstrRMF = DrgAddStrHandle("<DRM_OS2FILE,DRF_TEXT>");
ditem.hstrContainerName = DrgAddStrHandle("C:\\");
ditem.hstrSourceName = DrgAddStrHandle("C:\\CONFIG.SYS");
ditem.hstrTargetName = DrgAddStrHandle("C:\\OS2\\CONFIG.SYS");
ditem.cxOffset = 0;             /* X-offset of the origin of the */
                                /* image from the pointer hotspot*/
ditem.cyOffset = 0;             /* Y-offset of the origin of the */
                                /* image from the pointer hotspot*/
ditem.fsControl = 0;            /* Source item control flags     */
                                /* object is open                */
ditem.fsSupportedOps = 0;


ΓòÉΓòÉΓòÉ 6.4. DrgAllocDraginfo ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgAllocDraginfo ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgAllocDraginfo ΓòÉΓòÉΓòÉ

cDitem (ULONG) - input
   Number of objects. Number of objects being dragged. This number must be
   greater than 0.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgAllocDraginfo ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - return
   Pointer. Pointer to the DRAGINFO structure.

   NULL
      Error occurred.

   Other
      The DRAGINFO structure.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgAllocDraginfo ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INSUFFICIENT_MEMORY
   The operation terminated through insufficient memory.

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgAllocDraginfo ΓòÉΓòÉΓòÉ

This function must be called before the DrgDrag function is called.

The caller can define a default operation for the objects represented by the
DRAGINFO structure by modifying the usOperation field. If the usOperation field
is modified, the new value will be sent to the target as the operation whenever
a DO_DEFAULT operation would normally be sent. The caller should not modify any
other part of the DRAGINFO structure. The DRAGITEM structures associated with
the DRAGINFO structure should only be altered with DrgSetDragitem or by using a
pointer obtained with DrgQueryDragitemPtr.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgAllocDraginfo ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function allocates a DRAGINFO      */
/* structure.                              */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

ULONG      cDitem;         /* Number of objects */
PDRAGINFO  pDraginfo;      /* Pointer */

pDraginfo = DrgAllocDraginfo(cDitem);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgAllocDraginfo ΓòÉΓòÉΓòÉ

Related Functions

o DrgAccessDraginfo
o DrgDrag
o DrgFreeDraginfo
o DrgPushDraginfo


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgAllocDraginfo ΓòÉΓòÉΓòÉ

This example calls the DrgAllocDraginfo function to create a Drag structure for
a single object and uses the new structure to set the DRAGITEM (DrgSetDragitem)
structure.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <os2.h>

PDRAGINFO  pdinfo;       /* Pointer to DRAGINFO structure        */
HWND       hwnd;         /* Handle of calling (source) window    */
BOOL       flResult;     /* Result indicator                     */
DRAGITEM   ditem;        /* DRAGITEM structure                   */

pdinfo = DrgAllocDraginfo(1); /* Create the DRAGINFO structure   */
                              /* Set the drag item               */
flResult= DrgSetDragitem(pdinfo, &ditem, (ULONG)sizeof(ditem), 0);


ΓòÉΓòÉΓòÉ 6.5. DrgAllocDragtransfer ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgAllocDragtransfer ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgAllocDragtransfer ΓòÉΓòÉΓòÉ

cdxfer (ULONG) - input
   Number of structures. Number of DRAGTRANSFER structures to be allocated.
   This number must be greater than 0.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgAllocDragtransfer ΓòÉΓòÉΓòÉ

pResult (PDRAGTRANSFER) - return
   Pointer. Pointer to an array of DRAGTRANSFER structures.

   NULL
      Error occurred.

   Other
      The array of DRAGTRANSFER structures.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgAllocDragtransfer ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_MEMORY_ALLOCATION_ERR
   An error occurred during memory management.

PMERR_INSUFFICIENT_MEMORY
   The operation terminated through insufficient memory.

PMERR_PARAMETER_OUT_OF_RANGE
   The value of a parameter was not within the defined valid range for that
   parameter.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgAllocDragtransfer ΓòÉΓòÉΓòÉ

This function must be called before sending a DM_RENDER message.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgAllocDragtransfer ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function allocates a specified     */
/* number of DRAGTRANSFER structures from  */
/* a single segment.                       */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

ULONG          cdxfer;           /* Number of structures */
PDRAGTRANSFER  pResult;          /* Pointer */

pResult = DrgAllocDragtransfer(cdxfer);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgAllocDragtransfer ΓòÉΓòÉΓòÉ

Related Functions

o DrgFreeDragtransfer
o DrgSendTransferMsg


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgAllocDragtransfer ΓòÉΓòÉΓòÉ

This example calls the DrgAllocDragtransfer function to allocate a single
DRAGTRANSFER structure and adds a pointer to a DRAGITEM structure for an object
that will be transferred.

#define INCL_WINSTDDRAG   /* Direct Manipulation (Drag) Functions*/
#include <os2.h>

PDRAGTRANSFER  pResult;   /* Pointer to DRAGTRANSFER structure   */
PDRAGITEM      pDragitem; /* Pointer to DRAGITEM structure       */

pResult = DrgAllocDragtransfer(1);

if (pResult != NULL)      /* Indicate DRAGITEM to be transferred */
    pResult->pditem = pDragitem;


ΓòÉΓòÉΓòÉ 6.6. DrgDeleteDraginfoStrHandles ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgDeleteDraginfoStrHandles ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgDeleteDraginfoStrHandles ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - input
   Pointer. Pointer to the DRAGINFO structure that contains string handles to
   delete.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgDeleteDraginfoStrHandles ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgDeleteDraginfoStrHandles ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgDeleteDraginfoStrHandles ΓòÉΓòÉΓòÉ

Using this function is equivalent to calling the DrgDeleteStrHandle function
for each unique string in a DRAGINFO structure.

This function must be called by the target of a direct manipulation operation
either:

o After processing a DM_DROPHELP message
  or
o After completing the direct manipulation operation begun as a result of a
  DM_DROP message.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgDeleteDraginfoStrHandles ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function deletes each unique       */
/* string handle in a DRAGINFO structure.  */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGINFO  pDraginfo;      /* Pointer */
BOOL       fSuccess;       /* Success indicator */

fSuccess = DrgDeleteDraginfoStrHandles(
             pDraginfo);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgDeleteDraginfoStrHandles ΓòÉΓòÉΓòÉ

Related Functions

o DrgDeleteStrHandle


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgDeleteDraginfoStrHandles ΓòÉΓòÉΓòÉ

This example calls the DrgDeleteDraginfoStrHandles function to delete all
unique string handles associated with the specified DRAGINFO structure
(previously allocated by the DrgAllocDraginfo function).

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>

BOOL      fSuccess;     /* Indicate success or failure          */
DRAGINFO  Draginfo;     /* DRAGINFO structure containing string */
                        /* handles to delete                    */

fSuccess = DrgDeleteDraginfoStrHandles (&Draginfo);


ΓòÉΓòÉΓòÉ 6.7. DrgDeleteStrHandle ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgDeleteStrHandle ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgDeleteStrHandle ΓòÉΓòÉΓòÉ

Hstr (HSTR) - input
   String handle. The string handle to delete.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgDeleteStrHandle ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgDeleteStrHandle ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgDeleteStrHandle ΓòÉΓòÉΓòÉ

This function must be used to delete a string handle created by the
DrgAddStrHandle function.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgDeleteStrHandle ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function deletes a string handle.  */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

HSTR  Hstr;     /* String handle */
BOOL  fSuccess; /* Success indicator */

fSuccess = DrgDeleteStrHandle(Hstr);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgDeleteStrHandle ΓòÉΓòÉΓòÉ

Related Functions

o DrgAddStrHandle
o DrgDeleteDraginfoStrHandles


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgDeleteStrHandle ΓòÉΓòÉΓòÉ

This example calls the DrgDeleteStrHandle function to delete an existing string
handle (returned by a previous call to the DrgAddStrHandle function).

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>

BOOL  fSuccess;         /* Indicate success or failure          */
HSTR  Hstr;             /* String handle                        */

fSuccess = DrgDeleteStrHandle (Hstr);


ΓòÉΓòÉΓòÉ 6.8. DrgDrag ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgDrag ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgDrag ΓòÉΓòÉΓòÉ

hwndSource (HWND) - input
   Window handle. Handle of the window calling DrgDrag. This window is the
   source of the drag.

pDraginfo (PDRAGINFO) - input/output
   Pointer. Pointer to the DRAGINFO structure.

pdimg (PDRAGIMAGE) - input
   Pointer. Pointer to an array of DRAGIMAGE structures. These structures
   describe the images that are to be drawn under the pointing device pointer
   during the drag.

cdimg (ULONG) - input
   Array size. Size of the pdimg array.

vkTerminate (LONG) - input
   Pointing device button. Pointing device button that ends the drag operation.

   VK_BUTTON1
      Release of button 1 ends the drag.

   VK_BUTTON2
      Release of button 2 ends the drag.

   VK_BUTTON3
      Release of button 3 ends the drag.

   VK_ENDDRAG
      Release of the system-defined direct manipulation button ends the drag.
      This is the recommended value if the DrgDrag function call is invoked in
      response to a WM_BEGINDRAG message.

pReserved (PVOID) - input
   Reserved. Must be set to NULL by the caller.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgDrag ΓòÉΓòÉΓòÉ

hwndDest (HWND) - return
   Window handle. Handle of window on which the dragged objects were dropped.

   NULL
      Error occurred.

   Other
      Window handle.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgDrag ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_HWND
   An invalid window handle was specified.

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.

PMERR_INSUFFICIENT_MEMORY
   The operation terminated through insufficient memory.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgDrag ΓòÉΓòÉΓòÉ

This function:

o Initiates a direct manipulation operation
o Uses the input image to provide visual feedback to the user
o Notifies other windows as the dragged object passes over
o Notifies the destination if the object is dropped.

DrgDrag is called when the system-defined direct-manipulation button is pressed
while the pointer is over a window and a pointing device movement follows.  As
the pointer moves over a potential target, a DM_DRAGOVER message is sent to the
target. When the pointer moves from one target window to another, a
DM_DRAGLEAVE message is sent to the former target.

If the pointer is over a valid target when the direct-manipulation button is
released, a DM_DROP message is sent to the target.

Before the DM_DROP message is sent, the cxOffset and cyOffset fields are copied
from the DRAGIMAGE structures to the corresponding fields in the DRAGITEM
structures.  The values from the first DRAGIMAGE are copied to the first
DRAGITEM, from the second DRAGIMAGE to the second DRAGITEM, and so on. The
target can use this information to place the images in the same spatial
relationship after the drop.  If there are more DRAGITEM structures than there
are DRAGIMAGE structures, the cxOffset and cyOffset from the final DRAGIMAGE
are placed in each of the remaining DRAGITEM structures.

The caller can define a default operation for the objects represented by the
DRAGINFO structure by modifying the usOperation field. If the usOperation field
is modified, the new value will be sent to the target as the operation whenever
a DO_DEFAULT operation would normally be sent. The caller should not modify any
other part of the DRAGINFO structure. The DRAGITEM structures associated with
the DRAGINFO structure should only be altered with DrgSetDragitem or by using a
pointer obtained with DrgQueryDragitemPtr.

The following keys are active during the drag operation:

Esc       The drag operation is canceled.
F1        A DM_DROPHELP message is posted to the target so that it can provide
          context help for the drag operation.  The drag operation is canceled.

Before invoking DrgDrag, the caller is responsible for:

o Obtaining a DRAGINFO structure using DrgAllocDraginfo
o Initializing the DRAGITEM structures using DrgSetDragitem.

On return from DrgDrag, the caller must free the structure using
DrgFreeDraginfo.

If the dragged objects are not dropped, NULL is returned.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgDrag ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function performs a drag operation.*/
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

HWND        hwndSource;        /* Window handle */
PDRAGINFO   pDraginfo;         /* Pointer */
PDRAGIMAGE  pdimg;             /* Pointer */
ULONG       cdimg;             /* Array size */
LONG        vkTerminate;       /* Pointing device button */
PVOID       pReserved;         /* Reserved */
HWND        hwndDest;          /* Window handle */

hwndDest = DrgDrag(hwndSource, pDraginfo,
             pdimg, cdimg, vkTerminate,
             pReserved);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgDrag ΓòÉΓòÉΓòÉ

Prerequisite Functions

o DrgAllocDraginfo

Related Functions

o DrgFreeDraginfo
o DrgSetDragitem


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgDrag ΓòÉΓòÉΓòÉ

This example uses the DrgDrag function to drag a single object in response to
the direct-manipulation button being pressed while the pointer is over a drag
object. The example shows the initialization of the DRAGITEM, DRAGINFO, and
DRAGIMAGE structures used by the DrgDrag function.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions  */
#define INCL_WININPUT   /* Window Input Functions                */
#include <os2.h>

PDRAGINFO pdinfo;       /* Pointer to DRAGINFO structure         */
HWND      hwnd;         /* Handle of calling (source) window     */
BOOL      flResult;     /* Result indicator                      */
DRAGITEM  ditem;        /* DRAGITEM structure                    */
DRAGIMAGE dimg;         /* DRAGIMAGE structure                   */
HBITMAP   hbm;          /* Bit-map handle                        */
HWND      hwndDrop;     /* Handle of drop (target) window        */

case WM_BEGINDRAG:

    /*************************************************************/
    /* Initialize the DRAGITEM structure                         */
    /*************************************************************/
    ditem.hwndItem = hwnd;       /* Conversation partner         */
    ditem.ulItemID = ID_ITEM;    /* Identifies item being dragged*/
    ditem.hstrType = DrgAddStrHandle(DRT_TEXT);   /* Text item   */
    ditem.hstrRMF = DrgAddStrHandle("<DRM_OS2FILE,DRF_TEXT>");
    ditem.hstrContainerName = DrgAddStrHandle("C:\\");
    ditem.hstrSourceName = DrgAddStrHandle("C:\\CONFIG.SYS");
    ditem.hstrTargetName = DrgAddStrHandle("C:\\OS2\\CONFIG.SYS");
    ditem.cxOffset = 0;          /* X-offset of the origin of    */
                                 /* the image from the pointer   */
                                 /* hotspot                      */
    ditem.cyOffset = 0;          /* Y-offset of the origin of    */
                                 /* the image from the pointer   */
                                 /* hotspot                      */
    ditem.fsControl = 0;         /* Source item control flags    */
                                 /* object is open               */
    ditem.fsSupportedOps = 0;

    /*************************************************************/
    /* Create the DRAGINFO structure                             */
    /*************************************************************/
    pdinfo = DrgAllocDraginfo(1);
    if (!pdinfo) return (FALSE); /* If allocation fails,         */
                                 /* return FALSE                 */

    /*************************************************************/
    /* Initialize the DRAGIMAGE structure                        */
    /*************************************************************/
    dimg.cb = sizeof(DRAGIMAGE); /* Size control block           */
    dimg.cptl        = 0;
    dimg.hImage = hbm;           /* Image handle passed to       */
                                 /* DrgDrag                      */
    dimg.sizlStretch.cx = 20L;   /* Size to stretch ico or bmp to*/
    dimg.sizlStretch.cy = 20L;
    dimg.fl = DRG_BITMAP |       /* Flags passed to DrgDrag      */
              DRG_STRETCH;       /* Stretch to size specified    */
                                 /* in sizlStretch               */
    dimg.cxOffset = 0;           /* Offset of the origin of      */
    dimg.cyOffset = 0;           /* the image from the pointer   */
                                 /* hotspot                      */

    /*************************************************************/
    /* Set the drag item                                         */
    /*************************************************************/
    flResult= DrgSetDragitem(pdinfo, &ditem, (ULONG)sizeof(ditem),
                             0);

    /*************************************************************/
    /* Perform the drag operation:                               */
    /* - Give the user a visual cue by changing the pointer to a */
    /*   bit map                                                 */
    /* - Send DM_DRAGOVER messages to the target window (in this */
    /*   case it is also the source)                             */
    /*************************************************************/
    hwndDrop = DrgDrag(hwnd,   /* Source of the drag             */
                pdinfo,        /* Pointer to DRAGINFO structure  */
               (PDRAGIMAGE)&dimg, /* Drag image                  */
                1,             /* Size of the pdimg array        */
                VK_ENDDRAG,    /* Release of direct-manipulation */
                               /* button ends the drag           */
                NULL);         /* Reserved                       */


ΓòÉΓòÉΓòÉ 6.9. DrgDragFiles ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgDragFiles ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgDragFiles ΓòÉΓòÉΓòÉ

Hwnd (HWND) - input
   Window handle. Handle of calling window.

pFiles (PAPSZ) - input
   File names. The names of the files to be dragged.

pTypes (PAPSZ) - input
   File types. The file types of the files to be dragged.

pTargets (PAPSZ) - input
   Target file names.

cFiles (ULONG) - input
   Number of files. Number of files to be dragged.

hptrDrag (HPOINTER) - input
   Icon. Icon to display during the drag.

vkTerminate (ULONG) - input
   Button. Button that ends the drag.

fSourceRender (BOOL) - input
   Flag. Flag to indicate whether the source must perform the move or copy.

   TRUE
      The caller will receive a DM_RENDERFILE message for each file.

   FALSE
      All file manipulation is performed by DrgDragFiles.

ulReserved (ULONG) - input
   Reserved.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgDragFiles ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      The drag operation was initiated successfully.

   FALSE
      An error occurred.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgDragFiles ΓòÉΓòÉΓòÉ

This function begins a direct manipulation operation for one or more files.
DRAGINFO and DRAGITEM structures are allocated and initialized, and are then
used as input to DrgDrag.  All of the post-drag conversation required to
complete the direct manipulation operation is handled by an object window
created by this function.

The caller should set fSourceRender to TRUE if it must perform the file
manipulation for any of these files.  When fSourceRender is TRUE, the caller
receives a DM_RENDERFILE message as the drag-object window receives a DM_RENDER
message. The caller should move or copy the file after receiving the
DM_RENDERFILE message.  The caller should then send a DM_FILERENDERED message
to the drag-object window, and the drag-object window should send a
DM_RENDERCOMPLETE message to the target.

When pTypes is NULL, the .TYPE EA is interrogated to determine the type for
each file in pFiles.  When pTypes is not NULL, the size of the array is
expected to be the same as the size of pFiles.  When any individual pointer in
the array is NULL, the .TYPE EA for the corresponding file is read. When .TYPE
EA does not exist for any file for which it is needed, a type of DRT_UNKNOWN is
used.

When pTargets is NULL, the target name for a file will be the same as the
source file name with the path information removed. If pTargets is not NULL,
the size of the array is expected to be the same as the size of pFiles.  If any
individual pointer in the array is NULL, the target name for the corresponding
file will match the source name minus the path information.

The rendering mechanism and format for each file is: <DRM_OS2FILE,DRF_UNKNOWN>.

When an error occurs during the move or copy, the caller is sent a DM_DRAGERROR
message.  The caller can take corrective action.

As the operation is complete for each file in the list, a DM_DRAGFILECOMPLETE
message is sent to the caller of DrgDragFiles.  The caller is thus notified
that resources can be freed for a particular file.

This function returns TRUE if the drag operation was initiated successfully and
FALSE if an error occurred.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgDragFiles ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function begins a direct           */
/* manipulation operation for one or more  */
/* files.                                  */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

HWND      Hwnd;              /* Window handle */
PAPSZ     pFiles;            /* File names */
PAPSZ     pTypes;            /* File types */
PAPSZ     pTargets;          /* Target file names */
ULONG     cFiles;            /* Number of files */
HPOINTER  hptrDrag;          /* Icon */
ULONG     vkTerminate;       /* Button */
BOOL      fSourceRender;     /* Flag */
ULONG     ulReserved;        /* Reserved */
BOOL      fSuccess;          /* Success indicator */

fSuccess = DrgDragFiles(Hwnd, pFiles,
             pTypes, pTargets, cFiles,
             hptrDrag, vkTerminate,
             fSourceRender, ulReserved);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgDragFiles ΓòÉΓòÉΓòÉ

Related Functions

o DrgAcceptDroppedFiles


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgDragFiles ΓòÉΓòÉΓòÉ

This example calls the DrgDragFiles function to begin direct manipulation for a
single file object, using the same source and target name, and determining the
file type based on the file's type EA.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#define INCL_WININPUT   /* Window Input Functions               */
#include <os2.h>

BOOL     fSuccess;      /* Indicate success or failure          */
HWND     Hwnd;          /* Handle of calling window             */
PSZ      pFiles[1];     /* The names of the files to be dragged */
PSZ      pTypes[1];     /* The file types of the files to be    */
                        /* dragged                              */
PSZ      pTargets[1];   /* The target file names                */
HPOINTER hptrDrag;      /* Icon to display during drag          */

pFiles[0] = "FILENAME.EXT";  /* Copy file name to string array  */
pTargets[0] = NULL;     /* Use source name as target name       */
pTypes[0] = NULL;       /* Query type EA to determine file type */

fSuccess = DrgDragFiles(Hwnd, pFiles, pTypes, pTargets, 1,
                        hptrDrag, VK_BUTTON2, FALSE, 0L);


ΓòÉΓòÉΓòÉ 6.10. DrgFreeDraginfo ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgFreeDraginfo ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgFreeDraginfo ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - input
   Pointer. Pointer to the DRAGINFO structure.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgFreeDraginfo ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgFreeDraginfo ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_MEMORY_DEALLOCATION_ERR
   An error occurred during memory management.

PMERR_SOURCE_SAME_AS_TARGET
   The direct manipulation source and target process are the same.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgFreeDraginfo ΓòÉΓòÉΓòÉ

DrgFreeDraginfo fails with an error of PMERR_SOURCE_SAME_AS_TARGET if it is
called by the process that called DrgDrag before DrgDrag returns. When a
process is performing a drag operation between two of its own windows, this
prevents the source window from freeing the DRAGINFO structure before the
target window finishes processing.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgFreeDraginfo ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function frees a DRAGINFO          */
/* structure allocated by DrgAllocDraginfo.*/
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGINFO  pDraginfo;      /* Pointer */
BOOL       fSuccess;       /* Success indicator */

fSuccess = DrgFreeDraginfo(pDraginfo);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgFreeDraginfo ΓòÉΓòÉΓòÉ

Prerequisite Functions

o DrgAllocDraginfo

Related Functions

o DrgAccessDraginfo
o DrgDrag
o DrgPushDraginfo


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgFreeDraginfo ΓòÉΓòÉΓòÉ

This example calls the DrgFreeDraginfo function to free an existing DRAGINFO
structure allocated by the DrgAllocDraginfo function after a drag operation has
completed.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>

BOOL       fSuccess;    /* Indicate success or failure          */
PDRAGINFO  pdinfo;      /* Pointer to DRAGINFO structure        */
HWND       hwnd;        /* Handle of calling (source) window    */
DRAGIMAGE  dimg;        /* DRAGIMAGE structure                  */
HWND       hwndDrop;    /* Handle of drop (target) window       */

/****************************************************************/
/* Perform the drag operation:                                  */
/* - Give the user a visual cue by changing the pointer to a    */
/*   bit map                                                    */
/* - Send DM_DRAGOVER messages to the target window (in this    */
/*   case it is also the source)                                */
/****************************************************************/
hwndDrop = DrgDrag(hwnd,      /* Source of the drag             */
            pdinfo,           /* Pointer to DRAGINFO structure  */
           (PDRAGIMAGE)&dimg, /* Drag image                     */
            1,                /* Size of the pdimg array        */
            VK_ENDDRAG,       /* Release of drag button         */
                              /* Terminates the drag            */
            NULL);            /* Reserved                       */

fSuccess = DrgFreeDraginfo(&pdinfo);


ΓòÉΓòÉΓòÉ 6.11. DrgFreeDragtransfer ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgFreeDragtransfer ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgFreeDragtransfer ΓòÉΓòÉΓòÉ

pdxfer (PDRAGTRANSFER) - input
   Pointer. Pointer to the DRAGTRANSFER structures to be freed.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgFreeDragtransfer ΓòÉΓòÉΓòÉ

Rc (BOOL) - return
   Return code.

   0
      The structure was freed.

   Other
      Deallocation failed.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgFreeDragtransfer ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_MEMORY_DEALLOCATION_ERR
   An error occurred during memory management.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgFreeDragtransfer ΓòÉΓòÉΓòÉ

This function frees the DRAGTRANSFER structures allocated by calls to
DrgAllocDragtransfer.  When all of the DRAGTRANSFER structures have been freed,
the memory block containing the DRAGTRANSFER array is deallocated.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgFreeDragtransfer ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function frees the storage         */
/* associated with a DRAGTRANSFER          */
/* structure.                              */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGTRANSFER  pdxfer;          /* Pointer */
BOOL           Rc;              /* Return code */

Rc = DrgFreeDragtransfer(pdxfer);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgFreeDragtransfer ΓòÉΓòÉΓòÉ

Related Functions

o DrgAllocDragtransfer


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgFreeDragtransfer ΓòÉΓòÉΓòÉ

This example calls the DrgFreeDragtransfer function to free an existing
DRAGTRANSFER structure allocated by the DrgAllocDragtransfer function.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>

BOOL          fSuccess; /* Indicate success or failure          */
DRAGTRANSFER  dxfer;    /* Pointer to DRAGTRANSFER structure    */

fSuccess = DrgFreeDragtransfer(&dxfer);


ΓòÉΓòÉΓòÉ 6.12. DrgGetPS ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgGetPS ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgGetPS ΓòÉΓòÉΓòÉ

Hwnd (HWND) - input
   Window handle. Handle of the window for which presentation space is
   required.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgGetPS ΓòÉΓòÉΓòÉ

Hps (HPS) - return
   Presentation-space handle. Presentation-space handle used for drawing in the
   window.

   NULLHANDLE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgGetPS ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_HWND
   An invalid window handle was specified.

PMERR_NOT_DRAGGING
   A drag operation is not in progress at this time.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgGetPS ΓòÉΓòÉΓòÉ

This function returns a handle to a presentation space that can be used for
drawing while a direct manipulation operation is in progress.

DrgGetPS is called only during a direct manipulation operation. This function
is called only after a DM_DRAGOVER, DM_DRAGLEAVE, or DM_DROP message has been
received.

In order to draw target emphasis, an application must use DrgGetPS and
DrgReleasePS to unlock its window.

The presentation space created with DrgGetPS must be freed with DrgReleasePS.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgGetPS ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function gets a presentation space */
/* that is used to provide target feedback */
/* to the user during a drag operation.    */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

HWND  Hwnd; /* Window handle */
HPS   Hps;  /* Presentation-space handle */

Hps = DrgGetPS(Hwnd);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgGetPS ΓòÉΓòÉΓòÉ

Related Functions

o DrgReleasePS


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgGetPS ΓòÉΓòÉΓòÉ

This example uses the DrgGetPS function to get a presentation space handle
which is used during drag operations such as loading a drag bit map. When
finished with the presentation space, release it with the DrgReleasePS
function.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>

HPS   hps;              /* Presentation space handle            */
HWND  hwnd;             /* Handle of the window for which       */
                        /* presentation space is required       */

case DM_DRAGOVER:
    hps = DrgGetPS(hwnd);

DrawTargetEmphasis(hps, hwnd);
DrgReleasePS(hps);


ΓòÉΓòÉΓòÉ 6.13. DrgPostTransferMsg ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgPostTransferMsg ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgPostTransferMsg ΓòÉΓòÉΓòÉ

hwndTo (HWND) - input
   Window handle. Window handle to which the message is to be posted:

   Target
      hwndItem in the DRAGITEM structure.

   Source
      hwndClient in the DRAGTRANSFER structure.

ulMsgid (ULONG) - input
   Message identifier. Identifier of the message to be posted.
   DM_RENDERCOMPLETE is the only valid message.

pdxfer (PDRAGTRANSFER) - input
   Pointer. Pointer to the DRAGTRANSFER structure.

fs (ULONG) - input
   Flags. The flags to be passed in the param2 parameter of the message.

ulReserved (ULONG) - input
   Reserved. This must be 0.

fRetry (BOOL) - input
   Retry indicator.

   TRUE
      If the destination queue is full, the message posting is retried at
      1-second intervals until the message is posted successfully.

      In this case, DrgPostTransferMsg dispatches any messages in the queue by
      calling WinPeekMsg and WinDispatchMsg in a loop.  The application can
      receive messages sent by other applications while it is trying to post
      drag transfer messages.

   FALSE
      The call returns FALSE without retrying.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgPostTransferMsg ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgPostTransferMsg ΓòÉΓòÉΓòÉ

The fsReply field in the DRAGTRANSFER structure is set to 0 before the message
is posted. If the posting fails for any reason, FALSE is returned.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgPostTransferMsg ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function posts a message to the    */
/* other application involved in the       */
/* direct manipulation operation.          */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

HWND           hwndTo;              /* Window handle */
ULONG          ulMsgid;             /* Message identifier */
PDRAGTRANSFER  pdxfer;              /* Pointer */
ULONG          fs;                  /* Flags */
ULONG          ulReserved;          /* Reserved */
BOOL           fRetry;              /* Retry indicator */
BOOL           fSuccess;            /* Success indicator */

fSuccess = DrgPostTransferMsg(hwndTo,
             ulMsgid, pdxfer, fs,
             ulReserved, fRetry);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgPostTransferMsg ΓòÉΓòÉΓòÉ

Related Functions

o DrgSendTransferMsg


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgPostTransferMsg ΓòÉΓòÉΓòÉ

This example calls the DrgPostTransferMsg function to respond to a DM_RENDER
message from the target. The response consists of a DM_RENDERCOMPLETE message,
plus a flag indicating whether the render was successful (DMFL_RENDEROK) or not
(DMFL_RENDERFAIL).

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions  */
#include <os2.h>

MPARAM        mp1;      /* Message parameter 1                   */
BOOL          fSuccess; /* Indicate success or failure           */
BOOL          Rendered; /* Success of render operation           */
PDRAGTRANSFER pdxfer;   /* Pointer to DRAGTRANSFER structure     */

case DM_RENDER:
   pdxfer = (PDRAGTRANSFER)PVOIDFROMMP(mp1); /* Get DRAGTRANSFER */
                                             /* structure        */

     /************************************************************/
     /* Attempt to render file                                   */
     /************************************************************/

     if (Rendered)
        {
        fSuccess = DrgPostTransferMsg(pdxfer->pditem,
                                      DM_RENDERCOMPLETE,
                                      pdxfer,
                                      DMFL_RENDEROK,
                                      0,FALSE);
        return (MRESULT)TRUE;
        }
     else
        {
        fSuccess = DrgPostTransferMsg(pdxfer->pditem,
                                      DM_RENDERCOMPLETE,
                                      pdxfer,
                                      DMFL_RENDERFAIL,
                                      0,FALSE);
        return (MRESULT)FALSE;
        }


ΓòÉΓòÉΓòÉ 6.14. DrgPushDraginfo ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgPushDraginfo ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgPushDraginfo ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - input
   Pointer. Pointer to the DRAGINFO structure.

hwndDest (HWND) - input
   Window handle. Handle of the window whose process is to be given access to a
   DRAGINFO structure.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgPushDraginfo ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgPushDraginfo ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_ACCESS_DENIED
   The memory block was not allocated properly.

PMERR_INSUFFICIENT_MEMORY
   The operation terminated through insufficient memory.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgPushDraginfo ΓòÉΓòÉΓòÉ

The receiving process is responsible for:

 1. Deleting the string handles in the DRAGINFO structure with
    DrgDeleteDraginfoStrHandles
 2. Freeing the DRAGINFO structure using DrgFreeDraginfo.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgPushDraginfo ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function gives a process access to */
/* a DRAGINFO structure.                   */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGINFO  pDraginfo;      /* Pointer */
HWND       hwndDest;       /* Window handle */
BOOL       fSuccess;       /* Success indicator */

fSuccess = DrgPushDraginfo(pDraginfo,
             hwndDest);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgPushDraginfo ΓòÉΓòÉΓòÉ

Related Functions

o DrgAccessDraginfo
o DrgAllocDraginfo
o DrgDrag
o DrgFreeDraginfo


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgPushDraginfo ΓòÉΓòÉΓòÉ

This example calls the DrgPushDraginfo function to grant access to a DRAGINFO
structure to the process owning the specified window handle. The DRAGINFO
structure was previously allocated using the DrgAllocDraginfo function.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>

BOOL      fSuccess;     /* Indicate success or failure          */
DRAGINFO  Draginfo;     /* Pointer to DRAGINFO structure        */
HWND      hwndDest;     /* Handle of window whose process will  */
                        /* will be given access to the DRAGINFO */
                        /* structure                            */

fSuccess = DrgPushDraginfo(&Draginfo,hwndDest);


ΓòÉΓòÉΓòÉ 6.15. DrgQueryDragitem ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgQueryDragitem ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgQueryDragitem ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - input
   Pointer. Pointer to the DRAGINFO structure from which the DRAGITEM structure
   is obtained.

cbBuffer (ULONG) - input
   Number of bytes. Maximum number of bytes to copy.

pDragitem (PDRAGITEM) - output
   Pointer. Pointer to the buffer into which the DRAGITEM structure is copied.

iItem (ULONG) - input
   DRAGITEM index. Zero-based index of the DRAGITEM to be returned.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgQueryDragitem ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgQueryDragitem ΓòÉΓòÉΓòÉ

This function returns the DRAGITEM structure identified by iItem.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgQueryDragitem ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function returns a DRAGITEM        */
/* structure used in the direct            */
/* manipulation operation.                 */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGINFO  pDraginfo;      /* Pointer */
ULONG      cbBuffer;       /* Number of bytes */
PDRAGITEM  pDragitem;      /* Pointer */
ULONG      iItem;          /* DRAGITEM index */
BOOL       fSuccess;       /* Success indicator */

fSuccess = DrgQueryDragitem(pDraginfo,
             cbBuffer, pDragitem, iItem);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgQueryDragitem ΓòÉΓòÉΓòÉ

Related Functions

o DrgQueryDragitemPtr
o DrgSetDragitem


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgQueryDragitem ΓòÉΓòÉΓòÉ

This example calls the DrgQueryDragitem function to return the entirety of the
first DRAGITEM structure in the given DRAGINFO structure, after which it
obtains the source window handle.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>

BOOL      fSuccess;     /* Indicate success or failure          */
DRAGINFO  Draginfo;     /* DRAGINFO structure from which the    */
                        /* DRAGITEM structure is obtained       */
ULONG     cbBuffer;     /* Maximum number of bytes to copy      */
DRAGITEM  Dragitem;     /* Buffer into which the DRAGITEM       */
                        /* structure is copied                  */
ULONG     iItem;        /* Zero-based index of the DRAGITEM     */
                        /* to be returned                       */
HWND      hwndSource;   /* Source window handle for the drag    */

cbBuffer = sizeof(DRAGITEM); /* Copy entire DRAGITEM structure  */
iItem = 0;                   /* Return first DRAGITEM           */

fSuccess = DrgQueryDragitem(&Draginfo,cbBuffer,&Dragitem,iItem);

hwndSource = Dragitem.hwndItem;  /* Obtain source window handle */


ΓòÉΓòÉΓòÉ 6.16. DrgQueryDragitemCount ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgQueryDragitemCount ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Example
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgQueryDragitemCount ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - input
   Pointer. Pointer to the DRAGINFO structure for which the number of dragged
   objects is requested.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgQueryDragitemCount ΓòÉΓòÉΓòÉ

cDitem (ULONG) - return
   Number of objects. Number of objects being dragged.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgQueryDragitemCount ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function returns the number of     */
/* objects being dragged during the        */
/* current direct manipulation operation.  */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGINFO  pDraginfo;      /* Pointer */
ULONG      cDitem;         /* Number of objects */

cDitem = DrgQueryDragitemCount(pDraginfo);


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgQueryDragitemCount ΓòÉΓòÉΓòÉ

This example calls the DrgQueryDragitemCount function to return the number of
DRAGITEM structures in the corresponding DRAGINFO structure, which maps to the
number of objects being dragged.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions */
#include <os2.h>

ULONG     cDitem;       /* Number of objects being dragged      */
DRAGINFO  Draginfo;     /* DRAGINFO structure queried for the   */
                        /* number of drag objects               */

cDitem = DrgQueryDragitemCount(&Draginfo);


ΓòÉΓòÉΓòÉ 6.17. DrgQueryDragitemPtr ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgQueryDragitemPtr ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgQueryDragitemPtr ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - input
   Pointer. Pointer to the DRAGINFO structure from which the DRAGITEM structure
   is obtained.

ulIndex (ULONG) - input
   DRAGITEM index. Zero-based index of the DRAGITEM structure for which the
   pointer is to be returned.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgQueryDragitemPtr ΓòÉΓòÉΓòÉ

pDragitem (PDRAGITEM) - return
   Pointer. Pointer to the DRAGITEM structure.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgQueryDragitemPtr ΓòÉΓòÉΓòÉ

This function returns a pointer to ulItemID in the DRAGITEM structure used in
the direct manipulation operation.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgQueryDragitemPtr ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function returns a pointer to the  */
/* DRAGITEM structure used in the direct   */
/* manipulation operation.                 */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGINFO  pDraginfo;      /* Pointer */
ULONG      ulIndex;        /* DRAGITEM index */
PDRAGITEM  pDragitem;      /* Pointer */

pDragitem = DrgQueryDragitemPtr(pDraginfo,
              ulIndex);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgQueryDragitemPtr ΓòÉΓòÉΓòÉ

Related Functions

o DrgQueryDragitem


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgQueryDragitemPtr ΓòÉΓòÉΓòÉ

This example calls the DrgQueryDragitemPtr function to return a pointer to
first DRAGITEM structure in the given DRAGINFO structure, after which it
obtains the source window handle.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions  */
#include <os2.h>

PDRAGITEM  pDragitem;   /* DRAGITEM structure pointer            */
DRAGINFO   Draginfo;    /* DRAGINFO structure from which the     */
                        /* DRAGITEM structure is obtained        */
ULONG      ulIndex;     /* Zero-based index of the DRAGITEM      */
                        /* structure pointer to be returned      */
HWND       hwndSource;  /* Source window handle for the drag     */

USHORT     usn = 0;     /* Return pointer to first DRAGITEM      */

pDragitem = DrgQueryDragitemPtr(&Draginfo,usn);

hwndSource = pDragitem->hwndItem; /* Obtain source window handle */


ΓòÉΓòÉΓòÉ 6.18. DrgQueryNativeRMF ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgQueryNativeRMF ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgQueryNativeRMF ΓòÉΓòÉΓòÉ

pDragitem (PDRAGITEM) - input
   Pointer. Pointer to the DRAGITEM structure whose native rendering mechanism
   and format are to be obtained.

cbBuflen (ULONG) - input
   Number of bytes. Maximum number of bytes to copy to the buffer.

ppBuffer (PCHAR) - output
   Pointer. Pointer to the buffer in which the null-terminated string is to be
   returned.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgQueryNativeRMF ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgQueryNativeRMF ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgQueryNativeRMF ΓòÉΓòÉΓòÉ

If the rendering mechanism and format string for the object are NULL, FALSE is
returned. If TRUE is returned, the format of the string is: <mechanism,format>.

The native rendering mechanism and format are the first ordered pair, or the
first ordered pair produced by a cross product, in the string associated with
hstrRMF in the DRAGITEM structure.

DrgQueryNativeRMFLen can be used to determine the size of the buffer required
to hold the string returned by this function.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgQueryNativeRMF ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function obtains the ordered pair  */
/* that represents the native rendering    */
/* mechanism and format of the dragged     */
/* object.                                 */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGITEM  pDragitem;      /* Pointer */
ULONG      cbBuflen;       /* Number of bytes */
PCHAR      ppBuffer;       /* Pointer */
BOOL       fSuccess;       /* Success indicator */

fSuccess = DrgQueryNativeRMF(pDragitem,
             cbBuflen, ppBuffer);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgQueryNativeRMF ΓòÉΓòÉΓòÉ

Prerequisite Functions

o DrgQueryNativeRMFLen

Related Functions

o DrgVerifyNativeRMF


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgQueryNativeRMF ΓòÉΓòÉΓòÉ

This example shows how to obtain the window handle of the source of a drag
item.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#define INCL_DOSMEMMGR   /* Memory Management Functions for      */
                         /* DosSubAlloc                          */
#include <OS2.H>

DRAGITEM ditem;
PVOID    pMem;
PSZ      pszBuffer;
ULONG    cb;
BOOL     rc, fResult;

cb = DrgQueryNativeRMFLen(&ditem) + 1;

rc = DosSubAlloc(pMem, (PVOID *) pszBuffer, cb);

if (!rc)

{
   fResult = DrgQueryNativeRMF(&ditem, cb, pszBuffer);
}


ΓòÉΓòÉΓòÉ 6.19. DrgQueryNativeRMFLen ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgQueryNativeRMFLen ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgQueryNativeRMFLen ΓòÉΓòÉΓòÉ

pDragitem (PDRAGITEM) - input
   Pointer. Pointer to the DRAGITEM structure whose native rendering mechanism
   and format string length are to be obtained.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgQueryNativeRMFLen ΓòÉΓòÉΓòÉ

ulLength (ULONG) - return
   String length. String length of the ordered pair:

   0
      Error occurred.

   Other
      String length of the ordered pair, excluding the null-terminating byte.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgQueryNativeRMFLen ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgQueryNativeRMFLen ΓòÉΓòÉΓòÉ

This function is used to determine the size of the buffer that contains the
string representing the native rendering mechanism and format of the dragged
object.

If the input string handle is NULLHANDLE or not valid, a length of 0 is
returned.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgQueryNativeRMFLen ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function obtains the length of the */
/* string representing the native          */
/* rendering mechanism and format of the   */
/* dragged object.                         */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGITEM  pDragitem;      /* Pointer */
ULONG      ulLength;       /* String length */

ulLength = DrgQueryNativeRMFLen(pDragitem);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgQueryNativeRMFLen ΓòÉΓòÉΓòÉ

Related Functions

o DrgQueryNativeRMF


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgQueryNativeRMFLen ΓòÉΓòÉΓòÉ

This example shows how to obtain the window handle of the source of a drag
item.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#define INCL_DOSMEMMGR   /* Memory Management Functions for      */
                         /* DosSubAlloc                          */
#include <OS2.H>

DRAGITEM ditem;
PVOID    pMem;
PSZ      pszBuffer;
ULONG    cb;
BOOL     rc, fResult;

cb = DrgQueryNativeRMFLen(&ditem) + 1;

rc = DosSubAlloc(pMem, (PVOID *) pszBuffer, cb);

if (!rc)

{
   fResult = DrgQueryNativeRMF(&ditem, cb, pszBuffer);
}


ΓòÉΓòÉΓòÉ 6.20. DrgQueryStrName ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgQueryStrName ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgQueryStrName ΓòÉΓòÉΓòÉ

Hstr (HSTR) - input
   String handle. The handle must have been created with DrgAddStrHandle.

cbBuflen (ULONG) - input
   Number of bytes. Maximum number of bytes to copy.

pBuffer (PSZ) - output
   Buffer. Buffer where the null-terminated string is returned.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgQueryStrName ΓòÉΓòÉΓòÉ

ulLength (ULONG) - return
   Number of bytes. Number of bytes written to pBuffer.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgQueryStrName ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgQueryStrName ΓòÉΓòÉΓòÉ

This function should be called whenever the contents of a string referenced by
a drag string handle are required.  If the input string handle is NULLHANDLE or
not valid, a null string is returned.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgQueryStrName ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function gets the contents of a    */
/* string associated with a string handle. */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

HSTR   Hstr;      /* String handle */
ULONG  cbBuflen;  /* Number of bytes */
PSZ    pBuffer;   /* Buffer */
ULONG  ulLength;  /* Number of bytes */

ulLength = DrgQueryStrName(Hstr, cbBuflen,
             pBuffer);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgQueryStrName ΓòÉΓòÉΓòÉ

Prerequisite Functions

o DrgQueryStrNameLen

Related Functions

o DrgAddStrHandle


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgQueryStrName ΓòÉΓòÉΓòÉ

This example shows how to obtain the contents of a string given that the string
handle is known. The string handle must have been originally created with the
DrgAddStrHandle function.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#define INCL_DOSMEMMGR   /* Memory Management Functions for      */
                         /* DosAllocMem                          */
#include <OS2.H>

HSTR   hstr;             /* Handle to a string.  The handle must */
                         /* have been created with               */
                         /* DrgAddStrHandle.                     */
PSZ    pBuffer;          /* Buffer where the null-terminated     */
                         /* string is returned                   */
ULONG  ulStrlen;         /* String length                        */
ULONG  ulBytesRead;      /* Number of bytes read                 */
ULONG  rc;               /* Return code                          */

ulStrlen = DrgQueryStrNameLen(hstr) + 1;

rc = DosAllocMem((PVOID *) pBuffer,
                (LONG)ulStrlen,
                fPERM |
                PAG_COMMIT);

/*****************************************************************/
/* The ulBytesRead parameter contains the number of bytes        */
/* actually written to the memory pointed to by pBuffer          */
/*****************************************************************/
ulBytesRead = DrgQueryStrName(hstr,
                     ulStrlen,      /* Number of bytes to copy   */
                     pBuffer);


ΓòÉΓòÉΓòÉ 6.21. DrgQueryStrNameLen ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgQueryStrNameLen ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgQueryStrNameLen ΓòÉΓòÉΓòÉ

Hstr (HSTR) - input
   String handle. The handle must be created with DrgAddStrHandle.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgQueryStrNameLen ΓòÉΓòÉΓòÉ

cLength (ULONG) - return
   String length.

   0
      The string handle is NULLHANDLE or is not valid.

   Other
      The length of the string associated with the string handle, excluding the
      null terminating byte.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgQueryStrNameLen ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgQueryStrNameLen ΓòÉΓòÉΓòÉ

This function should be called before calling the DrgQueryStrName function. It
is used to determine and allocate the buffer size for the string associated
with the string handle.  If the input string handle is NULLHANDLE or not valid,
a length of 0 is returned.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgQueryStrNameLen ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function gets the length of a      */
/* string associated with a string handle. */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

HSTR   Hstr;     /* String handle */
ULONG  cLength;  /* String length */

cLength = DrgQueryStrNameLen(Hstr);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgQueryStrNameLen ΓòÉΓòÉΓòÉ

Related Functions

o DrgQueryStrName


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgQueryStrNameLen ΓòÉΓòÉΓòÉ

This example shows how to obtain the length of a string given that the string
handle is known. The string handle must have been originally created with the
DrgAddStrHandle function.

#define INCL_WINSTDDRAG /* Direct Manipulation (Drag) Functions  */
#define INCL_DOSMEMMGR  /* Memory Management Functions for       */
                        /* DosAllocMem                           */
#include <OS2.H>

HSTR   hstr;            /* Handle to a string.  The handle must  */
                        /* have been created with                */
                        /* DrgAddStrHandle.                      */
PSZ    pBuffer;         /* Buffer where the null-terminated      */
                        /* string is returned                    */
ULONG  ulStrlen;        /* String length                         */
ULONG  ulBytesRead;     /* Number of bytes read                  */
ULONG  rc;              /* Return code                           */

ulStrlen = DrgQueryStrNameLen(hstr) + 1;

rc = DosAllocMem((PVOID *) pBuffer,
                (LONG)ulStrlen,
                 fPERM |
                 PAG_COMMIT);

/*****************************************************************/
/* The ulBytesRead parameter contains the number of bytes        */
/* actually written to the memory pointed to by pBuffer          */
/*****************************************************************/
ulBytesRead = DrgQueryStrName(hstr,
                     ulStrlen,      /* Number of bytes to copy   */
                     pBuffer);


ΓòÉΓòÉΓòÉ 6.22. DrgQueryTrueType ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgQueryTrueType ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgQueryTrueType ΓòÉΓòÉΓòÉ

pDragitem (PDRAGITEM) - input
   Pointer. Pointer to the DRAGITEM structure whose true type is to be
   obtained.

cbBuflen (ULONG) - input
   Number of bytes. Maximum number of bytes to copy to the buffer.

pBuffer (PSZ) - output
   Buffer. Buffer in which the null-terminated string is to be returned.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgQueryTrueType ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgQueryTrueType ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgQueryTrueType ΓòÉΓòÉΓòÉ

The true type of an object is the first type in the string referenced by
hstrType in the DRAGITEM structure.

This function can be called after calling the DrgQueryTrueTypeLen function. If
the type string for the object is NULLHANDLE, FALSE is returned.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgQueryTrueType ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function obtains the true type of  */
/* a dragged object.                       */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGITEM  pDragitem;      /* Pointer */
ULONG      cbBuflen;       /* Number of bytes */
PSZ        pBuffer;        /* Buffer */
BOOL       fSuccess;       /* Success indicator */

fSuccess = DrgQueryTrueType(pDragitem,
             cbBuflen, pBuffer);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgQueryTrueType ΓòÉΓòÉΓòÉ

Prerequisite Functions

o DrgQueryTrueTypeLen

Related Functions

o DrgVerifyTrueType


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgQueryTrueType ΓòÉΓòÉΓòÉ

This example shows how to obtain the true type of an object.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <OS2.H>

BOOL     fSuccess;       /* Return value                         */
DRAGITEM Dragitem;       /* DRAGITEM structure whose true type   */
                         /* is to be obtained                    */

char szBuffer[32];       /* Buffer in which the null-terminated  */
                         /* string is to be returned             */

fSuccess = DrgQueryTrueType(&Dragitem,
                            sizeof(szBuffer),
                            szBuffer);


ΓòÉΓòÉΓòÉ 6.23. DrgQueryTrueTypeLen ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgQueryTrueTypeLen ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgQueryTrueTypeLen ΓòÉΓòÉΓòÉ

pDragitem (PDRAGITEM) - input
   Pointer. Pointer to the DRAGITEM structure whose true type length is to be
   obtained.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgQueryTrueTypeLen ΓòÉΓòÉΓòÉ

ulLength (ULONG) - return
   String length.

   0
      Error occurred.

   Other
      The length of the first element of the character string associated with
      hstrType, excluding the null-terminating byte.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgQueryTrueTypeLen ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgQueryTrueTypeLen ΓòÉΓòÉΓòÉ

This function can be used to determine the buffer size to allocate for the
string representing the true type of a dragged object. The true type of an
object is the first type in the type string referenced by hstrType in the
DRAGITEM structure.

This function can be called before calling the DrgQueryTrueType function.

If the input string handle is NULLHANDLE or not valid, a length of 0 is
returned.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgQueryTrueTypeLen ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function obtains the length of the */
/* string that represents the true type of */
/* a dragged object.                       */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGITEM  pDragitem;      /* Pointer */
ULONG      ulLength;       /* String length */

ulLength = DrgQueryTrueTypeLen(pDragitem);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgQueryTrueTypeLen ΓòÉΓòÉΓòÉ

Related Functions

o DrgQueryTrueType


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgQueryTrueTypeLen ΓòÉΓòÉΓòÉ

This example shows how to obtain the length of the true type string with the
DrgQueryTrueTypeLen function.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#define INCL_DOSMEMMGR   /* Memory Management Functions for      */
                         /* DosAllocMem                          */
#include <OS2.H>

PSZ      pszBuffer;      /* Buffer in which the DRAGITEM         */
                         /* structure is stored                  */
BOOL     fSuccess;       /* Return value                         */
DRAGITEM Dragitem;       /* DRAGITEM structure whose true type   */
                         /* length is to be obtained             */
ULONG    rc;             /* Return code                          */
ULONG    ulLength;       /* String length of dragged object      */

ulLength = DrgQueryTrueTypeLen(&Dragitem) + 1;

rc = DosAllocMem((PVOID *) pszBuffer, ulLength, fPERM);

fSuccess = DrgQueryTrueType(&Dragitem, ulLength, pszBuffer);


ΓòÉΓòÉΓòÉ 6.24. DrgReleasePS ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgReleasePS ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgReleasePS ΓòÉΓòÉΓòÉ

Hps (HPS) - input
   Presentation-space handle. Handle of the presentation space to release.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgReleasePS ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgReleasePS ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INV_HPS
   An invalid presentation-space handle was specified.

PMERR_NOT_DRAGGING
   A drag operation is not in progress at this time.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgReleasePS ΓòÉΓòÉΓòÉ

Only presentation spaces created with DrgGetPS can be released using this
function.

The presentation-space handle should not be used after this function.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgReleasePS ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function releases a presentation   */
/* space obtained by using the DrgGetPS    */
/* function.                               */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

HPS   Hps;      /* Presentation-space handle */
BOOL  fSuccess; /* Success indicator */

fSuccess = DrgReleasePS(Hps);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgReleasePS ΓòÉΓòÉΓòÉ

Prerequisite Functions

o DrgGetPS


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgReleasePS ΓòÉΓòÉΓòÉ

In this example the presentation space handle is retrieved, a bit map is
loaded, and the presentation space is released with the DrgReleasePS function.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <os2.h>
#define ID_BITMAP 255
HPS    hps;
HWND hwnd;

case DM_DRAGOVER:
    hps = DrgGetPS(hwnd);

    DrawTargetEmphasis(hps, hwnd);
    DrgReleasePS(hps);


ΓòÉΓòÉΓòÉ 6.25. DrgSendTransferMsg ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgSendTransferMsg ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgSendTransferMsg ΓòÉΓòÉΓòÉ

hwndTo (HWND) - input
   Window handle. Window handle to which the message is to be sent:

   Target
      hwndItem in the DRAGITEM structure.

   Source
      hwndClient in the DRAGTRANSFER structure.

ulMsgid (ULONG) - input
   Message identifier. Identifier of the message to be sent. Valid messages
   are:

   DM_ENDCONVERSATION
   DM_RENDER
   DM_RENDERPREPARE

mpParam1 (MPARAM) - input
   mp1 for the message.

mpParam2 (MPARAM) - input
   mp2 for the message.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgSendTransferMsg ΓòÉΓòÉΓòÉ

mresReply (MRESULT) - return
   Message-return data.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgSendTransferMsg ΓòÉΓòÉΓòÉ

If the message to be sent is DM_RENDER or DM_RENDERCOMPLETE, the fsReply field
in DRAGTRANSFER is set to 0 before the message is sent.  If the message cannot
be sent, FALSE is returned.

When the message to be sent is DM_RENDER, DosGiveSeg is called. DosGiveSeg
gives access to the DRAGTRANSFER structure to the process that owns the window
indicated by hwndTo.  The use count for the segment in which the DRAGTRANSFER
structure exists is incremented.

The process to which the message is being sent must call DrgFreeDragtransfer
for the DRAGTRANSFER structure before the segment can be freed.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgSendTransferMsg ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function sends a message to the    */
/* other application involved in the       */
/* direct manipulation operation.          */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

HWND     hwndTo;       /* Window handle */
ULONG    ulMsgid;      /* Message identifier */
MPARAM   mpParam1;     /* mp1 for the message */
MPARAM   mpParam2;     /* mp2 for the message */
MRESULT  mresReply;    /* Message-return data */

mresReply = DrgSendTransferMsg(hwndTo,
              ulMsgid, mpParam1, mpParam2);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgSendTransferMsg ΓòÉΓòÉΓòÉ

Related Functions

o DrgPostTransferMsg


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgSendTransferMsg ΓòÉΓòÉΓòÉ

This function is used to send a message from one window to another when a
direct manipulation is in progress. In this example, the function is used to
inform the target that the operation is complete and successful.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <os2.h>

PDRAGINFO pdinfo;
MPARAM    mp1;
TID       tid;

case DM_DROP:
  pdinfo = (PDRAGINFO) mp1;

  /***************************************************************/
  /* If this is a copy operation, spawn a thread to do the copy  */
  /***************************************************************/
  if (pdinfo->usOperation == DO_COPY)
  {
    DosCreateThread (&tid, CopyThread, pdinfo, FALSE, 4096);
  }
  break;

void Copy Thread (PDRAGINFO pdinfo)
{
  PDRAGITEM pditem;
  USHORT    i;
  ULONG     flResult;
  HAB       hab;
  HMQ       hmq;
  char      szSource[CCH_MAXPATH];
  char      szTarget[CCH_MACPATH];

  /***************************************************************/
  /* DrgSendTransferMsg needs a message queue, so create one for */
  /* this thread                                                 */
  /***************************************************************/
  hab = WinInitialize (0);
  hmq = WinCreateMsgQueue (hab, 0);

  /***************************************************************/
  /* Try to copy each item that was dragged                      */
  /***************************************************************/
  for (i = 0; i < pdinfo->cditem; i++)
  {
    /*************************************************************/
    /* Get a pointer to the DRAGITEM                             */
    /*************************************************************/
    pditem = DrgQueryDragitemPtr (pdinfo, i);

    /*************************************************************/
    /* If we could query the source and target names, and the    */
    /* copy was successful, return success                       */
    /*************************************************************/
    if (DrgQueryStrName (pditem->hstrSourceName, sizeof (szSource),
                         szSource)
        DrgQueryStrName (pditem->hstrTargetName, sizeof (szTarget),
                         szTarget)
        !DosCopy (szSource, szTarget, 0))
    {
      flResult = DMFL_TARGETSUCCESSFUL;
    }

    /*************************************************************/
    /* Otherwise, return failure                                 */
    /*************************************************************/
    else
    {
      flResult = DMFL_TARGETFAIL;
    }

    /*************************************************************/
    /* Let the source know we're done with this item             */
    /*************************************************************/
    DrgSendTransferMsg (pditem->hwndItem, DM_ENDCONVERSATION,
                        (MPARAM) pditem->ulItemID,
                        (MPARAM) flResult);
  }

  WinDestroyMsgQueue (hmq);
  WinTerminate (hab);
}


ΓòÉΓòÉΓòÉ 6.26. DrgSetDragImage ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgSetDragImage ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgSetDragImage ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - input
   Pointer. Pointer to the DRAGINFO structure representing the drag operation
   for which the pointer is to be set.

pdimg (PDRAGIMAGE) - input
   Pointer. Pointer to an array of DRAGIMAGE structures. These structures
   describe the images to be drawn under the pointer during the drag.

cdimg (ULONG) - input
   Array size. Size of the pdimg array.

pReserved (PVOID) - input
   Reserved. Must be set to NULL by the caller.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgSetDragImage ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgSetDragImage ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_ACCESS_DENIED
   The memory block was not allocated properly.

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.

PMERR_INSUFFICIENT_MEMORY
   The operation terminated through insufficient memory.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgSetDragImage ΓòÉΓòÉΓòÉ

The image that is set with DrgSetDragImage is used only while the pointer is
over the target that made the call.  If the pointer leaves the original target,
the new target can specify an image by calling DrgSetDragImage.

If the new target does not call DrgSetDragImage, the original image that was
supplied on the call to DrgDrag is used.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgSetDragImage ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function sets the image that is    */
/* being dragged.                          */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGINFO   pDraginfo;       /* Pointer */
PDRAGIMAGE  pdimg;           /* Pointer */
ULONG       cdimg;           /* Array size */
PVOID       pReserved;       /* Reserved */
BOOL        fSuccess;        /* Success indicator */

fSuccess = DrgSetDragImage(pDraginfo, pdimg,
             cdimg, pReserved);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgSetDragImage ΓòÉΓòÉΓòÉ

Related Functions

o DrgSetDragPointer


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgSetDragImage ΓòÉΓòÉΓòÉ

This example sets the icon image that is displayed during a direct manipulation
operation.

#define INCL_GPIBITMAPS  /* GPI Bit Map Functions                */
#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <os2.h>
#define ID_BITMAP 257    /* .rc file: "bitmap 257 drgimage.bmp"  */
HPS       hps;           /* Presentation space handle            */
BOOL      flResult;
HAB       hab;
PDRAGINFO pdinfo;
DRAGIMAGE dimg;
HBITMAP   hbm;           /* Bit-map handle                       */
HWND      hwnd;

/*****************************************************************/
/* Load a bit map for use as a drag image                        */
/*****************************************************************/

case WM_CREATE:
    hps = WinGetPS(hwnd);

    hbm = GpiLoadBitmap(hps,0L,ID_BITMAP,20L,20L);
    WinReleasePS(hps);
    break;

case DM_DRAGOVER:

/*****************************************************************/
/* Initialize the DRAGIMAGE structure                            */
/*****************************************************************/

      dimg.cb = sizeof(DRAGIMAGE);  /* Size control block        */
      dimg.cptl        = 0;
      dimg.hImage = hbm;            /* Image handle passed to    */
                                    /* DrgDrag                   */
      dimg.sizlStretch.cx = 20L;    /* Size to stretch ico or    */
      dimg.sizlStretch.cy = 20L;    /* bmp to                    */
      dimg.fl = DRG_BITMAP |
                DRG_STRETCH;        /* Stretch to size specified */
      dimg.cxOffset = 0;            /* Offset of the origin of   */
      dimg.cyOffset = 0;            /* the image from the pointer*/
                                    /* hotspot                   */

/*****************************************************************/
/* Set the drag image                                            */
/*****************************************************************/

flResult= DrgSetDragImage(pdinfo,&dimg,(ULONG)sizeof(dimg), NULL);


ΓòÉΓòÉΓòÉ 6.27. DrgSetDragitem ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgSetDragitem ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgSetDragitem ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - input
   Pointer. Pointer to the DRAGINFO structure in which to place the DRAGITEM.

pDragitem (PDRAGITEM) - input
   Pointer. Pointer to the DRAGITEM structure to place in DRAGINFO.

cbBuffer (ULONG) - input
   DRAGITEM size. Size of the DRAGITEM addressed by pDragitem.

iItem (ULONG) - input
   DRAGITEM index. Zero-based index of the DRAGITEM to be set.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgSetDragitem ΓòÉΓòÉΓòÉ

fSuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgSetDragitem ΓòÉΓòÉΓòÉ

This function is used to initialize the DRAGINFO structure before calling
DrgDrag.

This function is used only by the source of the drag, not by the target.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgSetDragitem ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function sets the values in a      */
/* DRAGITEM structure.                     */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGINFO  pDraginfo;      /* Pointer */
PDRAGITEM  pDragitem;      /* Pointer */
ULONG      cbBuffer;       /* DRAGITEM size */
ULONG      iItem;          /* DRAGITEM index */
BOOL       fSuccess;       /* Success indicator */

fSuccess = DrgSetDragitem(pDraginfo,
             pDragitem, cbBuffer, iItem);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgSetDragitem ΓòÉΓòÉΓòÉ

Related Functions

o DrgQueryDragitem


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgSetDragitem ΓòÉΓòÉΓòÉ

This example shows a direct manipulation operation between two windows. The
actual operation, copying the CONFIG.SYS file to C:\OS2\CONFIG.SYS, is visually
represented by a drag and drop of an icon.

#define INCL_GPIBITMAPS  /* GPI Bit Map Functions                */
#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#define INCL_DOSFILEMGR  /* File Management Functions            */
#define INCL_WININPUT    /* Window Input Functions               */
#include <os2.h>
#include <string.h>
#define ID_WINDOW 255
#define ID_ITEM 256
#define ID_BITMAP 257    /* .rc file: "bitmap 257 drgimage.bmp"  */
HPS       hps;           /* Presentation space handle            */
BOOL      flResult;
HAB       hab;
PDRAGINFO pdinfo;
DRAGITEM  ditem;
DRAGIMAGE dimg;
PDRAGITEM pditem;
HBITMAP   hbm;           /* Bit-map handle                       */
HPOINTER  hptr;          /* Pointer bit-map handle               */
HWND      hwndDrop;
HWND      hwnd;
MPARAM    mp1;
char szBuffer[32];       /* Buffer where intersection string     */
                         /* is returned                          */
char szSource[32];
char szTarget[32];

/*****************************************************************/
/* Inside  ClientWindowProc of Source Window                     */
/*****************************************************************/

case WM_BEGINDRAG:

/*****************************************************************/
/* Initialize the DRAGITEM structure                             */
/*****************************************************************/

    ditem.hwndItem = hwnd;      /* Conversation partner          */
    ditem.ulItemID = ID_ITEM;   /* Identifies item being dragged */
    ditem.hstrType = DrgAddStrHandle(DRT_TEXT);     /* Text item */
    ditem.hstrRMF = DrgAddStrHandle("<DRM_OS2FILE,DRF_TEXT>");
    ditem.hstrContainerName = DrgAddStrHandle("C:\\");
    ditem.hstrSourceName = DrgAddStrHandle("C:\\CONFIG.SYS");
    ditem.hstrTargetName = DrgAddStrHandle("C:\\OS2\\CONFIG.SYS");
    ditem.cxOffset = 0; ditem.cyOffset = 0;
    ditem.fsControl = 0; ditem.fsSupportedOps = 0;

/*****************************************************************/
/* Create the DRAGINFO structure                                 */
/*****************************************************************/

    pdinfo = DrgAllocDraginfo(1);

/*****************************************************************/
/* Initialize the DRAGIMAGE structure                            */
/*****************************************************************/

    dimg.cb = sizeof(DRAGIMAGE); /* Size control block           */
    dimg.cptl        = 0;
    dimg.hImage = hbm;           /* Image handle passed to       */
                                 /* DrgDrag                      */
    dimg.sizlStretch.cx = 20L;   /* Size to stretch ico or       */
    dimg.sizlStretch.cy = 20L;   /* bmp to                       */
    dimg.fl = DRG_BITMAP |
              DRG_STRETCH;       /* Stretch to size specified    */
    dimg.cxOffset = 0;           /* Offset of the origin of the  */
    dimg.cyOffset = 0;           /* image from the pointer       */
                                 /* hotspot                      */

flResult= DrgSetDragitem(pdinfo, &ditem, (ULONG)sizeof(ditem), 0);

/*****************************************************************/
/* Perform the drag operation:                                   */
/*****************************************************************/

      hwndDrop = DrgDrag(hwnd,  /* Source of the drag            */
                  pdinfo,       /* Pointer to DRAGINFO structure */
                 (PDRAGIMAGE)&dimg,  /* Drag image               */
                  1,            /* Size of the pdimg array       */
                  VK_ENGDRAG,   /* Release of drag button        */
                                /* terminates the drag           */
                  NULL);        /* Reserved                      */

/*****************************************************************/
/* Inside ClientWindowProc of Target Window                      */
/*****************************************************************/

  case DM_DRAGOVER:

      pdinfo = MPFROMP(mp1);
      pditem = DrgQueryDragitemPtr(pdinfo,0);

      flResult = DrgVerifyTrueType(pditem,"DRF_TEXT");

      if(!flResult)

/*****************************************************************/
/* Inform the application that you will accept the drop          */
/*****************************************************************/

      return(MRFROM2SHORT(DOR_DROP,DO_COPY));

  case DM_DROP:
      pdinfo = MPFROMP(mp1);
      pditem = DrgQueryDragitemPtr(pdinfo,0);

/*****************************************************************/
/* Perform the operation represented by the direct manipulation  */
/*****************************************************************/

DrgQueryStrName(pditem->hstrSourceName,sizeof(szSource),szSource);
DrgQueryStrName(pditem->hstrTargetName,sizeof(szTarget),szTarget);
flResult = DosCopy(szSource,szTarget,0L);

/*****************************************************************/
/* If operation is successful, return DMFL_TARGETSUCCESSFUL      */
/*****************************************************************/

if(!flResult)
{
      DrgSendTransferMsg(pditem->hwndItem,
                         DM_ENDCONVERSATION,
                         MPFROMLONG(pditem->ulItemID),
                         MPFROMLONG(DMFL_TARGETSUCCESSFUL));
}

/*****************************************************************/
/* Otherwise, return DMFL_TARGETFAIL                             */
/*****************************************************************/

else
{
      DrgSendTransferMsg(pditem->hwndItem,
                         DM_ENDCONVERSATION,
                         MPFROMLONG(pditem->ulItemID),
                         MPFROMLONG(DMFL_TARGETFAIL));
}


ΓòÉΓòÉΓòÉ 6.28. DrgSetDragPointer ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgSetDragPointer ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgSetDragPointer ΓòÉΓòÉΓòÉ

pDraginfo (PDRAGINFO) - input
   Pointer. Pointer to the DRAGINFO structure to be used for this drag.

hptrHandle (HPOINTER) - input
   Pointer handle. Handle to the pointer to use.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgSetDragPointer ΓòÉΓòÉΓòÉ

fResult (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgSetDragPointer ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_HPTR
   An invalid pointer handle was specified.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgSetDragPointer ΓòÉΓòÉΓòÉ

This function sets the pointer to be used to indicate the hot spot while
dragging over the current target.

The pointer that is set with DrgSetDragPointer is used only while it is over
the current target.  The pointer is reset to the default when a new target is
dragged over.

This function can be used by an application to provide meaningful augmentation
emphasis for an operation that is unknown to the system (for example, swap).

When the drag pointer is successfully set, TRUE is returned.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgSetDragPointer ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function sets the pointer to be    */
/* used while over the current target.     */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGINFO  pDraginfo;       /* Pointer */
HPOINTER   hptrHandle;      /* Pointer handle */
BOOL       fResult;         /* Success indicator */

fResult = DrgSetDragPointer(pDraginfo,
            hptrHandle);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgSetDragPointer ΓòÉΓòÉΓòÉ

Related Functions

o DrgSetDragImage


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgSetDragPointer ΓòÉΓòÉΓòÉ

This example uses the DrgSetDragPointer function to set the image used for the
pointer while the pointer is over the target during a direct manipulation
operation.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <OS2.H>
BOOL      flResult;
PDRAGITEM pditem;
HPOINTER  hptrCrossHair;
MPARAM    mp1;
char szBuffer[32];

case DM_DRAGOVER:
    DrgSetDragPointer ((PDRAGINFO) mp1, hptrCrossHair);


ΓòÉΓòÉΓòÉ 6.29. DrgVerifyNativeRMF ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgVerifyNativeRMF ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgVerifyNativeRMF ΓòÉΓòÉΓòÉ

pDragitem (PDRAGITEM) - input
   Pointer. Pointer to the DRAGITEM structure whose native rendering mechanism
   and format are to be verified.

pRMF (PSZ) - input
   String. A string specifying the rendering mechanism and format. The string
   is of the form: mechfmt[,mechfmt,mechfmt,...], where mechfmt can be in
   either of these formats:

   o <mechanism(1),format(1)>
   o (mechanism(1)[, mechanism(n)...]) (format(1)[,format(n)...])


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgVerifyNativeRMF ΓòÉΓòÉΓòÉ

fValid (BOOL) - return
   Validity indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgVerifyNativeRMF ΓòÉΓòÉΓòÉ

This function determines if the native rendering mechanism and format of a
dragged object are understood by the target.

If TRUE is returned, the target may be able to carry out the action indicated
by the direct manipulation itself, or it can select the native rendering
mechanism and format as those to be used for the data exchange.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgVerifyNativeRMF ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function determines if the native  */
/* rendering mechanism and format of an    */
/* object match any supplied by the        */
/* application.                            */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGITEM  pDragitem;      /* Pointer */
PSZ        pRMF;           /* String */
BOOL       fValid;         /* Validity indicator */

fValid = DrgVerifyNativeRMF(pDragitem, pRMF);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgVerifyNativeRMF ΓòÉΓòÉΓòÉ

Related Functions

o DrgQueryNativeRMF


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgVerifyNativeRMF ΓòÉΓòÉΓòÉ

This example determines if the native rendering mechanism and format of an
object match any supplied by the application.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <OS2.H>

DRAGITEM Dragitem;       /* DRAGITEM structure whose native      */
                         /* rendering mechanism and format are   */
                         /* to be verified                       */

char pszRMF[25];         /* A string specifying the rendering    */
                         /* mechanism and format.  The string is */
                         /* of the form:                         */
                         /*                                      */
                         /* mechfmt[,mechfmt,mechfmt,...],       */
                         /*                                      */
                         /* where 'mechfmt' can be in either of  */
                         /* these formats:                       */
                         /*                                      */
                         /*  o <mechanism(1),format(1)>          */
                         /*  o (mechanism(1)[, mechanism(n)...]) */
                         /*    (format(1)[,format(n)...])        */


strcpy(pszRMF,"(DRM_OS2FILE,DRF_TEXT)");
                         /* Mechanism is an OS/2 file and format */
                         /* is a null-terminated string.  See    */
                         /* the DRAGITEM structure for valid     */
                         /* formats.                             */

if(DrgVerifyNativeRMF(&Dragitem, pszRMF))
{
                         /* Code block                           */
}


ΓòÉΓòÉΓòÉ 6.30. DrgVerifyRMF ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgVerifyRMF ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgVerifyRMF ΓòÉΓòÉΓòÉ

pDragitem (PDRAGITEM) - input
   Pointer. Pointer to the DRAGITEM structure whose native rendering mechanism
   and format are to be validated.

pMech (PSZ) - input
   Mechanism string. A string specifying the rendering mechanism to search for.
   NULL will match any mechanism.

pFormat (PSZ) - input
   Format string. A string specifying the rendering format to search for. NULL
   will match any format.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgVerifyRMF ΓòÉΓòÉΓòÉ

fValid (BOOL) - return
   Validity indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgVerifyRMF ΓòÉΓòÉΓòÉ

This function determines if a given rendering mechanism and format ordered pair
are represented in the set of valid pairs specified by hstrRMF for the dragged
object.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgVerifyRMF ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function determines if a given     */
/* rendering mechanism and format are      */
/* supported for a dragged object.         */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGITEM  pDragitem;      /* Pointer */
PSZ        pMech;          /* Mechanism string */
PSZ        pFormat;        /* Format string */
BOOL       fValid;         /* Validity indicator */

fValid = DrgVerifyRMF(pDragitem, pMech,
           pFormat);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgVerifyRMF ΓòÉΓòÉΓòÉ

Related Functions

o DrgVerifyNativeRMF


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgVerifyRMF ΓòÉΓòÉΓòÉ

This example determines if a given rendering mechanism and format are supported
for a dragged object.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <OS2.H>

DRAGITEM Dragitem;       /* DRAGITEM structure whose native      */
                         /* rendering mechanism and format are   */
                         /* to be validated                      */
char pszMech[] = "DRM_OS2FILE";
                         /* A string specifying the rendering    */
                         /* mechanism to search for              */
char pszFormat[] = "DRF_TEXT";
                         /* A string specifying the rendering    */
                         /* format to search for                 */

if(DrgVerifyRMF(&Dragitem, pszMech, pszFormat))
                         /* Mechanism is an OS/2 file and format */
                         /* is a null-terminated string          */
{
                         /* Code block                           */
}


ΓòÉΓòÉΓòÉ 6.31. DrgVerifyTrueType ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgVerifyTrueType ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgVerifyTrueType ΓòÉΓòÉΓòÉ

pDragitem (PDRAGITEM) - input
   Pointer. Pointer to the DRAGITEM structure whose true type is to be
   verified.

pType (PSZ) - input
   Type string. A string specifying a type. This string is in the format:
   type[,type...].


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgVerifyTrueType ΓòÉΓòÉΓòÉ

fValid (BOOL) - return
   Validity indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgVerifyTrueType ΓòÉΓòÉΓòÉ

If an item in the string pointed to by pType matches the first type in the
string associated with hstrType in the DRAGITEM structure, TRUE is returned.

A target application uses this function to determine if it supports the true
type of a dragged object.  If the application does not support the true type,
it can either disallow a drop or change its default operation.  If the default
operation is a move, the drop should be disallowed, or the operation changed to
a copy to prevent any loss of data for the object.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgVerifyTrueType ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function determines if the true    */
/* type of a dragged object matches an     */
/* application-supplied type string.       */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGITEM  pDragitem;      /* Pointer */
PSZ        pType;          /* Type string */
BOOL       fValid;         /* Validity indicator */

fValid = DrgVerifyTrueType(pDragitem, pType);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgVerifyTrueType ΓòÉΓòÉΓòÉ

Related Functions

o DrgQueryTrueType
o DrgVerifyType
o DrgVerifyTypeSet


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgVerifyTrueType ΓòÉΓòÉΓòÉ

This example verifies whether a given type is present in the list of types
defined for a drag object.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <OS2.H>

BOOL      fValid;
DRAGITEM  Dragitem;      /* DRAGITEM structure whose hstrType is */
                         /* to be verified                       */

char pszType[8];         /* A string specifying the types to     */
                         /* search for                           */

strcpy(pszType,DRT_EXE); /* Executable file type. See the      */
                           /* DRAGINFO structure for valid       */
                           /* types.                             */

fValid = DrgVerifyTrueType(&Dragitem, pszType);


ΓòÉΓòÉΓòÉ 6.32. DrgVerifyType ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgVerifyType ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgVerifyType ΓòÉΓòÉΓòÉ

pDragitem (PDRAGITEM) - input
   Pointer. Pointer to the DRAGITEM structure whose hstrType is to be verified.

pType (PSZ) - input
   Type string. A string specifying the types to search for. This string is in
   the format: type[,type...].


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgVerifyType ΓòÉΓòÉΓòÉ

fValid (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DrgVerifyType ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

PMERR_INVALID_PARAMETERS
   An application parameter value is invalid for its converted PM type. For
   example: a 4-byte value outside the range -32,768 to +32,767 cannot be
   converted to a SHORT, and a negative number cannot be converted to a ULONG
   or USHORT.

PMERR_INSUFFICIENT_MEMORY
   The operation terminated through insufficient memory.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgVerifyType ΓòÉΓòÉΓòÉ

If at least one of the types specified by pType is present in hstrType in the
DRAGITEM structure, TRUE is returned.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgVerifyType ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function verifies whether a given  */
/* type is present in the list of types    */
/* defined for a drag object.              */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGITEM  pDragitem;      /* Pointer */
PSZ        pType;          /* Type string */
BOOL       fValid;         /* Success indicator */

fValid = DrgVerifyType(pDragitem, pType);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgVerifyType ΓòÉΓòÉΓòÉ

Related Functions

o DrgVerifyTrueType
o DrgVerifyTypeSet


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgVerifyType ΓòÉΓòÉΓòÉ

This example verifies whether a given type is present in the list of types
defined for a drag object.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <OS2.H>


BOOL     fValid;
DRAGITEM Dragitem;       /* DRAGITEM structure whose hstrType is */
                         /* to be verified                       */
char pszType[] = DRT_EXE;
                         /* A string specifying the types to     */
                         /* search for                           */

fValid = DrgVerifyType(&Dragitem, pszType);


ΓòÉΓòÉΓòÉ 6.33. DrgVerifyTypeSet ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DrgVerifyTypeSet ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DrgVerifyTypeSet ΓòÉΓòÉΓòÉ

pDragitem (PDRAGITEM) - input
   Pointer. Pointer to the DRAGITEM structure whose hstrType is to be verified.

pType (PSZ) - input
   Type string. A string specifying the types to search for. This string is in
   the format: type[,type...].

cbBuflen (ULONG) - input
   Buffer size. Size of the return buffer. The buffer should be at least one
   byte longer than the length of the string pointed to by pType.

pBuffer (PSZ) - output
   Buffer. Buffer where the intersection string is returned.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DrgVerifyTypeSet ΓòÉΓòÉΓòÉ

fMatch (BOOL) - return
   Match indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Notes - DrgVerifyTypeSet ΓòÉΓòÉΓòÉ

If at least one of the types specified by pType is present in hstrType in the
DRAGITEM structure, TRUE is returned.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DrgVerifyTypeSet ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function returns the intersection  */
/* of the contents of the string           */
/* associated with the type-string handle  */
/* for an object and an                    */
/* application-specified type string.      */
/*******************************************/

#define INCL_WINSTDDRAG
#include <os2.h>

PDRAGITEM  pDragitem;      /* Pointer */
PSZ        pType;          /* Type string */
ULONG      cbBuflen;       /* Buffer size */
PSZ        pBuffer;        /* Buffer */
BOOL       fMatch;         /* Match indicator */

fMatch = DrgVerifyTypeSet(pDragitem, pType,
           cbBuflen, pBuffer);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DrgVerifyTypeSet ΓòÉΓòÉΓòÉ

Related Functions

o DrgVerifyType
o DrgVerifyTrueType


ΓòÉΓòÉΓòÉ <hidden> Example Code - DrgVerifyTypeSet ΓòÉΓòÉΓòÉ

 In this example, the DrgVerifyTypeSet function is used to determine whether
DRT_TEXT is among the types associated with the object. If it is, the drop is
accepted.

#define INCL_WINSTDDRAG  /* Direct Manipulation (Drag) Functions */
#include <OS2.H>
#include <stdio.h>
BOOL     flResult;
DRAGITEM pditem;
char     szBuffer[32];

case DM_DRAGOVER:

   flResult = DrgVerifyTypeSet(&pditem,
                               DRT_TEXT,
                               sizeof(szBuffer),
                               szBuffer);

   flResult = strcmp(szBuffer,DRT_TEXT);

   /**************************************************************/
   /* See if the object is an OS/2 file as well as being of text */
   /* format.  AND result flag with previous result flag to get  */
   /* the "effective" return code.                               */
   /**************************************************************/

   flResult = DrgVerifyRMF(&pditem,"DRM_OS2FILE","DRF_TEXT");

   /**************************************************************/
   /* See if DRT_TEXT is the true type of the object             */
   /**************************************************************/

   flResult = DrgVerifyTrueType(&pditem,"DRF_TEXT");

   if(!flResult)

   /**************************************************************/
   /* Inform the application that you will accept the drop       */
   /**************************************************************/

   return(MRFROM2SHORT(DOR_DROP, DO_COPY));
   break;


ΓòÉΓòÉΓòÉ 7. Dynamic Data Formatting Functions ΓòÉΓòÉΓòÉ

The Information Presentation Facility (IPF) manages online, context-sensitive
help information. Dynamic Data Formatting (DDF) is used for displaying dynamic
help information. This section contains the DDF functions used to accomplish
Dynamic Data Formatting.


ΓòÉΓòÉΓòÉ 7.1. DdfBeginList ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfBeginList ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfBeginList ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

ulWidthDT (ULONG) - input
   Width of the definition term.

fBreakType (ULONG) - input
   Only the following constants may be specified:

   HMBT_ALL            Start all definition descriptions on the next line,
                       regardless of the actual lengths of definition terms.
   HMBT_FIT            Start definition description on the next line only when
                       the definition term is longer than the width specified.
   HMBT_NONE           Do not start the definition description on the next
                       line, even when the definition term is longer than the
                       width specified.

fSpacing (ULONG) - input
   Only the following constants may be specified:

   HMLS_SINGLELINE     Do not insert a blank line between each definition
                       description and the next definition term.
   HMLS_DOUBLELINE     Insert a blank line between each definition description
                       and the next definition term.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfBeginList ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfBeginList ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.

HMERR_DDF_LIST_UNCLOSED
   An attempt was made to nest a list.

HMERR_DDF_LIST_BREAKTYPE
   The value of BreakType is not valid.

HMERR_DDF_LIST_SPACING
   The value for Spacing is not valid.


ΓòÉΓòÉΓòÉ <hidden> Notes - DdfBeginList ΓòÉΓòÉΓòÉ

Once this function has been called, use of any DDF function other than
DdfListItem, DdfSetColor, and DdfEndList may produce unpredictable results.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfBeginList ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function begins a definition list  */
/* in the DDF buffer; it corresponds to    */
/* the :dl. (definition list) tag.         */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF   hddf;
ULONG  ulWidthDT;
ULONG  fBreakType;
ULONG  fSpacing;
BOOL   fsuccess;    /* Success indicator */

fsuccess = DdfBeginList(hddf, ulWidthDT,
             fBreakType, fSpacing);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfBeginList ΓòÉΓòÉΓòÉ

Related Functions

o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfBeginList ΓòÉΓòÉΓòÉ

 After initializing a DDF buffer with DdfInitialize, the example uses
DdfBeginList to indicate the beginning of a definition list in the DDF buffer
(this corresponds to the IPF dl tag). For a more detailed example and
discussion of initializing DDF, see the DdfInitialize sample.



#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>

struct _LISTITEM        /* definition list                      */
{
    PSZ Term;
    PSZ Desc;
} Definition[2] = {{"MVS", "Multiple Virtual
System"},
                   {"VM",  "Virtual Machine"}};
MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2)
{

    HWND   hwndParent;
    HWND   hwndInstance;
    HDDF   hDdf;            /* DDF handle                           */
    SHORT i;               /* loop index                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                   hwndInstance,  /* Handle of help instance */
                   0L,            /* Default buffer size     */
                   0L             /* Default increment       */
                   );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* begin definition list */
        if (!DdfBeginList(hDdf, 3L, HMBT_ALL, HMLS_SINGLELINE))
        {
            return (MRESULT)FALSE;
        }

        /* insert 2 entries into definition list */
        for (i=0; i < 2; i++)
        {
            if (!DdfListItem(hDdf, Definition[i].Term,
                                   Definition[i].Desc))
            {
               return (MRESULT)FALSE;
            }
        }

        /* terminate definition list */
        if (!DdfEndList(hDdf))
        {
            return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
    }
}


ΓòÉΓòÉΓòÉ 7.2. DdfBitmap ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfBitmap ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfBitmap ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

hbm (HBITMAP) - input
   Standard Presentation Manager bit map handle.

fAlign (ULONG) - input
   Any of the following values can be specified:

   ART_LEFT       Left-justify the bit map.
   ART_RIGHT      Right-justify the bit map.
   ART_CENTER     Center the bit map.
   ART_RUNIN      Allow the bit map to be reflowed with text.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfBitmap ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfBitmap ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.

HMERR_DDF_ALIGN_TYPE
   The alignment type is not valid.


ΓòÉΓòÉΓòÉ <hidden> Notes - DdfBitmap ΓòÉΓòÉΓòÉ

The handle to the presentation space in which the bit map was created cannot be
freed by the application while the panel is displayed.

Note:  There is a (3-byte + size of HBITMAP structure) ESC code overhead in the
       DDF internal buffer for this function.  There is a 1-byte ESC code
       overhead required for the Align flag.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfBitmap ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function places a reference to a   */
/* bit map in the DDF buffer.              */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF     hddf;
HBITMAP  hbm;
ULONG    fAlign;
BOOL     fsuccess;    /* Success indicator */

fsuccess = DdfBitmap(hddf, hbm, fAlign);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfBitmap ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfBitmap ΓòÉΓòÉΓòÉ

After initializing a DDF buffer with DdfInitialize, the example obtains a
device context (DevOpenDC), creates a presentation space (GpiCreatePS), and
loads a bit map (GpiLoadBitmap). It then uses DdfBitmap to place a reference to
the bit map in the DDF buffer. For a more detailed example and discussion of
initializing DDF, see the DdfInitialize sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_GPICONTROL         /* Basic PS control             */
#define INCL_GPIBITMAPS         /* Bit maps and Pel Operations   */
#define INCL_GPIPRIMITIVES      /* Drawing Primitives/Attributes*/
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>

#define ACVP_HAB  12
#define BM_HPS    16
#define BM_HDC    20
#define BM_HWND   24
#define ID_LEFT   255

MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
    HWND    hwndParent;     /* parent window                        */
    HWND    hwndInstance;   /* help instance window                 */
    HDDF    hDdf;           /* DDF handle                           */
    HDC     hdc;            /* device context handle                */
    HPS     hps;            /* presentation space handle            */
    HAB     hab;            /* anchor block handle                  */
    SIZEL   sizel = {0L,0L};/* size of new PS                       */
    HBITMAP hBitmap;        /* bit map handle                        */
    HMODULE hModule;        /* module handle                         */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                       hwndInstance,  /* Handle of help instance */
                       0L,            /* Default buffer size     */
                       0L             /* Default increment       */
                       );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* get module handle for bit map */
        DosQueryModuleHandle("bitmap", &hModule);
        if (hModule == NULLHANDLE)
        {
            return (MRESULT)FALSE;
        }

        /* get hab for this window */
        if ((hab = (HAB)WinQueryWindowULong(hwnd, ACVP_HAB)) == NULLHANDLE)
        {
            return (MRESULT)FALSE;
        }

        /* create a device context */
        if ((hdc = DevOpenDC(hab, OD_MEMORY, "*", 0L,
                               (PDEVOPENDATA)NULL, (HDC)NULL)) == NULLHANDLE)
        {
           return (MRESULT)FALSE;
        }

        /* save hdc in reserved word */
        WinSetWindowULong(hwnd, BM_HDC, (ULONG)hdc);


        /* create a noncached micro presentation space */
        /* and associate it with the window */
        if ((hps = GpiCreatePS(hab, hdc, &sizel, PU_PELS |
GPIF_DEFAULT
                                | GPIT_MICRO | GPIA_ASSOC)) == NULLHANDLE)
        {
           return (MRESULT)FALSE;
        }

        /* save hps in reserved word */
        WinSetWindowULong(hwnd, BM_HPS, (ULONG)hps);

        /* Load the Bit map to display */
        if ((hBitmap = GpiLoadBitmap(hps, hModule, ID_LEFT, 300L,
                                     300L)) == NULLHANDLE)
        {
            return (MRESULT)FALSE;
        }

        /* save bit map hwnd in reserved word */
        WinSetWindowULong(hwnd, BM_HWND, (ULONG)hBitmap);

        /* Display the bit map align left */
        if (!DdfBitmap(hDdf, hBitmap, (ULONG)TA_LEFT))
        {
            return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;

    case WM_CLOSE:
        /* release PS, DC, and bit map */
        GpiDestroyPS((HPS)WinQueryWindowULong(hwnd, BM_HPS));
        DevCloseDC((HDC)WinQueryWindowULong(hwnd, BM_HDC));
        GpiDeleteBitmap((HBITMAP)WinQueryWindowULong(hwnd, BM_HWND));
        WinDestroyWindow(WinQueryWindow(hwnd, QW_PARENT));
        return (MRESULT)TRUE;
    }
}


ΓòÉΓòÉΓòÉ 7.3. DdfEndList ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfEndList ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfEndList ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfEndList ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfEndList ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_LIST_UNINITIALIZED
   No definition list has been initialized by DdfBeginList.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfEndList ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function terminates the definition */
/* list initialized by DdfBeginList.       */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF  hddf;
BOOL  fsuccess; /* Success indicator */

fsuccess = DdfEndList(hddf);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfEndList ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfEndList ΓòÉΓòÉΓòÉ

 After initializing a DDF buffer with DdfInitialize, the example uses
DdfBeginList to indicate the beginning of a definition list in the DDF buffer
(this corresponds to the IPF dl tag). For a more detailed example and
discussion of initializing DDF, see the DdfInitialize sample.



#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>

struct _LISTITEM        /* definition list                      */
{
    PSZ Term;
    PSZ Desc;
} Definition[2] = {{"MVS", "Multiple Virtual
System"},
                   {"VM",  "Virtual Machine"}};
MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2)
{

    HWND   hwndParent;
    HWND   hwndInstance;
    HDDF   hDdf;            /* DDF handle                           */
    SHORT i;               /* loop index                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                   hwndInstance,  /* Handle of help instance */
                   0L,            /* Default buffer size     */
                   0L             /* Default increment       */
                   );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* begin definition list */
        if (!DdfBeginList(hDdf, 3L, HMBT_ALL, HMLS_SINGLELINE))
        {
            return (MRESULT)FALSE;
        }

        /* insert 2 entries into definition list */
        for (i=0; i < 2; i++)
        {
            if (!DdfListItem(hDdf, Definition[i].Term,
                                   Definition[i].Desc))
            {
               return (MRESULT)FALSE;
            }
        }

        /* terminate definition list */
        if (!DdfEndList(hDdf))
        {
            return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
    }
}


ΓòÉΓòÉΓòÉ 7.4. DdfHyperText ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfHyperText ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfHyperText ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

pText (PSZ) - input
   Hypertext phrase.

pReference (PSZ) - input
   The value of this parameter depends on the value of ReferenceType:

   - If ReferenceType is REFERENCE_BY_RES, this parameter must contain a
   pointer to a numeric string containing the res number; otherwise it will
   default to a res number of zero. Valid values are 1 - 64000; all other
   values are reserved.
   - If ReferenceType is REFERENCE_BY_ID, this parameter contains a pointer to
   a string containing the alphanumeric identifier of the destination panel.

fReferenceType (ULONG) - input
   This parameter specifies whether you are linking via a resource identifier
   (res number) or via an alphanumeric identifier.

   REFERENCE_BY_RES To link via a resource identifier.
   REFERENCE_BY_ID To link via an alphanumeric identifier.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfHyperText ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfHyperText ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.

HMERR_DDF_REFTYPE
   The reference type is not valid.


ΓòÉΓòÉΓòÉ <hidden> Notes - DdfHyperText ΓòÉΓòÉΓòÉ

Note:  There is a 3-byte ESC code overhead in the DDF internal buffer for each
       word in the text buffer.  There is a 1-byte ESC code overhead for each
       blank and for each newline character.  If ReferenceType is
       REFERENCE_BY_ID, then there is a (3-byte + Reference length) ESC code
       overhead. For a ReferenceType of REFERENCE_BY_RES, the overhead is 5
       bytes. Finally, there is a 3-byte ESC code overhead that is required for
       ending the hypertext link.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfHyperText ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function defines a hypertext link  */
/* to another panel.                       */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF   hddf;
PSZ    pText;
PSZ    pReference;
ULONG  fReferenceType;
BOOL   fsuccess;        /* Success indicator */

fsuccess = DdfHyperText(hddf, pText,
             pReference, fReferenceType);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfHyperText ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfHyperText ΓòÉΓòÉΓòÉ

 After initializing a DDF buffer with DdfInitialize, the example uses
DdfHyperText to create a hypertext link with another resource. For a more
detailed example and discussion of initializing DDF, see the DdfInitialize
sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>

PSZ    Text = "This text is a HYPERTEXT message.\n"; /* hypertext
                                                         string  */
PSZ    ResID = "1";     /* Resource identifier                  */

MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
    HWND   hwndParent;
    HWND   hwndInstance;
    HDDF   hDdf;            /* DDF handle                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                    hwndInstance,  /* Handle of help instance */
                    0L,            /* Default buffer size     */
                    0L             /* Default increment       */
                    );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* create hypertext link with resource 1 */
        if (!DdfHyperText(hDdf, (PSZ)Text, ResID, REFERENCE_BY_RES))
        {
            return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
    }
}


ΓòÉΓòÉΓòÉ 7.5. DdfInform ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfInform ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfInform ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

pText (PSZ) - input
   Hypertext phrase.

resInformNumber (ULONG) - input
   Res number associated with this hypertext field.  Possible values are 1 to
   64000; all other values are reserved.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfInform ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfInform ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfInform ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function defines a hypertext       */
/* inform link; it corresponds to the link */
/* tag with reftype=inform.                */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF   hddf;
PSZ    pText;
ULONG  resInformNumber;
BOOL   fsuccess;         /* Success indicator */

fsuccess = DdfInform(hddf, pText,
             resInformNumber);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfInform ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfInform ΓòÉΓòÉΓòÉ

After initializing a DDF buffer with DdfInitialize, the example uses DdfInform
to create a hypertext inform link with another resource (corresponds to the IPF
:link. tag with reftype=inform). For a more detailed example and discussion of
initializing DDF, see the DdfInitialize sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>

PSZ    Text = "This text is a HYPERTEXT message.\n"; /* hypertext
                                                         string  */
MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
    HWND   hwndParent;
    HWND   hwndInstance;
    HDDF   hDdf;            /* DDF handle                           */

    switch( ulMsg )
    {
        case HM_QUERY_DDF_DATA:
            /* get the help instance */
            hwndParent = WinQueryWindow( hwnd, QW_PARENT );
            hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
            hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                     MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                        hwndInstance,  /* Handle of help instance */
                        0L,            /* Default buffer size     */
                        0L             /* Default increment       */
                        );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* create hypertext inform link with resource 1 */
        if (!DdfInform(hDdf, (PSZ)Text, 1L))
        {
            return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
    }
}


ΓòÉΓòÉΓòÉ 7.6. DdfInitialize ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfInitialize ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfInitialize ΓòÉΓòÉΓòÉ

hwndHelpInstance (HWND) - input
   Handle of a help instance.

cbBuffer (ULONG) - input
   Initial length of internal buffer where DDF information is to be stored. If
   this field is NULL, a default value of 1K is defined.  The maximum value is
   60KB.

ulIncrement (ULONG) - input
   Amount by which to increment the buffer size, if necessary. If this field is
   NULL, a default value of 256 bytes is defined.  The maximum value is 60KB.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfInitialize ΓòÉΓòÉΓòÉ

hddfsuccess (HDDF) - return
   A handle to DDF (HDDF) is returned if initialization was successful.
   Otherwise, the value returned is:

   NULL
      An error has occurred because of insufficient memory or incorrect
      instance.


ΓòÉΓòÉΓòÉ <hidden> Notes - DdfInitialize ΓòÉΓòÉΓòÉ

At initialization, the default for dynamic data display is that text aligned on
the left, and formatting is turned on.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfInitialize ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function initializes the IPF       */
/* internal structures for dynamic data    */
/* formatting and returns a DDF handle.    */
/* The application uses this handle to     */
/* refer to a particular DDF panel.        */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HWND   hwndHelpInstance;
ULONG  cbBuffer;
ULONG  ulIncrement;
HDDF   hddfsuccess;

hddfsuccess = DdfInitialize(
                hwndHelpInstance, cbBuffer,
                ulIncrement);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfInitialize ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfInitialize ΓòÉΓòÉΓòÉ

This example shows how to initialize and use the Dynamic Data Facility for
displaying an online document. Two functions are defined: the first, SampleObj,
creates a window that will display the online information and specifies the
second function, SampleWindowProc, as the corresponding window procedure. These
two functions are compiled into a DLL and exported, so that IPF can invoke them
when it encounters the :ddf and :acviewport tags during execution. The
:acviewport tag will specify the DLL name and the SampleObj function; when IPF
calls SampleObj, it initializes an application-controlled window with
SampleWindowProc as the window procedure and returns the window handle. Later,
when IPF encounters the :ddf tag, it will send SampleWindowProc an
HM_QUERY_DDF_DATA message.  At this point, before calling any of the DDF API,
DdfInitialize must first be called to initiate a DDF buffer, after which the
other DDF API can be called to display the online information.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_WINDIALOGS         /* Dialog boxes                 */
#define INCL_DDF                /* Dynamic Data Facility        */
#define INCL_32
#include <os2.h>
#include <pmhelp.h>

#define COM_HWND 4                /* window word offsets        */
#define PAGE_HWND 8
#define ACVP_HAB  12

USHORT DdfClass = FALSE;

MRESULT EXPENTRY SampleWindowProc(HWND hWnd, ULONG Message,
                                 MPARAM lParam1, MPARAM lParam2);

USHORT APIENTRY SampleObj(PACVP pACVP, PCH Parameter)
{
HWND DdfHwnd;           /* Client window handle                  */
HWND DdfCHwnd;          /* Child window handle                   */
HWND PreviousHwnd;      /* Handle for setting comm window active */

    /* register DDF Base class if not registered already */
    if (!DdfClass)
    {
         if (!WinRegisterClass(
                   pACVP->hAB,   /* Anchor block handle           */
                   "CLASS_Ddf",  /* Application window class name */
                                 /* Address of window procedure   */
                   SampleWindowProc,
                                 /* Window class style            */
                   CS_SYNCPAINT | CS_SIZEREDRAW | CS_MOVENOTIFY,
                   20))          /* Extra storage                 */
        {
            return TRUE;
        }
        DdfClass = TRUE;
    }

    /*  create standard window  */
    if (!(DdfHwnd = WinCreateStdWindow(
                      pACVP->hWndParent, /* ACVP is parent       */
                      0L,                /* No class style       */
                      NULL,              /* Frame control flag   */
                      "CLASS_Ddf",       /* Window class name    */
                      NULL,              /* No title bar         */
                      0L,                /* No special style     */
                      0L,                /* Resource in .EXE     */
                      0,                 /* No window identifier */
                      &DdfCHwnd )))      /* Client window handle */
    {
        return FALSE;
    }

    /* store the frame window handle in ACVP data structure */
    pACVP->hWndACVP = DdfHwnd;

    /* set this window as active communication window */
    PreviousHwnd = (HWND)WinSendMsg(pACVP->hWndParent,
                           HM_SET_OBJCOM_WINDOW,
                           MPFROMHWND(DdfHwnd), NULL);

    /* save returned communication hwnd in reserved word */
    WinSetWindowULong(DdfCHwnd, COM_HWND, (ULONG)PreviousHwnd);

    /* save anchor block handle in reserved word */
    WinSetWindowULong (DdfCHwnd, ACVP_HAB, (ULONG)pACVP->hAB);

    return FALSE;
} /* SampleObj */


MRESULT EXPENTRY SampleWindowProc(HWND hWnd, ULONG Message,
                                 MPARAM lParam1, MPARAM lParam2)
{
    HWND   hwndParent;      /* parent window                        */
    HWND   hwndInstance;    /* help instance window                 */
    HDDF   hDdf;            /* DDF handle                           */
    ULONG  DdfID;           /* DDF resource id                      */

    switch (Message)
    {
    case HM_QUERY_DDF_DATA:
        WinSetWindowULong(hWnd, PAGE_HWND, LONGFROMMP(lParam1));
        DdfID = LONGFROMMP(lParam2);
        hwndParent = WinQueryWindow(hWnd, QW_PARENT);
        hwndParent = WinQueryWindow(hwndParent, QW_PARENT);
        hwndInstance = (HWND)WinSendMsg(hwndParent, HM_QUERY,
                                  MPFROMSHORT(HMQW_INSTANCE), NULL);

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                        hwndInstance,  /* Handle of help instance */
                        0L,            /* Default buffer size     */
                        0L             /* Default increment       */
                        );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;

    default:
        return (WinDefWindowProc(hWnd, Message, lParam1, lParam2));
    }
} /* SampleWindowProc */


ΓòÉΓòÉΓòÉ 7.7. DdfListItem ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfListItem ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfListItem ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

pTerm (PSZ) - input
   Term portion of the definition list entry.

pDescription (PSZ) - input
   Description portion of the definition list entry.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfListItem ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfListItem ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.

HMERR_DDF_LIST_UNINITIALIZED
   No definition list has been initialized by DdfBeginList.


ΓòÉΓòÉΓòÉ <hidden> Notes - DdfListItem ΓòÉΓòÉΓòÉ

The handle to the presentation space in which the bit map was created cannot be
freed by the application while the panel is displayed.

Note:  There is a (3-byte + size of HBITMAP structure) ESC code overhead in the
       DDF internal buffer for this function.  There is a 1-byte ESC code
       overhead required for the Align flag.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfListItem ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function inserts a definition list */
/* entry in the DDF buffer; it corresponds */
/* to a combination of the :dt.            */
/* (definition term) and :dd. (definition  */
/* define) tags.                           */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF  hddf;
PSZ   pTerm;
PSZ   pDescription;
BOOL  fsuccess;     /* Success indicator */

fsuccess = DdfListItem(hddf, pTerm,
             pDescription);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfListItem ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfListItem ΓòÉΓòÉΓòÉ

 After initializing a DDF buffer with DdfInitialize, the example uses
DdfBeginList to indicate the beginning of a definition list in the DDF buffer
(this corresponds to the IPF dl tag). For a more detailed example and
discussion of initializing DDF, see the DdfInitialize sample.



#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>

struct _LISTITEM        /* definition list                      */
{
    PSZ Term;
    PSZ Desc;
} Definition[2] = {{"MVS", "Multiple Virtual
System"},
                   {"VM",  "Virtual Machine"}};
MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2)
{

    HWND   hwndParent;
    HWND   hwndInstance;
    HDDF   hDdf;            /* DDF handle                           */
    SHORT i;               /* loop index                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                   hwndInstance,  /* Handle of help instance */
                   0L,            /* Default buffer size     */
                   0L             /* Default increment       */
                   );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* begin definition list */
        if (!DdfBeginList(hDdf, 3L, HMBT_ALL, HMLS_SINGLELINE))
        {
            return (MRESULT)FALSE;
        }

        /* insert 2 entries into definition list */
        for (i=0; i < 2; i++)
        {
            if (!DdfListItem(hDdf, Definition[i].Term,
                                   Definition[i].Desc))
            {
               return (MRESULT)FALSE;
            }
        }

        /* terminate definition list */
        if (!DdfEndList(hDdf))
        {
            return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
    }
}


ΓòÉΓòÉΓòÉ 7.8. DdfMetafile ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfMetafile ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfMetafile ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

hmf (HMF) - input
   The handle of the metafile to display.

prclRect (PRECTL) - input

   If not NULL, contains the size of the rectangle in which the metafile will
   be displayed.  The aspect ratio of the metafile is adjusted to fit this
   rectangle.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfMetafile ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfMetafile ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.


ΓòÉΓòÉΓòÉ <hidden> Notes - DdfMetafile ΓòÉΓòÉΓòÉ

Note:  There is a 3-byte ESC code overhead in the DDF internal buffer for this
       function.  There is also a (MetaFilename length) overhead. Finally, the
       Rect variable requires an additional 16 bytes of overhead in the DDF
       internal buffer.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfMetafile ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function places a reference to a   */
/* metafile into the DDF buffer.           */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF    hddf;
HMF     hmf;
PRECTL  prclRect;
BOOL    fsuccess;   /* Success indicator */

fsuccess = DdfMetafile(hddf, hmf, prclRect);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfMetafile ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfMetafile ΓòÉΓòÉΓòÉ

 After initializing a DDF buffer with DdfInitialize and loading a metafile with
GpiLoadMetaFile, the example uses DdfMetafile to place a reference to the
metafile in the DDF buffer. For a more detailed example and discussion of
initializing DDF, see the DdfInitialize sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#define INCL_GPIMETAFILES       /* MetaFiles                    */
#include <os2.h>
#include <pmhelp.h>

#define MF_HWND   0
#define ACVP_HAB  4

MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
    HWND   hwndParent;
    HAB    hab;
    HWND   hwndInstance;    /* help instance window                 */
    HDDF   hDdf;            /* DDF handle                           */
    HMF    hwndMetaFile;    /* metafile handle                      */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                    hwndInstance,  /* Handle of help instance */
                    0L,            /* Default buffer size     */
                    0L             /* Default increment       */
                    );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* get hab for this window */
        if ((hab = (HAB)WinQueryWindowULong(hwnd, ACVP_HAB)) == NULLHANDLE)
        {
           return (MRESULT)FALSE;
        }

        /* Load the Metafile to display */
        if ((hwndMetaFile = GpiLoadMetaFile(hab, "SAMP.MET")) == NULLHANDLE)
        {
            return (MRESULT)FALSE;
        }

        /* Save MetaFile hwnd in reserved word */
        WinSetWindowULong(hwnd, MF_HWND, hwndMetaFile);

        if (!DdfMetafile(hDdf, hwndMetaFile, NULL))
        {
            return (MRESULT)FALSE;
        }

        return (hDdf);

    case WM_CLOSE:
        GpiDeleteMetaFile((HMF)WinQueryWindowULong(hwnd, MF_HWND));
        WinDestroyWindow(WinQueryWindow(hwnd, QW_PARENT));

        return (MRESULT)TRUE;
    }
    return WinDefWindowProc( hwnd, ulMsg, mp1, mp2 );
}


ΓòÉΓòÉΓòÉ 7.9. DdfPara ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfPara ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfPara ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfPara ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfPara ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.


ΓòÉΓòÉΓòÉ <hidden> Notes - DdfPara ΓòÉΓòÉΓòÉ

Note:  There is a 1-byte ESC code overhead in the DDF internal buffer for this function.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfPara ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function creates a paragraph       */
/* within the DDF buffer. It corresponds   */
/* to the :p. tag. This function places a  */
/* reference to a bit map in the DDF       */
/* buffer.                                 */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF  hddf;
BOOL  fsuccess; /* Success indicator */

fsuccess = DdfPara(hddf);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfPara ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfPara ΓòÉΓòÉΓòÉ

After initializing a DDF buffer with DdfInitialize, the example uses DdfPara to
start a new paragraph, DdfSetFont and DdfSetFontStyle to have the text
displayed in a large, bold Courier font, DdfSetColor to change the text color,
and DdfText to place text in the buffer.  For a more detailed example and
discussion of initializing DDF, see the DdfInitialize sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>


MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
   HWND   hwndParent;
   HWND   hwndInstance;    /* help instance window                 */
   HDDF   hDdf;            /* DDF handle                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                    hwndInstance,  /* Handle of help instance */
                    0L,            /* Default buffer size     */
                    0L             /* Default increment       */
                    );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* create paragraph in DDF buffer */
        if( !DdfPara( hDdf ) )
        {
           return (MRESULT)FALSE;
        }

        /* Change to large (100 x 100 dimensions) Courier font */
        if( !DdfSetFont( hDdf, "Courier", 100L, 100L ) )
        {
           return (MRESULT)FALSE;
        }

        /* make the font BOLDFACE */
        if( !DdfSetFontStyle( hDdf, FM_SEL_BOLD ) )
        {
           return (MRESULT)FALSE;
        }

        /* make the text display as BLUE on a PALE GRAY background */
        if( !DdfSetColor( hDdf, CLR_PALEGRAY, CLR_BLUE ) )
        {
           return (MRESULT)FALSE;
        }

        /* Write data into the buffer */
        if (!DdfText(hDdf, "Sample Text"))
        {
           return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
    }
    return WinDefWindowProc( hwnd, ulMsg, mp1, mp2 );
}


ΓòÉΓòÉΓòÉ 7.10. DdfSetColor ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfSetColor ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfSetColor ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

BackColor (COLOR) - input
   Specifies the desired background color.

ForColor (COLOR) - input
   Specifies the desired foreground color.

   The following color value constants may be used for the foreground and
   background colors:

   CLR_DEFAULT -  used to set IPF default text color
   CLR_BLACK
   CLR_BLUE
   CLR_RED
   CLR_PINK
   CLR_GREEN
   CLR_CYAN
   CLR_YELLOW
   CLR_BROWN
   CLR_DARKGRAY
   CLR_DARKBLUE
   CLR_DARKRED
   CLR_DARKPINK
   CLR_DARKGREEN
   CLR_DARKCYAN
   CLR_PALEGRAY
   CLR_UNCHANGED


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfSetColor ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfSetColor ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.

HMERR_DDF_BACKCOLOR
   The background color is not valid.

HMERR_DDF_FORCOLOR
   The foreground color is not valid.


ΓòÉΓòÉΓòÉ <hidden> Notes - DdfSetColor ΓòÉΓòÉΓòÉ

Note:  There is a 4-byte ESC code overhead in the DDF internal buffer for the
       foreground color, and a 4-byte overhead for the background color, with
       this function.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfSetColor ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function sets the background and   */
/* foreground colors of the displayed text.*/
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF   hddf;
COLOR  BackColor;
COLOR  ForColor;
BOOL   fsuccess;   /* Success indicator */

fsuccess = DdfSetColor(hddf, BackColor,
             ForColor);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfSetColor ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfSetColor ΓòÉΓòÉΓòÉ

After initializing a DDF buffer with DdfInitialize, the example uses DdfPara to
start a new paragraph, DdfSetFont and DdfSetFontStyle to have the text
displayed in a large, bold Courier font, DdfSetColor to change the text color,
and DdfText to place text in the buffer.  For a more detailed example and
discussion of initializing DDF, see the DdfInitialize sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>


MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
   HWND   hwndParent;
   HWND   hwndInstance;    /* help instance window                 */
   HDDF   hDdf;            /* DDF handle                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                    hwndInstance,  /* Handle of help instance */
                    0L,            /* Default buffer size     */
                    0L             /* Default increment       */
                    );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* create paragraph in DDF buffer */
        if( !DdfPara( hDdf ) )
        {
           return (MRESULT)FALSE;
        }

        /* Change to large (100 x 100 dimensions) Courier font */
        if( !DdfSetFont( hDdf, "Courier", 100L, 100L ) )
        {
           return (MRESULT)FALSE;
        }

        /* make the font BOLDFACE */
        if( !DdfSetFontStyle( hDdf, FM_SEL_BOLD ) )
        {
           return (MRESULT)FALSE;
        }

        /* make the text display as BLUE on a PALE GRAY background */
        if( !DdfSetColor( hDdf, CLR_PALEGRAY, CLR_BLUE ) )
        {
           return (MRESULT)FALSE;
        }

        /* Write data into the buffer */
        if (!DdfText(hDdf, "Sample Text"))
        {
           return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
    }
    return WinDefWindowProc( hwnd, ulMsg, mp1, mp2 );
}


ΓòÉΓòÉΓòÉ 7.11. DdfSetFont ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfSetFont ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfSetFont ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

pFaceName (PSZ) - input
   This parameter can be specified in two ways:

   An ASCIIZ string specifying the font name.
   "NULL" or "DEFAULT" to specify the default font.

ulWidth (ULONG) - input
   Font width in in points.  A point is approximately 1/72 of an inch

ulHeight (ULONG) - input
   Font height in points.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfSetFont ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfSetFont ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfSetFont ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function specifies a text font in  */
/* the DDF buffer.                         */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF   hddf;
PSZ    pFaceName;
ULONG  ulWidth;
ULONG  ulHeight;
BOOL   fsuccess;   /* Success indicator */

fsuccess = DdfSetFont(hddf, pFaceName,
             ulWidth, ulHeight);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfSetFont ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFontStyle
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfSetFont ΓòÉΓòÉΓòÉ

After initializing a DDF buffer with DdfInitialize, the example uses DdfPara to
start a new paragraph, DdfSetFont and DdfSetFontStyle to have the text
displayed in a large, bold Courier font, DdfSetColor to change the text color,
and DdfText to place text in the buffer.  For a more detailed example and
discussion of initializing DDF, see the DdfInitialize sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>


MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
   HWND   hwndParent;
   HWND   hwndInstance;    /* help instance window                 */
   HDDF   hDdf;            /* DDF handle                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                    hwndInstance,  /* Handle of help instance */
                    0L,            /* Default buffer size     */
                    0L             /* Default increment       */
                    );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* create paragraph in DDF buffer */
        if( !DdfPara( hDdf ) )
        {
           return (MRESULT)FALSE;
        }

        /* Change to large (100 x 100 dimensions) Courier font */
        if( !DdfSetFont( hDdf, "Courier", 100L, 100L ) )
        {
           return (MRESULT)FALSE;
        }

        /* make the font BOLDFACE */
        if( !DdfSetFontStyle( hDdf, FM_SEL_BOLD ) )
        {
           return (MRESULT)FALSE;
        }

        /* make the text display as BLUE on a PALE GRAY background */
        if( !DdfSetColor( hDdf, CLR_PALEGRAY, CLR_BLUE ) )
        {
           return (MRESULT)FALSE;
        }

        /* Write data into the buffer */
        if (!DdfText(hDdf, "Sample Text"))
        {
           return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
    }
    return WinDefWindowProc( hwnd, ulMsg, mp1, mp2 );
}


ΓòÉΓòÉΓòÉ 7.12. DdfSetFontStyle ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfSetFontStyle ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfSetFontStyle ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

fFontStyle (ULONG) - input
   A NULL value for this parameter will set the font-style back to the default.
   Any of the following values can be specified:

   FM_SEL_ITALIC
   FM_SEL_BOLD
   FM_SEL_UNDERSCORE

These values can be "ORed" together to combine different font styles.

Note:  There is a 4-byte ESC code overhead in the DDF internal buffer for FontStyle.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfSetFontStyle ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfSetFontStyle ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.

HMERR_DDF_FONTSTYLE
   The font style is not valid.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfSetFontStyle ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function specifies a text font     */
/* style in the DDF buffer.                */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF   hddf;
ULONG  fFontStyle;
BOOL   fsuccess;    /* Success indicator */

fsuccess = DdfSetFontStyle(hddf, fFontStyle);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfSetFontStyle ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFormat
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfSetFontStyle ΓòÉΓòÉΓòÉ

After initializing a DDF buffer with DdfInitialize, the example uses DdfPara to
start a new paragraph, DdfSetFont and DdfSetFontStyle to have the text
displayed in a large, bold Courier font, DdfSetColor to change the text color,
and DdfText to place text in the buffer.  For a more detailed example and
discussion of initializing DDF, see the DdfInitialize sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>


MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
   HWND   hwndParent;
   HWND   hwndInstance;    /* help instance window                 */
   HDDF   hDdf;            /* DDF handle                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                    hwndInstance,  /* Handle of help instance */
                    0L,            /* Default buffer size     */
                    0L             /* Default increment       */
                    );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* create paragraph in DDF buffer */
        if( !DdfPara( hDdf ) )
        {
           return (MRESULT)FALSE;
        }

        /* Change to large (100 x 100 dimensions) Courier font */
        if( !DdfSetFont( hDdf, "Courier", 100L, 100L ) )
        {
           return (MRESULT)FALSE;
        }

        /* make the font BOLDFACE */
        if( !DdfSetFontStyle( hDdf, FM_SEL_BOLD ) )
        {
           return (MRESULT)FALSE;
        }

        /* make the text display as BLUE on a PALE GRAY background */
        if( !DdfSetColor( hDdf, CLR_PALEGRAY, CLR_BLUE ) )
        {
           return (MRESULT)FALSE;
        }

        /* Write data into the buffer */
        if (!DdfText(hDdf, "Sample Text"))
        {
           return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
    }
    return WinDefWindowProc( hwnd, ulMsg, mp1, mp2 );
}


ΓòÉΓòÉΓòÉ 7.13. DdfSetFormat ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfSetFormat ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfSetFormat ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

fFormatType (ULONG) - input
   Only the following constants may be used in this parameter:

   TRUE      Turn formatting on.
   FALSE     Turn formatting off.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfSetFormat ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfSetFormat ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_MEMORY
   Not enough memory is available.


ΓòÉΓòÉΓòÉ <hidden> Notes - DdfSetFormat ΓòÉΓòÉΓòÉ

Note:  If formatting is ON, there is a 3-byte ESC code overhead in the DDF
       internal buffer for this function.  Otherwise, there is a 4-byte ESC
       code overhead.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfSetFormat ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function is used to turn           */
/* formatting off or on. It corresponds to */
/* the :lines. tag.                        */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF   hddf;
ULONG  fFormatType;
BOOL   fsuccess;     /* Success indicator */

fsuccess = DdfSetFormat(hddf, fFormatType);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfSetFormat ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfText
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfSetFormat ΓòÉΓòÉΓòÉ

After initializing a DDF buffer with DdfInitialize, the example uses
DdfSetTextAlign to specify left justified test in the DDF buffer when
formatting is OFF.  The example then uses DdfSetFormat to turn off formatting
for text in the DDF buffer (corresponds to the IPF lines tag). For a more
detailed example and discussion of initializing DDF, see the DdfInitialize
sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_GPIPRIMITIVES      /* Drawing Primitives/Attributes*/
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>


MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
   HWND   hwndParent;
   HWND   hwndInstance;    /* help instance window                 */
   HDDF   hDdf;            /* DDF handle                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                    hwndInstance,  /* Handle of help instance */
                    0L,            /* Default buffer size     */
                    0L             /* Default increment       */
                    );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
           return (MRESULT)FALSE;
        }

        /* left justify text when formatting is OFF */
        if (!DdfSetTextAlign(hDdf, TA_LEFT))
        {
           return (MRESULT)FALSE;
        }

        /* turn formatting OFF */
        if (!DdfSetFormat(hDdf, FALSE))
        {
           return (MRESULT)FALSE;
        }

        if (!DdfText(hDdf,
                "Format OFF: This text should be Left Aligned!\n"))
        {
           return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
     }
     return WinDefWindowProc( hwnd, ulMsg, mp1, mp2 );
}


ΓòÉΓòÉΓòÉ 7.14. DdfSetTextAlign ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfSetTextAlign ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Errors
Notes
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfSetTextAlign ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

fAlign (ULONG) - input
   Only the following constants may be used:

   TA_LEFT        Left-justify text.
   TA_RIGHT       Right-justify text.
   TA_CENTER      Center text.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfSetTextAlign ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Errors - DdfSetTextAlign ΓòÉΓòÉΓòÉ

Possible returns from WinGetLastError

HMERR_DDF_ALIGN_TYPE
   The alignment type is not valid.


ΓòÉΓòÉΓòÉ <hidden> Notes - DdfSetTextAlign ΓòÉΓòÉΓòÉ

It should be called before DdfSetFormat is called to turn off text formatting,
and should not be called again until formatting is turned back on.  Note that
leading and trailing spaces are not stripped from the text as a result of this
alignment.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfSetTextAlign ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function defines whether left,     */
/* center, or right text justification is  */
/* to be used when text formatting is off. */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF   hddf;
ULONG  fAlign;
BOOL   fsuccess;  /* Success indicator */

fsuccess = DdfSetTextAlign(hddf, fAlign);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfSetTextAlign ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfText


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfSetTextAlign ΓòÉΓòÉΓòÉ

After initializing a DDF buffer with DdfInitialize, the example uses
DdfSetTextAlign to specify left justified test in the DDF buffer when
formatting is OFF.  The example then uses DdfSetFormat to turn off formatting
for text in the DDF buffer (corresponds to the IPF lines tag). For a more
detailed example and discussion of initializing DDF, see the DdfInitialize
sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_GPIPRIMITIVES      /* Drawing Primitives/Attributes*/
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>


MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
   HWND   hwndParent;
   HWND   hwndInstance;    /* help instance window                 */
   HDDF   hDdf;            /* DDF handle                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                    hwndInstance,  /* Handle of help instance */
                    0L,            /* Default buffer size     */
                    0L             /* Default increment       */
                    );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
           return (MRESULT)FALSE;
        }

        /* left justify text when formatting is OFF */
        if (!DdfSetTextAlign(hDdf, TA_LEFT))
        {
           return (MRESULT)FALSE;
        }

        /* turn formatting OFF */
        if (!DdfSetFormat(hDdf, FALSE))
        {
           return (MRESULT)FALSE;
        }

        if (!DdfText(hDdf,
                "Format OFF: This text should be Left Aligned!\n"))
        {
           return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
     }
     return WinDefWindowProc( hwnd, ulMsg, mp1, mp2 );
}


ΓòÉΓòÉΓòÉ 7.15. DdfText ΓòÉΓòÉΓòÉ


ΓòÉΓòÉΓòÉ <hidden> Topics - DdfText ΓòÉΓòÉΓòÉ

Select an item:

Function Syntax
Parameters
Return Values
Example
Related Functions
Glossary


ΓòÉΓòÉΓòÉ <hidden> Parameters - DdfText ΓòÉΓòÉΓòÉ

hddf (HDDF) - input
   Handle to DDF returned by DdfInitialize.

pText (PSZ) - input
   Pointer to the text buffer to be formatted.

   Note:  There is a 3-byte ESC code overhead in the DDF internal buffer for
          each word in the text buffer.  There is a 1-byte ESC code overhead
          for each blank and for each newline character.


ΓòÉΓòÉΓòÉ <hidden> Return Values - DdfText ΓòÉΓòÉΓòÉ

fsuccess (BOOL) - return
   Success indicator.

   TRUE
      Successful completion.

   FALSE
      Error occurred.


ΓòÉΓòÉΓòÉ <hidden> Syntax - DdfText ΓòÉΓòÉΓòÉ

/*******************************************/
/* This function adds text to the DDF      */
/* buffer.                                 */
/*******************************************/

#define INCL_DDF
#include <os2.h>

HDDF  hddf;
PSZ   pText;
BOOL  fsuccess; /* Success indicator */

fsuccess = DdfText(hddf, pText);


ΓòÉΓòÉΓòÉ <hidden> Related Functions - DdfText ΓòÉΓòÉΓòÉ

Related Functions

o DdfBeginList
o DdfBitmap
o DdfEndList
o DdfHyperText
o DdfInform
o DdfInitialize
o DdfListItem
o DdfMetafile
o DdfPara
o DdfSetColor
o DdfSetFont
o DdfSetFontStyle
o DdfSetFormat
o DdfSetTextAlign


ΓòÉΓòÉΓòÉ <hidden> Example Code - DdfText ΓòÉΓòÉΓòÉ

After initializing a DDF buffer with DdfInitialize, the example uses DdfPara to
start a new paragraph, DdfSetFont and DdfSetFontStyle to have the text
displayed in a large, bold Courier font, DdfSetColor to change the text color,
and DdfText to place text in the buffer.  For a more detailed example and
discussion of initializing DDF, see the DdfInitialize sample.

#define INCL_WINWINDOWMGR       /* General window management    */
#define INCL_WINMESSAGEMGR      /* Message management           */
#define INCL_DDF                /* Dynamic Data Facility        */
#include <os2.h>
#include <pmhelp.h>


MRESULT WindowProc( HWND hwnd, ULONG ulMsg, MPARAM mp1, MPARAM mp2 )
{
   HWND   hwndParent;
   HWND   hwndInstance;    /* help instance window                 */
   HDDF   hDdf;            /* DDF handle                           */

    switch( ulMsg )
    {
    case HM_QUERY_DDF_DATA:
        /* get the help instance */
        hwndParent = WinQueryWindow( hwnd, QW_PARENT );
        hwndParent = WinQueryWindow( hwndParent, QW_PARENT );
        hwndInstance = (HWND)WinSendMsg( hwndParent, HM_QUERY,
                                 MPFROMSHORT( HMQW_INSTANCE ), NULL );

        /* Allocate 1K Buffer (default)  */
        hDdf = DdfInitialize(
                    hwndInstance,  /* Handle of help instance */
                    0L,            /* Default buffer size     */
                    0L             /* Default increment       */
                    );

        if (hDdf == NULLHANDLE)       /* Check return code       */
        {
            return (MRESULT)FALSE;
        }

        /* create paragraph in DDF buffer */
        if( !DdfPara( hDdf ) )
        {
           return (MRESULT)FALSE;
        }

        /* Change to large (100 x 100 dimensions) Courier font */
        if( !DdfSetFont( hDdf, "Courier", 100L, 100L ) )
        {
           return (MRESULT)FALSE;
        }

        /* make the font BOLDFACE */
        if( !DdfSetFontStyle( hDdf, FM_SEL_BOLD ) )
        {
           return (MRESULT)FALSE;
        }

        /* make the text display as BLUE on a PALE GRAY background */
        if( !DdfSetColor( hDdf, CLR_PALEGRAY, CLR_BLUE ) )
        {
           return (MRESULT)FALSE;
        }

        /* Write data into the buffer */
        if (!DdfText(hDdf, "Sample Text"))
        {
           return (MRESULT)FALSE;
        }

        return (MRESULT)hDdf;
    }
    return WinDefWindowProc( hwnd, ulMsg, mp1, mp2 );
}


ΓòÉΓòÉΓòÉ 8. Errors ΓòÉΓòÉΓòÉ

Error codes are furnished numerically and alphabetically.

o For a listing of error codes by number, see Error Number and Name.

o For a listing of error codes and their explanations, see Error Name and
  Explanation.


ΓòÉΓòÉΓòÉ 8.1. Error Number and Name ΓòÉΓòÉΓòÉ

This section lists PM errors returned by WinGetLastError in order of their
error numbers. For explanations of these errors, see Error Name and
Explanation.

Error Number   Error Constant
0x0000         PMERR_OK
0x1001         HMERR_NO_FRAME_WND_IN_CHAIN
0x1001         PMERR_INVALID_HWND
0x1002         HMERR_INVALID_ASSOC_APP_WND
0x1002         PMERR_INVALID_HMQ
0x1003         HMERR_INVALID_ASSOC_HELP_INST
0x1003         PMERR_PARAMETER_OUT_OF_RANGE
0x1004         HMERR_INVALID_DESTROY_HELP_INST
0x1004         PMERR_WINDOW_LOCK_UNDERFLOW
0x1005         HMERR_NO_HELP_INST_IN_CHAIN
0x1005         PMERR_WINDOW_LOCK_OVERFLOW
0x1006         HMERR_INVALID_HELP_INSTANCE_HDL
0x1006         PMERR_BAD_WINDOW_LOCK_COUNT
0x1007         HMERR_INVALID_QUERY_APP_WND
0x1007         PMERR_WINDOW_NOT_LOCKED
0x1008         HMERR_HELP_INST_CALLED_INVALID
0x1008         PMERR_INVALID_SELECTOR
0x1009         HMERR_HELPTABLE_UNDEFINE
0x1009         PMERR_CALL_FROM_WRONG_THREAD
0x100A         HMERR_HELP_INSTANCE_UNDEFINE
0x100A         PMERR_RESOURCE_NOT_FOUND
0x100B         HMERR_HELPITEM_NOT_FOUND
0x100B         PMERR_INVALID_STRING_PARM
0x100C         HMERR_INVALID_HELPSUBITEM_SIZE
0x100C         PMERR_INVALID_HHEAP
0x100D         HMERR_HELPSUBITEM_NOT_FOUND
0x100D         PMERR_INVALID_HEAP_POINTER
0x100E         PMERR_INVALID_HEAP_SIZE_PARM
0x100F         PMERR_INVALID_HEAP_SIZE
0x1010         PMERR_INVALID_HEAP_SIZE_WORD
0x1011         PMERR_HEAP_OUT_OF_MEMORY
0x1012         PMERR_HEAP_MAX_SIZE_REACHED
0x1013         PMERR_INVALID_HATOMTBL
0x1014         PMERR_INVALID_ATOM
0x1015         PMERR_INVALID_ATOM_NAME
0x1016         PMERR_INVALID_INTEGER_ATOM
0x1017         PMERR_ATOM_NAME_NOT_FOUND
0x1018         PMERR_QUEUE_TOO_LARGE
0x1019         PMERR_INVALID_FLAG
0x101A         PMERR_INVALID_HACCEL
0x101B         PMERR_INVALID_HPTR
0x101C         PMERR_INVALID_HENUM
0x101D         PMERR_INVALID_SRC_CODEPAGE
0x101E         PMERR_INVALID_DST_CODEPAGE
0x101F         PMERR_UNKNOWN_COMPONENT_ID
0x1020         PMERR_UNKNOWN_ERROR_CODE
0x1021         PMERR_SEVERITY_LEVELS
0x1034         PMERR_INVALID_RESOURCE_FORMAT
0x1036         PMERR_NO_MSG_QUEUE
0x1037         PMERR_WIN_DEBUGMSG
0x1038         PMERR_QUEUE_FULL
0x1039         PMERR_LIBRARY_LOAD_FAILED
0x103A         PMERR_PROCEDURE_LOAD_FAILED
0x103B         PMERR_LIBRARY_DELETE_FAILED
0x103C         PMERR_PROCEDURE_DELETE_FAILED
0x103D         PMERR_ARRAY_TOO_LARGE
0x103E         PMERR_ARRAY_TOO_SMALL
0x103F         PMERR_DATATYPE_ENTRY_BAD_INDEX
0x1040         PMERR_DATATYPE_ENTRY_CTL_BAD
0x1041         PMERR_DATATYPE_ENTRY_CTL_MISS
0x1042         PMERR_DATATYPE_ENTRY_INVALID
0x1043         PMERR_DATATYPE_ENTRY_NOT_NUM
0x1044         PMERR_DATATYPE_ENTRY_NOT_OFF
0x1045         PMERR_DATATYPE_INVALID
0x1046         PMERR_DATATYPE_NOT_UNIQUE
0x1047         PMERR_DATATYPE_TOO_LONG
0x1048         PMERR_DATATYPE_TOO_SMALL
0x1049         PMERR_DIRECTION_INVALID
0x104A         PMERR_INVALID_HAB
0x104D         PMERR_INVALID_HSTRUCT
0x104E         PMERR_LENGTH_TOO_SMALL
0x104F         PMERR_MSGID_TOO_SMALL
0x1050         PMERR_NO_HANDLE_ALLOC
0x1051         PMERR_NOT_IN_A_PM_SESSION
0x1052         PMERR_MSG_QUEUE_ALREADY_EXISTS
0x1101         PMERR_INVALID_PIB
0x1102         PMERR_INSUFF_SPACE_TO_ADD
0x1103         PMERR_INVALID_GROUP_HANDLE
0x1104         PMERR_DUPLICATE_TITLE
0x1105         PMERR_INVALID_TITLE
0x1107         PMERR_HANDLE_NOT_IN_GROUP
0x1106         PMERR_INVALID_TARGET_HANDLE
0x1108         PMERR_INVALID_PATH_STATEMENT
0x1109         PMERR_NO_PROGRAM_FOUND
0x110A         PMERR_INVALID_BUFFER_SIZE
0x110B         PMERR_BUFFER_TOO_SMALL
0x110C         PMERR_PL_INITIALISATION_FAIL
0x110D         PMERR_CANT_DESTROY_SYS_GROUP
0x110E         PMERR_INVALID_TYPE_CHANGE
0x110F         PMERR_INVALID_PROGRAM_HANDLE
0x1110         PMERR_NOT_CURRENT_PL_VERSION
0x1111         PMERR_INVALID_CIRCULAR_REF
0x1112         PMERR_MEMORY_ALLOCATION_ERR
0x1113         PMERR_MEMORY_DEALLOCATION_ERR
0x1114         PMERR_TASK_HEADER_TOO_BIG
0x1115         PMERR_INVALID_INI_FILE_HANDLE
0x1116         PMERR_MEMORY_SHARE
0x1117         PMERR_OPEN_QUEUE
0x1118         PMERR_CREATE_QUEUE
0x1119         PMERR_WRITE_QUEUE
0x111A         PMERR_READ_QUEUE
0x111B         PMERR_CALL_NOT_EXECUTED
0x111C         PMERR_UNKNOWN_APIPKT
0x111D         PMERR_INITHREAD_EXISTS
0x111E         PMERR_CREATE_THREAD
0x111F         PMERR_NO_HK_PROFILE_INSTALLED
0x1120         PMERR_INVALID_DIRECTORY
0x1121         PMERR_WILDCARD_IN_FILENAME
0x1122         PMERR_FILENAME_BUFFER_FULL
0x1123         PMERR_FILENAME_TOO_LONG
0x1124         PMERR_INI_FILE_IS_SYS_OR_USER
0x1125         PMERR_BROADCAST_PLMSG
0x1126         PMERR_190_INIT_DONE
0x1127         PMERR_HMOD_FOR_PMSHAPI
0x1128         PMERR_SET_HK_PROFILE
0x1129         PMERR_API_NOT_ALLOWED
0x112A         PMERR_INI_STILL_OPEN
0x112B         PMERR_PROGDETAILS_NOT_IN_INI
0x112C         PMERR_PIBSTRUCT_NOT_IN_INI
0x112D         PMERR_INVALID_DISKPROGDETAILS
0x112E         PMERR_PROGDETAILS_READ_FAILURE
0x112F         PMERR_PROGDETAILS_WRITE_FAILURE
0x1130         PMERR_PROGDETAILS_QSIZE_FAILURE
0x1131         PMERR_INVALID_PROGDETAILS
0x1132         PMERR_SHEPROFILEHOOK_NOT_FOUND
0x1133         PMERR_190PLCONVERTED
0x1134         PMERR_FAILED_TO_CONVERT_INI_PL
0x1135         PMERR_PMSHAPI_NOT_INITIALISED
0x1136         PMERR_INVALID_SHELL_API_HOOK_ID
0x1200         PMERR_DOS_ERROR
0x1201         PMERR_NO_SPACE
0x1202         PMERR_INVALID_SWITCH_HANDLE
0x1203         PMERR_NO_HANDLE
0x1204         PMERR_INVALID_PROCESS_ID
0x1205         PMERR_NOT_SHELL
0x1206         PMERR_INVALID_WINDOW
0x1207         PMERR_INVALID_POST_MSG
0x1208         PMERR_INVALID_PARAMETERS
0x1209         PMERR_INVALID_PROGRAM_TYPE
0x120A         PMERR_NOT_EXTENDED_FOCUS
0x120B         PMERR_INVALID_SESSION_ID
0x120C         PMERR_SMG_INVALID_ICON_FILE
0x120D         PMERR_SMG_ICON_NOT_CREATED
0x120E         PMERR_SHL_DEBUG
0x1301         PMERR_OPENING_INI_FILE
0x1302         PMERR_INI_FILE_CORRUPT
0x1303         PMERR_INVALID_PARM
0x1304         PMERR_NOT_IN_IDX
0x1305         PMERR_NO_ENTRIES_IN_GROUP
0x1306         PMERR_INI_WRITE_FAIL
0x1307         PMERR_IDX_FULL
0x1308         PMERR_INI_PROTECTED
0x1309         PMERR_MEMORY_ALLOC
0x130A         PMERR_INI_INIT_ALREADY_DONE
0x130B         PMERR_INVALID_INTEGER
0x130C         PMERR_INVALID_ASCIIZ
0x130D         PMERR_CAN_NOT_CALL_SPOOLER
0x130D         PMERR_VALIDATION_REJECTED
0x1401         PMERR_WARNING_WINDOW_NOT_KILLED
0x1402         PMERR_ERROR_INVALID_WINDOW
0x1403         PMERR_ALREADY_INITIALIZED
0x1405         PMERR_MSG_PROG_NO_MOU
0x1406         PMERR_MSG_PROG_NON_RECOV
0x1407         PMERR_WINCONV_INVALID_PATH
0x1408         PMERR_PI_NOT_INITIALISED
0x1409         PMERR_PL_NOT_INITIALISED
0x140A         PMERR_NO_TASK_MANAGER
0x140B         PMERR_SAVE_NOT_IN_PROGRESS
0x140C         PMERR_NO_STACK_SPACE
0x140d         PMERR_INVALID_COLR_FIELD
0x140e         PMERR_INVALID_COLR_VALUE
0x140f         PMERR_COLR_WRITE
0x1501         PMERR_TARGET_FILE_EXISTS
0x1502         PMERR_SOURCE_SAME_AS_TARGET
0x1503         PMERR_SOURCE_FILE_NOT_FOUND
0x1504         PMERR_INVALID_NEW_PATH
0x1505         PMERR_TARGET_FILE_NOT_FOUND
0x1506         PMERR_INVALID_DRIVE_NUMBER
0x1507         PMERR_NAME_TOO_LONG
0x1508         PMERR_NOT_ENOUGH_ROOM_ON_DISK
0x1509         PMERR_NOT_ENOUGH_MEM
0x150B         PMERR_LOG_DRV_DOES_NOT_EXIST
0x150C         PMERR_INVALID_DRIVE
0x150D         PMERR_ACCESS_DENIED
0x150E         PMERR_NO_FIRST_SLASH
0x150F         PMERR_READ_ONLY_FILE
0x151F         PMERR_GROUP_PROTECTED
0x152F         PMERR_INVALID_PROGRAM_CATEGORY
0x1530         PMERR_INVALID_APPL
0x1531         PMERR_CANNOT_START
0x1532         PMERR_STARTED_IN_BACKGROUND
0x1533         PMERR_INVALID_HAPP
0x1534         PMERR_CANNOT_STOP
0x1601         PMERR_INTERNAL_ERROR_1
0x1602         PMERR_INTERNAL_ERROR_2
0x1603         PMERR_INTERNAL_ERROR_3
0x1604         PMERR_INTERNAL_ERROR_4
0x1605         PMERR_INTERNAL_ERROR_5
0x1606         PMERR_INTERNAL_ERROR_6
0x1607         PMERR_INTERNAL_ERROR_7
0x1608         PMERR_INTERNAL_ERROR_8
0x1609         PMERR_INTERNAL_ERROR_9
0x160A         PMERR_INTERNAL_ERROR_10
0x160B         PMERR_INTERNAL_ERROR_11
0x160C         PMERR_INTERNAL_ERROR_12
0x160D         PMERR_INTERNAL_ERROR_13
0x160E         PMERR_INTERNAL_ERROR_14
0x160F         PMERR_INTERNAL_ERROR_15
0x1610         PMERR_INTERNAL_ERROR_16
0x1611         PMERR_INTERNAL_ERROR_17
0x1612         PMERR_INTERNAL_ERROR_18
0x1613         PMERR_INTERNAL_ERROR_19
0x1614         PMERR_INTERNAL_ERROR_20
0x1615         PMERR_INTERNAL_ERROR_21
0x1616         PMERR_INTERNAL_ERROR_22
0x1617         PMERR_INTERNAL_ERROR_23
0x1618         PMERR_INTERNAL_ERROR_24
0x1619         PMERR_INTERNAL_ERROR_25
0x161A         PMERR_INTERNAL_ERROR_26
0x161B         PMERR_INTERNAL_ERROR_27
0x161C         PMERR_INTERNAL_ERROR_28
0x161D         PMERR_INTERNAL_ERROR_29
0x1630         PMERR_INVALID_FREE_MESSAGE_ID
0x1641         PMERR_FUNCTION_NOT_SUPPORTED
0x1642         PMERR_INVALID_ARRAY_COUNT
0x1643         PMERR_INVALID_LENGTH
0x1644         PMERR_INVALID_BUNDLE_TYPE
0x1645         PMERR_INVALID_PARAMETER
0x1646         PMERR_INVALID_NUMBER_OF_PARMS
0x1647         PMERR_GREATER_THAN_64K
0x1648         PMERR_INVALID_PARAMETER_TYPE
0x1649         PMERR_NEGATIVE_STRCOND_DIM
0x164A         PMERR_INVALID_NUMBER_OF_TYPES
0x164B         PMERR_INCORRECT_HSTRUCT
0x164C         PMERR_INVALID_ARRAY_SIZE
0x164D         PMERR_INVALID_CONTROL_DATATYPE
0x164E         PMERR_INCOMPLETE_CONTROL_SEQU
0x164F         PMERR_INVALID_DATATYPE
0x1650         PMERR_INCORRECT_DATATYPE
0x1651         PMERR_NOT_SELF_DESCRIBING_DTYP
0x1652         PMERR_INVALID_CTRL_SEQ_INDEX
0x1653         PMERR_INVALID_TYPE_FOR_LENGTH
0x1654         PMERR_INVALID_TYPE_FOR_OFFSET
0x1655         PMERR_INVALID_TYPE_FOR_MPARAM
0x1656         PMERR_INVALID_MESSAGE_ID
0x1657         PMERR_C_LENGTH_TOO_SMALL
0x1658         PMERR_APPL_STRUCTURE_TOO_SMALL
0x1659         PMERR_INVALID_ERRORINFO_HANDLE
0x165A         PMERR_INVALID_CHARACTER_INDEX
0x2001         HMERR_INDEX_NOT_FOUND
0x2001         PMERR_ALREADY_IN_AREA
0x2002         HMERR_CONTENT_NOT_FOUND
0x2002         PMERR_ALREADY_IN_ELEMENT
0x2003         HMERR_OPEN_LIB_FILE
0x2003         PMERR_ALREADY_IN_PATH
0x2004         HMERR_READ_LIB_FILE
0x2004         PMERR_ALREADY_IN_SEG
0x2005         HMERR_CLOSE_LIB_FILE
0x2005         PMERR_AREA_INCOMPLETE
0x2006         HMERR_INVALID_LIB_FILE
0x2006         PMERR_BASE_ERROR
0x2007         HMERR_NO_MEMORY
0x2007         PMERR_BITBLT_LENGTH_EXCEEDED
0x2008         HMERR_ALLOCATE_SEGMENT
0x2008         PMERR_BITMAP_IN_USE
0x2009         HMERR_FREE_MEMORY
0x2009         PMERR_BITMAP_IS_SELECTED
0x200A         PMERR_BITMAP_NOT_FOUND
0x200B         PMERR_BITMAP_NOT_SELECTED
0x200C         PMERR_BOUNDS_OVERFLOW
0x200D         PMERR_CALLED_SEG_IS_CHAINED
0x200E         PMERR_CALLED_SEG_IS_CURRENT
0x200F         PMERR_CALLED_SEG_NOT_FOUND
0x2010         HMERR_PANEL_NOT_FOUND
0x2010         PMERR_CANNOT_DELETE_ALL_DATA
0x2011         HMERR_DATABASE_NOT_OPEN
0x2011         PMERR_CANNOT_REPLACE_ELEMENT_0
0x2012         PMERR_COL_TABLE_NOT_REALIZABLE
0x2013         HMERR_LOAD_DLL
0x2013         PMERR_COL_TABLE_NOT_REALIZED
0x2014         PMERR_COORDINATE_OVERFLOW
0x2015         PMERR_CORR_FORMAT_MISMATCH
0x2016         PMERR_DATA_TOO_LONG
0x2017         PMERR_DC_IS_ASSOCIATED
0x2018         PMERR_DESC_STRING_TRUNCATED
0x2019         PMERR_DEVICE_DRIVER_ERROR_1
0x201A         PMERR_DEVICE_DRIVER_ERROR_2
0x201B         PMERR_DEVICE_DRIVER_ERROR_3
0x201C         PMERR_DEVICE_DRIVER_ERROR_4
0x201D         PMERR_DEVICE_DRIVER_ERROR_5
0x201E         PMERR_DEVICE_DRIVER_ERROR_6
0x201F         PMERR_DEVICE_DRIVER_ERROR_7
0x2020         PMERR_DEVICE_DRIVER_ERROR_8
0x2021         PMERR_DEVICE_DRIVER_ERROR_9
0x2022         PMERR_DEVICE_DRIVER_ERROR_10
0x2023         PMERR_DEV_FUNC_NOT_INSTALLED
0x2024         PMERR_DOSOPEN_FAILURE
0x2025         PMERR_DOSREAD_FAILURE
0x2026         PMERR_DRIVER_NOT_FOUND
0x2027         PMERR_DUP_SEG
0x2028         PMERR_DYNAMIC_SEG_SEQ_ERROR
0x2029         PMERR_DYNAMIC_SEG_ZERO_INV
0x202A         PMERR_ELEMENT_INCOMPLETE
0x202B         PMERR_ESC_CODE_NOT_SUPPORTED
0x202C         PMERR_EXCEEDS_MAX_SEG_LENGTH
0x202D         PMERR_FONT_AND_MODE_MISMATCH
0x202E         PMERR_FONT_FILE_NOT_LOADED
0x202F         PMERR_FONT_NOT_LOADED
0x2030         PMERR_FONT_TOO_BIG
0x2031         PMERR_HARDWARE_INIT_FAILURE
0x2032         PMERR_HBITMAP_BUSY
0x2033         PMERR_HDC_BUSY
0x2034         PMERR_HRGN_BUSY
0x2035         PMERR_HUGE_FONTS_NOT_SUPPORTED
0x2036         PMERR_ID_HAS_NO_BITMAP
0x2037         PMERR_IMAGE_INCOMPLETE
0x2038         PMERR_INCOMPAT_COLOR_FORMAT
0x2039         PMERR_INCOMPAT_COLOR_OPTIONS
0x203A         PMERR_INCOMPATIBLE_BITMAP
0x203B         PMERR_INCOMPATIBLE_METAFILE
0x203C         PMERR_INCORRECT_DC_TYPE
0x203D         PMERR_INSUFFICIENT_DISK_SPACE
0x203E         PMERR_INSUFFICIENT_MEMORY
0x203F         PMERR_INV_ANGLE_PARM
0x2040         PMERR_INV_ARC_CONTROL
0x2041         PMERR_INV_AREA_CONTROL
0x2042         PMERR_INV_ARC_POINTS
0x2043         PMERR_INV_ATTR_MODE
0x2044         PMERR_INV_BACKGROUND_COL_ATTR
0x2045         PMERR_INV_BACKGROUND_MIX_ATTR
0x2046         PMERR_INV_BITBLT_MIX
0x2047         PMERR_INV_BITBLT_STYLE
0x2048         PMERR_INV_BITMAP_DIMENSION
0x2049         PMERR_INV_BOX_CONTROL
0x204A         PMERR_INV_BOX_ROUNDING_PARM
0x204B         PMERR_INV_CHAR_ANGLE_ATTR
0x204C         PMERR_INV_CHAR_DIRECTION_ATTR
0x204D         PMERR_INV_CHAR_MODE_ATTR
0x204E         PMERR_INV_CHAR_POS_OPTIONS
0x204F         PMERR_INV_CHAR_SET_ATTR
0x2050         PMERR_INV_CHAR_SHEAR_ATTR
0x2051         PMERR_INV_CLIP_PATH_OPTIONS
0x2052         PMERR_INV_CODEPAGE
0x2053         PMERR_INV_COLOR_ATTR
0x2054         PMERR_INV_COLOR_DATA
0x2055         PMERR_INV_COLOR_FORMAT
0x2056         PMERR_INV_COLOR_INDEX
0x2057         PMERR_INV_COLOR_OPTIONS
0x2058         PMERR_INV_COLOR_START_INDEX
0x2059         PMERR_INV_COORD_OFFSET
0x205A         PMERR_INV_COORD_SPACE
0x205B         PMERR_INV_COORDINATE
0x205C         PMERR_INV_CORRELATE_DEPTH
0x205D         PMERR_INV_CORRELATE_TYPE
0x205E         PMERR_INV_CURSOR_BITMAP
0x205F         PMERR_INV_DC_DATA
0x2060         PMERR_INV_DC_TYPE
0x2061         PMERR_INV_DEVICE_NAME
0x2062         PMERR_INV_DEV_MODES_OPTIONS
0x2063         PMERR_INV_DRAW_CONTROL
0x2064         PMERR_INV_DRAW_VALUE
0x2065         PMERR_INV_DRAWING_MODE
0x2066         PMERR_INV_DRIVER_DATA
0x2067         PMERR_INV_DRIVER_NAME
0x2068         PMERR_INV_DRAW_BORDER_OPTION
0x2069         PMERR_INV_EDIT_MODE
0x206A         PMERR_INV_ELEMENT_OFFSET
0x206B         PMERR_INV_ELEMENT_POINTER
0x206C         PMERR_INV_END_PATH_OPTIONS
0x206D         PMERR_INV_ESC_CODE
0x206E         PMERR_INV_ESCAPE_DATA
0x206F         PMERR_INV_EXTENDED_LCID
0x2070         PMERR_INV_FILL_PATH_OPTIONS
0x2071         PMERR_INV_FIRST_CHAR
0x2072         PMERR_INV_FONT_ATTRS
0x2073         PMERR_INV_FONT_FILE_DATA
0x2074         PMERR_INV_FOR_THIS_DC_TYPE
0x2075         PMERR_INV_FORMAT_CONTROL
0x2076         PMERR_INV_FORMS_CODE
0x2077         PMERR_INV_FONTDEF
0x2078         PMERR_INV_GEOM_LINE_WIDTH_ATTR
0x2079         PMERR_INV_GETDATA_CONTROL
0x207A         PMERR_INV_GRAPHICS_FIELD
0x207B         PMERR_INV_HBITMAP
0x207C         PMERR_INV_HDC
0x207D         PMERR_INV_HJOURNAL
0x207E         PMERR_INV_HMF
0x207F         PMERR_INV_HPS
0x2080         PMERR_INV_HRGN
0x2081         PMERR_INV_ID
0x2082         PMERR_INV_IMAGE_DATA_LENGTH
0x2083         PMERR_INV_IMAGE_DIMENSION
0x2084         PMERR_INV_IMAGE_FORMAT
0x2085         PMERR_INV_IN_AREA
0x2086         PMERR_INV_IN_CALLED_SEG
0x2087         PMERR_INV_IN_CURRENT_EDIT_MODE
0x2088         PMERR_INV_IN_DRAW_MODE
0x2089         PMERR_INV_IN_ELEMENT
0x208A         PMERR_INV_IN_IMAGE
0x208B         PMERR_INV_IN_PATH
0x208C         PMERR_INV_IN_RETAIN_MODE
0x208D         PMERR_INV_IN_SEG
0x208E         PMERR_INV_IN_VECTOR_SYMBOL
0x208F         PMERR_INV_INFO_TABLE
0x2090         PMERR_INV_JOURNAL_OPTION
0x2091         PMERR_INV_KERNING_FLAGS
0x2092         PMERR_INV_LENGTH_OR_COUNT
0x2093         PMERR_INV_LINE_END_ATTR
0x2094         PMERR_INV_LINE_JOIN_ATTR
0x2095         PMERR_INV_LINE_TYPE_ATTR
0x2096         PMERR_INV_LINE_WIDTH_ATTR
0x2097         PMERR_INV_LOGICAL_ADDRESS
0x2098         PMERR_INV_MARKER_BOX_ATTR
0x2099         PMERR_INV_MARKER_SET_ATTR
0x209A         PMERR_INV_MARKER_SYMBOL_ATTR
0x209B         PMERR_INV_MATRIX_ELEMENT
0x209C         PMERR_INV_MAX_HITS
0x209D         PMERR_INV_METAFILE
0x209E         PMERR_INV_METAFILE_LENGTH
0x209F         PMERR_INV_METAFILE_OFFSET
0x20A0         PMERR_INV_MICROPS_DRAW_CONTROL
0x20A1         PMERR_INV_MICROPS_FUNCTION
0x20A2         PMERR_INV_MICROPS_ORDER
0x20A3         PMERR_INV_MIX_ATTR
0x20A4         PMERR_INV_MODE_FOR_OPEN_DYN
0x20A5         PMERR_INV_MODE_FOR_REOPEN_SEG
0x20A6         PMERR_INV_MODIFY_PATH_MODE
0x20A7         PMERR_INV_MULTIPLIER
0x20A8         PMERR_INV_NESTED_FIGURES
0x20A9         PMERR_INV_OR_INCOMPAT_OPTIONS
0x20AA         PMERR_INV_ORDER_LENGTH
0x20AB         PMERR_INV_ORDERING_PARM
0x20AC         PMERR_INV_OUTSIDE_DRAW_MODE
0x20AD         PMERR_INV_PAGE_VIEWPORT
0x20AE         PMERR_INV_PATH_ID
0x20AF         PMERR_INV_PATH_MODE
0x20B0         PMERR_INV_PATTERN_ATTR
0x20B1         PMERR_INV_PATTERN_REF_PT_ATTR
0x20B2         PMERR_INV_PATTERN_SET_ATTR
0x20B3         PMERR_INV_PATTERN_SET_FONT
0x20B4         PMERR_INV_PICK_APERTURE_OPTION
0x20B5         PMERR_INV_PICK_APERTURE_POSN
0x20B6         PMERR_INV_PICK_APERTURE_SIZE
0x20B7         PMERR_INV_PICK_NUMBER
0x20B8         PMERR_INV_PLAY_METAFILE_OPTION
0x20B9         PMERR_INV_PRIMITIVE_TYPE
0x20BA         PMERR_INV_PS_SIZE
0x20BB         PMERR_INV_PUTDATA_FORMAT
0x20BC         PMERR_INV_QUERY_ELEMENT_NO
0x20BD         PMERR_INV_RECT
0x20BE         PMERR_INV_REGION_CONTROL
0x20BF         PMERR_INV_REGION_MIX_MODE
0x20C0         PMERR_INV_REPLACE_MODE_FUNC
0x20C1         PMERR_INV_RESERVED_FIELD
0x20C2         PMERR_INV_RESET_OPTIONS
0x20C3         PMERR_INV_RGBCOLOR
0x20C4         PMERR_INV_SCAN_START
0x20C5         PMERR_INV_SEG_ATTR
0x20C6         PMERR_INV_SEG_ATTR_VALUE
0x20C7         PMERR_INV_SEG_CH_LENGTH
0x20C8         PMERR_INV_SEG_NAME
0x20C9         PMERR_INV_SEG_OFFSET
0x20CA         PMERR_INV_SETID
0x20CB         PMERR_INV_SETID_TYPE
0x20CC         PMERR_INV_SET_VIEWPORT_OPTION
0x20CD         PMERR_INV_SHARPNESS_PARM
0x20CE         PMERR_INV_SOURCE_OFFSET
0x20CF         PMERR_INV_STOP_DRAW_VALUE
0x20D0         PMERR_INV_TRANSFORM_TYPE
0x20D1         PMERR_INV_USAGE_PARM
0x20D2         PMERR_INV_VIEWING_LIMITS
0x20D3         PMERR_JFILE_BUSY
0x20D4         PMERR_JNL_FUNC_DATA_TOO_LONG
0x20D5         PMERR_KERNING_NOT_SUPPORTED
0x20D6         PMERR_LABEL_NOT_FOUND
0x20D7         PMERR_MATRIX_OVERFLOW
0x20D8         PMERR_METAFILE_INTERNAL_ERROR
0x20D9         PMERR_METAFILE_IN_USE
0x20DA         PMERR_METAFILE_LIMIT_EXCEEDED
0x20DB         PMERR_NAME_STACK_FULL
0x20DC         PMERR_NOT_CREATED_BY_DEVOPENDC
0x20DD         PMERR_NOT_IN_AREA
0x20DE         PMERR_NOT_IN_DRAW_MODE
0x20DF         PMERR_NOT_IN_ELEMENT
0x20E0         PMERR_NOT_IN_IMAGE
0x20E1         PMERR_NOT_IN_PATH
0x20E2         PMERR_NOT_IN_RETAIN_MODE
0x20E3         PMERR_NOT_IN_SEG
0x20E4         PMERR_NO_BITMAP_SELECTED
0x20E5         PMERR_NO_CURRENT_ELEMENT
0x20E6         PMERR_NO_CURRENT_SEG
0x20E7         PMERR_NO_METAFILE_RECORD_HANDLE
0x20E8         PMERR_ORDER_TOO_BIG
0x20E9         PMERR_OTHER_SET_ID_REFS
0x20EA         PMERR_OVERRAN_SEG
0x20EB         PMERR_OWN_SET_ID_REFS
0x20EC         PMERR_PATH_INCOMPLETE
0x20ED         PMERR_PATH_LIMIT_EXCEEDED
0x20EE         PMERR_PATH_UNKNOWN
0x20EF         PMERR_PEL_IS_CLIPPED
0x20F0         PMERR_PEL_NOT_AVAILABLE
0x20F1         PMERR_PRIMITIVE_STACK_EMPTY
0x20F2         PMERR_PROLOG_ERROR
0x20F3         PMERR_PROLOG_SEG_ATTR_NOT_SET
0x20F4         PMERR_PS_BUSY
0x20F5         PMERR_PS_IS_ASSOCIATED
0x20F6         PMERR_RAM_JNL_FILE_TOO_SMALL
0x20F7         PMERR_REALIZE_NOT_SUPPORTED
0x20F8         PMERR_REGION_IS_CLIP_REGION
0x20F9         PMERR_RESOURCE_DEPLETION
0x20FA         PMERR_SEG_AND_REFSEG_ARE_SAME
0x20FB         PMERR_SEG_CALL_RECURSIVE
0x20FC         PMERR_SEG_CALL_STACK_EMPTY
0x20FD         PMERR_SEG_CALL_STACK_FULL
0x20FE         PMERR_SEG_IS_CURRENT
0x20FF         PMERR_SEG_NOT_CHAINED
0x2100         PMERR_SEG_NOT_FOUND
0x2101         PMERR_SEG_STORE_LIMIT_EXCEEDED
0x2102         PMERR_SETID_IN_USE
0x2103         PMERR_SETID_NOT_FOUND
0x2104         PMERR_STARTDOC_NOT_ISSUED
0x2105         PMERR_STOP_DRAW_OCCURRED
0x2106         PMERR_TOO_MANY_METAFILES_IN_USE
0x2107         PMERR_TRUNCATED_ORDER
0x2108         PMERR_UNCHAINED_SEG_ZERO_INV
0x2109         PMERR_UNSUPPORTED_ATTR
0x210A         PMERR_UNSUPPORTED_ATTR_VALUE
0x210B         PMERR_ENDDOC_NOT_ISSUED
0x210C         PMERR_PS_NOT_ASSOCIATED
0x210D         PMERR_INV_FLOOD_FILL_OPTIONS
0x210E         PMERR_INV_FACENAME
0x210F         PMERR_PALETTE_SELECTED
0x2110         PMERR_NO_PALETTE_SELECTED
0x2111         PMERR_INV_HPAL
0x2112         PMERR_PALETTE_BUSY
0x2113         PMERR_START_POINT_CLIPPED
0x2114         PMERR_NO_FILL
0x2115         PMERR_INV_FACENAMEDESC
0x2116         PMERR_INV_BITMAP_DATA
0x2117         PMERR_INV_CHAR_ALIGN_ATTR
0x2118         PMERR_INV_HFONT
0x2119         PMERR_HFONT_IS_SELECTED
0x2120         PMERR_RASTER_FONT
0x3001         HMERR_DDF_MEMORY
0x3002         HMERR_DDF_ALIGN_TYPE
0x3003         HMERR_DDF_BACKCOLOR
0x3004         HMERR_DDF_FORECOLOR
0x3005         HMERR_DDF_FONTSTYLE
0x3006         HMERR_DDF_REFTYPE
0x3007         HMERR_DDF_LIST_UNCLOSED
0x3008         HMERR_DDF_LIST_UNINITIALIZED
0x3009         HMERR_DDF_LIST_BREAKTYPE
0x300A         HMERR_DDF_LIST_SPACING
0x300B         HMERR_DDF_HINSTANCE
0x300C         HMERR_DDF_EXCEED_MAX_LENGTH
0x300D         HMERR_DDF_EXCEED_MAX_INC
0x300E         HMERR_DDF_INVALID_DDF
0x300F         HMERR_DDF_FORMAT_TYPE
0x3010         HMERR_DDF_INVALID_PARM
0x3011         HMERR_DDF_INVALID_FONT
0x3012         HMERR_DDF_SEVERE
0x4001         PMERR_SPL_DRIVER_ERROR
0x4002         PMERR_SPL_DEVICE_ERROR
0x4003         PMERR_SPL_DEVICE_NOT_INSTALLED
0x4004         PMERR_SPL_QUEUE_ERROR
0x4005         PMERR_SPL_INV_HSPL
0x4006         PMERR_SPL_NO_DISK_SPACE
0x4007         PMERR_SPL_NO_MEMORY
0x4008         PMERR_SPL_PRINT_ABORT
0x4009         PMERR_SPL_SPOOLER_NOT_INSTALLED
0x400A         PMERR_SPL_INV_FORMS_CODE
0x400B         PMERR_SPL_INV_PRIORITY
0x400C         PMERR_SPL_NO_FREE_JOB_ID
0x400D         PMERR_SPL_NO_DATA
0x400E         PMERR_SPL_INV_TOKEN
0x400F         PMERR_SPL_INV_DATATYPE
0x4010         PMERR_SPL_PROCESSOR_ERROR
0x4011         PMERR_SPL_INV_JOB_ID
0x4012         PMERR_SPL_JOB_NOT_PRINTING
0x4013         PMERR_SPL_JOB_PRINTING
0x4014         PMERR_SPL_QUEUE_ALREADY_EXISTS
0x4015         PMERR_SPL_INV_QUEUE_NAME
0x4016         PMERR_SPL_QUEUE_NOT_EMPTY
0x4017         PMERR_SPL_DEVICE_ALREADY_EXISTS
0x4018         PMERR_SPL_DEVICE_LIMIT_REACHED
0x4019         PMERR_SPL_STATUS_STRING_TRUNC
0x401A         PMERR_SPL_INV_LENGTH_OR_COUNT
0x401B         PMERR_SPL_FILE_NOT_FOUND
0x401C         PMERR_SPL_CANNOT_OPEN_FILE
0x401D         PMERR_SPL_DRIVER_NOT_INSTALLED
0x401E         PMERR_SPL_INV_PROCESSOR_DATTYPE
0x401F         PMERR_SPL_INV_DRIVER_DATATYPE
0x4020         PMERR_SPL_PROCESSOR_NOT_INST
0x4021         PMERR_SPL_NO_SUCH_LOG_ADDRESS
0x4022         PMERR_SPL_PRINTER_NOT_FOUND
0x4023         PMERR_SPL_DD_NOT_FOUND
0x4024         PMERR_SPL_QUEUE_NOT_FOUND
0x4025         PMERR_SPL_MANY_QUEUES_ASSOC
0x4026         PMERR_SPL_NO_QUEUES_ASSOCIATED
0x4027         PMERR_SPL_INI_FILE_ERROR
0x4028         PMERR_SPL_NO_DEFAULT_QUEUE
0x4029         PMERR_SPL_NO_CURRENT_FORMS_CODE
0x402A         PMERR_SPL_NOT_AUTHORISED
0x402B         PMERR_SPL_TEMP_NETWORK_ERROR
0x402C         PMERR_SPL_HARD_NETWORK_ERROR
0x402D         PMERR_DEL_NOT_ALLOWED
0x402E         PMERR_CANNOT_DEL_QP_REF
0x402F         PMERR_CANNOT_DEL_QNAME_REF
0x4030         PMERR_CANNOT_DEL_PRINTER_DD_REF
0x4031         PMERR_CANNOT_DEL_PRN_NAME_REF
0x4032         PMERR_CANNOT_DEL_PRN_ADDR_REF
0x4033         PMERR_SPOOLER_QP_NOT_DEFINED
0x4034         PMERR_PRN_NAME_NOT_DEFINED
0x4035         PMERR_PRN_ADDR_NOT_DEFINED
0x4036         PMERR_PRINTER_DD_NOT_DEFINED
0x4037         PMERR_PRINTER_QUEUE_NOT_DEFINED
0x4038         PMERR_PRN_ADDR_IN_USE
0x4039         PMERR_SPL_TOO_MANY_OPEN_FILES
0x403A         PMERR_SPL_CP_NOT_REQD
0x4040         PMERR_UNABLE_TO_CLOSE_DEVICE
0x4FA1         PMERR_SPL_ERROR_1
0x4FA2         PMERR_SPL_ERROR_2
0x4FA3         PMERR_SPL_ERROR_3
0x4FA4         PMERR_SPL_ERROR_4
0x4FA5         PMERR_SPL_ERROR_5
0x4FA6         PMERR_SPL_ERROR_6
0x4FA7         PMERR_SPL_ERROR_7
0x4FA8         PMERR_SPL_ERROR_8
0x4FA9         PMERR_SPL_ERROR_9
0x4FAA         PMERR_SPL_ERROR_10
0x4FAB         PMERR_SPL_ERROR_11
0x4FAC         PMERR_SPL_ERROR_12
0x4FAD         PMERR_SPL_ERROR_13
0x4FAE         PMERR_SPL_ERROR_14
0x4FAF         PMERR_SPL_ERROR_15
0x4FB0         PMERR_SPL_ERROR_16
0x4FB1         PMERR_SPL_ERROR_17
0x4FB2         PMERR_SPL_ERROR_18
0x4FB3         PMERR_SPL_ERROR_19
0x4FB4         PMERR_SPL_ERROR_20
0x4FB5         PMERR_SPL_ERROR_21
0x4FB6         PMERR_SPL_ERROR_22
0x4FB7         PMERR_SPL_ERROR_23
0x4FB8         PMERR_SPL_ERROR_24
0x4FB9         PMERR_SPL_ERROR_25
0x4FBA         PMERR_SPL_ERROR_26
0x4FBB         PMERR_SPL_ERROR_27
0x4FBC         PMERR_SPL_ERROR_28
0x4FBD         PMERR_SPL_ERROR_29
0x4FBE         PMERR_SPL_ERROR_30
0x4FBF         PMERR_SPL_ERROR_31
0x4FC0         PMERR_SPL_ERROR_32
0x4FC1         PMERR_SPL_ERROR_33
0x4FC2         PMERR_SPL_ERROR_34
0x4FC3         PMERR_SPL_ERROR_35
0x4FC4         PMERR_SPL_ERROR_36
0x4FC5         PMERR_SPL_ERROR_37
0x4FC6         PMERR_SPL_ERROR_38
0x4FC7         PMERR_SPL_ERROR_39
0x4FC8         PMERR_SPL_ERROR_40
0x4FC9         PMERR_SPLMSGBOX_INFO_CAPTION
0x4FCA         PMERR_SPLMSGBOX_WARNING_CAPTION
0x4FCB         PMERR_SPLMSGBOX_ERROR_CAPTION
0x4FCC         PMERR_SPLMSGBOX_SEVERE_CAPTION
0x4FCD         PMERR_SPLMSGBOX_JOB_DETAILS
0x4FCE         PMERR_SPLMSGBOX_ERROR_ACTION
0x4FCF         PMERR_SPLMSGBOX_SEVERE_ACTION
0x4FD0         PMERR_SPLMSGBOX_BIT_0_TEXT
0x4FD1         PMERR_SPLMSGBOX_BIT_1_TEXT
0x4FD2         PMERR_SPLMSGBOX_BIT_2_TEXT
0x4FD3         PMERR_SPLMSGBOX_BIT_3_TEXT
0x4FD4         PMERR_SPLMSGBOX_BIT_4_TEXT
0x4FD5         PMERR_SPLMSGBOX_BIT_5_TEXT
0x4FD6         PMERR_SPLMSGBOX_BIT_15_TEXT
0x4FD7         PMERR_SPL_NOPATHBUFFER
0x4FD8         PMERR_SPL_ALREADY_INITIALISED
0x4FD9         PMERR_SPL_ERROR
0x5001         PMERR_INV_TYPE
0x5002         PMERR_INV_CONV
0x5003         PMERR_INV_SEGLEN
0x5004         PMERR_DUP_SEGNAME
0x5005         PMERR_INV_XFORM
0x5006         PMERR_INV_VIEWLIM
0x5007         PMERR_INV_3DCOORD
0x5008         PMERR_SMB_OVFLOW
0x5009         PMERR_SEG_OVFLOW
0x5010         PMERR_PIC_DUP_FILENAME


ΓòÉΓòÉΓòÉ 8.2. Error Name and Explanation ΓòÉΓòÉΓòÉ

This appendix gives an explanation for each PM error. The errors are listed in
alphabetic order.  The number associated with each error is given in Error
Number and Name.

Error Constant                                  Explanation

HMERR_ALLOCATE_SEGMENT                          Unable to allocate a segment of
                                                memory for memory allocation
                                                requests from the Help Manager.

HMERR_CLOSE_LIB_FILE                            The library file cannot be
                                                closed.

HMERR_CONTENT_NOT_FOUND                         The library file does not have
                                                any content.

HMERR_DATABASE_NOT_OPEN                         Unable to read the unopened
                                                database.

HMERR_DDF_ALIGN_TYPE                            The alignment type is not
                                                valid.

HMERR_DDF_BACKCOLOR                             The background color is not
                                                valid.

HMERR_DDF_EXCEED_MAX_INC                        The value specified to
                                                increment DDF memory is too
                                                large.

HMERR_DDF_EXCEED_MAX_LENGTH                     The amount of data is too large
                                                for the DDF buffer.

HMERR_DDF_FONTSTYLE                             The font style is not valid.

HMERR_DDF_FORECOLOR                             The foreground color is not
                                                valid.

HMERR_DDF_FORMAT_TYPE                           The format type specified is
                                                invalid.

HMERR_DDF_HINSTANCE                             The DDF instance is invalid.

HMERR_DDF_INVALID_DDF                           The DDF handle is invalid.

HMERR_DDF_INVALID_FONT                          The font value specified is
                                                invalid.

HMERR_DDF_INVALID_PARM                          One of the DDF parameters
                                                specified is invalid.

HMERR_DDF_LIST_BREAKTYPE                        The value of BreakType is not
                                                valid.

HMERR_DDF_LIST_SPACING                          The value for Spacing is not
                                                valid.

HMERR_DDF_LIST_UNCLOSED                         An attempt was made to nest a
                                                list.

HMERR_DDF_LIST_UNINITIALIZED                    No definition list has been
                                                initialized by DdfBeginList.

HMERR_DDF_MEMORY                                Not enough memory is available.

HMERR_DDF_REFTYPE                               The reference type is not
                                                valid.

HMERR_DDF_SEVERE                                Internal error detected by the
                                                Help Manager.

HMERR_FREE_MEMORY                               Unable to free allocated
                                                memory.

HMERR_HELP_INST_CALLED_INVALID                  The handle of the instance
                                                specified on a call to the Help
                                                Manager does not have the class
                                                name of a Help Manager
                                                instance.

HMERR_HELP_INSTANCE_UNDEFINE                    The help instance handle
                                                specified is invalid.

HMERR_HELPITEM_NOT_FOUND                        Context-sensitive help was
                                                requested but the ID of the
                                                main help item specified was
                                                not found in the help table.

HMERR_HELPSUBITEM_NOT_FOUND                     Context-sensitive help was
                                                requested but the ID of the
                                                help item specified was not
                                                found in the help subtable.

HMERR_HELPTABLE_UNDEFINE                        The application did not provide
                                                a help table for
                                                context-sensitive help.

HMERR_INDEX_NOT_FOUND                           The index is not in the library
                                                file.

HMERR_INVALID_ASSOC_APP_WND                     The application window handle
                                                specified on the
                                                WinAssociateHelpInstance
                                                function is not a valid window
                                                handle.

HMERR_INVALID_ASSOC_HELP_INST                   The help instance handle
                                                specified on the
                                                WinAssociateHelpInstance
                                                function is not a valid window
                                                handle.

HMERR_INVALID_DESTROY_HELP_INST                 The window handle specified as
                                                the help instance to destroy is
                                                not of the help instance class.

HMERR_INVALID_HELP_INSTANCE_HDL                 The handle specified to be a
                                                help instance does not have the
                                                class name of a Help Manager
                                                instance.

HMERR_INVALID_HELPSUBITEM_SIZE                  The help subtable item size is
                                                less than 2.

HMERR_INVALID_LIB_FILE                          Improper library file provided.

HMERR_INVALID_QUERY_APP_WND                     The application window
                                                specified on a
                                                WinQueryHelpInstance function
                                                is not a valid window handle.

HMERR_LOAD_DLL                                  Unable to load resource data
                                                link library.

HMERR_NO_FRAME_WND_IN_CHAIN                     There is no frame window in the
                                                window chain from which to find
                                                or set the associated help
                                                instance.

HMERR_NO_HELP_INST_IN_CHAIN                     The parent or owner chain of
                                                the application window
                                                specified does not have an
                                                associated help instance.

HMERR_NO_MEMORY                                 Unable to allocate the
                                                requested amount of memory.

HMERR_OPEN_LIB_FILE                             The library file cannot be
                                                opened.

HMERR_PANEL_NOT_FOUND                           Unable to find the requested
                                                help panel.

HMERR_READ_LIB_FILE                             The library file cannot be
                                                read.

PMERR_ACCESS_DENIED                             The memory block was not
                                                allocated properly.

PMERR_ALREADY_IN_AREA                           An attempt was made to begin a
                                                new area while an existing area
                                                bracket was already open.

PMERR_ALREADY_IN_ELEMENT                        An attempt was made to begin a
                                                new element while an existing
                                                element bracket was already
                                                open.

PMERR_ALREADY_IN_PATH                           An attempt was made to begin a
                                                new path while an existing path
                                                bracket was already open.

PMERR_ALREADY_IN_SEG                            An attempt was made to open a
                                                new segment while an existing
                                                segment bracket was already
                                                open.

PMERR_APPL_STRUCTURE_TOO_SMALL                  The application buffer length
                                                is less than the total length
                                                required for the (application)
                                                component types.

PMERR_ARRAY_TOO_SMALL                           The array specified was too
                                                small.

PMERR_AREA_INCOMPLETE                           One of the following has
                                                occurred:

                                                                                                o A segment has been opened, closed,
                                                                                                 or drawn.
                                                                                                o GpiAssociate was issued while an
                                                                                                 area bracket was open.
                                                                                                o A drawn segment has opened an area
                                                                                                 bracket and ended without closing it.

PMERR_ARRAY_TOO_LARGE                           More than 4 bytes was attempted
                                                to be inserted or extracted.

PMERR_ATOM_NAME_NOT_FOUND                       The specified atom name is not
                                                in the atom table.

PMERR_BASE_ERROR                                An OS/2 base error has
                                                occurred.  The base error code
                                                can be accessed using the
                                                OffBinaryData field of the
                                                ERRINFO structure returned by
                                                WinGetErrorInfo.

PMERR_BITMAP_IN_USE                             An attempt was made either to
                                                set a bit map into a device
                                                context using GpiSetBitmap
                                                while it was already selected
                                                into an existing device
                                                context, or to tag a bit map
                                                with a local pattern set
                                                identifier (setid) using
                                                GpiSetBitmapId while it was
                                                already tagged with an existing
                                                setid.

PMERR_BITMAP_IS_SELECTED                        An attempt was made to delete a
                                                bit map while it was selected
                                                into a device context.

PMERR_BITMAP_NOT_FOUND                          A attempt was made to perform a
                                                bit-map operation on a bit map
                                                that did not exist.

PMERR_BITMAP_NOT_SELECTED                       A attempt was made to perform
                                                an operation on presentation
                                                space associated with a memory
                                                device context that had no
                                                selected bit map.

PMERR_BOUNDS_OVERFLOW                           An internal overflow error
                                                occurred during boundary data
                                                accumulation.  This can occur
                                                if coordinates or matrix
                                                transformation elements (or
                                                both) are invalid or too large.

PMERR_BUFFER_TOO_SMALL                          The supplied buffer was not
                                                large enough for the data to be
                                                returned.

PMERR_C_LENGTH_TOO_SMALL                        The maximum length of the C
                                                structure is less than the
                                                total length required for the
                                                (C) component types.

PMERR_CALLED_SEG_IS_CHAINED                     An attempt was made to call a
                                                segment that has a chained
                                                attribute set.

PMERR_CAN_NOT_CALL_SPOOLER                      An error occurred attempting to
                                                call the spooler validation
                                                routine.  This error is not
                                                raised if the spooler is not
                                                installed.

PMERR_CANNOT_DEL_PRINTER_DD_REF                 Presentation Manager device
                                                driver deletion not possible
                                                due to a reference.

PMERR_CANNOT_DEL_PRN_ADDR_REF                   Printer port deletion not
                                                possible due to a reference.

PMERR_CANNOT_DEL_PRN_NAME_REF                   Printer deletion not possible
                                                due to a reference.

PMERR_CANNOT_DEL_QNAME_REF                      Spooler queue deletion not
                                                possible due to a reference.

PMERR_CANNOT_DEL_QP_REF                         Spooler queue processor
                                                deletion not possible due to a
                                                reference.

PMERR_CANNOT_STOP                               The session cannot be stopped.

PMERR_CALLED_SEG_IS_CURRENT                     An attempt was made to call a
                                                segment that is currently open.

PMERR_CALLED_SEG_NOT_FOUND                      An attempt was made to call a
                                                segment that did not exist.

PMERR_COL_TABLE_NOT_REALIZABLE                  An attempt was made to realize
                                                a color table that is not
                                                realizable.

PMERR_COL_TABLE_NOT_REALIZED                    An attempt was made to realize
                                                a color table on a device
                                                driver that does not support
                                                this function.

PMERR_COORDINATE_OVERFLOW                       An internal coordinate overflow
                                                error occurred.  This can occur
                                                if coordinates or matrix
                                                transformation elements (or
                                                both) are invalid or too large.

PMERR_DATA_TOO_LONG                             An attempt was made to transfer
                                                more than the maximum permitted
                                                amount of data (64512 bytes)
                                                using GpiPutData, GpiGetData,
                                                or GpiElement.

PMERR_DATATYPE_ENTRY_BAD_INDEX                  An invalid datatype entry index
                                                was specified.

PMERR_DATATYPE_ENTRY_CTL_BAD                    An invalid datatype entry
                                                control was specified.

PMERR_DATATYPE_ENTRY_CTL_MISS                   The datatype entry control was
                                                missing.

PMERR_DATATYPE_ENTRY_NOT_NUM                    The datatype entry specified
                                                was not numerical.

PMERR_DATATYPE_ENTRY_NOT_OFF                    The datatype entry specified
                                                was not an offset.

PMERR_DATATYPE_INVALID                          An invalid datatype was
                                                specified.

PMERR_DATATYPE_NOT_UNIQUE                       An attempt to register a
                                                datatype failed because it is
                                                not unique.

PMERR_DATATYPE_TOO_LONG                         The datatype specified was too
                                                long.

PMERR_DATATYPE_TOO_SMALL                        The datatype specified was too
                                                small.

PMERR_DC_IS_ASSOCIATED                          An attempt was made to
                                                associate a presentation space
                                                with a device context that was
                                                already associated or to
                                                destroy a device context that
                                                was associated.

PMERR_DEL_NOT_ALLOWED                           Deletion not possible.

PMERR_DESC_STRING_TRUNCATED                     An attempt was made to supply a
                                                description string with
                                                GpiBeginElement that was
                                                greater then the permitted
                                                maximum length (251
                                                characters).  The string was
                                                truncated.

PMERR_DEV_FUNC_NOT_INSTALLED                    The function requested is not
                                                supported by the presentation
                                                driver.

PMERR_DEVICE_DRIVER_ERROR_1                     Miscellaneous error available
                                                for use by user written device
                                                drivers.

PMERR_DEVICE_DRIVER_ERROR_2                     Miscellaneous error available
                                                for use by user written device
                                                drivers.

PMERR_DEVICE_DRIVER_ERROR_3                     Miscellaneous error available
                                                for use by user written device
                                                drivers.

PMERR_DEVICE_DRIVER_ERROR_4                     Miscellaneous error available
                                                for use by user written device
                                                drivers.

PMERR_DEVICE_DRIVER_ERROR_5                     Miscellaneous error available
                                                for use by user written device
                                                drivers.

PMERR_DEVICE_DRIVER_ERROR_6                     Miscellaneous error available
                                                for use by user written device
                                                drivers.

PMERR_DEVICE_DRIVER_ERROR_7                     Miscellaneous error available
                                                for use by user written device
                                                drivers.

PMERR_DEVICE_DRIVER_ERROR_8                     Miscellaneous error available
                                                for use by user written device
                                                drivers.

PMERR_DEVICE_DRIVER_ERROR_9                     Miscellaneous error available
                                                for use by user written device
                                                drivers.

PMERR_DEVICE_DRIVER_ERROR_10                    Miscellaneous error available
                                                for use by user written device
                                                drivers.

PMERR_DOS_ERROR                                 A DOS call returned an error.

PMERR_DOSOPEN_FAILURE                           A DosOpen call made during
                                                GpiLoadMetaFile or
                                                GpiSaveMetaFile gave a good
                                                return code but the file was
                                                not opened successfully.

PMERR_DOSREAD_FAILURE                           A DosRead call made during
                                                GpiLoadMetaFile gave a good
                                                return code.  However, it
                                                failed to read any more bytes
                                                although the file length
                                                indicated that there were more
                                                to be read.

PMERR_DRIVER_NOT_FOUND                          The device driver specified
                                                with DevPostDeviceModes was not
                                                found.

PMERR_DUP_SEG                                   During GpiPlayMetaFile, while
                                                the actual drawing mode was
                                                draw-and-retain or retain, a
                                                metafile segment to be stored
                                                in the presentation space was
                                                found to have the same segment
                                                identifier as an existing
                                                segment.

PMERR_DUP_SEGNAME                               A called segment has a name
                                                that has already been used by
                                                another called segment in the
                                                input PIF.

PMERR_DUPLICATE_TITLE                           The program title specified in
                                                the PIBSTRUCT already exists
                                                within the same group.

PMERR_DYNAMIC_SEG_SEQ_ERROR                     During removal of dynamic
                                                segments while processing
                                                GpiDrawChain, GpiDrawFrom, or
                                                GpiDrawSegment, the internal
                                                state indicated that dynamic
                                                segment data was still visible
                                                after all chained dynamic
                                                segments had been processed.
                                                This can occur if segments
                                                drawn dynamically (including
                                                called segments) are modified
                                                or removed from the chain while
                                                visible.

PMERR_DYNAMIC_SEG_ZERO_INV                      An attempt was been made to
                                                open a dynamic segment with a
                                                segment identifier of zero.

PMERR_ENDDOC_NOT_ISSUED                         A request to close the spooled
                                                output without first issuing a
                                                an ENDDOC was attempted.

PMERR_ESC_CODE_NOT_SUPPORTED                    The code specified with
                                                DevEscape is not supported by
                                                the target device driver.

PMERR_EXCEEDS_MAX_SEG_LENGTH                    During metafile creation or
                                                generation of retained graphics
                                                the system has exceeded maximum
                                                segment size.

PMERR_FONT_AND_MODE_MISMATCH                    An attempt was made to draw
                                                characters with a character
                                                mode and character set that are
                                                incompatible.  For example, the
                                                character specifies an
                                                image/raster font when the mode
                                                calls for a vector/outline
                                                font.

PMERR_FONT_FILE_NOT_LOADED                      An attempt was made to unload a
                                                font file that was not loaded.

PMERR_FONT_NOT_LOADED                           An attempt was made to create a
                                                font that was not loaded.

PMERR_FUNCTION_NOT_SUPPORTED                    The function is not supported.

PMERR_GREATER_THAN_64K                          A data item or array dimension
                                                is greater than 65 535.

PMERR_HBITMAP_BUSY                              An internal bit map busy error
                                                was detected.  The bit map was
                                                locked by one thread during an
                                                attempt to access it from
                                                another thread.

PMERR_HDC_BUSY                                  An internal device context busy
                                                error was detected.  The device
                                                context was locked by one
                                                thread during an attempt to
                                                access it from another thread.

PMERR_HEAP_MAX_SIZE_REACHED                     The heap has reached its
                                                maximum size (64KB), and cannot
                                                be increased.

PMERR_HEAP_OUT_OF_MEMORY                        An attempt to increase the size
                                                of the heap failed.

PMERR_HFONT_IS_SELECTED                         An attempt has been made to
                                                either change the owner of a
                                                font, or delete when it is
                                                currently selected.

PMERR_HRGN_BUSY                                 An internal region busy error
                                                was detected.  The region was
                                                locked by one thread during an
                                                attempt to access it from
                                                another thread.

PMERR_HUGE_FONTS_NOT_SUPPORTED                  An attempt was made using
                                                GpiSetCharSet,
                                                GpiSetPatternSet,
                                                GpiSetMarkerSet, or GpiSetAttrs
                                                to select a font that is larger
                                                than the maximum size (64Kb)
                                                supported by the target device
                                                driver.

PMERR_ID_HAS_NO_BITMAP                          No bit map was tagged with the
                                                setid specified on a
                                                GpiQueryBitmapHandle function.

PMERR_IMAGE_INCOMPLETE                          A drawn segment has opened an
                                                image bracket and ended without
                                                closing it.

PMERR_INCOMPATIBLE_BITMAP                       An attempt was made to select a
                                                bit map or perform a BitBlt
                                                operation on a device context
                                                that was incompatible with the
                                                format of the bit map.

PMERR_INCOMPATIBLE_METAFILE                     An attempt was made to
                                                associate a presentation space
                                                and a metafile device context
                                                with incompatible page units,
                                                size or coordinate format; or
                                                to play a metafile using the
                                                RES_RESET option (to reset the
                                                presentation space) to a
                                                presentation space that is
                                                itself associated with a
                                                metafile device context.

PMERR_INCOMPLETE_CONTROL_SEQ                    A control data type sequence is
                                                incomplete.

PMERR_INCORRECT_DATATYPE                        A data type is specified which
                                                is incorrect for this function.

PMERR_INCORRECT_DC_TYPE                         An attempt was made to perform
                                                a bit-map operation on a
                                                presentation space associated
                                                with a device context of a type
                                                that is unable to support
                                                bit-map operations.

PMERR_INCORRECT_HSTRUCT                         A structure handle is non-NULL,
                                                and is invalid for one of the
                                                following reasons:

                                                                                                o It is not the handle of a data structure.
                                                                                                o It is the handle of an ERRINFO
                                                                                                 structure, which should not be used on
                                                                                                 this call.
                                                                                                o A handle block returned by the bindings
                                                                                                 to the application has been used for an
                                                                                                 in-line structure handle.

PMERR_INI_FILE_IS_SYS_OR_USER                   User or system initialization
                                                file cannot be closed.

PMERR_INSUFF_SPACE_TO_ADD                       The initialization file could
                                                not be extended to add the
                                                required program or group.

PMERR_INSUFFICIENT_DISK_SPACE                   The operation terminated
                                                through insufficient disk
                                                space.

PMERR_INSUFFICIENT_MEMORY                       The operation terminated
                                                through insufficient memory.

PMERR_INTERNAL_ERROR_n                          An internal error has occurred.
                                                n is a number that identifies
                                                the particular error.

PMERR_INV_ANGLE_PARM                            An invalid angle parameter was
                                                specified with GpiPartialArc.

PMERR_INV_ARC_CONTROL                           An invalid control parameter
                                                was specified with GpiFullArc.

PMERR_INV_AREA_CONTROL                          An invalid options parameter
                                                was specified with
                                                GpiBeginArea.

PMERR_INV_ATTR_MODE                             An invalid mode parameter was
                                                specified with GpiSetAttrMode.

PMERR_INV_BACKGROUND_COL_ATTR                   An invalid background color
                                                attribute value was specified
                                                or the default value was
                                                explicitly specified with
                                                GpiSetAttrs instead of using
                                                the defaults mask.

PMERR_INV_BACKGROUND_MIX_ATTR                   An invalid background mix
                                                attribute value was specified
                                                or the default value was
                                                explicitly specified with
                                                GpiSetAttrs instead of using
                                                the defaults mask.

PMERR_INV_BITBLT_MIX                            An invalid lRop parameter was
                                                specified with a GpiBitBlt or
                                                GpiWCBitBlt function.

PMERR_INV_BITBLT_STYLE                          An invalid options parameter
                                                was specified with a GpiBitBlt
                                                or GpiWCBitBlt function.

PMERR_INV_BITMAP_DATA                           In processing a bit map, the
                                                end of the data was
                                                unexpectedly encountered.

PMERR_INV_BITMAP_DIMENSION                      An invalid dimension was
                                                specified with a load bit-map
                                                function.

PMERR_INV_BOX_CONTROL                           An invalid control parameter
                                                was specified with GpiBox.

PMERR_INV_BOX_ROUNDING_PARM                     An invalid corner rounding
                                                control parameter was specified
                                                with GpiBox.

PMERR_INV_CHAR_ALIGN_ATTR                       The text alignment attribute
                                                specified in
                                                GpiSetTextAlignment is not
                                                valid.

PMERR_INV_CHAR_ANGLE_ATTR                       The default character angle
                                                attribute value was explicitly
                                                specified with GpiSetAttrs
                                                instead of using the defaults
                                                mask.

PMERR_INV_CHAR_DIRECTION_ATTR                   An invalid character direction
                                                attribute value was specified
                                                or the default value was
                                                explicitly specified with
                                                GpiSetAttrs instead of using
                                                the defaults mask.

PMERR_INV_CHAR_MODE_ATTR                        An invalid character mode
                                                attribute value was specified
                                                or the default value was
                                                explicitly specified with
                                                GpiSetAttrs instead of using
                                                the defaults mask.

PMERR_INV_CHAR_POS_OPTIONS                      An invalid options parameter
                                                was specified with
                                                GpiCharStringPos or
                                                GpiCharStringPosAt.

PMERR_INV_CHAR_SET_ATTR                         An invalid character setid
                                                attribute value was specified
                                                or the default value was
                                                explicitly specified with
                                                GpiSetAttrs instead of using
                                                the defaults mask.

PMERR_INV_CHAR_SHEAR_ATTR                       An invalid character shear
                                                attribute value was specified
                                                or the default value was
                                                explicitly specified with
                                                GpiSetAttrs instead of using
                                                the defaults mask.

PMERR_INV_CLIP_PATH_OPTIONS                     An invalid options parameter
                                                was specified with
                                                GpiSetClipPath.

PMERR_INV_CODEPAGE                              An invalid code-page parameter
                                                was specified with GpiSetCp.

PMERR_INV_COLOR_ATTR                            An invalid color attribute
                                                value was specified or the
                                                default value was explicitly
                                                specified with GpiSetAttrs
                                                instead of using the defaults
                                                mask.

PMERR_INV_COLOR_DATA                            Invalid color table definition
                                                data was specified with
                                                GpiCreateLogColorTable.

PMERR_INV_COLOR_FORMAT                          An invalid format parameter was
                                                specified with
                                                GpiCreateLogColorTable.

PMERR_INV_COLOR_INDEX                           An invalid color index
                                                parameter was specified with
                                                GpiQueryRGBColor.

PMERR_INV_COLOR_OPTIONS                         An invalid options parameter
                                                was specified with a logical
                                                color table or color query
                                                function.

PMERR_INV_COLOR_START_INDEX                     An invalid starting index
                                                parameter was specified with a
                                                logical color table or color
                                                query function.

PMERR_INV_CONV                                  Invalid conversion-type
                                                parameter.

PMERR_INV_COORD_OFFSET                          An invalid coordinate offset
                                                value was specified.

PMERR_INV_COORD_SPACE                           An invalid source or target
                                                coordinate space parameter was
                                                specified with GpiConvert.

PMERR_INV_COORDINATE                            An invalid coordinate value was
                                                specified.

PMERR_INV_CORRELATE_DEPTH                       An invalid maxdepth parameter
                                                was specified with
                                                GpiCorrelateSegment,
                                                GpiCorrelateFrom, or
                                                GpiCorrelateChain.

PMERR_INV_CORRELATE_TYPE                        An invalid type parameter was
                                                specified with
                                                GpiCorrelateSegment,
                                                GpiCorrelateFrom, or
                                                GpiCorrelateChain.

PMERR_INV_CURSOR_BITMAP                         An invalid pointer was
                                                referenced with WinSetPointer.

PMERR_INV_DC_DATA                               An invalid data parameter was
                                                specified with DevOpenDC.

PMERR_INV_DC_TYPE                               An invalid type parameter was
                                                specified with DevOpenDC, or a
                                                function was issued that is
                                                invalid for a
                                                OD_METAFILE_NOQUERY device
                                                context.

PMERR_INV_DEV_MODES_OPTIONS                     An invalid options parameter
                                                was specified with
                                                DevPostDeviceModes.

PMERR_INV_DEVICE_NAME                           An invalid devicename parameter
                                                was specified with
                                                DevPostDeviceModes.

PMERR_INV_DRAW_BORDER_OPTION                    An invalid option parameter was
                                                specified with WinDrawBorder.

PMERR_INV_DRAW_CONTROL                          An invalid control parameter
                                                was specified with
                                                GpiSetDrawControl or
                                                GpiQueryDrawControl.

PMERR_INV_DRAW_VALUE                            An invalid value parameter was
                                                specified with
                                                GpiSetDrawControl.

PMERR_INV_DRAWING_MODE                          An invalid mode parameter was
                                                specified with
                                                GpiSetDrawControl not
                                                draw-and-retain or draw.

PMERR_INV_DRIVER_DATA                           Invalid driver data was
                                                specified.

PMERR_INV_DRIVER_NAME                           A driver name was specified
                                                which has not been installed.

PMERR_INV_EDIT_MODE                             An invalid mode parameter was
                                                specified with GpiSetEditMode.

PMERR_INV_ELEMENT_OFFSET                        An invalid off (offset)
                                                parameter was specified with
                                                GpiQueryElement.

PMERR_INV_ELEMENT_POINTER                       An attempt was made to issue
                                                GpiPutData with the element
                                                pointer not pointing at the
                                                last element.

PMERR_INV_END_PATH_OPTIONS                      An attempt to create or delete
                                                a path out of context of the
                                                path bracket was made.

PMERR_INV_ESCAPE_CODE                           An invalid code parameter was
                                                specified with DevEscape.

PMERR_INV_ESCAPE_DATA                           An invalid data parameter was
                                                specified with DevEscape.

PMERR_INV_FACENAME                              An invalid font family name was
                                                passed to GpiQueryFaceString.

PMERR_INV_FACENAMEDESC                          The font facename description
                                                is invalid.

PMERR_INV_FILL_PATH_OPTIONS                     An invalid options parameter
                                                was specified with GpiFillPath.

PMERR_INV_FIRST_CHAR                            An invalid firstchar parameter
                                                was specified with
                                                GpiQueryWidthTable.

PMERR_INV_FLOOD_FILL_OPTIONS                    Invalid flood fill parameters
                                                were specified.

PMERR_INV_FONT_ATTRS                            An invalid attrs parameter was
                                                specified with
                                                GpiCreateLogFont.

PMERR_INV_FONT_FILE_DATA                        The font file specified with
                                                GpiLoadFonts,
                                                GpiLoadPublicFonts,
                                                GpiQueryFontFileDescriptions,
                                                or GpiQueryFullFontFileDescs
                                                contains invalid data.

PMERR_INV_FOR_THIS_DC_TYPE                      An attempt has been made to
                                                issue GpiRemoveDynamics or
                                                GpiDrawDynamics to a
                                                presentation space associated
                                                with a metafile device context.

PMERR_INV_FORMS_CODE                            An invalid forms code parameter
                                                was specified with
                                                DevQueryHardcopyCaps.

PMERR_INV_GEOM_LINE_WIDTH_ATTR                  An invalid geometric line width
                                                attribute value was specified.

PMERR_INV_GETDATA_CONTROL                       An invalid format parameter was
                                                specified with GpiGetData.

PMERR_INV_GRAPHICS_FIELD                        An invalid field parameter was
                                                specified with
                                                GpiSetGraphicsField.

PMERR_INV_HBITMAP                               An invalid bit-map handle was
                                                specified.

PMERR_INV_HDC                                   An invalid device-context
                                                handle or (micro presentation
                                                space) presentation-space
                                                handle was specified.

PMERR_INV_HFONT                                 An invalid font handle was
                                                specified.

PMERR_INV_HMF                                   An invalid metafile handle was
                                                specified.

PMERR_INV_HPAL                                  An invalid color palette handle
                                                was specified.

PMERR_INV_HPS                                   An invalid presentation-space
                                                handle was specified.

PMERR_INV_HRGN                                  An invalid region handle was
                                                specified.

PMERR_INV_ID                                    An invalid lPSid parameter was
                                                specified with GpiRestorePS.

PMERR_INV_IMAGE_DATA_LENGTH                     An invalid lLength parameter
                                                was specified with GpiImage.
                                                There is a mismatch between the
                                                image size and the data length.

PMERR_INV_IMAGE_DIMENSION                       An invalid psizlImageSize
                                                parameter was specified with
                                                GpiImage.

PMERR_INV_IMAGE_FORMAT                          An invalid lFormat parameter
                                                was specified with GpiImage.

PMERR_INV_IN_AREA                               An attempt was made to issue a
                                                function invalid inside an area
                                                bracket.  This can be detected
                                                while the actual drawing mode
                                                is draw or draw-and-retain or
                                                during segment drawing or
                                                correlation functions.

PMERR_INV_IN_CURRENT_EDIT_MODE                  An attempt was made to issue a
                                                function invalid inside the
                                                current editing mode.

PMERR_INV_IN_ELEMENT                            An attempt was made to issue a
                                                function invalid inside an
                                                element bracket.

PMERR_INV_IN_IMAGE                              An attempt was made to issue a
                                                function invalid inside an
                                                element bracket.

PMERR_INV_IN_PATH                               An attempt was made to issue a
                                                function invalid inside a path
                                                bracket.

PMERR_INV_IN_RETAIN_MODE                        An attempt was made to issue a
                                                function (for example, query)
                                                that is invalid when the actual
                                                drawing mode is not draw or
                                                draw-and-retain.

PMERR_INV_IN_SEG                                An attempt was made to issue a
                                                function invalid inside a
                                                segment bracket.

PMERR_INV_IN_VECTOR_SYMBOL                      An invalid order was detected
                                                inside a vector symbol
                                                definition while drawing a
                                                vector (outline) font.

PMERR_INV_INFO_TABLE                            An invalid bit-map info table
                                                was specified with a bit-map
                                                operation.

PMERR_INV_LENGTH_OR_COUNT                       An invalid length or count
                                                parameter was specified.

PMERR_INV_LINE_END_ATTR                         An invalid line end attribute
                                                value was specified.

PMERR_INV_LINE_JOIN_ATTR                        An invalid line join attribute
                                                value was specified.

PMERR_INV_LINE_TYPE_ATTR                        An invalid line type attribute
                                                value was specified or the
                                                default value was explicitly
                                                specified with GpiSetAttrs
                                                instead of using the defaults
                                                mask.

PMERR_INV_LINE_WIDTH_ATTR                       An invalid line width attribute
                                                value was specified or the
                                                default value was explicitly
                                                specified with GpiSetAttrs
                                                instead of using the defaults
                                                mask.

PMERR_INV_LOGICAL_ADDRESS                       An invalid device logical
                                                address was specified.

PMERR_INV_MARKER_BOX_ATTR                       An invalid marker box attribute
                                                value was specified.

PMERR_INV_MARKER_SET_ATTR                       An invalid marker set attribute
                                                value was specified or the
                                                default value was explicitly
                                                specified with GpiSetAttrs
                                                instead of using the defaults
                                                mask.

PMERR_INV_MARKER_SYMBOL_ATTR                    An invalid marker symbol
                                                attribute value was specified
                                                or the default value was
                                                explicitly specified with
                                                GpiSetAttrs instead of using
                                                the defaults mask.

PMERR_INV_MATRIX_ELEMENT                        An invalid transformation
                                                matrix element was specified.

PMERR_INV_MAX_HITS                              An invalid maxhits parameter
                                                was specified with
                                                GpiCorrelateSegment,
                                                GpiCorrelateFrom, or
                                                GpiCorrelateChain.

PMERR_INV_METAFILE                              An invalid metafile was
                                                specified with GpiPlayMetaFile.

PMERR_INV_METAFILE_LENGTH                       An invalid length parameter was
                                                specified with
                                                GpiSetMetaFileBits or
                                                GpiQueryMetaFileBits.

PMERR_INV_METAFILE_OFFSET                       An invalid length parameter was
                                                specified with
                                                GpiSetMetaFileBits or
                                                GpiQueryMetaFileBits.

PMERR_INV_MICROPS_DRAW_CONTROL                  A draw control parameter was
                                                specified with
                                                GpiSetDrawControl that is
                                                invalid in a micro presentation
                                                space.

PMERR_INV_MICROPS_FUNCTION                      An attempt was made to issue a
                                                function that is invalid in a
                                                micro presentation space.

PMERR_INV_MICROPS_ORDER                         An attempt was made to play a
                                                metafile containing orders that
                                                are invalid in a micro
                                                presentation space.

PMERR_INV_MIX_ATTR                              An invalid mix attribute value
                                                was specified or the default
                                                value was explicitly specified
                                                with GpiSetAttrs instead of
                                                using the defaults mask.

PMERR_INV_MODE_FOR_OPEN_DYN                     An attempt was made to open a
                                                segment with the ATTR_DYNAMIC
                                                segment set, while the drawing
                                                mode was set to DM_DRAW or
                                                DM_DRAWANDRETAIN.

PMERR_INV_MODE_FOR_REOPEN_SEG                   An attempt was made to reopen
                                                an existing segment while the
                                                drawing mode was set to DM_DRAW
                                                or DM_DRAWANDRETAIN.

PMERR_INV_MODIFY_PATH_MODE                      An invalid mode parameter was
                                                specified with GpiModifyPath.

PMERR_INV_MULTIPLIER                            An invalid multiplier parameter
                                                was specified with
                                                GpiPartialArc or GpiFullArc.

PMERR_INV_NESTED_FIGURES                        Nested figures have been
                                                detected within a path
                                                definition.

PMERR_INV_OR_INCOMPAT_OPTIONS                   An invalid or incompatible
                                                (with micro presentation space)
                                                options parameter was specified
                                                with GpiCreatePS or GpiSetPS.

PMERR_INV_ORDER_LENGTH                          An invalid order length was
                                                detected during GpiPutData or
                                                segment drawing.

PMERR_INV_ORDERING_PARM                         An invalid order parameter was
                                                specified with
                                                GpiSetSegmentPriority.

PMERR_INV_OUTSIDE_DRAW_MODE                     An attempt was made to issue a
                                                GpiSavePS or GpiRestorePS
                                                function, or an output only
                                                function (for example,
                                                GpiPaintRegion) from
                                                GpiPlayMetaFile without the
                                                drawing mode set to DM_DRAW.

PMERR_INV_PAGE_VIEWPORT                         An invalid viewport parameter
                                                was specified with
                                                GpiSetPageViewport.

PMERR_INV_PATH_CONVERT_OPTIONS                  An invalid options parameter
                                                was specified with
                                                GpiOutlinePath.

PMERR_INV_PATH_ID                               An invalid path identifier
                                                parameter was specified.

PMERR_INV_PATTERN_ATTR                          An invalid pattern symbol
                                                attribute value was specified
                                                or the default value was
                                                explicitly specified with
                                                GpiSetAttrs instead of using
                                                the defaults mask.

PMERR_INV_PATTERN_REF_PT_ATTR                   An invalid refpoint attribute
                                                value was specified.

PMERR_INV_PATTERN_SET_ATTR                      An invalid pattern set
                                                attribute value was specified
                                                or the default value was
                                                explicitly specified with
                                                GpiSetAttrs instead of using
                                                the defaults mask.

PMERR_INV_PATTERN_SET_FONT                      An attempt was made to use an
                                                unsuitable font as a pattern
                                                set.

PMERR_INV_PICK_APERTURE_OPTION                  An invalid options parameter
                                                was specified with
                                                GpiSetPickApertureSize.

PMERR_INV_PICK_APERTURE_POSN                    An invalid pick aperture
                                                position was specified.

PMERR_INV_PICK_APERTURE_SIZE                    An invalid size parameter was
                                                specified with
                                                GpiSetPickApertureSize.

PMERR_INV_PLAY_METAFILE_OPTION                  An invalid option parameter was
                                                specified with GpiPlayMetaFile.

PMERR_INV_PRIMITIVE_TYPE                        An invalid primitive type
                                                parameter was specified with
                                                GpiSetAttrs or GpiQueryAttrs.

PMERR_INV_PS_SIZE                               An invalid size parameter was
                                                specified with GpiCreatePS or
                                                GpiSetPS.

PMERR_INV_PUTDATA_FORMAT                        An invalid format parameter was
                                                specified with GpiPutData.

PMERR_INV_QUERY_ELEMENT_NO                      An invalid start parameter was
                                                specified with DevQueryCaps.

PMERR_INV_RECT                                  An invalid rectangle parameter
                                                was specified.

PMERR_INV_REGION_CONTROL                        An invalid control parameter
                                                was specified with
                                                GpiQueryRegionRects.

PMERR_INV_REGION_MIX_MODE                       An invalid mode parameter was
                                                specified with
                                                GpiCombineRegion.

PMERR_INV_REPLACE_MODE_FUNC                     An attempt was made to issue
                                                GpiPutData with the editing
                                                mode set to SEGEM_REPLACE.

PMERR_INV_RESERVED_FIELD                        An invalid reserved field was
                                                specified.

PMERR_INV_RESET_OPTIONS                         An invalid options parameter
                                                was specified with GpiResetPS.

PMERR_INV_RGBCOLOR                              An invalid rgb color parameter
                                                was specified with
                                                GpiQueryNearestColor or
                                                GpiQueryColor.

PMERR_INV_SCAN_START                            An invalid scanstart parameter
                                                was specified with a bit-map
                                                function.

PMERR_INV_SEG_ATTR                              An invalid attribute parameter
                                                was specified with
                                                GpiSetSegmentAttrs,
                                                GpiQuerySegmentAttrs,
                                                GpiSetInitialSegmentAttrs, or
                                                GpiQueryInitialSegmentAttrs.

PMERR_INV_SEG_ATTR_VALUE                        An invalid attribute value
                                                parameter was specified with
                                                GpiSetSegmentAttrs or
                                                GpiSetInitialSegmentAttrs.

PMERR_INV_SEG_NAME                              An invalid segment identifier
                                                was specified.

PMERR_INV_SEG_OFFSET                            An invalid offset parameter was
                                                specified with GpiPutData.

PMERR_INV_SEGLEN                                An order length exceeds the
                                                remaining segment length in the
                                                input PIF.

PMERR_INV_SETID                                 An invalid setid parameter was
                                                specified.

PMERR_INV_SHARPNESS_PARM                        An invalid sharpness parameter
                                                was specified with
                                                GpiPolyFilletSharp.

PMERR_INV_STOP_DRAW_VALUE                       An invalid value parameter was
                                                specified with GpiSetStopDraw.

PMERR_INV_TRANSFORM_TYPE                        An invalid options parameter
                                                was specified with a transform
                                                matrix function.

PMERR_INV_TYPE                                  Invalid file-type parameter.

PMERR_INV_USAGE_PARM                            An invalid options parameter
                                                was specified with
                                                GpiCreateBitmap.

PMERR_INV_VIEWING_LIMITS                        An invalid limits parameter was
                                                specified with
                                                GpiSetViewingLimits.

PMERR_INV_VIEWLIM                               A set viewing limits order has
                                                an inconsistent mask and order
                                                length in the input PIF.

PMERR_INV_XFORM                                 A set (default) viewing
                                                transform order has an
                                                inconsistent mask and order
                                                length in the input PIF.

PMERR_INV_3DCOORD                               An order specifying
                                                3-dimensional coordinates has
                                                been found in the input PIF.

PMERR_INVALID_ARRAY_COUNT                       An array has an invalid count,
                                                that is, less than or equal to
                                                zero.

PMERR_INVALID_APPL                              Attempted to start an
                                                application whose type is not
                                                recognized by OS/2.

PMERR_INVALID_ARRAY_SIZE                        A control data type array size
                                                is invalid.

PMERR_INVALID_ASCIIZ                            The profile string is not a
                                                valid zero-terminated string.

PMERR_INVALID_ATOM                              The specified atom does not
                                                exist in the atom table.

PMERR_INVALID_ATOM_NAME                         An invalid atom name string was
                                                passed.

PMERR_INVALID_BUNDLE_TYPE                       An invalid bundle type was
                                                passed.

PMERR_INVALID_CHARACTER_INDEX                   On WinNextChar or WinPrevChar,
                                                a character index is invalid,
                                                that is, it is less than 1 or
                                                is greater than the string
                                                length+1.

PMERR_INVALID_CONTROL_DATATYPE                  An invalid control data type
                                                was specified.

PMERR_INVALID_CONTROL_SEQ_INDEX                 There is an invalid index in a
                                                control data type sequence (for
                                                array, length, offset or
                                                MPARAM) that is, the index is
                                                to a non-existent or
                                                non-numeric entry.

PMERR_INVALID_DATATYPE                          An invalid data type was
                                                specified.

PMERR_INVALID_DST_CODEPAGE                      The destination code page
                                                parameter is invalid.

PMERR_INVALID_FLAG                              An invalid bit was set for a
                                                parameter. Use constants
                                                defined by PM for options, and
                                                do not set any reserved bits.

PMERR_INVALID_ERRORINFO_HANDLE                  On WinFreeErrorInfo, the
                                                ERRINFO is not the handle of an
                                                ERRINFO structure, that is, it
                                                was not created by
                                                WinGetErrorInfo.

PMERR_INVALID_FREE_MESSAGE_ID                   An invalid message identifier
                                                was specified. The call has
                                                completed by assuming the
                                                message parameter and reply
                                                data types to be ULONG.

PMERR_INVALID_GROUP_HANDLE                      An invalid program-group handle
                                                was specified.

PMERR_INVALID_HACCEL                            An invalid accelerator-table
                                                handle was specified.

PMERR_INVALID_HANDLE                            An invalid handle was
                                                specified.

PMERR_INVALID_HAPP                              The application handle passed
                                                to WinTerminateApp does not
                                                correspond to a valid session.

PMERR_INVALID_HATOMTBL                          An invalid atom-table handle
                                                was specified.

PMERR_INVALID_HEAP_POINTER                      An invalid pointer was found
                                                within the heap.

PMERR_INVALID_HEAP_SIZE_PARM                    Invalid data was found within
                                                the heap.

PMERR_INVALID_HEAP_SIZE_WORD                    Invalid data was found within
                                                the heap.

PMERR_INVALID_HENUM                             An invalid enumeration handle
                                                was specified.

PMERR_INVALID_HHEAP                             An invalid heap handle was
                                                specified.

PMERR_INVALID_HMQ                               An invalid message-queue handle
                                                was specified.

PMERR_INVALID_HPTR                              An invalid pointer handle was
                                                specified.

PMERR_INVALID_HSTRUCT                           An invalid (null) structure
                                                handle was specified.

PMERR_INVALID_HWND                              An invalid window handle was
                                                specified.

PMERR_INVALID_INI_FILE_HANDLE                   An invalid initialization-file
                                                handle was specified.

PMERR_INVALID_INTEGER_ATOM                      The specified atom is not a
                                                valid integer atom.

PMERR_INVALID_MESSAGE_ID                        A message identifier is
                                                invalid.

PMERR_INVALID_NUMBER_OF_PARMS                   The number of parameters is
                                                invalid.

PMERR_INVALID_NUMBER_OF_TYPES                   The function call has an
                                                invalid number (zero) of types.

PMERR_INVALID_PARAMETERS                        An application parameter value
                                                is invalid for its converted PM
                                                type. For example: a 4-byte
                                                value outside the range -
                                                32,768 to +32,767 cannot be
                                                converted to a SHORT, and a
                                                negative number cannot be
                                                converted to a ULONG or USHORT.

PMERR_INVALID_PARAMETER_TYPE                    A parameter type is invalid for
                                                a bundle mask.

PMERR_INVALID_PARM                              A parameter to the function
                                                contained invalid data.

PMERR_INVALID_PROGRAM_HANDLE                    An invalid program handle was
                                                specified.

PMERR_INVALID_SESSION_ID                        The specified session
                                                identifier is invalid.  Either
                                                zero (for the application's own
                                                session) or a valid identifier
                                                must be specified.

PMERR_INVALID_SRC_CODEPAGE                      The source code page parameter
                                                is invalid.

PMERR_INVALID_STRING_PARM                       The specified string parameter
                                                is invalid.

PMERR_INVALID_SWITCH_HANDLE                     An invalid Window List entry
                                                handle was specified.

PMERR_INVALID_TARGET_HANDLE                     An invalid target program-group
                                                handle was specified.

PMERR_INVALID_TITLE                             The specified program or group
                                                title is too long or contains
                                                invalid characters.

PMERR_INVALID_TYPE_FOR_LENGTH                   The data type for a control
                                                length is invalid.

PMERR_INVALID_TYPE_FOR_MPARAM                   The message parameter type for
                                                a control MPARAM is invalid,
                                                that is, not mparam1, mparam2
                                                or mreply.

PMERR_INVALID_TYPE_FOR_OFFSET                   The data type for a control
                                                offset is invalid.

PMERR_INVALID_WINDOW                            The window specified with a
                                                Window List call is not a valid
                                                frame window.

PMERR_KERNING_NOT_SUPPORTED                     Kerning was requested on
                                                GpiCreateLogFont call to a
                                                presentation space associated
                                                with a device context that does
                                                not support kerning.

PMERR_LABEL_NOT_FOUND                           The specified element label did
                                                not exist.

PMERR_MATRIX_OVERFLOW                           An internal overflow error
                                                occurred during matrix
                                                multiplication. This can occur
                                                if coordinates or matrix
                                                transformation elements (or
                                                both) are invalid or too large.

PMERR_MEMORY_ALLOC                              An error occurred during memory
                                                management.

PMERR_MEMORY_ALLOCATION_ERR                     An error occurred during memory
                                                management.

PMERR_MEMORY_DEALLOCATION_ERR                   An error occurred during memory
                                                management.

PMERR_METAFILE_INTERNAL_ERROR                   An internal inconsistency has
                                                been detected during metafile
                                                unlock processing.

PMERR_METAFILE_IN_USE                           An attempt has been made to
                                                access a metafile that is in
                                                use by another thread.

PMERR_METAFILE_LIMIT_EXCEEDED                   The maximum permitted metafile
                                                size limit was exceeded during
                                                metafile recording.

PMERR_MSGID_TOO_SMALL                           The message identifier
                                                specified is too small.

PMERR_NEGATIVE_STRCOND_DIM                      A negative array dimension was
                                                passed for a data type length.

PMERR_NO_BITMAP_SELECTED                        An attempt has been made to
                                                operate on a memory device
                                                context that has no bit map
                                                selected.

PMERR_NO_CURRENT_ELEMENT                        An attempt has been made to
                                                issue GpiQueryElementType or
                                                GpiQueryElement while there is
                                                no currently open element.

PMERR_NO_CURRENT_SEG                            An attempt has been made to
                                                issue GpiQueryElementType or
                                                GpiQueryElement while there is
                                                no currently open segment.

PMERR_NO_FILL                                   No flood fill occurred because
                                                either the starting point color
                                                was the same as the input color
                                                when a boundary fill was
                                                requested, or the starting
                                                point color was not the same as
                                                the input color when a surface
                                                fill was requested.

PMERR_NO_METAFILE_RECORD_HANDLE                 The metafile record handle was
                                                not found during metafile
                                                recording, or DevEscape
                                                (DEVESC_STARTDOC) was not
                                                issued when drawing to a
                                                OD_QUEUED device context with a
                                                pszDataType field of PM_Q_STD.

PMERR_NO_PALETTE_SELECTED                       An attempt to realize a palette
                                                failed because no palette was
                                                previously selected into the
                                                Presentation Space.

PMERR_NO_SPACE                                  The limit on the number of
                                                Window List entries has been
                                                reached with WinAddSwitchEntry.

PMERR_NOT_CREATED_BY_DEVOPENDC                  An attempt has been made to
                                                destroy a device context using
                                                DevCloseDC that was not created
                                                using DevOpenDC.

PMERR_NOT_CURRENT_PL_VERSION                    An unexpected data format was
                                                found in the initialization
                                                file.

PMERR_NOT_DRAGGING                              A drag operation is not in
                                                progress at this time.

PMERR_NOT_IN_A_PM_SESSION                       An attempt was made to access
                                                function that is only available
                                                from PM programs from a non-PM
                                                session.

PMERR_NOT_IN_AREA                               An attempt was made to end an
                                                area using GpiEndArea or during
                                                segment drawing while not in an
                                                area bracket.

PMERR_NOT_IN_DRAW_MODE                          An attempt was made to issue
                                                GpiSavePS or GpiRestorePS while
                                                the drawing mode was not set to
                                                DM_DRAW.

PMERR_NOT_IN_ELEMENT                            An attempt was made to end an
                                                element using GpiEndElement or
                                                during segment drawing while
                                                not in an element bracket.

PMERR_NOT_IN_IDX                                The application name, key-name
                                                or program handle was not
                                                found.

PMERR_NOT_IN_IMAGE                              An attempt was made to end an
                                                image during segment drawing
                                                while not in an image bracket.

PMERR_NOT_IN_PATH                               An attempt was made to end a
                                                path using GpiEndPath or during
                                                segment drawing while not in a
                                                path bracket.

PMERR_NOT_IN_RETAIN_MODE                        An attempt was made to issue a
                                                segment editing element
                                                function that is invalid when
                                                the actual drawing mode is not
                                                set to retain.

PMERR_NOT_IN_SEG                                An attempt was made to end a
                                                segment using GpiCloseSegment
                                                while not in a segment bracket.

PMERR_NOT_SELF_DESCRIBING_DTYP                  A data type is not
                                                self-describing.

PMERR_OPENING_INI_FILE                          Unable to open initialization
                                                file (due to lack of disk space
                                                for example).

PMERR_ORDER_TOO_BIG                             An internal size limit was
                                                exceeded while converting
                                                orders from short to long
                                                format during GpiPutData
                                                processing. An order was too
                                                long to convert.

PMERR_OWN_SET_ID_REFS                           An attempt to unload a font
                                                failed because the setid is
                                                still being referenced.

PMERR_PALETTE_BUSY                              An attempt has been made to
                                                reset the owner of a palette
                                                when it was busy.

PMERR_PALETTE_SELECTED                          Color palette operations cannot
                                                be performed on a presentation
                                                space while a palette is
                                                selected.

PMERR_PARAMETER_OUT_OF_RANGE                    The value of a parameter was
                                                not within the defined valid
                                                range for that parameter.

PMERR_PATH_INCOMPLETE                           An attempt was made to open or
                                                close a segment either directly
                                                or during segment drawing, or
                                                to issue GpiAssociate while
                                                there is an open path bracket.

PMERR_PATH_LIMIT_EXCEEDED                       An internal size limit was
                                                exceeded during path or area
                                                processing.

PMERR_PATH_UNKNOWN                              An attempt was made to perform
                                                a path function on a path that
                                                did not exist.

PMERR_PEL_IS_CLIPPED                            An attempt was made to query a
                                                pel that had been clipped using
                                                GpiQueryPel.

PMERR_PEL_NOT_AVAILABLE                         An attempt was made to query a
                                                pel that did not exist in
                                                GpiQueryPel (for example, a
                                                memory device context with no
                                                selected bit map).

PMERR_PROLOG_ERROR                              A prolog error was detected
                                                during drawing.  Segment
                                                prologs are used internally
                                                within retained segments and
                                                also appear in metafiles. This
                                                error can also arise from an
                                                End Prolog order that is
                                                outside a prolog.

PMERR_PRINTER_DD_NOT_DEFINED                    The Presentation Manager device
                                                driver has not been defined.

PMERR_PRINTER_QUEUE_NOT_DEFINED                 The spooler queue for the
                                                printer has not been defined.

PMERR_PRN_ADDR_IN_USE                           A printer is already defined on
                                                the port.

PMERR_PRN_ADDR_NOT_DEFINED                      The printer port has not been
                                                defined.

PMERR_PRN_NAME_NOT_DEFINED                      The printer has not been
                                                defined.

PMERR_PS_BUSY                                   An attempt was made to access
                                                the presentation space from
                                                more than one thread
                                                simultaneously.

PMERR_PS_IS_ASSOCIATED                          An attempt was made to destroy
                                                a presentation or associate a
                                                presentation space that is
                                                still associated with a device
                                                context.

PMERR_PS_NOT_ASSOCIATED                         An attempt was made to access a
                                                presentation space that is not
                                                associated with a device
                                                context.

PMERR_QUEUE_ALREADY_EXISTS                      An attempt to create a message
                                                queue for a thread failed
                                                because one already exists for
                                                the calling thread.

PMERR_RASTER_FONT                               A request was made for the
                                                outline of a bit-map font.
                                                Outlines can only be returned
                                                for vector font characters.

PMERR_REALIZE_NOT_SUPPORTED                     An attempt was made to create a
                                                realizable logical color table
                                                on a device driver that does
                                                not support this function.

PMERR_REGION_IS_CLIP_REGION                     An attempt was made to perform
                                                a region operation on a region
                                                that is selected as a clip
                                                region.

PMERR_RESOURCE_DEPLETION                        An internal resource depletion
                                                error has occurred.

PMERR_RESOURCE_NOT_FOUND                        The specified resource identity
                                                could not be found.

PMERR_SEG_AND_REFSEG_ARE_SAME                   The segid and refsegid
                                                specified with
                                                GpiSetSegmentPriority were the
                                                same.

PMERR_SEG_CALL_STACK_EMPTY                      A call stack empty condition
                                                was detected when attempting a
                                                pop function during GpiPop or
                                                segment drawing.

PMERR_SEG_CALL_STACK_FULL                       A call stack full condition was
                                                detected when attempting to
                                                call a segment using
                                                GpiCallSegmentMatrix,
                                                attempting to preserve an
                                                attribute, or during segment
                                                drawing.

PMERR_SEG_IS_CURRENT                            An attempt was made to issue
                                                GpiGetData to a segment that
                                                was currently open.

PMERR_SEG_NOT_CHAINED                           An attempt was made to issue
                                                GpiDrawFrom, GpiCorrelateFrom
                                                or GpiQuerySegmentPriority for
                                                a segment that was not chained.

PMERR_SEG_NOT_FOUND                             The specified segment
                                                identifier did not exist.

PMERR_SEG_OVFLOW                                The input PIF has more than
                                                1000 called segments. This has
                                                overflowed an internal buffer.

PMERR_SEG_STORE_LIMIT_EXCEEDED                  The maximum permitted retained
                                                segment store size limit was
                                                exceeded.

PMERR_SET_ID_REFS                               An attempt to unload a font
                                                failed because the setid is
                                                still being referenced.

PMERR_SETID_IN_USE                              An attempt was made to specify
                                                a setid that was already in use
                                                as the currently selected
                                                character, marker or pattern
                                                set.

PMERR_SETID_NOT_FOUND                           An attempt was made to delete a
                                                setid that did not exist.

PMERR_SMB_OVFLOW                                The input PIF has more than 100
                                                symbol sets defined. This has
                                                overflowed an internal buffer.

PMERR_SOURCE_SAME_AS_TARGET                     The direct manipulation source
                                                and target process are the
                                                same.

PMERR_SPL_CANNOT_OPEN_FILE                      Unable to open the file.

PMERR_SPL_DD_NOT_FOUND                          The Presentation Manager device
                                                driver definition could not be
                                                found.

PMERR_SPL_DEVICE_ALREADY_EXISTS                 The device already exists.

PMERR_SPL_DEVICE_LIMIT_REACHED                  The limit on the number of
                                                devices has been reached.

PMERR_SPL_DEVICE_NOT_INSTALLED                  The device has not been
                                                installed.

PMERR_SPL_DRIVER_ERROR                          No Presentation Manager device
                                                driver supplied or found.

PMERR_SPL_DRIVER_NOT_INSTALLED                  The Presentation Manager device
                                                driver has not been installed.

PMERR_SPL_FILE_NOT_FOUND                        Unable to find the file.

PMERR_SPL_HARD_NETWORK_ERROR                    Hard network error.

PMERR_SPL_INI_FILE_ERROR                        Error accessing the
                                                initialization file.

PMERR_SPL_INV_DATATYPE                          The spool file data type is
                                                invalid.

PMERR_SPL_INV_DRIVER_DATATYPE                   The data type is invalid for
                                                the Presentation Manager device
                                                driver.

PMERR_SPL_INV_FORMS_CODE                        The forms code for the job is
                                                invalid.

PMERR_SPL_INV_HSPL                              The spooler handle is invalid.

PMERR_SPL_INV_JOB_ID                            The job id is invalid.

PMERR_SPL_INV_LENGTH_OR_COUNT                   The length or count is invalid.

PMERR_SPL_INV_PRIORITY                          The priority for the job is
                                                invalid.

PMERR_SPL_INV_PROCESSOR_DATTYPE                 The data type is invalid for
                                                the spooler queue processor.

PMERR_SPL_INV_QUEUE_NAME                        The spooler queue name is
                                                invalid.

PMERR_SPL_INV_TOKEN                             The token is invalid.

PMERR_SPL_JOB_NOT_PRINTING                      The print job is not printing.

PMERR_SPL_JOB_PRINTING                          The print job is already
                                                printing.

PMERR_SPL_MANY_QUEUES_ASSOC                     More than one queue has been
                                                associated with the printer.

PMERR_SPL_NO_CURRENT_FORMS_CODE                 There is no current forms code
                                                defined to the Presentation
                                                Manager device driver.

PMERR_SPL_NO_DATA                               No data supplied or found.

PMERR_SPL_NO_DEFAULT_QUEUE                      There is no default spooler
                                                queue for the printer.

PMERR_SPL_NO_DISK_SPACE                         There is not enough free disk
                                                space.

PMERR_SPL_NO_FREE_JOB_ID                        There is no free job id
                                                available.

PMERR_SPL_NO_MEMORY                             There is not enough free
                                                memory.

PMERR_SPL_NO_QUEUES_ASSOCIATED                  A queue has not been associated
                                                with the printer.

PMERR_SPL_NO_SUCH_LOG_ADDRESS                   The logical address does not
                                                exist (that is, it is not
                                                defined in the initialization
                                                file).

PMERR_SPL_NOT_AUTHORISED                        Not authorized to perform the
                                                operation.

PMERR_SPL_PRINT_ABORT                           The job has already been
                                                aborted.

PMERR_SPL_PRINTER_NOT_FOUND                     The printer definition could
                                                not be found.

PMERR_SPL_PROCESSOR_ERROR                       No spooler queue processor
                                                supplied or found.

PMERR_SPL_PROCESSOR_NOT_INST                    The spooler queue processor has
                                                not been installed.

PMERR_SPL_QUEUE_ALREADY_EXISTS                  The spooler queue already
                                                exists.

PMERR_SPL_QUEUE_ERROR                           No spooler queue supplied or
                                                found.

PMERR_SPL_QUEUE_NOT_EMPTY                       The spooler queue contains
                                                print jobs.

PMERR_SPL_QUEUE_NOT_FOUND                       The spooler queue definition
                                                could not be found.

PMERR_SPL_SPOOLER_NOT_INSTALLED                 The spooler is not installed.

PMERR_SPL_STATUS_STRING_TRUNC                   The print job status string has
                                                been truncated.

PMERR_SPL_TEMP_NETWORK_ERROR                    Temporary network error.

PMERR_SPL_TOO_MANY_OPEN_FILES                   Too many open files.

PMERR_SPOOLER_QP_NOT_DEFINED                    The spooler queue processor has
                                                not been defined.

PMERR_START_POINT_CLIPPED                       The starting point specified
                                                for flood fill is outside the
                                                current clipping path or
                                                region.

PMERR_STARTDOC_NOT_ISSUED                       A request to write spooled
                                                output without first issuing a
                                                STARTDOC was attempted.

PMERR_STARTED_IN_BACKGROUND                     The application started a new
                                                session in the background.

PMERR_STOP_DRAW_OCCURRED                        Segment drawing or
                                                GpiPlayMetaFile was stopped
                                                prematurely in response to a
                                                GpiSetStopDraw request.

PMERR_TOO_MANY_METAFILES_IN_USE                 The maximum number of metafiles
                                                allowed for a given process was
                                                exceeded.

PMERR_TRUNCATED_ORDER                           An incomplete order was
                                                detected during segment
                                                processing.

PMERR_UNABLE_TO_CLOSE_DEVICE                    Unable to close the print
                                                device (for example, powered
                                                off or offline).

PMERR_UNCHAINED_SEG_ZERO_INV                    An attempt was made to open
                                                segment with segment identifier
                                                zero and the ATTR_CHAINED
                                                segment attribute not
                                                specified.

PMERR_UNKNOWN_BUNDLE_TYPE                       Unknown bundle-type primitive.

PMERR_UNSUPPORTED_ATTR                          An unsupported attribute was
                                                specified in the attrmask with
                                                GpiSetAttrs or GpiQueryAttrs.

PMERR_UNSUPPORTED_ATTR_VALUE                    An attribute value was
                                                specified with GpiSetAttrs that
                                                is not supported.

PMERR_WIN_DEBUGMSG                              Ignore this error. It is
                                                reserved for system use.

PMERR_WINDOW_LOCK_OVERFLOW                      An overflow occurred for the
                                                use count of a window.

PMERR_WINDOW_LOCK_UNDERFLOW                     An attempt was made to
                                                decrement the use count of a
                                                window below zero.

PMERR_WINDOW_NOT_LOCKED                         The window specified in
                                                WinSendMsg was not locked.