Structures

Structures


This section describes the Active Document structures.

OLECMD
OLECMDTEXT
PAGERANGE
PAGESET

OLECMD

typedef struct _tagOLECMD
{
    ULONG cmdID;
    DWORD cmdf;
}OLECMDF;

Associates command flags from the OLECMDF enumeration with a command identifier through a call to the IOleCommandTarget::QueryStatus method.

cmdID
Command identifier; taken from the OLECMDID enumeration.
cmdf
Flags associated with cmdID; taken from the OLECMDF enumeration.

OLECMDTEXT

typedef struct _tagOLECMDTEXT
{
    DWORD cmdtextf;
    ULONG cwActual;
    ULONG cwBuf;
    wchar_t rgwz[1];
}OLECMDTEXT;

Specifies a text name or status string for a single command identifier. This structure is used with the IOleCommandTarget::QueryStatus method.

cmdtextf
Value from the OLECMDTEXTF enumeration describing whether the rgwz member contains a command name or status text.
cwActual
Number of characters actually written into the rgwz buffer before IOleCommandTarget::QueryStatus returns.
cwBuf
Number of elements in the rgwz buffer.
rgwz
Caller-allocated wide character buffer to receive the command name or status text.

PAGERANGE

typedef struct tagPAGERANGE
{
    LONG nFromPage;
    LONG nToPage;
}PAGERANGE;
 

Specifies a range of pages. The arrays contained in the rgPages member of the PAGESET structure are PAGERANGE structures.

nFromPage
First page of the range. This member can have any page number as a value. If this value is greater than the value specified in the nToPage member, the document will be printed in reverse page order.
nToPage
Last page of the range. A special value, PAGESET_TOLASTPAGE, indicates that all the remaining pages should be printed. This member can have any page number as a value. If this value is less than the value specified in the nFromPage member, the document will be printed in reverse page order.

PAGESET

typedef struct tagPAGESET
{
    ULONG cbStruct;
    BOOL fOddPages;
    BOOL fEvenPages;
    ULONG cPageRange;
    [size_is(cPageRange)] PAGERANGE rgPages[]
}PAGESET;
 

Identifies one or more page ranges to be printed and, optionally, identifies only the even or odd pages as part of a page set.

cbStruct
Number of bytes in this instance of the PAGESET structure. Must be a multiple of 4.
fOddPages
If TRUE, only the odd-numbered pages in the page set indicated by the rgPages member are to be printed.
fEvenPages
If TRUE, only the even-numbered pages in the page set indicated by the rgPages member are to be printed.
cPageRange
Number of page-range pairs specified in rgPages.
rgPages
Address of an array of PAGERANGE structures specifying the pages to be printed. One or more page ranges can be specified, as long as the number of page ranges is the value of the cPageRange member. The page ranges must be sorted in ascending order and must be nonoverlapping.

© 1997 Microsoft Corporation. All rights reserved. Terms of Use.