GraphicAccess4 Interface Methods

ImportGraphics Method

Imports graphics from existing XML files available in a folder. Galaxy, folder path, an overwrite flag, progress of the operation and a token to determine if the operation is cancelled are passed as parameters to the ImportGraphics function.

Syntax

Task<IGraphicAccessResult> ImportGraphics(IGalaxy galaxy, string strFolderPath, bool bOverWrite, IGraphicOperationStatus opNotifier = null, CancellationToken cancelToken = default);

Parameters

galaxy

Points to a galaxy to which graphics will be imported or where the API will be run.

strFolderPath

Directory folder location of the XML files.

bOverWrite

Boolean flag that indicates if an existing graphic can be overwritten by an imported graphic with the same name.

opNotifier

Returns the status of the import operation to the calling function (client)

cancelToken

Calling function (Client) can set this token to cancel the import graphics operation. For more information on CancellationToken, see the MSDN help.

After the import operation is complete, the results are set to Task<IGraphicAccessResult> which is derived from ICommandResult. A message appears and indicates if the operation succeeded or failed. For detailed information about the ICommandResult interface, see the GRAccess Toolkit API Help.

A succeeded message only means the import operation finished successfully. It does not indicate the quality of the exported XML file or the imported graphic. Check the SMC log file for any warning or error messages after each import operation.