Active Directory Provider::Group Remove

Removes an object from a Microsoft® Active Directory® group. Used by Microsoft® Provisioning Framework (MPF).

Group Remove is a wrapper for IADsGroup::Remove.

XML Input Schema

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

<executeData>1..1
  <group>1..1</group>
  <path>1..1</path>
  <flagSkipAction>0..1</flagSkipAction>
</executeData>

XML Output Schema

Group Remove does not return data.

Elements and Attributes

The following table describes the XML schema elements and attributes. Unless otherwise indicated, the data type is string.

Element Description, relationships, and attributes
executeData Description:
 Encapsulates the procedure's input data.

Children:
 flagSkipAction (minOccurs="0" maxOccurs="1")
group (minOccurs="1" maxOccurs="1")
path (minOccurs="0" maxOccurs="1")
flagSkipAction Description:
 Prevents the procedure from executing. If this element is specified, the procedure does not attempt to remove the object from the group, and rollback does not restore the object.

Now that MPF supports try/catch error handling (through try and catch elements), there is little need to specify flagSkipAction. This node was originally introduced to support error handling for Create Object. For example, a Create Object call ordinarily fails if the user already exists. To override this behavior, the request can include a flagIgnoreAlreadyExistsError node, which instructs Create Object to return a flagSkipAction node. Subsequent calls pass this node to prevent further operations on the object. In the case of Group Remove, the presence of flagSkipAction prevents accidental changes to the object.

Parent:
executeData

group Description:
 Lightweight directory access protocol (LDAP) path of the group.

Parent:
executeData

path Description:
 LDAP path of the object to remove from the group.

Parent:
executeData

See Also

Active Directory Provider, Preferred DC Active Directory Provider

Up Top of Page
© 1999-2002 Microsoft Corporation. All rights reserved.