Partilhar via


File API

Functions relating to the File API.

The functions prefaced with Ipcf rather than Ipc are a subset of the SDK and are the File API.

Note

For error condition processing, always use a call to IpcGetErrorMessageText right after an SDK API call fails, so you get complete information about the nature of the error.

 

In this section

IpcfDecryptFile

Decrypts the specified file on disk.

IpcfDecryptFileStream

Decrypts a file as a byte stream.

IpcfEncryptFile

Encrypts a file on disk.

IpcfEncryptFileStream

Encrypts a file as a byte stream.

IpcfEncryptFileStreamWithMetadata

Used to encrypt a file as a byte stream and optionally add metadata to the encryption license.

IpcfEncryptFileWithMetadata

Used to encrypt a file and optionally add metadata to the file encryption license.

IpcfGetDecryptedFilePath

Use to get the expected, decrypted, absolute file path.

IpcfGetDecryptedFilePathFromStream

Used to get the expected, decrypted, absolute file path.

IpcfGetEncryptedFilePath

Used to get the expected, encrypted, absolute file path.

IpcfGetEncryptedFilePathFromStream

Used to get the expected, encrypted, absolute file path.

IpcfGetFileProperty

Queries the properties of an IPCF_FILE_HANDLE or the file represented by it.

IpcfGetSerializedLicenseFromFile

Gets the license associated with a file.

IpcfGetSerializedLicenseFromFileStream

Gets the license associated with a file stream.

IpcfIsFileEncrypted

Determines whether a file on disk is encrypted.

IpcfIsFileStreamEncrypted

Determines whether a file stream is encrypted.

IpcfOpenFileOnHandle

Gets an IPCF_FILE_HANDLE associated with an encrypted file which can be used to access and modify that file's data.

IpcfOpenFileOnILockBytes

Gets an IPCF_FILE_HANDLE associated with an encrypted byte stream which can be used to access and modify that stream's data.

IpcfLogicalFileRangeToRawFileRange

Gets the raw file range for the given logical file range of the protected file content.

IpcfReadFile

Reads protected content of a protected file given a logical file range.

IpcfSetEndOfFile

Truncates a protected file.

IpcfSetFileProperty

Sets the properties on IPCF_FILE_HANDLE or on the file represented by it.

IpcfWriteFile

Modifies protected content of a protected file to a given logical file range.