Share via


ShareFileRenameOptions Class

Definition

Optional parameters for renaming a File or Directory.

public class ShareFileRenameOptions
type ShareFileRenameOptions = class
Public Class ShareFileRenameOptions
Inheritance
ShareFileRenameOptions

Constructors

ShareFileRenameOptions()

Properties

ContentType

Optional content type to set on the File. Note that this parameter does not apply for Directories.

DestinationConditions

Destination request conditions.

FilePermission

Optional file permission to set on the destination file or directory.

FilePermissionFormat

Optional format of the FilePermission.

IgnoreReadOnly

Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail.

Metadata

Optional custom metadata to set on the destination.

ReplaceIfExists

Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed.

SmbProperties

Optional SMB properties to set on the destination file or directory.

SourceConditions

Source request conditions. This parameter is only applicable if the source is a file.

Applies to