Collapse AllExpand All

Code: All Code: Multiple Code: C# Code: Visual Basic Code: Visual C++ Code: JavaScript

C#
Visual Basic
Visual C++
JavaScript

QWS3270 COM .NET Help

FileTransfer..::.Receive Method

FileTransfer Class Example See Also Send Feedback

This method transfers a file from the mainframe host to the PC.

Namespace: JollyGiant.Emulation
Assembly: JGSComdotNet (in JGSComdotNet.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#
public StatusCode Receive( string cmdline )

Visual Basic (Declaration)
Public Function Receive ( _ cmdline As String _ ) As StatusCode

Visual C++
public: virtual StatusCode Receive( String^ cmdline ) sealed

JavaScript
function Receive(cmdline);

Parameters

cmdline Type: System..::.StringRECEIVE command parameters (see remarks).

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:

Status code	Description
WHLLPARAMETERERROR	Parameter error or Data Length is zero or greater than 128.
WHLLFTXCOMPLETE	The file transfer completed (synchronous mode only).
WHLLFTXSEGMENTED	Transfer completed with one or more segmented records (synchronous mode only).
WHLLSYSERROR	The method failed due to a system error.
WHLLTRANSABORTED	The file transfer was aborted either by the user, or (if a timeout was set with SetSessionOptions(String, Int32%)) because the timeout period expired.
WHLLINVALIDFUNCTIONNUM	Invalid function number.
WHLLFILENOTFOUND	PC file not found.
WHLLACCESSDENIED	Access denied to PC file.
WHLLMEMORY	Insufficient memory.
WHLLINVALIDENVIRONMENT	Invalid environment.

Implements

IFileTransfer..::.Receive(String)

Remarks

The 'cmdline' string should contain the RECEIVE command parameters that you would normally enter at the TSO 'ready' prompt.

For example, to send the file SLR REPORT from the CMS host to a file named 'sales.rpt' on your PC, using a session with the ID of "E:"

PC_FILE ID:HOST FILE NAME (OPTIONS

SALES.RPT E:SLS REPORT (ASCII CRLF

Examples

Transfer a file named 'sales.rpt' from the to a CMS file 'SLS REPORT', using a session with ID 'E':

CopyC#

string cmdline = @"sales.rpt E:SLS REPORT (ASCII CRLR";
StatusCode code = Receive(cmdline);
if (code == WHLLFTXCOMPLETE)
{
    // transfer completed successfully
}
else
{
    ReportError(code);
}