DicomObjects.NET.8.48 Documentation
DicomObjects Namespace / IFrameSource Interface / ReadFrame Method
The zero-based frame number to read
The array to put the data into
Total number of frames expected to be present






In This Topic
    ReadFrame Method
    In This Topic
    Read one frame
    Syntax
    'Declaration
     
    
    Sub ReadFrame( _
       ByVal frame0 As System.Integer, _
       ByVal result As System.Array, _
       ByVal frameCount As System.Integer _
    ) 
    'Usage
     
    
    Dim instance As IFrameSource
    Dim frame0 As System.Integer
    Dim result As System.Array
    Dim frameCount As System.Integer
     
    instance.ReadFrame(frame0, result, frameCount)
    void ReadFrame( 
       System.int frame0,
       System.Array result,
       System.int frameCount
    )
    procedure ReadFrame( 
        frame0: System.Integer;
        result: System.Array;
        frameCount: System.Integer
    ); 
    function ReadFrame( 
       frame0 : System.int,
       result : System.Array,
       frameCount : System.int
    );
    void ReadFrame( 
       System.int frame0,
       System.Array* result,
       System.int frameCount
    ) 
    void ReadFrame( 
       System.int frame0,
       System.Array^ result,
       System.int frameCount
    ) 

    Parameters

    frame0
    The zero-based frame number to read
    result
    The array to put the data into
    frameCount
    Total number of frames expected to be present
    Remarks
    It is expected that result will contain a byte array in most cases
    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also