FileAccess

Returns the current working directory of the calling process. Relative file and directory paths are resolved against this process-wide working directory.

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.

Returns 1 when the currently open file is positioned at end-of-file; otherwise returns 0.

Provides the detailed open-error code from the most recent call to FileOpen, OpenForRead, OpenForWrite, OpenForReadWrite, or OpenForAppend.

Returns the human-readable message corresponding to FileOpenError for the most recent file-open attempt.

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.

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.

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.

Indicates the success or failure of the most recent method call: 1 means success, 0 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.

Windows only. If 1, 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 0.

When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version of the component/library, such as "10.1.0"

Appends text to the currently open file after converting the string to the legacy ANSI character encoding used by Chilkat for the platform.

Returns 1 for success, 0 for failure.

Appends all bytes contained in bd to the currently open file without text conversion.

Returns 1 for success, 0 for failure.

Appends the text contained in sb to the currently open file using the character encoding specified by charset.

Returns 1 for success, 0 for failure.

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 1 for success, 0 for failure.

Appends the UTF-16 little-endian byte-order mark to the currently open file. The two bytes written are FF FE.

Returns 1 for success, 0 for failure.

Appends the UTF-8 byte-order mark to the currently open file. The three bytes written are EF BB BF.

Returns 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.

Creates the directory specified by dirPath. Parent directories must already exist; use DirEnsureExists when missing parent directories should also be created.

Returns 1 for success, 0 for failure.

Deletes the directory specified by dirPath. The directory must be empty; use TreeDelete to recursively delete a directory and its contents.

Returns 1 for success, 0 for failure.

Ensures that the complete directory path dirPath exists, creating missing directories along the path as needed.

Returns 1 for success, 0 for failure.

Returns 1 if dirPath exists as a directory; otherwise returns 0.

Closes the currently open file and releases its operating-system file handle. Any exclusive lock obtained through LockFileOnOpen is released at this time.

Compares filePath1 and filePath2 byte-for-byte and returns 1 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.

Copies existingFilepath to newFilepath. If failIfExists is 1 and the destination already exists, the copy fails instead of overwriting it.

Returns 1 for success, 0 for failure.

Deletes the file specified by filePath.

Returns 1 for success, 0 for failure.

Returns 1 if filePath exists; otherwise returns 0. Use FileExists3 when the application must distinguish "does not exist" from "could not determine because of an error."

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.

Windows-specific low-level open. Opens filePath using arguments modeled after the Win32 CreateFile API. For portable code, prefer OpenForRead, OpenForWrite, OpenForReadWrite, or OpenForAppend.

Returns 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.

Renames or moves existingFilepath to newFilepath using the local filesystem.

Returns 1 for success, 0 for failure.

Moves the current file position by offset bytes relative to origin.

Returns 1 for success, 0 for failure.

Returns the file size in bytes as a signed 32-bit integer, or -1 on failure.

Returns 1 for success, 0 for failure.

Returns the size of filePath in bytes as a signed 64-bit integer, or -1 on failure.

Returns the size of filePath in bytes as a decimal string. This avoids the range limitation of a 32-bit integer return value.

Returns 1 for success, 0 for failure.

Examines path and classifies the filesystem entry.

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 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

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 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.

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.

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 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.

Opens an existing filePath for reading. The file may contain text or binary data and must already exist.

Returns 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.

Opens filePath for writing. The file is created if necessary; if it already exists, it is truncated to zero length when opened.

Returns 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.

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.

Reads the entire file at filePath, decodes its bytes using charset, and returns the resulting text.

Returns 1 for success, 0 for failure.

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 1, scanning restarts at the beginning of the file; otherwise it continues after the previously matched fragment.

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.

Returns 1 for success, 0 for failure.

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.

Changes the current working directory of the calling process to dirPath.

Returns 1 for success, 0 for failure.

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.

Sets the last-modified timestamp of filePath from lastModified. The precision actually stored depends on the underlying filesystem.

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 1 for success, 0 for failure.

Creates a symbolic link at linkPath that refers to targetPath.

Returns 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.

Recursively deletes the directory tree rooted at path, including contained files and subdirectories.

Returns 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.

Creates or opens filePath, encodes textData using charset, writes the resulting bytes, and closes the file. Existing file content is replaced. If includePreamble is 1, an appropriate preamble/BOM is included for encodings such as UTF-8 or UTF-16.

Returns 1 for success, 0 for failure.

Reads up to maxNumBytes bytes from the current file position and advances the file position by the number of bytes actually read. An empty byte array is returned on error.

Returns 1 for success, 0 for failure.

Writes all bytes in data at the current file position and advances the position accordingly.

Returns 1 for success, 0 for failure.

Deprecated. Use GetFileTimeStr instead.

Returns one file timestamp as a CkDateTime, selected by which: 0 = last-modified, 1 = last-access, 2 = creation.

Returns NULL on failure

Deprecated. Use GetFileTimeStr instead.

Returns the last-modified date/time for path as a CkDateTime. The documented resolution of this legacy method is one second.

Returns NULL on failure

Reads the zero-based block blockIndex from the currently open file, where each block is blockSize bytes. If the final block is shorter than blockSize, only the remaining bytes are returned.

Returns 1 for success, 0 for failure.

Reads the entire file at filePath as raw bytes and returns the binary data.

Returns 1 for success, 0 for failure.

Creates or opens filePath, writes all bytes from fileData, and closes the file. Existing file content is replaced.

Returns 1 for success, 0 for failure.