Interface ISTGeomFiler

Generates a SGF file

Namespace: STGeomApiTypes

Assembly: STGeomApiTypes.dll

Syntax

[Guid("DBB8B036-6D6C-4F90-AEB6-A2BE211F6318")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ISTGeomFiler

Methods

CloseFile()

Finish writing the SGF file

Declaration

bool CloseFile()

Returns

Type	Description
bool	Success status

OpenFile(string, ISTGeomReceiver)

Open the SGF file and read it

Declaration

bool OpenFile(string FileName, ISTGeomReceiver Receiver)

Parameters

Type	Name	Description
string	FileName	The path to the SGF file
ISTGeomReceiver	Receiver	The interface where the SGF file will be read

Returns

Type	Description
bool	Success status

StartFile(string)

Start writing a SGF file

Declaration

bool StartFile(string FileName)

Parameters

Type	Name	Description
string	FileName	The path to the SGF file

Returns

Type	Description
bool	Success status

StartReadFile(string)

Open a SGF file and read ONLY the header (fast, no geometry). Use ISGFFile.SaveToReceiver to replay the geometry afterwards.

Declaration

ISGFFile StartReadFile(string FileName)

Parameters

Type	Name	Description
string	FileName	The path to the SGF file

Returns

Type	Description
ISGFFile	The opened file object (header parsed); nil on failure

StopReadFile(out ISGFFile)

Declaration

void StopReadFile(out ISGFFile sgfFile)

Parameters

Type	Name	Description
ISGFFile	sgfFile