|
|
Downloads a remote URI to the protocols internal cache.
Namespace: Autodesk.Navisworks.Api.Plugins
Assembly: Autodesk.Navisworks.Api (in Autodesk.Navisworks.Api.dll)
Syntax
| Visual Basic |
|---|
Public MustOverride Function GetFileToCache ( _ uri As Uri, _ progress As Progress, _ <OutAttribute> ByRef cachePath As String _ ) As Boolean |
| C# |
|---|
public abstract bool GetFileToCache( Uri uri, Progress progress, out string cachePath ) |
| Visual C++ |
|---|
public: virtual bool GetFileToCache( Uri^ uri, Progress^ progress, [OutAttribute] String^% cachePath ) abstract |
Parameters
- uri
- Type: System..::..Uri
- progress
- Type: Autodesk.Navisworks.Api..::..Progress
- cachePath
- Type: System..::..String%
Remarks
This function is called to download an entire file to the
protocols own cache. This is similar to the GetFile function,
but instead the protocol decides where the local file should go
and returns it.
If this operation could take a long time, you should use the
provided progress object to check to see if the operation has been
cancelled by the user.