RemoveSolutionComponentRequest RemoveSolutionComponentRequest RemoveSolutionComponentRequest RemoveSolutionComponentRequest Class

Definition

Contains the data that is needed to remove a component from an unmanaged solution.

For the Web API use the RemoveSolutionComponent Action.

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

Examples


// Remove a Solution Component
//Remove the Account entity from the solution

      var retrieveForRemoveAccountRequest = new RetrieveEntityRequest()
      {
          LogicalName = Account.EntityLogicalName
      };
      
      var retrieveForRemoveAccountResponse = (RetrieveEntityResponse)svc.Execute(retrieveForRemoveAccountRequest);

      var removeReq = new RemoveSolutionComponentRequest()
      {
          ComponentId = (Guid)retrieveForRemoveAccountResponse.EntityMetadata.MetadataId,
          ComponentType = (int)componenttype.Entity,
          SolutionUniqueName = solution.UniqueName
      };
      svc.Execute(removeReq);

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.

solutions#WorkWithSolutions6 solutionsVB#WorkWithSolutions6

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 RemoveSolutionComponentResponse.

Privileges and Access Rights

To perform this action, the caller must have the privileges that are listed in RemoveSolutionComponent message privileges.

Constructors

RemoveSolutionComponentRequest() RemoveSolutionComponentRequest() RemoveSolutionComponentRequest() RemoveSolutionComponentRequest()

Initializes a new instance of the RemoveSolutionComponentRequest class.

Properties

ComponentId ComponentId ComponentId ComponentId

Gets or sets the ID of the solution component. Required.

ComponentType ComponentType ComponentType ComponentType

Gets or sets the value that represents the solution component that you want to add. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

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

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

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

(Inherited from OrganizationRequest)
SolutionUniqueName SolutionUniqueName SolutionUniqueName SolutionUniqueName

Gets or sets the value of the Solution.UniqueName attribute of the solution for which you want to add the solution component. Required.

Applies to