Class: cCallInterfaceHelper_mixin

Module location: cCallInterfaceHelper_mixin.pkg line 6 (view source)

Class Hierarchy:

cObjectMixincCallInterfaceHelper_mixin

Class Definition

Properties

booleanpbConvertXML
handlephoCallInterface

Functions and Procedures

AddressAllocVDFISData_pData(Address pVDFISData Integer iLen)
Alloc or reAlloc space for VDFISData.pData. Pass: pVDFISData and length. Alloc mem and set .pData and .iDataLen values in structure Ret: .pData
AddressCopy_StringtoVDFISData(String sValue Address pVDFISData)
must alloc new pData space and copy string to this space. Pass: Pointer to VDFISData, String. Pass by ref to avoid extra copy of string
StringCopy_VDFISDATAtoString(Address pVDFISData)
must create a new string and copy contents from pValue into it Pass: pValue points to VDFISData
DefineCallInterfaceHelper_mixin()
IntegerDoCall(Address pVDFISData)
Uses new runtime class for call parsing Note: There are no more parsing errors, since there is no parsing. There are four possible errors: 1. We receive a completely bad parameter block (dwError is set in structure or offset to service name is outside of range) #REPLACE DFERR_WEBAPP_WEBSERVICE_BAD_PARAMETER_BLOCK, |CI4376 2. We receive a call for a webservice that we don't have registered. #REPLACE DFERR_WEBAPP_WEBSERVICE_NOT_FOUND, |CI4375 3. We receive a call for a webservice, but it doesn't have a valid message number attached. Message number is zero. #REPLACE DFERR_WEBAPP_WEBSERVICE_BAD_REGISTRATION |CI4374 4. More than 16 arguments were passed. 16 arguments is the maximum for a webservice. #REPLACE DFERR_WEBAPP_WEBSERVICE_TOO_MANY_ARGUMENTS, |CI4387
IntegerFindMessageId(String sMsg)
Find message Id for passed message name ret: 0 if not found, else object Id of message
IntegerFindMessageItem(String sMsg)
Find message item for passed message name ret: -1 if not found, else item of message. The following messages use this item to retrieve data.
StringInterfaceMessageComment(Integer iItem)
IntegerInterfaceMessageCount()
StringInterfaceMessageId(Integer iItem)
IntegerInterfaceMessageIsExtended(Integer iItem)
Is message extended. Determines how sParams is parsed
StringInterfaceMessageName(Integer iItem)
retrieve interface Name (w/ proper casing), Id, Params, and Comments based on passed ID.
IntegerInterfaceMessageParamByRef(Integer iItem Integer iParam)
IntegerInterfaceMessageParamCount(Integer iItem)
IntegerInterfaceMessageParamDimCount(Integer iItem Integer iParam)
StringInterfaceMessageParamName(Integer iItem Integer iParam)
StringInterfaceMessageParams(Integer iItem)
IntegerInterfaceMessageParamType(Integer iItem Integer iParam)
StringInterfaceMessageParamTypeName(Integer iItem Integer iParam)
StringInterfaceTypeDefinitions(string sNSPre string sNsURI)
RegisterInterface(Integer iMsg String sMsgName String sParams String sComment)
add extended interface.
RegisterSimpleInterface(Integer iMsg String sMsgName String sParams String sComment)
add message to interface. Old vdf 2 message (was called RegisterInterface). use extended version below
RegisterStandardInterface()
RemoveInterface(Integer iMsg)
AddressVDFISData_iDataLen(Address pVDFISData)
extract Length pData pointer from passed pointer to VDFISData
AddressVDFISData_pData(Address pVDFISData)
extract and return pData pointer from passed pointer to VDFISData This is not a copy operation - just find pData.
StringWebRequestServiceName(Address pVdfISData)