IUIX_Combo::GetItemImage Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IUIX_Combo::GetItemImage Method}}
 
{{#customTitle:IUIX_Combo::GetItemImage Method}}
 
{{#parentPage:PXV:IUIX_Combo|GetItemImage Method|method}}
 
{{#parentPage:PXV:IUIX_Combo|GetItemImage Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets ''image'' of required item.  
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 12:
 
== Parameters ==
 
== Parameters ==
 
;nItem
 
;nItem
:[in]  Value of LONG.
+
:[in]  LONG. Number of an item.
 
;ppImage
 
;ppImage
:[out, retval]  Pointer to IUnknown*.
+
:[out, retval]  Returned object of IUnknown interface. If there is no image in required item, returns ''nullptr'' value. 
  
 
== 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 ==
 +
Note, that returned object is of IUnknown interface. Use _QueryImpl(..) to query implementation of [[PXV:IUIX_Icon|IUIX_Icon]] or [[PXV:IUIX_ImageData|IUIX_ImageData]] from IUnknown.
  
 
== See Also ==
 
== See Also ==
 
See also [[PXV:IUIX_Combo|IUIX_Combo]].
 
See also [[PXV:IUIX_Combo|IUIX_Combo]].

Revision as of 02:34, 8 May 2015


Gets image of required item.

Syntax

HRESULT GetItemImage([in]           LONG        nItem,
                     [out, retval]  IUnknown**  ppImage);

Parameters

nItem
[in] LONG. Number of an item.
ppImage
[out, retval] Returned object of IUnknown interface. If there is no image in required item, returns nullptr value.

Return Value

Returns S_OK if operation was successful or error code in other cases.

Remarks

Note, that returned object is of IUnknown interface. Use _QueryImpl(..) to query implementation of IUIX_Icon or IUIX_ImageData from IUnknown.

See Also

See also IUIX_Combo.