IIXC_Page::UnlockPageBlock Method

From Tracker Software PDF SDK
Jump to: navigation, search
Line 3: Line 3:
 
{{#parentPage:PXV:IIXC_Page|UnlockPageBlock Method|method}}
 
{{#parentPage:PXV:IIXC_Page|UnlockPageBlock Method|method}}
  
{{ToReview}}
 
  
 
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]].
Line 12: Line 11:
 
== Parameters ==
 
== Parameters ==
 
;pBlockData
 
;pBlockData
:[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 ==

Revision as of 13:27, 15 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 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.

See Also

IIXC_Page.
IIXC_Page::LockPageBlock
IXC_PageBlockData