Skip to content

Commit ea085d5

Browse files
mikeblomeColin Robertson
authored and
Colin Robertson
committed
replaced various token includes with plain text (#283)
1 parent 78badac commit ea085d5

File tree

616 files changed

+3401
-3342
lines changed

Some content is hidden

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

616 files changed

+3401
-3342
lines changed

docs/atl-mfc-shared/reference/cimage-class.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ BOOL BitBlt(
343343
The logical y-coordinate of the upper left corner of the destination rectangle.
344344

345345
`dwROP`
346-
The raster operation to be performed. Raster-operation codes define exactly how to combine the bits of the source, the destination, and the pattern (as defined by the currently selected brush) to form the destination. See [BitBlt](http://msdn.microsoft.com/library/windows/desktop/dd183370) in the [!INCLUDE[winSDK](./includes/winsdk_md.md)] for a list of other raster-operation codes and their descriptions.
346+
The raster operation to be performed. Raster-operation codes define exactly how to combine the bits of the source, the destination, and the pattern (as defined by the currently selected brush) to form the destination. See [BitBlt](http://msdn.microsoft.com/library/windows/desktop/dd183370) in the Windows SDK for a list of other raster-operation codes and their descriptions.
347347

348348
`pointDest`
349349
A [POINT](http://msdn.microsoft.com/library/windows/desktop/dd162805) structure indicating the upper left corner of the destination rectangle.
@@ -370,7 +370,7 @@ BOOL BitBlt(
370370
Nonzero if successful; otherwise zero.
371371

372372
### Remarks
373-
For more information, see [BitBlt](http://msdn.microsoft.com/library/windows/desktop/dd183370) in the [!INCLUDE[winSDK](./includes/winsdk_md.md)].
373+
For more information, see [BitBlt](http://msdn.microsoft.com/library/windows/desktop/dd183370) in the Windows SDK.
374374

375375
## <a name="cimage"></a> CImage::CImage
376376
Constructs a `CImage` object.
@@ -449,7 +449,7 @@ BOOL CreateEx(
449449
- **BI_BITFIELDS** The format is uncompressed and the color table consists of three `DWORD` color masks that specify the red, green, and blue components, respectively, of each pixel. This is valid when used with 16- and 32-bpp bitmaps.
450450

451451
*pdwBitfields*
452-
Only used if `eCompression` is set to **BI_BITFIELDS**, otherwise it must be **NULL**. A pointer to an array of three `DWORD` bitmasks, specifying which bits of each pixel are used for the red, green, and blue components of the color, respectively. For information on restrictions for the bitfields, see [BITMAPINFOHEADER](http://msdn.microsoft.com/library/windows/desktop/dd183376) in the [!INCLUDE[winSDK](./includes/winsdk_md.md)].
452+
Only used if `eCompression` is set to **BI_BITFIELDS**, otherwise it must be **NULL**. A pointer to an array of three `DWORD` bitmasks, specifying which bits of each pixel are used for the red, green, and blue components of the color, respectively. For information on restrictions for the bitfields, see [BITMAPINFOHEADER](http://msdn.microsoft.com/library/windows/desktop/dd183376) in the Windows SDK.
453453

454454
`dwFlags`
455455
Specifies if the bitmap object has an alpha channel. Can be a combination of zero or more of the following values:
@@ -603,7 +603,7 @@ int GetBPP() const throw();
603603
### Remarks
604604
This value determines the number of bits that define each pixel and the maximum number of colors in the bitmap.
605605
606-
The bits per pixel is usually 1, 4, 8, 16, 24, or 32. See the **biBitCount** member of [BITMAPINFOHEADER](http://msdn.microsoft.com/library/windows/desktop/dd183376) in the [!INCLUDE[winSDK](./includes/winsdk_md.md)] for more information about this value.
606+
The bits per pixel is usually 1, 4, 8, 16, 24, or 32. See the **biBitCount** member of [BITMAPINFOHEADER](http://msdn.microsoft.com/library/windows/desktop/dd183376) in the Windows SDK for more information about this value.
607607
608608
## <a name="getcolortable"></a> CImage::GetColorTable
609609
Retrieves red, green, blue (RGB) color values from a range of entries in the palette of the DIB section.
@@ -656,7 +656,7 @@ static HRESULT GetExporterFilterString(CSimpleString& strExporters,
656656
An array of GUIDs, with each element corresponding to one of the file types in the string. In the example in `pszAllFilesDescription` below, `aguidFileTypes`[0] is `GUID_NULL` and the remaining array values are the image file formats supported by the current operating system.
657657
658658
> [!NOTE]
659-
> For a complete list of constants, see **Image File Format Constants** in the [!INCLUDE[winSDK](./includes/winsdk_md.md)].
659+
> For a complete list of constants, see **Image File Format Constants** in the Windows SDK.
660660
661661
`pszAllFilesDescription`
662662
If this parameter is not **NULL**, the filter string will have one additional filter at the beginning of the list. This filter will have the current value of `pszAllFilesDescription` for its description, and accepts files of any extension supported by any other exporter in the list.
@@ -745,7 +745,7 @@ static HRESULT GetImporterFilterString(CSimpleString& strImporters,
745745
An array of GUIDs, with each element corresponding to one of the file types in the string. In the example in `pszAllFilesDescription` below, `aguidFileTypes`[0] is `GUID_NULL` with the remaining array values are the image file formats supported by the current operating system.
746746

747747
> [!NOTE]
748-
> For a complete list of constants, see **Image File Format Constants** in the [!INCLUDE[winSDK](./includes/winsdk_md.md)].
748+
> For a complete list of constants, see **Image File Format Constants** in the Windows SDK.
749749
750750
`pszAllFilesDescription`
751751
If this parameter is not **NULL**, the filter string will have one additional filter at the beginning of the list. This filter will have the current value of `pszAllFilesDescription` for its description, and accepts files of any extension supported by any other exporter in the list.
@@ -1081,7 +1081,7 @@ BOOL MaskBlt(
10811081
The vertical pixel offset for the mask bitmap specified by the `hbmMask` parameter.
10821082
10831083
`dwROP`
1084-
Specifies both foreground and background ternary raster operation codes that the method uses to control the combination of source and destination data. The background raster operation code is stored in the high-order byte of the high-order word of this value; the foreground raster operation code is stored in the low-order byte of the high-order word of this value; the low-order word of this value is ignored, and should be zero. For a discussion of foreground and background in the context of this method, see `MaskBlt` in the [!INCLUDE[winSDK](./includes/winsdk_md.md)]. For a list of common raster operation codes, see `BitBlt` in the [!INCLUDE[winSDK](./includes/winsdk_md.md)].
1084+
Specifies both foreground and background ternary raster operation codes that the method uses to control the combination of source and destination data. The background raster operation code is stored in the high-order byte of the high-order word of this value; the foreground raster operation code is stored in the low-order byte of the high-order word of this value; the low-order word of this value is ignored, and should be zero. For a discussion of foreground and background in the context of this method, see `MaskBlt` in the Windows SDK. For a list of common raster operation codes, see `BitBlt` in the Windows SDK.
10851085
10861086
`rectDest`
10871087
A reference to a `RECT` structure, identifying the destination.
@@ -1172,7 +1172,7 @@ BOOL PlgBlt(
11721172
### Remarks
11731173
If `hbmMask` identifies a valid monochrome bitmap, **PlgBit** uses this bitmap to mask the bits of color data from the source rectangle.
11741174
1175-
This method applies to Windows NT, versions 4.0 and later only. See [PlgBlt](http://msdn.microsoft.com/library/windows/desktop/dd162804) in the [!INCLUDE[winSDK](./includes/winsdk_md.md)] for more detailed information.
1175+
This method applies to Windows NT, versions 4.0 and later only. See [PlgBlt](http://msdn.microsoft.com/library/windows/desktop/dd162804) in the Windows SDK for more detailed information.
11761176
11771177
## <a name="releasedc"></a> CImage::ReleaseDC
11781178
Releases the device context.
@@ -1224,7 +1224,7 @@ HRESULT Save(LPCTSTR pszFileName,
12241224
- **ImageFormatGIF** A GIF compressed image.
12251225
12261226
> [!NOTE]
1227-
> For a complete list of constants, see **Image File Format Constants** in the [!INCLUDE[winSDK](./includes/winsdk_md.md)].
1227+
> For a complete list of constants, see **Image File Format Constants** in the Windows SDK.
12281228
12291229
### Return Value
12301230
A standard `HRESULT`.
@@ -1390,7 +1390,7 @@ BOOL StretchBlt(
13901390
The height, in logical units, of the destination rectangle.
13911391
13921392
`dwROP`
1393-
The raster operation to be performed. Raster-operation codes define exactly how to combine the bits of the source, the destination, and the pattern (as defined by the currently selected brush) to form the destination. See [BitBlt](http://msdn.microsoft.com/library/windows/desktop/dd183370) in the [!INCLUDE[winSDK](./includes/winsdk_md.md)] for a list of other raster-operation codes and their descriptions.
1393+
The raster operation to be performed. Raster-operation codes define exactly how to combine the bits of the source, the destination, and the pattern (as defined by the currently selected brush) to form the destination. See [BitBlt](http://msdn.microsoft.com/library/windows/desktop/dd183370) in the Windows SDK for a list of other raster-operation codes and their descriptions.
13941394
13951395
`rectDest`
13961396
A reference to a [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure, identifying the destination.
@@ -1414,7 +1414,7 @@ BOOL StretchBlt(
14141414
Nonzero if successful, otherwise 0.
14151415
14161416
### Remarks
1417-
For more information, see [StretchBlt](http://msdn.microsoft.com/library/windows/desktop/dd145120) in the [!INCLUDE[winSDK](./includes/winsdk_md.md)].
1417+
For more information, see [StretchBlt](http://msdn.microsoft.com/library/windows/desktop/dd145120) in the Windows SDK.
14181418
14191419
## <a name="transparentblt"></a> CImage::TransparentBlt
14201420
Copies a bitmap from the source device context to this current device context.

docs/atl-mfc-shared/reference/coledatetime-class.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ COleDateTime(const DBTIMESTAMP& dbts) throw();
204204
A `SYSTEMTIME` structure to be converted to a date/time value and copied into the new `COleDateTime` object.
205205

206206
`filetimeSrc`
207-
A `FILETIME` structure to be converted to a date/time value and copied into the new `COleDateTime` object. Note that `FILETIME` uses Universal Coordinated Time (UTC), so if you pass a local time in the structure, your results will be incorrect. See [File Times](http://msdn.microsoft.com/library/windows/desktop/ms724290) in the [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)] for more information.
207+
A `FILETIME` structure to be converted to a date/time value and copied into the new `COleDateTime` object. Note that `FILETIME` uses Universal Coordinated Time (UTC), so if you pass a local time in the structure, your results will be incorrect. See [File Times](http://msdn.microsoft.com/library/windows/desktop/ms724290) in the Windows SDK for more information.
208208

209209
`nYear`, `nMonth`, `nDay`, `nHour`, `nMin`, `nSec`
210210
Indicate the date and time values to be copied into the new `COleDateTime` object.
@@ -243,15 +243,15 @@ COleDateTime(const DBTIMESTAMP& dbts) throw();
243243

244244
- `COleDateTime(` *systimeSrc* **)** Constructs a `COleDateTime` object from a `SYSTEMTIME` value.
245245

246-
- `COleDateTime(` `filetimeSrc` **)** Constructs a `COleDateTime` object from a `FILETIME` value. . Note that `FILETIME` uses Universal Coordinated Time (UTC), so if you pass a local time in the structure, your results will be incorrect. See [File Times](http://msdn.microsoft.com/library/windows/desktop/ms724290) in the [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)] for more information.
246+
- `COleDateTime(` `filetimeSrc` **)** Constructs a `COleDateTime` object from a `FILETIME` value. . Note that `FILETIME` uses Universal Coordinated Time (UTC), so if you pass a local time in the structure, your results will be incorrect. See [File Times](http://msdn.microsoft.com/library/windows/desktop/ms724290) in the Windows SDK for more information.
247247

248248
- `COleDateTime(` `nYear`, `nMonth`, `nDay`, `nHour`, `nMin`, `nSec` **)** Constructs a `COleDateTime` object from the specified numerical values.
249249

250250
- `COleDateTime(` `wDosDate`, `wDosTime` **)** Constructs a `COleDateTime` object from the specified MS-DOS date and time values.
251251

252252
For more information on the `time_t` data type, see the [time](../../c-runtime-library/reference/time-time32-time64.md) function in the *Run-Time Library Reference*.
253253

254-
For more information, see the [SYSTEMTIME](http://msdn.microsoft.com/library/windows/desktop/ms724950) and [FILETIME](http://msdn.microsoft.com/library/windows/desktop/ms724284) structures in the [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)].
254+
For more information, see the [SYSTEMTIME](http://msdn.microsoft.com/library/windows/desktop/ms724950) and [FILETIME](http://msdn.microsoft.com/library/windows/desktop/ms724284) structures in the Windows SDK.
255255

256256
For more information about the bounds for `COleDateTime` values, see the article [Date and Time: Automation Support](../../atl-mfc-shared/date-and-time-automation-support.md).
257257

@@ -763,13 +763,13 @@ COleDateTime& operator=(const UDATE& udate) throw();
763763

764764
- **operator =(** `udate` **)** The **UDATE** value is converted and copied into this `COleDateTime` object. If the conversion is successful, the status of this object is set to valid; if unsuccessful, it is set to invalid. A **UDATE** structure represents an "unpacked" date. See the function [VarDateFromUdate](http://msdn.microsoft.com/en-us/1c924ac5-b896-49e1-9ccf-825ac7a030c8) for more details.
765765

766-
- **operator =(** `filetimeSrc` **)** The [FILETIME](http://msdn.microsoft.com/library/windows/desktop/ms724284) value is converted and copied into this `COleDateTime` object. If the conversion is successful, the status of this object is set to valid; otherwise it is set to invalid. `FILETIME` uses Universal Coordinated Time (UTC), so if you pass a UTC time in the structure, your results will be converted from UTC time to local time, and will be stored as variant time. This behavior is the same as in Visual C++ 6.0 and Visual C++.NET 2003 SP2. See [File Times](http://msdn.microsoft.com/library/windows/desktop/ms724290) in the [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)] for more information.
766+
- **operator =(** `filetimeSrc` **)** The [FILETIME](http://msdn.microsoft.com/library/windows/desktop/ms724284) value is converted and copied into this `COleDateTime` object. If the conversion is successful, the status of this object is set to valid; otherwise it is set to invalid. `FILETIME` uses Universal Coordinated Time (UTC), so if you pass a UTC time in the structure, your results will be converted from UTC time to local time, and will be stored as variant time. This behavior is the same as in Visual C++ 6.0 and Visual C++.NET 2003 SP2. See [File Times](http://msdn.microsoft.com/library/windows/desktop/ms724290) in the Windows SDK for more information.
767767

768-
For more information, see the [VARIANT](http://msdn.microsoft.com/en-us/e305240e-9e11-4006-98cc-26f4932d2118) entry in the [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)].
768+
For more information, see the [VARIANT](http://msdn.microsoft.com/en-us/e305240e-9e11-4006-98cc-26f4932d2118) entry in the Windows SDK.
769769

770770
For more information on the `time_t` data type, see the [time](../../c-runtime-library/reference/time-time32-time64.md) function in the *Run-Time Library Reference*.
771771

772-
For more information, see the [SYSTEMTIME](http://msdn.microsoft.com/library/windows/desktop/ms724950) and [FILETIME](http://msdn.microsoft.com/library/windows/desktop/ms724284) structures in the [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)].
772+
For more information, see the [SYSTEMTIME](http://msdn.microsoft.com/library/windows/desktop/ms724950) and [FILETIME](http://msdn.microsoft.com/library/windows/desktop/ms724284) structures in the Windows SDK.
773773

774774
For more information about the bounds for `COleDateTime` values, see the article [Date and Time: Automation Support](../../atl-mfc-shared/date-and-time-automation-support.md).
775775

docs/atl-mfc-shared/reference/cstringt-class.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -235,9 +235,9 @@ BSTR AllocSysString() const;
235235
### Remarks
236236
In MFC programs, a [CMemoryException Class](../../mfc/reference/cmemoryexception-class.md) is thrown if insufficient memory exists. In ATL programs, a [CAtlException](../../atl/reference/catlexception-class.md) is thrown. This function is normally used to return strings for Automation.
237237

238-
Commonly, if this string is passed to a COM function as an [in] parameter, then this requires the caller to free the string. This can be done by using [SysFreeString](http://msdn.microsoft.com/en-us/8f230ee3-5f6e-4cb9-a910-9c90b754dcd3), as described in the [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)]. For more information, see [Allocating and Releasing Memory for a BSTR](../../atl-mfc-shared/allocating-and-releasing-memory-for-a-bstr.md).
238+
Commonly, if this string is passed to a COM function as an [in] parameter, then this requires the caller to free the string. This can be done by using [SysFreeString](http://msdn.microsoft.com/en-us/8f230ee3-5f6e-4cb9-a910-9c90b754dcd3), as described in the Windows SDK. For more information, see [Allocating and Releasing Memory for a BSTR](../../atl-mfc-shared/allocating-and-releasing-memory-for-a-bstr.md).
239239

240-
For more information about OLE allocation functions in Windows, see [SysAllocString](http://msdn.microsoft.com/en-us/9e0437a2-9b4a-4576-88b0-5cb9d08ca29b) in the [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)].
240+
For more information about OLE allocation functions in Windows, see [SysAllocString](http://msdn.microsoft.com/en-us/9e0437a2-9b4a-4576-88b0-5cb9d08ca29b) in the Windows SDK.
241241

242242
### Example
243243
The following example demonstrates the use of `CStringT::AllocSysString`.
@@ -641,7 +641,7 @@ void __cdecl FormatMessage(PCXSTR pszFormat, [, argument]...);
641641
> [!NOTE]
642642
> `FormatMessage` attempts to allocate system memory for the newly formatted string. If this attempt fails, a memory exception is automatically thrown.
643643
644-
Each insert must have a corresponding parameter following the `pszFormat` or `nFormatID` parameter. Within the message text, several escape sequences are supported for dynamically formatting the message. For more information, see the Windows [FormatMessage](http://msdn.microsoft.com/library/windows/desktop/ms679351) function in the [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)].
644+
Each insert must have a corresponding parameter following the `pszFormat` or `nFormatID` parameter. Within the message text, several escape sequences are supported for dynamically formatting the message. For more information, see the Windows [FormatMessage](http://msdn.microsoft.com/library/windows/desktop/ms679351) function in the Windows SDK.
645645

646646
### Example
647647
[!code-cpp[NVC_ATLMFC_Utilities#118](../../atl-mfc-shared/codesnippet/cpp/cstringt-class_13.cpp)]
@@ -666,7 +666,7 @@ void FormatMessageV(PCXSTR pszFormat, va_list* pArgList);
666666
> [!NOTE]
667667
> `FormatMessageV` calls [CStringT::FormatMessage](#formatmessage), which attempts to allocate system memory for the newly formatted string. If this attempt fails, a memory exception is automatically thrown.
668668
669-
For more information, see the Windows [FormatMessage](http://msdn.microsoft.com/library/windows/desktop/ms679351) function in the [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)].
669+
For more information, see the Windows [FormatMessage](http://msdn.microsoft.com/library/windows/desktop/ms679351) function in the Windows SDK.
670670

671671
## <a name="formatv"></a> CStringT::FormatV
672672
Formats a message string using a variable argument list.

0 commit comments

Comments
 (0)