ホーム › Security.Credentials › CredGetTargetInfoA

CredGetTargetInfoA

関数

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

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

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CredGetTargetInfoA(
    LPCSTR TargetName,
    DWORD Flags,
    CREDENTIAL_TARGET_INFORMATIONA** TargetInfo
);

パラメーター

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

名前

型

方向

説明

TargetName

LPCSTR

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

Flags

DWORD

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

CRED_ALLOW_NAME_RESOLUTION

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

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

TargetInfo

CREDENTIAL_TARGET_INFORMATIONA**

out

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CredGetTargetInfoA(
    LPCSTR TargetName,
    DWORD Flags,
    CREDENTIAL_TARGET_INFORMATIONA** TargetInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CredGetTargetInfoA(
    [MarshalAs(UnmanagedType.LPStr)] string TargetName,   // LPCSTR
    uint Flags,   // DWORD
    IntPtr TargetInfo   // CREDENTIAL_TARGET_INFORMATIONA** out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredGetTargetInfoA(
    <MarshalAs(UnmanagedType.LPStr)> TargetName As String,   ' LPCSTR
    Flags As UInteger,   ' DWORD
    TargetInfo As IntPtr   ' CREDENTIAL_TARGET_INFORMATIONA** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' TargetName : LPCSTR
' Flags : DWORD
' TargetInfo : CREDENTIAL_TARGET_INFORMATIONA** out
Declare PtrSafe Function CredGetTargetInfoA Lib "advapi32" ( _
    ByVal TargetName As String, _
    ByVal Flags As Long, _
    ByVal TargetInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredGetTargetInfoA = Fiddle::Function.new(
  lib['CredGetTargetInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # TargetName : LPCSTR
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # TargetInfo : CREDENTIAL_TARGET_INFORMATIONA** out
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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