Interface WinccoaOptions

interface WinccoaOptions {
    langIdx: number;
    langTextFormat: WinccoaLangTextFormat;
    longAsBigInt: boolean;
    userId: number;
}

Properties

langIdx: number

Property which applies only when langTextFormat is StringFixed. It holds the index of the project language to return for LangTexts. Language index starts with 0 and default is 0.

See

Example

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

let isSuccess = false;
try {
isSuccess = winccoa.setOptions({
langTextFormat: WinccoaLangTextFormat.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);
}
}
langTextFormat: WinccoaLangTextFormat

Property which defines to which format a LangText will be converted. Default is StringActiveLanguage.

See

Example

let isSuccess = false;
try {
isSuccess = winccoa.setOptions({
langTextFormat: WinccoaLangTextFormat.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);
}
}
longAsBigInt: boolean

Property which indicates whether long and unsigned long Variables should be returned as BigInts or numbers. Default is false.

userId: number

Read only property of the userId with which manager was started