IXC_PageBlockData Structure
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IXC_PageBlockData Structure}} | {{#customTitle:IXC_PageBlockData Structure}} | ||
| + | {{#parentPage:PXV:IXC_Structures|IXC_PageBlockData|structure}} | ||
| − | Specifies the | + | Specifies the attributes of a locked block of a page. |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">struct IXC_PageBlockData | <pre class="brush:cpp;gutter:false">struct IXC_PageBlockData | ||
{ | { | ||
| − | ULONG Width; | + | ULONG Width; |
| − | ULONG Height; | + | ULONG Height; |
| − | LONG Stride; | + | LONG Stride; |
| − | ULONG reserved; | + | ULONG reserved; |
UCHAR* pData; | UCHAR* pData; | ||
}; | }; | ||
| Line 17: | Line 19: | ||
== Members == | == Members == | ||
;Width | ;Width | ||
| − | : | + | : The number of pixels in one scan line of the locked portion of the page. |
;Height | ;Height | ||
| − | : | + | : The number of scan lines in the locked portion of the page. |
;Stride | ;Stride | ||
| − | : | + | : Offset, in bytes, between consecutive scan lines of the page. |
;reserved | ;reserved | ||
| − | : | + | : Reserved for internal usage, and must be not modified by the user. |
;pData | ;pData | ||
| − | : Pointer to | + | : 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 == | ||
| − | + | [[PXV:IIXC_Page_LockPageBlock|IIXC_Page::LockPageBlock]], [[PXV:IIXC_Page_UnlockPageBlock|IIXC_Page::UnlockPageBlock]] | |
Latest revision as of 09:33, 23 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!
