SFtpFile C Reference Documentation
SFtpFile
Current Version: 11.5.0
Chilkat.SFtpFile
Read
Access the entry size as a 32-bit integer, 64-bit integer, or decimal
string using
Inspect creation, last-access, and last-modified times as date/time
values or RFC822-formatted strings when supported by the server.
Read numeric user and group IDs, and when the server supports it, textual
owner and group names.
Inspect the POSIX-style permissions bit mask for read, write, execute,
set-user-ID, set-group-ID, and sticky-bit information.
Check server-provided flags such as hidden, read-only, archive,
immutable, encrypted, compressed, sparse, append-only, system, and sync.
Inspect metadata for a file, directory, symlink, or special item in an SFTP listing.
Chilkat.SFtpFile represents one entry returned from an SFTP
directory listing. It exposes the entry name, file type, size, ownership,
permissions, timestamps, and server-provided attribute flags such as hidden,
read-only, archive, immutable, encrypted, compressed, sparse, append-only,
system, and synchronization status. It is typically used together with
Chilkat.SFtpDir when iterating a remote directory and deciding
how each entry should be displayed, filtered, downloaded, skipped, or
processed.
Name and type
Filename and FileType, or use convenience
flags such as IsRegular, IsDirectory, and
IsSymLink.
File sizes
Size32, Size64, or
SizeStr.
Timestamps
Ownership
Permissions
Extended attributes
Chilkat.SFtp, iterate its
Chilkat.SFtpDir entries, and populate a
Chilkat.SFtpFile object for each item. Use the file type,
timestamps, size, permissions, and attribute flags to decide whether the
entry is a regular file, directory, symlink, or special item and how the
application should handle it.
Create/Dispose
HCkSFtpFile instance = CkSFtpFile_Create(); // ... CkSFtpFile_Dispose(instance);
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.
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
const char *CkSFtpFile_createTimeStr(HCkSFtpFile cHandle);
Returns the file creation date and time as an RFC 822-formatted string, such as Fri, 21 Nov 1997 09:55:06 -0600.
Server requirement: Creation-time metadata is available only when the server supports SFTP version 4 or later and provides this attribute.
topDebugLogFilePath
void CkSFtpFile_putDebugLogFilePath(HCkSFtpFile cHandle, const char *newVal);
const char *CkSFtpFile_debugLogFilePath(HCkSFtpFile cHandle);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
Filename
const char *CkSFtpFile_filename(HCkSFtpFile cHandle);
Returns the name of the directory entry. Depending on the entry type, this may be a regular filename, directory name, symbolic-link name, or the name of another special filesystem object.
topFileType
const char *CkSFtpFile_fileType(HCkSFtpFile cHandle);
Identifies the type of directory entry. The returned value is one of the following:
| Value | Meaning |
|---|---|
regular | A regular file. |
directory | A directory. |
symLink | A symbolic link. |
special | A special file whose more specific type is not reported. |
unknown | The type is unknown or was not provided by the server. |
socket | A socket. |
charDevice | A character device. |
blockDevice | A block device. |
fifo | A FIFO (named pipe). |
The convenience properties IsRegular, IsDirectory, and IsSymLink may be used for the most common entry types.
Gid
Returns the numeric group ID associated with the file.
topGroup
const char *CkSFtpFile_group(HCkSFtpFile cHandle);
Returns the textual group name associated with the file.
Server requirement: This attribute is available only when the server supports SFTP version 4 or later and provides owner/group names.
topIsAppendOnly
Returns TRUE if the server marks the file as append-only. New data may be added only at the end of the file; existing data cannot be overwritten through normal file writes.
Server requirement: This attribute is defined for SFTP version 6 or later.
topIsArchive
Returns TRUE if the server marks the file for inclusion in backup or archive operations.
Server requirement: This attribute is defined for SFTP version 6 or later.
topIsCaseInsensitive
Applies to directories. Returns TRUE when names within the directory should be compared without regard to letter case.
Server requirement: This attribute is defined for SFTP version 6 or later.
topIsCompressed
Returns TRUE if the file is stored using transparent filesystem-level compression on the server.
This attribute describes how the server stores the file. It does not change the file bytes transferred through SFTP.
Server requirement: This attribute is defined for SFTP version 6 or later.
topIsDirectory
Returns TRUE if the directory entry is a directory.
IsEncrypted
Returns TRUE if the file is stored using transparent filesystem-level encryption on the server.
This attribute describes storage at rest. It does not alter the file bytes returned by read operations or accepted by write operations.
Server requirement: This attribute is defined for SFTP version 6 or later.
topIsHidden
Returns TRUE if the server marks the entry as hidden. Hidden entries are normally omitted from user-facing displays unless the user specifically requests them.
IsImmutable
Returns TRUE if the server marks the file as immutable. An immutable file cannot normally be deleted, renamed, modified, or used as the target of a new hard link.
Immutability is generally stronger than read-only status, the ordinary permission mask, or an access-control list. On many systems, only a privileged administrator can set or clear this attribute.
Server requirement: This attribute is defined for SFTP version 6 or later.
topIsReadOnly
Returns TRUE if the server marks the file as read-only.
Server requirement: This attribute is defined for SFTP version 6 or later.
topIsRegular
Returns TRUE if the directory entry is a regular file rather than a directory, symbolic link, device, socket, FIFO, or other special type.
IsSparse
Returns TRUE if the server identifies the file as sparse. A sparse file can contain unwritten regions, often called holes, that read as zero bytes without consuming equivalent physical disk space.
For example, writing data at an offset of 10 MB may leave the region between the previous end of file and that offset unallocated on disk.
Some servers store all files sparsely and may always set this flag. Other servers cannot reliably determine whether a file is sparse, so a file may be sparse even when this property is FALSE.
Server requirement: This attribute is defined for SFTP version 6 or later.
topIsSymLink
Returns TRUE if the directory entry is a symbolic link.
IsSync
Returns TRUE if modifications to the file are committed synchronously to server storage.
Server requirement: This attribute is defined for SFTP version 6 or later.
topIsSystem
Returns TRUE if the server marks the file as part of the operating system.
Server requirement: This attribute is defined for SFTP version 6 or later.
topLastAccessTimeStr
const char *CkSFtpFile_lastAccessTimeStr(HCkSFtpFile cHandle);
Returns the file's last-access date and time as an RFC 822-formatted string, such as Fri, 21 Nov 1997 09:55:06 -0600.
LastErrorHtml
const char *CkSFtpFile_lastErrorHtml(HCkSFtpFile cHandle);
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
const char *CkSFtpFile_lastErrorText(HCkSFtpFile cHandle);
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
const char *CkSFtpFile_lastErrorXml(HCkSFtpFile cHandle);
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
void CkSFtpFile_putLastMethodSuccess(HCkSFtpFile cHandle, BOOL newVal);
Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastModifiedTimeStr
const char *CkSFtpFile_lastModifiedTimeStr(HCkSFtpFile cHandle);
Returns the file's last-modified date and time as an RFC 822-formatted string, such as Fri, 21 Nov 1997 09:55:06 -0600.
Use LastModifiedTime when a native date/time value is more convenient.
Owner
const char *CkSFtpFile_owner(HCkSFtpFile cHandle);
Returns the textual owner name associated with the file.
Server requirement: This attribute is available only when the server supports SFTP version 4 or later and provides owner/group names.
topPermissions
Returns the POSIX-style file-permission bit mask. The values correspond to the permission and special-mode bits in the POSIX st_mode field.
| Symbol | Octal value | Meaning |
|---|---|---|
S_IRUSR | 0400 | Owner read |
S_IWUSR | 0200 | Owner write |
S_IXUSR | 0100 | Owner execute |
S_IRGRP | 0040 | Group read |
S_IWGRP | 0020 | Group write |
S_IXGRP | 0010 | Group execute |
S_IROTH | 0004 | Others read |
S_IWOTH | 0002 | Others write |
S_IXOTH | 0001 | Others execute |
S_ISUID | 4000 | Set-user-ID |
S_ISGID | 2000 | Set-group-ID |
S_ISVTX | 1000 | Sticky bit |
Use bitwise AND operations to test individual permission bits.
topSize32
Returns the file size in bytes as a 32-bit integer. Returns -1 when the size cannot be represented by a 32-bit integer. Use Size64 or SizeStr for larger values.
Size64
Returns the file size in bytes as a 64-bit integer.
topSizeStr
const char *CkSFtpFile_sizeStr(HCkSFtpFile cHandle);
Returns the file size in bytes as a base-10 string. This is the string representation of Size64 and is useful in environments where a 64-bit integer is inconvenient or unavailable.
Uid
Returns the numeric user ID associated with the file.
topUtf8
void CkSFtpFile_putUtf8(HCkSFtpFile cHandle, BOOL newVal);
When set to TRUE, all const char * arguments and return values are interpreted as UTF-8 strings. When set to FALSE, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is TRUE. Before v11.0.0, it was FALSE.
VerboseLogging
void CkSFtpFile_putVerboseLogging(HCkSFtpFile cHandle, BOOL newVal);
If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
const char *CkSFtpFile_version(HCkSFtpFile cHandle);
Methods
Deprecated
GetCreateDt
Deprecated. Use the CreateTimeStr property instead.
Returns the file creation date and time in UTC as a CkDateTime object.
Server requirement: Creation-time metadata is available only when the server supports SFTP version 4 or later and provides this attribute.
Returns NULL on failure
GetLastAccessDt
Deprecated. Use the LastAccessTimeStr property instead.
Returns the file's last-access date and time in UTC as a CkDateTime object.
Returns NULL on failure
GetLastModifiedDt
Deprecated. Use the LastModifiedTimeStr property instead.
Returns the file's last-modified date and time in UTC as a CkDateTime object.
Returns NULL on failure