IUpdateEndpointAuthProvider::GetEndpointToken メソッド

指定した資格情報を使用して、サービスのエンドポイントのトークンを要求します。

構文

HRESULT GetEndpointToken(
  [in]  GUID                        serviceId,
  [in]  UpdateEndpointType          endpointType,
  [in]  UpdateEndpointProxySettings proxySettings,
  [in]  HANDLE_PTR                  hUserToken,
  [in]  UpdateEndpointAuthTokenType tokenType,
  [in]  BOOL                        fRefreshOnline,
  [out] IUnknown                    **ppEndpointToken
);

パラメーター

serviceId [in]

更新するサービスを識別します。

endpointType [in]

サービスによって実装されるエンドポイントの種類を識別します。

proxySettings [in]

プロキシ サーバーに接続するときに使用する設定。 詳細については、UpdateEndpointProxySettings 構造体を参照してください。

hUserToken [in]

tokenType [in]

認証に使用される認証トークンの種類を識別します。

fRefreshOnline [in]

WUA が新規のトークンを要求するかどうかを示します。 True は、新規のトークンを要求することを示します。 False は、新規、またはキャッシュされたトークンを要求することを示します。 詳細については、「解説」を参照してください。

ppEndpointToken [out]

使用するエンドポイント トークンを指定します。

戻り値

成功すると、S_OK が返されます。 それ以外の場合は、COM または Windows エラー コードを返します。

解説

通常、WUA は、このメソッドが最初に呼び出されたときに fRefreshOnline パラメーターを false に設定します。次に、接続エラーが発生すると、メソッドが再度呼び出されたときに WUA がそのパラメーターを true に設定します。 ただし、このメソッドの実装は、Security Token Service (STS) に新しいトークンを要求したり、キャッシュされたトークンをいつでも提供したりできます。

要件

要件	Value
サポートされている最小のクライアント	Windows XP、Windows 2000 Professional SP3 [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2003、Windows 2000 Server SP3 [デスクトップ アプリのみ]
ヘッダー	UpdateEndpointAuth.h
IDL	UpdateEndpointAuth.idl
ライブラリ	UpdateEndpointAuth.lib
[DLL]	UpdateEndpointAuth.dll

関連項目

IUpdateEndpointAuthProvider