CkoSFtpDir Objective-C Reference Documentation

CkoSFtpDir

Current Version: 9.5.0.73

Represents a remote SFTP directory listing.

Object Creation

CkoSFtpDir *obj = [[CkoSFtpDir alloc] init];

Properties

LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO 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 = YES and failure = NO.
  • 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 YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumFilesAndDirs
@property (nonatomic, readonly, copy) NSNumber *NumFilesAndDirs;

The number of entries in this directory listing.

top
OriginalPath
@property (nonatomic, readonly, copy) NSString *OriginalPath;

The original path used to fetch this directory listing. This is the string that was originally passed to the OpenDir method when the directory was read.

top

Methods

GetFilename
- (NSString *)GetFilename:(NSNumber *)index;

Returns the Nth filename in the directory (indexing begins at 0).

Returns nil on failure

top
GetFileObject
- (CkoSFtpFile *)GetFileObject:(NSNumber *)index;

Returns the Nth entry in the directory. Indexing begins at 0.

Returns nil on failure

top
LoadTaskResult
- (BOOL)LoadTaskResult:(CkoTask *)task;
Introduced in version 9.5.0.52

Loads the SFTP directory object from a completed asynchronous task.

Returns YES for success, NO for failure.

top