DicomObjects.NET.8.48 Documentation
DicomObjects.DicomCodecs Namespace / CodecFactory Class / CheckStart Method
The fragment data to test
The transfer syntax to check against






In This Topic
    CheckStart Method
    In This Topic
    Check whether a stream contains data which could be the start of a frame of compressed data
    Syntax
    'Declaration
     
    
    Public MustOverride Function CheckStart( _
       ByVal stream As System.IO.Stream, _
       ByVal TransferSyntax As System.String _
    ) As System.Boolean
    'Usage
     
    
    Dim instance As CodecFactory
    Dim stream As System.IO.Stream
    Dim TransferSyntax As System.String
    Dim value As System.Boolean
     
    value = instance.CheckStart(stream, TransferSyntax)
    public abstract System.bool CheckStart( 
       System.IO.Stream stream,
       System.string TransferSyntax
    )
    public function CheckStart( 
        stream: System.IO.Stream;
        TransferSyntax: System.String
    ): System.Boolean; abstract; 
    public __abstract function CheckStart( 
       stream : System.IO.Stream,
       TransferSyntax : System.String
    ) : System.boolean;
    public: abstract System.bool CheckStart( 
       System.IO.Stream* stream,
       System.string* TransferSyntax
    ) 
    public:
    abstract System.bool CheckStart( 
       System.IO.Stream^ stream,
       System.String^ TransferSyntax
    ) 

    Parameters

    stream
    The fragment data to test
    TransferSyntax
    The transfer syntax to check against

    Return Value

    true if the data could be the start of a new frame for this transfer syntax
    Remarks
    This routine is used in the difficult cases where the basic offset table is empty, and where there is no obvious 1:1 relationship between fragments and frames, to determine which fragment is the start of which frame.
    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also