ホーム › NetworkManagement.P2P › PeerGroupIssueCredentials

PeerGroupIssueCredentials

関数

指定IDに対してグループ参加資格情報を発行する。

DLLP2P.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT PeerGroupIssueCredentials(
    void* hGroup,
    LPCWSTR pwzSubjectIdentity,
    PEER_CREDENTIAL_INFO* pCredentialInfo,   // optional
    DWORD dwFlags,
    LPWSTR* ppwzInvitation   // optional
);

パラメーター

名前

型

方向

説明

hGroup

void*

ピアが招待候補のピアに資格情報を発行する対象となるピアグループへのハンドル。このハンドルは PeerGroupCreate、PeerGroupOpen、または PeerGroupJoin 関数によって返されます。このパラメーターは必須です。

pwzSubjectIdentity

LPCWSTR

資格情報の発行先となるピアの ID を指定します。このパラメーターは必須です。

pCredentialInfo

PEER_CREDENTIAL_INFO*

inoptional

pwzSubjectIdentity で指定された ID を持つピアの資格情報に関する情報を格納する PEER_CREDENTIAL_INFO 構造体。このパラメーターが NULL の場合は、代わりにピアデータベースに格納されている情報が使用されます。このパラメーターは省略可能です。

このパラメーターを指定した場合、PEER_CREDENTIAL_INFO の次のフィールドは無視されます。

pwzIssuerPeerName
pwzIssuerFriendlyName

dwFlags

DWORD

資格情報の発行時に実行される処理を示す一連のフラグを指定します。このパラメーターに 0 (ゼロ) を設定した場合、資格情報は ppwzInvitation に返されます。このパラメーターは省略可能です。

値	意味
PEER_GROUP_STORE_CREDENTIALS	新しく作成されたサブジェクト ID の GMC をグループデータベースに発行します。この GMC はサブジェクトによって自動的に取得されます。このフラグが設定されていない場合、資格情報は電子メールなどの別のアプリケーションを使用して取得する必要があります。

ppwzInvitation

LPWSTR*

outoptional

関数呼び出しによって返される招待 XML 文字列へのポインター。この招待は帯域外 (out-of-band) で招待先のピアに渡され、招待先のピアはこれを PeerGroupJoin の呼び出しで使用します。このパラメーターは省略可能です。

戻り値の型: HRESULT

公式ドキュメント

PeerGroupIssueCredentials 関数は、GMC を含む資格情報を特定の ID に発行し、オプションで、招待されたピアがピアグループへの参加に使用できる招待 XML 文字列を返します。

戻り値

操作が成功した場合は S_OK を返します。それ以外の場合、この関数は次のいずれかの値を返します。

リターンコード	説明
E_INVALIDARG	いずれかのパラメーターが有効ではありません。
E_OUTOFMEMORY	操作を完了するために十分なメモリがありません。
PEER_E_IDENTITY_DELETED	資格情報を作成している ID が削除されています。
PEER_E_IDENTITY_NOT_FOUND	ID がグループデータベース内に見つからず、pCredentialInfo が NULL です。
PEER_E_NO_KEY_ACCESS	ID またはグループのキーへのアクセスが拒否されました。通常これは、ユーザーキーまたはコンピューターキーを格納するフォルダーのアクセス制御リスト (ACL) が正しくないことが原因です。これは ACL が手動でリセットされた場合に発生することがあります。

暗号化に固有のエラーが Microsoft RSA Base Provider から返されることがあります。これらのエラーには CRYPT_* というプレフィックスが付いており、Winerror.h で定義されています。

解説(Remarks)

この関数は、管理者のみが正常に呼び出すことができます。

メンバーの資格情報 (PEER_CREDENTIAL_INFO) は、PeerGroupEnumMembers を呼び出すことで取得します。資格情報は、特定のメンバーの PEER_MEMBER 構造体の pCredentialInfo フィールドにあります。

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

各言語での呼び出し定義

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

HRESULT PeerGroupIssueCredentials(
    void* hGroup,
    LPCWSTR pwzSubjectIdentity,
    PEER_CREDENTIAL_INFO* pCredentialInfo,   // optional
    DWORD dwFlags,
    LPWSTR* ppwzInvitation   // optional
);

[DllImport("P2P.dll", ExactSpelling = true)]
static extern int PeerGroupIssueCredentials(
    IntPtr hGroup,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string pwzSubjectIdentity,   // LPCWSTR
    IntPtr pCredentialInfo,   // PEER_CREDENTIAL_INFO* optional
    uint dwFlags,   // DWORD
    IntPtr ppwzInvitation   // LPWSTR* optional, out
);

<DllImport("P2P.dll", ExactSpelling:=True)>
Public Shared Function PeerGroupIssueCredentials(
    hGroup As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> pwzSubjectIdentity As String,   ' LPCWSTR
    pCredentialInfo As IntPtr,   ' PEER_CREDENTIAL_INFO* optional
    dwFlags As UInteger,   ' DWORD
    ppwzInvitation As IntPtr   ' LPWSTR* optional, out
) As Integer
End Function

' hGroup : void*
' pwzSubjectIdentity : LPCWSTR
' pCredentialInfo : PEER_CREDENTIAL_INFO* optional
' dwFlags : DWORD
' ppwzInvitation : LPWSTR* optional, out
Declare PtrSafe Function PeerGroupIssueCredentials Lib "p2p" ( _
    ByVal hGroup As LongPtr, _
    ByVal pwzSubjectIdentity As LongPtr, _
    ByVal pCredentialInfo As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal ppwzInvitation As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PeerGroupIssueCredentials = ctypes.windll.p2p.PeerGroupIssueCredentials
PeerGroupIssueCredentials.restype = ctypes.c_int
PeerGroupIssueCredentials.argtypes = [
    ctypes.POINTER(None),  # hGroup : void*
    wintypes.LPCWSTR,  # pwzSubjectIdentity : LPCWSTR
    ctypes.c_void_p,  # pCredentialInfo : PEER_CREDENTIAL_INFO* optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # ppwzInvitation : LPWSTR* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('P2P.dll')
PeerGroupIssueCredentials = Fiddle::Function.new(
  lib['PeerGroupIssueCredentials'],
  [
    Fiddle::TYPE_VOIDP,  # hGroup : void*
    Fiddle::TYPE_VOIDP,  # pwzSubjectIdentity : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pCredentialInfo : PEER_CREDENTIAL_INFO* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # ppwzInvitation : LPWSTR* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "p2p")]
extern "system" {
    fn PeerGroupIssueCredentials(
        hGroup: *mut (),  // void*
        pwzSubjectIdentity: *const u16,  // LPCWSTR
        pCredentialInfo: *mut PEER_CREDENTIAL_INFO,  // PEER_CREDENTIAL_INFO* optional
        dwFlags: u32,  // DWORD
        ppwzInvitation: *mut *mut u16  // LPWSTR* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("P2P.dll")]
public static extern int PeerGroupIssueCredentials(IntPtr hGroup, [MarshalAs(UnmanagedType.LPWStr)] string pwzSubjectIdentity, IntPtr pCredentialInfo, uint dwFlags, IntPtr ppwzInvitation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'P2P_PeerGroupIssueCredentials' -Namespace Win32 -PassThru
# $api::PeerGroupIssueCredentials(hGroup, pwzSubjectIdentity, pCredentialInfo, dwFlags, ppwzInvitation)

#uselib "P2P.dll"
#func global PeerGroupIssueCredentials "PeerGroupIssueCredentials" sptr, sptr, sptr, sptr, sptr
; PeerGroupIssueCredentials hGroup, pwzSubjectIdentity, varptr(pCredentialInfo), dwFlags, varptr(ppwzInvitation)   ; 戻り値は stat
; hGroup : void* -> "sptr"
; pwzSubjectIdentity : LPCWSTR -> "sptr"
; pCredentialInfo : PEER_CREDENTIAL_INFO* optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; ppwzInvitation : LPWSTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "P2P.dll"
#cfunc global PeerGroupIssueCredentials "PeerGroupIssueCredentials" sptr, wstr, var, int, var
; res = PeerGroupIssueCredentials(hGroup, pwzSubjectIdentity, pCredentialInfo, dwFlags, ppwzInvitation)
; hGroup : void* -> "sptr"
; pwzSubjectIdentity : LPCWSTR -> "wstr"
; pCredentialInfo : PEER_CREDENTIAL_INFO* optional -> "var"
; dwFlags : DWORD -> "int"
; ppwzInvitation : LPWSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "P2P.dll"
#cfunc global PeerGroupIssueCredentials "PeerGroupIssueCredentials" sptr, wstr, sptr, int, sptr
; res = PeerGroupIssueCredentials(hGroup, pwzSubjectIdentity, varptr(pCredentialInfo), dwFlags, varptr(ppwzInvitation))
; hGroup : void* -> "sptr"
; pwzSubjectIdentity : LPCWSTR -> "wstr"
; pCredentialInfo : PEER_CREDENTIAL_INFO* optional -> "sptr"
; dwFlags : DWORD -> "int"
; ppwzInvitation : LPWSTR* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。