GW2GetIdInfo

Sinopsis

Bagi sesi session , GW2GetIdInfo meletakkan dalam objek yang ditunjukkan oleh outputBuffer , penuding kepada penerangan bagi Glasswall Issue ID issueId. Panjang penerangan tersebut, dalam bait, diletakkan dalam objek size_t yang ditunjukkan oleh bufferLength.

#include "glasswall.core2.api.h"

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

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan. Jika berjaya, penimbal output diisi dengan Penerangan Isu.

Contoh

#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 */
}

Sinopsis

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

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan. Jika berjaya, penimbal output diisi dengan Penerangan Isu.

Contoh

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
}

Sinopsis

import com.glasswall.core2javabridge.*;

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

Penerangan

Fungsi ini sebelum ini memerlukan dua panggilan fungsi berasingan untuk mendapatkan data ID. Kini ia telah dipermudahkan untuk mengembalikan tetapan sebagai String. Dua fungsi asal telah ditamatkan penggunaan.

Pulangan

Fungsi GW2GetIdInfoString mengembalikan String yang mengandungi penerangan bagi issueId yang diberikan

Pengecualian GlasswallException akan dibaling jika session tidak sah, atau jika penerangan issueId tidak dapat diperoleh.

Sinopsis - Fungsi Ditamatkan

import com.glasswall.core2javabridge.*;

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

Penerangan - Fungsi Ditamatkan Penggunaan

Fungsi GW2GetIdInfo mengeluarkan penerangan bagi issueId yang diberikan untuk session tertentu ke ID Buffer dalaman. Dapatkan data ini melalui penggunaan fungsi GetIDBuffer.

Pulangan - Fungsi Ditamatkan

Fungsi GW2GetIdInfo mengembalikan enumerasi GW2_RetStatus yang ditukarkan kepada int. Nilainya akan negatif jika ralat berlaku. 0 menunjukkan kejayaan. Rujuk API Overview/Return types untuk butiran lanjut.

GetIDBuffer mengembalikan byte[] yang mengandungi penerangan ID. Ini akan menjadi null jika GetIDBuffer belum dipanggil.

Pengecualian GlasswallException akan dibaling jika session tidak sah, atau jika penerangan isu tidak dapat diperoleh.

Sinopsis

Mendapatkan semula perihalan kumpulan untuk Issue ID yang diberikan.

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

Pulangan

Satu rentetan, perihalan kumpulan untuk Issue ID yang diberikan.

Sinopsis

Fungsi ini meletakkan penuding kepada perihalan bagi IssueID yang ditentukan di lokasi yang ditentukan.

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

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan. Jika berjaya, penimbal output diisi dengan Penerangan Isu.

Contoh

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

...