Files
sqltoolsservice/docs/metadata/api/Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.yml
2016-12-15 16:37:50 -08:00

474 lines
16 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult
commentId: T:Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult
id: FileStreamReadResult
parent: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage
children:
- Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.#ctor(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue,System.Int32)
- Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.TotalLength
- Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value
langs:
- csharp
- vb
name: FileStreamReadResult
nameWithType: FileStreamReadResult
fullName: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult
type: Struct
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: FileStreamReadResult
path: ../src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs
startLine: 13
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage
summary: "\nRepresents a value returned from a read from a file stream. This is used to eliminate ref\nparameters used in the read methods.\n"
example: []
syntax:
content: public struct FileStreamReadResult
content.vb: Public Structure FileStreamReadResult
inheritedMembers:
- System.ValueType.Equals(System.Object)
- System.ValueType.GetHashCode
- System.ValueType.ToString
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetType
- System.Object.ReferenceEquals(System.Object,System.Object)
modifiers.csharp:
- public
- struct
modifiers.vb:
- Public
- Structure
- uid: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.TotalLength
commentId: P:Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.TotalLength
id: TotalLength
parent: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult
langs:
- csharp
- vb
name: TotalLength
nameWithType: FileStreamReadResult.TotalLength
fullName: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.TotalLength
type: Property
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: TotalLength
path: ../src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs
startLine: 25
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage
summary: "\nThe total length in bytes of the value, (including the bytes used to store the length\nof the value)\n"
remarks: "\nCell values are stored such that the length of the value is stored first, then the\nvalue itself is stored. Eg, a string may be stored as 0x03 0x6C 0x6F 0x6C. Under this\nsystem, the value would be \"lol\", the length would be 3, and the total length would be\n4 bytes.\n"
example: []
syntax:
content: public int TotalLength { get; set; }
content.vb: Public Property TotalLength As Integer
parameters: []
return:
type: System.Int32
overload: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.TotalLength*
modifiers.csharp:
- public
- get
- set
modifiers.vb:
- Public
- uid: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value
commentId: P:Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value
id: Value
parent: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult
langs:
- csharp
- vb
name: Value
nameWithType: FileStreamReadResult.Value
fullName: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value
type: Property
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: Value
path: ../src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs
startLine: 30
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage
summary: "\nValue of the cell\n"
example: []
syntax:
content: public DbCellValue Value { get; set; }
content.vb: Public Property Value As DbCellValue
parameters: []
return:
type: Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue
overload: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value*
modifiers.csharp:
- public
- get
- set
modifiers.vb:
- Public
- uid: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.#ctor(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue,System.Int32)
commentId: M:Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.#ctor(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue,System.Int32)
id: '#ctor(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue,System.Int32)'
parent: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult
langs:
- csharp
- vb
name: FileStreamReadResult(DbCellValue, Int32)
nameWithType: FileStreamReadResult.FileStreamReadResult(DbCellValue, Int32)
fullName: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.FileStreamReadResult(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue, System.Int32)
type: Constructor
source:
remote:
path: src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs
branch: master
repo: https://kburtram:67c6623fc506400046096af249535f684d9ea40b@github.com/Microsoft/sqltoolsservice.git
id: .ctor
path: ../src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs
startLine: 37
assemblies:
- Microsoft.SqlTools.ServiceLayer
namespace: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage
summary: "\nConstructs a new FileStreamReadResult\n"
example: []
syntax:
content: public FileStreamReadResult(DbCellValue value, int totalLength)
content.vb: Public Sub New(value As DbCellValue, totalLength As Integer)
parameters:
- id: value
type: Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue
description: The value of the result, ready for consumption by a client
- id: totalLength
type: System.Int32
description: The number of bytes for the used to store the value's length and value
overload: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.#ctor*
modifiers.csharp:
- public
modifiers.vb:
- Public
references:
- uid: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage
commentId: N:Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage
isExternal: false
name: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage
nameWithType: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage
fullName: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage
- uid: System.ValueType.Equals(System.Object)
commentId: M:System.ValueType.Equals(System.Object)
parent: System.ValueType
isExternal: true
name: Equals(Object)
nameWithType: ValueType.Equals(Object)
fullName: System.ValueType.Equals(System.Object)
spec.csharp:
- uid: System.ValueType.Equals(System.Object)
name: Equals
nameWithType: ValueType.Equals
fullName: System.ValueType.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.ValueType.Equals(System.Object)
name: Equals
nameWithType: ValueType.Equals
fullName: System.ValueType.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
- uid: System.ValueType.GetHashCode
commentId: M:System.ValueType.GetHashCode
parent: System.ValueType
isExternal: true
name: GetHashCode()
nameWithType: ValueType.GetHashCode()
fullName: System.ValueType.GetHashCode()
spec.csharp:
- uid: System.ValueType.GetHashCode
name: GetHashCode
nameWithType: ValueType.GetHashCode
fullName: System.ValueType.GetHashCode
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.ValueType.GetHashCode
name: GetHashCode
nameWithType: ValueType.GetHashCode
fullName: System.ValueType.GetHashCode
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System.ValueType.ToString
commentId: M:System.ValueType.ToString
parent: System.ValueType
isExternal: true
name: ToString()
nameWithType: ValueType.ToString()
fullName: System.ValueType.ToString()
spec.csharp:
- uid: System.ValueType.ToString
name: ToString
nameWithType: ValueType.ToString
fullName: System.ValueType.ToString
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.ValueType.ToString
name: ToString
nameWithType: ValueType.ToString
fullName: System.ValueType.ToString
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
name: Equals(Object, Object)
nameWithType: Object.Equals(Object, Object)
fullName: System.Object.Equals(System.Object, System.Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
nameWithType: Object.Equals
fullName: System.Object.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
nameWithType: Object.Equals
fullName: System.Object.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
name: GetType()
nameWithType: Object.GetType()
fullName: System.Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
nameWithType: Object.GetType
fullName: System.Object.GetType
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.GetType
name: GetType
nameWithType: Object.GetType
fullName: System.Object.GetType
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
name: ReferenceEquals(Object, Object)
nameWithType: Object.ReferenceEquals(Object, Object)
fullName: System.Object.ReferenceEquals(System.Object, System.Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
nameWithType: Object.ReferenceEquals
fullName: System.Object.ReferenceEquals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
nameWithType: Object.ReferenceEquals
fullName: System.Object.ReferenceEquals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
- uid: System.ValueType
commentId: T:System.ValueType
parent: System
isExternal: true
name: ValueType
nameWithType: ValueType
fullName: System.ValueType
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
name: Object
nameWithType: Object
fullName: System.Object
- uid: System
commentId: N:System
isExternal: false
name: System
nameWithType: System
fullName: System
- uid: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.TotalLength*
commentId: Overload:Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.TotalLength
isExternal: false
name: TotalLength
nameWithType: FileStreamReadResult.TotalLength
fullName: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.TotalLength
- uid: System.Int32
commentId: T:System.Int32
parent: System
isExternal: true
name: Int32
nameWithType: Int32
fullName: System.Int32
- uid: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value*
commentId: Overload:Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value
isExternal: false
name: Value
nameWithType: FileStreamReadResult.Value
fullName: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value
- uid: Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue
commentId: T:Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue
parent: Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
isExternal: false
name: DbCellValue
nameWithType: DbCellValue
fullName: Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue
- uid: Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
commentId: N:Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
isExternal: false
name: Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
nameWithType: Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
fullName: Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
- uid: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.#ctor*
commentId: Overload:Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.#ctor
isExternal: false
name: FileStreamReadResult
nameWithType: FileStreamReadResult.FileStreamReadResult
fullName: Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.FileStreamReadResult