GW2GetIdInfo

Buod

Para sa session na session, inilalagay ng GW2GetIdInfo sa object na tinutukoy ng outputBuffer ang isang pointer sa paglalarawan ng Glasswall Issue ID na issueId. Ang haba ng paglalarawan, sa bytes, ay inilalagay sa size_t object na tinutukoy ng bufferLength.

#include "glasswall.core2.api.h"

int GW2GetIdInfo(
    Session session,
    size_t issueId,
    size_t *bufferLength,
    char **outputBuffer);

Ibinabalik

Nagbabalik ng integer na GW2_RetStatus enum value. Ang mga negatibong numero ay nagpapahiwatig ng pagkabigo. Kapag matagumpay, ang output buffer ay pinupunan ng Issue Description.

Halimbawa

#include "glasswall.core2.api.h"

char *outbuf = NULL;
size_t buflen = 0;

if (GW2OpenSession() < 0)
    /* error opening session */
else
{
    int status = GW2GetIdInfo(session, issueId, &buflen, &outbuf);

    /* outbuf points to a buffer containing the XML file.
     * Either process the data pointed to, or copy the data and process it
     * after GW2CloseSession is called
     */

    if (GW2CloseSession() < 0)
        /* error closing session */
}

Buod

public int GetIdInfo(
    int session,
    uint IssueID,
    ref UIntPtr bufferLength,
    out IntPtr outputBuffer)

Ibinabalik

Nagbabalik ng integer na GW2_RetStatus enum value. Ang mga negatibong numero ay nagpapahiwatig ng pagkabigo. Kapag matagumpay, ang output buffer ay pinupunan ng Issue Description.

Halimbawa

using glasswall_core2;

...

Glasswall glasswall = new Glasswall(); // Instance of the Glasswall wrapper

int session      = glasswall.OpenSession();
int returnStatus = glasswall.GetIdInfo(session, 96, ref bufferLength, out buffer);

if (bufferLength >= 0)
{
    byte[] msgArray = glasswall.CreateArrayFromBuffer(buffer, bufferLength);
    // Error description for issue ID 96 now stored in a byte array
}

if (glasswall.CloseSession(session))
{
    // Error Handling
}

Buod

import com.glasswall.core2javabridge.*;

public String GW2GetIdInfoString(int session, int issueId) throws GlasswallException

Paglalarawan

Ang functionality na ito ay dati nang nangangailangan ng dalawang magkahiwalay na function call upang makuha ang ID data. Na-streamline na ito ngayon upang ibalik ang mga setting bilang isang String. Ang dalawang orihinal na function ay deprecated na.

Ibinabalik

Ang function na GW2GetIdInfoString ay nagbabalik ng isang String na naglalaman ng paglalarawan ng ibinigay na issueId

Isang exception na GlasswallException ang ihahagis kung hindi wasto ang session, o kung hindi makuha ang paglalarawan ng issueId.

Buod - Mga Hindi na Inirerekomendang Function

import com.glasswall.core2javabridge.*;

(Deprecated)
public int GW2GetIdInfo(int session, int issueId) throws GlasswallException
public byte[] GetIDBuffer(int session) throws GlasswallException

Paglalarawan - Mga Deprecated na Function

Ang function na GW2GetIdInfo ay naglalabas ng paglalarawan ng ibinigay na issueId para sa ibinigay na session sa internal ID Buffer. Kunin ang datos na ito sa pamamagitan ng paggamit ng function na GetIDBuffer.

Mga Return - Mga Hindi na Inirerekomendang Function

Ang function na GW2GetIdInfo ay nagbabalik ng isang GW2_RetStatus enumeration na kino-convert sa int. Magiging negatibo ang value kung may naganap na error. Ang 0 ay nagpapahiwatig ng tagumpay. Sumangguni sa API Overview/Return types para sa mga detalye.

Ang GetIDBuffer ay nagbabalik ng isang byte[] na naglalaman ng ID description. Ito ay magiging null kung hindi pa natawag ang GetIDBuffer.

Isang exception na GlasswallException ang ihahagis kung hindi wasto ang session, o kung hindi makuha ang paglalarawan ng issue.

Buod

Kinukuha ang paglalarawan ng grupo para sa ibinigay na Issue ID.

def get_id_info(self, issue_id: int, raise_unsupported: bool = True):
    """ Retrieves the group description for the given Issue ID. e.g. issue_id 96 returns "Document Processing Instances"

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

    Returns:
        id_info (str): The group description for the given Issue ID.
    """

Ibinabalik

Isang string, ang paglalarawan ng grupo para sa ibinigay na Issue ID.

Buod

Ang function na ito ay naglalagay ng pointer sa isang paglalarawan ng tinukoy na IssueID sa isang tinukoy na lokasyon.

/**
*
* @param {number} session The ID of the session.
* @param {number} issueId The ID of the issue.
* @param {number} bufferLength The length of the buffer.
* @param {string} outputBuffer The location of the output buffer.
*/

GW2GetIdInfo(
    session,
    issueId,
    bufferLength,
    outputBuffer)

Ibinabalik

Nagbabalik ng integer na GW2_RetStatus enum value. Ang mga negatibong numero ay nagpapahiwatig ng pagkabigo. Kapag matagumpay, ang output buffer ay pinupunan ng Issue Description.

Halimbawa

const ref = require('ref-napi');

...

function buffer_to_string(buffer, buffer_size) {

    if (!buffer.isNull() && ref.deref(buffer_size) > 0) {
        return Buffer.from(ref.reinterpret(ref.deref(buffer), ref.deref(buffer_size), 0)).toString();
    }
    else {
        return "";
    }
}

...

output_file_buffer = ref.alloc(ref.refType(ref.types.CString));
output_buffer_size = ref.alloc(ref.types.size_t, 0);
return_status      = gw.GW2GetIdInfo(session_id, 96, output_buffer_size, output_file_buffer);

let error_description = buffer_to_string(output_file_buffer, output_buffer_size);

...