DeleteOptionValue Message (MetadataService)

banner art

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

Works for all deployment types Works online only

Deletes an option value from a list of options.

The relevant classes are specified in the following table.

Type Class
Request DeleteOptionValueRequest
Response DeleteOptionValueResponse

Remarks

To perform this action, the caller must be a user in the organization for which metadata is requested and must have Write Attribute privilege.

Example

The following example shows how to use the DeleteOptionValue message.

[C#]
// Create an authentication token.
CrmAuthenticationToken token = new CrmAuthenticationToken();
token.OrganizationName = "AdventureWorksCycle";

// You can use enums.cs from the SDK\Helpers folder to get the enumeration for Active Directory authentication.
token.AuthenticationType = 0; 

// Create the metadata Web service
MetadataService metadataService = new MetadataService();
metadataService.Url = "http://<servername>:<port>/MSCRMServices/2007/MetadataService.asmx";
metadataService.CrmAuthenticationTokenValue = token;
metadataService.Credentials = System.Net.CredentialCache.DefaultCredentials;
metadataService.PreAuthenticate = true;

// Create the request.
DeleteOptionValueRequest deleteRequest = new DeleteOptionValueRequest();

// Set the properties for the request.
deleteRequest.AttributeLogicalName = "statuscode";
deleteRequest.EntityLogicalName = EntityName.contact.ToString();

// Remove a previously inserted option.
deleteRequest.Value = 200000;

DeleteOptionValueResponse deleteResponse = (DeleteOptionValueResponse)metadataService.Execute(deleteRequest);

[Visual Basic .NET]
' Set up the CRM service.
Dim token As New CrmAuthenticationToken()
' You can use enums.cs from the SDK\Helpers folder to get the enumeration for Active Directory authentication.
token.AuthenticationType = 0
token.OrganizationName = "AdventureWorksCycle";

// Create the metadata Web service.
Dim metadataService As New MetadataService ()
metadataService.Url = "http://<servername>:<port>/mscrmservices/2007/MetadataService.asmx";
metadataService.CrmAuthenticationTokenValue = token;
metadataService.Credentials = System.Net.CredentialCache.DefaultCredentials
metadataService.PreAuthenticate = true;

' Create the request.
Dim deleteRequest As New DeleteOptionValueRequest()

' Use an existing attribute.
deleteRequest.EntityLogicalName = EntityName.contact.ToString()
deleteRequest.AttributeLogicalName = "address1_addresstypecode"

' Remove a previously inserted option.
deleteRequest.Value = 200000

' Send the message.
Dim deleteResponse As DeleteOptionValueResponse = CType(metadataService.Execute(deleteRequest), DeleteOptionValueResponse)

See Also

Reference

© 2010 Microsoft Corporation. All rights reserved.