Win32 API 日本語リファレンス
ホームSecurity.Cryptography › NCryptQueryProtectionDescriptorName

NCryptQueryProtectionDescriptorName

関数
登録済み保護記述子名から記述子文字列を照会する。
DLLncrypt.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT NCryptQueryProtectionDescriptorName(
    LPCWSTR pwszName,
    LPWSTR pwszDescriptorString,   // optional
    UINT_PTR* pcDescriptorString,
    DWORD dwFlags
);

パラメーター

名前方向説明
pwszNameLPCWSTRin保護記述子の登録された表示名です。名前を登録するには、NCryptRegisterProtectionDescriptorName 関数を呼び出します。
pwszDescriptorStringLPWSTRoutoptional保護記述子のルールを格納する、null で終端された Unicode 文字列です。この関数を最初に呼び出す際には、この値を NULL に設定し、pcDescriptorString 引数が指す記述子文字列のサイズをゼロに設定します。詳細については「解説」を参照してください。
pcDescriptorStringUINT_PTR*inoutpwszDescriptorString パラメーターで取得される文字列の文字数を格納する変数へのポインターです。この関数を最初に呼び出す際には、変数をゼロに設定します。詳細については「解説」を参照してください。
dwFlagsDWORDin登録された名前を照会する対象のレジストリ ハイブを指定するフラグです。HKEY_CURRENT_USER ハイブを参照する場合はゼロを指定できます。または、NCRYPT_MACHINE_KEY_FLAG を指定して HKEY_LOCAL_MACHINE ハイブを照会することもできます。

戻り値の型: HRESULT

公式ドキュメント

登録された記述子の表示名に関連付けられた保護記述子のルール文字列を取得します。

戻り値

関数の成功または失敗を示すステータス コードを返します。返される可能性のあるコードには、以下が含まれますが、これらに限定されません。

戻り値 説明
ERROR_SUCCESS
関数は成功しました。
NTE_INVALID_PARAMETER
pwszName パラメーターを NULL にすることはできず、また、このパラメーターが指す値を空の文字列にすることもできません。
NTE_BAD_FLAGS
dwFlags パラメーターはゼロまたは NCRYPT_MACHINE_KEY_FLAG である必要があります。

解説(Remarks)

保護記述子のルール文字列を取得するには、この関数を 2 回呼び出す必要があります。最初の呼び出しでは、pwszDescriptorString 引数を NULL に設定し、pcDescriptorString 引数が指す値をゼロに設定します。最初の呼び出しでは、記述子文字列の文字数が取得されます。この数値を使用して文字列用のメモリを割り当て、割り当てたバッファーへのポインターを取得します。文字列を取得するには、そのポインターを使用して関数を再度呼び出します。

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

各言語での呼び出し定義

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

HRESULT NCryptQueryProtectionDescriptorName(
    LPCWSTR pwszName,
    LPWSTR pwszDescriptorString,   // optional
    UINT_PTR* pcDescriptorString,
    DWORD dwFlags
);
[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptQueryProtectionDescriptorName(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszDescriptorString,   // LPWSTR optional, out
    ref UIntPtr pcDescriptorString,   // UINT_PTR* in/out
    uint dwFlags   // DWORD
);
<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptQueryProtectionDescriptorName(
    <MarshalAs(UnmanagedType.LPWStr)> pwszName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pwszDescriptorString As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcDescriptorString As UIntPtr,   ' UINT_PTR* in/out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' pwszName : LPCWSTR
' pwszDescriptorString : LPWSTR optional, out
' pcDescriptorString : UINT_PTR* in/out
' dwFlags : DWORD
Declare PtrSafe Function NCryptQueryProtectionDescriptorName Lib "ncrypt" ( _
    ByVal pwszName As LongPtr, _
    ByVal pwszDescriptorString As LongPtr, _
    ByRef pcDescriptorString As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NCryptQueryProtectionDescriptorName = ctypes.windll.ncrypt.NCryptQueryProtectionDescriptorName
NCryptQueryProtectionDescriptorName.restype = ctypes.c_int
NCryptQueryProtectionDescriptorName.argtypes = [
    wintypes.LPCWSTR,  # pwszName : LPCWSTR
    wintypes.LPWSTR,  # pwszDescriptorString : LPWSTR optional, out
    ctypes.POINTER(ctypes.c_size_t),  # pcDescriptorString : UINT_PTR* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptQueryProtectionDescriptorName = Fiddle::Function.new(
  lib['NCryptQueryProtectionDescriptorName'],
  [
    Fiddle::TYPE_VOIDP,  # pwszName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pwszDescriptorString : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcDescriptorString : UINT_PTR* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "ncrypt")]
extern "system" {
    fn NCryptQueryProtectionDescriptorName(
        pwszName: *const u16,  // LPCWSTR
        pwszDescriptorString: *mut u16,  // LPWSTR optional, out
        pcDescriptorString: *mut usize,  // UINT_PTR* in/out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptQueryProtectionDescriptorName([MarshalAs(UnmanagedType.LPWStr)] string pwszName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszDescriptorString, ref UIntPtr pcDescriptorString, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptQueryProtectionDescriptorName' -Namespace Win32 -PassThru
# $api::NCryptQueryProtectionDescriptorName(pwszName, pwszDescriptorString, pcDescriptorString, dwFlags)
#uselib "ncrypt.dll"
#func global NCryptQueryProtectionDescriptorName "NCryptQueryProtectionDescriptorName" sptr, sptr, sptr, sptr
; NCryptQueryProtectionDescriptorName pwszName, varptr(pwszDescriptorString), varptr(pcDescriptorString), dwFlags   ; 戻り値は stat
; pwszName : LPCWSTR -> "sptr"
; pwszDescriptorString : LPWSTR optional, out -> "sptr"
; pcDescriptorString : UINT_PTR* in/out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ncrypt.dll"
#cfunc global NCryptQueryProtectionDescriptorName "NCryptQueryProtectionDescriptorName" wstr, var, var, int
; res = NCryptQueryProtectionDescriptorName(pwszName, pwszDescriptorString, pcDescriptorString, dwFlags)
; pwszName : LPCWSTR -> "wstr"
; pwszDescriptorString : LPWSTR optional, out -> "var"
; pcDescriptorString : UINT_PTR* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT NCryptQueryProtectionDescriptorName(LPCWSTR pwszName, LPWSTR pwszDescriptorString, UINT_PTR* pcDescriptorString, DWORD dwFlags)
#uselib "ncrypt.dll"
#cfunc global NCryptQueryProtectionDescriptorName "NCryptQueryProtectionDescriptorName" wstr, var, var, int
; res = NCryptQueryProtectionDescriptorName(pwszName, pwszDescriptorString, pcDescriptorString, dwFlags)
; pwszName : LPCWSTR -> "wstr"
; pwszDescriptorString : LPWSTR optional, out -> "var"
; pcDescriptorString : UINT_PTR* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ncrypt = windows.NewLazySystemDLL("ncrypt.dll")
	procNCryptQueryProtectionDescriptorName = ncrypt.NewProc("NCryptQueryProtectionDescriptorName")
)

// pwszName (LPCWSTR), pwszDescriptorString (LPWSTR optional, out), pcDescriptorString (UINT_PTR* in/out), dwFlags (DWORD)
r1, _, err := procNCryptQueryProtectionDescriptorName.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszName))),
	uintptr(pwszDescriptorString),
	uintptr(pcDescriptorString),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function NCryptQueryProtectionDescriptorName(
  pwszName: PWideChar;   // LPCWSTR
  pwszDescriptorString: PWideChar;   // LPWSTR optional, out
  pcDescriptorString: Pointer;   // UINT_PTR* in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ncrypt.dll' name 'NCryptQueryProtectionDescriptorName';
result := DllCall("ncrypt\NCryptQueryProtectionDescriptorName"
    , "WStr", pwszName   ; LPCWSTR
    , "Ptr", pwszDescriptorString   ; LPWSTR optional, out
    , "Ptr", pcDescriptorString   ; UINT_PTR* in/out
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: HRESULT
●NCryptQueryProtectionDescriptorName(pwszName, pwszDescriptorString, pcDescriptorString, dwFlags) = DLL("ncrypt.dll", "int NCryptQueryProtectionDescriptorName(char*, char*, void*, dword)")
# 呼び出し: NCryptQueryProtectionDescriptorName(pwszName, pwszDescriptorString, pcDescriptorString, dwFlags)
# pwszName : LPCWSTR -> "char*"
# pwszDescriptorString : LPWSTR optional, out -> "char*"
# pcDescriptorString : UINT_PTR* in/out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef NCryptQueryProtectionDescriptorNameNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<UintPtr>, Uint32);
typedef NCryptQueryProtectionDescriptorNameDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<UintPtr>, int);
final NCryptQueryProtectionDescriptorName = DynamicLibrary.open('ncrypt.dll')
    .lookupFunction<NCryptQueryProtectionDescriptorNameNative, NCryptQueryProtectionDescriptorNameDart>('NCryptQueryProtectionDescriptorName');
// pwszName : LPCWSTR -> Pointer<Utf16>
// pwszDescriptorString : LPWSTR optional, out -> Pointer<Utf16>
// pcDescriptorString : UINT_PTR* in/out -> Pointer<UintPtr>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NCryptQueryProtectionDescriptorName(
  pwszName: PWideChar;   // LPCWSTR
  pwszDescriptorString: PWideChar;   // LPWSTR optional, out
  pcDescriptorString: Pointer;   // UINT_PTR* in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ncrypt.dll' name 'NCryptQueryProtectionDescriptorName';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NCryptQueryProtectionDescriptorName"
  c_NCryptQueryProtectionDescriptorName :: CWString -> CWString -> Ptr CUIntPtr -> Word32 -> IO Int32
-- pwszName : LPCWSTR -> CWString
-- pwszDescriptorString : LPWSTR optional, out -> CWString
-- pcDescriptorString : UINT_PTR* in/out -> Ptr CUIntPtr
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ncryptqueryprotectiondescriptorname =
  foreign "NCryptQueryProtectionDescriptorName"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr size_t) @-> uint32_t @-> returning int32_t)
(* pwszName : LPCWSTR -> (ptr uint16_t) *)
(* pwszDescriptorString : LPWSTR optional, out -> (ptr uint16_t) *)
(* pcDescriptorString : UINT_PTR* in/out -> (ptr size_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ncrypt (t "ncrypt.dll"))
(cffi:use-foreign-library ncrypt)

(cffi:defcfun ("NCryptQueryProtectionDescriptorName" ncrypt-query-protection-descriptor-name :convention :stdcall) :int32
  (pwsz-name (:string :encoding :utf-16le))   ; LPCWSTR
  (pwsz-descriptor-string :pointer)   ; LPWSTR optional, out
  (pc-descriptor-string :pointer)   ; UINT_PTR* in/out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NCryptQueryProtectionDescriptorName = Win32::API::More->new('ncrypt',
    'int NCryptQueryProtectionDescriptorName(LPCWSTR pwszName, LPWSTR pwszDescriptorString, LPVOID pcDescriptorString, DWORD dwFlags)');
# my $ret = $NCryptQueryProtectionDescriptorName->Call($pwszName, $pwszDescriptorString, $pcDescriptorString, $dwFlags);
# pwszName : LPCWSTR -> LPCWSTR
# pwszDescriptorString : LPWSTR optional, out -> LPWSTR
# pcDescriptorString : UINT_PTR* in/out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目