IXC_PageBlockData Structure

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IXC_PageBlockData Structure}}
 
{{#customTitle:IXC_PageBlockData Structure}}
 
{{#parentPage:PXV:IXC|IXC_PageBlockData Structure|structure}}
 
{{#parentPage:PXV:IXC|IXC_PageBlockData Structure|structure}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
Specifies the ...
+
Specifies the attributes of a locked block of a page.
  
 
== Syntax ==
 
== Syntax ==
Line 20: Line 20:
 
== Members ==
 
== Members ==
 
;Width
 
;Width
: Value of ULONG ...
+
: The number of pixels in one scan line of the locked portion of the page.
 
;Height
 
;Height
: Value of ULONG ...
+
: The number of scan lines in the locked portion of the page.
 
;Stride
 
;Stride
: Value of LONG ...
+
: Offset, in bytes, between consecutive scan lines of the page.
 
;reserved
 
;reserved
: Value of ULONG ...
+
: Reserved for internal usage, and must be not modified by the user.
 
;pData
 
;pData
: Pointer to UCHAR ...
+
: Pointer to the first (index 0) scan line of the locked portion of the page.
 +
 
 +
== Remarks ==
 +
The '''IXC_PageBlockData''' structure is returned by [[PXV:IIXC_Page_LockPageBlock|PXV:IIXC_Page::LockPageBlock]] as part of the page block locking process, and used subsequently by [[PXV:IIXC_Page_UnlockPageBlock|PXV:IIXC_Page_UnlockPageBlock]] to unlock the page block. It should NOT be modified in any way!
  
 
== See Also ==
 
== See Also ==
See also ...
+
::[[PXV:IIXC_Page_LockPageBlock|PXV:IIXC_Page::LockPageBlock]]
 +
::[[PXV:IIXC_Page_UnlockPageBlock|PXV:IIXC_Page_UnlockPageBlock]]

Revision as of 04:44, 7 May 2015


Specifies the attributes of a locked block of a page.

Syntax

struct IXC_PageBlockData
{
    ULONG  Width;
    ULONG  Height;
    LONG   Stride;
    ULONG  reserved;
    UCHAR* pData;
};

Members

Width
The number of pixels in one scan line of the locked portion of the page.
Height
The number of scan lines in the locked portion of the page.
Stride
Offset, in bytes, between consecutive scan lines of the page.
reserved
Reserved for internal usage, and must be not modified by the user.
pData
Pointer to the first (index 0) scan line of the locked portion of the page.

Remarks

The IXC_PageBlockData structure is returned by PXV:IIXC_Page::LockPageBlock as part of the page block locking process, and used subsequently by IIXC_Page::UnlockPageBlock Method to unlock the page block. It should NOT be modified in any way!

See Also

PXV:IIXC_Page::LockPageBlock
IIXC_Page::UnlockPageBlock Method