Share via


FPCUserSets collection

Applies to: desktop apps only

The FPCUserSets collection holds a set of FPCUserSet objects that represent all the user sets defined in an array or the enterprise. Each user set may contain both Windows users that have accounts registered in Active Directory and non-Windows users that are authenticated using an authentication scheme other than that of Active Directory. Examples of non-Windows users include RADIUS and SecurID users. Access rules, Web publishing rules, system policy rules, and VPN quarantine settings can refer to specific user sets. For more information about different kinds of users in Forefront TMG, see Defining Groups of Users.

Forefront TMG provides the following predefined user sets:

  • All Authenticated Users.
  • All Users.
  • System and Network Service.

The FPCUserSets collection is accessed through the UserSets property of the FPCRuleElements object.

Ff826814.bkbutton(en-us,VS.85).png Click here to see the Forefront TMG object hierarchy.

Inheritance

This collection inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Members

The FPCUserSets collection has these types of members:

  • Methods
  • Properties

Methods

The FPCUserSets collection has these methods.

Method Description
Add

Creates a new FPCUserSet object in the collection and returns a reference to it.

Item

Retrieves the specified FPCUserSet object from the collection.

Remove

Removes an FPCUserSet object from the collection.

 

Properties

The FPCUserSets collection has these properties.

Property Access type Description

_NewEnum

Read-only

Gets an enumerator object for the collection.

Count

Read-only

Gets the number of FPCUserSet objects in the collection.

 

Methods Inherited from FPCPersist

Name Description
CancelWaitForChanges Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport Returns a Boolean value that indicates whether the properties of the collection, its elements, and their subobjects can be imported from the specified XML document.
Export Recursively writes the stored values of all the properties of the collection, its elements, and their subobjects to the specified XML document.
ExportToFile Recursively writes the stored values of all the properties of the collection, its elements, and their subobjects to the specified XML file.
GetServiceRestartMask Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import Recursively copies the values of all the properties of the collection, its elements, and their subobjects from the specified XML document to persistent storage.
ImportFromFile Recursively copies the values of all the properties of the collection, its elements, and their subobjects from the specified XML file to persistent storage.
LoadDocProperties Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh Recursively reads the values of all the properties of the collection, its elements, and their subobjects from persistent storage, overwriting any changes that have not been saved.
Save Recursively writes the current values of all the properties of the collection, its elements, and their subobjects to persistent storage.
WaitForChanges Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

 

Properties Inherited from FPCPersist

Name Description
PersistentName Gets the persistent name of the collection. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the collection.

 

Interfaces for C++ Programming

This collection implements the IFPCUserSets interface.

Requirements

Minimum supported client

Windows Vista, None supported

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

Forefront Threat Management Gateway (TMG) 2010

IDL

Msfpccom.idl

See also

COM Objects

 

 

Build date: 7/12/2010