GW2FileSessionStatus

#include "glasswall.core2.api.h"

int GW2FileSessionStatus(
    Session session,
    int *glasswallSessionStatus,
    char **statusMsgBuffer,
    size_t *statusBufferLength);

पैरामीटर

  session session की ID, जैसा कि GW2OpenSession द्वारा लौटाया गया है

  glasswallSessionStatus An integer output parameter describing the return status of the session as it relates to the last file that was processed. See the Return Types table for an explanation of glasswallSessionStatus.

  statusMsgBuffer एक string pointer output parameter है, जिसे session द्वारा अंतिम processed file पर की गई processing के उच्च-स्तरीय विवरण से भरा जाता है। उदाहरण: "Sanitisation Applied, Remedies Applied"। इस pointer द्वारा उपयोग की गई memory को user द्वारा free करने की आवश्यकता नहीं है।

  statusBufferLength एक output parameter है, जिसे statusMsgBuffer द्वारा point की गई memory के bytes में आकार से भरा जाता है।

रिटर्न

  एक integer लौटाता है जो दर्शाता है कि function call सफल था या नहीं। Negative numbers विफलता को दर्शाते हैं। Return codes की व्याख्या के लिए Return Types तालिका देखें। यदि session invalid है, तो glasswallSessionStatus, statusMsgBuffer और statusBufferLength undefined होंगे।

सारांश

/// <param name="session">Current open Glasswall session</param>
/// <param name="gwSessionStatus">Session status value</param>
/// <param name="outputBuffer">String that describes, at a high level, the processing carried out on the last document </param>
/// <param name="bufferLength">Size of the outputBuffer</param>
public int FileSessionStatus(
    int session,
    out IntPtr gwSessionStatus,
    out IntPtr outputBuffer,
    ref UIntPtr bufferLength)

रिटर्न

यदि session invalid है, तो यह -1 लौटाएगा। यदि session valid है, तो function 0 लौटाता है और gwSessionStatus, outputBuffer तथा bufferLength populate किए जाएंगे।

सारांश

import com.glasswall.core2javabridge.*;

public FileSessionStatus GW2FileSessionStatusResult(int session) throws GlasswallException

नोट

इस functionality के लिए पहले ID data प्राप्त करने हेतु तीन अलग-अलग function calls की आवश्यकता होती थी। अब इसे सरल बनाकर settings को FileSessionStatus object के रूप में लौटाया जाता है। मूल तीनों functions को deprecated कर दिया गया है।

रिटर्न

GW2FileSessionStatusResult function एक FileSessionStatus object लौटाता है, जिसमें session का summary status और session का summary description शामिल होता है।

FileSessionStatus object में दो variables होते हैं जो function call किए जाने के समय session की status का वर्णन करते हैं। ये हैं:

A GlasswallException exception will be thrown if session is invalid, or if the session status information could not be retrieved.

सारांश - अप्रचलित फ़ंक्शन

import com.glasswall.core2javabridge.*;

(Deprecated)
public int GW2FileSessionStatus(int session) throws GlasswallException
public int GetFileSessionStatusInt(int session) throws GlasswallException
public byte[] GetStatusBuffer(int session) throws GlasswallException

विवरण

GW2FileSessionStatus function एक status लौटाता है जो यह दर्शाता है कि session द्वारा निर्दिष्ट session के लिए session status जानकारी प्राप्त की जा सकी या नहीं।

GetFileSessionStatusInt function का उपयोग करके session summary status प्राप्त करें।

GetStatusBuffer function का उपयोग करके session summary status data प्राप्त करें।

रिटर्न्स - अप्रचलित फ़ंक्शन

GW2FileSessionStatus function GW2_RetStatus enumeration को int में convert करके लौटाता है। यदि कोई error हुआ हो तो value negative होगी। 0 success को दर्शाता है। विवरण के लिए API Overview/Return types देखें।

GetStatusBuffer function एक byte array buffer लौटाता है जिसमें दिए गए session के बारे में summary description होती है। यदि GW2FileSessionStatus को call नहीं किया गया है, तो यह null होगा।

GetFileSessionStatusInt function एक status लौटाता है जो किए गए कुल कार्य को दर्शाता है।

A GlasswallException exception will be thrown if session is invalid, or if session status information could not be retrieved.

सारांश

Glasswall session status message प्राप्त करता है। यह किए गए processing का उच्च-स्तरीय संकेत देता है।

def file_session_status_message(self, session: int, raise_unsupported: bool = True) -> str:
    """ Retrieves the Glasswall session status message. Gives a high level indication of the processing that was carried out.

    Args:
        session (int): The session integer.
        raise_unsupported (bool, optional): Default True. Raise exceptions when Glasswall encounters an error. Fail silently if False.

    Returns:
        result.message (str):The file session status message.
    """

रिटर्न

एक string के रूप में file session status message।

सारांश

/**
* This function retrieves the Glasswall Session Status. This status gives a high level indication of the processing
* that was carried out on the last document processed by the library
*/

GW2FileSessionStatus(session,
    glasswallSessionStatus,
    statusMsgBuffer,
    statusBufferLength)

रिटर्न

यदि session अमान्य है, तो यह -1 लौटाएगा और glasswallSessionStatus, statusMsgBuffer तथा statusBufferLength अपरिभाषित होंगे। यदि session मान्य है, तो फ़ंक्शन 0 लौटाता है और glasswallSessionStatus, statusMsgBuffer तथा statusBufferLength भरे जाएंगे।

उदाहरण

function getFileSessionStatus(session_id, gw) {
    /*
        Glasswall API signature:
        int GW2FileSessionStatus(
            Session session,
            int *glasswallSessionStatus,
            char **statusMsgBuffer,
            size_t *statusBufferLength
        );
    */

    // allocate space to store the session status; use .deref() to extract it
    let glasswallSessionStatus = ref.alloc('int');

    let CString_ptr = ref.refType(ref.types.CString);
    let statusMsgBuffer = ref.alloc(CString_ptr);

    // allocate space to store the buffer length; use .deref() to extract it
    let statusBufferLength = ref.alloc('size_t');

    let rv = gw.GW2FileSessionStatus(session_id, glasswallSessionStatus, statusMsgBuffer, statusBufferLength);

    arr_buf = buffer_to_array(statusMsgBuffer, statusBufferLength)
    // console.log(arr_buf.toString());

    let message = `\n  GW2FileSessionStatus:return=${rv}`;
    message += "\n    glasswallSessionStatus = " + glasswallSessionStatus.deref();
    message += "\n    statusMsgBuffer = \"" + arr_buf.toString() + '"';
    message += "\n    statusBufferLength = " + statusBufferLength.deref();

    return message;
}