Versions Compared

Version Old Version 4 New Version Current
Changes made by

Sylvain Ménard

Sylvain Ménard

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Group

Utilities

Description

Transfers

Transfer files from the target node to the host development node

using the FTP protocol. The FTP user used for the transfer is defined in the RT-LAB hardware configuration which can be modified through the RT-LAB MainControl sub-panels

.

Required Control

None

Usage

RtlabApi.GetTargetFile (sourceNodeName, sourceFile, targetPath, mode, logicalId)

Input

  • sourceNodeName: Physical node name (defined in RT-LAB hardware configuration).

  • sourceFile: Path and name of the file to be transferred (accepts wildcards).

  • targetPath: Path (only) of the target directory.

  • mode: See OP_FILE_TRANSFER_MODE.

  • logicalId: See Glossary. To specify all subsystem, set the logicalId to 0.

Output

None

Exception

  • EOK: Success.

  • EFAULT: Invalid parameter.

  • EBADF: Model not specified by previous Connect or

SetCurrentModel

  • OpenProject.

  • EINVAL: Invalid subsystem id.

  • EIO: Error sending the request or receiving the reply.

Examples

See example file_transfer.

Related Items

OP_FILE_TRANSFER_MODE, PutTargetFile.

Modules

import RtlabApi