IUIX_CustomLabelsProvider::GetCustomLabel Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CustomLabelsProvider::GetCustomLabel Method}} | {{#customTitle:IUIX_CustomLabelsProvider::GetCustomLabel Method}} | ||
| − | {{#parentPage:PXV:IUIX_CustomLabelsProvider#Methods|GetCustomLabel | + | {{#parentPage:PXV:IUIX_CustomLabelsProvider#Methods|GetCustomLabel|method}} |
| − | + | ||
| − | + | ||
The method of interface of PDF-XChange Editor SDK. | The method of interface of PDF-XChange Editor SDK. | ||
| + | |||
| + | Returns a custom label for the specified item. | ||
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT GetCustomLabel([in] LONG nItemLabelIndex, | <pre class="brush:cpp;gutter:false">HRESULT GetCustomLabel([in] LONG nItemLabelIndex, | ||
| − | [out] BSTR* | + | [out] BSTR* sLabel);</pre> |
== Parameters == | == Parameters == | ||
;nItemLabelIndex | ;nItemLabelIndex | ||
:[in] Value of LONG. | :[in] Value of LONG. | ||
| − | ; | + | ;sLabel |
:[out] Pointer to BSTR. | :[out] Pointer to BSTR. | ||
== 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:IUIX_CustomLabelsProvider|IUIX_CustomLabelsProvider]] | + | [[PXV:IUIX_CustomLabelsProvider|IUIX_CustomLabelsProvider]] |
Latest revision as of 15:06, 15 June 2015
The method of interface of PDF-XChange Editor SDK.
Returns a custom label for the specified item.
Syntax
HRESULT GetCustomLabel([in] LONG nItemLabelIndex,
[out] BSTR* sLabel);
Parameters
- nItemLabelIndex
- [in] Value of LONG.
- sLabel
- [out] Pointer to BSTR.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
