GW2GetIdInfo

概要

セッション session に対して、GW2GetIdInfo は outputBuffer が指すオブジェクト内に、Glasswall Issue ID issueId の説明へのポインタを格納します。説明の長さ（バイト単位）は、bufferLength が指す size_t オブジェクトに格納されます。

#include "glasswall.core2.api.h"

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

戻り値

整数の GW2_RetStatus 列挙値を返します。負の数は失敗を示します。成功した場合、出力バッファーには Issue Description が格納されます。

例

#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 */
}

概要

public int GetIdInfo(
    int session,
    uint IssueID,
    ref UIntPtr bufferLength,
    out IntPtr outputBuffer)

戻り値

整数の GW2_RetStatus 列挙値を返します。負の数は失敗を示します。成功した場合、出力バッファーには Issue Description が格納されます。

例

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
}

概要

import com.glasswall.core2javabridge.*;

public String GW2GetIdInfoString(int session, int issueId) throws GlasswallException

説明

この機能では以前、ID データを取得するために 2 つの別個の関数呼び出しが必要でした。現在は合理化され、設定を String として返すようになりました。元の 2 つの関数は非推奨になりました。

戻り値

The GW2GetIdInfoString function returns a String containing a description of the given issueId

GlasswallException 例外は、session が無効である場合、または issueId の説明を取得できなかった場合にスローされます。

概要 - 非推奨関数

import com.glasswall.core2javabridge.*;

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

説明 - 非推奨の関数

The GW2GetIdInfo function outputs the description of a given issueId for a given session to the internal ID Buffer. Retrieve this data through use of GetIDBuffer function.

戻り値 - 非推奨関数

GW2GetIdInfo 関数は、GW2_RetStatus 列挙型を int に変換して返します。エラーが発生した場合、値は負になります。0 は成功を示します。詳細については、API Overview/Return types を参照してください。

GetIDBuffer は、ID の説明を含む byte[] を返します。GetIDBuffer が呼び出されていない場合、これは null になります。

GlasswallException 例外は、session が無効である場合、または問題の説明を取得できなかった場合にスローされます。

概要

指定された Issue ID のグループ説明を取得します。

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

戻り値

文字列。指定された Issue ID のグループ説明です。

概要

この関数は、指定された IssueID の説明へのポインタを、指定された場所に配置します。

/**
*
* @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)

戻り値

整数の GW2_RetStatus 列挙値を返します。負の数は失敗を示します。成功した場合、出力バッファーには Issue Description が格納されます。

例

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

...