Asposecpplib
System::Web::Services::Protocols::SoapMessage Class Referenceabstract

Represent the SOAP message. 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::Object.

Inherited by System::Web::Services::Protocols::SoapClientMessage.

Public Member Functions

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...
 
virtual String get_Action ()=0
 Returns a value of the 'SOAPAction' attribute. 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...
 
virtual String get_Url ()=0
 Returns the XML Web service URL. 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...
 
virtual SoapProtocolVersion get_SoapVersion ()
 Returns the SOAP version that 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...
 

Protected Member Functions

virtual void EnsureInStage ()=0
 Checks if the current stage contains input parameters. More...
 
virtual void EnsureOutStage ()=0
 Checks if the current stage contains output parameters. More...
 
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

Represent the SOAP message. 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

◆ SoapMessage()

System::Web::Services::Protocols::SoapMessage::SoapMessage ( )

Constructs a new instance.

Member Function Documentation

◆ CollectHeaders()

void System::Web::Services::Protocols::SoapMessage::CollectHeaders ( System::SharedPtr< Object target,
System::ArrayPtr< System::SharedPtr< SoapHeaderMapping >>  headers,
SoapHeaderDirection  direction 
)

Sets the internal collection of the SOAP headers.

Parameters
targetThe object to get the SOAP headers from.
headersA collection of headers from which the internal collection will be filled.
directionThe SOAP header direction.

◆ EnsureInStage()

virtual void System::Web::Services::Protocols::SoapMessage::EnsureInStage ( )
protectedpure virtual

Checks if the current stage contains input parameters.

Implemented in System::Web::Services::Protocols::SoapClientMessage.

◆ EnsureOutStage()

virtual void System::Web::Services::Protocols::SoapMessage::EnsureOutStage ( )
protectedpure virtual

Checks if the current stage contains output parameters.

Implemented in System::Web::Services::Protocols::SoapClientMessage.

◆ EnsureStage()

void System::Web::Services::Protocols::SoapMessage::EnsureStage ( SoapMessageStage  stage)
protected

Checks if the current stage is equal to the specified one.

Parameters
stageThe stage to compare.
Exceptions
System::InvalidOperationExceptionWhen the current stage isn't equal to the specified one.

◆ FindHeader()

System::SharedPtr<SoapHeaderMapping> System::Web::Services::Protocols::SoapMessage::FindHeader ( System::ArrayPtr< System::SharedPtr< SoapHeaderMapping >>  headersInfo,
const TypeInfo headerType 
)

Find the header mapping by specified header type.

Parameters
headersInfoThe collection of the header mappings.
headerTypeThe header type to look for.
Returns
The header mapping.

◆ get_Action()

virtual String System::Web::Services::Protocols::SoapMessage::get_Action ( )
pure virtual

Returns a value of the 'SOAPAction' attribute.

Returns
A value of the 'SOAPAction' attribute.

Implemented in System::Web::Services::Protocols::SoapClientMessage.

◆ get_ContentEncoding()

String System::Web::Services::Protocols::SoapMessage::get_ContentEncoding ( )

Gets a value of the 'Content-Encoding' header.

Returns
A value of the 'Content-Encoding' header.

◆ get_ContentType()

String System::Web::Services::Protocols::SoapMessage::get_ContentType ( )

Gets a value of the 'Content-Type' header.

Returns
A value of the 'Content-Type' header.

◆ get_Exception()

SoapException System::Web::Services::Protocols::SoapMessage::get_Exception ( )

Gets the exception that is thrown by the XML Web service method.

Returns
The exception that is thrown by the XML Web service method.

◆ get_Headers()

System::SharedPtr<SoapHeaderCollection> System::Web::Services::Protocols::SoapMessage::get_Headers ( )

Returns the collection of the SOAP headers.

Returns
The collection of the SOAP headers.

◆ get_InParameters()

System::ArrayPtr<System::SharedPtr<Object> > System::Web::Services::Protocols::SoapMessage::get_InParameters ( )

Gets the parameters that are passed into the XML Web service method.

Returns
The parameters that are passed into the XML Web service method.

◆ get_IsSoap12()

bool System::Web::Services::Protocols::SoapMessage::get_IsSoap12 ( )

Returns a value that indicates if SOAP version 1.2 is used.

Returns
A value that indicates if SOAP version 1.2 is used.

◆ get_OutParameters()

System::ArrayPtr<System::SharedPtr<Object> > System::Web::Services::Protocols::SoapMessage::get_OutParameters ( )

Gets the output parameters passed into the XML Web service method.

Returns
The output parameters passed into the XML Web service method.

◆ get_SoapVersion()

virtual SoapProtocolVersion System::Web::Services::Protocols::SoapMessage::get_SoapVersion ( )
virtual

Returns the SOAP version that is used.

Returns
The SOAP version that is used.

Reimplemented in System::Web::Services::Protocols::SoapClientMessage.

◆ get_Stage()

SoapMessageStage System::Web::Services::Protocols::SoapMessage::get_Stage ( )

Gets the processing stage of a SOAP message.

Returns
The processing stage of a SOAP message.

◆ get_Stream()

System::SharedPtr<System::IO::Stream> System::Web::Services::Protocols::SoapMessage::get_Stream ( )

Gets the stream that contains the SOAP message data.

Returns
The stream that contains the SOAP message data.

◆ get_Url()

virtual String System::Web::Services::Protocols::SoapMessage::get_Url ( )
pure virtual

Returns the XML Web service URL.

Returns
The XML Web service URL.

Implemented in System::Web::Services::Protocols::SoapClientMessage.

◆ GetInParameterValue()

System::SharedPtr<Object> System::Web::Services::Protocols::SoapMessage::GetInParameterValue ( int32_t  index)

Gets the input parameter value at the specified index.

Parameters
indexThe index of the input parameter.
Returns
The input parameter value.

◆ GetOutParameterValue()

System::SharedPtr<Object> System::Web::Services::Protocols::SoapMessage::GetOutParameterValue ( int32_t  index)

Gets the output parameter value at the specified index.

Parameters
indexThe index of the output parameter.
Returns
The output parameter value.

◆ GetReturnValue()

System::SharedPtr<Object> System::Web::Services::Protocols::SoapMessage::GetReturnValue ( )

Gets the return value of the XML Web service method.

Returns
The return value of the XML Web service method.

◆ set_ContentEncoding()

void System::Web::Services::Protocols::SoapMessage::set_ContentEncoding ( String  value)

Sets a value of the 'Content-Encoding' header.

Parameters
valueThe value that must be set.

◆ set_ContentType()

void System::Web::Services::Protocols::SoapMessage::set_ContentType ( String  value)

Sets a value of the 'Content-Type' header.

Parameters
valueThe value that must be set.

◆ set_InParameters()

void System::Web::Services::Protocols::SoapMessage::set_InParameters ( System::ArrayPtr< System::SharedPtr< Object >>  value)

Sets the parameters that are passed into the XML Web service method.

Parameters
valueThe value that must be set.

◆ set_InternalStream()

void System::Web::Services::Protocols::SoapMessage::set_InternalStream ( System::SharedPtr< System::IO::Stream value)

Sets the stream that contains the SOAP message data.

Parameters
valueThe value that must be set.

◆ set_OutParameters()

void System::Web::Services::Protocols::SoapMessage::set_OutParameters ( System::ArrayPtr< System::SharedPtr< Object >>  value)

Sets the output parameters passed into the XML Web service method.

Parameters
valueThe value that must be set.

◆ SetException()

void System::Web::Services::Protocols::SoapMessage::SetException ( SoapException  ex)

Sets the exception that is thrown by the XML Web service method.

Parameters
exThe exception that must be set.

◆ SetHeaders()

void System::Web::Services::Protocols::SoapMessage::SetHeaders ( System::SharedPtr< SoapHeaderCollection headers)

Sets the collection of the SOAP headers.

Parameters
headersThe collection of the SOAP headers to set.

◆ SetStage()

void System::Web::Services::Protocols::SoapMessage::SetStage ( SoapMessageStage  stage)

Sets the processing stage of the SOAP message.

Parameters
stageThe stage that must be set.

◆ SetStream()

void System::Web::Services::Protocols::SoapMessage::SetStream ( System::SharedPtr< System::IO::Stream stream)

Sets the stream that contains the SOAP message data.

Parameters
streamThe stream that must be set.

◆ UpdateHeaderValues()

void System::Web::Services::Protocols::SoapMessage::UpdateHeaderValues ( System::SharedPtr< Object target,
System::ArrayPtr< System::SharedPtr< SoapHeaderMapping >>  headersInfo 
)

Updates the internal collection of the SOAP headers.

Parameters
targetThe object to get the SOAP headers from.
headersInfoA collection of headers from which the internal collection will be updated.