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

CryptDestroyHash

関数
ハッシュオブジェクトを破棄する。
DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CryptDestroyHash(
    UINT_PTR hHash
);

パラメーター

名前方向説明
hHashUINT_PTRin破棄するハッシュオブジェクトのハンドル。

戻り値の型: BOOL

公式ドキュメント

hHash パラメーターによって参照されるハッシュオブジェクトを破棄します。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

"NTE" で始まるエラーコードは、使用している特定の cryptographic service provider(CSP)によって生成されます。考えられるエラーコードの一部を次に示します。

戻り値 説明
ERROR_BUSY
hHash で指定されたハッシュオブジェクトは現在使用中であり、破棄できません。
ERROR_INVALID_HANDLE
hHash パラメーターが指定するハンドルが無効です。
ERROR_INVALID_PARAMETER
hHash パラメーターに無効な値が含まれています。
NTE_BAD_ALGID
hHash ハンドルが、この CSP がサポートしていないアルゴリズムを指定しています。
NTE_BAD_HASH
hHash パラメーターで指定されたハッシュオブジェクトが無効です。
NTE_BAD_UID
ハッシュオブジェクトの作成時に指定された CSP コンテキストが見つかりません。

解説(Remarks)

ハッシュオブジェクトが破棄されると、多くの CSP は、ハッシュオブジェクトが保持されていた CSP 内のメモリを上書きします。その後、CSP のメモリは解放されます。

CryptCreateHash の呼び出しと CryptDestroyHash の呼び出しは、1 対 1 で対応している必要があります。

特定の CSP を使用して作成されたすべてのハッシュオブジェクトは、CryptReleaseContext 関数でその CSP ハンドルを解放する前に破棄する必要があります。

使用例

CryptDestroyHash 関数を使用する例については、Example C Program: Creating and Hashing a Session Key を参照してください。

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

各言語での呼び出し定義

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

BOOL CryptDestroyHash(
    UINT_PTR hHash
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CryptDestroyHash(
    UIntPtr hHash   // UINT_PTR
);
<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptDestroyHash(
    hHash As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hHash : UINT_PTR
Declare PtrSafe Function CryptDestroyHash Lib "advapi32" ( _
    ByVal hHash As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CryptDestroyHash = ctypes.windll.advapi32.CryptDestroyHash
CryptDestroyHash.restype = wintypes.BOOL
CryptDestroyHash.argtypes = [
    ctypes.c_size_t,  # hHash : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptDestroyHash = Fiddle::Function.new(
  lib['CryptDestroyHash'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hHash : UINT_PTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn CryptDestroyHash(
        hHash: usize  // UINT_PTR
    ) -> 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 CryptDestroyHash(UIntPtr hHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptDestroyHash' -Namespace Win32 -PassThru
# $api::CryptDestroyHash(hHash)
#uselib "ADVAPI32.dll"
#func global CryptDestroyHash "CryptDestroyHash" sptr
; CryptDestroyHash hHash   ; 戻り値は stat
; hHash : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global CryptDestroyHash "CryptDestroyHash" sptr
; res = CryptDestroyHash(hHash)
; hHash : UINT_PTR -> "sptr"
; BOOL CryptDestroyHash(UINT_PTR hHash)
#uselib "ADVAPI32.dll"
#cfunc global CryptDestroyHash "CryptDestroyHash" intptr
; res = CryptDestroyHash(hHash)
; hHash : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procCryptDestroyHash = advapi32.NewProc("CryptDestroyHash")
)

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

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

typedef CryptDestroyHashNative = Int32 Function(UintPtr);
typedef CryptDestroyHashDart = int Function(int);
final CryptDestroyHash = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<CryptDestroyHashNative, CryptDestroyHashDart>('CryptDestroyHash');
// hHash : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CryptDestroyHash(
  hHash: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CryptDestroyHash';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CryptDestroyHash"
  c_CryptDestroyHash :: CUIntPtr -> IO CInt
-- hHash : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cryptdestroyhash =
  foreign "CryptDestroyHash"
    (size_t @-> returning int32_t)
(* hHash : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("CryptDestroyHash" crypt-destroy-hash :convention :stdcall) :int32
  (h-hash :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CryptDestroyHash = Win32::API::More->new('ADVAPI32',
    'BOOL CryptDestroyHash(WPARAM hHash)');
# my $ret = $CryptDestroyHash->Call($hHash);
# hHash : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目