GW2GetIdInfo

Sinopsis

Untuk sesi session, GW2GetIdInfo menempatkan, di objek yang ditunjuk oleh outputBuffer, sebuah pointer ke deskripsi Glasswall Issue ID issueId. Panjang deskripsi, dalam byte, ditempatkan di objek size_t yang ditunjuk oleh bufferLength.

#include "glasswall.core2.api.h"

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

Hasil pengembalian

Mengembalikan nilai enum integer GW2_RetStatus. Angka negatif menunjukkan kegagalan. Jika berhasil, buffer output akan diisi dengan Deskripsi Issue.

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)

Hasil pengembalian

Mengembalikan nilai enum integer GW2_RetStatus. Angka negatif menunjukkan kegagalan. Jika berhasil, buffer output akan diisi dengan Deskripsi Issue.

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

Deskripsi

Fungsionalitas ini sebelumnya memerlukan dua pemanggilan fungsi terpisah untuk mengambil data ID. Kini hal ini telah disederhanakan untuk mengembalikan pengaturan sebagai String. Dua fungsi asli tersebut telah ditandai deprecated.

Hasil pengembalian

Fungsi GW2GetIdInfoString mengembalikan String yang berisi deskripsi dari issueId yang diberikan

Pengecualian GlasswallException akan dilempar jika session tidak valid, atau jika deskripsi issueId tidak dapat diambil.

Sinopsis - Fungsi yang Tidak Digunakan Lagi

import com.glasswall.core2javabridge.*;

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

Deskripsi - Fungsi Deprecated

Fungsi GW2GetIdInfo mengeluarkan deskripsi dari issueId tertentu untuk session tertentu ke ID Buffer internal. Ambil data ini melalui penggunaan fungsi GetIDBuffer.

Nilai yang Dikembalikan - Fungsi yang Tidak Digunakan Lagi

Fungsi GW2GetIdInfo mengembalikan enumerasi GW2_RetStatus yang dikonversi menjadi int. Nilainya akan negatif jika terjadi kesalahan. 0 menunjukkan keberhasilan. Lihat API Overview/Return types untuk detail.

GetIDBuffer mengembalikan byte[] yang berisi deskripsi ID. Nilainya akan null jika GetIDBuffer belum dipanggil.

Pengecualian GlasswallException akan dilempar jika session tidak valid, atau jika deskripsi issue tidak dapat diambil.

Sinopsis

Mengambil deskripsi grup 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.
    """

Hasil pengembalian

Sebuah string, yaitu deskripsi grup untuk Issue ID yang diberikan.

Sinopsis

Fungsi ini menempatkan pointer ke deskripsi dari 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)

Hasil pengembalian

Mengembalikan nilai enum integer GW2_RetStatus. Angka negatif menunjukkan kegagalan. Jika berhasil, buffer output akan diisi dengan Deskripsi Issue.

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

...