指定された画像のメモリステップ(バイト単位メモリ横幅)を取得します。無効なチャイルド画像の場合は 0 を返します。異常終了した場合は、-1 を返します。

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

Syntax

C#
public static SIZE_T fnFIE_img_get_step_as_bytes(
	FHANDLE himg
)
Visual Basic
Public Shared Function fnFIE_img_get_step_as_bytes ( 
	himg As FHANDLE
) As SIZE_T

Parameters

himg
Type: fvalgcli..::..FHANDLE
情報を取得する画像のハンドル

Return Value

Type: SIZE_T
正常終了した場合は、画像のメモリステップ(バイト単位メモリ横幅)を返します。無効なチャイルド画像の場合は 0 を返します。異常終了した場合は、-1 を返します。

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>
        [FvPluginExecute]
        public void fnFIE_img_get_step_as_bytes()
        {
            // fnFIE_img_child_alloc 参照.
        }
    }
}

Visual Basic Copy imageCopy
'    $Revision: 1.1 $

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

Public Partial Class FIE
    ''' <summary>
    ''' 画像情報取得(ステップ).
    ''' </summary>
    <FvPluginExecute> _
    Public Sub fnFIE_img_get_step_as_bytes()
        ' fnFIE_img_child_alloc 参照.
    End Sub
End Class

See Also