IGPM::GetRSOP method (gpmgmt.h)

Creates and returns an GPMRSOP. You can specify the Resultant Set of Policy (RSoP) mode and a Windows Management Instrumentation (WMI) namespace.

Syntax

HRESULT GetRSOP(
  [in]  GPMRSOPMode gpmRSoPMode,
  [in]  BSTR        bstrNamespace,
  [in]  long        lFlags,
  [out] IGPMRSOP    **ppIGPMRSOP
);

Parameters

[in] gpmRSoPMode

Required. Mode in which to open the object. The following modes are supported.

rsopPlanning

Specifies RSoP planning mode

rsopLogging

Specifies RSoP logging mode

rsopUnknown

Valid only if the bstrNamespace parameter is specified

To perform the query, RSoP planning mode requires a domain controller that is running Windows Server.

[in] bstrNamespace

WMI namespace for the IGPMRSOPGPMRSOPGPMRSOP. Use a null-terminated string. This parameter can be NULL. For more information about how to retrieve the namespace, see the "Remarks" section.

[in] lFlags

This parameter must be zero.

[out] ppIGPMRSOP

Address of a pointer to the IGPMRSOP interface.

Return value

C++

Returns S_OK if successful. Returns a failure code if an error occurs.

JScript

Returns a reference to a GPMRSOP object.

VB

Returns a reference to a GPMRSOP object.

Remarks

To retrieve the WMI namespace, call the Namespace property method of the IGPMRSOP interface. Or, call the RsopCreateSession method of the RsopLoggingModeProvider and RsopPlanningModeProvider WMI classes. For more information about these methods, see the Group Policy documentation.

Requirements

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

See also

IGPM

IGPMRSOP