Win32 API 日本語リファレンス
ホームStorage.FileSystem › FileEncryptionStatusA

FileEncryptionStatusA

関数
ファイルの暗号化状態を取得する(ANSI版)。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL FileEncryptionStatusA(
    LPCSTR lpFileName,
    DWORD* lpStatus
);

パラメーター

名前方向説明
lpFileNameLPCSTRinファイルの名前。
lpStatusDWORD*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

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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 は、継続的可用性 (continuous availability) 機能を持つ共有上での EFS をサポートしていません。

メモ

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

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL FileEncryptionStatusA(
    LPCSTR lpFileName,
    DWORD* lpStatus
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FileEncryptionStatusA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName,   // LPCSTR
    out uint lpStatus   // DWORD* out
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FileEncryptionStatusA(
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String,   ' LPCSTR
    <Out> ByRef lpStatus As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpFileName : LPCSTR
' lpStatus : DWORD* out
Declare PtrSafe Function FileEncryptionStatusA Lib "advapi32" ( _
    ByVal lpFileName As String, _
    ByRef lpStatus As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FileEncryptionStatusA = ctypes.windll.advapi32.FileEncryptionStatusA
FileEncryptionStatusA.restype = wintypes.BOOL
FileEncryptionStatusA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    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')
FileEncryptionStatusA = Fiddle::Function.new(
  lib['FileEncryptionStatusA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpStatus : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn FileEncryptionStatusA(
        lpFileName: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool FileEncryptionStatusA([MarshalAs(UnmanagedType.LPStr)] string lpFileName, out uint lpStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_FileEncryptionStatusA' -Namespace Win32 -PassThru
# $api::FileEncryptionStatusA(lpFileName, lpStatus)
#uselib "ADVAPI32.dll"
#func global FileEncryptionStatusA "FileEncryptionStatusA" sptr, sptr
; FileEncryptionStatusA lpFileName, varptr(lpStatus)   ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; lpStatus : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global FileEncryptionStatusA "FileEncryptionStatusA" str, var
; res = FileEncryptionStatusA(lpFileName, lpStatus)
; lpFileName : LPCSTR -> "str"
; lpStatus : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FileEncryptionStatusA(LPCSTR lpFileName, DWORD* lpStatus)
#uselib "ADVAPI32.dll"
#cfunc global FileEncryptionStatusA "FileEncryptionStatusA" str, var
; res = FileEncryptionStatusA(lpFileName, lpStatus)
; lpFileName : LPCSTR -> "str"
; lpStatus : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procFileEncryptionStatusA = advapi32.NewProc("FileEncryptionStatusA")
)

// lpFileName (LPCSTR), lpStatus (DWORD* out)
r1, _, err := procFileEncryptionStatusA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
	uintptr(lpStatus),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FileEncryptionStatusA(
  lpFileName: PAnsiChar;   // LPCSTR
  lpStatus: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'FileEncryptionStatusA';
result := DllCall("ADVAPI32\FileEncryptionStatusA"
    , "AStr", lpFileName   ; LPCSTR
    , "Ptr", lpStatus   ; DWORD* out
    , "Int")   ; return: BOOL
●FileEncryptionStatusA(lpFileName, lpStatus) = DLL("ADVAPI32.dll", "bool FileEncryptionStatusA(char*, void*)")
# 呼び出し: FileEncryptionStatusA(lpFileName, lpStatus)
# lpFileName : LPCSTR -> "char*"
# lpStatus : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn FileEncryptionStatusA(
    lpFileName: [*c]const u8, // LPCSTR
    lpStatus: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc FileEncryptionStatusA(
    lpFileName: cstring,  # LPCSTR
    lpStatus: ptr uint32  # DWORD* out
): int32 {.importc: "FileEncryptionStatusA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
int FileEncryptionStatusA(
    const(char)* lpFileName,   // LPCSTR
    uint* lpStatus   // DWORD* out
);
ccall((:FileEncryptionStatusA, "ADVAPI32.dll"), stdcall, Int32,
      (Cstring, Ptr{UInt32}),
      lpFileName, lpStatus)
# lpFileName : LPCSTR -> Cstring
# lpStatus : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FileEncryptionStatusA(
    const char* lpFileName,
    uint32_t* lpStatus);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.FileEncryptionStatusA(lpFileName, lpStatus)
-- lpFileName : LPCSTR
-- lpStatus : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const FileEncryptionStatusA = lib.func('__stdcall', 'FileEncryptionStatusA', 'int32_t', ['str', 'uint32_t *']);
// FileEncryptionStatusA(lpFileName, lpStatus)
// lpFileName : LPCSTR -> 'str'
// lpStatus : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  FileEncryptionStatusA: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.FileEncryptionStatusA(lpFileName, lpStatus)
// lpFileName : LPCSTR -> "buffer"
// lpStatus : DWORD* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FileEncryptionStatusA(
    const char* lpFileName,
    uint32_t* lpStatus);
C, "ADVAPI32.dll");
// $ffi->FileEncryptionStatusA(lpFileName, lpStatus);
// lpFileName : LPCSTR
// lpStatus : DWORD* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.ASCII_OPTIONS);
    boolean FileEncryptionStatusA(
        String lpFileName,   // LPCSTR
        IntByReference lpStatus   // DWORD* out
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun FileEncryptionStatusA = FileEncryptionStatusA(
    lpFileName : UInt8*,   # LPCSTR
    lpStatus : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FileEncryptionStatusANative = Int32 Function(Pointer<Utf8>, Pointer<Uint32>);
typedef FileEncryptionStatusADart = int Function(Pointer<Utf8>, Pointer<Uint32>);
final FileEncryptionStatusA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<FileEncryptionStatusANative, FileEncryptionStatusADart>('FileEncryptionStatusA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// lpStatus : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FileEncryptionStatusA(
  lpFileName: PAnsiChar;   // LPCSTR
  lpStatus: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'FileEncryptionStatusA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FileEncryptionStatusA"
  c_FileEncryptionStatusA :: CString -> Ptr Word32 -> IO CInt
-- lpFileName : LPCSTR -> CString
-- lpStatus : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let fileencryptionstatusa =
  foreign "FileEncryptionStatusA"
    (string @-> (ptr uint32_t) @-> returning int32_t)
(* lpFileName : LPCSTR -> string *)
(* lpStatus : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("FileEncryptionStatusA" file-encryption-status-a :convention :stdcall) :int32
  (lp-file-name :string)   ; LPCSTR
  (lp-status :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FileEncryptionStatusA = Win32::API::More->new('ADVAPI32',
    'BOOL FileEncryptionStatusA(LPCSTR lpFileName, LPVOID lpStatus)');
# my $ret = $FileEncryptionStatusA->Call($lpFileName, $lpStatus);
# lpFileName : LPCSTR -> LPCSTR
# lpStatus : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目