GW2GetAllIdInfo

Sinopsis

Untuk session session, fungsi GW2GetAllIdInfo menempatkan pointer ke data XML yang diisi dengan deskripsi Glasswall Issue ID dan rentang nilai ke dalam objek yang ditunjuk oleh outputBuffer. Panjang buffer output yang terisi, dalam byte, ditempatkan dalam objek size_t yang ditunjuk oleh bufferLength.

#include "glasswall.core2.api.h"

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

Hasil pengembalian

Mengembalikan nilai enum integer GW2_RetStatus. Angka negatif menunjukkan kegagalan. Jika berhasil, buffer output berisi file XML.

Contoh

#include "glasswall.core2.api.h"

...

char *outbuf = NULL;
size_t buflen = 0;

if (GW2OpenSession())
    /* error opening session*/
else
{
    int status = GW2GetAllIdInfo(session, &buflen, &outbuf);
    /* Buffer contains the XML file.
    * Either process the data pointed to, or copy the data and process it
    * after the session is closed
    */

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

Sinopsis

public int GetAllIdInfo(
    int session,
    ref UIntPtr bufferLength,
    out IntPtr outputBuffer)

Hasil pengembalian

Mengembalikan nilai enum integer GW2_RetStatus. Angka negatif menunjukkan kegagalan. Jika berhasil, buffer output berisi file XML.

Contoh

...

UIntPtr bufferLength = UIntPtr.Zero;
IntPtr buffer        = new IntPtr();

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

using (StreamWriter writer = new StreamWriter(fileStream))
{
    writer.WriteLine($"GW2GetAllIdInfo completed with status code {returnStatus}");

    if ((int)bufferLength != 0)
    {
        WriteBytesToFile(Path.Combine(di.FullName, $"22 - GW2GetAllIdInfo.xml"),
            glasswall.CreateArrayFromBuffer(buffer, bufferLength)
        );
    }
}

import com.glasswall.core2javabridge.*;

public String GW2GetAllIdInfoString(int session) throws GlasswallException

Catatan

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 GW2GetAllIdInfoString mengembalikan String yang berisi deskripsi semua Glasswall ID.

Pengecualian GlasswallException akan dilempar jika session tidak valid, atau jika semua informasi ID tidak dapat diambil.

Sinopsis - Fungsi yang Tidak Digunakan Lagi

import com.glasswall.core2javabridge.*;

(Deprecated)
public int GW2GetAllIdInfo(int session) throws GlasswallException
public byte[] GetAllIDBuffer(int session) throws GlasswallException

Deskripsi - Fungsi Deprecated

Fungsi GW2GetAllIdInfo mengeluarkan deskripsi semua Glasswall ID untuk sesi yang ditentukan oleh session ke All ID Buffer internal. Ambil data ini melalui penggunaan fungsi GetAllIDBuffer.

Nilai yang Dikembalikan - Fungsi yang Tidak Digunakan Lagi

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

GetAllIDBuffer mengembalikan array byte yang berisi deskripsi Glasswall ID. Nilainya akan null jika GW2GetAllIdInfo belum dipanggil.

Pengecualian GlasswallException akan dilempar jika session tidak valid, atau jika semua informasi ID tidak dapat diambil.

Sinopsis

Mengambil XML yang berisi semua rentang Issue ID beserta deskripsi grupnya.

def get_all_id_info(self, output_file: Optional[str] = None, raise_unsupported: bool = True) -> str:
    """ Retrieves the XML containing all the Issue ID ranges with their group descriptions

    Args:
        output_file (Optional[str], optional): The output file path where the analysis file will be written.
        raise_unsupported (bool, optional): Default True. Raise exceptions when Glasswall encounters an error. Fail silently if False.

    Returns:
        all_id_info (str): A string XML analysis report containing all id info.
    """

Hasil pengembalian

Laporan analisis XML string yang berisi semua info id.

Sinopsis

/**
* This function places a pointer in a specified location to XML data populated with
* Glasswall Issue ID descriptions and value ranges, for a specified session.
*
* @param {number} session The ID of the session.
* @param {number} bufferLength The length of the buffer.
* @param {string} outputBuffer The location of the output buffer.
*/
GW2GetAllIdInfo(
    session,
    bufferLength,
    outputBuffer)

Hasil pengembalian

Mengembalikan nilai enum GW2_RetStatus berupa integer. Angka negatif menunjukkan kegagalan.

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

...

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

let xml_string = buffer_to_string(output_file_buffer, output_buffer_size);

...