Module cVdfInternetSession.pkg

**************************************************************************** $File name : cVdfInternetSession.pkg $File title : DataFlex Internet interface $Author : Janne Wassberg $System : VDF Internet Server Created : 97-10-01 @ 17.27.59 Confidential Trade Secret. Copyright 1998-1999 Data Access Corporation, Miami FL, USA All Rights reserved DataFlex is a registered trademark of Data Access Corporation. $Rev History JJT 8/22/2003 (9.1) removed all Oem/Ansi conversions. Flexcom now does this automatically. JJT 11/1/2000 Built for VDF7 JJT 10/2/00 changed to be xHtml compliant (e.g <br> --> <br /> added WmlEncode support ---------------------- JJT 01.09.99 Added messages RequestDDUpdate and RequestFindbyRecid. DFunc now called Call JJT 1999-07-29 Added functions WPO_ID and WPO_Count JJT 1998-11-11 Change Error_report to pass three params JW 1998-10-31 Merged latest OCX interface. 4 new Function/Procdures Server variables and cookies JJT 1998-10-14 Fixed rootname to logical name. Errors redirected later JJT 1998-09-15 Redid the Error object. Many changes JJT 1998-08-28 Merged latest OCX interface. Added OEM/ANSI conversion to all required strings JW 1998-07-02 Changed the OCX-interface to be the latest JW 1998-06-27 Source Merge for Internet by Janne Wassberg 97-10-01 File header created. 98-02-18 Version 105 98-03-10 Version 110 1998-06-27 Version 0.8-201 ****************************************************************************

cVdfInternetSession.pkg (view source)
• import declarations
  • FlexCOM20_Base.pkg (view source)
    Basic flexcom automation only
  • set.pkg (view source)
    set package
  • VDFISDataStruct.pkg (view source)
    structure defintion for VDFISdata type
  • HtmlEncode.pkg (view source)
    global HTMLEncode Function
  • WmlEncode.pkg (view source)
    global WmlLEncode Function
• IntegerghInetSession
• Void_TypePostQuitMessage(Integer iExitCode)
  ----------------cWebApp Class for Windows FlexCom Stuff ----------------------------------------------------- External function so tha app will close in a proper way
• cComIWebAppServerClientSession : Mixin
  CLSID: {C7F3BA7F-D36F-45B3-A0F4-87BF45CC507D} IWebAppServerClientSession Interface
  • OutputString(String lllpszHtml)
    • IntegerhDispatchDriver
  • OutputHTML(String llpszHtml)
  • RequestFileRecords(Integer llhWbpo)
    • IntegerhDispatchDriver
  • IntegerHtmlFormValue(String lllpszFormName)
    • IntegerhDispatchDriver
    • IntegerretVal
  • StringHtmlQueryString(String lllpszVariable)
    • IntegerhDispatchDriver
    • StringretVal
  • LogEvent(Integer lliEventType String lllpszEvent)
    • IntegerhDispatchDriver
  • BooleanOutputImage(String lllpszImageFilename)
    • IntegerhDispatchDriver
    • BooleanretVal
  • BooleanOutputTextFile(String lllpszTextFilename)
    • IntegerhDispatchDriver
    • BooleanretVal
  • RequestFileFieldValues(Integer llhWbpo)
    • IntegerhDispatchDriver
  • OutputPlainText(String lllpszText)
    • IntegerhDispatchDriver
  • IntegerGetCookie(String lllpszCookieName String lllpszCookieKeyName)
    • IntegerhDispatchDriver
    • IntegerretVal
  • SetCookieAttrib(String lllpszCookieName DateTime lldExpires String lllpszDomain String lllpszPath Boolean llbSecure)
    • IntegerhDispatchDriver
  • IntegerHttpServerVariable(String lllpszVariableName)
    • IntegerhDispatchDriver
    • IntegerretVal
  • SetCookie(String lllpszCookieName String lllpszCookieKeyName String lllpszValue)
    • IntegerhDispatchDriver
  • SetDevelopmentOnly()
    • IntegerhDispatchDriver
  • OutputData(Integer lllpData)
    • IntegerhDispatchDriver
  • integerCurrentWebAppEnvironment()
    WebAppEndPointEnvironment
    • IntegerhDispatchDriver
    • IntegerretVal
  • IntegerWebServiceRequestHeaders()
    • IntegerhDispatchDriver
    • IntegerretVal
  • AddWebServiceResponseHeader(Integer lllpData)
    • IntegerhDispatchDriver
• cCom_IWebAppServerClientSessionEvents : Mixin
  _IWebAppServerClientSessionEvents Interface
  • OnKillSession()
  • OnSetFileRecordID(Integer llhWbpo String lllpszFile String lllpszRecordID)
  • OnSetFileRowID(Integer llhWbpo String lllpszFile String lllpszRowId)
    jjt - new--to be added to com object-------------
  • OnSetFileFieldValue(Integer llhWbpo String lllpszFile String lllpszField Integer llpValue)
  • OnDDValue(String lllpszWPO String lllpszFile String lllpszField Integer lliOption String lllpszParam Integer llpValue)
  • OnRequestDelete(String lllpszWPO String lllpszFile Integer llpValue)
  • OnRequestFind(String lllpszWPO String lllpszFile String lllpszIndexName Integer lliFindMode Integer llpValue)
  • OnRequestSave(String lllpszWPO String lllpszFile Integer llpValue)
  • OnDoProcess(String lllpszWPO Integer lliParam String lllpszParam Integer llpValue)
  • OnRequestClear(String lllpszWPO String lllpszFile Boolean llbClearAll Integer llpValue)
  • OnDFFunc(String lllpszWPO Integer llpValue)
  • OnRequestFindByRecId(String lllpszWPO String lllpszFile String lllpszRecId Integer llpValue)
  • OnRequestFindByRowId(String lllpszWPO String lllpszFile String lllpszRowId Integer llpValue)
  • OnRequestDDUpdate(String lllpszWPO String lllpszFile Boolean llbShowErrs Integer lliExtra Integer llpValue)
  • OnAttachSession()
  • OnDetachSession()
  • RegisterComEvents()
• OLEVDFInetSession : cComAutomationObject
  CoClass ProgID: WebAppServer.ClientSession.16.1 CLSID: {08E7320F-F6CE-4704-BCD9-8F9306E3C2A3} Visual DataFlex Web Application Server Client Session Class
  • Construct_Object()
    Inherited from cComAutomationObject
• cFileIdsSet : set
  **********************************************************************// **********************************************************************//
  • Construct_Object()
    Set object will contain File Names
    • oFileNr : Array
  • Clear_File_Data()
  • integerFile_Count()
  • Set_File_Data(String sName Integer iFileNr)
    • IntegeriCount
  • StringFile_RootName(Integer iItem)
  • IntegerFile_Nr(Integer iItem)
  • integerSearch_File_Item(String sName)
  • IntegerSearch_File_Name(String sName)
    ret: 0 if not found, else file number of file
    • IntegeriItm
  • Initialize_Files()
    • IntegeriFile
    • Stringsname
  • Error_Report(integer iErrNum integer iErrLine string sErrMsg)
    Search_Field_Name provides a way of getting the field Name without generating an error. We will use an error handle in this object to "swallow" the error.
  • integerSearch_Field_Name(integer iFile string sFieldName)
    • IntegerhOldErr
    • IntegeriField
• cWpoIdsSet : Set
  **********************************************************************//
  • Construct_Object()
    • oWpoID : Array
      names are stored in the Set Object Ids are stored in the oWpoID array
  • Clear_Wpo_Data()
  • integerWpo_Count()
  • Set_Wpo_Data(String sWpoName Integer iWpoID)
    • IntegeriCount
  • StringWpo_Name(Integer iItem)
  • IntegerWpo_ID(Integer iItem)
  • integerSearch_WPO_Item(String sWpoName)
  • IntegerSearch_Wpo_ID(String sWpoName)
    ret: 0 if not found, else object Id of BPO
    • IntegeriItm
• cVDFInternetSession : OLEVDFInetSession
  The cVDFInternetSession class is considered private. All WBOs talk to this by sending messages to the ghInetSession handle but this entire interface is is private. All public access is defined in the WBOs and in the cWebApp object
  • Construct_Object()
    Inherited from OLEVDFInetSession
    • IntegerhErr
    • IntegerpbVerboseErrors
      when errors are reported should technical info be provided. If set to true you get Error#, Line#, File# and Field#
    • IntegerpbQueueErrors
      When True, VDF errors are queued. This should be set indirectly with ErrorQueueStart and ErrorQueueEnd
    • IntegerpbAllErrorsToEventLog
      If true, ALL errors are recorded in the event log. This is good for debugging. If false only appropriate error are event logged
    • IntegerpbAllErrorsToLocal
      If true, errors are directed to the VDF error handler. This means an error will pop up on your VDF program. Normally not wanted for the web, but this can be useful when debugging at the server
    • IntegerpbAllErrorsToHtml
      If false, no errors will be sent to the HTML client. Normally, this should be true. Might be useful when debugging
    • IntegerpeHtmlOutput
    • StringpsHtmlOutputFileName
    • integerpbFirstTimeOpen
    • IntegerpbPrivateInLogEvent
      used to prevent recursion in LogEvent method
    • oFileIds : cFileIdsSet
    • oWpoIds : cWpoIdsSet
      list of wbos (for asp)
    • oWsoIds : cWpoIdsSet
      list of wsos (for web-service)
  • PreSetFileRecordID(Integer lpDispParams)
    needed for backwards compatibility (private)
  • IntegerSearch_Wpo_ID(String sWebBPO)
    // when OCX is created, set up error redirection. We do this as // late as possible. (Occurs when activate sent to panel) // This used to be called PostCreateOCX Procedure OnCreate Forward send OnCreate End_Procedure Procedure Search_Wpo_ID string sWebBPO Returns Integer returns: Object ID of BPO, zero if not found
  • Set_Wpo_Data(String sWpoName Integer iWpoID)
    Add WPO to the list
  • IntegerWpo_ID(Integer iItem)
    return Id of WBP object for item
  • integerWpo_Count()
    get number of WBP items
  • IntegerSearch_Wso_ID(String sWebBPO)
    Same as above, but used for web services! Procedure Search_Wpo_ID string sWebBPO Returns Integer returns: Object ID of BPO, zero if not found
  • Set_Wso_Data(String sWpoName Integer iWpoID)
    Add WPO to the list
  • IntegerWso_ID(Integer iItem)
    return Id of WBP object for item
  • integerWso_Count()
    get number of WBP items
  • IntegerSearch_File_Name(String sName)
    Field and field string to integer conversion functions
  • IntegerSearch_Field_Name(integer iFile String sFieldName)
  • integerMapWPONametoID(string sWPO)
    This will be good for augmentation allowing us to handle not finding the WBPO any way we want.
    • IntegerhWPO
  • integerMapWSONametoID(string sWPO)
    This will be good for augmentation allowing us to handle not finding the WSO any way we want.
    • IntegerhWPO
  • DoSetVDFISData_Error(Address pVDFISData integer iError)
    place error code within VDFISData structure
    • IntegerbOK
  • OnKillSession()
    Inherited from cCom_IWebAppServerClientSessionEvents
    These events are sent by the OCX and must be directed to the WBPO
  • OnAttachSession()
    Inherited from cCom_IWebAppServerClientSessionEvents
    This object's container (cWebApp) must understand these DoAttach and Detach messages.
  • OnDetachSession()
    Inherited from cCom_IWebAppServerClientSessionEvents
  • OnRequestSave(String sWebBpo string sFile address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnRequestSave---------
    • IntegerhObjId
    • IntegeriError
  • OnRequestDelete(String sWebBpo string sFile address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnRequestDelete---------
    • IntegerhObjId
    • IntegeriError
  • OnRequestClear(String sWebBpo string sFile integer bClearAll address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnRequestClear---------
    • IntegerhObjId
    • IntegeriError
  • OnRequestFind(String sWebBpo string sFile string sField integer iFindMode Address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnRequestFind---------
    • IntegerhObjId
    • IntegeriError
  • OnDoProcess(String sWebBpo integer iParam string sParam1 address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnDoProcess---------
    • IntegerhObjId
    • IntegeriError
  • OnSetFileFieldValue(Integer hObjId String sFile String sField Address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnSetFielFieldValue---------
  • OnSetFileRecordId(Integer hObjId String sFile String sRecordId)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnSetFileRecordId---------
  • OnSetFileRowId(Integer hObjId String sFile String sRowId)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnSetFileRowId---------
  • OnDDValue(String sWebBpo String sFile String sField DWORD iOption String sParam Address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnDDValue---------
    • IntegerhObjId
    • IntegeriError
  • OnDFFunc(string sWebBpo Address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnDFFunc--------- Note that DfFunc and Call both map to this location. From this point on, it is Call This can be called as part of a webapp or a web-service. We must check and only pass these messages to the correct objects values for WebAppEndPointEnvironment in function CurrentWebAppEnvironment
    • IntegerhObjId
    • IntegeriError
    • IntegereWebAppEndPointEnvironment
  • OnRequestFindByRecId(String sWBO String sFile String sRecId Address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnRequestFindByRecId---------
    • IntegerhObjId
    • IntegeriError
  • OnRequestFindByRowId(String sWBO String sFile String sRowId Address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnRequestFindByRowId---------
    • IntegerhObjId
    • IntegeriError
  • OnRequestDDUpdate(String sWBO String sFile Boolean bShowErrs DWORD iExtra Address pVDFISData)
    Inherited from cCom_IWebAppServerClientSessionEvents
    -------------OnRequestDDUpdate---------
    • IntegerhObjId
    • IntegeriError
  • OutputHTMLtoTestFile(string sHtml)
    As of 9.1, we no longer Augment messages that require OEM/ASNI translation. Flexcom now does this for us. This only affects string parameters. Note that all data passed through VDFISData already is properly converted
    • StringsFile
  • OutputHtml(string sHtml)
    Inherited from cComIWebAppServerClientSession
    • IntegeriOut
  • OutputPlainText(String sText)
    Inherited from cComIWebAppServerClientSession
    • IntegeriOut
  • LogEvent(Integer iEventType String sEvent)
    Inherited from cComIWebAppServerClientSession
    augment to check for recursion as well as do ansi conversion
  • StringHtmlQueryString(String sVariable)
    Inherited from cComIWebAppServerClientSession
    • StringsRet
  • DWORDHtmlFormValue(String sFormName)
    Inherited from cComIWebAppServerClientSession
    • IntegerlretVal
  • ReportError(integer iErr string sErrMsg integer iLine integer iFileNr integer iFieldNr)
    Error Interface: ReportError and ReportErrorEvent is private and should never be sent. It is sent from within the error handler object to report errors
    • StringsLineBreak
    • StringsDtl
    • StringsFileName
    • StringsFieldName
  • ReportErrorEvent(integer iErr string sErrMsg integer iLine integer iFileNr integer iFieldNr)
    • StringsHtml
    • StringsLineBreak
    • StringsDtl
    • StringsFileName
    • StringsFieldName
  • EnumerateErrors(integer iMsg integer hObj)
    EnumerateErrors and ErrorReportCallBack could be used for advanced purposes allowing other objects to handle errors in a more custom fashion. use this to generate a report of all errors
  • ErrorReportCallBack(integer iItem integer iMsg integer hObj)
  • ReportAllErrors(String sErrHdr)
    use this to generate a report of all errors
  • ReportLastError(Integer bClearError)
    Use this to display the last error
  • stringErrorMessage(integer iItem)
    return error for item, return in HTML format
    • StringsLineBreak
    • StringsErrMsg
  • ClearErrors()
    This will clear all errors
  • IntegerErrorCount()
    return true if any errors exist in queue
  • integerFileFieldErrorItem(integer iFile integer iField)
    see if error exists for this file and field. If it does, return the item number, else return -1.
  • ErrorQueueStart()
    starts a queued errors,
  • ErrorQueueEnd()
    ends queued errors. Note that the queue is not cleared
  • ReportErrorItem(integer iItem)
    Generate error for pass item
  • LogErrorEvent(integer iErr string sText)
    Generate and error and make sure that it is logged in event log.
    • IntegerbOldSt

References (2):

Field References (0):