DicomObjects.NET8 Documentation
DicomObjects.DicomWeb Namespace / WadoWebClient Class / RetrieveMetaData Method
The Requested StudyUID
The Requested series UID (may be null/absent)
The Requested instance UID (may be null/absent)



In This Topic
    RetrieveMetaData Method (WadoWebClient)
    In This Topic
    Retrieve DICOM instances without their large data elements (so-called metadata), based on explicit study, series and instance UIDs
    Syntax
    'Declaration
     
    
    Public Function RetrieveMetaData( _
       ByVal StudyUID As String, _
       Optional ByVal SeriesUID As String, _
       Optional ByVal InstanceUID As String _
    ) As DicomDataSetCollection
    'Usage
     
    
    Dim instance As WadoWebClient
    Dim StudyUID As String
    Dim SeriesUID As String
    Dim InstanceUID As String
    Dim value As DicomDataSetCollection
     
    value = instance.RetrieveMetaData(StudyUID, SeriesUID, InstanceUID)

    Parameters

    StudyUID
    The Requested StudyUID
    SeriesUID
    The Requested series UID (may be null/absent)
    InstanceUID
    The Requested instance UID (may be null/absent)

    Return Value

    Set of Dicom Instances transformed from the json or xml
    Remarks

    This is intended to get a "quick overview" of instances before getting them fully, but if the instances are "used" (e.g. by viewing or writing out), then DicomObjects will automatically retrieve any "missing" data as required via individual bulk data retrieval calls. WHilst efficient for one or two elements (perhaps one frame of an image), if the whole instance is needed, then it is more efficient either to retrieve in native form, or to add all the bulk data items in one go via AppendBulkData .

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also