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 penuding rentetan yang diisikan dengan maklumat tetapan policy. Memori yang digunakan oleh penuding ini tidak perlu dibebaskan oleh pengguna. Sekiranya berlaku kegagalan, parameter ini mungkin ditetapkan kepada nullptr.

  policiesLength Parameter output yang diisikan dengan saiz dalam bait bagi memori yang ditunjuk oleh policiesBuffer

  format Format data. Ini mesti PF_XML.

Pulangan

  Mengembalikan integer yang menunjukkan sama ada panggilan fungsi berjaya. Nombor negatif menunjukkan kegagalan. Lihat jadual Return Types untuk penjelasan tentang kod pulangan.

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)

Pulangan

Mengembalikan nilai enum integer GW2_RetStatus. Nombor negatif menunjukkan kegagalan.

Sinopsis

import com.glasswall.core2javabridge.*;

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

Nota

Fungsi GW2GetPolicySettingsString mengeluarkan tetapan policy yang sedang didaftarkan untuk sesi yang ditentukan oleh session.

Rujuk API Overview/Return types untuk enumerator yang sah bagi format.

Fungsi ini sebelum ini memerlukan dua panggilan fungsi berasingan untuk mendapatkan data tetapan policy. Kini ia telah dipermudahkan untuk mengembalikan tetapan sebagai String. Dua fungsi asal telah ditandakan sebagai deprecated.

Pulangan

Fungsi GW2GetPolicySettingsString mengembalikan String yang mengandungi tetapan policy.

Pengecualian GlasswallException akan dibaling jika session tidak sah, atau jika tetapan policy tidak dapat diperoleh.

Sinopsis - Fungsi Ditamatkan

import com.glasswall.core2javabridge.*;

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

Penerangan - Fungsi Ditamatkan Penggunaan

Fungsi GW2GetPolicySettings mengeluarkan tetapan policy yang sedang didaftarkan untuk sesi yang ditentukan oleh session ke penimbal policy dalaman. Dapatkan data ini melalui penggunaan fungsi GetPolicyBuffer.

Rujuk API Overview/Return types untuk enumerator yang sah bagi format.

Pulangan - Fungsi Ditamatkan

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

GetPolicyBuffer mengembalikan byte[] yang mengandungi tetapan policy. Ini akan menjadi null jika GW2GetPolicySettings belum dipanggil.

Pengecualian GlasswallException akan dibaling jika session tidak sah, atau jika tetapan policy tidak dapat diperoleh.

Sinopsis

Mengembalikan konfigurasi pengurusan kandungan 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.
    """

Pulangan

xml_string (str): Rentetan XML bagi konfigurasi pengurusan kandungan semasa

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)

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

...