Kvaser.CanLib.xml 245 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Kvaser.CanLib</name>
  5. </assembly>
  6. <members>
  7. <member name="F:Kvaser.CanLib.CanLibDLL.MAX_STRING_SIZE">
  8. <summary>Maximum size of strings.</summary>
  9. </member>
  10. <member name="T:Kvaser.CanLib.CanLibDLL.canBusStatistics">
  11. <summary>This struct is returned by <see cref="M:Kvaser.CanLib.CanLibDLL.canGetBusStatistics(System.Int32,System.IntPtr,System.UInt64)"/></summary>
  12. </member>
  13. <member name="F:Kvaser.CanLib.CanLibDLL.canBusStatistics.stdData">
  14. <summary>Number of received standard (11-bit identifiers) data frames.</summary>
  15. </member>
  16. <member name="F:Kvaser.CanLib.CanLibDLL.canBusStatistics.stdRemote">
  17. <summary> Number of received standard (11-bit identifiers) remote frames.</summary>
  18. </member>
  19. <member name="F:Kvaser.CanLib.CanLibDLL.canBusStatistics.extData">
  20. <summary>Number of received extended (29-bit identifiers) data frames.</summary>
  21. </member>
  22. <member name="F:Kvaser.CanLib.CanLibDLL.canBusStatistics.extRemote">
  23. <summary>Number of received extended (29-bit identifiers) remote frames. </summary>
  24. </member>
  25. <member name="F:Kvaser.CanLib.CanLibDLL.canBusStatistics.errFrame">
  26. <summary>Number of error frames</summary>
  27. </member>
  28. <member name="F:Kvaser.CanLib.CanLibDLL.canBusStatistics.busLoad">
  29. <summary>The bus load, expressed as an integer in the interval 0 - 10000
  30. representing 0.00% - 100.00% bus load.</summary>
  31. </member>
  32. <member name="F:Kvaser.CanLib.CanLibDLL.canBusStatistics.overruns">
  33. <summary>The number of overruns detected by the hardware, firmware or driver.</summary>
  34. </member>
  35. <member name="T:Kvaser.CanLib.CanLibDLL.canUserIoPortData">
  36. <summary>This struct is returned in <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_USER_IOPORT"/> and <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_GET_USER_IOPORT"/>.</summary>C
  37. </member>
  38. <member name="F:Kvaser.CanLib.CanLibDLL.canUserIoPortData.portNo">
  39. <summary>Port number.</summary>
  40. </member>
  41. <member name="F:Kvaser.CanLib.CanLibDLL.canUserIoPortData.portValue">
  42. <summary>Port value.</summary>
  43. </member>
  44. <member name="T:Kvaser.CanLib.Canlib">
  45. <summary>
  46. The canlib DLL is a library for interacting with the CAN bus.
  47. </summary>
  48. </member>
  49. <member name="M:Kvaser.CanLib.Canlib.canAccept(System.Int32,System.Int32,System.Int32)">
  50. <summary>
  51. This routine sets the message acceptance filters on a CAN channel.
  52. On some boards the acceptance filtering is done by the CAN hardware; on other boards(typically those
  53. with an embedded CPU,) the acceptance filtering is done by software. <see cref="M:Kvaser.CanLib.Canlib.canAccept(System.Int32,System.Int32,System.Int32)"/> behaves in the same way
  54. for all boards, however.
  55. <see cref="M:Kvaser.CanLib.Canlib.canSetAcceptanceFilter(System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canAccept(System.Int32,System.Int32,System.Int32)"/> both serve the same purpose but the former can set the code
  56. and mask in just one call.
  57. If you want to remove a filter, call <see cref="M:Kvaser.CanLib.Canlib.canAccept(System.Int32,System.Int32,System.Int32)"/> with the mask set to 0.
  58. Note
  59. You can set the extended code and mask only on CAN boards that support extended identifiers.
  60. Acceptance filters for 11-bit and 29-bit (ext) are independent, meaning 11-bit filters
  61. will not affect 29-bit can frames and vice versa.
  62. Not all CAN boards support different masks for standard and extended CAN identifiers.
  63. </summary>
  64. <param name="handle">An open handle to a CAN circuit.</param>
  65. <param name="envelope">The mask or code to set.</param>
  66. <param name="flag">Any of <see cref="F:Kvaser.CanLib.Canlib.canFILTER_SET_CODE_STD"/>, <see cref="F:Kvaser.CanLib.Canlib.canFILTER_SET_MASK_STD"/>, <see cref="F:Kvaser.CanLib.Canlib.canFILTER_SET_CODE_EXT"/> or <see cref="F:Kvaser.CanLib.Canlib.canFILTER_SET_MASK_EXT"/></param>
  67. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  68. </member>
  69. <member name="M:Kvaser.CanLib.Canlib.canBusOff(System.Int32)">
  70. <summary>
  71. Takes the specified handle off-bus. If no other handle is active on the same channel, the channel
  72. will also be taken off-bus
  73. </summary>
  74. <param name="handle">An open handle to a CAN channel.</param>
  75. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  76. </member>
  77. <member name="M:Kvaser.CanLib.Canlib.canBusOn(System.Int32)">
  78. <summary>
  79. Takes the specified channel on-bus.
  80. If you are using multiple handles to the same physical channel, for example if you are writing
  81. a threaded application, you must call <see cref="M:Kvaser.CanLib.Canlib.canBusOn(System.Int32)"/> once for each handle. The same applies to canBusOff()
  82. - the physical channel will not go off bus until the last handle to the channel goes off bus.
  83. </summary>
  84. <param name="handle">An open handle to a CAN channel.</param>
  85. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  86. </member>
  87. <member name="M:Kvaser.CanLib.Canlib.canClose(System.Int32)">
  88. <summary>
  89. Closes the channel associated with the handle. If no other threads
  90. are using the CAN circuit, it is taken off bus. The handle can not be
  91. used for further references to the channel.
  92. </summary>
  93. <param name="handle">An open handle to a CAN channel.</param>
  94. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  95. </member>
  96. <member name="M:Kvaser.CanLib.Canlib.canFlushReceiveQueue(System.Int32)">
  97. <summary>This function removes all received messages from the handle's receive queue. Other handles open to
  98. the same channel are not affected by this operation. That is, only the messages belonging to the handle
  99. you are passing to canFlushReceiveQueue are discarded.
  100. Note: This call has the same effect as calling <see cref="M:Kvaser.CanLib.Canlib.canIoCtl(System.Int32,System.Int32,System.Int32@)"/> with a function code of <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_FLUSH_RX_BUFFER"/>.
  101. </summary>
  102. <param name="hnd">A handle to an open circuit.</param>
  103. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  104. </member>
  105. <member name="M:Kvaser.CanLib.Canlib.canFlushTransmitQueue(System.Int32)">
  106. <summary>
  107. This function removes all messages pending transmission from the transmit queue of the circuit.
  108. Note: If there are other handles open to the same circuit, they are also flushed.This call has the same effect as
  109. calling <see cref="M:Kvaser.CanLib.Canlib.canIoCtl(System.Int32,System.Int32,System.Int32@)"/> with a function code of <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_FLUSH_TX_BUFFER"/>.
  110. </summary>
  111. <param name="hnd">A handle to an open circuit.</param>
  112. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  113. </member>
  114. <member name="M:Kvaser.CanLib.Canlib.canGetBusOutputControl(System.Int32,System.Int32@)">
  115. <summary>
  116. This function retrieves the current CAN controller driver type. This corresponds loosely to the bus output control
  117. register in the CAN controller, hence the name of this function. CANlib does not allow for direct manipulation of
  118. the bus output control register; instead, symbolic constants are used to select the desired driver type.
  119. <para>&#160;</para>
  120. Note: Don't confuse the CAN controller driver type with the bus driver type. The CAN controller is not connected
  121. directly to the CAN bus; instead, it is connected to a bus transceiver circuit which interfaces directly to the bus.
  122. The "CAN controller driver type" we are talking about here refers to the mode which the CAN controller uses to drive
  123. the bus transceiver circuit.Silent Mode is not supported by all CAN controllers.
  124. </summary>
  125. <param name="handle">An open handle to a CAN circuit.</param>
  126. <param name="drivertype">A reference to an int which receives the current driver type. The driver type can be
  127. either <see cref="F:Kvaser.CanLib.Canlib.canDRIVER_NORMAL"/> or <see cref="F:Kvaser.CanLib.Canlib.canDRIVER_SILENT"/>.</param>
  128. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  129. </member>
  130. <member name="M:Kvaser.CanLib.Canlib.canGetBusParams(System.Int32,System.Int64@,System.Int32@,System.Int32@,System.Int32@,System.Int32@)">
  131. <summary>
  132. This function retrieves the current nominal bus parameters for the specified channel.
  133. The anatomy of a CAN bit is discussed in detail at Kvaser's web site at www.kvaser.com.
  134. </summary>
  135. <param name="handle">An open handle to a CAN controller.</param>
  136. <param name="freq">Bit rate (bits per second).</param>
  137. <param name="tseg1">Time segment 1, that is, the number of quanta from (but not including) the Sync Segment to the sampling point.</param>
  138. <param name="tseg2">Time segment 2, that is, the number of quanta from the sampling point to the end of the bit.</param>
  139. <param name="sjw">The Synchronization Jump Width.</param>
  140. <param name="noSamp">The number of sampling points; can be 1 or 3.</param>
  141. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  142. </member>
  143. <member name="M:Kvaser.CanLib.Canlib.canGetBusParamsFd(System.Int32,System.Int64@,System.Int32@,System.Int32@,System.Int32@)">
  144. <summary>
  145. This function retrieves the current data bus parameters for the specified CAN FD channel.
  146. </summary>
  147. <param name="handle">An open handle to a CAN FD controller.</param>
  148. <param name="freq">Bit rate (bits per second).</param>
  149. <param name="tseg1">Time segment 1, that is, the number of quanta from (but not including) the Sync Segment to the sampling point.</param>
  150. <param name="tseg2">Time segment 2, that is, the number of quanta from the sampling point to the end of the bit.</param>
  151. <param name="sjw">The Synchronization Jump Width.</param>
  152. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  153. </member>
  154. <member name="M:Kvaser.CanLib.Canlib.canGetBusStatistics(System.Int32,Kvaser.CanLib.Canlib.canBusStatistics@)">
  155. <summary>
  156. The <see cref="M:Kvaser.CanLib.Canlib.canGetBusStatistics(System.Int32,Kvaser.CanLib.Canlib.canBusStatistics@)"/> function retrieves the latest bus statistics figures reported by the driver. You request the bus
  157. statistics from the driver by calling the <see cref="M:Kvaser.CanLib.Canlib.canRequestBusStatistics(System.Int32)"/> function.
  158. </summary>
  159. <param name="hnd">An open handle to a CAN channel.</param>
  160. <param name="stat">A reference to a canBusStatistics struct that will receive the bus statistics figures.</param>
  161. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  162. </member>
  163. <member name="M:Kvaser.CanLib.Canlib.canGetDriverMode(System.Int32,System.Int32@,System.Int32@)">
  164. <summary>
  165. This function retrieves the current CAN bus driver mode. This is typically a mode like sleep, wakeup, standby, fast mode,
  166. etc. The different modes are almost always hardware dependent and requires special DRVcan cables. As an example, the DRVcan
  167. S implements J2411 compliant single-wire CAN and supports four line modes, namely Normal, Sleep, Fast and Wakeup.
  168. Standard ISO 11898 CAN do not support any of these bus driver modes.
  169. <para>&#160;</para>
  170. Note: The bus driver mode is typically used to control things like one- or two-wire mode, sleep mode, and so on. It requires
  171. special support in the CAN driver circuit.
  172. Not implemented in Linux
  173. </summary>
  174. <param name="hnd">An open handle to a CAN circuit.</param>
  175. <param name="lineMode">A reference to an int which receives the current line mode (canTRANSCEIVER_LINEMODE_xxx).</param>
  176. <param name="resNet">A reference to an int which receives the current resnet mode. This value is usually <see cref="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_RESNET_NA"/>
  177. except for special DRVcan cables.</param>
  178. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  179. </member>
  180. <member name="M:Kvaser.CanLib.Canlib.canGetErrorText(Kvaser.CanLib.Canlib.canStatus,System.String@)">
  181. <summary>
  182. This function translates an error code (canERR_xxx) to a human-readable, English text.
  183. </summary>
  184. <param name="err">The error code.</param>
  185. <param name="buf_str">A reference to a string containing the error text</param>
  186. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  187. </member>
  188. <member name="M:Kvaser.CanLib.Canlib.canGetChannelData(System.Int32,System.Int32,System.Object@)">
  189. <summary>
  190. This function can be used to retrieve certain pieces of information about a channel.
  191. You must pass a channel number and not a channel handle.
  192. </summary>
  193. <param name="channel">The number of the channel you are interested in. Channel
  194. numbers are integers in the interval beginning at 0
  195. (zero) and ending at the value returned by
  196. <see cref="M:Kvaser.CanLib.Canlib.canGetNumberOfChannels(System.Int32@)" />, minus 1.</param>
  197. <param name="item">This parameter specifies what data to obtain for the
  198. specified channel. The value is one of the constants canCHANNELDATA_xxx.</param>
  199. <param name="buffer">The Object with received data.</param>
  200. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  201. </member>
  202. <member name="M:Kvaser.CanLib.Canlib.canGetHandleData(System.Int32,System.Int32,System.Object@)">
  203. <summary>
  204. This function can be used to retrieve certain pieces of information about an open handle to a CANlib channel.
  205. </summary>
  206. <param name="hnd">An open handle to a CAN channel.</param>
  207. <param name="item">This parameter specifies what data to obtain for the specified handle. The value is one of the constants canCHANNELDATA_xxx</param>
  208. <param name="buffer">return value as a object</param>
  209. <returns></returns>
  210. </member>
  211. <member name="M:Kvaser.CanLib.Canlib.canGetNumberOfChannels(System.Int32@)">
  212. <summary> This function returns the number of available CAN channels in the computer. The virtual channels
  213. are included in this number.</summary>
  214. <param name="channelCount">A reference to an Int32 which will receive the current number of channels.</param>
  215. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  216. </member>
  217. <member name="M:Kvaser.CanLib.Canlib.canEnumHardwareEx(System.Int32@)">
  218. <summary> This function recreates the channel table and returns the number of available CAN channels in the computer.
  219. The virtual channels are included in this number.</summary>
  220. <param name="channelCount">A reference to an Int32 which will receive the current number of channels.</param>
  221. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  222. </member>
  223. <member name="M:Kvaser.CanLib.Canlib.canGetVersion">
  224. <summary>This API call returns the version of the CANlib API DLL (canlib32.dll). The most significant byte is
  225. the major version number and the least significant byte is the minor version number.
  226. The actual version of the different driver files can be obtained by studying the version resources in each of the files.
  227. <para>&#160;</para>
  228. Note: The version number of the canlib32.dll file is not related to the product version of CANlib you are using. CANlib
  229. consists of several driver and DLL files. To obtain the product version, use <see cref="M:Kvaser.CanLib.Canlib.canGetVersionEx(System.Int32)"/>.
  230. </summary>
  231. <returns>Version number of canlib32.dll
  232. <para>&#160;</para>
  233. Note: Linux returns version number from libcanlib.so</returns>
  234. </member>
  235. <member name="M:Kvaser.CanLib.Canlib.canGetVersionEx(System.Int32)">
  236. <summary> This function returns various version numbers from the driver routines.</summary>
  237. <param name="itemCode">Specifies which version number to retrieve. See canVERSION_CANLIB32_xxx</param>
  238. <returns>The return value is the desired version number.</returns>
  239. </member>
  240. <member name="M:Kvaser.CanLib.Canlib.canInitializeLibrary">
  241. <summary> This function must be called before any other functions are used. It will initialize the driver.
  242. You may call <see cref="M:Kvaser.CanLib.Canlib.canInitializeLibrary"/> more than once. The actual initialization will take place only once.
  243. Any errors encountered during library initialization will be "silent" and an appropriate canERR_xxx error code
  244. will be returned later on when <see cref="M:Kvaser.CanLib.Canlib.canOpenChannel(System.Int32,System.Int32)"/> (or any other API call that requires initialization) is called.</summary>
  245. </member>
  246. <member name="M:Kvaser.CanLib.Canlib.canIoCtl(System.Int32,System.Int32,System.Int32@)">
  247. <summary>This function performs several different functions defined as CanIOCTL_xxx.
  248. The functions are handle-specific unless otherwise noted; this means that they affect only the handle you pass to canIoCtl(),
  249. whereas other open handles will remain unaffected. The contents of val after the call is dependent on the function code you specified.</summary>
  250. <param name="handle">A handle to an open circuit.</param>
  251. <param name="func">A canIOCTL_xxx function code .</param>
  252. <param name="val">Value to Get</param>
  253. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  254. </member>
  255. <member name="M:Kvaser.CanLib.Canlib.canIoCtl(System.Int32,System.Int32,System.String@)">
  256. <summary>This function performs several different functions defined as CanIOCTL_xxx.
  257. The functions are handle-specific unless otherwise noted; this means that they affect only the handle you pass to canIoCtl(),
  258. whereas other open handles will remain unaffected. The contents of val after the call is dependent on the function code you specified.
  259. </summary>
  260. <param name="handle">A handle to an open circuit.</param>
  261. <param name="func">A canIOCTL_xxx function code .</param>
  262. <param name="str_buf">Return value as String</param>
  263. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  264. </member>
  265. <member name="M:Kvaser.CanLib.Canlib.canIoCtl(System.Int32,System.Int32,System.Object@)">
  266. <summary>This function performs several different functions defined as CanIOCTL_xxx.
  267. The functions are handle-specific unless otherwise noted; this means that they affect only the handle you pass to canIoCtl(),
  268. whereas other open handles will remain unaffected. The contents of val after the call is dependent on the function code you specified.
  269. </summary>
  270. <param name="handle">A handle to an open circuit.</param>
  271. <param name="func">A canIOCTL_xxx function code .</param>
  272. <param name="obj_buf">Set/Get value as an Object</param>
  273. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  274. </member>
  275. <member name="M:Kvaser.CanLib.Canlib.canObjBufAllocate(System.Int32,Kvaser.CanLib.Canlib.canObjBufType)">
  276. <summary>Allocates an object buffer associated with a handle to a CAN circuit.</summary>
  277. <param name="handle">An open handle to a CAN circuit.</param>
  278. <param name="type">The type of the buffer.</param>
  279. <returns>A buffer index (zero or positive) if success. canERR_xxx (negative) if failure</returns>
  280. </member>
  281. <member name="M:Kvaser.CanLib.Canlib.canObjBufDisable(System.Int32,System.Int32)">
  282. <summary>Disables the object buffer with the specified index.</summary>
  283. <param name="handle">An open handle to a CAN circuit. </param>
  284. <param name="idx">The index of the buffer.</param>
  285. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  286. </member>
  287. <member name="M:Kvaser.CanLib.Canlib.canObjBufEnable(System.Int32,System.Int32)">
  288. <summary>Enables the object buffer with the specified index.</summary>
  289. <param name="handle">An open handle to a CAN circuit. </param>
  290. <param name="idx">The index of the object buffer to enable.</param>
  291. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  292. </member>
  293. <member name="M:Kvaser.CanLib.Canlib.canObjBufFree(System.Int32,System.Int32)">
  294. <summary>Deallocates the object buffer with the specified index. The buffer can not be referenced after this operation.</summary>
  295. <param name="handle">An open handle to a CAN circuit. </param>
  296. <param name="idx">The object buffer to deallocate.</param>
  297. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  298. </member>
  299. <member name="M:Kvaser.CanLib.Canlib.canObjBufFreeAll(System.Int32)">
  300. <summary>Deallocates all object buffers on the specified handle. The buffers cannot be referenced after this operation.</summary>
  301. <param name="handle">An open handle to a CAN circuit. </param>
  302. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  303. </member>
  304. <member name="M:Kvaser.CanLib.Canlib.canObjBufSendBurst(System.Int32,System.Int32,System.Int32)">
  305. <summary>The canObjBufSendBurst function sends a burst of CAN messages. You have to set up an object buffer
  306. first with the message to send. The messages will be sent as fast as possible from the hardware.
  307. <para>&#160;</para>
  308. This function is intended for certain diagnostic applications.
  309. </summary>
  310. <param name="handle">An open handle to a CAN channel.</param>
  311. <param name="idx">The index of a CAN object buffer.</param>
  312. <param name="burstlen">The number of messages to send.</param>
  313. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  314. </member>
  315. <member name="M:Kvaser.CanLib.Canlib.canObjBufSetFilter(System.Int32,System.Int32,System.Int32,System.Int32)">
  316. <summary>Defines a message reception filter on the specified object buffer. Messages not matching
  317. the filter are discarded.
  318. Note: For an auto response buffer, set the code and mask that together define the identifier(s) that
  319. trigger(s) the automatic response.
  320. </summary>
  321. <param name="handle">An open handle to a CAN circuit.</param>
  322. <param name="idx">The index of the object buffer on which the filter is to be set.</param>
  323. <param name="code">The acceptance code in the filter.</param>
  324. <param name="mask">The acceptance mask in the filter.</param>
  325. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  326. </member>
  327. <member name="M:Kvaser.CanLib.Canlib.canObjBufSetFlags(System.Int32,System.Int32,System.Int32)">
  328. <summary>Sets object buffer flags on a specified object buffer.</summary>
  329. <param name="handle">An open handle to a CAN circuit.</param>
  330. <param name="idx">The buffer on which the flags are to be set.</param>
  331. <param name="flags">Specifies a combination of zero or more of the canOBJBUF_AUTO_RESPONSE_xxx flag values.</param>
  332. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  333. </member>
  334. <member name="M:Kvaser.CanLib.Canlib.canObjBufSetMsgCount(System.Int32,System.Int32,System.Int32)">
  335. <summary>The canObjBufSetMsgCount function sets the message count for an auto transmit object buffer.</summary>
  336. <param name="handle">An open handle to a CAN channel.</param>
  337. <param name="idx">The index of a CAN object buffer.</param>
  338. <param name="count">The message count.</param>
  339. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  340. </member>
  341. <member name="M:Kvaser.CanLib.Canlib.canObjBufSetPeriod(System.Int32,System.Int32,System.Int32)">
  342. <summary>The canObjBufSetPeriod function sets the transmission period for an auto transmission object buffer.</summary>
  343. <param name="handle">An open handle to a CAN channel.</param>
  344. <param name="idx">The index of a CAN object buffer.</param>
  345. <param name="period">The transmission interval, in microseconds.</param>
  346. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  347. </member>
  348. <member name="M:Kvaser.CanLib.Canlib.canObjBufWrite(System.Int32,System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)">
  349. <summary>Defines the contents of a specific object buffer.</summary>
  350. <param name="handle">An open handle to a CAN circuit.</param>
  351. <param name="idx">The index of the object buffer whose contents is to be defined.</param>
  352. <param name="id">The CAN identifier of the message.</param>
  353. <param name="msg">The contents of the message.</param>
  354. <param name="dlc">The length of the message in bytes.
  355. For Classic CAN dlc can be at most 8, unless <see cref="F:Kvaser.CanLib.Canlib.canOPEN_ACCEPT_LARGE_DLC"/> is used.
  356. For CAN FD dlc can be one of the following 0-8, 12, 16, 20, 24, 32, 48, 64.</param>
  357. <param name="flags">Message flags; a combination of the canMSG_xxx flags.</param>
  358. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  359. </member>
  360. <member name="M:Kvaser.CanLib.Canlib.canOpenChannel(System.Int32,System.Int32)">
  361. <summary>
  362. Opens a CAN channel (circuit) and returns a handle which is used
  363. in subsequent calls to CANlib. You can open the same channel from multiple threads, but you must
  364. call <see cref="M:Kvaser.CanLib.Canlib.canOpenChannel(System.Int32,System.Int32)"/> once per thread.
  365. </summary>
  366. <param name="channel">The number of the channel. Channel numbering is hardware dependent.</param>
  367. <param name="flags">A combination of canOPEN_xxx flags</param>
  368. <returns>Returns a handle to the opened circuit, or canERR_xxx (negative) if the call failed.</returns>
  369. </member>
  370. <member name="M:Kvaser.CanLib.Canlib.canParamCommitChanges">
  371. <summary>
  372. This function writes the current set of named parameters to the Registry. Previous entries are erased.
  373. The named parameters are stored in the HKEY_LOCAL_MACHINE\SOFTWARE\KVASER AB\CANLIB32\PredefinedBitrates key in the Registry.
  374. Note
  375. You must have Administrator's rights to write to the Registry.
  376. </summary>
  377. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  378. </member>
  379. <member name="M:Kvaser.CanLib.Canlib.canParamCreateNewEntry">
  380. <summary>
  381. This function creates a new entry in the table of named parameter settings.
  382. The named parameters are stored in the HKEY_LOCAL_MACHINE\SOFTWARE\KVASER AB\CANLIB32\PredefinedBitrates key in the Registry.
  383. Note
  384. You must have Administrator's rights to write to the Registry.
  385. </summary>
  386. <returns>The index of the created entry (zero or positive) if success else canStatus.canERR_XXX.</returns>
  387. </member>
  388. <member name="M:Kvaser.CanLib.Canlib.canParamDeleteEntry(System.Int32)">
  389. <summary>
  390. This function deletes the entry in the table of named parameter settings with the given index.
  391. The entries below (i.e. with higher indices) the deleted entry are moved up one step in the table.
  392. The named parameters are stored in the HKEY_LOCAL_MACHINE\SOFTWARE\KVASER AB\CANLIB32\PredefinedBitrates key in the Registry.
  393. </summary>
  394. <param name="index">The index of the entry to delete.</param>
  395. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  396. </member>
  397. <member name="M:Kvaser.CanLib.Canlib.canParamFindByName(System.String)">
  398. <summary>
  399. This function returns the index of the parameter setting with the given name.
  400. </summary>
  401. <param name="str_name">The name of the setting.</param>
  402. <returns>The index of the setting (zero or positive) if success else canStatus.canERR_XXX.</returns>
  403. </member>
  404. <member name="M:Kvaser.CanLib.Canlib.canParamGetBusParams(System.Int32,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@)">
  405. <summary>
  406. This function retrieves the bus parameters associated with the entry with the given index in the table of named
  407. parameter settings.
  408. </summary>
  409. <param name="index">The index of the entry in the table of named parameter settings.</param>
  410. <param name="bitrate">Bit rate (bits per second).</param>
  411. <param name="tseg1">Time segment 1, that is, the number of quanta from (but not including) the
  412. Sync Segment to the sampling point.</param>
  413. <param name="tseg2">Time segment 2, that is, the number of quanta from the sampling point to
  414. the end of the bit.</param>
  415. <param name="sjw">The Synchronization Jump Width.</param>
  416. <param name="noSamp">The number of sampling points; can be 1 or 3.</param>
  417. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  418. </member>
  419. <member name="M:Kvaser.CanLib.Canlib.canParamGetChannelNumber(System.Int32)">
  420. <summary>
  421. This function returns the channel number of the entry with the given index in the table of named parameter settings.
  422. </summary>
  423. <param name="index">The index of the entry in the table of named parameter settings.</param>
  424. <returns>The channel number of the entry in question (zero or positive) if success else canStatus.canERR_XXX.</returns>
  425. </member>
  426. <member name="M:Kvaser.CanLib.Canlib.canParamGetCount">
  427. <summary>
  428. This function returns the number of entries in the table of named channels.
  429. </summary>
  430. <returns>The number of channels (zero or positive) if success else canStatus.canERR_XXX.</returns>
  431. </member>
  432. <member name="M:Kvaser.CanLib.Canlib.canParamGetName(System.Int32,System.String@)">
  433. <summary>
  434. This function returns the name of a given entry in the list of named parameters.
  435. The named parameters are stored in the HKEY_LOCAL_MACHINE\SOFTWARE\KVASER AB\CANLIB32\PredefinedBitrates key in the Registry.
  436. </summary>
  437. <param name="index">The index of the entry in the named parameters list, whose name is to be returned.</param>
  438. <param name="str_buf">A reference to a string that is to receive the name.</param>
  439. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  440. </member>
  441. <member name="M:Kvaser.CanLib.Canlib.canParamSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  442. <summary>
  443. This function sets or changes the bus parameters for a given entry in the list of named parameters.
  444. Note: The bus parameters are not checked for validity.
  445. </summary>
  446. <param name="index">The index of the entry in the named parameter list whose parameters are to be set or changed.</param>
  447. <param name="bitrate">Bit rate (measured in bits per second); or one of the predefined constants canBITRATE_xxx.</param>
  448. <param name="tseg1">Time segment 1, that is, the number of quanta from (but not including) the
  449. Sync Segment to the sampling point.</param>
  450. <param name="tseg2">Time segment 2, that is, the number of quanta from the sampling point to
  451. the end of the bit.</param>
  452. <param name="sjw">The Synchronization Jump Width.</param>
  453. <param name="noSamp">The number of sampling points; can be 1 or 3.</param>
  454. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  455. </member>
  456. <member name="M:Kvaser.CanLib.Canlib.canParamSetChannelNumber(System.Int32,System.Int32)">
  457. <summary>
  458. This function sets the channel number for a specified entry in the list of named parameters. Channels are numbered from 0 and up.
  459. </summary>
  460. <param name="index">The index of the entry in the named parameter list whose channel number is to be set.</param>
  461. <param name="channel">The channel number</param>
  462. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  463. </member>
  464. <member name="M:Kvaser.CanLib.Canlib.canParamSetName(System.Int32,System.String)">
  465. <summary>
  466. This function sets or changes the name of a named parameter.
  467. </summary>
  468. <param name="index">The index of the named parameter whose name is to be changed or set.</param>
  469. <param name="str_buf">A string that contains the new name. If the string is longer than the
  470. maximum allowed name length, it is truncated.</param>
  471. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  472. </member>
  473. <member name="M:Kvaser.CanLib.Canlib.canParamSwapEntries(System.Int32,System.Int32)">
  474. <summary>
  475. This function swaps two entries in the list of named parameters.
  476. The named parameters are stored in the HKEY_LOCAL_MACHINE\SOFTWARE\KVASER AB\CANLIB32\PredefinedBitrates key in the Registry.
  477. </summary>
  478. <param name="index1">The first of the two entries that are to be swapped in the named parameters list.</param>
  479. <param name="index2">The second of the two entries that are to be swapped in the named parameters list.</param>
  480. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  481. </member>
  482. <member name="M:Kvaser.CanLib.Canlib.canProbeVersion(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  483. <summary>
  484. This function checks whether a specific version of CANlib is installed on the system.
  485. The default behaviour of canProbeVersion is to accept the version specified by major and minor, and any later version, and
  486. all beta versions.
  487. You get the default behaviour by setting flags to 0. Use any combination of the canVERSION_xxx flags to modify the behaviour.
  488. Note: Different handles might have different driver versions installed.This should not normally be the case but it might happen
  489. anyway.You should check the version for each handle you open, e.g.directly after calling canOpenChannel().
  490. </summary>
  491. <param name="hnd">A handle to an open circuit.</param>
  492. <param name="major">The major version number of the version to test for.</param>
  493. <param name="minor">The minor version number of the version to test for.</param>
  494. <param name="oem_id">Reserved, must be zero.</param>
  495. <param name="flags">Any combination of the canVERSION_xxx flags, or 0.</param>
  496. <returns>TRUE if the specified version of CANlib is installed on the system.</returns>
  497. </member>
  498. <member name="M:Kvaser.CanLib.Canlib.CopyFrameData(System.Byte[],System.Byte[],System.Int32)">
  499. <summary>
  500. Helper method to avoid code duplication in CanReadXXX methods.
  501. </summary>
  502. </member>
  503. <member name="M:Kvaser.CanLib.Canlib.canRead(System.Int32,System.Int32@,System.Byte[],System.Int32@,System.Int32@,System.Int64@)">
  504. <summary>
  505. Reads a message from the receive buffer. If no message is available, the function returns immediately
  506. with return code <see cref="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOMSG"/>.
  507. If you are using the same channel via multiple handles, note that the default behaviour is that the
  508. different handles will "hear" each other just as if each handle referred to a channel of its own. If
  509. you open, say, channel 0 from thread A and thread B and then send a message from thread A, it will be
  510. "received" by thread B. This behaviour can be changed using <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_LOCAL_TXECHO"/>.
  511. </summary>
  512. <param name="handle">A handle to an open circuit.</param>
  513. <param name="id">A reference to a buffer which receives the CAN identifier. This buffer will only get the
  514. identifier. To determine whether this identifier was standard (11-bit) or extended (29-bit), and/or
  515. whether it was remote or not, or if it was an error frame, examine the contents of the flag argument.</param>
  516. <param name="msg">A reference to the buffer which receives the message data. The output will be 8 or 64 byte
  517. depending on the type of message that was received (normal or CAN FD).</param>
  518. <param name="dlc">A reference to a buffer which will receive the message length.</param>
  519. <param name="flag">A reference to a buffer which receives the message flags, which is a combination of
  520. the canMSG_xxx (including canFDMSG_xxx if the CAN FD protocol is enabled) and canMSGERR_xxx values.</param>
  521. <param name="time">A reference to a buffer which receives the message time stamp.</param>
  522. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if a message was read. <see cref="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOMSG"/> if there was no message available, canERR_xxx if failure</returns>
  523. </member>
  524. <member name="M:Kvaser.CanLib.Canlib.canReadErrorCounters(System.Int32,System.Int32@,System.Int32@,System.Int32@)">
  525. <summary>
  526. Reads the error counters of the CAN controller.
  527. <see cref="M:Kvaser.CanLib.Canlib.canReadErrorCounters(System.Int32,System.Int32@,System.Int32@,System.Int32@)"/> returns the latest known values of the error counters in the specified circuit.If the error counters change
  528. values precisely when <see cref="M:Kvaser.CanLib.Canlib.canReadErrorCounters(System.Int32,System.Int32@,System.Int32@,System.Int32@)"/> is called, it may not be reflected in the returned result.
  529. Use <see cref="M:Kvaser.CanLib.Canlib.canIoCtl(System.Int32,System.Int32,System.Int32@)"/> to clear the counters.
  530. Note: Not all CAN controllers provide access to the error counters; in this case, an educated guess is returned.
  531. </summary>
  532. <param name="handle">A handle to an open circuit.</param>
  533. <param name="txErr">A reference to an int which receives the transmit error counter.</param>
  534. <param name="rxErr">A reference to an int which receives the receive error counter.</param>
  535. <param name="ovErr">A reference to an int which receives the which receives the number of overrun errors.</param>
  536. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  537. </member>
  538. <member name="M:Kvaser.CanLib.Canlib.canReadSpecific(System.Int32,System.Int32,System.Byte[],System.Int32@,System.Int32@,System.Int64@)">
  539. <summary>
  540. Reads a message with a specified identifier from the receive buffer. Any preceding message not matching
  541. the specified identifier will be kept in the receive buffer. If no message with the specified identifier
  542. is available, the function returns immediately with an error code.
  543. If you are using the same channel via multiple handles, note that the default behaviour is that the different
  544. handles will "hear" each other just as if each handle referred to a channel of its own. If you open, say,
  545. channel 0 from thread A and thread B and then send a message from thread A, it will be "received" by thread B.
  546. This behaviour can be changed using <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_LOCAL_TXECHO"/>.
  547. </summary>
  548. <param name="handle">A handle to an open circuit.</param>
  549. <param name="id">The desired CAN identifier.</param>
  550. <param name="msg">A reference to the buffer which receives the message data. The output will be 8 or 64 byte
  551. depending on the type of message that was received (normal or CAN FD).</param>
  552. <param name="dlc">A reference to a buffer which will receive the message length.</param>
  553. <param name="flag">A reference to a buffer which receives the message flags, which is a combination of
  554. the canMSG_xxx (including canFDMSG_xxx if the CAN FD protocol is enabled) and canMSGERR_xxx values.</param>
  555. <param name="time">A reference to a buffer which receives the message time stamp.</param>
  556. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if a message was read. <see cref="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOMSG"/> if there was no message available, canERR_xxx if failure</returns>
  557. </member>
  558. <member name="M:Kvaser.CanLib.Canlib.canReadSpecificSkip(System.Int32,System.Int32,System.Byte[],System.Int32@,System.Int32@,System.Int64@)">
  559. <summary>
  560. Reads a message with a specified identifier from the receive buffer. Any preceding message not matching
  561. the specified identifier will be removed in the receive buffer. If no message with the specified identifier
  562. is available, the function returns immediately with an error code.
  563. If you are using the same channel via multiple handles, note that the default behaviour is that the different
  564. handles will "hear" each other just as if each handle referred to a channel of its own. If you open, say,
  565. channel 0 from thread A and thread B and then send a message from thread A, it will be "received" by thread B.
  566. This behaviour can be changed using <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_LOCAL_TXECHO"/>.
  567. </summary>
  568. <param name="hnd">A handle to an open circuit.</param>
  569. <param name="id">The desired CAN identifier.</param>
  570. <param name="msg">A reference to the buffer which receives the message data. The output will be 8 or 64 byte
  571. depending on the type of message that was received (normal or CAN FD).</param>
  572. <param name="dlc">A reference to a buffer which will receive the message length.</param>
  573. <param name="flag">A reference to a buffer which receives the message flags, which is a combination of
  574. the canMSG_xxx (including canFDMSG_xxx if the CAN FD protocol is enabled) and canMSGERR_xxx values.</param>
  575. <param name="time">A reference to a buffer which receives the message time stamp.</param>
  576. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if a message was read. <see cref="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOMSG"/> if there was no message available, canERR_xxx if failure</returns>
  577. </member>
  578. <member name="M:Kvaser.CanLib.Canlib.canReadStatus(System.Int32,System.Int64@)">
  579. <summary>
  580. Returns the status for the specified circuit.
  581. flags receives a combination of the canSTAT_xxx flags.
  582. </summary>
  583. <param name="handle">A handle to an open circuit.</param>
  584. <param name="flags">a long which receives the status flags; this is a combination of any of the canSTAT_xxx.</param>
  585. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  586. </member>
  587. <member name="M:Kvaser.CanLib.Canlib.canReadSync(System.Int32,System.Int64)">
  588. <summary>
  589. Waits until the receive buffer contains at least one message or a timeout occurs.
  590. If you are using the same channel via multiple handles, note that the default behaviour is that the different handles
  591. will "hear" each other just as if each handle referred to a channel of its own.If you open, say, channel 0 from thread
  592. A and thread B and then send a message from thread A, it will be "received" by thread B.This behaviour can be changed
  593. using <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_LOCAL_TXECHO"/>.
  594. </summary>
  595. <param name="handle">A handle to an open circuit.</param>
  596. <param name="timeout">The timeout in milliseconds. 0xFFFFFFFF gives an infinite timeout.</param>
  597. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> (zero) if the queue contains the desired message.
  598. <see cref="F:Kvaser.CanLib.Canlib.canStatus.canERR_TIMEOUT"/> (negative) if a timeout occurs before a message arrived.
  599. canERR_xxx (negative) if the call fails.</returns>
  600. </member>
  601. <member name="M:Kvaser.CanLib.Canlib.canReadSyncSpecific(System.Int32,System.Int32,System.Int64)">
  602. <summary>
  603. Waits until the receive queue contains a message with the specified id, or a timeout occurs.
  604. If you are using the same channel via multiple handles, note that the default behaviour is that the
  605. different handles will "hear" each other just as if each handle referred to a channel of its own.
  606. If you open, say, channel 0 from thread A and thread B and then send a message from thread A, it will
  607. be "received" by thread B. This behaviour can be changed using <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_LOCAL_TXECHO"/>.
  608. </summary>
  609. <param name="handle">A handle to an open circuit.</param>
  610. <param name="id">The desired message identifier.</param>
  611. <param name="timeout">The timeout in milliseconds. 0xFFFFFFFF gives an infinite timeout.</param>
  612. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> (zero) if the queue contains the desired message.
  613. <see cref="F:Kvaser.CanLib.Canlib.canStatus.canERR_TIMEOUT"/> (negative) if a timeout occurs before a message arrived.
  614. canERR_xxx (negative) if the call fails.</returns>
  615. </member>
  616. <member name="M:Kvaser.CanLib.Canlib.canRequestBusStatistics(System.Int32)">
  617. <summary>
  618. The canRequestBusStatistics function requests bus statistics from the hardware. The bus statistics figures can be retrieved later by a call
  619. to the canGetBusStatistics function.
  620. <para>&#160;</para>
  621. Note: The time between a call to <see cref="M:Kvaser.CanLib.Canlib.canRequestBusStatistics(System.Int32)"/> and the point in time where the bus statistics is actually available via a call
  622. to <see cref="M:Kvaser.CanLib.Canlib.canGetBusStatistics(System.Int32,Kvaser.CanLib.Canlib.canBusStatistics@)"/> is not defined. Typically, you would call <see cref="M:Kvaser.CanLib.Canlib.canRequestBusStatistics(System.Int32)"/> from your application periodically (for example,
  623. once per second) to request the data from the driver and then call <see cref="M:Kvaser.CanLib.Canlib.canGetBusStatistics(System.Int32,Kvaser.CanLib.Canlib.canBusStatistics@)"/> with the same rate to obtain the latest reported data.
  624. </summary>
  625. <param name="hnd">An open handle to a CAN channel.</param>
  626. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  627. </member>
  628. <member name="M:Kvaser.CanLib.Canlib.canRequestChipStatus(System.Int32)">
  629. <summary>
  630. The <see cref="M:Kvaser.CanLib.Canlib.canRequestChipStatus(System.Int32)"/> function requests that the hardware report the chip status (bus on/error passive status etc.) to the driver.
  631. The chip status can later be retrieved using the <see cref="M:Kvaser.CanLib.Canlib.canReadStatus(System.Int32,System.Int64@)"/> function.
  632. <para>&#160;</para>
  633. Note: The <see cref="M:Kvaser.CanLib.Canlib.canRequestChipStatus(System.Int32)"/> function is asynchronous, that is, it completes before the answer is returned from the hardware.
  634. The time between a call to <see cref="M:Kvaser.CanLib.Canlib.canRequestChipStatus(System.Int32)"/> and the point in time where the chip status is actually available via a call
  635. to <see cref="M:Kvaser.CanLib.Canlib.canReadStatus(System.Int32,System.Int64@)"/> is not defined. <see cref="M:Kvaser.CanLib.Canlib.canReadStatus(System.Int32,System.Int64@)"/> always returns the latest data reported by the hardware.
  636. </summary>
  637. <param name="hnd">An open handle to a CAN channel.</param>
  638. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  639. </member>
  640. <member name="M:Kvaser.CanLib.Canlib.canResetBus(System.Int32)">
  641. <summary>
  642. This function tries to reset a CAN bus controller by taking the channel off bus and then on bus again
  643. (if it was on bus before the call to <see cref="M:Kvaser.CanLib.Canlib.canResetBus(System.Int32)"/>).
  644. This function will affect the hardware (and cause a real reset of the CAN chip) only if handle is the only
  645. handle open on the channel. If there are other open handles, this operation will not affect the hardware.
  646. </summary>
  647. <param name="handle"></param>
  648. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  649. </member>
  650. <member name="M:Kvaser.CanLib.Canlib.canReadWait(System.Int32,System.Int32@,System.Byte[],System.Int32@,System.Int32@,System.Int64@,System.Int64)">
  651. <summary>
  652. Reads a message from the receive buffer. If no message is available, the function waits until a message arrives or a timeout occurs.
  653. If you are using the same channel via multiple handles, note that the default behaviour is that the different handles will "hear" each
  654. other just as if each handle referred to a channel of its own. If you open, say, channel 0 from thread A and thread B and then send a
  655. message from thread A, it will be "received" by thread B. This behaviour can be changed using <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_LOCAL_TXECHO"/>.
  656. </summary>
  657. <param name="handle">A handle to an open circuit.</param>
  658. <param name="id">A reference to a buffer which receives the CAN identifier. This buffer will only get the
  659. identifier. To determine whether this identifier was standard (11-bit) or extended (29-bit), and/or
  660. whether it was remote or not, or if it was an error frame, examine the contents of the flag argument.</param>
  661. <param name="msg">A reference to the buffer which receives the message data. The output will be 8 or 64 byte
  662. depending on the type of message that was received (normal or CAN FD).</param>
  663. <param name="dlc">A reference to a buffer which will receive the message length.</param>
  664. <param name="flag">A reference to a buffer which receives the message flags, which is a combination of
  665. the canMSG_xxx (including canFDMSG_xxx if the CAN FD protocol is enabled) and canMSGERR_xxx values.</param>
  666. <param name="time">A reference to a buffer which receives the message time stamp.</param>
  667. <param name="timeout">If no message is immediately available, this parameter gives the number of milliseconds to wait for a message before
  668. returning. 0xFFFFFFFF gives an infinite timeout.</param>
  669. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success,
  670. <see cref = "F:Kvaser.CanLib.Canlib.canStatus.canERR_NOMSG"/> if there was no message available.
  671. else canStatus.canERR_XXX if failure.</returns>
  672. </member>
  673. <member name="M:Kvaser.CanLib.Canlib.canSetAcceptanceFilter(System.Int32,System.Int32,System.Int32,System.Int32)">
  674. <summary>
  675. This routine sets the message acceptance filters on a CAN channel.
  676. Format of code and mask:
  677. A binary 1 in a mask means "the corresponding bit in the code isrelevant"
  678. A binary 0 in a mask means "the corresponding bit in the code is notrelevant"
  679. A relevant binary 1 in a code means "the corresponding bit in theidentifier must be 1"
  680. A relevant binary 1 in a code means "the corresponding bit in theidentifier must be 1"
  681. In other words, the message is accepted if ((code XOR id) AND mask) == 0.
  682. is_extended should be set to:
  683. 0: if the code and mask shall apply to 11-bit CAN identifiers.
  684. 1: if the code and mask shall apply to 29-bit CAN identifiers.
  685. If you want to remove a filter, call canSetAcceptanceFilter() with the mask set to 0.
  686. On some boards the acceptance filtering is done by the CAN hardware; on other boards(typically those with an embedded CPU,)
  687. the acceptance filtering is done by software. <see cref="M:Kvaser.CanLib.Canlib.canSetAcceptanceFilter(System.Int32,System.Int32,System.Int32,System.Int32)"/> behaves in the same way for all boards, however.
  688. <see cref="M:Kvaser.CanLib.Canlib.canSetAcceptanceFilter(System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canAccept(System.Int32,System.Int32,System.Int32)"/> both serve the same purpose but the former can set the code and mask in just one call.
  689. Note: You can set the extended code and mask only on CAN boards that support extended identifiers.Not all CAN boards support
  690. different masks for standard and extended CAN identifiers.
  691. Not implemented in linux.
  692. </summary>
  693. <param name="hnd">An open handle to a CAN circuit.</param>
  694. <param name="code">The acceptance code to set.</param>
  695. <param name="mask">The acceptance mask to set.</param>
  696. <param name="is_extended">Select 29-bit CAN identifiers.</param>
  697. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  698. </member>
  699. <member name="M:Kvaser.CanLib.Canlib.canSetBitrate(System.Int32,System.Int32)">
  700. <summary>
  701. The <see cref="M:Kvaser.CanLib.Canlib.canSetBitrate(System.Int32,System.Int32)"/> function sets the nominal bit rate of the specified CAN channel. The sampling point is recalculated and
  702. kept as close as possible to the value before the call.
  703. </summary>
  704. <param name="hnd">An open handle to a CAN channel.</param>
  705. <param name="bitrate">The new bit rate, in bits/second.</param>
  706. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  707. </member>
  708. <member name="M:Kvaser.CanLib.Canlib.canSetBusOutputControl(System.Int32,System.Int32)">
  709. <summary>
  710. This function sets the driver type for a CAN controller. This corresponds
  711. loosely to the bus output control register in the CAN controller, hence the
  712. name of this function. CANlib does not allow for direct manipulation of the
  713. bus output control register; instead, symbolic constants are used to select
  714. the desired driver type.
  715. </summary>
  716. <param name="handle"> An open handle to a CAN channel.</param>
  717. <param name="drivertype"> Can driver type, canDRIVER_xxx).</param>
  718. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  719. </member>
  720. <member name="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  721. <summary>
  722. This function sets the nominal bus timing parameters for the specified CAN
  723. controller.
  724. The library provides default values for tseg1, tseg2, sjw and noSamp when
  725. freq is specified to one of the pre-defined constants,
  726. canBITRATE_xxx for classic CAN and canFD_BITRATE_xxx for CAN FD.
  727. If freq is any other value, no default values are supplied by the
  728. library.
  729. If you are using multiple handles to the same physical channel, for example
  730. if you are writing a threaded application, you must call <see cref="M:Kvaser.CanLib.Canlib.canBusOff(System.Int32)"/> once
  731. for each handle.The same applies to <see cref="M:Kvaser.CanLib.Canlib.canBusOn(System.Int32)"/> - the physical channel will
  732. not go off bus until the last handle to the channel goes off bus.
  733. Note: The value of sjw should normally be less than tseg1 and tseg2.
  734. Use <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)"/> to set the bus timing parameters in the
  735. ubiquitous 82c200 bit-timing register format.
  736. </summary>
  737. <param name="handle"> An open handle to a CAN channel.</param>
  738. <param name="freq"> Bit rate (measured in bits per second); or one of the
  739. predefined constants(canBITRATE_xxx for classic
  740. CAN and canFD_BITRATE_xxx for CAN FD).</param>
  741. <param name="tseg1"> Time segment 1, that is, the number of quanta from (but not
  742. including) the Sync Segment to the sampling point.</param>
  743. <param name="tseg2"> Time segment 2, that is, the number of quanta from the sampling
  744. point to the end of the bit.</param>
  745. <param name="sjw"> The Synchronization Jump Width.</param>
  746. <param name="noSamp"> The number of sampling points; can be 1 or 3.</param>
  747. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  748. </member>
  749. <member name="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)">
  750. <summary>
  751. This function sets the bus timing parameters using the same convention as the 82c200 CAN controller (which is the same as many
  752. other CAN controllers, for example, the 82527.)
  753. To calculate the bit timing parameters, you can use the bit timing calculator that is included with CANlib SDK. Look in the BIN directory.
  754. 82c200 Bit Timing
  755. btr0 [b7..b6]: SJW - 1
  756. btr0 [b5..b0]: Prescaler -1
  757. btr1 [b7]: 1: 3 samples, 0: 1 samples
  758. btr1 [b6..b4]: tseg2 - 1
  759. btr1 [b3..b0]: tseg1 - 2
  760. Note: CANlib will always behave as if the clock frequency is 16 MHz. It does not matter if the device has a different physical clock,
  761. since this will be compensated for by the driver.
  762. </summary>
  763. <param name="hnd">A handle to an open CAN circuit.</param>
  764. <param name="btr0">The desired bit timing, formatted as the contents of the BTR0 register in the 82c200.</param>
  765. <param name="btr1">The desired bit timing, formatted as the contents of the BTR1 register in the 82c200.</param>
  766. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  767. </member>
  768. <member name="M:Kvaser.CanLib.Canlib.canSetBusParamsFd(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  769. <summary>
  770. This function sets the data phase bus timing parameters for the specified
  771. CAN controller.
  772. The library provides default values for tseg1, tseg2 and
  773. sjw when freq is specified to one of the pre-defined
  774. constants, canFD_BITRATE_xxx.
  775. </summary>
  776. <param name="handle">An open handle to a CAN channel.</param>
  777. <param name="freq">CAN FD data bit rate (measured in bits per second); or
  778. one of the predefined constants canFD_BITRATE_xxx.</param>
  779. <param name="tseg1">Time segment 1, that is, the number of quanta from (but not
  780. including) the Sync Segment to the sampling point.</param>
  781. <param name="tseg2">Time segment 2, that is, the number of quanta from the sampling
  782. point to the end of the bit.</param>
  783. <param name="sjw">The Synchronization Jump Width.</param>
  784. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  785. </member>
  786. <member name="M:Kvaser.CanLib.Canlib.canSetBusParamsTq(System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq)">
  787. <summary>
  788. Set bus parameters for the specified CAN controller (classic CAN).
  789. If the channel is opened(see <see cref="M:Kvaser.CanLib.Canlib.canOpenChannel(System.Int32,System.Int32)"/>) with flags <see cref="F:Kvaser.CanLib.Canlib.canOPEN_CAN_FD"/> or <see cref="F:Kvaser.CanLib.Canlib.canOPEN_CAN_FD_NONISO"/>,
  790. use <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsFdTq(System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq,Kvaser.CanLib.Canlib.kvBusParamsTq)"/> instead.
  791. <remarks>Constraints that must be fulfilled:
  792. <c>nominal.tq = 1 + nominal.prop + nominal.phase1 + nominal.phase2</c>
  793. <c>nominal.tq &#8805; 3</c>
  794. <c>nominal.sjw &#8804; min(nominal.phase1, nominal.phase2)</c>
  795. <c>1 &#8804; nominal.prescaler &#8804; 2</c></remarks>
  796. To get device specific limits of bus parameters, see <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_BUS_PARAM_LIMITS"/>.
  797. </summary>
  798. <param name="hnd">An open handle to a CAN channel.</param>
  799. <param name="nominal">Structure holding all Nominal values.</param>
  800. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  801. </member>
  802. <member name="M:Kvaser.CanLib.Canlib.canGetBusParamsTq(System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq@)">
  803. <summary>
  804. Get bus parameters for the specified CAN controller.
  805. If the channel is opened (see <see cref="M:Kvaser.CanLib.Canlib.canOpenChannel(System.Int32,System.Int32)"/>) with flags <see cref="F:Kvaser.CanLib.Canlib.canOPEN_CAN_FD"/> or <see cref="F:Kvaser.CanLib.Canlib.canOPEN_CAN_FD_NONISO"/>, use <see cref="M:Kvaser.CanLib.Canlib.canGetBusParamsFdTq(System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq@,Kvaser.CanLib.Canlib.kvBusParamsTq@)"/> instead.
  806. </summary>
  807. <param name="hnd">An open handle to a CAN channel.</param>
  808. <param name="nominal">Structure holding bus parameters.</param>
  809. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  810. </member>
  811. <member name="M:Kvaser.CanLib.Canlib.canSetBusParamsFdTq(System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq,Kvaser.CanLib.Canlib.kvBusParamsTq)">
  812. <summary>
  813. Set bus parameters for the specified CAN controller.
  814. Use if the channel is opened(see <see cref="M:Kvaser.CanLib.Canlib.canOpenChannel(System.Int32,System.Int32)"/>) with flags <see cref="F:Kvaser.CanLib.Canlib.canOPEN_CAN_FD"/> or <see cref="F:Kvaser.CanLib.Canlib.canOPEN_CAN_FD_NONISO"/>, use <see cref="M:Kvaser.CanLib.Canlib.canGetBusParamsTq(System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq@)"/> otherwise.
  815. <remarks>
  816. Constraints that must be fulfilled:
  817. <c>nominal.tq = 1 + nominal.prop + nominal.phase1 + nominal.phase2</c>
  818. <c>nominal.tq &#8805; 3</c>
  819. <c>nominal.sjw &#8804; min(nominal.phase1, nominal.phase2)</c>
  820. <c>1 &#8804; nominal.prescaler &#8804; 2</c>
  821. <c>data.sjw &#8804; min(data.phase1, data.phase2)</c>
  822. <c>data.tq = 1 + data.phase1 + data.phase2</c>
  823. <c>data.tq &#8805; 3</c>
  824. <c>data.prescaler = nominal.prescaler</c>
  825. <c>data.prop = 0</c>
  826. </remarks>
  827. To get device specific limits of bus parameters, see <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_BUS_PARAM_LIMITS"/>.
  828. </summary>
  829. <param name="hnd">An open handle to a CAN channel.</param>
  830. <param name="nominal">Structure holding bus parameters for arbitration phase.</param>
  831. <param name="data">Structure holding bus parameters for data phase.</param>
  832. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  833. </member>
  834. <member name="M:Kvaser.CanLib.Canlib.canGetBusParamsFdTq(System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq@,Kvaser.CanLib.Canlib.kvBusParamsTq@)">
  835. <summary>
  836. Get bus parameters for the specified CAN controller.
  837. Use if the channel is opened(see <see cref="M:Kvaser.CanLib.Canlib.canOpenChannel(System.Int32,System.Int32)"/>) with flags <see cref="F:Kvaser.CanLib.Canlib.canOPEN_CAN_FD"/> or <see cref="F:Kvaser.CanLib.Canlib.canOPEN_CAN_FD_NONISO"/>, use <see cref="M:Kvaser.CanLib.Canlib.canGetBusParamsTq(System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq@)"/> otherwise.
  838. </summary>
  839. <param name="hnd">An open handle to a CAN channel.</param>
  840. <param name="nominal">Structure holding all Nominal values.</param>
  841. <param name="data">Structure holding all Data values.</param>
  842. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  843. </member>
  844. <member name="M:Kvaser.CanLib.Canlib.canSetDriverMode(System.Int32,System.Int32,System.Int32)">
  845. <summary>
  846. This function sets the current CAN bus driver mode. This is typically a mode like sleep, wakeup, standby, fast mode, etc.
  847. The different modes are almost always hardware dependent and requires special DRVcan cables. As an example, the DRVcan S
  848. implements J2411 compliant single-wire CAN and supports four line modes, namely Normal, Sleep, Fast and Wakeup.
  849. Standard ISO 11898 CAN do not support any of these bus driver modes.
  850. Note: The bus driver mode is typically used to control things like one- or two-wire mode, sleep mode, and so on. It requires
  851. special support in the CAN driver circuit.
  852. </summary>
  853. <param name="hnd">An open handle to a CAN circuit.</param>
  854. <param name="lineMode">An int which defines the line mode, canTRANSCEIVER_LINEMODE_xxx.</param>
  855. <param name="resNet">An int which defines the resnet mode. Set this parameter to <see cref="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_RESNET_NA"/> unless you have good
  856. reasons to set it to something else.</param>
  857. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  858. </member>
  859. <member name="M:Kvaser.CanLib.Canlib.canSetNotify(System.Int32,System.IntPtr,System.Int32)">
  860. <summary>
  861. This function associates a window handle with the CAN circuit. A WM__CANLIB message is sent to that window when certain events
  862. (specified by the canNOTIFY_xxx flags) occur.
  863. When an event take place, a WM__CANLIB message will be sent to the window whose handle is aHWnd. This WM__CANLIB message will have:
  864. * WPARAM handle to the circuit where the event occurred
  865. * HIWORD(LPARAM) 0
  866. * LOWORD(LPARAM) canEVENT_xxx
  867. In the routine that handles WM__CANLIB, you can call the CANlib API functions (for example, <see cref="M:Kvaser.CanLib.Canlib.canRead(System.Int32,System.Int32@,System.Byte[],System.Int32@,System.Int32@,System.Int64@)"/>) using the handle found in wParam.
  868. In the routine that handles WM__CANLIB, you must call <see cref="M:Kvaser.CanLib.Canlib.canRead(System.Int32,System.Int32@,System.Byte[],System.Int32@,System.Int32@,System.Int64@)"/> repeatedly until it returns canERR_NOMSG, regardless of the LPARAM value.
  869. This will flush the driver's internal event queues. If you fail to do this, no more events will be reported.
  870. </summary>
  871. <param name="handle">A handle to an open CAN circuit.</param>
  872. <param name="win_handle">Handle of the window which will receive the notification messages.</param>
  873. <param name="aNotifyFlags">The events specified with canNOTIFY_xxx, for which callback should be called.</param>
  874. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  875. </member>
  876. <member name="M:Kvaser.CanLib.Canlib.canTranslateBaud(System.Int32,System.Int32@,System.Int32@,System.Int32@,System.Int32@,System.Int32@)">
  877. <summary>
  878. This function translates the canBITRATE_xxx constants to their corresponding bus parameter values. At return, this freq
  879. contains the actual bit rate (in bits per second). TSeg1 is the number of quanta (less one) in a bit before the sampling
  880. point. TSeg2 is the number of quanta after the sampling point.
  881. </summary>
  882. <param name="bitrate">An int which contains the canBITRATE_xxx constant to translate.</param>
  883. <param name="freq">Frequency value.</param>
  884. <param name="tseg1">Time segment 1, that is, the number of quanta from (but not
  885. including) the Sync Segment to the sampling point. </param>
  886. <param name="tseg2">Time segment 2, that is, the number of quanta from the sampling
  887. point to the end of the bit. </param>
  888. <param name="sjw">Synchronization Jump Width. </param>
  889. <param name="nosamp">Number of sampling points. </param>
  890. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  891. </member>
  892. <member name="M:Kvaser.CanLib.Canlib.kvBitrateToBusParamsTq(System.Int32,System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq@)">
  893. <summary>
  894. This function initializes a kvBusParamsTq object from a canBITRATE_xxx constant.
  895. </summary>
  896. <param name="hnd">A handle to an open CAN circuit.</param>
  897. <param name="freq">An int which contains the canBITRATE_xxx constant to translate.</param>
  898. <param name="nominal">kvBusParamsTq object that will be initialized.</param>
  899. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  900. </member>
  901. <member name="M:Kvaser.CanLib.Canlib.kvBitrateToBusParamsFdTq(System.Int32,System.Int32,System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq@,Kvaser.CanLib.Canlib.kvBusParamsTq@)">
  902. <summary>
  903. This function initializes a kvBusParamsTq object from canFD_BITRATE_xxx constants.
  904. </summary>
  905. <param name="hnd">A handle to an open CAN circuit.</param>
  906. <param name="freqA">An int which contains the canFD_BITRATE_xxx arbitration bitrate constant to translate.</param>
  907. <param name="freqD">An int which contains the canFD_BITRATE_xxx data bitrate constant to translate.</param>
  908. <param name="arbitration">kvBusParamsTq object that will be initialized for the arbitration bitrate.</param>
  909. <param name="data">kvBusParamsTq object that will be initialized for the data bitrate.</param>
  910. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  911. </member>
  912. <member name="M:Kvaser.CanLib.Canlib.canWaitForEvent(System.Int32,System.Int64)">
  913. <summary>
  914. Waits for an event (of any kind) to happen at the specified CAN circuit, or a timeout to occur. An event in this context means
  915. for example the arrival of a CAN message or a CAN bus status change, but it can also be an event internal to the driver.
  916. </summary>
  917. <param name="hnd">A handle to an open CAN circuit.</param>
  918. <param name="timeout">The number of milliseconds to wait before the call returns, if no event occurs. 0xFFFFFFFF gives an
  919. infinite timeout.</param>
  920. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> (zero) if success. <see cref="F:Kvaser.CanLib.Canlib.canStatus.canERR_TIMEOUT"/> (negative) if nothing happened during the specified time period.
  921. canERR_xxx (negative) if failure</returns>
  922. </member>
  923. <member name="M:Kvaser.CanLib.Canlib.canWrite(System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)">
  924. <summary>
  925. This function sends a CAN message. The call returns immediately after queuing the message to the driver.
  926. If you are using the same channel via multiple handles, note that the default behaviour is that the
  927. different handles will "hear" each other just as if each handle referred to a channel of its own. If you
  928. open, say, channel 0 from thread A and thread B and then send a message from thread A, it will be "received"
  929. by thread B. This behaviour can be changed using <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_LOCAL_TXECHO"/>.
  930. <para>&#160;</para>
  931. Note
  932. The message has been queued for transmission when this calls return. It has not necessarily been sent.
  933. </summary>
  934. <param name="handle">A handle to an open CAN circuit.</param>
  935. <param name="id">The identifier of the CAN message to send.</param>
  936. <param name="msg">A reference to the message data.</param>
  937. <param name="dlc">The length of the message in bytes.
  938. For Classic CAN dlc can be at most 8, unless <see cref="F:Kvaser.CanLib.Canlib.canOPEN_ACCEPT_LARGE_DLC"/> is used.
  939. For CAN FD dlc can be one of the following 0-8, 12, 16, 20, 24, 32, 48, 64.</param>
  940. <param name="flag">A combination of message flags, canMSG_xxx (including canFDMSG_xxx if the CAN FD protocol
  941. is enabled). Use this parameter to send extended (29-bit) frames and/or remote frames. Use <see cref="F:Kvaser.CanLib.Canlib.canMSG_EXT"/> and/or
  942. <see cref="F:Kvaser.CanLib.Canlib.canMSG_RTR"/> for this purpose.</param>
  943. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  944. </member>
  945. <member name="M:Kvaser.CanLib.Canlib.canWriteSync(System.Int32,System.Int64)">
  946. <summary>
  947. Waits until all CAN messages for the specified handle are sent, or the timeout period expires.
  948. </summary>
  949. <param name="handle">A handle to an open CAN circuit.</param>
  950. <param name="timeout">The timeout in milliseconds. 0xFFFFFFFF gives an infinite timeout.</param>
  951. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> (zero) if the queue emptied before the timeout period came to its end.
  952. <see cref="F:Kvaser.CanLib.Canlib.canStatus.canERR_TIMEOUT"/> (negative) not all messages were transmitted when the timeout occurred.
  953. <see cref="F:Kvaser.CanLib.Canlib.canStatus.canERR_PARAM"/> (negative) This could be caused by an erroneous parameter, or if you have turned TXACKs off (by using <see cref="M:Kvaser.CanLib.Canlib.canIoCtl(System.Int32,System.Int32,System.Object@)"/>)
  954. because if you do you can't use this call. The driver simply doesn't know when all the messages are sent!
  955. canERR_xxx (negative) if failure</returns>
  956. </member>
  957. <member name="M:Kvaser.CanLib.Canlib.canWriteWait(System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,System.Int64)">
  958. <summary>
  959. This function sends a CAN message. It returns when the message is sent, or the timeout expires.
  960. This is a convenience function that combines <see cref="M:Kvaser.CanLib.Canlib.canWrite(System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canWriteSync(System.Int32,System.Int64)"/>.
  961. If you are using the same channel via multiple handles, note that the default behaviour is that the different handles will
  962. "hear" each other just as if each handle referred to a channel of its own. If you open, say, channel 0 from thread A and
  963. thread B and then send a message from thread A, it will be "received" by thread B. This behaviour can be changed using
  964. <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_LOCAL_TXECHO"/>.
  965. </summary>
  966. <param name="handle">A handle to an open CAN circuit.</param>
  967. <param name="id">The identifier of the CAN message to send.</param>
  968. <param name="msg">A reference to the message data.</param>
  969. <param name="dlc">The length of the message in bytes.
  970. For Classic CAN dlc can be at most 8, unless <see cref="F:Kvaser.CanLib.Canlib.canOPEN_ACCEPT_LARGE_DLC"/> is used.
  971. For CAN FD dlc can be one of the following 0-8, 12, 16, 20, 24, 32, 48, 64.</param>
  972. <param name="flag">A combination of message flags, canMSG_xxx (including canFDMSG_xxx if the CAN FD protocol
  973. is enabled). Use this parameter to send extended (29-bit) frames and/or remote frames. Use canMSG_EXT and/or
  974. canMSG_RTR for this purpose.</param>
  975. <param name="timeout">The timeout, in milliseconds. 0xFFFFFFFF gives an infinite timeout.</param>
  976. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  977. </member>
  978. <member name="M:Kvaser.CanLib.Canlib.canUnloadLibrary">
  979. <summary>
  980. Use this function if you are loading canlib32.dll dynamically (that is, using the Win32 API LoadLibrary)
  981. and need to unload it using the Win32 API FreeLibrary. <see cref="M:Kvaser.CanLib.Canlib.canUnloadLibrary"/> will free allocated memory,
  982. unload the DLLs canlib32.dll has loaded and de-initialize data structures.
  983. You must call <see cref="M:Kvaser.CanLib.Canlib.canInitializeLibrary"/> again to use the API functions in canlib32.dll.
  984. </summary>
  985. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  986. </member>
  987. <member name="M:Kvaser.CanLib.Canlib.GetUTF8Bytes(System.String)">
  988. <summary>
  989. Create a byte[] containing the utf-8 representation of string stringValue and a terminating'\0' character.
  990. </summary>
  991. </member>
  992. <member name="M:Kvaser.CanLib.Canlib.GetUTF8String(System.Byte[])">
  993. <summary>
  994. Convert byte[] contents to a string object using the utf-8 decoder.
  995. </summary>
  996. </member>
  997. <member name="M:Kvaser.CanLib.Canlib.CANSTATUS_SUCCESS(System.Int32)">
  998. <summary>
  999. Evaluate status code value as an int.
  1000. </summary>
  1001. <param name="X">status as int value.</param>
  1002. <returns>1 if x is equal to int value of canStatus.canOK else 0.</returns>
  1003. </member>
  1004. <member name="M:Kvaser.CanLib.Canlib.CANSTATUS_FAILURE(System.Int32)">
  1005. <summary>
  1006. Evaluate status code value as an int.
  1007. </summary>
  1008. <param name="X">status as int value.</param>
  1009. <returns>0 if x is equal to int value of canStatus.canOK else 1.</returns>
  1010. </member>
  1011. <member name="M:Kvaser.CanLib.Canlib.kvAnnounceIdentity(System.Int32,System.Object)">
  1012. <summary>
  1013. The <see cref="M:Kvaser.CanLib.Canlib.kvAnnounceIdentity(System.Int32,System.Object)"/> function is used by certain OEM applications.
  1014. </summary>
  1015. <param name="hnd">An open handle to a CAN channel.</param>
  1016. <param name="buffer"> Data to send to driver.</param>
  1017. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1018. </member>
  1019. <member name="M:Kvaser.CanLib.Canlib.kvAnnounceIdentityEx(System.Int32,System.Int32,System.Byte[])">
  1020. <summary>
  1021. The <see cref="M:Kvaser.CanLib.Canlib.kvAnnounceIdentityEx(System.Int32,System.Int32,System.Byte[])"/> function is used by certain OEM applications.
  1022. </summary>
  1023. <param name="hnd">An open handle to a CAN channel.</param>
  1024. <param name="type"> Type of announcement.</param>
  1025. <param name="data"> Data to send to driver.</param>
  1026. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1027. </member>
  1028. <member name="M:Kvaser.CanLib.Canlib.kvBeep(System.Int32,System.Int32,System.Int32)">
  1029. <summary>
  1030. Emit a sound of a specific frequency and duration from the loudspeaker on the device.
  1031. <para>&#160;</para>
  1032. Note: This function requires that a loudspeaker be present on the hardware.
  1033. </summary>
  1034. <param name="hnd">An open handle to a CAN channel.</param>
  1035. <param name="freq"> The frequency (in Hertz) of the sound.</param>
  1036. <param name="duration"> The duration of the sound, in milliseconds.</param>
  1037. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1038. </member>
  1039. <member name="M:Kvaser.CanLib.Canlib.kvDeviceGetMode(System.Int32,System.Int32@)">
  1040. <summary>
  1041. The <see cref="M:Kvaser.CanLib.Canlib.kvDeviceGetMode(System.Int32,System.Int32@)"/> reads the current device's specific mode.
  1042. </summary>
  1043. <param name="hnd">An open handle to a CAN channel.</param>
  1044. <param name="result"> A pointer to a 32-bit integer that will receive the kvDEVICE_MODE_xxx value.</param>
  1045. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1046. </member>
  1047. <member name="M:Kvaser.CanLib.Canlib.kvDeviceSetMode(System.Int32,System.Int32)">
  1048. <summary>
  1049. The <see cref="M:Kvaser.CanLib.Canlib.kvDeviceSetMode(System.Int32,System.Int32)"/> sets the mode.
  1050. </summary>
  1051. <param name="hnd">An open handle to a CAN channel.</param>
  1052. <param name="mode">One of the kvDEVICE_MODE_xxx constants, defining which mode to use.</param>
  1053. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1054. </member>
  1055. <member name="M:Kvaser.CanLib.Canlib.kvFileCopyFromDevice(System.Int32,System.String,System.String)">
  1056. <summary>
  1057. Copy an arbitrary file from the device to the host.
  1058. </summary>
  1059. <param name="hnd">An open handle to a CAN channel.</param>
  1060. <param name="deviceFileName">The device file name.</param>
  1061. <param name="hostFileName"> The target host file name.</param>
  1062. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1063. </member>
  1064. <member name="M:Kvaser.CanLib.Canlib.kvFileCopyToDevice(System.Int32,System.String,System.String)">
  1065. <summary>
  1066. Copy an arbitrary file from the host to the device.
  1067. </summary>
  1068. <param name="hnd">An open handle to a CAN channel.</param>
  1069. <param name="hostFileName">The host file name.</param>
  1070. <param name="deviceFileName">The target device file name.</param>
  1071. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1072. </member>
  1073. <member name="M:Kvaser.CanLib.Canlib.kvFileDelete(System.Int32,System.String)">
  1074. <summary>
  1075. This function deletes a file on the device
  1076. </summary>
  1077. <param name="hnd">An open handle to a CAN channel.</param>
  1078. <param name="deviceFileName">The file on the device to delete.</param>
  1079. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1080. </member>
  1081. <member name="M:Kvaser.CanLib.Canlib.kvFileGetCount(System.Int32,System.Int32@)">
  1082. <summary>
  1083. Get the number of files.
  1084. </summary>
  1085. <param name="hnd">An open handle to a CAN channel.</param>
  1086. <param name="count">The number of files on the device.</param>
  1087. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1088. </member>
  1089. <member name="M:Kvaser.CanLib.Canlib.kvFileGetName(System.Int32,System.Int32,System.String@)">
  1090. <summary>
  1091. Returns the name of the file with number fileNo.
  1092. </summary>
  1093. <param name="hnd">An open handle to a CAN channel.</param>
  1094. <param name="fileNo">The number of the file.</param>
  1095. <param name="name">Name of the file as a string</param>
  1096. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1097. </member>
  1098. <member name="M:Kvaser.CanLib.Canlib.kvFileGetSystemData(System.Int32,System.Int32,System.Int32@)">
  1099. <summary>
  1100. Read disk parameters
  1101. <para>&#160;</para>
  1102. Note: Not yet implemented
  1103. </summary>
  1104. <param name="hnd">An open handle to a CAN channel.</param>
  1105. <param name="itemCode">The item we want information on.</param>
  1106. <param name="result">A pointer to a 32-bit integer that will receive the result.</param>
  1107. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1108. </member>
  1109. <member name="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)">
  1110. <summary>
  1111. Turn the LEDs on the device on or off.
  1112. </summary>
  1113. <param name="hnd">An open handle to a CAN channel.</param>
  1114. <param name="action"> One of the kvLED_ACTION_xxx constants, defining which LED to turn on or off. </param>
  1115. <param name="timeout"> Specifies the time, in milliseconds, during which the action is to be carried out. When the timeout expires the LED(s) will return to its ordinary function.</param>
  1116. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1117. </member>
  1118. <member name="M:Kvaser.CanLib.Canlib.kvGetApplicationMapping(System.Int32,System.String,System.Int32,System.Int32@)">
  1119. <summary>
  1120. Note: The kvGetApplicationMapping function is presently not implemented.
  1121. </summary>
  1122. <param name="busType"></param>
  1123. <param name="appName"></param>
  1124. <param name="appChannel"></param>
  1125. <param name="resultingChannel"></param>
  1126. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1127. </member>
  1128. <member name="M:Kvaser.CanLib.Canlib.kvGetSupportedInterfaceInfo(System.Int32,System.String@,System.Int32@,System.Int32@)">
  1129. <summary>
  1130. The <see cref="M:Kvaser.CanLib.Canlib.kvGetSupportedInterfaceInfo(System.Int32,System.String@,System.Int32@,System.Int32@)"/> function returns information about the different supported hardware types in the installed version of CANlib.
  1131. This function is used to enumerate all the supported hardware types in the installed version of CANlib. It does not return a complete list of all supported devices, nor does it return a list of the presently installed hardware. The returned data indicates which device families are supported.
  1132. <para>&#160;</para>
  1133. For example, a returned set of data might be:<para>&#160;</para>
  1134. •hwType = <see cref="F:Kvaser.CanLib.Canlib.canHWTYPE_MEMORATOR_PRO"/><para>&#160;</para>
  1135. •hwBusType = <see cref="F:Kvaser.CanLib.Canlib.kvBUSTYPE_USB"/><para>&#160;</para>
  1136. •hwName = "Kvaser Memorator Professional"<para>&#160;</para>
  1137. This means that<para>&#160;</para>
  1138. •the presently installed version of CANlib supports members in the Kvaser Memorator Pro family(e.g.the HS/HS and the HS/LS),<para>&#160;</para>
  1139. •the members of the Kvaser Memorator Pro family are USB devices,<para>&#160;</para>
  1140. •the members of the Kvaser Memorator Pro family use the <see cref="F:Kvaser.CanLib.Canlib.canHWTYPE_MEMORATOR_PRO"/> hardware type.
  1141. The kvGetSupportedInterfaceInfo() function is intended to help application designers build a bus-oriented display of the different installed and/or supported Kvaser devices in the computer.
  1142. <para>&#160;</para>
  1143. Note: Not inplemented in linux.
  1144. </summary>
  1145. <param name="index">Use this parameter to enumerate the different supported hardware types. Start with index = 0, and then call
  1146. <see cref="M:Kvaser.CanLib.Canlib.kvGetSupportedInterfaceInfo(System.Int32,System.String@,System.Int32@,System.Int32@)"/> again() with index = 1,2,3,... until the function returns an error code.</param>
  1147. <param name="hwName">Name of the hardware family.</param>
  1148. <param name="hwType">Hardware type as a canHWTYPE_xxx.</param>
  1149. <param name="hwBusType">Bus type as a kvBUSTYPE_xxx.</param>
  1150. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1151. </member>
  1152. <member name="M:Kvaser.CanLib.Canlib.kvIoConfirmConfig(System.Int32)">
  1153. <summary>
  1154. This function is used to confirm configuration. It is required to call this function, before it is
  1155. possible to use any kvIoPinSetXxx()/kvIoPinGetXxx() function. After a configuration change, module removal
  1156. or insertion, it is required to confirm the new configuration.
  1157. /// <para>&#160;</para>
  1158. Note:
  1159. Preliminary API that may change. Not implemented in Linux.
  1160. </summary>
  1161. <param name="handle">An open handle to a CAN channel.</param>
  1162. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1163. </member>
  1164. <member name="M:Kvaser.CanLib.Canlib.kvIoPinGetAnalog(System.Int32,System.Int32,System.Single@)">
  1165. <summary>
  1166. This function is used to retrieve the voltage level of the specified analog I/O pin.
  1167. <para>&#160;</para>
  1168. Note:
  1169. Preliminary API that may change. Not implemented in Linux.
  1170. </summary>
  1171. <param name="handle">An open handle to a CAN channel.</param>
  1172. <param name="pin">The pin number, <see cref="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)"/>.</param>
  1173. <param name="value">A reference to a float which receives the voltage of the pin.</param>
  1174. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1175. </member>
  1176. <member name="M:Kvaser.CanLib.Canlib.kvIoPinGetDigital(System.Int32,System.Int32,System.Int32@)">
  1177. <summary>
  1178. This function is used to retrieve the value of the specified digital input I/O pin.
  1179. If the pin is LOW, the integer pointed to by value is assigned zero. If the pin is HIGH,
  1180. the integer pointed to by value is assigned a '1'.
  1181. <para>&#160;</para>
  1182. Note:
  1183. Preliminary API that may change. Not implemented in Linux.
  1184. </summary>
  1185. <param name="handle">An open handle to a CAN channel.</param>
  1186. <param name="pin">The pin number, <see cref="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)"/>.</param>
  1187. <param name="value">A reference to an unsigned int which receives the value of the pin.</param>
  1188. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1189. </member>
  1190. <member name="M:Kvaser.CanLib.Canlib.kvIoPinGetInfo(System.Int32,System.Int32,Kvaser.CanLib.Canlib.kvIOGetInfo,System.Object@)">
  1191. <summary>
  1192. This function is used to retrieve I/O pin properties.
  1193. <para>&#160;</para>
  1194. Note:
  1195. Preliminary API that may change. Not implemented in Linux.
  1196. </summary>
  1197. <param name="handle">An open handle to a CAN channel.</param>
  1198. <param name="pin">The pin number, <see cref="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)"/></param>
  1199. <param name="item">Type of item to retrieve, <see cref="T:Kvaser.CanLib.Canlib.kvIOGetInfo"/> .</param>
  1200. <param name="data">Object to store the data in.</param>
  1201. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1202. </member>
  1203. <member name="M:Kvaser.CanLib.Canlib.kvIoPinGetOutputAnalog(System.Int32,System.Int32,System.Single@)">
  1204. <summary>
  1205. This function is used to get the latest set voltage level of an analog I/O pin. This function only returns
  1206. values as they are presented in memory and the actual value on the output pin may therefore differ.
  1207. <para>&#160;</para>
  1208. Note:
  1209. Preliminary API that may change. Not implemented in Linux.
  1210. </summary>
  1211. <param name="handle">An open handle to a CAN channel.</param>
  1212. <param name="pin">The pin number, <see cref="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)"/>.</param>
  1213. <param name="value">A reference to a float which receives the latest set voltage level of the pin.</param>
  1214. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1215. </member>
  1216. <member name="M:Kvaser.CanLib.Canlib.kvIoPinGetOutputDigital(System.Int32,System.Int32,System.Int32@)">
  1217. <summary>
  1218. This function is used to get the latest set value of a digital output I/O pin. If the latest value
  1219. written to the pin is LOW, the integer pointed to by value is assigned zero. If it is HIGH, the
  1220. integer pointed to by value is assigned a '1'. This function only returns values as they are presented
  1221. in memory and the actual value on the output pin may therefore differ.
  1222. <para>&#160;</para>
  1223. Note:
  1224. Preliminary API that may change. Not implemented in Linux.
  1225. </summary>
  1226. <param name="handle">An open handle to a CAN channel.</param>
  1227. <param name="pin">The pin number, <see cref="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)"/>.</param>
  1228. <param name="value">A reference to an unsigned int which receives the value of the pin.</param>
  1229. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1230. </member>
  1231. <member name="M:Kvaser.CanLib.Canlib.kvIoPinGetOutputRelay(System.Int32,System.Int32,System.Int32@)">
  1232. <summary>
  1233. This function is used to get the latest set value of a relay I/O pin. If value is zero, the relay has
  1234. been set to OFF. For any non-zero value, the relay has been set to ON. This function returns values
  1235. as they are presented in memory and the actual state on the relay pin may differ.
  1236. <para>&#160;</para>
  1237. Note:
  1238. Preliminary API that may change. Not implemented in Linux.
  1239. </summary>
  1240. <param name="handle">An open handle to a CAN channel.</param>
  1241. <param name="pin">The pin number, <see cref="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)"/>.</param>
  1242. <param name="value">A reference to an unsigned int which receives the value of the pin.</param>
  1243. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1244. </member>
  1245. <member name="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)">
  1246. <summary>
  1247. Get the number of I/O pins available from a device.
  1248. <para>&#160;</para>
  1249. Note:
  1250. Preliminary API that may change. Not implemented in Linux.
  1251. </summary>
  1252. <param name="handle">An open handle to a CAN channel.</param>
  1253. <param name="pinCount">A reference to an int which receives the number of pins.</param>
  1254. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1255. </member>
  1256. <member name="M:Kvaser.CanLib.Canlib.kvIoPinSetAnalog(System.Int32,System.Int32,System.Single)">
  1257. <summary>
  1258. This function is used to set the voltage level of the specified analog I/O pin.
  1259. <para>&#160;</para>
  1260. Note:
  1261. Preliminary API that may change. Not implemented in Linux.
  1262. </summary>
  1263. <param name="handle">An open handle to a CAN channel.</param>
  1264. <param name="pin">The pin number, <see cref="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)"/> .</param>
  1265. <param name="value">A float which sets a voltage of the pin.</param>
  1266. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1267. </member>
  1268. <member name="M:Kvaser.CanLib.Canlib.kvIoPinSetDigital(System.Int32,System.Int32,System.Int32)">
  1269. <summary>
  1270. This function is used to set a digital output I/O pin. If value is zero, the pin is set LOW.
  1271. For any non-zero value, the pin is set HIGH.
  1272. <para>&#160;</para>
  1273. Note:
  1274. Preliminary API that may change. Not implemented in Linux.
  1275. </summary>
  1276. <param name="handle">An open handle to a CAN channel.</param>
  1277. <param name="pin">The pin number, <see cref="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)"/>. </param>
  1278. <param name="value">An int32 which sets a value of the pin.</param>
  1279. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1280. </member>
  1281. <member name="M:Kvaser.CanLib.Canlib.kvIoPinSetInfo(System.Int32,System.Int32,Kvaser.CanLib.Canlib.kvIOSetInfo,System.Object)">
  1282. <summary>
  1283. This function is used to set I/O pin properties, for items that can be changed.
  1284. <para>&#160;</para>
  1285. Note:
  1286. Preliminary API that may change. Not implemented in Linux.
  1287. </summary>
  1288. <param name="handle">An open handle to a CAN channel.</param>
  1289. <param name="pin">The pin number, <see cref="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)"/>.</param>
  1290. <param name="item">Type of item to set, <see cref="T:Kvaser.CanLib.Canlib.kvIOSetInfo"/>.</param>
  1291. <param name="data">The data to set.</param>
  1292. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1293. </member>
  1294. <member name="M:Kvaser.CanLib.Canlib.kvIoPinSetRelay(System.Int32,System.Int32,System.Int32)">
  1295. <summary>
  1296. This function is used to control a relay of the specified I/O pin. If value is zero, the relay is set to OFF.
  1297. For any non-zero value, the relay is set to ON.
  1298. <para>&#160;</para>
  1299. Note:
  1300. Preliminary API that may change. Not implemented in Linux.
  1301. </summary>
  1302. <param name="handle">An open handle to a CAN channel.</param>
  1303. <param name="pin">The pin number, <see cref="M:Kvaser.CanLib.Canlib.kvIoGetNumberOfPins(System.Int32,System.Int32@)"/> .</param>
  1304. <param name="value">An int which sets a value of the pin.</param>
  1305. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1306. </member>
  1307. <member name="M:Kvaser.CanLib.Canlib.kvPingGetLatest(System.Int32,System.Int32@,System.Int32@)">
  1308. <summary>This retrieves the latest ping time issued by an earlier call to <see cref="M:Kvaser.CanLib.Canlib.kvPingRequest(System.Int32,System.Int32@)"/>. </summary>
  1309. <param name="hnd">A handle to an open circuit.</param>
  1310. <param name="requestTime">Time of request in microseconds. Used for matching answer to request.</param>
  1311. <param name="pingTime">Latest value of ping time in milliseconds.</param>
  1312. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1313. </member>
  1314. <member name="M:Kvaser.CanLib.Canlib.kvPingRequest(System.Int32,System.Int32@)">
  1315. <summary>This function sends an active ping to a device. The ping time can later be retrieved using <see cref="M:Kvaser.CanLib.Canlib.kvPingGetLatest(System.Int32,System.Int32@,System.Int32@)"/>. </summary>
  1316. <param name="hnd">A handle to an open circuit.</param>
  1317. <param name="requestTime">Time of request in microseconds. Used for matching answer to request.</param>
  1318. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1319. </member>
  1320. <member name="M:Kvaser.CanLib.Canlib.kvIoSetModulePins(System.Int32,System.Int32,System.Object)">
  1321. <summary>
  1322. This function is used to set all output and relay pins of a module in a single call.
  1323. See also <see cref="M:Kvaser.CanLib.Canlib.kvIoGetModulePins(System.Int32,System.Int32,System.Object)"/>
  1324. <para>&#160;</para>
  1325. Note:
  1326. Preliminary API that may change.
  1327. Not implemented in linux.
  1328. Values for pins of type input are ignored.
  1329. </summary>
  1330. <param name="hnd">An open handle to a CAN channel.</param>
  1331. <param name="module">The module number, see <see cref="F:Kvaser.CanLib.Canlib.kvIOGetInfo.MODULE_NUMBER"/>.</param>
  1332. <param name="buffer">
  1333. An object that contains the module type and pin values to set. The object must correspond to the module type, and can be any one of the following.
  1334. <list type="bullet">
  1335. <item><see cref="T:Kvaser.CanLib.Canlib.kvIoModuleDigital"/></item>
  1336. <item><see cref="T:Kvaser.CanLib.Canlib.kvIoModuleAnalog"/></item>
  1337. <item><see cref="T:Kvaser.CanLib.Canlib.kvIoModuleRelay"/></item>
  1338. <item><see cref="T:Kvaser.CanLib.Canlib.kvIoModuleInternal"/></item>
  1339. </list>
  1340. </param>
  1341. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1342. </member>
  1343. <member name="M:Kvaser.CanLib.Canlib.kvIoGetModulePins(System.Int32,System.Int32,System.Object)">
  1344. <summary>
  1345. This function is used to read all the pins of one module in a single call.
  1346. See also <see cref="M:Kvaser.CanLib.Canlib.kvIoSetModulePins(System.Int32,System.Int32,System.Object)"/>
  1347. <para>&#160;</para>
  1348. Note:
  1349. Preliminary API that may change.
  1350. Not implemented in linux.
  1351. </summary>
  1352. <param name="hnd">An open handle to a CAN channel.</param>
  1353. <param name="module">The module number, see <see cref="F:Kvaser.CanLib.Canlib.kvIOGetInfo.MODULE_NUMBER"/>.</param>
  1354. <param name="buffer">An object that receives the type and pin values of the module. The object must correspond to the module type, and can be any of the following.
  1355. <list type="bullet">
  1356. <item><see cref="T:Kvaser.CanLib.Canlib.kvIoModuleDigital"/></item>
  1357. <item><see cref="T:Kvaser.CanLib.Canlib.kvIoModuleAnalog"/></item>
  1358. <item><see cref="T:Kvaser.CanLib.Canlib.kvIoModuleRelay"/></item>
  1359. <item><see cref="T:Kvaser.CanLib.Canlib.kvIoModuleInternal"/></item>
  1360. </list>
  1361. </param>
  1362. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1363. </member>
  1364. <member name="M:Kvaser.CanLib.Canlib.kvReadDeviceCustomerData(System.Int32,System.Int32,System.Int32,System.Byte[],System.Int32)">
  1365. <summary> Reading customer data works with Kvaser Leaf (of all types), Kvaser USBcan Professional, Kvaser Memorator Professional,
  1366. Kvaser Eagle and Kvaser Memorator Light.To write customer data use external tools.</summary>
  1367. <param name="hnd">An open handle to a CAN channel</param>
  1368. <param name="userNumber">Assigned by Kvaser.</param>
  1369. <param name="itemNumber">Must be zero (reserved)</param>
  1370. <param name="data">A pointer to a buffer of up to 8 bytes where the result will be placed.</param>
  1371. <param name="bufsize">The size of the buffer that data points at.</param>
  1372. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1373. </member>
  1374. <member name="M:Kvaser.CanLib.Canlib.kvReadTimer(System.Int32,System.Int32@)">
  1375. <summary>
  1376. The kvReadTimer reads the hardware clock on the specified device and returns the value.
  1377. When the call to <see cref="M:Kvaser.CanLib.Canlib.kvReadTimer(System.Int32,System.Int32@)"/> returns, the time value is already obsolete.The time required for the device firmware,
  1378. any intermediary buses (like USB,) and the operating system to return the time value is not defined.
  1379. </summary>
  1380. <param name="hnd">An open handle to a CAN channel</param>
  1381. <param name="time">Returned timer value</param>
  1382. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1383. </member>
  1384. <member name="M:Kvaser.CanLib.Canlib.kvReadTimer64(System.Int32,System.Int64@)">
  1385. <summary>
  1386. The kvReadTimer64 reads the hardware clock on the specified device and returns the value.
  1387. When the call to <see cref="M:Kvaser.CanLib.Canlib.kvReadTimer64(System.Int32,System.Int64@)"/> returns, the time value is already obsolete.The time required for the device firmware,
  1388. any intermediary buses (like USB,) and the operating system to return the time value is not defined.
  1389. </summary>
  1390. <param name="handle">An open handle to a CAN channel</param>
  1391. <param name="time">Returned timer value</param>
  1392. <returns><see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> if success else canStatus.canERR_XXX.</returns>
  1393. </member>
  1394. <member name="M:Kvaser.CanLib.Canlib.kvScriptLoadFile(System.Int32,System.Int32,System.String)">
  1395. <summary>
  1396. Loads a compiled script file (.txe) stored on the host(PC) into a script slot on the device.
  1397. <para>&#160;</para>
  1398. The canHandle is used to determine what channel is set as the default channel for the loaded script.
  1399. If your canHandle was opened via a device's second channel, the default channel number will be set to 1 (the numbering of channel on the card starts from 0).
  1400. </summary>
  1401. <param name="hnd">An open handle to a CAN channel.</param>
  1402. <param name="slotNo">The slot where to load the script.</param>
  1403. <param name="filePathOnPC">Path to the script file on PC.</param>
  1404. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1405. </member>
  1406. <member name="M:Kvaser.CanLib.Canlib.kvScriptLoadFileOnDevice(System.Int32,System.Int32,System.String)">
  1407. <summary>
  1408. Loads a compiled script file (.txe) stored on the device (SD card) into a script slot on the device.
  1409. <para>&#160;</para>
  1410. Note. Not implemented in linux.
  1411. </summary>
  1412. <param name="hnd">An open handle to a CAN channel.</param>
  1413. <param name="slotNo">The slot where to load the script.</param>
  1414. <param name="localFile">Path to the script file on PC.</param>
  1415. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1416. </member>
  1417. <member name="M:Kvaser.CanLib.Canlib.kvScriptSendEvent(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  1418. <summary>
  1419. Send an event of a type, and an event number and associated data to a script running in a specific slot.
  1420. <para>&#160;</para>
  1421. Note. Not implemented in linux.
  1422. </summary>
  1423. <param name="hnd">An open handle to a CAN channel.</param>
  1424. <param name="slotNo">The slot where to load the script.</param>
  1425. <param name="eventType">The event to send, of type kvEVENT_xxx.</param>
  1426. <param name="eventNo">The event's number.</param>
  1427. <param name="data">The event's data.</param>
  1428. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1429. </member>
  1430. <member name="M:Kvaser.CanLib.Canlib.kvScriptStart(System.Int32,System.Int32)">
  1431. <summary>
  1432. This routine starts a loaded script.
  1433. </summary>
  1434. <param name="hnd">An open handle to a CAN channel.</param>
  1435. <param name="slotNo">The slot with the loaded script we want to start.</param>
  1436. <returns>KvStatus.OK if success else canStatus.canERR_XXX.</returns>
  1437. </member>
  1438. <member name="M:Kvaser.CanLib.Canlib.kvScriptStatus(System.Int32,System.Int32,System.Int32@)">
  1439. <summary>
  1440. Read the current status of a script slot.
  1441. <para>&#160;</para>
  1442. Note. Not implemented in linux.
  1443. </summary>
  1444. <param name="hnd">An open handle to a CAN channel.</param>
  1445. <param name="slotNo">The slot where to load the script.</param>
  1446. <param name="status">The script status, as kvSCRIPT_STATUS_xxx flag bits.</param>
  1447. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1448. </member>
  1449. <member name="M:Kvaser.CanLib.Canlib.kvScriptStop(System.Int32,System.Int32,System.Int32)">
  1450. <summary>
  1451. This routine stops a started script.
  1452. </summary>
  1453. <param name="hnd">An open handle to a CAN channel.</param>
  1454. <param name="slotNo">The slot with the loaded script we want to start.</param>
  1455. <param name="mode">Stop mode of type kvSCRIPT_STOP_xx.</param>
  1456. <returns>KvStatus.OK if success else canStatus.canERR_XXX.</returns>
  1457. </member>
  1458. <member name="M:Kvaser.CanLib.Canlib.kvScriptTxeGetData(System.String,System.Int32,System.Object@)">
  1459. <summary>
  1460. This function can be used to retrieve information from a compiled script file (.txe).
  1461. </summary>
  1462. <param name="filePathOnPC">Path to the script file on PC.</param>
  1463. <param name="item">Item to obtain. Valid values are one of the constants canTXEDATA_xxx..</param>
  1464. <param name="buffer">Return value as object.</param>
  1465. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1466. </member>
  1467. <member name="M:Kvaser.CanLib.Canlib.kvScriptUnload(System.Int32,System.Int32)">
  1468. <summary>
  1469. Unloads a stopped script.
  1470. </summary>
  1471. <param name="hnd">An open handle to a CAN channel.</param>
  1472. <param name="slotNo">The slot where to load the script.</param>
  1473. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1474. </member>
  1475. <member name="M:Kvaser.CanLib.Canlib.kvScriptEnvvarClose(System.Int64)">
  1476. <summary>
  1477. Close an open envvar.
  1478. <para>&#160;</para>
  1479. Note. Not implemented in linux.
  1480. </summary>
  1481. <param name="eHnd">An open handle to an envvar.</param>
  1482. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1483. </member>
  1484. <member name="M:Kvaser.CanLib.Canlib.kvScriptEnvvarOpen(System.Int32,System.String,System.Int32@,System.Int32@)">
  1485. <summary>
  1486. Opens an existing envvar and returns a handle to it.
  1487. <para>&#160;</para>
  1488. Note. Not implemented in linux.
  1489. </summary>
  1490. <param name="hnd">An open handle to a CAN channel.</param>
  1491. <param name="envvarName">The envvar's name; a pointer to a \c NULL terminated array of chars.</param>
  1492. <param name="envvarType">A pointer to a 32-bit integer that will receive the kvENVVAR_TYPE_xxx type.</param>
  1493. <param name="envvarSize">A pointer to a 32-bit integer that will receive the size of the envvar in bytes.</param>
  1494. <returns>A KvHandle handle (positive) to an envvar if success, canERR_xxx (negative) if failure</returns>
  1495. </member>
  1496. <member name="M:Kvaser.CanLib.Canlib.kvScriptEnvvarGetData(System.Int64,System.Byte[]@,System.Int32,System.Int32)">
  1497. <summary>
  1498. Get a range of data bytes from an envvar.
  1499. <para>&#160;</para>
  1500. Note. Not implemented in linux.
  1501. </summary>
  1502. <param name="eHnd">An open handle to an envvar.</param>
  1503. <param name="buf">A pointer to a data area where the retrieved data range should be stored.</param>
  1504. <param name="start_index">The start index of the data range.</param>
  1505. <param name="data_len">The length in bytes of the data range.</param>
  1506. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1507. </member>
  1508. <member name="M:Kvaser.CanLib.Canlib.kvScriptEnvvarGetFloat(System.Int64,System.Single@)">
  1509. <summary>
  1510. Get the value of a float envvar.
  1511. <para>&#160;</para>
  1512. Note. Not implemented in linux.
  1513. </summary>
  1514. <param name="eHnd">An open handle to an envvar.</param>
  1515. <param name="val">The current value.</param>
  1516. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1517. </member>
  1518. <member name="M:Kvaser.CanLib.Canlib.kvScriptEnvvarGetInt(System.Int64,System.Int32@)">
  1519. <summary>
  1520. Get the value of an int envvar.
  1521. <para>&#160;</para>
  1522. Note. Not implemented in linux.
  1523. </summary>
  1524. <param name="eHnd">An open handle to an envvar.</param>
  1525. <param name="val">The current value.</param>
  1526. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1527. </member>
  1528. <member name="M:Kvaser.CanLib.Canlib.kvScriptGetText(System.Int32,System.Int32@,System.Int64@,System.Int32@,System.String@)">
  1529. <summary>
  1530. Reads a printf from a subscribed script slot. Set up a subscription with <see cref="M:Kvaser.CanLib.Canlib.kvScriptRequestText(System.Int32,System.Int32,System.Int32)"/>.
  1531. </summary>
  1532. <param name="hnd">An open handle to a CAN channel.</param>
  1533. <param name="slot">The slot where the printf originated.</param>
  1534. <param name="time">The printf timestamp.</param>
  1535. <param name="flags">Printf flags. A combination of canSTAT_xxx flags.</param>
  1536. <param name="buf">The printf string.</param>
  1537. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1538. </member>
  1539. <member name="M:Kvaser.CanLib.Canlib.kvScriptEnvvarSetData(System.Int64,System.Byte[],System.Int32,System.Int32)">
  1540. <summary>
  1541. Set a range of data bytes in an envvar.
  1542. <para>&#160;</para>
  1543. Note. Not implemented in linux.
  1544. </summary>
  1545. <param name="eHnd">An open handle to an envvar.</param>
  1546. <param name="buf">A pointer to a data area where the retrieved data range should be stored.</param>
  1547. <param name="start_index">The start index of the data range.</param>
  1548. <param name="data_len">The length in bytes of the data range.</param>
  1549. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1550. </member>
  1551. <member name="M:Kvaser.CanLib.Canlib.kvScriptEnvvarSetFloat(System.Int64,System.Single)">
  1552. <summary>
  1553. Sets the value of a float envvar.
  1554. <para>&#160;</para>
  1555. Note. Not implemented in linux.
  1556. </summary>
  1557. <param name="eHnd">An open handle to an envvar.</param>
  1558. <param name="val">The new value.</param>
  1559. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1560. </member>
  1561. <member name="M:Kvaser.CanLib.Canlib.kvScriptEnvvarSetInt(System.Int64,System.Int32)">
  1562. <summary>
  1563. Sets the value of an int envvar.
  1564. <para>&#160;</para>
  1565. Note. Not implemented in linux.
  1566. </summary>
  1567. <param name="eHnd">An open handle to an envvar.</param>
  1568. <param name="val">The new value.</param>
  1569. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1570. </member>
  1571. <member name="M:Kvaser.CanLib.Canlib.kvScriptRequestText(System.Int32,System.Int32,System.Int32)">
  1572. <summary>
  1573. Sets up a printf subscription to a selected script slot. Read the printf messages with <see cref="M:Kvaser.CanLib.Canlib.kvScriptGetText(System.Int32,System.Int32@,System.Int64@,System.Int32@,System.String@)"/>.
  1574. </summary>
  1575. <param name="hnd">An open handle to a CAN channel.</param>
  1576. <param name="slot">The slot to subscribe to.</param>
  1577. <param name="request">Subscription request i.e. kvSCRIPT_REQUEST_TEXT_xxx.</param>
  1578. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1579. </member>
  1580. <member name="M:Kvaser.CanLib.Canlib.kvScriptGetMaxEnvvarSize(System.Int32,System.Int32@)">
  1581. <summary>
  1582. Get the maximum size of an envvar.
  1583. <para>&#160;</para>
  1584. </summary>
  1585. <param name="hnd">An open handle to a CAN channel.</param>
  1586. <param name="size">The maximum size of an envvar.</param>
  1587. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1588. </member>
  1589. <member name="M:Kvaser.CanLib.Canlib.kvSelfTest(System.Int32,System.Int32@)">
  1590. <summary>
  1591. Runs a built-in self test in the device. Note that not all devices supports built-in self tests.
  1592. </summary>
  1593. <param name="hnd">An open handle to a CAN channel.</param>
  1594. <param name="presults">Self test result</param>
  1595. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1596. </member>
  1597. <member name="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)">
  1598. <summary>
  1599. The function registers a callback function which is called when certain events occur.
  1600. You can register at most one callback function per handle at any time.
  1601. To remove the callback, call <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/> with a NULL pointer in the callback argument.
  1602. <para>&#160;</para>
  1603. Note. The callback function is called in the context of a high-priority thread created by CANlib.
  1604. You should take precaution not to do any time consuming tasks in the callback. You must also arrange the synchronization between the callback and your other threads yourself.
  1605. </summary>
  1606. <param name="handle">An open handle to a CAN channel.</param>
  1607. <param name="callback">A pointer to a callback function of type <see cref="T:Kvaser.CanLib.Canlib.kvCallbackDelegate"/></param>
  1608. <param name="context">A pointer to arbitrary user-defined context data which is passed to the callback function. </param>
  1609. <param name="notifyFlags">One or more of the canNOTIFY_xxx flags.</param>
  1610. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1611. </member>
  1612. <member name="M:Kvaser.CanLib.Canlib.kvTimeDomainAddHandle(System.Object,System.Int32)">
  1613. <summary>
  1614. This routine adds an open channel handle to a domain.
  1615. <para>&#160;</para>
  1616. Note. A time domain is a set of channels with a common time base.
  1617. </summary>
  1618. <param name="domain">A TimeDomain returned from <see cref="M:Kvaser.CanLib.Canlib.kvTimeDomainCreate(System.Object@)"/></param>
  1619. <param name="handle">A Handle to an open channel</param>
  1620. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1621. </member>
  1622. <member name="M:Kvaser.CanLib.Canlib.kvTimeDomainCreate(System.Object@)">
  1623. <summary>
  1624. This routine creates an empty time domain.
  1625. The variable is set by this function and then used in later calls to other functions using a <see cref="T:System.IntPtr"/>.
  1626. Time domains created by <see cref="M:Kvaser.CanLib.Canlib.kvTimeDomainCreate(System.Object@)"/> can be destroyed with a call to <see cref="M:Kvaser.CanLib.Canlib.kvTimeDomainDelete(System.Object)"/>.
  1627. <para>&#160;</para>
  1628. Note. A time domain is a set of channels with a common time base.
  1629. </summary>
  1630. <param name="domain">An empty TimeDomain object</param>
  1631. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1632. </member>
  1633. <member name="M:Kvaser.CanLib.Canlib.kvTimeDomainDelete(System.Object)">
  1634. <summary>
  1635. This is a cleanup routine that deletes all members of a domain and then deletes the domain itself.
  1636. <para>&#160;</para>
  1637. Note. A time domain is a set of channels with a common time base.
  1638. </summary>
  1639. <param name="domain">A TimeDomain returned from <see cref="M:Kvaser.CanLib.Canlib.kvTimeDomainCreate(System.Object@)"/></param>
  1640. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1641. </member>
  1642. <member name="M:Kvaser.CanLib.Canlib.kvTimeDomainGetData(System.Object,Kvaser.CanLib.Canlib.kvTimeDomainData@)">
  1643. <summary>
  1644. This routine collects some data on a time domain.
  1645. </summary>
  1646. <remarks>A time domain is a set of channels with a common time base.</remarks>
  1647. <param name="domain">A TimeDomain returned from <see cref="M:Kvaser.CanLib.Canlib.kvTimeDomainCreate(System.Object@)"/></param>
  1648. <param name="data"> A <see cref="T:Kvaser.CanLib.Canlib.kvTimeDomainData"/> structure that is filled by the function</param>
  1649. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1650. </member>
  1651. <member name="M:Kvaser.CanLib.Canlib.kvTimeDomainRemoveHandle(System.Object,System.Int32)">
  1652. <summary>
  1653. This routine removes an open channel handle from a domain.
  1654. <para>&#160;</para>
  1655. Note. A time domain is a set of channels with a common time base.
  1656. </summary>
  1657. <param name="domain">A TimeDomain returned from <see cref="M:Kvaser.CanLib.Canlib.kvTimeDomainCreate(System.Object@)"/></param>
  1658. <param name="handle">A Handle to an open channel</param>
  1659. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1660. </member>
  1661. <member name="M:Kvaser.CanLib.Canlib.kvTimeDomainResetTime(System.Object)">
  1662. <summary>
  1663. This routine resets the time on all members of a time domain.
  1664. After a call to this routine timestamps from all channels with MagiSync™ running have no offset at all any longer.
  1665. The same applies for channels that reside on the same physical interface.
  1666. <para>&#160;</para>
  1667. Note. A time domain is a set of channels with a common time base.
  1668. </summary>
  1669. <param name="domain">A TimeDomain returned from <see cref="M:Kvaser.CanLib.Canlib.kvTimeDomainCreate(System.Object@)"/></param>
  1670. <returns>KvStatus.OK if success else KvStatus.ERR_XXX.</returns>
  1671. </member>
  1672. <member name="T:Kvaser.CanLib.Canlib.kvCallbackDelegate">
  1673. <summary>
  1674. Callback for Notifications, used in <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/>
  1675. The callback function is called with the following arguments:<para>&#160;</para>
  1676. •handle - the handle of the CAN channel where the event happened.<para>&#160;</para>
  1677. •context - the context pointer you passed to <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/>.<para>&#160;</para>
  1678. •notifyEvent - one of the canNOTIFY_xxx notification codes.<para>&#160;</para>
  1679. </summary>
  1680. </member>
  1681. <member name="T:Kvaser.CanLib.Canlib.canStatus">
  1682. <summary>
  1683. Generally, a return code greater than or equal to zero means success. A value less than zero means failure.
  1684. </summary>
  1685. </member>
  1686. <member name="F:Kvaser.CanLib.Canlib.canStatus.canOK">
  1687. <summary>Normal successful completion; The driver is just fine, and really believes it carried out your command to everyone's satisfaction. </summary>
  1688. </member>
  1689. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_PARAM">
  1690. <summary>Error in one or more parameters; a parameter specified in the call was invalid, out of range, or so. This status code will also be returned when the call is not implemented. </summary>
  1691. </member>
  1692. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOMSG">
  1693. <summary>There were no messages to read; A function tried to read a message, but there was no message to read. </summary>
  1694. </member>
  1695. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOTFOUND">
  1696. <summary>Specified device or channel not found. There is no hardware available that matches the given search criteria.
  1697. For example, you may have specified canOPEN_REQUIRE_EXTENDED but there's no controller capable of extended CAN.
  1698. You may have specified a channel number that is out of the range for the hardware in question. You may have requested exclusive
  1699. access to a channel, but the channel is already occupied. </summary>
  1700. </member>
  1701. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOMEM">
  1702. <summary>Out of memory; A memory allocation failed. </summary>
  1703. </member>
  1704. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOCHANNELS">
  1705. <summary>No channels available; There is indeed hardware matching the criteria you specified, but there are no channels available,
  1706. or the channel you specified is already occupied. </summary>
  1707. </member>
  1708. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_INTERRUPTED">
  1709. <summary>Interrupted by signals.</summary>
  1710. </member>
  1711. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_TIMEOUT">
  1712. <summary>Timeout occurred; A function waited for something to happen (for example, the arrival of a message), but that something didn't happen. </summary>
  1713. </member>
  1714. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOTINITIALIZED">
  1715. <summary>The library is not initialized; The driver is not initialized. canInitializeLibrary() was probably not called? </summary>
  1716. </member>
  1717. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOHANDLES">
  1718. <summary>Out of handles; No handles are available inside canlib32. The application has too many handles open (i.e. has called canOpenChannel() too many times, or there's a memory leak somewhere.)<para>&#160;</para>
  1719. Note. We are not talking about Windows handles here, it's CANLIB's own internal handles. </summary>
  1720. </member>
  1721. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_INVHANDLE">
  1722. <summary>Handle is invalid; The CANLIB handle you specified (if the API call includes a handle) is not valid. Ensure you are passing the handle and not, for example, a channel number. </summary>
  1723. </member>
  1724. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_INIFILE">
  1725. <summary>Error in the ini-file (16-bit only) </summary>
  1726. </member>
  1727. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_DRIVER">
  1728. <summary>Driver type not supported; CAN driver mode is not supported by the present hardware. </summary>
  1729. </member>
  1730. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_TXBUFOFL">
  1731. <summary>Transmit buffer overflow; The transmit queue was full, so the message was dropped. </summary>
  1732. </member>
  1733. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_RESERVED_1">
  1734. <summary>Reserved.</summary>
  1735. </member>
  1736. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_HARDWARE">
  1737. <summary>A hardware error has occurred; Something probably related to the hardware happened. This could mean that the device does not respond (IRQ or address conflict?),
  1738. or that the response was invalid or unexpected (faulty card?). </summary>
  1739. </member>
  1740. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_DYNALOAD">
  1741. <summary>A driver DLL can't be found or loaded; (One of) the DLL(s) specified in the registry failed to load. This could be a driver installation problem. </summary>
  1742. </member>
  1743. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_DYNALIB">
  1744. <summary>A DLL seems to have wrong version; DLL version mismatch. (One of) the DLL(s) specified in the registry is - probably - too old, or - less likely - too new. </summary>
  1745. </member>
  1746. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_DYNAINIT">
  1747. <summary>Error when initializing a DLL; Something failed when a device driver was being initialized. In other words, we can open the driver but it makes a lot of fuss about something we don't understand. </summary>
  1748. </member>
  1749. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOT_SUPPORTED">
  1750. <summary>Operation not supported by hardware or firmware. </summary>
  1751. </member>
  1752. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_RESERVED_5">
  1753. <summary>Reserved.</summary>
  1754. </member>
  1755. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_RESERVED_6">
  1756. <summary>Reserved.</summary>
  1757. </member>
  1758. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_RESERVED_2">
  1759. <summary>Reserved.</summary>
  1760. </member>
  1761. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_DRIVERLOAD">
  1762. <summary>Can't find or load kernel driver; A device driver (kernel mode driver for NT, VxD for W95/98) failed to load; or the DLL could not open the device. Privileges? Driver file missing?</summary>
  1763. </member>
  1764. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_DRIVERFAILED">
  1765. <summary>DeviceIOControl failed; Use Win32 GetLastError() to learn what really happened. </summary>
  1766. </member>
  1767. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOCONFIGMGR">
  1768. <summary>Can't find req'd config s/w (e.g. CS/SS) </summary>
  1769. </member>
  1770. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOCARD">
  1771. <summary>The card was removed or not inserted. </summary>
  1772. </member>
  1773. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_RESERVED_7">
  1774. <summary>Reserved.</summary>
  1775. </member>
  1776. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_REGISTRY">
  1777. <summary>Error (missing data) in the Registry; A registry key is missing, invalid, malformed, has gone for lunch or what not. can_verify.exe might provide some insight. </summary>
  1778. </member>
  1779. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_LICENSE">
  1780. <summary>The license is not valid. </summary>
  1781. </member>
  1782. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_INTERNAL">
  1783. <summary>Internal error in the driver; Indicates an error condition in the driver or DLL, which couldn't be properly handled. Please contact the friendly support at support@kvaser.com. </summary>
  1784. </member>
  1785. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NO_ACCESS">
  1786. <summary>Access denied; This means that you tried to set the bit rate on a handle to which you haven't got init access or you tried to open a channel that already is open with init access. See canOpenChannel() for more information about init access. </summary>
  1787. </member>
  1788. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_NOT_IMPLEMENTED">
  1789. <summary>Not implemented; The requested feature or function is not implemented in the device you are trying to use it on. </summary>
  1790. </member>
  1791. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_DEVICE_FILE">
  1792. <summary>Device File error; An error has occured when trying to access a file on the device. </summary>
  1793. </member>
  1794. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_HOST_FILE">
  1795. <summary>Host File error; An error has occured when trying to access a file on the host. </summary>
  1796. </member>
  1797. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_DISK">
  1798. <summary>Disk error; A disk error has occurred. Verify that the disk is initialized. </summary>
  1799. </member>
  1800. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_CRC">
  1801. <summary>CRC error; The CRC calculation did not match the expected result. </summary>
  1802. </member>
  1803. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_CONFIG">
  1804. <summary>Configuration Error; The configuration is corrupt. </summary>
  1805. </member>
  1806. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_MEMO_FAIL">
  1807. <summary>Memo Error; Other configuration error. </summary>
  1808. </member>
  1809. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_SCRIPT_FAIL">
  1810. <summary>Script Fail; A script has failed.
  1811. Note. This code represents several different failures, for example:<para>&#160;</para>
  1812. •Trying to load a corrupt file or not a .txe file<para>&#160;</para>
  1813. •Trying to start a t script that has not been loaded<para>&#160;</para>
  1814. •Trying to load a t script compiled with the wrong version of the t compiler<para>&#160;</para>
  1815. •Trying to unload a t script that has not been stopped<para>&#160;</para>
  1816. •Trying to use an envvar that does not exist
  1817. </summary>
  1818. </member>
  1819. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_SCRIPT_WRONG_VERSION">
  1820. <summary>The t script version dosen't match the version(s) that the device firmware supports.; </summary>
  1821. </member>
  1822. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_SCRIPT_TXE_CONTAINER_VERSION">
  1823. <summary>The compiled t script container file format is of a version which is not supported by this version of canlib.; </summary>
  1824. </member>
  1825. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_SCRIPT_TXE_CONTAINER_FORMAT">
  1826. <summary>An error occured while trying to parse the compiled t script file.; </summary>
  1827. </member>
  1828. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_BUFFER_TOO_SMALL">
  1829. <summary>The buffer provided was not large enough to contain the requested data.; </summary>
  1830. </member>
  1831. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_IO_WRONG_PIN_TYPE">
  1832. <summary>
  1833. The I/O pin doesn't exist or the I/O pin type doesn't match the called function,
  1834. e.g. trying to use input pins as outputs or use digital pins as analog pins.
  1835. </summary>
  1836. </member>
  1837. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_IO_NOT_CONFIRMED">
  1838. <summary>
  1839. The I/O pin configuration is not confirmed. Use kvIoConfirmConfig()
  1840. to confirm the configuration.
  1841. </summary>
  1842. </member>
  1843. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_IO_CONFIG_CHANGED">
  1844. <summary>
  1845. The I/O pin configuration has changed after last call to kvIoConfirmConfig. Use kvIoConfirmConfig()
  1846. to confirm the new configuration.
  1847. </summary>
  1848. </member>
  1849. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_IO_PENDING">
  1850. <summary>
  1851. The previous I/O pin value has not yet changed the output and is still pending.
  1852. This happens when e.g. kvIoPinSetAnalog() is called twice on the same pin within a short time.
  1853. </summary>
  1854. </member>
  1855. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR_IO_NO_VALID_CONFIG">
  1856. <summary>There is no valid I/O pin configuration.</summary>
  1857. </member>
  1858. <member name="F:Kvaser.CanLib.Canlib.canStatus.canERR__RESERVED">
  1859. <summary>Reserved.</summary>
  1860. </member>
  1861. <member name="T:Kvaser.CanLib.Canlib.kvIOGetInfo">
  1862. <summary> These defines are used to choose item in <see cref="M:Kvaser.CanLib.Canlib.kvIoPinGetInfo(System.Int32,System.Int32,Kvaser.CanLib.Canlib.kvIOGetInfo,System.Object@)"/>. </summary>
  1863. </member>
  1864. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.MODULE_TYPE">
  1865. <summary>An unsigned 32-bit integer, <see cref="F:Kvaser.CanLib.Canlib.kvIOGetInfo.MODULE_TYPE"/>. Read-only. </summary>
  1866. </member>
  1867. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.DIRECTION">
  1868. <summary>An unsigned 32-bit integer, <see cref="F:Kvaser.CanLib.Canlib.kvIOGetInfo.DIRECTION"/>. Read-only. </summary>
  1869. </member>
  1870. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.PIN_TYPE">
  1871. <summary>An unsigned 32-bit integer, <see cref="F:Kvaser.CanLib.Canlib.kvIOGetInfo.PIN_TYPE"/>. Read-only.</summary>
  1872. </member>
  1873. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.NUMBER_OF_BITS">
  1874. <summary>An unsigned 32-bit integer that contains the resolution in number of bits. Read-only. </summary>
  1875. </member>
  1876. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.RANGE_MIN">
  1877. <summary>A float that contains the lower range limit in volts. Read-only. Note. This is not applicable for relay pins. </summary>
  1878. </member>
  1879. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.RANGE_MAX">
  1880. <summary>A float that contains the upper range limit in volts. Read-only. Note. This is not applicable for relay pins.</summary>
  1881. </member>
  1882. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.DI_LOW_HIGH_FILTER">
  1883. <summary>An unsigned 32-bit integer that contains the filter time in micro seconds when a digital input pin goes from LOW to HIGH.</summary>
  1884. </member>
  1885. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.DI_HIGH_LOW_FILTER">
  1886. <summary>An unsigned 32-bit integer that contains the filter time in micro seconds when a digital input pin goes from HIGH to LOW.</summary>
  1887. </member>
  1888. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.AI_LP_FILTER_ORDER">
  1889. <summary>An unsigned 32-bit integer that contains the low-pass filter order for an analog input pin.</summary>
  1890. </member>
  1891. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.AI_HYSTERESIS">
  1892. <summary>A float that contains the hysteresis in volt for an analog input pin, i.e. the amount the input have to change before the sampled value is updated.</summary>
  1893. </member>
  1894. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.MODULE_NUMBER">
  1895. <summary>An unsigned 32-bit integer that contains the module number the pin belongs to. The number starts from 0. Read-only. </summary>
  1896. </member>
  1897. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.SERIAL_NUMBER">
  1898. <summary>An unsigned 32-bit integer that contains the serial number of the submodule the pin belongs to. Read-only. </summary>
  1899. </member>
  1900. <member name="F:Kvaser.CanLib.Canlib.kvIOGetInfo.FW_VERSION">
  1901. <summary>An unsigned 32-bit integer that contains the software version number of the submodule the pin belongs to.
  1902. This number consists of two 16-bit words, where the most significant word represents the major and the least significant the minor software version number. Read-only.</summary>
  1903. </member>
  1904. <member name="T:Kvaser.CanLib.Canlib.kvIOModuleType">
  1905. <summary>One of these constants is returned when requesting <see cref="F:Kvaser.CanLib.Canlib.kvIOGetInfo.MODULE_TYPE"/> using <see cref="M:Kvaser.CanLib.Canlib.kvIoPinGetInfo(System.Int32,System.Int32,Kvaser.CanLib.Canlib.kvIOGetInfo,System.Object@)"/>.</summary>
  1906. </member>
  1907. <member name="F:Kvaser.CanLib.Canlib.kvIOModuleType.DIGITAL">
  1908. <summary>Kvaser Add-on module with digital inputs and digital outputs.</summary>
  1909. </member>
  1910. <member name="F:Kvaser.CanLib.Canlib.kvIOModuleType.ANALOG">
  1911. <summary>Kvaser Add-on module with analog inputs and analog outputs.</summary>
  1912. </member>
  1913. <member name="F:Kvaser.CanLib.Canlib.kvIOModuleType.RELAY">
  1914. <summary>Kvaser Add-on module with relays and digital inputs.</summary>
  1915. </member>
  1916. <member name="F:Kvaser.CanLib.Canlib.kvIOModuleType.INTERNAL">
  1917. <summary>Kvaser built-in module with one digital input and one digital output.</summary>
  1918. </member>
  1919. <member name="T:Kvaser.CanLib.Canlib.kvIOPinType">
  1920. <summary> These defines are result when requesting <see cref="F:Kvaser.CanLib.Canlib.kvIOGetInfo.PIN_TYPE"/>. </summary>
  1921. </member>
  1922. <member name="F:Kvaser.CanLib.Canlib.kvIOPinType.DIGITAL">
  1923. <summary>Digital</summary>
  1924. </member>
  1925. <member name="F:Kvaser.CanLib.Canlib.kvIOPinType.ANALOG">
  1926. <summary>Analog</summary>
  1927. </member>
  1928. <member name="F:Kvaser.CanLib.Canlib.kvIOPinType.RELAY">
  1929. <summary>Relay</summary>
  1930. </member>
  1931. <member name="T:Kvaser.CanLib.Canlib.kvIOSetInfo">
  1932. <summary> These defines are used to choose item <see cref="M:Kvaser.CanLib.Canlib.kvIoPinSetInfo(System.Int32,System.Int32,Kvaser.CanLib.Canlib.kvIOSetInfo,System.Object)"/>.</summary>
  1933. </member>
  1934. <member name="F:Kvaser.CanLib.Canlib.kvIOSetInfo.DI_LOW_HIGH_FILTER">
  1935. <summary>An unsigned 32-bit integer that contains the filter time in micro seconds when a digital input pin goes from LOW to HIGH.</summary>
  1936. </member>
  1937. <member name="F:Kvaser.CanLib.Canlib.kvIOSetInfo.DI_HIGH_LOW_FILTER">
  1938. <summary>An unsigned 32-bit integer that contains the filter time in micro seconds when a digital input pin goes from HIGH to LOW.</summary>
  1939. </member>
  1940. <member name="F:Kvaser.CanLib.Canlib.kvIOSetInfo.AI_LP_FILTER_ORDER">
  1941. <summary>An unsigned 32-bit integer that contains the low-pass filter order for an analog input pin.</summary>
  1942. </member>
  1943. <member name="F:Kvaser.CanLib.Canlib.kvIOSetInfo.AI_HYSTERESIS">
  1944. <summary>A float that contains the hysteresis in volt for an analog input pin, i.e. the amount the input have to change before the sampled value is updated.</summary>
  1945. </member>
  1946. <member name="T:Kvaser.CanLib.Canlib.kvIOPinDirection">
  1947. <summary> These defines are result when requesting <see cref="F:Kvaser.CanLib.Canlib.kvIOGetInfo.DIRECTION"/>. </summary>
  1948. </member>
  1949. <member name="F:Kvaser.CanLib.Canlib.kvIOPinDirection.DIRECTION_IN">
  1950. <summary>Input </summary>
  1951. </member>
  1952. <member name="F:Kvaser.CanLib.Canlib.kvIOPinDirection.DIRECTION_OUT">
  1953. <summary>Output </summary>
  1954. </member>
  1955. <member name="T:Kvaser.CanLib.Canlib.canBusStatistics">
  1956. <summary>This struct is returned by canGetBusStatistics(). The values are cleared when the corresponding channel goes on bus.</summary>
  1957. </member>
  1958. <member name="F:Kvaser.CanLib.Canlib.canBusStatistics.stdData">
  1959. <summary>Number of received standard (11-bit identifiers) data frames.</summary>
  1960. </member>
  1961. <member name="F:Kvaser.CanLib.Canlib.canBusStatistics.stdRemote">
  1962. <summary>Number of received standard (11-bit identifiers) remote frames.</summary>
  1963. </member>
  1964. <member name="F:Kvaser.CanLib.Canlib.canBusStatistics.extData">
  1965. <summary>Number of received extended (29-bit identifiers) data frames.</summary>
  1966. </member>
  1967. <member name="F:Kvaser.CanLib.Canlib.canBusStatistics.extRemote">
  1968. <summary>Number of received extended (29-bit identifiers) remote frames.</summary>
  1969. </member>
  1970. <member name="F:Kvaser.CanLib.Canlib.canBusStatistics.errFrame">
  1971. <summary>Number of error frames.</summary>
  1972. </member>
  1973. <member name="F:Kvaser.CanLib.Canlib.canBusStatistics.busLoad">
  1974. <summary>Bus load</summary>
  1975. </member>
  1976. <member name="F:Kvaser.CanLib.Canlib.canBusStatistics.overruns">
  1977. <summary>The number of overruns detected by the hardware, firmware or driver.</summary>
  1978. </member>
  1979. <member name="T:Kvaser.CanLib.Canlib.canUserIoPortData">
  1980. <summary>canUserIoPortData Used in <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_USER_IOPORT"/> and <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_GET_USER_IOPORT"/>.</summary>
  1981. </member>
  1982. <member name="F:Kvaser.CanLib.Canlib.canUserIoPortData.portNo">
  1983. <summary>Port number used in e.g. <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_USER_IOPORT"/> /<see cref="F:Kvaser.CanLib.Canlib.canIOCTL_GET_USER_IOPORT"/>.</summary>
  1984. </member>
  1985. <member name="F:Kvaser.CanLib.Canlib.canUserIoPortData.portValue">
  1986. <summary>Port value used in e.g. <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_USER_IOPORT"/> /<see cref="F:Kvaser.CanLib.Canlib.canIOCTL_GET_USER_IOPORT"/>.</summary>
  1987. </member>
  1988. <member name="T:Kvaser.CanLib.Canlib.kvTimeDomainData">
  1989. <summary>Used for time domain handling.</summary>
  1990. </member>
  1991. <member name="P:Kvaser.CanLib.Canlib.kvTimeDomainData.nMagiSyncGroups">
  1992. <summary>number of MagiSync groups.</summary>
  1993. </member>
  1994. <member name="P:Kvaser.CanLib.Canlib.kvTimeDomainData.nMagiSyncedMembers">
  1995. <summary>number of MagiSync members.</summary>
  1996. </member>
  1997. <member name="P:Kvaser.CanLib.Canlib.kvTimeDomainData.nNonMagiSyncCards">
  1998. <summary>number of non MagiSync interfaces.</summary>
  1999. </member>
  2000. <member name="P:Kvaser.CanLib.Canlib.kvTimeDomainData.nNonMagiSyncedMembers">
  2001. <summary>number of non MagiSync members.</summary>
  2002. </member>
  2003. <member name="T:Kvaser.CanLib.Canlib.canChannelDataVersion">
  2004. <summary>Version info
  2005. Used in <see cref="M:Kvaser.CanLib.Canlib.canIoCtl(System.Int32,System.Int32,System.Object@)"/> when requesting <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DLL_FILE_VERSION"/>,
  2006. <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DLL_PRODUCT_VERSION"/>, <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DRIVER_FILE_VERSION"/> or
  2007. <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DRIVER_PRODUCT_VERSION"/></summary>
  2008. </member>
  2009. <member name="P:Kvaser.CanLib.Canlib.canChannelDataVersion.Version1">
  2010. <summary>Version1</summary>
  2011. </member>
  2012. <member name="P:Kvaser.CanLib.Canlib.canChannelDataVersion.Version2">
  2013. <summary>Version2</summary>
  2014. </member>
  2015. <member name="P:Kvaser.CanLib.Canlib.canChannelDataVersion.Version3">
  2016. <summary>Version3</summary>
  2017. </member>
  2018. <member name="P:Kvaser.CanLib.Canlib.canChannelDataVersion.Version4">
  2019. <summary>Version4</summary>
  2020. </member>
  2021. <member name="M:Kvaser.CanLib.Canlib.canChannelDataVersion.op_Implicit(Kvaser.CanLib.Canlib.canChannelDataVersion)~System.Int32[]">
  2022. <summary>Conversion operator returning Int32[] buffer</summary>
  2023. </member>
  2024. <member name="T:Kvaser.CanLib.Canlib.canChannelDataHwStatus">
  2025. <summary>HW Status.
  2026. Used in <see cref="M:Kvaser.CanLib.Canlib.canIoCtl(System.Int32,System.Int32,System.Object@)"/> when requesting <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_LOGGER_TYPE"/></summary>
  2027. </member>
  2028. <member name="P:Kvaser.CanLib.Canlib.canChannelDataHwStatus.HwStatus1">
  2029. <summary>HW Status1</summary>
  2030. </member>
  2031. <member name="P:Kvaser.CanLib.Canlib.canChannelDataHwStatus.HwStatus2">
  2032. <summary>HW Status2</summary>
  2033. </member>
  2034. <member name="P:Kvaser.CanLib.Canlib.canChannelDataHwStatus.HwStatus3">
  2035. <summary>HW Status3</summary>
  2036. </member>
  2037. <member name="P:Kvaser.CanLib.Canlib.canChannelDataHwStatus.HwStatus4">
  2038. <summary>HW Status4</summary>
  2039. </member>
  2040. <member name="P:Kvaser.CanLib.Canlib.canChannelDataHwStatus.HwStatus5">
  2041. <summary>HW Status5</summary>
  2042. </member>
  2043. <member name="P:Kvaser.CanLib.Canlib.canChannelDataHwStatus.HwStatus6">
  2044. <summary>HW Status6</summary>
  2045. </member>
  2046. <member name="M:Kvaser.CanLib.Canlib.canChannelDataHwStatus.op_Implicit(Kvaser.CanLib.Canlib.canChannelDataHwStatus)~System.Int32[]">
  2047. <summary>Conversion operator returning Int32[] buffer</summary>
  2048. </member>
  2049. <member name="T:Kvaser.CanLib.Canlib.kvClockInfo">
  2050. <summary>Returned when using <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CLOCK_INFO"/>
  2051. Returns clock characteristics for device
  2052. The device clock frequency can then be calculated as:
  2053. double frequency = numerator/denominator * 10 ** power_of_ten;</summary>
  2054. </member>
  2055. <member name="P:Kvaser.CanLib.Canlib.kvClockInfo.version">
  2056. <summary>The version of this struct, currently 1</summary>
  2057. </member>
  2058. <member name="P:Kvaser.CanLib.Canlib.kvClockInfo.numerator">
  2059. <summary>The numerator part of the device clock frequency.</summary>
  2060. </member>
  2061. <member name="P:Kvaser.CanLib.Canlib.kvClockInfo.denominator">
  2062. <summary>The denominator part of the device clock frequency.</summary>
  2063. </member>
  2064. <member name="P:Kvaser.CanLib.Canlib.kvClockInfo.power_of_ten">
  2065. <summary>The power_of_ten part of the device clock frequency.</summary>
  2066. </member>
  2067. <member name="P:Kvaser.CanLib.Canlib.kvClockInfo.accuracy_ppm">
  2068. <summary>The accuracy (in ppm) of the device clock.</summary>
  2069. </member>
  2070. <member name="T:Kvaser.CanLib.Canlib.kvBusParamLimits">
  2071. <summary>Returned when using <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_BUS_PARAM_LIMITS"/>
  2072. This struct shows the low level limits of the parameters.
  2073. The tq field is always zero for both min/max arbitration/data, and is reserved
  2074. for possible other uses in future releases.
  2075. If prop is zero for both min and max values, that means that the unit
  2076. does not distinguish between phase segment one and the propagation
  2077. segment, i.e. the limit applies to (phase1 + prop).
  2078. </summary>
  2079. <remarks>This is only intended for internal use.</remarks>
  2080. </member>
  2081. <member name="P:Kvaser.CanLib.Canlib.kvBusParamLimits.version">
  2082. <summary>The version of this struct, currently 2</summary>
  2083. </member>
  2084. <member name="P:Kvaser.CanLib.Canlib.kvBusParamLimits.arbitration_min">
  2085. <summary>Arbitration phase minimum parameters.</summary>
  2086. </member>
  2087. <member name="P:Kvaser.CanLib.Canlib.kvBusParamLimits.arbitration_max">
  2088. <summary>Arbitration phase maximum parameters.</summary>
  2089. </member>
  2090. <member name="P:Kvaser.CanLib.Canlib.kvBusParamLimits.data_min">
  2091. <summary>Data phase minimum parameters.</summary>
  2092. </member>
  2093. <member name="P:Kvaser.CanLib.Canlib.kvBusParamLimits.data_max">
  2094. <summary>Data phase maximum parameters.</summary>
  2095. </member>
  2096. <member name="T:Kvaser.CanLib.Canlib.kvBusParamsTq">
  2097. <summary>Returned when using <see cref="M:Kvaser.CanLib.Canlib.canGetBusParamsTq(System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq@)"/>, <see cref="M:Kvaser.CanLib.Canlib.canGetBusParamsFdTq(System.Int32,Kvaser.CanLib.Canlib.kvBusParamsTq@,Kvaser.CanLib.Canlib.kvBusParamsTq@)"/>
  2098. This struct shows the low level limits of the parameters.
  2099. Note that seg1 = prop + phase1 and seg2 = phase2</summary>
  2100. </member>
  2101. <member name="P:Kvaser.CanLib.Canlib.kvBusParamsTq.tq">
  2102. <summary>Total bit time, in number of time quanta.</summary>
  2103. </member>
  2104. <member name="P:Kvaser.CanLib.Canlib.kvBusParamsTq.phase1">
  2105. <summary>Phase segment 1, in number of time quanta</summary>
  2106. </member>
  2107. <member name="P:Kvaser.CanLib.Canlib.kvBusParamsTq.phase2">
  2108. <summary>Phase segment 2, in number of time quanta</summary>
  2109. </member>
  2110. <member name="P:Kvaser.CanLib.Canlib.kvBusParamsTq.sjw">
  2111. <summary>Sync jump width, in number of time quanta</summary>
  2112. </member>
  2113. <member name="P:Kvaser.CanLib.Canlib.kvBusParamsTq.prop">
  2114. <summary>Propagation segment, in number of time quanta</summary>
  2115. </member>
  2116. <member name="P:Kvaser.CanLib.Canlib.kvBusParamsTq.prescaler">
  2117. <summary>Prescaler</summary>
  2118. </member>
  2119. <member name="M:Kvaser.CanLib.Canlib.kvBusParamsTq.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  2120. <summary>
  2121. constructor, setting all default values.
  2122. </summary>
  2123. </member>
  2124. <member name="M:Kvaser.CanLib.Canlib.kvBusParamsTq.SetValues(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  2125. <summary>
  2126. Function, setting all structure values.
  2127. </summary>
  2128. </member>
  2129. <member name="F:Kvaser.CanLib.Canlib.canBITRATE_1M">
  2130. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)"/>
  2131. Indicate a bitrate of 1 Mbit/s. </summary>
  2132. </member>
  2133. <member name="F:Kvaser.CanLib.Canlib.canBITRATE_500K">
  2134. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)"/>
  2135. Indicate a bitrate of 500 kbit/s. </summary>
  2136. </member>
  2137. <member name="F:Kvaser.CanLib.Canlib.canBITRATE_250K">
  2138. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)"/>
  2139. Indicate a bitrate of 250 kbit/s. </summary>
  2140. </member>
  2141. <member name="F:Kvaser.CanLib.Canlib.canBITRATE_125K">
  2142. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)"/>
  2143. Indicate a bitrate of 125 kbit/s. </summary>
  2144. </member>
  2145. <member name="F:Kvaser.CanLib.Canlib.canBITRATE_100K">
  2146. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)"/>
  2147. Indicate a bitrate of 100 kbit/s. </summary>
  2148. </member>
  2149. <member name="F:Kvaser.CanLib.Canlib.canBITRATE_62K">
  2150. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)"/>
  2151. Indicate a bitrate of 62 kbit/s. </summary>
  2152. </member>
  2153. <member name="F:Kvaser.CanLib.Canlib.canBITRATE_50K">
  2154. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)"/>
  2155. Indicate a bitrate of 50 kbit/s. </summary>
  2156. </member>
  2157. <member name="F:Kvaser.CanLib.Canlib.canBITRATE_83K">
  2158. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)"/>
  2159. Indicate a bitrate of 83 kbit/s. </summary>
  2160. </member>
  2161. <member name="F:Kvaser.CanLib.Canlib.canBITRATE_10K">
  2162. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsC200(System.Int32,System.Byte,System.Byte)"/>
  2163. Indicate a bitrate of 10 kbit/s. </summary>
  2164. </member>
  2165. <member name="F:Kvaser.CanLib.Canlib.canFD_BITRATE_500K_80P">
  2166. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsFd(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> when using the CAN FD protocol.
  2167. Indicates a bitrate of 0.5 Mbit/s and sampling point at 80%. </summary>
  2168. </member>
  2169. <member name="F:Kvaser.CanLib.Canlib.canFD_BITRATE_1M_80P">
  2170. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsFd(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> when using the CAN FD protocol.
  2171. Indicates a bitrate of 1.0 Mbit/s and sampling point at 80%. </summary>
  2172. </member>
  2173. <member name="F:Kvaser.CanLib.Canlib.canFD_BITRATE_2M_80P">
  2174. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsFd(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> when using the CAN FD protocol.
  2175. Indicates a bitrate of 2.0 Mbit/s and sampling point at 80%. </summary>
  2176. </member>
  2177. <member name="F:Kvaser.CanLib.Canlib.canFD_BITRATE_2M_60P">
  2178. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsFd(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> when using the CAN FD protocol.
  2179. Indicates a bitrate of 2.0 Mbit/s and sampling point at 60%. </summary>d
  2180. </member>
  2181. <member name="F:Kvaser.CanLib.Canlib.canFD_BITRATE_4M_80P">
  2182. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsFd(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> when using the CAN FD protocol.
  2183. Indicates a bitrate of 4.0 Mbit/s and sampling point at 80%.</summary>
  2184. </member>
  2185. <member name="F:Kvaser.CanLib.Canlib.canFD_BITRATE_8M_60P">
  2186. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsFd(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> when using the CAN FD protocol.
  2187. Indicates a bitrate of 8.0 Mbit/s and sampling point at 60%. </summary>
  2188. </member>
  2189. <member name="F:Kvaser.CanLib.Canlib.canFD_BITRATE_8M_80P">
  2190. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.canSetBusParams(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.canSetBusParamsFd(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"/> when using the CAN FD protocol.
  2191. Indicates a bitrate of 8.0 Mbit/s and sampling point at 80%. </summary>
  2192. </member>
  2193. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CHANNEL_CAP">
  2194. <summary>Buffer points to a 32-bit unsigned integer that receives the capabilities of the CAN controller;
  2195. this is a combination of the canCHANNEL_CAP_xxx flags.</summary>
  2196. </member>
  2197. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_TRANS_CAP">
  2198. <summary>Buffer points to a 32-bit unsigned integer that receives the capabilities of the CAN transceiver;
  2199. this is a combination of the canDRIVER_CAP_xxx flags.</summary>
  2200. </member>
  2201. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CHANNEL_FLAGS">
  2202. <summary>Buffer points to a 32-bit unsigned integer that receives a combination of canCHANNEL_IS_xxx flags.</summary>
  2203. </member>
  2204. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CARD_TYPE">
  2205. <summary>Buffer points to a 32-bit unsigned integer that receives the hardware type of the card.
  2206. This value is any one of the canHWTYPE_xxx constants</summary>
  2207. </member>
  2208. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CARD_NUMBER">
  2209. <summary>Buffer points to a 32-bit unsigned integer that receives the card's number in the computer.
  2210. Each card type is numbered separately. For example, the first LAPcan card in a machine will have
  2211. number 0, the second LAPcan number 1, etc.</summary>
  2212. </member>
  2213. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CHAN_NO_ON_CARD">
  2214. <summary>Buffer points to a 32-bit unsigned integer which receives the channel number on the card.</summary>
  2215. </member>
  2216. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CARD_SERIAL_NO">
  2217. <summary>Buffer points to a 64-bit (8 bytes) area which receives the serial number of the card.
  2218. If the card doesn't have a serial number, 0 is returned. The serial number is an 8-byte unsigned
  2219. integer. Currently, no products are using all 8 bytes; at most 4 bytes are used.</summary>
  2220. </member>
  2221. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_TRANS_SERIAL_NO">
  2222. <summary>Buffer points to a 64-bit (8 bytes) area which receives the serial number of the
  2223. transceiver. The serial number is an 8-byte unsigned integer. If the transceiver doesn't have a
  2224. serial number, 0 is returned.</summary>
  2225. </member>
  2226. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CARD_FIRMWARE_REV">
  2227. <summary>Buffer points to a 64-bit (8 bytes) area which receives the firmware revision number
  2228. on the card. This number consists of four 16-bit words: the major revision, the minor revision,
  2229. the release number and the build number, listed in order from the most significant to the least
  2230. significant.</summary>
  2231. </member>
  2232. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CARD_HARDWARE_REV">
  2233. <summary>Buffer points to a 64-bit (8 bytes) area which receives the hardware revision number
  2234. on the card. This number consists of four 16-bit words; the two most significant are always 0,
  2235. and the two least significant are the major revision and the minor revision, listed in order
  2236. from the most significant to the least significant.</summary>
  2237. </member>
  2238. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CARD_UPC_NO">
  2239. <summary>Buffer points to a 64-bit (8 bytes) area which receives the UPC (EAN) number for the card.
  2240. If there is no UPC number, the buffer is filled with zeros.
  2241. The UPC (EAN) number is coded as a BCD string, so e.g. 73-30130-00122-0 is coded as 0x0007330130001220.</summary>
  2242. </member>
  2243. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_TRANS_UPC_NO">
  2244. <summary>Buffer points to a 64-bit (8 bytes) area which receives the UPC (EAN) number for the transceiver.
  2245. If there is no UPC number, the buffer is filled with zeros.
  2246. The UPC (EAN) number is coded as a BCD string, so e.g. 73-30130-00122-0 is coded as 0x0007330130001220.
  2247. Note. Not implemented in linux. </summary>
  2248. </member>
  2249. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CHANNEL_NAME">
  2250. <summary>Buffer points to an area which receives a zero-terminated string with a clear-text
  2251. name of the channel.</summary>
  2252. <remarks> Use of this item code is no longer recommended. The returned
  2253. channel name doesn't contain the exact hardware type (it just contains
  2254. the device family) and uses zero-based channel numbering, which is not
  2255. user friendly. Instead, use e.g. <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DEVDESCR_ASCII"/> and
  2256. <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CHAN_NO_ON_CARD"/> to build your own channel name.</remarks>
  2257. </member>
  2258. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DLL_FILE_VERSION">
  2259. <summary>Buffer points to an array of 4 32-bit unsigned integers which receives the file
  2260. version number of the second-level DLL driver file, i.e. the DLL that interfaces between
  2261. canlib32.dll and the driver proper.<para>&#160;</para>
  2262. •0: 0<para>&#160;</para>
  2263. •1: The build number<para>&#160;</para>
  2264. •2: The minor revision number<para>&#160;</para>
  2265. •3: The major revision number<para>&#160;</para>
  2266. </summary>
  2267. </member>
  2268. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DLL_PRODUCT_VERSION">
  2269. <summary>Buffer points to an array of four 32-bit integers which receives the file
  2270. version number product version number of the second-level DLL driver file, i.e.
  2271. the DLL that interfaces between canlib32.dll and the driver proper.
  2272. Contents depending on index:<para>&#160;</para>
  2273. •0: 0<para>&#160;</para>
  2274. •1: 1<para>&#160;</para>
  2275. •2: The minor revision number<para>&#160;</para>
  2276. •3: The major revision number<para>&#160;</para>
  2277. </summary>
  2278. </member>
  2279. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DLL_FILETYPE">
  2280. <summary>Buffer points to a 32-bit unsigned integer which receives a number that identifies
  2281. the second-level DLL driver file, i.e. the DLL that interfaces between canlib32.dll and the
  2282. driver proper.
  2283. •1: kvalapw.dll - used with CANlib up to 2.29.<para>&#160;</para>
  2284. •2: kvalapw2.dll - used with CANlib from 3.0 and on.<para>&#160;</para>
  2285. </summary>
  2286. </member>
  2287. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_TRANS_TYPE">
  2288. <summary>Buffer points to a 32-bit unsigned integer which receives the CAN transceiver type
  2289. of the specified channel. This value is one of the canTRANSCEIVER_TYPE_xxx</summary>
  2290. </member>
  2291. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DEVICE_PHYSICAL_POSITION">
  2292. <summary>Buffer points to a 32-bit unsigned integer which receives an address indicating where
  2293. the device is located on its underlying bus. The interpretation of this number is bus-specific.
  2294. If the address is unknown or the bus driver does not support an address, the bus driver leaves
  2295. this member at its default value of 0xFFFFFFFF.
  2296. The following list describes the information certain bus drivers store in the Address field for their child devices: <para>&#160;</para>
  2297. •ISA: Does not supply an address.Defaults to 0xFFFFFFFF.<para>&#160;</para>
  2298. •PC Card(PCMCIA): The socket number(typically 0x00 or 0x40)<para>&#160;</para>
  2299. •PCI: The device number in the high word and the function number in the low word.<para>&#160;</para>
  2300. •USB: The port number.<para>&#160;</para>
  2301. Note. Not implemented in linux.
  2302. </summary>
  2303. </member>
  2304. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_UI_NUMBER">
  2305. <summary>Buffer points to a 32-bit unsigned integer which receives a number associated with the
  2306. device that can be displayed in the user interface. This number is typically a user-perceived
  2307. slot number, such as a number printed next to the slot on the board, or some other number that
  2308. makes locating the physical device easier for the user. For buses with no such convention, or
  2309. when the UI number is unknown, 0xFFFFFFFF is returned.</summary>
  2310. </member>
  2311. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_TIMESYNC_ENABLED">
  2312. <summary>Buffer points to a 32-bit unsigned integer which is set to 0, if the legacy time
  2313. synchronization is not currently enabled for the specified channel, and 1, if the legacy time
  2314. synchronization is currently enabled for the specified channel.</summary>
  2315. </member>
  2316. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DRIVER_FILE_VERSION">
  2317. <summary>Buffer points to an array of four 32-bit integers which receives the file
  2318. version number of the kernel-mode driver.
  2319. Contents depending on index:<para>&#160;</para>
  2320. •0: The build number <para>&#160;</para>
  2321. •1: 0<para>&#160;</para>
  2322. •2: The minor revision number<para>&#160;</para>
  2323. •3: The major revision number<para>&#160;</para>
  2324. </summary>
  2325. </member>
  2326. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DRIVER_PRODUCT_VERSION">
  2327. <summary>Buffer points to an array of four 32-bit integers which receives the product
  2328. version number of the kernel-mode driver.
  2329. Contents depending on index:<para>&#160;</para>
  2330. •0: 0<para>&#160;</para>
  2331. •1: 0<para>&#160;</para>
  2332. •2: The minor revision number<para>&#160;</para>
  2333. •3: The major revision number<para>&#160;</para>
  2334. </summary>
  2335. </member>
  2336. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_MFGNAME_UNICODE">
  2337. <summary>Buffer points to a string with the device manufacturer's name.
  2338. Note. Not implemented in linux.</summary>
  2339. </member>
  2340. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_MFGNAME_ASCII">
  2341. <summary>Buffer points to a string with the device manufacturer's name.</summary>
  2342. </member>
  2343. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DEVDESCR_UNICODE">
  2344. <summary>Buffer points to a string with the product name of the device.
  2345. Note. Not implemented in linux.</summary>
  2346. </member>
  2347. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DEVDESCR_ASCII">
  2348. <summary>Buffer points to a string with the product name of the device.</summary>
  2349. </member>
  2350. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DRIVER_NAME">
  2351. <summary>Buffer points to a string with the name of the device driver (e.g. "kcanl").</summary>
  2352. </member>
  2353. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CHANNEL_QUALITY">
  2354. <summary>Buffer points to a 32-bit unsigned integer that receives the quality of the channel,
  2355. where the quality is measured in percent of optimal quality.
  2356. For WLAN, -90 dBm and -35 dBm are considered 0% and 100%, respectively.
  2357. The quality is 100% for any directly connected channel(USB, PCI etc.).
  2358. </summary>
  2359. </member>
  2360. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_ROUNDTRIP_TIME">
  2361. <summary>Buffer point to a 32-bit unsigned integer that receives the roundtrip time which is
  2362. measured in milliseconds.</summary>
  2363. </member>
  2364. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_BUS_TYPE">
  2365. <summary>Buffer points to a 32-bit unsigned integer that receives the kvBUSTYPE_GROUP_xxx bus type.</summary>
  2366. </member>
  2367. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_DEVNAME_ASCII">
  2368. <summary>Buffer points to a string with the current device name.</summary>
  2369. </member>
  2370. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_TIME_SINCE_LAST_SEEN">
  2371. <summary>Buffer points to a 32-bit unsigned integer that contains the time in milliseconds since
  2372. the last communication occurred.
  2373. For WLAN devices, this is the time since the last keep-alive message. </summary>
  2374. </member>
  2375. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_REMOTE_OPERATIONAL_MODE">
  2376. <summary>Buffer points to a 32-bit unsigned integer that receives the current WLAN operational
  2377. mode of the remote capable device; canCHANNEL_OPMODE_xxx.</summary>
  2378. </member>
  2379. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_REMOTE_PROFILE_NAME">
  2380. <summary>Buffer points to a string with the remote profile name of the device.</summary>
  2381. </member>
  2382. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_REMOTE_HOST_NAME">
  2383. <summary>Buffer points to a string with the remote host name of the device.</summary>
  2384. </member>
  2385. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_REMOTE_MAC">
  2386. <summary>Buffer points to a string with the mac address of the device.</summary>
  2387. </member>
  2388. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_MAX_BITRATE">
  2389. <summary>Buffer points to a 32-bit unsigned integer which receives maximum bitrate of the device.
  2390. Zero value means no limit on bitrate.</summary>
  2391. </member>
  2392. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CHANNEL_CAP_MASK">
  2393. <summary>Buffer points to a 32-bit unsigned integer that receives the capabilities mask of the CAN
  2394. channel. This mask specifies which capabilities the device is guaranteed to support/not
  2395. support at the moment, see canCHANNEL_CAP_xxx for info about flags.</summary>
  2396. </member>
  2397. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_IS_REMOTE">
  2398. <summary>Buffer points to a 32-bit unsigned integer that is 1 if the channel(device) is currently
  2399. connected as a remote device. 0 if it is not currently a remote device.</summary>
  2400. </member>
  2401. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_REMOTE_TYPE">
  2402. <summary>Buffer points to a 32-bit unsigned integer that returns the type of remote connection.
  2403. See kvREMOTE_TYPExxx for returned values.</summary>
  2404. </member>
  2405. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_LOGGER_TYPE">
  2406. <summary>Buffer points to a 32-bit unsigned integer that returns the logger type of the device.
  2407. See kvLOGGER_TYPE_xxx for returned values.</summary>
  2408. </member>
  2409. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_HW_STATUS">
  2410. <summary>Buffer points to a <see cref="T:Kvaser.CanLib.Canlib.canChannelDataHwStatus"/> with the hardware status codes for the device
  2411. Note. This is only intended for internal use.</summary>
  2412. </member>
  2413. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_FEATURE_EAN">
  2414. <summary>Buffer is an unsigned int64 containing the unsigned int32 values, feature eanLo and feature eanHi of the device.
  2415. Note. This is only intended for internal use.</summary>
  2416. </member>
  2417. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_BUS_PARAM_LIMITS">
  2418. <summary>This define is used in <see cref="M:Kvaser.CanLib.Canlib.canGetChannelData(System.Int32,System.Int32,System.Object@)"/>, buffer mentioned below refers to this functions argument.
  2419. buffer is <see cref="T:Kvaser.CanLib.Canlib.kvBusParamLimits"/></summary>
  2420. </member>
  2421. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CLOCK_INFO">
  2422. <summary>This define is used in <see cref="M:Kvaser.CanLib.Canlib.canGetChannelData(System.Int32,System.Int32,System.Object@)"/>, buffer mentioned below refers to this functions argument.
  2423. buffer is <see cref="T:Kvaser.CanLib.Canlib.kvClockInfo"/></summary>
  2424. </member>
  2425. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CHANNEL_CAP_EX">
  2426. <summary>Buffer points to an array of two 64-bit unsigned integers that receives the capabilities value and capabilities mask of the CAN controller.
  2427. The mask specifies which capabilities the corresponding device is guaranteed to support/not support at the moment.
  2428. Contents depending on index:<para>&#160;</para>
  2429. •0: 0<para>value</para>
  2430. •1: 0<para>mask</para>
  2431. Value and mask is a combination of the canCHANNEL_CAP_EX_xxx flags.</summary>
  2432. </member>
  2433. <member name="F:Kvaser.CanLib.Canlib.canCHANNELDATA_CUST_CHANNEL_NAME">
  2434. <summary>Buffer is a string with channel name.
  2435. If no channel name is set, canERR_NOT_IMPLEMENTED will be returned, regardless of channel name is supported in the device or not.
  2436. </summary>
  2437. </member>
  2438. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_IS_EXCLUSIVE">
  2439. <summary>Used with canCHANNELDATA_CHANNEL_FLAGS, indicates that the channel is opened exclusively.</summary>
  2440. </member>
  2441. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_IS_OPEN">
  2442. <summary>Used with canCHANNELDATA_CHANNEL_FLAGS, indicates that the channel is active
  2443. (either opened in LIN mode or on-bus in CAN mode.)</summary>
  2444. </member>
  2445. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_IS_CANFD">
  2446. <summary>Used with canCHANNELDATA_CHANNEL_FLAGS, indicates that the channel has been opened
  2447. as CAN FD.</summary>
  2448. </member>
  2449. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_IS_LIN">
  2450. <summary>Reserved for when needed.</summary>
  2451. public const int canCHANNEL_IS_CANFD_NON_ISO = 0x0008;
  2452. <summary>canCHANNELDATA_CHANNEL_FLAGS, indicates that the channel has been opened as LIN.</summary>
  2453. </member>
  2454. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_IS_LIN_MASTER">
  2455. <summary>canCHANNELDATA_CHANNEL_FLAGS, indicates that the channel has been opened as a LIN master.</summary>
  2456. </member>
  2457. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_IS_LIN_SLAVE">
  2458. <summary>canCHANNELDATA_CHANNEL_FLAGS, indicates that the channel has been opened as a LIN slave.</summary>
  2459. </member>
  2460. <member name="F:Kvaser.CanLib.Canlib.canDRIVER_OFF">
  2461. <summary>The driver is turned off. Not implemented in all types of hardware.</summary>
  2462. </member>
  2463. <member name="F:Kvaser.CanLib.Canlib.canDRIVER_SILENT">
  2464. <summary>Sets the CAN controller in Silent Mode; that is, it doesn't send anything, not even ACK bits, on the bus. Reception works as usual.
  2465. Note: The values 2,3,5,6,7 are reserved values for compatibility reasons.
  2466. </summary>
  2467. </member>
  2468. <member name="F:Kvaser.CanLib.Canlib.canDRIVER_NORMAL">
  2469. <summary>The "normal" driver type (push-pull). This is the default.</summary>
  2470. </member>
  2471. <member name="F:Kvaser.CanLib.Canlib.canFILTER_NULL_MASK">
  2472. <summary>Sets the code for standard (11-bit) identifiers.</summary>
  2473. </member>
  2474. <member name="F:Kvaser.CanLib.Canlib.canFILTER_ACCEPT">
  2475. <summary>Sets the code for standard (11-bit) identifiers.</summary>
  2476. </member>
  2477. <member name="F:Kvaser.CanLib.Canlib.canFILTER_REJECT">
  2478. <summary>Sets the code for standard (11-bit) identifiers.</summary>
  2479. </member>
  2480. <member name="F:Kvaser.CanLib.Canlib.canFILTER_SET_CODE_STD">
  2481. <summary>Sets the code for standard (11-bit) identifiers.</summary>
  2482. </member>
  2483. <member name="F:Kvaser.CanLib.Canlib.canFILTER_SET_MASK_STD">
  2484. <summary>Sets the code for standard (11-bit) identifiers.</summary>
  2485. </member>
  2486. <member name="F:Kvaser.CanLib.Canlib.canFILTER_SET_CODE_EXT">
  2487. <summary>Sets the mask for standard (11-bit) identifiers.</summary>
  2488. </member>
  2489. <member name="F:Kvaser.CanLib.Canlib.canFILTER_SET_MASK_EXT">
  2490. <summary>Sets the mask for extended (29-bit) identifiers.</summary>
  2491. </member>
  2492. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_NONE">
  2493. <summary>Unknown or undefined</summary>
  2494. </member>
  2495. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_VIRTUAL">
  2496. <summary>The virtual CAN bus</summary>
  2497. </member>
  2498. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_LAPCAN">
  2499. <summary>LAPcan Family</summary>
  2500. </member>
  2501. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_CANPARI">
  2502. <summary>CANpari (obsolete).</summary>
  2503. </member>
  2504. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_PCCAN">
  2505. <summary>PCcan Family</summary>
  2506. </member>
  2507. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_PCICAN">
  2508. <summary>PCIcan Family</summary>
  2509. </member>
  2510. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_USBCAN">
  2511. <summary>USBcan (obsolete).</summary>
  2512. </member>
  2513. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_PCICAN_II">
  2514. <summary>PCIcan II family</summary>
  2515. </member>
  2516. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_USBCAN_II">
  2517. <summary>USBcan II, USBcan Rugged, Kvaser Memorator</summary>
  2518. </member>
  2519. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_SIMULATED">
  2520. <summary>Simulated CAN bus for Kvaser Creator (obsolete).</summary>
  2521. </member>
  2522. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_ACQUISITOR">
  2523. <summary>Kvaser Acquisitor (obsolete).</summary>
  2524. </member>
  2525. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_LEAF">
  2526. <summary>Kvaser Leaf Family</summary>
  2527. </member>
  2528. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_PC104_PLUS">
  2529. <summary>Kvaser PC104+</summary>
  2530. </member>
  2531. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_PCICANX_II">
  2532. <summary>Kvaser PCIcanx II</summary>
  2533. </member>
  2534. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_MEMORATOR_II">
  2535. <summary>Kvaser Memorator Professional family</summary>
  2536. </member>
  2537. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_MEMORATOR_PRO">
  2538. <summary>Kvaser Memorator Professional family</summary>
  2539. </member>
  2540. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_USBCAN_PRO">
  2541. <summary>Kvaser USBcan Professional</summary>
  2542. </member>
  2543. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_IRIS">
  2544. <summary>Obsolete name, use canHWTYPE_BLACKBIRD instead</summary>
  2545. </member>
  2546. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_BLACKBIRD">
  2547. <summary>Kvaser BlackBird</summary>
  2548. </member>
  2549. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_MEMORATOR_LIGHT">
  2550. <summary>Kvaser Memorator Light</summary>
  2551. </member>
  2552. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_MINIHYDRA">
  2553. <summary>Obsolete name, use canHWTYPE_EAGLE instead</summary>
  2554. </member>
  2555. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_EAGLE">
  2556. <summary>Kvaser Eagle family</summary>
  2557. </member>
  2558. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_BAGEL">
  2559. <summary>Obsolete name, use canHWTYPE_BLACKBIRD_V2 instead</summary>
  2560. </member>
  2561. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_BLACKBIRD_V2">
  2562. <summary>Kvaser BlackBird v2</summary>
  2563. </member>
  2564. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_MINIPCIE">
  2565. <summary>Kvaser Mini PCI Express</summary>
  2566. </member>
  2567. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_USBCAN_KLINE">
  2568. <summary>USBcan Pro HS/K-Line</summary>
  2569. </member>
  2570. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_ETHERCAN">
  2571. <summary>Kvaser Ethercan</summary>
  2572. </member>
  2573. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_USBCAN_LIGHT">
  2574. <summary>Kvaser USBcan Light</summary>
  2575. </member>
  2576. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_USBCAN_PRO2">
  2577. <summary>Kvaser USBcan Pro 5xHS and variants</summary>
  2578. </member>
  2579. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_PCIE_V2">
  2580. <summary>Kvaser PCIEcan 4xHS and variants</summary>
  2581. </member>
  2582. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_MEMORATOR_PRO2">
  2583. <summary>Kvaser Memorator Pro 5xHS and variants</summary>
  2584. </member>
  2585. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_LEAF2">
  2586. <summary>Kvaser Leaf Pro HS v2 and variants</summary>
  2587. </member>
  2588. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_MEMORATOR_V2">
  2589. <summary>Kvaser Memorator (2nd generation)</summary>
  2590. </member>
  2591. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_CANLINHYBRID">
  2592. <summary>Kvaser Hybrid CAN/LIN</summary>
  2593. </member>
  2594. <member name="F:Kvaser.CanLib.Canlib.canHWTYPE_DINRAIL">
  2595. <summary>Kvaser DIN Rail SE400S and variants</summary>
  2596. </member>
  2597. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_EXTENDED_CAN">
  2598. <summary>Can use extended identifiers</summary>
  2599. </member>
  2600. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_BUS_STATISTICS">
  2601. <summary>Can report busload etc</summary>
  2602. </member>
  2603. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_ERROR_COUNTERS">
  2604. <summary>Can return error counters</summary>
  2605. </member>
  2606. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_RESERVED_2">
  2607. <summary>Obsolete, only used by LAPcan driver</summary>
  2608. </member>
  2609. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_GENERATE_ERROR">
  2610. <summary>Can send error frames</summary>
  2611. </member>
  2612. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_GENERATE_OVERLOAD">
  2613. <summary>Can send CAN overload frame</summary>
  2614. </member>
  2615. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_TXREQUEST">
  2616. <summary>Can report when a CAN messsage transmission is initiated</summary>
  2617. </member>
  2618. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_TXACKNOWLEDGE">
  2619. <summary>Can report when a CAN messages has been transmitted</summary>
  2620. </member>
  2621. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_VIRTUAL">
  2622. <summary>Virtual CAN channel</summary>
  2623. </member>
  2624. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_SIMULATED">
  2625. <summary>Simulated CAN channel</summary>
  2626. </member>
  2627. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_RESERVED_1">
  2628. <summary>Obsolete, use canCHANNEL_CAP_REMOTE_ACCESS or \ref canGetChannelData() instead.</summary>
  2629. </member>
  2630. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_CAN_FD">
  2631. <summary>CAN-FD ISO compliant channel</summary>
  2632. </member>
  2633. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_CAN_FD_NONISO">
  2634. <summary>CAN-FD NON-ISO compliant channel</summary>
  2635. </member>
  2636. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_SILENT_MODE">
  2637. <summary>Channel supports Silent mode</summary>
  2638. </member>
  2639. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_SINGLE_SHOT">
  2640. <summary>Channel supports Single Shot messages</summary>
  2641. </member>
  2642. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_LOGGER">
  2643. <summary>Channel has logger capabilities.</summary>
  2644. </member>
  2645. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_REMOTE_ACCESS">
  2646. <summary>Channel has remote capabilities.</summary>
  2647. </member>
  2648. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_SCRIPT">
  2649. <summary>Channel has script capabilities.</summary>
  2650. </member>
  2651. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_LIN_HYBRID">
  2652. <summary>Channel has LIN capabilities.</summary>
  2653. </member>
  2654. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_IO_API">
  2655. <summary>Channel has IO API capabilities.</summary>
  2656. </member>
  2657. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_DIAGNOSTICS">
  2658. <summary>Channel has diagnostic capabilities.</summary>
  2659. </member>
  2660. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_CAP_EX_BUSPARAMS_TQ">
  2661. <summary>Channel has Busparams TQ capabilities.</summary>
  2662. </member>
  2663. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_OPMODE_NONE">
  2664. <summary> WLAN Operational mode</summary>
  2665. <summary>Not applicable, or unknown </summary>
  2666. </member>
  2667. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_OPMODE_INFRASTRUCTURE">
  2668. <summary>Infrastructure mode </summary>
  2669. </member>
  2670. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_OPMODE_RESERVED">
  2671. <summary>Reserved value, do not use </summary>
  2672. </member>
  2673. <member name="F:Kvaser.CanLib.Canlib.canCHANNEL_OPMODE_ADHOC">
  2674. <summary>Adhoc mode </summary>
  2675. </member>
  2676. <member name="F:Kvaser.CanLib.Canlib.canDRIVER_CAP_HIGHSPEED">
  2677. <summary> Driver (transceiver) capabilities</summary>
  2678. <summary>Used with <see cref="F:Kvaser.CanLib.Canlib.canCHANNELDATA_TRANS_CAP"/> </summary>
  2679. </member>
  2680. <member name="F:Kvaser.CanLib.Canlib.canEVENT_RX">
  2681. <summary> Notification codes; appears in the notification <see cref="F:Kvaser.CanLib.Canlib.WM__CANLIB"/> message.</summary>
  2682. <summary>when the queue of received CAN messages goes from empty to non-empty </summary>
  2683. </member>
  2684. <member name="F:Kvaser.CanLib.Canlib.canEVENT_TX">
  2685. <summary>when a CAN message has been transmitted </summary>
  2686. </member>
  2687. <member name="F:Kvaser.CanLib.Canlib.canEVENT_ERROR">
  2688. <summary>when a CAN bus error is reported by the CAN controller </summary>
  2689. </member>
  2690. <member name="F:Kvaser.CanLib.Canlib.canEVENT_STATUS">
  2691. <summary>when the CAN controller changes state </summary>
  2692. </member>
  2693. <member name="F:Kvaser.CanLib.Canlib.canEVENT_ENVVAR">
  2694. <summary>An envvar changed. </summary>
  2695. </member>
  2696. <member name="F:Kvaser.CanLib.Canlib.canEVENT_BUSONOFF">
  2697. <summary>Bus on/off status changed. </summary>
  2698. </member>
  2699. <member name="F:Kvaser.CanLib.Canlib.canEVENT_REMOVED">
  2700. <summary>Device removed. </summary>
  2701. </member>
  2702. <member name="F:Kvaser.CanLib.Canlib.canOPEN_EXCLUSIVE">
  2703. Flags that can be combined in a call to <see cref="M:Kvaser.CanLib.Canlib.canOpenChannel(System.Int32,System.Int32)"/>.
  2704. <summary>Don't allow sharing of this CANlib channel between applications.</summary>
  2705. </member>
  2706. <member name="F:Kvaser.CanLib.Canlib.canOPEN_REQUIRE_EXTENDED">
  2707. <summary>This flag causes two things to happen:
  2708. The call will fail if the specified circuit doesn't allow extended CAN (CAN 2.0B).
  2709. or
  2710. If no frame-type flag is specified in a call to <see cref="M:Kvaser.CanLib.Canlib.canWrite(System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)"/>, it is assumed
  2711. that extended CAN should be used.</summary>
  2712. </member>
  2713. <member name="F:Kvaser.CanLib.Canlib.canOPEN_ACCEPT_VIRTUAL">
  2714. <summary>Allow opening of virtual channels as well as physical channels.</summary>
  2715. </member>
  2716. <member name="F:Kvaser.CanLib.Canlib.canOPEN_OVERRIDE_EXCLUSIVE">
  2717. <summary>Open the channel even if it is opened for exclusive access already. Warning! Use this flag with caution.</summary>
  2718. </member>
  2719. <member name="F:Kvaser.CanLib.Canlib.canOPEN_REQUIRE_INIT_ACCESS">
  2720. <summary>Fail the call if the channel cannot be opened with init access.
  2721. Init access means that the CAN handle can set bit rate and CAN driver mode. At most one CAN handle may have init access to any given channel.<para>&#160;</para>
  2722. If you try to set the bit rate or CAN driver mode for a handle to which you don't have init access, the call will silently fail (i.e. <see cref="F:Kvaser.CanLib.Canlib.canStatus.canOK"/> is
  2723. returned although the call had no effect), unless you enable "access error reporting" by calling <see cref="M:Kvaser.CanLib.Canlib.canIoCtl(System.Int32,System.Int32,System.Object@)"/> using <see cref="F:Kvaser.CanLib.Canlib.canIOCTL_SET_REPORT_ACCESS_ERRORS"/>.
  2724. Access error reporting is by default off. Init access is the default.
  2725. </summary>
  2726. </member>
  2727. <member name="F:Kvaser.CanLib.Canlib.canOPEN_NO_INIT_ACCESS">
  2728. <summary>Don't open the handle with init access.
  2729. A handle opened without init access will still set default bitrate when going on bus, if no other handle has opened the channel with init access at the time of the buson.
  2730. </summary>
  2731. </member>
  2732. <member name="F:Kvaser.CanLib.Canlib.canOPEN_ACCEPT_LARGE_DLC">
  2733. <summary>The channel will accept messages with DLC (Data Length Code) greater than 8.
  2734. If this flag is not used, a message with DLC > 8 will always be reported or transmitted as a message with DLC = 8.
  2735. If the <see cref="F:Kvaser.CanLib.Canlib.canOPEN_ACCEPT_LARGE_DLC"/> flag is used, the message will be sent and/or received with the true DLC, which can be at most 15.
  2736. Note. The length of the message is always at most 8.</summary>
  2737. </member>
  2738. <member name="F:Kvaser.CanLib.Canlib.canOPEN_CAN_FD">
  2739. <summary>The channel will use the CAN FD protocol, ISO compliant.</summary>
  2740. </member>
  2741. <member name="F:Kvaser.CanLib.Canlib.canOPEN_CAN_FD_NONISO">
  2742. <summary>The channel will use the CAN FD NON-ISO protocol. Use this if you want to configure the can controller to be able to communicate with a can controller
  2743. designed prior to the release of the CAN FD ISO specification.
  2744. Non ISO mode implies:
  2745. <para>&#160;</para>
  2746. •The stuff bit counter will not be included in the frame format.<para>&#160;</para>
  2747. •Initial value for CRC17 and CRC21 will be zero.<para>&#160;</para>
  2748. This also means that messages with canFDMSG_xxx flags can now be used.</summary>
  2749. </member>
  2750. <member name="F:Kvaser.CanLib.Canlib.canMSG_MASK">
  2751. <summary>Used to mask the non-info bits.</summary>
  2752. </member>
  2753. <member name="F:Kvaser.CanLib.Canlib.canMSG_RTR">
  2754. <summary>Message is a remote request.</summary>
  2755. </member>
  2756. <member name="F:Kvaser.CanLib.Canlib.canMSG_STD">
  2757. <summary>Message has a standard (11-bit) identifier.</summary>
  2758. </member>
  2759. <member name="F:Kvaser.CanLib.Canlib.canMSG_EXT">
  2760. <summary>Message has an extended(29-bit) identifier.</summary>
  2761. </member>
  2762. <member name="F:Kvaser.CanLib.Canlib.canMSG_WAKEUP">
  2763. <summary>Message is a WAKEUP message(SWC hardware.)</summary>
  2764. </member>
  2765. <member name="F:Kvaser.CanLib.Canlib.canMSG_NERR">
  2766. <summary>NERR was active during the message(TJA1054 hardware)</summary>
  2767. </member>
  2768. <member name="F:Kvaser.CanLib.Canlib.canMSG_ERROR_FRAME">
  2769. <summary>Message represents an error frame.</summary>
  2770. </member>
  2771. <member name="F:Kvaser.CanLib.Canlib.canMSG_TXACK">
  2772. <summary>Message is a TX ACK(msg has really been sent)</summary>
  2773. </member>
  2774. <member name="F:Kvaser.CanLib.Canlib.canMSG_TXRQ">
  2775. <summary>Message is a TX REQUEST(msg was transfered to the chip)</summary>
  2776. </member>
  2777. <member name="F:Kvaser.CanLib.Canlib.canMSG_DELAY_MSG">
  2778. <summary>Message is NOT sent on the bus. The transmission of messages are delayed. The dlc specifies
  2779. the delay in milliseconds (1..1000).</summary>
  2780. </member>
  2781. <member name="F:Kvaser.CanLib.Canlib.canMSG_LOCAL_TXACK">
  2782. <summary>Message is a LOCAL TX ACK (msg was sent on another handle on the same channel)</summary>
  2783. </member>
  2784. <member name="F:Kvaser.CanLib.Canlib.canMSG_SINGLE_SHOT">
  2785. <summary>Message is Single Shot, try to send once, no retransmission. This flag can only be used with
  2786. transmitted messages.</summary>
  2787. </member>
  2788. <member name="F:Kvaser.CanLib.Canlib.canMSG_TXNACK">
  2789. <summary>Message is a failed Single Shot, message was not sent. This flag is only used with received messages.</summary>
  2790. </member>
  2791. <member name="F:Kvaser.CanLib.Canlib.canMSG_ABL">
  2792. <summary>Only together with canMSG_TXNACK, Single shot message was not sent because arbitration was lost.
  2793. This flag is only used with received messages.</summary>
  2794. </member>
  2795. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_MASK">
  2796. <summary>Used to mask the non-error bits</summary>
  2797. </member>
  2798. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_HW_OVERRUN">
  2799. <summary>HW buffer overrun</summary>
  2800. </member>
  2801. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_SW_OVERRUN">
  2802. <summary>SW buffer overrun</summary>
  2803. </member>
  2804. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_STUFF">
  2805. <summary>Stuff error</summary>
  2806. </member>
  2807. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_FORM">
  2808. <summary>Form error</summary>
  2809. </member>
  2810. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_CRC">
  2811. <summary>CRC error</summary>
  2812. </member>
  2813. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_BIT0">
  2814. <summary>Sent dom, read rec</summary>
  2815. </member>
  2816. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_BIT1">
  2817. <summary>Sent rec, read dom</summary>
  2818. </member>
  2819. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_OVERRUN">
  2820. <summary>Any overrun condition. \sa \ref section_user_guide_send_recv_overruns</summary>
  2821. </member>
  2822. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_BIT">
  2823. <summary>Any bit error.</summary>
  2824. </member>
  2825. <member name="F:Kvaser.CanLib.Canlib.canMSGERR_BUSERR">
  2826. <summary>Any RX error</summary>
  2827. </member>
  2828. <member name="F:Kvaser.CanLib.Canlib.canFDMSG_MASK">
  2829. <summary>Bit mask for canFDMSG_XXX bits</summary>
  2830. </member>
  2831. <member name="F:Kvaser.CanLib.Canlib.canFDMSG_FDF">
  2832. <summary>Message is an FD message (CAN FD)</summary>
  2833. </member>
  2834. <member name="F:Kvaser.CanLib.Canlib.canFDMSG_BRS">
  2835. <summary>Message is sent/received with bit rate switch (CAN FD)</summary>
  2836. </member>
  2837. <member name="F:Kvaser.CanLib.Canlib.canFDMSG_ESI">
  2838. <summary>Sender of the message is in error passive mode (CAN FD)</summary>
  2839. </member>
  2840. <member name="F:Kvaser.CanLib.Canlib.canSTAT_ERROR_PASSIVE">
  2841. <summary>The circuit is error passive.</summary>
  2842. </member>
  2843. <member name="F:Kvaser.CanLib.Canlib.canSTAT_BUS_OFF">
  2844. <summary>The circuit is Off Bus.</summary>
  2845. </member>
  2846. <member name="F:Kvaser.CanLib.Canlib.canSTAT_ERROR_WARNING">
  2847. <summary> At least one error counter > 96.</summary>
  2848. </member>
  2849. <member name="F:Kvaser.CanLib.Canlib.canSTAT_ERROR_ACTIVE">
  2850. <summary>The circuit is error active.</summary>
  2851. </member>
  2852. <member name="F:Kvaser.CanLib.Canlib.canSTAT_TX_PENDING">
  2853. <summary>There are messages pending transmission.</summary>
  2854. </member>
  2855. <member name="F:Kvaser.CanLib.Canlib.canSTAT_RX_PENDING">
  2856. <summary>There are messages in the receive buffer.</summary>
  2857. </member>
  2858. <member name="F:Kvaser.CanLib.Canlib.canSTAT_RESERVED_1">
  2859. <summary>The circuit is error passive.</summary>
  2860. </member>
  2861. <member name="F:Kvaser.CanLib.Canlib.canSTAT_TXERR">
  2862. <summary>There has been at least one TX error.</summary>
  2863. </member>
  2864. <member name="F:Kvaser.CanLib.Canlib.canSTAT_RXERR">
  2865. <summary>There has been at least one RX error of some sort.</summary>
  2866. </member>
  2867. <member name="F:Kvaser.CanLib.Canlib.canSTAT_HW_OVERRUN">
  2868. <summary>There has been at least one HW buffer overflow.</summary>
  2869. </member>
  2870. <member name="F:Kvaser.CanLib.Canlib.canSTAT_SW_OVERRUN">
  2871. <summary>There has been at least one SW buffer overflow.</summary>
  2872. </member>
  2873. <member name="F:Kvaser.CanLib.Canlib.canSTAT_OVERRUN">
  2874. <summary>For convenience.</summary>
  2875. </member>
  2876. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_PREFER_EXT">
  2877. <summary>Prefer extended identifiers (Value is ignored).</summary>
  2878. </member>
  2879. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_PREFER_STD">
  2880. <summary>Prefer standard identifiers (Value is ignored).</summary>
  2881. </member>
  2882. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_CLEAR_ERROR_COUNTERS">
  2883. <summary>Clear the Can Error Counter (Value is ignored).</summary>
  2884. </member>
  2885. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_TIMER_SCALE">
  2886. <summary>Set Timer Scale (default value is 1000 us. Input value is a uint32 in us) .</summary>
  2887. </member>
  2888. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_TXACK">
  2889. <summary>Enabling transmit Acknowledges on a channel (Input value is a uint32).</summary>
  2890. </member>
  2891. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_RX_BUFFER_LEVEL">
  2892. <summary>Get the current RX buffer level (Return value is a uint32).</summary>
  2893. </member>
  2894. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_TX_BUFFER_LEVEL">
  2895. <summary>Get the current TX buffer level (Return value is a uint32).</summary>
  2896. </member>
  2897. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_FLUSH_RX_BUFFER">
  2898. <summary>Discard the current contents of the RX queue (Value is ignored).</summary>
  2899. </member>
  2900. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_FLUSH_TX_BUFFER">
  2901. <summary>Discard the current contents of the TX queue (Value is ignored).</summary>
  2902. </member>
  2903. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_TIMER_SCALE">
  2904. <summary>Get the Current timer scale (Value is a uint32 in us).</summary>
  2905. </member>
  2906. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_TXRQ">
  2907. <summary>Turns transmit requests on or off.(Valid input values are 0 and 1 (uint32))</summary>
  2908. </member>
  2909. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_EVENTHANDLE">
  2910. <summary>Buf points at a HANDLE which receives a Windows Event handle which can be passed to the
  2911. Win32 API WaitForSingleObject.</summary>
  2912. </member>
  2913. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_BYPASS_MODE">
  2914. <summary>Not yet implemented.</summary>
  2915. </member>
  2916. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_WAKEUP">
  2917. <summary>This is only intended for internal use.</summary>
  2918. </member>
  2919. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_DRIVERHANDLE">
  2920. <summary>Buf points to a HANDLE which receives the Windows handle related to the CANlib handle.</summary>
  2921. </member>
  2922. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_MAP_RXQUEUE">
  2923. <summary>This is only intended for internal use.</summary>
  2924. </member>
  2925. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_WAKEUP">
  2926. <summary>This is only intended for internal use.</summary>
  2927. </member>
  2928. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_REPORT_ACCESS_ERRORS">
  2929. <summary>Buf points to a unsigned char which contains, 0 to turn access error reporting off, and
  2930. 1 to turn access error reporting on.</summary>
  2931. </member>
  2932. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_REPORT_ACCESS_ERRORS">
  2933. <summary>Returns an Int32 the current setting of the access error reporting (0 or 1.)</summary>
  2934. </member>
  2935. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_CONNECT_TO_VIRTUAL_BUS">
  2936. <summary>Connects the handle to the virtual bus number (0..31) which the buf points to. Argument is of type unsigned int</summary>
  2937. </member>
  2938. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_DISCONNECT_FROM_VIRTUAL_BUS">
  2939. <summary>Disconnects the handle from the virtual bus number (0..31) which the buf points to. Argument is of type unsigned int</summary>
  2940. </member>
  2941. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_USER_IOPORT">
  2942. <summary>Buf points to a canUserIoPortData struct that contains a port number and a port value to set.
  2943. This is used by special hardware only.</summary>
  2944. </member>
  2945. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_USER_IOPORT">
  2946. <summary>Buf points to a canUserIoPortData struct that contains a port number. After the call, the
  2947. struct will contain the current value of the I/O port. This is used by special hardware only.</summary>
  2948. </member>
  2949. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_BUFFER_WRAPAROUND_MODE">
  2950. <summary>This is only intended for internal use.</summary>
  2951. </member>
  2952. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_RX_QUEUE_SIZE">
  2953. <summary>Use this function code to set the size of the receive buffer for a specific handle.
  2954. Value is a uint32 which contains the new size (number of messages) of the receive buffer.</summary>
  2955. </member>
  2956. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_USB_THROTTLE">
  2957. <summary>This is only intended for internal use.</summary>
  2958. </member>
  2959. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_USB_THROTTLE">
  2960. <summary>This is only intended for internal use.</summary>
  2961. </member>
  2962. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_BUSON_TIME_AUTO_RESET">
  2963. <summary>This function enables or disables automatic time reset on bus on. Argument is of type Int32 with value enable or disable (1 or 0). </summary>
  2964. </member>
  2965. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_TXACK">
  2966. <summary>Returns the state of the Transmit Acknowledge as a uint32</summary>
  2967. </member>
  2968. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_LOCAL_TXECHO">
  2969. <summary>Buf points to an unsigned byte. If the value is zero, the local transmit echo is turned
  2970. off for the handle. Otherwise, local transmit echo is turned on.</summary>
  2971. </member>
  2972. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_ERROR_FRAMES_REPORTING">
  2973. <summary>This function turns error frame reporting on or off. Argument is of type Int32 with value on or off (1 or 0). </summary>
  2974. </member>
  2975. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_CHANNEL_QUALITY">
  2976. <summary>Value is a uint32 that receives the quality of the channel, where the quality is measured
  2977. in percent of optimal quality.</summary>
  2978. </member>
  2979. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_ROUNDTRIP_TIME">
  2980. <summary>Returns the round trip time to a device. value is a uint32 that contains the roundtrip
  2981. time measured in milliseconds.</summary>
  2982. </member>
  2983. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_BUS_TYPE">
  2984. <summary>Value is a uint32 that contains the kvBUSTYPE_GROUP_xxx bus type.</summary>
  2985. </member>
  2986. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_DEVNAME_ASCII">
  2987. <summary>
  2988. Value is a string with the current device name.
  2989. <remarks>Not supported on Linux.</remarks>>
  2990. </summary>
  2991. </member>
  2992. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_TIME_SINCE_LAST_SEEN">
  2993. <summary>Value is a uint32 that contains the time in milliseconds since the last communication occurred.</summary>
  2994. </member>
  2995. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_TX_INTERVAL">
  2996. <summary>Value a uint32 that contains the number of microseconds the minimum CAN message transmit
  2997. interval should be set to, or 0xffffffff to fetch the current setting. The minimum interval can not be set to more than one second.</summary>
  2998. </member>
  2999. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_BRLIMIT">
  3000. <summary>Value is uint32 that contains a user defined bitrate. A value of 0 means that the device
  3001. should use its own default bitrate limit.</summary>
  3002. </member>
  3003. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_THROTTLE_SCALED">
  3004. <summary>Set the responsitivity of some devices. Value is a uint32 that should contain a value between 0 and 100.</summary>
  3005. </member>
  3006. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_GET_THROTTLE_SCALED">
  3007. <summary>Set the responsitivity of some devices. Value is a uint32 that should contain a value between 0 and 100.</summary>
  3008. </member>
  3009. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_RESET_OVERRUN_COUNT">
  3010. <summary>Reset overrun count and flags, buf argument is ignored</summary>
  3011. </member>
  3012. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_LIN_MODE">
  3013. <summary>Set the current LIN access mode returned in canCHANNELDATA_CHANNEL_FLAGS. Note. Only for internal Use</summary>
  3014. </member>
  3015. <member name="F:Kvaser.CanLib.Canlib.canIOCTL_SET_LOCAL_TXACK">
  3016. <summary>Enable reception of canMSG_LOCAL_TXACK. Value is uint32 and can be either 0 or 1. A value of 0 means that the local txack is disabled,
  3017. a value of 1 means that it is enabled. </summary>
  3018. </member>
  3019. <member name="F:Kvaser.CanLib.Canlib.canNOTIFY_NONE">
  3020. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/> as notification flags. Turn notifications off. .</summary>
  3021. </member>
  3022. <member name="F:Kvaser.CanLib.Canlib.canNOTIFY_RX">
  3023. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/> as notification flags. CAN message reception notification.</summary>
  3024. </member>
  3025. <member name="F:Kvaser.CanLib.Canlib.canNOTIFY_TX">
  3026. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/> as notification flags. CAN message transmission notification.</summary>
  3027. </member>
  3028. <member name="F:Kvaser.CanLib.Canlib.canNOTIFY_ERROR">
  3029. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/> as notification flags. CAN bus error notification.</summary>
  3030. </member>
  3031. <member name="F:Kvaser.CanLib.Canlib.canNOTIFY_STATUS">
  3032. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/> as notification flags. CAN chip status change.</summary>
  3033. </member>
  3034. <member name="F:Kvaser.CanLib.Canlib.canNOTIFY_ENVVAR">
  3035. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/> as notification flags.An environment variable was changed by a script. Note that you will not be notified when an environment variable is updated from the Canlib API.</summary>
  3036. </member>
  3037. <member name="F:Kvaser.CanLib.Canlib.canNOTIFY_BUSONOFF">
  3038. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/> as notification flags. Notify on bus on/off status changed.</summary>
  3039. </member>
  3040. <member name="F:Kvaser.CanLib.Canlib.canNOTIFY_REMOVED">
  3041. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.kvSetNotifyCallback(System.Int32,Kvaser.CanLib.Canlib.kvCallbackDelegate,System.IntPtr,System.Int32)"/> as notification flags. Notify on device removed. </summary>
  3042. </member>
  3043. <member name="T:Kvaser.CanLib.Canlib.canObjBufType">
  3044. <summary> These defines are used when allocating object buffers using <see cref="M:Kvaser.CanLib.Canlib.canObjBufAllocate(System.Int32,Kvaser.CanLib.Canlib.canObjBufType)"/>. </summary>
  3045. </member>
  3046. <member name="F:Kvaser.CanLib.Canlib.canObjBufType.AUTO_RESPONSE">
  3047. <summary>The requested buffer is an auto-response buffer.</summary>
  3048. </member>
  3049. <member name="F:Kvaser.CanLib.Canlib.canObjBufType.PERIODIC_TX">
  3050. <summary>The requested buffer is an auto-transmit buffer.</summary>
  3051. </member>
  3052. <member name="F:Kvaser.CanLib.Canlib.canOBJBUF_AUTO_RESPONSE_RTR_ONLY">
  3053. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.canObjBufSetFlags(System.Int32,System.Int32,System.Int32)"/>.</summary>
  3054. </member>
  3055. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_NA">
  3056. <summary>Not Affected/Not available.</summary>
  3057. </member>
  3058. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_SWC_SLEEP">
  3059. <summary>SWC Sleep Mode.</summary>
  3060. </member>
  3061. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_SWC_NORMAL">
  3062. <summary>SWC Normal Mode.</summary>
  3063. </member>
  3064. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_SWC_FAST">
  3065. <summary>SWC High-Speed Mode.</summary>
  3066. </member>
  3067. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_SWC_WAKEUP">
  3068. <summary>SWC Wakeup Mode.</summary>
  3069. </member>
  3070. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_SLEEP">
  3071. <summary>Sleep mode for those supporting it.</summary>
  3072. </member>
  3073. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_NORMAL">
  3074. <summary>Normal mode (the inverse of sleep mode) for those supporting it.</summary>
  3075. </member>
  3076. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_STDBY">
  3077. <summary>Standby for those who support it.</summary>
  3078. </member>
  3079. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_TT_CAN_H">
  3080. <summary>Truck and Trailer: operating mode single wire using CAN high.</summary>
  3081. </member>
  3082. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_TT_CAN_L">
  3083. <summary>Truck and Trailer: operating mode single wire using CAN low.</summary>
  3084. </member>
  3085. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_OEM1">
  3086. <summary>Reserved for OEM apps.</summary>
  3087. </member>
  3088. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_OEM2">
  3089. <summary>Reserved for OEM apps.</summary>
  3090. </member>
  3091. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_OEM3">
  3092. <summary>Reserved for OEM apps.</summary>
  3093. </member>
  3094. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_LINEMODE_OEM4">
  3095. <summary>Reserved for OEM apps.</summary>
  3096. </member>
  3097. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_RESNET_NA">
  3098. <summary></summary>
  3099. </member>
  3100. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_RESNET_MASTER">
  3101. <summary></summary>
  3102. </member>
  3103. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_RESNET_MASTER_STBY">
  3104. <summary></summary>
  3105. </member>
  3106. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_RESNET_SLAVE">
  3107. <summary></summary>
  3108. </member>
  3109. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_UNKNOWN">
  3110. <summary>Transceiver (logical) types.</summary>
  3111. <summary>Unknown or undefined.</summary>
  3112. </member>
  3113. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_251">
  3114. <summary>82c251 </summary>
  3115. </member>
  3116. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_252">
  3117. <summary>82c252, TJA1053, TJA1054 </summary>
  3118. </member>
  3119. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_DNOPTO">
  3120. <summary>Optoisolated 82C251. </summary>
  3121. </member>
  3122. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_W210">
  3123. <summary>Unknown or undefined. </summary>
  3124. </member>
  3125. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_SWC_PROTO">
  3126. <summary>AU5790 prototype. </summary>
  3127. </member>
  3128. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_SWC">
  3129. <summary>AU5790. </summary>
  3130. </member>
  3131. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_EVA">
  3132. <summary>Unknown or undefined.</summary>
  3133. </member>
  3134. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_FIBER">
  3135. <summary>82c251 with fibre extension </summary>
  3136. </member>
  3137. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_K251">
  3138. <summary>K-line + 82c251. </summary>
  3139. </member>
  3140. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_K">
  3141. <summary>K-line, without CAN. </summary>
  3142. </member>
  3143. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_1054_OPTO">
  3144. <summary>TJA1054 with optical isolation. </summary>
  3145. </member>
  3146. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_SWC_OPTO">
  3147. <summary>AU5790 with optical isolation. </summary>
  3148. </member>
  3149. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_TT">
  3150. <summary>B10011S Truck-And-Trailer. </summary>
  3151. </member>
  3152. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_1050">
  3153. <summary>TJA1050. </summary>
  3154. </member>
  3155. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_1050_OPTO">
  3156. <summary>TJA1050 with optical isolation. </summary>
  3157. </member>
  3158. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_1041">
  3159. <summary>TJA1041. </summary>
  3160. </member>
  3161. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_1041_OPTO">
  3162. <summary>TJA1041 with optical isolation. </summary>
  3163. </member>
  3164. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_RS485">
  3165. <summary>RS485 (i.e. J1708) </summary>
  3166. </member>
  3167. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_LIN">
  3168. <summary>LIN. </summary>
  3169. </member>
  3170. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_KONE">
  3171. <summary>KONE. </summary>
  3172. </member>
  3173. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_CANFD">
  3174. <summary>CAN-FD. </summary>
  3175. </member>
  3176. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_CANFD_LIN">
  3177. <summary>HYBRID CAN-FD/LIN. </summary>
  3178. </member>
  3179. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_LINX_LIN">
  3180. <summary>Unknown or undefined. </summary>
  3181. </member>
  3182. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_LINX_J1708">
  3183. <summary>Unknown or undefined. </summary>
  3184. </member>
  3185. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_LINX_K">
  3186. <summary>Unknown or undefined. </summary>
  3187. </member>
  3188. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_LINX_SWC">
  3189. <summary>Unknown or undefined. </summary>
  3190. </member>
  3191. <member name="F:Kvaser.CanLib.Canlib.canTRANSCEIVER_TYPE_LINX_LS">
  3192. <summary>Unknown or undefined. </summary>
  3193. </member>
  3194. <member name="F:Kvaser.CanLib.Canlib.canTXEDATA_FILE_VERSION">
  3195. <summary>These defines are used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptTxeGetData(System.String,System.Int32,System.Object@)"/>.
  3196. buffer points to an array of 3 32-bit unsigned integers which receives the three part version number of the compiled script file(.txe) file format
  3197. </summary>
  3198. </member>
  3199. <member name="F:Kvaser.CanLib.Canlib.canTXEDATA_COMPILER_VERSION">
  3200. <summary>These defines are used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptTxeGetData(System.String,System.Int32,System.Object@)"/>.
  3201. buffer points to an array of 3 32-bit unsigned integers which receives the three part version number of the compiler used to create the compiled script file(.txe).
  3202. </summary>
  3203. </member>
  3204. <member name="F:Kvaser.CanLib.Canlib.canTXEDATA_DATE">
  3205. <summary>These defines are used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptTxeGetData(System.String,System.Int32,System.Object@)"/>.
  3206. buffer points to an array of 6 32-bit unsigned integers which receive the compilation date in Coordinated Universal Time(UTC) of the compiled script file(.txe).
  3207. </summary>
  3208. </member>
  3209. <member name="F:Kvaser.CanLib.Canlib.canTXEDATA_DESCRIPTION">
  3210. <summary>These defines are used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptTxeGetData(System.String,System.Int32,System.Object@)"/>.
  3211. buffer points to an area which receives a zero-terminated string with a description of the compiled script file(.txe).
  3212. </summary>
  3213. </member>
  3214. <member name="F:Kvaser.CanLib.Canlib.canTXEDATA_SOURCE">
  3215. <summary>These defines are used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptTxeGetData(System.String,System.Int32,System.Object@)"/>.
  3216. buffer points to an area which receives a list containing the names and content of all source files which were used to generate the compiled script file(.txe).
  3217. </summary>
  3218. </member>
  3219. <member name="F:Kvaser.CanLib.Canlib.canTXEDATA_SIZE_OF_CODE">
  3220. <summary>These defines are used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptTxeGetData(System.String,System.Int32,System.Object@)"/>.
  3221. buffer points to a single unsigned integer which receives the size of the compiled code of the compiled script file(.txe).
  3222. </summary>
  3223. </member>
  3224. <member name="F:Kvaser.CanLib.Canlib.canTXEDATA_IS_ENCRYPTED">
  3225. <summary>These defines are used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptTxeGetData(System.String,System.Int32,System.Object@)"/>.
  3226. buffer points to a single unsigned integer which will receive a non-zero value if the compiled script file (.txe) contents is encrypted.
  3227. </summary>
  3228. </member>
  3229. <member name="F:Kvaser.CanLib.Canlib.canVERSION_DONT_ACCEPT_LATER">
  3230. <summary></summary>
  3231. </member>
  3232. <member name="F:Kvaser.CanLib.Canlib.canVERSION_DONT_ACCEPT_BETAS">
  3233. <summary></summary>
  3234. </member>
  3235. <member name="F:Kvaser.CanLib.Canlib.canVERSION_CANLIB32_VERSION">
  3236. <summary>Version number of the canlib32.dll file coded as an unsigned 16-bit word.</summary>
  3237. </member>
  3238. <member name="F:Kvaser.CanLib.Canlib.canVERSION_CANLIB32_PRODVER">
  3239. <summary>Product version number of CANlib coded as an unsigned 16-bit word.</summary>
  3240. </member>
  3241. <member name="F:Kvaser.CanLib.Canlib.canVERSION_CANLIB32_PRODVER32">
  3242. <summary>Product version number of canlib32.dll coded as an unsigned 32-bit word.</summary>
  3243. </member>
  3244. <member name="F:Kvaser.CanLib.Canlib.canVERSION_CANLIB32_BETA">
  3245. <summary>Returns 1 if the present version is a beta (preview) release, or 0 if it is an official release.</summary>
  3246. </member>
  3247. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_NONE">
  3248. <summary>Unkown bus type.
  3249. Note. Not inplemented in linux.</summary>
  3250. </member>
  3251. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_PCI">
  3252. <summary>Bus of type PCI.
  3253. Note. Not inplemented in linux.</summary>
  3254. </member>
  3255. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_PCMCIA">
  3256. <summary>Bus of type PCMCIA.
  3257. Note. Not inplemented in linux.</summary>
  3258. </member>
  3259. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_USB">
  3260. <summary>Bus of type USB.
  3261. Note. Not inplemented in linux.</summary>
  3262. </member>
  3263. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_WLAN">
  3264. <summary>Bus of type WLAN.
  3265. Note. Not inplemented in linux.</summary>
  3266. </member>
  3267. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_PCI_EXPRESS">
  3268. <summary>Bus of type PCI Express.
  3269. Note. Not inplemented in linux.</summary>
  3270. </member>
  3271. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_ISA">
  3272. <summary>Bus of type ISA.
  3273. Note. Not inplemented in linux.</summary>
  3274. </member>
  3275. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_VIRTUAL">
  3276. <summary>Bus of type virtual.
  3277. Note. Not inplemented in linux.</summary>
  3278. </member>
  3279. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_PC104_PLUS">
  3280. <summary>Bus of type PC104+.
  3281. Note. Not inplemented in linux.</summary>
  3282. </member>
  3283. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_LAN">
  3284. <summary>Bus of type LAN.
  3285. Note. Not inplemented in linux.</summary>
  3286. </member>
  3287. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_GROUP_VIRTUAL">
  3288. <summary>BusType Virtual.</summary>
  3289. </member>
  3290. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_GROUP_LOCAL">
  3291. <summary>BusType Local.</summary>
  3292. </member>
  3293. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_GROUP_REMOTE">
  3294. <summary>BusType Remote.</summary>
  3295. </member>
  3296. <member name="F:Kvaser.CanLib.Canlib.kvBUSTYPE_GROUP_INTERNAL">
  3297. <summary>BusType Internal.</summary>
  3298. </member>
  3299. <member name="F:Kvaser.CanLib.Canlib.kvDEVICE_MODE_INTERFACE">
  3300. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.kvDeviceSetMode(System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.kvDeviceGetMode(System.Int32,System.Int32@)"/>. Device is running or should be running in interface mode.</summary>
  3301. </member>
  3302. <member name="F:Kvaser.CanLib.Canlib.kvDEVICE_MODE_LOGGER">
  3303. <summary>Used in <see cref="M:Kvaser.CanLib.Canlib.kvDeviceSetMode(System.Int32,System.Int32)"/> and <see cref="M:Kvaser.CanLib.Canlib.kvDeviceGetMode(System.Int32,System.Int32@)"/>. Device is running or should be running in logger mode.</summary>
  3304. </member>
  3305. <member name="F:Kvaser.CanLib.Canlib.kvENVVAR_TYPE_INT">
  3306. <summary>This define is used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptEnvvarOpen(System.Int32,System.String,System.Int32@,System.Int32@)"/>. It defines the type of the envvar as int.</summary>
  3307. </member>
  3308. <member name="F:Kvaser.CanLib.Canlib.kvENVVAR_TYPE_FLOAT">
  3309. <summary>This define is used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptEnvvarOpen(System.Int32,System.String,System.Int32@,System.Int32@)"/>. It defines the type of the envvar as float.</summary>
  3310. </member>
  3311. <member name="F:Kvaser.CanLib.Canlib.kvENVVAR_TYPE_STRING">
  3312. <summary>This define is used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptEnvvarOpen(System.Int32,System.String,System.Int32@,System.Int32@)"/>. It defines the type of the envvar as string.</summary>
  3313. </member>
  3314. <member name="F:Kvaser.CanLib.Canlib.kvEVENT_TYPE_KEY">
  3315. <summary>This define is used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptEnvvarOpen(System.Int32,System.String,System.Int32@,System.Int32@)"/>. It defines an event of type "key pressed".</summary>
  3316. </member>
  3317. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_ALL_LEDS_ON">
  3318. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn all LEDs on.</summary>
  3319. </member>
  3320. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_ALL_LEDS_OFF">
  3321. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn all LEDs off.</summary>
  3322. </member>
  3323. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_0_ON">
  3324. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 0 on.</summary>
  3325. </member>
  3326. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_0_OFF">
  3327. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 0 off.</summary>
  3328. </member>
  3329. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_1_ON">
  3330. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 1 on.</summary>
  3331. </member>
  3332. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_1_OFF">
  3333. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 1 off.</summary>
  3334. </member>
  3335. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_2_ON">
  3336. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 2 on.</summary>
  3337. </member>
  3338. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_2_OFF">
  3339. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 2 off.</summary>
  3340. </member>
  3341. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_3_ON">
  3342. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 3 on.</summary>
  3343. </member>
  3344. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_3_OFF">
  3345. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 3 off.</summary>
  3346. </member>
  3347. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_4_ON">
  3348. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 4 on.</summary>
  3349. </member>
  3350. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_4_OFF">
  3351. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 4 off.</summary>
  3352. </member>
  3353. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_5_ON">
  3354. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 5 on.</summary>
  3355. </member>
  3356. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_5_OFF">
  3357. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 5 off.</summary>
  3358. </member>
  3359. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_6_ON">
  3360. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 6 on.</summary>
  3361. </member>
  3362. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_6_OFF">
  3363. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 6 off.</summary>
  3364. </member>
  3365. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_7_ON">
  3366. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 7 on.</summary>
  3367. </member>
  3368. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_7_OFF">
  3369. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 7 off.</summary>
  3370. </member>
  3371. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_8_ON">
  3372. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 8 on.</summary>
  3373. </member>
  3374. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_8_OFF">
  3375. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 8 off.</summary>
  3376. </member>
  3377. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_9_ON">
  3378. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 9 on.</summary>
  3379. </member>
  3380. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_9_OFF">
  3381. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 9 off.</summary>
  3382. </member>
  3383. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_10_ON">
  3384. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 10 on.</summary>
  3385. </member>
  3386. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_10_OFF">
  3387. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 10 off.</summary>
  3388. </member>
  3389. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_11_ON">
  3390. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 11 on.</summary>
  3391. </member>
  3392. <member name="F:Kvaser.CanLib.Canlib.kvLED_ACTION_LED_11_OFF">
  3393. <summary>This constant is used in <see cref="M:Kvaser.CanLib.Canlib.kvFlashLeds(System.Int32,System.Int32,System.Int32)"/>. Turn LED 11 off.</summary>
  3394. </member>
  3395. <member name="F:Kvaser.CanLib.Canlib.kvSCRIPT_STOP_NORMAL">
  3396. <summary>Script stop modes. Used by <see cref="M:Kvaser.CanLib.Canlib.kvScriptStop(System.Int32,System.Int32,System.Int32)"/>. Stop a running script .</summary>
  3397. </member>
  3398. <member name="F:Kvaser.CanLib.Canlib.kvSCRIPT_STOP_FORCED">
  3399. <summary>Script stop modes. Used by <see cref="M:Kvaser.CanLib.Canlib.kvScriptStop(System.Int32,System.Int32,System.Int32)"/>. Request termination of a hanged script.</summary>
  3400. </member>
  3401. <member name="F:Kvaser.CanLib.Canlib.kvSCRIPT_REQUEST_TEXT_UNSUBSCRIBE">
  3402. <summary>These defines are used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptRequestText(System.Int32,System.Int32,System.Int32)"/> for printf message subscribe/unsubscribe. Cancel subscription of printf messages from script slots.</summary>
  3403. </member>
  3404. <member name="F:Kvaser.CanLib.Canlib.kvSCRIPT_REQUEST_TEXT_SUBSCRIBE">
  3405. <summary>These defines are used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptRequestText(System.Int32,System.Int32,System.Int32)"/> for printf message subscribe/unsubscribe. Cancel subscription of printf messages from script slots.</summary>
  3406. </member>
  3407. <member name="F:Kvaser.CanLib.Canlib.kvSCRIPT_REQUEST_TEXT_ALL_SLOTS">
  3408. <summary>These defines are used in <see cref="M:Kvaser.CanLib.Canlib.kvScriptRequestText(System.Int32,System.Int32,System.Int32)"/> for printf message subscribe/unsubscribe. Cancel subscription of printf messages from script slots.</summary>
  3409. </member>
  3410. <member name="F:Kvaser.CanLib.Canlib.kvSCRIPT_STATUS_LOADED">
  3411. <summary>Script status flag bits. Used by <see cref="M:Kvaser.CanLib.Canlib.kvScriptStatus(System.Int32,System.Int32,System.Int32@)"/>. The slot is loaded with a script.</summary>
  3412. </member>
  3413. <member name="F:Kvaser.CanLib.Canlib.kvSCRIPT_STATUS_RUNNING">
  3414. <summary>Script status flag bits. Used by <see cref="M:Kvaser.CanLib.Canlib.kvScriptStatus(System.Int32,System.Int32,System.Int32@)"/>. The slot is running a script.</summary>
  3415. </member>
  3416. <member name="F:Kvaser.CanLib.Canlib.canINVALID_HANDLE">
  3417. <summary>Indicates an invalid canHandle.</summary>
  3418. </member>
  3419. <member name="F:Kvaser.CanLib.Canlib.WM__CANLIB">
  3420. <summary> Notify message sent to the application window.</summary>
  3421. </member>
  3422. <member name="T:Kvaser.CanLib.Canlib.kvIoModuleDigital">
  3423. <summary>
  3424. This class is used in <see cref="M:Kvaser.CanLib.Canlib.kvIoGetModulePins(System.Int32,System.Int32,System.Object)"/> and <see cref="M:Kvaser.CanLib.Canlib.kvIoSetModulePins(System.Int32,System.Int32,System.Object)"/>.
  3425. It represents a digital add-on module.
  3426. </summary>
  3427. </member>
  3428. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleDigital.type">
  3429. <summary>The type of the module.</summary>
  3430. </member>
  3431. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleDigital.DO">
  3432. <summary>Digital Out</summary>
  3433. </member>
  3434. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleDigital.DI">
  3435. <summary>Digital In</summary>
  3436. </member>
  3437. <member name="T:Kvaser.CanLib.Canlib.kvIoModuleInternal">
  3438. <summary>
  3439. This class is used in <see cref="M:Kvaser.CanLib.Canlib.kvIoGetModulePins(System.Int32,System.Int32,System.Object)"/> and <see cref="M:Kvaser.CanLib.Canlib.kvIoSetModulePins(System.Int32,System.Int32,System.Object)"/>.
  3440. It represents a digital internal module
  3441. </summary>
  3442. </member>
  3443. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleInternal.type">
  3444. <summary>The type of the module.</summary>
  3445. </member>
  3446. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleInternal.DIO">
  3447. <summary>Digital Out (Bit 0), Digital In (Bit 1)</summary>
  3448. </member>
  3449. <member name="T:Kvaser.CanLib.Canlib.kvIoModuleRelay">
  3450. <summary>
  3451. This class is used in <see cref="M:Kvaser.CanLib.Canlib.kvIoGetModulePins(System.Int32,System.Int32,System.Object)"/> and <see cref="M:Kvaser.CanLib.Canlib.kvIoSetModulePins(System.Int32,System.Int32,System.Object)"/>.
  3452. It represents a relay add-on module.
  3453. </summary>
  3454. [StructLayout(LayoutKind.Sequential)]
  3455. </member>
  3456. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleRelay.type">
  3457. <summary>The type of the module.</summary>
  3458. </member>
  3459. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleRelay.RO">
  3460. <summary>Relay Out</summary>
  3461. </member>
  3462. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleRelay.DI">
  3463. <summary>Digital In</summary>
  3464. </member>
  3465. <member name="T:Kvaser.CanLib.Canlib.kvIoModuleAnalog">
  3466. <summary>
  3467. This class is used in <see cref="M:Kvaser.CanLib.Canlib.kvIoGetModulePins(System.Int32,System.Int32,System.Object)"/> and <see cref="M:Kvaser.CanLib.Canlib.kvIoSetModulePins(System.Int32,System.Int32,System.Object)"/>.
  3468. It represents an analog add-on module.
  3469. </summary>
  3470. </member>
  3471. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleAnalog.type">
  3472. <summary>The type of the module.</summary>
  3473. </member>
  3474. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleAnalog.AO1">
  3475. <summary>Analog Out 1</summary>
  3476. </member>
  3477. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleAnalog.AO2">
  3478. <summary>Analog Out 2</summary>
  3479. </member>
  3480. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleAnalog.AO3">
  3481. <summary>Analog Out 3</summary>
  3482. </member>
  3483. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleAnalog.AO4">
  3484. <summary>Analog Out 4</summary>
  3485. </member>
  3486. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleAnalog.AI1">
  3487. <summary>Analog In 1</summary>
  3488. </member>
  3489. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleAnalog.AI2">
  3490. <summary>Analog In 2</summary>
  3491. </member>
  3492. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleAnalog.AI3">
  3493. <summary>Analog In 3</summary>
  3494. </member>
  3495. <member name="F:Kvaser.CanLib.Canlib.kvIoModuleAnalog.AI4">
  3496. <summary>Analog In 4</summary>
  3497. </member>
  3498. </members>
  3499. </doc>