Win32 API 日本語リファレンス
ホーム › Security.Authentication.Identity › QueryCredentialsAttributesW

QueryCredentialsAttributesW

関数
資格情報ハンドルの属性情報を取得する(Unicode版)。
DLLSECUR32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SECUR32.dll  (Unicode / -W)
#include <windows.h>

HRESULT QueryCredentialsAttributesW(
    SecHandle* phCredential,
    DWORD ulAttribute,
    void* pBuffer
);

パラメーター

名前型方向説明
phCredentialSecHandle*in照会する資格情報のハンドル。
ulAttributeDWORDin

照会する属性を指定します。このパラメーターには、次の属性のいずれかを指定できます。

値 意味
SECPKG_CRED_ATTR_CERT
SecPkgCredentials_Cert 型の pbuffer に証明書のサムプリントを返します。

この属性は Kerberos でのみサポートされます。

Windows Server 2008 R2、Windows 7、Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この属性は使用できません。

SECPKG_CRED_ATTR_NAMES
SecPkgCredentials_Names 型の pbuffer に資格情報の名前を返します。

この属性は、WOW64 モードの Schannel ではサポートされません。

SECPKG_ATTR_SUPPORTED_ALGS
SecPkgCred_SupportedAlgs 型の pbuffer に、サポートされているアルゴリズムを返します。指定した証明書でサポートされているかどうか、またはローカルコンピューターで有効になっているかどうかに関係なく、サポートされているすべてのアルゴリズムが含まれます。

この属性は Schannel でのみサポートされます。

SECPKG_ATTR_CIPHER_STRENGTHS
SecPkgCred_CipherStrengths 型の pbuffer に暗号強度を返します。

この属性は Schannel でのみサポートされます。

SECPKG_ATTR_SUPPORTED_PROTOCOLS
SecPkgCred_SupportedProtocols 型の pbuffer に、サポートされているアルゴリズムを返します。指定した証明書でサポートされているかどうか、またはローカルコンピューターで有効になっているかどうかに関係なく、サポートされているすべてのプロトコルが含まれます。

この属性は Schannel でのみサポートされます。

pBuffervoid*inout要求した属性を受け取るバッファーへのポインター。返される構造体の型は ulAttribute の値によって異なります。

戻り値の型: HRESULT

公式ドキュメント

資格情報に関連付けられた名前など、資格情報の属性を取得します。(Unicode)

戻り値

関数が成功した場合、戻り値は SEC_E_OK です。

関数が失敗した場合、戻り値は次のエラーコードのいずれかになります。

戻り値 説明
SEC_E_INVALID_HANDLE
関数に渡されたハンドルが有効ではありません。
SEC_E_UNSUPPORTED_FUNCTION
指定された属性は Schannel でサポートされていません。この戻り値は、Schannel SSP が使用されている場合にのみ返されます。
SEC_E_INSUFFICIENT_MEMORY
要求を完了するために使用できるメモリが不足しています。

解説(Remarks)

QueryCredentialsAttributes 関数を使用すると、アプリケーションは、指定した資格情報に関連付けられた名前をはじめとする、資格情報のいくつかの特性を判別できます。

SECPKG_ATTR_CIPHER_STRENGTHS 属性を照会すると、 SecPkgCred_CipherStrengths 構造体が返されます。この構造体の暗号強度は、資格情報の作成時に使用された SCH_CREDENTIALS 構造体の暗号強度と同じです。

メモ アプリケーションは、既定の資格情報でこの属性を照会することにより、システムの既定の暗号強度を調べることができます。既定の資格情報は、pAuthData パラメーターに NULL を指定して AcquireCredentialsHandle を呼び出すことで作成されます。
SECPKG_ATTR_SUPPORTED_ALGS 属性を照会すると、 SecPkgCred_SupportedAlgs 構造体が返されます。この構造体に含まれるアルゴリズムは、資格情報の作成時に使用された SCH_CREDENTIALS 構造体で示されたものと互換性があります。

SECPKG_ATTR_SUPPORTED_PROTOCOLS 属性を照会すると、 SecPkgCred_SupportedProtocols 構造体が返されます。この構造体には、SCH_CREDENTIALS 構造体の grbitEnabledProtocols フィールドと互換性のあるビット配列が含まれます。

pBuffer パラメーターが指す構造体は、呼び出し元が割り当てる必要があります。pBuffer 構造体で返されるポインターのバッファーは、セキュリティパッケージが割り当てます。呼び出し元は、 FreeContextBuffer 関数を呼び出して、セキュリティパッケージが割り当てたポインターを解放できます。

メモ

sspi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして QueryCredentialsAttributes を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーの原因となる可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

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

各言語での呼び出し定義

// SECUR32.dll  (Unicode / -W)
#include <windows.h>

HRESULT QueryCredentialsAttributesW(
    SecHandle* phCredential,
    DWORD ulAttribute,
    void* pBuffer
);
[DllImport("SECUR32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int QueryCredentialsAttributesW(
    IntPtr phCredential,   // SecHandle*
    uint ulAttribute,   // DWORD
    IntPtr pBuffer   // void* in/out
);
<DllImport("SECUR32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function QueryCredentialsAttributesW(
    phCredential As IntPtr,   ' SecHandle*
    ulAttribute As UInteger,   ' DWORD
    pBuffer As IntPtr   ' void* in/out
) As Integer
End Function
' phCredential : SecHandle*
' ulAttribute : DWORD
' pBuffer : void* in/out
Declare PtrSafe Function QueryCredentialsAttributesW Lib "secur32" ( _
    ByVal phCredential As LongPtr, _
    ByVal ulAttribute As Long, _
    ByVal pBuffer As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

QueryCredentialsAttributesW = ctypes.windll.secur32.QueryCredentialsAttributesW
QueryCredentialsAttributesW.restype = ctypes.c_int
QueryCredentialsAttributesW.argtypes = [
    ctypes.c_void_p,  # phCredential : SecHandle*
    wintypes.DWORD,  # ulAttribute : DWORD
    ctypes.POINTER(None),  # pBuffer : void* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SECUR32.dll')
QueryCredentialsAttributesW = Fiddle::Function.new(
  lib['QueryCredentialsAttributesW'],
  [
    Fiddle::TYPE_VOIDP,  # phCredential : SecHandle*
    -Fiddle::TYPE_INT,  # ulAttribute : DWORD
    Fiddle::TYPE_VOIDP,  # pBuffer : void* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "secur32")]
extern "system" {
    fn QueryCredentialsAttributesW(
        phCredential: *mut SecHandle,  // SecHandle*
        ulAttribute: u32,  // DWORD
        pBuffer: *mut ()  // void* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SECUR32.dll", CharSet = CharSet.Unicode)]
public static extern int QueryCredentialsAttributesW(IntPtr phCredential, uint ulAttribute, IntPtr pBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SECUR32_QueryCredentialsAttributesW' -Namespace Win32 -PassThru
# $api::QueryCredentialsAttributesW(phCredential, ulAttribute, pBuffer)
#uselib "SECUR32.dll"
#func global QueryCredentialsAttributesW "QueryCredentialsAttributesW" wptr, wptr, wptr
; QueryCredentialsAttributesW varptr(phCredential), ulAttribute, pBuffer   ; 戻り値は stat
; phCredential : SecHandle* -> "wptr"
; ulAttribute : DWORD -> "wptr"
; pBuffer : void* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SECUR32.dll"
#cfunc global QueryCredentialsAttributesW "QueryCredentialsAttributesW" var, int, sptr
; res = QueryCredentialsAttributesW(phCredential, ulAttribute, pBuffer)
; phCredential : SecHandle* -> "var"
; ulAttribute : DWORD -> "int"
; pBuffer : void* in/out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT QueryCredentialsAttributesW(SecHandle* phCredential, DWORD ulAttribute, void* pBuffer)
#uselib "SECUR32.dll"
#cfunc global QueryCredentialsAttributesW "QueryCredentialsAttributesW" var, int, intptr
; res = QueryCredentialsAttributesW(phCredential, ulAttribute, pBuffer)
; phCredential : SecHandle* -> "var"
; ulAttribute : DWORD -> "int"
; pBuffer : void* in/out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	secur32 = windows.NewLazySystemDLL("SECUR32.dll")
	procQueryCredentialsAttributesW = secur32.NewProc("QueryCredentialsAttributesW")
)

// phCredential (SecHandle*), ulAttribute (DWORD), pBuffer (void* in/out)
r1, _, err := procQueryCredentialsAttributesW.Call(
	uintptr(phCredential),
	uintptr(ulAttribute),
	uintptr(pBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function QueryCredentialsAttributesW(
  phCredential: Pointer;   // SecHandle*
  ulAttribute: DWORD;   // DWORD
  pBuffer: Pointer   // void* in/out
): Integer; stdcall;
  external 'SECUR32.dll' name 'QueryCredentialsAttributesW';
result := DllCall("SECUR32\QueryCredentialsAttributesW"
    , "Ptr", phCredential   ; SecHandle*
    , "UInt", ulAttribute   ; DWORD
    , "Ptr", pBuffer   ; void* in/out
    , "Int")   ; return: HRESULT
●QueryCredentialsAttributesW(phCredential, ulAttribute, pBuffer) = DLL("SECUR32.dll", "int QueryCredentialsAttributesW(void*, dword, void*)")
# 呼び出し: QueryCredentialsAttributesW(phCredential, ulAttribute, pBuffer)
# phCredential : SecHandle* -> "void*"
# ulAttribute : DWORD -> "dword"
# pBuffer : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "secur32" fn QueryCredentialsAttributesW(
    phCredential: [*c]SecHandle, // SecHandle*
    ulAttribute: u32, // DWORD
    pBuffer: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc QueryCredentialsAttributesW(
    phCredential: ptr SecHandle,  # SecHandle*
    ulAttribute: uint32,  # DWORD
    pBuffer: pointer  # void* in/out
): int32 {.importc: "QueryCredentialsAttributesW", stdcall, dynlib: "SECUR32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "secur32");
extern(Windows)
int QueryCredentialsAttributesW(
    SecHandle* phCredential,   // SecHandle*
    uint ulAttribute,   // DWORD
    void* pBuffer   // void* in/out
);
ccall((:QueryCredentialsAttributesW, "SECUR32.dll"), stdcall, Int32,
      (Ptr{SecHandle}, UInt32, Ptr{Cvoid}),
      phCredential, ulAttribute, pBuffer)
# phCredential : SecHandle* -> Ptr{SecHandle}
# ulAttribute : DWORD -> UInt32
# pBuffer : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t QueryCredentialsAttributesW(
    void* phCredential,
    uint32_t ulAttribute,
    void* pBuffer);
]]
local secur32 = ffi.load("secur32")
-- secur32.QueryCredentialsAttributesW(phCredential, ulAttribute, pBuffer)
-- phCredential : SecHandle*
-- ulAttribute : DWORD
-- pBuffer : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SECUR32.dll');
const QueryCredentialsAttributesW = lib.func('__stdcall', 'QueryCredentialsAttributesW', 'int32_t', ['void *', 'uint32_t', 'void *']);
// QueryCredentialsAttributesW(phCredential, ulAttribute, pBuffer)
// phCredential : SecHandle* -> 'void *'
// ulAttribute : DWORD -> 'uint32_t'
// pBuffer : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SECUR32.dll", {
  QueryCredentialsAttributesW: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.QueryCredentialsAttributesW(phCredential, ulAttribute, pBuffer)
// phCredential : SecHandle* -> "pointer"
// ulAttribute : DWORD -> "u32"
// pBuffer : void* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t QueryCredentialsAttributesW(
    void* phCredential,
    uint32_t ulAttribute,
    void* pBuffer);
C, "SECUR32.dll");
// $ffi->QueryCredentialsAttributesW(phCredential, ulAttribute, pBuffer);
// phCredential : SecHandle*
// ulAttribute : DWORD
// pBuffer : void* in/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 Secur32 extends StdCallLibrary {
    Secur32 INSTANCE = Native.load("secur32", Secur32.class, W32APIOptions.UNICODE_OPTIONS);
    int QueryCredentialsAttributesW(
        Pointer phCredential,   // SecHandle*
        int ulAttribute,   // DWORD
        Pointer pBuffer   // void* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("secur32")]
lib LibSECUR32
  fun QueryCredentialsAttributesW = QueryCredentialsAttributesW(
    phCredential : SecHandle*,   # SecHandle*
    ulAttribute : UInt32,   # DWORD
    pBuffer : Void*   # void* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef QueryCredentialsAttributesWNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef QueryCredentialsAttributesWDart = int Function(Pointer<Void>, int, Pointer<Void>);
final QueryCredentialsAttributesW = DynamicLibrary.open('SECUR32.dll')
    .lookupFunction<QueryCredentialsAttributesWNative, QueryCredentialsAttributesWDart>('QueryCredentialsAttributesW');
// phCredential : SecHandle* -> Pointer<Void>
// ulAttribute : DWORD -> Uint32
// pBuffer : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function QueryCredentialsAttributesW(
  phCredential: Pointer;   // SecHandle*
  ulAttribute: DWORD;   // DWORD
  pBuffer: Pointer   // void* in/out
): Integer; stdcall;
  external 'SECUR32.dll' name 'QueryCredentialsAttributesW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "QueryCredentialsAttributesW"
  c_QueryCredentialsAttributesW :: Ptr () -> Word32 -> Ptr () -> IO Int32
-- phCredential : SecHandle* -> Ptr ()
-- ulAttribute : DWORD -> Word32
-- pBuffer : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let querycredentialsattributesw =
  foreign "QueryCredentialsAttributesW"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* phCredential : SecHandle* -> (ptr void) *)
(* ulAttribute : DWORD -> uint32_t *)
(* pBuffer : void* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library secur32 (t "SECUR32.dll"))
(cffi:use-foreign-library secur32)

(cffi:defcfun ("QueryCredentialsAttributesW" query-credentials-attributes-w :convention :stdcall) :int32
  (ph-credential :pointer)   ; SecHandle*
  (ul-attribute :uint32)   ; DWORD
  (p-buffer :pointer))   ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $QueryCredentialsAttributesW = Win32::API::More->new('SECUR32',
    'int QueryCredentialsAttributesW(LPVOID phCredential, DWORD ulAttribute, LPVOID pBuffer)');
# my $ret = $QueryCredentialsAttributesW->Call($phCredential, $ulAttribute, $pBuffer);
# phCredential : SecHandle* -> LPVOID
# ulAttribute : DWORD -> DWORD
# pBuffer : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型