IGroupPolicyObject::GetDSPath method (gpedit.h)

Article
02/22/2024

The GetDSPath method retrieves the Active Directory path to the root of the specified GPO section.

Syntax

HRESULT GetDSPath(
  [in]  DWORD    dwSection,
  [out] LPOLESTR pszPath,
  [in]  int      cchMaxPath
);

Parameters

[in] dwSection

Specifies the GPO section. This parameter can be one of the following values.

GPO_SECTION_ROOT

Root section

GPO_SECTION_USER

User section

GPO_SECTION_MACHINE

Computer section

[out] pszPath

Pointer to a buffer that receives the path, in ADSI format (LDAP://cn=user, ou=users, dc=coname, dc=com).

[in] cchMaxPath

Specifies the maximum number of characters that can be stored in the pszPath buffer.

Return value

If the method succeeds, the return value is S_OK. Otherwise, the method returns one of the COM error codes defined in the Platform SDK header file WinError.h.

Remarks

If you call the GetDSPath method and specify a computer GPO, the method succeeds, but on return, the pszPath parameter contains an empty string. This is because computer GPOs do not have Active Directory storage; they have only file system storage.

To retrieve the file system path to the root of a GPO section, you can call the GetFileSysPath method.

Requirements

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