--- product: Chilkat product_version: 11.7.0 language: ckruby language_label: Ruby class: FileAccess class_name: CkFileAccess license: free deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/rubyCkFileAccessRef.html --- # Chilkat FileAccess — Ruby — v11.7.0 > Chilkat 11.7.0 · language=ckruby · class=FileAccess (CkFileAccess) > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/FileAccess.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckruby/guide.md`. ## Purpose **Read, write, compare, copy, split, inspect, and manage files and paths.** `Chilkat.FileAccess` provides general-purpose file-system utilities for applications that need direct control over files, directories, paths, timestamps, and low-level file operations. It can read, write, append, seek, compare, copy, rename, delete, split, reassemble, and inspect files, and also includes helpers for directory operations, path parsing, symbolic links, temporary filenames, block-based reading, fragment scanning, text replacement, and open-file access. **Read and write files** Load or save text and binary files, append data, replace file contents, and work with explicit character encodings when needed. **File management** Copy, rename, delete, compare, split, reassemble, and inspect files using straightforward file-system utility methods. **Directories and paths** Create, remove, check, and work with directories, and use path helpers to extract filenames, extensions, directory names, and related path parts. **Open-file operations** Open files for lower-level reading or writing, seek within files, read blocks, and process large files without loading everything at once. **Timestamps and metadata** Get or set file times, inspect sizes and existence, and use metadata helpers when coordinating file processing workflows. **Special file utilities** Generate temporary filenames, work with symbolic links, scan for byte fragments, and perform text replacement in files. **Common pattern:** Use `FileAccess` for local file-system tasks that are outside the scope of a specific protocol class. It is especially useful for preparing files before upload, saving downloaded data, comparing or splitting files, reading large files in blocks, manipulating paths, or performing small filesystem operations without using platform-specific APIs. For an extended overview, see [FileAccess Class Overview](https://www.chilkatsoft.com/fileaccess_class_overview.asp). ## Object creation, unlocking and error handling **Object Creation** ```ruby obj = Chilkat::CkFileAccess.new() ``` Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Ruby. How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called. ## Members common to every Chilkat class Documented once per language in `common-members.md`; listed here so this page is self-contained. | Property | Signature | Access | Meaning | |---|---|---|---| | `DebugLogFilePath` | `# strVal is a string # ckStr is a CkString fileAccess.get_DebugLogFilePath(ckStr); strVal = fileAccess.debugLogFilePath(); fileAccess.put_DebugLogFilePath(strVal);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. | | `LastErrorHtml` | `# strVal is a string # ckStr is a CkString fileAccess.get_LastErrorHtml(ckStr); strVal = fileAccess.lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `# strVal is a string # ckStr is a CkString fileAccess.get_LastErrorText(ckStr); strVal = fileAccess.lastErrorText();` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `# strVal is a string # ckStr is a CkString fileAccess.get_LastErrorXml(ckStr); strVal = fileAccess.lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `# boolVal is a boolean boolVal = fileAccess.get_LastMethodSuccess(); fileAccess.put_LastMethodSuccess(boolVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. | | `Utf8` | `# boolVal is a boolean boolVal = fileAccess.get_Utf8(); fileAccess.put_Utf8(boolVal);` | read/write | When set to `true`, all `string` arguments and return values are interpreted as UTF-8 strings. | | `VerboseLogging` | `# boolVal is a boolean boolVal = fileAccess.get_VerboseLogging(); fileAccess.put_VerboseLogging(boolVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `# strVal is a string # ckStr is a CkString fileAccess.get_Version(ckStr); strVal = fileAccess.version();` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `CurrentDir` | property, read-only | `# strVal is a string # ckStr is a CkString fileAccess.get_CurrentDir(ckStr); strVal = fileAccess.currentDir();` | | `EndOfFile` | property, read-only | `# boolVal is a boolean boolVal = fileAccess.get_EndOfFile();` | | `FileOpenError` | property, read-only | `# intVal is an integer intVal = fileAccess.get_FileOpenError();` | | `FileOpenErrorMsg` | property, read-only | `# strVal is a string # ckStr is a CkString fileAccess.get_FileOpenErrorMsg(ckStr); strVal = fileAccess.fileOpenErrorMsg();` | | `LockFileOnOpen` | property, read/write | `# boolVal is a boolean boolVal = fileAccess.get_LockFileOnOpen(); fileAccess.put_LockFileOnOpen(boolVal);` | | `AppendAnsi` | method | `# text is a string status = fileAccess.AppendAnsi(text);` | | `AppendBd` | method | `# bd is a CkBinData status = fileAccess.AppendBd(bd);` | | `AppendSb` | method | `# sb is a CkStringBuilder # charset is a string status = fileAccess.AppendSb(sb, charset);` | | `AppendText` | method | `# str is a string # charset is a string status = fileAccess.AppendText(str, charset);` | | `AppendUnicodeBOM` | method | `status = fileAccess.AppendUnicodeBOM();` | | `AppendUtf8BOM` | method | `status = fileAccess.AppendUtf8BOM();` | | `DirAutoCreate` | method | `# filePath is a string status = fileAccess.DirAutoCreate(filePath);` | | `DirCreate` | method | `# dirPath is a string status = fileAccess.DirCreate(dirPath);` | | `DirDelete` | method | `# dirPath is a string status = fileAccess.DirDelete(dirPath);` | | `DirEnsureExists` | method | `# dirPath is a string status = fileAccess.DirEnsureExists(dirPath);` | | `DirExists` | method | `# dirPath is a string retBool = fileAccess.DirExists(dirPath);` | | `FileClose` | method | `fileAccess.FileClose();` | | `FileContentsEqual` | method | `# filePath1 is a string # filePath2 is a string retBool = fileAccess.FileContentsEqual(filePath1, filePath2);` | | `FileCopy` | method | `# existingFilepath is a string # newFilepath is a string # failIfExists is a boolean status = fileAccess.FileCopy(existingFilepath, newFilepath, failIfExists);` | | `FileDelete` | method | `# filePath is a string status = fileAccess.FileDelete(filePath);` | | `FileExists` | method | `# filePath is a string retBool = fileAccess.FileExists(filePath);` | | `FileExists3` | method | `# path is a string retInt = fileAccess.FileExists3(path);` | | `FileOpen` | method | `# filePath is a string # accessMode is an integer # shareMode is an integer # createDisposition is an integer # attributes is an integer status = fileAccess.FileOpen(filePath, accessMode, shareMode, createDisposition, attributes);` | | `FileReadBd` | method | `# maxNumBytes is an integer # binData is a CkBinData status = fileAccess.FileReadBd(maxNumBytes, binData);` | | `FileRename` | method | `# existingFilepath is a string # newFilepath is a string status = fileAccess.FileRename(existingFilepath, newFilepath);` | | `FileSeek` | method | `# offset is an integer # origin is an integer status = fileAccess.FileSeek(offset, origin);` | | `FileSize` | method | `# filePath is a string status = fileAccess.FileSize(filePath);` | | `FileSize64` | method | `# filePath is a string retInt64 = fileAccess.FileSize64(filePath);` | | `FileSizeStr` | method | `# filePath is a string # outStr is a CkString (output) status = fileAccess.FileSizeStr(filePath, outStr); retStr = fileAccess.fileSizeStr(filePath);` | | `FileType` | method | `# path is a string retInt = fileAccess.FileType(path);` | | `FileWriteBd` | method | `# binData is a CkBinData # offset is an integer # numBytes is an integer status = fileAccess.FileWriteBd(binData, offset, numBytes);` | | `GenBlockId` | method | `# index is an integer # length is an integer # encoding is a string # outStr is a CkString (output) status = fileAccess.GenBlockId(index, length, encoding, outStr); retStr = fileAccess.genBlockId(index, length, encoding);` | | `GetDirectoryName` | method | `# path is a string # outStr is a CkString (output) status = fileAccess.GetDirectoryName(path, outStr); retStr = fileAccess.getDirectoryName(path);` | | `GetExtension` | method | `# path is a string # outStr is a CkString (output) status = fileAccess.GetExtension(path, outStr); retStr = fileAccess.getExtension(path);` | | `GetFileName` | method | `# path is a string # outStr is a CkString (output) status = fileAccess.GetFileName(path, outStr); retStr = fileAccess.getFileName(path);` | | `GetFileNameWithoutExtension` | method | `# path is a string # outStr is a CkString (output) status = fileAccess.GetFileNameWithoutExtension(path, outStr); retStr = fileAccess.getFileNameWithoutExtension(path);` | | `GetFileTimeStr` | method | `# path is a string # which is an integer # outStr is a CkString (output) status = fileAccess.GetFileTimeStr(path, which, outStr); retStr = fileAccess.getFileTimeStr(path, which);` | | `GetNumBlocks` | method | `# blockSize is an integer retInt = fileAccess.GetNumBlocks(blockSize);` | | `GetTempFilename` | method | `# dirPath is a string # prefix is a string # outStr is a CkString (output) status = fileAccess.GetTempFilename(dirPath, prefix, outStr); retStr = fileAccess.getTempFilename(dirPath, prefix);` | | `OpenForAppend` | method | `# filePath is a string status = fileAccess.OpenForAppend(filePath);` | | `OpenForRead` | method | `# filePath is a string status = fileAccess.OpenForRead(filePath);` | | `OpenForReadWrite` | method | `# filePath is a string status = fileAccess.OpenForReadWrite(filePath);` | | `OpenForWrite` | method | `# filePath is a string status = fileAccess.OpenForWrite(filePath);` | | `ReadBinaryToEncoded` | method | `# filePath is a string # encoding is a string # outStr is a CkString (output) status = fileAccess.ReadBinaryToEncoded(filePath, encoding, outStr); retStr = fileAccess.readBinaryToEncoded(filePath, encoding);` | | `ReadBlockBd` | method | `# blockIndex is an integer # blockSize is an integer # bd is a CkBinData status = fileAccess.ReadBlockBd(blockIndex, blockSize, bd);` | | `ReadEntireTextFile` | method | `# filePath is a string # charset is a string # outStrFileContents is a CkString (output) status = fileAccess.ReadEntireTextFile(filePath, charset, outStr); retStr = fileAccess.readEntireTextFile(filePath, charset);` | | `ReadNextFragment` | method | `# startAtBeginning is a boolean # beginMarker is a string # endMarker is a string # charset is a string # sb is a CkStringBuilder retInt = fileAccess.ReadNextFragment(startAtBeginning, beginMarker, endMarker, charset, sb);` | | `ReassembleFile` | method | `# partsDirPath is a string # partPrefix is a string # partExtension is a string # reassembledFilename is a string status = fileAccess.ReassembleFile(partsDirPath, partPrefix, partExtension, reassembledFilename);` | | `ReplaceStrings` | method | `# filePath is a string # charset is a string # existingString is a string # replacementString is a string retInt = fileAccess.ReplaceStrings(filePath, charset, existingString, replacementString);` | | `SetCurrentDir` | method | `# dirPath is a string status = fileAccess.SetCurrentDir(dirPath);` | | `SetFileTimes` | method | `# filePath is a string # createTime is a CkDateTime # lastAccessTime is a CkDateTime # lastModTime is a CkDateTime status = fileAccess.SetFileTimes(filePath, createTime, lastAccessTime, lastModTime);` | | `SetLastModified` | method | `# filePath is a string # lastModified is a CkDateTime status = fileAccess.SetLastModified(filePath, lastModified);` | | `SplitFile` | method | `# fileToSplit is a string # partPrefix is a string # partExtension is a string # partSize is an integer # destDir is a string status = fileAccess.SplitFile(fileToSplit, partPrefix, partExtension, partSize, destDir);` | | `SymlinkCreate` | method | `# targetPath is a string # linkPath is a string status = fileAccess.SymlinkCreate(targetPath, linkPath);` | | `SymlinkTarget` | method | `# linkPath is a string # outStr is a CkString (output) status = fileAccess.SymlinkTarget(linkPath, outStr); retStr = fileAccess.symlinkTarget(linkPath);` | | `TreeDelete` | method | `# path is a string status = fileAccess.TreeDelete(path);` | | `Truncate` | method | `status = fileAccess.Truncate();` | | `WriteEntireTextFile` | method | `# filePath is a string # textData is a string # charset is a string # includedPreamble is a boolean status = fileAccess.WriteEntireTextFile(filePath, textData, charset, includedPreamble);` | Deprecated members are listed at the end of this file with their replacements; do not use them in new code. ## Properties ### FileAccess.CurrentDir `Chilkat 11.7.0 · ckruby · FileAccess · CurrentDir · property · read-only` ```ruby # strVal is a string # ckStr is a CkString fileAccess.get_CurrentDir(ckStr); strVal = fileAccess.currentDir(); ``` Returns the current working directory of the calling process. Relative file and directory paths are resolved against this process-wide working directory. **Process-wide setting:** The working directory belongs to the process, not to an individual `FileAccess` object. Changing it can therefore affect relative-path behavior elsewhere in the application. ### FileAccess.EndOfFile `Chilkat 11.7.0 · ckruby · FileAccess · EndOfFile · property · read-only` ```ruby # boolVal is a boolean boolVal = fileAccess.get_EndOfFile(); ``` Returns `true` when the currently open file is positioned at end-of-file; otherwise returns `false`. **Open-file state:** This property applies to the file opened by `OpenForRead`, `OpenForWrite`, `OpenForReadWrite`, `OpenForAppend`, or `FileOpen`. ### FileAccess.FileOpenError `Chilkat 11.7.0 · ckruby · FileAccess · FileOpenError · property · read-only` ```ruby # intVal is an integer intVal = fileAccess.get_FileOpenError(); ``` Provides the detailed open-error code from the most recent call to `FileOpen`, `OpenForRead`, `OpenForWrite`, `OpenForReadWrite`, or `OpenForAppend`. | Code | Meaning | | :--- | :--- | | `0` | Success; no open error. | | `1` | Access denied. | | `2` | File not found. | | `3` | General, non-specific open error. | | `4` | File already exists. | | `5` | The path refers to a directory and the requested access involves writing. | | `6` | Too many symbolic links were encountered while resolving the path. | | `7` | The process already has the maximum number of files open. | | `8` | The pathname is too long. | | `9` | The system-wide limit on open files has been reached. | | `10` | The pathname refers to a device special file for which no corresponding device exists. | | `11` | Insufficient kernel memory was available. | | `12` | A file was to be created, but the containing device has no space available. | | `13` | A pathname component expected to be a directory is not a directory. | | `14` | The regular file is too large to be opened because of an operating-system limitation. | | `15` | The path is on a read-only filesystem and write access was requested. | **Use with FileOpenErrorMsg:** `FileOpenError` is useful for programmatic handling; `FileOpenErrorMsg` provides the corresponding human-readable message. ### FileAccess.FileOpenErrorMsg `Chilkat 11.7.0 · ckruby · FileAccess · FileOpenErrorMsg · property · read-only` ```ruby # strVal is a string # ckStr is a CkString fileAccess.get_FileOpenErrorMsg(ckStr); strVal = fileAccess.fileOpenErrorMsg(); ``` Returns the human-readable message corresponding to `FileOpenError` for the most recent file-open attempt. ### FileAccess.LockFileOnOpen `Chilkat 11.7.0 · ckruby · FileAccess · LockFileOnOpen · property · read/write · since 9.5.0.80` ```ruby # boolVal is a boolean boolVal = fileAccess.get_LockFileOnOpen(); fileAccess.put_LockFileOnOpen(boolVal); ``` **Windows only.** If `true`, `OpenForAppend`, `OpenForRead`, `OpenForReadWrite`, and `OpenForWrite` request exclusive access to the file. Other processes are prevented from opening the file until `FileClose` releases the handle. The default is `false`. **File sharing:** Windows file sharing is established when the file handle is opened. Set this property before calling an `OpenFor*` method. ## Methods ### FileAccess.AppendAnsi `Chilkat 11.7.0 · ckruby · FileAccess · AppendAnsi · method` ```ruby # text is a string status = fileAccess.AppendAnsi(text); ``` Appends `text` to the currently open file after converting the string to the legacy ANSI character encoding used by Chilkat for the platform. **Character encoding:** Use `AppendText` or `AppendSb` when an explicit encoding such as `utf-8` is preferred. Returns true for success, false for failure. ### FileAccess.AppendBd `Chilkat 11.7.0 · ckruby · FileAccess · AppendBd · method · since 9.5.0.76` ```ruby # bd is a CkBinData status = fileAccess.AppendBd(bd); ``` Appends all bytes contained in `bd` to the currently open file without text conversion. Returns true for success, false for failure. ### FileAccess.AppendSb `Chilkat 11.7.0 · ckruby · FileAccess · AppendSb · method · since 9.5.0.76` ```ruby # sb is a CkStringBuilder # charset is a string status = fileAccess.AppendSb(sb, charset); ``` Appends the text contained in `sb` to the currently open file using the character encoding specified by `charset`. Returns true for success, false for failure. ### FileAccess.AppendText `Chilkat 11.7.0 · ckruby · FileAccess · AppendText · method` ```ruby # str is a string # charset is a string status = fileAccess.AppendText(str, charset); ``` Appends `str` to the currently open file after encoding the text with the character set named by `charset`, such as `utf-8` or `iso-8859-1`. Returns true for success, false for failure. ### FileAccess.AppendUnicodeBOM `Chilkat 11.7.0 · ckruby · FileAccess · AppendUnicodeBOM · method` ```ruby status = fileAccess.AppendUnicodeBOM(); ``` Appends the UTF-16 little-endian byte-order mark to the currently open file. The two bytes written are `FF FE`. **BOM placement:** A BOM normally belongs at the beginning of a text file. This method appends bytes at the current write position, so call it before writing text when creating a new UTF-16LE file. Returns true for success, false for failure. ### FileAccess.AppendUtf8BOM `Chilkat 11.7.0 · ckruby · FileAccess · AppendUtf8BOM · method` ```ruby status = fileAccess.AppendUtf8BOM(); ``` Appends the UTF-8 byte-order mark to the currently open file. The three bytes written are `EF BB BF`. **UTF-8 BOM:** A UTF-8 BOM is optional. Some software uses it as an encoding signature, while other software expects BOM-less UTF-8. Returns true for success, false for failure. ### FileAccess.DirAutoCreate `Chilkat 11.7.0 · ckruby · FileAccess · DirAutoCreate · method` ```ruby # filePath is a string status = fileAccess.DirAutoCreate(filePath); ``` Ensures that the directory portion of `filePath` exists. Any missing parent directories are created; the final path component is treated as a filename and is not created as a directory. **Difference from DirEnsureExists:** Use `DirAutoCreate` when you have a file path. Use `DirEnsureExists` when the argument itself is a directory path. Returns true for success, false for failure. ### FileAccess.DirCreate `Chilkat 11.7.0 · ckruby · FileAccess · DirCreate · method` ```ruby # dirPath is a string status = fileAccess.DirCreate(dirPath); ``` Creates the directory specified by `dirPath`. Parent directories must already exist; use `DirEnsureExists` when missing parent directories should also be created. Returns true for success, false for failure. ### FileAccess.DirDelete `Chilkat 11.7.0 · ckruby · FileAccess · DirDelete · method` ```ruby # dirPath is a string status = fileAccess.DirDelete(dirPath); ``` Deletes the directory specified by `dirPath`. The directory must be empty; use `TreeDelete` to recursively delete a directory and its contents. Returns true for success, false for failure. ### FileAccess.DirEnsureExists `Chilkat 11.7.0 · ckruby · FileAccess · DirEnsureExists · method` ```ruby # dirPath is a string status = fileAccess.DirEnsureExists(dirPath); ``` Ensures that the complete directory path `dirPath` exists, creating missing directories along the path as needed. Returns true for success, false for failure. ### FileAccess.DirExists `Chilkat 11.7.0 · ckruby · FileAccess · DirExists · method · since 10.0.0` ```ruby # dirPath is a string retBool = fileAccess.DirExists(dirPath); ``` Returns `true` if `dirPath` exists as a directory; otherwise returns `false`. ### FileAccess.FileClose `Chilkat 11.7.0 · ckruby · FileAccess · FileClose · method` ```ruby fileAccess.FileClose(); ``` Closes the currently open file and releases its operating-system file handle. Any exclusive lock obtained through `LockFileOnOpen` is released at this time. ### FileAccess.FileContentsEqual `Chilkat 11.7.0 · ckruby · FileAccess · FileContentsEqual · method` ```ruby # filePath1 is a string # filePath2 is a string retBool = fileAccess.FileContentsEqual(filePath1, filePath2); ``` Compares `filePath1` and `filePath2` byte-for-byte and returns `true` only when their contents are identical. File sizes are compared first; when sizes match, the files are compared incrementally rather than being loaded entirely into memory. **Binary comparison:** The comparison is byte-oriented. Text encodings, line-ending conventions, and Unicode normalization are not interpreted or normalized. ### FileAccess.FileCopy `Chilkat 11.7.0 · ckruby · FileAccess · FileCopy · method` ```ruby # existingFilepath is a string # newFilepath is a string # failIfExists is a boolean status = fileAccess.FileCopy(existingFilepath, newFilepath, failIfExists); ``` Copies `existingFilepath` to `newFilepath`. If `failIfExists` is `true` and the destination already exists, the copy fails instead of overwriting it. Returns true for success, false for failure. ### FileAccess.FileDelete `Chilkat 11.7.0 · ckruby · FileAccess · FileDelete · method` ```ruby # filePath is a string status = fileAccess.FileDelete(filePath); ``` Deletes the file specified by `filePath`. Returns true for success, false for failure. ### FileAccess.FileExists `Chilkat 11.7.0 · ckruby · FileAccess · FileExists · method` ```ruby # filePath is a string retBool = fileAccess.FileExists(filePath); ``` Returns `true` if `filePath` exists; otherwise returns `false`. Use `FileExists3` when the application must distinguish "does not exist" from "could not determine because of an error." ### FileAccess.FileExists3 `Chilkat 11.7.0 · ckruby · FileAccess · FileExists3 · method · since 9.5.0.45` ```ruby # path is a string retInt = fileAccess.FileExists3(path); ``` Checks whether `path` exists and returns a three-state result: `1` if it exists, `0` if it does not exist, and `-1` if Chilkat could not determine the result because of permissions or another filesystem error. ### FileAccess.FileOpen `Chilkat 11.7.0 · ckruby · FileAccess · FileOpen · method` ```ruby # filePath is a string # accessMode is an integer # shareMode is an integer # createDisposition is an integer # attributes is an integer status = fileAccess.FileOpen(filePath, accessMode, shareMode, createDisposition, attributes); ``` **Windows-specific low-level open.** Opens `filePath` using arguments modeled after the Win32 `CreateFile` API. For portable code, prefer `OpenForRead`, `OpenForWrite`, `OpenForReadWrite`, or `OpenForAppend`. | Category | Common values | | --- | --- | | Access | `GENERIC_READ = 0x80000000`, `GENERIC_WRITE = 0x40000000` | | Sharing | `FILE_SHARE_READ = 0x1`, `FILE_SHARE_WRITE = 0x2` | | Disposition | `CREATE_NEW=1`, `CREATE_ALWAYS=2`, `OPEN_EXISTING=3`, `OPEN_ALWAYS=4`, `TRUNCATE_EXISTING=5` | **Open failures:** When this method fails, inspect `FileOpenError` and `FileOpenErrorMsg` for the reason. Returns true for success, false for failure. ### FileAccess.FileReadBd `Chilkat 11.7.0 · ckruby · FileAccess · FileReadBd · method · since 9.5.0.64` ```ruby # maxNumBytes is an integer # binData is a CkBinData status = fileAccess.FileReadBd(maxNumBytes, binData); ``` Reads up to `maxNumBytes` bytes from the current file position and appends the bytes to `binData`. The file position advances by the number of bytes read. **Destination behavior:** Existing bytes already present in `binData` are preserved; newly read bytes are appended. Returns true for success, false for failure. ### FileAccess.FileRename `Chilkat 11.7.0 · ckruby · FileAccess · FileRename · method` ```ruby # existingFilepath is a string # newFilepath is a string status = fileAccess.FileRename(existingFilepath, newFilepath); ``` Renames or moves `existingFilepath` to `newFilepath` using the local filesystem. Returns true for success, false for failure. ### FileAccess.FileSeek `Chilkat 11.7.0 · ckruby · FileAccess · FileSeek · method` ```ruby # offset is an integer # origin is an integer status = fileAccess.FileSeek(offset, origin); ``` Moves the current file position by `offset` bytes relative to `origin`. | | | | --- | --- | | `0` | Offset from the beginning of the file. | | `1` | Offset from the current file position. | | `2` | Offset from end-of-file; negative offsets are commonly used. | **Random access:** Seeking changes where the next read or write occurs; it does not itself read, write, or resize the file. Returns true for success, false for failure. ### FileAccess.FileSize `Chilkat 11.7.0 · ckruby · FileAccess · FileSize · method` ```ruby # filePath is a string status = fileAccess.FileSize(filePath); ``` Returns the file size in bytes as a signed 32-bit integer. **Failure returns 0:** If the size cannot be obtained (for example, the file does not exist or cannot be accessed), the return value is `0`, which is the same as for an empty file. To detect failure, use `FileSizeStr`, which fails instead of returning a size, or check first with `FileExists3`. **Large files:** A signed 32-bit result cannot represent files larger than approximately 2 GB. Use `FileSize64` or `FileSizeStr` for large files. ### FileAccess.FileSize64 `Chilkat 11.7.0 · ckruby · FileAccess · FileSize64 · method · since 9.5.0.88` ```ruby # filePath is a string retInt64 = fileAccess.FileSize64(filePath); ``` Returns the size of `filePath` in bytes as a signed 64-bit integer. **Failure returns 0:** If the size cannot be obtained (for example, the file does not exist or cannot be accessed), the return value is `0`, which is the same as for an empty file. To detect failure, use `FileSizeStr`, which fails instead of returning a size, or check first with `FileExists3`. ### FileAccess.FileSizeStr `Chilkat 11.7.0 · ckruby · FileAccess · FileSizeStr · method · since 9.5.0.80` ```ruby # filePath is a string # outStr is a CkString (output) status = fileAccess.FileSizeStr(filePath, outStr); retStr = fileAccess.fileSizeStr(filePath); ``` Returns the size of `filePath` in bytes as a decimal string. This avoids the range limitation of a 32-bit integer return value. Returns true for success, false for failure. ### FileAccess.FileType `Chilkat 11.7.0 · ckruby · FileAccess · FileType · method · since 9.5.0.77` ```ruby # path is a string retInt = fileAccess.FileType(path); ``` Examines `path` and classifies the filesystem entry. | | | | --- | --- | | `-1` | Unable to determine because of permissions or another error. | | `0` | Does not exist. | | `1` | Regular file. | | `2` | Directory. | | `3` | Symbolic link. | | `4` | Windows shortcut. | | `99` | Another filesystem type. | **Future values:** Additional file-type codes may be added in future versions as needed. ### FileAccess.FileWriteBd `Chilkat 11.7.0 · ckruby · FileAccess · FileWriteBd · method · since 9.5.0.64` ```ruby # binData is a CkBinData # offset is an integer # numBytes is an integer status = fileAccess.FileWriteBd(binData, offset, numBytes); ``` Writes bytes from `binData` to the currently open file. `offset` selects the starting byte within the `BinData`; `numBytes` selects how many bytes to write. Set both to `0` to write the entire `BinData`, or set `numBytes` to `0` to write all remaining bytes beginning at `offset`. Returns true for success, false for failure. ### FileAccess.GenBlockId `Chilkat 11.7.0 · ckruby · FileAccess · GenBlockId · method · since 9.5.0.58` ```ruby # index is an integer # length is an integer # encoding is a string # outStr is a CkString (output) status = fileAccess.GenBlockId(index, length, encoding, outStr); retStr = fileAccess.genBlockId(index, length, encoding); ``` Generates a fixed-width decimal block identifier from `index`, padded to `length` characters, and then encodes those bytes using `encoding` (for example `base64`, `hex`, or `ascii`). This utility was originally added for block-oriented uploads such as Azure Blob block uploads. **Ordering:** Fixed-width decimal identifiers preserve numeric ordering when identifiers are compared lexically, provided the chosen width is large enough for all indexes. Returns true for success, false for failure. ### FileAccess.GetDirectoryName `Chilkat 11.7.0 · ckruby · FileAccess · GetDirectoryName · method · since 9.5.0.64` ```ruby # path is a string # outStr is a CkString (output) status = fileAccess.GetDirectoryName(path, outStr); retStr = fileAccess.getDirectoryName(path); ``` Returns the directory portion of `path` according to Chilkat path-parsing rules. ``` GetDirectoryName('C:\MyDir\MySubDir\myfile.ext') -> 'C:\MyDir\MySubDir\' GetDirectoryName('C:\MyDir\MySubDir') -> 'C:\MyDir\' GetDirectoryName('C:\') -> 'C:\' ``` Returns true for success, false for failure. ### FileAccess.GetExtension `Chilkat 11.7.0 · ckruby · FileAccess · GetExtension · method · since 9.5.0.64` ```ruby # path is a string # outStr is a CkString (output) status = fileAccess.GetExtension(path, outStr); retStr = fileAccess.getExtension(path); ``` Returns the filename extension portion of `path`, including the leading period. A period appearing only in a directory name is not treated as the file extension. ``` GetExtension('C:\mydir.old\myfile.ext') -> '.ext' GetExtension('C:\mydir.old\') -> '' ``` Returns true for success, false for failure. ### FileAccess.GetFileName `Chilkat 11.7.0 · ckruby · FileAccess · GetFileName · method · since 9.5.0.64` ```ruby # path is a string # outStr is a CkString (output) status = fileAccess.GetFileName(path, outStr); retStr = fileAccess.getFileName(path); ``` Returns the final filename component of `path`, including its extension. If the path ends with a directory separator, the returned filename is empty. ``` GetFileName('C:\mydir\myfile.ext') -> 'myfile.ext' GetFileName('C:\mydir\') -> '' ``` Returns true for success, false for failure. ### FileAccess.GetFileNameWithoutExtension `Chilkat 11.7.0 · ckruby · FileAccess · GetFileNameWithoutExtension · method · since 9.5.0.64` ```ruby # path is a string # outStr is a CkString (output) status = fileAccess.GetFileNameWithoutExtension(path, outStr); retStr = fileAccess.getFileNameWithoutExtension(path); ``` Returns the final filename component of `path` with its extension removed. If `path` ends with a directory separator, the returned value is empty. ``` GetFileNameWithoutExtension('C:\mydir\myfile.ext') -> 'myfile' GetFileNameWithoutExtension('C:\mydir\') -> '' ``` Returns true for success, false for failure. ### FileAccess.GetFileTimeStr `Chilkat 11.7.0 · ckruby · FileAccess · GetFileTimeStr · method · since 11.0.0` ```ruby # path is a string # which is an integer # outStr is a CkString (output) status = fileAccess.GetFileTimeStr(path, which, outStr); retStr = fileAccess.getFileTimeStr(path, which); ``` Returns one file timestamp as an ISO 8601 UTC string in the form `YYYY-MM-DDTHH:MM:SSZ`. The `which` argument selects `0` = last-modified, `1` = last-access, or `2` = creation. **Portability:** Creation/birth time is not available on every filesystem. The documented Chilkat behavior on Linux is to return the last-modified time when creation time is unavailable. Returns true for success, false for failure. ### FileAccess.GetNumBlocks `Chilkat 11.7.0 · ckruby · FileAccess · GetNumBlocks · method · since 9.5.0.58` ```ruby # blockSize is an integer retInt = fileAccess.GetNumBlocks(blockSize); ``` Returns how many `blockSize`-byte blocks are required to cover the currently open file. A partial final block counts as one block. Returns `0` for an empty file and `-1` if no file is open. **Calculation:** Conceptually this is `ceil(fileSize / blockSize)` for a non-empty file. ### FileAccess.GetTempFilename `Chilkat 11.7.0 · ckruby · FileAccess · GetTempFilename · method` ```ruby # dirPath is a string # prefix is a string # outStr is a CkString (output) status = fileAccess.GetTempFilename(dirPath, prefix, outStr); retStr = fileAccess.getTempFilename(dirPath, prefix); ``` Generates a temporary pathname in `dirPath` using `prefix` and a random alphanumeric suffix, in the general form `prefix_xxxx.TMP`. The returned pathname is guaranteed not to already exist at the time it is generated. Returns true for success, false for failure. ### FileAccess.OpenForAppend `Chilkat 11.7.0 · ckruby · FileAccess · OpenForAppend · method` ```ruby # filePath is a string status = fileAccess.OpenForAppend(filePath); ``` Opens `filePath` for writing at end-of-file. The file is created if it does not exist. Existing content is preserved, and the initial file position is at the end. **Open failures:** If the open/create operation fails, inspect `FileOpenError` and `FileOpenErrorMsg`. On Windows, `LockFileOnOpen` can request exclusive access for this method. Returns true for success, false for failure. ### FileAccess.OpenForRead `Chilkat 11.7.0 · ckruby · FileAccess · OpenForRead · method` ```ruby # filePath is a string status = fileAccess.OpenForRead(filePath); ``` Opens an existing `filePath` for reading. The file may contain text or binary data and must already exist. **Open failures:** If the open/create operation fails, inspect `FileOpenError` and `FileOpenErrorMsg`. On Windows, `LockFileOnOpen` can request exclusive access for this method. Returns true for success, false for failure. ### FileAccess.OpenForReadWrite `Chilkat 11.7.0 · ckruby · FileAccess · OpenForReadWrite · method` ```ruby # filePath is a string status = fileAccess.OpenForReadWrite(filePath); ``` Opens `filePath` for both reading and writing. The file is created if necessary. Existing content is preserved, and the initial file position is at the beginning. **Open failures:** If the open/create operation fails, inspect `FileOpenError` and `FileOpenErrorMsg`. On Windows, `LockFileOnOpen` can request exclusive access for this method. Returns true for success, false for failure. ### FileAccess.OpenForWrite `Chilkat 11.7.0 · ckruby · FileAccess · OpenForWrite · method` ```ruby # filePath is a string status = fileAccess.OpenForWrite(filePath); ``` Opens `filePath` for writing. The file is created if necessary; if it already exists, it is truncated to zero length when opened. **Open failures:** If the open/create operation fails, inspect `FileOpenError` and `FileOpenErrorMsg`. On Windows, `LockFileOnOpen` can request exclusive access for this method. Returns true for success, false for failure. ### FileAccess.ReadBinaryToEncoded `Chilkat 11.7.0 · ckruby · FileAccess · ReadBinaryToEncoded · method` ```ruby # filePath is a string # encoding is a string # outStr is a CkString (output) status = fileAccess.ReadBinaryToEncoded(filePath, encoding, outStr); retStr = fileAccess.readBinaryToEncoded(filePath, encoding); ``` Reads the entire file at `filePath` as binary data and returns an encoded textual representation. Supported encoding names documented for this method include `base64`, `hex`, `qp`, and `url`. **Encoding is not encryption:** These encodings transform bytes into text; they do not provide confidentiality. Returns true for success, false for failure. ### FileAccess.ReadBlockBd `Chilkat 11.7.0 · ckruby · FileAccess · ReadBlockBd · method · since 9.5.0.79` ```ruby # blockIndex is an integer # blockSize is an integer # bd is a CkBinData status = fileAccess.ReadBlockBd(blockIndex, blockSize, bd); ``` Reads the zero-based block `blockIndex` from the currently open file, using `blockSize` bytes per block, and appends the bytes to `bd`. A partial final block is appended at its actual length. **Destination behavior:** Existing contents of `bd` are preserved; the block bytes are appended. Returns true for success, false for failure. ### FileAccess.ReadEntireTextFile `Chilkat 11.7.0 · ckruby · FileAccess · ReadEntireTextFile · method` ```ruby # filePath is a string # charset is a string # outStrFileContents is a CkString (output) status = fileAccess.ReadEntireTextFile(filePath, charset, outStr); retStr = fileAccess.readEntireTextFile(filePath, charset); ``` Reads the entire file at `filePath`, decodes its bytes using `charset`, and returns the resulting text. **Charset matters:** The charset controls byte-to-character conversion. Use the encoding that actually represents the file; incorrect charset selection can produce incorrect text or conversion failure. Returns true for success, false for failure. ### FileAccess.ReadNextFragment `Chilkat 11.7.0 · ckruby · FileAccess · ReadNextFragment · method · since 9.5.0.80` ```ruby # startAtBeginning is a boolean # beginMarker is a string # endMarker is a string # charset is a string # sb is a CkStringBuilder retInt = fileAccess.ReadNextFragment(startAtBeginning, beginMarker, endMarker, charset, sb); ``` Scans the currently open file for the next text fragment beginning with `beginMarker` and ending with `endMarker`. The matched fragment, including both markers, is decoded using `charset` and appended to `sb`. If `startAtBeginning` is `true`, scanning restarts at the beginning of the file; otherwise it continues after the previously matched fragment. | | | | --- | --- | | `1` | A fragment was found and appended. | | `0` | No matching fragment was found. | | `-1` | An error occurred while reading. | ### FileAccess.ReassembleFile `Chilkat 11.7.0 · ckruby · FileAccess · ReassembleFile · method` ```ruby # partsDirPath is a string # partPrefix is a string # partExtension is a string # reassembledFilename is a string status = fileAccess.ReassembleFile(partsDirPath, partPrefix, partExtension, reassembledFilename); ``` Reassembles a file previously divided by `SplitFile`. Parts are read from `partsDirPath` using the supplied `partPrefix` and `partExtension`, and the combined bytes are written to `reassembledFilename`. **Byte-for-byte reconstruction:** Reassembly is a binary operation; no text decoding or newline conversion is performed. Returns true for success, false for failure. ### FileAccess.ReplaceStrings `Chilkat 11.7.0 · ckruby · FileAccess · ReplaceStrings · method` ```ruby # filePath is a string # charset is a string # existingString is a string # replacementString is a string retInt = fileAccess.ReplaceStrings(filePath, charset, existingString, replacementString); ``` Reads the file at `filePath` as text using `charset`, replaces occurrences of `existingString` with `replacementString`, writes the updated text back to the file, and returns the number of replacements made. **Text operation:** This is character-based replacement after decoding the file. It is not suitable for arbitrary binary files. ### FileAccess.SetCurrentDir `Chilkat 11.7.0 · ckruby · FileAccess · SetCurrentDir · method` ```ruby # dirPath is a string status = fileAccess.SetCurrentDir(dirPath); ``` Changes the current working directory of the calling process to `dirPath`. **Process-wide effect:** The current directory is normally process-wide, so changing it can affect relative paths used by other code or threads. Absolute paths avoid that dependency. Returns true for success, false for failure. ### FileAccess.SetFileTimes `Chilkat 11.7.0 · ckruby · FileAccess · SetFileTimes · method` ```ruby # filePath is a string # createTime is a CkDateTime # lastAccessTime is a CkDateTime # lastModTime is a CkDateTime status = fileAccess.SetFileTimes(filePath, createTime, lastAccessTime, lastModTime); ``` Sets the creation, last-access, and last-modified timestamps for `filePath` from the supplied `CkDateTime` objects. On filesystems that do not support a creation/birth time, `createTime` is ignored. **Filesystem differences:** Timestamp availability and precision are filesystem- and operating-system-dependent. Returns true for success, false for failure. ### FileAccess.SetLastModified `Chilkat 11.7.0 · ckruby · FileAccess · SetLastModified · method` ```ruby # filePath is a string # lastModified is a CkDateTime status = fileAccess.SetLastModified(filePath, lastModified); ``` Sets the last-modified timestamp of `filePath` from `lastModified`. The precision actually stored depends on the underlying filesystem. Returns true for success, false for failure. ### FileAccess.SplitFile `Chilkat 11.7.0 · ckruby · FileAccess · SplitFile · method` ```ruby # fileToSplit is a string # partPrefix is a string # partExtension is a string # partSize is an integer # destDir is a string status = fileAccess.SplitFile(fileToSplit, partPrefix, partExtension, partSize, destDir); ``` Splits `fileToSplit` into sequential binary parts of up to `partSize` bytes and writes them to `destDir` using `partPrefix` and `partExtension`. Use `ReassembleFile` to reconstruct the original file. Returns true for success, false for failure. ### FileAccess.SymlinkCreate `Chilkat 11.7.0 · ckruby · FileAccess · SymlinkCreate · method · since 9.5.0.77` ```ruby # targetPath is a string # linkPath is a string status = fileAccess.SymlinkCreate(targetPath, linkPath); ``` Creates a symbolic link at `linkPath` that refers to `targetPath`. **Windows note:** A Windows symbolic link is not the same as a Windows shortcut. Windows may require elevated privileges or an operating-system configuration such as Developer Mode that permits unprivileged symbolic-link creation, depending on system policy and how the application is launched. Returns true for success, false for failure. ### FileAccess.SymlinkTarget `Chilkat 11.7.0 · ckruby · FileAccess · SymlinkTarget · method · since 9.5.0.77` ```ruby # linkPath is a string # outStr is a CkString (output) status = fileAccess.SymlinkTarget(linkPath, outStr); retStr = fileAccess.symlinkTarget(linkPath); ``` Returns the resolved target pathname for the symbolic link at `linkPath`. On Windows, this method also understands Windows shortcut (`.lnk`) files and returns the absolute target path. **Link vs. target:** A symbolic link is a filesystem object that refers to another path. A Windows shortcut is a separate shell-file format; Chilkat supports both here even though they are different mechanisms. Returns true for success, false for failure. ### FileAccess.TreeDelete `Chilkat 11.7.0 · ckruby · FileAccess · TreeDelete · method` ```ruby # path is a string status = fileAccess.TreeDelete(path); ``` Recursively deletes the directory tree rooted at `path`, including contained files and subdirectories. **Destructive operation:** This operation is recursive and destructive. Ensure `path` identifies the intended tree before calling it. Returns true for success, false for failure. ### FileAccess.Truncate `Chilkat 11.7.0 · ckruby · FileAccess · Truncate · method · since 9.5.0.80` ```ruby status = fileAccess.Truncate(); ``` Truncates the currently open file at the current file position. Bytes at and after that position are removed, making the current position the new end-of-file. **Use with FileSeek:** A common pattern is to seek to the desired new length and then call `Truncate`. Returns true for success, false for failure. ### FileAccess.WriteEntireTextFile `Chilkat 11.7.0 · ckruby · FileAccess · WriteEntireTextFile · method` ```ruby # filePath is a string # textData is a string # charset is a string # includedPreamble is a boolean status = fileAccess.WriteEntireTextFile(filePath, textData, charset, includedPreamble); ``` Creates or opens `filePath`, encodes `textData` using `charset`, writes the resulting bytes, and closes the file. Existing file content is replaced. If `includePreamble` is `true`, an appropriate preamble/BOM is included for encodings such as UTF-8 or UTF-16. **BOM terminology:** A BOM is part of the byte representation of the text file; it is not part of the application string itself. Returns true for success, false for failure. ## Deprecated members — do not use in new code | Member | Kind | Deprecated in | Use instead | |---|---|---|---| | `FileRead` | method | before 11.6.1 | — | | `FileWrite` | method | before 11.6.1 | — | | `GetFileTime` | method | before 11.6.1 | `GetFileTimeStr` | | `GetLastModified` | method | before 11.6.1 | `GetFileTimeStr` | | `ReadBlock` | method | before 11.6.1 | — | | `ReadEntireFile` | method | before 11.6.1 | — | | `WriteEntireFile` | method | before 11.6.1 | — | ## Related classes [`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckruby/classes/BinData.md), [`CkDateTime`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckruby/classes/CkDateTime.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckruby/classes/StringBuilder.md)