CoreRMO::Flush Candidates

Removes candidates from candidate sets. Used by Microsoft. Provisioning Framework (MPF).

It is a wise practice to call Flush Candidates to clear candidate sets whenever candidates are no longer needed. This ensures that other procedure calls referencing the candidate set will not operate on extraneous candidates.

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.


XML Output Schema

Flush Candidates does not return data

Elements and Attributes

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

Element Description, relationships, and attributes
candidates Description:
Encapsulates data needed to interact with a candidate set.


category (minOccurs="0" maxOccurs="1")
(minOccurs="0" maxOccurs="1")

category Description:
Category of objects to flush from the candidate set: resourceInstance, resourceGroup, consumerInstance, or consumerGroup.


executeData Description:
Encapsulates the procedure's input data.

candidates (minOccurs="0" maxOccurs="1")

targetSet Description:
Candidate set to flush.



	<execute procedure="Flush Candidates" namespace="CoreRMO"> 


If targetSet and category are specified, this function removes only candidates from the specified candidate set that match the specified category. If no optional parameters are specified, it removes all candidates from every candidate set.

See Also

CoreRMO Provider, List Candidates, Resource Manager

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