Internal KCML Functions

functions

Add
ClearList
Destructor
GetElement
GetEnumerator
IsEmpty
IsNotEmpty
KCML_AES_DecryptAES decrypts cyphertext into plaintext$ using a 256 bit key.
KCML_AES_EncryptAES encrypts plaintext into cyphertext$ using a 256 bit key.
KCML_Build_GetInfoReturns build information about the KCML executable
KCML_Build_GetLibrariesObtain a list of all the libraries in a system
KCML_Build_GetLibraryDependenciesObtain a list of all the dependencies of a library or program in the system
KCML_Build_GetSrcListObtain a list of libraries and their constituent src files
KCML_Build_MakeDynamicLibraryBuild a dynamic library
KCML_Class_Enum_FnGet enum function for class
KCML_Class_FindGiven class name return KCML_Class
KCML_ClearTestStateClear error flags after callback
KCML_Clock_GetCountGet processor clock count
KCML_Clock_GetFrequencyGet the frequency of 'KCML_Clock_GetCount()
KCML_Clock_GetTimeReturns the clock count in seconds
KCML_Compile_ProgramCompile code in src$ to output buffer dst$.
KCML_Compiler_GetInfoGet details on compiler to use for this system
KCML_Coverage_EndStop code coverage measuring
KCML_Coverage_EnumerateLibraryEnumerate the code coverage entries for a given library.
KCML_Coverage_FindFind the hit count for the given statement.
KCML_Coverage_SaveSave session coverage to disk.
KCML_Coverage_StartStart code coverage measuring
KCML_DBLog_CommentAdd comment to databse logging stats
KCML_DBLog_EndStop database logging
KCML_DBLog_StartStart database logging
KCML_Debug_DumpPoolHandleRetrieve iterator for the memory pool
KCML_Debug_EnableCallStatsEnable or disable collection of function call counts.
KCML_Debug_FormatStringReturn a string in a printable form
KCML_Debug_GetPoolEnumeratorRetrieve iterator for the memory pool
KCML_Debug_GetPoolNameReturn the name of a global pool, if applicable
KCML_Debug_GetPoolsRetrieve information about the active memory pools
KCML_Debug_GetReturnStackGet return stack
KCML_Debug_GetReturnStackExGet return stack
KCML_Debug_IsRunningDefTestTest whether KCML is currently running a DEFTEST.
KCML_Debug_LeakCheckCheck for memory leaks in the specified region
KCML_Debug_OdbcCall the 'odbc function to emulate kiodbc for debugging purposes
KCML_Debug_SymbolStatsEnable recording of symbol statistics
KCML_Debug_WorkbenchBreak in to a background running program
KCML_Debug_WorkerThread_IsRunning
KCML_Debug_WorkerThread_Post
KCML_Debug_WorkerThread_ProcessInbox
KCML_decodeConvert to UTF-8 from an encoding
KCML_DecodeMagicToTypeConvert magic connection/handle/symbol number to type integer
KCML_DecodeMagicToValueConvert magic connection/handle/symbol number to pre-6.20 integer
KCML_DecodeRowidToHandleConvert database ROWID to handle number
KCML_Defsub_SetHookRegister a trace routine to be executed in during subroutine calls.
KCML_DES_DecryptDES decrypts cyphertext into plaintext$ using a 56 bit key.
KCML_DES_EncryptDES encrypts plaintext into cyphertext$ using a 56 bit key.
KCML_Dir_ListReturns a list of files and directories.
KCML_encodeConvert from UTF-8 into an encoding
KCML_Exception_Get_LogGet the error message details
KCML_File_IsRegularIndicates if the given file is a regular file
KCML_File_StatReturns information about the given file.
KCML_Form_AddExtra
KCML_Form_AddImageDir
KCML_Form_CreateHTMLCtrlPageCreate the standard page to be used by HTML controls in KClient
KCML_Form_Disable_Async_EventsSelectively disable asynchronous events.
KCML_Form_GetCurrentEventInfoReturns information abount current event
KCML_Form_InEventReturns the current event
KCML_Form_IsTranslatablePropertyDetermine if the property is suitable for translation.
KCML_Form_Set_RaiseEvent_CallbackSets a RaiseEvent callback
KCML_Form_SetDefaultSClassSet default sclass for all forms
KCML_Form_SetEndPageSet the web page to be shown after the KCML application has exited.
KCML_Form_SetjQuery
KCML_Form_SetStyle
KCML_Form_ShowEventPendingTest if a form Show event is pending
KCML_Form_WriteBrowserPage
KCML_FormHook_SetCallbacksSet form hook functions
KCML_Get_TermInfoReturn information about the connected terminal
KCML_GetBinaryProgramInfoGet information about a binary program file
KCML_GetHostByNameReturn the internet address of given host name
KCML_HashClass_Add
KCML_HashClass_AddKey
KCML_HashClass_Count
KCML_HashClass_Find
KCML_HashClass_FindIndex
KCML_HashClass_GetEnumerator
KCML_HashClass_RemoveAll
KCML_HashClass_RemoveElement
KCML_HashClass_RemoveIndex
KCML_HashClass_RemoveIterator
KCML_HashClass_RemoveKey
KCML_HashClass_SetKey
KCML_Headless_DebugMessageOutput a debug message in headless test logging
KCML_Help_DisplayInvoke the $HELP() functionality
KCML_Hook_SetCallbacksSet hook functions to KCML
KCML_Icon_ClearClear content of mapping list
KCML_Icon_GetImagesReturn a list of images in an icon format image.
KCML_Icon_LoadConvert a Icon format image to a 2 dimenisonal array representing the image.
KCML_Icon_MapAdd pairs of filenames to the map list.
KCML_Icon_SearchSearch for the mapped icon filename from the map list
KCML_Image_LoadConvert a Jpeg format image to a 2 dimenisonal array representing the image.
KCML_Image_MakeURLMap filename to url for use on Browser Client
KCML_Image_ResizeResize an image
KCML_Image_SaveSave an image to a buffer in the specified format
KCML_ImpersonateImpersonate a user
KCML_Invoke_Spy
KCML_IteratorBaseClass_MoveNext
KCML_IteratorClass_Element
KCML_Jpeg_CorrectRotationUse embedded EXIF information to find if image is rotate it and correct if necessary
KCML_Jpeg_LoadConvert a Jpeg format image to a 2 dimenisonal array representing the image.
KCML_Jpeg_SaveSave an image to a buffer in Jpeg format
KCML_KClient_GetEnvironmentObtain a list of environment variables
KCML_KClient_GetVarGet a KClient variable
KCML_Kconf_GetAliasesObtain a list of aliases
KCML_Kconf_GetClientsRetrieve the validclients access control list
KCML_Kconf_GetEnvironmentObtain a list of environment variables
KCML_Kconf_GetServicesObtain a list of services
KCML_Kconf_GetSoapObtain a list of SOAP services
KCML_Kconf_GetSoapEnvironmentObtain a list of environment variables for a SOAP service
KCML_Kconf_GetSvcInfoRetrieve detailed service information
KCML_Kconf_GetTableSpacesObtain a list of table spaces
KCML_Kconf_GetUsersRetrieve the validusers access control list
KCML_KForm_SetApplicationConfigFileSet application configuration file to be passed to KForm
KCML_Language_GetLangFolderGet the language folder for a given lang code
KCML_Language_GetLocaleGet the locale from the language code
KCML_Language_GetTranslationFileGet the file and path of the index file created given the name of the language directory
KCML_Language_LookupStringLookup up the string in the translation file
KCML_Language_SetSlotIdentify the language code of a language slot
KCML_Language_StripGUICharactersRemove any accelerator keys and trailing punctuation from the string supplied
KCML_Lic_AcquireConsume an application license and store it in $PSTAT
KCML_Lic_CountCounts the number of application licenses in use
KCML_Lic_CreateSessionCreates a pseudo-session that consumes a KCML licence
KCML_Lic_DestroySessionReturn the applications assigned in $PSTAT to this partition
KCML_Lic_GetApplicationsReturn the applications assigned in $PSTAT to this partition
KCML_Lic_ReleaseRelease an application from $PSTAT
KCML_ListClass_Add
KCML_ListClass_AddKey
KCML_ListClass_Count
KCML_ListClass_Find
KCML_ListClass_FindIndex
KCML_ListClass_GetEnumerator
KCML_ListClass_InsertElement
KCML_ListClass_InsertIndex
KCML_ListClass_InsertIterator
KCML_ListClass_InsertKey
KCML_ListClass_RemoveAll
KCML_ListClass_RemoveElement
KCML_ListClass_RemoveIndex
KCML_ListClass_RemoveIterator
KCML_ListClass_RemoveKey
KCML_ListClass_Set
KCML_ListClass_SetElement
KCML_ListClass_SetIndex
KCML_ListClass_SetKey
KCML_LoadSourceLoad, and recreate, a program source
KCML_Machine_GetInfoRetrieve information about the host machine
KCML_Map_DeclarePtrMap a pointer returned by $DECLARE to a structure or string variable
KCML_Map_FileMemory map a file onto a scalar string variable
KCML_Map_FileArrayMap a string array variable to a file
KCML_MapClass_Add
KCML_MapClass_AddKey
KCML_MapClass_Count
KCML_MapClass_Find
KCML_MapClass_FindIndex
KCML_MapClass_GetEnumerator
KCML_MapClass_RemoveAll
KCML_MapClass_RemoveElement
KCML_MapClass_RemoveIndex
KCML_MapClass_RemoveIterator
KCML_MapClass_RemoveKey
KCML_MapClass_SetKey
KCML_MD5Computes a 128 bit MD5 hash from the given buffer
KCML_MessageQueue_IsEnabledCheck if a message queue has been configured
KCML_MessageQueue_SendSend a message to a message queue
KCML_Narrow_UTF8Narrows wide ASCII characters in a UTF8 string
KCML_Normalize_UTF8Normalizes wide ASCII and half-width kana characters in a UTF8 string
KCML_OCX_AddMethodHook Add and OCX hook method callback.
KCML_OCX_SetHook Setup an OCX hook.
KCML_OCXHook_SetCallbacksSet OCX hook functions
KCML_OIDC_GetClaimRetrieve a claim from the identity token or user info
KCML_OIDC_GetClaimsGet identity token claims as JSON
KCML_OIDC_LogInTokenObtain a new OIDC auth token by prompting the user to reauthenticate
KCML_OIDC_LogOutTokenEnd OIDC session
KCML_OIDC_RefreshTokenAttempt to refresh OIDC auth token without user interaction
KCML_OIDC_RevokeTokenRevoke OIDC auth token
KCML_OIDC_SetTokenExpirySet auth token expiry in seconds. For testing. Cannot be used to extend token lifespan
KCML_OIDC_TokenExpiresInReturns time to auth token expiry in seconds
KCML_Panic_SetHookRegister a callback routine to be executed to be called before and after PANICs.
KCML_Panic_SuppressHide return stack from PANIC
KCML_PerfMetric_ClearStop a performance metric.
KCML_PerfMetric_CloseFileCloses that a file is associated it with the performance metric message queue.
KCML_PerfMetric_FlushFlush the current value of a performance metric.
KCML_PerfMetric_GetReturns a list of perfmance metrics
KCML_PerfMetric_OpenFileOpens a file to receive performance metrics
KCML_PerfMetric_ParamReturns a list of perfmance metric parameters
KCML_PerfMetric_SectionClearUnsets the additional performance metrics that were set from the named [perfmetric:section$] in /etc/kcml/msgq.conf
KCML_PerfMetric_SectionSetSets additional performance metrics for the current partition from the named section in /etc/kcml/msgq.conf
KCML_PerfMetric_SendSend application performance metrics to a RabbitMQ server.
KCML_PerfMetric_SetEnable a performance metric.
KCML_PerfStats_CommentAdd comment to performance stats
KCML_PerfStats_EndStop performance measuring
KCML_PerfStats_IsRunningIs perfstats running?
KCML_PerfStats_StartStart performance measuring
KCML_PerfTimer_PollPoll a performance timer.
KCML_PerfTimer_StartStart a performance timer.
KCML_PerfTimer_StopStop a performance timer.
KCML_Png_LoadConvert a PNG format image to a 2 dimenisonal array representing the image.
KCML_Png_SaveSave an image to a buffer in PNG format
KCML_pollPoll status of an array of sockets, pipes or files
KCML_Priority_SetCallbackSet the callback function to be called by KCML to discover the priority level of a control
KCML_Proc_GetInfoRetrieve process information
KCML_RabbitMQ_SendSend a message to a RabbitMQ server.
KCML_Record_DecodeEncode a table row buffer
KCML_Record_EncodeEncode a table row buffer
KCML_RSA_DecryptDecrypt a string using an RSA private key
KCML_RSA_EncryptEncrypt a string using an RSA public key
KCML_Search_RecordSearch an array of records by given key and search value
KCML_Session_SetTimeoutSets a session timeout callback
KCML_SessionPool_Call
KCML_SetEditorMagicCallbackSet an editor magic callback.
KCML_SetRev8For testing. Behave as if Rev8
KCML_SetTestCallbackSetup test harness
KCML_SHA1Computes a 160 bit SHA-1 hash from the given buffer
KCML_Signal_PartitionSignal a parition.
KCML_Signal_SetCallbackSet the callback function to be called by KCML when a signal is raised by 'KCML_Signal_Partition
KCML_Socket_GetPeerNameGet the address of the peer connected to the socket
KCML_Socket_GetSockNameGet the current address to which the socket is bound
KCML_Socket_SetSSLTurn TLS/SSL on socket on or off
KCML_Sort_FileSort a file by the given key
KCML_Sort_RecordSort an array of records by given key
KCML_Sql_IsReservedWordTest to see if a word is a reserved word in the KCML SQL parser
KCML_String_SetNativeNewlinesConvert string with internal HEX(0D) newline characters to native file format
KCML_Struct_Enum_FnGet enum function for record/struct
KCML_Sym_GetInstanceNumberReturns an instance number for a sym variable
KCML_Sym_ValidateInstanceNumberReturns whether an instance number for a sym variable is still valid
KCML_Tag_GetPropertyGet a property tag
KCML_Tag_SetPropertySet a property tag
KCML_Term_SetValueAllow the application to define the value returned by #TERM
KCML_Test_DollarDeclareRespondReplay a $DECLARE in headless forms testing
KCML_Test_EnumerateDefTestsEnumerate the DEFTESTs for a given library.
KCML_Test_OLECreateRespondReplay an OLE create call in headless forms testing
KCML_Test_OLEGetHandleRespondReplay an OLE get handle call in headless forms testing
KCML_Test_OLEMethodHandleRespondReplay an OLE method handle call in headless forms testing
KCML_Test_OLEMethodRespondReplay an OLE method call in headless forms testing
KCML_Test_OLEPropertyRespondReplay an OLE property in headless forms testing
KCML_Test_SetFormsCallbackSet a callback function to enable automated forms testing
KCML_Test_SetTermIdSet terminal ID string in headless forms testing
KCML_Test_SetUserSet LOGNAME env var in headless forms testing
KCML_Uuid_CreateCreate a UUID
KCML_Uuid_FromStringConvert a string to a UUID
KCML_Uuid_ToStringConvert a UUID to a printable string
KCML_VectorClass_Add
KCML_VectorClass_AddKey
KCML_VectorClass_Count
KCML_VectorClass_Find
KCML_VectorClass_FindIndex
KCML_VectorClass_GetEnumerator
KCML_VectorClass_InsertElement
KCML_VectorClass_InsertIndex
KCML_VectorClass_InsertIterator
KCML_VectorClass_InsertKey
KCML_VectorClass_RemoveAll
KCML_VectorClass_RemoveElement
KCML_VectorClass_RemoveIndex
KCML_VectorClass_RemoveIterator
KCML_VectorClass_RemoveKey
KCML_VectorClass_Set
KCML_VectorClass_SetElement
KCML_VectorClass_SetIndex
KCML_VectorClass_SetKey
KCML_View_AddTableColumnToListAdd the specified column from the table to the column list
KCML_View_GetColumnListReturn the KDB SQL column list for the given view
KCML_View_GetColumnListArrayReturn an array of ordinals for the column list
KCML_View_GetSymFnColumnListReturn the column list of the view of the nth parameter typed to a view
KCML_View_MergeColumnListMerge two column lists
KCML_Workbench_HaveBuiltLibrariesReturn whether user has built libraries in the workbench
KDB_FailOver_FatalResetSuppress the fatal PANIC after the failover callback when no database server is available
KDB_FailOver_SetHookRegister a callback routine to be executed after a reconnect.
KDB_Transaction_DebugWarningEnable/disable the workbench warning when debugging a WHILE TRANS block
KDB_Transaction_SetHookRegister a callback routine to be executed in transactions.
MoveNext
Reset

classes

ClassList
Entry
IEnumerable
IEnumerator
IList
Iterator

records

_KCML_CollectionClass
_KCML_FormHook
_KCML_HashClass
_KCML_Hook
_KCML_IteratorBaseClass
_KCML_IteratorClass
_KCML_ListClass
_KCML_MapClass
_KCML_MemoryPoolIterator
_KCML_OCXHook
_KCML_VectorClass
KCML_AMQP_Connection
KCML_Class
KCML_CollectionClass
KCML_EditorController
KCML_Field
KCML_HashClass
KCML_InternalReflection
KCML_IteratorBaseClass
KCML_IteratorClass
KCML_Languages
KCML_Library
KCML_ListClass
KCML_MapClass
KCML_Method
KCML_Object
KCML_Parameter
KCML_RealEditorController
KCML_StringGenerator
KCML_Value
KCML_VectorClass