CkSFtpFile Ruby Reference Documentation

CkSFtpFile

Represents a remote SFTP file.

Object Creation

obj = Chilkat::CkSFtpFile.new()

Properties

# strVal is a string
# ckStr is a CkString
sFtpFile.get_CreateTimeStr(ckStr);
strVal = sFtpFile.createTimeStr();

The same as the CreateTime property, but returns the date/time as an RFC822 formatted string.

# strVal is a string
# ckStr is a CkString
sFtpFile.get_FileType(ckStr);
strVal = sFtpFile.fileType();

One of the following values:

  regular
  directory
  symLink
  special
  unknown
  socket
  charDevice
  blockDevice
  fifo

# strVal is a string
# ckStr is a CkString
sFtpFile.get_Filename(ckStr);
strVal = sFtpFile.filename();

The filename (or directory name, symbolic link name, etc.)

# intVal is an integer
intVal = sFtpFile.get_Gid();

The integer Group ID of the file.

# strVal is a string
# ckStr is a CkString
sFtpFile.get_Group(ckStr);
strVal = sFtpFile.group();

The group ownership of the file. This property is only supported by servers running SFTP v4 or later.

# boolVal is a boolean
boolVal = sFtpFile.get_IsAppendOnly();

If true, this file may only be appended. This property is only supported by servers running SFTP v6 or later.

# boolVal is a boolean
boolVal = sFtpFile.get_IsArchive();

If true, the file should be included in backup / archive operations. This property is only supported by servers running SFTP v6 or later.

# boolVal is a boolean
boolVal = sFtpFile.get_IsCaseInsensitive();

This attribute applies only to directories. This attribute means that files and directory names in this directory should be compared without regard to case. This property is only supported by servers running SFTP v6 or later.

# boolVal is a boolean
boolVal = sFtpFile.get_IsCompressed();

The file is stored on disk using file-system level transparent compression. This flag does not affect the file data on the wire. This property is only supported by servers running SFTP v6 or later.

# boolVal is a boolean
boolVal = sFtpFile.get_IsDirectory();

If true, this is a directory.

# boolVal is a boolean
boolVal = sFtpFile.get_IsEncrypted();

The file is stored on disk using file-system level transparent encryption. This flag does not affect the file data on the wire (for either READ or WRITE requests.) This property is only supported by servers running SFTP v6 or later.

# boolVal is a boolean
boolVal = sFtpFile.get_IsHidden();

If true, the file SHOULD NOT be shown to user unless specifically requested.

# boolVal is a boolean
boolVal = sFtpFile.get_IsImmutable();

The file cannot be deleted or renamed, no hard link can be created to this file, and no data can be written to the file.

This bit implies a stronger level of protection than ReadOnly, the file permission mask or ACLs. Typically even the superuser cannot write to immutable files, and only the superuser can set or remove the bit.

This property is only supported by servers running SFTP v6 or later.

# boolVal is a boolean
boolVal = sFtpFile.get_IsReadOnly();

If true, the file is read-only. This property is only supported by servers running SFTP v6 or later.

# boolVal is a boolean
boolVal = sFtpFile.get_IsRegular();

true if this is a normal file (not a directory or any of the other non-file types).

# boolVal is a boolean
boolVal = sFtpFile.get_IsSparse();

The file is a sparse file; this means that file blocks that have not been explicitly written are not stored on disk. For example, if a client writes a buffer at 10 M from the beginning of the file, the blocks between the previous EOF marker and the 10 M offset would not consume physical disk space.

Some servers may store all files as sparse files, in which case this bit will be unconditionally set. Other servers may not have a mechanism for determining if the file is sparse, and so the file MAY be stored sparse even if this flag is not set.

This property is only supported by servers running SFTP v6 or later.

# boolVal is a boolean
boolVal = sFtpFile.get_IsSymLink();

true if this is a symbolic link.

# boolVal is a boolean
boolVal = sFtpFile.get_IsSync();

When the file is modified, the changes are written synchronously to the disk. This property is only supported by servers running SFTP v6 or later.

# boolVal is a boolean
boolVal = sFtpFile.get_IsSystem();

true if the file is part of the operating system. This property is only supported by servers running SFTP v6 or later.

# strVal is a string
# ckStr is a CkString
sFtpFile.get_LastAccessTimeStr(ckStr);
strVal = sFtpFile.lastAccessTimeStr();

The same as the LastAccessTime property, but returns the date/time as an RFC822 formatted string.

# strVal is a string
# ckStr is a CkString
sFtpFile.get_LastModifiedTimeStr(ckStr);
strVal = sFtpFile.lastModifiedTimeStr();

The same as the LastModifiedTime property, but returns the date/time as an RFC822 formatted string.

# strVal is a string
# ckStr is a CkString
sFtpFile.get_Owner(ckStr);
strVal = sFtpFile.owner();

The owner of the file. This property is only supported by servers running SFTP v4 or later.

# intVal is an integer
intVal = sFtpFile.get_Permissions();

The 'permissions' field contains a bit mask specifying file permissions. These permissions correspond to the st_mode field of the stat structure defined by POSIX [IEEE.1003-1.1996].

This protocol uses the following values for the symbols declared in the POSIX standard.

       S_IRUSR  0000400 (octal)
       S_IWUSR  0000200
       S_IXUSR  0000100
       S_IRGRP  0000040
       S_IWGRP  0000020
       S_IXGRP  0000010
       S_IROTH  0000004
       S_IWOTH  0000002
       S_IXOTH  0000001
       S_ISUID  0004000
       S_ISGID  0002000
       S_ISVTX  0001000

# intVal is an integer
intVal = sFtpFile.get_Size32();

Size of the file in bytes. If the size is too large for 32-bits, a -1 is returned.

# int64Val is a 64-bit integer
int64Val = sFtpFile.get_Size64();

Size of the file in bytes. If the file size is a number too large for 64 bits, you have an AMAZINGLY large disk drive.

# strVal is a string
# ckStr is a CkString
sFtpFile.get_SizeStr(ckStr);
strVal = sFtpFile.sizeStr();

Same as Size64, but the number is returned as a string in decimal format.

# intVal is an integer
intVal = sFtpFile.get_Uid();

The integer User ID of the file.

# boolVal is a boolean
boolVal = sFtpFile.get_Utf8();
sFtpFile.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

Methods

# returns a CkDateTime
ret_ckDateTime = sFtpFile.GetCreateDt();

Returns the file creation date and time (GMT / UTC). This method is only supported by servers running SFTP v4 or later.

# returns a CkDateTime
ret_ckDateTime = sFtpFile.GetLastAccessDt();

Returns the last-access date and time (GMT / UTC).

# returns a CkDateTime
ret_ckDateTime = sFtpFile.GetLastModifiedDt();

Returns the last-modified date and time (GMT / UTC).