ホーム › Security.Cryptography › NCryptGetProtectionDescriptorInfo

NCryptGetProtectionDescriptorInfo

関数

保護記述子ハンドルから情報を取得する。

DLLncrypt.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT NCryptGetProtectionDescriptorInfo(
    NCRYPT_DESCRIPTOR_HANDLE hDescriptor,
    const NCRYPT_ALLOC_PARA* pMemPara,   // optional
    DWORD dwInfoType,
    void** ppvInfo
);

パラメーター

名前

型

方向

説明

hDescriptor

NCRYPT_DESCRIPTOR_HANDLE

NCryptCreateProtectionDescriptor を呼び出して作成した保護記述子ハンドルです。

pMemPara

NCRYPT_ALLOC_PARA*

inoptional

カスタムのメモリ管理関数を指定するために使用できる NCRYPT_ALLOC_PARA 構造体へのポインターです。この引数を NULL に設定した場合、メモリの割り当てには内部的に LocalAlloc 関数が使用され、アプリケーションは ppvInfo パラメーターが指すメモリを解放するために LocalFree を呼び出す必要があります。

dwInfoType

DWORD

記述子の情報を ppvInfo パラメーターにどのように返すかを指定します。次の値を指定できます。

値	意味
NCRYPT_PROTECTION_INFO_TYPE_DESCRIPTOR_STRING	ppvInfo 引数に記述子のルール文字列が返されます。

ppvInfo

void**

out

記述子の情報へのポインターです。

戻り値の型: HRESULT

公式ドキュメント

保護記述子のルール文字列を取得します。

戻り値

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

戻り値	説明
ERROR_SUCCESS	関数は成功しました。
NTE_INVALID_PARAMETER	ppvInfo パラメーターを NULL にすることはできません。
NTE_NOT_SUPPORTED	dwInfoType パラメーターにサポートされていない値が指定されました。
NTE_INVALID_HANDLE	hDescriptor パラメーターで指定されたハンドルが無効です。

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

各言語での呼び出し定義

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

HRESULT NCryptGetProtectionDescriptorInfo(
    NCRYPT_DESCRIPTOR_HANDLE hDescriptor,
    const NCRYPT_ALLOC_PARA* pMemPara,   // optional
    DWORD dwInfoType,
    void** ppvInfo
);

[DllImport("ncrypt.dll", ExactSpelling = true)]
static extern int NCryptGetProtectionDescriptorInfo(
    IntPtr hDescriptor,   // NCRYPT_DESCRIPTOR_HANDLE
    IntPtr pMemPara,   // NCRYPT_ALLOC_PARA* optional
    uint dwInfoType,   // DWORD
    IntPtr ppvInfo   // void** out
);

<DllImport("ncrypt.dll", ExactSpelling:=True)>
Public Shared Function NCryptGetProtectionDescriptorInfo(
    hDescriptor As IntPtr,   ' NCRYPT_DESCRIPTOR_HANDLE
    pMemPara As IntPtr,   ' NCRYPT_ALLOC_PARA* optional
    dwInfoType As UInteger,   ' DWORD
    ppvInfo As IntPtr   ' void** out
) As Integer
End Function

' hDescriptor : NCRYPT_DESCRIPTOR_HANDLE
' pMemPara : NCRYPT_ALLOC_PARA* optional
' dwInfoType : DWORD
' ppvInfo : void** out
Declare PtrSafe Function NCryptGetProtectionDescriptorInfo Lib "ncrypt" ( _
    ByVal hDescriptor As LongPtr, _
    ByVal pMemPara As LongPtr, _
    ByVal dwInfoType As Long, _
    ByVal ppvInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NCryptGetProtectionDescriptorInfo = ctypes.windll.ncrypt.NCryptGetProtectionDescriptorInfo
NCryptGetProtectionDescriptorInfo.restype = ctypes.c_int
NCryptGetProtectionDescriptorInfo.argtypes = [
    wintypes.HANDLE,  # hDescriptor : NCRYPT_DESCRIPTOR_HANDLE
    ctypes.c_void_p,  # pMemPara : NCRYPT_ALLOC_PARA* optional
    wintypes.DWORD,  # dwInfoType : DWORD
    ctypes.c_void_p,  # ppvInfo : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ncrypt.dll')
NCryptGetProtectionDescriptorInfo = Fiddle::Function.new(
  lib['NCryptGetProtectionDescriptorInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hDescriptor : NCRYPT_DESCRIPTOR_HANDLE
    Fiddle::TYPE_VOIDP,  # pMemPara : NCRYPT_ALLOC_PARA* optional
    -Fiddle::TYPE_INT,  # dwInfoType : DWORD
    Fiddle::TYPE_VOIDP,  # ppvInfo : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ncrypt")]
extern "system" {
    fn NCryptGetProtectionDescriptorInfo(
        hDescriptor: *mut core::ffi::c_void,  // NCRYPT_DESCRIPTOR_HANDLE
        pMemPara: *const NCRYPT_ALLOC_PARA,  // NCRYPT_ALLOC_PARA* optional
        dwInfoType: u32,  // DWORD
        ppvInfo: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ncrypt.dll")]
public static extern int NCryptGetProtectionDescriptorInfo(IntPtr hDescriptor, IntPtr pMemPara, uint dwInfoType, IntPtr ppvInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ncrypt_NCryptGetProtectionDescriptorInfo' -Namespace Win32 -PassThru
# $api::NCryptGetProtectionDescriptorInfo(hDescriptor, pMemPara, dwInfoType, ppvInfo)

#uselib "ncrypt.dll"
#func global NCryptGetProtectionDescriptorInfo "NCryptGetProtectionDescriptorInfo" sptr, sptr, sptr, sptr
; NCryptGetProtectionDescriptorInfo hDescriptor, varptr(pMemPara), dwInfoType, ppvInfo   ; 戻り値は stat
; hDescriptor : NCRYPT_DESCRIPTOR_HANDLE -> "sptr"
; pMemPara : NCRYPT_ALLOC_PARA* optional -> "sptr"
; dwInfoType : DWORD -> "sptr"
; ppvInfo : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ncrypt.dll"
#cfunc global NCryptGetProtectionDescriptorInfo "NCryptGetProtectionDescriptorInfo" sptr, var, int, sptr
; res = NCryptGetProtectionDescriptorInfo(hDescriptor, pMemPara, dwInfoType, ppvInfo)
; hDescriptor : NCRYPT_DESCRIPTOR_HANDLE -> "sptr"
; pMemPara : NCRYPT_ALLOC_PARA* optional -> "var"
; dwInfoType : DWORD -> "int"
; ppvInfo : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ncrypt.dll"
#cfunc global NCryptGetProtectionDescriptorInfo "NCryptGetProtectionDescriptorInfo" sptr, sptr, int, sptr
; res = NCryptGetProtectionDescriptorInfo(hDescriptor, varptr(pMemPara), dwInfoType, ppvInfo)
; hDescriptor : NCRYPT_DESCRIPTOR_HANDLE -> "sptr"
; pMemPara : NCRYPT_ALLOC_PARA* optional -> "sptr"
; dwInfoType : DWORD -> "int"
; ppvInfo : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。