VCI - Virtual CAN Interface - Ixxat

More documents

Recommendations

Info

Interface description4 Interface description4.1 General functions4.1.1 vciInitializeThe function initializes the VCI for the calling process. The complete syntax of thefunction is:HRESULT VCIAPI vciInitialize ( void );Parameter:The function has no parameters.Return value:If run successfully, the function returns the value VCI_OK, otherwise an errorcode not equal to VCI_OK. Further information on the error code is providedby the function vciFormatError.Comments:The function must be called at the beginning of a program in order to initializethe DLL for the calling process.4.1.2 vciFormatErrorThe function converts a VCI error code into a text that can be read by users, orinto a character string. The complete syntax of the function is:void VCIAPI vciFormatError (HRESULT hrError,PCHAR pszText);Parameters:hrError[in] Error code that is to be converted into text.pszText[out] Pointer to a buffer for the text string. The buffer must provide spacefor at least VCI_MAX_ERRSTRLEN characters. The function saves the errortext including a final 0 character in the specified memory area.Return value:The function has no return value.36Copyright IXXAT Automation GmbH C-API Programming Manual, Version 1.5
Interface description4.1.3 vciDisplayErrorThe function displays a message window on the screen in accordance with thespecified error code. The complete syntax of the function is:void VCIAPI vciDisplayError (HWND hwndParent,PCHAR pszCaption,HRESULT hrError);Parameters:hwndParent[in] Handle of the higher order window. If the value ZERO is specified here,the message window has no higher order window.pszCaption[in] Pointer to a 0-terminated character string with the text for the tile lineof the message window. If the value ZERO is specified here, a pre-definedtitle line text is displayed.hrError[in] Error code for which the message is to be displayed.Return value:The function has no return value.Comments:If the value –1 is given in the parameter hrError, the function determines thelast error code that occurred with the API function GetLastError and displays acorresponding message window. If the value 0 is given in the parameter hrError,no message window is displayed.4.1.4 vciGetVersionThe function determines the version of the installed VCI. The complete syntax ofthe function is:HRESULT VCIAPI vciGetVersion (PUINT32 pdwMajorVersion,PUINT32 pdwMinorVersion );pdwMajorVersion[out] Address of a variable of type UINT32. If run successfully, the functionreturns the major version number of the VCI in this variable.Parameters:pdwMinorVersion[out] Address of a variable of type UINT32. If run successfully, the functionreturns the minor version number of the VCI in this variable.37Copyright IXXAT Automation GmbH C-API Programming Manual, Version 1.5
Page 8 and 9: System overviewThe VCI server runni
Page 10 and 11: Device management and device access
Page 12 and 13: Device management and device access
Page 14 and 15: Accessing the bus3 Accessing the bu
Page 16 and 17: Accessing the bus3.1.2.1 Controller
Page 18 and 19: Accessing the bus3.1.2.2 Message fi
Page 20 and 21: Accessing the busAs the example sho
Page 22 and 23: Accessing the busAfter a message ch
Page 24 and 25: Accessing the busHRESULT hResult;HA
Page 26 and 27: Accessing the bust zTransmit object
Page 28 and 29: Accessing the busNormally, the tran
Page 30 and 31: Accessing the bus3.2.2.1 Controller
Page 32 and 33: Accessing the busIf the connection
Page 34 and 35: Accessing the busAfter a message mo
Page 38 and 39: Interface descriptionReturn value:I
Page 40 and 41: Interface descriptionpszGuid[out] P
Page 42 and 43: Interface description4.2.1.2 vciEnu
Page 44 and 45: Interface descriptionComments:The c
Page 46 and 47: Interface descriptionpVciidDevice[o
Page 48 and 49: Interface descriptionComments:After
Page 50 and 51: Interface descriptionphControl[out]
Page 52 and 53: Interface descriptionReturn value:I
Page 54 and 55: Interface description4.3.1.6 canCon
Page 56 and 57: Interface description4.3.1.8 canCon
Page 58 and 59: Interface description4.3.1.10 canCo
Page 60 and 61: Interface description4.3.2 Message
Page 62 and 63: Interface descriptionpCaps[out] Poi
Page 64 and 65: Interface description4.3.2.6 canCha
Page 66 and 67: Interface description4.3.2.9 canCha
Page 68 and 69: Interface description4.3.2.11 canCh
Page 70 and 71: Interface description4.3.3 Cyclic t
Page 72 and 73: Interface description4.3.3.4 canSch
Page 74 and 75: Interface description4.3.3.7 canSch
Page 76 and 77: Interface description4.3.3.10 canSc
Page 78 and 79: Interface description4.4.1.3 linCon
Page 80 and 81: Interface description4.4.1.6 linCon
Page 82 and 83: Interface description4.4.2.1 linMon
Page 84 and 85: Interface description4.4.2.4 linMon
Page 86 and 87:
Interface description4.4.2.7 linMon
Page 88 and 89:
Interface descriptionReturn value:I
Page 90 and 91:
Types and structures• VciObjectId
Page 92 and 93:
Types and structures• wBusCouplin
Page 94 and 95:
Types and structures• dwStatus:[o
Page 96 and 97:
Types and structures5.2.5 CANMSGINF
Page 98 and 99:
Types and structuresCAN_MSGTYPE_STA
Page 100 and 101:
Types and structures5.2.7 CANCYCLIC
Page 102 and 103:
Types and structures• dwClockFreq
Page 104 and 105:
Types and structuresThe information
Page 106:
Types and structures• Bits.ovr:[o
show all

VCI - Virtual CAN Interface - Ixxat

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?