ExcelService.CancelRequest Method

Cancels the most recent request if it is still pending in the session.

Namespace:  Microsoft.Office.Excel.Server.WebServices
Assembly:  Microsoft.Office.Excel.Server.WebServices (in Microsoft.Office.Excel.Server.WebServices.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Sub CancelRequest ( _
    sessionId As String, _
    <OutAttribute> ByRef status As Status() _
)
'Usage
Dim instance As ExcelService
Dim sessionId As String
Dim status As Status()

instance.CancelRequest(sessionId, status)
[WebMethodAttribute]
public void CancelRequest(
    string sessionId,
    out Status[] status
)

Parameters

  • sessionId
    Type: System.String

    The Excel Web Services session ID.

  • status
    Type: []

    Alert information.

Remarks

This is the only method that can be called without causing an error before the reply has been received from a pending call.

Both the original pending call and the CancelRequest method call always return reply messages, whether or not the cancellation succeeds. The returned reply messages may be normal (that is, without errors) or may indicate that an error has occurred.

See Also

Reference

ExcelService Class

ExcelService Members

Microsoft.Office.Excel.Server.WebServices Namespace