Rate This Document
Findability
Accuracy
Completeness
Readability

GetProductVersion

Obtain the KVSIP product information, including the software name and version.

The function interface declaration is as follows:

KvsipResult KVSIP_GetProductVersion(KvsipProVersion *packageInfo);

Return Value

  • Success: KVSIP_STS_NO_ERR is returned.
  • Failure: An error code is returned.

Error Codes

Error Code

Description

KVSIP_STS_NULL_PTR_ERR

The KvsipProVersion pointer is null.

Example

#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include "kvsip.h"
#include "vsip.h"
#include "vsip_type.h"

void GetProductVersionExample()
{
    KvsipProVersion versionGet;
    KvsipResult result = KVSIP_GetProductVersion(&versionGet);
    KvsipProVersion *version = &versionGet;
    if (result == KVSIP_STS_NO_ERR) {
        printf("%s\n", version->componentName);
        printf("%s\n", version->packageVersion);
    }
}

int main(void) {
    GetProductVersionExample();
    return 0;
}

Output:

Component Name: BoostKit-kvsip
Component Version: 1.7.0