IPXV_AttachList::Find Method

Latest revision as of 02:47, 15 June 2015

Finds item in the attachments list.

HRESULT Find([in]           IPXC_FileSpec*  pItem,
             [out, retval]  LONG*           nIndex);

pItem: [in] Pointer to IPXC_FileSpec containing the item to search for in the attachments list.
nIndex: [out, retval] Returned index of the item in the attachments list.

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IPXV_AttachList::Find Method}}
+{{#parentPage:PXV:IPXV_AttachList#Methods|Find|method}}
-The method of interface of PDF-XChange Editor SDK.
+Finds item in the attachments list.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT Find([in] IPXC_FileAttachment* pItem, [out, retval] LONG* pIndex);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT Find([in]           IPXC_FileSpec*  pItem,
+             [out, retval]  LONG*           nIndex);</pre>
 == Parameters ==
-;''pItem''
+;pItem
-:[in]  Pointer to [[PXV:IPXC_FileAttachment|IPXC_FileAttachment]].
+:[in]  Pointer to [[PXV:IPXC_FileSpec|IPXC_FileSpec]] containing the item to search for in the attachments list.
-;''pIndex''
+;nIndex
-:[out, retval]  Pointer to LONG.
+:[out, retval]  Returned index of the item in the attachments list.
 == 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.
 == See Also ==
-See also [[PXV:IPXV_AttachList|IPXV_AttachList]].
+[[PXV:IPXV_AttachList|IPXV_AttachList]]