Replication.getRecordTransportInfo (Method)

Returns a structure whose members contain a replication record's transport information to a target server. Structure members include the server's name, the ftp server, the ftp port, and so on.

Returns:

Replication_GetRecordTransportInfo_Result (struct)

Each row of the returned query results has the following fields:

Field Name Type Description
FTPCommonSpotDirectory PlainText The path to the CommonSpot directory (for example /web/commonspot/).
FTPPassive Boolean Boolean flag which when set to true indicates that the FTP protocol uses passive mode.
FTPPassword PlainText_Secure The FTP password.
FTPPort ServerPort_EmptyString The port used by the FTP protocol.
FTPServer IPAddressOrHostName_EmptyString The target server's IP address or alias.
FTPUserName PlainText The FTP username.
TransportType ReplicationTransportType The type of the transportation. This can be 'FTP', 'HTTP', 'UNC', or 'Manual'.
UNCPath PlainText The UNC path to the CommonSpot directory if a direct connection transport type is specified. Otherwise, this is an empty string.

Arguments:

Name Type Required Description
id ReplicationID Required A replication record's ID.
serverName PlainText_NonNull Required A server's name.

Context:

License Requirements Replication
Permission Requirements site:ManageReplication
Deny Context None
Require Context None
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization This method may be customized at the site level

Error Codes:

Code Error Message
36010 No replication record exists having an ID of $1 and server '$2'.

Notes:

None