Asposecpplib
System::Web::Services::Protocols::SoapClientMessage Class Referencefinal

Represents the data in a SOAP request sent or a SOAP response received. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Web::Services::Protocols::SoapMessage.

Public Member Functions

String get_Action () override
 Returns a value of the 'SOAPAction' attribute. More...
 
System::SharedPtr< SoapHttpClientProtocolget_Client ()
 Returns an instance of the client proxy class. More...
 
virtual bool get_OneWay ()
 Returns a value that indicates if a client doesn't wait for a server to finish processing a method. More...
 
String get_Url () override
 Returns the XML Web service URL. More...
 
SoapProtocolVersion get_SoapVersion () override
 Returns the SOAP version that is used. More...
 
 SoapClientMessage (System::SharedPtr< SoapHttpClientProtocol > client, System::SharedPtr< SoapMethodStubInfo > msi, String url, System::ArrayPtr< System::SharedPtr< Object >> parameters)
 Constructs a new instance. More...
 
- Public Member Functions inherited from System::Web::Services::Protocols::SoapMessage
System::ArrayPtr< System::SharedPtr< Object > > get_InParameters ()
 Gets the parameters that are passed into the XML Web service method. More...
 
void set_InParameters (System::ArrayPtr< System::SharedPtr< Object >> value)
 Sets the parameters that are passed into the XML Web service method. More...
 
System::ArrayPtr< System::SharedPtr< Object > > get_OutParameters ()
 Gets the output parameters passed into the XML Web service method. More...
 
void set_OutParameters (System::ArrayPtr< System::SharedPtr< Object >> value)
 Sets the output parameters passed into the XML Web service method. More...
 
String get_ContentType ()
 Gets a value of the 'Content-Type' header. More...
 
void set_ContentType (String value)
 Sets a value of the 'Content-Type' header. More...
 
System::SharedPtr< SoapHeaderCollectionget_Headers ()
 Returns the collection of the SOAP headers. More...
 
SoapMessageStage get_Stage ()
 Gets the processing stage of a SOAP message. More...
 
System::SharedPtr< System::IO::Streamget_Stream ()
 Gets the stream that contains the SOAP message data. More...
 
void SetStream (System::SharedPtr< System::IO::Stream > stream)
 Sets the stream that contains the SOAP message data. More...
 
String get_ContentEncoding ()
 Gets a value of the 'Content-Encoding' header. More...
 
void set_ContentEncoding (String value)
 Sets a value of the 'Content-Encoding' header. More...
 
bool get_IsSoap12 ()
 Returns a value that indicates if SOAP version 1.2 is used. More...
 
void set_InternalStream (System::SharedPtr< System::IO::Stream > value)
 Sets the stream that contains the SOAP message data. More...
 
 SoapMessage ()
 Constructs a new instance. More...
 
void SetStage (SoapMessageStage stage)
 Sets the processing stage of the SOAP message. More...
 
System::SharedPtr< ObjectGetInParameterValue (int32_t index)
 Gets the input parameter value at the specified index. More...
 
System::SharedPtr< ObjectGetOutParameterValue (int32_t index)
 Gets the output parameter value at the specified index. More...
 
System::SharedPtr< ObjectGetReturnValue ()
 Gets the return value of the XML Web service method. More...
 
void SetHeaders (System::SharedPtr< SoapHeaderCollection > headers)
 Sets the collection of the SOAP headers. More...
 
void SetException (SoapException ex)
 Sets the exception that is thrown by the XML Web service method. More...
 
SoapException get_Exception ()
 Gets the exception that is thrown by the XML Web service method. More...
 
void CollectHeaders (System::SharedPtr< Object > target, System::ArrayPtr< System::SharedPtr< SoapHeaderMapping >> headers, SoapHeaderDirection direction)
 Sets the internal collection of the SOAP headers. More...
 
void UpdateHeaderValues (System::SharedPtr< Object > target, System::ArrayPtr< System::SharedPtr< SoapHeaderMapping >> headersInfo)
 Updates the internal collection of the SOAP headers. More...
 
System::SharedPtr< SoapHeaderMapping > FindHeader (System::ArrayPtr< System::SharedPtr< SoapHeaderMapping >> headersInfo, const TypeInfo &headerType)
 Find the header mapping by specified header type. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Public Attributes

System::SharedPtr< SoapMethodStubInfo > MethodStubInfo
 Method stub information. More...
 
System::ArrayPtr< System::SharedPtr< Object > > Parameters
 A collection of parameters. More...
 

Protected Member Functions

void EnsureInStage () override
 Checks if the current stage contains input parameters. More...
 
void EnsureOutStage () override
 Checks if the current stage contains output parameters. More...
 
- Protected Member Functions inherited from System::Web::Services::Protocols::SoapMessage
void EnsureStage (SoapMessageStage stage)
 Checks if the current stage is equal to the specified one. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Represents the data in a SOAP request sent or a SOAP response received. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ SoapClientMessage()

System::Web::Services::Protocols::SoapClientMessage::SoapClientMessage ( System::SharedPtr< SoapHttpClientProtocol client,
System::SharedPtr< SoapMethodStubInfo >  msi,
String  url,
System::ArrayPtr< System::SharedPtr< Object >>  parameters 
)

Constructs a new instance.

Parameters
clientAn instance of the client proxy class.
msiMethod stub information.
urlThe URL of an XML web service.
parametersA collection of parameters.

Member Function Documentation

◆ EnsureInStage()

void System::Web::Services::Protocols::SoapClientMessage::EnsureInStage ( )
overrideprotectedvirtual

Checks if the current stage contains input parameters.

Implements System::Web::Services::Protocols::SoapMessage.

◆ EnsureOutStage()

void System::Web::Services::Protocols::SoapClientMessage::EnsureOutStage ( )
overrideprotectedvirtual

Checks if the current stage contains output parameters.

Implements System::Web::Services::Protocols::SoapMessage.

◆ get_Action()

String System::Web::Services::Protocols::SoapClientMessage::get_Action ( )
overridevirtual

Returns a value of the 'SOAPAction' attribute.

Returns
A value of the 'SOAPAction' attribute.

Implements System::Web::Services::Protocols::SoapMessage.

◆ get_Client()

System::SharedPtr<SoapHttpClientProtocol> System::Web::Services::Protocols::SoapClientMessage::get_Client ( )

Returns an instance of the client proxy class.

Returns
An instance of the client proxy class.

◆ get_OneWay()

virtual bool System::Web::Services::Protocols::SoapClientMessage::get_OneWay ( )
virtual

Returns a value that indicates if a client doesn't wait for a server to finish processing a method.

Returns
A value that indicates if a client doesn't wait for a server to finish processing a method.

◆ get_SoapVersion()

SoapProtocolVersion System::Web::Services::Protocols::SoapClientMessage::get_SoapVersion ( )
overridevirtual

Returns the SOAP version that is used.

Returns
The SOAP version that is used.

Reimplemented from System::Web::Services::Protocols::SoapMessage.

◆ get_Url()

String System::Web::Services::Protocols::SoapClientMessage::get_Url ( )
overridevirtual

Returns the XML Web service URL.

Returns
The XML Web service URL.

Implements System::Web::Services::Protocols::SoapMessage.

Member Data Documentation

◆ MethodStubInfo

System::SharedPtr<SoapMethodStubInfo> System::Web::Services::Protocols::SoapClientMessage::MethodStubInfo

Method stub information.

◆ Parameters

System::ArrayPtr<System::SharedPtr<Object> > System::Web::Services::Protocols::SoapClientMessage::Parameters

A collection of parameters.