DsQuerySitesByCostA 関数 (ntdsapi.h)
DsQuerySitesByCost 関数は、1 つのサイトと 1 つ以上の他のサイトとの間の通信コストを取得します。
構文
NTDSAPI_POSTXP DWORD DsQuerySitesByCostA(
[in] HANDLE hDS,
LPSTR pszFromSite,
LPSTR *rgszToSites,
[in] DWORD cToSites,
[in] DWORD dwFlags,
[out] PDS_SITE_COST_INFO *prgSiteInfo
);
パラメーター
[in] hDS
ディレクトリ サービス ハンドル。
pszFromSite
コストが測定されるサイトの相対識別名を含む null で終わる文字列へのポインター。
rgszToSites
コストが測定されるサイトの相対識別名を含む null で終わる文字列ポインターの配列を格納します。
[in] cToSites
rgwszToSites 配列内の要素の数を格納します。
[in] dwFlags
予約済み。
[out] prgSiteInfo
コスト データを受け取る DS_SITE_COST_INFO 構造体の配列へのポインター。 この配列の各要素には、 pwszFromSite パラメーターで識別されるサイトと、対応する rgwszToSites 要素によって識別されるサイトの間のコスト データが含まれます。
DsQuerySitesFree を呼び出して不要になった場合、呼び出し元はこのメモリを解放する必要があります。
戻り値
成功した場合 はERROR_SUCCESS を返し、それ以外の場合は Win32 または RPC エラー コードを返します。 考えられるエラー コードには、次の一覧に示す値が含まれます。
注釈
この関数によって取得されるコスト値は、比較にのみ使用され、それ自体では意味がありません。 たとえば、サイト 1 のコストはサイト 2 のコストと比較できますが、サイト 1 のコストを固定値と比較することはできません。
注意
ntdsapi.h ヘッダーは、DsQuerySitesByCost をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | ntdsapi.h |
| Library | Ntdsapi.lib |
| [DLL] | Ntdsapi.dll |