IMAExtensible2GetPartitions.GetPartitions Method

This method is used to define logical partitions of the data in the data source.

Namespace: Microsoft.MetadirectoryServices
Assembly: Microsoft.MetadirectoryServicesEx (in Microsoft.MetadirectoryServicesEx.dll)

Usage

'Usage
Dim instance As IMAExtensible2GetPartitions
Dim configParameters As KeyedCollection(Of String, ConfigParameter)
Dim returnValue As IList(Of Partition)

returnValue = instance.GetPartitions(configParameters)

Syntax

'Declaration
Function GetPartitions ( _
    configParameters As KeyedCollection(Of String, ConfigParameter) _
) As IList(Of Partition)

IList<Partition> GetPartitions (
    KeyedCollection<string,ConfigParameter> configParameters
)

IList<Partition^>^ GetPartitions (
    KeyedCollection<String^, ConfigParameter^>^ configParameters
)

IList<Partition> GetPartitions (
    KeyedCollection<String,ConfigParameter> configParameters
)

function GetPartitions (
    configParameters : KeyedCollection<String,ConfigParameter>
) : IList<Partition>

Parameters

• configParameters
  Contains a collection of ConfigParameter objects.

Return Value

Returns a list of Partition.

Remarks

This method is only used when the DistinguishedNameStyle is set to LDAP.

A partition is a separate namespace within one shared schema. For example in Active Directory every domain is a partition within one forest. A partition is the logical grouping for import and export operations. Import and Export have partition as a context and all operations must happen in this context. Partitions are supposed to represent a hierarchy in LDAP. The dn on a partition is used in import to verify that all returned objects are within the scope of a partition. The partition dn is also used during provisioning from the metaverse to the connector space to determine which partition an object should be associated with during export.

A partition can also be marked to be HiddenByDefault. When this is set then the administrator must select to show “Show All” on the partitions page in the UI to see the partition and select it as a candidate for import/export. It is expected that namespaces dedicated for special uses, such as storing configuration and schema information, are hidden.

If this method is not implemented, then the “default” partition will be used.

Exceptions: Return values, Errors, and Exceptions

The following is an example of GetPartitions:

 public IList<Partition> GetPartitions(KeyedCollection<string, ConfigParameter> configParameters)
        {
            List<Partition> partitionList = new List<Partition>();
 
            partitionList.Add(Partition.Create(Guid.NewGuid(), "DC=contoso,DC=com"));
 
            return partitionList;
        }

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Change History

See Also

Reference

IMAExtensible2GetPartitions Interface
IMAExtensible2GetPartitions Members
Microsoft.MetadirectoryServices Namespace