CPROJ.iRemoveDocument Method

CPROJiRemoveDocument Method

Removes (and closes if visible) a document from the current project.

Available since Oasis montaj version: 5.0
Limitations: May not be available if running outside of a Oasis Montaj or from a command line program.
License: Available to anyone.

Namespace: Geosoft.Desktop.GXNetX
Assembly: geosoft.desktop.gxnetx (in geosoft.desktop.gxnetx.dll)

Notes

The passed file name must be a valid file name complete with an extension and qualifiers (if applicable).

Syntax

C++

Copy

public static int iRemoveDocument(
	CGXNETCore gxNetShared,
	string name
)

Public Shared Function iRemoveDocument ( 
	gxNetShared As CGXNETCore,
	name As String
) As Integer

public:
static int iRemoveDocument(
	CGXNETCore^ gxNetShared, 
	String^ name
)

static member iRemoveDocument : 
        gxNetShared : CGXNETCore * 
        name : string -> int

Parameters

gxNetShared: Type: GeoEngine.Core.GXNetXCGXNETCore
A shared CGXNETCore
name: Type: SystemString
Document name

Return Value

Type: Int32
0 - Ok 1 - Document not found in project

Reference

CPROJ Class

Geosoft.Desktop.GXNetX Namespace