属性スコープクエリの実行

属性スコープクエリは、オブジェクトの識別名値属性の検索を実行できるようにする検索設定です。 検索する属性は単一値でも複数値でもかまいませんが、ADS_DN_STRING 型である必要があります。 検索を実行すると、ADSIは属性の識別名の値を列挙し、識別名で表されるオブジェクトに対して検索を実行します。 例えば、グループオブジェクトのmember属性に対して属性スコープ検索が実行された場合、ADSIはmember属性内の識別名を列挙し、指定された検索条件でグループの各メンバーを検索する。

ADS_DN_STRING型ではない属性に対して属性スコープクエリを実行すると、検索は失敗します。 また、属性スコープクエリでは、ADS_SEARCHPREF_SEARCH_SCOPE設定をADS_SCOPE_BASEに設定する必要があります。 ADS_SEARCHPREF_SEARCH_SCOPE設定は自動的にADS_SCOPE_BASEに設定されますが、ADS_SEARCHPREF_SEARCH_SCOPE設定が他の値に設定されている場合、IDirectorySearch::SetSearchPreferenceはE_ADS_BAD_PARAMETERで失敗します。

属性スコープクエリの結果は複数のサーバーにまたがる場合があり、サーバーは返されたすべての行に対して要求されたすべてのデータを返さない場合があります。 この場合、IDirectorySearch::GetNextRowまたはIDirectorySearch::GetFirstRowを呼び出して最後の行を取得すると、S_ADS_NOMORE_ROWSではなくS_ADS_ERRORSOCCURREDを返します。

属性スコープクエリを指定するには、ADSTYPE_CASE_IGNORE_STRING値をIDirectorySearch::SetSearchPreferenceメソッドに渡されるADS_SEARCHPREF_INFO配列で検索する属性のlDAPDisplayNameに設定したADS_SEARCHPREF_ATTRIBUTE_QUERY検索オプションを設定します。 この操作を次のコード例に示します。

ADS_SEARCHPREF_INFO SearchPref;
SearchPref.dwSearchPref = ADS_SEARCHPREF_ATTRIBUTE_QUERY;
SearchPref.vValue.dwType = ADSTYPE_CASE_IGNORE_STRING;
SearchPref.vValue.Boolean = L"member";

次のコード例は、ADS_SEARCHPREF_ATTRIBUTE_QUERY検索オプションの使用方法を示しています。

/***************************************************************************

    SearchGroupMembers()

    Searches the members of a group that are of type user and prints each 
    user's cn and distinguishedName values to the console.

    Parameters:

    pwszGroupDN - Contains the distinguished name of the group whose 
    members will be searched.

***************************************************************************/

HRESULT SearchGroupMembers(LPCWSTR pwszGroupDN)
{
    HRESULT hr;
    CComPtr<IDirectorySearch> spSearch;
    CComBSTR sbstrADsPath;
 
    // Bind to the group and get the IDirectorySearch interface.
    sbstrADsPath = "LDAP://";
    sbstrADsPath += pwszGroupDN;
    hr = ADsOpenObject(sbstrADsPath,
        NULL,
        NULL,
        ADS_SECURE_AUTHENTICATION,
        IID_IDirectorySearch,
        (void**)&spSearch);
    if(FAILED(hr))
    {
        return hr;
    }
 
    ADS_SEARCHPREF_INFO SearchPrefs[1];

    // Set the ADS_SEARCHPREF_ATTRIBUTE_QUERY search preference.
    SearchPrefs[0].dwSearchPref = ADS_SEARCHPREF_ATTRIBUTE_QUERY;
    SearchPrefs[0].vValue.dwType = ADSTYPE_CASE_IGNORE_STRING;
    SearchPrefs[0].vValue.CaseIgnoreString = L"member";

    // Set the search preferences.
    hr = spSearch->SetSearchPreference(SearchPrefs, sizeof(SearchPrefs)/sizeof(ADS_SEARCHPREF_INFO));
    if(FAILED(hr))
    {
        return hr;
    }

    ADS_SEARCH_HANDLE hSearch;
    
    // Create the search filter.
    LPWSTR pwszSearchFilter = L"(&(objectClass=user))";
 
    // Set attributes to return.
    LPWSTR rgpwszAttributes[] = {L"cn", L"distinguishedName"};
    DWORD dwNumAttributes = sizeof(rgpwszAttributes)/sizeof(LPWSTR);
 
    // Execute the search.
    hr = spSearch->ExecuteSearch(pwszSearchFilter,
        rgpwszAttributes,
        dwNumAttributes,
        &hSearch);
    if(FAILED(hr))
    {
        return hr;
    }

    // Get the first result row.
    hr = spSearch->GetFirstRow(hSearch);
    while(S_OK == hr)
    {
        ADS_SEARCH_COLUMN col;

        // Enumerate the retrieved attributes.
        for(DWORD i = 0; i < dwNumAttributes; i++)
        {
            hr = spSearch->GetColumn(hSearch, rgpwszAttributes[i], &col);
            if(SUCCEEDED(hr))
            {
                switch(col.dwADsType)
                {
                case ADSTYPE_DN_STRING:
                    wprintf(L"%s: %s\n\n", rgpwszAttributes[i], col.pADsValues[0].DNString);
                    break;

                case ADSTYPE_CASE_IGNORE_STRING:
                    wprintf(L"%s: %s\n\n", rgpwszAttributes[i], col.pADsValues[0].CaseExactString);
                    break;

                default:
                    break;
                }
                
                // Free the column.
                spSearch->FreeColumn(&col);
            }
        }
        
        // Get the next row.
        hr = spSearch->GetNextRow(hSearch);
    }

    // Close the search handle to cleanup.
    hr = spSearch->CloseSearchHandle(hSearch);

    return hr;
}

この検索が実行され、結果が列挙されると、グループのmember属性リストに含まれるすべてのユーザーオブジェクトのname、telephone number、office numberが返される。

エラー処理: 属性スコープクエリの結果は複数のサーバーにまたがる場合があり、サーバーは返されたすべての行に対して要求されたすべてのデータを返さない場合があります。 この場合、GetNextRowまたはGetFirstRowを呼び出すことによって最後の行が取得されると、ADSIはS_ADS_NOMORE_ROWSではなくS_ADS_ERRORSOCCURREDを返します。