libjaylink  0.2.0
Library to access J-Link devices
Functions
core.c File Reference

Core library functions. More...

#include <stdlib.h>
#include <stdbool.h>
#include "libjaylink.h"
#include "libjaylink-internal.h"

Functions

int jaylink_init (struct jaylink_context **ctx)
 Initialize libjaylink. More...
 
int jaylink_exit (struct jaylink_context *ctx)
 Shutdown libjaylink. More...
 
bool jaylink_library_has_cap (enum jaylink_capability cap)
 Check for a capability of libjaylink. More...
 

Detailed Description

Core library functions.

Function Documentation

int jaylink_exit ( struct jaylink_context ctx)

Shutdown libjaylink.

Parameters
[in,out]ctxlibjaylink context.
Return values
JAYLINK_OKSuccess.
JAYLINK_ERR_ARGInvalid arguments.
Since
0.1.0
int jaylink_init ( struct jaylink_context **  ctx)

Initialize libjaylink.

This function must be called before any other libjaylink function is called.

Parameters
[out]ctxNewly allocated libjaylink context on success, and undefined on failure.
Return values
JAYLINK_OKSuccess.
JAYLINK_ERR_ARGInvalid arguments.
JAYLINK_ERR_MALLOCMemory allocation error.
JAYLINK_ERROther error conditions.
Since
0.1.0
bool jaylink_library_has_cap ( enum jaylink_capability  cap)

Check for a capability of libjaylink.

Parameters
[in]capCapability to check for.
Return values
trueCapability is supported.
falseCapability is not supported or invalid argument.
Since
0.1.0