IADsPathname::Retrieve method (iads.h)

The IADsPathname::Retrieve method retrieves the path of the object with different format types.

Syntax

HRESULT Retrieve(
  [in]  long lnFormatType,
  [out] BSTR *pbstrADsPath
);

Parameters

[in] lnFormatType

Specifies the format that the path should be retrieved in. This can be one of the values specified in the ADS_FORMAT_ENUM enumeration.

[out] pbstrADsPath

Contains a pointer to a BSTR value the receives the object path. The caller must free this memory with the SysFreeString function when it is no longer required.

Return value

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

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

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header iads.h
DLL Activeds.dll

See also

ADSI Error Codes

ADS_FORMAT_ENUM

IADsPathname

SysFreeString