msiFtpGet ( msParam_t *  target,
msParam_t *  destObj,
msParam_t *  status,
ruleExecInfo_t *  rei 
)
Description:
This microservice gets a remote file using FTP and writes it to an iRODS object.
Module:
URL
Since:
pre-2.1
Author:
Antoine de Torcy
Date:
2008-09-24
Note:
This microservice uses libcurl to open an ftp session with a remote server and read from a remote file. The results are written to a newly created iRODS object, one block at a time until the whole file is read.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] target - Required - a STR_MS_T containing the remote URL.
[in] destObj - Required - a DataObjInp_MS_T or a STR_MS_T which would be taken as the object's path.
[out] status - a INT_MS_T containing the status.
[in,out] rei - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation.
Session Variables Used:
None
Session Variables Modified:
None
iCAT Attributes Used:
None
iCAT Attributes Modified:
None
Side Effect:
None
Returns:
integer
Return values:
0 on success
Precondition:
None
Postcondition:
None
See also:
None

Definition at line 114 of file ftpMS.c.

Generated on Mon Jun 25 14:02:14 2012 for iRODS Documentation by  doxygen 1.6.3