GridFSBucket.RenameAsync Method (BsonValue, String, CancellationToken) (original) (raw)

GridFSBucketRenameAsync Method (BsonValue, String, CancellationToken)

Renames a GridFS file.

Namespace: MongoDB.Driver.GridFS
Assembly: MongoDB.Driver.GridFS (in MongoDB.Driver.GridFS.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed

Syntax

public Task RenameAsync( BsonValue id, string newFilename, CancellationToken cancellationToken = null )

Public Function RenameAsync ( id As BsonValue, newFilename As String, Optional cancellationToken As CancellationToken = Nothing ) As Task

member RenameAsync : id : BsonValue * newFilename : string * ?cancellationToken : CancellationToken (* Defaults: let _cancellationToken = defaultArg cancellationToken null *) -> Task

Parameters

id

Type: MongoDB.BsonBsonValue
The file id.

newFilename

Type: SystemString
The new filename.

cancellationToken (Optional)

Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: Task
A Task.

See Also

Reference