Asposecpplib
System::Web::Services::Protocols::SoapHeader Class Reference

Represents content of the SOAP header. 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.

Public Member Functions

String get_Actor ()
 Gets the URI of the SOAP header recipient when SOAP version 1.1 is used. More...
 
void set_Actor (String value)
 Sets the URI of the SOAP header recipient when SOAP version 1.1 is used. More...
 
bool get_DidUnderstand ()
 Gets a value that indicates if the SOAP header is properly processed. More...
 
void set_DidUnderstand (bool value)
 Sets a value that indicates if the SOAP header is properly processed. More...
 
String get_EncodedMustUnderstand ()
 Gets a value of the 'mustUnderstand' attribute when SOAP version 1.1 is used. More...
 
void set_EncodedMustUnderstand (String value)
 Sets a value of the 'mustUnderstand' attribute when SOAP version 1.1 is used. More...
 
bool get_MustUnderstand ()
 Gets a value that indicates if the SOAP header must be understood. More...
 
void set_MustUnderstand (bool value)
 Sets a value that indicates if the SOAP header must be understood. More...
 
String get_EncodedMustUnderstand12 ()
 Gets a value of the 'mustUnderstand' attribute when SOAP version 1.2 is used. More...
 
void set_EncodedMustUnderstand12 (String value)
 Sets a value of the 'mustUnderstand' attribute when SOAP version 1.2 is used. More...
 
String get_EncodedRelay ()
 Gets a string representation of the 'relay' attribute value. More...
 
void set_EncodedRelay (String value)
 Sets a string representation of the 'relay' attribute value. More...
 
bool get_Relay ()
 Gets a value of the 'relay' attribute. More...
 
void set_Relay (bool value)
 Sets a value of the 'relay' attribute. More...
 
String get_Role ()
 Gets the URI of the SOAP header recipient when SOAP version 1.2 is used. More...
 
void set_Role (String value)
 Sets the URI of the SOAP header recipient when SOAP version 1.2 is used. More...
 
 SoapHeader (System::SharedPtr< Xml::XmlElement > elem)
 Constructs a new instance. 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

 SoapHeader ()
 Constructs a new instance. 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 content of the SOAP header. 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

◆ SoapHeader() [1/2]

System::Web::Services::Protocols::SoapHeader::SoapHeader ( System::SharedPtr< Xml::XmlElement elem)

Constructs a new instance.

Parameters
elemAn XML element used to initialize a new instance.

◆ SoapHeader() [2/2]

System::Web::Services::Protocols::SoapHeader::SoapHeader ( )
protected

Constructs a new instance.

Member Function Documentation

◆ get_Actor()

String System::Web::Services::Protocols::SoapHeader::get_Actor ( )

Gets the URI of the SOAP header recipient when SOAP version 1.1 is used.

Returns
The URI of the SOAP header recipient when SOAP version 1.1 is used.

◆ get_DidUnderstand()

bool System::Web::Services::Protocols::SoapHeader::get_DidUnderstand ( )

Gets a value that indicates if the SOAP header is properly processed.

Returns
A value that indicates if the SOAP header is properly processed.

◆ get_EncodedMustUnderstand()

String System::Web::Services::Protocols::SoapHeader::get_EncodedMustUnderstand ( )

Gets a value of the 'mustUnderstand' attribute when SOAP version 1.1 is used.

Returns
A value of the 'mustUnderstand' attribute when SOAP version 1.1 is used.

◆ get_EncodedMustUnderstand12()

String System::Web::Services::Protocols::SoapHeader::get_EncodedMustUnderstand12 ( )

Gets a value of the 'mustUnderstand' attribute when SOAP version 1.2 is used.

Returns
A value of the 'mustUnderstand' attribute when SOAP version 1.2 is used.

◆ get_EncodedRelay()

String System::Web::Services::Protocols::SoapHeader::get_EncodedRelay ( )

Gets a string representation of the 'relay' attribute value.

Returns
A string representation of the 'relay' attribute value.

◆ get_MustUnderstand()

bool System::Web::Services::Protocols::SoapHeader::get_MustUnderstand ( )

Gets a value that indicates if the SOAP header must be understood.

Returns
A value that indicates if the SOAP header must be understood.

◆ get_Relay()

bool System::Web::Services::Protocols::SoapHeader::get_Relay ( )

Gets a value of the 'relay' attribute.

Returns
A value of the 'relay' attribute.

◆ get_Role()

String System::Web::Services::Protocols::SoapHeader::get_Role ( )

Gets the URI of the SOAP header recipient when SOAP version 1.2 is used.

Returns
The URI of the SOAP header recipient when SOAP version 1.2 is used.

◆ set_Actor()

void System::Web::Services::Protocols::SoapHeader::set_Actor ( String  value)

Sets the URI of the SOAP header recipient when SOAP version 1.1 is used.

Parameters
valueThe value that must be set.

◆ set_DidUnderstand()

void System::Web::Services::Protocols::SoapHeader::set_DidUnderstand ( bool  value)

Sets a value that indicates if the SOAP header is properly processed.

Parameters
valueThe value that must be set.

◆ set_EncodedMustUnderstand()

void System::Web::Services::Protocols::SoapHeader::set_EncodedMustUnderstand ( String  value)

Sets a value of the 'mustUnderstand' attribute when SOAP version 1.1 is used.

Parameters
valueThe value that must be set.

◆ set_EncodedMustUnderstand12()

void System::Web::Services::Protocols::SoapHeader::set_EncodedMustUnderstand12 ( String  value)

Sets a value of the 'mustUnderstand' attribute when SOAP version 1.2 is used.

Parameters
valueThe value that must be set.

◆ set_EncodedRelay()

void System::Web::Services::Protocols::SoapHeader::set_EncodedRelay ( String  value)

Sets a string representation of the 'relay' attribute value.

Parameters
valueThe value that must be set.
Remarks
Possible values: '0', 'false', '1' and 'true'.

◆ set_MustUnderstand()

void System::Web::Services::Protocols::SoapHeader::set_MustUnderstand ( bool  value)

Sets a value that indicates if the SOAP header must be understood.

Parameters
valueThe value that must be set.

◆ set_Relay()

void System::Web::Services::Protocols::SoapHeader::set_Relay ( bool  value)

Sets a value of the 'relay' attribute.

Parameters
valueThe value that must be set.

◆ set_Role()

void System::Web::Services::Protocols::SoapHeader::set_Role ( String  value)

Sets the URI of the SOAP header recipient when SOAP version 1.2 is used.

Parameters
valueThe value that must be set.