GW2GetPolicySettings

#include "glasswall.core2.api.h"

int GW2GetPolicySettings (
    Session session,
    char **policiesBuffer,
    size_t *policiesLength,
    Policy_format format);

Parameter

  session ID sesi seperti yang dikembalikan oleh GW2OpenSession

  policiesBuffer Parameter output pointer string yang diisi dengan informasi pengaturan policy. Memori yang digunakan oleh pointer ini tidak perlu dibebaskan oleh pengguna. Jika terjadi kegagalan, parameter ini dapat diatur ke nullptr.

  policiesLength Parameter output yang diisi dengan ukuran dalam byte dari memori yang ditunjuk oleh policiesBuffer

  format Format data. Ini harus berupa PF_XML.

Hasil pengembalian

  Mengembalikan bilangan bulat yang menunjukkan apakah pemanggilan fungsi berhasil. Angka negatif menunjukkan kegagalan. Lihat tabel Return Types untuk penjelasan kode pengembalian.

Sinopsis

/// <summary>
/// Retrieves policy settings for the session
/// </summary>
/// <param name="session">Current open Glasswall session</param>
/// <param name="policiesBufferPtr">A pointer to the object containing a pointer pointing to the policy data</param>
/// <param name="policiesLengthPtr">A pointer to a object containing the size in bytes </param>
public  int GetPolicySettings(
    int session,
    out IntPtr policiesBufferPtr,
    ref UIntPtr policiesLengthPtr,
    int format)

Hasil pengembalian

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

Sinopsis

import com.glasswall.core2javabridge.*;

public String GW2GetPolicySettingsString(int session, int format) throws GlasswallException

Catatan

Fungsi GW2GetPolicySettingsString menghasilkan pengaturan policy yang saat ini terdaftar untuk sesi yang ditentukan oleh session.

Lihat API Overview/Return types untuk enumerator yang valid bagi format.

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

Hasil pengembalian

Fungsi GW2GetPolicySettingsString mengembalikan String yang berisi pengaturan policy.

Exception GlasswallException akan dilempar jika session tidak valid, atau jika pengaturan policy tidak dapat diambil.

Sinopsis - Fungsi yang Tidak Digunakan Lagi

import com.glasswall.core2javabridge.*;

(Deprecated)
public int GW2GetPolicySettings(int session, int format) throws GlasswallException
public byte[] GetPolicyBuffer(int session) throws GlasswallException

Deskripsi - Fungsi Deprecated

Fungsi GW2GetPolicySettings menghasilkan pengaturan policy yang saat ini terdaftar untuk sesi yang ditentukan oleh session ke buffer policy internal. Ambil data ini melalui penggunaan fungsi GetPolicyBuffer.

Lihat API Overview/Return types untuk enumerator yang valid bagi format.

Nilai yang Dikembalikan - Fungsi yang Tidak Digunakan Lagi

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

GetPolicyBuffer mengembalikan byte[] yang berisi pengaturan policy. Nilainya akan null jika GW2GetPolicySettings belum dipanggil.

Exception GlasswallException akan dilempar jika session tidak valid, atau jika pengaturan policy tidak dapat diambil.

Sinopsis

Mengembalikan konfigurasi manajemen konten untuk sesi tertentu.

def get_content_management_policy(self, session: int):
    """ Returns the content management configuration for a given session.

    Args:
        session (int): The session integer.

    Returns:
        xml_string (str): The XML string of the current content management configuration.
    """

Hasil pengembalian

xml_string (str): String XML dari konfigurasi manajemen konten saat ini

Sinopsis

/**
 * This function returns the policy settings used for the specified session
 *
 * @param {number} session The ID of the session.
 * @param {string} policiesBuffer The pointer to the policy buffer.
 * @param {number} policiesLength The size of the data in the policy buffer
 * @param {number} format The format of the policy.
 */

GW2GetPolicySettings(
    session,
    policiesBuffer,
    policiesLength,
    format)

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 policy_file_buffer = ref.alloc(ref.refType(ref.types.CString));
let policy_buffer_size = ref.alloc(ref.types.size_t, 0);

let return_status = gw.GW2GetPolicySettings(session_id, policy_file_buffer, policy_buffer_size, 0);
let xml_string = buffer_to_string(policy_file_buffer, policy_buffer_size);

...