IPXV_Inst::Str2ID Method
From PDF XChange PDF SDK
| (3 intermediate revisions by one other user not shown) | |||
| Line 8: | Line 8: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Str2ID([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT Str2ID([in] BSTR sStr, |
[in, defaultvalue(-1)] VARIANT_BOOL bAddIfNotExists, | [in, defaultvalue(-1)] VARIANT_BOOL bAddIfNotExists, | ||
| − | [out, retval] LONG* | + | [out, retval] LONG* nID);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;sStr |
:[in] The string identifier to be converted to number. | :[in] The string identifier to be converted to number. | ||
;bAddIfNotExists | ;bAddIfNotExists | ||
:[in, defaultvalue(-1)] Indicates whether to add input string to the global table of string-identifiers. Default value is <tt>true</tt>. | :[in, defaultvalue(-1)] Indicates whether to add input string to the global table of string-identifiers. Default value is <tt>true</tt>. | ||
| − | ; | + | ;nID |
:[out, retval] Returns the numeric ID. | :[out, retval] Returns the numeric ID. | ||
== Return Value == | == Return Value == | ||
Returns S_OK if operation was successful or error code in other cases. | Returns S_OK if operation was successful or error code in other cases. | ||
| + | |||
| + | == Sample == | ||
| + | <pre class="brush:c#">//C# | ||
| + | private void AddContent(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst, PDFXEdit.IPXC_Content Content) | ||
| + | { | ||
| + | int nID = Inst.Str2ID("op.addContent", false); | ||
| + | PDFXEdit.IOperation Op = Inst.CreateOp(nID); | ||
| + | PDFXEdit.ICabNode input = Op.Params.Root["Input"]; | ||
| + | input.Add().v = Doc.CoreDoc; | ||
| + | PDFXEdit.ICabNode options = Op.Params.Root["Options"]; | ||
| + | options["Content"].v = Content; | ||
| + | options["TargetPage"].v = 0; | ||
| + | options["InsertClone"].v = true; | ||
| + | Op.Do(); | ||
| + | } | ||
| + | </pre> | ||
== See Also == | == See Also == | ||
[[PXV:IPXV_Inst|IPXV_Inst]] | [[PXV:IPXV_Inst|IPXV_Inst]] | ||
Latest revision as of 23:54, 21 April 2016
Converts string identifier to numerical identifier.
Syntax
HRESULT Str2ID([in] BSTR sStr,
[in, defaultvalue(-1)] VARIANT_BOOL bAddIfNotExists,
[out, retval] LONG* nID);
Parameters
- sStr
- [in] The string identifier to be converted to number.
- bAddIfNotExists
- [in, defaultvalue(-1)] Indicates whether to add input string to the global table of string-identifiers. Default value is true.
- nID
- [out, retval] Returns the numeric ID.
Return Value
Returns S_OK if operation was successful or error code in other cases.
Sample
//C#
private void AddContent(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst, PDFXEdit.IPXC_Content Content)
{
int nID = Inst.Str2ID("op.addContent", false);
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
PDFXEdit.ICabNode input = Op.Params.Root["Input"];
input.Add().v = Doc.CoreDoc;
PDFXEdit.ICabNode options = Op.Params.Root["Options"];
options["Content"].v = Content;
options["TargetPage"].v = 0;
options["InsertClone"].v = true;
Op.Do();
}
