Ig2SettingAtt (Object)

Interface dedicated to modify or read the current settings corresponding to the IG2 Data Exchange

Ensure consistency with the C++ interface to which the work is delegated.


Properties


Property ExportMode() As (Read Only)
Get the Export Mode option value.
Parameters:
oMode
Legal values: An available value of the enum CatIg2ExportModeEnum.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Property ExportSheets() As (Read Only)
Get the Exported Sheets option value.
Parameters:
oSheets
Legal values: An available value of the enum CatIg2ExportSheetsEnum.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Property ExportViewAsViewport() As (Read Only)
Get the value of the Export Views as Viewports option. That value is only taken into account when the export mode is set to Semantic.
Parameters:
oViewsAsViewports
Legal values:
TRUE : Export Views as Viewports enable.
FALSE : Export Views as Viewports disable.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Property ImportDestinationView() As (Read Only)
Get the destination view.
Parameters:
oDestinationView
Legal values: An available value of the enum CatIg2ImportDestinationViewEnum.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Property ImportDftStandard() As (Read Only)
Get the name of the Drafting standard, which define the standard of the resulting CATDrawing file.
Parameters:
oDftStandard
the CATBSTR corresponding to the Drafting standard.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Property ImportDimensions() As (Read Only)
Get the Import dimensions option value.
Parameters:
oDimensions
Legal values: An available value of the enum CatIg2ImportDimensionsEnum.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Property ImportEndPoints() As (Read Only)
Get the Create End Points option value.
Parameters:
oEndPoints
Legal values: An available value of the enum CatIg2ImportCreateEndPointsEnum.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Property ImportUnit() As (Read Only)
Get the import unit.
Parameters:
oUnit
Legal values: An available value of the enum CatIg2ImportUnitEnum.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure

Methods


Func GetExportModeInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the Export Mode option.
Parameters:
ioAdminLevel

If the option is locked, AdminLevel gives the administration level that imposes the value of the option.
If the option is not locked, AdminLevel gives the administration level that will give the value of the option after a reset.
ioLocked
Indicates if the option has been locked.
oModified
Indicates if the option has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Func GetExportSheetsInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the Exported Sheets option.
Parameters:
ioAdminLevel

If the option is locked, AdminLevel gives the administration level that imposes the value of the option.
If the option is not locked, AdminLevel gives the administration level that will give the value of the option after a reset.
ioLocked
Indicates if the option has been locked.
oModified
Indicates if the option has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Func GetExportViewAsViewportInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the Export Views as Viewports option.
Parameters:
ioAdminLevel

If the option is locked, AdminLevel gives the administration level that imposes the value of the option.
If the option is not locked, AdminLevel gives the administration level that will give the value of the option after a reset.
ioLocked
Indicates if the option has been locked.
oModified
Indicates if the option has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Func GetImportDestinationViewInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the destination view option.
Parameters:
ioAdminLevel

If the option is locked, AdminLevel gives the administration level that imposes the value of the option.
If the option is not locked, AdminLevel gives the administration level that will give the value of the option after a reset.
ioLocked
Indicates if the option has been locked.
oModified
Indicates if the option has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Func GetImportDftStandardInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the Drafting standard option.
Parameters:
ioAdminLevel

If the option is locked, AdminLevel gives the administration level that imposes the value of the option.
If the option is not locked, AdminLevel gives the administration level that will give the value of the option after a reset.
ioLocked
Indicates if the option has been locked.
oModified
Indicates if the option has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Func GetImportDimensionsInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the Import dimensions option.
Parameters:
ioAdminLevel

If the option is locked, AdminLevel gives the administration level that imposes the value of the option.
If the option is not locked, AdminLevel gives the administration level that will give the value of the option after a reset.
ioLocked
Indicates if the option has been locked.
oModified
Indicates if the option has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Func GetImportEndPointsInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the Create End Points option.
Parameters:
ioAdminLevel

If the option is locked, AdminLevel gives the administration level that imposes the value of the option.
If the option is not locked, AdminLevel gives the administration level that will give the value of the option after a reset.
ioLocked
Indicates if the option has been locked.
oModified
Indicates if the option has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Func GetImportUnitInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the import unit option.
Parameters:
ioAdminLevel

If the option is locked, AdminLevel gives the administration level that imposes the value of the option.
If the option is not locked, AdminLevel gives the administration level that will give the value of the option after a reset.
ioLocked
Indicates if the option has been locked.
oModified
Indicates if the option has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub SetExportModeLock( iLocked)
Locks or unlocks the Export Mode option if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE: to lock the option.
FALSE: to unlock the option.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub SetExportSheetsLock( iLocked)
Locks or unlocks the Exported Sheets option if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE: to lock the option.
FALSE: to unlock the option.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub SetExportViewAsViewportLock( iLocked)
Locks or unlocks the Export Views as Viewports option if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE: to lock the option.
FALSE: to unlock the option.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub SetImportDestinationViewLock( iLocked)
Locks or unlocks the import destination view if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE: to lock the option.
FALSE: to unlock the option.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub SetImportDftStandardLock( iLocked)
Locks or unlocks the Drafting standard option if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE: to lock the option.
FALSE: to unlock the option.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub SetImportDimensionsLock( iLocked)
Locks or unlocks the Import dimensions option if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE: to lock the option.
FALSE: to unlock the option.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub SetImportEndPointsLock( iLocked)
Locks or unlocks the Create End Points option if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE: to lock the option.
FALSE: to unlock the option.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub SetImportUnitLock( iLocked)
Locks or unlocks the import unit option if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE: to lock the option.
FALSE: to unlock the option.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub set_ExportMode( iMode)
Set the Export Mode option value.
Parameters:
iMode
Legal values: An available value of the enum CatIg2ExportModeEnum.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub set_ExportSheets( iSheets)
set the Exported Sheets option value.
Parameters:
iSheets
Legal values: An available value of the enum CatIg2ExportSheetsEnum.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub set_ExportViewAsViewport( iViewsAsViewports)
Set the value of the Export Views as Viewports option. That value is only taken into account when the export mode is set to Semantic.
Parameters:
iViewsAsViewports
Legal values:
TRUE : Enable the export of views as Viewports.
FALSE : Disable the export of views as Viewports.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub set_ImportDestinationView( iDestinationView)
Set the destination view.
Parameters:
iDestinationView
Legal values: An available value of the enum CatIg2ImportDestinationViewEnum
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub set_ImportDftStandard( iDftStandard)
Set the name of the Drafting standard, which define the standard of the resulting CATDrawing file.
Parameters:
iDftStandard
the CATBSTR corresponding to the Drafting standard.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub set_ImportDimensions( iDimensions)
Set the Import dimensions option value.
Parameters:
iDimensions
Legal values: An available value of the enum CatIg2ImportDimensionsEnum.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub set_ImportEndPoints( iEndPoints)
Set the Create End Points option value.
Parameters:
iEndPoints
Legal values: An available value of the enum CatIg2ImportCreateEndPointsEnum.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Sub set_ImportUnit( iUnit)
Set the import unit.
Parameters:
iUnit
Legal values: An available value of the enum CatIg2ImportUnitEnum
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure