Skip to content

Improve System.Guid and System.Type.Guid documentation #9715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 15, 2024
Merged

Improve System.Guid and System.Type.Guid documentation #9715

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b8ef7a0
Import System.Guid and System.Type.Guid documentation
jkotas Mar 13, 2024
22013ba
Merge branch 'main' into guid
jkotas Mar 15, 2024
99cd9e8
Delete unused snippets
jkotas Mar 15, 2024
654d78a
FB
jkotas Mar 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 0 additions & 52 deletions snippets/cpp/VS_Snippets_CLR/Guid/CPP/Guids.cpp
View file
Open in desktop

This file was deleted.

45 changes: 0 additions & 45 deletions snippets/csharp/System/Guid/Overview/Guids.cs
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions snippets/csharp/System/Guid/Overview/Project.csproj
View file
Open in desktop

This file was deleted.

41 changes: 0 additions & 41 deletions snippets/fsharp/System/Guid/Overview/Guids.fs
View file
Open in desktop

This file was deleted.

10 changes: 0 additions & 10 deletions snippets/fsharp/System/Guid/Overview/fs.fsproj
View file
Open in desktop

This file was deleted.

50 changes: 0 additions & 50 deletions snippets/visualbasic/VS_Snippets_CLR/Guid/VB/Guids.vb
View file
Open in desktop

This file was deleted.

12 changes: 0 additions & 12 deletions xml/System/Guid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,18 +114,6 @@
## Remarks
A GUID is a 128-bit integer (16 bytes) that can be used across all computers and networks wherever a unique identifier is required. Such an identifier has a very low probability of being duplicated.



## Examples
The following example uses the <xref:System.Runtime.InteropServices.GuidAttribute?displayProperty=nameWithType> class to assign a GUID to an interface and to a user-defined class. It retrieves the value of the GUID by calling the <xref:System.Attribute.GetCustomAttribute%2A> method, and compares it with two other GUIDs to determine whether they are equal.

:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Guid/CPP/Guids.cpp" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/System/Guid/Overview/Guids.cs" interactive="try-dotnet" id="Snippet1":::
:::code language="fsharp" source="~/snippets/fsharp/System/Guid/Overview/Guids.fs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Guid/VB/Guids.vb" id="Snippet1":::

Note that the <xref:System.Runtime.InteropServices.GuidAttribute> attribute is typically used in an application to expose a type to COM. If you compile this example, you can run the [Assembly Registration tool (Regasm.exe)](/dotnet/framework/tools/regasm-exe-assembly-registration-tool) on the generated assembly to create registry (.reg) and type library (.tlb) files. The .reg file can be used to register the coclass in the registry, and the .tlb file can provide metadata for COM interop.

]]></format>
</remarks>
</Docs>
Expand Down
4 changes: 2 additions & 2 deletions xml/System/Type.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11038,9 +11038,9 @@ Calling this method overload is the same as calling the <xref:System.Type.GetTyp
<format type="text/markdown"><![CDATA[

## Remarks
A GUID is associated with a type using the <xref:System.Runtime.InteropServices.GuidAttribute> attribute.

This property returns a GUID that's associated with a type using the <xref:System.Runtime.InteropServices.GuidAttribute> attribute. If the attribute is omitted, a GUID is assigned automatically.

The GUID returned by this property is typically used to expose a type to COM. It is not meant to be used as a unique identifier of the type.

## Examples
The following example creates the class `MyClass1` with a public method, creates a `Type` object corresponding to `MyClass1`, and gets the <xref:System.Guid> structure using the `GUID` property of the `Type` class.
Expand Down