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.

[Visual Basic]
Public Function GetOutParameterValue( _
   ByVal index As Integer _
) As Object
[C#]
public object GetOutParameterValue(
 int index
);
[C++]
public: Object* GetOutParameterValue(
 int index
);
[JScript]
public function GetOutParameterValue(
   index : int
) : Object;

Parameters

index
The zero-based index of the parameter in the array of parameters.

Return Value

An Object representing the parameter at the specified index.

Exceptions

Exception Type Condition
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.

Remarks

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 BeforeDeserialize SoapMessageStage.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

SoapMessage Class | SoapMessage Members | System.Web.Services.Protocols Namespace

Show: