GridFSBucketRenameAsync Method (BsonValue, String, CancellationToken) |
Note: This API is now obsolete.
Renames a GridFS file.
Namespace: MongoDB.Driver.GridFSAssembly: MongoDB.Driver.GridFS (in MongoDB.Driver.GridFS.dll) Version: 2.1.0
Syntax [ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")]
public Task RenameAsync(
BsonValue id,
string newFilename,
CancellationToken cancellationToken = null
)
<ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")>
Public Function RenameAsync (
id As BsonValue,
newFilename As String,
Optional cancellationToken As CancellationToken = Nothing
) As Task
[<ObsoleteAttribute("All new GridFS files should use an ObjectId as the Id.")>]
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:
TaskA Task.
See Also