IIXC_Page::UnlockPageBlock Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IIXC_Page::UnlockPageBlock Method}} | {{#customTitle:IIXC_Page::UnlockPageBlock Method}} | ||
| − | {{#parentPage:PXV:IIXC_Page|UnlockPageBlock | + | {{#parentPage:PXV:IIXC_Page#Methods|UnlockPageBlock|method}} |
| − | + | ||
| − | + | ||
The method unlocks a portion of the page that was previously locked by a call to [[PXV:IIXC_Page_LockPageBlock|IIXC_Page::LockPageBlock]]. | 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 == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT UnlockPageBlock([in] IXC_PageBlockData* | + | <pre class="brush:cpp;gutter:false">HRESULT UnlockPageBlock([in] IXC_PageBlockData* stBlockData);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;stBlockData |
| − | :[in] Pointer to [[PXV:IXC_PageBlockData|IXC_PageBlockData]] structure that was previously passed to [[PXV:IIXC_Page_LockPageBlock|IIXC_Page::LockPageBlock]]. | + | :[in] Pointer to a [[PXV:IXC_PageBlockData|IXC_PageBlockData]] structure that was previously passed to [[PXV:IIXC_Page_LockPageBlock|IIXC_Page::LockPageBlock]]. |
== Return Value == | == Return Value == | ||
| Line 21: | Line 20: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IIXC_Page|IIXC_Page]] | |
| − | + | ||
| − | + | ||
Latest revision as of 02:17, 15 June 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* stBlockData);
Parameters
- stBlockData
- [in] Pointer to a 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.
