SendToFile(SessionCriteria,Boolean,String,ProgressMonitorStack) Method

In This Topic

Write the completed package to the provided full file name and path without extension.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function SendToFile( _
   ByVal sessions As SessionCriteria, _
   ByVal markAsRead As Boolean, _
   ByVal fullFileNamePath As String, _
   ByVal progressMonitors As ProgressMonitorStack _
) As PackageSendEventArgs

public PackageSendEventArgs SendToFile( 
   SessionCriteria sessions,
   bool markAsRead,
   string fullFileNamePath,
   ProgressMonitorStack progressMonitors
)

Parameters

sessions: The set of match rules to apply to sessions to determine what to send.
markAsRead: True to have every included session marked as read upon successful completion.
fullFileNamePath: The file name and path to write the final package to
progressMonitors: The asynchronous progress monitoring stack.

Return Value

The Package Send Event Arguments object that was also used for the EndSend event.

Exceptions

Exception	Description
System.ArgumentNullException	A required parameter was null.
System.ArgumentOutOfRangeException	The provided file information is not a fully qualified file name and path.

Remarks

The EndSend event will be raised when the send operation completes. Any provided extension will be removed and replaced with the standard Gibraltar package extension.

Requirements

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

Reference

Packager Class
Packager Members
Overload List

Send Feedback