ホーム › Security.Credentials › CredGetTargetInfoW

CredGetTargetInfoW

関数

対象名に関連付けられた対象情報を取得する。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CredGetTargetInfoW(
    LPCWSTR TargetName,
    DWORD Flags,
    CREDENTIAL_TARGET_INFORMATIONW** TargetInfo
);

パラメーター

名前	型	方向	説明
TargetName	LPCWSTR	in	情報を取得する対象となるターゲットコンピューターの名前を含む、null 終端文字列へのポインターです。
Flags	DWORD	in	関数の動作を制御するフラグです。次のフラグを使用できます。 CRED_ALLOW_NAME_RESOLUTION TargetName に対するターゲット情報が見つからない場合、TargetName の名前解決を行い、他の形式に変換します。それらの他の形式のいずれかにターゲット情報が存在する場合は、その情報が返されます。現在は DNS 名前解決のみが行われます。これは、アプリケーションが認証パッケージを直接呼び出さない場合に役立ちます。アプリケーションは TargetName を別のソフトウェア層に渡してサーバーに対する認証を行うことができ、そのソフトウェア層が名前を解決して、解決後の名前を認証パッケージに渡す場合があります。この場合、元の TargetName に対するターゲット情報は存在しません。
TargetInfo	CREDENTIAL_TARGET_INFORMATIONW**	out	ターゲット情報を格納する、単一の割り当て済みブロックバッファーへのポインターです。返される TargetInfo のメンバーのうち、少なくとも 1 つは NULL 以外になります。バッファー内に含まれるポインターは、いずれもこの単一の割り当て済みブロック内の位置を指すポインターです。返された単一のバッファーは、CredFree を呼び出して解放する必要があります。

名前

型

方向

説明

TargetName

LPCWSTR

情報を取得する対象となるターゲットコンピューターの名前を含む、null 終端文字列へのポインターです。

Flags

DWORD

関数の動作を制御するフラグです。次のフラグを使用できます。

CRED_ALLOW_NAME_RESOLUTION

TargetName に対するターゲット情報が見つからない場合、TargetName の名前解決を行い、他の形式に変換します。それらの他の形式のいずれかにターゲット情報が存在する場合は、その情報が返されます。現在は DNS 名前解決のみが行われます。

これは、アプリケーションが認証パッケージを直接呼び出さない場合に役立ちます。アプリケーションは TargetName を別のソフトウェア層に渡してサーバーに対する認証を行うことができ、そのソフトウェア層が名前を解決して、解決後の名前を認証パッケージに渡す場合があります。この場合、元の TargetName に対するターゲット情報は存在しません。

TargetInfo

CREDENTIAL_TARGET_INFORMATIONW**

out

ターゲット情報を格納する、単一の割り当て済みブロックバッファーへのポインターです。返される TargetInfo のメンバーのうち、少なくとも 1 つは NULL 以外になります。バッファー内に含まれるポインターは、いずれもこの単一の割り当て済みブロック内の位置を指すポインターです。返された単一のバッファーは、CredFree を呼び出して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

CredGetTargetInfo 関数は、指定されたターゲットコンピューターについて、既知のすべてのターゲット名情報を取得します。(Unicode)

戻り値

関数は、成功した場合は TRUE を、失敗した場合は FALSE を返します。より具体的なステータスコードを取得するには、GetLastError 関数を呼び出すことができます。次のステータスコードが返される場合があります。

ERROR_NOT_FOUND
指定されたサーバーのターゲット情報が利用できません。

解説(Remarks)

メモ

wincred.h ヘッダーは、CredGetTargetInfo を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、不整合が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

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

BOOL CredGetTargetInfoW(
    LPCWSTR TargetName,
    DWORD Flags,
    CREDENTIAL_TARGET_INFORMATIONW** TargetInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CredGetTargetInfoW(
    [MarshalAs(UnmanagedType.LPWStr)] string TargetName,   // LPCWSTR
    uint Flags,   // DWORD
    IntPtr TargetInfo   // CREDENTIAL_TARGET_INFORMATIONW** out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredGetTargetInfoW(
    <MarshalAs(UnmanagedType.LPWStr)> TargetName As String,   ' LPCWSTR
    Flags As UInteger,   ' DWORD
    TargetInfo As IntPtr   ' CREDENTIAL_TARGET_INFORMATIONW** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' TargetName : LPCWSTR
' Flags : DWORD
' TargetInfo : CREDENTIAL_TARGET_INFORMATIONW** out
Declare PtrSafe Function CredGetTargetInfoW Lib "advapi32" ( _
    ByVal TargetName As LongPtr, _
    ByVal Flags As Long, _
    ByVal TargetInfo 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

CredGetTargetInfoW = ctypes.windll.advapi32.CredGetTargetInfoW
CredGetTargetInfoW.restype = wintypes.BOOL
CredGetTargetInfoW.argtypes = [
    wintypes.LPCWSTR,  # TargetName : LPCWSTR
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # TargetInfo : CREDENTIAL_TARGET_INFORMATIONW** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredGetTargetInfoW = Fiddle::Function.new(
  lib['CredGetTargetInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # TargetName : LPCWSTR
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # TargetInfo : CREDENTIAL_TARGET_INFORMATIONW** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn CredGetTargetInfoW(
        TargetName: *const u16,  // LPCWSTR
        Flags: u32,  // DWORD
        TargetInfo: *mut *mut CREDENTIAL_TARGET_INFORMATIONW  // CREDENTIAL_TARGET_INFORMATIONW** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CredGetTargetInfoW([MarshalAs(UnmanagedType.LPWStr)] string TargetName, uint Flags, IntPtr TargetInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredGetTargetInfoW' -Namespace Win32 -PassThru
# $api::CredGetTargetInfoW(TargetName, Flags, TargetInfo)

#uselib "ADVAPI32.dll"
#func global CredGetTargetInfoW "CredGetTargetInfoW" wptr, wptr, wptr
; CredGetTargetInfoW TargetName, Flags, varptr(TargetInfo)   ; 戻り値は stat
; TargetName : LPCWSTR -> "wptr"
; Flags : DWORD -> "wptr"
; TargetInfo : CREDENTIAL_TARGET_INFORMATIONW** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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