Class FCApplication
Inheritance
System.Object
FCApplication
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: FChoice.Foundation.Clarify.Compatibility.dll
Syntax
[ComVisible(true)]
[Guid("96EFBAF6-4FA0-4f71-A012-910F6CF61120")]
[ClassInterface(ClassInterfaceType.None)]
public sealed class FCApplication : IFCApplication
Constructors
FCApplication()
Declaration
Fields
LOGDIRNAME
Declaration
public const string LOGDIRNAME = "logs"
Field Value
| Type |
Description |
| System.String |
|
LOGFILENAME
Declaration
public const string LOGFILENAME = "fc.log"
Field Value
| Type |
Description |
| System.String |
|
SQLLOGFILENAME
Declaration
public const string SQLLOGFILENAME = "fc_sql.log"
Field Value
| Type |
Description |
| System.String |
|
Properties
base_objid
Declaration
public int base_objid { get; }
Property Value
| Type |
Description |
| System.Int32 |
|
clarify_ver
Declaration
public string clarify_ver { get; }
Property Value
| Type |
Description |
| System.String |
|
ConnectionString
Declaration
public string ConnectionString { get; }
Property Value
| Type |
Description |
| System.String |
|
ConvertTimeZone
Declaration
public bool ConvertTimeZone { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
DataProtectorEntropy
Declaration
public string DataProtectorEntropy { set; }
Property Value
| Type |
Description |
| System.String |
|
db_name
Declaration
public string db_name { get; }
Property Value
| Type |
Description |
| System.String |
|
db_type
Declaration
public string db_type { get; }
Property Value
| Type |
Description |
| System.String |
|
GetMachineTimeZone
Declaration
public string GetMachineTimeZone { get; }
Property Value
| Type |
Description |
| System.String |
|
IsDBTraveler
Declaration
public bool IsDBTraveler { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsDBUnicode
Declaration
public bool IsDBUnicode { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsFcflNet
Declaration
public bool IsFcflNet { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
LicenseExpirationDate
Declaration
public string LicenseExpirationDate { get; }
Property Value
| Type |
Description |
| System.String |
|
LoggingConfigFilePath
Declaration
public string LoggingConfigFilePath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Midnight
Declaration
public string Midnight { get; set; }
Property Value
| Type |
Description |
| System.String |
|
schema_rev
Declaration
public short schema_rev { get; }
Property Value
| Type |
Description |
| System.Int16 |
|
ServerTimeZone
Declaration
public string ServerTimeZone { get; set; }
Property Value
| Type |
Description |
| System.String |
|
site_id
Declaration
public short site_id { get; }
Property Value
| Type |
Description |
| System.Int16 |
|
TruncateStringFields
Declaration
public bool TruncateStringFields { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
WorkingDirectory
Declaration
public string WorkingDirectory { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Methods
build_mtm_name(String, String, String)
Declaration
public string build_mtm_name(string tableName, string relationName, string inverseRelationName)
Parameters
| Type |
Name |
Description |
| System.String |
tableName |
|
| System.String |
relationName |
|
| System.String |
inverseRelationName |
|
Returns
| Type |
Description |
| System.String |
|
CreateSession(Object)
Declaration
public FCSession CreateSession(object sessIdValue)
Parameters
| Type |
Name |
Description |
| System.Object |
sessIdValue |
|
Returns
CurrentSessions()
Declaration
public string CurrentSessions()
Returns
| Type |
Description |
| System.String |
|
EncryptClarifyPassword(String, String)
Declaration
public 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
public string EncryptDBPassword(string password)
Parameters
| Type |
Name |
Description |
| System.String |
password |
|
Returns
| Type |
Description |
| System.String |
|
FileExists(String)
Declaration
public bool FileExists(string path)
Parameters
| Type |
Name |
Description |
| System.String |
path |
|
Returns
| Type |
Description |
| System.Boolean |
|
FindString(Object)
Declaration
public string FindString(object StringID)
Parameters
| Type |
Name |
Description |
| System.Object |
StringID |
|
Returns
| Type |
Description |
| System.String |
|
get_change_date_field(String)
Declaration
public string get_change_date_field(string tableName)
Parameters
| Type |
Name |
Description |
| System.String |
tableName |
|
Returns
| Type |
Description |
| System.String |
|
get_dt_fields(String)
Declaration
public 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
public 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
public Recordset GetADPObjects(object ObjectTypes)
Parameters
| Type |
Name |
Description |
| System.Object |
ObjectTypes |
|
Returns
| Type |
Description |
| ADODB.Recordset |
|
GetCountryList()
Declaration
public Recordset GetCountryList()
Returns
| Type |
Description |
| ADODB.Recordset |
|
GetCountryObjid(String)
Declaration
public int GetCountryObjid(string Country)
Parameters
| Type |
Name |
Description |
| System.String |
Country |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetDefaultCountry()
Declaration
public string GetDefaultCountry()
Returns
| Type |
Description |
| System.String |
|
GetDefaultCountryObjId()
Declaration
public int GetDefaultCountryObjId()
Returns
| Type |
Description |
| System.Int32 |
|
GetDefaultState(String)
Declaration
public string GetDefaultState(string country)
Parameters
| Type |
Name |
Description |
| System.String |
country |
|
Returns
| Type |
Description |
| System.String |
|
GetDefaultStateObjid(String)
Declaration
public int GetDefaultStateObjid(string country)
Parameters
| Type |
Name |
Description |
| System.String |
country |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetDefaultTimeZone()
Declaration
public string GetDefaultTimeZone()
Returns
| Type |
Description |
| System.String |
|
GetDefaultTimeZoneObjid()
Declaration
public int GetDefaultTimeZoneObjid()
Returns
| Type |
Description |
| System.Int32 |
|
GetFullStateObjid(String, String)
Declaration
public int GetFullStateObjid(string country, string state)
Parameters
| Type |
Name |
Description |
| System.String |
country |
|
| System.String |
state |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetGbstDefault(String)
Declaration
public string GetGbstDefault(string listName)
Parameters
| Type |
Name |
Description |
| System.String |
listName |
|
Returns
| Type |
Description |
| System.String |
|
GetGbstDefaultObjid(String)
Declaration
public int GetGbstDefaultObjid(string listName)
Parameters
| Type |
Name |
Description |
| System.String |
listName |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetGbstElmById(String, Int32)
Declaration
public 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
public 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
public int GetGbstElmRankObjid(string listName, int elementRank)
Parameters
| Type |
Name |
Description |
| System.String |
listName |
|
| System.Int32 |
elementRank |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetGbstList(String, Object)
Declaration
public 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
public 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
public 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
public int GetHgbstElmObjId(string element, string listName, object Element1, object Element2, object Element3, object Element4)
Parameters
| Type |
Name |
Description |
| System.String |
element |
|
| 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
public 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
public string GetLocalizedGbstDefault(string listName)
Parameters
| Type |
Name |
Description |
| System.String |
listName |
|
Returns
| Type |
Description |
| System.String |
|
GetLocalizedGbstElmById(String, Int32)
Declaration
public 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
public 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
public 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
public string GetResClausesStr(int tblNum)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tblNum |
|
Returns
| Type |
Description |
| System.String |
|
GetResTbl(Int32, ref String[])
Declaration
public bool GetResTbl(int tblNum, ref string[] restructionFieldNames)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tblNum |
|
| System.String[] |
restructionFieldNames |
|
Returns
| Type |
Description |
| System.Boolean |
|
GetServerTimeZoneOffset()
Declaration
public int GetServerTimeZoneOffset()
Returns
| Type |
Description |
| System.Int32 |
|
GetShortTimeZoneObjId(String)
Declaration
public int GetShortTimeZoneObjId(string timeZoneName)
Parameters
| Type |
Name |
Description |
| System.String |
timeZoneName |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetStateObjid(String, String)
Declaration
public int GetStateObjid(string country, string state)
Parameters
| Type |
Name |
Description |
| System.String |
country |
|
| System.String |
state |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetStates(String)
Declaration
public Recordset GetStates(string country)
Parameters
| Type |
Name |
Description |
| System.String |
country |
|
Returns
| Type |
Description |
| ADODB.Recordset |
|
GetTableFields(String)
Declaration
public Recordset GetTableFields(string tableName)
Parameters
| Type |
Name |
Description |
| System.String |
tableName |
|
Returns
| Type |
Description |
| ADODB.Recordset |
|
GetTableID(String)
Declaration
public int GetTableID(string tableName)
Parameters
| Type |
Name |
Description |
| System.String |
tableName |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetTableName(Int32)
Declaration
public string GetTableName(int TableNum)
Parameters
| Type |
Name |
Description |
| System.Int32 |
TableNum |
|
Returns
| Type |
Description |
| System.String |
|
GetTableRels(String, Boolean)
Declaration
public Recordset GetTableRels(string tableName, bool allowOneToMany)
Parameters
| Type |
Name |
Description |
| System.String |
tableName |
|
| System.Boolean |
allowOneToMany |
|
Returns
| Type |
Description |
| ADODB.Recordset |
|
GetTablesAndViews(Object)
Declaration
public Recordset GetTablesAndViews(object TablesOnly)
Parameters
| Type |
Name |
Description |
| System.Object |
TablesOnly |
|
Returns
| Type |
Description |
| ADODB.Recordset |
|
GetTimeZoneList()
Declaration
public Recordset GetTimeZoneList()
Returns
| Type |
Description |
| ADODB.Recordset |
|
GetTimeZoneObjid(String)
Declaration
public int GetTimeZoneObjid(string timeZoneName)
Parameters
| Type |
Name |
Description |
| System.String |
timeZoneName |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetTimeZoneOffset(String)
Declaration
public int GetTimeZoneOffset(string timeZoneName)
Parameters
| Type |
Name |
Description |
| System.String |
timeZoneName |
|
Returns
| Type |
Description |
| System.Int32 |
|
GetTimeZonesInCountry(String)
Declaration
public Recordset GetTimeZonesInCountry(string Country)
Parameters
| Type |
Name |
Description |
| System.String |
Country |
|
Returns
| Type |
Description |
| ADODB.Recordset |
|
Initialize()
Declaration
InitializeFull(String, String, String, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)
Declaration
public 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 |
|
InitializeWithParams(NameValueCollection)
Declaration
[ComVisible(false)]
public void InitializeWithParams(NameValueCollection envParams)
Parameters
| Type |
Name |
Description |
| System.Collections.Specialized.NameValueCollection |
envParams |
|
is_it_a_field(String, String)
Declaration
public 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
public 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
public 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
public 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
public 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
public 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
public 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
public 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
public 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
public bool is_rel_mandatory(int tableNum, string relationName)
Parameters
| Type |
Name |
Description |
| System.Int32 |
tableNum |
|
| System.String |
relationName |
|
Returns
| Type |
Description |
| System.Boolean |
|
IsCountry(String)
Declaration
public bool IsCountry(string Country)
Parameters
| Type |
Name |
Description |
| System.String |
Country |
|
Returns
| Type |
Description |
| System.Boolean |
|
IsFullState(String, String)
Declaration
public 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
public 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
public bool IsInHgbstList(string element, string listName, object Element1, object Element2, object Element3, object Element4)
Parameters
| Type |
Name |
Description |
| System.String |
element |
|
| System.String |
listName |
|
| System.Object |
Element1 |
|
| System.Object |
Element2 |
|
| System.Object |
Element3 |
|
| System.Object |
Element4 |
|
Returns
| Type |
Description |
| System.Boolean |
|
IsOnDST(String, DateTime)
Declaration
public bool IsOnDST(string timeZoneName, DateTime date)
Parameters
| Type |
Name |
Description |
| System.String |
timeZoneName |
|
| System.DateTime |
date |
|
Returns
| Type |
Description |
| System.Boolean |
|
IsState(String, String)
Declaration
public bool IsState(string country, string state)
Parameters
| Type |
Name |
Description |
| System.String |
country |
|
| System.String |
state |
|
Returns
| Type |
Description |
| System.Boolean |
|
IsTimeZone(String)
Declaration
public bool IsTimeZone(string timeZoneName)
Parameters
| Type |
Name |
Description |
| System.String |
timeZoneName |
|
Returns
| Type |
Description |
| System.Boolean |
|
IsTimeZoneInCountry(String, String, Boolean)
Declaration
public 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
public void Log(object TheMessageType, object TheMessage)
Parameters
| Type |
Name |
Description |
| System.Object |
TheMessageType |
|
| System.Object |
TheMessage |
|
LogEx(String, String)
Declaration
public void LogEx(string logLevel, string logMessage)
Parameters
| Type |
Name |
Description |
| System.String |
logLevel |
|
| System.String |
logMessage |
|
RankIsInGbstLst(String, Int32)
Declaration
public bool RankIsInGbstLst(string listName, int rank)
Parameters
| Type |
Name |
Description |
| System.String |
listName |
|
| System.Int32 |
rank |
|
Returns
| Type |
Description |
| System.Boolean |
|
SetServerTimeZoneToMachineTimeZone()
Declaration
public void SetServerTimeZoneToMachineTimeZone()
sprintf(String, Object, Object, Object, Object, Object, Object)
Declaration
public 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
public void UpdateCache()
UpdateSchemaCache()
Declaration
public void UpdateSchemaCache()
ValidateEncryptedPassword(String, String, Int16)
Declaration
public 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 |
|
Implements