ホーム › Security.Cryptography › CryptContextAddRef

CryptContextAddRef

関数

暗号プロバイダーコンテキストの参照カウントを増やす。

DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CryptContextAddRef(
    UINT_PTR hProv,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
hProv	UINT_PTR	in	HCRYPTPROV ハンドル。このハンドルの参照カウントがインクリメントされます。このハンドルは、あらかじめ CryptAcquireContext を使用して作成されている必要があります。
pdwReserved	DWORD*	optional	将来の使用のために予約されており、NULL を指定する必要があります。
dwFlags	DWORD	in	将来の使用のために予約されており、ゼロを指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

HCRYPTPROV 暗号化サービスプロバイダー (CSP) ハンドルの参照カウントを 1 つ増やします。

戻り値

関数が成功した場合、戻り値は 0 以外 (TRUE) です。

関数が失敗した場合、戻り値は 0 (FALSE) です。拡張エラー情報を取得するには、 GetLastError を呼び出します。考えられるエラーコードの 1 つを次に示します。

戻り値	説明
ERROR_INVALID_PARAMETER	いずれかのパラメーターに有効でない値が含まれています。これは多くの場合、有効でないポインターです。

解説(Remarks)

この関数は HCRYPTPROV ハンドルの参照カウントを増やすため、ハンドルを実際に解放するには CryptReleaseContext を複数回呼び出す必要があります。

例

次の例では、取得済みの CSP ハンドルの参照カウントをインクリメントします。

//--------------------------------------------------------------------
// hCryptProv is a HCRYPTPROV variable that was previously acquired
// by using CryptAcquireContext or CryptAcquireCertificatePrivateKey.

if(CryptContextAddRef(
       hCryptProv, 
       NULL, 
       0)) 
{
    printf("CryptContextAddRef succeeded. \n");
}
else
{
   printf("Error during CryptContextAddRef!\n");
   exit(1);
}
//--------------------------------------------------------------------
//  The reference count on hCryptProv is now greater than one. The 
//  first call to CryptReleaseContext will not release the provider 
//  handle. A second call to CryptReleaseContext would be needed to 
//  release the context.

この関数を使用する別の例については、例: CryptAcquireContext を使用する C プログラムを参照してください。

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

各言語での呼び出し定義

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

BOOL CryptContextAddRef(
    UINT_PTR hProv,
    DWORD* pdwReserved,   // optional
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptContextAddRef(
    UIntPtr hProv,   // UINT_PTR
    IntPtr pdwReserved,   // DWORD* optional
    uint dwFlags   // DWORD
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptContextAddRef(
    hProv As UIntPtr,   ' UINT_PTR
    pdwReserved As IntPtr,   ' DWORD* optional
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProv : UINT_PTR
' pdwReserved : DWORD* optional
' dwFlags : DWORD
Declare PtrSafe Function CryptContextAddRef Lib "advapi32" ( _
    ByVal hProv As LongPtr, _
    ByVal pdwReserved 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

CryptContextAddRef = ctypes.windll.advapi32.CryptContextAddRef
CryptContextAddRef.restype = wintypes.BOOL
CryptContextAddRef.argtypes = [
    ctypes.c_size_t,  # hProv : UINT_PTR
    ctypes.POINTER(wintypes.DWORD),  # pdwReserved : DWORD* optional
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptContextAddRef = Fiddle::Function.new(
  lib['CryptContextAddRef'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hProv : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pdwReserved : DWORD* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CryptContextAddRef(
        hProv: usize,  // UINT_PTR
        pdwReserved: *mut u32,  // DWORD* optional
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool CryptContextAddRef(UIntPtr hProv, IntPtr pdwReserved, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptContextAddRef' -Namespace Win32 -PassThru
# $api::CryptContextAddRef(hProv, pdwReserved, dwFlags)

#uselib "ADVAPI32.dll"
#func global CryptContextAddRef "CryptContextAddRef" sptr, sptr, sptr
; CryptContextAddRef hProv, varptr(pdwReserved), dwFlags   ; 戻り値は stat
; hProv : UINT_PTR -> "sptr"
; pdwReserved : DWORD* optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CryptContextAddRef "CryptContextAddRef" sptr, var, int
; res = CryptContextAddRef(hProv, pdwReserved, dwFlags)
; hProv : UINT_PTR -> "sptr"
; pdwReserved : DWORD* optional -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CryptContextAddRef "CryptContextAddRef" sptr, sptr, int
; res = CryptContextAddRef(hProv, varptr(pdwReserved), dwFlags)
; hProv : UINT_PTR -> "sptr"
; pdwReserved : DWORD* optional -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。