GW2FileSessionStatus

#include "glasswall.core2.api.h"

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

Mga Parameter

  session Ang ID ng session gaya ng ibinalik ng GW2OpenSession

  glasswallSessionStatus Isang integer output parameter na naglalarawan sa return status ng session kaugnay ng huling file na naproseso. Tingnan ang talahanayang Return Types para sa paliwanag ng glasswallSessionStatus.

  statusMsgBuffer Isang string pointer output parameter na pinupunan ng mataas na antas na paglalarawan ng pagproseso na isinagawa sa huling file na naproseso ng session. Hal. "Sanitisation Applied, Remedies Applied". Ang memory na ginagamit ng pointer na ito ay hindi kailangang i-free ng user.

  statusBufferLength Isang output parameter na pinupunan ng laki sa bytes ng memory na tinutukoy ng statusMsgBuffer.

Ibinabalik

  Nagbabalik ng integer na nagsasaad kung matagumpay ang function call. Ang mga negatibong numero ay nagsasaad ng pagkabigo. Tingnan ang talahanayang Return Types para sa paliwanag ng mga return code. Kung hindi wasto ang session, ang glasswallSessionStatus, statusMsgBuffer at statusBufferLength ay hindi matutukoy.

Buod

/// <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)

Ibinabalik

Kung hindi wasto ang session, magbabalik ito ng -1. Kung wasto ang session, magbabalik ang function ng 0 at mapupunan ang gwSessionStatus, outputBuffer at bufferLength.

Buod

import com.glasswall.core2javabridge.*;

public FileSessionStatus GW2FileSessionStatusResult(int session) throws GlasswallException

Tandaan

Dati, ang functionality na ito ay nangangailangan ng tatlong magkakahiwalay na function call upang makuha ang ID data. Na-streamline na ito ngayon upang ibalik ang mga setting bilang isang FileSessionStatus object. Ang tatlong orihinal na function ay deprecated na.

Ibinabalik

Ang function na GW2FileSessionStatusResult ay nagbabalik ng isang FileSessionStatus object na naglalaman ng buod na status ng session, at ng buod na paglalarawan ng session.

Ang FileSessionStatus object ay naglalaman ng dalawang variable na naglalarawan sa status ng session sa oras na tawagin ang function. Ang mga ito ay:

Maghahagis ng exception na GlasswallException kung hindi wasto ang session, o kung hindi makuha ang impormasyon ng status ng session.

Buod - Mga Hindi na Inirerekomendang Function

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

Paglalarawan

Ang function na GW2FileSessionStatus ay nagbabalik ng status na nagsasaad kung nakuha ang impormasyon ng status ng session para sa session na tinukoy ng session.

Kunin ang buod na status ng session sa pamamagitan ng paggamit ng function na GetFileSessionStatusInt.

Kunin ang datos ng buod na status ng session sa pamamagitan ng paggamit ng function na GetStatusBuffer.

Mga Return - Mga Hindi na Inirerekomendang Function

Ang function na GW2FileSessionStatus ay nagbabalik ng enumeration na GW2_RetStatus na na-convert sa int. Magiging negatibo ang value kung may naganap na error. Ang 0 ay nagsasaad ng tagumpay. Tingnan ang API Overview/Return types para sa mga detalye.

Ang function na GetStatusBuffer ay nagbabalik ng byte array buffer na naglalaman ng buod na paglalarawan tungkol sa ibinigay na session. Ito ay magiging null kung hindi pa natawag ang GW2FileSessionStatus.

Ang function na GetFileSessionStatusInt ay nagbabalik ng status na nagsasaad ng kabuuang gawaing isinagawa.

Maghahagis ng exception na GlasswallException kung hindi wasto ang session, o kung hindi makuha ang impormasyon ng status ng session.

Buod

Kinukuha ang mensahe ng status ng session ng Glasswall. Nagbibigay ito ng mataas na antas na indikasyon ng pagproseso na isinagawa.

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.
    """

Ibinabalik

Isang mensahe ng status ng file session bilang isang string.

Buod

/**
* 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)

Ibinabalik

Kung hindi wasto ang session, magbabalik ito ng -1 at ang glasswallSessionStatus, statusMsgBuffer at statusBufferLength ay magiging undefined. Kung wasto ang session, magbabalik ang function ng 0 at ang glasswallSessionStatus, statusMsgBuffer at statusBufferLength ay mapupunan.

Halimbawa

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;
}