Share via


DeleteFileRequest Class

Definition

Contains the data needed to delete a stored binary file.

public ref class DeleteFileRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class DeleteFileRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type DeleteFileRequest = class
    inherit OrganizationRequest
Public NotInheritable Class DeleteFileRequest
Inherits OrganizationRequest
Inheritance
DeleteFileRequest
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 instance.

/// <summary>
/// Demonstrates how to delete a file.
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance.</param>
/// <param name="fileId">The ID of the file to delete.</param>
static void DeleteFile(IOrganizationService service, Guid fileId)
{
      DeleteFileRequest deleteFileRequest = new()
      {
         FileId = fileId
      };
      service.Execute(deleteFileRequest);
}

Remarks

Learn how to delete file column data

Learn how to use file column data

Constructors

DeleteFileRequest()

Initializes a new instance of the DeleteFileRequest class.

Properties

ExtensionData

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

(Inherited from OrganizationRequest)
FileId

Gets or sets the identifier of the stored binary file.

Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
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 the request. 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