Discuss this help topic in SecureBlackbox Forum

TElXMLSOAPCompoundParameter.AddString

TElXMLSOAPCompoundParameter     See also     


Filter: C#  VB.NET  Pascal  C++  PHP  Java  


Adds a new string parameter to the compound.

Declaration

[C#]
    int AddString(string ParamName, string Value);
    int AddString(string ParamName, string Value, bool NormalizeNEL);
    int AddString(string ParamName, string ParamNamespaceURI, string Value);
    int AddString(string ParamName, string ParamNamespaceURI, string Value, bool NormalizeNEL);

[VB.NET]
    Function AddString(ByVal ParamName As String, ByVal Value As String) As Integer
    Function AddString(ByVal ParamName As String, ByVal Value As String, ByVal NormalizeNEL As Boolean) As Integer
    Function AddString(ByVal ParamName As String, ByVal ParamNamespaceURI As String, ByVal Value As String) As Integer
    Function AddString(ByVal ParamName As String, ByVal ParamNamespaceURI As String, ByVal Value As String, ByVal NormalizeNEL As Boolean) As Integer

[Pascal]
    function AddString(const ParamName, Value : XMLString) : Integer; overload;
    function AddString(const ParamName, Value : XMLString; NormalizeNEL : Boolean) : Integer; overload;
    function AddString(const ParamName, ParamNamespaceURI, Value : XMLString) : Integer; overload;
    function AddString(const ParamName, ParamNamespaceURI, Value : XMLString; NormalizeNEL : Boolean) : Integer; overload;

[C++]
    int32_t AddString(const sb_u16string &ParamName, const sb_u16string &Value);
    int32_t AddString(const std::wstring &ParamName, const std::wstring &Value);
    int32_t AddString(const sb_u16string &ParamName, const sb_u16string &Value, bool NormalizeNEL);
    int32_t AddString(const std::wstring &ParamName, const std::wstring &Value, bool NormalizeNEL);
    int32_t AddString(const sb_u16string &ParamName, const sb_u16string &ParamNamespaceURI, const sb_u16string &Value);
    int32_t AddString(const std::wstring &ParamName, const std::wstring &ParamNamespaceURI, const std::wstring &Value);
    int32_t AddString(const sb_u16string &ParamName, const sb_u16string &ParamNamespaceURI, const sb_u16string &Value, bool NormalizeNEL);
    int32_t AddString(const std::wstring &ParamName, const std::wstring &ParamNamespaceURI, const std::wstring &Value, bool NormalizeNEL);

[PHP]
    integer AddString(string $ParamName, string $Value)
    integer AddString(string $ParamName, string $Value, bool $NormalizeNEL)
    integer AddString(string $ParamName, string $ParamNamespaceURI, string $Value)
    integer AddString(string $ParamName, string $ParamNamespaceURI, string $Value, bool $NormalizeNEL)

[Java]
    int addString(String ParamName, String ParamNamespaceURI, String Value);
    int addString(String ParamName, String Value);
    int addString(String ParamName, String Value, boolean NormalizeNEL);
    int addString(String ParamName, String ParamNamespaceURI, String Value, boolean NormalizeNEL);

Parameters

  • ParamName - the name of the new parameter.
  • NormalizeNEL - specifies whether to normalize the newline (NEL) characters.
  • ParamNamespaceURI - new parameter's namespace URI.
  • Value - the value of the new parameter.

Return value

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

Description

Use this method to add a string value to the compound.

See also:     Items    

Discuss this help topic in SecureBlackbox Forum