NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

IDataObject.GetData (Type)

Retrieves the data associated with the specified class type format.

[Visual Basic]
Overloads Function GetData( _
   ByVal format As Type _
) As Object
[C#]
object GetData(
   Type format
);
[C++]
Object* GetData(
   Type* format
) = 0;
[JScript]
function GetData(
   format : Type
) : Object;

Parameters

format
A Type representing the format of the data to retrieve. See DataFormats for predefined formats.

Return Value

The data associated with the specified format, or a null reference (in Visual Basic Nothing).

Remarks

If this method cannot find data in the specified format, it attempts to convert the data to the format. If the data cannot be converted to the specified format, or if the data was stored with autoConvert set to false, this method returns a null reference (Nothing).

To determine whether data is associated with, or can be converted to, a format, call GetDataPresent before calling GetData. Call GetFormats for a list of valid formats for the data stored in this instance.

Note   Data can be converted to another format if it was stored specifying that conversion is allowed, and if the requested format is compatable with the stored format. For example, data stored as Unicode can be converted to text.

For an implementation of this method, see GetData.

See Also

IDataObject Interface | IDataObject Members | System.WinForms Namespace | IDataObject.GetData Overload List | SetData | GetDataPresent | DataFormats | GetFormats | SetData | GetDataPresent | GetFormats