IIXC_Page::UnlockPageBlock Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 2: | Line 2: | ||
{{#customTitle:IIXC_Page::UnlockPageBlock Method}} | {{#customTitle:IIXC_Page::UnlockPageBlock Method}} | ||
{{#parentPage:PXV:IIXC_Page|UnlockPageBlock Method|method}} | {{#parentPage:PXV:IIXC_Page|UnlockPageBlock Method|method}} | ||
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | The method of | + | The method unlocks a portion of the page that was previously locked by a call to [[PXV:IIXC_Page_LockPageBlock|IIXC_Page::LockPageBlock]]. |
== Syntax == | == Syntax == | ||
| Line 12: | Line 12: | ||
== Parameters == | == Parameters == | ||
;pBlockData | ;pBlockData | ||
| − | :[in] Pointer to [[PXV:IXC_PageBlockData|IXC_PageBlockData]]. | + | :[in] Pointer to [[PXV:IXC_PageBlockData|IXC_PageBlockData]] structure that was previously passed to [[PXV:IIXC_Page_LockPageBlock|IIXC_Page::LockPageBlock]]. |
== Return Value == | == Return Value == | ||
Returns S_OK if operation was successful or error code in other cases. | Returns S_OK if operation was successful or error code in other cases. | ||
| + | |||
| + | == Remarks == | ||
| + | [[PXV:IIXC_Page_LockPageBlock|IIXC_Page::LockPageBlock]] and [[PXV:IIXC_Page_UnlockPageBlock|IIXC_Page::UnlockPageBlock]] must be used as a pair. A call to the [[PXV:IIXC_Page_LockPageBlock|IIXC_Page::LockPageBlock]] function of the page establishes a temporary buffer that you can use to read or write pixel data. After you write to the temporary buffer, a call to [[PXV:IIXC_Page_UnlockPageBlock|IIXC_Page::UnlockPageBlock]] copies the pixel data in the buffer to the page. | ||
== See Also == | == See Also == | ||
See also [[PXV:IIXC_Page|IIXC_Page]]. | See also [[PXV:IIXC_Page|IIXC_Page]]. | ||
Revision as of 05:07, 7 May 2015
The method unlocks a portion of the page that was previously locked by a call to IIXC_Page::LockPageBlock.
Syntax
HRESULT UnlockPageBlock([in] IXC_PageBlockData* pBlockData);
Parameters
- pBlockData
- [in] Pointer to IXC_PageBlockData structure that was previously passed to IIXC_Page::LockPageBlock.
Return Value
Returns S_OK if operation was successful or error code in other cases.
Remarks
IIXC_Page::LockPageBlock and IIXC_Page::UnlockPageBlock must be used as a pair. A call to the IIXC_Page::LockPageBlock function of the page establishes a temporary buffer that you can use to read or write pixel data. After you write to the temporary buffer, a call to IIXC_Page::UnlockPageBlock copies the pixel data in the buffer to the page.
See Also
See also IIXC_Page.
