DeleteOptionSetRequest Class

Definition

Contains the data that is needed to delete a global option set.

public ref class DeleteOptionSetRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class DeleteOptionSetRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type DeleteOptionSetRequest = class
    inherit OrganizationRequest
Public NotInheritable Class DeleteOptionSetRequest
Inherits OrganizationRequest
Inheritance
DeleteOptionSetRequest
Attributes

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface.

// Deletes Option sets
        DeleteOptionSetRequest deleteRequest = new DeleteOptionSetRequest
          {
             Name = _globalOptionSetName
           };
           svc.Execute(deleteRequest);

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of DeleteOptionSetResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges listed in DeleteOptionSet message privileges.

Notes for Callers

You cannot delete a global option set that is used by a picklist attribute. Use RetrieveDependentComponentsRequest to determine whether the global option set has any dependencies.

Constructors

DeleteOptionSetRequest()

Initializes a new instance of the DeleteOptionSetRequest class

Properties

ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Name

Gets or sets the name of the global option set to delete. Required.

Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to