TElXMLSOAPBaseSignatureHandler.AddReference method

TElXMLSOAPBaseSignatureHandler.AddReference

Adds a new reference to the list.

Declaration

[C#]
    int AddReference(TElXMLDOMElement Element);
    int AddReference(TElXMLDOMElement Element, bool AutoGenerateId);
    int AddReference(TElXMLDOMElement Element, string CustomId);
    int AddReference(TElXMLCustomElement Element);
    int AddReference(TElXMLCustomElement Element, bool AutoGenerateId);
    int AddReference(TElXMLCustomElement Element, string CustomId);
    int AddReference(System.IO.Stream Stream, string FileNameURI);

[VB.NET]
    Function AddReference(ByVal Element As TElXMLDOMElement) As Integer
    Function AddReference(ByVal Element As TElXMLDOMElement, ByVal AutoGenerateId As Boolean) As Integer
    Function AddReference(ByVal Element As TElXMLDOMElement, ByVal CustomId As String) As Integer
    Function AddReference(ByVal Element As TElXMLCustomElement) As Integer
    Function AddReference(ByVal Element As TElXMLCustomElement, ByVal AutoGenerateId As Boolean) As Integer
    Function AddReference(ByVal Element As TElXMLCustomElement, ByVal CustomId As String) As Integer
    Function AddReference(ByVal Stream As System.IO.Stream, ByVal FileNameURI As String) As Integer

[Pascal]
    function AddReference(Element : TElXMLDOMElement) : Integer; overload;
    function AddReference(Element : TElXMLDOMElement; AutoGenerateId : Boolean) : Integer; overload;
    function AddReference(Element : TElXMLDOMElement; const CustomId : XMLString) : Integer; overload;
    function AddReference(Element : TElXMLCustomElement) : Integer; overload;
    function AddReference(Element : TElXMLCustomElement; AutoGenerateId : Boolean) : Integer; overload;
    function AddReference(Element : TElXMLCustomElement; const CustomId : XMLString) : Integer; overload;
    function AddReference(Stream : TElStream; const FileNameURI : XMLString) : Integer; overload;

[C++]
    int32_t AddReference(TElXMLDOMElement &Element);
    int32_t AddReference(TElXMLDOMElement *Element);
    int32_t AddReference(TElXMLDOMElement &Element, bool AutoGenerateId);
    int32_t AddReference(TElXMLDOMElement *Element, bool AutoGenerateId);
    int32_t AddReference(TElXMLDOMElement &Element, const sb_u16string &CustomId);
    int32_t AddReference(TElXMLDOMElement *Element, const sb_u16string &CustomId);
    int32_t AddReference(TElXMLDOMElement &Element, const std::wstring &CustomId);
    int32_t AddReference(TElXMLDOMElement *Element, const std::wstring &CustomId);
    int32_t AddReference(TElXMLCustomElement &Element);
    int32_t AddReference(TElXMLCustomElement *Element);
    int32_t AddReference(TElXMLCustomElement &Element, bool AutoGenerateId);
    int32_t AddReference(TElXMLCustomElement *Element, bool AutoGenerateId);
    int32_t AddReference(TElXMLCustomElement &Element, const sb_u16string &CustomId);
    int32_t AddReference(TElXMLCustomElement *Element, const sb_u16string &CustomId);
    int32_t AddReference(TElXMLCustomElement &Element, const std::wstring &CustomId);
    int32_t AddReference(TElXMLCustomElement *Element, const std::wstring &CustomId);
    int32_t AddReference(TStream &Stream, const sb_u16string &FileNameURI);
    int32_t AddReference(TStream *Stream, const sb_u16string &FileNameURI);
    int32_t AddReference(TStream &Stream, const std::wstring &FileNameURI);
    int32_t AddReference(TStream *Stream, const std::wstring &FileNameURI);

[PHP]
    integer AddReference(TElXMLDOMElement $Element)
    integer AddReference(TElXMLDOMElement $Element, bool $AutoGenerateId)
    integer AddReference(TElXMLDOMElement $Element, string $CustomId)
    integer AddReference(TElXMLCustomElement $Element)
    integer AddReference(TElXMLCustomElement $Element, bool $AutoGenerateId)
    integer AddReference(TElXMLCustomElement $Element, string $CustomId)
    integer AddReference(TStream $Stream, string $FileNameURI)

[Java]
    int addReference(TElXMLCustomElement Element, String CustomId);
    int addReference(TElStream Stream, String FileNameURI);
    int addReference(TElXMLDOMElement Element);
    int addReference(TElXMLCustomElement Element, boolean AutoGenerateId);
    int addReference(TElXMLCustomElement Element);
    int addReference(TElXMLDOMElement Element, boolean AutoGenerateId);
    int addReference(TElXMLDOMElement Element, String CustomId);

Parameters

Element - the XML element to be signed.
AutoGenerateId - set this parameter to true to allow the signer to automatically generate the element's identifier.
CustomId - this parameter can be used to assign a custom identifier to the element.
Stream - a stream containing the data to be signed.
FileNameURI - name of the file to be signed.

Return value

Returns the index of the newly added item in the list on success, and -1 on failure.

Description

Use this method to add a reference to the entry that will be covered by the signature.