Discuss this help topic in SecureBlackbox Forum

TElXMLSOAPClient.AddStringParameter

TElXMLSOAPClient     See also     


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


Adds a new string parameter to the list.

Declaration

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

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

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

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

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

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

Parameters

  • ParamName - the name of the new parameter.
  • NormalizeNEL - (Normalize NEw Line) specifies whether the end-of-line characters should be normalized.
  • ParamNamespaceURI - the namespace URI of the new parameter.
  • Value - the value of the new parameter.

Return value

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

Description

This is a convenience method for adding a string message operation parameter.

See also:     Add parameters to SOAP message     AddParameter     Parameters    

Discuss this help topic in SecureBlackbox Forum