Função DsBrowseForContainerA (dsclient.h)

A função DsBrowseForContainer exibe uma caixa de diálogo usada para procurar objetos de contêiner no Active Directory Domain Services.

Sintaxe

int DsBrowseForContainerA(
  [in] PDSBROWSEINFOA pInfo
);

Parâmetros

[in] pInfo

Ponteiro para uma estrutura de DSBROWSEINFO que contém dados sobre como inicializar a caixa de diálogo do navegador de contêiner e recebe dados sobre o objeto selecionado.

Valor de retorno

A função retornará IDOK se o usuário selecionar um contêiner e clicar no botão OK ou clicar duas vezes em um objeto. Se o usuário cancelar a caixa de diálogo, a função retornará IDCANCEL. Se ocorrer um erro, a função retornará -1. Use a função GetLastError para recuperar informações de erro estendidas.

Observações

A caixa de diálogo exibe um seletor de contêiner que é preenchido com contêineres de uma raiz específica ou que usa domínios confiáveis. Se ele usa domínios confiáveis, ele pode usar o domínio no qual o usuário está conectado no momento ou pode usar um domínio alternativo especificado pelo aplicativo usando o pszRoot membro da estrutura de DSBROWSEINFO . Se o usuário clicar no botão OK ou clicar duas vezes em um objeto, IDOK será retornado e pszPath conterá o ADsPath do objeto selecionado. Se o usuário cancelar a caixa de diálogo, DsBrowseForContainer retornará IDCANCEL.

O membro pszRoot contém um ADsPath, que deve estar no seguinte formato:

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

DsBrowseForContainer usa esse caminho como a raiz da árvore. O membro pszRoot também pode ser usado para especificar um domínio que tenha uma relação de confiança com o domínio no qual o usuário está conectado, para que o usuário possa procurar o contêiner Usuários do domínio alternativo. Se o membro pszPath contiver um caminho, a caixa de diálogo navegará de pszRoot pelos contêineres até chegar ao objeto especificado por pszPath.

A função DsBrowseForContainer dá suporte a uma função de retorno de chamada, conforme especificado na estrutura de DSBROWSEINFO . A função de retorno de chamada pode ser usada para filtrar, modificar ou atualizar a exibição com base na alteração de seleção e assim por diante. Para obter mais informações, consulte BFFCallBack .

Importante

 A partir do Windows Server 2003, a versão ANSI dessa função (DsBrowseForContainerA) não é implementada e sempre retorna -1.

Exemplos

O exemplo de código a seguir escolhe um contêiner no domínio no qual o usuário está conectado. A exibição também exibe todos os domínios confiáveis.

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 contains the resulting path
    }
}

Nota

O dsclient.h cabeçalho define DsBrowseForContainer como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows Vista
servidor com suporte mínimo	Windows Server 2008
da Plataforma de Destino	Windows
cabeçalho	dsclient.h
biblioteca	Dsuiext.lib
de DLL	Dsuiext.dll

Consulte também

BFFCallBack

DSBROWSEINFO