ホーム › Networking.ActiveDirectory › DsBrowseForContainerW

DsBrowseForContainerW

関数

ディレクトリコンテナ選択ダイアログを表示する(Unicode版)。

DLLdsuiext.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT DsBrowseForContainerW(
    DSBROWSEINFOW* pInfo
);

パラメーター

名前	型	方向	説明
pInfo	DSBROWSEINFOW*	inout	コンテナーブラウザーダイアログの初期化に関するデータを格納し、選択されたオブジェクトに関するデータを受け取る DSBROWSEINFO 構造体へのポインター。

戻り値の型: INT

公式ドキュメント

Active Directory ドメインサービスのコンテナーオブジェクトを参照するためのダイアログボックスを表示します。(Unicode)

戻り値

ユーザーがコンテナーを選択して OK ボタンをクリックした場合、またはオブジェクトをダブルクリックした場合、この関数は IDOK を返します。ユーザーがダイアログボックスをキャンセルした場合、この関数は IDCANCEL を返します。エラーが発生した場合、この関数は -1 を返します。拡張エラー情報を取得するには、GetLastError 関数を使用します。

解説(Remarks)

このダイアログボックスにはコンテナーピッカーが表示されます。コンテナーピッカーには、特定のルート配下のコンテナーが設定されるか、信頼されたドメインが使用されます。信頼されたドメインを使用する場合は、ユーザーが現在ログオンしているドメインを使用することも、DSBROWSEINFO 構造体の pszRoot メンバーを使用してアプリケーションが指定した別のドメインを使用することもできます。ユーザーが OK ボタンをクリックするか、オブジェクトをダブルクリックすると、IDOK が返され、pszPath に選択されたオブジェクトの ADsPath が格納されます。ユーザーがダイアログボックスをキャンセルした場合、DsBrowseForContainer は IDCANCEL を返します。

pszRoot メンバーには ADsPath を格納します。ADsPath は次の形式である必要があります。

LDAP://fabrikam.com/CN=Users,DC=Fabrikam,DC=com

DsBrowseForContainer は、このパスをツリーのルートとして使用します。pszRoot メンバーは、ユーザーがサインインしているドメインと信頼関係にあるドメインを指定するためにも使用できます。これにより、ユーザーは別のドメインの Users コンテナーを参照できます。pszPath メンバーにパスが格納されている場合、ダイアログは pszRoot から各コンテナーをたどり、pszPath で指定されたオブジェクトに到達するまで移動します。

DsBrowseForContainer 関数は、DSBROWSEINFO 構造体で指定するコールバック関数をサポートします。コールバック関数は、選択の変更などに応じてビューをフィルター処理、変更、または更新するために使用できます。詳細については、 BFFCallBack を参照してください。

重要

Windows Server 2003 以降、この関数の ANSI バージョン (DsBrowseForContainerA) は実装されておらず、常に -1 を返します。

例

次のコード例では、ユーザーがサインインしているドメイン内のコンテナーを選択します。ビューには、信頼されたすべてのドメインも表示されます。

void PickContainer(void)
{
    DSBROWSEINFOW dsbi = { 0 };
    WCHAR wszResult[MAX_PATH];
 
    dsbi.cbStruct = sizeof(dsbi);
    dsbi.pszCaption = L"The container picker";
    dsbi.pszTitle = L"Pick a container for this example.";
    dsbi.pszPath = wszResult;
    dsbi.cchPath = MAX_PATH;
    dsbi.dwFlags = DSBI_ENTIREDIRECTORY;

    int nReturn = DsBrowseForContainerW(&dsbi);
 
    if ( IDOK == nReturn )
    {
        // wszResult に結果のパスが格納される
    }
}

メモ

dsclient.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI バージョンまたは Unicode バージョンを自動的に選択するエイリアスとして、DsBrowseForContainer を定義しています。エンコードに依存しないエイリアスの使用と、エンコードに依存するコードを混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

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

INT DsBrowseForContainerW(
    DSBROWSEINFOW* pInfo
);

[DllImport("dsuiext.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int DsBrowseForContainerW(
    IntPtr pInfo   // DSBROWSEINFOW* in/out
);

<DllImport("dsuiext.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DsBrowseForContainerW(
    pInfo As IntPtr   ' DSBROWSEINFOW* in/out
) As Integer
End Function

' pInfo : DSBROWSEINFOW* in/out
Declare PtrSafe Function DsBrowseForContainerW Lib "dsuiext" ( _
    ByVal pInfo 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

DsBrowseForContainerW = ctypes.windll.dsuiext.DsBrowseForContainerW
DsBrowseForContainerW.restype = ctypes.c_int
DsBrowseForContainerW.argtypes = [
    ctypes.c_void_p,  # pInfo : DSBROWSEINFOW* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dsuiext.dll')
DsBrowseForContainerW = Fiddle::Function.new(
  lib['DsBrowseForContainerW'],
  [
    Fiddle::TYPE_VOIDP,  # pInfo : DSBROWSEINFOW* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "dsuiext")]
extern "system" {
    fn DsBrowseForContainerW(
        pInfo: *mut DSBROWSEINFOW  // DSBROWSEINFOW* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dsuiext.dll", CharSet = CharSet.Unicode)]
public static extern int DsBrowseForContainerW(IntPtr pInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dsuiext_DsBrowseForContainerW' -Namespace Win32 -PassThru
# $api::DsBrowseForContainerW(pInfo)

#uselib "dsuiext.dll"
#func global DsBrowseForContainerW "DsBrowseForContainerW" wptr
; DsBrowseForContainerW varptr(pInfo)   ; 戻り値は stat
; pInfo : DSBROWSEINFOW* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dsuiext.dll"
#cfunc global DsBrowseForContainerW "DsBrowseForContainerW" var
; res = DsBrowseForContainerW(pInfo)
; pInfo : DSBROWSEINFOW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dsuiext.dll"
#cfunc global DsBrowseForContainerW "DsBrowseForContainerW" sptr
; res = DsBrowseForContainerW(varptr(pInfo))
; pInfo : DSBROWSEINFOW* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。