All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Typedefs | Functions
GenApiC.h File Reference

GenApi C bindings. More...

#include <stddef.h>
#include <genapic/GenApiCDefines.h>
#include <genapic/GenApiCTypes.h>
#include <genapic/GenApiCEnums.h>
#include <genapic/GenApiCError.h>
#include <genapic/GenApiC32BitMethods.h>

Macros

#define GENAPIC_INVALID_HANDLE   ( (void*)0 )
 A value for invalid / uninitialized handles.
 

Typedefs

typedef struct
GENAPI_FILE_HANDLE_ * 
GENAPI_FILE_HANDLE
 A handle for a GenApi file object.
 
typedef struct
NODE_CALLBACK_HANDLE_ * 
NODE_CALLBACK_HANDLE
 A handle for a node callback object.
 
typedef struct NODE_HANDLE_ * NODE_HANDLE
 A handle for a node object.
 
typedef struct NODEMAP_HANDLE_ * NODEMAP_HANDLE
 A handle for a node map object.
 

Functions

GENAPIC_RESULT GenApiBooleanGetValue (NODE_HANDLE hNode, _Bool *pValue)
 Return a node's boolean value. More...
 
GENAPIC_RESULT GenApiBooleanSetValue (NODE_HANDLE hNode, _Bool value)
 Set a node's boolean value. More...
 
GENAPIC_RESULT GenApiCategoryGetFeatureByIndex (NODE_HANDLE hNode, size_t index, NODE_HANDLE *phEntry)
 Get a feature node from a category by its index. More...
 
GENAPIC_RESULT GenApiCategoryGetNumFeatures (NODE_HANDLE hNode, size_t *pValue)
 Returns the number of features in a category. More...
 
GENAPIC_RESULT GenApiCommandExecute (NODE_HANDLE hNode)
 Trigger the execution of a command. More...
 
GENAPIC_RESULT GenApiCommandIsDone (NODE_HANDLE hNode, _Bool *pValue)
 Check whether command has finished. More...
 
GENAPIC_RESULT GenApiEnumerationEntryGetSymbolic (NODE_HANDLE hNode, char *pBuf, size_t *pBufLen)
 Return the symbolic name of an enumeration entry node. More...
 
GENAPIC_RESULT GenApiEnumerationEntryGetValue (NODE_HANDLE hNode, int *pValue)
 Returns the numerical index of an enumeration entry. More...
 
GENAPIC_RESULT GenApiEnumerationGetEntryByIndex (NODE_HANDLE hNode, size_t index, NODE_HANDLE *pEntry)
 Get an entry from an enumeration by index. More...
 
GENAPIC_RESULT GenApiEnumerationGetEntryByName (NODE_HANDLE hNode, const char *pName, NODE_HANDLE *pEntry)
 Get an entry from an enumeration by name. More...
 
GENAPIC_RESULT GenApiEnumerationGetNumEntries (NODE_HANDLE hNode, size_t *pValue)
 Get the number of entries in an enumeration. More...
 
GENAPIC_RESULT GenApiFileClose (GENAPI_FILE_HANDLE hFile)
 Closes a file. More...
 
GENAPIC_RESULT GenApiFileExists (NODEMAP_HANDLE hMap, const char *pFileName, _Bool *pResult)
 Check whether a file exists. More...
 
GENAPIC_RESULT GenApiFileOpen (NODEMAP_HANDLE hMap, const char *pFileName, EGenApiFileAccessMode accessMode, GENAPI_FILE_HANDLE *phFile)
 Opens a file. More...
 
GENAPIC_RESULT GenApiFileRead (GENAPI_FILE_HANDLE hFile, void *pBuffer, size_t *pLength)
 Reads binary data from a file. More...
 
GENAPIC_RESULT GenApiFilesAreSupported (NODEMAP_HANDLE hMap, _Bool *pResult)
 Check whether the device supports accessing files. More...
 
GENAPIC_RESULT GenApiFileWrite (GENAPI_FILE_HANDLE hFile, const void *pBuffer, size_t length)
 Writes binary data to a file. More...
 
GENAPIC_RESULT GenApiFloatGetMax (NODE_HANDLE hNode, double *pValue)
 Get a node's maximum floating-point value. More...
 
GENAPIC_RESULT GenApiFloatGetMin (NODE_HANDLE hNode, double *pValue)
 Get a node's minimum floating-point value. More...
 
GENAPIC_RESULT GenApiFloatGetRepresentation (NODE_HANDLE hNode, EGenApiRepresentation *pValue)
 Get a node's preferred representation. More...
 
GENAPIC_RESULT GenApiFloatGetUnit (NODE_HANDLE hNode, char *pBuf, size_t *pBufLen)
 Return a floating-point node's unit. More...
 
GENAPIC_RESULT GenApiFloatGetValue (NODE_HANDLE hNode, double *pValue)
 Get a node's floating-point value without validation. More...
 
GENAPIC_RESULT GenApiFloatGetValueEx (NODE_HANDLE hNode, _Bool verify, double *pValue)
 Return a node's floating-point value with optional validation. More...
 
GENAPIC_RESULT GenApiFloatSetValue (NODE_HANDLE hNode, double value)
 Set a node's floating-point value with mandatory validation. More...
 
GENAPIC_RESULT GenApiFloatSetValueEx (NODE_HANDLE hNode, _Bool verify, double value)
 Set a node's floating-point value with optional validation. More...
 
GENAPIC_RESULT GenApiGetLastErrorDetail (char *pBuf, size_t *pBufLen)
 Get detailed textual description for the latest error details, e.g. the origin of the error. More...
 
GENAPIC_RESULT GenApiGetLastErrorMessage (char *pBuf, size_t *pBufLen)
 Get a brief textual description of the latest error. More...
 
GENAPIC_RESULT GenApiIntegerGetInc (NODE_HANDLE hNode, int64_t *pValue)
 Get the value increment from an integer node. More...
 
GENAPIC_RESULT GenApiIntegerGetMax (NODE_HANDLE hNode, int64_t *pValue)
 Get the maximum value from an integer node. More...
 
GENAPIC_RESULT GenApiIntegerGetMin (NODE_HANDLE hNode, int64_t *pValue)
 Get the minimum value from an integer node. More...
 
GENAPIC_RESULT GenApiIntegerGetRepresentation (NODE_HANDLE hNode, EGenApiRepresentation *pValue)
 Get a node's preferred representation. More...
 
GENAPIC_RESULT GenApiIntegerGetValue (NODE_HANDLE hNode, int64_t *pValue)
 Get a node's integer value without validation. More...
 
GENAPIC_RESULT GenApiIntegerGetValueEx (NODE_HANDLE hNode, _Bool verify, int64_t *pValue)
 Return a node's integer value with optional validation. More...
 
GENAPIC_RESULT GenApiIntegerSetValue (NODE_HANDLE hNode, int64_t value)
 Set a node's integer value with mandatory validation. More...
 
GENAPIC_RESULT GenApiIntegerSetValueEx (NODE_HANDLE hNode, _Bool verify, int64_t value)
 Set a node's integer value with optional validation. More...
 
GENAPIC_RESULT GenApiNodeDeregisterCallback (NODE_HANDLE hNode, NODE_CALLBACK_HANDLE hCb)
 Remove a node callback function. More...
 
GENAPIC_RESULT GenApiNodeFromString (NODE_HANDLE hNode, const char *pString)
 Set a node's value from a text string with mandatory validation. More...
 
GENAPIC_RESULT GenApiNodeFromStringEx (NODE_HANDLE hNode, _Bool verify, const char *pString)
 Set a node's value from a text string with optional validation. More...
 
GENAPIC_RESULT GenApiNodeGetAccessMode (NODE_HANDLE hNode, EGenApiAccessMode *pAccessMode)
 Query node for allowed access modes. More...
 
GENAPIC_RESULT GenApiNodeGetAlias (NODE_HANDLE hNode, NODE_HANDLE *phNode)
 Get a node's alias. More...
 
GENAPIC_RESULT GenApiNodeGetCachingMode (NODE_HANDLE hNode, EGenApiCachingMode *pCachingMode)
 Query node for its caching mode. More...
 
GENAPIC_RESULT GenApiNodeGetDescription (NODE_HANDLE hNode, char *pBuf, size_t *pBufLen)
 Return a node's description text. More...
 
GENAPIC_RESULT GenApiNodeGetDisplayName (NODE_HANDLE hNode, char *pBuf, size_t *pBufLen)
 Return a node's user-friendly name. More...
 
GENAPIC_RESULT GenApiNodeGetName (NODE_HANDLE hNode, char *pBuf, size_t *pBufLen)
 Return a node's name. More...
 
GENAPIC_RESULT GenApiNodeGetNameSpace (NODE_HANDLE hNode, EGenApiNameSpace *pNamespace)
 Return a node's name space. More...
 
GENAPIC_RESULT GenApiNodeGetPollingTime (NODE_HANDLE hNode, int64_t *pPollingTime)
 Query a node for its recommended polling interval. More...
 
GENAPIC_RESULT GenApiNodeGetToolTip (NODE_HANDLE hNode, char *pBuf, size_t *pBufLen)
 Return a node's tool tip text. More...
 
GENAPIC_RESULT GenApiNodeGetType (NODE_HANDLE hNode, EGenApiNodeType *pType)
 Get node type. More...
 
GENAPIC_RESULT GenApiNodeGetVisibility (NODE_HANDLE hNode, EGenApiVisibility *pVisibility)
 Return a node's visibility. More...
 
GENAPIC_RESULT GenApiNodeImposeAccessMode (NODE_HANDLE hNode, EGenApiAccessMode imposedAccessMode)
 Modify a node's accessibility. More...
 
GENAPIC_RESULT GenApiNodeImposeVisibility (NODE_HANDLE hNode, EGenApiVisibility imposedVisibility)
 Modify a node's visibility. More...
 
GENAPIC_RESULT GenApiNodeInvalidateNode (NODE_HANDLE hNode)
 Mark node as possibly changed. More...
 
GENAPIC_RESULT GenApiNodeIsAvailable (NODE_HANDLE hNode, _Bool *pResult)
 Check whether a feature's value is available. More...
 
GENAPIC_RESULT GenApiNodeIsImplemented (NODE_HANDLE hNode, _Bool *pResult)
 Check whether a feature is implemented. More...
 
GENAPIC_RESULT GenApiNodeIsReadable (NODE_HANDLE hNode, _Bool *pResult)
 Check whether a feature's value is readable. More...
 
GENAPIC_RESULT GenApiNodeIsWritable (NODE_HANDLE hNode, _Bool *pResult)
 Check whether a feature's value is writable. More...
 
GENAPIC_RESULT GenApiNodeMapGetNode (NODEMAP_HANDLE hMap, const char *pName, NODE_HANDLE *phNode)
 Find a node by its name. More...
 
GENAPIC_RESULT GenApiNodeMapGetNodeByIndex (NODEMAP_HANDLE hMap, size_t index, NODE_HANDLE *phNode)
 Find a node by its index. More...
 
GENAPIC_RESULT GenApiNodeMapGetNumNodes (NODEMAP_HANDLE hMap, size_t *pValue)
 Get the number of nodes contained in a node map. More...
 
GENAPIC_RESULT GenApiNodeMapPoll (NODEMAP_HANDLE hMap, int64_t timestamp)
 Poll all nodes in a node map. More...
 
GENAPIC_RESULT GenApiNodeRegisterCallback (NODE_HANDLE hNode, NodeCallbackFunction_t *pCbFunction, NODE_CALLBACK_HANDLE *phCb)
 Install a node callback function. More...
 
GENAPIC_RESULT GenApiNodeToString (NODE_HANDLE hNode, char *pBuf, size_t *pBufLen)
 Return a textual representation of a node's value. More...
 
GENAPIC_RESULT GenApiNodeToStringEx (NODE_HANDLE hNode, _Bool verify, char *pBuf, size_t *pBufLen)
 Return a textual representation of a node's value with optional validation. More...
 
GENAPIC_RESULT GenApiPortRead (NODE_HANDLE hNode, void *pBuffer, int64_t Address, size_t Length)
 Perform a raw read on the port implemented by the node passed. More...
 
GENAPIC_RESULT GenApiPortWrite (NODE_HANDLE hNode, const void *pBuffer, int64_t Address, size_t Length)
 Perform a raw write on the port implemented by the node passed. More...
 
GENAPIC_RESULT GenApiSelectorGetNumSelectedFeatures (NODE_HANDLE hNode, size_t *pValue)
 Return the number of selected nodes. More...
 
GENAPIC_RESULT GenApiSelectorGetNumSelectingFeatures (NODE_HANDLE hNode, size_t *pValue)
 Return the number of selecting features. More...
 
GENAPIC_RESULT GenApiSelectorGetSelectedFeatureByIndex (NODE_HANDLE hNode, size_t index, NODE_HANDLE *phNode)
 Get a selected node by its index. More...
 
GENAPIC_RESULT GenApiSelectorGetSelectingFeatureByIndex (NODE_HANDLE hNode, size_t index, NODE_HANDLE *phNode)
 Return a selecting feature by its index. More...
 

Detailed Description

GenApi C bindings.


pylon C 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:56)