Skip to content

Commit

Permalink
Document some internal SQL type ctors as additional-apis (#28911)
Browse files Browse the repository at this point in the history
  • Loading branch information
GrabYourPitchforks authored Apr 6, 2022
1 parent 6c840da commit 0497ba6
Show file tree
Hide file tree
Showing 5 changed files with 132 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/framework/additional-apis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ These APIs support the product infrastructure and are not intended or supported

* [Microsoft.SqlServer.Server.SmiOrderProperty.Item property](microsoft.sqlserver.server.smiorderproperty.item.md)
* [System.Exception.PrepForRemoting method](system.exception.prepforremoting.md)
* [System.Data.SqlTypes.SqlBinary Constructor](system.data.sqltypes.sqlbinary.-ctor.md)
* [System.Data.SqlTypes.SqlChars.Stream property](system.data.sqltypes.sqlchars.stream.md)
* [System.Data.SqlTypes.SqlGuid Constructor](system.data.sqltypes.sqlguid.-ctor.md)
* [System.Data.SqlTypes.SqlMoney Constructor](system.data.sqltypes.sqlmoney.-ctor.md)
* [System.Data.SqlTypes.SqlStreamChars Constructor](system.data.sqltypes.sqlstreamchars.-ctor.md)
* [System.Data.SqlTypes.SqlStreamChars.CanSeek property](system.data.sqltypes.sqlstreamchars.canseek.md)
* [System.Data.SqlTypes.SqlStreamChars.IsNull property](system.data.sqltypes.sqlstreamchars.isnull.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
description: "Learn more about: SqlBinary Constructor"
title: SqlBinary Constructor (System.Data.SqlTypes)
author: grabyourpitchforks
ms.date: 04/04/2022
ms.technology: "dotnet-data"
topic_type:
- "apiref"
api_name:
- "System.Data.SqlTypes.SqlBinary..ctor"
api_location:
- "System.Data.dll"
api_type:
- "Assembly"
---
# SqlBinary Constructor

Initializes a new instance of the `SqlBinary` struct without making a copy of the `byte` array passed via the `value` parameter. Future mutations to this array may cause the resulting `SqlBinary` instance to change its value.

The `ignored` parameter is ignored.

```csharp
internal SqlBinary(byte[] value, bool ignored);
```

## Remarks

> [!WARNING]
> This overload of the `SqlBinary` constructor is internal and is not meant to be used directly in your code. This API may not be available in future versions of .NET.
>
> Microsoft does not support the use of this constructor in a production application under any circumstance.
## Requirements

**Namespace:** <xref:System.Data.SqlTypes>

**Assembly:** System.Data (in System.Data.dll)

**.NET Framework versions:** Available since 2.0.
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
description: "Learn more about: SqlGuid Constructor"
title: SqlGuid Constructor (System.Data.SqlTypes)
author: grabyourpitchforks
ms.date: 04/04/2022
ms.technology: "dotnet-data"
topic_type:
- "apiref"
api_name:
- "System.Data.SqlTypes.SqlGuid..ctor"
api_location:
- "System.Data.dll"
api_type:
- "Assembly"
---
# SqlGuid Constructor

Initializes a new instance of the `SqlGuid` struct without making a copy of the `byte` array passed via the `value` parameter. Future mutations to this array may cause the resulting `SqlGuid` instance to change its value.

The `ignored` parameter is ignored.

```csharp
internal SqlGuid(byte[] value, bool ignored);
```

## Remarks

> [!WARNING]
> This overload of the `SqlGuid` constructor is internal and is not meant to be used directly in your code. This API may not be available in future versions of .NET.
>
> Microsoft does not support the use of this constructor in a production application under any circumstance.
## Requirements

**Namespace:** <xref:System.Data.SqlTypes>

**Assembly:** System.Data (in System.Data.dll)

**.NET Framework versions:** Available since 2.0.
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
description: "Learn more about: SqlMoney Constructor"
title: SqlMoney Constructor (System.Data.SqlTypes)
author: grabyourpitchforks
ms.date: 04/04/2022
ms.technology: "dotnet-data"
topic_type:
- "apiref"
api_name:
- "System.Data.SqlTypes.SqlMoney..ctor"
api_location:
- "System.Data.dll"
api_type:
- "Assembly"
---
# SqlMoney Constructor

Initializes a new instance of the `SqlMoney` struct, where `value` has already been scaled by a ten-thousandth of a currency unit. For example, if __20000__ is provided for the `value` parameter, this `SqlMoney` instance will represent __2__ currency units.

The `ignored` parameter is ignored.

```csharp
internal SqlMoney(long value, int ignored);
```

## Remarks

> [!WARNING]
> This overload of the `SqlMoney` constructor is internal and is not meant to be used directly in your code. This API may not be available in future versions of .NET.
>
> Microsoft does not support the use of this constructor in a production application under any circumstance.
## Requirements

**Namespace:** <xref:System.Data.SqlTypes>

**Assembly:** System.Data (in System.Data.dll)

**.NET Framework versions:** Available since 2.0.
12 changes: 12 additions & 0 deletions docs/framework/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -463,10 +463,22 @@ items:
href: additional-apis/system.exception.prepforremoting.md
- name: System.Data.SqlTypes
items:
- name: SqlBinary structure
items:
- name: SqlBinary constructor
href: additional-apis/system.data.sqltypes.sqlbinary.-ctor.md
- name: SqlChars class
items:
- name: Stream property
href: additional-apis/system.data.sqltypes.sqlchars.stream.md
- name: SqlGuid structure
items:
- name: SqlGuid constructor
href: additional-apis/system.data.sqltypes.sqlguid.-ctor.md
- name: SqlMoney structure
items:
- name: SqlMoney constructor
href: additional-apis/system.data.sqltypes.sqlmoney.-ctor.md
- name: SqlStreamChars class
items:
- name: SqlStreamChars constructor
Expand Down

0 comments on commit 0497ba6

Please sign in to comment.