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

SetFileAttributesW

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

シグネチャ

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

BOOL SetFileAttributesW(
    LPCWSTR lpFileName,
    FILE_FLAGS_AND_ATTRIBUTES dwFileAttributes
);

パラメーター

名前方向説明
lpFileNameLPCWSTRin

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

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

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加しなくても MAX_PATH 制限を解除するようにオプトインできます。詳細については、「ファイル、パス、および名前空間の名前付け」の「Maximum Path Length Limitation」セクションを参照してください。

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)
ファイルのデータが即座には利用できません。この属性は、ファイル データが 物理的にオフライン ストレージへ移動されたことを示します。この属性は、階層型 ストレージ管理ソフトウェアであるリモート記憶域によって使用されます。アプリケーションはこの属性を勝手に変更しないでください。
FILE_ATTRIBUTE_READONLY
1 (0x1)
読み取り専用のファイル。アプリケーションはこのファイルを読み取ることはできますが、書き込みや削除はできません。この 属性はディレクトリには適用されません。詳細については、「Windows Server 2003、Windows XP、または Windows Vista でフォルダーの読み取り専用属性またはシステム属性を表示または変更できない」を参照してください。
FILE_ATTRIBUTE_SYSTEM
4 (0x4)
オペレーティング システムが一部として使用する、または排他的に使用するファイルまたはディレクトリ。
FILE_ATTRIBUTE_TEMPORARY
256 (0x100)
一時記憶域として使用されているファイル。十分なキャッシュ メモリが利用可能な場合、ファイル システムはデータを大容量ストレージへ書き戻すことを避けます。 通常、アプリケーションはハンドルを閉じた後に一時ファイルを削除するためです。そのシナリオでは、システムはデータの書き込みを完全に 回避できます。それ以外の場合、データはハンドルを閉じた後に書き込まれます。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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 透過的フェールオーバー (TFO) はい
SMB 3.0 とスケールアウト ファイル共有 (SO) はい
クラスター共有ボリューム ファイル システム (CsvFS) はい
回復性ファイル システム (ReFS) はい

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

メモ

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

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

各言語での呼び出し定義

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

BOOL SetFileAttributesW(
    LPCWSTR lpFileName,
    FILE_FLAGS_AND_ATTRIBUTES dwFileAttributes
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetFileAttributesW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName,   // LPCWSTR
    uint dwFileAttributes   // FILE_FLAGS_AND_ATTRIBUTES
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetFileAttributesW(
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String,   ' LPCWSTR
    dwFileAttributes As UInteger   ' FILE_FLAGS_AND_ATTRIBUTES
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpFileName : LPCWSTR
' dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES
Declare PtrSafe Function SetFileAttributesW Lib "kernel32" ( _
    ByVal lpFileName As LongPtr, _
    ByVal dwFileAttributes 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

SetFileAttributesW = ctypes.windll.kernel32.SetFileAttributesW
SetFileAttributesW.restype = wintypes.BOOL
SetFileAttributesW.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    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')
SetFileAttributesW = Fiddle::Function.new(
  lib['SetFileAttributesW'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn SetFileAttributesW(
        lpFileName: *const u16,  // LPCWSTR
        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.Unicode, SetLastError = true)]
public static extern bool SetFileAttributesW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, uint dwFileAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFileAttributesW' -Namespace Win32 -PassThru
# $api::SetFileAttributesW(lpFileName, dwFileAttributes)
#uselib "KERNEL32.dll"
#func global SetFileAttributesW "SetFileAttributesW" wptr, wptr
; SetFileAttributesW lpFileName, dwFileAttributes   ; 戻り値は stat
; lpFileName : LPCWSTR -> "wptr"
; dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetFileAttributesW "SetFileAttributesW" wstr, int
; res = SetFileAttributesW(lpFileName, dwFileAttributes)
; lpFileName : LPCWSTR -> "wstr"
; dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "int"
; BOOL SetFileAttributesW(LPCWSTR lpFileName, FILE_FLAGS_AND_ATTRIBUTES dwFileAttributes)
#uselib "KERNEL32.dll"
#cfunc global SetFileAttributesW "SetFileAttributesW" wstr, int
; res = SetFileAttributesW(lpFileName, dwFileAttributes)
; lpFileName : LPCWSTR -> "wstr"
; dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetFileAttributesW = kernel32.NewProc("SetFileAttributesW")
)

// lpFileName (LPCWSTR), dwFileAttributes (FILE_FLAGS_AND_ATTRIBUTES)
r1, _, err := procSetFileAttributesW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
	uintptr(dwFileAttributes),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetFileAttributesW(
  lpFileName: PWideChar;   // LPCWSTR
  dwFileAttributes: DWORD   // FILE_FLAGS_AND_ATTRIBUTES
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetFileAttributesW';
result := DllCall("KERNEL32\SetFileAttributesW"
    , "WStr", lpFileName   ; LPCWSTR
    , "UInt", dwFileAttributes   ; FILE_FLAGS_AND_ATTRIBUTES
    , "Int")   ; return: BOOL
●SetFileAttributesW(lpFileName, dwFileAttributes) = DLL("KERNEL32.dll", "bool SetFileAttributesW(char*, dword)")
# 呼び出し: SetFileAttributesW(lpFileName, dwFileAttributes)
# lpFileName : LPCWSTR -> "char*"
# dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn SetFileAttributesW(
    lpFileName: [*c]const u16, // LPCWSTR
    dwFileAttributes: u32 // FILE_FLAGS_AND_ATTRIBUTES
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetFileAttributesW(
    lpFileName: WideCString,  # LPCWSTR
    dwFileAttributes: uint32  # FILE_FLAGS_AND_ATTRIBUTES
): int32 {.importc: "SetFileAttributesW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int SetFileAttributesW(
    const(wchar)* lpFileName,   // LPCWSTR
    uint dwFileAttributes   // FILE_FLAGS_AND_ATTRIBUTES
);
ccall((:SetFileAttributesW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, UInt32),
      lpFileName, dwFileAttributes)
# lpFileName : LPCWSTR -> Cwstring
# dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetFileAttributesW(
    const uint16_t* lpFileName,
    uint32_t dwFileAttributes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetFileAttributesW(lpFileName, dwFileAttributes)
-- lpFileName : LPCWSTR
-- dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetFileAttributesW = lib.func('__stdcall', 'SetFileAttributesW', 'int32_t', ['str16', 'uint32_t']);
// SetFileAttributesW(lpFileName, dwFileAttributes)
// lpFileName : LPCWSTR -> 'str16'
// dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetFileAttributesW: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.SetFileAttributesW(lpFileName, dwFileAttributes)
// lpFileName : LPCWSTR -> "buffer"
// dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetFileAttributesW(
    const uint16_t* lpFileName,
    uint32_t dwFileAttributes);
C, "KERNEL32.dll");
// $ffi->SetFileAttributesW(lpFileName, dwFileAttributes);
// lpFileName : LPCWSTR
// 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.UNICODE_OPTIONS);
    boolean SetFileAttributesW(
        WString lpFileName,   // LPCWSTR
        int dwFileAttributes   // FILE_FLAGS_AND_ATTRIBUTES
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun SetFileAttributesW = SetFileAttributesW(
    lpFileName : UInt16*,   # LPCWSTR
    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 SetFileAttributesWNative = Int32 Function(Pointer<Utf16>, Uint32);
typedef SetFileAttributesWDart = int Function(Pointer<Utf16>, int);
final SetFileAttributesW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetFileAttributesWNative, SetFileAttributesWDart>('SetFileAttributesW');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetFileAttributesW(
  lpFileName: PWideChar;   // LPCWSTR
  dwFileAttributes: DWORD   // FILE_FLAGS_AND_ATTRIBUTES
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetFileAttributesW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setfileattributesw =
  foreign "SetFileAttributesW"
    ((ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("SetFileAttributesW" set-file-attributes-w :convention :stdcall) :int32
  (lp-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-file-attributes :uint32))   ; FILE_FLAGS_AND_ATTRIBUTES
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetFileAttributesW = Win32::API::More->new('KERNEL32',
    'BOOL SetFileAttributesW(LPCWSTR lpFileName, DWORD dwFileAttributes)');
# my $ret = $SetFileAttributesW->Call($lpFileName, $dwFileAttributes);
# lpFileName : LPCWSTR -> LPCWSTR
# dwFileAttributes : FILE_FLAGS_AND_ATTRIBUTES -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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