DataObject.GetData Метод

Определение

Возвращает данные в указанном формате.Returns data in a specified data format.

Перегрузки

GetData(String)

Возвращает данные в формате, указанном строкой.Returns data in a format specified by a string.

GetData(Type)

Возвращает объект данных в формате, указанном объектом Type.Returns a data object in a format specified by a Type object.

GetData(String, Boolean)

Возвращает объект данных в указанном формате, при необходимости преобразуя данные в этот формат.Returns a data object in a specified format, optionally converting the data to the specified format.

GetData(String)

Возвращает данные в формате, указанном строкой.Returns data in a format specified by a string.

public:
 virtual System::Object ^ GetData(System::String ^ format);
public object GetData (string format);
abstract member GetData : string -> obj
override this.GetData : string -> obj
Public Function GetData (format As String) As Object

Параметры

format
String

Строка, задающая формат для данных.A string that specifies the format for the data. Набор предопределенных форматов данных см. в статье о классе DataFormats.For a set of predefined data formats, see the DataFormats class.

Возвращаемое значение

Object

Объект, содержащий данные в указанном формате, или значение null, если данные недоступны в указанном формате.An object that contains the data in the specified format, or null if the data is unavailable in the specified format.

Реализации

Исключения

format имеет значение null.format is null.

Примеры

В следующем примере этот метод используется для первой проверки доступности указанного формата данных (изначально или путем автоматического преобразования). Если указанный формат доступен, в примере данные извлекаются с помощью GetData(String) метода.The following example uses this method to first check whether a specified data format is available (natively or by auto-convert); if the specified format is available, the example retrieves the data by using the GetData(String) method.

DataObject dataObject = new DataObject("Some string data to store...");

string desiredFormat = DataFormats.UnicodeText;
byte[] data = null;

// Use the GetDataPresent method to check for the presence of a desired data format.
// This particular overload of GetDataPresent looks for both native and auto-convertible 
// data formats.
if (dataObject.GetDataPresent(desiredFormat))
{
    // If the desired data format is present, use one of the GetData methods to retrieve the
    // data from the data object.
    data = dataObject.GetData(desiredFormat) as byte[];
}
Dim dataObject As New DataObject("Some string data to store...")

Dim desiredFormat As String = DataFormats.UnicodeText
Dim data() As Byte = Nothing

' Use the GetDataPresent method to check for the presence of a desired data format.
' This particular overload of GetDataPresent looks for both native and auto-convertible 
' data formats.
If dataObject.GetDataPresent(desiredFormat) Then
    ' If the desired data format is present, use one of the GetData methods to retrieve the
    ' data from the data object.
    data = TryCast(dataObject.GetData(desiredFormat), Byte())
End If

В следующем примере кода используется GetDataPresent(String, Boolean) метод, чтобы сначала проверить, доступен ли заданный формат данных в собственном формате (фильтры с автопреобразуемым форматом данных). Если указанный формат доступен, в примере данные извлекаются с помощью GetData(String) метода.The following example code uses the GetDataPresent(String, Boolean) method to first check if a specified data format is available natively (auto-convertible data formats are filtered); if the specified format is available, the example retrieves the data by using the GetData(String) method.

DataObject dataObject = new DataObject("Some string data to store...");

string desiredFormat = DataFormats.UnicodeText;
bool noAutoConvert = false;
byte[] data = null;

// Use the GetDataPresent method to check for the presence of a desired data format.
// The autoconvert parameter is set to false to filter out auto-convertible data formats,
// returning true only if the specified data format is available natively.
if (dataObject.GetDataPresent(desiredFormat, noAutoConvert))
{
    // If the desired data format is present, use one of the GetData methods to retrieve the
    // data from the data object.
    data = dataObject.GetData(desiredFormat) as byte[];
}
Dim dataObject As New DataObject("Some string data to store...")

Dim desiredFormat As String = DataFormats.UnicodeText
Dim noAutoConvert As Boolean = False
Dim data() As Byte = Nothing

' Use the GetDataPresent method to check for the presence of a desired data format.
' The autoconvert parameter is set to false to filter out auto-convertible data formats,
' returning true only if the specified data format is available natively.
If dataObject.GetDataPresent(desiredFormat, noAutoConvert) Then
    ' If the desired data format is present, use one of the GetData methods to retrieve the
    ' data from the data object.
    data = TryCast(dataObject.GetData(desiredFormat), Byte())
End If

Применяется к

GetData(Type)

Возвращает объект данных в формате, указанном объектом Type.Returns a data object in a format specified by a Type object.

public:
 virtual System::Object ^ GetData(Type ^ format);
public object GetData (Type format);
abstract member GetData : Type -> obj
override this.GetData : Type -> obj
Public Function GetData (format As Type) As Object

Параметры

format
Type

Type, указывающий формат данных.A Type that specifies the format for the data. Набор предопределенных форматов данных см. в статье о классе DataFormats.For a set of predefined data formats, see the DataFormats class.

Возвращаемое значение

Object

Объект данных с данными в указанном формате или значение null, если данные в указанном формате недоступны.A data object with the data in the specified format, or null if the data is unavailable in the specified format.

Реализации

Исключения

format имеет значение null.format is null.

Применяется к

GetData(String, Boolean)

Возвращает объект данных в указанном формате, при необходимости преобразуя данные в этот формат.Returns a data object in a specified format, optionally converting the data to the specified format.

public:
 virtual System::Object ^ GetData(System::String ^ format, bool autoConvert);
public object GetData (string format, bool autoConvert);
abstract member GetData : string * bool -> obj
override this.GetData : string * bool -> obj
Public Function GetData (format As String, autoConvert As Boolean) As Object

Параметры

format
String

Строка, задающая формат для данных.A string that specifies the format for the data. Набор предопределенных форматов данных см. в статье о классе DataFormats.For a set of predefined data formats, see the DataFormats class.

autoConvert
Boolean

Значение true — пытаться автоматически преобразовать данные в указанный формат; значение false — без преобразования формата данных.true to attempt to automatically convert the data to the specified format; false for no data format conversion.

Возвращаемое значение

Object

Объект данных с данными в указанном формате или значение null, если данные в указанном формате недоступны.A data object with the data in the specified format, or null if the data is unavailable in the specified format.

Если параметр autoConvert равен true, а данные нельзя преобразовать в указанный формат, или если автоматическое преобразование отключено (вызовом метода SetData(String, Object, Boolean) с параметром autoConvert, равным false), данный метод возвращает значение null.If the autoConvert parameter is true and the data cannot be converted to the specified format, or if automatic conversion is disabled (by calling SetData(String, Object, Boolean) with the autoConvert parameter set to false), this method returns null.

Реализации

Исключения

Параметр format имеет значение NULL.format is null.

Применяется к