Skip to content

Commit b390547

Browse files
authored
delete 404 links to samples (#9874)
1 parent 47937fd commit b390547

8 files changed

+1036
-1104
lines changed

xml/System.IO.Packaging/CertificateEmbeddingOption.xml

+13-14
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,25 @@
2121
<Docs>
2222
<summary>Specifies the location where the X.509 certificate that is used in signing is stored.</summary>
2323
<remarks>
24-
<format type="text/markdown"><![CDATA[
25-
26-
## Remarks
27-
If the certificate is `NotEmbedded` in the package, an application that verifies signatures must provide a copy of the certificate in order to verify the signatures that are signed by it.
28-
29-
`InSignaturePart` adds two informational elements, `<KeyName>` and `<KeyValue>`, as part of the <xref:System.Security.Cryptography.Xml.Signature.KeyInfo%2A> field of the stored digital signature. The `<KeyName>` and `<KeyValue>` elements are not processed as part of signature validation and are therefore not secure from modification. Applications should not make any assumption regarding the validity of these two elements. To avoid undetected modification and possible confusion, applications should use the `InCertificatePart` option instead of `InSignaturePart`. The `InCertificatePart` option does not provide or expose either `<KeyName>` or `<KeyValue>`.
30-
31-
32-
33-
## Examples
34-
The following example shows how to use `CertificateEmbeddingOption` in order to set the <xref:System.IO.Packaging.PackageDigitalSignatureManager.CertificateOption%2A?displayProperty=nameWithType> property.
35-
24+
<format type="text/markdown"><![CDATA[
25+
26+
## Remarks
27+
28+
If the certificate is `NotEmbedded` in the package, an application that verifies signatures must provide a copy of the certificate in order to verify the signatures that are signed by it.
29+
30+
`InSignaturePart` adds two informational elements, `<KeyName>` and `<KeyValue>`, as part of the <xref:System.Security.Cryptography.Xml.Signature.KeyInfo%2A> field of the stored digital signature. The `<KeyName>` and `<KeyValue>` elements are not processed as part of signature validation and are therefore not secure from modification. Applications should not make any assumption regarding the validity of these two elements. To avoid undetected modification and possible confusion, applications should use the `InCertificatePart` option instead of `InSignaturePart`. The `InCertificatePart` option does not provide or expose either `<KeyName>` or `<KeyValue>`.
31+
32+
## Examples
33+
34+
The following example shows how to use `CertificateEmbeddingOption` in order to set the <xref:System.IO.Packaging.PackageDigitalSignatureManager.CertificateOption%2A?displayProperty=nameWithType> property.
35+
3636
:::code language="csharp" source="~/snippets/csharp/System.IO.Packaging/CertificateEmbeddingOption/Overview/PackageDigitalSignature.cs" id="SnippetPackageDigSigSign":::
3737
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PackageDigitalSignature/visualbasic/packagedigitalsignature.vb" id="SnippetPackageDigSigSign":::
38-
38+
3939
]]></format>
4040
</remarks>
4141
<altmember cref="P:System.IO.Packaging.PackageDigitalSignatureManager.CertificateOption" />
4242
<altmember cref="P:System.IO.Packaging.PackageDigitalSignature.CertificateEmbeddingOption" />
43-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=159966">Creating a Package with a Digital Signature Sample</related>
4443
<related type="ExternalDocumentation" href="https://www.ecma-international.org/publications-and-standards/standards/ecma-376/">Open Packaging Conventions (OPC) Specification</related>
4544
</Docs>
4645
<Members>

xml/System.IO.Packaging/PackUriHelper.xml

+309-314
Large diffs are not rendered by default.

xml/System.IO.Packaging/Package.xml

+463-504
Large diffs are not rendered by default.

xml/System.IO.Packaging/PackageDigitalSignatureManager.xml

+211-221
Large diffs are not rendered by default.

xml/System.IO.Packaging/PackageRelationshipSelector.xml

+7-8
Original file line numberDiff line numberDiff line change
@@ -49,19 +49,18 @@
4949
<Docs>
5050
<summary>Defines <see cref="T:System.IO.Packaging.PackageRelationship" /> criteria to select part-level or package-level relationships.</summary>
5151
<remarks>
52-
<format type="text/markdown"><![CDATA[
53-
54-
## Remarks
55-
<xref:System.IO.Packaging.PackageRelationshipSelector> is used by the <xref:System.IO.Packaging.PackageDigitalSignatureManager.Sign%2A> method of the <xref:System.IO.Packaging.PackageDigitalSignatureManager> class to specify a list of <xref:System.IO.Packaging.PackageRelationship> parts to be signed.
56-
57-
<xref:System.IO.Packaging.PackageRelationshipSelector> is used by the <xref:System.IO.Packaging.PackageDigitalSignature.SignedRelationshipSelectors%2A> property of the <xref:System.IO.Packaging.PackageDigitalSignature> class to obtain a list of <xref:System.IO.Packaging.PackageRelationship> parts that have been signed with the given digital signature.
58-
52+
<format type="text/markdown"><![CDATA[
53+
54+
## Remarks
55+
<xref:System.IO.Packaging.PackageRelationshipSelector> is used by the <xref:System.IO.Packaging.PackageDigitalSignatureManager.Sign%2A> method of the <xref:System.IO.Packaging.PackageDigitalSignatureManager> class to specify a list of <xref:System.IO.Packaging.PackageRelationship> parts to be signed.
56+
57+
<xref:System.IO.Packaging.PackageRelationshipSelector> is used by the <xref:System.IO.Packaging.PackageDigitalSignature.SignedRelationshipSelectors%2A> property of the <xref:System.IO.Packaging.PackageDigitalSignature> class to obtain a list of <xref:System.IO.Packaging.PackageRelationship> parts that have been signed with the given digital signature.
58+
5959
]]></format>
6060
</remarks>
6161
<altmember cref="T:System.IO.Packaging.PackageRelationshipSelectorType" />
6262
<altmember cref="T:System.IO.Packaging.PackageRelationship" />
6363
<altmember cref="T:System.IO.Packaging.PackagePart" />
64-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=159966">Creating a Package with a Digital Signature Sample</related>
6564
<related type="ExternalDocumentation" href="https://www.ecma-international.org/publications-and-standards/standards/ecma-376/">Open Packaging Conventions (OPC) Specification</related>
6665
</Docs>
6766
<Members>

xml/System.IO.Packaging/VerifyResult.xml

+9-11
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,15 @@
2121
<Docs>
2222
<summary>Specifies the result of a certificate or signature verification.</summary>
2323
<remarks>
24-
<format type="text/markdown"><![CDATA[
25-
26-
## Examples
27-
The following example shows how to use the <xref:System.IO.Packaging.VerifyResult> enumeration.
28-
29-
:::code language="csharp" source="~/snippets/csharp/System.IO.Packaging/CertificateEmbeddingOption/Overview/PackageDigitalSignature.cs" id="Snippetpackagedigsigvalidate":::
30-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PackageDigitalSignature/visualbasic/packagedigitalsignature.vb" id="Snippetpackagedigsigvalidate":::
31-
32-
For the complete sample, see [Creating a Package with a Digital Signature Sample](https://go.microsoft.com/fwlink/?LinkID=159966).
33-
24+
<format type="text/markdown"><![CDATA[
25+
26+
## Examples
27+
28+
The following example shows how to use the <xref:System.IO.Packaging.VerifyResult> enumeration.
29+
30+
:::code language="csharp" source="~/snippets/csharp/System.IO.Packaging/CertificateEmbeddingOption/Overview/PackageDigitalSignature.cs" id="Snippetpackagedigsigvalidate":::
31+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PackageDigitalSignature/visualbasic/packagedigitalsignature.vb" id="Snippetpackagedigsigvalidate":::
32+
3433
]]></format>
3534
</remarks>
3635
<altmember cref="Overload:System.IO.Packaging.PackageDigitalSignature.Verify" />
@@ -39,7 +38,6 @@
3938
<altmember cref="T:System.IO.Packaging.PackageDigitalSignature" />
4039
<altmember cref="T:System.IO.Packaging.PackageDigitalSignatureManager" />
4140
<altmember cref="T:System.IO.Packaging.InvalidSignatureEventHandler" />
42-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=159966">Creating a Package with a Digital Signature Sample</related>
4341
</Docs>
4442
<Members>
4543
<Member MemberName="CertificateRequired">

xml/System.IO.Packaging/ZipPackage.xml

+19-25
Original file line numberDiff line numberDiff line change
@@ -49,30 +49,24 @@
4949
<Docs>
5050
<summary>Implements a derived subclass of the abstract <see cref="T:System.IO.Packaging.Package" /> base class - the <see cref="T:System.IO.Packaging.ZipPackage" /> class uses a ZIP archive as the container store. This class cannot be inherited.</summary>
5151
<remarks>
52-
<format type="text/markdown"><![CDATA[
53-
54-
## Remarks
55-
The **Package**.<xref:System.IO.Packaging.Package.Open%2A> method uses <xref:System.IO.Packaging.ZipPackage> containers by default.
56-
57-
58-
59-
## Examples
60-
This example shows how to create a basic <xref:System.IO.Packaging.ZipPackage>.
61-
62-
The example creates a package that contains a single document part which is defined as the package's root element by a package-level <xref:System.IO.Packaging.PackageRelationship>.
63-
64-
The package also contains an image part and a second <xref:System.IO.Packaging.PackageRelationship> which defines an association between the source document part and the target image part. (The image is a resource that is used with the document).
65-
52+
<format type="text/markdown"><![CDATA[
53+
54+
## Remarks
55+
The **Package**.<xref:System.IO.Packaging.Package.Open%2A> method uses <xref:System.IO.Packaging.ZipPackage> containers by default.
56+
57+
## Examples
58+
This example shows how to create a basic <xref:System.IO.Packaging.ZipPackage>.
59+
60+
The example creates a package that contains a single document part which is defined as the package's root element by a package-level <xref:System.IO.Packaging.PackageRelationship>.
61+
62+
The package also contains an image part and a second <xref:System.IO.Packaging.PackageRelationship> which defines an association between the source document part and the target image part. (The image is a resource that is used with the document).
63+
6664
:::code language="csharp" source="~/snippets/csharp/System.IO.Packaging/Package/Overview/PackageWrite.cs" id="Snippetpackagewritecreatepackage":::
67-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PackageWrite/visualbasic/packagewrite.vb" id="Snippetpackagewritecreatepackage":::
68-
69-
For the complete sample, see [Writing a Package Sample](https://go.microsoft.com/fwlink/?LinkID=160055).
70-
65+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/PackageWrite/visualbasic/packagewrite.vb" id="Snippetpackagewritecreatepackage":::
66+
7167
]]></format>
7268
</remarks>
7369
<altmember cref="T:System.IO.Packaging.PackagePart" />
74-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=160055">Writing a Package Sample</related>
75-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=160034">Reading a Package Sample</related>
7670
</Docs>
7771
<Members>
7872
<Member MemberName="CreatePartCore">
@@ -309,13 +303,13 @@
309303
<returns>An array of <see cref="T:System.IO.Packaging.ZipPackagePart" /> objects.</returns>
310304
<remarks>
311305
<format type="text/markdown"><![CDATA[
312-
313-
Some or all of the parts may be interleaved. The Part object for an interleaved part encapsulates the Uri of the proper part name and the ZipFileInfo of the initial piece. This function does not go through the extra work of checking piece naming validity throughout the package.
314-
306+
307+
Some or all of the parts may be interleaved. The Part object for an interleaved part encapsulates the Uri of the proper part name and the ZipFileInfo of the initial piece. This function does not go through the extra work of checking piece naming validity throughout the package.
308+
315309
This means that interleaved parts without an initial piece will be silently ignored. Other naming anomalies are caught at the stream level when an I/O operation involves an anomalous or missing piece.
316-
310+
317311
This function reads directly from the underlying IO layer and is supposed to be called just once in the lifetime of a package (at initialization time).
318-
312+
319313
]]></format>
320314
</remarks>
321315
</Docs>

xml/System.IO.Packaging/ZipPackagePart.xml

+5-7
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,13 @@
3939
<Docs>
4040
<summary>Represents a part that is stored in a <see cref="T:System.IO.Packaging.ZipPackage" />.</summary>
4141
<remarks>
42-
<format type="text/markdown"><![CDATA[
43-
44-
## Remarks
45-
<xref:System.IO.Packaging.ZipPackagePart> provides the derived <xref:System.IO.Packaging.PackagePart> implementation for parts that are stored in a <xref:System.IO.Packaging.ZipPackage>.
46-
42+
<format type="text/markdown"><![CDATA[
43+
44+
## Remarks
45+
<xref:System.IO.Packaging.ZipPackagePart> provides the derived <xref:System.IO.Packaging.PackagePart> implementation for parts that are stored in a <xref:System.IO.Packaging.ZipPackage>.
46+
4747
]]></format>
4848
</remarks>
49-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=160055">Writing a Package Sample</related>
50-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=160034">Reading a Package Sample</related>
5149
</Docs>
5250
<Members>
5351
<Member MemberName="GetStreamCore">

0 commit comments

Comments
 (0)