IPXC_Article::RemoveBead Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Article::RemoveBead Method}} | {{#customTitle:IPXC_Article::RemoveBead Method}} | ||
| − | {{#parentPage:PXV:IPXC_Article|method | + | {{#parentPage:PXV:IPXC_Article#Methods|RemoveBead|method}} |
| − | + | ||
| − | + | ||
| − | + | Removes bead from article by index. Note that removing last bead will remove '''F''' value from the article's [[PXV:IPXS_PDFVariant|PDF object]]. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT RemoveBead([in] ULONG nBead);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT RemoveBead([in] ULONG nBead);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;nBead |
| − | :[in] | + | :[in] Index of the bead that will be removed. |
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_Article|IPXC_Article]] | |
Latest revision as of 02:20, 15 June 2015
Removes bead from article by index. Note that removing last bead will remove F value from the article's PDF object.
Syntax
HRESULT RemoveBead([in] ULONG nBead);
Parameters
- nBead
- [in] Index of the bead that will be removed.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
