Win32 API 日本語リファレンス
ホームSystem.Threading › SetProtectedPolicy

SetProtectedPolicy

関数
保護ポリシー値をGUID指定で設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL SetProtectedPolicy(
    const GUID* PolicyGuid,
    UINT_PTR PolicyValue,
    UINT_PTR* OldPolicyValue   // optional
);

パラメーター

名前方向説明
PolicyGuidGUID*in設定するポリシーのグローバル一意識別子 (GUID)。
PolicyValueUINT_PTRinポリシーに設定する値。
OldPolicyValueUINT_PTR*outoptional必要に応じて、指定したポリシーに関連付けられていた元の値を受け取ります。

戻り値の型: BOOL

公式ドキュメント

保護されたポリシーを設定します。

戻り値

関数が成功した場合は true、それ以外の場合は false。この関数のエラー値を取得するには、GetLastError を呼び出します。

解説(Remarks)

保護されたポリシーは、読み取り専用メモリに格納されるプロセス全体の構成設定です。これは、アプリケーションの実行中にポリシーが破損したり意図しない方法で変更されたりすることから保護することを目的としています。保護されたポリシーは、主に Windows 内部で使用される仕組みです。

この関数を呼び出すアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0603 以降として定義します。詳細については、Using the Windows Headers を参照してください。

この関数は、Windows 8.1 および Windows Server 2012 R2 向けの update 3 (2014 年 11 月の更新) で利用可能になりました。

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL SetProtectedPolicy(
    const GUID* PolicyGuid,
    UINT_PTR PolicyValue,
    UINT_PTR* OldPolicyValue   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetProtectedPolicy(
    ref Guid PolicyGuid,   // GUID*
    UIntPtr PolicyValue,   // UINT_PTR
    IntPtr OldPolicyValue   // UINT_PTR* optional, out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetProtectedPolicy(
    ByRef PolicyGuid As Guid,   ' GUID*
    PolicyValue As UIntPtr,   ' UINT_PTR
    OldPolicyValue As IntPtr   ' UINT_PTR* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' PolicyGuid : GUID*
' PolicyValue : UINT_PTR
' OldPolicyValue : UINT_PTR* optional, out
Declare PtrSafe Function SetProtectedPolicy Lib "kernel32" ( _
    ByVal PolicyGuid As LongPtr, _
    ByVal PolicyValue As LongPtr, _
    ByVal OldPolicyValue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetProtectedPolicy = ctypes.windll.kernel32.SetProtectedPolicy
SetProtectedPolicy.restype = wintypes.BOOL
SetProtectedPolicy.argtypes = [
    ctypes.c_void_p,  # PolicyGuid : GUID*
    ctypes.c_size_t,  # PolicyValue : UINT_PTR
    ctypes.POINTER(ctypes.c_size_t),  # OldPolicyValue : UINT_PTR* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetProtectedPolicy = Fiddle::Function.new(
  lib['SetProtectedPolicy'],
  [
    Fiddle::TYPE_VOIDP,  # PolicyGuid : GUID*
    Fiddle::TYPE_UINTPTR_T,  # PolicyValue : UINT_PTR
    Fiddle::TYPE_VOIDP,  # OldPolicyValue : UINT_PTR* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetProtectedPolicy(
        PolicyGuid: *const GUID,  // GUID*
        PolicyValue: usize,  // UINT_PTR
        OldPolicyValue: *mut usize  // UINT_PTR* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetProtectedPolicy(ref Guid PolicyGuid, UIntPtr PolicyValue, IntPtr OldPolicyValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetProtectedPolicy' -Namespace Win32 -PassThru
# $api::SetProtectedPolicy(PolicyGuid, PolicyValue, OldPolicyValue)
#uselib "KERNEL32.dll"
#func global SetProtectedPolicy "SetProtectedPolicy" sptr, sptr, sptr
; SetProtectedPolicy varptr(PolicyGuid), PolicyValue, varptr(OldPolicyValue)   ; 戻り値は stat
; PolicyGuid : GUID* -> "sptr"
; PolicyValue : UINT_PTR -> "sptr"
; OldPolicyValue : UINT_PTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global SetProtectedPolicy "SetProtectedPolicy" var, sptr, var
; res = SetProtectedPolicy(PolicyGuid, PolicyValue, OldPolicyValue)
; PolicyGuid : GUID* -> "var"
; PolicyValue : UINT_PTR -> "sptr"
; OldPolicyValue : UINT_PTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetProtectedPolicy(GUID* PolicyGuid, UINT_PTR PolicyValue, UINT_PTR* OldPolicyValue)
#uselib "KERNEL32.dll"
#cfunc global SetProtectedPolicy "SetProtectedPolicy" var, intptr, var
; res = SetProtectedPolicy(PolicyGuid, PolicyValue, OldPolicyValue)
; PolicyGuid : GUID* -> "var"
; PolicyValue : UINT_PTR -> "intptr"
; OldPolicyValue : UINT_PTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetProtectedPolicy = kernel32.NewProc("SetProtectedPolicy")
)

// PolicyGuid (GUID*), PolicyValue (UINT_PTR), OldPolicyValue (UINT_PTR* optional, out)
r1, _, err := procSetProtectedPolicy.Call(
	uintptr(PolicyGuid),
	uintptr(PolicyValue),
	uintptr(OldPolicyValue),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetProtectedPolicy(
  PolicyGuid: PGUID;   // GUID*
  PolicyValue: NativeUInt;   // UINT_PTR
  OldPolicyValue: Pointer   // UINT_PTR* optional, out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetProtectedPolicy';
result := DllCall("KERNEL32\SetProtectedPolicy"
    , "Ptr", PolicyGuid   ; GUID*
    , "UPtr", PolicyValue   ; UINT_PTR
    , "Ptr", OldPolicyValue   ; UINT_PTR* optional, out
    , "Int")   ; return: BOOL
●SetProtectedPolicy(PolicyGuid, PolicyValue, OldPolicyValue) = DLL("KERNEL32.dll", "bool SetProtectedPolicy(void*, int, void*)")
# 呼び出し: SetProtectedPolicy(PolicyGuid, PolicyValue, OldPolicyValue)
# PolicyGuid : GUID* -> "void*"
# PolicyValue : UINT_PTR -> "int"
# OldPolicyValue : UINT_PTR* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn SetProtectedPolicy(
    PolicyGuid: [*c]GUID, // GUID*
    PolicyValue: usize, // UINT_PTR
    OldPolicyValue: [*c]usize // UINT_PTR* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc SetProtectedPolicy(
    PolicyGuid: ptr GUID,  # GUID*
    PolicyValue: uint,  # UINT_PTR
    OldPolicyValue: ptr uint  # UINT_PTR* optional, out
): int32 {.importc: "SetProtectedPolicy", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetProtectedPolicy(
    GUID* PolicyGuid,   // GUID*
    size_t PolicyValue,   // UINT_PTR
    size_t* OldPolicyValue   // UINT_PTR* optional, out
);
ccall((:SetProtectedPolicy, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{GUID}, Csize_t, Ptr{Csize_t}),
      PolicyGuid, PolicyValue, OldPolicyValue)
# PolicyGuid : GUID* -> Ptr{GUID}
# PolicyValue : UINT_PTR -> Csize_t
# OldPolicyValue : UINT_PTR* optional, out -> Ptr{Csize_t}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetProtectedPolicy(
    void* PolicyGuid,
    uintptr_t PolicyValue,
    uintptr_t* OldPolicyValue);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetProtectedPolicy(PolicyGuid, PolicyValue, OldPolicyValue)
-- PolicyGuid : GUID*
-- PolicyValue : UINT_PTR
-- OldPolicyValue : UINT_PTR* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetProtectedPolicy = lib.func('__stdcall', 'SetProtectedPolicy', 'int32_t', ['void *', 'uintptr_t', 'uintptr_t *']);
// SetProtectedPolicy(PolicyGuid, PolicyValue, OldPolicyValue)
// PolicyGuid : GUID* -> 'void *'
// PolicyValue : UINT_PTR -> 'uintptr_t'
// OldPolicyValue : UINT_PTR* optional, out -> 'uintptr_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetProtectedPolicy: { parameters: ["pointer", "usize", "pointer"], result: "i32" },
});
// lib.symbols.SetProtectedPolicy(PolicyGuid, PolicyValue, OldPolicyValue)
// PolicyGuid : GUID* -> "pointer"
// PolicyValue : UINT_PTR -> "usize"
// OldPolicyValue : UINT_PTR* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetProtectedPolicy(
    void* PolicyGuid,
    size_t PolicyValue,
    size_t* OldPolicyValue);
C, "KERNEL32.dll");
// $ffi->SetProtectedPolicy(PolicyGuid, PolicyValue, OldPolicyValue);
// PolicyGuid : GUID*
// PolicyValue : UINT_PTR
// OldPolicyValue : UINT_PTR* optional, 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean SetProtectedPolicy(
        Pointer PolicyGuid,   // GUID*
        long PolicyValue,   // UINT_PTR
        LongByReference OldPolicyValue   // UINT_PTR* optional, out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetProtectedPolicy = SetProtectedPolicy(
    PolicyGuid : GUID*,   # GUID*
    PolicyValue : LibC::SizeT,   # UINT_PTR
    OldPolicyValue : LibC::SizeT*   # UINT_PTR* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetProtectedPolicyNative = Int32 Function(Pointer<Void>, UintPtr, Pointer<UintPtr>);
typedef SetProtectedPolicyDart = int Function(Pointer<Void>, int, Pointer<UintPtr>);
final SetProtectedPolicy = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetProtectedPolicyNative, SetProtectedPolicyDart>('SetProtectedPolicy');
// PolicyGuid : GUID* -> Pointer<Void>
// PolicyValue : UINT_PTR -> UintPtr
// OldPolicyValue : UINT_PTR* optional, out -> Pointer<UintPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetProtectedPolicy(
  PolicyGuid: PGUID;   // GUID*
  PolicyValue: NativeUInt;   // UINT_PTR
  OldPolicyValue: Pointer   // UINT_PTR* optional, out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetProtectedPolicy';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetProtectedPolicy"
  c_SetProtectedPolicy :: Ptr () -> CUIntPtr -> Ptr CUIntPtr -> IO CInt
-- PolicyGuid : GUID* -> Ptr ()
-- PolicyValue : UINT_PTR -> CUIntPtr
-- OldPolicyValue : UINT_PTR* optional, out -> Ptr CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setprotectedpolicy =
  foreign "SetProtectedPolicy"
    ((ptr void) @-> size_t @-> (ptr size_t) @-> returning int32_t)
(* PolicyGuid : GUID* -> (ptr void) *)
(* PolicyValue : UINT_PTR -> size_t *)
(* OldPolicyValue : UINT_PTR* optional, out -> (ptr size_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetProtectedPolicy" set-protected-policy :convention :stdcall) :int32
  (policy-guid :pointer)   ; GUID*
  (policy-value :uint64)   ; UINT_PTR
  (old-policy-value :pointer))   ; UINT_PTR* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetProtectedPolicy = Win32::API::More->new('KERNEL32',
    'BOOL SetProtectedPolicy(LPVOID PolicyGuid, WPARAM PolicyValue, LPVOID OldPolicyValue)');
# my $ret = $SetProtectedPolicy->Call($PolicyGuid, $PolicyValue, $OldPolicyValue);
# PolicyGuid : GUID* -> LPVOID
# PolicyValue : UINT_PTR -> WPARAM
# OldPolicyValue : UINT_PTR* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。