GW2GetAllIdInfo

Sinopsis

Bagi session session, fungsi GW2GetAllIdInfo meletakkan ke dalam objek yang ditunjukkan oleh outputBuffer satu penuding kepada data XML yang diisikan dengan perihalan Glasswall Issue ID dan julat nilai. Panjang, dalam bait, bagi penimbal output yang diisikan diletakkan dalam objek size_t yang ditunjukkan oleh bufferLength.

#include "glasswall.core2.api.h"

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

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan. Jika berjaya, penimbal output mengandungi fail 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)

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan. Jika berjaya, penimbal output mengandungi fail 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

Nota

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 GW2GetAllIdInfoString mengembalikan String yang mengandungi penerangan bagi semua Glasswall ID.

Pengecualian GlasswallException akan dilemparkan jika session tidak sah, atau jika semua maklumat ID tidak dapat diperoleh.

Sinopsis - Fungsi Ditamatkan

import com.glasswall.core2javabridge.*;

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

Penerangan - Fungsi Ditamatkan Penggunaan

Fungsi GW2GetAllIdInfo mengeluarkan penerangan semua Glasswall ID bagi sesi yang ditentukan oleh session ke All ID Buffer dalaman. Dapatkan data ini melalui penggunaan fungsi GetAllIDBuffer.

Pulangan - Fungsi Ditamatkan

Fungsi GW2GetAllIdInfo 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.

GetAllIDBuffer mengembalikan tatasusunan bait yang mengandungi penerangan Glasswall ID. Ini akan menjadi null jika GW2GetAllIdInfo belum dipanggil.

Pengecualian GlasswallException akan dilemparkan jika session tidak sah, atau jika semua maklumat ID tidak dapat diperoleh.

Sinopsis

Mendapatkan XML yang mengandungi semua julat Issue ID bersama penerangan kumpulannya.

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

Pulangan

Laporan analisis XML rentetan yang mengandungi semua maklumat 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)

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor 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);

...