SolidFramework.Platform.Platform Class Reference

Public Member Functions
delegate bool	TempFileIsAboutToBeCreatedCallback ([global::System.Runtime.InteropServices.MarshalAs(global::System.Runtime.InteropServices.UnmanagedType.LPWStr)] string tempFile)
	Delegate for the TempFileIsAboutToBeCreated callback

Static Public Member Functions
static void	SetTempFileIsAboutToBeCreatedCallback (global::System.Func< string, bool > callback)
static void	SetTempFileIsAboutToBeCreatedCallback (TempFileIsAboutToBeCreatedCallback callback)
	Registers a callback that can be used to identify when Solid Framework is about to create a temporary file. Note: This was added to provide a mechanism to allow Anti-virus software to discriminate between those files that were being created by Solid Framework, and those that malware had created.
static string	GetSupportDirectory ()
	Gets the directory where the Solid Framework DLLs are located (This will be where they were unpacked to if using the .NET Solid Framework).
static string	GetAppDataDirectory ()
	Gets the directory where the application data is be stored.
static void	SetAppDataDirectory (string path)
	Sets the directory where the application data is be stored.
static string	GetCMapDirectory ()
	Gets the directory where the Character Mapping information is stored. It is unlikely that you will need to modify this. The default value is the folder "CMap" Within the folder "Resources" within the SupportDirectory.
static void	SetCMapDirectory (string path)
	Sets the directory where the Character Mapping information is stored. It is unlikely that you will need to modify this. The default value is the folder "CMap" Within the folder "Resources" within the SupportDirectory.
static string	GetColorProfileDirectory ()
	Gets the directory where the Color Profile is stored. It is unlikely that you will need to modify this. The default value is the folder "Resources" within the SupportDirectory.
static void	SetColorProfileDirectory (string path)
	Sets the directory where the Color Profile is stored. It is unlikely that you will need to modify this. The default value is the folder "Resources" within the SupportDirectory.
static string	GetFontDirectory ()
	Linux only: Gets the directory which should be serached for fonts in addition to those in the system Fonts folder. This is not implemented for Windows versions of the SDK.
static void	SetFontDirectory (string path)
	Linux only: Sets the directory which should be serached for fonts in addition to those in the system Fonts folder. This is not implemented for Windows versions of the SDK.
static string	GetFontsDataBaseFile ()
	Gets the location of a file (usually called fonts.pdf) that contains information about the fonts that should be considered as candidates when reconstructing files. If this is specified then other fonts available on the system will be ignored. Note that the file must have a specific structure, and as such you cannot use just any PDF for this purpose. Please contact suppo.nosp@m.rt@s.nosp@m.olidd.nosp@m.ocum.nosp@m.ents..nosp@m.com for information about how to create a Fonts Database File.
static void	SetFontsDataBaseFile (string path)
	Gets the location of a file (usually called fonts.pdf) that contains information about the fonts that should be considered as candidates when reconstructing files. If this is specified then other fonts available on the system will be ignored. Note that the file must have a specific structure, and as such you cannot use just any PDF for this purpose. Please contact suppo.nosp@m.rt@s.nosp@m.olidd.nosp@m.ocum.nosp@m.ents..nosp@m.com for information about how to create a Fonts Database File.
static string	GetTempDirectory ()
	Gets the path to the directory that this process will save its temporary files into
static string	GetFullVersion ()
	Gets the full version string for this version of SolidFramework (e.g. "9.2.8680.1")
static string	GetVersion ()
	Gets the version string for this version of SolidFramework (e.g. "9.2")
static string	GetBuild ()
	Gets the build number for this version of SolidFramework (e.g. "8680")
static string	GetLogFilename ()
	Gets the name of the logfile that is being generated by Solid Framework. If this value is empty then logging is not occurring. This is an alternative method of getting SolidFramework.Plumbing.Logging.Instance.Path;
static void	SetLogFilename (string path)
	Sets the name of the logfile that Solid Framework should generate. If this value is set then logging is enabled. This has the same effect as setting SolidFramework.Plumbing.Logging.Instance.Path = path;
static void	WriteToLog (string content)
	Writes the specific text to the logfile that is generated by Solid Framework.
static bool	SetWarningLevel (SolidFramework.Plumbing.WarningLevelType val)
	Sets the level of messages that will be logged. It is unlikely that you will need to change this.
static SolidFramework.Plumbing.WarningLevelType	GetWarningLevel ()
	Gets the level of messages that will be logged. It is unlikely that you will need to change this.
static void	SupportPlatformIndependentPaths (bool value)
	Sets whether SolidFramework should accept both '\' and '/' as directory separators Defaults to false.
static void	Terminate ()
	Unloads the converters and cleans up the temporary files
static void	Initialize ()
	Initializes SolidFramework's native platform from the default path, installing it if it doesn't exist
static void	Initialize (string path)
	Initializes SolidFramework's native platform from the specified path, installing it if it doesn't exist The native platform will be automatically updated if it doesn't match this version of SolidFramework More...
static void	Initialize (string path, bool? replaceExisting)
	Initializes SolidFramework's native platform from the specified path, installing it if it doesn't exist If replaceExisting is true, the native platform will be updated even if it appears to be the same version If replaceExisting is null, the native platform will only be updated if it appears to be a different version of SolidFramework If replaceExisting is false, the native platform will not be updated even if its incompatible version of SolidFramework (not recommended) More...

Member Function Documentation

Initialize() [1/2]

static void SolidFramework.Platform.Platform.Initialize ( string  path )

static

Initializes SolidFramework's native platform from the specified path, installing it if it doesn't exist The native platform will be automatically updated if it doesn't match this version of SolidFramework

Parameters

path	The path to load the native platform from

Initialize() [2/2]

static void SolidFramework.Platform.Platform.Initialize ( string  path, bool?  replaceExisting  )

static

Initializes SolidFramework's native platform from the specified path, installing it if it doesn't exist If replaceExisting is true, the native platform will be updated even if it appears to be the same version If replaceExisting is null, the native platform will only be updated if it appears to be a different version of SolidFramework If replaceExisting is false, the native platform will not be updated even if its incompatible version of SolidFramework (not recommended)

Parameters

path	The path to load the native platform from
replaceExisting	Whether to update the native platform or not