IGPMRSOP Property Methods

  • Article

The property methods of the interface get and set the properties described in the following table. For a general discussion of property methods, see Interface Property Methods in the ADSI documentation . RSoP planning mode requires a Windows Server domain controller to perform the query.

The IGPMRSOP interface defines the following properties.

Properties

LoggingComputer

Name of the computer being logged. The computer must have RSoP enabled.

Access type: Read/write

Scripting data type: String

// C++ method syntax
HRESULT put_LoggingComputer(
  [in] BSTR bstrVal
);
HRESULT get_LoggingComputer(
  [out] BSTR* bstrVal
);

LoggingFlags

Logging mode flags. This property can be one of the following values:

  • RSOP_NO_COMPUTER

  • RSOP_NO_USER

RSOP_NO_COMPUTER and RSOP_NO_USER must not be specified together.

Access type: Read/write

Scripting data type: Long

// C++ method syntax
HRESULT put_LoggingFlags(
  [in] long lVal
);
HRESULT get_LoggingFlags(
  [out] long* lVal
);

LoggingUser

Name of the user targeted in logging mode.

Access type: Read/write

Scripting data type: String

// C++ method syntax
HRESULT put_LoggingUser(
  [in] BSTR bstrVal
);
HRESULT get_LoggingUser(
  [out] BSTR* bstrVal
);

Mode

RSOP mode. This property can be one of the following: rsopUnknown, rsopPlanning, or rsopLogging.

Access type: Read-only

// C++ method syntax
HRESULT get_Mode(
  [out] GPMRSOPMode* pVal
);

Namespace

RSOP WMI namespace generated as output from an RSoP simulation. The format is typically "\\computername\root\rsop\namespace".

Access type: Read-only

Scripting data type: String

// C++ method syntax
HRESULT get_Namespace(
  [out] BSTR* bstrVal
);

PlanningComputer

Name of the computer to use during planning mode simulation. This is the SAM account name of the Computer object; for example, example\computer.

Access type: Read/write

Scripting data type: String

// C++ method syntax
HRESULT put_PlanningComputer(
  [in] BSTR bstrVal
);
HRESULT get_PlanningComputer(
  [out] BSTR* bstrVal
);

PlanningComputerSecurityGroups

The pvarVal contains the security groups to associate with the computer during planning mode simulation. The PlanningComputerSecurityGroups property returns a SAFEARRAY that contains VARIANT members. Each VARIANT contains a Dispatch pointer to the IGPMTrustee interface.

Set the PlanningComputerSecurityGroups property to an empty SAFEARRAY to specify that the RSoP query must be run with no security groups. If you set the property to VT_NULL, or never set the property, the query uses the default security groups for the user. If no security groups are specified, the property returns a VARIANT of type VT_NULL. When specifying a list of security groups for a query, "Authenticated Users" and "Everyone" is always implicit and should not be in the list.

Access type: Read/write

Scripting data type: Variant

// C++ method syntax
HRESULT put_PlanningComputerSecurityGroups(
  [in] VARIANT varVal
);
HRESULT get_PlanningComputerSecurityGroups(
  [out] VARIANT* pvarVal
);

PlanningComputerSOM

Scope of management (SOM) to use for the computer during planning mode simulation. This is the distinguished name of the Active Directory container in which the user object resides, for purposes of the RSoP simulation. It is not necessary that this property be the true location where the object currently resides.

Access type: Read/write

Scripting data type: String

// C++ method syntax
HRESULT put_PlanningComputerSOM(
  [in] BSTR bstrVal
);
HRESULT get_PlanningComputerSOM(
  [out] BSTR* bstrVal
);

PlanningComputerWMIFilters

The pvarVal parameter contains the WMI filters to associate with the computer during planning mode simulation. The PlanningComputerWMIFilters property returns a SAFEARRAY that contains VARIANT members. Each VARIANT contains a Dispatch pointer to the IGPMWMIFilter interface.

Access type: Read/write

Scripting data type: Variant

// C++ method syntax
HRESULT put_PlanningComputerWMIFilters(
  [in] VARIANT varVal
);
HRESULT get_PlanningComputerWMIFilters(
  [out] VARIANT* pvarVal
);

PlanningDomainController

Name of the DC to use in planning mode. This can be a DNS name or a NetBIOS name. The DC must be running Windows Server.

Access type: Read/write

Scripting data type: String

// C++ method syntax
HRESULT put_PlanningDomainController(
  [in] BSTR bstrVal
);
HRESULT get_PlanningDomainController(
  [out] BSTR* bstrVal
);

PlanningFlags

Planning mode flags. The value of this property can be one or more of the following constants combined using logical OR operators.

  • RSOP_NO_COMPUTER
  • RSOP_NO_USER
  • RSOP_PLANNING_ASSUME_SLOW_LINK
  • RSOP_PLANNING_ASSUME_LOOPBACK_MERGE
  • RSOP_PLANNING_ASSUME_LOOPBACK_REPLACE
  • RSOP_PLANNING_ASSUME_USER_WQLFILTER_TRUE
  • RSOP_PLANNING_ASSUME_COMP_WQLFILTER_TRUE

RSOP_NO_COMPUTER and RSOP_NO_USER must not be specified together.

RSOP_PLANNING_ASSUME_LOOPBACK_MERGE and RSOP_PLANNING_ASSUME_LOOPBACK_REPLACE must not be specified together.

Access type: Read/write

Scripting data type: Long

// C++ method syntax
HRESULT put_PlanningFlags(
  [in] long lVal
);
HRESULT get_PlanningFlags(
  [out] long* lVal
);

PlanningSiteName

Name of the site to use during planning mode simulation; for example, Default-first-site-name.

Access type: Read/write

Scripting data type: String

// C++ method syntax
HRESULT put_PlanningSiteName(
  [in] BSTR bstrVal
);
HRESULT get_PlanningSiteName(
  [out] BSTR* bstrVal
);

PlanningUser

Name of the user for planning mode simulation. This is the Security Accounts Manager (SAM) account name of the User object; for example, example\user.

Access type: Read/write

Scripting data type: String

// C++ method syntax
HRESULT put_PlanningUser(
  [in] BSTR bstrVal
);
HRESULT get_PlanningUser(
  [out] BSTR* bstrVal
);

PlanningUserSecurityGroups

The pvarVal parameter contains the security groups to associate with the user during planning mode simulation. The PlanningUserSecurityGroups property returns a SAFEARRAY of VARIANT members. Each VARIANT contains a Dispatch pointer to the IGPMTrustee interface.

Set the PlanningUserSecurityGroups property to an empty SAFEARRAY to specify that the RSoP query must be run with no security groups. If you set the property to VT_NULL, or never set the property, the query uses the default security groups for the user. If no security groups are specified, the property returns a VARIANT of type VT_NULL. When specifying a list of security groups for a query, "Authenticated Users" and "Everyone" is always implicit and should not be in the list.

Access type: Read/write

Scripting data type: Variant

// C++ method syntax
HRESULT put_PlanningUserSecurityGroups(
  [in] VARIANT varVal
);
HRESULT get_PlanningUserSecurityGroups(
  [out] VARIANT* pvarVal
);

PlanningUserSOM

Name of the user scope of management (SOM) to use during planning mode simulation. This is the distinguished name of the Active Directory container in which the user object resides, for purposes of the RSoP simulation. It is not necessary that this property be the true location where the object currently resides.

Access type: Read/write

Scripting data type: String

// C++ method syntax
HRESULT put_PlanningUserSOM(
  [in] BSTR bstrVal
);
HRESULT get_PlanningUserSOM(
  [out] BSTR* bstrVal
);

PlanningUserWMIFilters

The pvarVal parameter contains the WMI filters to associate with the user during planning mode simulation. The PlanningUserWMIFilters property returns a SAFEARRAY that contains VARIANT members. Each VARIANT contains a Dispatch pointer to the IGPMWMIFilter interface.

Access type: Read/write

Scripting data type: Variant

// C++ method syntax
HRESULT put_PlanningUserWMIFilters(
  [in] VARIANT varVal
);
HRESULT get_PlanningUserWMIFilters(
  [out] VARIANT* pvarVal
);

Remarks

For more information about security groups, see How Security Groups are Used in Access Control in the Active Directory Programmer's Guide.

Requirements
Minimum supported client
 Windows Vista
Minimum supported server
 Windows Server 2008
Header
Gpmgmt.h
IDL
Gpmgmt.idl
DLL
Gpmgmt.dll
IID
 IID_IGPMRSOP is defined as 49ED785A-3237-4FF2-B1F0-FDF5A8D5A1EE

See also

IGPMRSOP

IGPM

IGPMWMIFilter

IGPMTrustee