Directory Services

IADsLocality Property Methods

The methods of the IADsLocality interface read and write the properties described in this topic. For more information, see Interface Property Methods.


Property Description

[Visual Basic]
Access: Read/Write
DataType: BSTR

HRESULT get_Description
([out] BSTR* pbstrDescription);
HRESULT put_Description
([in] BSTR bstrDescription);

Indicates the text that describes the locality.

[Visual Basic]
Access: Read/Write
DataType: BSTR

HRESULT get_LocalityName
([out] BSTR* pbstrLocalityName);
HRESULT put_LocalityName
([in] BSTR bstrLocalityName);

Indicates the name of the geographical region as represented by this locality object.

[Visual Basic]
Access: Read/Write
DataType: BSTR

HRESULT get_PostalAddress
([out] BSTR* pbstrPostalAddress);
HRESULT put_PostalAddress
([in] BSTR bstrPostalAddress);

Indicates the main postal address of the locality.

[Visual Basic]
Access: Read/Write
DataType: Variant

HRESULT get_SeeAlso
([out] VARIANT* pvSeeAlso);
HRESULT put_SeeAlso
([in] VARIANT vSeeAlso);

Indicates an array of ADsPath names of directory objects relevant to this object.

Example Code [Visual Basic]

The following code example displays the locality data of a container object. It assumes that a locality object, named "myLocality", has been created for the container object and the properties have been set.

Dim dom As IADsContainer
Dim loc As IADsLocality
On Error GoTo Cleanup
Set dom = getObject("LDAP://adsrv1/dc=Fabrikam, dc=Com")
Set loc = dom.GetObject("locality","L=myLocality")
Debug.Print loc.Name
Debug.Print loc.LocalityName
Debug.Print loc.Description
Debug.Print loc.PostalAddress
Debug.Print loc.SeeAlso

	If (Err.Number<>0) Then
		MsgBox("An error has occurred. " & Err.Number)
	End If
	Set dom = Nothing
	Set loc = Nothing


Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Header: Declared in Iads.h.

See Also

IADs, IADsLocality, Interface Property Methods