データマトリックス指定したインデックス番号にあるデータマトリックスのメッセージを取得

Namespace: fvalgcli
Assembly: fvalgcli (in fvalgcli.dll) Version: 3.1.0.0 (3.1.0.11)

Syntax

C#
public static int fnFIE_dm_query_message(
	FHANDLE hdm,
	int id,
	ref UCHAR_PTR message,
	ref int message_length
)
Visual Basic
Public Shared Function fnFIE_dm_query_message ( 
	hdm As FHANDLE,
	id As Integer,
	ByRef message As UCHAR_PTR,
	ByRef message_length As Integer
) As Integer

Parameters

hdm
Type: fvalgcli..::..FHANDLE
データマトリックスオブジェクトハンドル
id
Type: System..::..Int32
fnFIE_dm_query_decoded() によって得られたインデックス配列の参照値。
message
Type: fvalgcli..::..UCHAR_PTR%
読み取ったデータマトリックスメッセージ。(ASCII文字列の先頭アドレスを返します。IntPtr.Zero で初期化してください。取得したアドレスは解放しないでください。)
message_length
Type: System..::..Int32%
読み取ったデータマトリックスメッセージの文字列長。メッセージ自体に (終端文字)を含む可能性がある場合には文字列長を取得して message を使用してください。

Return Value

Type: Int32
以下のエラーコードを返します。

エラーコード：
f_err内容
F_ERR_NONE正常終了
F_ERR_INVALID_OBJECTデータマトリックスオブジェクトの異常
F_ERR_INVALID_PARAMパラメータ異常
F_ERR_NODATAメッセージがありません(パラメータ id に、検出したがデコードに失敗したインデックス番号を指定しました)
F_ERR_NO_LICENCEライセンスエラー、または未初期化エラー

Examples

C# Copy imageCopy
//    $Revision: 1.1 $

using System;
using System.Collections.Generic;
using System.Text;
using fvalgcli;

namespace TC
{
    public partial class FIE
    {
        /// <summary>
        /// データマトリクス指定したインデックス番号にあるデータマトリクスのメッセージを取得.
        /// </summary>
        /// <param name="hQR"></param>
        public void fnFIE_dm_query_message(FHANDLE hdm, int id)
        {
            try
            {
                UCHAR_PTR message = UCHAR_PTR.Zero;
                int message_length = 0;

                int status = api.fnFIE_dm_query_message(hdm, id, ref message, ref message_length);
                Assert.IsTrue(status == (int)f_err.F_ERR_NONE, "fnFIE_dm_query_message: エラーが発生しました。({0})", (f_err)status);

                Console.WriteLine("fnFIE_dm_query_message");
                Console.WriteLine("message={0}", (string)message);
                Console.WriteLine("message_length={0}", message_length);
            }
            finally
            {
            }
        }
    }
}

Visual Basic Copy imageCopy
'    $Revision: 1.1 $

Imports System.Collections.Generic
Imports System.Text
Imports fvalgcli

Public Partial Class FIE
    ''' <summary>
    ''' データマトリクス指定したインデックス番号にあるデータマトリクスのメッセージを取得.
    ''' </summary>
    ''' <param name="hQR"></param>
    Public Sub fnFIE_dm_query_message(hdm As FHANDLE, id As Integer)
        Try
            Dim message As UCHAR_PTR = UCHAR_PTR.Zero
            Dim message_length As Integer = 0

            Dim status As Integer = api.fnFIE_dm_query_message(hdm, id, message, message_length)
            Assert.IsTrue(status = CInt(f_err.F_ERR_NONE), "fnFIE_dm_query_message: エラーが発生しました。({0})", CType(status, f_err))

            Console.WriteLine("fnFIE_dm_query_message")
            Console.WriteLine("message={0}", CType(message, String))
            Console.WriteLine("message_length={0}", message_length)
        Finally
        End Try
    End Sub
End Class

See Also