Retrieves the current block of data and stores it in a variable of type variant.
Return Value
Void
Syntax
object.GetData data, [type,] [maxLen]
The GetData method syntax has these parts:
| Part | Description |
| object | An object expression that evaluates to an object in the Applies To list. |
| data | Where retrieved data will be stored after the method returns successfully. If there is not enough data available for requested type, data will be set to Empty. |
| type | Optional. Type of data to be retrieved, as shown in Settings. |
| maxLen | Optional. Specifies the desired size when receiving a byte array or a string. If this parameter is missing for byte array or string, all available data will be retrieved. If provided for data types other than byte array and string, this parameter is ignored. |
Settings
The settings for type are:
| Description | Constant |
| Byte | vbByte |
| Integer | vbInteger |
| Long | vbLong |
| Single | vbSingle |
| Double | vbDouble |
| Currency | vbCurrency |
| Date | vbDate |
| Boolean | vbBoolean |
| SCODE | vbError |
| String | vbString |
| Byte Array | vbArray + vbByte |
Remarks
It's common to use the GetData method with the DataArrival event, which includes the totalBytes argument. If you specify a maxlen that is less than the totalBytes argument, you will get the warning 10040 indicating that the remaining bytes will be lost.