RSOP_IEAKPolicySetting class

Article
05/31/2018

Represents the policy data for general settings related to management and customization of Microsoft Internet Explorer. Administrators can set options for the client browser UI, connections, URLs, proxy settings, URL security zones, and Favorites using the Internet Explorer Administration Kit (IEAK). IEAK is the Microsoft toolkit for customizing and distributing Internet Explorer. All settings abstracted by this class are stored in an .ins file, a text file that represents IEAK settings. The class is used to report RSoP.

Note

Classes that derive from the RSOP_PolicySetting class must redefine the precedence property to be a key.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[AMENDMENT]
class RSOP_IEAKPolicySetting : RSOP_PolicySetting
{
  string   id;
  uint32   precedence;
  string   name = "";
  string   GPOID = "";
  string   SOMID = "";
  datetime creationTime;
  boolean  preferenceMode = FALSE;
  string   titleBarText;
  string   titleBarCustomText;
  string   userAgentText;
  string   toolbarBackgroundBitmapPath;
  boolean  customizeAnimatedBitmaps;
  string   largeAnimatedBitmapName;
  string   largeAnimatedBitmapPath;
  string   smallAnimatedBitmapName;
  string   smallAnimatedBitmapPath;
  boolean  customizeLogoBitmaps;
  string   largeCustomLogoBitmapName;
  string   largeCustomLogoBitmapPath;
  string   smallCustomLogoBitmapName;
  string   smallCustomLogoBitmapPath;
  boolean  deleteExistingToolbarButtons;
  sint32   toolbarButtons;
  boolean  placeFavoritesAtTopOfList;
  boolean  deleteExistingFavorites;
  boolean  deleteAdminCreatedFavoritesOnly;
  sint32   customFavorites;
  sint32   customLinks;
  boolean  deleteExistingChannels;
  boolean  enableDesktopChannelBarByDefault;
  sint32   channels;
  sint32   categories;
  string   homePageURL;
  string   searchBarURL;
  string   onlineHelpPageURL;
  boolean  importSecurityZoneSettings;
  uint32   importedZoneCount;
  boolean  importContentRatingsSettings;
  boolean  importAuthenticodeSecurityInfo;
  boolean  enableTrustedPublisherLockdown;
  boolean  importProgramSettings;
};

Members

The RSOP_IEAKPolicySetting class has these types of members:

Properties

Properties

The RSOP_IEAKPolicySetting class has these properties.

categories

Data type: sint32
Access type: Read-only
Qualifiers: DisplayName ("Categories")

TBD

channels

Data type: sint32
Access type: Read-only
Qualifiers: DisplayName ("Channels")

TBD

creationTime

Data type: datetime
Access type: Read-only

Time the policy object was created.

This property is inherited from the RSOP_PolicySetting class.

customFavorites

Data type: sint32
Access type: Read-only
Qualifiers: DisplayName ("Custom Favorites")

Number of custom Favorites items and folders to add to the Favorites folder used by Internet Explorer. Favorites items and folders are described by the RSOP_IEFavoriteItem class.

customizeAnimatedBitmaps

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Customize Animated Bitmaps")

If TRUE, the system uses the custom large and/or small animated logo bitmaps that are specified to replace the animated Internet Explorer logo in the upper-right hand corner of the Internet Explorer window. If FALSE, the system uses the animated Internet Explorer logo.

customizeLogoBitmaps

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Customize Logo Bitmaps")

If TRUE, the system uses the custom large and/or small static logo bitmaps that are specified to replace the static Internet Explorer logo in the upper-right hand corner of the Internet Explorer window. If FALSE, the system uses the static Internet Explorer logo.

customLinks

Data type: sint32
Access type: Read-only
Qualifiers: DisplayName ("Custom Links")

Number of custom link items to add to the Internet Explorer Links bar. Items are described by the RSOP_IELinkItem class.

deleteAdminCreatedFavoritesOnly

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Delete Admin Created Favorites Only")

If TRUE, the system deletes only those Favorites items and folders created by an administrator. If FALSE, these types of Favorites are not deleted. Note that if you set this property equal to TRUE, you must also set the deleteExistingFavorites property equal to TRUE.

deleteExistingChannels

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Delete Existing Channels")

If TRUE, the system deletes all existing Channels, if present. If FALSE, Channels are not deleted.

deleteExistingFavorites

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Delete Existing Favorites")

If TRUE, the system deletes all Favorites items and folders. If FALSE, existing Favorites are not deleted.

deleteExistingToolbarButtons

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Delete Existing Toolbar Buttons")

If TRUE, the system deletes existing custom toolbar buttons from the Internet Explorer button bar. If FALSE, custom toolbar buttons are not deleted.

enableDesktopChannelBarByDefault

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Enable Desktop Channel Bar By Default")

Enable the Desktop Channel Bar by default.

enableTrustedPublisherLockdown

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Enable Trusted Publisher Lockdown")

If TRUE, this property enables trusted publisher lockdown, which prevents users from adding new trusted Authenticode publishers while using the Internet Explorer browser. If FALSE, the lockdown is not enabled. Note that enabling this lockdown does not prevent access to the Content Advisor Internet option.

GPOID

Data type: string
Access type: Read-only

Identifies the GPO that contains the policy object. You can obtain this value from PGROUP_POLICY_OBJECT->lpDSPath. You must remove the prefix LDAP://CN=Machine from lpDSPath.

This property is inherited from the RSOP_PolicySetting class.

homePageURL

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Home Page URL")

URL to use for the Internet Explorer home page.

id

Data type: string
Access type: Read-only
Qualifiers: key, DisplayName ("ID")

Unique identifier for objects of this class.

This property is inherited from the RSOP_PolicySetting class.

importAuthenticodeSecurityInfo

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Import Authenticode Security Info")

If TRUE, the system imports Authenticode security information. If FALSE, Authenticode security information is not customized. For more information, see RSOP_IEAuthenticodeCertificate.

importContentRatingsSettings

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Import Content Ratings Settings")

If TRUE, the system imports the settings for content ratings. If FALSE, these settings are not customized. For more information, see RSOP_IESecurityContentRatings.

importedZoneCount

Data type: uint32
Access type: Read-only
Qualifiers: DisplayName ("Imported Zone Count")

Value specifying the number of URL security zones imported from another computer. Internet Explorer 5.x has five security zones by default: Internet, Local Intranet, Trusted Sites, Restricted Sites, and My Computer.

importProgramSettings

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Import Program Settings")

If TRUE, the system imports the program settings to use with Internet Explorer. If FALSE, program settings are not customized. For more information, see RSOP_IEProgramSettings and RSOP_IEImportedProgramSettings.

importSecurityZoneSettings

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Import Security Zone Settings")

If TRUE, the system imports URL security zone settings. If FALSE, security zone settings are not customized. For more information, see RSOP_IESecurityZoneSettings.

largeAnimatedBitmapName

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Large Animated Bitmap Name")

File name of a large animated bitmap to replace the large animated Internet Explorer logo.

largeAnimatedBitmapPath

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Large Animated Bitmap Path")

File system path to a large animated bitmap to replace the large animated Internet Explorer logo.

largeCustomLogoBitmapName

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Large Custom Logo Bitmap Name")

File name of a large custom logo bitmap to replace the large static Internet Explorer logo.

largeCustomLogoBitmapPath

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Large Custom Logo Bitmap Path")

File system path to a large custom logo bitmap to replace the large static Internet Explorer logo.

name

Data type: string
Access type: Read-only

User-friendly name of the policy object.

This property is inherited from the RSOP_PolicySetting class.

onlineHelpPageURL

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Online Help Page URL")

URL to use for the on-line help page.

placeFavoritesAtTopOfList

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Place Favorites At Top Of List")

If TRUE, the system places the Favorites described by the RSOP_IEFavoriteItem class in this namespace at the top of the Favorites in the user's Internet Explorer. If FALSE, Favorites items described by the RSOP_IEFavoriteItem class are mixed with the user's Favorites according to the default Internet Explorer ordering scheme.

precedence

Data type: uint32
Access type: Read-only
Qualifiers: key, DisplayName ("Precedence")

The order or precedence in which the policy object should be applied.

This property is inherited from the RSOP_PolicySetting class.

preferenceMode

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Preference Mode")

If TRUE, IEAK settings for this user and computer are in preference mode, as defined by IEAK. If FALSE, preference mode is not set.

searchBarURL

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Search Bar URL")

URL to use for the search bar.

smallAnimatedBitmapName

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Small Animated Bitmap Name")

File name of a small animated bitmap to replace the small animated Internet Explorer logo.

smallAnimatedBitmapPath

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Small Animated Bitmap Path")

File system path to a small animated bitmap to replace the small animated Internet Explorer logo.

smallCustomLogoBitmapName

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Small Custom Logo Bitmap Name")

File name of a small custom logo bitmap to replace the small static Internet Explorer logo.

smallCustomLogoBitmapPath

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Small Custom Logo Bitmap Path")

File system path to a small custom logo bitmap to replace the small static Internet Explorer logo.

SOMID

Data type: string
Access type: Read-only

The scope of management (SOM) associated with the GPO that contains this policy object. You can obtain this value from PGROUP_POLICY_OBJECT->lpLink. You must remove the prefix LDAP:// from lpLink.

This property is inherited from the RSOP_PolicySetting class.

titleBarCustomText

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Title Bar Custom Text")

Title bar custom text. The text appears in the Internet Explorer title bar following the standard string, "Microsoft Internet Explorer provided by".

titleBarText

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Title Bar Text")

Title bar text. The text appears in the Internet Explorer title bar, and includes the standard string "Microsoft Internet Explorer provided by".

toolbarBackgroundBitmapPath

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Toolbar Background Bitmap Path")

File system path to the bitmap to use as the background for the Internet Explorer toolbar.

toolbarButtons

Data type: sint32
Access type: Read-only
Qualifiers: DisplayName ("Delete Existing Toolbar Buttons")

Number of custom buttons placed on the Internet Explorer button bar. The buttons are described by the RSOP_IEToolbarButton class.

userAgentText

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("User Agent Text")

The string to append to the userAgent property value of the windows.navigator object as defined by the Internet Explorer Document Object Model (DOM).

Remarks

The RSOP_IEAKPolicySetting class is derived from the RSOP_PolicySetting class.

Requirements


Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	Root\RSOP\Computer, Root\RSOP\User
MOF	Rsop.mof
DLL	GPSvc.dll

RSOP_IEAKPolicySetting class

Syntax

Members

Properties

Remarks

Requirements

See also

Additional resources