# MTSessionFailures

An object holding a collection of all failed sessions. This object also allows sessions to be restarted or abandoned.

## Program ID

MetraPipeline.MTSessionFailures.1

## MTSessionFailures Methods

AbandonSession | Permanently deletes a failed session. No record of the session will remain on the system.
AbandonLostSession | Permanently deletes a failed session. No record of the session will remain on the system. No error needs to exist for the session to be deleted.
Login | Method to provide security credentials for some operations.
Refresh | Retrieve the list of failed sessions again.
ResubmitLostSession | Resubmit a session marked as lost by the auditor.
ResubmitSession | Resubmit a failed session, without any modification, back into the pipeline. (As of 3.0, this operation is transactional.)

## Example

Example to be provided in a future release of this online help system.

# Method Detail

## AbandonLostSession

Permanently delete a failed session. No record of the session will remain on the system. No error needs to exist for the session to be deleted.

### Visual Basic Syntax

Sub AbandonLostSession(sessionID As String)

### C++ Syntax

HRESULT AbandonLostSession(BSTR sessionID);

### Arguments

sessionID

base64 encoded ID of session to be abandoned.

txn

Optional MTTransaction object. If an MTTransaction object is passed in, this method will be transactional.

## AbandonSession

Permanently delete a failed session. No record of the session will remain on the system.

### Visual Basic Syntax

Sub AbandonSession(sessionID As String)

### C++ Syntax

HRESULT AbandonSession(BSTR sessionID);

### Arguments

sessionID

base64 encoded ID of session to be abandoned.

## Login

Login method is used to support Authentication/Authorization functionality. This method is currently only needed for the ExportSession method.

### Visual Basic Syntax

Function Login(login As String, login_namespace As String, password As String)

### C++ Syntax

HRESULT Login(BSTR login, BSTR login_namespace, BSTR password);

### Arguments

login

The login name for the session.

login_namespace

The name space corresponding to the login parameter being passed.

password

The password corresponding to the login parameter being passed.

## Refresh

Retrieve the list of failed sessions again. Enumeration over this object will then have the current list of failed sessions.

### Visual Basic Syntax

Sub Refresh()

### C++ Syntax

HRESULT Refresh();

### Errors Raised

PIPE_ERR_INTERNAL_ERROR

if the queue is in an inconsistent state.

## ResubmitLostSession

Resubmit a session marked as lost by the auditor. The session is retrieved from the routing queue journal and placed back on the routing queue.

### Visual Basic Syntax

Sub ResubmitLostSession(sessionID As String)

### C++ Syntax

HRESULT ResubmitLostSession(BSTR sessionID);

### Arguments

sessionID

base64 encoded ID of session to be resubmitted.

## ResubmitSession

Resubmit a failed session, without any modification, back into the pipeline. The session is taken from the routing queue journal and placed back on the routing queue. (As of 3.0, this operation is transactional.)

### Visual Basic Syntax

Sub ResubmitSession(sessionID As String)

### C++ Syntax

HRESULT ResubmitSession(BSTR sessionID);

### Arguments

sessionID

base64 encoded ID of session to be resubmitted.