IUIX_Combo::GetItemImage Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Combo::GetItemImage Method}}
 
{{#customTitle:IUIX_Combo::GetItemImage Method}}
{{#parentPage:PXV:IUIX_Combo|method}}
+
{{#parentPage:PXV:IUIX_Combo#Methods|GetItemImage|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Gets ''image'' of required item.  
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetItemImage([in] LONG nItem, [out, retval] IUnknown** ppImage);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetItemImage([in]           LONG       nItem,
 +
                    [out, retval] IUnknown** pImage);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nItem''
+
;nItem
:[in]  Value of LONG.
+
:[in]  number of an item.
;''ppImage''
+
;pImage
:[out, retval]  Pointer to IUnknown*.
+
:[out, retval]  Returned object of <code>IUnknown</code> interface. If there is no image in required item, returns <code>nullptr</code> value. 
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.
 +
 
 +
== Remarks ==
 +
Note, that returned object is of <code>IUnknown</code> interface. Use <code>[[PXV:IUIX_Obj_QueryImpl|QueryImpl]]</code> method to query implementation of <code>[[PXV:IUIX_Icon|IUIX_Icon]]</code> or <code>[[PXV:IUIX_ImageData|IUIX_ImageData]]</code> from <code>IUnknown</code>.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_Combo|IUIX_Combo]].
+
[[PXV:IUIX_Combo|IUIX_Combo]]

Latest revision as of 14:08, 15 June 2015


Gets image of required item.

Syntax

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

Parameters

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

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

Remarks

Note, that returned object is of IUnknown interface. Use QueryImpl method to query implementation of IUIX_Icon or IUIX_ImageData from IUnknown.

See Also

IUIX_Combo