Interface IFCApplication

Namespace: FChoice.Foundation.Clarify.Compatibility
Assembly: FChoice.Foundation.Clarify.Compatibility.dll
Syntax
[Guid("76778FF4-8666-4eba-A60A-DA8D9F743A64")]
[ComVisible(true)]
public interface IFCApplication

Properties

base_objid

Declaration
int base_objid { get; }
Property Value
Type Description
System.Int32

clarify_ver

Declaration
string clarify_ver { get; }
Property Value
Type Description
System.String

ConnectionString

Declaration
string ConnectionString { get; }
Property Value
Type Description
System.String

ConvertTimeZone

Declaration
bool ConvertTimeZone { get; set; }
Property Value
Type Description
System.Boolean

DataProtectorEntropy

Declaration
string DataProtectorEntropy { set; }
Property Value
Type Description
System.String

db_name

Declaration
string db_name { get; }
Property Value
Type Description
System.String

db_type

Declaration
string db_type { get; }
Property Value
Type Description
System.String

GetMachineTimeZone

Declaration
string GetMachineTimeZone { get; }
Property Value
Type Description
System.String

IsDBTraveler

Declaration
bool IsDBTraveler { get; }
Property Value
Type Description
System.Boolean

IsDBUnicode

Declaration
bool IsDBUnicode { get; }
Property Value
Type Description
System.Boolean

IsFcflNet

Declaration
bool IsFcflNet { get; }
Property Value
Type Description
System.Boolean

LicenseExpirationDate

Declaration
string LicenseExpirationDate { get; }
Property Value
Type Description
System.String

LoggingConfigFilePath

Declaration
string LoggingConfigFilePath { get; set; }
Property Value
Type Description
System.String

Midnight

Declaration
string Midnight { get; set; }
Property Value
Type Description
System.String

schema_rev

Declaration
short schema_rev { get; }
Property Value
Type Description
System.Int16

ServerTimeZone

Declaration
string ServerTimeZone { get; set; }
Property Value
Type Description
System.String

site_id

Declaration
short site_id { get; }
Property Value
Type Description
System.Int16

TruncateStringFields

Declaration
bool TruncateStringFields { get; set; }
Property Value
Type Description
System.Boolean

WorkingDirectory

Declaration
string WorkingDirectory { get; set; }
Property Value
Type Description
System.String

Methods

build_mtm_name(String, String, String)

Declaration
string build_mtm_name(string tableName, string relationName, string inverseRelatioName)
Parameters
Type Name Description
System.String tableName
System.String relationName
System.String inverseRelatioName
Returns
Type Description
System.String

CreateSession(Object)

Declaration
FCSession CreateSession(object sessionId)
Parameters
Type Name Description
System.Object sessionId
Returns
Type Description
FCSession

CurrentSessions()

Declaration
string CurrentSessions()
Returns
Type Description
System.String

EncryptClarifyPassword(String, String)

Declaration
string EncryptClarifyPassword(string password, string fc_session_id)
Parameters
Type Name Description
System.String password
System.String fc_session_id
Returns
Type Description
System.String

EncryptDBPassword(String)

Declaration
string EncryptDBPassword(string password)
Parameters
Type Name Description
System.String password
Returns
Type Description
System.String

FileExists(String)

Declaration
bool FileExists(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
System.Boolean

FindString(Object)

Declaration
string FindString(object StringID)
Parameters
Type Name Description
System.Object StringID
Returns
Type Description
System.String

get_change_date_field(String)

Declaration
string get_change_date_field(string tableName)
Parameters
Type Name Description
System.String tableName
Returns
Type Description
System.String

get_dt_fields(String)

Declaration
string get_dt_fields(string tableName)
Parameters
Type Name Description
System.String tableName
Returns
Type Description
System.String

get_fields_types_lens(String, Boolean)

Declaration
string get_fields_types_lens(string tableName, bool includeRelations)
Parameters
Type Name Description
System.String tableName
System.Boolean includeRelations
Returns
Type Description
System.String

GetADPObjects(Object)

Declaration
Recordset GetADPObjects(object ObjectTypes)
Parameters
Type Name Description
System.Object ObjectTypes
Returns
Type Description
ADODB.Recordset

GetCountryList()

Declaration
Recordset GetCountryList()
Returns
Type Description
ADODB.Recordset

GetCountryObjid(String)

Declaration
int GetCountryObjid(string Country)
Parameters
Type Name Description
System.String Country
Returns
Type Description
System.Int32

GetDefaultCountry()

Declaration
string GetDefaultCountry()
Returns
Type Description
System.String

GetDefaultCountryObjId()

Declaration
int GetDefaultCountryObjId()
Returns
Type Description
System.Int32

GetDefaultState(String)

Declaration
string GetDefaultState(string Country)
Parameters
Type Name Description
System.String Country
Returns
Type Description
System.String

GetDefaultStateObjid(String)

Declaration
int GetDefaultStateObjid(string Country)
Parameters
Type Name Description
System.String Country
Returns
Type Description
System.Int32

GetDefaultTimeZone()

Declaration
string GetDefaultTimeZone()
Returns
Type Description
System.String

GetDefaultTimeZoneObjid()

Declaration
int GetDefaultTimeZoneObjid()
Returns
Type Description
System.Int32

GetFullStateObjid(String, String)

Declaration
int GetFullStateObjid(string Country, string State)
Parameters
Type Name Description
System.String Country
System.String State
Returns
Type Description
System.Int32

GetGbstDefault(String)

Declaration
string GetGbstDefault(string ListName)
Parameters
Type Name Description
System.String ListName
Returns
Type Description
System.String

GetGbstDefaultObjid(String)

Declaration
int GetGbstDefaultObjid(string ListName)
Parameters
Type Name Description
System.String ListName
Returns
Type Description
System.Int32

GetGbstElmById(String, Int32)

Declaration
string GetGbstElmById(string ListName, int ElmObjid)
Parameters
Type Name Description
System.String ListName
System.Int32 ElmObjid
Returns
Type Description
System.String

GetGbstElmObjid(String, String)

Declaration
int GetGbstElmObjid(string ListName, string Element)
Parameters
Type Name Description
System.String ListName
System.String Element
Returns
Type Description
System.Int32

GetGbstElmRankObjid(String, Int32)

Declaration
int GetGbstElmRankObjid(string ListName, int Rank)
Parameters
Type Name Description
System.String ListName
System.Int32 Rank
Returns
Type Description
System.Int32

GetGbstList(String, Object)

Declaration
Recordset GetGbstList(string ListName, object IncludeInactive)
Parameters
Type Name Description
System.String ListName
System.Object IncludeInactive
Returns
Type Description
ADODB.Recordset

GetHgbstElmDefault(String, Object, Object, Object, Object)

Declaration
string GetHgbstElmDefault(string ListName, object Element1, object Element2, object Element3, object Element4)
Parameters
Type Name Description
System.String ListName
System.Object Element1
System.Object Element2
System.Object Element3
System.Object Element4
Returns
Type Description
System.String

GetHgbstElmDefaultObjid(String, Object, Object, Object, Object)

Declaration
int GetHgbstElmDefaultObjid(string ListName, object Element1, object Element2, object Element3, object Element4)
Parameters
Type Name Description
System.String ListName
System.Object Element1
System.Object Element2
System.Object Element3
System.Object Element4
Returns
Type Description
System.Int32

GetHgbstElmObjId(String, String, Object, Object, Object, Object)

Declaration
int GetHgbstElmObjId(string TheElement, string ListName, object Element1, object Element2, object Element3, object Element4)
Parameters
Type Name Description
System.String TheElement
System.String ListName
System.Object Element1
System.Object Element2
System.Object Element3
System.Object Element4
Returns
Type Description
System.Int32

GetHgbstList(String, Object, Object, Object, Object, Object)

Declaration
Recordset GetHgbstList(string ListName, object Element1, object Element2, object Element3, object Element4, object includeInactive)
Parameters
Type Name Description
System.String ListName
System.Object Element1
System.Object Element2
System.Object Element3
System.Object Element4
System.Object includeInactive
Returns
Type Description
ADODB.Recordset

GetLocalizedGbstDefault(String)

Declaration
string GetLocalizedGbstDefault(string listName)
Parameters
Type Name Description
System.String listName
Returns
Type Description
System.String

GetLocalizedGbstElmById(String, Int32)

Declaration
string GetLocalizedGbstElmById(string listName, int elmObjID)
Parameters
Type Name Description
System.String listName
System.Int32 elmObjID
Returns
Type Description
System.String

GetRelationData(String, String)

Declaration
Recordset GetRelationData(string relationName, string tableName)
Parameters
Type Name Description
System.String relationName
System.String tableName
Returns
Type Description
ADODB.Recordset

GetResClauses(Int32, ref String)

Declaration
bool GetResClauses(int tblNum, ref string clauses)
Parameters
Type Name Description
System.Int32 tblNum
System.String clauses
Returns
Type Description
System.Boolean

GetResClausesStr(Int32)

Declaration
string GetResClausesStr(int tblNum)
Parameters
Type Name Description
System.Int32 tblNum
Returns
Type Description
System.String

GetResTbl(Int32, ref String[])

Declaration
bool GetResTbl(int tblNum, ref string[] the_res)
Parameters
Type Name Description
System.Int32 tblNum
System.String[] the_res
Returns
Type Description
System.Boolean

GetServerTimeZoneOffset()

Declaration
int GetServerTimeZoneOffset()
Returns
Type Description
System.Int32

GetShortTimeZoneObjId(String)

Declaration
int GetShortTimeZoneObjId(string TimeZone)
Parameters
Type Name Description
System.String TimeZone
Returns
Type Description
System.Int32

GetStateObjid(String, String)

Declaration
int GetStateObjid(string Country, string State)
Parameters
Type Name Description
System.String Country
System.String State
Returns
Type Description
System.Int32

GetStates(String)

Declaration
Recordset GetStates(string Country)
Parameters
Type Name Description
System.String Country
Returns
Type Description
ADODB.Recordset

GetTableFields(String)

Declaration
Recordset GetTableFields(string tableName)
Parameters
Type Name Description
System.String tableName
Returns
Type Description
ADODB.Recordset

GetTableID(String)

Declaration
int GetTableID(string TableName)
Parameters
Type Name Description
System.String TableName
Returns
Type Description
System.Int32

GetTableName(Int32)

Declaration
string GetTableName(int TableNum)
Parameters
Type Name Description
System.Int32 TableNum
Returns
Type Description
System.String

GetTableRels(String, Boolean)

Declaration
Recordset GetTableRels(string tableName, bool allowOneToMany)
Parameters
Type Name Description
System.String tableName
System.Boolean allowOneToMany
Returns
Type Description
ADODB.Recordset

GetTablesAndViews(Object)

Declaration
Recordset GetTablesAndViews(object TablesOnly)
Parameters
Type Name Description
System.Object TablesOnly
Returns
Type Description
ADODB.Recordset

GetTimeZoneList()

Declaration
Recordset GetTimeZoneList()
Returns
Type Description
ADODB.Recordset

GetTimeZoneObjid(String)

Declaration
int GetTimeZoneObjid(string TimeZone)
Parameters
Type Name Description
System.String TimeZone
Returns
Type Description
System.Int32

GetTimeZoneOffset(String)

Declaration
int GetTimeZoneOffset(string TimeZone)
Parameters
Type Name Description
System.String TimeZone
Returns
Type Description
System.Int32

GetTimeZonesInCountry(String)

Declaration
Recordset GetTimeZonesInCountry(string Country)
Parameters
Type Name Description
System.String Country
Returns
Type Description
ADODB.Recordset

Initialize()

Declaration
void Initialize()

InitializeFull(String, String, String, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)

Declaration
void InitializeFull(string LoginName, string password, string DBServer, string DBName, object DBType, object LogFile, object SqlLogFile, object SQLLogging, object fcAppLogging, object fcSessionLogging, object fcGenericLogging, object fcBulkLogging, object fcSqlExecLogging, object NoCacheFile)
Parameters
Type Name Description
System.String LoginName
System.String password
System.String DBServer
System.String DBName
System.Object DBType
System.Object LogFile
System.Object SqlLogFile
System.Object SQLLogging
System.Object fcAppLogging
System.Object fcSessionLogging
System.Object fcGenericLogging
System.Object fcBulkLogging
System.Object fcSqlExecLogging
System.Object NoCacheFile

is_it_a_field(String, String)

Declaration
bool is_it_a_field(string tableName, string fieldName)
Parameters
Type Name Description
System.String tableName
System.String fieldName
Returns
Type Description
System.Boolean

is_it_a_table(String)

Declaration
bool is_it_a_table(string tableName)
Parameters
Type Name Description
System.String tableName
Returns
Type Description
System.Boolean

is_it_change_field(String, String)

Declaration
bool is_it_change_field(string tableName, string fieldName)
Parameters
Type Name Description
System.String tableName
System.String fieldName
Returns
Type Description
System.Boolean

is_it_date_field(String, String)

Declaration
bool is_it_date_field(string tableName, string fieldName)
Parameters
Type Name Description
System.String tableName
System.String fieldName
Returns
Type Description
System.Boolean

is_it_int_field(String, String)

Declaration
bool is_it_int_field(string tableName, string fieldName)
Parameters
Type Name Description
System.String tableName
System.String fieldName
Returns
Type Description
System.Boolean

is_it_searchable(String, String)

Declaration
bool is_it_searchable(string tableName, string fieldName)
Parameters
Type Name Description
System.String tableName
System.String fieldName
Returns
Type Description
System.Boolean

is_it_string_fld(String, String)

Declaration
bool is_it_string_fld(string tableName, string fieldName)
Parameters
Type Name Description
System.String tableName
System.String fieldName
Returns
Type Description
System.Boolean

is_it_unicode(String, String)

Declaration
bool is_it_unicode(string tableName, string fieldName)
Parameters
Type Name Description
System.String tableName
System.String fieldName
Returns
Type Description
System.Boolean

is_rel_exclusive(Int32, String, ref String, ref String)

Declaration
bool is_rel_exclusive(int tbl_num, string relationName, ref string tbl_fld, ref string objid_fld)
Parameters
Type Name Description
System.Int32 tbl_num
System.String relationName
System.String tbl_fld
System.String objid_fld
Returns
Type Description
System.Boolean

is_rel_mandatory(Int32, String)

Declaration
bool is_rel_mandatory(int tbl_num, string relationName)
Parameters
Type Name Description
System.Int32 tbl_num
System.String relationName
Returns
Type Description
System.Boolean

IsCountry(String)

Declaration
bool IsCountry(string Country)
Parameters
Type Name Description
System.String Country
Returns
Type Description
System.Boolean

IsFullState(String, String)

Declaration
bool IsFullState(string Country, string State)
Parameters
Type Name Description
System.String Country
System.String State
Returns
Type Description
System.Boolean

IsInGbstLst(String, String)

Declaration
bool IsInGbstLst(string ListName, string Element)
Parameters
Type Name Description
System.String ListName
System.String Element
Returns
Type Description
System.Boolean

IsInHgbstList(String, String, Object, Object, Object, Object)

Declaration
bool IsInHgbstList(string TheElement, string ListName, object Element1, object Element2, object Element3, object Element4)
Parameters
Type Name Description
System.String TheElement
System.String ListName
System.Object Element1
System.Object Element2
System.Object Element3
System.Object Element4
Returns
Type Description
System.Boolean

IsOnDST(String, DateTime)

Declaration
bool IsOnDST(string TheTimeZone, DateTime TheDate)
Parameters
Type Name Description
System.String TheTimeZone
System.DateTime TheDate
Returns
Type Description
System.Boolean

IsState(String, String)

Declaration
bool IsState(string Country, string State)
Parameters
Type Name Description
System.String Country
System.String State
Returns
Type Description
System.Boolean

IsTimeZone(String)

Declaration
bool IsTimeZone(string TImeZone)
Parameters
Type Name Description
System.String TImeZone
Returns
Type Description
System.Boolean

IsTimeZoneInCountry(String, String, Boolean)

Declaration
bool IsTimeZoneInCountry(string Country, string TimeZone, bool IsFullName)
Parameters
Type Name Description
System.String Country
System.String TimeZone
System.Boolean IsFullName
Returns
Type Description
System.Boolean

Log(Object, Object)

Declaration
void Log(object TheMessageType, object TheMessage)
Parameters
Type Name Description
System.Object TheMessageType
System.Object TheMessage

LogEx(String, String)

Declaration
void LogEx(string logLevel, string logMessage)
Parameters
Type Name Description
System.String logLevel
System.String logMessage

RankIsInGbstLst(String, Int32)

Declaration
bool RankIsInGbstLst(string ListName, int Rank)
Parameters
Type Name Description
System.String ListName
System.Int32 Rank
Returns
Type Description
System.Boolean

SetServerTimeZoneToMachineTimeZone()

Declaration
void SetServerTimeZoneToMachineTimeZone()

sprintf(String, Object, Object, Object, Object, Object, Object)

Declaration
string sprintf(string inputString, object arg1, object arg2, object arg3, object arg4, object arg5, object arg6)
Parameters
Type Name Description
System.String inputString
System.Object arg1
System.Object arg2
System.Object arg3
System.Object arg4
System.Object arg5
System.Object arg6
Returns
Type Description
System.String

UpdateCache()

Declaration
void UpdateCache()

UpdateSchemaCache()

Declaration
void UpdateSchemaCache()

ValidateEncryptedPassword(String, String, Int16)

Declaration
bool ValidateEncryptedPassword(string str, string encr, short pre9)
Parameters
Type Name Description
System.String str
System.String encr
System.Int16 pre9
Returns
Type Description
System.Boolean