SFtpFile C Reference Documentation

SFtpFile

Current Version: 9.5.0.75

Represents a remote SFTP file.

Create/Dispose

HCkSFtpFile instance = CkSFtpFile_Create();
// ...
CkSFtpFile_Dispose(instance);
HCkSFtpFile CkSFtpFile_Create(void);

Creates an instance of the HCkSFtpFile object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkSFtpFile_Dispose(HCkSFtpFile handle);

Objects created by calling CkSFtpFile_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkSFtpFile_Dispose.

Properties

CreateTimeStr
void CkSFtpFile_getCreateTimeStr(HCkSFtpFile cHandle, HCkString retval);
const char *CkSFtpFile_createTimeStr(HCkSFtpFile cHandle);

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

top
Filename
void CkSFtpFile_getFilename(HCkSFtpFile cHandle, HCkString retval);
const char *CkSFtpFile_filename(HCkSFtpFile cHandle);

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

top
FileType
void CkSFtpFile_getFileType(HCkSFtpFile cHandle, HCkString retval);
const char *CkSFtpFile_fileType(HCkSFtpFile cHandle);

One of the following values:

  regular
  directory
  symLink
  special
  unknown
  socket
  charDevice
  blockDevice
  fifo

top
Gid
int CkSFtpFile_getGid(HCkSFtpFile cHandle);

The integer Group ID of the file.

top
Group
void CkSFtpFile_getGroup(HCkSFtpFile cHandle, HCkString retval);
const char *CkSFtpFile_group(HCkSFtpFile cHandle);

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

top
IsAppendOnly
BOOL CkSFtpFile_getIsAppendOnly(HCkSFtpFile cHandle);

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

top
IsArchive
BOOL CkSFtpFile_getIsArchive(HCkSFtpFile cHandle);

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

top
IsCaseInsensitive
BOOL CkSFtpFile_getIsCaseInsensitive(HCkSFtpFile cHandle);

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.

top
IsCompressed
BOOL CkSFtpFile_getIsCompressed(HCkSFtpFile cHandle);

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.

top
IsDirectory
BOOL CkSFtpFile_getIsDirectory(HCkSFtpFile cHandle);

If TRUE, this is a directory.

top
IsEncrypted
BOOL CkSFtpFile_getIsEncrypted(HCkSFtpFile cHandle);

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.

top
IsHidden
BOOL CkSFtpFile_getIsHidden(HCkSFtpFile cHandle);

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

top
IsImmutable
BOOL CkSFtpFile_getIsImmutable(HCkSFtpFile cHandle);

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.

top
IsReadOnly
BOOL CkSFtpFile_getIsReadOnly(HCkSFtpFile cHandle);

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

top
IsRegular
BOOL CkSFtpFile_getIsRegular(HCkSFtpFile cHandle);

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

top
IsSparse
BOOL CkSFtpFile_getIsSparse(HCkSFtpFile cHandle);

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.

top
IsSymLink
BOOL CkSFtpFile_getIsSymLink(HCkSFtpFile cHandle);

TRUE if this is a symbolic link.

top
IsSync
BOOL CkSFtpFile_getIsSync(HCkSFtpFile cHandle);

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.

top
IsSystem
BOOL CkSFtpFile_getIsSystem(HCkSFtpFile cHandle);

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

top
LastAccessTimeStr
void CkSFtpFile_getLastAccessTimeStr(HCkSFtpFile cHandle, HCkString retval);
const char *CkSFtpFile_lastAccessTimeStr(HCkSFtpFile cHandle);

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

top
LastMethodSuccess
BOOL CkSFtpFile_getLastMethodSuccess(HCkSFtpFile cHandle);
void CkSFtpFile_putLastMethodSuccess(HCkSFtpFile cHandle, BOOL newVal);

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastModifiedTimeStr
void CkSFtpFile_getLastModifiedTimeStr(HCkSFtpFile cHandle, HCkString retval);
const char *CkSFtpFile_lastModifiedTimeStr(HCkSFtpFile cHandle);

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

top
Owner
void CkSFtpFile_getOwner(HCkSFtpFile cHandle, HCkString retval);
const char *CkSFtpFile_owner(HCkSFtpFile cHandle);

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

top
Permissions
int CkSFtpFile_getPermissions(HCkSFtpFile cHandle);

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

top
Size32
int CkSFtpFile_getSize32(HCkSFtpFile cHandle);

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

top
Size64
__int64 CkSFtpFile_getSize64(HCkSFtpFile cHandle);

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.

top
SizeStr
void CkSFtpFile_getSizeStr(HCkSFtpFile cHandle, HCkString retval);
const char *CkSFtpFile_sizeStr(HCkSFtpFile cHandle);

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

top
Uid
int CkSFtpFile_getUid(HCkSFtpFile cHandle);

The integer User ID of the file.

top
Utf8
BOOL CkSFtpFile_getUtf8(HCkSFtpFile cHandle);
void CkSFtpFile_putUtf8(HCkSFtpFile cHandle, BOOL newVal);

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.

top

Methods

GetCreateDt
HCkDateTime CkSFtpFile_GetCreateDt(HCkSFtpFile cHandle);

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

Returns NULL on failure

top
GetLastAccessDt
HCkDateTime CkSFtpFile_GetLastAccessDt(HCkSFtpFile cHandle);

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

Returns NULL on failure

top
GetLastModifiedDt
HCkDateTime CkSFtpFile_GetLastModifiedDt(HCkSFtpFile cHandle);

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

Returns NULL on failure

top