VCI - Virtual CAN Interface - Ixxat

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