Unigine::FileSystemMount Class

FileSystemMount Class

Members

---

int getAccess ( ) #

Returns the current access mode of the mount point.

Return value

Mount point access mode, one of the ACCESS_* values.

const char * getName ( ) #

Returns the name of the mount point.

Return value

Mount point name.

const char * getDataPath ( ) #

Returns the absolute path to the mounted folder/package.

Return value

Absolute path to the mounted folder/package.

const char * getVirtualPath ( ) #

Returns the virtual path to the folder to which the contents of the external folder/package is mounted.

Return value

Virtual path to the folder to which the contents of the external folder/package is mounted.

const char * getUMountPath ( ) #

Returns the absolute path to the *.umount file.

Return value

Absolute path to the *.umount file.

void setExclusiveFilters ( Vector< String > & OUT_filters ) #

Sets the list of exclusive filters (whitelist) to be used for files as a list of wildcards.

Arguments

• Vector< String > & OUT_filters - List of wildcards to be used to filter files in the mounted folder/package.
  Notice

  Maximum number of patterns that can be used is limited to 32.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

void getExclusiveFilters ( Vector< String > & OUT_filters ) #

Returns the list of exclusive filters (whitelist) used for files as a list of wildcards.

Arguments

• Vector< String > & OUT_filters - List of wildcards currently used to filter files in the mounted folder/package.
  Notice

  Maximum number of patterns that can be used is limited to 32.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

void setIgnoreFilters ( Vector< String > & OUT_filters ) #

Sets the list of ignore filters (blacklist) to be used for files as a list of wildcards.

Arguments

• Vector< String > & OUT_filters - List of wildcards to be used to filter out files to be ignored in the mounted folder/package.
  Notice

  Maximum number of patterns that can be used is limited to 32.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

void getIgnoreFilters ( Vector< String > & OUT_filters ) #

Returns the list of ignore filters (blacklist) used for files as a list of wildcards.

Arguments

• Vector< String > & OUT_filters - List of wildcards currently used to filter out files to be ignored in the mounted folder/package.
  Notice

  Maximum number of patterns that can be used is limited to 32.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

void getVirtualFiles ( Vector< String > & OUT_files ) #

Returns the list of virtual paths to all files in the mounted folder/package.

Arguments

• Vector< String > & OUT_files - Output vector to store the list of files stored in the mounted folder/package.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

bool isPathFilteredOut ( const char * path ) #

Returns a value indicating whether the specified path is filtered out by the exclusive and ignore filters.

Arguments

• const char * path - Any file path.

Return value

true if the specified path is filtered out after applying exclusive and ignore filters if any; otherwise, false.