IPXV_Inst::Str2ID Method

PDF Editor Layer > Interfaces > IPXV_Inst > IPXV_Inst::Str2ID Method

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();
}

See Also

IPXV_Inst