GridFSBucketRenameAsync Method (ObjectId, String, CancellationToken) |
Renames a GridFS file.
Namespace: MongoDB.Driver.GridFSAssembly: MongoDB.Driver.GridFS (in MongoDB.Driver.GridFS.dll) Version: 2.1.0
Syntax public Task RenameAsync(
ObjectId id,
string newFilename,
CancellationToken cancellationToken = null
)
Public Function RenameAsync (
id As ObjectId,
newFilename As String,
Optional cancellationToken As CancellationToken = Nothing
) As Task
abstract RenameAsync :
id : ObjectId *
newFilename : string *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task
override RenameAsync :
id : ObjectId *
newFilename : string *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task
Parameters
- id
- Type: MongoDB.BsonObjectId
The file id. - newFilename
- Type: SystemString
The new filename. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskA Task.
Implements
IGridFSBucketRenameAsync(ObjectId, String, CancellationToken)See Also