IPXV_AttachList::Remove Method

Latest revision as of 03:47, 15 June 2015

Removes items from the attachments list by index.

HRESULT Remove([in]                   ULONG  nIndex,
               [in, defaultvalue(1)]  ULONG  nCount);

nIndex: [in] Starting index of the items to be removed from the attachments list.
nCount: [in, defaultvalue(1)] Number of the items to be removed from the attachments list starting from the given index.

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::Remove Method}}
+{{#parentPage:PXV:IPXV_AttachList#Methods|Remove|method}}
 Removes items from the attachments list by index.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT Remove([in] ULONG nIndex, [in, optional] ULONG nCount);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT Remove([in]                   ULONG  nIndex,
+               [in, defaultvalue(1)]  ULONG  nCount);</pre>
 == Parameters ==
-;''nIndex''
+;nIndex
 :[in]  Starting index of the items to be removed from the attachments list.
-;''nCount''
+;nCount
-:[in, optional]  Number of the items to be removed from the attachments list starting from the given index.
+:[in, defaultvalue(1)]  Number of the items to be removed from the attachments list starting from the given index.
 == 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]]