Wasabi ExpressPlay SDK for Desktop Systems  1.23.0
Typedefs | Functions
WSB_License Class

Marlin Broadband license object. More...

Typedefs

typedef struct WSB_License WSB_License
 A WSB_License object represents information about a license. More...
 

Functions

WSB_EXPORT WSB_UInt32 WSB_License_GetId (const WSB_License *license)
 Gets the license ID for a specified license. More...
 
WSB_EXPORT WSB_ByteArray WSB_License_GetData (const WSB_License *license)
 Gets the license data (the bytes representing the license) for a specified license. More...
 
WSB_EXPORT WSB_Int32 WSB_License_GetExpirationDate (const WSB_License *license)
 Gets the license expiration date for a specified license. More...
 
WSB_EXPORT WSB_Int32 WSB_License_GetPriority (const WSB_License *license)
 Gets the license priority for a specified license. More...
 
WSB_EXPORT WSB_Int32 WSB_License_GetInsertionDate (const WSB_License *license)
 Gets the license insertion date (the date it was inserted into the License Store) for a specified license. More...
 
WSB_EXPORT const char * WSB_License_GetTag (const WSB_License *license)
 Gets the license tag for a specified license. More...
 

Detailed Description

Marlin Broadband license object.

Typedef Documentation

◆ WSB_License

typedef struct WSB_License WSB_License

A WSB_License object represents information about a license.

Function Documentation

◆ WSB_License_GetData()

WSB_EXPORT WSB_ByteArray WSB_License_GetData ( const WSB_License license)

Gets the license data (the bytes representing the license) for a specified license.

Parameters
licenseThe WSB_License representing the license whose license data will be returned.
Returns
A WSB_ByteArray object containing the license data, or a WSB_ByteArray with a NULL value for the data field and 0 for the data_size field if the WSB_License does not include license data (for example, if the WSB_License was obtained by calling WSB_LicenseStore_EnumerateLicenses but the flag for including the license data was not set in that call).

◆ WSB_License_GetExpirationDate()

WSB_EXPORT WSB_Int32 WSB_License_GetExpirationDate ( const WSB_License license)

Gets the license expiration date for a specified license.

Parameters
licenseThe WSB_License representing the license whose license expiration date will be returned.
Returns
The value of the attribute "urn:marlin:core:node:attribute:expiration-date" embedded inside the "Control" tag of the license, or -1 if the WSB_License does not include expiration date data. The value is represented as the number of UTC (Coordinated Universal Time) minutes since 1970-01-01.

◆ WSB_License_GetId()

WSB_EXPORT WSB_UInt32 WSB_License_GetId ( const WSB_License license)

Gets the license ID for a specified license.

The license ID is the ID that was assigned by the License Store when the license was added.

Parameters
licenseThe WSB_License representing the license whose ID will be returned.
Returns
The license ID.

◆ WSB_License_GetInsertionDate()

WSB_EXPORT WSB_Int32 WSB_License_GetInsertionDate ( const WSB_License license)

Gets the license insertion date (the date it was inserted into the License Store) for a specified license.

Parameters
licenseThe WSB_License representing the license whose license insertion date will be returned.
Returns
The time when the license was added into the License Store. It is represented as the number of UTC (Coordinated Universal Time) minutes since 1970-01-01. This method returns -1 if the WSB_License does not include insertion date data.

◆ WSB_License_GetPriority()

WSB_EXPORT WSB_Int32 WSB_License_GetPriority ( const WSB_License license)

Gets the license priority for a specified license.

Currently the license priority is not used.

Parameters
licenseThe WSB_License representing the license whose license priority will be returned.
Returns
Always returns -1 for now.

◆ WSB_License_GetTag()

WSB_EXPORT const char* WSB_License_GetTag ( const WSB_License license)

Gets the license tag for a specified license.

The tag is a text string that was specified when the license was added to the License Store. As an example, it could be something like "myApp inserted this license".

Parameters
licenseThe WSB_License representing the license whose license tag will be returned.
Returns
A pointer to a NULL-terminated string containing the tag, or NULL if the WSB_License does not include a tag.