Interface WinccoaOptions

interface WinccoaOptions {
    langIdx: number;
    langStringFormat: WinccoaLangStringFormat;
    langTextFormat?: WinccoaLangTextFormat;
    longAsBigInt: boolean;
    splitTimeout: number;
    timeFormat: WinccoaTimeFormat;
    userId: number;
}

Properties

langIdx: number

Property that applies only when langStringFormat is StringFixed. It holds the index of the project language to return for LangStrings. Language index starts with 0 and default is 0.

import { WinccoaManager, WinccoaLangStringFormat } from 'winccoa-manager';
const winccoa = new WinccoaManager();

let isSuccess = false;
try {
isSuccess = winccoa.setOptions({
langStringFormat: WinccoaLangStringFormat.StringFixed,
langIdx: 1
});
} catch (exc) {
console.error(exc);
}

if (isSuccess){
try {
let description = winccoa.dpGetDescription('ExampleDP_Rpt1.');
console.info('DP description for 2nd project language: ' + description);
} catch (exc) {
console.error(exc);
}
}
langStringFormat: WinccoaLangStringFormat

Property which defines in which format a WinccoaLangString will be returned from the API. Default is StringActiveLanguage.

let isSuccess = false;
try {
isSuccess = winccoa.setOptions({
langStringFormat: WinccoaLangStringFormat.StringActiveLanguage,
});
} catch (exc) {
console.error(exc);
}

if (isSuccess){
try {
let description = winccoa.dpGetDescription('ExampleDP_Rpt1.');
console.info('DP description for active lang only: ' + description);
} catch (exc) {
console.error(exc);
}
}
langTextFormat?: WinccoaLangTextFormat

Use langStringFormat instead.

longAsBigInt: boolean

Property that indicates whether long and unsigned long Variables should be returned asBigIntornumber. Default is false.

splitTimeout: number

Property which indicates how long to keep a long-running split requests like WinccoaManager.dpQuerySplit active before cancelling it in milliseconds. Default is 60000 (= 1 minute).

timeFormat: WinccoaTimeFormat

Property that defines how a WinccoaTime will be returned from the API. Default is Date.

userId: number

Read only property of the userId with which manager was started.