ホーム › Storage.FileSystem › FileEncryptionStatusW

FileEncryptionStatusW

関数

ファイルの暗号化状態を取得する(Unicode版)。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL FileEncryptionStatusW(
    LPCWSTR lpFileName,
    DWORD* lpStatus
);

パラメーター

名前

型

方向

説明

lpFileName

LPCWSTR

ファイルの名前。

lpStatus

DWORD*

out

ファイルの暗号化状態を受け取る変数へのポインター。このパラメーターには次のいずれかの値を指定できます。

値	意味
FILE_ENCRYPTABLE 0	ファイルは暗号化できます。 Windows の Home、Home Premium、Starter、および ARM エディション: FILE_ENCRYPTABLE が返される場合がありますが、これらのエディションの Windows では EFS によるファイルの暗号化はサポートされていません。
FILE_IS_ENCRYPTED 1	ファイルは暗号化されています。
FILE_READ_ONLY 8	ファイルは読み取り専用ファイルです。
FILE_ROOT_DIR 3	ファイルはルートディレクトリです。ルートディレクトリは暗号化できません。
FILE_SYSTEM_ATTR 2	ファイルはシステムファイルです。システムファイルは暗号化できません。
FILE_SYSTEM_DIR 4	ファイルはシステムディレクトリです。システムディレクトリは暗号化できません。
FILE_SYSTEM_NOT_SUPPORT 6	ファイルシステムはファイルの暗号化をサポートしていません。
FILE_UNKNOWN 5	暗号化状態は不明です。ファイルは暗号化されている可能性があります。
FILE_USER_DISALLOWED 7	将来の使用のために予約されています。

戻り値の型: BOOL

公式ドキュメント

指定されたファイルの暗号化状態を取得します。(Unicode)

戻り値

関数が成功した場合、戻り値は 0 以外です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされています。

テクノロジ	サポート
Server Message Block (SMB) 3.0 プロトコル	はい
SMB 3.0 Transparent Failover (TFO)	いいえ
SMB 3.0 with Scale-out File Shares (SO)	いいえ
Cluster Shared Volume File System (CsvFS)	いいえ
Resilient File System (ReFS)	いいえ

SMB 3.0 は、継続的な可用性機能を持つ共有上での EFS をサポートしていません。

メモ

winbase.h ヘッダーは FileEncryptionStatus をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL FileEncryptionStatusW(
    LPCWSTR lpFileName,
    DWORD* lpStatus
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FileEncryptionStatusW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName,   // LPCWSTR
    out uint lpStatus   // DWORD* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FileEncryptionStatusW(
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String,   ' LPCWSTR
    <Out> ByRef lpStatus As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpFileName : LPCWSTR
' lpStatus : DWORD* out
Declare PtrSafe Function FileEncryptionStatusW Lib "advapi32" ( _
    ByVal lpFileName As LongPtr, _
    ByRef lpStatus As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FileEncryptionStatusW = ctypes.windll.advapi32.FileEncryptionStatusW
FileEncryptionStatusW.restype = wintypes.BOOL
FileEncryptionStatusW.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # lpStatus : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
FileEncryptionStatusW = Fiddle::Function.new(
  lib['FileEncryptionStatusW'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpStatus : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn FileEncryptionStatusW(
        lpFileName: *const u16,  // LPCWSTR
        lpStatus: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool FileEncryptionStatusW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, out uint lpStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_FileEncryptionStatusW' -Namespace Win32 -PassThru
# $api::FileEncryptionStatusW(lpFileName, lpStatus)

#uselib "ADVAPI32.dll"
#func global FileEncryptionStatusW "FileEncryptionStatusW" wptr, wptr
; FileEncryptionStatusW lpFileName, varptr(lpStatus)   ; 戻り値は stat
; lpFileName : LPCWSTR -> "wptr"
; lpStatus : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global FileEncryptionStatusW "FileEncryptionStatusW" wstr, var
; res = FileEncryptionStatusW(lpFileName, lpStatus)
; lpFileName : LPCWSTR -> "wstr"
; lpStatus : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global FileEncryptionStatusW "FileEncryptionStatusW" wstr, sptr
; res = FileEncryptionStatusW(lpFileName, varptr(lpStatus))
; lpFileName : LPCWSTR -> "wstr"
; lpStatus : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。