IADsPropertyList：：GetPropertyItem 方法 (iads.h)

项目
08/24/2023

IADsPropertyList：：GetPropertyItem 方法从列表中检索与名称匹配的项。

语法

HRESULT GetPropertyItem(
  [in]      BSTR    bstrName,
  [in]      LONG    lnADsType,
  [in, out] VARIANT *pVariant
);

参数

[in] bstrName

包含所请求属性的名称。

[in] lnADsType

包含一个 ADSTYPEENUM 枚举值，该值确定在解释请求的属性时要使用的数据类型。如果类型未知，则可以将此参数设置为 ADSTYPE_UNKNOWN。对于无架构服务器，用户必须指定类型。

[in, out] pVariant

调用方分配的 VARIANT 变量的地址。返回时， VARIANT 包含对象的 IDispatch 接口指针，该指针实现检索到的属性的 IADsPropertyEntry 接口。

当不再需要数据时，必须使用 VariantClear 函数释放为此参数分配的任何内存。

返回值

此方法支持标准 HRESULT 返回值，包括 S_OK。如果未找到请求的属性项，该方法将返回 ADS_PROPERTY_NOT_FOUND。有关详细信息和其他返回值，请参阅 ADSI 错误代码。

注解

此方法返回的 IADsPropertyValue 对象的属性将取决于 lnADsType 中指定的类型。下表将数据类型映射到相应的 IADsPropertyEntry 属性。

lnADsType 值	要使用的 IADsPropertyValue 属性
ADSTYPE_INVALID	不可用。
ADSTYPE_DN_STRING	DNString
ADSTYPE_CASE_EXACT_STRING	CaseExactString
ADSTYPE_CASE_IGNORE_STRING	CaseIgnoreString
ADSTYPE_PRINTABLE_STRING	PrintableString
ADSTYPE_NUMERIC_STRING	NumericString
ADSTYPE_BOOLEAN	布尔值
ADSTYPE_INTEGER	整数
ADSTYPE_OCTET_STRING	OctetString
ADSTYPE_UTC_TIME	UTCTime
ADSTYPE_LARGE_INTEGER	LargeInteger
ADSTYPE_PROV_SPECIFIC	使用 IADsPropertyValue2：：GetObjectProperty (VT_ARRAY \|VT_UI1) 。
ADSTYPE_OBJECT_CLASS	不可用。
ADSTYPE_CASEIGNORE_LIST	使用 IADsPropertyValue2：：GetObjectProperty (IADsCaseIgnoreList) 。
ADSTYPE_OCTET_LIST	使用 IADsPropertyValue2：：GetObjectProperty (IADsOctetList) 。
ADSTYPE_PATH	使用 IADsPropertyValue2：：GetObjectProperty (IADsPath) 。
ADSTYPE_POSTALADDRESS	使用 IADsPropertyValue2：：GetObjectProperty (IADsPostalAddress) 。
ADSTYPE_TIMESTAMP	使用 IADsPropertyValue2：：GetObjectProperty (IADsTimestamp) 。
ADSTYPE_BACKLINK	使用 IADsPropertyValue2：：GetObjectProperty (IADsBackLink) 。
ADSTYPE_TYPEDNAME	使用 IADsPropertyValue2：：GetObjectProperty (IADsTypedName) 。
ADSTYPE_HOLD	使用 IADsPropertyValue2：：GetObjectProperty (IADsHold) 。
ADSTYPE_NETADDRESS	使用 IADsPropertyValue2：：GetObjectProperty (IADsNetAddress) 。
ADSTYPE_REPLICAPOINTER	使用 IADsPropertyValue2：：GetObjectProperty (IADsReplicaPointer) 。
ADSTYPE_FAXNUMBER	使用 IADsPropertyValue2：：GetObjectProperty (IADsFaxNumber) 。
ADSTYPE_EMAIL	使用 IADsPropertyValue2：：GetObjectProperty (IADsEmail) 。
ADSTYPE_NT_SECURITY_DESCRIPTOR	SecurityDescriptor
ADSTYPE_UNKNOWN	不可用。
ADSTYPE_DN_WITH_BINARY	使用 IADsPropertyValue2：：GetObjectProperty (IADsDNWithBinary) 。
ADSTYPE_DN_WITH_STRING	使用 IADsPropertyValue2：：GetObjectProperty (IADsDNWithString) 。

示例

下面的代码示例演示如何使用 GetPropertyItem 方法检索属性条目。

Const ADSTYPE_CASE_IGNORE_STRING = 3
Dim propList As IADsPropertyList
Dim propEntry As IADsPropertyEntry
Dim propVal As IADsPropertyValue

Set propList = GetObject("LDAP://dc01/DC=Fabrikam,DC=com")
propList.GetInfo
 
Set propEntry = propList.GetPropertyItem("dc", ADSTYPE_CASE_IGNORE_STRING)
 
For Each v In propEntry.Values
    Set propVal = v

    ' Use the CaseIgnoreString property because the ADSTYPE_CASE_IGNORE_STRING 
    ' type was requested in GetPropertyItem.
    Debug.Print propVal.CaseIgnoreString
Next

Set propList = Nothing
Set propEntry = Nothing
Set propVal = Nothing

下面的代码示例演示如何使用 GetPropertyItem 方法检索属性条目。它假定已正确检索 IADsPropertyList 接口。有关如何加载属性缓存的详细信息，请参阅 IADsPropertyList 中的 GetPropertyCache 示例函数。

#include <activeds.h>
#include <stdio.h>
 
/////////////////////////////////////////////////////////
// Function to retrieve a specified property entry 
// using the IADsPropertyList::GetPropertyItem method.
/////////////////////////////////////////////////////////
IADsPropertyEntry *GetPropertyItem(
      IADsPropertyList *pList, 
      BSTR entryName,
      long entryType)
{
   IADsPropertyEntry *pEntry;
   VARIANT var;
   VariantInit(&var);

   if(!pList || !entryName)
   {
      _tprintf("Invalid argument...");
      return NULL;
   }
 
   // Get a property entry.
   hr = pList->GetPropertyItem(entryName, entryType, &var);
   hr = V_DISPATCH(&var)->QueryInterface(IID_IADsPropertyEntry,
                                         (void**)&pEntry);
   VariantClear(&var);
 
   return pEntry;
}
 
///////////////////////////////////////////////////////
// Examine a property entry.
///////////////////////////////////////////////////////
IADsPropertyList *pList = NULL;
IADsPropertyEntry *pEntry = NULL;

pList = GetPropertyCache(L"LDAP://dc01/DC=Fabrikam,DC=COM");
 
if(pList)
{
    pEntry = GetPropertyItem(pList, L"dc", ADSTYPE_CASE_IGNORE_STRING);
}

if(pEntry)
{ 
    BSTR nm;
    HRESULT hr = pEntry->get_Name(&nm);
    if(SUCCEEDED(hr))
    {
        printf("Property name = %S\n",nm);
        SysFreeString(nm);
    }
}
 
if(pList)
    pList->Release();
if(pEntry)
    pEntry->Release();