EncryptFileA 関数 (winbase.h)
ファイルまたはディレクトリを暗号化します。 ファイル内のすべてのデータ ストリームが暗号化されます。 暗号化されたディレクトリに作成されたすべての新しいファイルが暗号化されます。
構文
BOOL EncryptFileA(
[in] LPCSTR lpFileName
);
パラメーター
[in] lpFileName
暗号化するファイルまたはディレクトリの名前。
呼び出し元には、FILE_READ_DATA、FILE_WRITE_DATA、FILE_READ_ATTRIBUTES、FILE_WRITE_ATTRIBUTES、SYNCHRONIZE アクセス権が必要です。 詳細については、「 ファイル のセキュリティとアクセス権」を参照してください。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
EncryptFile 関数は、暗号化されているファイルへの排他的アクセスを必要とし、別のプロセスがファイルを使用している場合は失敗します。
ファイルが既に暗号化されている場合、 EncryptFile は単に 0 以外の値を返します。これは成功を示します。 ファイルが圧縮されている場合、 EncryptFile は暗号化する前にファイルを圧縮解除します。
lpFileName で読み取り専用ファイルが指定されている場合、関数は失敗し、GetLastError はERROR_FILE_READ_ONLYを返します。 lpFileName が読み取り専用ファイルを含むディレクトリを指定した場合、関数は成功しますが、ディレクトリは暗号化されません。
暗号化されたファイルの暗号化を解除するには、DecryptFile 関数を使用します。
Windows 8、Windows Server 2012、以降では、この関数は次のテクノロジでサポートされています。
| テクノロジ | サポートされています |
|---|---|
| サーバー メッセージ ブロック (SMB) 3.0 プロトコル | はい |
| SMB 3.0 Transparent Failover (TFO) | いいえ |
| スケールアウト ファイル共有 (SO) を使う SMB 3.0 | いいえ |
| クラスターの共有ボリューム ファイル システム (CsvFS) | いいえ |
| Resilient File System (ReFS) | いいえ |
SMB 3.0 では、継続的可用性機能を備えた共有上の EFS はサポートされていません。
注意
winbase.h ヘッダーは EncryptFile をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | winbase.h (Windows.h を含む) |
| Library | Advapi32.lib |
| [DLL] | Advapi32.dll |
| API セット | ext-ms-win-advapi32-encryptedfile-l1-1-0 (Windows 8で導入) |