C Requires Chilkat v11.7.0+

Validate a QR Code Request

See more QR Code Examples

Demonstrates the validate operation, which examines a request without producing anything. The scope says how far to look: definition checks the options, capacity also checks that the data fits a QR symbol, and layout also checks the rendered size against the limits. The response has a validationStatus of valid or invalid, a list of checks, and findings[] describing what is wrong. A request that cannot be understood at all, such as one with a misspelled option, still makes the call fail in the usual way. C

#include <C_CkFormats.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkFormats fmt;
    HCkJsonObject jsonOut;
    int i;
    int n;
    HCkJsonObject json;

    success = FALSE;

    //  This example requires the Chilkat API to have been previously unlocked.
    //  See Global Unlock Sample for sample code.

    fmt = CkFormats_Create();
    jsonOut = CkJsonObject_Create();

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"target","symbol");
    CkJsonObject_UpdateString(json,"validation.scope","capacity");
    CkJsonObject_UpdateString(json,"payload.text","https://www.chilkatsoft.com/barcode_overview.asp");

    success = CkFormats_QrCode(fmt,"validate",json,jsonOut);
    if (success == FALSE) {
        printf("%s\n",CkFormats_lastErrorText(fmt));
        CkFormats_Dispose(fmt);
        CkJsonObject_Dispose(jsonOut);
        CkJsonObject_Dispose(json);
        return;
    }

    printf("status: %s\n",CkJsonObject_stringOf(jsonOut,"validationStatus"));
    n = CkJsonObject_SizeOfArray(jsonOut,"checks");
    for (i = 0; i <= n - 1; i++) {
        CkJsonObject_putI(jsonOut,i);
        printf("  %s: %s\n",CkJsonObject_stringOf(jsonOut,"checks[i].name"),CkJsonObject_stringOf(jsonOut,"checks[i].status"));
    }

    //  The same text does not fit version 2 at error-correction level H.
    CkJsonObject_UpdateInt(json,"encoding.qr.maxVersion",2);
    CkJsonObject_UpdateString(json,"encoding.qr.errorCorrection","H");

    success = CkFormats_QrCode(fmt,"validate",json,jsonOut);
    if (success == FALSE) {
        printf("%s\n",CkFormats_lastErrorText(fmt));
        CkFormats_Dispose(fmt);
        CkJsonObject_Dispose(jsonOut);
        CkJsonObject_Dispose(json);
        return;
    }

    printf("status: %s\n",CkJsonObject_stringOf(jsonOut,"validationStatus"));
    n = CkJsonObject_SizeOfArray(jsonOut,"checks");
    for (i = 0; i <= n - 1; i++) {
        CkJsonObject_putI(jsonOut,i);
        printf("  %s: %s\n",CkJsonObject_stringOf(jsonOut,"checks[i].name"),CkJsonObject_stringOf(jsonOut,"checks[i].status"));
    }

    n = CkJsonObject_SizeOfArray(jsonOut,"findings");
    for (i = 0; i <= n - 1; i++) {
        CkJsonObject_putI(jsonOut,i);
        printf("finding: %s at %s\n",CkJsonObject_stringOf(jsonOut,"findings[i].code"),CkJsonObject_stringOf(jsonOut,"findings[i].path"));
        printf("  %s\n",CkJsonObject_stringOf(jsonOut,"findings[i].message"));
    }

    //  Sample output:

    //  status: valid
    //    definition: passed
    //    capacity: passed
    //    layout: notApplicable
    //  status: invalid
    //    definition: passed
    //    capacity: failed
    //    layout: notApplicable
    //  finding: capacityExceeded at /payload
    //    the payload does not fit any admitted QR version at the selected error-correction level


    CkFormats_Dispose(fmt);
    CkJsonObject_Dispose(jsonOut);
    CkJsonObject_Dispose(json);

    }