Directory Services

IADsPathname::Set

The IADsPathname::Set method sets up the Pathname object for parsing a directory path. The path is set with a format as defined in ADS_SETTYPE_ENUM.

HRESULT Set( 
  BSTR bstrADsPath,
  long lnSetType
);

Parameters

bstrADsPath
[in] Path of an ADSI object.
lnSetType
[in] An ADS_SETTYPE_ENUM option that defines the format type to be retrieved.

Return Values

This method supports the standard return values, as well as the following:

For more information and other return values, see ADSI Error Codes.

Return Code Description
S_OK The operation succeeded.
E_FAIL The operation failed.
E_ADS_BAD_PATHNAME The path is invalid.

Remarks

This method will set the namespace as specified and identify the appropriate provider for performing the path cracking operation. Resetting to a different namespace will lose data already set by this method.

Example Code [Visual Basic]

The following Visual Basic code example sets a full ADSI path on the Pathname object.

Dim x As New Pathname
 
x.Set "LDAP://server/CN=Jeff Smith, DC=Fabrikam, DC=Com", ADS_SETTYPE_FULL
dn = x.GetElement(0)	' dn now is "CN=Jeff Smith".

Example Code [VBScript]

The following VBScript/ASP code example sets a full ADSI path on the Pathname object.

<%
Dim x
const ADS_SETTYPE_FULL = 1
Set x = CreateObject("Pathname")
path = "LDAP://server/CN=Jeff Smith, DC=Fabrikam,DC=com" 
x.Set path, ADS_SETTYPE_FULL
dn = x.GetElement(0)	' dn now is "CN=Jeff Smith".
%>

Example Code [C++]

The following C++ code example sets a full ADSI path on the Pathname object.

[C++]
IADsPathname *pPathname=NULL;
HRESULT hr;
 
hr = CoCreateInstance(CLSID_Pathname,
					NULL,
					CLSCTX_INPROC_SERVER,
					IID_IADsPathname,
					(void**)&pPathname);
 
if(FAILED(hr)) 
{
	if(pPathname) pPathname->Release();
	return NULL;
}
 
hr = pPathname->Set(CComBSTR("LDAP://CN=pencil/desk"), ADS_SETTYPE_FULL);

Requirements

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

IADsPathname, ADS_SETTYPE_ENUM, ADSI Error Codes