This documentation is archived and is not being maintained.

SoapMessage::GetOutParameterValue Method

Gets the out parameter passed into the XML Web service method at the specified index.

Namespace:  System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)

public:
Object^ GetOutParameterValue(
	int index
)

Parameters

index
Type: System::Int32
The zero-based index of the parameter in the array of parameters.

Return Value

Type: System::Object
An Object representing the parameter at the specified index.

ExceptionCondition
IndexOutOfRangeException

The index parameter is greater than the length of the parameters array.

InvalidOperationException

Accessing this property when out parameters are not available. For details see the Remarks section.

If out parameters are not available, ASP.NET throws an InvalidOperationException when accessing the GetOutParameterValue property.

In a SoapClientMessage the out parameters are available in the AfterDeserialize SoapMessageStage. In a SoapServerMessage the out parameters are available in the BeforeSerialize of the SoapMessageStage.


myStreamWriter->WriteLine( "The values of the out parameter are:" );
myStreamWriter->WriteLine(
   "The value of the out parameter is: {0}", message->GetOutParameterValue( 0 ) );


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: