.. _file_include_VmbC_VmbC.h: File VmbC.h =========== |exhale_lsh| :ref:`Parent directory ` (``include/VmbC``) .. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS Main header file for the VmbC API. .. contents:: Contents :local: :backlinks: none Definition (``include/VmbC/VmbC.h``) ------------------------------------ .. toctree:: :maxdepth: 1 program_listing_file_include_VmbC_VmbC.h.rst Detailed Description -------------------- This file describes all necessary definitions for using Allied Vision's VmbC API. These type definitions are designed to be portable from other languages and other operating systems. General conventions: - Method names are composed in the following manner: - Vmb"Action" example: :ref:`exhale_function_group__Init_1gace3a3b10e68d4a80975782a05d4be4f2` - Vmb"Entity""Action" or Vmb"ActionTarget""Action" example: :ref:`exhale_function_group__CameraInfo_1gaaff15baa63bc7975dfdabb94c83c918b` - Vmb"Entity""SubEntity/ActionTarget""Action" example: :ref:`exhale_function_group__CmdAccess_1gab4c8af9e1fc39e870ed79ef100dd3bf9` - Strings (generally declared as "const char *") are assumed to have a trailing 0 character - All pointer parameters should of course be valid, except if stated otherwise. - To ensure compatibility with older programs linked against a former version of the API, all struct* parameters have an accompanying sizeofstruct parameter. - Functions returning lists are usually called twice: once with a zero buffer to get the length of the list, and then again with a buffer of the correct length. Includes -------- - ``VmbC/VmbCTypeDefinitions.h`` (:ref:`file_include_VmbC_VmbCTypeDefinitions.h`) - ``VmbC/VmbCommonTypes.h`` (:ref:`file_include_VmbC_VmbCommonTypes.h`) - ``stddef.h`` - ``stdint.h`` Functions --------- - :ref:`exhale_function_group__CameraInfo_1ga6a7ec1503fbf35c937c3a7cebefeb1b4` - :ref:`exhale_function_group__CameraInfo_1ga812c1829ed6fae75c246f34cd94a96df` - :ref:`exhale_function_group__CameraInfo_1gad6e2632d0cc4c9f7def89e839f681fbf` - :ref:`exhale_function_group__CameraInfo_1gaaff15baa63bc7975dfdabb94c83c918b` - :ref:`exhale_function_group__CameraInfo_1ga7e2fc291a27b13c3e071211476c5089b` - :ref:`exhale_function_group__Capture_1ga1d477d6cd758717d1379457ed0c3789e` - :ref:`exhale_function_group__Capture_1ga21e639881606a401365b24e6d3103664` - :ref:`exhale_function_group__Capture_1gaab717c843618bb68d60c40d1782a701d` - :ref:`exhale_function_group__Capture_1ga0a0ddf0d7c6321f9bc2f49e829a75acf` - :ref:`exhale_function_group__Capture_1gad930f14013c81ebf9accaa2e33a2eca6` - :ref:`exhale_function_group__ChunkData_1gae988d459f02508e5351fa74a77fa727e` - :ref:`exhale_function_group__GeneralFeatures_1ga003bcad157cbab8b57fd2519f0f4174c` - :ref:`exhale_function_group__BoolAccess_1gab237f4632def4d236e663b7b6e2e436c` - :ref:`exhale_function_group__BoolAccess_1ga046c8964787cd09859e4284e7a4bbf6b` - :ref:`exhale_function_group__CmdAccess_1ga41ec1ac4840cdbcdf73db17b163ca640` - :ref:`exhale_function_group__CmdAccess_1gab4c8af9e1fc39e870ed79ef100dd3bf9` - :ref:`exhale_function_group__EnumAccess_1gac65e9ab1b45173b4f1c4a603e1c3ff13` - :ref:`exhale_function_group__EnumAccess_1ga77e491824bbbb167599eed693d49b37d` - :ref:`exhale_function_group__EnumAccess_1gadc1e10914675ce6cd5c370eb64218e12` - :ref:`exhale_function_group__EnumAccess_1ga5865eaebc41255cc42f1b4e55e4cec74` - :ref:`exhale_function_group__EnumAccess_1gaa25c06d402514f2955a1d776f23b9790` - :ref:`exhale_function_group__EnumAccess_1gac7d4dae9837354e1cfbf11e170930f03` - :ref:`exhale_function_group__EnumAccess_1ga28e646dbf2da4c710fb8d726f5f9b79e` - :ref:`exhale_function_group__FloatAccess_1gafc7f66fd2b41ab1c5befbc30590c466e` - :ref:`exhale_function_group__FloatAccess_1ga0d000a3de90f1004377603a0c63b8ba3` - :ref:`exhale_function_group__FloatAccess_1gade87be887da83416187d712ad2c60bf7` - :ref:`exhale_function_group__FloatAccess_1gaa90bfc8e713d78fabc0e80cd7dcf6ec1` - :ref:`exhale_function_group__GeneralFeatures_1ga04fb690359722ffc88d99fe1aa2ac346` - :ref:`exhale_function_group__IntAccess_1ga53467a94a0f3222f9f12b04aa14a4cc6` - :ref:`exhale_function_group__IntAccess_1ga541cecdec56682a4d373aa69761d3aa9` - :ref:`exhale_function_group__IntAccess_1ga0af6dceea32b42b26aa35cad311b6d84` - :ref:`exhale_function_group__IntAccess_1gaf087631e05835850b65cfee0e96228fa` - :ref:`exhale_function_group__IntAccess_1gaf886d7e34167a4598ef47f1c2e440155` - :ref:`exhale_function_group__FeatureInvalidation_1ga04e8a6c386ae5795e95c983faf3873a6` - :ref:`exhale_function_group__FeatureInvalidation_1gadcce25b156fabad63e8324b056c7f69f` - :ref:`exhale_function_group__GeneralFeatures_1ga8e280586067b26bcb918536985b61e78` - :ref:`exhale_function_group__RawAccess_1gadde9235bd7ff2c9a169e355a1f10a4b2` - :ref:`exhale_function_group__RawAccess_1ga008957c5bb4387cdf61c48e206623eb6` - :ref:`exhale_function_group__RawAccess_1ga25149004bddbe70f69872491793684c7` - :ref:`exhale_function_group__GeneralFeatures_1ga25cebea66eca22b4446ce905d341c47e` - :ref:`exhale_function_group__StringAccess_1ga95a58ccbc3fdc567284ca1b5c43c377f` - :ref:`exhale_function_group__StringAccess_1ga77714f07d58b37af1f05fb5592fe006b` - :ref:`exhale_function_group__StringAccess_1ga49acda79263c8fbb82e484fb87626830` - :ref:`exhale_function_group__Capture_1gaee139d04da418e0551fb08f55dd85d7b` - :ref:`exhale_function_group__Capture_1gaf4c88f8b9076ecb09a4257f41a1f5ed0` - :ref:`exhale_function_group__Capture_1ga48c9c9792d2aaca605d274d5501fcb9f` - :ref:`exhale_function_group__Interface_1gaff72d38f33e5efc6f9f80b65b6f9e029` - :ref:`exhale_function_group__DirectAccess_1ga2dcc658c4faafaab4dfff68ff618824d` - :ref:`exhale_function_group__DirectAccess_1ga88d1b30d3f97b32344a37075f8f37350` - :ref:`exhale_function_group__Capture_1ga2baa414c2a8f9046c6dfa2bbe16185d0` - :ref:`exhale_function_group__LoadSaveSettings_1ga618d6ddc00a05f9a476e95148800d7b5` - :ref:`exhale_function_group__LoadSaveSettings_1ga7326c5908bf4699a2975289a1bd99c30` - :ref:`exhale_function_group__Init_1ga3adc3b7c9181e8821c6892d8e35f40ee` - :ref:`exhale_function_group__Init_1gace3a3b10e68d4a80975782a05d4be4f2` - :ref:`exhale_function_group__TransportLayer_1gabc5b2c212a7e04c16d7f42e4b8f65c7a` - :ref:`exhale_function_group__Version_1ga095f6915021cbd2595cc126074b69671` Defines ------- - :ref:`exhale_define_VmbC_8h_1a98b1e9649f86c6836d7af795e6264149` - :ref:`exhale_define_VmbC_8h_1ae3e76fcd723b40f47957d9af613b6762` Variables --------- - :ref:`exhale_variable_VmbC_8h_1a7aaba49699c8f13e8c7de111d51efc05`