Метод IADs::Get (iads.h)
Метод IADs::Get извлекает свойство заданного имени из кэша свойств. Свойство может быть однозначным или многозначным. Значение свойства представляется либо как вариант для однозначного свойства, либо в виде массива вариантов ( variant или байтов) для свойства, допускающего несколько значений.
Синтаксис
HRESULT Get(
[in] BSTR bstrName,
[out] VARIANT *pvProp
);
Параметры
[in] bstrName
Содержит BSTR , указывающий имя свойства.
[out] pvProp
Указатель на variant , получающий значение свойства . Для свойства с несколькими значениями pvProp является массивом вариантов VARIANT, если свойство не является двоичным типом. В последнем случае pvProp — это массив вариантов байтов (VT_U1 или VT_ARRAY). Для свойства, ссылающегося на объект, pvProp является указателем VT_DISPATCH на объект, на который ссылается.
Возвращаемое значение
Этот метод поддерживает стандартные возвращаемые значения, а также следующие.
Дополнительные сведения см. в разделе Коды ошибок ADSI.
Комментарии
Метод IADs::Get требует, чтобы вызывающий объект обрабатывал значения свойств с одним и несколькими значениями по-разному. Таким образом, если известно, что интересующее свойство является однозначным или многозначным, используйте метод IADs::Get для получения значения свойства. В следующем примере кода показано, как вызывающий объект может обрабатывать однозначные и многозначные свойства при вызове этого метода.
Если свойство не инициализировано, вызов этого метода вызывает неявный вызов метода IADs::GetInfo . При этом загружается из базового каталога, где хранятся значения поддерживаемых свойств, которые не были заданы в кэше. Все последующие вызовы IADs::Get касаются только значений свойств в кэше. Дополнительные сведения о поведении неявных и явных вызовов IADs::GetInfo см. в разделе IADs::GetInfo.
Вы также можете использовать IADs::GetEx для получения значений свойств из кэша свойств. Однако значения возвращаются в виде массива вариантов variant, независимо от того, являются ли они однозначными или многозначными. То есть ADSI пытается упаковать возвращаемые значения свойств в согласованные форматы данных. Это позволяет сэкономить вам, как вызывающей стороны, усилия по проверке типов данных, если вы не уверены, что возвращаемые данные имеют одно или несколько значений.
Примеры
В следующем примере кода извлекается дескриптор безопасности для объекта с помощью IADs::Get.
Dim x As IADs
Dim Desc As IADsSecurityDescriptor
On Error GoTo ErrTest:
Set x = GetObject("LDAP://CN=Administrator,CN=Users,DC=Fabrikam,DC=com")
' Single-valued properties.
Debug.Print "Home Phone Number is: " & x.Get("homePhone")
' Some property values represents other ADSI objects.
' Consult your provider documentation.
Set Desc = x.Get("ntSecurityDescriptor")
' Multi-valued property, assuming that multiple values were
' assigned to the "otherHomePhone" properties. Caller must
' enumerate all the available values.
Debug.Print "Other Phone Numbers are: "
otherNumbers = x.Get("otherHomePhone")
For Each homeNum In otherNumbers
Debug.Print homeNum
Next
Exit Sub
ErrTest:
Debug.Print Hex(Err.Number)
Set x = Nothing
Set Desc = Nothing
В следующем примере кода показано, как работать со значениями свойств двоичных данных с помощью IADs::Get и IADs::P ut.
Dim oTarget As IADs
Dim Octet(5) As Byte
Dim MultiOctet(2) As Variant
Dim i As Integer, j As Integer
On Error GoTo Cleanup
' Set up MultiOctetString.
For i = 0 To 2
For j = 0 To 5
Octet(j) = CByte(i * j)
Next j
MultiOctet(i) = Octet
Next i
' Bind to the object and set MultiOctetString.
Set oTarget=GetObject("LDAP://CN=SomeUser,CN=Users,DC=Fabrikam, DC=COM")
oTarget.Put "multiOctetString", MultiOctet
oTarget.SetInfo
Dim GetOctet As Variant
Dim Temp As Variant
' Read back and print MultiOctetString.
GetOctet = oTarget.Get("multiOctetString")
For i = LBound(GetOctet) To UBound(GetOctet)
Temp = GetOctet(i)
For j = LBound(Temp) To UBound(Temp)
Debug.Print Temp(j)
Next j
Debug.Print "----"
Next i
Exit Sub
Cleanup:
MsgBox("An error has occurred. " & Err.Number)
Set oTarget = Nothing
В следующем примере кода показано, как получить значения необязательных свойств объекта с помощью IADs::Get.
<HTML>
<head><title></title></head>
<body>
<%
Dim x
On error resume next
Set x = GetObject("WinNT://Fabrikam/Administrator")
Response.Write "Object Name: " & x.Name & "<br>"
Response.Write "Object Class: " & x.Class & "<br>"
' Get optional property values of this object.
Set cls = GetObject(x.Schema)
For Each op In cls.OptionalProperties
v = obj.Get(op)
if err.Number = 0 then
Response.Write "Optional Property: " & op & "=" & v & "<br>"
end if
Next
%>
</body>
</html>
В следующем примере кода считываются атрибуты с одним и несколькими значениями с помощью IADs::Get.
HRESULT hr;
IADs *pUsr=NULL;
CoInitialize(NULL);
///////////////////////////////
// Bind to a directory object.
///////////////////////////////
hr = ADsGetObject(L"WinNT://Fabrikam/Administrator,user", IID_IADs, (void**) &pUsr );
if ( !SUCCEEDED(hr) ) { return hr; }
//////////////////////////////////
// Get a single-valued attribute.
//////////////////////////////////
VARIANT var;
VariantInit(&var);
hr = pUsr->Get(CComBSTR("FullName"), &var );
if ( SUCCEEDED(hr) )
{
printf("FullName: %S\n", V_BSTR(&var) );
VariantClear(&var);
}
if ( pUsr )
{
pUsr->Release();
}
///////////////////////////////////////////////////////
// Get a multi-valued attribute from a service object.
///////////////////////////////////////////////////////
IADs *pSvc = NULL;
hr = ADsGetObject(L"WinNT://Fabrikam/Account/Browser,service", IID_IADs, (void**) &pSvc );
if ( !SUCCEEDED(hr) )
{
return hr;
}
hr = pSvc->Get(CComBSTR("Dependencies"), &var );
if ( SUCCEEDED(hr) )
{
LONG lstart, lend;
SAFEARRAY *sa = V_ARRAY( &var );
VARIANT varItem;
// Get the lower and upper bound.
hr = SafeArrayGetLBound( sa, 1, &lstart );
hr = SafeArrayGetUBound( sa, 1, &lend );
// Iterate and print the content.
VariantInit(&varItem);
printf("Getting service dependencies using IADs :\n");
for ( long idx=lstart; idx <= lend; idx++ )
{
hr = SafeArrayGetElement( sa, &idx, &varItem );
printf("%S ", V_BSTR(&varItem));
VariantClear(&varItem);
}
printf("\n");
VariantClear(&var);
}
// Cleanup.
if ( pSvc )
{
pSvc->Release();
}
Требования
| Минимальная версия клиента | Windows Vista |
| Минимальная версия сервера | Windows Server 2008 |
| Целевая платформа | Windows |
| Header | iads.h |
| DLL | Activeds.dll |