dde.js

"use strict";
/***************************************************
* Licensed Materials - Property of HCL.
* (c)Copyright HCL America, Inc. 2023-2024
****************************************************/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ddeTerminate = exports.ddePoke = exports.ddeInitiate = exports.ddeExecute = exports._notes = void 0;
const tslib_1 = require("tslib");
/**
 * @file dde
 * @module DDE (Dynamic Data Exchange)
 * @category DDE
 */
const notesf_base = tslib_1.__importStar(require("../notes/dde"));
const notesf = () => notesf_base;
exports._notes = notesf_base;
//-----------------------------
// Notes @functions DDE
/**
 * Passes the specified command string to the DDE application, which is identified
 * by the conversation ID. @DDEExecute is always used in conjunction with
 * @DDEInitiate and @DDETerminate.
 * @throws {Error} no plans to implement
 */
function ddeExecute() {
    return notesf().DDEExecute();
}
exports.ddeExecute = ddeExecute;
/**
 * Initiates a conversation with a DDE server, and returns the conversation ID.
 * @throws {Error} no plans to implement
 */
function ddeInitiate() {
    return notesf().DDEInitiate();
}
exports.ddeInitiate = ddeInitiate;
/**
 * Deposits unsolicited data into the specified location within the DDE server
 * application. If the data was successfully inserted into the target location,
 * @DDEPoke returns an ACK (acknowledgement) with the value @True(1); if the
 * attempt was not successful, the call returns a NACK (negative acknowledgment)
 * with the value @False(0). If the conversation ID is invalid, an error is
 * returned (see @IsError).
 * @throws {Error} no plans to implement
 */
function ddePoke() {
    return notesf().DDEPoke();
}
exports.ddePoke = ddePoke;
/**
 * Terminates the conversation with a DDE application.
 * @throws {Error} no plans to implement
 */
function ddeTerminate() {
    return notesf().DDETerminate();
}
exports.ddeTerminate = ddeTerminate;
//# sourceMappingURL=dde.js.map