Navigation
API > API/Plugins > API/Plugins/StormSyncDrives > API/Plugins/StormSyncDrives/IStormSyncDrivesModule
Description
Register and mount the provided mount point config (with a Mount Point root path and Mount Directory filesystem path)
Mount root path and directory will be validated first, and errors will be logged into Message Logs.
| Name | RegisterMountPoint |
| Type | function |
| Header File | /Engine/Plugins/VirtualProduction/StormSync/Source/StormSyncDrives/Public/IStormSyncDrivesModule.h |
| Include Path | #include "IStormSyncDrivesModule.h" |
bool RegisterMountPoint
(
const FStormSyncMountPointConfig & InMountPoint,
FText & ErrorText,
EStormSyncDriveErrorCode * OutError
)
true if we were able to register the mount point
Parameters
| Name | Remarks |
|---|---|
| InMountPoint | The config with root mount path & directory to mount |
| ErrorText | Localized text describing the error in case mounting failed |
| OutError | optional enum for further details on the operation's error if any |