LicenseSpring C++ SDK
Easily add Software Licensing to your application
ExtendedOptions.h File Reference
#include "../APIDef.h"
#include "../PODTypes.h"
#include <stdbool.h>
#include <wchar.h>
#include <stdint.h>

Go to the source code of this file.

Classes

struct  LSProxySettings
 
struct  LSHardwareKeySerialList
 Structure to hold a list of strings (serial numbers). More...
 
struct  LSHardwareKeyOptions
 C-interface struct mirroring LicenseSpring::HardwareKeyOptions. More...
 
struct  LSExtendedOptions
 

Typedefs

typedef LS_API struct LSProxySettings LSProxySettings
 
typedef LS_API struct LSHardwareKeySerialList LSSerialList
 Structure to hold a list of strings (serial numbers). More...
 
typedef LS_API struct LSHardwareKeyOptions LSHardwareKeyOptions
 C-interface struct mirroring LicenseSpring::HardwareKeyOptions. More...
 
typedef LS_API struct LSExtendedOptions LSExtendedOptions
 

Functions

LS_API LSProxySettingsCreateLSProxySettings (const char *proxy, const char *user, const char *password)
 
LS_API void FreeLSProxySettings (LSProxySettings *settings)
 
LS_API void FreeLSSerialList (LSSerialList *list)
 Frees the memory allocated for an LSSerialList structure. More...
 
LS_API LSHardwareKeyOptionsCreateLSHardwareKeyOptions ()
 Creates a new LSHardwareKeyOptions object. More...
 
LS_API void FreeLSHardwareKeyOptions (LSHardwareKeyOptions *options)
 Frees the memory associated with an LSHardwareKeyOptions object. More...
 
LS_API LSSerialList ListAvailableHardwareKeys ()
 Lists the serial numbers of all connected YubiKeys with PIV support. More...
 
LS_API LSExtendedOptionsCreateLSExtendedOptions ()
 
LS_API LSExtendedOptionsCreateLSExtendedOptionsByPath (const wchar_t *licenseFilePath)
 
LS_API LSExtendedOptionsCreateLSExtendedOptionsEx (const wchar_t *licenseFilePath, const char *hardwareID, const LSProxySettings *proxy)
 
LS_API void FreeLSExtendedOptions (LSExtendedOptions *options)
 

Typedef Documentation

◆ LSProxySettings

◆ LSSerialList

Structure to hold a list of strings (serial numbers).

Returned by ListAvailableHardwareKeys. Must be freed using FreeLSSerialList.

◆ LSHardwareKeyOptions

◆ LSExtendedOptions

Function Documentation

◆ CreateLSProxySettings()

LS_API LSProxySettings * CreateLSProxySettings ( const char *  proxy,
const char *  user,
const char *  password 
)

◆ FreeLSProxySettings()

LS_API void FreeLSProxySettings ( LSProxySettings settings)

◆ FreeLSSerialList()

LS_API void FreeLSSerialList ( LSSerialList list)

Frees the memory allocated for an LSSerialList structure.

Parameters
listPointer to the LSSerialList returned by ListAvailableHardwareKeys.

◆ CreateLSHardwareKeyOptions()

LS_API LSHardwareKeyOptions * CreateLSHardwareKeyOptions ( )

Creates a new LSHardwareKeyOptions object.

Returns
Pointer to the created object. Must be freed with FreeLSHardwareKeyOptions.

◆ FreeLSHardwareKeyOptions()

LS_API void FreeLSHardwareKeyOptions ( LSHardwareKeyOptions options)

Frees the memory associated with an LSHardwareKeyOptions object.

Parameters
optionsPointer to the object created by CreateLSHardwareKeyOptions.

◆ ListAvailableHardwareKeys()

LS_API LSSerialList ListAvailableHardwareKeys ( )

Lists the serial numbers of all connected YubiKeys with PIV support.

Corresponds to the static C++ method HardwareKeyOptions::ListAvailableKeys.

Returns
An LSSerialList structure containing the serial numbers. The caller is responsible for freeing this structure using FreeLSSerialList. Returns a list with count=0 on error or if no keys are found.

◆ CreateLSExtendedOptions()

LS_API LSExtendedOptions * CreateLSExtendedOptions ( )

◆ CreateLSExtendedOptionsByPath()

LS_API LSExtendedOptions * CreateLSExtendedOptionsByPath ( const wchar_t *  licenseFilePath)

◆ CreateLSExtendedOptionsEx()

LS_API LSExtendedOptions * CreateLSExtendedOptionsEx ( const wchar_t *  licenseFilePath,
const char *  hardwareID,
const LSProxySettings proxy 
)

◆ FreeLSExtendedOptions()

LS_API void FreeLSExtendedOptions ( LSExtendedOptions options)