Skip to content

Commit 6c821fd

Browse files
mikeblomeColin Robertson
authored andcommitted
msdn link fixes in atl-mfc for offline books (MicrosoftDocs#221)
* convert msdn links to site links in atl part 1 * more msdn links changed to local * fixed broken links from previous commit * fixed remaining broken * msdn link fixes in dotnet, atl, windows, parallel * corrected human-induced errors * additional fixes for offline
1 parent 4185763 commit 6c821fd

File tree

366 files changed

+10435
-10428
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

366 files changed

+10435
-10428
lines changed

docs/atl/atl-encoding-reference.md

Lines changed: 21 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -40,35 +40,27 @@ Encoding in a range of common Internet standards such as uuencode, hexadecimal,
4040

4141
|||
4242
|-|-|
43-
|[AtlGetHexValue](http://msdn.microsoft.com/library/d6868900-7e1b-44c0-9a73-9635f3f2811e)|Call this function to get the numeric value of a hexadecimal digit.|
44-
|[AtlHexDecode](http://msdn.microsoft.com/library/305ccc56-7f96-4795-b297-b04e58c98187)|Decodes a string of data that has been encoded as hexadecimal text such as by a previous call to [AtlHexEncode](http://msdn.microsoft.com/library/256f1d5c-ca40-488e-bcfb-503cf6ac0ea8).|
45-
|[AtlHexDecodeGetRequiredLength](http://msdn.microsoft.com/library/d2a28877-fe5e-420d-93b4-3b46d910d752)|Call this function to get the size in bytes of a buffer that could contain data decoded from a hex-encoded string of the specified length.|
46-
|[AtlHexEncode](http://msdn.microsoft.com/library/256f1d5c-ca40-488e-bcfb-503cf6ac0ea8)|Call this function to encode some data as a string of hexadecimal text.|
47-
|[AtlHexEncodeGetRequiredLength](http://msdn.microsoft.com/library/7decfd9b-7227-4676-b16f-f50ffc6c0caa)|Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.|
48-
|[AtlUnicodeToUTF8](http://msdn.microsoft.com/library/104f13d8-379c-4bb0-b894-e54cad7ed9aa)|Call this function to convert a Unicode string to UTF-8.|
49-
|[BEncode](http://msdn.microsoft.com/library/cb8f07fb-d0a6-438f-97e9-459ac34df11f)|Call this function to convert some data using the "B" encoding.|
50-
|[BEncodeGetRequiredLength](http://msdn.microsoft.com/library/2bd75b97-fe14-4b30-99c6-b943269eef25)|Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.|
51-
|[EscapeXML](http://msdn.microsoft.com/library/bc8793f9-538a-487a-b47d-2ef95e84a15b)|Call this function to convert characters that are unsafe for use in XML to their safe equivalents.|
52-
|[GetExtendedChars](http://msdn.microsoft.com/library/26c5fa33-f313-4c4b-baf7-cca2ac11885c)|Call this function to get the number of extended characters in a string.|
53-
|[IsExtendedChar](http://msdn.microsoft.com/library/9c6721f5-ddfb-478b-a976-fe015bdf2ec1)|Call this function to find out if a given character is an extended character (less than 32, greater than 126, and not a tab, linefeed or carriage return)|
54-
|[QEncode](http://msdn.microsoft.com/library/6dba5385-ecfc-4a18-85ab-4e8a224384f9)|Call this function to convert some data using the "Q" encoding.|
55-
|[QEncodeGetRequiredLength](http://msdn.microsoft.com/library/7f9faf68-66a5-4f33-87c4-dcd97eeaae4f)|Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.|
56-
|[QPDecode](http://msdn.microsoft.com/library/c5caf731-9bc4-4740-8899-720f84ed014c)|Decodes a string of data that has been encoded in quoted-printable format such as by a previous call to [QPEncode](http://msdn.microsoft.com/library/f6ea53d6-3677-48bd-8717-74a3900fa3c5).|
57-
|[QPDecodeGetRequiredLength](http://msdn.microsoft.com/library/84750f57-75c3-4c0d-bcfa-57a55d034198)|Call this function to get the size in bytes of a buffer that could contain data decoded from quoted-printable-encoded string of the specified length.|
58-
|[QPEncode](http://msdn.microsoft.com/library/f6ea53d6-3677-48bd-8717-74a3900fa3c5)|Call this function to encode some data in quoted-printable format.|
59-
|[QPEncodeGetRequiredLength](http://msdn.microsoft.com/library/68652cfd-17f0-45c6-a12a-3a6096ea11e5)|Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.|
60-
|[UUDecode](http://msdn.microsoft.com/library/5841f625-166f-4f4a-a4f8-841982fa7a22)|Decodes a string of data that has been uuencoded such as by a previous call to [UUEncode](http://msdn.microsoft.com/library/26fc4290-23ed-4f40-935a-93f30edab161).|
61-
|[UUDecodeGetRequiredLength](http://msdn.microsoft.com/library/abfa1d1f-caf6-4029-a94c-1a48937791dd)|Call this function to get the size in bytes of a buffer that could contain data decoded from a uuencoded string of the specified length.|
62-
|[UUEncode](http://msdn.microsoft.com/library/26fc4290-23ed-4f40-935a-93f30edab161)|Call this function to uuencode some data.|
63-
|[UUEncodeGetRequiredLength](http://msdn.microsoft.com/library/df54060a-ed3b-4883-bdae-5d4b28db7c86)|Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.|
64-
65-
### Macros
66-
67-
|||
68-
|-|-|
69-
|[ATL_ESC Flags](http://msdn.microsoft.com/library/daf3aa3c-7498-4d63-9fb6-e05b4815c2b8)|These flags are used to control the behavior of [EscapeXML](http://msdn.microsoft.com/library/bc8793f9-538a-487a-b47d-2ef95e84a15b).|
70-
|[ATLSMTP_QPENCODE Flags](http://msdn.microsoft.com/library/6b15a3ab-8e57-49e4-8104-09b26ebb96c4)|These flags describe how quoted-printable encoding is to be performed by [QPEncode](http://msdn.microsoft.com/library/f6ea53d6-3677-48bd-8717-74a3900fa3c5).|
71-
|[ATLSMTP_UUENCODE Flags](http://msdn.microsoft.com/library/ecb79b81-b764-4a48-a05c-a9dee6e7bbce)|These flags describe how uuencoding is to be performed by [UUEncode](http://msdn.microsoft.com/library/26fc4290-23ed-4f40-935a-93f30edab161).|
43+
|[AtlGetHexValue](reference/atl-text-encoding-functions.md#atlgethexvalue)|Call this function to get the numeric value of a hexadecimal digit.|
44+
|[AtlHexDecode](reference/atl-text-encoding-functions.md#atlhexdecode)|Decodes a string of data that has been encoded as hexadecimal text such as by a previous call to [AtlHexEncode](reference/atl-text-encoding-functions.md#atlhexencode).|
45+
|[AtlHexDecodeGetRequiredLength](reference/atl-text-encoding-functions.md#atlhexdecodegetrequiredlength)|Call this function to get the size in bytes of a buffer that could contain data decoded from a hex-encoded string of the specified length.|
46+
|[AtlHexEncode](reference/atl-text-encoding-functions.md#atlhexencode)|Call this function to encode some data as a string of hexadecimal text.|
47+
|[AtlHexEncodeGetRequiredLength](reference/atl-text-encoding-functions.md#atlhexencodegetrequiredlength)|Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.|
48+
|[AtlUnicodeToUTF8](reference/atl-text-encoding-functions.md#atlunicodetoutf8)|Call this function to convert a Unicode string to UTF-8.|
49+
|[BEncode](reference/atl-text-encoding-functions.md#bencode)|Call this function to convert some data using the "B" encoding.|
50+
|[BEncodeGetRequiredLength](reference/atl-text-encoding-functions.md#bencodegetrequiredlength)|Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.|
51+
|[EscapeXML](reference/atl-text-encoding-functions.md#escapexml)|Call this function to convert characters that are unsafe for use in XML to their safe equivalents.|
52+
|[GetExtendedChars](reference/atl-text-encoding-functions.md#getextendedchars)|Call this function to get the number of extended characters in a string.|
53+
|[IsExtendedChar](reference/atl-text-encoding-functions.md#isextendedchar)|Call this function to find out if a given character is an extended character (less than 32, greater than 126, and not a tab, linefeed or carriage return)|
54+
|[QEncode](reference/atl-text-encoding-functions.md#qencode)|Call this function to convert some data using the "Q" encoding.|
55+
|[QEncodeGetRequiredLength](reference/atl-text-encoding-functions.md#qencodegetrequiredlength)|Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.|
56+
|[QPDecode](reference/atl-text-encoding-functions.md#qpdecode)|Decodes a string of data that has been encoded in quoted-printable format such as by a previous call to [QPEncode](reference/atl-text-encoding-functions.md#qpencode).|
57+
|[QPDecodeGetRequiredLength](reference/atl-text-encoding-functions.md#qpdecodegetrequiredlength)|Call this function to get the size in bytes of a buffer that could contain data decoded from quoted-printable-encoded string of the specified length.|
58+
|[QPEncode](reference/atl-text-encoding-functions.md#qpencode)|Call this function to encode some data in quoted-printable format.|
59+
|[QPEncodeGetRequiredLength](reference/atl-text-encoding-functions.md#qpencodegetrequiredlength)|Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.|
60+
|[UUDecode](reference/atl-text-encoding-functions.md#uudecode)|Decodes a string of data that has been uuencoded such as by a previous call to [UUEncode](reference/atl-text-encoding-functions.md#uuencode).|
61+
|[UUDecodeGetRequiredLength](reference/atl-text-encoding-functions.md#uudecodegetrequiredlength)|Call this function to get the size in bytes of a buffer that could contain data decoded from a uuencoded string of the specified length.|
62+
|[UUEncode](reference/atl-text-encoding-functions.md#uuencode)|Call this function to uuencode some data.|
63+
|[UUEncodeGetRequiredLength](reference/atl-text-encoding-functions.md#uuencodegetrequiredlength)|Call this function to get the size in characters of a buffer that could contain a string encoded from data of the specified size.|
7264

7365
## See Also
7466
[Concepts](../atl/active-template-library-atl-concepts.md)

docs/atl/atl-event-handling-summary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ In general, handling COM events is a relatively simple process. There are three
6060
|Advise function|Unadvise function|Most suitable for use with|Requires you to keep track of a cookie|Comments|
6161
|---------------------|-----------------------|--------------------------------|---------------------------------------------|--------------|
6262

63-
|[AtlAdvise](http://msdn.microsoft.com/library/625a2f03-6b7f-4761-be5d-d2871d1d3254), [CComPtrBase::Advise](../atl/reference/ccomptrbase-class.md#advise)|[AtlUnadvise](http://msdn.microsoft.com/library/939d2e50-e2df-4e8f-a16a-e9650b8f0340)|Vtable or dual interfaces|Yes|`AtlAdvise` is a global ATL function. `CComPtrBase::Advise` is used by [CComPtr](../atl/reference/ccomptr-class.md) and [CComQIPtr](../atl/reference/ccomqiptr-class.md).|
63+
|[AtlAdvise](reference/connection-point-global-functions.md#atladvise), [CComPtrBase::Advise](../atl/reference/ccomptrbase-class.md#advise)|[AtlUnadvise](reference/connection-point-global-functions.md#atlunadvise)|Vtable or dual interfaces|Yes|`AtlAdvise` is a global ATL function. `CComPtrBase::Advise` is used by [CComPtr](../atl/reference/ccomptr-class.md) and [CComQIPtr](../atl/reference/ccomqiptr-class.md).|
6464

6565
|[IDispEventSimpleImpl::DispEventAdvise](../atl/reference/idispeventsimpleimpl-class.md#dispeventadvise)|[IDispEventSimpleImpl::DispEventUnadvise](../atl/reference/idispeventsimpleimpl-class.md#dispeventunadvise)|[IDispEventImpl](../atl/reference/idispeventimpl-class.md) or [IDispEventSimpleImpl](../atl/reference/idispeventsimpleimpl-class.md)|No|Fewer parameters than `AtlAdvise` since the base class does more work.|
6666
|[CComCompositeControl::AdviseSinkMap(TRUE)](../atl/reference/ccomcompositecontrol-class.md#advisesinkmap)|[CComCompositeControl::AdviseSinkMap(FALSE)](../atl/reference/ccomcompositecontrol-class.md#advisesinkmap)|ActiveX controls in Composite controls|No|`CComCompositeControl::AdviseSinkMap` advises all entries in the event sink map. The same function unadvises the entries. This method is called automatically by the `CComCompositeControl` class.|

docs/atl/atl-utilities-reference.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -110,15 +110,7 @@ ATL provides code for manipulating paths and URLs in the form of [CPathT](../atl
110110
|[ATLPath::StripToRoot](../atl/reference/atl-path-functions.md#striptoroot)|This function is an overloaded wrapper for [PathStripToRoot](http://msdn.microsoft.com/library/windows/desktop/bb773757).|
111111
|[ATLPath::UnquoteSpaces](../atl/reference/atl-path-functions.md#unquotespaces)|This function is an overloaded wrapper for [PathUnquoteSpaces](http://msdn.microsoft.com/library/windows/desktop/bb773763).|
112112

113-
### Macros
114-
115-
|||
116-
|-|-|
117-
|[ATL_URL Flags](http://msdn.microsoft.com/library/76e8cc5c-4e17-4eb1-ac29-a94d5256c4a7)|These flags modify the behavior of [AtlEscapeUrl](http://msdn.microsoft.com/library/e4413300-dd10-43ad-9eaf-772e58398316) and [AtlCanonicalizeUrl](http://msdn.microsoft.com/library/80015d95-081d-4bbb-a176-77670cdb16e8) .|
118-
|[ATL_WORKER_THREAD_WAIT](http://msdn.microsoft.com/library/4d209004-47f4-4c6a-98b4-aee49ffb0911)|This macro defines the default value in milliseconds that [CWorkerThread::Shutdown](../atl/reference/cworkerthread-class.md#shutdown) will wait for the worker thread to shut down.|
119-
|[ATLS_DEFAULT_THREADPOOLSHUTDOWNTIMEOUT](http://msdn.microsoft.com/library/c1e660a7-d490-42af-bbe1-ded76e80cc10)|This macro defines the default time in milliseconds that [CThreadPool](../atl/reference/cthreadpool-class.md) will wait for a thread to shut down.|
120-
|[ATLS_DEFAULT_THREADSPERPROC](http://msdn.microsoft.com/library/e0dcf107-72a9-4122-abb4-83c63aa7d571)|This macro defines the default number of threads per processor used by [CThreadPool](../atl/reference/cthreadpool-class.md).|
121-
113+
122114
## See Also
123115
[Concepts](../atl/active-template-library-atl-concepts.md)
124116
[ATL COM Desktop Components](../atl/atl-com-desktop-components.md)

docs/atl/changing-the-default-class-factory-and-aggregation-model.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ translation.priority.ht:
4343
# Changing the Default Class Factory and Aggregation Model
4444
ATL uses [CComCoClass](../atl/reference/ccomcoclass-class.md) to define the default class factory and aggregation model for your object. `CComCoClass` specifies the following two macros:
4545

46-
- [DECLARE_CLASSFACTORY](http://msdn.microsoft.com/library/51a6b925-07c0-4d3a-9174-0b8c808975e4) Declares the class factory to be [CComClassFactory](../atl/reference/ccomclassfactory-class.md).
46+
- [DECLARE_CLASSFACTORY](reference/aggregation-and-class-factory-macros.md#declare_classfactory) Declares the class factory to be [CComClassFactory](../atl/reference/ccomclassfactory-class.md).
4747

48-
- [DECLARE_AGGREGATABLE](http://msdn.microsoft.com/library/e7e568d7-04e0-4226-b5dc-224deed229ab) Declares that your object can be aggregated.
48+
- [DECLARE_AGGREGATABLE](reference/aggregation-and-class-factory-macros.md#declare_aggregatable) Declares that your object can be aggregated.
4949

50-
You can override either of these defaults by specifying another macro in your class definition. For example, to use [CComClassFactory2](../atl/reference/ccomclassfactory2-class.md) instead of `CComClassFactory`, specify the [DECLARE_CLASSFACTORY2](http://msdn.microsoft.com/library/38a6c969-7297-4bb1-9ba6-1fe2d355b285) macro:
50+
You can override either of these defaults by specifying another macro in your class definition. For example, to use [CComClassFactory2](../atl/reference/ccomclassfactory2-class.md) instead of `CComClassFactory`, specify the [DECLARE_CLASSFACTORY2](reference/aggregation-and-class-factory-macros.md#declare_classfactory2) macro:
5151

5252
[!code-cpp[NVC_ATL_COM#2](../atl/codesnippet/cpp/changing-the-default-class-factory-and-aggregation-model_1.h)]
5353

54-
Two other macros that define a class factory are [DECLARE_CLASSFACTORY_AUTO_THREAD](http://msdn.microsoft.com/library/19d7105e-03e8-4412-9f5e-5384c8a5e18f) and [DECLARE_CLASSFACTORY_SINGLETON](http://msdn.microsoft.com/library/0e4a3964-c03d-463e-884c-fe3b416db478).
54+
Two other macros that define a class factory are [DECLARE_CLASSFACTORY_AUTO_THREAD](reference/aggregation-and-class-factory-macros.md#declare_classfactory_auto_thread) and [DECLARE_CLASSFACTORY_SINGLETON](reference/aggregation-and-class-factory-macros.md#declare_classfactory_singleton).
5555

5656
ATL also uses the `typedef` mechanism to implement default behavior. For example, the `DECLARE_AGGREGATABLE` macro uses `typedef` to define a type called **_CreatorClass**, which is then referenced throughout ATL. Note that in a derived class, a `typedef` using the same name as the base class's `typedef` results in ATL using your definition and overriding the default behavior.
5757

docs/atl/commandhandler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ translation.priority.ht:
6767
The result of message processing. 0 if successful.
6868

6969
## Remarks
70-
For an example of using this message handler in a message map, see [COMMAND_HANDLER](http://msdn.microsoft.com/library/7b53ffe3-be95-43f7-a21a-dc9516a19f2a).
70+
For an example of using this message handler in a message map, see [COMMAND_HANDLER](reference/message-map-macros-atl.md#command_handler).
7171

7272
## See Also
7373
[Implementing a Window](../atl/implementing-a-window.md)

docs/atl/creating-an-aggregated-object.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ Aggregation delegates **IUnknown** calls, providing a pointer to the outer objec
4242

4343
2. Override [FinalConstruct](../atl/reference/ccomobjectrootex-class.md#finalconstruct) to create the aggregate.
4444

45-
3. Use the **IUnknown** pointer, defined in Step 1, as the second parameter for the [COM_INTERFACE_ENTRY_AGGREGATE](http://msdn.microsoft.com/library/c671fa40-a57b-4797-ae88-c9762dabd4dc) macros.
45+
3. Use the **IUnknown** pointer, defined in Step 1, as the second parameter for the [COM_INTERFACE_ENTRY_AGGREGATE](reference/com-interface-entry-macros.md#com_interface_entry_aggregate) macros.
4646

4747
4. Override [FinalRelease](../atl/reference/ccomobjectrootex-class.md#finalrelease) to release the **IUnknown** pointer.
4848

4949
> [!NOTE]
50-
> If you use and release an interface from the aggregated object during `FinalConstruct`, you should add the [DECLARE_PROTECT_FINAL_CONSTRUCT](http://msdn.microsoft.com/library/2d2e5ddc-057a-43ca-87c8-d3477a8193a0) macro to the definition of your class object.
50+
> If you use and release an interface from the aggregated object during `FinalConstruct`, you should add the [DECLARE_PROTECT_FINAL_CONSTRUCT](reference/aggregation-and-class-factory-macros.md#declare_protect_final_construct) macro to the definition of your class object.
5151
5252
## See Also
5353
[Fundamentals of ATL COM Objects](../atl/fundamentals-of-atl-com-objects.md)

docs/atl/example-implementing-a-property-page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ translation.priority.ht:
3333
- "zh-tw"
3434
---
3535
# Example: Implementing a Property Page
36-
This example shows how to build a property page that displays (and allows you to change) properties of the [Document Classes](../mfc/document-classes.md) interface. This interface is exposed by documents in Visual Studio's [Common Environment Object Model Examples](http://msdn.microsoft.com/library/919cdb58-9f6d-45e6-a0f1-9ca8f6e7051f) (although the property page that you'll create won't care where the objects it manipulates come from as long as they support the correct interface).
36+
This example shows how to build a property page that displays (and allows you to change) properties of the [Document Classes](../mfc/document-classes.md) interface.
3737

3838
The example is based on the [ATLPages sample](../visual-cpp-samples.md).
3939

docs/atl/hosting-activex-controls-using-atl-axhost.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ The sample in this topic shows how to create AXHost and how to host an ActiveX c
6363

6464
## See Also
6565
[Control Containment FAQ](../atl/atl-control-containment-faq.md)
66-
[AtlAxCreateControl](http://msdn.microsoft.com/library/582a883e-2050-4af0-bf27-e89a0948f41d)
67-
[AtlAxCreateControlEx](http://msdn.microsoft.com/library/8b21d43b-7c3e-4ff1-9419-e0bd695d34df)
68-
[AtlAxCreateControlLic](http://msdn.microsoft.com/library/b409bd0e-28c9-4d9a-80a4-8df77a3aff88)
69-
[AtlAxCreateControlLicEx](http://msdn.microsoft.com/library/abcbef3f-fcb0-4c87-8524-bff31e31e1b2)
66+
[AtlAxCreateControl](reference/composite-control-global-functions.md#atlaxcreatecontrol)
67+
[AtlAxCreateControlEx](reference/composite-control-global-functions.md#atlaxcreatecontrolex)
68+
[AtlAxCreateControlLic](reference/composite-control-global-functions.md#atlaxcreatecontrollic)
69+
[AtlAxCreateControlLicEx](reference/composite-control-global-functions.md#atlaxcreatecontrolex)
7070
[CAxWindow2T Class](../atl/reference/caxwindow2t-class.md)
7171
[IAxWinHostWindowLic Interface](../atl/reference/iaxwinhostwindowlic-interface.md)
7272

0 commit comments

Comments
 (0)