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

SetFileAttributesA

関数
指定ファイルの属性を設定する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetFileAttributesA(
    LPCSTR lpFileName,
    FILE_FLAGS_AND_ATTRIBUTES dwFileAttributes
);

パラメーター

名前型方向説明
lpFileNameLPCSTRin

属性を設定するファイルの名前。

既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除することをオプトインで選択できます。詳細については、ファイル、パス、名前空間の名前付けの「最大パス長の制限」セクションを参照してください。

dwFileAttributesFILE_FLAGS_AND_ATTRIBUTESin

ファイルに設定するファイル属性。

このパラメーターには、ビット単位の OR 演算子で結合された 1 つ以上の値を指定できます。ただし、他のすべての値は FILE_ATTRIBUTE_NORMAL を上書きします。

すべての属性がこの関数でサポートされているわけではありません。詳細については、「解説」セクションを参照してください。

以下は、サポートされている属性値の一覧です。

値 意味
FILE_ATTRIBUTE_ARCHIVE
32 (0x20)
アーカイブ ファイルまたはアーカイブ ディレクトリであるファイルまたはディレクトリ。アプリケーションは通常、この属性を 使用して、バックアップまたは削除の対象となるファイルにマークを付けます。
FILE_ATTRIBUTE_HIDDEN
2 (0x2)
ファイルまたはディレクトリが隠しファイルです。通常のディレクトリ一覧には含まれません。
FILE_ATTRIBUTE_NORMAL
128 (0x80)
他の属性が設定されていないファイル。この属性は、単独で使用される場合にのみ有効です。
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED
8192 (0x2000)
ファイルまたはディレクトリは、コンテンツ インデックス サービスによってインデックスを作成されません。
FILE_ATTRIBUTE_OFFLINE
4096 (0x1000)
ファイルのデータがすぐには利用できません。この属性は、ファイル データが 物理的にオフライン ストレージに移動されたことを示します。この属性は、階層型 ストレージ管理ソフトウェアであるリモート記憶域 (Remote Storage) によって使用されます。アプリケーションは、この属性を無断で変更しないでください。
FILE_ATTRIBUTE_READONLY
1 (0x1)
読み取り専用のファイル。アプリケーションはファイルを読み取ることができますが、書き込みや削除はできません。この 属性はディレクトリでは尊重されません。詳細については、「Windows Server 2003、Windows XP、または Windows Vista で、フォルダーの読み取り専用属性またはシステム属性を表示または変更できない」を参照してください。
FILE_ATTRIBUTE_SYSTEM
4 (0x4)
オペレーティング システムが一部として使用する、または排他的に使用するファイルまたはディレクトリ。
FILE_ATTRIBUTE_TEMPORARY
256 (0x100)
一時的な記憶域として使用されているファイル。ファイル システムは、十分なキャッシュ メモリが利用可能な場合、 データを大容量記憶域に書き戻すことを回避します。これは通常、アプリケーションがハンドルを閉じた後に一時ファイルを 削除するためです。そのシナリオでは、システムはデータの書き込みを完全に回避できます。それ以外の場合、データはハンドルを閉じた後に 書き込まれます。

戻り値の型: BOOL

公式ドキュメント

ファイルまたはディレクトリの属性を設定します。(ANSI)

戻り値

関数が成功すると、戻り値は 0 以外になります。

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

解説(Remarks)

次の表は、SetFileAttributes を使用して設定できない属性を設定する方法について説明しています。 すべてのファイル属性値とその説明の完全な一覧については、 File Attribute Constants を参照してください。

属性 設定方法
FILE_ATTRIBUTE_COMPRESSED

0x800

ファイルの圧縮状態を設定するには、 DeviceIoControl 関数を FSCTL_SET_COMPRESSION 操作とともに使用します。
FILE_ATTRIBUTE_DEVICE

0x40

予約済み。使用しないでください。
FILE_ATTRIBUTE_DIRECTORY

0x10

ファイルをディレクトリに変換することはできません。ディレクトリを作成するには、 CreateDirectory または CreateDirectoryEx 関数を使用します。
FILE_ATTRIBUTE_ENCRYPTED

0x4000

暗号化されたファイルを作成するには、 CreateFile 関数を FILE_ATTRIBUTE_ENCRYPTED 属性とともに使用します。既存のファイルを暗号化された ファイルに変換するには、EncryptFile 関数を使用します。
FILE_ATTRIBUTE_REPARSE_POINT

0x400

ファイルまたはディレクトリに再解析ポイントを関連付けるには、 DeviceIoControl 関数を FSCTL_SET_REPARSE_POINT 操作とともに使用します。
FILE_ATTRIBUTE_SPARSE_FILE

0x200

ファイルのスパース属性を設定するには、 DeviceIoControl 関数を FSCTL_SET_SPARSE 操作とともに使用します。

トランザクション操作

トランザクション内で変更のためにファイルが開かれている場合、トランザクションがコミットされるまで、他のスレッドは 変更のためにそのファイルを開くことができません。したがって、トランザクション化されたスレッドが最初にファイルを開いた場合、 トランザクションがコミットされる前にファイルを変更しようとする後続のスレッドは、共有違反を受け取ります。トランザクション化されていないスレッドが トランザクション化されたスレッドより先にファイルを変更し、トランザクションがそのファイルを開こうとしたときにファイルがまだ開かれている場合、 トランザクションはエラー ERROR_TRANSACTIONAL_CONFLICT を受け取ります。

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) はい

例

例については、 Retrieving and Changing File Attributes を参照してください。

メモ

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

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

各言語での呼び出し定義

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

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

SetFileAttributesA = ctypes.windll.kernel32.SetFileAttributesA
SetFileAttributesA.restype = wintypes.BOOL
SetFileAttributesA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    wintypes.DWORD,  # dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetFileAttributesA = Fiddle::Function.new(
  lib['SetFileAttributesA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
    -Fiddle::TYPE_INT,  # dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetFileAttributesA(
        lpFileName: *const u8,  // LPCSTR
        dwFileAttributes: u32  // FILE_FLAGS_AND_ATTRIBUTES
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SetFileAttributesA([MarshalAs(UnmanagedType.LPStr)] string lpFileName, uint dwFileAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFileAttributesA' -Namespace Win32 -PassThru
# $api::SetFileAttributesA(lpFileName, dwFileAttributes)
#uselib "KERNEL32.dll"
#func global SetFileAttributesA "SetFileAttributesA" sptr, sptr
; SetFileAttributesA lpFileName, dwFileAttributes   ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetFileAttributesA "SetFileAttributesA" str, int
; res = SetFileAttributesA(lpFileName, dwFileAttributes)
; lpFileName : LPCSTR -> "str"
; dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "int"
; BOOL SetFileAttributesA(LPCSTR lpFileName, FILE_FLAGS_AND_ATTRIBUTES dwFileAttributes)
#uselib "KERNEL32.dll"
#cfunc global SetFileAttributesA "SetFileAttributesA" str, int
; res = SetFileAttributesA(lpFileName, dwFileAttributes)
; lpFileName : LPCSTR -> "str"
; dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetFileAttributesA = kernel32.NewProc("SetFileAttributesA")
)

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

extern "kernel32" fn SetFileAttributesA(
    lpFileName: [*c]const u8, // LPCSTR
    dwFileAttributes: u32 // FILE_FLAGS_AND_ATTRIBUTES
) callconv(std.os.windows.WINAPI) i32;
proc SetFileAttributesA(
    lpFileName: cstring,  # LPCSTR
    dwFileAttributes: uint32  # FILE_FLAGS_AND_ATTRIBUTES
): int32 {.importc: "SetFileAttributesA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetFileAttributesA(
    const(char)* lpFileName,   // LPCSTR
    uint dwFileAttributes   // FILE_FLAGS_AND_ATTRIBUTES
);
ccall((:SetFileAttributesA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, UInt32),
      lpFileName, dwFileAttributes)
# lpFileName : LPCSTR -> Cstring
# dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetFileAttributesA(
    const char* lpFileName,
    uint32_t dwFileAttributes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetFileAttributesA(lpFileName, dwFileAttributes)
-- lpFileName : LPCSTR
-- dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetFileAttributesA = lib.func('__stdcall', 'SetFileAttributesA', 'int32_t', ['str', 'uint32_t']);
// SetFileAttributesA(lpFileName, dwFileAttributes)
// lpFileName : LPCSTR -> 'str'
// dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetFileAttributesA: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.SetFileAttributesA(lpFileName, dwFileAttributes)
// lpFileName : LPCSTR -> "buffer"
// dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetFileAttributesA(
    const char* lpFileName,
    uint32_t dwFileAttributes);
C, "KERNEL32.dll");
// $ffi->SetFileAttributesA(lpFileName, dwFileAttributes);
// lpFileName : LPCSTR
// dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
    boolean SetFileAttributesA(
        String lpFileName,   // LPCSTR
        int dwFileAttributes   // FILE_FLAGS_AND_ATTRIBUTES
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetFileAttributesA = SetFileAttributesA(
    lpFileName : UInt8*,   # LPCSTR
    dwFileAttributes : UInt32   # FILE_FLAGS_AND_ATTRIBUTES
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let setfileattributesa =
  foreign "SetFileAttributesA"
    (string @-> uint32_t @-> returning int32_t)
(* lpFileName : LPCSTR -> string *)
(* dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

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

関連項目

文字セット違い
公式の関連項目
使用する型