diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 75dc5da1e0a..6498b2c6631 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,118 +1,186 @@ -When writing documentation, follow these guidelines: - -## General style tips - -* Get to the point fast. Be concise and clear. -* Talk like a person. -* Simpler is better. -* Be brief. Give customers just enough information to make decisions confidently. Prune excess words. -* Break up long sentences. -* Follow the style of the [Microsoft Writing Style Guide](https://learn.microsoft.com/style-guide/welcome/). If there's a conflict between the following guidelines and the Microsoft Writing Style Guide, ask how to resolve it. - -## Grammar - -* Use present tense verbs (is, open) instead of past tense (was, opened). For example, "The method returns a value" instead of "The method will return a value." -* Write factual statements and direct commands. Avoid hypotheticals. -* Use active voice where the subject performs the action. -* Write in second person (you) to speak directly to readers. -* Use gender-neutral language. -* Avoid multiple -ing words that could create ambiguity. -* Keep prepositional phrases simple and clear. -* Place modifiers close to what they modify. -* Use a conversational tone with contractions. -* Don't use "we" or "our" to refer to the authors of the documentation. -* Use the imperative mood for instructions. For example, "Call the method" instead of "You should call the method." -* Use "might" instead of "may" to indicate possibility. For example, "This method might throw an exception" instead of "This method may throw an exception." -* Use the Oxford comma in lists of three or more items. +# Copilot Instructions for `cpp-docs-pr` + +## Introduction + +This document contains general and repository-specific instructions for GitHub Copilot when assisting with the `cpp-docs-pr` repository. + +## Priority Levels + +This document uses the following markers to indicate instruction priority: + +- **[REQUIRED]** - Must be followed. May cause build failures or PR blocks if violated +- **[STYLE]** - Microsoft Writing Style Guide requirement for consistency +- **[C++-SPECIFIC]** - C++ documentation convention that overrides general guidance +- No marker - Best practice recommendation; use judgment based on context + +## General Guidelines + +### Using MCP tools +If the user intent relates to Azure Devops, make sure to prioritize the Azure DevOps MCP server tools. + +### 1. Issue Handling +When creating a PR for an issue: +- [ ] Read the full issue and all linked references + - [ ] **new-feature:** State which version introduced the feature + - [ ] **bug:** Focus on correcting technical inaccuracies +- [ ] When you're assigned an issue, after you've completed your work and the workflows (status checks) have run, ensure there are no build warnings under the OpenPublishing.Build status check. If there are, open the build report (under View Details) and resolve any build warnings you introduced. +- [ ] When starting work on an issue, document your understanding in a comment: state the issue's purpose, expected outcome, and your implementation approach. + +### 2. Issue Discussion Analysis +When working on an issue: +- [ ] **Read the complete issue discussion** - Don't rely solely on the initial issue description +- [ ] **Prioritize maintainer guidance** - Comments from repository maintainers (especially those with "MEMBER" association) should take precedence over the original issue description +- [ ] **Look for updated analysis** - Later comments may contain revised understanding, additional context, or modified resolution approaches +- [ ] **Check for explicit instructions** - Look for phrases like "Action required by GitHub Copilot" or direct "@copilot" mentions that provide specific guidance +- [ ] **Validate your understanding** - If the discussion seems to contradict the initial issue description, follow the most recent maintainer guidance + +### 3. File Naming and Organization +**Naming conventions:** +- [ ] Name new Markdown files in all lowercase with hyphens separating words +- [ ] Omit filler words like "the" or "a" from file names + +**Folder structure:** +- [ ] Linux topics → `docs/linux/` +- [ ] C++ STL → `docs/standard-library/` +- [ ] C runtime → `docs/c-runtime-library/` +- [ ] C++ language → `docs/cpp/` +- [ ] Visual Studio IDE features → `docs/ide/` +- [ ] Build process/modules → `docs/build/reference/` +- [ ] Build Insights → `docs/build-insights/` + +### 4. Links and References +- [ ] Add links to related topics and resources where appropriate. +- [ ] Use relative links for files in this repo +- [ ] **[REQUIRED]** Links to other documentation articles should be relative, not absolute. Start relative links with `/docs/` and include the `.md` suffix. If you add a link to another page on learn.microsoft.com that's not in this repo, remove https://learn.microsoft.com/en-us from the link. +- [ ] **[REQUIRED]** Links to bookmarks within the same article should be relative and start with `#`. +- [ ] **[REQUIRED]** Link descriptions should be descriptive and make sense on their own. Don't use "click here" or "this link" or "here". +- [ ] **[STYLE]** When you are going to refer to another file or an article on the web, use this format: "For more information, see [descriptive name of link](link path)." The exception to this is the See Also links at the end of an article. Those should be markdown links and contain the title of the article you link to as the descriptive portion of the link. +- [ ] For external links to non-Microsoft sites: + - [ ] **[REQUIRED]** Use absolute URLs + - [ ] **[REQUIRED]** Remove any language or culture segment from the URL path (such as `/en-us/`, `/fr-fr/`, `/en/`, etc.) + - [ ] Example (MDN): + - [ ] Original: `https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event` + - [ ] Correct: `https://developer.mozilla.org/docs/Web/API/Element/click_event` + +- [ ] For links to Microsoft Learn content in other repositories: + - [ ] **[REQUIRED]** Use the relative URL starting with a forward slash + - [ ] Don't include the scheme and the host (example: `https://learn.microsoft.com`) and don't include the locale (example: `en-us`) + - [ ] Example: For the target Learn website URL `https://learn.microsoft.com/en-us/dotnet/core/introduction`, use the relative URL `/dotnet/core/introduction` for the link destination + +## Repository-Specific Guidelines +- [ ] **[REQUIRED]** Follow the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) + - [ ] Use contractions following the guidance in [Use contractions](https://learn.microsoft.com/en-us/style-guide/word-choice/use-contractions) +- [ ] **Repository Exceptions**: + - [ ] **[REQUIRED]** Use **bold** text for UI elements like menu items, dialog names, and names of text boxes. + - [ ] **[REQUIRED]** Number ordered lists as "1." for every item (don't use sequential numbers) + - [ ] **[REQUIRED]** Use backticks around content specifically for file names (`file.txt`), folders (`folder`), file paths (`folder/file.txt`), custom types (`myVariable`, `MyClass`), raw URLs in the text (`https://www.contoso.com`), file extensions (`.cpp`), and code like method names, property names, and language keywords. Also use for text that should never be localized. + - [ ] **[REQUIRED]** Use `code style` for resource names (like virtual machine names) that shouldn't be localized. + - [ ] **[C++-SPECIFIC]** Use `code style` for command-line commands. The style in some articles uses **bold** for command-line commands, but use `code style` instead. + - [ ] **[STYLE]** Use placeholders with braces in the format `{PLACEHOLDER NAME}` when used code examples and other contexts where placeholders are used. Use uppercase letters with spaces between words for the placeholder name inside the braces. + - [ ] Wrong: "Launch the app and navigate to `https://localhost:/openapi/v1.json` to view the generated OpenAPI document." + - [ ] Correct: "Launch the app and navigate to `https://localhost:{PORT}/openapi/v1.json` to view the generated OpenAPI document, where the `{PORT}` placeholder is the port." + - [ ] For any new or updated .md file added to the repository, ensure the following frontmatter (metadata) is included as specified in [Metadata for Microsoft Learn documentation.](https://learn.microsoft.com/en-us/contribute/content/metadata): + - [ ] **[REQUIRED]** Metadata `ai-usage: ai-assisted` if any AI assistance was used. + - [ ] **[REQUIRED]** When updating a topic that has the ms.assetid: metadata, remove the entire ms.assetid line. + - [ ] **[REQUIRED]** Place the title metadata first, followed by the remaining metadata lines as shown in the following example: +**Example:** + ```yaml + --- + title: "Understanding C++ modules" + description: "Learn how to use C++ modules in Visual Studio" + author: github-username + ms.author: ms-alias + ms.date: 12/11/2025 + ms.topic: concept-article + ai-usage: ai-assisted + --- + ``` + +### 5. Content Writing Guidelines +- [ ] **[STYLE]** Get to the point fast. Be concise and clear. +- [ ] **[STYLE]** Talk like a person. +- [ ] **[STYLE]** Simpler is better. +- [ ] **[STYLE]** Be brief. Give customers just enough information to make decisions confidently. Prune excess words. +- [ ] **[STYLE]** Break up long sentences. +- [ ] **[STYLE]** Use present tense verbs (is, open) instead of past tense (was, opened). For example, "The method returns a value" instead of "The method will return a value." +- [ ] **[STYLE]** Write factual statements and direct commands. Avoid hypotheticals. +- [ ] **[STYLE]** Use active voice where the subject performs the action. +- [ ] **[STYLE]** Write in second person (you) to speak directly to readers. +- [ ] **[STYLE]** Use gender-neutral language. +- [ ] **[STYLE]** Avoid multiple -ing words that could create ambiguity. +- [ ] **[STYLE]** Keep prepositional phrases simple and clear. +- [ ] **[STYLE]** Place modifiers close to what they modify. +- [ ] **[STYLE]** Use a conversational tone with contractions. +- [ ] **[STYLE]** Don't use "we" or "our" to refer to the authors of the documentation. +- [ ] **[STYLE]** Use the imperative mood for instructions. For example, "Call the method" instead of "You should call the method." +- [ ] **[STYLE]** Use "might" instead of "may" to indicate possibility. For example, "This method might throw an exception" instead of "This method may throw an exception." +- [ ] **[STYLE]** Use the Oxford comma in lists of three or more items. +- [ ] Introductory paragraph: + - [ ] When drafting the first paragraph of any new article, or when significantly updating an existing article: + - [ ] Explain why and when the topic matters in practical C++ development scenarios. + - [ ] Give a concise summary of what the article covers or enables, so readers know what to expect. + - [ ] When significantly updating, revise the introductory paragraph to match the new scope and content. + +### 6. PR Description Requirements +- [ ] ALWAYS include "Fixes #[issue-number]" in the PR description, at the first line of the description to link back to the original issue +- [ ] Include a clear summary of changes made +- [ ] List all files that were modified with brief descriptions ## Capitalization -* Use sentence-style capitalization for everything except proper nouns. -* Always capitalize proper nouns. -* Don’t capitalize the spelled-out form of an acronym unless it's a proper noun. -* Use title-style capitalization for product and service names. -* Don't use all uppercase for emphasis. +- [ ] Use sentence-style capitalization for everything except proper nouns. +- [ ] Always capitalize proper nouns. +- [ ] Don’t capitalize the spelled-out form of an acronym unless it's a proper noun. +- [ ] Use title-style capitalization for product and service names. +- [ ] Don't use all uppercase for emphasis. ## Numbers -* Spell out numbers for zero through nine, unless space is limited. Use numerals for 10 and above. -* Spell out numbers at the beginning of a sentence. -* Spell out ordinal numbers such as first, second, and third. Don't add -ly to form adverbs from ordinal numbers. -* Number ordered list items all as "1." instead of "1.", "2.", etc. Use bullets for unordered lists. +The following does NOT apply to step numbers but applies to all other numbers: +- [ ] Spell out numbers for zero through nine, unless space is limited. Use numerals for 10 and above. +- [ ] Spell out numbers at the beginning of a sentence. +- [ ] Spell out ordinal numbers such as first, second, and third. Don't add -ly to form adverbs from ordinal numbers. +- [ ] Number ordered list items all as 1. instead of sequentially as 1., 2., etc. Use bullets for unordered lists. ## Punctuation -* Use short, simple sentences. -* End all sentences with a period. -* Use one space after punctuation marks. -* After a colon, capitalize only proper nouns. -* Avoid semicolons - use separate sentences instead. -* Use question marks sparingly. -* Don't use slashes (/) - use "or" instead. - -## Text formatting - -* UI elements, like menu items, dialog names, and names of text boxes, should be in **bold** text. -* Use `code style` for: - * Code elements, like method names, property names, and language keywords. - * SQL commands. - * NuGet package names. - * Command-line commands. - * Database table and column names. - * Resource names (like virtual machine names) that shouldn't be localized. - * URLs that you don't want to be selectable. - * File names and folders, custom types, and other text that should never be localized. -* For code placeholders, if you want users to replace part of an input string with their own values, use angle brackets (less than < and greater than > characters) on that placeholder text. +- [ ] Use short, simple sentences. +- [ ] End all sentences with a period. +- [ ] Use one space after punctuation marks. +- [ ] After a colon, capitalize only proper nouns. +- [ ] Avoid semicolons - use separate sentences instead. +- [ ] Use question marks sparingly. +- [ ] Don't use slashes (/) - use "or" instead. ## Headings -* Headings should be in sentence case, not title case. Don't use gerunds in titles. -* Don't apply an inline style like italic, or bold to headings. But do use inline code style for headings that are code elements, like method names or property names. +- [ ] Headings should be in sentence case, not title case. Don't use gerunds in titles. +- [ ] Don't apply an inline style like italic, or bold to headings. But do use inline code style for headings that are code elements, like method names or property names. ## Alerts -* Alerts are a Markdown extension to create block quotes that render with colors and icons that indicate the significance of the content. The following alert types are supported: +- [ ] Alerts are a Markdown extension to create block quotes that render with colors and icons that indicate the significance of the content. The following alert types are supported: - * `[!NOTE]` Information the user should notice even if skimming. - * `[!TIP]` Optional information to help a user be more successful. - * `[!IMPORTANT]` Essential information required for user success. - * `[!CAUTION]` Negative potential consequences of an action. - * `[!WARNING]` Dangerous certain consequences of an action. - -## Adding links - -* Add links to related topics and resources where appropriate. -* Links to other documentation articles should be relative, not absolute. Start relative links with `/docs/` and include the `.md` suffix. If you add a link to another page on learn.microsoft.com that's not in this repo, remove https://learn.microsoft.com/en-us from the link. -* Links to bookmarks within the same article should be relative and start with `#`. -* Link descriptions should be descriptive and make sense on their own. Don't use "click here" or "this link" or "here". -* When you are going to refer to another file or an article on the web, use this format: "For more information, see [descriptive name of link](link path)." The exception to this is the See Also links at the end of an article. Those should be markdown links and contain the title of the article you link to as the descriptive portion of the link. - -## Adding new files - -* If you add a new Markdown file, it should be named in all lowercase with hyphens separating words. Also, omit any filler words such as "the" or "a" from the file name. -* If you're adding a new Markdown file, the following indicates where it should go the folder structure. If you aren't sure, ask. - If the new file is about Linux, put it in the docs/linux folder. - If the new file is about the C++ Standard Template Library (STL), put it in the docs/standard-library folder. - If the new file is about the C runtime, put it in the docs/c-runtime-library folder. - If the new file is about the C++ language, put it in the docs/cpp folder. - If the new file is about a C++ feature specific to the Visual Studio IDE, put it in the docs/ide folder. - If the new file is about the build process or modules, put it in the docs/build\reference folder. - If the new file is about Build Insights, put it in the docs/build-insights folder. + - [ ] `[!NOTE]` Information the user should notice even if skimming. + - [ ] `[!TIP]` Optional information to help a user be more successful. + - [ ] `[!IMPORTANT]` Essential information required for user success. + - [ ] `[!CAUTION]` Negative potential consequences of an action. + - [ ] `[!WARNING]` Dangerous certain consequences of an action. ## Images -* Use images only when they add value. -* Images have a descriptive and meaningful alt text that starts with "Screenshot showing" and ends with ".". -* Videos have a descriptive and meaningful alt text or title that starts with "Video showing" and ends with ".". +- [ ] Use images only when they add value. +- [ ] Images have a descriptive and meaningful alt text that starts with "Screenshot showing" and ends with ".". +- [ ] Videos have a descriptive and meaningful alt text or title that starts with "Video showing" and ends with ".". ## Numbered steps -* Write complete sentences with capitalization and periods -* Use imperative verbs -* Clearly indicate where actions take place (UI location) -* For single steps, use a bullet instead of a number -* When allowed, use angle brackets for menu sequences (File > Open) +- [ ] Write complete sentences with capitalization and periods +- [ ] Use imperative verbs +- [ ] Clearly indicate where actions take place (UI location) +- [ ] For single steps, use a bullet instead of a number +- [ ] When allowed, use angle brackets for menu sequences (File > Open) ## Terminology -* Use "Select" instead of "Click" for UI elements like buttons, menu items, links, dropdowns, and checkboxes. \ No newline at end of file +- [ ] Use "Select" instead of "Click" for UI elements like buttons, menu items, links, dropdowns, and checkboxes. \ No newline at end of file diff --git a/.github/copilot-issue-verification-action-plan.md b/.github/copilot-issue-verification-action-plan.md new file mode 100644 index 00000000000..3f6d7e270e6 --- /dev/null +++ b/.github/copilot-issue-verification-action-plan.md @@ -0,0 +1,220 @@ +--- +ai-usage: ai-assisted +author: TylerMSFT +ms.author: twhitney +ms.date: 11/13/2025 +--- + +# GitHub issue analysis and action plan prompt for C++ documentation + +## Goal +Analyze the GitHub issue and provide a **structured report** determining: +1. Whether the issue is valid and actionable. +2. Whether the issue is within scope of the articles the issue relates to, or if a new article is needed. +3. The exact documentation changes required (if applicable). +4. A clear action plan that can guide PR creation. + +The report should be suitable for posting directly in the issue discussion. + +--- + +## Analysis Steps + +### 1. Information Gathering +Collect and review: +* The **issue title, description, and all comments**. +* The **published documentation** (via the provided URL). +* The **source file(s)** in the repository. +* Any **linked issues, PRs, or external references**. +* **Environment details**: .NET version, tooling versions (VS, VS Code, CLI, EF Core, etc.). +* **Code samples or error messages** mentioned in the issue. + +### 1.5 Source File Analysis +When examining source files: +* **Provide direct GitHub permalinks** to specific lines or sections. +* **Note exact line numbers** for proposed changes. +* **Include line number ranges** in GitHub URLs using `#L-L` format. +* **Quote current content** from specific lines before proposing changes. +* **Use permalinks with commit SHA** when referencing specific versions. + +Example format for file references: +* Single line: `https://github.com/owner/repo/blob/main/file.md#L123`. +* Line range: `https://github.com/owner/repo/blob/main/file.md#L123-L145`. +* Permalink: `https://github.com/owner/repo/blob//file.md#L123`. + +### 2. Validation Criteria +Determine if the issue is: +* **In scope**: Related to ASP.NET Core documentation (not product bugs). +* **Accurate**: The reported problem genuinely exists. +* **Clear**: Sufficient information to take action. +* **Current**: Applies to supported .NET versions. + +### 3. Translation Requirements +If any content is not in English: +* Include the original text in a quote block. +* Provide complete English translation. +* Label clearly as "Original" and "Translation". + +--- + +## Output Format + +### File Naming +`-analysis-report.md` + +### Report Structure + +#### Header +```markdown +## AI Analysis Report +**Analyzed by:** @ +**Date:** +**Issue:** # +**Model:** GitHub Copilot +--- +``` + +#### For Valid Issues + +```markdown +# Issue Analysis: + +## ✅ Issue Validation +**Status:** Valid and actionable + +## 📋 Issue Summary + + +## 📁 Affected Files +| File | Path | Lines | Section | +|------|------|-------|---------| +| Main article | [`aspnetcore/path/to/file.md`](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md#L123-L145) | 123-145 | "Section Heading" | +| Code sample | [`aspnetcore/path/to/sample.cs`](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/sample.cs#L45-L67) | 45-67 | `MethodName()` method | + +## 📝 Proposed Changes + +### Documentation Updates +**File:** [`aspnetcore/path/to/file.md`](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md#L123-L145) +**Location:** Lines 123-145 (after the paragraph containing "[specific anchor text]") +**Type:** [New paragraph / Note block / Code example / Replacement] + +**Current content (lines 123-125):** +```markdown +[Current text that will be replaced or followed] +``` + +**Proposed change:** +```markdown +[Proposed documentation text here] +``` + +### Code Sample Updates (if applicable) +**File:** [`sample.cs`](https://github.com/dotnet/AspNetCore.Docs/blob/main/path/to/sample.cs#L45-L67) +**Lines:** 45-67 +**Change:** [Add/Modify/Remove] + +**Current code:** +```csharp +// Current code at specified lines +``` + +**Proposed code:** +```csharp +// Proposed code changes +``` + +## 🎯 Action Plan +1. **Edit file:** [`aspnetcore/path/to/file.md`](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md) + * Navigate to: [Line 123](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/path/to/file.md#L123) + * Find section: "Exact Section Heading" + * After text: "last sentence before insertion point" + * Insert: [!NOTE] block with explanation + +2. **Update sample:** [`path/to/sample.cs`](https://github.com/dotnet/AspNetCore.Docs/blob/main/path/to/sample.cs) + * Navigate to: [Lines 45-67](https://github.com/dotnet/AspNetCore.Docs/blob/main/path/to/sample.cs#L45-L67) + * Modify method: `MethodName()` + * Change: Update to use new pattern + +## ⚠️ Considerations +* Verify change applies to .NET [version] +* Check if similar updates needed in related articles +* Consider adding cross-references to [related topic] + +## 🔗 References +* Published article: [URL] +* Related issue: #[number] +* Microsoft Learn docs: [relevant MS docs link] +``` + +#### For Invalid Issues + +```markdown +# Issue Analysis: + +## ❌ Issue Validation +**Status:** Not actionable as is +**Reason:** [Out of scope / Insufficient information / Product issue / Already addressed] + +## 📋 Explanation + + +## 💡 Recommendation +* [Close with explanation] +* [Redirect to appropriate repository] +* [Request additional information] +* [Convert to discussion] + +## 🔗 Alternative Resources +* [Link to relevant documentation] +* [Link to appropriate repository for product issues] +``` + +--- + +## Special Instructions + +### Line Number Guidelines +* **Always inspect the actual source file** to determine accurate line numbers. +* **Provide line ranges** rather than single lines when changes affect multiple lines. +* **Use GitHub's line highlighting** format in URLs (#L123 for single, #L123-L145 for range). +* **Quote the existing content** at those lines to confirm accuracy. +* **Consider context lines** - include a few lines before/after for clarity. +* **Update line numbers** if the file has changed since issue creation. + +### Content Block Usage +Only recommend using special blocks when truly appropriate, they should not be overused: +* `[!IMPORTANT]`: Security issues, breaking changes, data loss risks +* `[!WARNING]`: Common mistakes, deprecation notices +* `[!NOTE]`: Helpful clarifications, version-specific info +* `[!TIP]`: Best practices, productivity hints + +### Code Samples +* Use appropriate language identifier for syntax highlighting. +* Include necessary `using` statements or imports. +* Add comments for complex logic. +* Ensure samples are complete and runnable. + +### Scope Boundaries +**DO:** +* Focus on documentation clarity and accuracy. +* Address missing information. +* Fix technical inaccuracies. +* Improve code samples. + +**DON'T:** +* Attempt to fix product bugs through documentation. +* Make architectural recommendations. +* Add opinions or preferences. +* Modify unrelated sections. + +## Issue labels +* Upon completion of the report, set the `ai-reviewed-issue-reported-action-plan` label for the issue. + +### Common Issue Types +1. **Missing information**: Add clarifying content +2. **Outdated content**: Update to current version +3. **Broken samples**: Fix or replace code +4. **Unclear instructions**: Rewrite for clarity +5. **Missing prerequisites**: Add setup steps + +--- \ No newline at end of file diff --git a/.gitignore b/.gitignore index 10b0192bf56..de09a544e84 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ _themes.VS.Modern/ #.github/ .openpublishing.buildcore.ps1 .vscode/ +.squad/ # Documentation build /docs/vcppdocs diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index dc663314250..717a62c31c1 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -1,5 +1,2805 @@ { "redirections": [ + { + "source_path": "docs/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/cpp-amp-overview.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/cpp-amp-overview", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/graphics-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/graphics-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/using-accelerator-and-accelerator-view-objects.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-accelerator-and-accelerator-view-objects", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/using-cpp-amp-in-windows-store-apps.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-cpp-amp-in-windows-store-apps", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/using-lambdas-function-objects-and-restricted-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-lambdas-function-objects-and-restricted-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/using-tiles.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-tiles", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/walkthrough-debugging-a-cpp-amp-application.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/walkthrough-debugging-a-cpp-amp-application", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/walkthrough-matrix-multiplication.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/walkthrough-matrix-multiplication", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-view-removed-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-view-removed-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/adopt-d3d-access-lock-t-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/adopt-d3d-access-lock-t-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/array-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/array-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/array-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/array-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/completion-future-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/completion-future-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-direct3d-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-direct3d-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-fast-math-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-fast-math-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-fast-math-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-fast-math-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-direct3d-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace-enums.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace-enums", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-constants-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-constants-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-enums-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-enums-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-functions-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-functions-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-operators-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-operators-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-precise-math-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-precise-math-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-precise-math-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-precise-math-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/extent-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/extent-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/index-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/index-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/invalid-compute-domain-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/invalid-compute-domain-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/out-of-memory-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/out-of-memory-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/reference-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/reference-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/runtime-exception-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/runtime-exception-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/sampler-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/sampler-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/scoped-d3d-access-lock-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/scoped-d3d-access-lock-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/short-vector-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/short-vector-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/short-vector-traits-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/short-vector-traits-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/texture-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/texture-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/texture-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/texture-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tile-barrier-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tile-barrier-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tiled-extent-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tiled-extent-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tiled-index-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tiled-index-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uninitialized-object-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uninitialized-object-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unsupported-feature-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unsupported-feature-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/reference/writeonly-texture-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/writeonly-texture-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-160" + ] + }, + { + "source_path": "docs/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/cpp-amp-overview.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/cpp-amp-overview", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/graphics-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/graphics-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/using-accelerator-and-accelerator-view-objects.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-accelerator-and-accelerator-view-objects", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/using-cpp-amp-in-windows-store-apps.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-cpp-amp-in-windows-store-apps", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/using-lambdas-function-objects-and-restricted-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-lambdas-function-objects-and-restricted-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/using-tiles.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-tiles", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/walkthrough-debugging-a-cpp-amp-application.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/walkthrough-debugging-a-cpp-amp-application", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/walkthrough-matrix-multiplication.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/walkthrough-matrix-multiplication", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-view-removed-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-view-removed-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/adopt-d3d-access-lock-t-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/adopt-d3d-access-lock-t-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/array-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/array-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/array-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/array-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/completion-future-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/completion-future-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-direct3d-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-direct3d-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-fast-math-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-fast-math-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-fast-math-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-fast-math-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-direct3d-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace-enums.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace-enums", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-constants-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-constants-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-enums-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-enums-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-functions-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-functions-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-operators-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-operators-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-precise-math-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-precise-math-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-precise-math-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-precise-math-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/extent-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/extent-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/index-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/index-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/invalid-compute-domain-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/invalid-compute-domain-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/out-of-memory-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/out-of-memory-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/reference-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/reference-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/runtime-exception-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/runtime-exception-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/sampler-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/sampler-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/scoped-d3d-access-lock-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/scoped-d3d-access-lock-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/short-vector-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/short-vector-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/short-vector-traits-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/short-vector-traits-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/texture-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/texture-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/texture-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/texture-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tile-barrier-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tile-barrier-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tiled-extent-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tiled-extent-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tiled-index-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tiled-index-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uninitialized-object-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uninitialized-object-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unsupported-feature-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unsupported-feature-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/reference/writeonly-texture-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/writeonly-texture-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-150" + ] + }, + { + "source_path": "docs/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/cpp-amp-overview.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/cpp-amp-overview", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/graphics-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/graphics-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/using-accelerator-and-accelerator-view-objects.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-accelerator-and-accelerator-view-objects", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/using-cpp-amp-in-windows-store-apps.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-cpp-amp-in-windows-store-apps", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/using-lambdas-function-objects-and-restricted-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-lambdas-function-objects-and-restricted-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/using-tiles.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-tiles", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/walkthrough-debugging-a-cpp-amp-application.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/walkthrough-debugging-a-cpp-amp-application", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/walkthrough-matrix-multiplication.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/walkthrough-matrix-multiplication", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-view-removed-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-view-removed-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/adopt-d3d-access-lock-t-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/adopt-d3d-access-lock-t-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/array-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/array-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/array-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/array-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/completion-future-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/completion-future-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-direct3d-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-direct3d-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-fast-math-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-fast-math-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-fast-math-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-fast-math-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-direct3d-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace-enums.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace-enums", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-constants-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-constants-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-enums-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-enums-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-functions-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-functions-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-operators-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-operators-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-precise-math-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-precise-math-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-precise-math-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-precise-math-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/extent-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/extent-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/index-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/index-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/invalid-compute-domain-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/invalid-compute-domain-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/out-of-memory-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/out-of-memory-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/reference-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/reference-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/runtime-exception-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/runtime-exception-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/sampler-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/sampler-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/scoped-d3d-access-lock-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/scoped-d3d-access-lock-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/short-vector-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/short-vector-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/short-vector-traits-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/short-vector-traits-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/texture-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/texture-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/texture-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/texture-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tile-barrier-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tile-barrier-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tiled-extent-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tiled-extent-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tiled-index-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tiled-index-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uninitialized-object-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uninitialized-object-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unsupported-feature-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unsupported-feature-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/reference/writeonly-texture-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/writeonly-texture-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-140" + ] + }, + { + "source_path": "docs/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/cpp-amp-overview.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/cpp-amp-overview", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/graphics-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/graphics-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/using-accelerator-and-accelerator-view-objects.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-accelerator-and-accelerator-view-objects", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/using-cpp-amp-in-windows-store-apps.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-cpp-amp-in-windows-store-apps", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/using-lambdas-function-objects-and-restricted-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-lambdas-function-objects-and-restricted-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/using-tiles.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-tiles", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/walkthrough-debugging-a-cpp-amp-application.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/walkthrough-debugging-a-cpp-amp-application", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/walkthrough-matrix-multiplication.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/walkthrough-matrix-multiplication", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-view-removed-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-view-removed-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/adopt-d3d-access-lock-t-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/adopt-d3d-access-lock-t-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/array-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/array-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/array-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/array-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/completion-future-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/completion-future-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-direct3d-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-direct3d-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-fast-math-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-fast-math-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-fast-math-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-fast-math-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-direct3d-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace-enums.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace-enums", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-constants-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-constants-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-enums-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-enums-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-functions-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-functions-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-operators-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-operators-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-precise-math-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-precise-math-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-precise-math-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-precise-math-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/extent-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/extent-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/index-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/index-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/invalid-compute-domain-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/invalid-compute-domain-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/out-of-memory-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/out-of-memory-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/reference-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/reference-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/runtime-exception-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/runtime-exception-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/sampler-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/sampler-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/scoped-d3d-access-lock-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/scoped-d3d-access-lock-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/short-vector-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/short-vector-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/short-vector-traits-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/short-vector-traits-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/texture-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/texture-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/texture-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/texture-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tile-barrier-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tile-barrier-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tiled-extent-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tiled-extent-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tiled-index-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tiled-index-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uninitialized-object-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uninitialized-object-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unsupported-feature-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unsupported-feature-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/reference/writeonly-texture-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/writeonly-texture-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-180" + ] + }, + { + "source_path": "docs/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/cpp-amp-overview.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/cpp-amp-overview", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/graphics-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/graphics-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/using-accelerator-and-accelerator-view-objects.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-accelerator-and-accelerator-view-objects", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/using-cpp-amp-in-windows-store-apps.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-cpp-amp-in-windows-store-apps", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/using-lambdas-function-objects-and-restricted-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-lambdas-function-objects-and-restricted-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/using-tiles.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/using-tiles", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/walkthrough-debugging-a-cpp-amp-application.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/walkthrough-debugging-a-cpp-amp-application", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/walkthrough-matrix-multiplication.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/walkthrough-matrix-multiplication", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/accelerator-view-removed-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/accelerator-view-removed-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/adopt-d3d-access-lock-t-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/adopt-d3d-access-lock-t-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/array-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/array-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/array-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/array-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/completion-future-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/completion-future-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-direct3d-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-direct3d-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-fast-math-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-fast-math-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-fast-math-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-fast-math-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-direct3d-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace-enums.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace-enums", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-graphics-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-graphics-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-constants-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-constants-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-enums-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-enums-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-functions-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-functions-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-namespace-operators-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-namespace-operators-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-precise-math-namespace-functions.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-precise-math-namespace-functions", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/concurrency-precise-math-namespace.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/concurrency-precise-math-namespace", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/double-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/double-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/extent-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/extent-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/float-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/float-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/index-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/index-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/int-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/int-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/invalid-compute-domain-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/invalid-compute-domain-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/norm-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/norm-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/out-of-memory-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/out-of-memory-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/reference-cpp-amp.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/reference-cpp-amp", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/runtime-exception-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/runtime-exception-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/sampler-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/sampler-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/scoped-d3d-access-lock-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/scoped-d3d-access-lock-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/short-vector-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/short-vector-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/short-vector-traits-structure.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/short-vector-traits-structure", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/texture-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/texture-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/texture-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/texture-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tile-barrier-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tile-barrier-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tiled-extent-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tiled-extent-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/tiled-index-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/tiled-index-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uint-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uint-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/uninitialized-object-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/uninitialized-object-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-2-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-2-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-3-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-3-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-4-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-4-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unorm-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unorm-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/unsupported-feature-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/unsupported-feature-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, + { + "source_path": "docs/parallel/amp/reference/writeonly-texture-view-class.md", + "redirect_url": "/previous-versions/cpp/parallel/amp/reference/writeonly-texture-view-class", + "redirect_document_id": false, + "monikers": [ + "msvc-170" + ] + }, { "source_path": "docs/windows/desktop-applications-visual-cpp.md", "redirect_url": "/cpp/windows/overview-of-windows-programming-in-cpp", @@ -13764,6 +16564,176 @@ "source_path": "docs/overview/whats-new-cpp-docs.md", "redirect_url": "../../cpp/overview/what-s-new-for-visual-cpp-in-visual-studio", "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/sample-container.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/sample-container-class.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/sample-container-classes.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/sample-container-member-functions.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/sample-container-members.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/sample-container-operators.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/sample-container-specialized-template-functions.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/sample-container-typedefs.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/operator-equality-sample-container.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/operator-greater-than-sample-container.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/operator-less-or-equal-sample-container.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/operator-less-than-sample-container.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/swap-sample-container.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/operator-greater-or-equal.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/operator-inequality.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-begin.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-clear.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-const-iterator.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-const-reference.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-const-reverse-iterator.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-difference-type.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-empty.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-end.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-erase.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-iterator.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-max-size.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-rbegin.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-reference.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-rend.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-reverse-iterator.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-size.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-size-type.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-swap.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false + }, + { + "source_path": "docs/standard-library/container-class-value-type.md", + "redirect_url": "/cpp/standard-library/stl-containers", + "redirect_document_id": false } ] -} \ No newline at end of file +} diff --git a/.vscode/settings.json b/.vscode/settings.json index 7eaad279a3d..60de5be0fe6 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -13,5 +13,8 @@ "Makefile", "VB.NET", "XML" - ] + ], + "python-envs.defaultEnvManager": "ms-python.python:conda", + "python-envs.defaultPackageManager": "ms-python.python:conda", + "python-envs.pythonProjects": [] } \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bbfa4431118..1fed536772c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contributing -Thank you for your interest in contributing to the Visual C++ documentation! +Thank you for your interest in contributing to the Microsoft C++ documentation! -In this topic, you'll see the basic process for adding or updating content in the [Visual C++ documentation site](https://learn.microsoft.com/cpp/). +In this topic, you'll see the basic process for adding or updating content in the [Microsoft C++ documentation site](https://learn.microsoft.com/cpp/). In this topic, we'll cover: @@ -14,16 +14,13 @@ In this topic, we'll cover: ## Process for contributing -**Step 1:** Open an issue describing the article you wish to write and how it relates to existing content. -The content inside the **docs** folder is organized into sections that are organized by content area (e.g., debugger). Try to determine the correct folder for your new content. Get feedback on your proposal. - -You can skip this first step for small changes. +**Step 1:** The content inside the **docs** folder is organized into sections that are organized by content area (e.g., debugger). Try to determine the correct folder for your changes. **Step 2:** Fork the `MicrosoftDocs/cpp-docs` repository. -**Step 3:** Create a `branch` for your article. +**Step 3:** Create a `branch` for your changes. -**Step 4:** Write your article. +**Step 4:** Make your edits and commit. If it's a new topic, you can use this [template file](./styleguide/template.md) as your starting point. It contains the writing guidelines and also explains the metadata required for each article, such as author information. @@ -46,9 +43,7 @@ docs **Step 5:** Submit a Pull Request (PR) from your branch to `MicrosoftDocs/cpp-docs/main`. -If your PR is addressing an existing issue, add the `Fixes #Issue_Number` keyword to the commit message or PR description, so the issue can be automatically closed when the PR is merged. For more information, see [Closing issues via commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/). - -The Visual Studio team will review your PR and let you know if the change looks good or if there are any other updates/changes necessary in order to approve it. +The Microsoft C++ docs team will review your PR and let you know if the change looks good or if there are any other updates/changes necessary in order to approve it. **Step 6:** Make any necessary updates to your branch as discussed with the team. @@ -58,9 +53,9 @@ On a certain cadence, we push all commits from main branch into the live branch ## DOs and DON'Ts -Below is a short list of guiding rules that you should keep in mind when you are contributing to the .NET documentation. +Below is a short list of guiding rules that you should keep in mind when you are contributing to the Microsoft C++ documentation. -- **DON'T** surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time. +- **DON'T** surprise us with big pull requests. - **DO** read the [style guide](./styleguide/template.md) and [voice and tone](./styleguide/voice-tone.md) guidelines. - **DO** use the [template](./styleguide/template.md) file as the starting point of your work. - **DO** create a separate branch on your fork before working on the articles. @@ -68,7 +63,7 @@ Below is a short list of guiding rules that you should keep in mind when you are - **DO** blog and tweet (or whatever) about your contributions, frequently! > [!NOTE] -> You might notice that some of the topics are not currently following all the guidelines specified here and on the [style guide](./styleguide/template.md) as well. We're working towards achieving consistency throughout the site. Check the list of [open issues](https://github.com/MicrosoftDocs/cpp-docs/issues?q=is%3Aissue+is%3Aopen+label%3Aguidelines-adherence) we're currently tracking for that specific goal. +> You might notice that some of the topics are not currently following all the guidelines specified here and on the [style guide](./styleguide/template.md) as well. We're working towards achieving consistency throughout the site. ## Building the documentation diff --git a/docs/assembler/arm/arm-assembler-command-line-reference.md b/docs/assembler/arm/arm-assembler-command-line-reference.md index 6c79ceaf152..a686553e861 100644 --- a/docs/assembler/arm/arm-assembler-command-line-reference.md +++ b/docs/assembler/arm/arm-assembler-command-line-reference.md @@ -5,7 +5,7 @@ ms.date: 05/09/2022 --- # ARM Assembler command-line reference -The Microsoft ARM assemblers, **armasm** and **armasm64**, support several command-line options. By default, **armasm** assembles ARMv7 Thumb assembly language into the Microsoft implementation of the Common Object File Format (COFF). The **armasm64** assembler creates COFF object code for ARM64 and ARM64EC targets. The linker can link COFF code objects produced by both the ARM assembler and the C/C++ compiler. It can link either together with object libraries created by the librarian. +The Microsoft ARM assemblers, **armasm** and **armasm64**, support several command-line options. By default, **armasm** assembles ARMv7 Thumb assembly language into the Microsoft implementation of the Common Object File Format (COFF). The **armasm64** assembler creates COFF object code for ARM64 and ARM64EC targets. The linker can link COFF code objects produced by both the ARM assembler and the MSVC compiler. It can link either together with object libraries created by the librarian. ## Syntax diff --git a/docs/assembler/inline/asm.md b/docs/assembler/inline/asm.md index a14c0854693..78787c9492b 100644 --- a/docs/assembler/inline/asm.md +++ b/docs/assembler/inline/asm.md @@ -13,7 +13,7 @@ helpviewer_keywords: ["__asm keyword [C++], vs. asm blocks", "__asm keyword [C++ The **`__asm`** keyword invokes the inline assembler and can appear wherever a C or C++ statement is legal. It can't appear by itself. It must be followed by an assembly instruction, a group of instructions enclosed in braces, or, at minimum, an empty pair of braces. The term "**`__asm`** block" here refers to any instruction or group of instructions, whether or not in braces. > [!NOTE] -> Visual C++ support for the Standard C++ **`asm`** keyword is limited to the fact that the compiler will not generate an error on the keyword. However, an **`asm`** block will not generate any meaningful code. Use **`__asm`** instead of **`asm`**. +> MSVC support for the Standard C++ **`asm`** keyword is limited to the fact that the compiler will not generate an error on the keyword. However, an **`asm`** block will not generate any meaningful code. Use **`__asm`** instead of **`asm`**. ## Grammar diff --git a/docs/assembler/inline/instruction-set-for-inline-assembly.md b/docs/assembler/inline/instruction-set-for-inline-assembly.md index 13b356b5264..bbcdcbd635e 100644 --- a/docs/assembler/inline/instruction-set-for-inline-assembly.md +++ b/docs/assembler/inline/instruction-set-for-inline-assembly.md @@ -10,7 +10,7 @@ ms.assetid: a45b5b22-9b5f-4545-81ec-70eb8ea2ef9b **Microsoft Specific** -The Microsoft C++ compiler supports all opcodes through the Pentium 4 and AMD Athlon. Additional instructions supported by the target processor can be created with the [_emit Pseudoinstruction](../../assembler/inline/emit-pseudoinstruction.md). +The MSVC compiler supports all opcodes through the Pentium 4 and AMD Athlon. Additional instructions supported by the target processor can be created with the [_emit Pseudoinstruction](../../assembler/inline/emit-pseudoinstruction.md). **END Microsoft Specific** diff --git a/docs/assembler/inline/intel-s-mmx-instruction-set.md b/docs/assembler/inline/intel-s-mmx-instruction-set.md index eb492df28df..c66d08a1255 100644 --- a/docs/assembler/inline/intel-s-mmx-instruction-set.md +++ b/docs/assembler/inline/intel-s-mmx-instruction-set.md @@ -10,7 +10,7 @@ ms.assetid: 705deb2d-c3fd-4696-9e22-8bcf25866daf **Microsoft Specific** -The Microsoft C++ compiler allows you to use Intel's MMX (multimedia extension) instruction set in the inline assembler. The MMX instructions are also supported by the debugger disassembly. The compiler generates a warning message if the function contains MMX instructions but does not contain an EMMS instruction to empty the multimedia state. For more information, see the Intel Web site. +The MSVC compiler allows you to use Intel's MMX (multimedia extension) instruction set in the inline assembler. The MMX instructions are also supported by the debugger disassembly. The compiler generates a warning message if the function contains MMX instructions but does not contain an EMMS instruction to empty the multimedia state. For more information, see the Intel Web site. **END Microsoft Specific** diff --git a/docs/assembler/masm/at-unwindversion.md b/docs/assembler/masm/at-unwindversion.md new file mode 100644 index 00000000000..388cfd802e7 --- /dev/null +++ b/docs/assembler/masm/at-unwindversion.md @@ -0,0 +1,60 @@ +--- +description: "Learn more about: @UnwindVersion" +title: "@UnwindVersion" +ms.date: 05/07/2026 +f1_keywords: ["@UnwindVersion"] +helpviewer_keywords: ["@UnwindVersion symbol"] +ai-usage: ai-assisted +--- +# \@UnwindVersion + +A predefined macro that returns the unwind version the `.asm` file is being assembled with. + +## Syntax + +> **\@UnwindVersion** + +## Remarks + +> [!IMPORTANT] +> This symbol is experimental and is subject to change. Enable Unwind Version 3 with `ml64.exe /unwindv3`. + +**\@UnwindVersion** is set to the unwind version used by the assembler. When `/unwindv3` is passed to `ml64.exe`, **\@UnwindVersion** is set to `3`; otherwise it's set to `1`. + +Use this macro with conditional assembly directives such as `IF` to assemble different code paths depending on the unwind version. + +This example is intended to be assembled only as it doesn't define an application entry point: + +## Example for unwindv3 + +```asm +; ml64 /c /unwindv3 ex1.asm +.code + +IF @UnwindVersion EQ 3 + +foo PROC FRAME + .pushreg r12 + push r12 + + .endprolog + + mov rax, 0 + + .beginepilog + .popreg r12 + pop r12 + .endepilog + ret +foo ENDP +ELSE + .ERR <@UnwindVersion should be 3> +ENDIF + +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/directives-reference.md b/docs/assembler/masm/directives-reference.md index c9f7208c7d7..97de3fcad7a 100644 --- a/docs/assembler/masm/directives-reference.md +++ b/docs/assembler/masm/directives-reference.md @@ -4,7 +4,7 @@ title: "Directives Reference" ms.date: 07/15/2020 f1_keywords: ["Directives Reference"] helpviewer_keywords: ["MASM (Microsoft Macro Assembler), directives reference"] -ms.assetid: da6efcd1-18f7-41de-81cd-a002a02f9a22 +ai-usage: ai-assisted --- # Directives Reference @@ -27,6 +27,49 @@ ms.assetid: da6efcd1-18f7-41de-81cd-a002a02f9a22 :::column-end::: :::row-end::: +## x64 Unwind Version 3 (experimental) + +The following directives are used with `ml64.exe` when the `/unwindv3` option is enabled. Unwind Version 3 is experimental and is subject to change. + +**Prologue directives** + +:::row::: + :::column span=""::: + [`.ALLOCSTACK`](dot-allocstack.md)\ + [`.ENDPROLOG`](dot-endprolog.md)\ + [`.PUSH2REG`](dot-push2reg.md) + :::column-end::: + :::column span=""::: + [`.PUSHFRAME`](dot-pushframe.md)\ + [`.PUSHREG`](dot-pushreg.md)\ + [`.SAVEREG`](dot-savereg.md) + :::column-end::: + :::column span=""::: + [`.SAVEXMM128`](dot-savexmm128.md)\ + [`.SETFRAME`](dot-setframe.md) + :::column-end::: +:::row-end::: + +**Epilogue directives** + +:::row::: + :::column span=""::: + [`.BEGINEPILOG`](dot-beginepilog.md)\ + [`.ENDEPILOG`](dot-endepilog.md)\ + [`.FREESTACK`](dot-freestack.md) + :::column-end::: + :::column span=""::: + [`.POP2REG`](dot-pop2reg.md)\ + [`.POPFRAME`](dot-popframe.md)\ + [`.POPREG`](dot-popreg.md)\ + [`.RESTOREREG`](dot-restorereg.md) + :::column-end::: + :::column span=""::: + [`.RESTOREXMM128`](dot-restorexmm128.md)\ + [`.UNSETFRAME`](dot-unsetframe.md) + :::column-end::: +:::row-end::: + ## Code Labels :::row::: diff --git a/docs/assembler/masm/dot-allocstack.md b/docs/assembler/masm/dot-allocstack.md index 13c5e6e1146..6d0881627bd 100644 --- a/docs/assembler/masm/dot-allocstack.md +++ b/docs/assembler/masm/dot-allocstack.md @@ -1,39 +1,41 @@ --- description: "Learn more about: .ALLOCSTACK" title: ".ALLOCSTACK" -ms.date: "12/17/2019" +ms.date: 05/11/2026 f1_keywords: [".ALLOCSTACK"] helpviewer_keywords: [".ALLOCSTACK directive"] -ms.assetid: 9801594b-7ac2-4df2-a49d-07d9dd9af99e +ai-usage: ai-assisted --- # .ALLOCSTACK -Generates a **UWOP_ALLOC_SMALL** or a **UWOP_ALLOC_LARGE** with the specified size for the current offset in the prologue. +`.ALLOCSTACK` generates a **UWOP_ALLOC_SMALL** or a **UWOP_ALLOC_LARGE** with the specified size for the current offset in the prologue. ## Syntax -> **.ALLOCSTACK** *size* +> `.ALLOCSTACK` *size* ## Remarks -MASM will choose the most efficient encoding for a given size. +Microsoft Assembler (MASM) chooses the most efficient encoding for a given size. -**.ALLOCSTACK** allows ml64.exe users to specify how a frame function unwinds and is only allowed within the prologue, which extends from the [PROC](proc.md) FRAME declaration to the [.ENDPROLOG](dot-endprolog.md) directive. These directives do not generate code; they only generate `.xdata` and `.pdata`. **.ALLOCSTACK** should be preceded by instructions that actually implement the actions to be unwound. It is a good practice to wrap both the unwind directives and the code they are meant to unwind in a macro to ensure agreement. +`.ALLOCSTACK` allows `ml64.exe` users to specify how a frame function unwinds and is only allowed within the prologue, which extends from the [PROC](proc.md) `FRAME` declaration to the [.ENDPROLOG](dot-endprolog.md) directive. +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. +- Precede `.ALLOCSTACK` with the instructions that actually implement the actions to be unwound. Wrap both the unwind directives and the code they're meant to unwind in a macro to ensure agreement. The *size* operand must be a multiple of 8. -For more information, see [MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md). +The epilogue counterpart is [.FREESTACK](dot-freestack.md). -## Sample +## Example: specify an unwind version 3 unwind/exception handler The following sample shows how to specify an unwind/exception handler: ```asm -; ml64 ex3.asm /link /entry:Example1 /SUBSYSTEM:Console +; ml64 ex3.asm /link /entry:Example3 /SUBSYSTEM:Console text SEGMENT PUBLIC Example3 PUBLIC Example3_UW -Example3_UW PROC NEAR +Example3_UW PROC ; exception/unwind handler body ret 0 @@ -56,7 +58,61 @@ text ENDS END ``` +## Unwind Version 3 behavior + +> [!IMPORTANT] +> Unwind Version 3 support is experimental and is subject to change. Enable it by using `ml64.exe /unwindv3`. + +`.ALLOCSTACK` generates a `WOD_ALLOC_SMALL`, `WOD_ALLOC_LARGE`, or `WOD_ALLOC_HUGE` Unwind Version 3 unwind code entry with the specified size for the current offset in the prolog. + +`.ALLOCSTACK` must appear **before** the `sub rsp, N` instruction it describes. This requirement is the opposite of Version 1, where the directive follows the instruction. + +MASM emits one of three unwind codes depending on the allocation size: + +| Unwind code | Condition | +|---|---| +| `WOD_ALLOC_SMALL` | *size* ≤ 128 bytes | +| `WOD_ALLOC_LARGE` | *size* ≤ 32 KB | +| `WOD_ALLOC_HUGE` | *size* > 32 KB | + +Version 1 generates only `UWOP_ALLOC_SMALL` or `UWOP_ALLOC_LARGE`. Version 3 adds a third variant, `WOD_ALLOC_HUGE`, for allocations larger than 32 KB. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. + +### Example for unwindv3 + +```asm +; ml64 ex3.asm /unwindv3 /link /entry:Example3 /SUBSYSTEM:Console +text SEGMENT +PUBLIC Example3 +PUBLIC Example3_UW +Example3_UW PROC + ; exception/unwind handler body + + ret 0 + +Example3_UW ENDP + +Example3 PROC FRAME : Example3_UW + +.allocstack 16 + sub rsp, 16 + +.endprolog + + ; function body + add rsp, 16 + ret 0 + +Example3 ENDP +text ENDS +END +``` + ## See also +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ [Directives Reference](directives-reference.md)\ -[MASM BNF Grammar](masm-bnf-grammar.md) +[MASM BNF Grammar](masm-bnf-grammar.md)\ +[MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md) \ No newline at end of file diff --git a/docs/assembler/masm/dot-beginepilog.md b/docs/assembler/masm/dot-beginepilog.md new file mode 100644 index 00000000000..9f05bcdaf1d --- /dev/null +++ b/docs/assembler/masm/dot-beginepilog.md @@ -0,0 +1,59 @@ +--- +description: "Learn more about: .BEGINEPILOG" +title: ".BEGINEPILOG" +ms.date: 05/04/2026 +ai-usage: ai-assisted +f1_keywords: [".BEGINEPILOG"] +helpviewer_keywords: [".BEGINEPILOG directive"] +--- +# .BEGINEPILOG + +Marks the start of an epilogue unwind region. This directive doesn't emit an Unwind Operation Descriptors (WOD) code. + +## Syntax + +> `.BEGINEPILOG` + +## Remarks + +> [!IMPORTANT] +> This directive is experimental and is subject to change. +> Enable Unwind Version 3 by using `ml64.exe /unwindv3`. + +`.BEGINEPILOG` is only valid in Unwind Version 3. + +- It marks the start of an epilogue region where epilogue unwind operations are recorded. Pair `.BEGINEPILOG` with a closing [.ENDEPILOG](dot-endepilog.md) or no epilog unwind codes are emitted. +- In Unwind Version 3, epilog directives are mandatory for epilog unwind code generation. +- Epilogues must contain at least one directive. +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. + +## Example for unwindv3 + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .allocstack 16 + sub rsp, 16 +.endprolog + ; function body + .beginepilog + .freestack 16 + add rsp, 16 + .endepilog + ret +Example1 ENDP +_text ENDS +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[Directives Reference](directives-reference.md)\ +[.ENDEPILOG](dot-endepilog.md)\ +[.ENDPROLOG](dot-endprolog.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-endepilog.md b/docs/assembler/masm/dot-endepilog.md new file mode 100644 index 00000000000..af9383ae19e --- /dev/null +++ b/docs/assembler/masm/dot-endepilog.md @@ -0,0 +1,60 @@ +--- +description: "Learn more about: .ENDEPILOG" +title: ".ENDEPILOG" +ms.date: "04/29/2026" +ai-usage: ai-assisted +f1_keywords: [".ENDEPILOG"] +helpviewer_keywords: [".ENDEPILOG directive"] +--- +# .ENDEPILOG + +Marks the end of an epilogue unwind region. This directive doesn't emit a Windows unwind data (WOD) unwind code. + +## Syntax + +> **.ENDEPILOG** + +## Remarks + +> [!IMPORTANT] +> This directive is experimental and is subject to change. +> Enable Unwind Version 3 by using `ml64.exe /unwindv3`. + +**.ENDEPILOG** is only valid in Unwind Version 3. + +- It marks the end of an epilogue region started by [.BEGINEPILOG](dot-beginepilog.md). +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. +- Epilogues must contain at least one directive. +- Epilogue directives are mandatory for epilogue unwind code generation. No epilogue unwind codes are emitted without a `.BEGINEPILOG`/`.ENDEPILOG` pair. +- It's an error to use epilogue directives outside of the region between [.BEGINEPILOG](dot-beginepilog.md) and **.ENDEPILOG**. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. + +## Example + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .allocstack 16 + sub rsp, 16 +.endprolog + ; function body + .beginepilog + .freestack 16 + add rsp, 16 + .endepilog + ret +Example1 ENDP +_text ENDS +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[Directives Reference](directives-reference.md)\ +[.BEGINEPILOG](dot-beginepilog.md)\ +[.ENDPROLOG](dot-endprolog.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-endprolog.md b/docs/assembler/masm/dot-endprolog.md index c864e0c8494..bc366ab72e5 100644 --- a/docs/assembler/masm/dot-endprolog.md +++ b/docs/assembler/masm/dot-endprolog.md @@ -1,14 +1,14 @@ --- description: "Learn more about: .ENDPROLOG" title: ".ENDPROLOG" -ms.date: "12/17/2019" +ms.date: 05/06/2026 f1_keywords: [".ENDPROLOG"] helpviewer_keywords: [".ENDPROLOG directive"] -ms.assetid: 61a2474c-9527-46e6-9f9d-bc4b42c10f35 +ai-usage: ai-assisted --- # .ENDPROLOG -Signals the end of the prologue declarations. +Marks the end of the prologue declarations. ## Syntax @@ -16,11 +16,22 @@ Signals the end of the prologue declarations. ## Remarks -It is an error to use any of the prologue declarations outside of the region between [PROC](proc.md) **FRAME** and **.ENDPROLOG**. +It's an error to use any of the prologue declarations outside of the region between [PROC](proc.md) `FRAME` and **.ENDPROLOG**. For more information, see [MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md). +## Unwind Version 3 behavior + +> [!IMPORTANT] +> Unwind Version 3 support is experimental and is subject to change. +> Enable it with `ml64.exe /unwindv3`. + +`.ENDPROLOG` is also used in Unwind Version 3 and continues to mark the end of the function prologue. It doesn't generate a Windows unwind data (WOD) unwind code entry. + +It's an error to use any prologue directive outside the region between `PROC FRAME` and `.ENDPROLOG`. + ## See also +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ [Directives Reference](directives-reference.md)\ [MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-freestack.md b/docs/assembler/masm/dot-freestack.md new file mode 100644 index 00000000000..bf80a2be682 --- /dev/null +++ b/docs/assembler/masm/dot-freestack.md @@ -0,0 +1,74 @@ +--- +description: "Learn more about: .FREESTACK" +title: ".FREESTACK" +ms.date: 05/06/2026 +f1_keywords: [".FREESTACK"] +helpviewer_keywords: [".FREESTACK directive"] +ai-usage: ai-assisted +--- +# .FREESTACK + +Generates a **WOD_ALLOC_SMALL**, **WOD_ALLOC_LARGE**, or **WOD_ALLOC_HUGE** unwind code entry with the specified size for the current offset in the epilogue. + +## Syntax + +> **.FREESTACK** *size* + +## Parameters + +*size*\ +The number of bytes to deallocate from the stack. Must be a multiple of 8. + +## Remarks + +> [!IMPORTANT] +> This directive is experimental and is subject to change. +> Enable Unwind Version 3 by using `ml64.exe /unwindv3`. + +- You can use **.FREESTACK** only in Unwind Version 3. It's the epilogue counterpart to [.ALLOCSTACK](dot-allocstack.md). +- You can use **.FREESTACK** only within an epilogue region, between [.BEGINEPILOG](dot-beginepilog.md) and [.ENDEPILOG](dot-endepilog.md). +- In Unwind Version 3, **.FREESTACK** must appear **before** the `add rsp, N` instruction that implements the stack deallocation. +- To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. +- Microsoft Assembler (MASM) chooses the most efficient encoding for a given size. + +MASM emits one of three unwind codes depending on the size: + +| Unwind code | Condition | +|---|---| +| `WOD_ALLOC_SMALL` | *size* ≤ 128 bytes | +| `WOD_ALLOC_LARGE` | *size* ≤ 32 KB | +| `WOD_ALLOC_HUGE` | *size* > 32 KB | + +In Unwind Version 3, epilogue directives are mandatory for epilogue unwind code generation. The assembler doesn't emit epilogue unwind codes without a `.BEGINEPILOG`/`.ENDEPILOG` pair. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. + +## Example for unwindv3 + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .allocstack 16 + sub rsp, 16 +.endprolog + ; function body + .beginepilog + .freestack 16 + add rsp, 16 + .endepilog + ret +Example1 ENDP +_text ENDS +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[Directives Reference](directives-reference.md)\ +[.ALLOCSTACK](dot-allocstack.md)\ +[.BEGINEPILOG](dot-beginepilog.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-pop2reg.md b/docs/assembler/masm/dot-pop2reg.md new file mode 100644 index 00000000000..56dbdff4b52 --- /dev/null +++ b/docs/assembler/masm/dot-pop2reg.md @@ -0,0 +1,76 @@ +--- +description: "Learn more about: .POP2REG" +title: ".POP2REG" +ms.date: 05/04/2026 +f1_keywords: [".POP2REG"] +helpviewer_keywords: [".POP2REG directive"] +ai-usage: ai-assisted +--- +# .POP2REG + +Generates a two-register pop unwind code entry for the specified register pair using the current offset in the epilogue. + +## Syntax + +> **.POP2REG** *register1*, *register2* + +## Parameters + +*register1*\ +The first register to pop. Must be a general-purpose 64-bit register. + +*register2*\ +The second register to pop. Must be a general-purpose 64-bit register. + +*register1* and *register2* may each be one of:\ +`RAX, RCX, RDX, RBX, RDI, RSI, RBP, R8, R9, R10, R11, R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R22, R23, R24, R25, R26, R27, R28, R29, R30, R31`. + +## Remarks + +> [!IMPORTANT] +> This directive is experimental and is subject to change. Enable Unwind Version 3 with `ml64.exe /unwindv3`. + +- **.POP2REG** is only valid in Unwind Version 3. It's the epilogue counterpart to [.PUSH2REG](dot-push2reg.md). +- **.POP2REG** is only allowed within an epilogue region, between [.BEGINEPILOG](dot-beginepilog.md) and [.ENDEPILOG](dot-endepilog.md). +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. +- In Unwind Version 3, **.POP2REG** must appear **before** the instruction that actually implements the action to be unwound. +- In Unwind Version 3, epilogue directives are mandatory for epilogue unwind code generation. No epilogue unwind codes are emitted without a `.BEGINEPILOG`/`.ENDEPILOG` pair. +- To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. + +If *register1* and *register2* are consecutive and in increasing order, MASM emits a `WOD_PUSH_CONSECUTIVE_2` unwind code. Otherwise, MASM emits a `WOD_PUSH2` unwind code. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. + +## Example + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .push2reg rbx, rsi + push2 rbx, rsi + .push2reg r10, r11 + push2 r10, r11 +.endprolog + ; rest of function ... + .beginepilog + .pop2reg r10, r11 + pop2 r10, r11 + .pop2reg rbx, rsi + pop2 rbx, rsi + .endepilog + ret +Example1 ENDP +_text ENDS +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[Directives Reference](directives-reference.md)\ +[.PUSH2REG](dot-push2reg.md)\ +[.POPREG](dot-popreg.md)\ +[.BEGINEPILOG](dot-beginepilog.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-popframe.md b/docs/assembler/masm/dot-popframe.md new file mode 100644 index 00000000000..6f0d869f13d --- /dev/null +++ b/docs/assembler/masm/dot-popframe.md @@ -0,0 +1,74 @@ +--- +description: "Learn more about: .POPFRAME" +title: ".POPFRAME" +ms.date: 05/01/2026 +f1_keywords: [".POPFRAME"] +helpviewer_keywords: [".POPFRAME directive"] +ai-usage: ai-assisted +--- +# .POPFRAME + +Generates a `WOD_PUSH_CANONICAL_FRAME` Windows unwind data (WOD) unwind code entry in the epilogue. + +## Syntax + +> **.POPFRAME** ⟦**CODE** | *value*⟧ + +## Parameters + +*value*\ +An optional numeric modifier in the range 0–255.\ +Mutually exclusive with **CODE**. If you specify the optional **CODE** keyword, the unwind code entry receives a modifier of 1.\ +If you specify an optional numeric *value* instead, it receives the specified value.\ +If you don't pass an argument, the value is 0. + +## Remarks + +> [!IMPORTANT] +> This directive is experimental and is subject to change. Enable Unwind Version 3 with `ml64.exe /unwindv3`. + +The **.POPFRAME** directive lets `ml64.exe` users specify how a frame function unwinds in an epilog. You can only use it within an epilog region, between [.BEGINEPILOG](dot-beginepilog.md) and [.ENDEPILOG](dot-endepilog.md). + +- **.POPFRAME** is only valid in Unwind Version 3. It's the epilog counterpart of [.PUSHFRAME](dot-pushframe.md). The operand value should match the corresponding **.PUSHFRAME** in the prologue. +- In Unwind Version 3, **.POPFRAME** must appear **before** the instruction that implements the action to be unwound. To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. +- In Unwind Version 3, epilogue directives are mandatory for epilogue unwind code generation. No epilogue unwind codes are emitted without a `.BEGINEPILOG`/`.ENDEPILOG` pair. +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. + +> [!NOTE] +> In Unwind Version 1, directives appear after the corresponding instruction. In Unwind Version 3, directives appear **before** the instruction. + +## Example for unwindv3 + +The following example shows how to use **.POPFRAME** in an epilogue to indicate an interrupt handler that pushes and pops a canonical machine frame. + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .pushframe + .pushreg rbx + push rbx + .allocstack 32 + sub rsp, 32 +.endprolog + ; interrupt handler body ... + .beginepilog + .freestack 32 + add rsp, 32 + .popreg rbx + pop rbx + .popframe + .endepilog + iretq +Example1 ENDP +_text ENDS +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[.PUSHFRAME](dot-pushframe.md)\ +[.BEGINEPILOG](dot-beginepilog.md)\ +[.ENDEPILOG](dot-endepilog.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-popreg.md b/docs/assembler/masm/dot-popreg.md new file mode 100644 index 00000000000..963e7de0f48 --- /dev/null +++ b/docs/assembler/masm/dot-popreg.md @@ -0,0 +1,70 @@ +--- +description: "Learn more about: .POPREG" +title: ".POPREG" +ms.date: 05/04/2026 +f1_keywords: [".POPREG"] +helpviewer_keywords: [".POPREG directive"] +ai-usage: ai-assisted +--- +# .POPREG + +Generates a `WOD_PUSH` unwind code entry for the specified register using the current offset in the epilogue. + +## Syntax + +> .POPREG *register* + +## Parameters + +*register*\ +The register to pop. Must be a general-purpose 64-bit register. + +## Remarks + +> [!IMPORTANT] +> This directive is experimental and is subject to change. Enable Unwind Version 3 by using the `/unwindv3` option in ml64.exe. + +`.POPREG` is only valid in Unwind Version 3. It's the epilogue counterpart to [.PUSHREG](dot-pushreg.md). + +`.POPREG` is only allowed within an epilogue region, between [.BEGINEPILOG](dot-beginepilog.md) and [.ENDEPILOG](dot-endepilog.md). These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. In Unwind Version 3, `.POPREG` must appear **before** the `pop` instruction that implements the register restore. To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. + +*register* may be one of:\ +`RAX, RCX, RDX, RBX, RDI, RSI, RBP, R8, R9, R10, R11, R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R22, R23, R24, R25, R26, R27, R28, R29, R30, R31` + +In Unwind Version 3, epilogue directives are mandatory for epilogue unwind code generation. The assembler doesn't emit epilogue unwind codes without a `.BEGINEPILOG`/`.ENDEPILOG` pair. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. + +## Example for unwindv3 + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .pushreg rbx + push rbx + .pushreg rsi + push rsi +.endprolog + ; rest of function ... + .beginepilog + .popreg rsi + pop rsi + .popreg rbx + pop rbx + .endepilog + ret +Example1 ENDP +_text ENDS +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[Directives Reference](directives-reference.md)\ +[.PUSHREG](dot-pushreg.md)\ +[.POP2REG](dot-pop2reg.md)\ +[.BEGINEPILOG](dot-beginepilog.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-push2reg.md b/docs/assembler/masm/dot-push2reg.md new file mode 100644 index 00000000000..d43e1113271 --- /dev/null +++ b/docs/assembler/masm/dot-push2reg.md @@ -0,0 +1,65 @@ +--- +description: "Learn more about: .PUSH2REG" +title: ".PUSH2REG" +ms.date: 05/04/2026 +f1_keywords: [".PUSH2REG"] +helpviewer_keywords: [".PUSH2REG directive"] +ai-usage: ai-assisted +--- +# .PUSH2REG + +Generates a two-register push unwind code entry for the specified register pair using the current offset in the prologue. + +## Syntax + +> `.PUSH2REG` *register1*, *register2* + +## Parameters + +*register1*\ +The first register to push. Must be a general-purpose 64-bit register. + +*register2*\ +The second register to push. Must be a general-purpose 64-bit register. + +*register1* and *register2* may each be one of:\ +`RAX, RCX, RDX, RBX, RDI, RSI, RBP, R8, R9, R10, R11, R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R22, R23, R24, R25, R26, R27, R28, R29, R30, R31.` + +## Remarks + +> [!IMPORTANT] +> This directive is experimental and is subject to change. Enable Unwind Version 3 by using `ml64.exe /unwindv3`. + +- Use `.PUSH2REG` to specify how a frame function unwinds. You can only use this directive within the prologue, which extends from the [PROC](proc.md) `FRAME` declaration to the [.ENDPROLOG](dot-endprolog.md) directive. +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. In Unwind Version 3, `.PUSH2REG` must appear **before** the instruction that actually implements the action to be unwound. To ensure agreement, it's a good practice to wrap both the unwind directives and the code they're meant to unwind in a macro. +- If *register1* and *register2* are consecutive and in increasing order, MASM emits a `WOD_PUSH_CONSECUTIVE_2` unwind code. Otherwise, MASM emits a `WOD_PUSH2` unwind code. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. + +## Example for unwindv3 + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .push2reg r10, r11 + push2 r10, r11 + .push2reg rbx, rsi + push2 rbx, rsi +.endprolog + ; rest of function ... + ret +Example1 ENDP +_text ENDS +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[Directives Reference](directives-reference.md)\ +[.POP2REG](dot-pop2reg.md)\ +[.PUSHREG](dot-pushreg.md)\ +[.ENDPROLOG](dot-endprolog.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-pushframe.md b/docs/assembler/masm/dot-pushframe.md index 07dc3972dfc..da3d77c596f 100644 --- a/docs/assembler/masm/dot-pushframe.md +++ b/docs/assembler/masm/dot-pushframe.md @@ -4,23 +4,58 @@ description: "Describes the .PUSHFRAME MASM directive, used to specify how to un ms.date: "12/06/2019" f1_keywords: [".PUSHFRAME"] helpviewer_keywords: [".PUSHFRAME directive"] -ms.assetid: 17b123d0-4c6d-4fd2-85eb-798e8ad0a73c +ai-usage: ai-assisted --- # .PUSHFRAME -Generates a `UWOP_PUSH_MACHFRAME` unwind code entry. If the optional **CODE** keyword is specified, the unwind code entry is given a modifier of 1. Otherwise the modifier is 0. +Generates a `UWOP_PUSH_MACHFRAME` unwind code entry. If you specify the optional **CODE** keyword, the unwind code entry gets a modifier of 1. Otherwise, the modifier is 0. ## Syntax -> **.PUSHFRAME** ⟦**CODE**⟧;; +> `.PUSHFRAME` ⟦**CODE**⟧ ;Prior to Unwind Version 3 +> `.PUSHFRAME` ⟦**CODE**⟧ | [0-255] ;Unwind Version 3 specific ## Remarks -.PUSHFRAME allows ml64.exe users to specify how a frame function unwinds. It's only allowed within the prologue, which extends from the [PROC](proc.md) FRAME declaration to the [.ENDPROLOG](dot-endprolog.md) directive. These directives don't generate code; they only generate `.xdata` and `.pdata`. **.PUSHFRAME** should be preceded by instructions that actually implement the actions to be unwound. It's a good practice to wrap both the unwind directives and the code they're meant to unwind in a macro to ensure agreement. +Use `.PUSHFRAME` with `ml64.exe` to specify how a frame function unwinds. You can only use it within the prologue, which extends from the [PROC](proc.md) `FRAME` declaration to the [.ENDPROLOG](dot-endprolog.md) directive. +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. +- Precede `.PUSHFRAME` with the instructions that implement the actions to be unwound. +- To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. -For more information, see [MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md). +## Unwind Version 3 behavior + +> [!IMPORTANT] +> Unwind Version 3 support is experimental and is subject to change. Enable it by using `ml64.exe /unwindv3`. + +In Unwind Version 3, `.PUSHFRAME` emits a `WOD_PUSH_CANONICAL_FRAME` unwind code entry.\ +When you specify the optional **CODE** keyword, the unwind code entry modifier value is 1.\ +If you specify an optional *value*, the directive uses it directly.\ +If you don't pass an argument, the value is 0. The *value* must be in the range 0–255. + +> **Note:** In Unwind Version 1 the directives come after the instruction. In Unwind Version 3, the directives come before the instruction. +> `.PUSHFRAME` must appear **before** the instruction it describes. This behavior is the opposite of Version 1, where the directive follows the instruction. + +### Example for unwindv3 + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .pushframe CODE +.endprolog + ; interrupt handler body ... + iretq +Example1 ENDP +_text ENDS +END +``` + +The epilogue counterpart is [.POPFRAME](dot-popframe.md). ## See also +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ [Directives reference](directives-reference.md)\ -[MASM BNF Grammar](masm-bnf-grammar.md) +[.POPFRAME](dot-popframe.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md)\ +[MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md) diff --git a/docs/assembler/masm/dot-pushreg.md b/docs/assembler/masm/dot-pushreg.md index a433f688d6e..d6a48cb5227 100644 --- a/docs/assembler/masm/dot-pushreg.md +++ b/docs/assembler/masm/dot-pushreg.md @@ -1,10 +1,10 @@ --- description: "Learn more about: .PUSHREG" title: ".PUSHREG" -ms.date: "12/16/2019" +ms.date: 05/04/2026 f1_keywords: [".PUSHREG"] helpviewer_keywords: [".PUSHREG directive"] -ms.assetid: e0c83758-dfed-40ea-afe6-cb833c8d2d30 +ai-usage: ai-assisted --- # .PUSHREG @@ -14,23 +14,20 @@ Generates a `UWOP_PUSH_NONVOL` unwind code entry for the specified register numb > .PUSHREG *register* -## Remarks - -**.PUSHREG** allows ml64.exe users to specify how a frame function unwinds, and is only allowed within the prologue, which extends from the [PROC](proc.md) **FRAME** declaration to the [.ENDPROLOG](dot-endprolog.md) directive. These directives do not generate code; they only generate `.xdata` and `.pdata`. **.PUSHREG** should be preceded by instructions that actually implement the actions to be unwound. It is a good practice to wrap both the unwind directives and the code they are meant to unwind in a macro to ensure agreement. - *register* may be one of:\ -RAX | RCX | RDX | RBX | RDI | RSI | RBP | R8 | R9 | R10 | R11 | R12 | R13 | R14 | R15. - -For more information, see [MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md). +`RAX, RCX, RDX, RBX, RDI, RSI, RBP, R8, R9, R10, R11, R12, R13, R14, R15` -## Sample +Unwind Version 3 extends register support to include R16–R31. *register* may be one of:\ +`RAX, RCX, RDX, RBX, RDI, RSI, RBP, R8, R9, R10, R11, R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R22, R23, R24, R25, R26, R27, R28, R29, R30, R31` -### Description +## Remarks -The following sample shows how to push non-volatile registers. +Use `.PUSHREG` with `ml64.exe` to specify how a frame function unwinds. You can only use `.PUSHREG` within the prologue, which extends from the [PROC](proc.md) `FRAME` declaration to the [.ENDPROLOG](dot-endprolog.md) directive. These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. Precede `.PUSHREG` with the instructions that actually implement the actions to be unwound. To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. ### Code +The following sample shows how to push nonvolatile registers. + ```asm ; ml64 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE _text SEGMENT @@ -51,7 +48,42 @@ _text ENDS END ``` +## Unwind Version 3 behavior + +> [!IMPORTANT] +> Unwind Version 3 support is experimental and is subject to change. Enable it by using `ml64.exe /unwindv3`. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. +> In Unwind Version 3, `.PUSHREG` generates a `WOD_PUSH` unwind code entry and must appear **before** the `push reg` instruction it describes. This requirement is the opposite of Version 1, where the directive follows the instruction. + +### Example for unwindv3 + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .pushreg r10 + push r10 + .pushreg r15 + push r15 + .pushreg rbx + push rbx + .pushreg rsi + push rsi +.endprolog + ; rest of function ... + ret +Example1 ENDP +_text ENDS +END +``` + +The epilogue counterpart is [.POPREG](dot-popreg.md). + ## See also +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ [Directives reference](directives-reference.md)\ -[MASM BNF Grammar](masm-bnf-grammar.md) +[MASM BNF Grammar](masm-bnf-grammar.md)\ +[MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md) \ No newline at end of file diff --git a/docs/assembler/masm/dot-restorereg.md b/docs/assembler/masm/dot-restorereg.md new file mode 100644 index 00000000000..94836c8da74 --- /dev/null +++ b/docs/assembler/masm/dot-restorereg.md @@ -0,0 +1,77 @@ +--- +description: "Learn more about: .RESTOREREG" +title: ".RESTOREREG" +ms.date: 05/04/2026 +f1_keywords: [".RESTOREREG"] +helpviewer_keywords: [".RESTOREREG directive"] +ai-usage: ai-assisted +--- +# .RESTOREREG + +Generates either a `WOD_SAVE_NONVOL` or a `WOD_SAVE_NONVOL_FAR` unwind code entry for the specified register and offset, using the current epilogue offset. + +## Syntax + +> `.RESTOREREG` *reg*, *offset* + +## Parameters + +*reg*\ +The nonvolatile register to restore. + +*offset*\ +The stack offset from which the register is restored. + +## Remarks + +> [!IMPORTANT] +> This directive is experimental and is subject to change. Enable Unwind Version 3 by using `ml64.exe /unwindv3`. + +`.RESTOREREG` is only valid in Unwind Version 3. It's the epilogue counterpart to [.SAVEREG](dot-savereg.md). + +Microsoft Assembler (MASM) chooses the most efficient encoding for a given offset. + +- `.RESTOREREG` is only allowed within an epilogue region, between [.BEGINEPILOG](dot-beginepilog.md) and [.ENDEPILOG](dot-endepilog.md). +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. +- In Unwind Version 3, `.RESTOREREG` must appear **before** the instruction that loads the register from the stack. +- To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. +- In Unwind Version 3, epilogue directives are mandatory for epilogue unwind code generation. No epilogue unwind codes are emitted without a `.BEGINEPILOG`/`.ENDEPILOG` pair. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. + +## Example for unwindv3 + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .allocstack 020h + sub rsp, 020h + .savereg rbx, 0 + mov [rsp], rbx + .savereg rsi, 8 + mov [rsp+8], rsi +.endprolog + ; rest of function ... + .beginepilog + .restorereg rsi, 8 + mov rsi, [rsp+8] + .restorereg rbx, 0 + mov rbx, [rsp] + .freestack 020h + add rsp, 020h + .endepilog + ret +Example1 ENDP +_text ENDS +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[Directives Reference](directives-reference.md)\ +[.SAVEREG](dot-savereg.md)\ +[.BEGINEPILOG](dot-beginepilog.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-restorexmm128.md b/docs/assembler/masm/dot-restorexmm128.md new file mode 100644 index 00000000000..03d1bc27750 --- /dev/null +++ b/docs/assembler/masm/dot-restorexmm128.md @@ -0,0 +1,77 @@ +--- +description: "Learn more about: .RESTOREXMM128" +title: ".RESTOREXMM128" +ms.date: 05/06/2026 +f1_keywords: [".RESTOREXMM128"] +helpviewer_keywords: [".RESTOREXMM128 directive"] +ai-usage: ai-assisted +--- +# .RESTOREXMM128 + +Generates either a `WOD_SAVE_XMM128` or a `WOD_SAVE_XMM128_FAR` Unwind Version 3 unwind code entry for the specified XMM register and offset using the current epilogue offset. + +## Syntax + +> `.RESTOREXMM128` *xmmreg*, *offset* + +## Parameters + +*xmmreg*\ +The XMM register to restore. + +*offset*\ +The stack offset from which the register is restored. Must be a multiple of 16. + +## Remarks + +> [!IMPORTANT] +> This directive is experimental and is subject to change. Enable Unwind Version 3 with `ml64.exe /unwindv3`. + +`.RESTOREXMM128` is only valid in Unwind Version 3. It's the epilogue counterpart to [.SAVEXMM128](dot-savexmm128.md). + +Microsoft Assembler (MASM) chooses the most efficient encoding for a given offset. + +- `.RESTOREXMM128` is only allowed within an epilogue region, between [.BEGINEPILOG](dot-beginepilog.md) and [.ENDEPILOG](dot-endepilog.md). +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. +- In Unwind Version 3, `.RESTOREXMM128` must appear **before** the instruction that loads the XMM register from the stack. +- To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. +- In Unwind Version 3, epilogue directives are mandatory for epilogue unwind code generation. No epilogue unwind codes are emitted without a `.BEGINEPILOG`/`.ENDEPILOG` pair. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. + +## Example for unwindv3 + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .allocstack 030h + sub rsp, 030h + .savexmm128 xmm6, 0 + movdqa [rsp], xmm6 + .savexmm128 xmm7, 010h + movdqa [rsp+010h], xmm7 +.endprolog + ; rest of function ... + .beginepilog + .restorexmm128 xmm7, 010h + movdqa xmm7, [rsp+010h] + .restorexmm128 xmm6, 0 + movdqa xmm6, [rsp] + .freestack 030h + add rsp, 030h + .endepilog + ret +Example1 ENDP +_text ENDS +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[Directives Reference](directives-reference.md)\ +[.SAVEXMM128](dot-savexmm128.md)\ +[.BEGINEPILOG](dot-beginepilog.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-savereg.md b/docs/assembler/masm/dot-savereg.md index a786f88777f..654d19cfe57 100644 --- a/docs/assembler/masm/dot-savereg.md +++ b/docs/assembler/masm/dot-savereg.md @@ -1,26 +1,70 @@ --- description: "Learn more about: .SAVEREG" title: ".SAVEREG" -ms.date: "12/16/2019" +ms.date: 05/06/2026 f1_keywords: [".SAVEREG"] helpviewer_keywords: [".SAVEREG directive"] -ms.assetid: 1dbc2ef6-a197-40e7-9e55-fddcae8cef29 +ai-usage: ai-assisted --- # .SAVEREG -Generates either a `UWOP_SAVE_NONVOL` or a `UWOP_SAVE_NONVOL_FAR` unwind code entry for the specified register (*reg*) and offset (*offset*) using the current prologue offset. MASM will choose the most efficient encoding. +Generates either a `UWOP_SAVE_NONVOL` or a `UWOP_SAVE_NONVOL_FAR` unwind code entry for the specified register (*reg*) and offset (*offset*) using the current prologue offset. Microsoft Assembler (MASM) chooses the most efficient encoding. ## Syntax -> **.SAVEREG** *reg*__,__ *offset* +> `.SAVEREG` *reg*__,__ *offset* ## Remarks -**.SAVEREG** allows ml64.exe users to specify how a frame function unwinds and is only allowed within the prologue, which extends from the [PROC](proc.md) FRAME declaration to the [.ENDPROLOG](dot-endprolog.md) directive. These directives do not generate code; they only generate `.xdata` and `.pdata`. **.SAVEREG** should be preceded by instructions that actually implement the actions to be unwound. It is a good practice to wrap both the unwind directives and the code they are meant to unwind in a macro to ensure agreement. +Use `.SAVEREG` with `ml64.exe` to specify how a frame function unwinds. You can only use it within the prologue, which extends from the [`PROC`](proc.md) `FRAME` declaration to the [.ENDPROLOG](dot-endprolog.md) directive. +- These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. +- Precede `.SAVEREG` with instructions that actually implement the actions to be unwound. +- To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. -For more information, see [MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md). +## Unwind Version 3 behavior + +> [!IMPORTANT] +> Unwind Version 3 support is experimental and is subject to change. Enable it by using `ml64.exe /unwindv3`. + +In Unwind Version 3, `.SAVEREG` emits either a `WOD_SAVE_NONVOL` or a `WOD_SAVE_NONVOL_FAR` unwind code entry. MASM selects the most efficient encoding based on the size of *offset*: + +| Unwind code | Condition | +|---|---| +| `WOD_SAVE_NONVOL` | *offset* can be encoded as a scaled 16-bit value | +| `WOD_SAVE_NONVOL_FAR` | *offset* requires a full 32-bit value | + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. +> `.SAVEREG` must appear **before** the instruction it describes. This requirement is the opposite of Version 1, where the directive follows the instruction. + +### Example for unwindv3 + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .allocstack 020h + sub rsp, 020h + .savereg rbx, 0 + mov [rsp], rbx + .savereg rsi, 8 + mov [rsp+8], rsi +.endprolog + ; rest of function ... + mov rsi, [rsp+8] + mov rbx, [rsp] + add rsp, 020h + ret +Example1 ENDP +_text ENDS +END +``` + +The epilogue counterpart is [.RESTOREREG](dot-restorereg.md). ## See also +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ [Directives reference](directives-reference.md)\ +[MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md)\ [MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-savexmm128.md b/docs/assembler/masm/dot-savexmm128.md index 6a914c5547f..ed2fae15341 100644 --- a/docs/assembler/masm/dot-savexmm128.md +++ b/docs/assembler/masm/dot-savexmm128.md @@ -1,28 +1,69 @@ --- description: "Learn more about: .SAVEXMM128" title: ".SAVEXMM128" -ms.date: "12/17/2019" +ms.date: 05/04/2026 f1_keywords: [".SAVEXMM128"] helpviewer_keywords: [".SAVEXMM128 directive"] -ms.assetid: 551eb472-b8d0-47b1-8d82-995d1f485723 +ai-usage: ai-assisted --- # .SAVEXMM128 -Generates either a `UWOP_SAVE_XMM128` or a `UWOP_SAVE_XMM128_FAR` unwind code entry for the specified XMM register and offset using the current prologue offset. MASM will choose the most efficient encoding. +Generates either a `UWOP_SAVE_XMM128` or a `UWOP_SAVE_XMM128_FAR` unwind code entry for the specified XMM register and offset using the current prologue offset. Microsoft Assembler (MASM) chooses the most efficient encoding. ## Syntax -> **.SAVEXMM128** *xmmreg* , *offset* +> `.SAVEXMM128` *xmmreg* , *offset* ## Remarks -**.SAVEXMM128** allows ml64.exe users to specify how a frame function unwinds, and is only allowed within the prologue, which extends from the [PROC](proc.md) FRAME declaration to the [.ENDPROLOG](dot-endprolog.md) directive. These directives do not generate code; they only generate `.xdata` and `.pdata`. .SAVEXMM128 should be preceded by instructions that actually implement the actions to be unwound. It is a good practice to wrap both the unwind directives and the code they are meant to unwind in a macro to ensure agreement. +Use `.SAVEXMM128` with `ml64.exe` to specify how a frame function unwinds. You can only use it within the prologue, which extends from the [`PROC`](proc.md) `FRAME` declaration to the [.ENDPROLOG](dot-endprolog.md) directive. These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. Precede `.SAVEXMM128` by the instructions that actually implement the actions to be unwound. To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. *offset* must be a multiple of 16. -For more information, see [MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md). +## Unwind Version 3 behavior + +> [!IMPORTANT] +> Unwind Version 3 support is experimental and is subject to change. Enable it by using `ml64.exe /unwindv3`. + +In Unwind Version 3, `.SAVEXMM128` emits either a `WOD_SAVE_XMM128` or a `WOD_SAVE_XMM128_FAR` unwind code entry. Microsoft Assembler (MASM) selects the most efficient encoding based on the size of *offset*: + +| Unwind code | Condition | +|---|---| +| `WOD_SAVE_XMM128` | *offset* can be encoded as a scaled 16-bit value | +| `WOD_SAVE_XMM128_FAR` | *offset* requires a full 32-bit value | + +> [!NOTE] +> In Unwind Version 1 the directives come after the instruction. In Unwind Version 3, the directives come before the instruction. +> `.SAVEXMM128` must appear **before** the instruction it describes. This requirement is the opposite of Version 1, where the directive follows the instruction. + +### Example for unwindv3 + +```asm +; ml64 /unwindv3 ex1.asm /link /entry:Example1 /SUBSYSTEM:CONSOLE +_text SEGMENT +Example1 PROC FRAME + .allocstack 030h + sub rsp, 030h + .savexmm128 xmm6, 0 + movdqa [rsp], xmm6 + .savexmm128 xmm7, 010h + movdqa [rsp+010h], xmm7 +.endprolog + ; rest of function ... + movdqa xmm7, [rsp+010h] + movdqa xmm6, [rsp] + add rsp, 030h + ret +Example1 ENDP +_text ENDS +END +``` + +The epilogue counterpart is [.RESTOREXMM128](dot-restorexmm128.md). ## See also +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ [Directives reference](directives-reference.md)\ -[MASM BNF Grammar](masm-bnf-grammar.md) +[MASM BNF Grammar](masm-bnf-grammar.md)\ +[MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md) diff --git a/docs/assembler/masm/dot-setframe.md b/docs/assembler/masm/dot-setframe.md index d33281ed97a..7eeec50f330 100644 --- a/docs/assembler/masm/dot-setframe.md +++ b/docs/assembler/masm/dot-setframe.md @@ -1,10 +1,10 @@ --- description: "Learn more about: .SETFRAME" title: ".SETFRAME" -ms.date: "12/17/2019" +ms.date: 05/04/2026 f1_keywords: [".SETFRAME"] helpviewer_keywords: [".SETFRAME directive"] -ms.assetid: eaa9b5ed-4daa-4f1e-bdb6-100758007ab3 +ai-usage: ai-assisted --- # .SETFRAME @@ -12,13 +12,11 @@ Fills in the frame register field and offset in the unwind information using the ## Syntax -> **.SETFRAME** *reg*, *offset* +> `.SETFRAME` *reg*, *offset* ## Remarks -**.SETFRAME** allows ml64.exe users to specify how a frame function unwinds, and is only allowed within the prologue, which extends from the [PROC](proc.md) FRAME declaration to the [.ENDPROLOG](dot-endprolog.md) directive. These directives do not generate code; they only generate `.xdata` and `.pdata`. **.SETFRAME** should be preceded by instructions that actually implement the actions to be unwound. It is a good practice to wrap both the unwind directives and the code they are meant to unwind in a macro to ensure agreement. - -For more information, see [MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md). +Use `.SETFRAME` to specify how a frame function unwinds. You can only use it within the prologue, which extends from the [`PROC`](proc.md) `FRAME` declaration to the [.ENDPROLOG](dot-endprolog.md) directive. These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code. Precede `.SETFRAME` with instructions that implement the actions to be unwound. To ensure agreement, wrap both the unwind directives and the code they're meant to unwind in a macro. ## Sample @@ -55,7 +53,51 @@ _text ENDS END ``` +## Unwind Version 3 behavior + +> [!IMPORTANT] +> Unwind Version 3 support is experimental and is subject to change. Enable it by using `ml64.exe /unwindv3`. + +In Unwind Version 3, `.SETFRAME` emits a `WOD_SET_FPREG` unwind code entry for the specified register using the current prologue offset. It also fills in the frame register field and offset in the unwind information. The *offset* must be a multiple of 16 and less than or equal to 240. + +> [!NOTE] +> In Unwind Version 1 the directives come after the instruction. In Unwind Version 3, the directives come before the instruction. +> `.SETFRAME` must appear **before** the instruction it describes. This requirement is the opposite of Version 1, where the directive follows the instruction. + +### Example for unwindv3 + +```asm +; ml64 /unwindv3 frmex2.asm /link /entry:frmex2 /SUBSYSTEM:CONSOLE +_text SEGMENT +frmex2 PROC FRAME + .pushreg rbp + push rbp + .allocstack 010h + sub rsp, 010h + .setframe rbp, 0 + mov rbp, rsp +.endprolog + ; modify the stack pointer outside of the prologue (similar to alloca) + sub rsp, 060h + + ; we can unwind from the following AV because of the frame pointer + mov rax, 0 + mov rax, [rax] ; AV! + + add rsp, 060h + add rsp, 010h + pop rbp + ret +frmex2 ENDP +_text ENDS +END +``` + +The epilogue counterpart is [.UNSETFRAME](dot-unsetframe.md). + ## See also +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md)\ [Directives reference](directives-reference.md)\ [MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/dot-unsetframe.md b/docs/assembler/masm/dot-unsetframe.md new file mode 100644 index 00000000000..10b55371053 --- /dev/null +++ b/docs/assembler/masm/dot-unsetframe.md @@ -0,0 +1,82 @@ +--- +description: "Learn more about: .UNSETFRAME" +title: ".UNSETFRAME" +ms.date: 05/04/2026 +f1_keywords: [".UNSETFRAME"] +helpviewer_keywords: [".UNSETFRAME directive"] +ai-usage: ai-assisted +--- +# .UNSETFRAME + +Generates a `WOD_SET_FPREG` unwind code entry for the specified register and offset using the current offset in the epilogue. + +## Syntax + +> `.UNSETFRAME` *reg*, *offset* + +## Parameters + +*reg*\ +The frame pointer register to unset. + +*offset*\ +The offset into the stack frame where the frame pointer was established. + +## Remarks + +> [!IMPORTANT] +> This directive is experimental and is subject to change. Enable Unwind Version 3 with `ml64.exe /unwindv3`. + +`.UNSETFRAME` is only valid in Unwind Version 3. It's the epilogue counterpart to [.SETFRAME](dot-setframe.md). + +`.UNSETFRAME` is only allowed within an epilogue region, between [.BEGINEPILOG](dot-beginepilog.md) and [.ENDEPILOG](dot-endepilog.md). These directives generate unwind metadata (`.xdata` and `.pdata` sections) but don't produce executable code.\ +In Unwind Version 3, `.UNSETFRAME` must appear **before** the instruction that restores the stack pointer from the frame pointer register.\ +It's a good practice to wrap both the unwind directives and the code they're meant to unwind in a macro to ensure agreement. + +In Unwind Version 3, epilogue directives are mandatory for epilogue unwind code generation. No epilogue unwind codes are emitted without a `.BEGINEPILOG`/`.ENDEPILOG` pair. + +> [!NOTE] +> In Unwind Version 1, the directive appears after the corresponding instruction. In Unwind Version 3, the directive appears **before** the instruction. + +## Example for unwindv3 + +```asm +; ml64 /unwindv3 frmex2.asm /link /entry:frmex2 /SUBSYSTEM:CONSOLE +_text SEGMENT +frmex2 PROC FRAME + .pushreg rbp + push rbp + .allocstack 010h + sub rsp, 010h + .setframe rbp, 0 + mov rbp, rsp +.endprolog + ; modify the stack pointer outside of the prologue (similar to alloca) + sub rsp, 060h + + ; we can unwind from the following AV because of the frame pointer + mov rax, 0 + mov rax, [rax] ; AV! + + add rsp, 060h + .beginepilog + .unsetframe rbp, 0 + mov rsp, rbp + .freestack 010h + add rsp, 010h + .popreg rbp + pop rbp + .endepilog + ret +frmex2 ENDP +_text ENDS +END +``` + +## See also + +[x64 Unwind Version 3 (experimental)](directives-reference.md#x64-unwind-version-3-experimental)\ +[Directives Reference](directives-reference.md)\ +[.SETFRAME](dot-setframe.md)\ +[.BEGINEPILOG](dot-beginepilog.md)\ +[MASM BNF Grammar](masm-bnf-grammar.md) diff --git a/docs/assembler/masm/masm-for-x64-ml64-exe.md b/docs/assembler/masm/masm-for-x64-ml64-exe.md index 840b0020837..6abb9b44993 100644 --- a/docs/assembler/masm/masm-for-x64-ml64-exe.md +++ b/docs/assembler/masm/masm-for-x64-ml64-exe.md @@ -1,8 +1,9 @@ --- description: "Learn more about: Microsoft Macro Assembler (MASM) for x64 (ml64.exe)" title: "MASM for x64 (ml64.exe)" -ms.date: 09/21/2021 +ms.date: 05/07/2026 helpviewer_keywords: ["ml64", "ml64.exe", "masm for x64"] +ai-usage: ai-assisted --- # MASM for x64 (ml64.exe) @@ -21,34 +22,54 @@ The Visual Studio project system supports assembler-language files built by usin ### To add an assembler-language file to an existing Visual Studio C++ project 1. Select the project in **Solution Explorer**. On the menu bar, choose **Project**, **Build Customizations**. - 1. In the **Visual C++ Build Customization Files** dialog box, check the checkbox next to **masm(.targets,.props)**. Choose **OK** to save your selection and close the dialog box. - 1. On the menu bar, choose **Project**, **Add New Item**. - 1. In the **Add New Item** dialog box, select **C++ file (.cpp)** in the center pane. In the **Name** edit control, enter a new file name that has a *`.asm`* extension instead of *`.cpp`*. Choose **Add** to add the file to your project and close the dialog box. Create your assembler-language code in the *`.asm`* file you added. When you build your solution, the MASM assembler is invoked to assemble the *`.asm`* file into an object file that is then linked into your project. To make symbol access easier, declare your assembler functions as `extern "C"` in your C++ source code, rather than using the C++ name decoration conventions in your assembler-language source files. -## ml64-Specific Directives +## ml64-specific directives You can use the following ml64-specific directives in your assembler-language source code that targets x64: - [`.ALLOCSTACK`](dot-allocstack.md) - - [`.ENDPROLOG`](dot-endprolog.md) - - [`.PUSHFRAME`](dot-pushframe.md) - - [`.PUSHREG`](dot-pushreg.md) - - [`.SAVEREG`](dot-savereg.md) - - [`.SAVEXMM128`](dot-savexmm128.md) - - [`.SETFRAME`](dot-setframe.md) -The [`PROC`](proc.md) directive has also been updated for use with ml64.exe. +The [`PROC`](proc.md) directive is also updated for use with ml64.exe. + +## Unwind Version 3 directives (experimental) + +> [!IMPORTANT] +> Unwind Version 3 support is experimental and is subject to change. + +Unwind Version 3 is an updated unwind code scheme for x64 that generates richer stack unwind metadata. It introduces new epilogue directives, extends register support, and changes the directive ordering model. + +### Enable Unwind Version 3 + +Assemble with the `/unwindv3` option: `ml64 /unwindv3 filename.asm /link /entry:FunctionName` + +### Key differences from Version 1 + +| Feature | Version 1 | Version 3 | +|---|---|---| +| Directive ordering | Directive follows instruction | Directive precedes instruction | +| Unwind codes | `UWOP_*` | `WOD_*` | +| `.ALLOCSTACK` size variants | 2 (`UWOP_ALLOC_SMALL`, `UWOP_ALLOC_LARGE`) | 3 (adds `WOD_ALLOC_HUGE` for > 32 KB) | +| `.PUSHREG` register range | R0–R15 | R0–R31 | +| Epilogue recording | Optional | Mandatory (`.BEGINEPILOG`/`.ENDEPILOG` required) | +| Register-pair push/pop | Not supported | `.PUSH2REG`/`.POP2REG` directives | + +Epilogue recording is mandatory in Version 3: `.BEGINEPILOG` and `.ENDEPILOG` must surround the epilogue instructions. Without them, no epilogue unwind codes are emitted. + +> [!NOTE] +> In Unwind Version 1 the directives come after the instruction. In Unwind Version 3, the directives come before the instruction. + +For a complete list of Version 3 directives, see [x64 Unwind Version 3 directives](directives-reference.md) and [@UnwindVersion](at-unwindversion.md). ## 32-Bit Address Mode (Address Size Override) diff --git a/docs/assembler/masm/ml-and-ml64-command-line-reference.md b/docs/assembler/masm/ml-and-ml64-command-line-reference.md index e4ea469e36f..d838fb61520 100644 --- a/docs/assembler/masm/ml-and-ml64-command-line-reference.md +++ b/docs/assembler/masm/ml-and-ml64-command-line-reference.md @@ -1,9 +1,10 @@ --- title: "ML and ML64 command-line reference" description: "Reference guide to the Microsoft MASM ML and ML64 assembler command-line options." -ms.date: 7/3/2023 -f1_keywords: ["ML"] -helpviewer_keywords: ["/W* MASM compiler option", "/c MASM compiler option", "/EP MASM compiler option", "/Fe MASM compiler option", "/Zp MASM compiler option", "/AT MASM compiler option", "/Zm MASM compiler option", "/Sf MASM compiler option", "/Sp MASM compiler option", "/w MASM compiler option", "/Fl MASM compiler option", "/coff MASM compiler option", "/St MASM compiler option", "/Cx MASM compiler option", "/Sl MASM compiler option", "/Cu MASM compiler option", "MASM (Microsoft Macro Assembler), ML command-line reference", "/FPi MASM compiler option", "/Zf MASM compiler option", "ML environment variable", "/Fr MASM compiler option", "/help MASM compiler option", "/Sa MASM compiler option", "/Zd MASM compiler option", "/I MASM compiler option", "/? MASM compiler option", "/Bl MASM compiler option", "/Fm MASM compiler option", "/Fo MASM compiler option", "command-line reference [ML]", "/Sn MASM compiler option", "/Gd MASM compiler option", "/D* MASM compiler option", "environment variables, ML", "/Gc MASM compiler option", "/F* MASM compiler option", "/Sc MASM compiler option", "/H MASM compiler option", "/Zs MASM compiler option", "/omf MASM compiler option", "/quiet MASM compiler option", "/Sg MASM compiler option", "/Cp MASM compiler option", "/Zi MASM compiler option", "/nologo MASM compiler option", "/Sx MASM compiler option", "/WX MASM compiler option", "/Ss MASM compiler option", "command line, reference [ML]", "/Ta MASM compiler option"] +ms.date: 04/29/2026 +ai-usage: ai-assisted +f1_keywords: ["ML", "/unwindv3"] +helpviewer_keywords: ["/W* MASM compiler option", "/c MASM compiler option", "/EP MASM compiler option", "/Fe MASM compiler option", "/Zp MASM compiler option", "/AT MASM compiler option", "/Zm MASM compiler option", "/Sf MASM compiler option", "/Sp MASM compiler option", "/w MASM compiler option", "/Fl MASM compiler option", "/coff MASM compiler option", "/St MASM compiler option", "/Cx MASM compiler option", "/Sl MASM compiler option", "/Cu MASM compiler option", "MASM (Microsoft Macro Assembler), ML command-line reference", "/FPi MASM compiler option", "/Zf MASM compiler option", "ML environment variable", "/Fr MASM compiler option", "/help MASM compiler option", "/Sa MASM compiler option", "/Zd MASM compiler option", "/I MASM compiler option", "/? MASM compiler option", "/Bl MASM compiler option", "/Fm MASM compiler option", "/Fo MASM compiler option", "command-line reference [ML]", "/Sn MASM compiler option", "/Gd MASM compiler option", "/D* MASM compiler option", "environment variables, ML", "/Gc MASM compiler option", "/F* MASM compiler option", "/Sc MASM compiler option", "/H MASM compiler option", "/Zs MASM compiler option", "/omf MASM compiler option", "/quiet MASM compiler option", "/Sg MASM compiler option", "/Cp MASM compiler option", "/Zi MASM compiler option", "/nologo MASM compiler option", "/Sx MASM compiler option", "/WX MASM compiler option", "/Ss MASM compiler option", "command line, reference [ML]", "/Ta MASM compiler option", "/unwindv3 MASM compiler option"] --- # ML and ML64 command-line reference @@ -61,6 +62,7 @@ The options listed in the following table: | **`/St`** *`text`* | Specifies title for source listing. Same as [`TITLE`](title.md) text. | | **`/Sx`** | Turns on false conditionals in listing. | | **`/Ta`** *`filename`* | Assembles source file whose name doesn't end with the *`.asm`* extension. | +| **`/unwindv3`** | Enables experimental Unwind Version 3 unwind directive support. When specified, V3 unwind directives must appear *before* their associated instruction (the reverse of V1 behavior), epilogue recording via [`.BEGINEPILOG`](dot-beginepilog.md)/[`.ENDEPILOG`](dot-endepilog.md) is required, and the predefined macro [`@UnwindVersion`](at-unwindversion.md) returns `3`. For more information, see [MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md).
Only available in ml64.exe. | | **`/w`** | Same as **`/W0 /WX`**. | | **`/W`** *`level`* | Sets the warning level, where *`level`* = 0, 1, 2, or 3. | | **`/WX`** | If warnings are generated, returns an error code. | @@ -69,6 +71,8 @@ The options listed in the following table: | **`/Zf`** | Makes all symbols public. | | **`/ZH:MD5`** | Use MD5 for checksum in debug info. | | **`/ZH:SHA_256`** | Use SHA256 for checksum in debug info (default in Visual Studio 2022 version 17.0 and later). | +| **`/ZH:SHA384`** | Use SHA384 for checksum in debug info. | +| **`/ZH:SHA512`** | Use SHA512 for checksum in debug info. | | **`/Zi`** | Generates CodeView information in object file. | | **`/Zm`** | Enables **`M510`** option for maximum compatibility with MASM 5.1.
Not available in ml64.exe. | | **`/Zp`**⟦*`alignment`*⟧ | Packs structures on the specified byte boundary. The *`alignment`* can be 1, 2, 4, 8, or 16. | diff --git a/docs/assembler/masm/proc.md b/docs/assembler/masm/proc.md index 9eb65fc3770..222b437a4a9 100644 --- a/docs/assembler/masm/proc.md +++ b/docs/assembler/masm/proc.md @@ -12,8 +12,8 @@ Marks start and end of a procedure block called *label*. The statements in the b ## Syntax -> *label* **PROC** ⟦*distance*⟧ ⟦*language-type*⟧ ⟦ **PUBLIC** | **PRIVATE** | **EXPORT** ⟧ ⟦__\<__*prologuearg*__>__⟧ ⟦**USES** *reglist*⟧ ⟦__,__ *parameter* ⟦__:__*tag*⟧ ...⟧\ -> ⟦**FRAME** ⟦__:__*ehandler-address*⟧ ⟧\ +> *label* `PROC` ⟦*distance*⟧ ⟦*language-type*⟧ ⟦ `PUBLIC` | `PRIVATE` | `EXPORT` ⟧ ⟦__\<__*prologuearg*__>__⟧ ⟦`USES` *reglist*⟧ ⟦__,__ *parameter* ⟦__:__*tag*⟧ ...⟧\ +> ⟦`FRAME` ⟦__:__*ehandler-address*⟧ ⟧\ > *statements*\ > *label* **ENDP** @@ -21,9 +21,9 @@ Marks start and end of a procedure block called *label*. The statements in the b The ⟦*distance*⟧ and ⟦*language-type*⟧ arguments are valid only in 32-bit MASM. -⟦**FRAME** ⟦__:__*ehandler-address*⟧ ⟧ is only valid with ml64.exe, and causes MASM to generate a function table entry in .pdata and unwind information in .xdata for a function's structured exception handling unwind behavior. +⟦`FRAME` ⟦__:__*ehandler-address*⟧ ⟧ is only valid with ml64.exe, and causes MASM to generate a function table entry in .pdata and unwind information in .xdata for a function's structured exception handling unwind behavior. -When the **FRAME** attribute is used, it must be followed by an [.ENDPROLOG](dot-endprolog.md) directive. +When the `FRAME` attribute is used, it must be followed by an [.ENDPROLOG](dot-endprolog.md) directive. See [MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md) for more information on using ml64.exe. @@ -49,7 +49,7 @@ _text ENDS END ``` -The above code will emit the following function table and unwind information: +The above code emits the following function table and unwind information: ```Output FileHeader->Machine 34404 diff --git a/docs/assembler/masm/symbols-reference.md b/docs/assembler/masm/symbols-reference.md index c7fd4af9f81..a6c296fc5c1 100644 --- a/docs/assembler/masm/symbols-reference.md +++ b/docs/assembler/masm/symbols-reference.md @@ -1,9 +1,9 @@ --- description: "Learn more about: Symbols reference" title: "Symbols reference" -ms.date: 07/15/2020 +ms.date: 05/04/2026 helpviewer_keywords: ["MASM (Microsoft Macro Assembler), symbols reference"] -ms.assetid: 96ed59cc-dafa-4299-bb2e-9c7c3f496491 +ai-usage: ai-assisted --- # Symbols reference @@ -30,6 +30,9 @@ ms.assetid: 96ed59cc-dafa-4299-bb2e-9c7c3f496491 :::column span=""::: [`@Interface`](at-interface.md) :::column-end::: + :::column span=""::: + [`@UnwindVersion`](at-unwindversion.md) + :::column-end::: :::column span=""::: [`@Version`](at-version.md) :::column-end::: diff --git a/docs/assembler/toc.yml b/docs/assembler/toc.yml index 8f8b923a9c3..1e90a1e19d3 100644 --- a/docs/assembler/toc.yml +++ b/docs/assembler/toc.yml @@ -117,6 +117,8 @@ items: href: ../assembler/masm/dot-alpha.md - name: ASSUME href: ../assembler/masm/assume.md + - name: .BEGINEPILOG + href: ../assembler/masm/dot-beginepilog.md - name: .BREAK href: ../assembler/masm/dot-break.md - name: BYTE @@ -171,6 +173,8 @@ items: href: ../assembler/masm/end-masm.md - name: .ENDIF href: ../assembler/masm/dot-endif.md + - name: .ENDEPILOG + href: ../assembler/masm/dot-endepilog.md - name: ENDM href: ../assembler/masm/endm.md - name: ENDP @@ -225,6 +229,8 @@ items: href: ../assembler/masm/forc.md - name: .FPO href: ../assembler/masm/dot-fpo.md + - name: .FREESTACK + href: ../assembler/masm/dot-freestack.md - name: FWORD href: ../assembler/masm/fword.md - name: GOTO @@ -315,8 +321,14 @@ items: href: ../assembler/masm/oword.md - name: PAGE href: ../assembler/masm/page.md + - name: .POP2REG + href: ../assembler/masm/dot-pop2reg.md - name: POPCONTEXT href: ../assembler/masm/popcontext.md + - name: .POPREG + href: ../assembler/masm/dot-popreg.md + - name: .POPFRAME + href: ../assembler/masm/dot-popframe.md - name: PROC href: ../assembler/masm/proc.md - name: PROTO @@ -325,6 +337,8 @@ items: href: ../assembler/masm/public-masm.md - name: PURGE href: ../assembler/masm/purge.md + - name: .PUSH2REG + href: ../assembler/masm/dot-push2reg.md - name: PUSHCONTEXT href: ../assembler/masm/pushcontext.md - name: .PUSHFRAME @@ -349,6 +363,10 @@ items: href: ../assembler/masm/repeat.md - name: REPT href: ../assembler/masm/rept.md + - name: .RESTOREREG + href: ../assembler/masm/dot-restorereg.md + - name: .RESTOREXMM128 + href: ../assembler/masm/dot-restorexmm128.md - name: .SAFESEH href: ../assembler/masm/dot-safeseh.md - name: .SALL @@ -401,6 +419,8 @@ items: href: ../assembler/masm/typedef-masm.md - name: UNION href: ../assembler/masm/union.md + - name: .UNSETFRAME + href: ../assembler/masm/dot-unsetframe.md - name: .UNTIL href: ../assembler/masm/dot-until.md - name: .UNTILCXZ @@ -479,6 +499,8 @@ items: href: ../assembler/masm/at-substr.md - name: "@Time" href: ../assembler/masm/at-time.md + - name: "@UnwindVersion" + href: ../assembler/masm/at-unwindversion.md - name: "@Version" href: ../assembler/masm/at-version.md - name: "@WordSize" diff --git a/docs/atl-mfc-shared/allocating-and-releasing-memory-for-a-bstr.md b/docs/atl-mfc-shared/allocating-and-releasing-memory-for-a-bstr.md index b257f105f93..d1c1db36c70 100644 --- a/docs/atl-mfc-shared/allocating-and-releasing-memory-for-a-bstr.md +++ b/docs/atl-mfc-shared/allocating-and-releasing-memory-for-a-bstr.md @@ -4,10 +4,11 @@ title: "Allocating and Releasing Memory for a BSTR" ms.date: "11/04/2016" f1_keywords: ["bstr"] helpviewer_keywords: ["BSTRs, memory allocation", "memory deallocation, string memory", "memory [C++], releasing", "memory allocation, BSTRs", "memory deallocation, BSTR memory", "strings [C++], releasing"] -ms.assetid: 98041e29-3442-4a02-b425-7a4a13e9cc84 --- # Allocating and Releasing Memory for a `BSTR` +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + When you create `BSTR`s and pass them between COM objects, you must take care in treating the memory they use in order to avoid memory leaks. When a `BSTR` stays within an interface, you must free its memory when you are done with it. However, when a `BSTR` passes out of an interface, the receiving object takes responsibility for its memory management. In general, the rules for allocating and releasing memory allocated for `BSTR`s are as follows: diff --git a/docs/atl-mfc-shared/atl-mfc-concepts.md b/docs/atl-mfc-shared/atl-mfc-concepts.md index 6227696c2bb..c2d4845da77 100644 --- a/docs/atl-mfc-shared/atl-mfc-concepts.md +++ b/docs/atl-mfc-shared/atl-mfc-concepts.md @@ -3,15 +3,16 @@ description: "Learn more about: ATL/MFC Concepts" title: "ATL-MFC Concepts" ms.date: "11/04/2016" helpviewer_keywords: ["MFC", "ATL"] -ms.assetid: 4d973f56-8730-4e0b-9522-b5f43bc4548d --- # ATL/MFC Concepts +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + This section provides conceptual and task-based topics to help you program using the classes shared between Active Template Library (ATL) and Microsoft Foundation Class (MFC) Library. ## In This Section -[Strings (ATL/MFC)](../atl-mfc-shared/strings-atl-mfc.md)
+[Strings (ATL/MFC)](../atl-mfc-shared/strings-atl-mfc.md)\ Describes how to manage string data in applications. ## See also diff --git a/docs/atl-mfc-shared/atl-mfc-shared-classes.md b/docs/atl-mfc-shared/atl-mfc-shared-classes.md index 564d03df38f..52b69d1e957 100644 --- a/docs/atl-mfc-shared/atl-mfc-shared-classes.md +++ b/docs/atl-mfc-shared/atl-mfc-shared-classes.md @@ -6,10 +6,11 @@ ms.date: "11/04/2016" ms.topic: "concept-article" f1_keywords: ["vc.classes.shared"] helpviewer_keywords: ["CPoint class, shared class", "CFileTimeSpan class, shared class", "COleDateTime class, shared class", "CFixedStringT class, shared class", "CStrBufT class, shared class", "CFileTime class, shared class", "CRect class, shared class", "CSimpleStringT class, shared class", "CStringT class, shared class", "CSize class, shared class", "CStringData class, shared class", "IAtlStringMgr class, shared class", "shared classes, MFC and ATL", "COleDateTimeSpan class, shared class", "CString objects, shared class", "shared classes"] -ms.assetid: e13aaac3-21ec-4f4d-8834-432b40fde544 --- # ATL/MFC Shared Classes +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + These utility classes can be used in any native C++ project without requiring any MFC DLL. ## In This Section diff --git a/docs/atl-mfc-shared/avoidance-of-heap-contention.md b/docs/atl-mfc-shared/avoidance-of-heap-contention.md index 6639bbbe493..aec032124dc 100644 --- a/docs/atl-mfc-shared/avoidance-of-heap-contention.md +++ b/docs/atl-mfc-shared/avoidance-of-heap-contention.md @@ -3,10 +3,11 @@ description: "Learn more about: Avoidance of Heap Contention" title: "Avoidance of Heap Contention" ms.date: "11/04/2016" helpviewer_keywords: ["heap contention"] -ms.assetid: 797129d7-5f8c-4b0e-8974-bb93217e9ab5 --- # Avoidance of Heap Contention +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + The default string managers provided by MFC and ATL are simple wrappers on top of a global heap. This global heap is fully thread-safe, meaning that multiple threads can allocate and free memory from it simultaneously without corrupting the heap. To help provide thread safety, the heap has to serialize access to itself. This is usually accomplished with a critical section or similar locking mechanism. Whenever two threads try to access the heap simultaneously, one thread is blocked until the other thread's request is finished. For many applications, this situation rarely occurs and the performance impact of the heap's locking mechanism is negligible. However, for applications that frequently access the heap from multiple threads contention for the heap's lock can cause the application to run slower than if it were single-threaded (even on machines with multiple CPUs). Applications that use [CStringT](../atl-mfc-shared/reference/cstringt-class.md) are especially susceptible to heap contention because operations on `CStringT` objects frequently require reallocation of the string buffer. diff --git a/docs/atl-mfc-shared/basic-cstring-operations.md b/docs/atl-mfc-shared/basic-cstring-operations.md index 047bd978b28..243f52b3271 100644 --- a/docs/atl-mfc-shared/basic-cstring-operations.md +++ b/docs/atl-mfc-shared/basic-cstring-operations.md @@ -6,6 +6,8 @@ helpviewer_keywords: ["CString objects, basic operations", "string literals, CSt --- # Basic CString Operations +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + This topic explains the following basic [CString](../atl-mfc-shared/reference/cstringt-class.md) operations: - [Creating CString objects from standard C literal strings](#_core_creating_cstring_objects_from_standard_c_literal_strings) diff --git a/docs/atl-mfc-shared/cfixedstringt-example-of-a-custom-string-manager.md b/docs/atl-mfc-shared/cfixedstringt-example-of-a-custom-string-manager.md index 11094716d1b..b525fdae33f 100644 --- a/docs/atl-mfc-shared/cfixedstringt-example-of-a-custom-string-manager.md +++ b/docs/atl-mfc-shared/cfixedstringt-example-of-a-custom-string-manager.md @@ -3,10 +3,11 @@ description: "Learn more about: CFixedStringT: Example of a Custom String Manage title: "CFixedStringT: Example of a Custom String Manager" ms.date: "11/04/2016" helpviewer_keywords: ["CFixedStringT class, using a custom string manager"] -ms.assetid: 1cf11fd7-51b8-4b94-87af-02bc25f47dd6 --- # CFixedStringT: Example of a Custom String Manager +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + The ATL library implements one example of a custom string manager used by class [CFixedStringT](../atl-mfc-shared/reference/cfixedstringt-class.md), called **CFixedStringMgr**. `CFixedStringT` is derived from [CStringT](../atl-mfc-shared/reference/cstringt-class.md) and implements a string that allocates its character data as part of the `CFixedStringT` object itself as long as the string is less than the length specified by the `t_nChars` template parameter of `CFixedStringT`. With this approach, the string does not need the heap at all, unless the length of the string grows beyond the size of the fixed buffer. Because `CFixedStringT` does not always use a heap to allocate its string data, it cannot use `CAtlStringMgr` as its string manager. It uses a custom string manager (`CFixedStringMgr`), implementing the [IAtlStringMgr](../atl-mfc-shared/reference/iatlstringmgr-class.md) interface. This interface is discussed in [Implementation of a Custom String Manager (Advanced Method)](../atl-mfc-shared/implementation-of-a-custom-string-manager-advanced-method.md). The constructor for `CFixedStringMgr` takes three parameters: diff --git a/docs/atl-mfc-shared/cstring-argument-passing.md b/docs/atl-mfc-shared/cstring-argument-passing.md index 68ff5addc65..23f1483655f 100644 --- a/docs/atl-mfc-shared/cstring-argument-passing.md +++ b/docs/atl-mfc-shared/cstring-argument-passing.md @@ -6,6 +6,8 @@ helpviewer_keywords: ["strings [C++], as function input/output", "argument passi --- # `CString` Argument Passing +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + This article explains how to pass [`CString`](../atl-mfc-shared/reference/cstringt-class.md) objects to functions and how to return `CString` objects from functions. ## `CString` Argument-Passing Conventions diff --git a/docs/atl-mfc-shared/cstring-exception-cleanup.md b/docs/atl-mfc-shared/cstring-exception-cleanup.md index f9571eb6993..3a5273217b2 100644 --- a/docs/atl-mfc-shared/cstring-exception-cleanup.md +++ b/docs/atl-mfc-shared/cstring-exception-cleanup.md @@ -3,10 +3,11 @@ description: "Learn more about: CString Exception Cleanup" title: "CString Exception Cleanup" ms.date: "11/04/2016" helpviewer_keywords: ["CString objects, exceptions", "exception handling, cleanup code"] -ms.assetid: 28b9ce70-be63-4a0d-92a8-44bbfbc95e83 --- # CString Exception Cleanup +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + In previous versions of MFC, it was important that you clean up [CString](../atl-mfc-shared/reference/cstringt-class.md) objects after use. With MFC version 3.0 and later, explicit cleanup is no longer necessary. Under the C++ exception handling mechanism that MFC now uses, you do not have to worry about cleanup after an exception. For a description of how C++ "unwinds" the stack after an exception is caught, see [the try, catch, and throw statements](../cpp/try-throw-and-catch-statements-cpp.md). Even if you use the MFC **TRY**/**CATCH** macros instead of the C++ keywords **`try`** and **`catch`**, MFC uses the C++ exception mechanism underneath, so you still do not need to clean up explicitly. diff --git a/docs/atl-mfc-shared/cstring-operations-relating-to-c-style-strings.md b/docs/atl-mfc-shared/cstring-operations-relating-to-c-style-strings.md index c90c04bf1b1..8629690cd0a 100644 --- a/docs/atl-mfc-shared/cstring-operations-relating-to-c-style-strings.md +++ b/docs/atl-mfc-shared/cstring-operations-relating-to-c-style-strings.md @@ -3,10 +3,11 @@ description: "Learn more about: CString Operations Relating to C-Style Strings" title: "CString Operations Relating to C-Style Strings" ms.date: "11/04/2016" helpviewer_keywords: ["CString objects, basic operations", "MFC [C++], string handling class", "string conversion [C++], C-style strings", "strings [C++], string operations", "standard run-time library string functions", "null values, Null-terminated string conversion", "string functions", "strings [C++], in C", "string arguments", "C-style strings", "strings [C++], class CString", "casting CString objects"] -ms.assetid: 5048de8a-5298-4891-b8a0-c554b5a3ac1b --- # `CString` Operations Relating to C-Style Strings +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + A [`CString`](../atl-mfc-shared/using-cstring.md) object contains character string data. `CString` inherits the set of the [methods and operators](../atl-mfc-shared/reference/cstringt-class.md) that are defined in the class template [`CStringT`](../atl-mfc-shared/reference/cstringt-class.md) to work with string data. (`CString` is a **`typedef`** that specializes `CStringT` to work with the kind of character data that `CString` supports.) `CString` does not store character data internally as a C-style null-terminated string. Instead, `CString` tracks the length of character data so that it can more securely watch the data and the space it requires. diff --git a/docs/atl-mfc-shared/cstring-semantics.md b/docs/atl-mfc-shared/cstring-semantics.md index a8b283511b6..a978cc1e251 100644 --- a/docs/atl-mfc-shared/cstring-semantics.md +++ b/docs/atl-mfc-shared/cstring-semantics.md @@ -3,10 +3,11 @@ description: "Learn more about: CString Semantics" title: "CString Semantics" ms.date: "11/04/2016" helpviewer_keywords: ["semantics in Cstring", "CString objects, assignment semantics", "assignment statements, assigning CString objects"] -ms.assetid: d4023480-526f-499a-85f6-324b4de5b85f --- # CString Semantics +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + Even though [CString](../atl-mfc-shared/reference/cstringt-class.md) objects are dynamic objects that can grow, they act like built-in primitive types and simple classes. Each `CString` object represents a unique value. `CString` objects should be thought of as the actual strings rather than as pointers to strings. You can assign one `CString` object to another. However, when you modify one of the two `CString` objects, the other `CString` object is not modified, as shown by the following example: diff --git a/docs/atl-mfc-shared/date-and-time.md b/docs/atl-mfc-shared/date-and-time.md index 6285d86cb2f..9f7eec080cc 100644 --- a/docs/atl-mfc-shared/date-and-time.md +++ b/docs/atl-mfc-shared/date-and-time.md @@ -6,6 +6,8 @@ helpviewer_keywords: ["time, MFC programming", "time", "MFC, date and time", "da --- # Date and Time +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + MFC supports several different ways of working with dates and times: - Support for the Automation [`DATE` data type](../atl-mfc-shared/date-type.md). `DATE` supports date, time, and date/time values. The [`COleDateTime`](../atl-mfc-shared/reference/coledatetime-class.md) and [`COleDateTimeSpan`](../atl-mfc-shared/reference/coledatetimespan-class.md) classes encapsulate this functionality. They work with the [`COleVariant`](../mfc/reference/colevariant-class.md) class using Automation support. diff --git a/docs/atl-mfc-shared/date-type.md b/docs/atl-mfc-shared/date-type.md index 51909869c5b..6c9e9c6c7fb 100644 --- a/docs/atl-mfc-shared/date-type.md +++ b/docs/atl-mfc-shared/date-type.md @@ -4,10 +4,11 @@ title: "DATE Type" ms.date: "11/04/2016" f1_keywords: ["DATE"] helpviewer_keywords: ["Date data type, implementing", "Date data type", "DATE type", "Date data type, about Date data type", "MFC, date and time", "hour values representation"] -ms.assetid: 695853ed-b614-4575-b793-b8c287372038 --- # DATE Type +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + The DATE type is implemented using an 8-byte floating-point number. Days are represented by whole number increments starting with 30 December 1899, midnight as time zero. Hour values are expressed as the absolute value of the fractional part of the number. The following table illustrates several dates along with their DATE type numeric equivalent: |Date and time|Representation| diff --git a/docs/atl-mfc-shared/exporting-string-classes-using-cstringt.md b/docs/atl-mfc-shared/exporting-string-classes-using-cstringt.md index 3e5b794a885..c8e98da7fe7 100644 --- a/docs/atl-mfc-shared/exporting-string-classes-using-cstringt.md +++ b/docs/atl-mfc-shared/exporting-string-classes-using-cstringt.md @@ -3,10 +3,11 @@ description: "Learn more about: Exporting String Classes Using CStringT" title: "Exporting String Classes Using CStringT" ms.date: "11/04/2016" helpviewer_keywords: ["CStringT class, exporting strings"] -ms.assetid: bdfc441e-8d2a-461c-9885-46178066c09f --- # Exporting String Classes Using CStringT +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + In the past, MFC developers have derived from `CString` to specialize their own string classes. In Microsoft Visual C++.NET (MFC 8.0), the [CString](../atl-mfc-shared/using-cstring.md) class was superseded by a template class called [CStringT](../atl-mfc-shared/reference/cstringt-class.md). This provided several benefits: - It allowed the MFC `CString` class to be used in ATL projects without linking in the larger MFC static library or DLL. diff --git a/docs/atl-mfc-shared/implementation-of-a-custom-string-manager-advanced-method.md b/docs/atl-mfc-shared/implementation-of-a-custom-string-manager-advanced-method.md index 55fe40e157f..0ea1922d71c 100644 --- a/docs/atl-mfc-shared/implementation-of-a-custom-string-manager-advanced-method.md +++ b/docs/atl-mfc-shared/implementation-of-a-custom-string-manager-advanced-method.md @@ -3,10 +3,11 @@ description: "Learn more about: Implementation of a Custom String Manager (Advan title: "Implementation of a Custom String Manager (Advanced Method)" ms.date: "11/04/2016" helpviewer_keywords: ["IAtlStringMgr class, using"] -ms.assetid: 64ab7da9-47c1-4c4a-9cd7-4cc37e7f3f57 --- # Implementation of a Custom String Manager (Advanced Method) +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + In specialized situations, you might want to implement a custom string manager that does more than just change which heap is used to allocate memory. In this situation, you must manually implement the [IAtlStringMgr](../atl-mfc-shared/reference/iatlstringmgr-class.md) interface as your custom string manager. In order to do this, it is important to first understand how [CStringT](../atl-mfc-shared/reference/cstringt-class.md) uses that interface to manage its string data. Every instance of `CStringT` has a pointer to a [CStringData](../atl-mfc-shared/reference/cstringdata-class.md) structure. This variable-length structure contains important information about the string (such as length), as well as the actual character data for the string. Every custom string manager is responsible for allocating and freeing these structures at the request of `CStringT`. diff --git a/docs/atl-mfc-shared/implementation-of-a-custom-string-manager-basic-method.md b/docs/atl-mfc-shared/implementation-of-a-custom-string-manager-basic-method.md index 2e91251aaa2..ff0ead0d8cd 100644 --- a/docs/atl-mfc-shared/implementation-of-a-custom-string-manager-basic-method.md +++ b/docs/atl-mfc-shared/implementation-of-a-custom-string-manager-basic-method.md @@ -3,10 +3,11 @@ description: "Learn more about: Implementation of a Custom String Manager (Basic title: "Implementation of a Custom String Manager (Basic Method)" ms.date: "11/04/2016" helpviewer_keywords: ["IAtlStringMgr class, using"] -ms.assetid: eac5d13e-cbb4-4e82-b01e-f5f2dbcb962a --- # Implementation of a Custom String Manager (Basic Method) +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + The easiest way to customize the memory allocation scheme for string data is to use the ATL-provided `CAtlStringMgr` class but provide your own memory allocation routines. The constructor for `CAtlStringMgr` takes a single parameter: a pointer to an `IAtlMemMgr` object. `IAtlMemMgr` is an abstract base class that provides a generic interface to a heap. Using the `IAtlMemMgr` interface, the `CAtlStringMgr` allocates, reallocates, and frees the memory used to store string data. You can either implement the `IAtlMemMgr` interface yourself, or use one of the five ATL-provided memory manager classes. The ATL-provided memory managers simply wrap existing memory allocation facilities: - [CCRTHeap](../atl/reference/ccrtheap-class.md) Wraps the standard CRT heap functions ([malloc](../c-runtime-library/reference/malloc.md), [free](../c-runtime-library/reference/free.md), and [realloc](../c-runtime-library/reference/realloc.md)) diff --git a/docs/atl-mfc-shared/includes/lifecycle-note.md b/docs/atl-mfc-shared/includes/lifecycle-note.md new file mode 100644 index 00000000000..6725bfc524e --- /dev/null +++ b/docs/atl-mfc-shared/includes/lifecycle-note.md @@ -0,0 +1,2 @@ +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library and Active Template Library (ATL) continue to be supported. However, we're no longer adding features or updating the documentation. \ No newline at end of file diff --git a/docs/atl-mfc-shared/memory-management-with-cstringt.md b/docs/atl-mfc-shared/memory-management-with-cstringt.md index c0df6f2ceb3..104e67a46e7 100644 --- a/docs/atl-mfc-shared/memory-management-with-cstringt.md +++ b/docs/atl-mfc-shared/memory-management-with-cstringt.md @@ -3,10 +3,11 @@ description: "Learn more about: Memory Management with CStringT" title: "Memory Management with CStringT" ms.date: "11/04/2016" helpviewer_keywords: ["CString objects, memory management", "memory [C++], usage", "IAtlStringMgr class, using", "strings [C++], custom memory management", "CFixedStringT class, description of", "strings [C++], memory management", "CStringT class, memory management"] -ms.assetid: 88b8342d-19b5-48c4-9cf6-e4c44cece21e --- # Memory Management with CStringT +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + Class [CStringT](../atl-mfc-shared/reference/cstringt-class.md) is a template class used to manipulate variable-length character strings. The memory to hold these strings is allocated and released through a string manager object, associated with each instance of `CStringT`. MFC and ATL provide default instantiations of `CStringT`, called `CString`, `CStringA`, and `CStringW`, which manipulate strings of different character types. These character types are of type TCHAR, **`char`**, and **`wchar_t`**, respectively. These default string types use a string manager that allocates memory from the process heap (in ATL) or the CRT heap (in MFC). For typical applications, this memory allocation scheme is sufficient. However, for code making intensive use of strings (or multithreaded code) the default memory managers may not perform optimally. This topic describes how to override the default memory management behavior of `CStringT`, creating allocators specifically optimized for the task at hand. - [Implementation of a Custom String Manager (Basic Method)](../atl-mfc-shared/implementation-of-a-custom-string-manager-basic-method.md) diff --git a/docs/atl-mfc-shared/reference/cfiletime-class.md b/docs/atl-mfc-shared/reference/cfiletime-class.md index 35d7d8dc48e..abc271c7199 100644 --- a/docs/atl-mfc-shared/reference/cfiletime-class.md +++ b/docs/atl-mfc-shared/reference/cfiletime-class.md @@ -4,10 +4,11 @@ title: "CFileTime class" ms.date: "10/18/2018" f1_keywords: ["CFileTime", "ATLTIME/ATL::CFileTime", "ATLTIME/ATL::CFileTime::CFileTime", "ATLTIME/ATL::CFileTime::GetCurrentTime", "ATLTIME/ATL::CFileTime::GetTime", "ATLTIME/ATL::CFileTime::LocalToUTC", "ATLTIME/ATL::CFileTime::SetTime", "ATLTIME/ATL::CFileTime::UTCToLocal", "ATLTIME/ATL::CFileTime::Day", "ATLTIME/ATL::CFileTime::Hour", "ATLTIME/ATL::CFileTime::Millisecond", "ATLTIME/ATL::CFileTime::Minute", "ATLTIME/ATL::CFileTime::Second", "ATLTIME/ATL::CFileTime::Week"] helpviewer_keywords: ["CFileTime class", "shared classes, CFileTime"] -ms.assetid: 1a358a65-1383-4124-b0d4-59b026e6860f --- # `CFileTime` class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for managing the date and time values associated with a file. ## Syntax diff --git a/docs/atl-mfc-shared/reference/cfiletimespan-class.md b/docs/atl-mfc-shared/reference/cfiletimespan-class.md index 62a26f382ec..b972803f581 100644 --- a/docs/atl-mfc-shared/reference/cfiletimespan-class.md +++ b/docs/atl-mfc-shared/reference/cfiletimespan-class.md @@ -4,10 +4,11 @@ description: "The Active Template Library (ATL) and Microsoft Foundation Classes ms.date: "01/10/2020" f1_keywords: ["CFileTimeSpan", "ATLTIME/ATL::CFileTimeSpan", "ATLTIME/ATL::CFileTimeSpan::CFileTimeSpan", "ATLTIME/ATL::CFileTimeSpan::GetTimeSpan", "ATLTIME/ATL::CFileTimeSpan::SetTimeSpan"] helpviewer_keywords: ["shared classes, CFileTimeSpan", "CFileTimeSpan class"] -ms.assetid: 5856fb39-9c82-4027-8ccf-8760890491ec --- # `CFileTimeSpan` class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for managing relative date and time values associated with a file. ## Syntax diff --git a/docs/atl-mfc-shared/reference/cfixedstringt-class.md b/docs/atl-mfc-shared/reference/cfixedstringt-class.md index c236dcb8d4d..6109dc0c1a6 100644 --- a/docs/atl-mfc-shared/reference/cfixedstringt-class.md +++ b/docs/atl-mfc-shared/reference/cfixedstringt-class.md @@ -4,10 +4,11 @@ title: "CFixedStringT Class" ms.date: "03/27/2019" f1_keywords: ["CFixedStringT", "CSTRINGT/ATL::CFixedStringT", "CSTRINGT/ATL::CFixedStringT::CFixedStringT"] helpviewer_keywords: ["CFixedStringT class", "shared classes, CFixedStringT"] -ms.assetid: 6d4171ba-3104-493a-a6cc-d515f4ba9a4b --- # CFixedStringT Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a string object with a fixed character buffer. ## Syntax diff --git a/docs/atl-mfc-shared/reference/cimage-class.md b/docs/atl-mfc-shared/reference/cimage-class.md index d355d0f27a4..311a44e2811 100644 --- a/docs/atl-mfc-shared/reference/cimage-class.md +++ b/docs/atl-mfc-shared/reference/cimage-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["jpeg files", "bitmaps [C++], ATL and MFC support for", "i --- # `CImage` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + `CImage` provides enhanced bitmap support, including the ability to load and save images in JPEG, GIF, BMP, and Portable Network Graphics (PNG) formats. > [!IMPORTANT] diff --git a/docs/atl-mfc-shared/reference/classes-shared-by-mfc-and-atl.md b/docs/atl-mfc-shared/reference/classes-shared-by-mfc-and-atl.md index bbcb2af0790..6fb01f6e90c 100644 --- a/docs/atl-mfc-shared/reference/classes-shared-by-mfc-and-atl.md +++ b/docs/atl-mfc-shared/reference/classes-shared-by-mfc-and-atl.md @@ -3,10 +3,11 @@ description: "Learn more about: Classes Shared by MFC and ATL" title: "Classes Shared by MFC and ATL" ms.date: "11/04/2016" helpviewer_keywords: ["shared classes, classes"] -ms.assetid: ca8b4b6b-744d-430b-b31f-d5b2f17bf210 --- # Classes Shared by MFC and ATL +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + The following table lists the classes shared between MFC and ATL. |Class|Description|Header file| diff --git a/docs/atl-mfc-shared/reference/coledatetime-class.md b/docs/atl-mfc-shared/reference/coledatetime-class.md index 5da193d9b93..98a888a14f1 100644 --- a/docs/atl-mfc-shared/reference/coledatetime-class.md +++ b/docs/atl-mfc-shared/reference/coledatetime-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["shared classes, COleDateTime", "time-only values", "Date --- # COleDateTime Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Encapsulates the `DATE` data type that is used in OLE automation. ## Syntax diff --git a/docs/atl-mfc-shared/reference/coledatetimespan-class.md b/docs/atl-mfc-shared/reference/coledatetimespan-class.md index 491074bbae3..04701fb7ddc 100644 --- a/docs/atl-mfc-shared/reference/coledatetimespan-class.md +++ b/docs/atl-mfc-shared/reference/coledatetimespan-class.md @@ -4,10 +4,11 @@ title: "COleDateTimeSpan Class" ms.date: "03/27/2019" f1_keywords: ["COleDateTimeSpan", "ATLCOMTIME/ATL::COleDateTimeSpan", "ATLCOMTIME/ATL::COleDateTimeSpan::COleDateTimeSpan", "ATLCOMTIME/ATL::COleDateTimeSpan::Format", "ATLCOMTIME/ATL::COleDateTimeSpan::GetDays", "ATLCOMTIME/ATL::COleDateTimeSpan::GetHours", "ATLCOMTIME/ATL::COleDateTimeSpan::GetMinutes", "ATLCOMTIME/ATL::COleDateTimeSpan::GetSeconds", "ATLCOMTIME/ATL::COleDateTimeSpan::GetStatus", "ATLCOMTIME/ATL::COleDateTimeSpan::GetTotalDays", "ATLCOMTIME/ATL::COleDateTimeSpan::GetTotalHours", "ATLCOMTIME/ATL::COleDateTimeSpan::GetTotalMinutes", "ATLCOMTIME/ATL::COleDateTimeSpan::GetTotalSeconds", "ATLCOMTIME/ATL::COleDateTimeSpan::SetDateTimeSpan", "ATLCOMTIME/ATL::COleDateTimeSpan::SetStatus", "ATLCOMTIME/ATL::COleDateTimeSpan::m_span", "ATLCOMTIME/ATL::COleDateTimeSpan::m_status"] helpviewer_keywords: ["timespan", "time span", "shared classes, COleDateTimeSpan", "Date data type, MFC encapsulation of", "COleDateTimeSpan class"] -ms.assetid: 7441526d-a30a-4019-8fb3-3fee6f897cbe --- # COleDateTimeSpan Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Represents a relative time, a time span. ## Syntax diff --git a/docs/atl-mfc-shared/reference/cpoint-class.md b/docs/atl-mfc-shared/reference/cpoint-class.md index 1636a18f6dd..d153efe18e5 100644 --- a/docs/atl-mfc-shared/reference/cpoint-class.md +++ b/docs/atl-mfc-shared/reference/cpoint-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["LPPOINT structure", "POINT structure", "CPoint class"] --- # `CPoint` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Similar to the Windows `POINT` structure. ## Syntax diff --git a/docs/atl-mfc-shared/reference/crect-class.md b/docs/atl-mfc-shared/reference/crect-class.md index a213a9fcb66..2ccae83333a 100644 --- a/docs/atl-mfc-shared/reference/crect-class.md +++ b/docs/atl-mfc-shared/reference/crect-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["LPCRECT data type", "CRect class", "LPRECT operator", "RE --- # `CRect` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Similar to a Windows [`RECT`](/windows/win32/api/windef/ns-windef-rect) structure. ## Syntax diff --git a/docs/atl-mfc-shared/reference/csimplestringt-class.md b/docs/atl-mfc-shared/reference/csimplestringt-class.md index b62a850efa1..cda69f67bea 100644 --- a/docs/atl-mfc-shared/reference/csimplestringt-class.md +++ b/docs/atl-mfc-shared/reference/csimplestringt-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["shared classes, CSimpleStringT", "strings [C++], ATL clas --- # `CSimpleStringT` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a `CSimpleStringT` object. ## Syntax diff --git a/docs/atl-mfc-shared/reference/csize-class.md b/docs/atl-mfc-shared/reference/csize-class.md index f398b5055da..458de4f0ed0 100644 --- a/docs/atl-mfc-shared/reference/csize-class.md +++ b/docs/atl-mfc-shared/reference/csize-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["SIZE", "dimensions, MFC", "dimensions", "CSize class"] --- # CSize Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Similar to the Windows [SIZE](/windows/win32/api/windef/ns-windef-size) structure, which implements a relative coordinate or position. ## Syntax diff --git a/docs/atl-mfc-shared/reference/cstrbuft-class.md b/docs/atl-mfc-shared/reference/cstrbuft-class.md index 4cc53bfee59..ed385faa03d 100644 --- a/docs/atl-mfc-shared/reference/cstrbuft-class.md +++ b/docs/atl-mfc-shared/reference/cstrbuft-class.md @@ -4,10 +4,11 @@ title: "CStrBufT Class" ms.date: "10/18/2018" f1_keywords: ["CStrBufT", "ATLSIMPSTR/ATL::CStrBufT", "ATLSIMPSTR/ATL::CStrBufT::CStrBufT", "ATLSIMPSTR/ATL::CStrBufT::SetLength", "ATLSIMPSTR/ATL::CStrBufT::AUTO_LENGTH", "ATLSIMPSTR/ATL::CStrBufT::SET_LENGTH"] helpviewer_keywords: ["strings [C++], custom memory management", "CStrBufT class", "shared classes, CStrBufT"] -ms.assetid: 6b50fa8f-87e8-4ed4-a229-157ce128710f --- # CStrBufT Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides automatic resource cleanup for `GetBuffer` and `ReleaseBuffer` calls on an existing `CStringT` object. ## Syntax diff --git a/docs/atl-mfc-shared/reference/cstringdata-class.md b/docs/atl-mfc-shared/reference/cstringdata-class.md index 2755f5e8ab1..8db5939672f 100644 --- a/docs/atl-mfc-shared/reference/cstringdata-class.md +++ b/docs/atl-mfc-shared/reference/cstringdata-class.md @@ -4,10 +4,11 @@ title: "CStringData Class" ms.date: "11/04/2016" f1_keywords: ["CStringData", "ATLSIMPSTR/ATL::CStringData", "ATLSIMPSTR/ATL::AddRef", "ATLSIMPSTR/ATL::data", "ATLSIMPSTR/ATL::IsLocked", "ATLSIMPSTR/ATL::IsShared", "ATLSIMPSTR/ATL::Lock", "ATLSIMPSTR/ATL::Release", "ATLSIMPSTR/ATL::Unlock", "ATLSIMPSTR/ATL::nAllocLength", "ATLSIMPSTR/ATL::nDataLength", "ATLSIMPSTR/ATL::nRefs", "ATLSIMPSTR/ATL::pStringMgr"] helpviewer_keywords: ["CStringData class", "shared classes, CStringData"] -ms.assetid: 4e31b5ca-3dbe-4fd5-b692-8211fbfb2593 --- # CStringData Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents the data of a string object. ## Syntax diff --git a/docs/atl-mfc-shared/reference/cstringt-class.md b/docs/atl-mfc-shared/reference/cstringt-class.md index a47c9ad9a69..d22cac3373a 100644 --- a/docs/atl-mfc-shared/reference/cstringt-class.md +++ b/docs/atl-mfc-shared/reference/cstringt-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["strings [C++], in ATL", "shared classes, CStringT", "CStr --- # `CStringT` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a **`CStringT`** object. ## Syntax diff --git a/docs/atl-mfc-shared/reference/ctime-class.md b/docs/atl-mfc-shared/reference/ctime-class.md index 067db91b524..9c5623b02f3 100644 --- a/docs/atl-mfc-shared/reference/ctime-class.md +++ b/docs/atl-mfc-shared/reference/ctime-class.md @@ -4,10 +4,11 @@ title: "CTime Class" ms.date: "10/18/2018" f1_keywords: ["ATLTIME/ATL::CTime", "ATLTIME/ATL::CTime::CTime", "ATLTIME/ATL::CTime::Format", "ATLTIME/ATL::CTime::FormatGmt", "ATLTIME/ATL::CTime::GetAsDBTIMESTAMP", "ATLTIME/ATL::CTime::GetAsSystemTime", "ATLTIME/ATL::CTime::GetCurrentTime", "ATLTIME/ATL::CTime::GetDay", "ATLTIME/ATL::CTime::GetDayOfWeek", "ATLTIME/ATL::CTime::GetGmtTm", "ATLTIME/ATL::CTime::GetHour", "ATLTIME/ATL::CTime::GetLocalTm", "ATLTIME/ATL::CTime::GetMinute", "ATLTIME/ATL::CTime::GetMonth", "ATLTIME/ATL::CTime::GetSecond", "ATLTIME/ATL::CTime::GetTime", "ATLTIME/ATL::CTime::GetYear", "ATLTIME/ATL::CTime::Serialize64"] helpviewer_keywords: ["CTime class", "shared classes, CTime"] -ms.assetid: 0a299544-485b-48dc-9d3c-fdc30f57d612 --- # CTime Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Represents an absolute time and date. ## Syntax diff --git a/docs/atl-mfc-shared/reference/ctimespan-class.md b/docs/atl-mfc-shared/reference/ctimespan-class.md index ae10bdba1cf..df669d06353 100644 --- a/docs/atl-mfc-shared/reference/ctimespan-class.md +++ b/docs/atl-mfc-shared/reference/ctimespan-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["elapsed time, CTimeSpan object", "timespan", "time span", --- # `CTimeSpan` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + An amount of time, which is internally stored as the number of seconds in the time span. ## Syntax diff --git a/docs/atl-mfc-shared/reference/iatlstringmgr-class.md b/docs/atl-mfc-shared/reference/iatlstringmgr-class.md index 9eb991ca286..c94ac02b615 100644 --- a/docs/atl-mfc-shared/reference/iatlstringmgr-class.md +++ b/docs/atl-mfc-shared/reference/iatlstringmgr-class.md @@ -4,10 +4,11 @@ title: "IAtlStringMgr Class" ms.date: "10/18/2018" f1_keywords: ["IAtlStringMgr", "ATLSIMPSTR/ATL::IAtlStringMgr", "ATLSIMPSTR/ATL::Allocate", "ATLSIMPSTR/ATL::Clone", "ATLSIMPSTR/ATL::Free", "ATLSIMPSTR/ATL::GetNilString", "ATLSIMPSTR/ATL::Reallocate"] helpviewer_keywords: ["shared classes, IAtlStringMgr", "memory, managing", "IAtlStringMgr class"] -ms.assetid: 722f0346-a770-4aa7-8f94-177be8dba823 --- # IAtlStringMgr Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents the interface to a `CStringT` memory manager. ## Syntax diff --git a/docs/atl-mfc-shared/string-data-management.md b/docs/atl-mfc-shared/string-data-management.md index b48c6a636da..c30b096c6ec 100644 --- a/docs/atl-mfc-shared/string-data-management.md +++ b/docs/atl-mfc-shared/string-data-management.md @@ -6,6 +6,8 @@ helpviewer_keywords: ["Unicode, string objects"] --- # String Data Management +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + Visual C++ provides several ways to manage string data: - [String Manipulation](../c-runtime-library/string-manipulation-crt.md) for working with C-style `NULL`-terminated strings diff --git a/docs/atl-mfc-shared/strings-atl-mfc.md b/docs/atl-mfc-shared/strings-atl-mfc.md index 1c0b4515fa4..a497b8ec3a7 100644 --- a/docs/atl-mfc-shared/strings-atl-mfc.md +++ b/docs/atl-mfc-shared/strings-atl-mfc.md @@ -6,6 +6,8 @@ helpviewer_keywords: ["const char pointers", "strings [C++], in ATL", "MFC [C++] --- # Strings (ATL/MFC) +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + Nearly all programs work with string data. Visual C++ provides several ways to manage this string data. ## In This Section diff --git a/docs/atl-mfc-shared/unicode-and-multibyte-character-set-mbcs-support.md b/docs/atl-mfc-shared/unicode-and-multibyte-character-set-mbcs-support.md index 2ba1928aa64..b6ca21a7e14 100644 --- a/docs/atl-mfc-shared/unicode-and-multibyte-character-set-mbcs-support.md +++ b/docs/atl-mfc-shared/unicode-and-multibyte-character-set-mbcs-support.md @@ -6,6 +6,8 @@ helpviewer_keywords: ["MFC [C++], character set support", "MBCS [C++], strings a --- # Unicode and Multibyte Character Set (MBCS) Support +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + Some languages, for example, Japanese and Chinese, have large character sets. To support programming for these markets, the Microsoft Foundation Class Library (MFC) enables two different approaches to handling large character sets: - [Unicode](#mfc-support-for-unicode-strings), **`wchar_t`** based wide-characters, and strings encoded as UTF-16. diff --git a/docs/atl-mfc-shared/using-cstring.md b/docs/atl-mfc-shared/using-cstring.md index f6a99466fcc..829888fc125 100644 --- a/docs/atl-mfc-shared/using-cstring.md +++ b/docs/atl-mfc-shared/using-cstring.md @@ -3,10 +3,11 @@ description: "Learn more about: Using CString" title: "Using CString" ms.date: "06/18/2018" helpviewer_keywords: ["CString objects, C++ string manipulation", "CString objects, reference counting", "CString class (Visual C++)"] -ms.assetid: ed018aaf-8b10-46f9-828c-f9c092dc7609 --- # Using `CString` +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + The topics in this section describe how to program with `CString`. For reference documentation about the `CString` class, see the documentation for [`CStringT`](../atl-mfc-shared/reference/cstringt-class.md). To use `CString`, include the `atlstr.h` header. diff --git a/docs/atl-mfc-shared/using-cstringt.md b/docs/atl-mfc-shared/using-cstringt.md index e7232579f8a..6e322077aef 100644 --- a/docs/atl-mfc-shared/using-cstringt.md +++ b/docs/atl-mfc-shared/using-cstringt.md @@ -3,10 +3,11 @@ description: "Learn more about: Using CStringT" title: "Using CStringT" ms.date: "11/04/2016" helpviewer_keywords: ["CStringT class, using"] -ms.assetid: 3a9fffb1-6f90-482a-ab69-4003e6084cb5 --- # Using CStringT +[!INCLUDE[product-lifecycle-status](./includes/lifecycle-note.md)] + The topics in this section describe programming using the template class [CStringT](../atl-mfc-shared/reference/cstringt-class.md). ## In This Section diff --git a/docs/atl/active-template-library-atl-concepts.md b/docs/atl/active-template-library-atl-concepts.md index cda405159a6..ba5f6335bbc 100644 --- a/docs/atl/active-template-library-atl-concepts.md +++ b/docs/atl/active-template-library-atl-concepts.md @@ -3,11 +3,12 @@ description: "Learn more about: Active Template Library (ATL) Concepts" title: "Active Template Library (ATL) Concepts" ms.date: "05/06/2019" helpviewer_keywords: ["ATL, about ATL"] -ms.assetid: a3960991-4d76-4da5-9568-3fa7fde53ff4 ms.topic: concept-article --- # Active Template Library (ATL) Concepts +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The Active Template Library (ATL) is a set of template-based C++ classes that let you create small, fast Component Object Model (COM) objects. It has special support for key COM features, including stock implementations, dual interfaces, standard COM enumerator interfaces, connection points, tear-off interfaces, and ActiveX controls. If you do a lot of ATL programming, you will want to learn more about COM and .NET attributes, which is designed to simplify COM programming. For more information, see [Attributed Programming](../windows/attributes/cpp-attributes-com-net.md). (COM and .NET attributes are not to be confused with the \[\[attribute]] feature in the C++ standard.) diff --git a/docs/atl/active-template-library-atl-tutorial.md b/docs/atl/active-template-library-atl-tutorial.md index 2a9841ea00c..e8054c8897f 100644 --- a/docs/atl/active-template-library-atl-tutorial.md +++ b/docs/atl/active-template-library-atl-tutorial.md @@ -4,11 +4,12 @@ description: "Create an ActiveX control using Microsoft C++ and the Active Templ ms.custom: "get-started-article" ms.date: "05/03/2019" helpviewer_keywords: ["ATL projects, tutorials", "controls [ATL], tutorials", "ATL tutorial", "tutorials [ATL]", "ATL, tutorials"] -ms.assetid: f921a121-09c8-4812-9317-e15b2f1471fa ms.topic: tutorial --- # Active Template Library (ATL) Tutorial +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL is designed to simplify the process of creating efficient, flexible, lightweight controls. This tutorial leads you through the creation of an ActiveX control, demonstrating many ATL and COM fundamentals. By following this tutorial, you will learn how to add a control to an ATL project that draws a circle and a filled polygon. You will then add a property to indicate how many sides the polygon will have and create drawing code for updating the control when the property changes. The control will then be displayed on a Web page using some VBScript to make it respond to events. diff --git a/docs/atl/adding-a-control-atl-tutorial-part-2.md b/docs/atl/adding-a-control-atl-tutorial-part-2.md index 668cb2039f1..f0cdb0d25aa 100644 --- a/docs/atl/adding-a-control-atl-tutorial-part-2.md +++ b/docs/atl/adding-a-control-atl-tutorial-part-2.md @@ -3,11 +3,12 @@ description: "Learn more about: Adding a Control (ATL Tutorial, Part 2)" title: "Adding a Control (ATL Tutorial, Part 2)" ms.custom: "get-started-article" ms.date: "08/19/2019" -ms.assetid: c9575a75-1064-41f1-9697-7aada560c669 ms.topic: tutorial --- # Adding a Control (ATL Tutorial, Part 2) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + In this step, you add a control to your project, build it, and test it on a Web page. ## Procedures diff --git a/docs/atl/adding-a-property-page-atl-tutorial-part-6.md b/docs/atl/adding-a-property-page-atl-tutorial-part-6.md index 394d9aff8da..1d169bed706 100644 --- a/docs/atl/adding-a-property-page-atl-tutorial-part-6.md +++ b/docs/atl/adding-a-property-page-atl-tutorial-part-6.md @@ -3,11 +3,12 @@ description: "Learn more about: Adding a Property Page (ATL Tutorial, Part 6)" title: "Adding a Property Page (ATL Tutorial, Part 6)" ms.custom: "get-started-article" ms.date: "09/27/2018" -ms.assetid: df80d255-e7ea-49d9-b940-3f012e90cf9b ms.topic: tutorial --- # Adding a Property Page (ATL Tutorial, Part 6) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + > [!NOTE] > The ATL OLE DB Provider wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/adding-a-property-to-the-control-atl-tutorial-part-3.md b/docs/atl/adding-a-property-to-the-control-atl-tutorial-part-3.md index 839a2653ed1..852dd925637 100644 --- a/docs/atl/adding-a-property-to-the-control-atl-tutorial-part-3.md +++ b/docs/atl/adding-a-property-to-the-control-atl-tutorial-part-3.md @@ -3,11 +3,12 @@ description: "Learn more about: Adding a Property to the Control (ATL Tutorial, title: "Adding a Property to the Control (ATL Tutorial, Part 3)" ms.custom: "get-started-article" ms.date: "09/26/2018" -ms.assetid: f775fe34-103b-4f07-9999-400e987ee030 ms.topic: tutorial --- # Adding a Property to the Control (ATL Tutorial, Part 3) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + `IPolyCtl` is the interface that contains the control's custom methods and properties, and you will add a property to it. ### To add the property definitions to your project diff --git a/docs/atl/adding-an-atl-message-handler.md b/docs/atl/adding-an-atl-message-handler.md index ee2243126a9..178eb55484c 100644 --- a/docs/atl/adding-an-atl-message-handler.md +++ b/docs/atl/adding-an-atl-message-handler.md @@ -3,11 +3,12 @@ description: "Learn more about: Adding an ATL Message Handler" title: "Adding an ATL Message Handler" ms.date: "11/04/2016" helpviewer_keywords: ["message handlers [C++]", "ATL, windows", "message handling [C++], ATL message handler", "windows [C++], ATL", "ATL, message handlers"] -ms.assetid: cdea38a1-0d9b-4f8d-bbd5-b4f063fb3eeb ms.topic: concept-article --- # Adding an ATL Message Handler +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + To add a message handler (a member function that handles Windows messages) to a control, first select the control in the Class View. Then open the **Properties** window, select the **Messages** icon, and click the drop-down control in the box opposite the required message. This will add a declaration for the message handler in the control's header file and a skeleton implementation of the handler in the control's .cpp file. It will also add the message map and add an entry for the handler. Adding a message handler in ATL is similar to adding a message handler to an MFC class. See [Adding an MFC Message Handler](../mfc/reference/adding-an-mfc-message-handler.md) for more information. diff --git a/docs/atl/adding-an-event-atl-tutorial-part-5.md b/docs/atl/adding-an-event-atl-tutorial-part-5.md index 48d9ef8f01d..ed1690d4df0 100644 --- a/docs/atl/adding-an-event-atl-tutorial-part-5.md +++ b/docs/atl/adding-an-event-atl-tutorial-part-5.md @@ -3,11 +3,12 @@ description: "Learn more about: Adding an Event (ATL Tutorial, Part 5)" title: "Adding an Event (ATL Tutorial, Part 5)" ms.custom: "get-started-article" ms.date: "09/27/2018" -ms.assetid: 2de12022-3148-4ce3-8606-8a9d4274f0e9 ms.topic: tutorial --- # Adding an Event (ATL Tutorial, Part 5) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + In this step, you will add a `ClickIn` and a `ClickOut` event to your ATL control. You will fire the `ClickIn` event if the user clicks within the polygon and fire `ClickOut` if the user clicks outside. The tasks to add an event are as follows: - Adding the `ClickIn` and `ClickOut` methods diff --git a/docs/atl/adding-connection-points-to-an-object.md b/docs/atl/adding-connection-points-to-an-object.md index d2564c44cd6..732d3688c9c 100644 --- a/docs/atl/adding-connection-points-to-an-object.md +++ b/docs/atl/adding-connection-points-to-an-object.md @@ -7,6 +7,8 @@ ms.topic: how-to --- # Adding Connection Points to an Object +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The [ATL Tutorial](active-template-library-atl-tutorial.md) demonstrates how to create a control with support for connection points, how to add events, and then how to implement the connection point. ATL implements connection points with the [`IConnectionPointImpl`](reference/iconnectionpointimpl-class.md) class. To implement a connection point, you have two choices: diff --git a/docs/atl/adding-functionality-to-the-composite-control.md b/docs/atl/adding-functionality-to-the-composite-control.md index 35766209450..f32c146abd8 100644 --- a/docs/atl/adding-functionality-to-the-composite-control.md +++ b/docs/atl/adding-functionality-to-the-composite-control.md @@ -3,11 +3,12 @@ description: "Learn more about: Adding Functionality to the Composite Control" title: "Adding Functionality to the Composite Control" ms.date: "11/04/2016" helpviewer_keywords: ["event handlers [C++], ActiveX controls", "composite controls, handling events", "ActiveX controls [C++], events"] -ms.assetid: 98f85681-9564-480d-af38-03f9733fe58b ms.topic: concept-article --- # Adding Functionality to the Composite Control +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Once you have inserted any necessary controls into the composite control, the next step involves adding new functionality. This new functionality usually falls into two categories: - Supporting additional interfaces and customizing the behavior of your composite control with additional, specific features. diff --git a/docs/atl/aggregation.md b/docs/atl/aggregation.md index 36c510daf37..e1b0448277a 100644 --- a/docs/atl/aggregation.md +++ b/docs/atl/aggregation.md @@ -3,10 +3,11 @@ description: "Learn more about: Aggregation" title: "Aggregation" ms.date: "11/04/2016" helpviewer_keywords: ["aggregation [C++]", "aggregate objects [C++]"] -ms.assetid: 7125bb8e-b269-4b50-9bba-295b467a54cc --- # Aggregation +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + There are times when an object's implementor would like to take advantage of the services offered by another, prebuilt object. Furthermore, it would like this second object to appear as a natural part of the first. COM achieves both of these goals through containment and aggregation. Aggregation means that the containing (outer) object creates the contained (inner) object as part of its creation process and the interfaces of the inner object are exposed by the outer. An object allows itself to be aggregatable or not. If it is, then it must follow certain rules for aggregation to work properly. diff --git a/docs/atl/atl-and-the-free-threaded-marshaler.md b/docs/atl/atl-and-the-free-threaded-marshaler.md index 5d5e78c8a63..b496b5b4fc8 100644 --- a/docs/atl/atl-and-the-free-threaded-marshaler.md +++ b/docs/atl/atl-and-the-free-threaded-marshaler.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL and the Free Threaded Marshaler" title: "ATL and the Free Threaded Marshaler" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, free threaded marshaler", "free threaded marshaler", "threading [C++], marshaler in ATL", "threading [ATL], free threaded marshaler", "FTM in ATL"] -ms.assetid: 2db88a13-2217-4ebc-aa7e-432d5da902eb --- # ATL and the Free Threaded Marshaler +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The ATL Simple Object Wizard's Attributes page provides an option that allows your class to aggregate the free threaded marshaler (FTM). The wizard generates code to create an instance of the free threaded marshaler in `FinalConstruct` and release that instance in `FinalRelease`. A COM_INTERFACE_ENTRY_AGGREGATE macro is automatically added to the COM map to ensure that `QueryInterface` requests for [IMarshal](/windows/win32/api/objidlbase/nn-objidlbase-imarshal) are handled by the free threaded marshaler. diff --git a/docs/atl/atl-class-overview.md b/docs/atl/atl-class-overview.md index 98846a0de5f..bf22cf76fca 100644 --- a/docs/atl/atl-class-overview.md +++ b/docs/atl/atl-class-overview.md @@ -3,11 +3,12 @@ description: "Learn more about: ATL class overview" title: "ATL class overview" ms.date: "11/04/2016" helpviewer_keywords: ["classes [C++], ATL", "ATL, class reference"] -ms.assetid: c38ac93d-c3a2-4ce7-8153-f1d34c0f0fa6 ms.topic: concept-article --- # ATL class overview +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Classes in the Active Template Library (ATL) can be categorized as follows: [Class factories](../atl/class-factories-classes.md)\ diff --git a/docs/atl/atl-collection-and-enumerator-classes.md b/docs/atl/atl-collection-and-enumerator-classes.md index d96c74e5703..b887eabdb83 100644 --- a/docs/atl/atl-collection-and-enumerator-classes.md +++ b/docs/atl/atl-collection-and-enumerator-classes.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Collection and Enumerator Classes" title: "ATL Collection and Enumerator Classes" ms.date: "11/04/2016" helpviewer_keywords: ["enumerators, ATL classes", "collection classes, ATL"] -ms.assetid: 6818db73-7094-48d8-a0ca-18147beec362 --- # ATL Collection and Enumerator Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL provides the following classes to help you implement collections and enumerators. |Class|Description| diff --git a/docs/atl/atl-collection-classes.md b/docs/atl/atl-collection-classes.md index db96014d6f0..bd9c02edc03 100644 --- a/docs/atl/atl-collection-classes.md +++ b/docs/atl/atl-collection-classes.md @@ -3,11 +3,12 @@ description: "Learn more about: ATL Collection Classes" title: "ATL collection class overview" ms.date: "11/19/2018" helpviewer_keywords: ["DestructElements function", "collection classes, choosing", "ConstructElements function", "SerializeElements function", "traits classes", "collection classes, about collection classes", "CTraits classes", "collection classes"] -ms.assetid: 4d619d46-5b4e-41dd-b9fd-e86b1fbc00b5 ms.topic: concept-article --- # ATL Collection Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL provides many classes for storing and accessing data. Which class you decide to use depends on several factors, including: - The amount of data to be stored diff --git a/docs/atl/atl-collections-and-enumerators.md b/docs/atl/atl-collections-and-enumerators.md index 68eea6e6f86..ba991026b3c 100644 --- a/docs/atl/atl-collections-and-enumerators.md +++ b/docs/atl/atl-collections-and-enumerators.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Collections and Enumerators" title: "ATL Collections and Enumerators" ms.date: "11/04/2016" helpviewer_keywords: ["enumerator interfaces", "collections, ATL classes", "enumerators, ATL classes", "collection interfaces"] -ms.assetid: b2d37119-3ab2-4e0a-b65b-f377f07e4098 --- # ATL Collections and Enumerators +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + A `collection` is a COM object that provides an interface that allows access to a group of data items (raw data or other objects). An interface that follows the standards for providing access to a group of objects is known as a *collection interface*. At a minimum, collection interfaces must provide a `Count` property that returns the number of items in the collection, an `Item` property that returns an item from the collection based on an index, and a `_NewEnum` property that returns an enumerator for the collection. Optionally, collection interfaces can provide `Add` and `Remove` methods to allow items to be inserted into or deleted from the collection, and a `Clear` method to remove all items. diff --git a/docs/atl/atl-com-desktop-components.md b/docs/atl/atl-com-desktop-components.md index 3d5d2ad0c96..e12f41f8be4 100644 --- a/docs/atl/atl-com-desktop-components.md +++ b/docs/atl/atl-com-desktop-components.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL COM Desktop Components" title: "ATL COM Desktop Components" ms.date: "10/19/2018" helpviewer_keywords: ["ATL, reference", "ATL, about ATL"] -ms.assetid: 291f38d1-d2de-4687-86a9-99b4fd35706c --- # ATL COM Desktop Components +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The ATL Reference documents the Active Template Library (ATL), a set of template-based C++ classes that simplify the programming of Component Object Model (COM) objects. COM is a binary specification for creating and consuming software components on Windows. To fully take advantage of ATL, a working familiarity with COM is highly recommended. For more information about COM, see [Component Object Model (COM)](/windows/win32/com/component-object-model--com--portal). ## In This Section diff --git a/docs/atl/atl-com-property-pages.md b/docs/atl/atl-com-property-pages.md index 109d83b95c0..3b84ea0421e 100644 --- a/docs/atl/atl-com-property-pages.md +++ b/docs/atl/atl-com-property-pages.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL COM Property Pages" title: "ATL COM Property Pages" ms.date: "11/04/2016" helpviewer_keywords: ["property pages, COM", "ATL COM objects", "COM property pages", "property pages, ATL", "COM objects, ATL", "ATL property pages"] -ms.assetid: 663c7caa-2e5e-4b5c-b8ea-fd434ceb1654 --- # ATL COM Property Pages +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + COM property pages provide a user interface for setting the properties (or calling the methods) of one or more COM objects. Property pages are used extensively by ActiveX controls for providing rich user interfaces that allow control properties to be set at design time. Property pages are COM objects that implement the [IPropertyPage](/windows/win32/api/ocidl/nn-ocidl-ipropertypage) or [IPropertyPage2](/windows/win32/api/ocidl/nn-ocidl-ipropertypage2) interface. These interfaces provide methods that allow the page to be associated with a `site` (a COM object representing the container of the page) and a number of *objects* (COM objects whose methods will be called in response to changes made by the user of the property page). The property page container is responsible for calling methods on the property page interface to tell the page when to show or hide its user interface, and when to apply the changes made by the user to the underlying objects. diff --git a/docs/atl/atl-composite-control-fundamentals.md b/docs/atl/atl-composite-control-fundamentals.md index 99d5bc76e01..c96615a0bd2 100644 --- a/docs/atl/atl-composite-control-fundamentals.md +++ b/docs/atl/atl-composite-control-fundamentals.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Composite Control Fundamentals" title: "ATL Composite Control Fundamentals" ms.date: "11/04/2016" helpviewer_keywords: ["composite controls, about composite controls"] -ms.assetid: 2ac78cdd-1ec4-4d78-871c-1bcc23b5253e --- # ATL Composite Control Fundamentals +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + A composite control is a type of ActiveX control that can contain (similar to a dialog box) other ActiveX controls or Windows controls. Once the composite control is built, it can be inserted anywhere an ActiveX control can be hosted. The ATL Project Wizard and **Add Class** dialog box automate the process of creating and implementing a composite control project, similar to the result of running the Application Wizard to create an MFC application framework. The development process consists of five steps: diff --git a/docs/atl/atl-connection-point-classes.md b/docs/atl/atl-connection-point-classes.md index 9de4d1eaf44..21d955c22e5 100644 --- a/docs/atl/atl-connection-point-classes.md +++ b/docs/atl/atl-connection-point-classes.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Connection Point Classes" title: "ATL Connection Point Classes" ms.date: "11/04/2016" helpviewer_keywords: ["CFirePropNotifyEvent class, connection point classes", "connection points [C++], ATL classes", "ATL, connection points", "CComDynamicUnkArray class, connection point classes", "CFirePropNotifyEvent class", "CComUnkArray class, connection point classes"] -ms.assetid: 9582ba71-7ace-4df4-9c9b-1b0636953efc --- # ATL Connection Point Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL uses the following classes to support connection points: - [IConnectionPointImpl](../atl/reference/iconnectionpointimpl-class.md) implements a connection point. The IID of the outgoing interface it represents is passed as a template parameter. diff --git a/docs/atl/atl-connection-point-example.md b/docs/atl/atl-connection-point-example.md index 0a7cf22ac7a..c837053c9e1 100644 --- a/docs/atl/atl-connection-point-example.md +++ b/docs/atl/atl-connection-point-example.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Connection Point Example" title: "ATL Connection Point Example" ms.date: "11/04/2016" helpviewer_keywords: ["connection points [C++], examples", "examples [ATL]"] -ms.assetid: a49721b7-f308-43de-8868-f662a94bc81a --- # ATL Connection Point Example +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + This example shows an object that supports [IPropertyNotifySink](/windows/win32/api/ocidl/nn-ocidl-ipropertynotifysink) as an outgoing interface: [!code-cpp[NVC_ATL_Windowing#84](../atl/codesnippet/cpp/atl-connection-point-example_1.h)] diff --git a/docs/atl/atl-connection-points.md b/docs/atl/atl-connection-points.md index 9bad34db0b4..cb3f08ffa9f 100644 --- a/docs/atl/atl-connection-points.md +++ b/docs/atl/atl-connection-points.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Connection Points" title: "ATL Connection Points" ms.date: "11/04/2016" helpviewer_keywords: ["connections, connection points", "ATL, connection points", "connection points [C++], about connection points"] -ms.assetid: 17d76165-5f83-4f95-b36d-483821c247a1 --- # ATL Connection Points +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + A connectable object is one that supports outgoing interfaces. An outgoing interface allows the object to communicate with a client. For each outgoing interface, the connectable object exposes a connection point. Each outgoing interface is implemented by a client on an object called a sink. ![Diagram that shows the connection points on a client object and a connectable object.](../atl/media/vc2zw31.gif "Connection points") diff --git a/docs/atl/atl-copy-policy-classes.md b/docs/atl/atl-copy-policy-classes.md index 08787e3fe9b..0c2aad5b629 100644 --- a/docs/atl/atl-copy-policy-classes.md +++ b/docs/atl/atl-copy-policy-classes.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Copy Policy Classes" title: "ATL Copy Policy Classes" ms.date: "11/04/2016" helpviewer_keywords: ["data [C++], ATL", "classes [C++], copy policy", "copy policy classes [C++]", "_Copy class", "_CopyInterface class"] -ms.assetid: 06704b68-d318-4c5d-a65b-71457fe9d00d --- # ATL Copy Policy Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Copy policy classes are [utility classes](../atl/utility-classes.md) used to initialize, copy, and delete data. Copy policy classes allow you to define copy semantics for any type of data, and to define conversions between different data types. ATL uses copy policy classes in its implementations of the following templates: diff --git a/docs/atl/atl-encoding-reference.md b/docs/atl/atl-encoding-reference.md index e7153b05201..36787474f2a 100644 --- a/docs/atl/atl-encoding-reference.md +++ b/docs/atl/atl-encoding-reference.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Encoding Reference" title: "ATL Encoding Reference" ms.date: "11/04/2016" helpviewer_keywords: ["encoding", "encoding, functions"] -ms.assetid: 82d4fdf3-3c4a-4fe2-b297-8ffb4714406f --- # ATL Encoding Reference +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Encoding in a range of common Internet standards such as uuencode, hexadecimal, and UTF8 is supported by the code found in *`atlenc.h`*. ### Functions diff --git a/docs/atl/atl-event-handling-summary.md b/docs/atl/atl-event-handling-summary.md index 166f1d40284..55d8eabacca 100644 --- a/docs/atl/atl-event-handling-summary.md +++ b/docs/atl/atl-event-handling-summary.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Event Handling Summary" title: "ATL Event Handling Summary" ms.date: "11/04/2016" helpviewer_keywords: ["event handling, implementing"] -ms.assetid: e8b47ef0-0bdc-47ff-9dd6-34df11dde9a2 --- # ATL Event Handling Summary +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + In general, handling COM events is a relatively simple process. There are three main steps: - Implement the event interface on your object. diff --git a/docs/atl/atl-module-classes.md b/docs/atl/atl-module-classes.md index 4613d5af005..512b96192d5 100644 --- a/docs/atl/atl-module-classes.md +++ b/docs/atl/atl-module-classes.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Module Classes" title: "ATL Module Classes" ms.date: "11/04/2016" helpviewer_keywords: ["CComModule class, what's changed", "ATL, module classes", "module classes"] -ms.assetid: fd75382d-c955-46ba-a38e-37728b7fa00f --- # ATL Module Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + This topic discusses the module classes that were new in ATL 7.0. ## CComModule Replacement Classes diff --git a/docs/atl/atl-registry-component-registrar.md b/docs/atl/atl-registry-component-registrar.md index 6fc68ca1fc2..3615ba7fc45 100644 --- a/docs/atl/atl-registry-component-registrar.md +++ b/docs/atl/atl-registry-component-registrar.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Registry Component (Registrar)" title: "ATL Registry Component (Registrar)" ms.date: "11/04/2016" helpviewer_keywords: ["scripting, registry scripting", "ATL, registry", "registrar scripts [ATL]", "registry, accessing", "ATL Registrar", "scripts, Registrar scripts", "registry, Registrar"] -ms.assetid: 106752ae-4cfc-4030-8cb2-d36a1d635a2e --- # ATL Registry Component (Registrar) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The ATL Registrar provides optimized access to the system registry through a custom interface. The Registrar is free-threaded and allows static linking of code for C++ clients. > [!NOTE] diff --git a/docs/atl/atl-services.md b/docs/atl/atl-services.md index 4acde07ca7e..591a7222173 100644 --- a/docs/atl/atl-services.md +++ b/docs/atl/atl-services.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Services" title: "ATL Services" ms.date: "11/04/2016" helpviewer_keywords: ["CServiceModule class", "COM objects, ATL", "services, ATL", "ATL services"] -ms.assetid: 8c09d1a8-7548-4d2c-947c-9d795a81659b --- # ATL Services +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + To create your ATL COM object so that it runs in a service, simply select Service (EXE) from the list of server options in the ATL Project Wizard. The wizard will then create a class derived from `CAtlServiceModuleT` to implement the service. When the ATL COM object is built as a service, it will only be registered as a local server, and it will not appear in the list of services in Control Panel. This is because it is easier to debug the service as a local server than as a service. To install it as a service, run the following at the command prompt: diff --git a/docs/atl/atl-support-for-dhtml-controls.md b/docs/atl/atl-support-for-dhtml-controls.md index eca0e2fe0b1..2a2f8c091f8 100644 --- a/docs/atl/atl-support-for-dhtml-controls.md +++ b/docs/atl/atl-support-for-dhtml-controls.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Support for DHTML Controls" title: "ATL Support for DHTML Controls" ms.date: "11/04/2016" helpviewer_keywords: ["HTML controls, ATL support", "DHTML controls, ATL support", "DHTML controls"] -ms.assetid: 4ba98098-da5d-4362-96ad-8372f816c307 --- # ATL Support for DHTML Controls +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Using ATL, you can create a control with Dynamic HTML (DHTML) capability. An ATL DHTML control: - Hosts the WebBrowser control. diff --git a/docs/atl/atl-utilities-reference.md b/docs/atl/atl-utilities-reference.md index d903e4dbab6..19120124b84 100644 --- a/docs/atl/atl-utilities-reference.md +++ b/docs/atl/atl-utilities-reference.md @@ -5,6 +5,8 @@ ms.date: 11/04/2016 --- # ATL utilities reference +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL provides code for manipulating paths and URLs in the form of [CPathT](../atl/reference/cpatht-class.md) and [CUrl](../atl/reference/curl-class.md). A thread pool, [CThreadPool](../atl/reference/cthreadpool-class.md), can be used in your applications. This code can be found in atlpath.h and atlutil.h. ## Classes diff --git a/docs/atl/atl-window-classes.md b/docs/atl/atl-window-classes.md index bf9968a0313..92c7c453843 100644 --- a/docs/atl/atl-window-classes.md +++ b/docs/atl/atl-window-classes.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Window Classes" title: "ATL Window Classes" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, windows", "windows [C++], subclassing", "windows [C++], superclassing", "windows [C++], ATL", "subclassing ATL window classes", "superclassing", "superclassing, ATL"] -ms.assetid: 1d12b708-de3e-49d5-9e41-42fe4769fa62 --- # ATL Window Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL includes several classes that allow you to use and implement windows. These classes, like other ATL classes, provide an efficient implementation that does not impose an overhead on your code. This section describes the ATL window classes and explains how to use them. diff --git a/docs/atl/benefits-and-tradeoffs-of-the-method-used-to-link-to-the-crt.md b/docs/atl/benefits-and-tradeoffs-of-the-method-used-to-link-to-the-crt.md index d84c7e8e639..3c3d0fe0276 100644 --- a/docs/atl/benefits-and-tradeoffs-of-the-method-used-to-link-to-the-crt.md +++ b/docs/atl/benefits-and-tradeoffs-of-the-method-used-to-link-to-the-crt.md @@ -3,10 +3,11 @@ description: "Learn more about: Benefits and Tradeoffs of the Method Used to Lin title: "Benefits and Tradeoffs of the Method Used to Link to the CRT" ms.date: "05/06/2019" helpviewer_keywords: ["_ATL_MIN_CRT macro"] -ms.assetid: 49b485f7-9487-49e4-b12a-0f710b620e2b --- # Benefits and Tradeoffs of the Method Used to Link to the CRT +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Your project can link with the CRT either dynamically or statically. The table below outlines the benefits and tradeoffs involved in choosing which method to use. |Method|Benefit|Tradeoff| diff --git a/docs/atl/building-and-testing-the-atl-project.md b/docs/atl/building-and-testing-the-atl-project.md index d5920c6e591..53aebdcc5e4 100644 --- a/docs/atl/building-and-testing-the-atl-project.md +++ b/docs/atl/building-and-testing-the-atl-project.md @@ -3,11 +3,12 @@ description: "Learn more about: Building and Testing the ATL Project" title: "Building and Testing the ATL Project" ms.date: "11/04/2016" helpviewer_keywords: ["composite controls, building and testing the project", "composite controls, containers for"] -ms.assetid: 5c1541f8-f6cb-4c22-bd22-c66bcfbaa077 ms.topic: concept-article --- # Building and Testing the ATL Project +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + As mentioned in [Inserting a Composite Control](../atl/inserting-a-composite-control.md), one of the initial components of the project is a default HTML page that hosts your new composite control. After you finish modifying the composite control, click **Build Solution** or **Rebuild Solution** from the **Build** menu. Once the project successfully builds, load the HTML page, located in the root directory of your composite control project, into Internet Explorer or another browser and test the functionality of your control. You can also test your composite control using the Test Container tool, or any other application that can host an ActiveX control. See [Testing Properties and Events with Test Container](../mfc/testing-properties-and-events-with-test-container.md) for information on how to access the test container. diff --git a/docs/atl/calling-cpp-code-from-dhtml.md b/docs/atl/calling-cpp-code-from-dhtml.md index a5d05fe09ee..03f3e87a0d4 100644 --- a/docs/atl/calling-cpp-code-from-dhtml.md +++ b/docs/atl/calling-cpp-code-from-dhtml.md @@ -3,11 +3,12 @@ description: "Learn more about: Calling C++ Code from DHTML" title: "Calling C++ Code from DHTML" ms.date: "11/04/2016" helpviewer_keywords: ["DHTML, calling C++ code from"] -ms.assetid: 37329acd-4c22-40ca-a85a-b7480748f75f ms.topic: concept-article --- # Calling C++ Code from DHTML +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + A DHTML control can be hosted in a container, such as Test Container or Internet Explorer. See [Testing Properties and Events with Test Container](../mfc/testing-properties-and-events-with-test-container.md) for information on how to access Test Container. The container hosting the control communicates with the control using the normal control interfaces. DHTML uses the dispatch interface that ends with "UI" to communicate with your C++ code and your HTML resource. In [Modifying the ATL DHTML Control](../atl/modifying-the-atl-dhtml-control.md), you can practice adding the methods to be called by these different interfaces. diff --git a/docs/atl/catlservicemodulet-handler-function.md b/docs/atl/catlservicemodulet-handler-function.md index a2da13bec83..c21778eec43 100644 --- a/docs/atl/catlservicemodulet-handler-function.md +++ b/docs/atl/catlservicemodulet-handler-function.md @@ -3,10 +3,11 @@ description: "Learn more about: CAtlServiceModuleT::Handler Function" title: "CAtlServiceModuleT::Handler Function" ms.date: "11/04/2016" helpviewer_keywords: ["Handler method"] -ms.assetid: 14db5f2a-be87-4774-a296-445cb6fc7b2e --- # CAtlServiceModuleT::Handler Function +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + `CAtlServiceModuleT::Handler` is the routine that the service control manager (SCM) calls to retrieve the status of the service and give it various instructions (such as stopping or pausing). The SCM passes an operation code to `Handler` to indicate what the service should do. A default ATL-generated service only handles the stop instruction. If the SCM passes the stop instruction, the service tells the SCM that the program is about to stop. The service then calls `PostThreadMessage` to post a quit message to itself. This terminates the message loop and the service will ultimately close. To handle more instructions, you need to change the `m_status` data member initialized in the `CAtlServiceModuleT` constructor. This data member tells the SCM which buttons to enable when the service is selected in the Services Control Panel application. diff --git a/docs/atl/catlservicemodulet-run-function.md b/docs/atl/catlservicemodulet-run-function.md index 9471ee390a8..e9aadfc95c2 100644 --- a/docs/atl/catlservicemodulet-run-function.md +++ b/docs/atl/catlservicemodulet-run-function.md @@ -3,10 +3,11 @@ description: "Learn more about: CAtlServiceModuleT::Run Function" title: "CAtlServiceModuleT::Run Function" ms.date: "11/04/2016" helpviewer_keywords: ["ATL services, security"] -ms.assetid: 42c010f0-e60e-459c-a63b-a53a24cda93b --- # CAtlServiceModuleT::Run Function +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + `Run` contains calls to `PreMessageLoop`, `RunMessageLoop`, and `PostMessageLoop`. After being called, `PreMessageLoop` first stores the service's thread ID. The service will use this ID to close itself by sending a WM_QUIT message using the Win32 API function, [PostThreadMessage](/windows/win32/api/winuser/nf-winuser-postthreadmessagew). `PreMessageLoop` then calls `InitializeSecurity`. By default, `InitializeSecurity` calls [CoInitializeSecurity](/windows/win32/api/combaseapi/nf-combaseapi-coinitializesecurity) with the security descriptor set to NULL, which means that any user has access to your object. diff --git a/docs/atl/catlservicemodulet-servicemain-function.md b/docs/atl/catlservicemodulet-servicemain-function.md index f3cfffa7fd3..f037a2ca6ae 100644 --- a/docs/atl/catlservicemodulet-servicemain-function.md +++ b/docs/atl/catlservicemodulet-servicemain-function.md @@ -3,10 +3,11 @@ description: "Learn more about: CAtlServiceModuleT::ServiceMain Function" title: "CAtlServiceModuleT::ServiceMain Function" ms.date: "11/04/2016" helpviewer_keywords: ["ServiceMain method"] -ms.assetid: f21408c1-1919-4dec-88d8-bf5b39ac9808 --- # CAtlServiceModuleT::ServiceMain Function +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The service control manager (SCM) calls `ServiceMain` when you open the Services Control Panel application, select the service, and click **Start**. After the SCM calls `ServiceMain`, a service must give the SCM a handler function. This function lets the SCM obtain the service's status and pass specific instructions (such as pausing or stopping). The SCM gets this function when the service passes `_Handler` to the Win32 API function, [RegisterServiceCtrlHandler](/windows/win32/api/winsvc/nf-winsvc-registerservicectrlhandlerw). (`_Handler` is a static member function that calls the non-static member function [Handler](../atl/reference/catlservicemodulet-class.md#handler).) diff --git a/docs/atl/catlservicemodulet-start-function.md b/docs/atl/catlservicemodulet-start-function.md index 920857413d4..670a2023aee 100644 --- a/docs/atl/catlservicemodulet-start-function.md +++ b/docs/atl/catlservicemodulet-start-function.md @@ -3,10 +3,11 @@ description: "Learn more about: CAtlServiceModuleT::Start Function" title: "CAtlServiceModuleT::Start Function" ms.date: "11/04/2016" helpviewer_keywords: ["Start method"] -ms.assetid: b5193a23-41bc-42d2-8d55-3eb43dc62238 --- # CAtlServiceModuleT::Start Function +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + When the service is run, `_tWinMain` calls `CAtlServiceModuleT::WinMain`, which in turn calls `CAtlServiceModuleT::Start`. `CAtlServiceModuleT::Start` sets up an array of `SERVICE_TABLE_ENTRY` structures that map each service to its startup function. This array is then passed to the Win32 API function, [StartServiceCtrlDispatcher](/windows/win32/api/winsvc/nf-winsvc-startservicectrldispatcherw). In theory, one EXE could handle multiple services and the array could have multiple `SERVICE_TABLE_ENTRY` structures. Currently, however, an ATL-generated service supports only one service per EXE. Therefore, the array has a single entry that contains the service name and `_ServiceMain` as the startup function. `_ServiceMain` is a static member function of `CAtlServiceModuleT` that calls the non-static member function, `ServiceMain`. diff --git a/docs/atl/changing-the-default-class-factory-and-aggregation-model.md b/docs/atl/changing-the-default-class-factory-and-aggregation-model.md index 78b9ca1c8a0..31cf67c1254 100644 --- a/docs/atl/changing-the-default-class-factory-and-aggregation-model.md +++ b/docs/atl/changing-the-default-class-factory-and-aggregation-model.md @@ -3,11 +3,12 @@ description: "Learn more about: Changing the Default Class Factory and Aggregati title: "Changing the Default Class Factory and Aggregation Model" ms.date: "11/04/2016" helpviewer_keywords: ["CComClassFactory class, making the default", "aggregation [C++], using ATL", "aggregation [C++], aggregation models", "defaults [C++], aggregation model in ATL", "default class factory", "class factories, changing default", "CComCoClass class, default class factory and aggregation model", "default class factory, ATL", "defaults [C++], class factory"] -ms.assetid: 6e040e95-0f38-4839-8a8b-c9800dd47e8c ms.topic: concept-article --- # Changing the Default Class Factory and Aggregation Model +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + 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: - [DECLARE_CLASSFACTORY](reference/aggregation-and-class-factory-macros.md#declare_classfactory) Declares the class factory to be [CComClassFactory](../atl/reference/ccomclassfactory-class.md). diff --git a/docs/atl/changing-the-drawing-code-atl-tutorial-part-4.md b/docs/atl/changing-the-drawing-code-atl-tutorial-part-4.md index 2ed4a960e6b..d835f00e7d9 100644 --- a/docs/atl/changing-the-drawing-code-atl-tutorial-part-4.md +++ b/docs/atl/changing-the-drawing-code-atl-tutorial-part-4.md @@ -4,11 +4,12 @@ title: "Changing the Drawing Code (ATL Tutorial, Part 4)" ms.custom: "get-started-article" ms.date: "09/26/2018" helpviewer_keywords: ["_ATL_MIN_CRT macro"] -ms.assetid: 08ff14e8-aa49-4139-a110-5d071939cf1e ms.topic: tutorial --- # Changing the Drawing Code (ATL Tutorial, Part 4) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + By default, the control's drawing code displays a square and the text **PolyCtl**. In this step, you will change the code to display something more interesting. The following tasks are involved: - Modifying the Header File diff --git a/docs/atl/class-factories-classes.md b/docs/atl/class-factories-classes.md index 15bda12d380..a0e9bdb8927 100644 --- a/docs/atl/class-factories-classes.md +++ b/docs/atl/class-factories-classes.md @@ -4,10 +4,11 @@ title: " ATL Class Factories Classes" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["class factories", "class factories, ATL classes"] -ms.assetid: 1d8c2ae2-2c37-452c-a02d-1ecbdd309f84 --- # Class Factories Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes implement or support a class factory: - [CComClassFactory](../atl/reference/ccomclassfactory-class.md) Provides a default class factory for object creation. diff --git a/docs/atl/class-information-classes.md b/docs/atl/class-information-classes.md index 4f4b3f3158e..b1854183884 100644 --- a/docs/atl/class-information-classes.md +++ b/docs/atl/class-information-classes.md @@ -4,10 +4,11 @@ title: "Class Information Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["class information, retrieving"] -ms.assetid: 39365025-f24a-41ae-87ab-4ae8ed085b98 --- # Class Information Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following class provides support for retrieving class information: - [IProvideClassInfo2Impl](../atl/reference/iprovideclassinfo2impl-class.md) Provides access to type information. Retrieves the outgoing IID for the object's default event set. diff --git a/docs/atl/collection-classes.md b/docs/atl/collection-classes.md index 0545b6d29b0..5702e9832d1 100644 --- a/docs/atl/collection-classes.md +++ b/docs/atl/collection-classes.md @@ -4,10 +4,11 @@ title: "Collection classes in ATL" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["collection classes"] -ms.assetid: eff95de6-78ef-4212-9d7d-1dacbdd4cc58 --- # Collection Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes provide support for arrays, lists, maps, and also traits methods for helping with comparisons and element access. - [CAtlArray](../atl/reference/catlarray-class.md) This class implements an array object. diff --git a/docs/atl/com-modules-classes.md b/docs/atl/com-modules-classes.md index 4c4671f1231..768c712e943 100644 --- a/docs/atl/com-modules-classes.md +++ b/docs/atl/com-modules-classes.md @@ -4,10 +4,11 @@ title: "COM Modules Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["COM modules classes"] -ms.assetid: 0a8a82dd-a153-47cd-9bbe-1a1ad5d1a6ff --- # COM Modules Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes provide support for a COM module: - [CAtlBaseModule](../atl/reference/catlbasemodule-class.md) This class is instantiated in every ATL project. diff --git a/docs/atl/commandhandler.md b/docs/atl/commandhandler.md index 6ad29accfb3..2a299bfa7d7 100644 --- a/docs/atl/commandhandler.md +++ b/docs/atl/commandhandler.md @@ -4,10 +4,11 @@ title: "CommandHandler" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["CommandHandler function"] -ms.assetid: 662bc7bf-4a10-42b3-986d-d8bae4f63551 --- # CommandHandler +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + `CommandHandler` is the function identified by the third parameter of the COMMAND_HANDLER macro in your message map. ## Syntax diff --git a/docs/atl/composite-controls-classes.md b/docs/atl/composite-controls-classes.md index 0e45651cc80..42f653e0cbb 100644 --- a/docs/atl/composite-controls-classes.md +++ b/docs/atl/composite-controls-classes.md @@ -4,10 +4,11 @@ title: "Composite Controls Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["composite controls, C++", "composite controls classes"] -ms.assetid: 9e8d65c4-d631-4500-a28b-6d42c35aba26 --- # Composite Controls Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following class provides support for creating composite controls - [CComCompositeControl](../atl/reference/ccomcompositecontrol-class.md) ActiveX controls derived from `CComCompositeControl` are hosted by a standard dialog box. These types of controls are called composite controls because they are able to host other controls (native Windows controls and ActiveX controls). diff --git a/docs/atl/connection-points-classes.md b/docs/atl/connection-points-classes.md index 52b73a0103c..4903c12022e 100644 --- a/docs/atl/connection-points-classes.md +++ b/docs/atl/connection-points-classes.md @@ -4,10 +4,11 @@ title: "Connection Points Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["classes [C++], connection points", "connection points classes"] -ms.assetid: 076365fa-299a-4dce-84c3-a5dff0e0da1f --- # Connection Points Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes provide support for connection points: - [IConnectionPointContainerImpl](../atl/reference/iconnectionpointcontainerimpl-class.md) Implements a connection point container. diff --git a/docs/atl/control-containment-classes.md b/docs/atl/control-containment-classes.md index 1446101b696..8eb055a2cbf 100644 --- a/docs/atl/control-containment-classes.md +++ b/docs/atl/control-containment-classes.md @@ -4,10 +4,11 @@ title: "Control Containment Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["control containment classes"] -ms.assetid: e0812aee-c078-4ced-b967-247976552b9a --- # Control Containment Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes provide containment support for hosting controls: - [CAxWindow](../atl/reference/caxwindow-class.md) Provides methods for manipulating a window that hosts an ActiveX control. diff --git a/docs/atl/controls-general-support-classes.md b/docs/atl/controls-general-support-classes.md index fdb016140e0..2bcaa142937 100644 --- a/docs/atl/controls-general-support-classes.md +++ b/docs/atl/controls-general-support-classes.md @@ -4,10 +4,11 @@ title: "ATL Controls: General Support Classes" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["controls [ATL]", "general support classes"] -ms.assetid: cf73f1d2-7542-48e3-b8c8-9d3abf29f85b --- # Controls: General Support Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes provide general support for ATL controls: - [CComControl](../atl/reference/ccomcontrol-class.md) Consists of helper functions and data members that are essential to ATL controls. diff --git a/docs/atl/creating-an-aggregated-object.md b/docs/atl/creating-an-aggregated-object.md index f0bc8d88b24..e6e24a5bf08 100644 --- a/docs/atl/creating-an-aggregated-object.md +++ b/docs/atl/creating-an-aggregated-object.md @@ -3,11 +3,12 @@ description: "Learn more about: Creating an Aggregated Object" title: "Creating an Aggregated Object" ms.date: "11/04/2016" helpviewer_keywords: ["aggregation [C++], creating aggregated objects", "aggregate objects [C++], creating"] -ms.assetid: fc29d7aa-fd53-4276-9c2f-37379f71b179 ms.topic: how-to --- # Creating an Aggregated Object +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Aggregation delegates `IUnknown` calls, providing a pointer to the outer object's `IUnknown` to the inner object. ## To create an aggregated object diff --git a/docs/atl/creating-an-atl-dhtml-control.md b/docs/atl/creating-an-atl-dhtml-control.md index 1831d58d0b3..c6c4f9c846b 100644 --- a/docs/atl/creating-an-atl-dhtml-control.md +++ b/docs/atl/creating-an-atl-dhtml-control.md @@ -3,11 +3,12 @@ description: "Learn more about: Creating an ATL DHTML Control" title: "Creating an ATL DHTML Control" ms.date: "11/04/2016" helpviewer_keywords: ["HTML controls, creating", "DHTML controls", "DHTML controls, creating"] -ms.assetid: 1d8f0ede-7d8b-4959-976e-b4d0e2a87f5a ms.topic: how-to --- # Creating an ATL DHTML Control +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The ATL Control Wizard automates the process of creating a DHTML control. It generates the necessary resource files, including an HTML file containing sample code. ## To create an ATL DHTML control diff --git a/docs/atl/creating-registrar-scripts.md b/docs/atl/creating-registrar-scripts.md index d9d281b53ab..9e9e8eb0ca2 100644 --- a/docs/atl/creating-registrar-scripts.md +++ b/docs/atl/creating-registrar-scripts.md @@ -3,11 +3,12 @@ description: "Learn more about: Creating Registrar scripts" title: "Creating scripts for ATL Registrar" ms.date: "05/14/2014" helpviewer_keywords: ["scripting, registry scripting", "ATL, registry", "registrar scripts [ATL]", "scripts, Registrar scripts", "scripts, creating"] -ms.assetid: cbd5024b-8061-4a71-be65-7fee90374a35 ms.topic: concept-article --- # Creating Registrar scripts +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + A registrar script provides data-driven, rather than API-driven, access to the system registry. Data-driven access is typically more efficient since it takes only one or two lines in a script to add a key to the registry. The [ATL Control Wizard](../atl/reference/atl-control-wizard.md) automatically generates a registrar script for your COM server. You can find this script in the .rgs file associated with your object. diff --git a/docs/atl/creating-the-project-atl-tutorial-part-1.md b/docs/atl/creating-the-project-atl-tutorial-part-1.md index b8a01fd2255..c7aa2721438 100644 --- a/docs/atl/creating-the-project-atl-tutorial-part-1.md +++ b/docs/atl/creating-the-project-atl-tutorial-part-1.md @@ -3,11 +3,12 @@ description: "Learn more about: Creating the Project (ATL Tutorial, Part 1)" title: "Creating the Project (ATL Tutorial, Part 1)" ms.custom: "get-started-article" ms.date: "08/19/2019" -ms.assetid: f6b727d1-390a-4b27-b82f-daadcd9fc059 ms.topic: tutorial --- # Creating the Project (ATL Tutorial, Part 1) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + This tutorial walks you step-by-step through a non-attributed ATL project that creates an ActiveX object that displays a polygon. The object includes options for allowing the user to change the number of sides making up the polygon, and code to refresh the display. > [!NOTE] diff --git a/docs/atl/data-transfer-classes.md b/docs/atl/data-transfer-classes.md index 67709a809cd..c3515d329ca 100644 --- a/docs/atl/data-transfer-classes.md +++ b/docs/atl/data-transfer-classes.md @@ -4,10 +4,11 @@ title: "Data Transfer Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["data transfer [C++]", "data transfer [C++], classes", "data transfer classes [C++]"] -ms.assetid: c10bcdc8-b90c-4c2a-9179-fd3de80461da --- # Data Transfer Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes support various types of data transfer: - [IDataObjectImpl](../atl/reference/idataobjectimpl-class.md) Supports Uniform Data Transfer by using standard formats to retrieve and set data. Handles data change notifications by managing connections to advise sinks. diff --git a/docs/atl/data-types-classes.md b/docs/atl/data-types-classes.md index 85d986bad81..c636b279ff2 100644 --- a/docs/atl/data-types-classes.md +++ b/docs/atl/data-types-classes.md @@ -4,10 +4,11 @@ title: "Data Types Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["data types classes [C++]", "data types [C++], classes"] -ms.assetid: 29882bab-9174-4dfa-8227-ccfeba80b865 --- # Data Types Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes wrap C++ data types: - [CComBSTR](../atl/reference/ccombstr-class.md) Wraps the `BSTR` data type. diff --git a/docs/atl/dcomcnfg.md b/docs/atl/dcomcnfg.md index 0a0468d6a57..ac312effae9 100644 --- a/docs/atl/dcomcnfg.md +++ b/docs/atl/dcomcnfg.md @@ -3,10 +3,11 @@ description: "Learn more about: DCOMCNFG" title: "DCOMCNFG" ms.date: "11/04/2016" helpviewer_keywords: ["DCOMCNFG utility", "DCOM, configuring in ATL"] -ms.assetid: 5a8126e9-ef27-40fb-a66e-9dce8d1a7e80 --- # DCOMCNFG +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + DCOMCNFG is a Windows NT 4.0 utility that allows you to configure various DCOM-specific settings in the registry. The DCOMCNFG window has three pages: Default Security, Default Properties, and Applications. Under Windows 2000 a fourth page, Default Protocols, is present. ## Default Security Page diff --git a/docs/atl/debugging-and-exceptions-classes.md b/docs/atl/debugging-and-exceptions-classes.md index 703972808b0..c8a8205fa2c 100644 --- a/docs/atl/debugging-and-exceptions-classes.md +++ b/docs/atl/debugging-and-exceptions-classes.md @@ -4,10 +4,11 @@ title: "Debugging and Exceptions Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["debugging and exceptions classes"] -ms.assetid: d42d7649-9721-4a1a-8b38-d983a649fdb9 --- # Debugging and Exceptions Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + These classes provide support for exception handling and debugging. - [CAtlDebugInterfacesModule](../atl/reference/catldebuginterfacesmodule-class.md) This class provides support for debugging interfaces. diff --git a/docs/atl/debugging-tips.md b/docs/atl/debugging-tips.md index 5fcdee636d5..f5680d207ed 100644 --- a/docs/atl/debugging-tips.md +++ b/docs/atl/debugging-tips.md @@ -3,11 +3,12 @@ description: "Learn more about: Debugging Tips" title: "Debugging Tips (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, debugging", "services, debugging"] -ms.assetid: 48c60244-d0ce-4466-85fa-6fa65fcfe86c ms.topic: concept-article --- # Debugging Tips +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following topics outline some useful steps for debugging your service: - [Using Task Manager](../atl/using-task-manager.md) diff --git a/docs/atl/design-principles-for-collection-and-enumerator-interfaces.md b/docs/atl/design-principles-for-collection-and-enumerator-interfaces.md index e75179b64e0..7f9b5386a3b 100644 --- a/docs/atl/design-principles-for-collection-and-enumerator-interfaces.md +++ b/docs/atl/design-principles-for-collection-and-enumerator-interfaces.md @@ -3,11 +3,12 @@ description: "Learn more about: Design Principles for Collection and Enumerator title: "Designing Collection and Enumerator Interfaces (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["enumerator interfaces", "collection interfaces"] -ms.assetid: ea19a39e-6333-41a1-be62-5435c236640e ms.topic: concept-article --- # Design Principles for Collection and Enumerator Interfaces +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + There are different design principles behind each type of interface: - A collection interface provides *random* access to a *single* item in the collection via the `Item` method, it lets clients discover how many items are in the collection via the `Count` property, and often allows clients to add and remove items. diff --git a/docs/atl/displaying-assertions.md b/docs/atl/displaying-assertions.md index 8587c3eb40c..e4ffc2a6420 100644 --- a/docs/atl/displaying-assertions.md +++ b/docs/atl/displaying-assertions.md @@ -3,11 +3,12 @@ description: "Learn more about: Displaying Assertions" title: "Displaying Assertions" ms.date: "05/05/2019" helpviewer_keywords: ["debugging [ATL], displaying assertions", "assertions, displaying", "debugging assertions", "assertions, debugging"] -ms.assetid: fa353fe8-4656-4384-a5d2-8866bc977f06 ms.topic: concept-article --- # Displaying Assertions +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + If the client connected to your service appears to stop responding, the service may have asserted and displayed a message box that you are not able to see. You can confirm this by using the Visual Studio debugger to debug your code (see [Using Task Manager](../atl/using-task-manager.md) earlier in this section). If you determine that your service is displaying a message box that you cannot see, you may want to set the **Allow Service to Interact with Desktop** option before using the service again. This option is a startup parameter that permits any message boxes displayed by the service to appear on the desktop. To set this option, open the Services Control Panel application, select the service, click **Startup**, and then select the **Allow Service to Interact with Desktop** option. diff --git a/docs/atl/dual-interfaces-and-atl.md b/docs/atl/dual-interfaces-and-atl.md index 2039cb3e12e..38dcc7d2888 100644 --- a/docs/atl/dual-interfaces-and-atl.md +++ b/docs/atl/dual-interfaces-and-atl.md @@ -3,10 +3,11 @@ description: "Learn more about: Dual Interfaces and ATL" title: "Dual Interfaces and ATL" ms.date: "11/04/2016" helpviewer_keywords: ["COM, and ATL", "ATL, dual interfaces", "dual interfaces, about dual interfaces"] -ms.assetid: 5a390e89-d2c4-41f0-8538-cab2c5e5d4c8 --- # Dual Interfaces and ATL +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + A dual interface allows its methods to be accessed as dispinterface methods or as vtable methods. This section covers some of the features of dual interfaces from an ATL perspective. ## In This Section diff --git a/docs/atl/dual-interfaces-and-events.md b/docs/atl/dual-interfaces-and-events.md index a0a520b396a..5e5fc2bc5e1 100644 --- a/docs/atl/dual-interfaces-and-events.md +++ b/docs/atl/dual-interfaces-and-events.md @@ -3,10 +3,11 @@ description: "Learn more about: Dual Interfaces and Events" title: "Dual Interfaces and Events" ms.date: "11/04/2016" helpviewer_keywords: ["events [C++], dual interfaces", "dual interfaces, events"] -ms.assetid: bb382f7c-e885-4274-bf07-83f3602615d2 --- # Dual Interfaces and Events +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + While it is possible to design an event interface as a dual, there are a number of good design reasons not to do so. The fundamental reason is that the source of the event will only fire the event via the vtable or via `Invoke`, not both. If the event source fires the event as a direct vtable method call, the `IDispatch` methods will never be used and it's clear that the interface should have been a pure vtable interface. If the event source fires the event as a call to `Invoke`, the vtable methods will never be used and it's clear that the interface should have been a dispinterface. If you define your event interfaces as duals, you'll be requiring clients to implement part of an interface that will never be used. > [!NOTE] diff --git a/docs/atl/dual-interfaces-classes.md b/docs/atl/dual-interfaces-classes.md index b6755655498..c66bd005920 100644 --- a/docs/atl/dual-interfaces-classes.md +++ b/docs/atl/dual-interfaces-classes.md @@ -4,10 +4,11 @@ title: "Dual Interfaces Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["dual interfaces, classes", "dual interfaces"] -ms.assetid: c2b1b165-ff39-4e4a-a683-91eca9158304 --- # Dual Interfaces Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following class provides support for dual interfaces: - [IDispatchImpl](../atl/reference/idispatchimpl-class.md) Implements the `IDispatch` portion of a dual interface. For more information, see [Implementing the IDispatch Interface](/previous-versions/windows/desktop/automat/implementing-the-idispatch-interface). diff --git a/docs/atl/enumerators-and-collections-classes.md b/docs/atl/enumerators-and-collections-classes.md index 6ccef203df3..1362c008dee 100644 --- a/docs/atl/enumerators-and-collections-classes.md +++ b/docs/atl/enumerators-and-collections-classes.md @@ -4,10 +4,11 @@ title: "Enumerators and Collections Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["enumerators, ATL classes"] -ms.assetid: fcd093b2-98bf-444d-94ab-9a55520a5051 --- # Enumerators and Collections Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes provide support for COM collections and enumerations: - [CComEnum](../atl/reference/ccomenum-class.md) Defines a COM enumerator object based on an array. diff --git a/docs/atl/error-information-classes.md b/docs/atl/error-information-classes.md index 5a2a987385b..bea5c2cbbe2 100644 --- a/docs/atl/error-information-classes.md +++ b/docs/atl/error-information-classes.md @@ -4,10 +4,11 @@ title: "Error Information Classe (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["error handling, error information classes", "error handling, classes", "error information, classes"] -ms.assetid: ba40c8fb-81fd-4f61-8f47-fa2cb540e274 --- # Error Information Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following class indicates how error information is handled: - [ISupportErrorInfoImpl](../atl/reference/isupporterrorinfoimpl-class.md) Determines whether the object supports the [IErrorInfo](/windows/win32/api/oaidl/nn-oaidl-ierrorinfo) interface. `IErrorInfo` allows error information to be propagated back to the client. diff --git a/docs/atl/event-handling-and-atl.md b/docs/atl/event-handling-and-atl.md index 649b68042c1..9a06e07a6a7 100644 --- a/docs/atl/event-handling-and-atl.md +++ b/docs/atl/event-handling-and-atl.md @@ -3,10 +3,11 @@ description: "Learn more about: Event Handling and ATL" title: "Event Handling and ATL" ms.date: "11/04/2016" helpviewer_keywords: ["event handling, about event handling"] -ms.assetid: e4812b0d-6fdd-4e8c-bdb8-378a25c7bde2 --- # Event Handling and ATL +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + This section shows how to sink events using ATL. It covers the principles of COM event handling and the specifics of sinking events using the support provided by ATL. For information on how to fire events and implement connection points, read [ATL Connection Points](../atl/atl-connection-points.md). diff --git a/docs/atl/event-handling-principles.md b/docs/atl/event-handling-principles.md index 41c766a5e7a..4aba9a8917b 100644 --- a/docs/atl/event-handling-principles.md +++ b/docs/atl/event-handling-principles.md @@ -3,10 +3,11 @@ description: "Learn more about: Event Handling Principles" title: "Event Handling Principles (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["event handling, implementing", "event handling, advising event sources", "interfaces, event and event sink", "dual interfaces, event interfaces", "event handling, dual event interfaces"] -ms.assetid: d17ca7cb-54f2-4658-ab8b-b721ac56801d --- # Event Handling Principles +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + There are three steps common to all event handling. You will need to: - Implement the event interface on your object. diff --git a/docs/atl/example-implementing-a-property-page.md b/docs/atl/example-implementing-a-property-page.md index 6e7ee66751a..57f0ba62255 100644 --- a/docs/atl/example-implementing-a-property-page.md +++ b/docs/atl/example-implementing-a-property-page.md @@ -3,11 +3,12 @@ description: "Learn more about: Example: Implementing a Property Page" title: "Implementing a Property Page (ATL)" ms.date: "05/09/2019" helpviewer_keywords: ["property pages, implementing"] -ms.assetid: c30b67fe-ce08-4249-ae29-f3060fa8d61e ms.topic: how-to --- # Example: Implementing a Property Page +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" The ATL Property Page wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/file-handling-classes.md b/docs/atl/file-handling-classes.md index 22602083ecb..da26a0af03f 100644 --- a/docs/atl/file-handling-classes.md +++ b/docs/atl/file-handling-classes.md @@ -4,10 +4,11 @@ title: "File Handling Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["file classes [C++]"] -ms.assetid: 94355eb1-daa3-4825-b183-7392b3899561 --- # File Handling Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + These classes provide methods for handling files, temporary files, and memory-mapped files. - [CAtlFile](../atl/reference/catlfile-class.md) This class provides a thin wrapper around the Windows file-handling API. diff --git a/docs/atl/fundamentals-of-atl-com-objects.md b/docs/atl/fundamentals-of-atl-com-objects.md index afc7adb434f..336b93f9f20 100644 --- a/docs/atl/fundamentals-of-atl-com-objects.md +++ b/docs/atl/fundamentals-of-atl-com-objects.md @@ -3,10 +3,11 @@ description: "Learn more about: Fundamentals of ATL COM Objects" title: "Fundamentals of ATL COM Objects" ms.date: "11/19/2018" helpviewer_keywords: ["COM, and ATL", "ATL, COM", "ATL COM objects", "COM objects, ATL"] -ms.assetid: 0f9c9d98-cc28-45da-89ac-dc94cee422fe --- # Fundamentals of ATL COM Objects +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following illustration depicts the relationship among the classes and interfaces that are used to define an ATL COM object. ![Diagram of the classes and interfaces used to define an A T L object.](../atl/media/vc307y1.gif "ATL structure") diff --git a/docs/atl/identifying-the-elements-of-the-dhtml-control-project.md b/docs/atl/identifying-the-elements-of-the-dhtml-control-project.md index 7ac825b8372..563f6a8ec03 100644 --- a/docs/atl/identifying-the-elements-of-the-dhtml-control-project.md +++ b/docs/atl/identifying-the-elements-of-the-dhtml-control-project.md @@ -3,11 +3,12 @@ description: "Learn more about: Identifying the Elements of the DHTML Control Pr title: "Identifying the Elements of the DHTML Control Project" ms.date: "11/19/2018" helpviewer_keywords: ["HTML controls, ATL support", "DHTML controls, ATL support"] -ms.assetid: b627547a-3768-4346-9900-4b7a21fb8e27 ms.topic: concept-article --- # Identifying the Elements of the DHTML Control Project +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Most DHTML control code is exactly like that created for any ATL control. For a basic understanding of the generic code, work through the [ATL tutorial](../atl/active-template-library-atl-tutorial.md), and read the sections [Creating an ATL Project](../atl/reference/creating-an-atl-project.md) and [Fundamentals of ATL COM Objects](../atl/fundamentals-of-atl-com-objects.md). A DHTML control is similar to any ATL control, except: diff --git a/docs/atl/implementing-a-dialog-box.md b/docs/atl/implementing-a-dialog-box.md index c84428bea54..a416d87a717 100644 --- a/docs/atl/implementing-a-dialog-box.md +++ b/docs/atl/implementing-a-dialog-box.md @@ -3,11 +3,12 @@ description: "Learn more about: Implementing a Dialog Box" title: "Implementing a Dialog Box" ms.date: "11/04/2016" helpviewer_keywords: ["CSimpleDialog class, implementing dialog boxes in ATL", "dialog boxes, ATL", "CAxDialogImpl class, implementing dialog boxes in ATL", "ATL, dialog boxes"] -ms.assetid: 478525f2-aa6a-435a-b162-68fc8aa98a8e ms.topic: how-to --- # Implementing a Dialog Box +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + There are two ways to add a dialog box to your ATL project: use the ATL Dialog Wizard or add it manually. ## Adding a Dialog Box with the ATL Dialog Wizard diff --git a/docs/atl/implementing-a-dual-interface.md b/docs/atl/implementing-a-dual-interface.md index 6abd84d51b4..fc2afff4195 100644 --- a/docs/atl/implementing-a-dual-interface.md +++ b/docs/atl/implementing-a-dual-interface.md @@ -3,11 +3,12 @@ description: "Learn more about: Implementing a Dual Interface" title: "Implementing a Dual Interface (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["IDispatchImpl class, implementing dual interfaces", "dual interfaces, implementing"] -ms.assetid: d1da3633-b445-4dcd-8a0a-3efdafada3ea ms.topic: concept-article --- # Implementing a Dual Interface +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + You can implement a dual interface using the [IDispatchImpl](../atl/reference/idispatchimpl-class.md) class, which provides a default implementation of the `IDispatch` methods in a dual interface. For more information, see [Implementing the IDispatch Interface](/previous-versions/windows/desktop/automat/implementing-the-idispatch-interface). To use this class: diff --git a/docs/atl/implementing-a-window-with-cwindowimpl.md b/docs/atl/implementing-a-window-with-cwindowimpl.md index be0f590b83f..aaad98298e0 100644 --- a/docs/atl/implementing-a-window-with-cwindowimpl.md +++ b/docs/atl/implementing-a-window-with-cwindowimpl.md @@ -3,11 +3,12 @@ description: "Learn more about: Implementing a Window with CWindowImpl" title: "Implementing a Window with CWindowImpl" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, windows", "windows [C++], subclassing", "windows [C++], superclassing", "windows [C++], ATL", "subclassing ATL window classes", "superclassing, ATL"] -ms.assetid: 3fc40550-f1d6-4702-8b7c-4cf682b6a855 ms.topic: how-to --- # Implementing a Window with CWindowImpl +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + To implement a window, derive a class from `CWindowImpl`. In your derived class, declare a message map and the message handler functions. You can now use your class in three different ways: - [Create a window based on a new Windows class](#_atl_creating_a_window_based_on_a_new_windows_class) diff --git a/docs/atl/implementing-a-window.md b/docs/atl/implementing-a-window.md index dbe42c3fbc5..478f0fa5750 100644 --- a/docs/atl/implementing-a-window.md +++ b/docs/atl/implementing-a-window.md @@ -3,11 +3,12 @@ description: "Learn more about: Implementing a Window" title: "Implementing a Window (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, windows", "CWindowImpl class, using", "windows [C++], implementing in ATL"] -ms.assetid: eb1ce8d6-72f9-4894-aae7-e60a61665628 ms.topic: concept-article --- # Implementing a Window +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Class [CWindowImpl](../atl/reference/cwindowimpl-class.md) allows you to implement a window and handle its messages. Message handing in ATL is based on a message map. This section explains: - How to [add a message handler](../atl/adding-an-atl-message-handler.md) to a control. diff --git a/docs/atl/implementing-an-stl-based-collection.md b/docs/atl/implementing-an-stl-based-collection.md index 761ef740d16..5670f233a3b 100644 --- a/docs/atl/implementing-an-stl-based-collection.md +++ b/docs/atl/implementing-an-stl-based-collection.md @@ -3,11 +3,12 @@ description: "Learn more about: Implementing a C++ Standard Library-Based Collec title: "Implementing a C++ Standard Library-Based Collection" ms.date: "11/04/2016" helpviewer_keywords: ["ICollectionOnSTLImpl interface"] -ms.assetid: 6d49f819-1957-4813-b074-3f12c494d8ca ms.topic: how-to --- # Implementing a C++ Standard Library-Based Collection +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL provides the `ICollectionOnSTLImpl` interface to enable you to quickly implement C++ Standard Library-based collection interfaces on your objects. To understand how this class works, you will work through a simple example (below) that uses this class to implement a read-only collection aimed at Automation clients. The sample code is from the [ATLCollections sample](../overview/visual-cpp-samples.md). diff --git a/docs/atl/implementing-ccomobject-ccomaggobject-and-ccompolyobject.md b/docs/atl/implementing-ccomobject-ccomaggobject-and-ccompolyobject.md index e7a6428fbaa..1248dc40715 100644 --- a/docs/atl/implementing-ccomobject-ccomaggobject-and-ccompolyobject.md +++ b/docs/atl/implementing-ccomobject-ccomaggobject-and-ccompolyobject.md @@ -3,11 +3,12 @@ description: "Learn more about: Implementing CComObject, CComAggObject, and CCom title: "Implementing CComObject, CComAggObject, and CComPolyObject" ms.date: "11/04/2016" helpviewer_keywords: ["CComPolyObject class, implementing", "CreateInstance method", "CComAggObject class", "CComObject class, implementing"] -ms.assetid: 5aabe938-104d-492e-9c41-9f7fb1c62098 ms.topic: concept-article --- # Implementing CComObject, CComAggObject, and CComPolyObject +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The template classes [CComObject](../atl/reference/ccomobject-class.md), [CComAggObject](../atl/reference/ccomaggobject-class.md), and [CComPolyObject](../atl/reference/ccompolyobject-class.md) are always the most derived classes in the inheritance chain. It is their responsibility to handle all of the methods in `IUnknown`: `QueryInterface`, `AddRef`, and `Release`. In addition, `CComAggObject` and `CComPolyObject` (when used for aggregated objects) provide the special reference counting and `QueryInterface` semantics required for the inner unknown. Whether `CComObject`, `CComAggObject`, or `CComPolyObject` is used depends on whether you declare one (or none) of the following macros: diff --git a/docs/atl/implementing-ccomobjectrootex.md b/docs/atl/implementing-ccomobjectrootex.md index 5dc0fc19caf..48a7ab9b4de 100644 --- a/docs/atl/implementing-ccomobjectrootex.md +++ b/docs/atl/implementing-ccomobjectrootex.md @@ -3,11 +3,12 @@ description: "Learn more about: Implementing CComObjectRootEx" title: "Implementing CComObjectRootEx" ms.date: "11/04/2016" helpviewer_keywords: ["CComObjectRoot class, implementing", "CComObjectRootEx class"] -ms.assetid: 79630c44-f2df-4e9e-b730-400a0ebfbd2b ms.topic: concept-article --- # Implementing CComObjectRootEx +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + [CComObjectRootEx](../atl/reference/ccomobjectrootex-class.md) is essential; all ATL objects must have one instance of `CComObjectRootEx` or [CComObjectRoot](../atl/reference/ccomobjectroot-class.md) in their inheritance. `CComObjectRootEx` provides the default `QueryInterface` mechanism based on COM map entries. Through its COM map, an object's interfaces are exposed to a client when the client queries for an interface. The query is performed through `CComObjectRootEx::InternalQueryInterface`. `InternalQueryInterface` only handles interfaces in the COM map table. diff --git a/docs/atl/implementing-property-pages.md b/docs/atl/implementing-property-pages.md index d9e3b0942c4..b6fb0ecf5ee 100644 --- a/docs/atl/implementing-property-pages.md +++ b/docs/atl/implementing-property-pages.md @@ -3,11 +3,12 @@ description: "Learn more about: Implementing Property Pages" title: "Implementing Property Pages" ms.date: "11/04/2016" helpviewer_keywords: ["IPropertyPage2 class", "IPropertyPage class", "property pages, implementing"] -ms.assetid: 62f29440-33a7-40eb-a1ef-3634c95f640c ms.topic: how-to --- # Implementing Property Pages +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" The ATL Property Page wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/implementing-the-event-handling-interface.md b/docs/atl/implementing-the-event-handling-interface.md index 3442039a73e..121be8961ce 100644 --- a/docs/atl/implementing-the-event-handling-interface.md +++ b/docs/atl/implementing-the-event-handling-interface.md @@ -3,11 +3,12 @@ description: "Learn more about: Implementing the Event Handling Interface" title: "Implementing the Event Handling Interface" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, event handling", "event handling, ATL", "interfaces, event and event sink"] -ms.assetid: eb2a5b33-88dc-4ce3-bee0-c5c38ea050d7 ms.topic: concept-article --- # Implementing the Event Handling Interface +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL helps you with all three elements required for handling events: implementing the event interface, advising the event source, and unadvising the event source. The precise steps you'll need to take depend on the type of the event interface and the performance requirements of your application. The most common ways of implementing an interface using ATL are: diff --git a/docs/atl/includes/lifecycle-note.md b/docs/atl/includes/lifecycle-note.md new file mode 100644 index 00000000000..7d403694aaa --- /dev/null +++ b/docs/atl/includes/lifecycle-note.md @@ -0,0 +1,3 @@ +>[!NOTE] +> The Active Template Library (ATL) continues to be supported. However, we're no longer adding features or updating the documentation. + diff --git a/docs/atl/inserting-a-composite-control.md b/docs/atl/inserting-a-composite-control.md index ad1f4f6dc24..78e2ee55f0d 100644 --- a/docs/atl/inserting-a-composite-control.md +++ b/docs/atl/inserting-a-composite-control.md @@ -3,11 +3,12 @@ description: "Learn more about: Inserting a Composite Control" title: "Inserting a Composite Control" ms.date: "11/04/2016" helpviewer_keywords: ["composite controls, inserting with ATL Object Wizard", "composite controls", "ATL Control Wizard"] -ms.assetid: f10b1927-9fc6-40a7-ac29-efdac70584fe ms.topic: how-to --- # Inserting a Composite Control +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The **Add Class** dialog box allows you to insert an ATL object into a project. Access this dialog box by right-clicking the project name in Solution Explorer, pointing to **Add**, and then clicking **Add Class**. In the **Add Class** dialog box, choose **ATL Control**. This will start the [ATL Control Wizard](../atl/reference/atl-control-wizard.md). To create a composite control, select the **Options** tab, and click the **Composite control** check box. diff --git a/docs/atl/interface-pointers-classes.md b/docs/atl/interface-pointers-classes.md index d54f0ad4aa5..06f9c44a043 100644 --- a/docs/atl/interface-pointers-classes.md +++ b/docs/atl/interface-pointers-classes.md @@ -4,10 +4,11 @@ title: "Interface Pointers Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["pointers, to interfaces", "interfaces, pointers classes", "interface pointers classes"] -ms.assetid: 712617a1-17ae-4b5c-a32c-a48b758df7a6 --- # Interface Pointers Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes manage a given interface pointer: - [CComPtr](../atl/reference/ccomptr-class.md) Performs automatic reference counting. diff --git a/docs/atl/interfaces-atl.md b/docs/atl/interfaces-atl.md index 93422d3cd23..1b36fe72cec 100644 --- a/docs/atl/interfaces-atl.md +++ b/docs/atl/interfaces-atl.md @@ -4,10 +4,11 @@ title: "Interfaces (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["COM interfaces", "interfaces, COM"] -ms.assetid: de6c8b12-6230-4fdc-af66-a28b91d5ee55 --- # Interfaces (ATL) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + An interface is the way in which an object exposes its functionality to the outside world. In COM, an interface is a table of pointers (like a C++ vtable) to functions implemented by the object. The table represents the interface, and the functions to which it points are the methods of that interface. An object can expose as many interfaces as it chooses. Each interface is based on the fundamental COM interface, [IUnknown](../atl/iunknown.md). The methods of `IUnknown` allow navigation to other interfaces exposed by the object. diff --git a/docs/atl/introduction-to-atl-window-classes.md b/docs/atl/introduction-to-atl-window-classes.md index 5ae3fc8c8a3..6c245514d51 100644 --- a/docs/atl/introduction-to-atl-window-classes.md +++ b/docs/atl/introduction-to-atl-window-classes.md @@ -3,11 +3,12 @@ description: "Learn more about: Introduction to ATL Window Classes" title: "Introduction to ATL Window Classes" ms.date: "11/04/2016" helpviewer_keywords: ["window classes"] -ms.assetid: 503efc2c-a269-495d-97cf-3fb300d52f3d ms.topic: concept-article --- # Introduction to ATL Window Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following ATL classes are designed to implement and manipulate windows: - [CWindow](../atl/reference/cwindow-class.md) allows you to attach a window handle to the `CWindow` object. You then call `CWindow` methods to manipulate the window. diff --git a/docs/atl/introduction-to-atl.md b/docs/atl/introduction-to-atl.md index cccfc973918..0a62bded508 100644 --- a/docs/atl/introduction-to-atl.md +++ b/docs/atl/introduction-to-atl.md @@ -4,11 +4,12 @@ title: "Introduction to ATL" ms.custom: "index-page" ms.date: "11/04/2016" helpviewer_keywords: ["COM objects, creating in ATL", "ATL"] -ms.assetid: 77f565e8-c4ec-4a80-af4b-7278fcfe5c98 ms.topic: concept-article --- # Introduction to ATL +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL is the Active Template Library, a set of template-based C++ classes with which you can easily create small, fast Component Object Model (COM) objects. It has special support for key COM features including: stock implementations of [IUnknown](/windows/win32/api/unknwn/nn-unknwn-iunknown), [IClassFactory](/windows/win32/api/unknwnbase/nn-unknwnbase-iclassfactory), [IClassFactory2](/windows/win32/api/ocidl/nn-ocidl-iclassfactory2), and `IDispatch`; dual interfaces; standard COM enumerator interfaces; connection points; tear-off interfaces; and ActiveX controls. ATL code can be used to create single-threaded objects, apartment-model objects, free-threaded model objects, or both free-threaded and apartment-model objects. diff --git a/docs/atl/introduction-to-com-and-atl.md b/docs/atl/introduction-to-com-and-atl.md index 57e25904bca..47447c9ebdb 100644 --- a/docs/atl/introduction-to-com-and-atl.md +++ b/docs/atl/introduction-to-com-and-atl.md @@ -4,11 +4,12 @@ title: "Introduction to COM and ATL" ms.custom: "index-page" ms.date: "11/04/2016" helpviewer_keywords: ["COM, and ATL", "ATL, COM", "COM objects, ATL"] -ms.assetid: 35d6ae9c-abbb-42f0-9344-33f3c19ac3ce ms.topic: concept-article --- # Introduction to COM and ATL +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + This section provides a brief introduction to COM and ATL. ## In This Section diff --git a/docs/atl/introduction-to-com.md b/docs/atl/introduction-to-com.md index c44fc4f0652..8b192520ef9 100644 --- a/docs/atl/introduction-to-com.md +++ b/docs/atl/introduction-to-com.md @@ -4,11 +4,12 @@ title: "Introduction to COM" ms.custom: "index-page" ms.date: "11/04/2016" helpviewer_keywords: ["COM"] -ms.assetid: 120735d9-db71-4ad3-a730-ce576ea2354e ms.topic: concept-article --- # Introduction to COM +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + COM is the fundamental "object model" on which ActiveX Controls and OLE are built. COM allows an object to expose its functionality to other components and to host applications. It defines both how the object exposes itself and how this exposure works across processes and across networks. COM also defines the object's life cycle. Fundamental to COM are these concepts: diff --git a/docs/atl/invoking-scripts.md b/docs/atl/invoking-scripts.md index 2d339471811..3cc906049fc 100644 --- a/docs/atl/invoking-scripts.md +++ b/docs/atl/invoking-scripts.md @@ -3,11 +3,12 @@ description: "Learn more about: Invoking Scripts" title: "Invoking Scripts (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["StringRegister method", "scripts, invoking registry in ATL"] -ms.assetid: eabd41ee-586b-4266-9e92-5aaad04b73a4 ms.topic: concept-article --- # Invoking Scripts +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + [Using Replaceable Parameters (The Registrar's Preprocessor)](../atl/using-replaceable-parameters-the-registrar-s-preprocessor.md) discusses replacement maps and mentions the Registrar method **AddReplacement**. The Registrar has eight other methods specific to scripting, and all are described in the following table. |Method|Syntax/Description| diff --git a/docs/atl/iunknown-implementation-classes.md b/docs/atl/iunknown-implementation-classes.md index 7721fad35c6..a64a723fe84 100644 --- a/docs/atl/iunknown-implementation-classes.md +++ b/docs/atl/iunknown-implementation-classes.md @@ -4,10 +4,11 @@ title: "IUnknown Implementation Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["IUnknown implementation classes"] -ms.assetid: 47b69bb5-69d8-4a9c-84a8-329bdde2bb3f --- # IUnknown Implementation Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes implement `IUnknown` and related methods: - [CComObjectRootEx](../atl/reference/ccomobjectrootex-class.md) Manages reference counting for both aggregated and nonaggregated objects. Allows you to specify a threading model. diff --git a/docs/atl/iunknown.md b/docs/atl/iunknown.md index ee1578aa31f..e466a86e6a5 100644 --- a/docs/atl/iunknown.md +++ b/docs/atl/iunknown.md @@ -4,10 +4,11 @@ title: "IUnknown" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["COM interfaces, base interface", "IUnknown interface"] -ms.assetid: e6b85472-e54b-4b8c-b19f-4454d6c05a8f --- # IUnknown +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + [IUnknown](/windows/win32/api/unknwn/nn-unknwn-iunknown) is the base interface of every other COM interface. This interface defines three methods: [QueryInterface](/windows/win32/api/unknwn/nf-unknwn-iunknown-queryinterface(q)), [AddRef](/windows/win32/api/unknwn/nf-unknwn-iunknown-addref), and [Release](/windows/win32/api/unknwn/nf-unknwn-iunknown-release). [QueryInterface](/windows/win32/api/unknwn/nf-unknwn-iunknown-queryinterface(q)) allows an interface user to ask the object for a pointer to another of its interfaces. [AddRef](/windows/win32/api/unknwn/nf-unknwn-iunknown-addref) and [Release](/windows/win32/api/unknwn/nf-unknwn-iunknown-release) implement reference counting on the interface. ## See also diff --git a/docs/atl/linking-to-the-crt-in-your-atl-project.md b/docs/atl/linking-to-the-crt-in-your-atl-project.md index 430134baa43..3e5d84ca794 100644 --- a/docs/atl/linking-to-the-crt-in-your-atl-project.md +++ b/docs/atl/linking-to-the-crt-in-your-atl-project.md @@ -3,11 +3,12 @@ description: "Learn more about: Linking to the CRT in Your ATL Project" title: "Linking to the CRT in Your ATL Project" ms.date: "11/04/2016" helpviewer_keywords: ["CRT, linking with ATL", "WinMainCRTStartup method", "DllMainCRTStartup method", "wWinMainCRTStartup method", "ATL, C Run-Time library (CRT)"] -ms.assetid: 650957ae-362c-4ecf-8b03-5d49138e8b5b ms.topic: concept-article --- # Linking to the CRT in Your ATL Project +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The [C Run-Time Libraries](../c-runtime-library/crt-library-features.md) (CRT) provide many useful functions that can make programming much easier during ATL development. All ATL projects link to the CRT library. You can see the advantages and disadvantages of linking method in [Benefits and Tradeoffs of the Method Used to Link to the CRT](../atl/benefits-and-tradeoffs-of-the-method-used-to-link-to-the-crt.md). ## Effects of Linking to the CRT on Your Program Image diff --git a/docs/atl/marshaling.md b/docs/atl/marshaling.md index 1f5c52b2be5..28f1c0f3582 100644 --- a/docs/atl/marshaling.md +++ b/docs/atl/marshaling.md @@ -3,11 +3,12 @@ description: "Learn more about: Marshaling" title: "Marshaling" ms.date: "11/04/2016" helpviewer_keywords: ["marshaling, COM interop", "marshaling", "COM interfaces, marshaling"] -ms.assetid: 40644b0a-1106-4fc8-9dfb-9bee9915d825 ms.topic: concept-article --- # Marshaling +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The COM technique of marshaling allows interfaces exposed by an object in one process to be used in another process. In marshaling, COM provides code (or uses code provided by the interface implementor) both to pack a method's parameters into a format that can be moved across processes (as well as, across the wire to processes running on other machines) and to unpack those parameters at the other end. Likewise, COM must perform these same steps on the return from the call. > [!NOTE] diff --git a/docs/atl/memory-management-classes.md b/docs/atl/memory-management-classes.md index 680e61f19de..89bea5d1d08 100644 --- a/docs/atl/memory-management-classes.md +++ b/docs/atl/memory-management-classes.md @@ -4,10 +4,11 @@ title: "Memory Management Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["memory, managing"] -ms.assetid: be564a5e-577e-40a7-bfe3-25ad21e57270 --- # Memory Management Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + These classes provide support for heap pointers, smart pointers, and other memory allocation routines. - [CAutoPtr](../atl/reference/cautoptr-class.md) This class represents a smart pointer object. diff --git a/docs/atl/message-handler-functions.md b/docs/atl/message-handler-functions.md index a37dc85d188..e478109d521 100644 --- a/docs/atl/message-handler-functions.md +++ b/docs/atl/message-handler-functions.md @@ -4,10 +4,11 @@ title: "Message Handler Functions" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["MESSAGE_HANDLER macro", "COMMAND_HANDLER macro", "CommandHandler method", "MessageHandler method", "NotifyHandler method", "message maps, ATL", "NOTIFY_HANDLER macro, message handler functions", "ATL, message handlers"] -ms.assetid: 2007a8c5-0143-42f1-91ab-809f235f9d50 --- # Message Handler Functions +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL provides three types of message handler functions: |Type of message handler|Corresponding message macro| diff --git a/docs/atl/message-maps-atl.md b/docs/atl/message-maps-atl.md index 0ab8a690a8f..6b0ab765a4d 100644 --- a/docs/atl/message-maps-atl.md +++ b/docs/atl/message-maps-atl.md @@ -4,10 +4,11 @@ title: "Message Maps (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["message maps, ATL", "ATL, message handlers"] -ms.assetid: 9e100400-65c7-4a85-8857-4e6cb6dd7340 --- # Message Maps (ATL) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + A message map associates a handler function with a particular message, command, or notification. By using ATL's [message map macros](../atl/reference/message-map-macros-atl.md), you can specify a message map for a window. The window procedures in `CWindowImpl`, `CDialogImpl`, and `CContainedWindowT` direct a window's messages to its message map. The [message handler functions](../atl/message-handler-functions.md) accept an additional argument of type `BOOL&`. This argument indicates whether a message has been processed, and it is set to TRUE by default. A handler function can then set the argument to FALSE to indicate that it has not handled a message. In this case, ATL will continue to look for a handler function further in the message map. By setting this argument to FALSE, you can first perform some action in response to a message and then allow the default processing or another handler function to finish handling the message. diff --git a/docs/atl/messagehandler.md b/docs/atl/messagehandler.md index 4fcdaad53bd..4fa25ca0ead 100644 --- a/docs/atl/messagehandler.md +++ b/docs/atl/messagehandler.md @@ -4,10 +4,11 @@ title: "MessageHandler" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["MessageHandler function"] -ms.assetid: 8a0acf97-1b0d-4226-91b9-75446634a03c --- # MessageHandler +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + `MessageHandler` is the name of the function identified by the second parameter of the MESSAGE_HANDLER macro in your message map. ## Syntax diff --git a/docs/atl/mmc-snap-in-classes.md b/docs/atl/mmc-snap-in-classes.md index 140e10dc5e1..62c9af27f64 100644 --- a/docs/atl/mmc-snap-in-classes.md +++ b/docs/atl/mmc-snap-in-classes.md @@ -4,10 +4,11 @@ title: "MMC Snap-In Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["MMC Snap-In classes"] -ms.assetid: 4af1d5af-687f-48b1-b2c5-fa252241b4d6 --- # MMC Snap-In Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes provide support for developing Microsoft Management Console (MMC) snap-in components: - [CSnapInItemImpl](../atl/reference/csnapinitemimpl-class.md) Implements a snap-in node object, such as adding menu items and toolbars, and forwarding commands for the snap-in node to the appropriate handler function. diff --git a/docs/atl/modifying-the-atl-dhtml-control.md b/docs/atl/modifying-the-atl-dhtml-control.md index 3e77a536a1f..34fab00665a 100644 --- a/docs/atl/modifying-the-atl-dhtml-control.md +++ b/docs/atl/modifying-the-atl-dhtml-control.md @@ -3,11 +3,12 @@ description: "Learn more about: Modifying the ATL DHTML Control" title: "Modifying the ATL DHTML Control" ms.date: "11/04/2016" helpviewer_keywords: ["HTML controls, modifying", "DHTML controls", "DHTML controls, modifying"] -ms.assetid: c053f35f-8629-4600-9595-721f5956777a ms.topic: how-to --- # Modifying the ATL DHTML Control +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The ATL Control Wizard provides starter code so you can build and run the control, and so you can see how the methods are written in the project files and how the DHTML calls into the control's C++ code using the dispatch methods. You can add any dispatch method to the interface. Then, you can call the methods in the HTML resource. ## To modify the ATL DHTML control diff --git a/docs/atl/modifying-the-atl-project.md b/docs/atl/modifying-the-atl-project.md index d9211d97764..7b87fb2adbf 100644 --- a/docs/atl/modifying-the-atl-project.md +++ b/docs/atl/modifying-the-atl-project.md @@ -3,11 +3,12 @@ description: "Learn more about: Modifying the ATL Project" title: "Modifying the ATL Project" ms.date: "11/04/2016" helpviewer_keywords: ["controls [ATL], adding to composite controls", "Dialog editor, working with composite controls", "composite controls, adding controls"] -ms.assetid: 59984518-748f-4b8b-875f-3e97d22d0b0f ms.topic: concept-article --- # Modifying the ATL Project +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + At this point, your composite control project implements the necessary objects for your composite control. The next step is to add any controls that the composite control will contain and handle any necessary events. To add additional ActiveX or Windows controls, add a new resource script and then use the Dialog editor. For more information on adding controls (and related tasks), see [Dialog Editor](../windows/dialog-editor.md). diff --git a/docs/atl/multiple-dual-interfaces.md b/docs/atl/multiple-dual-interfaces.md index 99c43025249..52b22900163 100644 --- a/docs/atl/multiple-dual-interfaces.md +++ b/docs/atl/multiple-dual-interfaces.md @@ -4,10 +4,11 @@ title: "Multiple Dual Interfaces" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["multiple dual interfaces", "COM_INTERFACE_ENTRY2 macro", "dual interfaces, exposing multiple", "multiple dual interfaces, exposing with ATL", "IDispatchImpl class, multiple dual interfaces", "COM_INTERFACE_ENTRY_IID macro"] -ms.assetid: 7fea86e6-247f-4063-be6e-85588a9e3719 --- # Multiple Dual Interfaces +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + You may want to combine the advantages of a dual interface (that is, the flexibility of both vtable and late binding, thus making the class available to scripting languages as well as C++) with the techniques of multiple inheritance. Although it is possible to expose multiple dual interfaces on a single COM object, it is not recommended. If there are multiple dual interfaces, there must be only one `IDispatch` interface exposed. The techniques available to ensure that this is the case carry penalties such as loss of function or increased code complexity. The developer considering this approach should carefully weigh the advantages and disadvantages. diff --git a/docs/atl/nonextensible-attribute.md b/docs/atl/nonextensible-attribute.md index 08a854a4873..517f6ad1da7 100644 --- a/docs/atl/nonextensible-attribute.md +++ b/docs/atl/nonextensible-attribute.md @@ -3,10 +3,11 @@ description: "Learn more about: nonextensible Attribute" title: "nonextensible Attribute" ms.date: "11/04/2016" helpviewer_keywords: ["nonextensible attribute", "dual interfaces, nonextensible attribute"] -ms.assetid: 02a4a18b-ffd3-4d53-8fd1-feb1c05ad5ac --- # nonextensible Attribute +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + If a dual interface will not be extended at run time (that is, you won't provide methods or properties via `IDispatch::Invoke` that are not available via the vtable), you should apply the **nonextensible** attribute to your interface definition. This attribute provides information to client languages (such as Visual Basic) that can be used to enable full code verification at compile time. If this attribute is not supplied, bugs may remain hidden in the client code until run time. For more information on the **nonextensible** attribute and an example, see [nonextensible](../windows/attributes/nonextensible.md). diff --git a/docs/atl/notifyhandler.md b/docs/atl/notifyhandler.md index adb1d4a0db6..deaf83115cf 100644 --- a/docs/atl/notifyhandler.md +++ b/docs/atl/notifyhandler.md @@ -4,10 +4,11 @@ title: "NotifyHandler" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["NotifyHandler function"] -ms.assetid: 5ff953ec-de35-42bc-8b3c-d384d636c139 --- # NotifyHandler +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The name of the function identified by the third parameter of the NOTIFY_HANDLER macro in your message map. ## Syntax diff --git a/docs/atl/object-safety-classes.md b/docs/atl/object-safety-classes.md index 8021fd778b8..69ec66cf8eb 100644 --- a/docs/atl/object-safety-classes.md +++ b/docs/atl/object-safety-classes.md @@ -4,10 +4,11 @@ title: Object Safety Classes (ATL) ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["safety classes", "object safety classes"] -ms.assetid: 00060b28-49e2-4ec1-9a22-f501e07821d6 --- # Object Safety Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following class provides support for object safety: - [IObjectSafetyImpl](../atl/reference/iobjectsafetyimpl-class.md) Allows an object to be marked as safe for initialization or safe for scripting. diff --git a/docs/atl/persistence-classes.md b/docs/atl/persistence-classes.md index bce7966eb71..18d1a4e3826 100644 --- a/docs/atl/persistence-classes.md +++ b/docs/atl/persistence-classes.md @@ -4,10 +4,11 @@ title: "Persistence Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["persistence classes", "persistence, classes"] -ms.assetid: a6a2b6b2-52bc-471c-b78a-de58363128bb --- # Persistence Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes implement object persistence: - [IPersistPropertyBagImpl](../atl/reference/ipersistpropertybagimpl-class.md) Allows a client to load and save an object's properties to a property bag. diff --git a/docs/atl/programming-with-atl-and-c-run-time-code.md b/docs/atl/programming-with-atl-and-c-run-time-code.md index 66c4ade4f21..804e19a5600 100644 --- a/docs/atl/programming-with-atl-and-c-run-time-code.md +++ b/docs/atl/programming-with-atl-and-c-run-time-code.md @@ -3,11 +3,12 @@ description: "Learn more about: Programming with ATL and C Run-Time Code" title: "Programming with ATL and C Run-Time Code" ms.date: "11/04/2016" helpviewer_keywords: ["ATL_MIN_CRT macro", "CRT, using with ATL", "_ATL_MIN_CRT macro", "ATL, C Run-Time library (CRT)"] -ms.assetid: 20f03b66-1eb7-4add-84a2-6047db0911eb ms.topic: concept-article --- # Programming with ATL and C Run-Time Code +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + This section discusses the benefits of using the C Run-Time Library (CRT) with either static or dynamic linking. ## In This Section diff --git a/docs/atl/programming-with-ccombstr-atl.md b/docs/atl/programming-with-ccombstr-atl.md index 31f7ee2d370..c1b044ae46b 100644 --- a/docs/atl/programming-with-ccombstr-atl.md +++ b/docs/atl/programming-with-ccombstr-atl.md @@ -3,11 +3,12 @@ description: "Learn more about: Programming with CComBSTR (ATL)" title: "Programming with CComBSTR (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["CComBSTR class, programming with", "Unicode, using CComBSTR [ATL]"] -ms.assetid: d3bd0851-d132-4be9-9c4c-6ccba17acb2b ms.topic: concept-article --- # Programming with CComBSTR (ATL) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The ATL class [CComBSTR](../atl/reference/ccombstr-class.md) provides a wrapper around the BSTR data type. While `CComBSTR` is a useful tool, there are several situations that require caution. - [Conversion Issues](#programmingwithccombstr_conversionissues) diff --git a/docs/atl/properties-and-property-pages-classes.md b/docs/atl/properties-and-property-pages-classes.md index 17e8307bb07..9fafa9baf65 100644 --- a/docs/atl/properties-and-property-pages-classes.md +++ b/docs/atl/properties-and-property-pages-classes.md @@ -4,10 +4,11 @@ title: "Properties and Property Pages Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["property pages, classes", "properties [ATL], classes", "properties [ATL]"] -ms.assetid: 31616f98-69f8-48b2-8d58-b8e7d1c2b2d8 --- # Properties and Property Pages Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes support properties and property pages: - [CComDispatchDriver](../atl/reference/atl-typedefs.md#ccomdispatchdriver) Retrieves or sets an object's properties through an `IDispatch` pointer. diff --git a/docs/atl/putting-the-control-on-a-web-page-atl-tutorial-part-7.md b/docs/atl/putting-the-control-on-a-web-page-atl-tutorial-part-7.md index faf66529f16..b191688f163 100644 --- a/docs/atl/putting-the-control-on-a-web-page-atl-tutorial-part-7.md +++ b/docs/atl/putting-the-control-on-a-web-page-atl-tutorial-part-7.md @@ -3,11 +3,12 @@ description: "Learn more about: Putting the Control on a Web Page (ATL Tutorial, title: "Putting the Control on a Web Page (ATL Tutorial, Part 7)" ms.custom: "get-started-article" ms.date: "05/06/2019" -ms.assetid: 50dc4c95-c95b-4006-b88a-9826f7bdb222 ms.topic: tutorial --- # Putting the Control on a Web Page (ATL Tutorial, Part 7) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Your control is now finished. To see your control work in a real-world situation, put it on a Web page. An HTML file that contains the control was created when you defined your control. Open the PolyCtl.htm file from **Solution Explorer**, and you can see your control on a Web page. In this step, you add functionality to the control and script the Web page to respond to events. You'll also modify the control to let Internet Explorer know the control is safe for scripting. diff --git a/docs/atl/queryinterface.md b/docs/atl/queryinterface.md index 3d982e0e938..6849e52d2cd 100644 --- a/docs/atl/queryinterface.md +++ b/docs/atl/queryinterface.md @@ -4,10 +4,11 @@ title: "QueryInterface" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["interfaces, pointers", "interfaces, availability", "QueryInterface method"] -ms.assetid: 62fce95e-aafa-4187-b50b-e6611b74c3b3 --- # `QueryInterface` +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Although there are mechanisms by which an object can express the functionality it provides statically (before it is instantiated), the fundamental COM mechanism is to use the `IUnknown` method called [`QueryInterface`](/windows/win32/api/unknwn/nf-unknwn-iunknown-queryinterface(q)). Every interface is derived from `IUnknown`, so every interface has an implementation of `QueryInterface`. Regardless of implementation, this method queries an object using the `IID` of the interface to which the caller wants a pointer. If the object supports that interface, `QueryInterface` retrieves a pointer to the interface, while also calling `AddRef`. Otherwise, it returns the `E_NOINTERFACE` error code. diff --git a/docs/atl/recommendations-for-choosing-between-atl-and-mfc.md b/docs/atl/recommendations-for-choosing-between-atl-and-mfc.md index 2fc4145a2b8..f52522b644c 100644 --- a/docs/atl/recommendations-for-choosing-between-atl-and-mfc.md +++ b/docs/atl/recommendations-for-choosing-between-atl-and-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Recommendations for Choosing Between ATL and MFC title: "Recommendations for Choosing Between ATL and MFC" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, ATL support", "ATL, vs. MFC"] -ms.assetid: 269325bb-11a8-4330-ad2b-a14a2458679e --- # Recommendations for Choosing Between ATL and MFC +>[!NOTE] +> The Microsoft Foundation Classes library (MFC) and Active Template Library (ATL) continue to be supported. However, we're no longer adding features or updating the documentation. + When developing components and applications, you can choose between two approaches — ATL and MFC (the Microsoft Foundation Class Library). ## Using ATL diff --git a/docs/atl/reference-counting.md b/docs/atl/reference-counting.md index db71a9ca66c..594cc68c495 100644 --- a/docs/atl/reference-counting.md +++ b/docs/atl/reference-counting.md @@ -3,10 +3,11 @@ description: "Learn more about: Reference Counting" title: "Reference Counting (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["AddRef method [C++], reference counting", "reference counting", "AddRef method [C++]", "reference counts", "references, counting"] -ms.assetid: b1fd4514-6de6-429f-9e60-2777c0d07a3d --- # Reference Counting +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + COM itself does not automatically try to remove an object from memory when it thinks the object is no longer being used. Instead, the object programmer must remove the unused object. The programmer determines whether an object can be removed based on a reference count. COM uses the `IUnknown` methods, [AddRef](/windows/win32/api/unknwn/nf-unknwn-iunknown-addref) and [Release](/windows/win32/api/unknwn/nf-unknwn-iunknown-release), to manage the reference count of interfaces on an object. The general rules for calling these methods are: diff --git a/docs/atl/reference/adding-a-new-interface-in-an-atl-project.md b/docs/atl/reference/adding-a-new-interface-in-an-atl-project.md index f9b927b58c0..04bda95f84c 100644 --- a/docs/atl/reference/adding-a-new-interface-in-an-atl-project.md +++ b/docs/atl/reference/adding-a-new-interface-in-an-atl-project.md @@ -4,10 +4,11 @@ title: "Adding a New Interface in an ATL Project" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.ATL.interface"] helpviewer_keywords: ["interfaces, adding to ATL objects", "Implement Interface ATL wizard", "controls [ATL], interfaces", "ATL projects, adding interfaces"] -ms.assetid: 7d34b023-2c6b-4155-aca3-d47a40968063 --- # Adding a New Interface in an ATL Project +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + When you add an interface to your object or control, you create stubbed-out functions for each method in that interface. In your object or control, you can add only interfaces currently found in an existing type library. Also, the class in which you add the interface must implement the [BEGIN_COM_MAP](com-map-macros.md#begin_com_map) macro or, if the project is attributed, it must have the `coclass` attribute. You can add a new interface to your control in one of two ways: manually or using code wizards in Class View. diff --git a/docs/atl/reference/adding-an-atl-active-server-page-component.md b/docs/atl/reference/adding-an-atl-active-server-page-component.md index 508bf1fbfca..9b0aa9b0b73 100644 --- a/docs/atl/reference/adding-an-atl-active-server-page-component.md +++ b/docs/atl/reference/adding-an-atl-active-server-page-component.md @@ -2,10 +2,11 @@ description: "Learn more about: Adding an ATL Active Server Page Component" title: "Adding an ATL Active Server Page Component" ms.date: "05/09/2019" -ms.assetid: 7be2204c-6e58-4099-8892-001b848c8987 --- # Adding an ATL Active Server Page Component +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" The ATL Active Server Pages component wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/adding-an-atl-com-plus-1-0-component.md b/docs/atl/reference/adding-an-atl-com-plus-1-0-component.md index 6df0a367ba5..b04378c1ea7 100644 --- a/docs/atl/reference/adding-an-atl-com-plus-1-0-component.md +++ b/docs/atl/reference/adding-an-atl-com-plus-1-0-component.md @@ -2,10 +2,11 @@ description: "Learn more about: Adding an ATL COM+ 1.0 Component" title: "Adding an ATL COM+ 1.0 Component" ms.date: "05/09/2019" -ms.assetid: c6c95e64-9ee4-4a6e-8804-5930202ce1b9 --- # Adding an ATL COM+ 1.0 Component +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" The ATL COM+ 1.0 Component wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/adding-an-atl-control.md b/docs/atl/reference/adding-an-atl-control.md index c9a01745336..e62a42cd078 100644 --- a/docs/atl/reference/adding-an-atl-control.md +++ b/docs/atl/reference/adding-an-atl-control.md @@ -3,10 +3,11 @@ description: "Learn more about: Adding an ATL Control" title: "Adding an ATL Control" ms.date: "11/04/2016" helpviewer_keywords: ["ATL projects, adding controls", "controls [ATL], adding to projects"] -ms.assetid: 10223e7e-fdb7-4163-80c6-44aeafa8e6ce --- # Adding an ATL Control +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Use this wizard to add a user interface object to a project that supports interfaces for all potential containers. To support these interfaces, the project must have been created as an ATL application or as an MFC application that contains ATL support. You can use the [ATL Project Wizard](../../atl/reference/atl-project-wizard.md) to create an ATL application, or [add an ATL object to your MFC application](../../mfc/reference/adding-atl-support-to-your-mfc-project.md) to implement ATL support for an MFC application. ## To add an ATL control to your project diff --git a/docs/atl/reference/adding-an-atl-dialog-box.md b/docs/atl/reference/adding-an-atl-dialog-box.md index 928fd204304..e7519718ea2 100644 --- a/docs/atl/reference/adding-an-atl-dialog-box.md +++ b/docs/atl/reference/adding-an-atl-dialog-box.md @@ -3,10 +3,11 @@ description: "Learn more about: Adding an ATL Dialog Box" title: "Adding an ATL Dialog Box" ms.date: "11/04/2016" helpviewer_keywords: ["ATL projects, adding dialog resources", "MFC dialog boxes, ATL dialogs", "dialog boxes, ATL"] -ms.assetid: 152a378f-7b24-4f66-aeba-c740973f03a6 --- # Adding an ATL Dialog Box +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + To add an ATL dialog to your project, your project must be either an ATL project or an MFC project that includes ATL support. You can use the [ATL Project Wizard](../../atl/reference/atl-project-wizard.md) to create an ATL application, or [add an ATL object to your MFC application](../../mfc/reference/adding-atl-support-to-your-mfc-project.md) to implement ATL support for an MFC application. By default, the ATL Dialog Wizard implements a dialog box derived from [CAxDialogImpl](../../atl/reference/caxdialogimpl-class.md). This class includes support for hosting ActiveX and Windows controls. If you do not want the overhead of ActiveX control support, once the wizard has generated your code, replace all instances of `CAxDialogImpl` with either [CSimpleDialog](../../atl/reference/csimpledialog-class.md) or [CDialogImpl](../../atl/reference/cdialogimpl-class.md) as your base class. diff --git a/docs/atl/reference/adding-an-atl-ole-db-consumer.md b/docs/atl/reference/adding-an-atl-ole-db-consumer.md index 52b1acc39ab..52b42c75ed2 100644 --- a/docs/atl/reference/adding-an-atl-ole-db-consumer.md +++ b/docs/atl/reference/adding-an-atl-ole-db-consumer.md @@ -3,10 +3,11 @@ description: "Learn more about: Adding an ATL OLE DB Consumer" title: "Adding an ATL OLE DB Consumer" ms.date: "05/09/2019" helpviewer_keywords: ["ATL OLE DB consumers"] -ms.assetid: f940a513-4e42-4148-b521-dd0d7dc89fa2 --- # Adding an ATL OLE DB Consumer +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" The ATL OLE DB Consumer wizard is not available in Visual Studio 2019 and later. You can still add the functionality manually. For more information, see [Creating a Consumer Without Using a Wizard](../../data/oledb/creating-a-consumer-without-using-a-wizard.md). diff --git a/docs/atl/reference/adding-an-atl-ole-db-provider.md b/docs/atl/reference/adding-an-atl-ole-db-provider.md index 3aba76e606f..908e53502a3 100644 --- a/docs/atl/reference/adding-an-atl-ole-db-provider.md +++ b/docs/atl/reference/adding-an-atl-ole-db-provider.md @@ -3,10 +3,11 @@ description: "Learn more about: Adding an ATL OLE DB Provider" title: "Adding an ATL OLE DB Provider" ms.date: "05/09/2019" helpviewer_keywords: ["OLE DB, adding ATL OLE DB provider to projects", "ATL projects, adding ATL OLE DB providers", "ATL OLE DB providers"] -ms.assetid: 26fba1e3-880f-4bc6-90e5-2096a48a3a6c --- # Adding an ATL OLE DB Provider +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" The ATL OLE DB Provider wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/adding-an-atl-property-page.md b/docs/atl/reference/adding-an-atl-property-page.md index 376b4875a7f..543c72db463 100644 --- a/docs/atl/reference/adding-an-atl-property-page.md +++ b/docs/atl/reference/adding-an-atl-property-page.md @@ -3,10 +3,11 @@ description: "Learn more about: Adding an ATL Property Page" title: "Adding an ATL Property Page" ms.date: "05/09/2019" helpviewer_keywords: ["property pages, adding", "ATL projects, adding property pages", "controls [ATL], property pages"] -ms.assetid: ddf92b49-42a2-46d2-b6b8-d37baedebeca --- # Adding an ATL Property Page +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + > [!NOTE] > The ATL Property Page wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/adding-an-atl-simple-object.md b/docs/atl/reference/adding-an-atl-simple-object.md index 91e8e2ddac4..53c4b37fd33 100644 --- a/docs/atl/reference/adding-an-atl-simple-object.md +++ b/docs/atl/reference/adding-an-atl-simple-object.md @@ -4,10 +4,11 @@ title: "Adding an ATL Simple Object" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.classes.adding.atl"] helpviewer_keywords: ["ATL projects, adding objects", "objects [ATL]", "ATL, simple objects"] -ms.assetid: 9c57d2ef-0447-4c84-8982-3304b8e49847 --- # Adding an ATL Simple Object +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + To add an ATL (Active Template Library) object to your project, your project must have been created as an ATL application or as an MFC application that contains ATL support. You can use the [ATL Project Wizard](../../atl/reference/atl-project-wizard.md) to create an ATL application, or [add an ATL object to your MFC application](../../mfc/reference/adding-atl-support-to-your-mfc-project.md) to implement ATL support for an MFC application. You can define COM interfaces for your new ATL object when you first create it, or add them later by using the [Implement Interface](../../ide/implementing-an-interface-visual-cpp.md#implement-interface-wizard) command from the **Class View** shortcut menu. diff --git a/docs/atl/reference/adding-objects-and-controls-to-an-atl-project.md b/docs/atl/reference/adding-objects-and-controls-to-an-atl-project.md index 036b72dc54c..f77dfceb83e 100644 --- a/docs/atl/reference/adding-objects-and-controls-to-an-atl-project.md +++ b/docs/atl/reference/adding-objects-and-controls-to-an-atl-project.md @@ -4,10 +4,11 @@ title: "Adding Objects and Controls to an ATL Project" ms.date: "05/09/2019" f1_keywords: ["vc.appwiz.ATL.controls"] helpviewer_keywords: ["ATL projects, adding objects", "wizards [C++], ATL projects", "ATL projects, adding controls", "controls [ATL], adding to projects", "objects [C++], adding to ATL projects", "ATL Control Wizard"] -ms.assetid: c0adcbd0-07fe-4c55-a8fd-8c2c65ecdaad --- # Adding Objects and Controls to an ATL Project +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + > [!NOTE] > The ATL COM+ 1.0 Component Wizard, ATL OLE DB Consumer wizard, and ATL Active Server Page Component wizard are not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/aggregation-and-class-factory-macros.md b/docs/atl/reference/aggregation-and-class-factory-macros.md index b6dacd4282f..7520e67a5f9 100644 --- a/docs/atl/reference/aggregation-and-class-factory-macros.md +++ b/docs/atl/reference/aggregation-and-class-factory-macros.md @@ -4,10 +4,11 @@ title: "Aggregation and Class Factory Macros" ms.date: 08/12/2020 f1_keywords: ["ATLCOM/ATL::DECLARE_AGGREGATABLE", "ATLCOM/ATL::DECLARE_CLASSFACTORY", "ATLCOM/ATL::DECLARE_CLASSFACTORY_EX", "ATLCOM/ATL::DECLARE_CLASSFACTORY_AUTO_THREAD", "ATLCOM/ATL::DECLARE_CLASSFACTORY_SINGLETON", "ATLCOM/ATL::DECLARE_GET_CONTROLLING_UNKNOWN", "ATLCOM/ATL::DECLARE_NOT_AGGREGATABLE", "ATLCOM/ATL::DECLARE_ONLY_AGGREGATABLE", "ATLCOM/ATL::DECLARE_POLY_AGGREGATABLE", "ATLCOM/ATL::DECLARE_PROTECT_FINAL_CONSTRUCT", "ATLCOM/ATL::DECLARE_VIEW_STATUS", "ATLDEF/ATL::DECLARE_AGGREGATABLE", "ATLDEF/ATL::DECLARE_CLASSFACTORY", "ATLDEF/ATL::DECLARE_CLASSFACTORY_EX", "ATLDEF/ATL::DECLARE_CLASSFACTORY_AUTO_THREAD", "ATLDEF/ATL::DECLARE_CLASSFACTORY_SINGLETON", "ATLDEF/ATL::DECLARE_GET_CONTROLLING_UNKNOWN", "ATLDEF/ATL::DECLARE_NOT_AGGREGATABLE", "ATLDEF/ATL::DECLARE_ONLY_AGGREGATABLE", "ATLDEF/ATL::DECLARE_POLY_AGGREGATABLE", "ATLDEF/ATL::DECLARE_PROTECT_FINAL_CONSTRUCT", "ATLDEF/ATL::DECLARE_VIEW_STATUS", "ATLCOM/DECLARE_AGGREGATABLE", "ATLCOM/DECLARE_CLASSFACTORY", "ATLCOM/DECLARE_CLASSFACTORY_EX", "ATLCOM/DECLARE_CLASSFACTORY_AUTO_THREAD", "ATLCOM/DECLARE_CLASSFACTORY_SINGLETON", "ATLCOM/DECLARE_GET_CONTROLLING_UNKNOWN", "ATLCOM/DECLARE_NOT_AGGREGATABLE", "ATLCOM/DECLARE_ONLY_AGGREGATABLE", "ATLCOM/DECLARE_POLY_AGGREGATABLE", "ATLCOM/DECLARE_PROTECT_FINAL_CONSTRUCT", "ATLCOM/DECLARE_VIEW_STATUS", "ATL::DECLARE_AGGREGATABLE", "ATL::DECLARE_CLASSFACTORY", "ATL::DECLARE_CLASSFACTORY_EX", "ATL::DECLARE_CLASSFACTORY_AUTO_THREAD", "ATL::DECLARE_CLASSFACTORY_SINGLETON", "ATL::DECLARE_GET_CONTROLLING_UNKNOWN", "ATL::DECLARE_NOT_AGGREGATABLE", "ATL::DECLARE_ONLY_AGGREGATABLE", "ATL::DECLARE_POLY_AGGREGATABLE", "ATL::DECLARE_PROTECT_FINAL_CONSTRUCT", "ATL::DECLARE_VIEW_STATUS", "DECLARE_AGGREGATABLE", "DECLARE_CLASSFACTORY", "DECLARE_CLASSFACTORY_EX", "DECLARE_CLASSFACTORY_AUTO_THREAD", "DECLARE_CLASSFACTORY_SINGLETON", "DECLARE_GET_CONTROLLING_UNKNOWN", "DECLARE_NOT_AGGREGATABLE", "DECLARE_ONLY_AGGREGATABLE", "DECLARE_POLY_AGGREGATABLE", "DECLARE_PROTECT_FINAL_CONSTRUCT", "DECLARE_VIEW_STATUS"] helpviewer_keywords: ["class factories, ATL macros", "aggregation [C++], ATL macros", "ATL::DECLARE_AGGREGATABLE", "ATL::DECLARE_CLASSFACTORY", "ATL::DECLARE_CLASSFACTORY_EX", "ATL::DECLARE_CLASSFACTORY_AUTO_THREAD", "ATL::DECLARE_CLASSFACTORY_SINGLETON", "ATL::DECLARE_GET_CONTROLLING_UNKNOWN", "ATL::DECLARE_NOT_AGGREGATABLE", "ATL::DECLARE_ONLY_AGGREGATABLE", "ATL::DECLARE_POLY_AGGREGATABLE", "ATL::DECLARE_PROTECT_FINAL_CONSTRUCT", "ATL::DECLARE_VIEW_STATUS"] -ms.assetid: d99d379a-0eec-481f-8daa-252dac18f163 --- # Aggregation and Class Factory Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros provide ways of controlling aggregation and of declaring class factories. | Macro | Description | diff --git a/docs/atl/reference/appearance-atl-control-wizard.md b/docs/atl/reference/appearance-atl-control-wizard.md index 5a28f5a572e..2f305fd5e95 100644 --- a/docs/atl/reference/appearance-atl-control-wizard.md +++ b/docs/atl/reference/appearance-atl-control-wizard.md @@ -4,10 +4,11 @@ title: "Appearance, ATL Control Wizard" ms.date: "08/31/2018" f1_keywords: ["vc.codewiz.class.atl.control.misc"] helpviewer_keywords: ["ATL Control Wizard, appearance"] -ms.assetid: cc16d7ff-74d7-4c15-9ebd-4b19201ff457 --- # Appearance, ATL Control Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Use this page of the wizard to identify additional user element options for the control. This page is available for controls identified as **Standard controls** under **Control type** on the [Options, ATL Control Wizard](../../atl/reference/options-atl-control-wizard.md) page. ## UIElement List diff --git a/docs/atl/reference/application-settings-atl-project-wizard.md b/docs/atl/reference/application-settings-atl-project-wizard.md index 03b0fade12f..6922ea0313c 100644 --- a/docs/atl/reference/application-settings-atl-project-wizard.md +++ b/docs/atl/reference/application-settings-atl-project-wizard.md @@ -4,10 +4,11 @@ title: "Application Settings, ATL Project Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.atl.com.appset"] helpviewer_keywords: ["ATL Project Wizard, application settings"] -ms.assetid: d48c9fc5-f439-49fd-884c-8bcfa7d52991 --- # Application Settings, ATL Project Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Use the **Application Settings** page of the ATL Project Wizard to design and add basic features to a new ATL project. ## Server type diff --git a/docs/atl/reference/asp-atl-active-server-page-component-wizard.md b/docs/atl/reference/asp-atl-active-server-page-component-wizard.md index efb54c5bbfa..3a9dd3f5419 100644 --- a/docs/atl/reference/asp-atl-active-server-page-component-wizard.md +++ b/docs/atl/reference/asp-atl-active-server-page-component-wizard.md @@ -4,10 +4,11 @@ title: "ASP, ATL Active Server Page Component Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.class.atl.asp.asp"] helpviewer_keywords: ["ATL Active Server Page Component Wizard, ASP"] -ms.assetid: 4d8cafd6-5e12-4461-8911-29288896af3c --- # ASP, ATL Active Server Page Component Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Use this page of the ATL Active Server Page Component Wizard to specify optional settings for handling information and state related to your ASP component. - **Optional methods** diff --git a/docs/atl/reference/atl-active-server-page-component-wizard.md b/docs/atl/reference/atl-active-server-page-component-wizard.md index ceab8c73f93..410c00ddb87 100644 --- a/docs/atl/reference/atl-active-server-page-component-wizard.md +++ b/docs/atl/reference/atl-active-server-page-component-wizard.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Active Server Page Component Wizard" title: "ATL Active Server Page Component Wizard" ms.date: "05/09/2019" helpviewer_keywords: ["ASP components, creating in ATL"] -ms.assetid: 5a5cb904-dbbf-44ea-ad3d-2ddd14c1d3c5 --- # ATL Active Server Page Component Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" This wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/atl-base-module70-structure.md b/docs/atl/reference/atl-base-module70-structure.md index 78cbd738768..004ec92a8bd 100644 --- a/docs/atl/reference/atl-base-module70-structure.md +++ b/docs/atl/reference/atl-base-module70-structure.md @@ -4,10 +4,11 @@ title: "_ATL_BASE_MODULE70 Structure" ms.date: "11/04/2016" f1_keywords: ["ATL::_ATL_BASE_MODULE70", "ATL._ATL_BASE_MODULE70", "_ATL_BASE_MODULE70"] helpviewer_keywords: ["ATL_BASE_MODULE70 structure", "_ATL_BASE_MODULE70 structure"] -ms.assetid: 4539282f-15b8-4d7c-aafa-a85dc56f4980 --- # _ATL_BASE_MODULE70 Structure +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Used by any project that uses ATL. ## Syntax diff --git a/docs/atl/reference/atl-classes.md b/docs/atl/reference/atl-classes.md index 36a3ed3f0de..836fa1aa854 100644 --- a/docs/atl/reference/atl-classes.md +++ b/docs/atl/reference/atl-classes.md @@ -6,6 +6,8 @@ helpviewer_keywords: ["classes [C++], ATL", "ATL, classes"] --- # ATL classes and structs +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + The Active Template Library (ATL) includes the following classes and structs. To find a particular class by category, see the [ATL Class Overview](../../atl/atl-class-overview.md). |Class / struct|Description|Header file| diff --git a/docs/atl/reference/atl-com-module70-structure.md b/docs/atl/reference/atl-com-module70-structure.md index 3f37add4ec9..424d68a7e57 100644 --- a/docs/atl/reference/atl-com-module70-structure.md +++ b/docs/atl/reference/atl-com-module70-structure.md @@ -4,10 +4,11 @@ title: "_ATL_COM_MODULE70 Structure" ms.date: "11/04/2016" f1_keywords: ["ATL::_ATL_COM_MODULE70", "ATL._ATL_COM_MODULE70", "_ATL_COM_MODULE70"] helpviewer_keywords: ["_ATL_COM_MODULE70 structure", "ATL_COM_MODULE70 structure"] -ms.assetid: 5b0b2fd0-bdeb-4c7e-8870-78fa69ace6e6 --- # _ATL_COM_MODULE70 Structure +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Used by COM-related code in ATL. ## Syntax diff --git a/docs/atl/reference/atl-com-plus-1-0-component-wizard.md b/docs/atl/reference/atl-com-plus-1-0-component-wizard.md index 4f342caa931..a72c326005e 100644 --- a/docs/atl/reference/atl-com-plus-1-0-component-wizard.md +++ b/docs/atl/reference/atl-com-plus-1-0-component-wizard.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL COM+ 1.0 Component Wizard" title: "ATL COM+ 1.0 Component Wizard" ms.date: "05/08/2019" helpviewer_keywords: ["ATL projects, adding components"] -ms.assetid: 11670681-8671-4122-96a4-2e52f8dadce0 --- # ATL COM+ 1.0 Component Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" This wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/atl-control-wizard.md b/docs/atl/reference/atl-control-wizard.md index f1ba09a54dd..1c7f40ee9f4 100644 --- a/docs/atl/reference/atl-control-wizard.md +++ b/docs/atl/reference/atl-control-wizard.md @@ -4,10 +4,11 @@ title: "ATL Control Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.class.atl.control.overview"] helpviewer_keywords: ["ATL projects, adding controls", "controls [ATL], adding to projects", "ATL Control Wizard"] -ms.assetid: 991f8e72-ffbc-4382-a4ce-e255acfba5b6 --- # ATL Control Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Inserts into an ATL project (or an MFC project with ATL support) an ATL control. You can use this wizard to insert one of three kinds of controls: - Standard control diff --git a/docs/atl/reference/atl-dialog-wizard.md b/docs/atl/reference/atl-dialog-wizard.md index c2908571e3c..862cb038b71 100644 --- a/docs/atl/reference/atl-dialog-wizard.md +++ b/docs/atl/reference/atl-dialog-wizard.md @@ -4,10 +4,11 @@ title: "ATL Dialog Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.class.atl.dlg.overview"] helpviewer_keywords: ["ATL projects, adding dialog resources", "ATL Dialog Wizard"] -ms.assetid: b0b9ace5-83c9-40d3-82c3-eb6293f10583 --- # ATL Dialog Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This wizard inserts into the project an ATL dialog box object, derived from [CAxDialogImpl](../../atl/reference/caxdialogimpl-class.md). A dialog box derived from `CAxDialogImpl` can host ActiveX controls. The wizard creates a dialog resource with default **OK** and **Cancel** buttons. You can edit the dialog resource and add ActiveX controls using the [Dialog Editor](../../windows/dialog-editor.md) in Resource View. diff --git a/docs/atl/reference/atl-drawinfo-structure.md b/docs/atl/reference/atl-drawinfo-structure.md index 8c44e5e231a..971943f6209 100644 --- a/docs/atl/reference/atl-drawinfo-structure.md +++ b/docs/atl/reference/atl-drawinfo-structure.md @@ -4,10 +4,11 @@ title: "ATL_DRAWINFO Structure" ms.date: "11/04/2016" f1_keywords: ["ATL::ATL_DRAWINFO", "ATL_DRAWINFO", "ATL.ATL_DRAWINFO"] helpviewer_keywords: ["ATL_DRAWINFO structure"] -ms.assetid: dd2e2aa8-e8c5-403b-b4df-35c0f6f57fb7 --- # ATL_DRAWINFO Structure +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Contains information used for rendering to various targets, such as a printer, metafile, or ActiveX control. ## Syntax diff --git a/docs/atl/reference/atl-func-info-structure.md b/docs/atl/reference/atl-func-info-structure.md index 2be432a32d9..7f3e2b1dc1d 100644 --- a/docs/atl/reference/atl-func-info-structure.md +++ b/docs/atl/reference/atl-func-info-structure.md @@ -4,10 +4,11 @@ title: "_ATL_FUNC_INFO Structure" ms.date: "11/04/2016" f1_keywords: ["_ATL_FUNC_INFO", "ATL::_ATL_FUNC_INFO", "ATL._ATL_FUNC_INFO"] helpviewer_keywords: ["_ATL_FUNC_INFO structure", "ATL_FUNC_INFO structure"] -ms.assetid: 441ebe2c-f971-47de-9f52-a258e8d6f88e --- # _ATL_FUNC_INFO Structure +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Contains type information used to describe a method or property on a dispinterface. ## Syntax diff --git a/docs/atl/reference/atl-functions.md b/docs/atl/reference/atl-functions.md index f32f42b2041..96a93f09150 100644 --- a/docs/atl/reference/atl-functions.md +++ b/docs/atl/reference/atl-functions.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Functions" title: "ATL Functions" ms.date: "11/04/2016" helpviewer_keywords: ["functions [ATL]", "ATL, global functions"] -ms.assetid: 69db0cb2-de1d-445b-b692-020d6e8c2173 --- # ATL Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + To find an ATL function by category, see the following topics. [ATL Path Functions](../../atl/reference/com-map-global-functions.md)
diff --git a/docs/atl/reference/atl-global-variables.md b/docs/atl/reference/atl-global-variables.md index 68a23951c11..553aec1f266 100644 --- a/docs/atl/reference/atl-global-variables.md +++ b/docs/atl/reference/atl-global-variables.md @@ -4,10 +4,11 @@ title: "ATL Global Variables" ms.date: "12/06/2017" f1_keywords: ["ATLBASE/_pAtlModule"] helpviewer_keywords: ["global variables, ATL", "_pAtlModule"] -ms.assetid: e881a319-99ca-4f5d-8a0b-34b3dcd0f37f --- # ATL Global Variables +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ## _pAtlModule A global variable storing a pointer to the current module. diff --git a/docs/atl/reference/atl-http-utility-functions.md b/docs/atl/reference/atl-http-utility-functions.md index 47f78813f00..6980b30e704 100644 --- a/docs/atl/reference/atl-http-utility-functions.md +++ b/docs/atl/reference/atl-http-utility-functions.md @@ -2,10 +2,11 @@ description: "Learn more about: ATL HTTP Utility Functions" title: "ATL HTTP Utility Functions" ms.date: "11/04/2016" -ms.assetid: 4db57ef2-31fa-4696-bbeb-79a9035033ed --- # ATL HTTP Utility Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions support manipulation of URLs. |Function|Description| diff --git a/docs/atl/reference/atl-macros.md b/docs/atl/reference/atl-macros.md index 28f62b30117..d660507aeb8 100644 --- a/docs/atl/reference/atl-macros.md +++ b/docs/atl/reference/atl-macros.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Macros" title: "ATL Macros" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, macros", "macros, ATL"] -ms.assetid: 788bd803-e7dc-4dc5-9e8d-31649471415b --- # ATL Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + To find an ATL macro by category, see the following topics. [Aggregation and Class Factory Macros](../../atl/reference/aggregation-and-class-factory-macros.md)
diff --git a/docs/atl/reference/atl-module70-structure.md b/docs/atl/reference/atl-module70-structure.md index eeee4263273..642c262492a 100644 --- a/docs/atl/reference/atl-module70-structure.md +++ b/docs/atl/reference/atl-module70-structure.md @@ -4,10 +4,11 @@ title: "_ATL_MODULE70 Structure" ms.date: "11/04/2016" f1_keywords: ["_ATL_MODULE70", "ATL::_ATL_MODULE70", "ATL._ATL_MODULE70"] helpviewer_keywords: ["ATL_MODULE70 structure", "_ATL_MODULE70 structure"] -ms.assetid: b059b2c8-dfd1-4ac9-b07d-39df638cc7b3 --- # _ATL_MODULE70 Structure +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Contains data used by every ATL module. ## Syntax diff --git a/docs/atl/reference/atl-ole-db-consumer-wizard.md b/docs/atl/reference/atl-ole-db-consumer-wizard.md index da09ffeebbb..8192655ec73 100644 --- a/docs/atl/reference/atl-ole-db-consumer-wizard.md +++ b/docs/atl/reference/atl-ole-db-consumer-wizard.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL OLE DB Consumer Wizard" title: "ATL OLE DB Consumer Wizard" ms.date: "07/02/2019" helpviewer_keywords: ["ATL projects, adding ATL OLE DB consumers"] -ms.assetid: dcb68ed1-2224-422f-9f7b-108a74864204 --- # ATL OLE DB Consumer Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" This wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/atl-ole-db-provider-wizard.md b/docs/atl/reference/atl-ole-db-provider-wizard.md index 29417f6f85d..e0d73a85994 100644 --- a/docs/atl/reference/atl-ole-db-provider-wizard.md +++ b/docs/atl/reference/atl-ole-db-provider-wizard.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL OLE DB Provider Wizard" title: "ATL OLE DB Provider Wizard" ms.date: "05/09/2019" helpviewer_keywords: ["ATL projects, adding ATL OLE DB providers"] -ms.assetid: cf91ba78-01d1-4d12-b673-e95d96bfbebe --- # ATL OLE DB Provider Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" This wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/atl-operators.md b/docs/atl/reference/atl-operators.md index 85beb951ab3..2e16c36d15a 100644 --- a/docs/atl/reference/atl-operators.md +++ b/docs/atl/reference/atl-operators.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Operators" title: "ATL Operators" ms.date: "11/04/2016" helpviewer_keywords: ["operators [ATL]"] -ms.assetid: 58ccd252-2869-45ee-8a5c-3ca40ee7f8a2 --- # ATL Operators +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This section contains the reference topics for the ATL global operators. |Operator|Description| diff --git a/docs/atl/reference/atl-path-functions.md b/docs/atl/reference/atl-path-functions.md index 33562d071a8..709a5e9f82a 100644 --- a/docs/atl/reference/atl-path-functions.md +++ b/docs/atl/reference/atl-path-functions.md @@ -4,10 +4,11 @@ title: "ATL Path functions" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, path"] f1_keywords: ["ATLPATH/ATL::ATLPath::AddBackslash", "ATLPATH/ATL::ATLPath::AddExtension", "ATLPATH/ATL::ATLPath::Append", "ATLPATH/ATL::ATLPath::BuildRoot", "ATLPATH/ATL::ATLPath::Canonicalize", "ATLPATH/ATL::ATLPath::Combine", "ATLPATH/ATL::ATLPath::CommonPrefix", "ATLPATH/ATL::ATLPath::CompactPath", "ATLPATH/ATL::ATLPath::CompactPathEx", "ATLPATH/ATL::ATLPath::FileExists", "ATLPATH/ATL::ATLPath::FindExtension", "ATLPATH/ATL::ATLPath::FindFileName", "ATLPATH/ATL::ATLPath::GetDriveNumber", "ATLPATH/ATL::ATLPath::IsDirectory", "ATLPATH/ATL::ATLPath::IsFileSpec", "ATLPATH/ATL::ATLPath::IsPrefix", "ATLPATH/ATL::ATLPath::IsRelative", "ATLPATH/ATL::ATLPath::IsRoot", "ATLPATH/ATL::ATLPath::IsSameRoot", "ATLPATH/ATL::ATLPath::IsUNC", "ATLPATH/ATL::ATLPath::IsUNCServer", "ATLPATH/ATL::ATLPath::IsUNCServerShare", "ATLPATH/ATL::ATLPath::MakePretty", "ATLPATH/ATL::ATLPath::MatchSpec", "ATLPATH/ATL::ATLPath::QuoteSpaces", "ATLPATH/ATL::ATLPath::RelativePathTo", "ATLPATH/ATL::ATLPath::RemoveArgs", "ATLPATH/ATL::ATLPath::RemoveBackslash", "ATLPATH/ATL::ATLPath::RemoveBlanks", "ATLPATH/ATL::ATLPath::RemoveExtension", "ATLPATH/ATL::ATLPath::RemoveFileSpec", "ATLPATH/ATL::ATLPath::RenameExtension", "ATLPATH/ATL::ATLPath::SkipRoot", "ATLPATH/ATL::ATLPath::StripPath", "ATLPATH/ATL::ATLPath::StripToRoot", "ATLPATH/ATL::ATLPath::UnquoteSpaces"] -ms.assetid: d1ec2b8d-7ec7-43ea-90dd-0a740d2a742b --- # ATL Path functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ATL provides the ATLPath class for manipulating paths in the form of [CPathT](cpatht-class.md). This code can be found in atlpath.h. ## Related Classes diff --git a/docs/atl/reference/atl-project-wizard.md b/docs/atl/reference/atl-project-wizard.md index 54180ade5d1..f0ceeb5726f 100644 --- a/docs/atl/reference/atl-project-wizard.md +++ b/docs/atl/reference/atl-project-wizard.md @@ -4,10 +4,11 @@ title: "ATL Project Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.atl.com.overview"] helpviewer_keywords: ["ATL projects, creating", "ATL Project Wizard"] -ms.assetid: 564d2aaf-5b8e-4c2a-a925-ca40a283ea34 --- # ATL Project Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + The Active Template Library (ATL) is a set of template-based C++ classes that simplify writing small and fast COM objects. The ATL Project Wizard creates a project with the structures to contain COM objects. ## Overview diff --git a/docs/atl/reference/atl-property-page-wizard.md b/docs/atl/reference/atl-property-page-wizard.md index 16c00456903..4d7eb8263ac 100644 --- a/docs/atl/reference/atl-property-page-wizard.md +++ b/docs/atl/reference/atl-property-page-wizard.md @@ -4,10 +4,11 @@ title: "ATL Property Page Wizard" ms.date: "05/09/2019" f1_keywords: ["vc.codewiz.class.atl.ppg.overview"] helpviewer_keywords: ["ATL projects, adding property pages", "ATL Property Page Wizard"] -ms.assetid: 6113e325-facd-4f68-b491-144d75209922 --- # ATL Property Page Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" This wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/atl-simple-object-wizard.md b/docs/atl/reference/atl-simple-object-wizard.md index 23a819b1bf8..392f374f655 100644 --- a/docs/atl/reference/atl-simple-object-wizard.md +++ b/docs/atl/reference/atl-simple-object-wizard.md @@ -4,10 +4,11 @@ title: "ATL Simple Object Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.class.atl.simple.overview"] helpviewer_keywords: ["ATL projects, adding objects", "ATL Simple Object Wizard"] -ms.assetid: f7f85741-9aad-4543-a917-a29b996364da --- # ATL Simple Object Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This wizard inserts into the project a minimal COM object. Use this page of the wizard to specify the names that identify the C++ class and files for your object and its COM functionality. Use the [Options](../../atl/reference/options-atl-simple-object-wizard.md) page of this wizard to specify the object's threading model, its aggregation support, and whether it supports dual interfaces and Automation. You can also indicate support for the error information interface, connection points, Internet Explorer support, and free-threaded marshaling. diff --git a/docs/atl/reference/atl-text-encoding-functions.md b/docs/atl/reference/atl-text-encoding-functions.md index aa50e31f2ef..6afe2a4900b 100644 --- a/docs/atl/reference/atl-text-encoding-functions.md +++ b/docs/atl/reference/atl-text-encoding-functions.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Text Encoding Functions" title: "ATL Text Encoding Functions" ms.date: "11/04/2016" f1_keywords: ["atlbase/ATL::AtlGetHexValue", "atlbase/ATL::AtlGetVersion", "atlenc/ATL::AtlHexDecode", "atlenc/ATL::AtlHexDecodeGetRequiredLength", "atlenc/ATL::AtlHexEncode", "atlenc/ATL::AtlHexEncodeGetRequiredLength", "atlenc/ATL::AtlHexValue", "atlenc/ATL::BEncode", "atlenc/ATL::BEncodeGetRequiredLength", "atlenc/ATL::EscapeXML", "atlenc/ATL::GetExtendedChars", "atlenc/ATL::IsExtendedChar", "atlenc/ATL::QEncode", "atlenc/ATL::QEncodeGetRequiredLength", "atlenc/ATL::QPDecode", "atlenc/ATL::QPDecodeGetRequiredLength", "atlenc/ATL::QPEncode", "atlenc/ATL::QPEncodeGetRequiredLength", "atlenc/ATL::UUDecode", "atlenc/ATL::UUDecodeGetRequiredLength", "atlenc/ATL::UUEncode", "atlenc/ATL::UUEncodeGetRequiredLength"] -ms.assetid: 2ae1648b-2b87-4112-92aa-0069fcfd23da --- # ATL Text Encoding Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions support text encoding and decoding. |Function|Description| diff --git a/docs/atl/reference/atl-typedefs.md b/docs/atl/reference/atl-typedefs.md index 471587e3278..28f4a79773f 100644 --- a/docs/atl/reference/atl-typedefs.md +++ b/docs/atl/reference/atl-typedefs.md @@ -4,10 +4,11 @@ title: "ATL Typedefs" ms.date: "11/04/2016" f1_keywords: ["atlcore/ATL::_ATL_BASE_MODULE", "atlbase/ATL::_ATL_COM_MODULE", "atlbase/ATL::_ATL_MODULE", "atlbase/ATL::_ATL_WIN_MODULE", "atlutil/ATL::ATL_URL_PORT", "atlbase/ATL::CComDispatchDriver", "atlbase/ATL::CComGlobalsThreadModel", "atlbase/ATL::CComObjectThreadModel", "atlwin/ATL::CContainedWindow", "atlpath/ATL::CPath", "atlpath/ATL::CPathA", "atlpath/ATL::CPathW", " atlsimpcoll/ATL::CSimpleValArray", " atlutil/ATL::LPCURL", "atlbase/ATL::DefaultThreadTraits", "atlutil/ATL::LPURL"] helpviewer_keywords: ["typedefs, ATL", "typedefs", "ATL, typedefs"] -ms.assetid: 7dd05baa-3efb-4e3b-af23-793c610f4560 --- # ATL Typedefs +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + The Active Template Library includes the following typedefs. |Typedef|Description| diff --git a/docs/atl/reference/atl-url-scheme-enum.md b/docs/atl/reference/atl-url-scheme-enum.md index fbed95cb013..8c6df2df608 100644 --- a/docs/atl/reference/atl-url-scheme-enum.md +++ b/docs/atl/reference/atl-url-scheme-enum.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL_URL_SCHEME" title: "ATL_URL_SCHEME enumeration" ms.date: "11/04/2016" helpviewer_keywords: ["ATLUTIL/ATL::ATL_URL_SCHEME"] -ms.assetid: f4131046-8ba0-4ec1-8209-84203f05d20e --- # ATL_URL_SCHEME +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + The members of this enumeration provide constants for the schemes understood by [CUrl](curl-class.md). ## Syntax diff --git a/docs/atl/reference/atl-win-module70-structure.md b/docs/atl/reference/atl-win-module70-structure.md index 4a053f0aecd..b5e717cbc3a 100644 --- a/docs/atl/reference/atl-win-module70-structure.md +++ b/docs/atl/reference/atl-win-module70-structure.md @@ -4,10 +4,11 @@ title: "_ATL_WIN_MODULE70 Structure" ms.date: "11/04/2016" f1_keywords: ["_ATL_WIN_MODULE70", "ATL::_ATL_WIN_MODULE70", "ATL._ATL_WIN_MODULE70"] helpviewer_keywords: ["_ATL_WIN_MODULE70 structure", "ATL_WIN_MODULE70 structure"] -ms.assetid: a0aaf3ea-ca77-46ec-bd53-4dfb61dffbea --- # _ATL_WIN_MODULE70 Structure +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Used by windowing code in ATL. ## Syntax diff --git a/docs/atl/reference/atl-wizards-and-dialog-boxes.md b/docs/atl/reference/atl-wizards-and-dialog-boxes.md index 0632227a113..0b3400f14d8 100644 --- a/docs/atl/reference/atl-wizards-and-dialog-boxes.md +++ b/docs/atl/reference/atl-wizards-and-dialog-boxes.md @@ -3,10 +3,11 @@ description: "Learn more about: ATL Wizards and Dialog Boxes" title: "ATL Wizards and Dialog Boxes" ms.date: "06/26/2020" helpviewer_keywords: ["ATL, class wizards"] -ms.assetid: 51cf002a-83bc-41ba-aeb8-364ea2331375 --- # ATL Wizards and Dialog Boxes +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + The Active Template Library (ATL) wizards generate boilerplate code for various kinds of COM objects. You can run the wizards by opening the shortcut menu for a project in **Solution Explorer** and choosing **Add**, **Class**. ## Related Articles diff --git a/docs/atl/reference/atlcreatewnddata-structure.md b/docs/atl/reference/atlcreatewnddata-structure.md index ab5f1b3cf66..ccef921db99 100644 --- a/docs/atl/reference/atlcreatewnddata-structure.md +++ b/docs/atl/reference/atlcreatewnddata-structure.md @@ -4,10 +4,11 @@ title: "_AtlCreateWndData Structure" ms.date: "11/04/2016" f1_keywords: ["ATL::_AtlCreateWndData", "ATL._AtlCreateWndData", "_AtlCreateWndData"] helpviewer_keywords: ["_AtlCreateWndData structure", "AtlCreateWndData structure"] -ms.assetid: 76ed5382-bfbf-4b8b-8a29-912688dfd2ae --- # _AtlCreateWndData Structure +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This structure contains class instance data in windowing code in ATL. ## Syntax diff --git a/docs/atl/reference/ca2aex-class.md b/docs/atl/reference/ca2aex-class.md index 17184ac1d4a..17355a4e6d8 100644 --- a/docs/atl/reference/ca2aex-class.md +++ b/docs/atl/reference/ca2aex-class.md @@ -4,10 +4,11 @@ title: "CA2AEX Class" ms.date: "11/04/2016" f1_keywords: ["CA2AEX", "ATLCONV/ATL::CA2AEX", "ATLCONV/ATL::CA2AEX::CA2AEX", "ATLCONV/ATL::CA2AEX::m_psz", "ATLCONV/ATL::CA2AEX::m_szBuffer"] helpviewer_keywords: ["CA2AEX class"] -ms.assetid: 57dc65df-d9cf-4a84-99d3-6e031dde3664 --- # CA2AEX Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is used by the string conversion macros CA2TEX and CT2AEX, and the typedef CA2A. > [!IMPORTANT] diff --git a/docs/atl/reference/ca2caex-class.md b/docs/atl/reference/ca2caex-class.md index 384efbd5ea5..74d94867f69 100644 --- a/docs/atl/reference/ca2caex-class.md +++ b/docs/atl/reference/ca2caex-class.md @@ -4,10 +4,11 @@ title: "CA2CAEX Class" ms.date: "11/04/2016" f1_keywords: ["CA2CAEX", "ATLCONV/ATL::CA2CAEX", "ATLCONV/ATL::CA2CAEX::CA2CAEX", "ATLCONV/ATL::CA2CAEX::m_psz"] helpviewer_keywords: ["CA2CAEX class"] -ms.assetid: 388e7c1d-a144-474c-a182-b15f69a74bd8 --- # CA2CAEX Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is used by string conversion macros CA2CTEX and CT2CAEX, and the typedef CA2CA. > [!IMPORTANT] diff --git a/docs/atl/reference/ca2wex-class.md b/docs/atl/reference/ca2wex-class.md index 6b350dc68cf..efe52c7c486 100644 --- a/docs/atl/reference/ca2wex-class.md +++ b/docs/atl/reference/ca2wex-class.md @@ -4,10 +4,11 @@ title: "CA2WEX Class" ms.date: "11/04/2016" f1_keywords: ["CA2WEX", "ATLCONV/ATL::CA2WEX", "ATLCONV/ATL::CA2WEX::CA2WEX", "ATLCONV/ATL::CA2WEX::m_psz", "ATLCONV/ATL::CA2WEX::m_szBuffer"] helpviewer_keywords: ["CA2WEX class"] -ms.assetid: 317d9ffb-e84f-47e8-beda-57e28fb19124 --- # CA2WEX Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is used by the string conversion macros CA2TEX, CA2CTEX, CT2WEX, and CT2CWEX, and the typedef CA2W. > [!IMPORTANT] diff --git a/docs/atl/reference/caccesstoken-class.md b/docs/atl/reference/caccesstoken-class.md index 49272bfcd4a..6cd58e432ee 100644 --- a/docs/atl/reference/caccesstoken-class.md +++ b/docs/atl/reference/caccesstoken-class.md @@ -4,10 +4,11 @@ title: "CAccessToken Class" ms.date: "07/02/2019" f1_keywords: ["CAccessToken", "ATLSECURITY/ATL::CAccessToken", "ATLSECURITY/ATL::CAccessToken::Attach", "ATLSECURITY/ATL::CAccessToken::CheckTokenMembership", "ATLSECURITY/ATL::CAccessToken::CreateImpersonationToken", "ATLSECURITY/ATL::CAccessToken::CreatePrimaryToken", "ATLSECURITY/ATL::CAccessToken::CreateProcessAsUser", "ATLSECURITY/ATL::CAccessToken::CreateRestrictedToken", "ATLSECURITY/ATL::CAccessToken::Detach", "ATLSECURITY/ATL::CAccessToken::DisablePrivilege", "ATLSECURITY/ATL::CAccessToken::DisablePrivileges", "ATLSECURITY/ATL::CAccessToken::EnablePrivilege", "ATLSECURITY/ATL::CAccessToken::EnablePrivileges", "ATLSECURITY/ATL::CAccessToken::GetDefaultDacl", "ATLSECURITY/ATL::CAccessToken::GetEffectiveToken", "ATLSECURITY/ATL::CAccessToken::GetGroups", "ATLSECURITY/ATL::CAccessToken::GetHandle", "ATLSECURITY/ATL::CAccessToken::GetImpersonationLevel", "ATLSECURITY/ATL::CAccessToken::GetLogonSessionId", "ATLSECURITY/ATL::CAccessToken::GetLogonSid", "ATLSECURITY/ATL::CAccessToken::GetOwner", "ATLSECURITY/ATL::CAccessToken::GetPrimaryGroup", "ATLSECURITY/ATL::CAccessToken::GetPrivileges", "ATLSECURITY/ATL::CAccessToken::GetProcessToken", "ATLSECURITY/ATL::CAccessToken::GetProfile", "ATLSECURITY/ATL::CAccessToken::GetSource", "ATLSECURITY/ATL::CAccessToken::GetStatistics", "ATLSECURITY/ATL::CAccessToken::GetTerminalServicesSessionId", "ATLSECURITY/ATL::CAccessToken::GetThreadToken", "ATLSECURITY/ATL::CAccessToken::GetTokenId", "ATLSECURITY/ATL::CAccessToken::GetType", "ATLSECURITY/ATL::CAccessToken::GetUser", "ATLSECURITY/ATL::CAccessToken::HKeyCurrentUser", "ATLSECURITY/ATL::CAccessToken::Impersonate", "ATLSECURITY/ATL::CAccessToken::ImpersonateLoggedOnUser", "ATLSECURITY/ATL::CAccessToken::IsTokenRestricted", "ATLSECURITY/ATL::CAccessToken::LoadUserProfile", "ATLSECURITY/ATL::CAccessToken::LogonUser", "ATLSECURITY/ATL::CAccessToken::OpenCOMClientToken", "ATLSECURITY/ATL::CAccessToken::OpenNamedPipeClientToken", "ATLSECURITY/ATL::CAccessToken::OpenRPCClientToken", "ATLSECURITY/ATL::CAccessToken::OpenThreadToken", "ATLSECURITY/ATL::CAccessToken::PrivilegeCheck", "ATLSECURITY/ATL::CAccessToken::Revert", "ATLSECURITY/ATL::CAccessToken::SetDefaultDacl", "ATLSECURITY/ATL::CAccessToken::SetOwner", "ATLSECURITY/ATL::CAccessToken::SetPrimaryGroup"] helpviewer_keywords: ["CAccessToken class"] -ms.assetid: bb5c5945-56a5-4083-b442-76573cee83ab --- # CAccessToken Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for an access token. > [!IMPORTANT] diff --git a/docs/atl/reference/cacl-class.md b/docs/atl/reference/cacl-class.md index 1521ad15fe8..49733e001d4 100644 --- a/docs/atl/reference/cacl-class.md +++ b/docs/atl/reference/cacl-class.md @@ -4,10 +4,11 @@ title: "CAcl Class" ms.date: "11/04/2016" f1_keywords: ["CAcl", "ATLSECURITY/ATL::CAcl", "ATLSECURITY/ATL::CAcl::CAccessMaskArray", "ATLSECURITY/ATL::CAcl::CAceFlagArray", "ATLSECURITY/ATL::CAcl::CAceTypeArray", "ATLSECURITY/ATL::CAcl::CAcl", "ATLSECURITY/ATL::CAcl::GetAceCount", "ATLSECURITY/ATL::CAcl::GetAclEntries", "ATLSECURITY/ATL::CAcl::GetAclEntry", "ATLSECURITY/ATL::CAcl::GetLength", "ATLSECURITY/ATL::CAcl::GetPACL", "ATLSECURITY/ATL::CAcl::IsEmpty", "ATLSECURITY/ATL::CAcl::IsNull", "ATLSECURITY/ATL::CAcl::RemoveAce", "ATLSECURITY/ATL::CAcl::RemoveAces", "ATLSECURITY/ATL::CAcl::SetEmpty", "ATLSECURITY/ATL::CAcl::SetNull"] helpviewer_keywords: ["CAcl class"] -ms.assetid: 20bcb9af-dc1c-4737-b923-3864776680d6 --- # CAcl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for an `ACL` (access-control list) structure. > [!IMPORTANT] diff --git a/docs/atl/reference/cadapt-class.md b/docs/atl/reference/cadapt-class.md index e3596e34f0d..010fa0f3f7f 100644 --- a/docs/atl/reference/cadapt-class.md +++ b/docs/atl/reference/cadapt-class.md @@ -4,10 +4,11 @@ title: "CAdapt Class" ms.date: "11/04/2016" f1_keywords: ["CAdapt", "ATLCOMCLI/ATL::CAdapt", "ATLCOMCLI/ATL::CAdapt::CAdapt", "ATLCOMCLI/ATL::CAdapt::m_T"] helpviewer_keywords: ["address-of operator", "adapter objects", "& operator, address-of operator", "CAdapt class"] -ms.assetid: 0bb695a5-72fe-43d1-8f39-7e4da6e34765 --- # CAdapt Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This template is used to wrap classes that redefine the address-of operator to return something other than the address of the object. ## Syntax diff --git a/docs/atl/reference/category-macros.md b/docs/atl/reference/category-macros.md index 2520af59602..c6339244da1 100644 --- a/docs/atl/reference/category-macros.md +++ b/docs/atl/reference/category-macros.md @@ -3,10 +3,11 @@ description: "Learn more about: Category Macros" title: "Category Macros" ms.date: "11/04/2016" f1_keywords: ["ATLCOM/BEGIN_CATEGORY_MAP", "ATLCOM/END_CATEGORY_MAP", "ATLCOM/IMPLEMENTED_CATEGORY", "ATLCOM/REQUIRED_CATEGORY", "atlcom/ATL::BEGIN_CATEGORY_MAP", "atlcom/ATL::END_CATEGORY_MAP", "atlcom/ATL::IMPLEMENTED_CATEGORY", "atlcom/ATL::REQUIRED_CATEGORY"] -ms.assetid: 223578cb-6180-4787-a8d8-ba3787a5d3ee --- # Category Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros define category maps. |Macro|Description| diff --git a/docs/atl/reference/catlarray-class.md b/docs/atl/reference/catlarray-class.md index e2ff7b40f54..9a7af00b550 100644 --- a/docs/atl/reference/catlarray-class.md +++ b/docs/atl/reference/catlarray-class.md @@ -4,10 +4,11 @@ title: "CAtlArray Class" ms.date: "11/04/2016" f1_keywords: ["CAtlArray", "ATLCOLL/ATL::CAtlArray", "ATLCOLL/ATL::Add", "ATLCOLL/ATL::Append", "ATLCOLL/ATL::AssertValid", "ATLCOLL/ATL::Copy", "ATLCOLL/ATL::FreeExtra", "ATLCOLL/ATL::GetAt", "ATLCOLL/ATL::GetCount", "ATLCOLL/ATL::GetData", "ATLCOLL/ATL::InsertArrayAt", "ATLCOLL/ATL::InsertAt", "ATLCOLL/ATL::IsEmpty", "ATLCOLL/ATL::RemoveAll", "ATLCOLL/ATL::RemoveAt", "ATLCOLL/ATL::SetAt", "ATLCOLL/ATL::SetAtGrow", "ATLCOLL/ATL::SetCount", "ATLCOLL/ATL::INARGTYPE", "ATLCOLL/ATL::OUTARGTYPE"] helpviewer_keywords: ["CAtlArray class"] -ms.assetid: 0b503aa8-2357-40af-a326-6654bf1da098 --- # CAtlArray Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements an array object. ## Syntax diff --git a/docs/atl/reference/catlautothreadmodule-class.md b/docs/atl/reference/catlautothreadmodule-class.md index ad171cbf113..fde8b27ac04 100644 --- a/docs/atl/reference/catlautothreadmodule-class.md +++ b/docs/atl/reference/catlautothreadmodule-class.md @@ -4,10 +4,11 @@ title: "CAtlAutoThreadModule Class" ms.date: "11/04/2016" f1_keywords: ["CAtlAutoThreadModule", "atlbase/ATL::CAtlAutoThreadModule"] helpviewer_keywords: ["CAtlAutoThreadModule class"] -ms.assetid: 3be834aa-55ef-403e-94ae-41979691b15f --- # CAtlAutoThreadModule Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements a thread-pooled, apartment-model COM server. > [!IMPORTANT] diff --git a/docs/atl/reference/catlautothreadmodulet-class.md b/docs/atl/reference/catlautothreadmodulet-class.md index b3551f67c25..fdc99205556 100644 --- a/docs/atl/reference/catlautothreadmodulet-class.md +++ b/docs/atl/reference/catlautothreadmodulet-class.md @@ -4,10 +4,11 @@ title: "CAtlAutoThreadModuleT Class" ms.date: "11/04/2016" f1_keywords: ["CAtlAutoThreadModuleT", "ATLBASE/ATL::CAtlAutoThreadModuleT", "ATLBASE/ATL::CAtlAutoThreadModuleT::GetDefaultThreads"] helpviewer_keywords: ["CAtlAutoThreadModuleT class"] -ms.assetid: ae1667c6-3fb8-47bc-b35d-9ea5e9896d7f --- # CAtlAutoThreadModuleT Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for implementing a thread-pooled, apartment-model COM server. > [!IMPORTANT] diff --git a/docs/atl/reference/catlbasemodule-class.md b/docs/atl/reference/catlbasemodule-class.md index ca75cf7b50b..1126d5109ea 100644 --- a/docs/atl/reference/catlbasemodule-class.md +++ b/docs/atl/reference/catlbasemodule-class.md @@ -4,10 +4,11 @@ title: "CAtlBaseModule Class" ms.date: "11/04/2016" f1_keywords: ["CAtlBaseModule", "ATLCORE/ATL::CAtlBaseModule", "ATLCORE/ATL::CAtlBaseModule::CAtlBaseModule", "ATLCORE/ATL::CAtlBaseModule::AddResourceInstance", "ATLCORE/ATL::CAtlBaseModule::GetHInstanceAt", "ATLCORE/ATL::CAtlBaseModule::GetModuleInstance", "ATLCORE/ATL::CAtlBaseModule::GetResourceInstance", "ATLCORE/ATL::CAtlBaseModule::RemoveResourceInstance", "ATLCORE/ATL::CAtlBaseModule::SetResourceInstance", "ATLCORE/ATL::CAtlBaseModule::m_bInitFailed"] helpviewer_keywords: ["CAtlBaseModule class"] -ms.assetid: 55ade80c-9b0c-4c51-933e-2158436c1096 --- # CAtlBaseModule Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is instantiated in every ATL project. ## Syntax diff --git a/docs/atl/reference/catlcommodule-class.md b/docs/atl/reference/catlcommodule-class.md index ec1824a9769..cb307e817bc 100644 --- a/docs/atl/reference/catlcommodule-class.md +++ b/docs/atl/reference/catlcommodule-class.md @@ -4,10 +4,11 @@ title: "CAtlComModule Class" ms.date: "11/04/2016" f1_keywords: ["CAtlComModule", "ATLBASE/ATL::CAtlComModule", "ATLBASE/ATL::CAtlComModule::CAtlComModule", "ATLBASE/ATL::CAtlComModule::RegisterServer", "ATLBASE/ATL::CAtlComModule::RegisterTypeLib", "ATLBASE/ATL::CAtlComModule::UnregisterServer", "ATLBASE/ATL::CAtlComModule::UnRegisterTypeLib"] helpviewer_keywords: ["CAtlComModule class"] -ms.assetid: af5dd71a-a0d1-4a2e-9a24-154a03381c75 --- # CAtlComModule Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements a COM server module. ## Syntax diff --git a/docs/atl/reference/catldebuginterfacesmodule-class.md b/docs/atl/reference/catldebuginterfacesmodule-class.md index 38a674b3e7c..ff00c86e3c5 100644 --- a/docs/atl/reference/catldebuginterfacesmodule-class.md +++ b/docs/atl/reference/catldebuginterfacesmodule-class.md @@ -4,10 +4,11 @@ title: "CAtlDebugInterfacesModule Class" ms.date: "11/04/2016" f1_keywords: ["CAtlDebugInterfacesModule", "atlbase/ATL::CAtlDebugInterfacesModule"] helpviewer_keywords: ["_ATL_DEBUG_QI macro", "CAtlDebugInterfacesModule class"] -ms.assetid: a193b567-8191-4115-a963-a10805972bac --- # CAtlDebugInterfacesModule Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides support for debugging interfaces. ## Syntax diff --git a/docs/atl/reference/catldllmodulet-class.md b/docs/atl/reference/catldllmodulet-class.md index af960db0ee0..95c947d68cd 100644 --- a/docs/atl/reference/catldllmodulet-class.md +++ b/docs/atl/reference/catldllmodulet-class.md @@ -4,10 +4,11 @@ title: "CAtlDllModuleT Class" ms.date: "11/04/2016" f1_keywords: ["CAtlDllModuleT", "ATLBASE/ATL::CAtlDllModuleT", "ATLBASE/ATL::CAtlDllModuleT::CAtlDllModuleT", "ATLBASE/ATL::CAtlDllModuleT::DllCanUnloadNow", "ATLBASE/ATL::CAtlDllModuleT::DllGetClassObject", "ATLBASE/ATL::CAtlDllModuleT::DllMain", "ATLBASE/ATL::CAtlDllModuleT::DllRegisterServer", "ATLBASE/ATL::CAtlDllModuleT::DllUnregisterServer", "ATLBASE/ATL::CAtlDllModuleT::GetClassObject"] helpviewer_keywords: ["CAtlDllModuleT class"] -ms.assetid: 351d5767-8257-4878-94be-45a85e31a72d --- # CAtlDllModuleT Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents the module for a DLL. ## Syntax diff --git a/docs/atl/reference/catlexception-class.md b/docs/atl/reference/catlexception-class.md index 5549aa2ab77..584270063fc 100644 --- a/docs/atl/reference/catlexception-class.md +++ b/docs/atl/reference/catlexception-class.md @@ -4,10 +4,11 @@ title: "CAtlException Class" ms.date: "11/04/2016" f1_keywords: ["CAtlException", "ATLEXCEPT/ATL::CAtlException", "ATLEXCEPT/ATL::CAtlException::CAtlException", "ATLEXCEPT/ATL::CAtlException::m_hr"] helpviewer_keywords: ["CAtlException class"] -ms.assetid: 3fd7b041-f70d-4292-b947-0d70781d95a8 --- # CAtlException Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class defines an ATL exception. ## Syntax diff --git a/docs/atl/reference/catlexemodulet-class.md b/docs/atl/reference/catlexemodulet-class.md index 9d191306d99..fa15ff7dee1 100644 --- a/docs/atl/reference/catlexemodulet-class.md +++ b/docs/atl/reference/catlexemodulet-class.md @@ -4,10 +4,11 @@ title: "CAtlExeModuleT Class" ms.date: "11/04/2016" f1_keywords: ["CAtlExeModuleT", "ATLBASE/ATL::CAtlExeModuleT", "ATLBASE/ATL::CAtlExeModuleT::CAtlExeModuleT", "ATLBASE/ATL::CAtlExeModuleT::InitializeCom", "ATLBASE/ATL::CAtlExeModuleT::ParseCommandLine", "ATLBASE/ATL::CAtlExeModuleT::PostMessageLoop", "ATLBASE/ATL::CAtlExeModuleT::PreMessageLoop", "ATLBASE/ATL::CAtlExeModuleT::RegisterClassObjects", "ATLBASE/ATL::CAtlExeModuleT::RevokeClassObjects", "ATLBASE/ATL::CAtlExeModuleT::Run", "ATLBASE/ATL::CAtlExeModuleT::RunMessageLoop", "ATLBASE/ATL::CAtlExeModuleT::UninitializeCom", "ATLBASE/ATL::CAtlExeModuleT::Unlock", "ATLBASE/ATL::CAtlExeModuleT::WinMain", "ATLBASE/ATL::CAtlExeModuleT::m_bDelayShutdown", "ATLBASE/ATL::CAtlExeModuleT::m_dwPause", "ATLBASE/ATL::CAtlExeModuleT::m_dwTimeOut"] helpviewer_keywords: ["CAtlExeModuleT class"] -ms.assetid: 82245f3d-91d4-44fa-aa86-7cc7fbd758d9 --- # CAtlExeModuleT Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents the module for an application. ## Syntax diff --git a/docs/atl/reference/catlfile-class.md b/docs/atl/reference/catlfile-class.md index bbc448b9790..d959d4b8c38 100644 --- a/docs/atl/reference/catlfile-class.md +++ b/docs/atl/reference/catlfile-class.md @@ -4,10 +4,11 @@ title: "CAtlFile Class" ms.date: "11/04/2016" f1_keywords: ["CAtlFile", "ATLFILE/ATL::CAtlFile", "ATLFILE/ATL::CAtlFile::CAtlFile", "ATLFILE/ATL::CAtlFile::Create", "ATLFILE/ATL::CAtlFile::Flush", "ATLFILE/ATL::CAtlFile::GetOverlappedResult", "ATLFILE/ATL::CAtlFile::GetPosition", "ATLFILE/ATL::CAtlFile::GetSize", "ATLFILE/ATL::CAtlFile::LockRange", "ATLFILE/ATL::CAtlFile::Read", "ATLFILE/ATL::CAtlFile::Seek", "ATLFILE/ATL::CAtlFile::SetSize", "ATLFILE/ATL::CAtlFile::UnlockRange", "ATLFILE/ATL::CAtlFile::Write", "ATLFILE/ATL::CAtlFile::m_pTM"] helpviewer_keywords: ["CAtlFile class"] -ms.assetid: 93ed160b-af2a-448c-9cbe-e5fa46c199bb --- # CAtlFile Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a thin wrapper around the Windows file-handling API. > [!IMPORTANT] diff --git a/docs/atl/reference/catlfilemapping-class.md b/docs/atl/reference/catlfilemapping-class.md index 8eebfc290c1..db442ec69fb 100644 --- a/docs/atl/reference/catlfilemapping-class.md +++ b/docs/atl/reference/catlfilemapping-class.md @@ -4,10 +4,11 @@ title: "CAtlFileMapping Class" ms.date: "11/04/2016" f1_keywords: ["CAtlFileMapping", "atlfile/ATL::CAtlFileMapping"] helpviewer_keywords: ["CAtlFileMapping class"] -ms.assetid: 899fc058-e05e-48b5-aca9-340403bb9e26 --- # CAtlFileMapping Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a memory-mapped file, adding a cast operator to the methods of [CAtlFileMappingBase](../../atl/reference/catlfilemappingbase-class.md). > [!IMPORTANT] diff --git a/docs/atl/reference/catlfilemappingbase-class.md b/docs/atl/reference/catlfilemappingbase-class.md index f7084aa9571..b2bc6e3c4e5 100644 --- a/docs/atl/reference/catlfilemappingbase-class.md +++ b/docs/atl/reference/catlfilemappingbase-class.md @@ -4,10 +4,11 @@ title: "CAtlFileMappingBase Class" ms.date: "11/04/2016" f1_keywords: ["CAtlFileMappingBase", "ATLFILE/ATL::CAtlFileMappingBase", "ATLFILE/ATL::CAtlFileMappingBase::CAtlFileMappingBase", "ATLFILE/ATL::CAtlFileMappingBase::CopyFrom", "ATLFILE/ATL::CAtlFileMappingBase::GetData", "ATLFILE/ATL::CAtlFileMappingBase::GetHandle", "ATLFILE/ATL::CAtlFileMappingBase::GetMappingSize", "ATLFILE/ATL::CAtlFileMappingBase::MapFile", "ATLFILE/ATL::CAtlFileMappingBase::MapSharedMem", "ATLFILE/ATL::CAtlFileMappingBase::OpenMapping", "ATLFILE/ATL::CAtlFileMappingBase::Unmap"] helpviewer_keywords: ["CAtlFileMappingBase class"] -ms.assetid: be555723-2790-4f57-a8fb-be4d68460775 --- # CAtlFileMappingBase Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a memory-mapped file. > [!IMPORTANT] diff --git a/docs/atl/reference/catllist-class.md b/docs/atl/reference/catllist-class.md index 6b1fc2ce91e..a5cada88bd7 100644 --- a/docs/atl/reference/catllist-class.md +++ b/docs/atl/reference/catllist-class.md @@ -4,10 +4,11 @@ title: "CAtlList Class" ms.date: "11/04/2016" f1_keywords: ["CAtlList", "ATLCOLL/ATL::CAtlList", "ATLCOLL/ATL::CAtlList::INARGTYPE", "ATLCOLL/ATL::CAtlList::CAtlList", "ATLCOLL/ATL::CAtlList::AddHead", "ATLCOLL/ATL::CAtlList::AddHeadList", "ATLCOLL/ATL::CAtlList::AddTail", "ATLCOLL/ATL::CAtlList::AddTailList", "ATLCOLL/ATL::CAtlList::AssertValid", "ATLCOLL/ATL::CAtlList::Find", "ATLCOLL/ATL::CAtlList::FindIndex", "ATLCOLL/ATL::CAtlList::GetAt", "ATLCOLL/ATL::CAtlList::GetCount", "ATLCOLL/ATL::CAtlList::GetHead", "ATLCOLL/ATL::CAtlList::GetHeadPosition", "ATLCOLL/ATL::CAtlList::GetNext", "ATLCOLL/ATL::CAtlList::GetPrev", "ATLCOLL/ATL::CAtlList::GetTail", "ATLCOLL/ATL::CAtlList::GetTailPosition", "ATLCOLL/ATL::CAtlList::InsertAfter", "ATLCOLL/ATL::CAtlList::InsertBefore", "ATLCOLL/ATL::CAtlList::IsEmpty", "ATLCOLL/ATL::CAtlList::MoveToHead", "ATLCOLL/ATL::CAtlList::MoveToTail", "ATLCOLL/ATL::CAtlList::RemoveAll", "ATLCOLL/ATL::CAtlList::RemoveAt", "ATLCOLL/ATL::CAtlList::RemoveHead", "ATLCOLL/ATL::CAtlList::RemoveHeadNoReturn", "ATLCOLL/ATL::CAtlList::RemoveTail", "ATLCOLL/ATL::CAtlList::RemoveTailNoReturn", "ATLCOLL/ATL::CAtlList::SetAt", "ATLCOLL/ATL::CAtlList::SwapElements"] helpviewer_keywords: ["CAtlList class"] -ms.assetid: 09e98053-64b2-4efa-99ab-d0542caaf981 --- # CAtlList Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for creating and managing a list object. ## Syntax diff --git a/docs/atl/reference/catlmap-class.md b/docs/atl/reference/catlmap-class.md index b9273b02c8e..1801355e86b 100644 --- a/docs/atl/reference/catlmap-class.md +++ b/docs/atl/reference/catlmap-class.md @@ -4,10 +4,11 @@ title: "CAtlMap Class" ms.date: "11/04/2016" f1_keywords: ["CAtlMap", "ATLCOLL/ATL::CAtlMap", "ATLCOLL/ATL::CAtlMap::KINARGTYPE", "ATLCOLL/ATL::CAtlMap::KOUTARGTYPE", "ATLCOLL/ATL::CAtlMap::VINARGTYPE", "ATLCOLL/ATL::CAtlMap::VOUTARGTYPE", "ATLCOLL/ATL::CPair::m_key", "ATLCOLL/ATL::CPair::m_value", "ATLCOLL/ATL::CAtlMap::CAtlMap", "ATLCOLL/ATL::CAtlMap::AssertValid", "ATLCOLL/ATL::CAtlMap::DisableAutoRehash", "ATLCOLL/ATL::CAtlMap::EnableAutoRehash", "ATLCOLL/ATL::CAtlMap::GetAt", "ATLCOLL/ATL::CAtlMap::GetCount", "ATLCOLL/ATL::CAtlMap::GetHashTableSize", "ATLCOLL/ATL::CAtlMap::GetKeyAt", "ATLCOLL/ATL::CAtlMap::GetNext", "ATLCOLL/ATL::CAtlMap::GetNextAssoc", "ATLCOLL/ATL::CAtlMap::GetNextKey", "ATLCOLL/ATL::CAtlMap::GetNextValue", "ATLCOLL/ATL::CAtlMap::GetStartPosition", "ATLCOLL/ATL::CAtlMap::GetValueAt", "ATLCOLL/ATL::CAtlMap::InitHashTable", "ATLCOLL/ATL::CAtlMap::IsEmpty", "ATLCOLL/ATL::CAtlMap::Lookup", "ATLCOLL/ATL::CAtlMap::Rehash", "ATLCOLL/ATL::CAtlMap::RemoveAll", "ATLCOLL/ATL::CAtlMap::RemoveAtPos", "ATLCOLL/ATL::CAtlMap::RemoveKey", "ATLCOLL/ATL::CAtlMap::SetAt", "ATLCOLL/ATL::CAtlMap::SetOptimalLoad", "ATLCOLL/ATL::CAtlMap::SetValueAt"] helpviewer_keywords: ["CAtlMap class"] -ms.assetid: 5e2fe028-8e6d-4686-93df-1433d2080ec3 --- # CAtlMap Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for creating and managing a map object. ## Syntax diff --git a/docs/atl/reference/catlmodule-class.md b/docs/atl/reference/catlmodule-class.md index 637193f3c88..2136b7f2d94 100644 --- a/docs/atl/reference/catlmodule-class.md +++ b/docs/atl/reference/catlmodule-class.md @@ -4,10 +4,11 @@ title: "CAtlModule Class" ms.date: "11/04/2016" f1_keywords: ["CAtlModule", "ATLBASE/ATL::CAtlModule", "ATLBASE/ATL::CAtlModule::CAtlModule", "ATLBASE/ATL::CAtlModule::AddCommonRGSReplacements", "ATLBASE/ATL::CAtlModule::AddTermFunc", "ATLBASE/ATL::CAtlModule::GetGITPtr", "ATLBASE/ATL::CAtlModule::GetLockCount", "ATLBASE/ATL::CAtlModule::Lock", "ATLBASE/ATL::CAtlModule::Term", "ATLBASE/ATL::CAtlModule::Unlock", "ATLBASE/ATL::CAtlModule::UpdateRegistryFromResourceD", "ATLBASE/ATL::CAtlModule::UpdateRegistryFromResourceDHelper", "ATLBASE/ATL::CAtlModule::UpdateRegistryFromResourceS", "ATLBASE/ATL::CAtlModule::m_libid", "ATLBASE/ATL::CAtlModule::m_pGIT"] helpviewer_keywords: ["CAtlModule class"] -ms.assetid: 63fe02f1-4c4b-4e7c-ae97-7ad7b4252415 --- # CAtlModule Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods used by several ATL module classes. ## Syntax diff --git a/docs/atl/reference/catlmodulet-class.md b/docs/atl/reference/catlmodulet-class.md index aeddee3c887..d8cc2b1db58 100644 --- a/docs/atl/reference/catlmodulet-class.md +++ b/docs/atl/reference/catlmodulet-class.md @@ -4,10 +4,11 @@ title: "CAtlModuleT Class" ms.date: "11/04/2016" f1_keywords: ["CAtlModuleT", "ATLBASE/ATL::CAtlModuleT", "ATLBASE/ATL::CAtlModuleT::CAtlModuleT", "ATLBASE/ATL::CAtlModuleT::InitLibId", "ATLBASE/ATL::CAtlModuleT::RegisterAppId", "ATLBASE/ATL::CAtlModuleT::RegisterServer", "ATLBASE/ATL::CAtlModuleT::UnregisterAppId", "ATLBASE/ATL::CAtlModuleT::UnregisterServer", "ATLBASE/ATL::CAtlModuleT::UpdateRegistryAppId"] helpviewer_keywords: ["CAtlModuleT class"] -ms.assetid: 9b74d02f-9117-47b1-a05e-c5945f83dd2b --- # CAtlModuleT Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements an ATL module. ## Syntax diff --git a/docs/atl/reference/catlpreviewctrlimpl-class.md b/docs/atl/reference/catlpreviewctrlimpl-class.md index 2f2fc09617b..c5e24db6ba6 100644 --- a/docs/atl/reference/catlpreviewctrlimpl-class.md +++ b/docs/atl/reference/catlpreviewctrlimpl-class.md @@ -4,10 +4,11 @@ title: "CAtlPreviewCtrlImpl Class" ms.date: "11/04/2016" f1_keywords: ["CAtlPreviewCtrlImpl", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::CAtlPreviewCtrlImpl", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::Create", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::Destroy", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::Focus", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::OnPaint", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::Redraw", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::SetHost", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::SetPreviewVisuals", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::SetRect", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::DoPaint", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::m_plf", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::m_clrBack", "ATLPREVIEWCTRLIMPL/ATL::CAtlPreviewCtrlImpl::m_clrText"] helpviewer_keywords: ["CAtlPreviewCtrlImpl class"] -ms.assetid: 39b3299e-07e4-4abc-9b6e-b54bfa3b0802 --- # CAtlPreviewCtrlImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is an ATL implementation of a window that is placed on a host window provided by the Shell for Rich Preview. > [!IMPORTANT] diff --git a/docs/atl/reference/catlservicemodulet-class.md b/docs/atl/reference/catlservicemodulet-class.md index 8931b815121..19c51da62bc 100644 --- a/docs/atl/reference/catlservicemodulet-class.md +++ b/docs/atl/reference/catlservicemodulet-class.md @@ -4,10 +4,11 @@ title: "CAtlServiceModuleT Class" ms.date: "05/06/2019" f1_keywords: ["CAtlServiceModuleT", "ATLBASE/ATL::CAtlServiceModuleT", "ATLBASE/ATL::CAtlServiceModuleT::CAtlServiceModuleT", "ATLBASE/ATL::CAtlServiceModuleT::Handler", "ATLBASE/ATL::CAtlServiceModuleT::InitializeSecurity", "ATLBASE/ATL::CAtlServiceModuleT::Install", "ATLBASE/ATL::CAtlServiceModuleT::IsInstalled", "ATLBASE/ATL::CAtlServiceModuleT::LogEvent", "ATLBASE/ATL::CAtlServiceModuleT::OnContinue", "ATLBASE/ATL::CAtlServiceModuleT::OnInterrogate", "ATLBASE/ATL::CAtlServiceModuleT::OnPause", "ATLBASE/ATL::CAtlServiceModuleT::OnShutdown", "ATLBASE/ATL::CAtlServiceModuleT::OnStop", "ATLBASE/ATL::CAtlServiceModuleT::OnUnknownRequest", "ATLBASE/ATL::CAtlServiceModuleT::ParseCommandLine", "ATLBASE/ATL::CAtlServiceModuleT::PreMessageLoop", "ATLBASE/ATL::CAtlServiceModuleT::RegisterAppId", "ATLBASE/ATL::CAtlServiceModuleT::Run", "ATLBASE/ATL::CAtlServiceModuleT::ServiceMain", "ATLBASE/ATL::CAtlServiceModuleT::SetServiceStatus", "ATLBASE/ATL::CAtlServiceModuleT::Start", "ATLBASE/ATL::CAtlServiceModuleT::Uninstall", "ATLBASE/ATL::CAtlServiceModuleT::Unlock", "ATLBASE/ATL::CAtlServiceModuleT::UnregisterAppId", "ATLBASE/ATL::CAtlServiceModuleT::WinMain", "ATLBASE/ATL::CAtlServiceModuleT::m_bService", "ATLBASE/ATL::CAtlServiceModuleT::m_dwThreadID", "ATLBASE/ATL::CAtlServiceModuleT::m_hServiceStatus", "ATLBASE/ATL::CAtlServiceModuleT::m_status", "ATLBASE/ATL::CAtlServiceModuleT::m_szServiceName"] helpviewer_keywords: ["CAtlServiceModuleT class"] -ms.assetid: 8fc753ce-4a50-402b-9b4a-0a4ce5dd496c --- # CAtlServiceModuleT Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements a service. > [!IMPORTANT] diff --git a/docs/atl/reference/catltemporaryfile-class.md b/docs/atl/reference/catltemporaryfile-class.md index 9878d4a0d93..597aaba7e09 100644 --- a/docs/atl/reference/catltemporaryfile-class.md +++ b/docs/atl/reference/catltemporaryfile-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CAtlTemporaryFile class"] --- # CAtlTemporaryFile Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for the creation and use of a temporary file. > [!IMPORTANT] diff --git a/docs/atl/reference/catltransactionmanager-class.md b/docs/atl/reference/catltransactionmanager-class.md index 4c4430bf45b..4eec9cfe549 100644 --- a/docs/atl/reference/catltransactionmanager-class.md +++ b/docs/atl/reference/catltransactionmanager-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CAtlTransactionManager class"] --- # CAtlTransactionManager Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + CAtlTransactionManager class provides a wrapper to Kernel Transaction Manager (KTM) functions. > [!IMPORTANT] diff --git a/docs/atl/reference/catlwinmodule-class.md b/docs/atl/reference/catlwinmodule-class.md index fe46bab7a8f..dfd3f356a9a 100644 --- a/docs/atl/reference/catlwinmodule-class.md +++ b/docs/atl/reference/catlwinmodule-class.md @@ -4,10 +4,11 @@ title: "CAtlWinModule Class" ms.date: "11/04/2016" f1_keywords: ["CAtlWinModule", "ATLBASE/ATL::CAtlWinModule", "ATLBASE/ATL::CAtlWinModule::CAtlWinModule", "ATLBASE/ATL::CAtlWinModule::AddCreateWndData", "ATLBASE/ATL::CAtlWinModule::ExtractCreateWndData"] helpviewer_keywords: ["CAtlWinModule class"] -ms.assetid: 7ec844af-0f68-4a34-b0c8-9de50a025df0 --- # CAtlWinModule Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides support for ATL windowing components. > [!IMPORTANT] diff --git a/docs/atl/reference/cautoptr-class.md b/docs/atl/reference/cautoptr-class.md index ec51839b4b2..69c6edfac9f 100644 --- a/docs/atl/reference/cautoptr-class.md +++ b/docs/atl/reference/cautoptr-class.md @@ -4,10 +4,11 @@ title: "CAutoPtr class" ms.date: "11/04/2016" f1_keywords: ["CAutoPtr", "ATLBASE/ATL::CAutoPtr", "ATLBASE/ATL::CAutoPtr::CAutoPtr", "ATLBASE/ATL::CAutoPtr::Attach", "ATLBASE/ATL::CAutoPtr::Detach", "ATLBASE/ATL::CAutoPtr::Free", "ATLBASE/ATL::CAutoPtr::m_p"] helpviewer_keywords: ["CAutoPtr class"] -ms.assetid: 08988d53-4fb0-4711-bdfc-8ac29c63f410 --- # `CAutoPtr` class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a smart pointer object. > [!IMPORTANT] diff --git a/docs/atl/reference/cautoptrarray-class.md b/docs/atl/reference/cautoptrarray-class.md index cadb53e14a1..ab3616b4920 100644 --- a/docs/atl/reference/cautoptrarray-class.md +++ b/docs/atl/reference/cautoptrarray-class.md @@ -4,10 +4,11 @@ title: "CAutoPtrArray Class" ms.date: "11/04/2016" f1_keywords: ["CAutoPtrArray", "ATLCOLL/ATL::CAutoPtrArray", "ATLCOLL/ATL::CAutoPtrArray::CAutoPtrArray"] helpviewer_keywords: ["CAutoPtrArray class"] -ms.assetid: 880a70da-8c81-4427-8ac6-49aa8d424244 --- # CAutoPtrArray Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods useful when constructing an array of smart pointers. > [!IMPORTANT] diff --git a/docs/atl/reference/cautoptrelementtraits-class.md b/docs/atl/reference/cautoptrelementtraits-class.md index 90b8dbbea8c..5d2f5125152 100644 --- a/docs/atl/reference/cautoptrelementtraits-class.md +++ b/docs/atl/reference/cautoptrelementtraits-class.md @@ -4,10 +4,11 @@ title: "CAutoPtrElementTraits Class" ms.date: "11/04/2016" f1_keywords: ["CAutoPtrElementTraits", "ATLCOLL/ATL::CAutoPtrElementTraits", "ATLCOLL/ATL::CAutoPtrElementTraits::INARGTYPE", "ATLCOLL/ATL::CAutoPtrElementTraits::OUTARGTYPE"] helpviewer_keywords: ["CAutoPtrElementTraits class"] -ms.assetid: 777c1b14-6ab7-491f-b9a5-be149e71d4a2 --- # CAutoPtrElementTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods, static functions, and typedefs useful when creating collections of smart pointers. > [!IMPORTANT] diff --git a/docs/atl/reference/cautoptrlist-class.md b/docs/atl/reference/cautoptrlist-class.md index c2b8e2a7d2a..9f1ae599de9 100644 --- a/docs/atl/reference/cautoptrlist-class.md +++ b/docs/atl/reference/cautoptrlist-class.md @@ -4,10 +4,11 @@ title: "CAutoPtrList Class" ms.date: "11/04/2016" f1_keywords: ["CAutoPtrList", "ATLCOLL/ATL::CAutoPtrList", "ATLCOLL/ATL::CAutoPtrList::CAutoPtrList"] helpviewer_keywords: ["CAutoPtrList class"] -ms.assetid: 11de4aca-28b0-4ff2-a74a-cb602312ffbd --- # CAutoPtrList Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods useful when constructing a list of smart pointers. > [!IMPORTANT] diff --git a/docs/atl/reference/cautorevertimpersonation-class.md b/docs/atl/reference/cautorevertimpersonation-class.md index 6f63d124513..0999a258299 100644 --- a/docs/atl/reference/cautorevertimpersonation-class.md +++ b/docs/atl/reference/cautorevertimpersonation-class.md @@ -4,10 +4,11 @@ title: "CAutoRevertImpersonation Class" ms.date: "11/04/2016" f1_keywords: ["CAutoRevertImpersonation", "ATLSECURITY/ATL::CAutoRevertImpersonation", "ATLSECURITY/ATL::CAutoRevertImpersonation::CAutoRevertImpersonation", "ATLSECURITY/ATL::CAutoRevertImpersonation::Attach", "ATLSECURITY/ATL::CAutoRevertImpersonation::Detach", "ATLSECURITY/ATL::CAutoRevertImpersonation::GetAccessToken"] helpviewer_keywords: ["CAutoRevertImpersonation class"] -ms.assetid: 43732849-1940-4bd4-9d52-7a5698bb8838 --- # CAutoRevertImpersonation Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class reverts [CAccessToken](../../atl/reference/caccesstoken-class.md) objects to a nonimpersonating state when it goes out of scope. ## Syntax diff --git a/docs/atl/reference/cautovectorptr-class.md b/docs/atl/reference/cautovectorptr-class.md index be4c474bcce..e53ebac6abb 100644 --- a/docs/atl/reference/cautovectorptr-class.md +++ b/docs/atl/reference/cautovectorptr-class.md @@ -4,10 +4,11 @@ title: "CAutoVectorPtr Class" ms.date: "11/04/2016" f1_keywords: ["CAutoVectorPtr", "ATLBASE/ATL::CAutoVectorPtr", "ATLBASE/ATL::CAutoVectorPtr::CAutoVectorPtr", "ATLBASE/ATL::CAutoVectorPtr::Allocate", "ATLBASE/ATL::CAutoVectorPtr::Attach", "ATLBASE/ATL::CAutoVectorPtr::Detach", "ATLBASE/ATL::CAutoVectorPtr::Free", "ATLBASE/ATL::CAutoVectorPtr::m_p"] helpviewer_keywords: ["CAutoVectorPtr class"] -ms.assetid: 0030362b-6bc4-4a47-9b5b-3c3899dceab4 --- # CAutoVectorPtr Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a smart pointer object using vector new and delete operators. > [!IMPORTANT] diff --git a/docs/atl/reference/cautovectorptrelementtraits-class.md b/docs/atl/reference/cautovectorptrelementtraits-class.md index 86e766db0b2..7a18d053716 100644 --- a/docs/atl/reference/cautovectorptrelementtraits-class.md +++ b/docs/atl/reference/cautovectorptrelementtraits-class.md @@ -4,10 +4,11 @@ title: "CAutoVectorPtrElementTraits Class" ms.date: "11/04/2016" f1_keywords: ["CAutoVectorPtrElementTraits", "ATLCOLL/ATL::CAutoVectorPtrElementTraits", "ATLCOLL/ATL::CAutoVectorPtrElementTraits::INARGTYPE", "ATLCOLL/ATL::CAutoVectorPtrElementTraits::OUTARGTYPE"] helpviewer_keywords: ["CAutoVectorPtrElementTraits class"] -ms.assetid: 16b81a56-55fb-46ca-b376-66a1884231a6 --- # CAutoVectorPtrElementTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods, static functions, and typedefs useful when creating collections of smart pointers using vector new and delete operators. > [!IMPORTANT] diff --git a/docs/atl/reference/caxdialogimpl-class.md b/docs/atl/reference/caxdialogimpl-class.md index 76937ed12b0..8e536aadf64 100644 --- a/docs/atl/reference/caxdialogimpl-class.md +++ b/docs/atl/reference/caxdialogimpl-class.md @@ -4,10 +4,11 @@ title: "CAxDialogImpl Class" ms.date: "11/04/2016" f1_keywords: ["CAxDialogImpl", "ATLWIN/ATL::CAxDialogImpl", "ATLWIN/ATL::CAxDialogImpl::AdviseSinkMap", "ATLWIN/ATL::CAxDialogImpl::Create", "ATLWIN/ATL::CAxDialogImpl::DestroyWindow", "ATLWIN/ATL::CAxDialogImpl::DoModal", "ATLWIN/ATL::CAxDialogImpl::EndDialog", "ATLWIN/ATL::CAxDialogImpl::GetDialogProc", "ATLWIN/ATL::CAxDialogImpl::GetIDD", "ATLWIN/ATL::CAxDialogImpl::IsDialogMessage", "ATLWIN/ATL::CAxDialogImpl::m_bModal"] helpviewer_keywords: ["CAxDialogImpl class", "ATL, dialog boxes"] -ms.assetid: 817df483-3fa8-44e7-8487-72ba0881cd27 --- # CAxDialogImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements a dialog box (modal or modeless) that hosts ActiveX controls. > [!IMPORTANT] diff --git a/docs/atl/reference/caxwindow-class.md b/docs/atl/reference/caxwindow-class.md index 1817a66fc3c..6a8268eb678 100644 --- a/docs/atl/reference/caxwindow-class.md +++ b/docs/atl/reference/caxwindow-class.md @@ -4,7 +4,6 @@ title: "CAxWindow Class" ms.date: "11/04/2016" f1_keywords: ["CAxWindow", "ATLWIN/ATL::CAxWindow", "ATLWIN/ATL::AttachControl", "ATLWIN/ATL::CreateControl", "ATLWIN/ATL::CreateControlEx", "ATLWIN/ATL::GetWndClassName", "ATLWIN/ATL::QueryControl", "ATLWIN/ATL::QueryHost", "ATLWIN/ATL::SetExternalDispatch", "ATLWIN/ATL::SetExternalUIHandler"] helpviewer_keywords: ["CAxWindow class", "ATL, hosting ActiveX controls"] -ms.assetid: 85e79261-43e4-4770-bde0-1ff87f222b0f api_type: - DllExport api_location: @@ -14,6 +13,8 @@ api_name: --- # CAxWindow Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for manipulating a window hosting an ActiveX control. > [!IMPORTANT] diff --git a/docs/atl/reference/caxwindow2t-class.md b/docs/atl/reference/caxwindow2t-class.md index 866f52ad95f..b8ed27afc15 100644 --- a/docs/atl/reference/caxwindow2t-class.md +++ b/docs/atl/reference/caxwindow2t-class.md @@ -4,10 +4,11 @@ title: "CAxWindow2T Class" ms.date: "11/04/2016" f1_keywords: ["CAxWindow2T", "ATLWIN/ATL::CAxWindow2T", "ATLWIN/ATL::CAxWindow2T::CAxWindow2T", "ATLWIN/ATL::CAxWindow2T::Create", "ATLWIN/ATL::CAxWindow2T::CreateControlLic", "ATLWIN/ATL::CAxWindow2T::CreateControlLicEx", "ATLWIN/ATL::CAxWindow2T::GetWndClassName"] helpviewer_keywords: ["CAxWindow2 class"] -ms.assetid: b87bc943-7991-4537-b902-2138d7f4d837 --- # CAxWindow2T Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for manipulating a window that hosts an ActiveX control, and also has support for hosting licensed ActiveX controls. > [!IMPORTANT] diff --git a/docs/atl/reference/cbindstatuscallback-class.md b/docs/atl/reference/cbindstatuscallback-class.md index 1de6349c0cc..795c96c8517 100644 --- a/docs/atl/reference/cbindstatuscallback-class.md +++ b/docs/atl/reference/cbindstatuscallback-class.md @@ -4,10 +4,11 @@ title: "CBindStatusCallback Class" ms.date: "11/04/2016" f1_keywords: ["CBindStatusCallback", "ATLCTL/ATL::CBindStatusCallback", "ATLCTL/ATL::CBindStatusCallback::CBindStatusCallback", "ATLCTL/ATL::CBindStatusCallback::Download", "ATLCTL/ATL::CBindStatusCallback::GetBindInfo", "ATLCTL/ATL::CBindStatusCallback::GetPriority", "ATLCTL/ATL::CBindStatusCallback::OnDataAvailable", "ATLCTL/ATL::CBindStatusCallback::OnLowResource", "ATLCTL/ATL::CBindStatusCallback::OnObjectAvailable", "ATLCTL/ATL::CBindStatusCallback::OnProgress", "ATLCTL/ATL::CBindStatusCallback::OnStartBinding", "ATLCTL/ATL::CBindStatusCallback::OnStopBinding", "ATLCTL/ATL::CBindStatusCallback::StartAsyncDownload", "ATLCTL/ATL::CBindStatusCallback::m_dwAvailableToRead", "ATLCTL/ATL::CBindStatusCallback::m_dwTotalRead", "ATLCTL/ATL::CBindStatusCallback::m_pFunc", "ATLCTL/ATL::CBindStatusCallback::m_pT", "ATLCTL/ATL::CBindStatusCallback::m_spBindCtx", "ATLCTL/ATL::CBindStatusCallback::m_spBinding", "ATLCTL/ATL::CBindStatusCallback::m_spMoniker", "ATLCTL/ATL::CBindStatusCallback::m_spStream"] helpviewer_keywords: ["asynchronous data transfer [C++]", "data transfer [C++]", "data transfer [C++], asynchronous", "CBindStatusCallback class"] -ms.assetid: 0f5da276-6031-4418-b2a9-a4750ef29e77 --- # CBindStatusCallback Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements the `IBindStatusCallback` interface. > [!IMPORTANT] diff --git a/docs/atl/reference/ccomaggobject-class.md b/docs/atl/reference/ccomaggobject-class.md index b6eefe72330..f3401c8642f 100644 --- a/docs/atl/reference/ccomaggobject-class.md +++ b/docs/atl/reference/ccomaggobject-class.md @@ -4,10 +4,11 @@ title: "CComAggObject Class" ms.date: "11/04/2016" f1_keywords: ["CComAggObject", "ATLCOM/ATL::CComAggObject", "ATLCOM/ATL::CComAggObject::CComAggObject", "ATLCOM/ATL::CComAggObject::AddRef", "ATLCOM/ATL::CComAggObject::CreateInstance", "ATLCOM/ATL::CComAggObject::FinalConstruct", "ATLCOM/ATL::CComAggObject::FinalRelease", "ATLCOM/ATL::CComAggObject::QueryInterface", "ATLCOM/ATL::CComAggObject::Release", "ATLCOM/ATL::CComAggObject::m_contained"] helpviewer_keywords: ["aggregate objects [C++], in ATL", "aggregation [C++], ATL objects", "CComAggObject class"] -ms.assetid: 7aa90d69-d399-477b-880d-e2cdf0ef7881 --- # CComAggObject Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements the [IUnknown](/windows/win32/api/unknwn/nn-unknwn-iunknown) interface for an aggregated object. By definition, an aggregated object is contained within an outer object. The `CComAggObject` class is similar to the [CComObject Class](../../atl/reference/ccomobject-class.md), except that it exposes an interface that is directly accessible to external clients. ## Syntax diff --git a/docs/atl/reference/ccomallocator-class.md b/docs/atl/reference/ccomallocator-class.md index c29ebdbe019..83af39f1631 100644 --- a/docs/atl/reference/ccomallocator-class.md +++ b/docs/atl/reference/ccomallocator-class.md @@ -4,10 +4,11 @@ title: "CComAllocator Class" ms.date: "11/04/2016" f1_keywords: ["CComAllocator", "ATLBASE/ATL::CComAllocator", "ATLBASE/ATL::CComAllocator::Allocate", "ATLBASE/ATL::CComAllocator::Free", "ATLBASE/ATL::CComAllocator::Reallocate"] helpviewer_keywords: ["CComAllocator class"] -ms.assetid: 0cd706fd-0c7b-42d3-9054-febe2966fc8e --- # CComAllocator Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for managing memory using COM memory routines. ## Syntax diff --git a/docs/atl/reference/ccomapartment-class.md b/docs/atl/reference/ccomapartment-class.md index b49417cff84..f1b11e286b0 100644 --- a/docs/atl/reference/ccomapartment-class.md +++ b/docs/atl/reference/ccomapartment-class.md @@ -4,10 +4,11 @@ title: "CComApartment Class" ms.date: "11/04/2016" f1_keywords: ["CComApartment", "ATLBASE/ATL::CComApartment", "ATLBASE/ATL::CComApartment::CComApartment", "ATLBASE/ATL::CComApartment::Apartment", "ATLBASE/ATL::CComApartment::GetLockCount", "ATLBASE/ATL::CComApartment::Lock", "ATLBASE/ATL::CComApartment::Unlock", "ATLBASE/ATL::CComApartment::m_dwThreadID", "ATLBASE/ATL::CComApartment::m_hThread", "ATLBASE/ATL::CComApartment::m_nLockCnt"] helpviewer_keywords: ["apartments in ATL EXE modules", "CComApartment class"] -ms.assetid: dbc177d7-7ee4-45f2-b563-d578a467ca93 --- # CComApartment Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides support for managing an apartment in a thread-pooled EXE module. > [!IMPORTANT] diff --git a/docs/atl/reference/ccomautocriticalsection-class.md b/docs/atl/reference/ccomautocriticalsection-class.md index 1307f3e999d..a2f558a71ac 100644 --- a/docs/atl/reference/ccomautocriticalsection-class.md +++ b/docs/atl/reference/ccomautocriticalsection-class.md @@ -4,10 +4,11 @@ title: "CComAutoCriticalSection Class" ms.date: "11/04/2016" f1_keywords: ["CComAutoCriticalSection", "ATLCORE/ATL::CComAutoCriticalSection", "ATLCORE/ATL::CComAutoCriticalSection::CComAutoCriticalSection"] helpviewer_keywords: ["CComAutoCriticalSection class"] -ms.assetid: 491a9d90-3398-4f90-88f5-fd2172a46b30 --- # CComAutoCriticalSection Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + `CComAutoCriticalSection` provides methods for obtaining and releasing ownership of a critical section object. ## Syntax diff --git a/docs/atl/reference/ccomautodeletecriticalsection-class.md b/docs/atl/reference/ccomautodeletecriticalsection-class.md index b7ab596a45f..61c39b5626b 100644 --- a/docs/atl/reference/ccomautodeletecriticalsection-class.md +++ b/docs/atl/reference/ccomautodeletecriticalsection-class.md @@ -4,10 +4,11 @@ title: "CComAutoDeleteCriticalSection Class" ms.date: "11/04/2016" f1_keywords: ["CComAutoDeleteCriticalSection", "atlcore/ATL::CComAutoDeleteCriticalSection"] helpviewer_keywords: ["CComAutoDeleteCriticalSection class"] -ms.assetid: 2396dbea-1c60-4841-b50e-c4e18af311a3 --- # CComAutoDeleteCriticalSection Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for obtaining and releasing ownership of a critical section object. ## Syntax diff --git a/docs/atl/reference/ccomautothreadmodule-class.md b/docs/atl/reference/ccomautothreadmodule-class.md index 4cff4d76b9d..2c6e947a2fe 100644 --- a/docs/atl/reference/ccomautothreadmodule-class.md +++ b/docs/atl/reference/ccomautothreadmodule-class.md @@ -4,10 +4,11 @@ title: "CComAutoThreadModule Class" ms.date: "11/04/2016" f1_keywords: ["CComAutoThreadModule", "ATLBASE/ATL::CComAutoThreadModule", "ATLBASE/ATL::CreateInstance", "ATLBASE/ATL::GetDefaultThreads", "ATLBASE/ATL::Init", "ATLBASE/ATL::Lock", "ATLBASE/ATL::Unlock", "ATLBASE/ATL::dwThreadID", "ATLBASE/ATL::m_Allocator", "ATLBASE/ATL::m_nThreads", "ATLBASE/ATL::m_pApartments"] helpviewer_keywords: ["CComAutoThreadModule class", "apartment model modules"] -ms.assetid: 13063ea5-a57e-4aac-97d3-227137262811 --- # CComAutoThreadModule Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + As of ATL 7.0, `CComAutoThreadModule` is obsolete: see [ATL Module Classes](../../atl/atl-module-classes.md) for more details. > [!IMPORTANT] diff --git a/docs/atl/reference/ccombstr-class.md b/docs/atl/reference/ccombstr-class.md index 14c7a7e8d83..7062d1d7d9c 100644 --- a/docs/atl/reference/ccombstr-class.md +++ b/docs/atl/reference/ccombstr-class.md @@ -4,10 +4,11 @@ title: "CComBSTR Class" ms.date: "11/04/2016" f1_keywords: ["CComBSTR", "ATLBASE/ATL::CComBSTR", "ATLBASE/ATL::CComBSTR::CComBSTR", "ATLBASE/ATL::CComBSTR::Append", "ATLBASE/ATL::CComBSTR::AppendBSTR", "ATLBASE/ATL::CComBSTR::AppendBytes", "ATLBASE/ATL::CComBSTR::ArrayToBSTR", "ATLBASE/ATL::CComBSTR::AssignBSTR", "ATLBASE/ATL::CComBSTR::Attach", "ATLBASE/ATL::CComBSTR::BSTRToArray", "ATLBASE/ATL::CComBSTR::ByteLength", "ATLBASE/ATL::CComBSTR::Copy", "ATLBASE/ATL::CComBSTR::CopyTo", "ATLBASE/ATL::CComBSTR::Detach", "ATLBASE/ATL::CComBSTR::Empty", "ATLBASE/ATL::CComBSTR::Length", "ATLBASE/ATL::CComBSTR::LoadString", "ATLBASE/ATL::CComBSTR::ReadFromStream", "ATLBASE/ATL::CComBSTR::ToLower", "ATLBASE/ATL::CComBSTR::ToUpper", "ATLBASE/ATL::CComBSTR::WriteToStream", "ATLBASE/ATL::CComBSTR::m_str"] helpviewer_keywords: ["BSTRs, wrapper", "CComBSTR class", "CComBSTR"] -ms.assetid: 8fea1879-a05e-47a5-a803-8dec60eaa534 --- # `CComBSTR` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for [`BSTR`](/previous-versions/windows/desktop/automat/bstr)s. ## Syntax diff --git a/docs/atl/reference/ccomcachedtearoffobject-class.md b/docs/atl/reference/ccomcachedtearoffobject-class.md index 26e8f9526df..bfeda509925 100644 --- a/docs/atl/reference/ccomcachedtearoffobject-class.md +++ b/docs/atl/reference/ccomcachedtearoffobject-class.md @@ -4,10 +4,11 @@ title: "CComCachedTearOffObject Class" ms.date: "11/04/2016" f1_keywords: ["CComCachedTearOffObject", "ATLCOM/ATL::CComCachedTearOffObject", "ATLCOM/ATL::CComCachedTearOffObject::CComCachedTearOffObject", "ATLCOM/ATL::CComCachedTearOffObject::AddRef", "ATLCOM/ATL::CComCachedTearOffObject::FinalConstruct", "ATLCOM/ATL::CComCachedTearOffObject::FinalRelease", "ATLCOM/ATL::CComCachedTearOffObject::QueryInterface", "ATLCOM/ATL::CComCachedTearOffObject::Release", "ATLCOM/ATL::CComCachedTearOffObject::m_contained"] helpviewer_keywords: ["cache, ATL cached tear-off objects", "CComCachedTearOffObject class"] -ms.assetid: ae19507d-a1de-4dbc-a988-da9f75a50c95 --- # CComCachedTearOffObject Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements [IUnknown](/windows/win32/api/unknwn/nn-unknwn-iunknown) for a tear-off interface. ## Syntax diff --git a/docs/atl/reference/ccomclassfactory-class.md b/docs/atl/reference/ccomclassfactory-class.md index 02636d54b19..8ffc9ddddb9 100644 --- a/docs/atl/reference/ccomclassfactory-class.md +++ b/docs/atl/reference/ccomclassfactory-class.md @@ -4,10 +4,11 @@ title: "CComClassFactory Class" ms.date: "11/04/2016" f1_keywords: ["CComClassFactory", "ATLCOM/ATL::CComClassFactory", "ATLCOM/ATL::CComClassFactory::CreateInstance", "ATLCOM/ATL::CComClassFactory::LockServer"] helpviewer_keywords: ["CComClassFactory class"] -ms.assetid: e56dacf7-d5c4-4c42-aef4-a86d91981a1b --- # CComClassFactory Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements the [IClassFactory](/windows/win32/api/unknwnbase/nn-unknwnbase-iclassfactory) interface. ## Syntax diff --git a/docs/atl/reference/ccomclassfactory2-class.md b/docs/atl/reference/ccomclassfactory2-class.md index 6a40fbd71ed..b96614dc260 100644 --- a/docs/atl/reference/ccomclassfactory2-class.md +++ b/docs/atl/reference/ccomclassfactory2-class.md @@ -4,10 +4,11 @@ title: "CComClassFactory2 Class" ms.date: "11/04/2016" f1_keywords: ["CComClassFactory2", "ATLCOM/ATL::CComClassFactory2", "ATLCOM/ATL::CComClassFactory2::CreateInstance", "ATLCOM/ATL::CComClassFactory2::CreateInstanceLic", "ATLCOM/ATL::CComClassFactory2::GetLicInfo", "ATLCOM/ATL::CComClassFactory2::LockServer", "ATLCOM/ATL::CComClassFactory2::RequestLicKey"] helpviewer_keywords: ["CComClassFactory2 class"] -ms.assetid: 19b66fd6-b9ed-47a0-822c-8132184f5a3e --- # CComClassFactory2 Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements the [IClassFactory2](/windows/win32/api/ocidl/nn-ocidl-iclassfactory2) interface. ## Syntax diff --git a/docs/atl/reference/ccomclassfactoryautothread-class.md b/docs/atl/reference/ccomclassfactoryautothread-class.md index af076db252a..39c4c45f686 100644 --- a/docs/atl/reference/ccomclassfactoryautothread-class.md +++ b/docs/atl/reference/ccomclassfactoryautothread-class.md @@ -4,10 +4,11 @@ title: "CComClassFactoryAutoThread Class" ms.date: "11/04/2016" f1_keywords: ["CComClassFactoryAutoThread", "ATLCOM/ATL::CComClassFactoryAutoThread", "ATLCOM/ATL::CComClassFactoryAutoThread::CreateInstance", "ATLCOM/ATL::CComClassFactoryAutoThread::LockServer"] helpviewer_keywords: ["CComClassFactoryAutoThread class"] -ms.assetid: 22008042-533f-4dd9-bf7e-191ee571f9a1 --- # CComClassFactoryAutoThread Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements the [IClassFactory](/windows/win32/api/unknwnbase/nn-unknwnbase-iclassfactory) interface, and allows objects to be created in multiple apartments. > [!IMPORTANT] diff --git a/docs/atl/reference/ccomclassfactorysingleton-class.md b/docs/atl/reference/ccomclassfactorysingleton-class.md index 7559d27a594..a2eb6745545 100644 --- a/docs/atl/reference/ccomclassfactorysingleton-class.md +++ b/docs/atl/reference/ccomclassfactorysingleton-class.md @@ -4,10 +4,11 @@ title: "CComClassFactorySingleton Class" ms.date: "11/04/2016" f1_keywords: ["CComClassFactorySingleton", "ATLCOM/ATL::CComClassFactorySingleton", "ATLCOM/ATL::CComClassFactorySingleton::CreateInstance", "ATLCOM/ATL::CComClassFactorySingleton::m_spObj"] helpviewer_keywords: ["CComClassFactorySingleton class"] -ms.assetid: debb983c-382b-487b-8d42-7ea26dc158b8 --- # CComClassFactorySingleton Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class derives from [CComClassFactory](../../atl/reference/ccomclassfactory-class.md) and uses [CComObjectGlobal](../../atl/reference/ccomobjectglobal-class.md) to construct a single object. > [!IMPORTANT] diff --git a/docs/atl/reference/ccomcoclass-class.md b/docs/atl/reference/ccomcoclass-class.md index 2101a31f892..c9ccbbc5100 100644 --- a/docs/atl/reference/ccomcoclass-class.md +++ b/docs/atl/reference/ccomcoclass-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CComCoClass class", "aggregation [C++], aggregation model --- # CComCoClass Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for creating instances of a class, and obtaining its properties. ## Syntax diff --git a/docs/atl/reference/ccomcompositecontrol-class.md b/docs/atl/reference/ccomcompositecontrol-class.md index d2899ea4afc..09bdc9f10a2 100644 --- a/docs/atl/reference/ccomcompositecontrol-class.md +++ b/docs/atl/reference/ccomcompositecontrol-class.md @@ -4,10 +4,11 @@ title: "CComCompositeControl Class" ms.date: "11/04/2016" f1_keywords: ["CComCompositeControl", "ATLCTL/ATL::CComCompositeControl", "ATLCTL/ATL::CComCompositeControl::CComCompositeControl", "ATLCTL/ATL::CComCompositeControl::AdviseSinkMap", "ATLCTL/ATL::CComCompositeControl::CalcExtent", "ATLCTL/ATL::CComCompositeControl::Create", "ATLCTL/ATL::CComCompositeControl::CreateControlWindow", "ATLCTL/ATL::CComCompositeControl::SetBackgroundColorFromAmbient", "ATLCTL/ATL::CComCompositeControl::m_hbrBackground", "ATLCTL/ATL::CComCompositeControl::m_hWndFocus"] helpviewer_keywords: ["CComCompositeControl class", "composite controls, CComCompositeControl class"] -ms.assetid: 1304b931-27e8-4fbc-be8e-bb226ad887fb --- # CComCompositeControl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides the methods required to implement a composite control. > [!IMPORTANT] diff --git a/docs/atl/reference/ccomcontainedobject-class.md b/docs/atl/reference/ccomcontainedobject-class.md index 1f6f7008ce7..47a9a11db59 100644 --- a/docs/atl/reference/ccomcontainedobject-class.md +++ b/docs/atl/reference/ccomcontainedobject-class.md @@ -4,10 +4,11 @@ title: "CComContainedObject Class" ms.date: "11/04/2016" f1_keywords: ["CComContainedObject", "ATLCOM/ATL::CComContainedObject", "ATLCOM/ATL::CComContainedObject::CComContainedObject", "ATLCOM/ATL::CComContainedObject::AddRef", "ATLCOM/ATL::CComContainedObject::GetControllingUnknown", "ATLCOM/ATL::CComContainedObject::QueryInterface", "ATLCOM/ATL::CComContainedObject::Release"] helpviewer_keywords: ["aggregate objects [C++], in ATL", "aggregation [C++], ATL objects", "CComContainedObject class"] -ms.assetid: e8616b41-c200-47b8-bf2c-fb9f713ebdad --- # CComContainedObject Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements [IUnknown](/windows/win32/api/unknwn/nn-unknwn-iunknown) by delegating to the owner object's `IUnknown`. > [!IMPORTANT] diff --git a/docs/atl/reference/ccomcontrol-class.md b/docs/atl/reference/ccomcontrol-class.md index 4c3cba00c3e..ef8078200c8 100644 --- a/docs/atl/reference/ccomcontrol-class.md +++ b/docs/atl/reference/ccomcontrol-class.md @@ -4,10 +4,11 @@ title: "CComControl Class" ms.date: "11/04/2016" f1_keywords: ["CComControl", "ATLCTL/ATL::CComControl", "ATLCTL/ATL::CComControl::CComControl", "ATLCTL/ATL::CComControl::ControlQueryInterface", "ATLCTL/ATL::CComControl::CreateControlWindow", "ATLCTL/ATL::CComControl::FireOnChanged", "ATLCTL/ATL::CComControl::FireOnRequestEdit", "ATLCTL/ATL::CComControl::MessageBox"] helpviewer_keywords: ["control flags", "CComControlBase class, CComControl class", "stock properties, ATL", "CComControl class", "controls [ATL], control helper functions", "ambient properties", "controls [ATL], properties"] -ms.assetid: 55368c27-bd16-45a7-b701-edb36157c8e8 --- # CComControl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for creating and managing ATL controls. > [!IMPORTANT] diff --git a/docs/atl/reference/ccomcontrolbase-class.md b/docs/atl/reference/ccomcontrolbase-class.md index f65f6c90ee2..82c638b2f4b 100644 --- a/docs/atl/reference/ccomcontrolbase-class.md +++ b/docs/atl/reference/ccomcontrolbase-class.md @@ -4,10 +4,11 @@ title: "CComControlBase Class" ms.date: "11/04/2016" f1_keywords: ["CComControlBase", "ATLCTL/ATL::CComControlBase", "ATLCTL/ATL::CComControlBase::AppearanceType", "ATLCTL/ATL::CComControlBase::CComControlBase", "ATLCTL/ATL::CComControlBase::ControlQueryInterface", "ATLCTL/ATL::CComControlBase::DoesVerbActivate", "ATLCTL/ATL::CComControlBase::DoesVerbUIActivate", "ATLCTL/ATL::CComControlBase::DoVerbProperties", "ATLCTL/ATL::CComControlBase::FireViewChange", "ATLCTL/ATL::CComControlBase::GetAmbientAppearance", "ATLCTL/ATL::CComControlBase::GetAmbientAutoClip", "ATLCTL/ATL::CComControlBase::GetAmbientBackColor", "ATLCTL/ATL::CComControlBase::GetAmbientCharSet", "ATLCTL/ATL::CComControlBase::GetAmbientCodePage", "ATLCTL/ATL::CComControlBase::GetAmbientDisplayAsDefault", "ATLCTL/ATL::CComControlBase::GetAmbientDisplayName", "ATLCTL/ATL::CComControlBase::GetAmbientFont", "ATLCTL/ATL::CComControlBase::GetAmbientFontDisp", "ATLCTL/ATL::CComControlBase::GetAmbientForeColor", "ATLCTL/ATL::CComControlBase::GetAmbientLocaleID", "ATLCTL/ATL::CComControlBase::GetAmbientMessageReflect", "ATLCTL/ATL::CComControlBase::GetAmbientPalette", "ATLCTL/ATL::CComControlBase::GetAmbientProperty", "ATLCTL/ATL::CComControlBase::GetAmbientRightToLeft", "ATLCTL/ATL::CComControlBase::GetAmbientScaleUnits", "ATLCTL/ATL::CComControlBase::GetAmbientShowGrabHandles", "ATLCTL/ATL::CComControlBase::GetAmbientShowHatching", "ATLCTL/ATL::CComControlBase::GetAmbientSupportsMnemonics", "ATLCTL/ATL::CComControlBase::GetAmbientTextAlign", "ATLCTL/ATL::CComControlBase::GetAmbientTopToBottom", "ATLCTL/ATL::CComControlBase::GetAmbientUIDead", "ATLCTL/ATL::CComControlBase::GetAmbientUserMode", "ATLCTL/ATL::CComControlBase::GetDirty", "ATLCTL/ATL::CComControlBase::GetZoomInfo", "ATLCTL/ATL::CComControlBase::InPlaceActivate", "ATLCTL/ATL::CComControlBase::InternalGetSite", "ATLCTL/ATL::CComControlBase::OnDraw", "ATLCTL/ATL::CComControlBase::OnDrawAdvanced", "ATLCTL/ATL::CComControlBase::OnKillFocus", "ATLCTL/ATL::CComControlBase::OnMouseActivate", "ATLCTL/ATL::CComControlBase::OnPaint", "ATLCTL/ATL::CComControlBase::OnSetFocus", "ATLCTL/ATL::CComControlBase::PreTranslateAccelerator", "ATLCTL/ATL::CComControlBase::SendOnClose", "ATLCTL/ATL::CComControlBase::SendOnDataChange", "ATLCTL/ATL::CComControlBase::SendOnRename", "ATLCTL/ATL::CComControlBase::SendOnSave", "ATLCTL/ATL::CComControlBase::SendOnViewChange", "ATLCTL/ATL::CComControlBase::SetControlFocus", "ATLCTL/ATL::CComControlBase::SetDirty", "ATLCTL/ATL::CComControlBase::m_bAutoSize", "ATLCTL/ATL::CComControlBase::m_bDrawFromNatural", "ATLCTL/ATL::CComControlBase::m_bDrawGetDataInHimetric", "ATLCTL/ATL::CComControlBase::m_bInPlaceActive", "ATLCTL/ATL::CComControlBase::m_bInPlaceSiteEx", "ATLCTL/ATL::CComControlBase::m_bNegotiatedWnd", "ATLCTL/ATL::CComControlBase::m_bRecomposeOnResize", "ATLCTL/ATL::CComControlBase::m_bRequiresSave", "ATLCTL/ATL::CComControlBase::m_bResizeNatural", "ATLCTL/ATL::CComControlBase::m_bUIActive", "ATLCTL/ATL::CComControlBase::m_bUsingWindowRgn", "ATLCTL/ATL::CComControlBase::m_bWasOnceWindowless", "ATLCTL/ATL::CComControlBase::m_bWindowOnly", "ATLCTL/ATL::CComControlBase::m_bWndLess", "ATLCTL/ATL::CComControlBase::m_hWndCD", "ATLCTL/ATL::CComControlBase::m_nFreezeEvents", "ATLCTL/ATL::CComControlBase::m_rcPos", "ATLCTL/ATL::CComControlBase::m_sizeExtent", "ATLCTL/ATL::CComControlBase::m_sizeNatural", "ATLCTL/ATL::CComControlBase::m_spAdviseSink", "ATLCTL/ATL::CComControlBase::m_spAmbientDispatch", "ATLCTL/ATL::CComControlBase::m_spClientSite", "ATLCTL/ATL::CComControlBase::m_spDataAdviseHolder", "ATLCTL/ATL::CComControlBase::m_spInPlaceSite", "ATLCTL/ATL::CComControlBase::m_spOleAdviseHolder"] helpviewer_keywords: ["CComControlBase class"] -ms.assetid: 3d1bf022-acf2-4092-8283-ff8cee6332f3 --- # CComControlBase Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for creating and managing ATL controls. > [!IMPORTANT] diff --git a/docs/atl/reference/ccomcriticalsection-class.md b/docs/atl/reference/ccomcriticalsection-class.md index 7ee8d73ac54..dc63e60f1ee 100644 --- a/docs/atl/reference/ccomcriticalsection-class.md +++ b/docs/atl/reference/ccomcriticalsection-class.md @@ -4,10 +4,11 @@ title: "CComCriticalSection Class" ms.date: "11/04/2016" f1_keywords: ["CComCriticalSection", "ATLCORE/ATL::CComCriticalSection", "ATLCORE/ATL::CComCriticalSection::CComCriticalSection", "ATLCORE/ATL::CComCriticalSection::Init", "ATLCORE/ATL::CComCriticalSection::Lock", "ATLCORE/ATL::CComCriticalSection::Term", "ATLCORE/ATL::CComCriticalSection::Unlock", "ATLCORE/ATL::CComCriticalSection::m_sec"] helpviewer_keywords: ["CComCriticalSection class"] -ms.assetid: 44e1edd2-90be-4bfe-9739-58e8b419e7d1 --- # CComCriticalSection Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for obtaining and releasing ownership of a critical section object. ## Syntax diff --git a/docs/atl/reference/ccomcritseclock-class.md b/docs/atl/reference/ccomcritseclock-class.md index 726f3bc79c4..2b05e7b608c 100644 --- a/docs/atl/reference/ccomcritseclock-class.md +++ b/docs/atl/reference/ccomcritseclock-class.md @@ -4,10 +4,11 @@ title: "CComCritSecLock Class" ms.date: "11/04/2016" f1_keywords: ["CComCritSecLock", "ATLBASE/ATL::CComCritSecLock", "ATLBASE/ATL::CComCritSecLock::CComCritSecLock", "ATLBASE/ATL::CComCritSecLock::Lock", "ATLBASE/ATL::CComCritSecLock::Unlock"] helpviewer_keywords: ["CComCritSecLock class"] -ms.assetid: 223152a1-86c3-4ef9-89a7-f455fe791b0e --- # CComCritSecLock Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for locking and unlocking a critical section object. ## Syntax diff --git a/docs/atl/reference/ccomcurrency-class.md b/docs/atl/reference/ccomcurrency-class.md index cee7bfd016c..ba76d99a06d 100644 --- a/docs/atl/reference/ccomcurrency-class.md +++ b/docs/atl/reference/ccomcurrency-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CComCurrency class"] --- # `CComCurrency` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + `CComCurrency` has methods and operators for creating and managing a `CURRENCY` object. ## Syntax diff --git a/docs/atl/reference/ccomdynamicunkarray-class.md b/docs/atl/reference/ccomdynamicunkarray-class.md index 682edba8166..f81b285a499 100644 --- a/docs/atl/reference/ccomdynamicunkarray-class.md +++ b/docs/atl/reference/ccomdynamicunkarray-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["connection points [C++], managing", "CComDynamicUnkArray --- # CComDynamicUnkArray Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class stores an array of `IUnknown` pointers. ## Syntax diff --git a/docs/atl/reference/ccomenum-class.md b/docs/atl/reference/ccomenum-class.md index 874c02b84cf..d8c54423b54 100644 --- a/docs/atl/reference/ccomenum-class.md +++ b/docs/atl/reference/ccomenum-class.md @@ -4,10 +4,11 @@ title: "CComEnum Class" ms.date: "11/04/2016" f1_keywords: ["CComEnum", "atlcom/ATL::CComEnum"] helpviewer_keywords: ["CComEnum class"] -ms.assetid: bff7dd7b-eb6e-4d6e-96ed-2706e66c8b3b --- # CComEnum Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class defines a COM enumerator object based on an array. ## Syntax diff --git a/docs/atl/reference/ccomenumimpl-class.md b/docs/atl/reference/ccomenumimpl-class.md index 904acfd49b9..221edcb1d4a 100644 --- a/docs/atl/reference/ccomenumimpl-class.md +++ b/docs/atl/reference/ccomenumimpl-class.md @@ -4,10 +4,11 @@ title: "CComEnumImpl Class" ms.date: "11/04/2016" f1_keywords: ["CComEnumImpl", "ATLCOM/ATL::CComEnumImpl", "ATLCOM/ATL::CComEnumImpl::CComEnumImpl", "ATLCOM/ATL::CComEnumImpl::Clone", "ATLCOM/ATL::CComEnumImpl::Init", "ATLCOM/ATL::CComEnumImpl::Next", "ATLCOM/ATL::CComEnumImpl::Reset", "ATLCOM/ATL::CComEnumImpl::Skip", "ATLCOM/ATL::CComEnumImpl::m_begin", "ATLCOM/ATL::CComEnumImpl::m_dwFlags", "ATLCOM/ATL::CComEnumImpl::m_end", "ATLCOM/ATL::CComEnumImpl::m_iter", "ATLCOM/ATL::CComEnumImpl::m_spUnk"] helpviewer_keywords: ["CComEnumImpl class"] -ms.assetid: cc0d8e76-e608-46db-87cd-4c7161fe32d2 --- # CComEnumImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides the implementation for a COM enumerator interface where the items being enumerated are stored in an array. ## Syntax diff --git a/docs/atl/reference/ccomenumonstl-class.md b/docs/atl/reference/ccomenumonstl-class.md index 7ab682b5062..9d581e4f87c 100644 --- a/docs/atl/reference/ccomenumonstl-class.md +++ b/docs/atl/reference/ccomenumonstl-class.md @@ -4,10 +4,11 @@ title: "CComEnumOnSTL Class" ms.date: "11/04/2016" f1_keywords: ["CComEnumOnSTL", "atlcom/ATL::CComEnumOnSTL"] helpviewer_keywords: ["CComEnumOnSTL class"] -ms.assetid: befe1a44-7a00-4f28-9a2e-cc0fa526643c --- # CComEnumOnSTL Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class defines a COM enumerator object based on a C++ Standard Library collection. ## Syntax diff --git a/docs/atl/reference/ccomfakecriticalsection-class.md b/docs/atl/reference/ccomfakecriticalsection-class.md index 087bc175ffb..9d146470b88 100644 --- a/docs/atl/reference/ccomfakecriticalsection-class.md +++ b/docs/atl/reference/ccomfakecriticalsection-class.md @@ -4,10 +4,11 @@ title: "CComFakeCriticalSection Class" ms.date: "11/04/2016" f1_keywords: ["CComFakeCriticalSection", "ATLCORE/ATL::CComFakeCriticalSection", "ATLCORE/ATL::CComFakeCriticalSection::Init", "ATLCORE/ATL::CComFakeCriticalSection::Lock", "ATLCORE/ATL::CComFakeCriticalSection::Term", "ATLCORE/ATL::CComFakeCriticalSection::Unlock"] helpviewer_keywords: ["CComFakeCriticalSection class"] -ms.assetid: a4811b97-96bb-493b-ab9f-62822aeddb10 --- # CComFakeCriticalSection Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides the same methods as [CComCriticalSection](../../atl/reference/ccomcriticalsection-class.md) but does not provide a critical section. ## Syntax diff --git a/docs/atl/reference/ccomgitptr-class.md b/docs/atl/reference/ccomgitptr-class.md index 1cc42d0b166..e2478fd7faf 100644 --- a/docs/atl/reference/ccomgitptr-class.md +++ b/docs/atl/reference/ccomgitptr-class.md @@ -4,10 +4,11 @@ title: "CComGITPtr Class" ms.date: "11/04/2016" f1_keywords: ["CComGITPtr", "ATLBASE/ATL::CComGITPtr", "ATLBASE/ATL::CComGITPtr::CComGITPtr", "ATLBASE/ATL::CComGITPtr::Attach", "ATLBASE/ATL::CComGITPtr::CopyTo", "ATLBASE/ATL::CComGITPtr::Detach", "ATLBASE/ATL::CComGITPtr::GetCookie", "ATLBASE/ATL::CComGITPtr::Revoke", "ATLBASE/ATL::CComGITPtr::m_dwCookie"] helpviewer_keywords: ["CComGITPtr class"] -ms.assetid: af895acb-525a-4555-bb67-b241b7df515b --- # CComGITPtr Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for dealing with interface pointers and the global interface table (GIT). ## Syntax diff --git a/docs/atl/reference/ccomheap-class.md b/docs/atl/reference/ccomheap-class.md index f561ecf30de..f4446ee0ef4 100644 --- a/docs/atl/reference/ccomheap-class.md +++ b/docs/atl/reference/ccomheap-class.md @@ -4,10 +4,11 @@ title: "CComHeap Class" ms.date: "11/04/2016" f1_keywords: ["CComHeap", "ATLCOMMEM/ATL::CComHeap", "ATLCOMMEM/ATL::CComHeap::Allocate", "ATLCOMMEM/ATL::CComHeap::Free", "ATLCOMMEM/ATL::CComHeap::GetSize", "ATLCOMMEM/ATL::CComHeap::Reallocate"] helpviewer_keywords: ["CComHeap class"] -ms.assetid: c74183ce-98ae-46fb-b186-93ea4cf0222b --- # `CComHeap` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements [`IAtlMemMgr`](../../atl/reference/iatlmemmgr-class.md) using the COM memory allocation functions. > [!IMPORTANT] diff --git a/docs/atl/reference/ccomheapptr-class.md b/docs/atl/reference/ccomheapptr-class.md index 0edb83160e8..16767755ff6 100644 --- a/docs/atl/reference/ccomheapptr-class.md +++ b/docs/atl/reference/ccomheapptr-class.md @@ -4,10 +4,11 @@ title: "CComHeapPtr Class" ms.date: "11/04/2016" f1_keywords: ["CComHeapPtr", "ATLBASE/ATL::CComHeapPtr", "ATLBASE/ATL::CComHeapPtr::CComHeapPtr"] helpviewer_keywords: ["CComHeapPtr class"] -ms.assetid: bd08b53d-da2b-43ab-a79c-e7c8dbbc5994 --- # CComHeapPtr Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + A smart pointer class for managing heap pointers. ## Syntax diff --git a/docs/atl/reference/ccommodule-class.md b/docs/atl/reference/ccommodule-class.md index eb17faf3c4e..0d8c58b4f6f 100644 --- a/docs/atl/reference/ccommodule-class.md +++ b/docs/atl/reference/ccommodule-class.md @@ -4,10 +4,11 @@ title: "CComModule Class" ms.date: "08/19/2019" f1_keywords: ["CComModule", "ATLBASE/ATL::CComModule", "ATLBASE/ATL::CComModule::GetClassObject", "ATLBASE/ATL::CComModule::GetModuleInstance", "ATLBASE/ATL::CComModule::GetResourceInstance", "ATLBASE/ATL::CComModule::GetTypeLibInstance", "ATLBASE/ATL::CComModule::Init", "ATLBASE/ATL::CComModule::RegisterClassHelper", "ATLBASE/ATL::CComModule::RegisterClassObjects", "ATLBASE/ATL::CComModule::RegisterServer", "ATLBASE/ATL::CComModule::RegisterTypeLib", "ATLBASE/ATL::CComModule::RevokeClassObjects", "ATLBASE/ATL::CComModule::Term", "ATLBASE/ATL::CComModule::UnregisterClassHelper", "ATLBASE/ATL::CComModule::UnregisterServer", "ATLBASE/ATL::CComModule::UpdateRegistryClass", "ATLBASE/ATL::CComModule::UpdateRegistryFromResourceD", "ATLBASE/ATL::CComModule::UpdateRegistryFromResourceS", "ATLBASE/ATL::CComModule::m_csObjMap", "ATLBASE/ATL::CComModule::m_csTypeInfoHolder", "ATLBASE/ATL::CComModule::m_csWindowCreate", "ATLBASE/ATL::CComModule::m_hInst", "ATLBASE/ATL::CComModule::m_hInstResource", "ATLBASE/ATL::CComModule::m_hInstTypeLib", "ATLBASE/ATL::CComModule::m_pObjMap"] helpviewer_keywords: ["CComModule class", "DLL modules [C++], ATL"] -ms.assetid: f5face2c-8fd8-40e6-9ec3-54ab74701769 --- # CComModule Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + As of ATL 7.0, `CComModule` is deprecated: see [ATL Module Classes](../../atl/atl-module-classes.md) for more details. > [!IMPORTANT] diff --git a/docs/atl/reference/ccommultithreadmodel-class.md b/docs/atl/reference/ccommultithreadmodel-class.md index 651aa91f662..56e99deb92b 100644 --- a/docs/atl/reference/ccommultithreadmodel-class.md +++ b/docs/atl/reference/ccommultithreadmodel-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["ATL, multithreading", "CComMultiThreadModel class", "thre --- # CComMultiThreadModel Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + `CComMultiThreadModel` provides thread-safe methods for incrementing and decrementing the value of a variable. ## Syntax diff --git a/docs/atl/reference/ccommultithreadmodelnocs-class.md b/docs/atl/reference/ccommultithreadmodelnocs-class.md index 9a116848eab..b5af9c08403 100644 --- a/docs/atl/reference/ccommultithreadmodelnocs-class.md +++ b/docs/atl/reference/ccommultithreadmodelnocs-class.md @@ -4,10 +4,11 @@ title: "CComMultiThreadModelNoCS Class" ms.date: "11/04/2016" f1_keywords: ["CComMultiThreadModelNoCS", "ATLBASE/ATL::CComMultiThreadModelNoCS", "ATLBASE/ATL::CComMultiThreadModelNoCS::AutoCriticalSection", "ATLBASE/ATL::CComMultiThreadModelNoCS::CriticalSection", "ATLBASE/ATL::CComMultiThreadModelNoCS::ThreadModelNoCS", "ATLBASE/ATL::CComMultiThreadModelNoCS::Decrement", "ATLBASE/ATL::CComMultiThreadModelNoCS::Increment"] helpviewer_keywords: ["ATL, multithreading", "CComMultiThreadModelNoCS class", "threading [ATL]"] -ms.assetid: 2b3f7a45-fd72-452c-aaf3-ccdaa621c821 --- # CComMultiThreadModelNoCS Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + `CComMultiThreadModelNoCS` provides thread-safe methods for incrementing and decrementing the value of a variable, without critical section locking or unlocking functionality. ## Syntax diff --git a/docs/atl/reference/ccomobject-class.md b/docs/atl/reference/ccomobject-class.md index 940285715a1..9e209ec6239 100644 --- a/docs/atl/reference/ccomobject-class.md +++ b/docs/atl/reference/ccomobject-class.md @@ -4,10 +4,11 @@ title: "CComObject Class" ms.date: "11/04/2016" f1_keywords: ["CComObject", "ATLCOM/ATL::CComObject", "ATLCOM/ATL::CComObject::CComObject", "ATLCOM/ATL::CComObject::AddRef", "ATLCOM/ATL::CComObject::CreateInstance", "ATLCOM/ATL::CComObject::QueryInterface", "ATLCOM/ATL::CComObject::Release"] helpviewer_keywords: ["CComObject class"] -ms.assetid: e2b6433b-6349-4749-b4bc-acbd7a22c8b0 --- # CComObject Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` for a nonaggregated object. ## Syntax diff --git a/docs/atl/reference/ccomobjectglobal-class.md b/docs/atl/reference/ccomobjectglobal-class.md index 14afcb2e9d4..345291d1d39 100644 --- a/docs/atl/reference/ccomobjectglobal-class.md +++ b/docs/atl/reference/ccomobjectglobal-class.md @@ -4,10 +4,11 @@ title: "CComObjectGlobal Class" ms.date: "11/04/2016" f1_keywords: ["CComObjectGlobal", "ATLCOM/ATL::CComObjectGlobal", "ATLCOM/ATL::CComObjectGlobal::CComObjectGlobal", "ATLCOM/ATL::CComObjectGlobal::AddRef", "ATLCOM/ATL::CComObjectGlobal::QueryInterface", "ATLCOM/ATL::CComObjectGlobal::Release", "ATLCOM/ATL::CComObjectGlobal::m_hResFinalConstruct"] helpviewer_keywords: ["CComObjectGlobal class"] -ms.assetid: 79bdee55-66e4-4536-b5b3-bdf09f78b9a6 --- # CComObjectGlobal Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class manages a reference count on the module containing your `Base` object. ## Syntax diff --git a/docs/atl/reference/ccomobjectnolock-class.md b/docs/atl/reference/ccomobjectnolock-class.md index e98933f3641..91009986913 100644 --- a/docs/atl/reference/ccomobjectnolock-class.md +++ b/docs/atl/reference/ccomobjectnolock-class.md @@ -4,10 +4,11 @@ title: "CComObjectNoLock Class" ms.date: "11/04/2016" f1_keywords: ["CComObjectNoLock", "ATLCOM/ATL::CComObjectNoLock", "ATLCOM/ATL::CComObjectNoLock::CComObjectNoLock", "ATLCOM/ATL::CComObjectNoLock::AddRef", "ATLCOM/ATL::CComObjectNoLock::QueryInterface", "ATLCOM/ATL::CComObjectNoLock::Release"] helpviewer_keywords: ["CComObjectNoLock class"] -ms.assetid: 288c6506-7da8-4127-8d58-7f4bd779539a --- # CComObjectNoLock Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` for a nonaggregated object, but does not increment the module lock count in the constructor. ## Syntax diff --git a/docs/atl/reference/ccomobjectroot-class.md b/docs/atl/reference/ccomobjectroot-class.md index 5a34267e8d9..e12f04a372f 100644 --- a/docs/atl/reference/ccomobjectroot-class.md +++ b/docs/atl/reference/ccomobjectroot-class.md @@ -4,10 +4,11 @@ title: "CComObjectRoot Class" ms.date: "11/04/2016" f1_keywords: ["CComObjectRoot", "atlcom/ATL::CComObjectRoot"] helpviewer_keywords: ["CComObjectRoot class"] -ms.assetid: f8797c38-6e73-4f67-85c2-71654cffa8eb --- # CComObjectRoot Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This typedef of [CComObjectRootEx](../../atl/reference/ccomobjectrootex-class.md) is templatized on the default threading model of the server. ## Syntax diff --git a/docs/atl/reference/ccomobjectrootex-class.md b/docs/atl/reference/ccomobjectrootex-class.md index d28e79d4906..4b7181dd07d 100644 --- a/docs/atl/reference/ccomobjectrootex-class.md +++ b/docs/atl/reference/ccomobjectrootex-class.md @@ -4,10 +4,11 @@ title: "CComObjectRootEx Class" ms.date: "11/04/2016" f1_keywords: ["CComObjectRootEx", "ATLCOM/ATL::CComObjectRootEx", "ATLCOM/ATL::InternalAddRef", "ATLCOM/ATL::InternalRelease", "ATLCOM/ATL::Lock", "ATLCOM/ATL::Unlock", "ATLCOM/ATL::FinalConstruct", "ATLCOM/ATL::FinalRelease", "ATLCOM/ATL::OuterAddRef", "ATLCOM/ATL::OuterQueryInterface", "ATLCOM/ATL::OuterRelease", "ATLCOM/ATL::InternalQueryInterface", "ATLCOM/ATL::ObjectMain", "ATLCOM/ATL::m_dwRef", "ATLCOM/ATL::m_pOuterUnknown"] helpviewer_keywords: ["reference counting"] -ms.assetid: 894a3d7c-2daf-4fd0-8fa4-e6a05bcfb631 --- # CComObjectRootEx Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods to handle object reference count management for both nonaggregated and aggregated objects. ## Syntax diff --git a/docs/atl/reference/ccomobjectstack-class.md b/docs/atl/reference/ccomobjectstack-class.md index 946beb5b66c..3e109aa93a3 100644 --- a/docs/atl/reference/ccomobjectstack-class.md +++ b/docs/atl/reference/ccomobjectstack-class.md @@ -4,10 +4,11 @@ title: "CComObjectStack Class" ms.date: "11/04/2016" f1_keywords: ["CComObjectStack", "ATLCOM/ATL::CComObjectStack", "ATLCOM/ATL::CComObjectStack::CComObjectStack", "ATLCOM/ATL::CComObjectStack::AddRef", "ATLCOM/ATL::CComObjectStack::QueryInterface", "ATLCOM/ATL::CComObjectStack::Release", "ATLCOM/ATL::CComObjectStack::m_hResFinalConstruct"] helpviewer_keywords: ["CComObjectStack class"] -ms.assetid: 3da72c40-c834-45f6-bb76-6ac204028d80 --- # CComObjectStack Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class creates a temporary COM object and provides it with a skeletal implementation of `IUnknown`. ## Syntax diff --git a/docs/atl/reference/ccompolyobject-class.md b/docs/atl/reference/ccompolyobject-class.md index d3632a52837..42991caee8d 100644 --- a/docs/atl/reference/ccompolyobject-class.md +++ b/docs/atl/reference/ccompolyobject-class.md @@ -4,10 +4,11 @@ title: "CComPolyObject Class" ms.date: "11/04/2016" f1_keywords: ["CComPolyObject", "ATLCOM/ATL::CComPolyObject", "ATLCOM/ATL::CComPolyObject::CComPolyObject", "ATLCOM/ATL::CComPolyObject::AddRef", "ATLCOM/ATL::CComPolyObject::CreateInstance", "ATLCOM/ATL::CComPolyObject::FinalConstruct", "ATLCOM/ATL::CComPolyObject::FinalRelease", "ATLCOM/ATL::CComPolyObject::QueryInterface", "ATLCOM/ATL::CComPolyObject::Release", "ATLCOM/ATL::CComPolyObject::m_contained"] helpviewer_keywords: ["aggregate objects [C++], in ATL", "aggregation [C++], ATL objects", "CComPolyObject class"] -ms.assetid: eaf67c18-e855-48ca-9b15-f1df3106121b --- # CComPolyObject Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` for an aggregated or nonaggregated object. ## Syntax diff --git a/docs/atl/reference/ccomptr-class.md b/docs/atl/reference/ccomptr-class.md index 6ccf6090383..9be4578c843 100644 --- a/docs/atl/reference/ccomptr-class.md +++ b/docs/atl/reference/ccomptr-class.md @@ -4,10 +4,11 @@ description: "Reference guide to the Microsoft C++ Active Template Library (ATL) ms.date: "02/07/2020" f1_keywords: ["CComPtr", "ATLBASE/ATL::CComPtr", "ATLBASE/ATL::CComPtr::CComPtr"] helpviewer_keywords: ["CComPtr class"] -ms.assetid: 22d9ea8d-ed66-4c34-940f-141db11e83bd --- # `CComPtr` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + A smart pointer class for managing COM interface pointers. ## Syntax diff --git a/docs/atl/reference/ccomptrbase-class.md b/docs/atl/reference/ccomptrbase-class.md index c2363d848e2..c1653b2a447 100644 --- a/docs/atl/reference/ccomptrbase-class.md +++ b/docs/atl/reference/ccomptrbase-class.md @@ -4,10 +4,11 @@ title: "CComPtrBase Class" ms.date: "11/04/2016" f1_keywords: ["CComPtrBase", "ATLCOMCLI/ATL::CComPtrBase", "ATLCOMCLI/ATL::CComPtrBase::Advise", "ATLCOMCLI/ATL::CComPtrBase::Attach", "ATLCOMCLI/ATL::CComPtrBase::CoCreateInstance", "ATLCOMCLI/ATL::CComPtrBase::CopyTo", "ATLCOMCLI/ATL::CComPtrBase::Detach", "ATLCOMCLI/ATL::CComPtrBase::IsEqualObject", "ATLCOMCLI/ATL::CComPtrBase::QueryInterface", "ATLCOMCLI/ATL::CComPtrBase::Release", "ATLCOMCLI/ATL::CComPtrBase::SetSite", "ATLCOMCLI/ATL::CComPtrBase::p"] helpviewer_keywords: ["CComPtrBase class"] -ms.assetid: 6dbe9543-dee8-4a97-b02f-dd3a25f4a1a0 --- # `CComPtrBase` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a basis for smart pointer classes using COM-based memory routines. ## Syntax diff --git a/docs/atl/reference/ccomqiptr-class.md b/docs/atl/reference/ccomqiptr-class.md index 03490efe16e..23c87d54f7e 100644 --- a/docs/atl/reference/ccomqiptr-class.md +++ b/docs/atl/reference/ccomqiptr-class.md @@ -4,10 +4,11 @@ title: "CComQIPtr Class" ms.date: "11/04/2016" f1_keywords: ["CComQIPtr", "ATLCOMCLI/ATL::CComQIPtr", "ATLCOMCLI/ATL::CComQIPtr::CComQIPtr"] helpviewer_keywords: ["CComQIPtr class"] -ms.assetid: 969cacb5-05b6-4af4-b683-24911d70242d --- # CComQIPtr Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + A smart pointer class for managing COM interface pointers. ## Syntax diff --git a/docs/atl/reference/ccomqiptrelementtraits-class.md b/docs/atl/reference/ccomqiptrelementtraits-class.md index c81c56e55e6..9d739a9404c 100644 --- a/docs/atl/reference/ccomqiptrelementtraits-class.md +++ b/docs/atl/reference/ccomqiptrelementtraits-class.md @@ -4,10 +4,11 @@ title: "CComQIPtrElementTraits Class" ms.date: "11/04/2016" f1_keywords: ["CComQIPtrElementTraits", "ATLCOLL/ATL::CComQIPtrElementTraits", "ATLCOLL/ATL::CComQIPtrElementTraits::INARGTYPE"] helpviewer_keywords: ["CComQIPtrElementTraits class"] -ms.assetid: 9df9250a-5413-4362-b133-332932a597c4 --- # CComQIPtrElementTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods, static functions, and typedefs useful when creating collections of COM interface pointers. ## Syntax diff --git a/docs/atl/reference/ccomsafearray-class.md b/docs/atl/reference/ccomsafearray-class.md index d9c6729e915..e8b65490485 100644 --- a/docs/atl/reference/ccomsafearray-class.md +++ b/docs/atl/reference/ccomsafearray-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CComSafeArray class"] --- # `CComSafeArray` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for the `SAFEARRAY` structure. ## Syntax diff --git a/docs/atl/reference/ccomsafearraybound-class.md b/docs/atl/reference/ccomsafearraybound-class.md index fa65d7b399d..2d1ea111408 100644 --- a/docs/atl/reference/ccomsafearraybound-class.md +++ b/docs/atl/reference/ccomsafearraybound-class.md @@ -4,10 +4,11 @@ title: "CComSafeArrayBound Class" ms.date: "05/06/2019" f1_keywords: ["CComSafeArrayBound", "ATLSAFE/ATL::CComSafeArrayBound", "ATLSAFE/ATL::GetCount", "ATLSAFE/ATL::GetLowerBound", "ATLSAFE/ATL::GetUpperBound", "ATLSAFE/ATL::SetCount", "ATLSAFE/ATL::SetLowerBound"] helpviewer_keywords: ["CComSafeArrayBound class"] -ms.assetid: dd6299db-5f84-4630-bbf0-f5add5318437 --- # CComSafeArrayBound Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for a [SAFEARRAYBOUND](/windows/win32/api/oaidl/ns-oaidl-safearraybound) structure. ## Syntax diff --git a/docs/atl/reference/ccomsafedeletecriticalsection-class.md b/docs/atl/reference/ccomsafedeletecriticalsection-class.md index 1ece1377c38..c4e8ec088ea 100644 --- a/docs/atl/reference/ccomsafedeletecriticalsection-class.md +++ b/docs/atl/reference/ccomsafedeletecriticalsection-class.md @@ -4,10 +4,11 @@ title: "CComSafeDeleteCriticalSection Class" ms.date: "11/04/2016" f1_keywords: ["CComSafeDeleteCriticalSection", "ATLCORE/ATL::CComSafeDeleteCriticalSection", "ATLCORE/ATL::CComSafeDeleteCriticalSection::CComSafeDeleteCriticalSection", "ATLCORE/ATL::CComSafeDeleteCriticalSection::Init", "ATLCORE/ATL::CComSafeDeleteCriticalSection::Lock", "ATLCORE/ATL::CComSafeDeleteCriticalSection::Term", "ATLCORE/ATL::m_bInitialized"] helpviewer_keywords: ["CComSafeDeleteCriticalSection class"] -ms.assetid: 4d2932c4-ba8f-48ec-8664-1db8bed01314 --- # CComSafeDeleteCriticalSection Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for obtaining and releasing ownership of a critical section object. ## Syntax diff --git a/docs/atl/reference/ccomsimplethreadallocator-class.md b/docs/atl/reference/ccomsimplethreadallocator-class.md index 3ba04a9ad2d..1d3b4a19f4b 100644 --- a/docs/atl/reference/ccomsimplethreadallocator-class.md +++ b/docs/atl/reference/ccomsimplethreadallocator-class.md @@ -4,10 +4,11 @@ title: "CComSimpleThreadAllocator Class" ms.date: "11/04/2016" f1_keywords: ["CComSimpleThreadAllocator", "ATLBASE/ATL::CComSimpleThreadAllocator", "ATLBASE/ATL::CComSimpleThreadAllocator::GetThread"] helpviewer_keywords: ["threading [ATL], selecting threads", "ATL threads", "CComSimpleThreadAllocator class", "ATL threads, allocating"] -ms.assetid: 66b2166a-8c50-49fd-b8e4-7f293470327d --- # CComSimpleThreadAllocator Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class manages thread selection for the class `CComAutoThreadModule`. ## Syntax diff --git a/docs/atl/reference/ccomsinglethreadmodel-class.md b/docs/atl/reference/ccomsinglethreadmodel-class.md index 1fdb2f95db5..d81455f0ca3 100644 --- a/docs/atl/reference/ccomsinglethreadmodel-class.md +++ b/docs/atl/reference/ccomsinglethreadmodel-class.md @@ -4,10 +4,11 @@ title: "CComSingleThreadModel Class" ms.date: "2/29/2020" f1_keywords: ["CComSingleThreadModel", "ATLBASE/ATL::CComSingleThreadModel", "ATLBASE/ATL::CComSingleThreadModel::AutoCriticalSection", "ATLBASE/ATL::CComSingleThreadModel::CriticalSection", "ATLBASE/ATL::CComSingleThreadModel::ThreadModelNoCS", "ATLBASE/ATL::CComSingleThreadModel::Decrement", "ATLBASE/ATL::CComSingleThreadModel::Increment"] helpviewer_keywords: ["single-threaded applications", "CComSingleThreadModel class", "single-threaded applications, ATL"] -ms.assetid: e5dc30c7-405a-4ba4-8ae9-51937243fce8 --- # CComSingleThreadModel Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for incrementing and decrementing the value of a variable. ## Syntax diff --git a/docs/atl/reference/ccomtearoffobject-class.md b/docs/atl/reference/ccomtearoffobject-class.md index 42f6daf5171..a1813b71e2d 100644 --- a/docs/atl/reference/ccomtearoffobject-class.md +++ b/docs/atl/reference/ccomtearoffobject-class.md @@ -4,10 +4,11 @@ title: "CComTearOffObject Class" ms.date: "11/04/2016" f1_keywords: ["CComTearOffObject", "ATLCOM/ATL::CComTearOffObject", "ATLCOM/ATL::CComTearOffObject::CComTearOffObject", "ATLCOM/ATL::CComTearOffObject::AddRef", "ATLCOM/ATL::CComTearOffObject::QueryInterface", "ATLCOM/ATL::CComTearOffObject::Release", "ATLCOM/ATL::CComTearOffObjectBase", "ATLCOM/ATL::m_pOwner"] helpviewer_keywords: ["tear-off interfaces, ATL", "tear-off interfaces", "CComTearOffObject class"] -ms.assetid: d974b598-c6b2-42b1-8360-9190d9d0fbf3 --- # CComTearOffObject Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements a tear-off interface. ## Syntax diff --git a/docs/atl/reference/ccomunkarray-class.md b/docs/atl/reference/ccomunkarray-class.md index dcdc5ecd76d..2232eea84ef 100644 --- a/docs/atl/reference/ccomunkarray-class.md +++ b/docs/atl/reference/ccomunkarray-class.md @@ -4,10 +4,11 @@ title: "CComUnkArray Class" ms.date: "11/04/2016" f1_keywords: ["CComUnkArray", "ATLCOM/ATL::CComUnkArray", "ATLCOM/ATL::CComUnkArray::CComUnkArray", "ATLCOM/ATL::CComUnkArray::Add", "ATLCOM/ATL::CComUnkArray::begin", "ATLCOM/ATL::CComUnkArray::end", "ATLCOM/ATL::CComUnkArray::GetCookie", "ATLCOM/ATL::CComUnkArray::GetUnknown", "ATLCOM/ATL::CComUnkArray::Remove"] helpviewer_keywords: ["connection points [C++], managing", "CComUnkArray class"] -ms.assetid: 5fd4b378-a7b5-4cc1-8866-8ab72a73639e --- # CComUnkArray Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class stores `IUnknown` pointers, and is designed to be used as a parameter to the [IConnectionPointImpl](../../atl/reference/iconnectionpointimpl-class.md) template class. ## Syntax diff --git a/docs/atl/reference/ccomvariant-class.md b/docs/atl/reference/ccomvariant-class.md index e3b806e113a..b7387eaed95 100644 --- a/docs/atl/reference/ccomvariant-class.md +++ b/docs/atl/reference/ccomvariant-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["VARIANT macro", "CComVariant class", "VARIANT macro, ATL" --- # `CComVariant` class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class wraps the `VARIANT` type, providing a member indicating the type of data stored. ## Syntax diff --git a/docs/atl/reference/ccontainedwindowt-class.md b/docs/atl/reference/ccontainedwindowt-class.md index 92e55f8f39c..a3bd317fda7 100644 --- a/docs/atl/reference/ccontainedwindowt-class.md +++ b/docs/atl/reference/ccontainedwindowt-class.md @@ -4,10 +4,11 @@ title: "CContainedWindowT Class" ms.date: "11/04/2016" f1_keywords: ["CContainedWindowT", "ATLWIN/ATL::CContainedWindowT", "ATLWIN/ATL::CContainedWindowT::CContainedWindowT", "ATLWIN/ATL::CContainedWindowT::Create", "ATLWIN/ATL::CContainedWindowT::DefWindowProc", "ATLWIN/ATL::CContainedWindowT::GetCurrentMessage", "ATLWIN/ATL::CContainedWindowT::RegisterWndSuperclass", "ATLWIN/ATL::CContainedWindowT::SubclassWindow", "ATLWIN/ATL::CContainedWindowT::SwitchMessageMap", "ATLWIN/ATL::CContainedWindowT::UnsubclassWindow", "ATLWIN/ATL::CContainedWindowT::WindowProc", "ATLWIN/ATL::CContainedWindowT::m_dwMsgMapID", "ATLWIN/ATL::CContainedWindowT::m_lpszClassName", "ATLWIN/ATL::CContainedWindowT::m_pfnSuperWindowProc", "ATLWIN/ATL::CContainedWindowT::m_pObject"] helpviewer_keywords: ["CContainedWindow class", "contained windows", "CContainedWindowT class"] -ms.assetid: cde0ca36-9347-4068-995a-d294dae57ca9 --- # CContainedWindowT Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements a window contained within another object. > [!IMPORTANT] diff --git a/docs/atl/reference/ccrtallocator-class.md b/docs/atl/reference/ccrtallocator-class.md index 782c70f47f4..6df2c1e8ef6 100644 --- a/docs/atl/reference/ccrtallocator-class.md +++ b/docs/atl/reference/ccrtallocator-class.md @@ -4,10 +4,11 @@ title: "CCRTAllocator Class" ms.date: "11/04/2016" f1_keywords: ["CCRTAllocator", "ATLCORE/ATL::CCRTAllocator", "ATLCORE/ATL::CCRTAllocator::Allocate", "ATLCORE/ATL::CCRTAllocator::Free", "ATLCORE/ATL::CCRTAllocator::Reallocate"] helpviewer_keywords: ["CCRTAllocator class"] -ms.assetid: 3e1b8cb0-859a-41ab-8e93-6f0b5ceca49d --- # CCRTAllocator Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for managing memory using CRT memory routines. ## Syntax diff --git a/docs/atl/reference/ccrtheap-class.md b/docs/atl/reference/ccrtheap-class.md index 2c032d979d5..e1437bf729f 100644 --- a/docs/atl/reference/ccrtheap-class.md +++ b/docs/atl/reference/ccrtheap-class.md @@ -4,10 +4,11 @@ title: "CCRTHeap Class" ms.date: "11/04/2016" f1_keywords: ["CCRTHeap", "ATLMEM/ATL::CCRTHeap", "ATLMEM/ATL::CCRTHeap::Allocate", "ATLMEM/ATL::CCRTHeap::Free", "ATLMEM/ATL::CCRTHeap::GetSize", "ATLMEM/ATL::CCRTHeap::Reallocate"] helpviewer_keywords: ["CCRTHeap class"] -ms.assetid: 321bd6c5-1856-4ff7-8590-95044a1209f7 --- # CCRTHeap Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements [IAtlMemMgr](../../atl/reference/iatlmemmgr-class.md) using the CRT heap functions. ## Syntax diff --git a/docs/atl/reference/cdacl-class.md b/docs/atl/reference/cdacl-class.md index dcd93c40d51..d3efde58ccc 100644 --- a/docs/atl/reference/cdacl-class.md +++ b/docs/atl/reference/cdacl-class.md @@ -4,10 +4,11 @@ title: "CDacl Class" ms.date: "11/04/2016" f1_keywords: ["CDacl", "ATLSECURITY/ATL::CDacl", "ATLSECURITY/ATL::CDacl::CDacl", "ATLSECURITY/ATL::CDacl::AddAllowedAce", "ATLSECURITY/ATL::CDacl::AddDeniedAce", "ATLSECURITY/ATL::CDacl::GetAceCount", "ATLSECURITY/ATL::CDacl::RemoveAce", "ATLSECURITY/ATL::CDacl::RemoveAllAces"] helpviewer_keywords: ["CDacl class"] -ms.assetid: 2dc76616-6362-4967-b6cf-e2d39ca37ddd --- # CDacl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for a DACL (discretionary access-control list) structure. > [!IMPORTANT] diff --git a/docs/atl/reference/cdebugreporthook-class.md b/docs/atl/reference/cdebugreporthook-class.md index a525a352572..5226a4b5a71 100644 --- a/docs/atl/reference/cdebugreporthook-class.md +++ b/docs/atl/reference/cdebugreporthook-class.md @@ -4,10 +4,11 @@ title: "CDebugReportHook Class" ms.date: "11/04/2016" f1_keywords: ["CDebugReportHook", "ATLUTIL/ATL::CDebugReportHook", "ATLUTIL/ATL::CDebugReportHook::CDebugReportHook", "ATLUTIL/ATL::CDebugReportHook::CDebugReportHookProc", "ATLUTIL/ATL::CDebugReportHook::RemoveHook", "ATLUTIL/ATL::CDebugReportHook::SetHook", "ATLUTIL/ATL::CDebugReportHook::SetPipeName", "ATLUTIL/ATL::CDebugReportHook::SetTimeout"] helpviewer_keywords: ["CDebugReportHook class"] -ms.assetid: 798076c3-6e63-4286-83b8-aa1bbcd0c20c --- # CDebugReportHook Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Use this class to send debug reports to a named pipe. ## Syntax diff --git a/docs/atl/reference/cdefaultchartraits-class.md b/docs/atl/reference/cdefaultchartraits-class.md index 6d941499c6e..af31367ac79 100644 --- a/docs/atl/reference/cdefaultchartraits-class.md +++ b/docs/atl/reference/cdefaultchartraits-class.md @@ -4,10 +4,11 @@ title: "CDefaultCharTraits Class" ms.date: "11/04/2016" f1_keywords: ["CDefaultCharTraits", "ATLCOLL/ATL::CDefaultCharTraits", "ATLCOLL/ATL::CDefaultCharTraits::CharToLower", "ATLCOLL/ATL::CDefaultCharTraits::CharToUpper"] helpviewer_keywords: ["CDefaultCharTraits class"] -ms.assetid: f94a3934-597f-401d-8513-ed6924ae069a --- # CDefaultCharTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides two static functions for converting characters between uppercase and lowercase. ## Syntax diff --git a/docs/atl/reference/cdefaultcomparetraits-class.md b/docs/atl/reference/cdefaultcomparetraits-class.md index ba680d50619..214e82b226e 100644 --- a/docs/atl/reference/cdefaultcomparetraits-class.md +++ b/docs/atl/reference/cdefaultcomparetraits-class.md @@ -4,10 +4,11 @@ title: "CDefaultCompareTraits Class" ms.date: "11/04/2016" f1_keywords: ["CDefaultCompareTraits", "ATLCOLL/ATL::CDefaultCompareTraits", "ATLCOLL/ATL::CDefaultCompareTraits::CompareElements", "ATLCOLL/ATL::CDefaultCompareTraits::CompareElementsOrdered"] helpviewer_keywords: ["CDefaultCompareTraits class"] -ms.assetid: a17e2740-e7b4-48f2-aeb7-c80ce84b63f7 --- # CDefaultCompareTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides default element comparison functions. ## Syntax diff --git a/docs/atl/reference/cdefaultelementtraits-class.md b/docs/atl/reference/cdefaultelementtraits-class.md index ee35bca2b36..7f33e07d8f3 100644 --- a/docs/atl/reference/cdefaultelementtraits-class.md +++ b/docs/atl/reference/cdefaultelementtraits-class.md @@ -4,10 +4,11 @@ title: "CDefaultElementTraits Class" ms.date: "11/04/2016" f1_keywords: ["CDefaultElementTraits", "atlcoll/ATL::CDefaultElementTraits"] helpviewer_keywords: ["CDefaultElementTraits class"] -ms.assetid: ac5ee610-7957-4b7c-92b6-38ff72e4118e --- # CDefaultElementTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides default methods and functions for a collection class. ## Syntax diff --git a/docs/atl/reference/cdefaulthashtraits-class.md b/docs/atl/reference/cdefaulthashtraits-class.md index 8c626840a95..562b6da25a7 100644 --- a/docs/atl/reference/cdefaulthashtraits-class.md +++ b/docs/atl/reference/cdefaulthashtraits-class.md @@ -4,10 +4,11 @@ title: "CDefaultHashTraits Class" ms.date: "11/04/2016" f1_keywords: ["CDefaultHashTraits", "ATLCOLL/ATL::CDefaultHashTraits", "ATLCOLL/ATL::CDefaultHashTraits::Hash"] helpviewer_keywords: ["CDefaultHashTraits class"] -ms.assetid: d8ec4b37-6d58-447b-a0c1-8580c5b1ab85 --- # CDefaultHashTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a static function for calculating hash values. ## Syntax diff --git a/docs/atl/reference/cdialogimpl-class.md b/docs/atl/reference/cdialogimpl-class.md index 56a1d4713c2..322ce2b5812 100644 --- a/docs/atl/reference/cdialogimpl-class.md +++ b/docs/atl/reference/cdialogimpl-class.md @@ -4,10 +4,11 @@ title: "CDialogImpl Class" ms.date: "11/04/2016" f1_keywords: ["CDialogImpl", "ATLWIN/ATL::CDialogImpl", "ATLWIN/ATL::Create", "ATLWIN/ATL::DestroyWindow", "ATLWIN/ATL::DoModal", "ATLWIN/ATL::EndDialog", "ATLWIN/ATL::GetDialogProc", "ATLWIN/ATL::MapDialogRect", "ATLWIN/ATL::OnFinalMessage", "ATLWIN/ATL::DialogProc", "ATLWIN/ATL::StartDialogProc"] helpviewer_keywords: ["dialog boxes, ATL", "CDialogImpl class"] -ms.assetid: d430bc7b-8a28-4ad3-9507-277bdd2c2c2e --- # CDialogImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for creating a modal or modeless dialog box. > [!IMPORTANT] diff --git a/docs/atl/reference/cdynamicchain-class.md b/docs/atl/reference/cdynamicchain-class.md index 27e0374b8f9..b3095ff263e 100644 --- a/docs/atl/reference/cdynamicchain-class.md +++ b/docs/atl/reference/cdynamicchain-class.md @@ -4,10 +4,11 @@ title: "CDynamicChain Class" ms.date: "11/04/2016" f1_keywords: ["CDynamicChain", "ATLWIN/ATL::CDynamicChain", "ATLWIN/ATL::CDynamicChain::CDynamicChain", "ATLWIN/ATL::CDynamicChain::CallChain", "ATLWIN/ATL::CDynamicChain::RemoveChainEntry", "ATLWIN/ATL::CDynamicChain::SetChainEntry"] helpviewer_keywords: ["message maps, chaining", "chaining message maps", "CDynamicChain class"] -ms.assetid: f084b2be-0e77-4836-973d-ae278a1e9da8 --- # CDynamicChain Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods supporting the dynamic chaining of message maps. > [!IMPORTANT] diff --git a/docs/atl/reference/celementtraits-class.md b/docs/atl/reference/celementtraits-class.md index 067c69927e0..69ba5045e2b 100644 --- a/docs/atl/reference/celementtraits-class.md +++ b/docs/atl/reference/celementtraits-class.md @@ -4,10 +4,11 @@ title: "CElementTraits Class" ms.date: "11/04/2016" f1_keywords: ["CElementTraits", "atlcoll/ATL::CElementTraits"] helpviewer_keywords: ["CElementTraits class"] -ms.assetid: 496528e5-7f80-4b45-be0c-6f646feb43c5 --- # CElementTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is used by collection classes to provide methods and functions for moving, copying, comparison, and hashing operations. ## Syntax diff --git a/docs/atl/reference/celementtraitsbase-class.md b/docs/atl/reference/celementtraitsbase-class.md index 8bf122174c6..569f754e6b2 100644 --- a/docs/atl/reference/celementtraitsbase-class.md +++ b/docs/atl/reference/celementtraitsbase-class.md @@ -4,10 +4,11 @@ title: "CElementTraitsBase Class" ms.date: "11/04/2016" f1_keywords: ["CElementTraitsBase", "ATLCOLL/ATL::CElementTraitsBase", "ATLCOLL/ATL::CElementTraitsBase::INARGTYPE", "ATLCOLL/ATL::CElementTraitsBase::OUTARGTYPE", "ATLCOLL/ATL::CElementTraitsBase::CopyElements", "ATLCOLL/ATL::CElementTraitsBase::RelocateElements"] helpviewer_keywords: ["CElementTraitsBase class"] -ms.assetid: 75284caf-347e-4355-a7d8-efc708dd514a --- # CElementTraitsBase Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides default copy and move methods for a collection class. ## Syntax diff --git a/docs/atl/reference/cfirepropnotifyevent-class.md b/docs/atl/reference/cfirepropnotifyevent-class.md index 76834b9a5ed..a9058036f19 100644 --- a/docs/atl/reference/cfirepropnotifyevent-class.md +++ b/docs/atl/reference/cfirepropnotifyevent-class.md @@ -4,10 +4,11 @@ title: "CFirePropNotifyEvent Class" ms.date: "11/04/2016" f1_keywords: ["CFirePropNotifyEvent", "ATLCTL/ATL::CFirePropNotifyEvent", "ATLCTL/ATL::CFirePropNotifyEvent::FireOnChanged", "ATLCTL/ATL::CFirePropNotifyEvent::FireOnRequestEdit"] helpviewer_keywords: ["sinks, notifying of ATL events", "CFirePropNotifyEvent class", "connection points [C++], notifying of events"] -ms.assetid: eb7a563e-6bce-4cdf-8d20-8c6a5307781b --- # CFirePropNotifyEvent Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for notifying the container's sink regarding control property changes. > [!IMPORTANT] diff --git a/docs/atl/reference/cglobalheap-class.md b/docs/atl/reference/cglobalheap-class.md index 426101159d7..38fe72d252b 100644 --- a/docs/atl/reference/cglobalheap-class.md +++ b/docs/atl/reference/cglobalheap-class.md @@ -4,10 +4,11 @@ title: "CGlobalHeap Class" ms.date: "11/04/2016" f1_keywords: ["CGlobalHeap", "ATLMEM/ATL::CGlobalHeap", "ATLMEM/ATL::CGlobalHeap::Allocate", "ATLMEM/ATL::CGlobalHeap::Free", "ATLMEM/ATL::CGlobalHeap::GetSize", "ATLMEM/ATL::CGlobalHeap::Reallocate"] helpviewer_keywords: ["CGlobalHeap class"] -ms.assetid: e348d838-3aa7-4bee-a1b3-cd000c99f834 --- # CGlobalHeap Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements [IAtlMemMgr](../../atl/reference/iatlmemmgr-class.md) using the Win32 global heap functions. > [!IMPORTANT] diff --git a/docs/atl/reference/chandle-class.md b/docs/atl/reference/chandle-class.md index 237fa0cd883..54f0095d210 100644 --- a/docs/atl/reference/chandle-class.md +++ b/docs/atl/reference/chandle-class.md @@ -4,10 +4,11 @@ title: "CHandle Class" ms.date: "07/09/2019" f1_keywords: ["CHandle", "ATLBASE/ATL::CHandle", "ATLBASE/ATL::CHandle::CHandle", "ATLBASE/ATL::CHandle::Attach", "ATLBASE/ATL::CHandle::Close", "ATLBASE/ATL::CHandle::Detach", "ATLBASE/ATL::CHandle::m_h"] helpviewer_keywords: ["CHandle class"] -ms.assetid: 883e9db5-40ec-4e29-9c74-4dd2ddd2e35d --- # CHandle Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for creating and using a handle object. ## Syntax diff --git a/docs/atl/reference/cheapptr-class.md b/docs/atl/reference/cheapptr-class.md index c7888bfbccd..53580613dcc 100644 --- a/docs/atl/reference/cheapptr-class.md +++ b/docs/atl/reference/cheapptr-class.md @@ -4,10 +4,11 @@ title: "CHeapPtr Class" ms.date: "11/04/2016" f1_keywords: ["CHeapPtr", "ATLCORE/ATL::CHeapPtr", "ATLCORE/ATL::CHeapPtr::CHeapPtr", "ATLCORE/ATL::CHeapPtr::Allocate", "ATLCORE/ATL::CHeapPtr::Reallocate"] helpviewer_keywords: ["CHeapPtr class"] -ms.assetid: e5c5bfd4-9bf1-4164-8a83-8155fe253454 --- # CHeapPtr Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + A smart pointer class for managing heap pointers. > [!IMPORTANT] diff --git a/docs/atl/reference/cheapptrbase-class.md b/docs/atl/reference/cheapptrbase-class.md index 8ba15f0fb65..a756cc99bc3 100644 --- a/docs/atl/reference/cheapptrbase-class.md +++ b/docs/atl/reference/cheapptrbase-class.md @@ -4,10 +4,11 @@ title: "CHeapPtrBase class" ms.date: "11/04/2016" f1_keywords: ["CHeapPtrBase", "ATLCORE/ATL::CHeapPtrBase", "ATLCORE/ATL::CHeapPtrBase::AllocateBytes", "ATLCORE/ATL::CHeapPtrBase::Attach", "ATLCORE/ATL::CHeapPtrBase::Detach", "ATLCORE/ATL::CHeapPtrBase::Free", "ATLCORE/ATL::CHeapPtrBase::ReallocateBytes", "ATLCORE/ATL::CHeapPtrBase::m_pData"] helpviewer_keywords: ["CHeapPtrBase class"] -ms.assetid: 501ac1b2-fb34-4c72-b7e6-a4f1fc8fda21 --- # `CHeapPtrBase` class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class forms the basis for several smart heap pointer classes. > [!IMPORTANT] diff --git a/docs/atl/reference/cheapptrelementtraits-class.md b/docs/atl/reference/cheapptrelementtraits-class.md index 3ff0b3f44d1..5fb6c021ad1 100644 --- a/docs/atl/reference/cheapptrelementtraits-class.md +++ b/docs/atl/reference/cheapptrelementtraits-class.md @@ -4,10 +4,11 @@ title: "CHeapPtrElementTraits Class" ms.date: "11/04/2016" f1_keywords: ["CHeapPtrElementTraits", "ATLCOLL/ATL::CHeapPtrElementTraits", "ATLCOLL/ATL::CHeapPtrElementTraits::INARGTYPE", "ATLCOLL/ATL::CHeapPtrElementTraits::OUTARGTYPE"] helpviewer_keywords: ["CHeapPtrElementTraits class"] -ms.assetid: 910e0e06-3c8b-4242-bf00-b57eb74fbc77 --- # CHeapPtrElementTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods, static functions, and typedefs useful when creating collections of heap pointers. > [!IMPORTANT] diff --git a/docs/atl/reference/cheapptrlist-class.md b/docs/atl/reference/cheapptrlist-class.md index 591c5787727..4513428fcb8 100644 --- a/docs/atl/reference/cheapptrlist-class.md +++ b/docs/atl/reference/cheapptrlist-class.md @@ -4,10 +4,11 @@ title: "CHeapPtrList Class" ms.date: "11/04/2016" f1_keywords: ["CHeapPtrList", "ATLCOLL/ATL::CHeapPtrList", "ATLCOLL/ATL::CHeapPtrList::CHeapPtrList"] helpviewer_keywords: ["CHeapPtrList class"] -ms.assetid: cc70e585-362a-4007-81db-c705eb181226 --- # CHeapPtrList Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods useful when constructing a list of heap pointers. > [!IMPORTANT] diff --git a/docs/atl/reference/cinterfacearray-class.md b/docs/atl/reference/cinterfacearray-class.md index 3a6ec0bc1df..d7c378a72a9 100644 --- a/docs/atl/reference/cinterfacearray-class.md +++ b/docs/atl/reference/cinterfacearray-class.md @@ -4,10 +4,11 @@ title: "CInterfaceArray Class" ms.date: "11/04/2016" f1_keywords: ["CInterfaceArray", "ATLCOLL/ATL::CInterfaceArray", "ATLCOLL/ATL::CInterfaceArray::CInterfaceArray"] helpviewer_keywords: ["CInterfaceArray class"] -ms.assetid: 1f29cf66-a086-4a7b-b6a8-64f73da39f79 --- # CInterfaceArray Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods useful when constructing an array of COM interface pointers. ## Syntax diff --git a/docs/atl/reference/cinterfacelist-class.md b/docs/atl/reference/cinterfacelist-class.md index e5aae7bdce7..f445de12465 100644 --- a/docs/atl/reference/cinterfacelist-class.md +++ b/docs/atl/reference/cinterfacelist-class.md @@ -4,10 +4,11 @@ title: "CInterfaceList Class" ms.date: "11/04/2016" f1_keywords: ["CInterfaceList", "ATLCOLL/ATL::CInterfaceList", "ATLCOLL/ATL::CInterfaceList::CInterfaceList"] helpviewer_keywords: ["CInterfaceList class"] -ms.assetid: 2077764d-25e5-4b3d-96c8-08a287bbcd25 --- # CInterfaceList Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods useful when constructing a list of COM interface pointers. ## Syntax diff --git a/docs/atl/reference/clocalheap-class.md b/docs/atl/reference/clocalheap-class.md index 32ff5c199e4..9d597b0d29c 100644 --- a/docs/atl/reference/clocalheap-class.md +++ b/docs/atl/reference/clocalheap-class.md @@ -4,10 +4,11 @@ title: "CLocalHeap Class" ms.date: "11/04/2016" f1_keywords: ["CLocalHeap", "ATLMEM/ATL::CLocalHeap", "ATLMEM/ATL::CLocalHeap::Allocate", "ATLMEM/ATL::CLocalHeap::Free", "ATLMEM/ATL::CLocalHeap::GetSize", "ATLMEM/ATL::CLocalHeap::Reallocate"] helpviewer_keywords: ["CLocalHeap class"] -ms.assetid: 1ffa87a5-5fc8-4f8d-8809-58e87e963bd2 --- # CLocalHeap Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements [IAtlMemMgr](../../atl/reference/iatlmemmgr-class.md) using the Win32 local heap functions. > [!IMPORTANT] diff --git a/docs/atl/reference/cmessagemap-class.md b/docs/atl/reference/cmessagemap-class.md index 1f8f30e7429..3e9c87e6d8e 100644 --- a/docs/atl/reference/cmessagemap-class.md +++ b/docs/atl/reference/cmessagemap-class.md @@ -4,10 +4,11 @@ title: "CMessageMap Class" ms.date: "11/04/2016" f1_keywords: ["CMessageMap", "ATLWIN/ATL::CMessageMap", "ATLWIN/ATL::CMessageMap::ProcessWindowMessage"] helpviewer_keywords: ["CMessageMap class", "message maps, ATL", "ATL, message handlers"] -ms.assetid: 1f97bc16-a8a0-4cf0-b90f-1778813a5c8e --- # CMessageMap Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class allows an object's message maps to be access by another object. > [!IMPORTANT] diff --git a/docs/atl/reference/cnonstatelessworker-class.md b/docs/atl/reference/cnonstatelessworker-class.md index 014cd170ab8..c11f44e5cf6 100644 --- a/docs/atl/reference/cnonstatelessworker-class.md +++ b/docs/atl/reference/cnonstatelessworker-class.md @@ -4,10 +4,11 @@ title: "CNonStatelessWorker Class" ms.date: "11/04/2016" f1_keywords: ["CNonStatelessWorker", "ATLUTIL/ATL::CNonStatelessWorker", "ATLUTIL/ATL::CNonStatelessWorker::RequestType", "ATLUTIL/ATL::CNonStatelessWorker::Execute", "ATLUTIL/ATL::CNonStatelessWorker::Initialize", "ATLUTIL/ATL::CNonStatelessWorker::Terminate"] helpviewer_keywords: ["CNonStatelessWorker class"] -ms.assetid: d00936c6-9e7d-49fb-b87d-417b963367d1 --- # CNonStatelessWorker Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Receives requests from a thread pool and passes them on to a worker object that is created and destroyed on each request. > [!IMPORTANT] diff --git a/docs/atl/reference/cnoworkerthread-class.md b/docs/atl/reference/cnoworkerthread-class.md index 69c725ddc5e..a46f79dd47f 100644 --- a/docs/atl/reference/cnoworkerthread-class.md +++ b/docs/atl/reference/cnoworkerthread-class.md @@ -4,10 +4,11 @@ title: "CNoWorkerThread Class" ms.date: "11/04/2016" f1_keywords: ["CNoWorkerThread", "ATLUTIL/ATL::CNoWorkerThread", "ATLUTIL/ATL::CNoWorkerThread::AddHandle", "ATLUTIL/ATL::CNoWorkerThread::AddTimer", "ATLUTIL/ATL::CNoWorkerThread::GetThreadHandle", "ATLUTIL/ATL::CNoWorkerThread::GetThreadId", "ATLUTIL/ATL::CNoWorkerThread::Initialize", "ATLUTIL/ATL::CNoWorkerThread::RemoveHandle", "ATLUTIL/ATL::CNoWorkerThread::Shutdown"] helpviewer_keywords: ["CNoWorkerThread class"] -ms.assetid: 29f06bae-b658-4aac-9c14-331e996d25d1 --- # CNoWorkerThread Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Use this class as the argument for the `MonitorClass` template parameter to cache classes if you want to disable dynamic cache maintenance. > [!IMPORTANT] diff --git a/docs/atl/reference/com-interface-entry-macros.md b/docs/atl/reference/com-interface-entry-macros.md index 83a187ec491..dd365f7d09d 100644 --- a/docs/atl/reference/com-interface-entry-macros.md +++ b/docs/atl/reference/com-interface-entry-macros.md @@ -4,10 +4,11 @@ title: "COM Interface Entry Macros" ms.date: "03/28/2017" f1_keywords: ["atlcom/ATL::COM_INTERFACE_ENTRY", "atlcom/ATL::COM_INTERFACE_ENTRY_IID", "atlcom/ATL::COM_INTERFACE_ENTRY_AGGREGATE", "atlcom/ATL::COM_INTERFACE_ENTRY_AGGREGATE_BLIND", "atlcom/ATL::COM_INTERFACE_ENTRY_AUTOAGGREGATE", "atlcom/ATL::COM_INTERFACE_ENTRY_AUTOAGGREGATE_BLIND", "atlcom/ATL::COM_INTERFACE_ENTRY_BREAK", "atlcom/ATL::COM_INTERFACE_ENTRY_CACHED_TEAR_OFF", "atlcom/ATL::COM_INTERFACE_ENTRY_TEAR_OFF", "atlcom/ATL::COM_INTERFACE_ENTRY_CHAIN", "atlcom/ATL::COM_INTERFACE_ENTRY_FUNC", "atlcom/ATL::COM_INTERFACE_ENTRY_FUNC_BLIND", "atlcom/ATL::COM_INTERFACE_ENTRY_NOINTERFACE"] helpviewer_keywords: ["COM interfaces, COM interface entry macros"] -ms.assetid: 19dcb768-2e1f-4b8d-a618-453a01a4bd00 --- # COM_INTERFACE_ENTRY Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros enter an object's interfaces into its COM map so that they can be accessed by `QueryInterface`. The order of entries in the COM map is the order interfaces will be checked for a matching IID during `QueryInterface`. |Macro|Description| diff --git a/docs/atl/reference/com-map-global-functions.md b/docs/atl/reference/com-map-global-functions.md index 97e19802646..e7ebb9ed76d 100644 --- a/docs/atl/reference/com-map-global-functions.md +++ b/docs/atl/reference/com-map-global-functions.md @@ -4,10 +4,11 @@ title: "COM Map Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlbase/ATL::AtlInternalQueryInterface", "atlbase/ATL::InlineIsEqualIUnknown"] helpviewer_keywords: ["COM interfaces, COM map global functions"] -ms.assetid: b9612d30-eb23-46ef-8093-d56f237d3cf1 --- # COM Map Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions provide support for COM Map `IUnknown` implementations. |Function|Description| diff --git a/docs/atl/reference/com-map-macros.md b/docs/atl/reference/com-map-macros.md index 6734604721d..93d4b26bb69 100644 --- a/docs/atl/reference/com-map-macros.md +++ b/docs/atl/reference/com-map-macros.md @@ -4,10 +4,11 @@ title: "COM Map Macros" ms.date: "11/04/2016" f1_keywords: ["atlcom/ATL::BEGIN_COM_MAP", "atlcom/ATL::END_COM_MAP", "ATLCOM/BEGIN_COM_MAP", "ATLCOM/END_COM_MAP"] helpviewer_keywords: ["COM interfaces, COM map macros"] -ms.assetid: 0f33656d-321f-4996-90cc-9a7f21ab73c3 --- # COM Map Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros define COM interface maps. |Macro|Description| diff --git a/docs/atl/reference/com-plus-1-0-atl-com-plus-1-0-component-wizard.md b/docs/atl/reference/com-plus-1-0-atl-com-plus-1-0-component-wizard.md index 0a125245518..37826eba5b2 100644 --- a/docs/atl/reference/com-plus-1-0-atl-com-plus-1-0-component-wizard.md +++ b/docs/atl/reference/com-plus-1-0-atl-com-plus-1-0-component-wizard.md @@ -3,10 +3,11 @@ description: "Learn more about: COM+ 1.0, ATL COM+ 1.0 Component Wizard" title: "COM+ 1.0, ATL COM+ 1.0 Component Wizard" ms.date: "05/09/2019" f1_keywords: ["vc.codewiz.class.atl.mts.options"] -ms.assetid: 2fbe259c-6be1-4d0e-9cfe-721c75c97cb1 --- # COM+ 1.0, ATL COM+ 1.0 Component Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" This wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/com-plus-1-0-support-in-atl-projects.md b/docs/atl/reference/com-plus-1-0-support-in-atl-projects.md index ae0f296311b..72d9e7e0ff7 100644 --- a/docs/atl/reference/com-plus-1-0-support-in-atl-projects.md +++ b/docs/atl/reference/com-plus-1-0-support-in-atl-projects.md @@ -4,10 +4,11 @@ title: "COM+ 1.0 Support in ATL Projects" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.ATL.MTS"] helpviewer_keywords: ["ATL projects, COM+ 1.0 support"] -ms.assetid: 51fb08ac-d632-4657-a4e0-d3f989f0b6f8 --- # COM+ 1.0 Support in ATL Projects +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + You can use the [ATL Project Wizard](../../atl/reference/creating-an-atl-project.md) to create a project with basic support for COM+ 1.0 components. COM+ 1.0 is designed for developing distributed component-based applications. It also provides a run-time infrastructure for deploying and managing these applications. diff --git a/docs/atl/reference/compiler-options-macros.md b/docs/atl/reference/compiler-options-macros.md index 4c80bb5d9bf..465fd84fab8 100644 --- a/docs/atl/reference/compiler-options-macros.md +++ b/docs/atl/reference/compiler-options-macros.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["compiler options, macros"] --- # Compiler Options Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros control specific compiler features. |Macro|Description| diff --git a/docs/atl/reference/composite-control-global-functions.md b/docs/atl/reference/composite-control-global-functions.md index b55042bb271..b14dc283be1 100644 --- a/docs/atl/reference/composite-control-global-functions.md +++ b/docs/atl/reference/composite-control-global-functions.md @@ -4,10 +4,11 @@ title: "Composite Control Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlhost/ATL::AtlAxDialogBox", "atlhost/ATL::AtlAxCreateDialog", "atlhost/ATL::AtlAxCreateControl", "atlhost/ATL::AtlAxCreateControlEx", "atlhost/ATL::AtlAxCreateControlLic", "atlhost/ATL::AtlAxCreateControlLicEx", "atlhost/ATL::AtlAxAttachControl", "atlhost/ATL::AtlAxGetHost", "atlhost/ATL::AtlAxGetControl", "atlhost/ATL::AtlSetChildSite", "atlhost/ATL::AtlAxWinInit", "atlhost/ATL::AtlAxWinTerm", "atlhost/ATL::AtlGetObjectSourceInterface"] helpviewer_keywords: ["composite controls, global functions"] -ms.assetid: 536884cd-e863-4c7a-ab0a-604dc60a0bbe --- # Composite Control Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions provide support for creating dialog boxes, and for creating, hosting and licensing ActiveX controls. > [!IMPORTANT] diff --git a/docs/atl/reference/composite-control-macros.md b/docs/atl/reference/composite-control-macros.md index 9721f16031c..94620901dbc 100644 --- a/docs/atl/reference/composite-control-macros.md +++ b/docs/atl/reference/composite-control-macros.md @@ -4,10 +4,11 @@ title: "Composite Control Macros" ms.date: "05/06/2019" f1_keywords: ["atlcom/ATL::BEGIN_SINK_MAP", "atlcom/ATL::END_SINK_MAP", "atlcom/ATL::SINK_ENTRY", "ATLCOM/BEGIN_SINK_MAP", "ATLCOM/END_SINK_MAP", "ATLCOM/SINK_ENTRY", "ATLCOM/SINK_ENTRY_EX", "ATLCOM/SINK_ENTRY_EX_P", "ATLCOM/SINK_ENTRY_INFO", "ATLCOM/SINK_ENTRY_INFO_P", "BEGIN_SINK_MAP", "END_SINK_MAP", "SINK_ENTRY", "SINK_ENTRY_EX", "SINK_ENTRY_EX_P", "SINK_ENTRY_INFO", "SINK_ENTRY_INFO_P"] helpviewer_keywords: ["composite controls, macros"] -ms.assetid: 17f2dd5e-07e6-4aa6-b965-7a361c78c45e --- # Composite Control Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros define event sink maps and entries. |Macro|Description| diff --git a/docs/atl/reference/connection-point-global-functions.md b/docs/atl/reference/connection-point-global-functions.md index be49a8643a4..27a14e4ca41 100644 --- a/docs/atl/reference/connection-point-global-functions.md +++ b/docs/atl/reference/connection-point-global-functions.md @@ -4,10 +4,11 @@ title: "Connection Point Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlbase/ATL::AtlAdvise", "atlbase/ATL::AtlUnadvise", "atlbase/ATL::AtlAdviseSinkMap"] helpviewer_keywords: ["connection points [C++], global functions"] -ms.assetid: bcb4bf50-2155-4e20-b8bb-f2908b03a6e7 --- # Connection Point Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions provide support for connection points and sink maps. > [!IMPORTANT] diff --git a/docs/atl/reference/connection-point-macros.md b/docs/atl/reference/connection-point-macros.md index 490abb2c387..5bdfd5b0491 100644 --- a/docs/atl/reference/connection-point-macros.md +++ b/docs/atl/reference/connection-point-macros.md @@ -4,10 +4,11 @@ title: "Connection Point Macros" ms.date: "11/04/2016" f1_keywords: ["atlcom/ATL::BEGIN_CONNECTION_POINT_MAP", "atlcom/ATL::END_CONNECTION_POINT_MAP", "ATLCOM/BEGIN_CONNECTION_POINT_MAP", "ATLCOM/END_CONNECTION_POINT_MAP", "ATLCOM/CONNECTION_POINT_ENTRY", "ATLCOM/CONNECTION_POINT_ENTRY_P", "BEGIN_CONNECTION_POINT_MAP", "END_CONNECTION_POINT_MAP", "CONNECTION_POINT_ENTRY", "CONNECTION_POINT_ENTRY_P"] helpviewer_keywords: ["connection points [C++], macros"] -ms.assetid: cc3a6dd3-5538-45df-b027-1f34963c31e5 --- # Connection Point Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros define connection point maps and entries. |Macro|Description| diff --git a/docs/atl/reference/cpatht-class.md b/docs/atl/reference/cpatht-class.md index 32b31a3db12..93adf44cd29 100644 --- a/docs/atl/reference/cpatht-class.md +++ b/docs/atl/reference/cpatht-class.md @@ -4,10 +4,11 @@ title: "CPathT Class" ms.date: "03/27/2019" f1_keywords: ["CPathT", "ATLPATH/ATL::CPathT", "ATLPATH/ATL::CPathT::PCXSTR", "ATLPATH/ATL::CPathT::PXSTR", "ATLPATH/ATL::CPathT::XCHAR", "ATLPATH/ATL::CPathT::CPathT", "ATLPATH/ATL::CPathT::AddBackslash", "ATLPATH/ATL::CPathT::AddExtension", "ATLPATH/ATL::CPathT::Append", "ATLPATH/ATL::CPathT::BuildRoot", "ATLPATH/ATL::CPathT::Canonicalize", "ATLPATH/ATL::CPathT::Combine", "ATLPATH/ATL::CPathT::CommonPrefix", "ATLPATH/ATL::CPathT::CompactPath", "ATLPATH/ATL::CPathT::CompactPathEx", "ATLPATH/ATL::CPathT::FileExists", "ATLPATH/ATL::CPathT::FindExtension", "ATLPATH/ATL::CPathT::FindFileName", "ATLPATH/ATL::CPathT::GetDriveNumber", "ATLPATH/ATL::CPathT::GetExtension", "ATLPATH/ATL::CPathT::IsDirectory", "ATLPATH/ATL::CPathT::IsFileSpec", "ATLPATH/ATL::CPathT::IsPrefix", "ATLPATH/ATL::CPathT::IsRelative", "ATLPATH/ATL::CPathT::IsRoot", "ATLPATH/ATL::CPathT::IsSameRoot", "ATLPATH/ATL::CPathT::IsUNC", "ATLPATH/ATL::CPathT::IsUNCServer", "ATLPATH/ATL::CPathT::IsUNCServerShare", "ATLPATH/ATL::CPathT::MakePretty", "ATLPATH/ATL::CPathT::MatchSpec", "ATLPATH/ATL::CPathT::QuoteSpaces", "ATLPATH/ATL::CPathT::RelativePathTo", "ATLPATH/ATL::CPathT::RemoveArgs", "ATLPATH/ATL::CPathT::RemoveBackslash", "ATLPATH/ATL::CPathT::RemoveBlanks", "ATLPATH/ATL::CPathT::RemoveExtension", "ATLPATH/ATL::CPathT::RemoveFileSpec", "ATLPATH/ATL::CPathT::RenameExtension", "ATLPATH/ATL::CPathT::SkipRoot", "ATLPATH/ATL::CPathT::StripPath", "ATLPATH/ATL::CPathT::StripToRoot", "ATLPATH/ATL::CPathT::UnquoteSpaces", "ATLPATH/ATL::CPathT::m_strPath"] helpviewer_keywords: ["CPathT class"] -ms.assetid: eba4137d-1fd2-4b44-a2e1-0944db64df3c --- # CPathT Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a path. > [!IMPORTANT] diff --git a/docs/atl/reference/cprimitiveelementtraits-class.md b/docs/atl/reference/cprimitiveelementtraits-class.md index 7a0da283d47..efbb2c1caff 100644 --- a/docs/atl/reference/cprimitiveelementtraits-class.md +++ b/docs/atl/reference/cprimitiveelementtraits-class.md @@ -4,10 +4,11 @@ title: "CPrimitiveElementTraits Class" ms.date: "11/04/2016" f1_keywords: ["CPrimitiveElementTraits", "ATLCOLL/ATL::CPrimitiveElementTraits", "ATLCOLL/ATL::CPrimitiveElementTraits::INARGTYPE", "ATLCOLL/ATL::CPrimitiveElementTraits::OUTARGTYPE"] helpviewer_keywords: ["CPrimitiveElementTraits class"] -ms.assetid: 21c1cea8-2c5a-486c-b65c-85490f3ed4e6 --- # CPrimitiveElementTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides default methods and functions for a collection class composed of primitive data types. ## Syntax diff --git a/docs/atl/reference/cprivateobjectsecuritydesc-class.md b/docs/atl/reference/cprivateobjectsecuritydesc-class.md index 8d18a4cef84..b3e8123fd32 100644 --- a/docs/atl/reference/cprivateobjectsecuritydesc-class.md +++ b/docs/atl/reference/cprivateobjectsecuritydesc-class.md @@ -4,10 +4,11 @@ title: "CPrivateObjectSecurityDesc Class" ms.date: "11/04/2016" f1_keywords: ["CPrivateObjectSecurityDesc", "ATLSECURITY/ATL::CPrivateObjectSecurityDesc", "ATLSECURITY/ATL::CPrivateObjectSecurityDesc::CPrivateObjectSecurityDesc", "ATLSECURITY/ATL::CPrivateObjectSecurityDesc::ConvertToAutoInherit", "ATLSECURITY/ATL::CPrivateObjectSecurityDesc::Create", "ATLSECURITY/ATL::CPrivateObjectSecurityDesc::Get", "ATLSECURITY/ATL::CPrivateObjectSecurityDesc::Set"] helpviewer_keywords: ["CPrivateObjectSecurityDesc class"] -ms.assetid: 2c4bbb13-bf99-4833-912a-197f6815bb5d --- # CPrivateObjectSecurityDesc Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a private object security descriptor object. ## Syntax diff --git a/docs/atl/reference/crbmap-class.md b/docs/atl/reference/crbmap-class.md index 4617fc49e3c..3a09ccf6c49 100644 --- a/docs/atl/reference/crbmap-class.md +++ b/docs/atl/reference/crbmap-class.md @@ -4,10 +4,11 @@ title: "CRBMap Class" ms.date: "11/04/2016" f1_keywords: ["CRBMap", "ATLCOLL/ATL::CRBMap", "ATLCOLL/ATL::CRBMap::CRBMap", "ATLCOLL/ATL::CRBMap::Lookup", "ATLCOLL/ATL::CRBMap::RemoveKey", "ATLCOLL/ATL::CRBMap::SetAt"] helpviewer_keywords: ["CRBMap class"] -ms.assetid: 658e94dc-e835-4356-aed1-1513e1f66969 --- # CRBMap Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a mapping structure, using a Red-Black binary tree. ## Syntax diff --git a/docs/atl/reference/crbmultimap-class.md b/docs/atl/reference/crbmultimap-class.md index 3788491f6d5..c50ea797627 100644 --- a/docs/atl/reference/crbmultimap-class.md +++ b/docs/atl/reference/crbmultimap-class.md @@ -4,10 +4,11 @@ title: "CRBMultiMap Class" ms.date: "11/04/2016" f1_keywords: ["CRBMultiMap", "ATLCOLL/ATL::CRBMultiMap", "ATLCOLL/ATL::CRBMultiMap::CRBMultiMap", "ATLCOLL/ATL::CRBMultiMap::FindFirstWithKey", "ATLCOLL/ATL::CRBMultiMap::GetNextValueWithKey", "ATLCOLL/ATL::CRBMultiMap::GetNextWithKey", "ATLCOLL/ATL::CRBMultiMap::Insert", "ATLCOLL/ATL::CRBMultiMap::RemoveKey"] helpviewer_keywords: ["CRBMultiMap class"] -ms.assetid: 94d3ec0c-3e30-4ab7-a101-d8da4fb8add3 --- # CRBMultiMap Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a mapping structure that allows each key can be associated with more than one value, using a Red-Black binary tree. ## Syntax diff --git a/docs/atl/reference/crbtree-class.md b/docs/atl/reference/crbtree-class.md index 1b37d5c41ee..d755ed2a10c 100644 --- a/docs/atl/reference/crbtree-class.md +++ b/docs/atl/reference/crbtree-class.md @@ -4,10 +4,11 @@ title: "CRBTree Class" ms.date: "11/04/2016" f1_keywords: ["CRBTree", "ATLCOLL/ATL::CRBTree", "ATLCOLL/ATL::CRBTree::KINARGTYPE", "ATLCOLL/ATL::CRBTree::KOUTARGTYPE", "ATLCOLL/ATL::CRBTree::VINARGTYPE", "ATLCOLL/ATL::CRBTree::VOUTARGTYPE", "ATLCOLL/ATL::CRBTree::FindFirstKeyAfter", "ATLCOLL/ATL::CRBTree::GetAt", "ATLCOLL/ATL::CRBTree::GetCount", "ATLCOLL/ATL::CRBTree::GetHeadPosition", "ATLCOLL/ATL::CRBTree::GetKeyAt", "ATLCOLL/ATL::CRBTree::GetNext", "ATLCOLL/ATL::CRBTree::GetNextAssoc", "ATLCOLL/ATL::CRBTree::GetNextKey", "ATLCOLL/ATL::CRBTree::GetNextValue", "ATLCOLL/ATL::CRBTree::GetPrev", "ATLCOLL/ATL::CRBTree::GetTailPosition", "ATLCOLL/ATL::CRBTree::GetValueAt", "ATLCOLL/ATL::CRBTree::IsEmpty", "ATLCOLL/ATL::CRBTree::RemoveAll", "ATLCOLL/ATL::CRBTree::RemoveAt", "ATLCOLL/ATL::CRBTree::SetValueAt"] helpviewer_keywords: ["CRBTree class"] -ms.assetid: a1b1cb63-38e4-4fc2-bb28-f774d1721760 --- # CRBTree Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for creating and utilizing a Red-Black tree. ## Syntax diff --git a/docs/atl/reference/creating-an-atl-project.md b/docs/atl/reference/creating-an-atl-project.md index 0e82550faf9..2b8d1914bda 100644 --- a/docs/atl/reference/creating-an-atl-project.md +++ b/docs/atl/reference/creating-an-atl-project.md @@ -4,10 +4,11 @@ title: "Creating an ATL Project" ms.date: "05/06/2019" f1_keywords: ["vc.appwiz.ATL.project"] helpviewer_keywords: ["ATL projects, creating", "ATL70.DLL", "_ATL_MIN_CRT macro", "distributing files with ATL components"] -ms.assetid: 061d5f98-f669-440e-9380-42f017a0f9e8 --- # Creating an ATL Project +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + The easiest way to create an ATL project is to use the ATL Project Wizard, located in the **Win32 Projects** folder of the **New Project** dialog box. ## To create an ATL project using the ATL Project Wizard diff --git a/docs/atl/reference/cregkey-class.md b/docs/atl/reference/cregkey-class.md index 175495ad2e4..d2510be3e45 100644 --- a/docs/atl/reference/cregkey-class.md +++ b/docs/atl/reference/cregkey-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CRegKey class", "ATL, registry", "registry, deleting valu --- # `CRegKey` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for manipulating entries in the system registry. > [!IMPORTANT] diff --git a/docs/atl/reference/crtthreadtraits-class.md b/docs/atl/reference/crtthreadtraits-class.md index de1edbf63f5..3703ee3ee16 100644 --- a/docs/atl/reference/crtthreadtraits-class.md +++ b/docs/atl/reference/crtthreadtraits-class.md @@ -4,10 +4,11 @@ title: "CRTThreadTraits Class" ms.date: "11/04/2016" f1_keywords: ["CRTThreadTraits", "ATLBASE/ATL::CRTThreadTraits", "ATLBASE/ATL::CRTThreadTraits::CreateThread"] helpviewer_keywords: ["CRTThreadTraits class", "threading [ATL], creation functions", "threading [ATL], CRT threads"] -ms.assetid: eb6e20b0-c2aa-4170-8e34-aaeeacc86343 --- # CRTThreadTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides the creation function for a CRT thread. Use this class if the thread will use CRT functions. > [!IMPORTANT] diff --git a/docs/atl/reference/csacl-class.md b/docs/atl/reference/csacl-class.md index 47717cec068..12157beccdf 100644 --- a/docs/atl/reference/csacl-class.md +++ b/docs/atl/reference/csacl-class.md @@ -4,10 +4,11 @@ title: "CSacl Class" ms.date: "11/04/2016" f1_keywords: ["CSacl", "ATLSECURITY/ATL::CSacl", "ATLSECURITY/ATL::CSacl::CSacl", "ATLSECURITY/ATL::CSacl::AddAuditAce", "ATLSECURITY/ATL::CSacl::GetAceCount", "ATLSECURITY/ATL::CSacl::RemoveAce", "ATLSECURITY/ATL::CSacl::RemoveAllAces"] helpviewer_keywords: ["CSacl class"] -ms.assetid: 8624889b-aebc-4183-9d29-a20f07837f05 --- # CSacl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for a SACL (system access-control list) structure. > [!IMPORTANT] diff --git a/docs/atl/reference/csecurityattributes-class.md b/docs/atl/reference/csecurityattributes-class.md index 7ba2de9becc..ffb68f7fe43 100644 --- a/docs/atl/reference/csecurityattributes-class.md +++ b/docs/atl/reference/csecurityattributes-class.md @@ -4,10 +4,11 @@ title: "CSecurityAttributes Class" ms.date: "11/04/2016" f1_keywords: ["CSecurityAttributes", "ATLSECURITY/ATL::CSecurityAttributes", "ATLSECURITY/ATL::CSecurityAttributes::CSecurityAttributes", "ATLSECURITY/ATL::CSecurityAttributes::Set"] helpviewer_keywords: ["CSecurityAttributes class"] -ms.assetid: a094880c-52e1-4a28-97ff-752d5869908e --- # CSecurityAttributes Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a thin wrapper for the security attributes structure. > [!IMPORTANT] diff --git a/docs/atl/reference/csecuritydesc-class.md b/docs/atl/reference/csecuritydesc-class.md index d5042907684..67f652293ec 100644 --- a/docs/atl/reference/csecuritydesc-class.md +++ b/docs/atl/reference/csecuritydesc-class.md @@ -4,10 +4,11 @@ title: "CSecurityDesc Class" ms.date: "11/04/2016" f1_keywords: ["CSecurityDesc", "ATLSECURITY/ATL::CSecurityDesc", "ATLSECURITY/ATL::CSecurityDesc::CSecurityDesc", "ATLSECURITY/ATL::CSecurityDesc::FromString", "ATLSECURITY/ATL::CSecurityDesc::GetControl", "ATLSECURITY/ATL::CSecurityDesc::GetDacl", "ATLSECURITY/ATL::CSecurityDesc::GetGroup", "ATLSECURITY/ATL::CSecurityDesc::GetOwner", "ATLSECURITY/ATL::CSecurityDesc::GetPSECURITY_DESCRIPTOR", "ATLSECURITY/ATL::CSecurityDesc::GetSacl", "ATLSECURITY/ATL::CSecurityDesc::IsDaclAutoInherited", "ATLSECURITY/ATL::CSecurityDesc::IsDaclDefaulted", "ATLSECURITY/ATL::CSecurityDesc::IsDaclPresent", "ATLSECURITY/ATL::CSecurityDesc::IsDaclProtected", "ATLSECURITY/ATL::CSecurityDesc::IsGroupDefaulted", "ATLSECURITY/ATL::CSecurityDesc::IsOwnerDefaulted", "ATLSECURITY/ATL::CSecurityDesc::IsSaclAutoInherited", "ATLSECURITY/ATL::CSecurityDesc::IsSaclDefaulted", "ATLSECURITY/ATL::CSecurityDesc::IsSaclPresent", "ATLSECURITY/ATL::CSecurityDesc::IsSaclProtected", "ATLSECURITY/ATL::CSecurityDesc::IsSelfRelative", "ATLSECURITY/ATL::CSecurityDesc::MakeAbsolute", "ATLSECURITY/ATL::CSecurityDesc::MakeSelfRelative", "ATLSECURITY/ATL::CSecurityDesc::SetControl", "ATLSECURITY/ATL::CSecurityDesc::SetDacl", "ATLSECURITY/ATL::CSecurityDesc::SetGroup", "ATLSECURITY/ATL::CSecurityDesc::SetOwner", "ATLSECURITY/ATL::CSecurityDesc::SetSacl", "ATLSECURITY/ATL::CSecurityDesc::ToString"] helpviewer_keywords: ["CSecurityDesc class"] -ms.assetid: 3767a327-378f-4690-ba40-4d9f6a1f5ee4 --- # CSecurityDesc Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for the `SECURITY_DESCRIPTOR` structure. > [!IMPORTANT] diff --git a/docs/atl/reference/csid-class.md b/docs/atl/reference/csid-class.md index 49be86aa613..064eaa6ad79 100644 --- a/docs/atl/reference/csid-class.md +++ b/docs/atl/reference/csid-class.md @@ -4,10 +4,11 @@ title: "CSid class" ms.date: "03/27/2019" f1_keywords: ["CSid", "ATLSECURITY/ATL::CSid", "ATLSECURITY/ATL::CSid::CSidArray", "ATLSECURITY/ATL::CSid::CSid", "ATLSECURITY/ATL::CSid::AccountName", "ATLSECURITY/ATL::CSid::Domain", "ATLSECURITY/ATL::CSid::EqualPrefix", "ATLSECURITY/ATL::CSid::GetLength", "ATLSECURITY/ATL::CSid::GetPSID", "ATLSECURITY/ATL::CSid::GetPSID_IDENTIFIER_AUTHORITY", "ATLSECURITY/ATL::CSid::GetSubAuthority", "ATLSECURITY/ATL::CSid::GetSubAuthorityCount", "ATLSECURITY/ATL::CSid::IsValid", "ATLSECURITY/ATL::CSid::LoadAccount", "ATLSECURITY/ATL::CSid::Sid", "ATLSECURITY/ATL::CSid::SidNameUse"] helpviewer_keywords: ["CSid class"] -ms.assetid: be58b7ca-5958-49c3-a833-ca341aaaf753 --- # `CSid` class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for a `SID` (security identifier) structure. > [!IMPORTANT] diff --git a/docs/atl/reference/csimplearray-class.md b/docs/atl/reference/csimplearray-class.md index 12a7cd13323..c9393a904da 100644 --- a/docs/atl/reference/csimplearray-class.md +++ b/docs/atl/reference/csimplearray-class.md @@ -4,10 +4,11 @@ title: "CSimpleArray Class" ms.date: "11/04/2016" f1_keywords: ["CSimpleArray", "ATLSIMPCOLL/ATL::CSimpleArray", "ATLSIMPCOLL/ATL::CSimpleArray::CSimpleArray", "ATLSIMPCOLL/ATL::CSimpleArray::Add", "ATLSIMPCOLL/ATL::CSimpleArray::Find", "ATLSIMPCOLL/ATL::CSimpleArray::GetData", "ATLSIMPCOLL/ATL::CSimpleArray::GetSize", "ATLSIMPCOLL/ATL::CSimpleArray::Remove", "ATLSIMPCOLL/ATL::CSimpleArray::RemoveAll", "ATLSIMPCOLL/ATL::CSimpleArray::RemoveAt", "ATLSIMPCOLL/ATL::CSimpleArray::SetAtIndex"] helpviewer_keywords: ["CSimpleArray class"] -ms.assetid: ee0c9f39-b61c-4c18-bc43-4eada21dca3a --- # CSimpleArray Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for managing a simple array. ## Syntax diff --git a/docs/atl/reference/csimplearrayequalhelper-class.md b/docs/atl/reference/csimplearrayequalhelper-class.md index e88c64cd44f..dd20404054a 100644 --- a/docs/atl/reference/csimplearrayequalhelper-class.md +++ b/docs/atl/reference/csimplearrayequalhelper-class.md @@ -4,10 +4,11 @@ title: "CSimpleArrayEqualHelper Class" ms.date: "11/04/2016" f1_keywords: ["CSimpleArrayEqualHelper", "ATLSIMPCOLL/ATL::CSimpleArrayEqualHelper", "ATLSIMPCOLL/ATL::CSimpleArrayEqualHelper::IsEqual"] helpviewer_keywords: ["CSimpleArrayEqualHelper class"] -ms.assetid: a2b55d89-78c9-42ef-842c-5304c6d20ad6 --- # CSimpleArrayEqualHelper Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a helper for the [CSimpleArray](../../atl/reference/csimplearray-class.md) class. ## Syntax diff --git a/docs/atl/reference/csimplearrayequalhelperfalse-class.md b/docs/atl/reference/csimplearrayequalhelperfalse-class.md index 9b66910ec4e..36ad6022a6d 100644 --- a/docs/atl/reference/csimplearrayequalhelperfalse-class.md +++ b/docs/atl/reference/csimplearrayequalhelperfalse-class.md @@ -4,10 +4,11 @@ title: "CSimpleArrayEqualHelperFalse Class" ms.date: "11/04/2016" f1_keywords: ["CSimpleArrayEqualHelperFalse", "ATLSIMPCOLL/ATL::CSimpleArrayEqualHelperFalse", "ATLSIMPCOLL/ATL::CSimpleArrayEqualHelperFalse::IsEqual"] helpviewer_keywords: ["CSimpleArrayEqualHelperFalse class"] -ms.assetid: 6918af6f-d23d-49eb-8482-c44272f5ffeb --- # CSimpleArrayEqualHelperFalse Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a helper for the [CSimpleArray](../../atl/reference/csimplearray-class.md) class. ## Syntax diff --git a/docs/atl/reference/csimpledialog-class.md b/docs/atl/reference/csimpledialog-class.md index 9650d3ce7c3..ea993e768cc 100644 --- a/docs/atl/reference/csimpledialog-class.md +++ b/docs/atl/reference/csimpledialog-class.md @@ -4,10 +4,11 @@ title: "CSimpleDialog Class" ms.date: "11/04/2016" f1_keywords: ["CSimpleDialog", "ATLWIN/ATL::CSimpleDialog", "ATLWIN/ATL::CSimpleDialog::DoModal"] helpviewer_keywords: ["CSimpleDialog class", "CSimpleDialog class, modal dialog boxes in ATL", "dialog boxes, modal", "modal dialog boxes, ATL"] -ms.assetid: 2ae65cc9-4f32-4168-aecd-200b4a480fdf --- # CSimpleDialog Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements a basic modal dialog box. ## Syntax diff --git a/docs/atl/reference/csimplemap-class.md b/docs/atl/reference/csimplemap-class.md index 50f20403759..ce0d4f90990 100644 --- a/docs/atl/reference/csimplemap-class.md +++ b/docs/atl/reference/csimplemap-class.md @@ -4,10 +4,11 @@ title: "CSimpleMap Class" ms.date: "11/04/2016" f1_keywords: ["CSimpleMap", "ATLSIMPCOLL/ATL::CSimpleMap", "ATLSIMPCOLL/ATL::CSimpleMap::_ArrayElementType", "ATLSIMPCOLL/ATL::CSimpleMap::_ArrayKeyType", "ATLSIMPCOLL/ATL::CSimpleMap::CSimpleMap", "ATLSIMPCOLL/ATL::CSimpleMap::Add", "ATLSIMPCOLL/ATL::CSimpleMap::FindKey", "ATLSIMPCOLL/ATL::CSimpleMap::FindVal", "ATLSIMPCOLL/ATL::CSimpleMap::GetKeyAt", "ATLSIMPCOLL/ATL::CSimpleMap::GetSize", "ATLSIMPCOLL/ATL::CSimpleMap::GetValueAt", "ATLSIMPCOLL/ATL::CSimpleMap::Lookup", "ATLSIMPCOLL/ATL::CSimpleMap::Remove", "ATLSIMPCOLL/ATL::CSimpleMap::RemoveAll", "ATLSIMPCOLL/ATL::CSimpleMap::RemoveAt", "ATLSIMPCOLL/ATL::CSimpleMap::ReverseLookup", "ATLSIMPCOLL/ATL::CSimpleMap::SetAt", "ATLSIMPCOLL/ATL::CSimpleMap::SetAtIndex"] helpviewer_keywords: ["CSimpleMap class"] -ms.assetid: 61b06eb4-ae73-44b0-a305-0afb5a33e8b1 --- # CSimpleMap Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides support for a simple mapping array. ## Syntax diff --git a/docs/atl/reference/csimplemapequalhelper-class.md b/docs/atl/reference/csimplemapequalhelper-class.md index 05c3178fdaa..ad384ff61db 100644 --- a/docs/atl/reference/csimplemapequalhelper-class.md +++ b/docs/atl/reference/csimplemapequalhelper-class.md @@ -4,10 +4,11 @@ title: "CSimpleMapEqualHelper Class" ms.date: "11/04/2016" f1_keywords: ["CSimpleMapEqualHelper", "ATLSIMPCOLL/ATL::CSimpleMapEqualHelper", "ATLSIMPCOLL/ATL::CSimpleMapEqualHelper::IsEqualKey", "ATLSIMPCOLL/ATL::CSimpleMapEqualHelper::IsEqualValue"] helpviewer_keywords: ["CSimpleMapEqualHelper class"] -ms.assetid: 9bb2968a-d609-405c-8272-ff3b42df6164 --- # CSimpleMapEqualHelper Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a helper for the [CSimpleMap](../../atl/reference/csimplemap-class.md) class. ## Syntax diff --git a/docs/atl/reference/csimplemapequalhelperfalse-class.md b/docs/atl/reference/csimplemapequalhelperfalse-class.md index 97e43c2e59e..0be6f6a9539 100644 --- a/docs/atl/reference/csimplemapequalhelperfalse-class.md +++ b/docs/atl/reference/csimplemapequalhelperfalse-class.md @@ -4,10 +4,11 @@ title: "CSimpleMapEqualHelperFalse Class" ms.date: "11/04/2016" f1_keywords: ["CSimpleMapEqualHelperFalse", "ATLSIMPCOLL/ATL::CSimpleMapEqualHelperFalse", "ATLSIMPCOLL/ATL::CSimpleMapEqualHelperFalse::IsEqualKey", "ATLSIMPCOLL/ATL::CSimpleMapEqualHelperFalse::IsEqualValue"] helpviewer_keywords: ["CSimpleMapEqualHelperFalse class"] -ms.assetid: a873eea3-e130-45cc-a476-61ee79511c3b --- # CSimpleMapEqualHelperFalse Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a helper for the [CSimpleMap](../../atl/reference/csimplemap-class.md) class. ## Syntax diff --git a/docs/atl/reference/csnapinitemimpl-class.md b/docs/atl/reference/csnapinitemimpl-class.md index b302a376c2c..b9c745e5ff1 100644 --- a/docs/atl/reference/csnapinitemimpl-class.md +++ b/docs/atl/reference/csnapinitemimpl-class.md @@ -4,10 +4,11 @@ title: "CSnapInItemImpl Class" ms.date: "11/04/2016" f1_keywords: ["CSnapInItemImpl", "ATLSNAP/ATL::CSnapInItemImpl", "ATLSNAP/ATL::CSnapInItemImpl::CSnapInItemImpl", "ATLSNAP/ATL::CSnapInItemImpl::AddMenuItems", "ATLSNAP/ATL::CSnapInItemImpl::Command", "ATLSNAP/ATL::CSnapInItemImpl::CreatePropertyPages", "ATLSNAP/ATL::CSnapInItemImpl::FillData", "ATLSNAP/ATL::CSnapInItemImpl::GetResultPaneInfo", "ATLSNAP/ATL::CSnapInItemImpl::GetResultViewType", "ATLSNAP/ATL::CSnapInItemImpl::GetScopePaneInfo", "ATLSNAP/ATL::CSnapInItemImpl::Notify", "ATLSNAP/ATL::CSnapInItemImpl::QueryPagesFor", "ATLSNAP/ATL::CSnapInItemImpl::SetMenuInsertionFlags", "ATLSNAP/ATL::CSnapInItemImpl::SetToolbarButtonInfo", "ATLSNAP/ATL::CSnapInItemImpl::UpdateMenuState", "ATLSNAP/ATL::CSnapInItemImpl::UpdateToolbarButton", "ATLSNAP/ATL::CSnapInItemImpl::m_bstrDisplayName", "ATLSNAP/ATL::CSnapInItemImpl::m_resultDataItem", "ATLSNAP/ATL::CSnapInItemImpl::m_scopeDataItem"] helpviewer_keywords: ["snap-ins, data items", "snap-ins, ATL support for", "CSnapInItemImpl class", "snap-ins"] -ms.assetid: 52caefbd-9eae-49b0-add2-d55524271aa7 --- # CSnapInItemImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for implementing a snap-in node object. > [!IMPORTANT] diff --git a/docs/atl/reference/csnapinpropertypageimpl-class.md b/docs/atl/reference/csnapinpropertypageimpl-class.md index e7cd51b1c78..ab78fc1e15c 100644 --- a/docs/atl/reference/csnapinpropertypageimpl-class.md +++ b/docs/atl/reference/csnapinpropertypageimpl-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["snap-ins, property pages", "snap-ins", "property pages, A --- # CSnapInPropertyPageImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for implementing a snap-in property page object. > [!IMPORTANT] diff --git a/docs/atl/reference/csocketaddr-class.md b/docs/atl/reference/csocketaddr-class.md index de051c6ae62..5a186823dce 100644 --- a/docs/atl/reference/csocketaddr-class.md +++ b/docs/atl/reference/csocketaddr-class.md @@ -4,10 +4,11 @@ title: "CSocketAddr Class" ms.date: "10/22/2018" f1_keywords: ["CSocketAddr", "ATLSOCKET/ATL::CSocketAddr", "ATLSOCKET/ATL::CSocketAddr::CSocketAddr", "ATLSOCKET/ATL::CSocketAddr::FindAddr", "ATLSOCKET/ATL::CSocketAddr::FindINET4Addr", "ATLSOCKET/ATL::CSocketAddr::FindINET6Addr", "ATLSOCKET/ATL::CSocketAddr::GetAddrInfo", "ATLSOCKET/ATL::CSocketAddr::GetAddrInfoList"] helpviewer_keywords: ["CSocketAddr class"] -ms.assetid: 2fb2d8a7-899e-4a36-a342-cc9f4fcdd68c --- # CSocketAddr Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for converting host names to host addresses, supporting both IPv4 and IPV6 formats. ## Syntax diff --git a/docs/atl/reference/cstockpropimpl-class.md b/docs/atl/reference/cstockpropimpl-class.md index 1f4959941f7..0b5fc8d9fc6 100644 --- a/docs/atl/reference/cstockpropimpl-class.md +++ b/docs/atl/reference/cstockpropimpl-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CStockPropImpl class", "controls [ATL], stock properties" --- # CStockPropImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for supporting stock property values. > [!IMPORTANT] diff --git a/docs/atl/reference/cstringelementtraits-class.md b/docs/atl/reference/cstringelementtraits-class.md index d314865a597..93cb8ccf5a2 100644 --- a/docs/atl/reference/cstringelementtraits-class.md +++ b/docs/atl/reference/cstringelementtraits-class.md @@ -4,10 +4,11 @@ title: "CStringElementTraits Class" ms.date: "11/04/2016" f1_keywords: ["CStringElementTraits", "CSTRINGT/ATL::CStringElementTraits", "CSTRINGT/ATL::CStringElementTraits::INARGTYPE", "CSTRINGT/ATL::CStringElementTraits::OUTARGTYPE", "CSTRINGT/ATL::CStringElementTraits::CompareElements", "CSTRINGT/ATL::CStringElementTraits::CompareElementsOrdered", "CSTRINGT/ATL::CStringElementTraits::CopyElements", "CSTRINGT/ATL::CStringElementTraits::Hash", "CSTRINGT/ATL::CStringElementTraits::RelocateElements"] helpviewer_keywords: ["CStringElementTraits class"] -ms.assetid: 74d7134b-099d-4455-bf91-3e68ccbf95bc --- # CStringElementTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides static functions used by collection classes storing `CString` objects. ## Syntax diff --git a/docs/atl/reference/cstringelementtraitsi-class.md b/docs/atl/reference/cstringelementtraitsi-class.md index 089e89ec285..41f472f6925 100644 --- a/docs/atl/reference/cstringelementtraitsi-class.md +++ b/docs/atl/reference/cstringelementtraitsi-class.md @@ -4,10 +4,11 @@ title: "CStringElementTraitsI Class" ms.date: "11/04/2016" f1_keywords: ["CStringElementTraitsI", "ATLCOLL/ATL::CStringElementTraitsI", "ATLCOLL/ATL::CStringElementTraitsI::INARGTYPE", "ATLCOLL/ATL::CStringElementTraitsI::OUTARGTYPE", "ATLCOLL/ATL::CStringElementTraitsI::CompareElements", "ATLCOLL/ATL::CStringElementTraitsI::CompareElementsOrdered", "ATLCOLL/ATL::CStringElementTraitsI::Hash"] helpviewer_keywords: ["CStringElementTraitsI class"] -ms.assetid: c23f92b1-91e5-400f-96ed-258b02622b7a --- # CStringElementTraitsI Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides static functions related to strings stored in collection class objects. It is similar to [CStringElementTraits](../../atl/reference/cstringelementtraits-class.md), but performs case-insensitive comparisons. ## Syntax diff --git a/docs/atl/reference/cstringrefelementtraits-class.md b/docs/atl/reference/cstringrefelementtraits-class.md index ed14c61490e..1973a6ed2fb 100644 --- a/docs/atl/reference/cstringrefelementtraits-class.md +++ b/docs/atl/reference/cstringrefelementtraits-class.md @@ -4,10 +4,11 @@ title: "CStringRefElementTraits Class" ms.date: "11/04/2016" f1_keywords: ["CStringRefElementTraits", "ATLCOLL/ATL::CStringRefElementTraits", "ATLCOLL/ATL::CStringRefElementTraits::CompareElements", "ATLCOLL/ATL::CStringRefElementTraits::CompareElementsOrdered", "ATLCOLL/ATL::CStringRefElementTraits::Hash"] helpviewer_keywords: ["CStringRefElementTraits class"] -ms.assetid: cc15062d-5627-46cc-ac2b-1744afdc2dbd --- # CStringRefElementTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides static functions related to strings stored in collection class objects. The string objects are dealt with as references. ## Syntax diff --git a/docs/atl/reference/cthreadpool-class.md b/docs/atl/reference/cthreadpool-class.md index 0cca6b473fa..a9760e62914 100644 --- a/docs/atl/reference/cthreadpool-class.md +++ b/docs/atl/reference/cthreadpool-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CThreadPool class"] --- # CThreadPool Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a pool of worker threads that process a queue of work items. ## Syntax diff --git a/docs/atl/reference/ctokengroups-class.md b/docs/atl/reference/ctokengroups-class.md index 50ca0053c9b..08dfba3fbf9 100644 --- a/docs/atl/reference/ctokengroups-class.md +++ b/docs/atl/reference/ctokengroups-class.md @@ -4,10 +4,11 @@ title: "CTokenGroups Class" ms.date: "11/04/2016" f1_keywords: ["CTokenGroups", "ATLSECURITY/ATL::CTokenGroups", "ATLSECURITY/ATL::CTokenGroups::CTokenGroups", "ATLSECURITY/ATL::CTokenGroups::Add", "ATLSECURITY/ATL::CTokenGroups::Delete", "ATLSECURITY/ATL::CTokenGroups::DeleteAll", "ATLSECURITY/ATL::CTokenGroups::GetCount", "ATLSECURITY/ATL::CTokenGroups::GetLength", "ATLSECURITY/ATL::CTokenGroups::GetPTOKEN_GROUPS", "ATLSECURITY/ATL::CTokenGroups::GetSidsAndAttributes", "ATLSECURITY/ATL::CTokenGroups::LookupSid"] helpviewer_keywords: ["CTokenGroups class"] -ms.assetid: 2ab08076-4b08-4487-bc70-ec6dee304190 --- # CTokenGroups Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for the `TOKEN_GROUPS` structure. > [!IMPORTANT] diff --git a/docs/atl/reference/ctokenprivileges-class.md b/docs/atl/reference/ctokenprivileges-class.md index df23437d13c..43abc2e7c6c 100644 --- a/docs/atl/reference/ctokenprivileges-class.md +++ b/docs/atl/reference/ctokenprivileges-class.md @@ -4,10 +4,11 @@ title: "CTokenPrivileges Class" ms.date: "11/04/2016" f1_keywords: ["CTokenPrivileges", "ATLSECURITY/ATL::CTokenPrivileges", "ATLSECURITY/ATL::CTokenPrivileges::CTokenPrivileges", "ATLSECURITY/ATL::CTokenPrivileges::Add", "ATLSECURITY/ATL::CTokenPrivileges::Delete", "ATLSECURITY/ATL::CTokenPrivileges::DeleteAll", "ATLSECURITY/ATL::CTokenPrivileges::GetCount", "ATLSECURITY/ATL::CTokenPrivileges::GetDisplayNames", "ATLSECURITY/ATL::CTokenPrivileges::GetLength", "ATLSECURITY/ATL::CTokenPrivileges::GetLuidsAndAttributes", "ATLSECURITY/ATL::CTokenPrivileges::GetNamesAndAttributes", "ATLSECURITY/ATL::CTokenPrivileges::GetPTOKEN_PRIVILEGES", "ATLSECURITY/ATL::CTokenPrivileges::LookupPrivilege"] helpviewer_keywords: ["CTokenPrivileges class"] -ms.assetid: 89590105-f001-4014-870d-142926091231 --- # CTokenPrivileges Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is a wrapper for the `TOKEN_PRIVILEGES` structure. > [!IMPORTANT] diff --git a/docs/atl/reference/curl-class.md b/docs/atl/reference/curl-class.md index ff1a201f3fc..1676b7244ed 100644 --- a/docs/atl/reference/curl-class.md +++ b/docs/atl/reference/curl-class.md @@ -4,10 +4,11 @@ title: "CUrl Class" ms.date: "05/06/2019" f1_keywords: ["CUrl", "ATLUTIL/ATL::CUrl", "ATLUTIL/ATL::CUrl::CUrl", "ATLUTIL/ATL::CUrl::Canonicalize", "ATLUTIL/ATL::CUrl::Clear", "ATLUTIL/ATL::CUrl::CrackUrl", "ATLUTIL/ATL::CUrl::CreateUrl", "ATLUTIL/ATL::CUrl::GetExtraInfo", "ATLUTIL/ATL::CUrl::GetExtraInfoLength", "ATLUTIL/ATL::CUrl::GetHostName", "ATLUTIL/ATL::CUrl::GetHostNameLength", "ATLUTIL/ATL::CUrl::GetPassword", "ATLUTIL/ATL::CUrl::GetPasswordLength", "ATLUTIL/ATL::CUrl::GetPortNumber", "ATLUTIL/ATL::CUrl::GetScheme", "ATLUTIL/ATL::CUrl::GetSchemeName", "ATLUTIL/ATL::CUrl::GetSchemeNameLength", "ATLUTIL/ATL::CUrl::GetUrlLength", "ATLUTIL/ATL::CUrl::GetUrlPath", "ATLUTIL/ATL::CUrl::GetUrlPathLength", "ATLUTIL/ATL::CUrl::GetUserName", "ATLUTIL/ATL::CUrl::GetUserNameLength", "ATLUTIL/ATL::CUrl::SetExtraInfo", "ATLUTIL/ATL::CUrl::SetHostName", "ATLUTIL/ATL::CUrl::SetPassword", "ATLUTIL/ATL::CUrl::SetPortNumber", "ATLUTIL/ATL::CUrl::SetScheme", "ATLUTIL/ATL::CUrl::SetSchemeName", "ATLUTIL/ATL::CUrl::SetUrlPath", "ATLUTIL/ATL::CUrl::SetUserName"] helpviewer_keywords: ["CUrl class"] -ms.assetid: b3894d34-47b9-4961-9719-4197153793da --- # CUrl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents a URL. It allows you to manipulate each element of the URL independently of the others whether parsing an existing URL string or building a string from scratch. > [!IMPORTANT] diff --git a/docs/atl/reference/cw2aex-class.md b/docs/atl/reference/cw2aex-class.md index 9029cccbe76..ef2b3d63263 100644 --- a/docs/atl/reference/cw2aex-class.md +++ b/docs/atl/reference/cw2aex-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CW2AEX class"] --- # `CW2AEX` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is used by the string conversion macros `CT2AEX`, `CW2TEX`, `CW2CTEX`, and `CT2CAEX`, and the typedef `CW2A`. > [!IMPORTANT] diff --git a/docs/atl/reference/cw2cwex-class.md b/docs/atl/reference/cw2cwex-class.md index 58df28f8f63..c00e6ef2143 100644 --- a/docs/atl/reference/cw2cwex-class.md +++ b/docs/atl/reference/cw2cwex-class.md @@ -4,10 +4,11 @@ title: "CW2CWEX Class" ms.date: "11/04/2016" f1_keywords: ["CW2CWEX", "ATLCONV/ATL::CW2CWEX", "ATLCONV/ATL::CW2CWEX::CW2CWEX", "ATLCONV/ATL::CW2CWEX::m_psz"] helpviewer_keywords: ["CW2CWEX class"] -ms.assetid: d654b22b-05a6-410f-a0ec-9a2cbbb4cca7 --- # CW2CWEX Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is used by the string conversion macros CW2CTEX and CT2CWEX, and the typedef CW2W. > [!IMPORTANT] diff --git a/docs/atl/reference/cw2wex-class.md b/docs/atl/reference/cw2wex-class.md index d5c15f69f2e..7148e484e49 100644 --- a/docs/atl/reference/cw2wex-class.md +++ b/docs/atl/reference/cw2wex-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CW2WEX class"] --- # CW2WEX Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class is used by the string conversion macros CW2TEX and CT2WEX, and the typedef CW2W. > [!IMPORTANT] diff --git a/docs/atl/reference/cwin32heap-class.md b/docs/atl/reference/cwin32heap-class.md index 8c69f91f153..0076ab7e2c0 100644 --- a/docs/atl/reference/cwin32heap-class.md +++ b/docs/atl/reference/cwin32heap-class.md @@ -4,10 +4,11 @@ title: "CWin32Heap Class" ms.date: "11/04/2016" f1_keywords: ["CWin32Heap", "ATLMEM/ATL::CWin32Heap", "ATLMEM/ATL::CWin32Heap::CWin32Heap", "ATLMEM/ATL::CWin32Heap::Allocate", "ATLMEM/ATL::CWin32Heap::Attach", "ATLMEM/ATL::CWin32Heap::Detach", "ATLMEM/ATL::CWin32Heap::Free", "ATLMEM/ATL::CWin32Heap::GetSize", "ATLMEM/ATL::CWin32Heap::Reallocate", "ATLMEM/ATL::CWin32Heap::m_bOwnHeap", "ATLMEM/ATL::CWin32Heap::m_hHeap"] helpviewer_keywords: ["CWin32Heap class"] -ms.assetid: 69176022-ed98-4e3b-96d8-116b0c58ac95 --- # CWin32Heap Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements [IAtlMemMgr](../../atl/reference/iatlmemmgr-class.md) using the Win32 heap allocation functions. > [!IMPORTANT] diff --git a/docs/atl/reference/cwindow-class.md b/docs/atl/reference/cwindow-class.md index c91fae3db68..99016859b08 100644 --- a/docs/atl/reference/cwindow-class.md +++ b/docs/atl/reference/cwindow-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["CWindow class"] --- # `CWindow` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for manipulating a window. > [!IMPORTANT] diff --git a/docs/atl/reference/cwindowimpl-class.md b/docs/atl/reference/cwindowimpl-class.md index d2041bc669a..bfd4e676f0c 100644 --- a/docs/atl/reference/cwindowimpl-class.md +++ b/docs/atl/reference/cwindowimpl-class.md @@ -4,10 +4,11 @@ title: "CWindowImpl Class" ms.date: "11/04/2016" f1_keywords: ["CWindowImpl", "ATLWIN/ATL::CWindowImpl", "ATLWIN/ATL::CWindowImpl::Create", "ATLWIN/ATL::CWindowImpl::DefWindowProc", "ATLWIN/ATL::CWindowImpl::GetCurrentMessage", "ATLWIN/ATL::CWindowImpl::GetWindowProc", "ATLWIN/ATL::CWindowImpl::OnFinalMessage", "ATLWIN/ATL::CWindowImpl::SubclassWindow", "ATLWIN/ATL::CWindowImpl::UnsubclassWindow", "ATLWIN/ATL::CWindowImpl::GetWndClassInfo", "ATLWIN/ATL::CWindowImpl::WindowProc", "ATLWIN/ATL::CWindowImpl::m_pfnSuperWindowProc"] helpviewer_keywords: ["CWindowImpl class", "subclassing windows, ATL"] -ms.assetid: 02eefd45-a0a6-4d1b-99f6-dbf627e2cc2f --- # CWindowImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Provides methods for creating or subclassing a window. > [!IMPORTANT] diff --git a/docs/atl/reference/cwintraits-class.md b/docs/atl/reference/cwintraits-class.md index e7d7b65eabc..123d908d88a 100644 --- a/docs/atl/reference/cwintraits-class.md +++ b/docs/atl/reference/cwintraits-class.md @@ -4,10 +4,11 @@ title: "CWinTraits Class" ms.date: "11/04/2016" f1_keywords: ["CWinTraits", "ATLWIN/ATL::CWinTraits", "ATLWIN/ATL::CWinTraits::GetWndExStyle", "ATLWIN/ATL::CWinTraits::GetWndStyle"] helpviewer_keywords: ["CMDIChildWinTraits class", "window styles, default values for ATL", "CWinTraits class", "CFrameWinTraits class", "CControlWinTraits class"] -ms.assetid: f78f486e-6d9c-42c6-8e86-371e05aa7e59 --- # CWinTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a method for standardizing the styles used when creating a window object. > [!IMPORTANT] diff --git a/docs/atl/reference/cwintraitsor-class.md b/docs/atl/reference/cwintraitsor-class.md index fbc54c0034a..8f6c147d330 100644 --- a/docs/atl/reference/cwintraitsor-class.md +++ b/docs/atl/reference/cwintraitsor-class.md @@ -4,10 +4,11 @@ title: "CWinTraitsOR Class" ms.date: "11/04/2016" f1_keywords: ["CWinTraitsOR", "ATLWIN/ATL::CWinTraitsOR", "ATLWIN/ATL::CWinTraitsOR::GetWndExStyle", "ATLWIN/ATL::CWinTraitsOR::GetWndStyle"] helpviewer_keywords: ["CWinTraitsOR class", "window styles, default values for ATL"] -ms.assetid: 1eb7b1e8-a9bd-411b-a30a-35a8a10af989 --- # CWinTraitsOR Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a method for standardizing the styles used when creating a window object. > [!IMPORTANT] diff --git a/docs/atl/reference/cwndclassinfo-class.md b/docs/atl/reference/cwndclassinfo-class.md index 0ac47624556..4cbf31cfbf4 100644 --- a/docs/atl/reference/cwndclassinfo-class.md +++ b/docs/atl/reference/cwndclassinfo-class.md @@ -4,10 +4,11 @@ title: "CWndClassInfo Class" ms.date: "11/04/2016" f1_keywords: ["CWndClassInfo", "ATLWIN/ATL::CWndClassInfo", "ATLWIN/ATL::Register", "ATLWIN/ATL::m_atom", "ATLWIN/ATL::m_bSystemCursor", "ATLWIN/ATL::m_lpszCursorID", "ATLWIN/ATL::m_lpszOrigName", "ATLWIN/ATL::m_szAutoName", "ATLWIN/ATL::m_wc", "ATLWIN/ATL::pWndProc"] helpviewer_keywords: ["CWndClassInfo class"] -ms.assetid: c36fe7e1-75f1-4cf5-a06f-9f59c43fe6fb --- # CWndClassInfo Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for registering information for a window class. > [!IMPORTANT] diff --git a/docs/atl/reference/cworkerthread-class.md b/docs/atl/reference/cworkerthread-class.md index a0171833ba9..8e3c4e5cbb1 100644 --- a/docs/atl/reference/cworkerthread-class.md +++ b/docs/atl/reference/cworkerthread-class.md @@ -4,10 +4,11 @@ title: "CWorkerThread Class" ms.date: "11/04/2016" f1_keywords: ["CWorkerThread", "ATLUTIL/ATL::CWorkerThread", "ATLUTIL/ATL::CWorkerThread::CWorkerThread", "ATLUTIL/ATL::CWorkerThread::AddHandle", "ATLUTIL/ATL::CWorkerThread::AddTimer", "ATLUTIL/ATL::CWorkerThread::GetThreadHandle", "ATLUTIL/ATL::CWorkerThread::GetThreadId", "ATLUTIL/ATL::CWorkerThread::Initialize", "ATLUTIL/ATL::CWorkerThread::RemoveHandle", "ATLUTIL/ATL::CWorkerThread::Shutdown"] helpviewer_keywords: ["CWorkerThread class"] -ms.assetid: be79a832-1345-4a36-a13e-a406cc65286f --- # CWorkerThread Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class creates a worker thread or uses an existing one, waits on one or more kernel object handles, and executes a specified client function when one of the handles is signaled. > [!IMPORTANT] diff --git a/docs/atl/reference/debugging-and-error-reporting-global-functions.md b/docs/atl/reference/debugging-and-error-reporting-global-functions.md index defba9ea3c3..0d293887fd6 100644 --- a/docs/atl/reference/debugging-and-error-reporting-global-functions.md +++ b/docs/atl/reference/debugging-and-error-reporting-global-functions.md @@ -4,10 +4,11 @@ title: "Debugging and Error Reporting Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlcomcli/ATL::AtlHresultFromLastError", "atlcom/ATL::AtlReportError", "atldef/ATL::AtlThrow"] helpviewer_keywords: ["functions [ATL], error reporting"] -ms.assetid: 11339c02-98cd-428d-b3b9-7deeb155a6a3 --- # Debugging and Error Reporting Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions provide useful debugging and trace facilities. |Name|Description| diff --git a/docs/atl/reference/debugging-and-error-reporting-macros.md b/docs/atl/reference/debugging-and-error-reporting-macros.md index 463ef4c0072..c5d43762cfc 100644 --- a/docs/atl/reference/debugging-and-error-reporting-macros.md +++ b/docs/atl/reference/debugging-and-error-reporting-macros.md @@ -4,10 +4,11 @@ title: "Debugging and Error Reporting Macros" ms.date: "05/06/2019" f1_keywords: ["atldef/ATL::_ATL_DEBUG_INTERFACES", "atldef/ATL::_ATL_DEBUG_QI", "atldef/ATL::ATLASSERT", "afx/ATL::ATLENSURE", "atltrace/ATL::ATLTRACENOTIMPL", "atltrace/ATL::ATLTRACE", "ATLDEF/_ATL_DEBUG_INTERFACES", "ATLDEF/_ATL_DEBUG_QI", "ATLDEF/ATLASSERT", "AFX/ATLENSURE", "ATLTRACE/ATLTRACENOTIMPL", "ATLTRACE/ATLTRACE", "ATLDEF/ATLSTATIC_ASSERT"] helpviewer_keywords: ["macros, error reporting"] -ms.assetid: 4da9b87f-ec5c-4a32-ab93-637780909b9d --- # Debugging and Error Reporting Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros provide useful debugging and trace facilities. |Name|Description| diff --git a/docs/atl/reference/default-atl-project-configurations.md b/docs/atl/reference/default-atl-project-configurations.md index 0b8caec7af5..bca92e9bb53 100644 --- a/docs/atl/reference/default-atl-project-configurations.md +++ b/docs/atl/reference/default-atl-project-configurations.md @@ -3,10 +3,11 @@ description: "Learn more about: Default ATL Project Configurations" title: "Default ATL Project Configurations" ms.date: "10/20/2017" helpviewer_keywords: ["ATL projects, default configurations"] -ms.assetid: 7e272722-41af-4330-b965-a6d74ec16880 --- # Default ATL Project Configurations +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + The ATL Project Wizard creates two project configurations by default: |Configuration|Character set|Use of ATL| diff --git a/docs/atl/reference/device-context-global-functions.md b/docs/atl/reference/device-context-global-functions.md index 7ef43f0431e..0720fd8042b 100644 --- a/docs/atl/reference/device-context-global-functions.md +++ b/docs/atl/reference/device-context-global-functions.md @@ -3,10 +3,11 @@ description: "Learn more about: Device Context Global Functions" title: "Device Context Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlwin/ATL::AtlCreateTargetDC"] -ms.assetid: 08ec28f6-daff-4882-9544-e8a4639d05c4 --- # Device Context Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This function creates a device context for a given device. |Name|Description| diff --git a/docs/atl/reference/event-handling-global-functions.md b/docs/atl/reference/event-handling-global-functions.md index 69c6f619b65..f5948e23c2d 100644 --- a/docs/atl/reference/event-handling-global-functions.md +++ b/docs/atl/reference/event-handling-global-functions.md @@ -4,10 +4,11 @@ title: "Event Handling Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlbase/ATL::AtlWaitWithMessageLoop"] helpviewer_keywords: ["event handling, global functions", "global functions, event handling"] -ms.assetid: fd674470-3def-47c3-be1c-894fa85f13e8 --- # Event Handling Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This function provides an event handler. > [!IMPORTANT] diff --git a/docs/atl/reference/exception-handling-macros.md b/docs/atl/reference/exception-handling-macros.md index 44f99934523..fe201b9e3a1 100644 --- a/docs/atl/reference/exception-handling-macros.md +++ b/docs/atl/reference/exception-handling-macros.md @@ -4,10 +4,11 @@ title: "Exception Handling Macros" ms.date: "11/04/2016" f1_keywords: ["atldef/ATL::_ATLCATCH", "atldef/ATL::_ATLCATCHALL", "atldef/ATL::_ATLTRY", "ATLDEF/_ATLCATCH", "ATLDEF/_ATLCATCHALL", "ATLDEF/_ATLTRY"] helpviewer_keywords: ["exception handling, macros", "C++ exception handling, macros"] -ms.assetid: a8385d34-3fb0-4006-a42a-de045cacf0f4 --- # Exception Handling Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros provide support for exception handling. |Name|Description| diff --git a/docs/atl/reference/iatlautothreadmodule-class.md b/docs/atl/reference/iatlautothreadmodule-class.md index 42df620330a..f83105ba786 100644 --- a/docs/atl/reference/iatlautothreadmodule-class.md +++ b/docs/atl/reference/iatlautothreadmodule-class.md @@ -4,10 +4,11 @@ title: "IAtlAutoThreadModule Class" ms.date: "11/04/2016" f1_keywords: ["IAtlAutoThreadModule", "atlbase/ATL::IAtlAutoThreadModule"] helpviewer_keywords: ["IAtlAutoThreadModule class"] -ms.assetid: fcb58cf9-a427-4be9-89eb-04e1ab5cc3a1 --- # IAtlAutoThreadModule Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents an interface to a `CreateInstance` method. > [!IMPORTANT] diff --git a/docs/atl/reference/iatlmemmgr-class.md b/docs/atl/reference/iatlmemmgr-class.md index 46acd301740..5df51a5cfc1 100644 --- a/docs/atl/reference/iatlmemmgr-class.md +++ b/docs/atl/reference/iatlmemmgr-class.md @@ -4,10 +4,11 @@ title: "IAtlMemMgr Class" ms.date: "11/04/2016" f1_keywords: ["IAtlMemMgr", "ATLMEM/ATL::IAtlMemMgr", "ATLMEM/ATL::Allocate", "ATLMEM/ATL::Free", "ATLMEM/ATL::GetSize", "ATLMEM/ATL::Reallocate"] helpviewer_keywords: ["IAtlMemMgr class", "memory, managing", "memory, memory manager"] -ms.assetid: 18b2c569-25fe-4464-bdb6-3b1abef7154a --- # IAtlMemMgr Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class represents the interface to a memory manager. ## Syntax diff --git a/docs/atl/reference/iaxwinambientdispatch-interface.md b/docs/atl/reference/iaxwinambientdispatch-interface.md index f1799cf5b26..4810d037297 100644 --- a/docs/atl/reference/iaxwinambientdispatch-interface.md +++ b/docs/atl/reference/iaxwinambientdispatch-interface.md @@ -4,10 +4,11 @@ title: "IAxWinAmbientDispatch Interface" ms.date: "11/04/2016" f1_keywords: ["IAxWinAmbientDispatch", "ATLIFACE/ATL::IAxWinAmbientDispatch", "ATLIFACE/ATL::get_AllowContextMenu", "ATLIFACE/ATL::get_AllowShowUI", "ATLIFACE/ATL::get_AllowWindowlessActivation", "ATLIFACE/ATL::get_BackColor", "ATLIFACE/ATL::get_DisplayAsDefault", "ATLIFACE/ATL::get_DocHostDoubleClickFlags", "ATLIFACE/ATL::get_DocHostFlags", "ATLIFACE/ATL::get_Font", "ATLIFACE/ATL::get_ForeColor", "ATLIFACE/ATL::get_LocaleID", "ATLIFACE/ATL::get_MessageReflect", "ATLIFACE/ATL::get_OptionKeyPath", "ATLIFACE/ATL::get_ShowGrabHandles", "ATLIFACE/ATL::get_ShowHatching", "ATLIFACE/ATL::get_UserMode", "ATLIFACE/ATL::put_AllowContextMenu", "ATLIFACE/ATL::put_AllowShowUI", "ATLIFACE/ATL::put_AllowWindowlessActivation", "ATLIFACE/ATL::put_BackColor", "ATLIFACE/ATL::put_DisplayAsDefault", "ATLIFACE/ATL::put_DocHostDoubleClickFlags", "ATLIFACE/ATL::put_DocHostFlags", "ATLIFACE/ATL::put_Font", "ATLIFACE/ATL::put_ForeColor", "ATLIFACE/ATL::put_LocaleID", "ATLIFACE/ATL::put_MessageReflect", "ATLIFACE/ATL::put_OptionKeyPath", "ATLIFACE/ATL::put_UserMode"] helpviewer_keywords: ["IAxWinAmbientDispatch interface"] -ms.assetid: 55ba6f7b-7a3c-4792-ae47-c8a84b683ca9 --- # IAxWinAmbientDispatch Interface +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This interface provides methods for specifying characteristics of the hosted control or container. > [!IMPORTANT] diff --git a/docs/atl/reference/iaxwinambientdispatchex-interface.md b/docs/atl/reference/iaxwinambientdispatchex-interface.md index 4df19f4e982..45190ff5ecb 100644 --- a/docs/atl/reference/iaxwinambientdispatchex-interface.md +++ b/docs/atl/reference/iaxwinambientdispatchex-interface.md @@ -4,10 +4,11 @@ title: "IAxWinAmbientDispatchEx Interface" ms.date: "11/04/2016" f1_keywords: ["IAxWinAmbientDispatchEx", "ATLIFACE/ATL::IAxWinAmbientDispatchEx", "ATLIFACE/ATL::SetAmbientDispatch"] helpviewer_keywords: ["IAxWinAmbientDispatchEx interface"] -ms.assetid: 2c25e079-6128-4278-bc72-b2c6195ba7ef --- # IAxWinAmbientDispatchEx Interface +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This interface implements supplemental ambient properties for a hosted control. > [!IMPORTANT] diff --git a/docs/atl/reference/iaxwinhostwindow-interface.md b/docs/atl/reference/iaxwinhostwindow-interface.md index 38ea65043d6..9b981a96ee3 100644 --- a/docs/atl/reference/iaxwinhostwindow-interface.md +++ b/docs/atl/reference/iaxwinhostwindow-interface.md @@ -4,10 +4,11 @@ title: "IAxWinHostWindow Interface" ms.date: "11/04/2016" f1_keywords: ["IAxWinHostWindow", "ATLIFACE/ATL::IAxWinHostWindow", "ATLIFACE/ATL::AttachControl", "ATLIFACE/ATL::CreateControl", "ATLIFACE/ATL::CreateControlEx", "ATLIFACE/ATL::QueryControl", "ATLIFACE/ATL::SetExternalDispatch", "ATLIFACE/ATL::SetExternalUIHandler"] helpviewer_keywords: ["IAxWinHostWindow interface"] -ms.assetid: 9821c035-cd52-4c46-b58a-9278064f09b4 --- # IAxWinHostWindow Interface +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This interface provides methods for manipulating a control and its host object. > [!IMPORTANT] diff --git a/docs/atl/reference/iaxwinhostwindowlic-interface.md b/docs/atl/reference/iaxwinhostwindowlic-interface.md index e2d65671f24..49479516988 100644 --- a/docs/atl/reference/iaxwinhostwindowlic-interface.md +++ b/docs/atl/reference/iaxwinhostwindowlic-interface.md @@ -4,10 +4,11 @@ title: "IAxWinHostWindowLic Interface" ms.date: "11/04/2016" f1_keywords: ["IAxWinHostWindowLic", "ATLIFACE/ATL::IAxWinHostWindowLic", "ATLIFACE/ATL::CreateControlLic", "ATLIFACE/ATL::CreateControlLicEx"] helpviewer_keywords: ["IAxWinHostWindowLic interface"] -ms.assetid: 750f1520-6bce-428c-aca0-fccbe3f063c7 --- # IAxWinHostWindowLic Interface +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This interface provides methods for manipulating a licensed control and its host object. ## Syntax diff --git a/docs/atl/reference/icollectiononstlimpl-class.md b/docs/atl/reference/icollectiononstlimpl-class.md index 58c7584c398..54377d23a95 100644 --- a/docs/atl/reference/icollectiononstlimpl-class.md +++ b/docs/atl/reference/icollectiononstlimpl-class.md @@ -4,10 +4,11 @@ title: "ICollectionOnSTLImpl Class" ms.date: "11/04/2016" f1_keywords: ["ICollectionOnSTLImpl", "ATLCOM/ATL::ICollectionOnSTLImpl", "ATLCOM/ATL::ICollectionOnSTLImpl::get__NewEnum", "ATLCOM/ATL::ICollectionOnSTLImpl::getcount", "ATLCOM/ATL::ICollectionOnSTLImpl::get_Item", "ATLCOM/ATL::ICollectionOnSTLImpl::m_coll"] helpviewer_keywords: ["ICollectionOnSTLImpl class"] -ms.assetid: 683c88b0-0d97-4779-a762-e493334ba7f9 --- # ICollectionOnSTLImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods used by a collection class. ## Syntax diff --git a/docs/atl/reference/iconnectionpointcontainerimpl-class.md b/docs/atl/reference/iconnectionpointcontainerimpl-class.md index fd6e2362ee3..e7575eb5862 100644 --- a/docs/atl/reference/iconnectionpointcontainerimpl-class.md +++ b/docs/atl/reference/iconnectionpointcontainerimpl-class.md @@ -4,10 +4,11 @@ title: "IConnectionPointContainerImpl Class" ms.date: "11/04/2016" f1_keywords: ["IConnectionPointContainerImpl", "ATLCOM/ATL::IConnectionPointContainerImpl", "ATLCOM/ATL::IConnectionPointContainerImpl::EnumConnectionPoints", "ATLCOM/ATL::IConnectionPointContainerImpl::FindConnectionPoint"] helpviewer_keywords: ["connectable objects", "connection points [C++], container", "IConnectionPointContainerImpl class"] -ms.assetid: 10db5a8d-8be9-4d9d-8a82-8ab9ffe3e9d6 --- # IConnectionPointContainerImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements a connection point container to manage a collection of [IConnectionPointImpl](../../atl/reference/iconnectionpointimpl-class.md) objects. ## Syntax diff --git a/docs/atl/reference/iconnectionpointimpl-class.md b/docs/atl/reference/iconnectionpointimpl-class.md index 2b51b7bc46c..01653837946 100644 --- a/docs/atl/reference/iconnectionpointimpl-class.md +++ b/docs/atl/reference/iconnectionpointimpl-class.md @@ -4,10 +4,11 @@ title: "IConnectionPointImpl Class" ms.date: "11/04/2016" f1_keywords: ["IConnectionPointImpl", "ATLCOM/ATL::IConnectionPointImpl", "ATLCOM/ATL::IConnectionPointImpl::Advise", "ATLCOM/ATL::IConnectionPointImpl::EnumConnections", "ATLCOM/ATL::IConnectionPointImpl::GetConnectionInterface", "ATLCOM/ATL::IConnectionPointImpl::GetConnectionPointContainer", "ATLCOM/ATL::IConnectionPointImpl::Unadvise", "ATLCOM/ATL::IConnectionPointImpl::m_vec"] helpviewer_keywords: ["connection points [C++], implementing", "IConnectionPointImpl class"] -ms.assetid: 27992115-3b86-45dd-bc9e-54f32876c557 --- # IConnectionPointImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements a connection point. ## Syntax diff --git a/docs/atl/reference/idataobjectimpl-class.md b/docs/atl/reference/idataobjectimpl-class.md index 3ebc3c44024..66da64d27e2 100644 --- a/docs/atl/reference/idataobjectimpl-class.md +++ b/docs/atl/reference/idataobjectimpl-class.md @@ -4,10 +4,11 @@ title: "IDataObjectImpl Class" ms.date: "11/04/2016" f1_keywords: ["IDataObjectImpl", "ATLCTL/ATL::IDataObjectImpl", "ATLCTL/ATL::IDataObjectImpl::DAdvise", "ATLCTL/ATL::IDataObjectImpl::DUnadvise", "ATLCTL/ATL::IDataObjectImpl::EnumDAdvise", "ATLCTL/ATL::IDataObjectImpl::EnumFormatEtc", "ATLCTL/ATL::IDataObjectImpl::FireDataChange", "ATLCTL/ATL::IDataObjectImpl::GetCanonicalFormatEtc", "ATLCTL/ATL::IDataObjectImpl::GetData", "ATLCTL/ATL::IDataObjectImpl::GetDataHere", "ATLCTL/ATL::IDataObjectImpl::QueryGetData", "ATLCTL/ATL::IDataObjectImpl::SetData"] helpviewer_keywords: ["data transfer [C++]", "data transfer [C++], Uniform Data Transfer", "IDataObjectImpl class", "IDataObject, ATL implementation"] -ms.assetid: b680f0f7-7795-40a1-a0f6-f48768201c89 --- # IDataObjectImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for supporting Uniform Data Transfer and managing connections. > [!IMPORTANT] diff --git a/docs/atl/reference/idispatchimpl-class.md b/docs/atl/reference/idispatchimpl-class.md index e44623c7625..ee9891c47fb 100644 --- a/docs/atl/reference/idispatchimpl-class.md +++ b/docs/atl/reference/idispatchimpl-class.md @@ -4,10 +4,11 @@ title: "IDispatchImpl Class" ms.date: "11/04/2016" f1_keywords: ["IDispatchImpl", "ATLCOM/ATL::IDispatchImpl", "ATLCOM/ATL::IDispatchImpl::IDispatchImpl", "ATLCOM/ATL::IDispatchImpl::GetIDsOfNames", "ATLCOM/ATL::IDispatchImpl::GetTypeInfo", "ATLCOM/ATL::IDispatchImpl::GetTypeInfoCount", "ATLCOM/ATL::IDispatchImpl::Invoke"] helpviewer_keywords: ["dual interfaces, classes", "IDispatchImpl class", "IDispatch class support in ATL"] -ms.assetid: 8108eb36-1228-4127-a203-3ab5ba488892 --- # IDispatchImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Provides a default implementation for the `IDispatch` part of a dual interface. > [!IMPORTANT] diff --git a/docs/atl/reference/idispeventimpl-class.md b/docs/atl/reference/idispeventimpl-class.md index ef54c3c7b5c..fe3cb6578ab 100644 --- a/docs/atl/reference/idispeventimpl-class.md +++ b/docs/atl/reference/idispeventimpl-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["IDispEventImpl class"] --- # `IDispEventImpl` Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides implementations of the `IDispatch` methods. > [!IMPORTANT] diff --git a/docs/atl/reference/idispeventsimpleimpl-class.md b/docs/atl/reference/idispeventsimpleimpl-class.md index c76ceee1297..4224ca90998 100644 --- a/docs/atl/reference/idispeventsimpleimpl-class.md +++ b/docs/atl/reference/idispeventsimpleimpl-class.md @@ -4,10 +4,11 @@ title: "IDispEventSimpleImpl Class" ms.date: "11/04/2016" f1_keywords: ["IDispEventSimpleImpl", "ATLCOM/ATL::IDispEventSimpleImpl", "ATLCOM/ATL::IDispEventSimpleImpl::Advise", "ATLCOM/ATL::IDispEventSimpleImpl::DispEventAdvise", "ATLCOM/ATL::IDispEventSimpleImpl::DispEventUnadvise", "ATLCOM/ATL::IDispEventSimpleImpl::GetIDsOfNames", "ATLCOM/ATL::IDispEventSimpleImpl::GetTypeInfo", "ATLCOM/ATL::IDispEventSimpleImpl::GetTypeInfoCount", "ATLCOM/ATL::IDispEventSimpleImpl::Invoke", "ATLCOM/ATL::IDispEventSimpleImpl::Unadvise"] helpviewer_keywords: ["IDispEventSimpleImpl class"] -ms.assetid: 971d82b7-a921-47fa-a4d8-909bed377ab0 --- # IDispEventSimpleImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides implementations of the `IDispatch` methods, without getting type information from a type library. > [!IMPORTANT] diff --git a/docs/atl/reference/idochostuihandlerdispatch-interface.md b/docs/atl/reference/idochostuihandlerdispatch-interface.md index d748d3e3df2..35749bfb535 100644 --- a/docs/atl/reference/idochostuihandlerdispatch-interface.md +++ b/docs/atl/reference/idochostuihandlerdispatch-interface.md @@ -4,10 +4,11 @@ title: "IDocHostUIHandlerDispatch Interface" ms.date: "07/02/2019" f1_keywords: ["IDocHostUIHandlerDispatch", "atlbase/ATL::IDocHostUIHandlerDispatch"] helpviewer_keywords: ["IDocHostUIHandlerDispatch interface"] -ms.assetid: 6963a301-601a-4ac3-8bef-f7b252ea2fc6 --- # IDocHostUIHandlerDispatch Interface +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + An interface to the Microsoft HTML parsing and rendering engine. > [!IMPORTANT] diff --git a/docs/atl/reference/ienumonstlimpl-class.md b/docs/atl/reference/ienumonstlimpl-class.md index c8c694372a0..99b2f3ab0b2 100644 --- a/docs/atl/reference/ienumonstlimpl-class.md +++ b/docs/atl/reference/ienumonstlimpl-class.md @@ -4,10 +4,11 @@ title: "IEnumOnSTLImpl Class" ms.date: "11/04/2016" f1_keywords: ["IEnumOnSTLImpl", "ATLCOM/ATL::IEnumOnSTLImpl", "ATLCOM/ATL::IEnumOnSTLImpl::Clone", "ATLCOM/ATL::IEnumOnSTLImpl::Init", "ATLCOM/ATL::IEnumOnSTLImpl::Next", "ATLCOM/ATL::IEnumOnSTLImpl::Reset", "ATLCOM/ATL::IEnumOnSTLImpl::Skip", "ATLCOM/ATL::IEnumOnSTLImpl::m_iter", "ATLCOM/ATL::IEnumOnSTLImpl::m_pcollection", "ATLCOM/ATL::IEnumOnSTLImpl::m_spUnk"] helpviewer_keywords: ["IEnumOnSTLImpl class"] -ms.assetid: 1789e77b-88b8-447d-a490-806b918912ce --- # IEnumOnSTLImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class defines an enumerator interface based on a C++ Standard Library collection. ## Syntax diff --git a/docs/atl/reference/interfaces-atl-control-wizard.md b/docs/atl/reference/interfaces-atl-control-wizard.md index 97794e03f9b..f27b167effe 100644 --- a/docs/atl/reference/interfaces-atl-control-wizard.md +++ b/docs/atl/reference/interfaces-atl-control-wizard.md @@ -4,10 +4,11 @@ title: "Interfaces, ATL Control Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.class.atl.control.interfaces"] helpviewer_keywords: ["ATL Control Wizard, interfaces"] -ms.assetid: 971eadcd-6a1e-46f2-b8fe-ee6b53dfe3ea --- # Interfaces, ATL Control Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This page of the wizard identifies the interfaces that the control supports. By default, the supported interfaces are those typically used by most containers. > [!NOTE] diff --git a/docs/atl/reference/iobjectsafetyimpl-class.md b/docs/atl/reference/iobjectsafetyimpl-class.md index dee092995fc..61f7cf4f394 100644 --- a/docs/atl/reference/iobjectsafetyimpl-class.md +++ b/docs/atl/reference/iobjectsafetyimpl-class.md @@ -4,10 +4,11 @@ title: "IObjectSafetyImpl Class" ms.date: "11/04/2016" f1_keywords: ["IObjectSafetyImpl", "ATLCTL/ATL::IObjectSafetyImpl", "ATLCTL/ATL::IObjectSafetyImpl::GetInterfaceSafetyOptions", "ATLCTL/ATL::IObjectSafetyImpl::SetInterfaceSafetyOptions", "ATLCTL/ATL::IObjectSafetyImpl::m_dwCurrentSafety"] helpviewer_keywords: ["controls [ATL], safe", "safe for scripting and initialization (controls)", "IObjectSafety, ATL implementation", "IObjectSafetyImpl class"] -ms.assetid: 64e32082-d910-4a8a-a5bf-ebed9145359d --- # IObjectSafetyImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a default implementation of the `IObjectSafety` interface to allow a client to retrieve and set an object's safety levels. > [!IMPORTANT] diff --git a/docs/atl/reference/iobjectwithsiteimpl-class.md b/docs/atl/reference/iobjectwithsiteimpl-class.md index 5ae9a4b8d7c..3d686a03d63 100644 --- a/docs/atl/reference/iobjectwithsiteimpl-class.md +++ b/docs/atl/reference/iobjectwithsiteimpl-class.md @@ -4,10 +4,11 @@ title: "IObjectWithSiteImpl Class" ms.date: "11/04/2016" f1_keywords: ["IObjectWithSiteImpl", "ATLCOM/ATL::IObjectWithSiteImpl", "ATLCOM/ATL::IObjectWithSiteImpl::GetSite", "ATLCOM/ATL::IObjectWithSiteImpl::SetChildSite", "ATLCOM/ATL::IObjectWithSiteImpl::SetSite", "ATLCOM/ATL::IObjectWithSiteImpl::m_spUnkSite"] helpviewer_keywords: ["IObjectWithSiteImpl class"] -ms.assetid: 4e1f774f-bc3d-45ee-9a1c-c3533a511588 --- # IObjectWithSiteImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods allowing an object to communicate with its site. ## Syntax diff --git a/docs/atl/reference/iolecontrolimpl-class.md b/docs/atl/reference/iolecontrolimpl-class.md index 6c3430e9ceb..d1e7e97f595 100644 --- a/docs/atl/reference/iolecontrolimpl-class.md +++ b/docs/atl/reference/iolecontrolimpl-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["IOleControlImpl class"] --- # IOleControlImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a default implementation of the `IOleControl` interface and implements `IUnknown`. > [!IMPORTANT] diff --git a/docs/atl/reference/ioleinplaceactiveobjectimpl-class.md b/docs/atl/reference/ioleinplaceactiveobjectimpl-class.md index 64fcdcd25bf..b275380a09b 100644 --- a/docs/atl/reference/ioleinplaceactiveobjectimpl-class.md +++ b/docs/atl/reference/ioleinplaceactiveobjectimpl-class.md @@ -4,10 +4,11 @@ title: "IOleInPlaceActiveObjectImpl Class" ms.date: "11/04/2016" f1_keywords: ["IOleInPlaceActiveObjectImpl", "ATLCTL/ATL::IOleInPlaceActiveObjectImpl", "ATLCTL/ATL::IOleInPlaceActiveObjectImpl::ContextSensitiveHelp", "ATLCTL/ATL::IOleInPlaceActiveObjectImpl::EnableModeless", "ATLCTL/ATL::IOleInPlaceActiveObjectImpl::GetWindow", "ATLCTL/ATL::IOleInPlaceActiveObjectImpl::OnDocWindowActivate", "ATLCTL/ATL::IOleInPlaceActiveObjectImpl::OnFrameWindowActivate", "ATLCTL/ATL::IOleInPlaceActiveObjectImpl::ResizeBorder", "ATLCTL/ATL::IOleInPlaceActiveObjectImpl::TranslateAccelerator"] helpviewer_keywords: ["IOleInPlaceActiveObjectImpl class", "ActiveX controls [C++], communication between container and control", "IOleInPlaceActiveObject, ATL implementation"] -ms.assetid: 44e6cc6d-a2dc-4187-98e3-73cf0320dea9 --- # IOleInPlaceActiveObjectImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides methods for assisting communication between an in-place control and its container. > [!IMPORTANT] diff --git a/docs/atl/reference/ioleinplaceobjectwindowlessimpl-class.md b/docs/atl/reference/ioleinplaceobjectwindowlessimpl-class.md index d34f0d80b9b..d4307e69f4c 100644 --- a/docs/atl/reference/ioleinplaceobjectwindowlessimpl-class.md +++ b/docs/atl/reference/ioleinplaceobjectwindowlessimpl-class.md @@ -4,10 +4,11 @@ title: "IOleInPlaceObjectWindowlessImpl Class" ms.date: "11/04/2016" f1_keywords: ["IOleInPlaceObjectWindowlessImpl", "ATLCTL/ATL::IOleInPlaceObjectWindowlessImpl", "ATLCTL/ATL::IOleInPlaceObjectWindowlessImpl::ContextSensitiveHelp", "ATLCTL/ATL::IOleInPlaceObjectWindowlessImpl::GetDropTarget", "ATLCTL/ATL::IOleInPlaceObjectWindowlessImpl::GetWindow", "ATLCTL/ATL::IOleInPlaceObjectWindowlessImpl::InPlaceDeactivate", "ATLCTL/ATL::IOleInPlaceObjectWindowlessImpl::OnWindowMessage", "ATLCTL/ATL::IOleInPlaceObjectWindowlessImpl::ReactivateAndUndo", "ATLCTL/ATL::IOleInPlaceObjectWindowlessImpl::SetObjectRects", "ATLCTL/ATL::IOleInPlaceObjectWindowlessImpl::UIDeactivate"] helpviewer_keywords: ["IOleInPlaceObjectWindowless, ATL implementation", "activation [C++], ATL", "IOleInPlaceObjectWindowlessImpl class", "ActiveX controls [C++], communication between container and control", "controls [ATL], windowless", "deactivating ATL"] -ms.assetid: a2e0feb4-bc59-4adf-aab2-105457bbdbb4 --- # IOleInPlaceObjectWindowlessImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and provides methods that enable a windowless control to receive window messages and to participate in drag-and-drop operations. > [!IMPORTANT] diff --git a/docs/atl/reference/ioleobjectimpl-class.md b/docs/atl/reference/ioleobjectimpl-class.md index 888f9c0db98..42349e85a20 100644 --- a/docs/atl/reference/ioleobjectimpl-class.md +++ b/docs/atl/reference/ioleobjectimpl-class.md @@ -4,10 +4,11 @@ title: "IOleObjectImpl Class" ms.date: "11/04/2016" f1_keywords: ["IOleObjectImpl", "ATLCTL/ATL::IOleObjectImpl", "ATLCTL/ATL::IOleObjectImpl::Advise", "ATLCTL/ATL::IOleObjectImpl::Close", "ATLCTL/ATL::IOleObjectImpl::DoVerb", "ATLCTL/ATL::IOleObjectImpl::DoVerbDiscardUndo", "ATLCTL/ATL::IOleObjectImpl::DoVerbHide", "ATLCTL/ATL::IOleObjectImpl::DoVerbInPlaceActivate", "ATLCTL/ATL::IOleObjectImpl::DoVerbOpen", "ATLCTL/ATL::IOleObjectImpl::DoVerbPrimary", "ATLCTL/ATL::IOleObjectImpl::DoVerbShow", "ATLCTL/ATL::IOleObjectImpl::DoVerbUIActivate", "ATLCTL/ATL::IOleObjectImpl::EnumAdvise", "ATLCTL/ATL::IOleObjectImpl::EnumVerbs", "ATLCTL/ATL::IOleObjectImpl::GetClientSite", "ATLCTL/ATL::IOleObjectImpl::GetClipboardData", "ATLCTL/ATL::IOleObjectImpl::GetExtent", "ATLCTL/ATL::IOleObjectImpl::GetMiscStatus", "ATLCTL/ATL::IOleObjectImpl::GetMoniker", "ATLCTL/ATL::IOleObjectImpl::GetUserClassID", "ATLCTL/ATL::IOleObjectImpl::GetUserType", "ATLCTL/ATL::IOleObjectImpl::InitFromData", "ATLCTL/ATL::IOleObjectImpl::IsUpToDate", "ATLCTL/ATL::IOleObjectImpl::OnPostVerbDiscardUndo", "ATLCTL/ATL::IOleObjectImpl::OnPostVerbHide", "ATLCTL/ATL::IOleObjectImpl::OnPostVerbInPlaceActivate", "ATLCTL/ATL::IOleObjectImpl::OnPostVerbOpen", "ATLCTL/ATL::IOleObjectImpl::OnPostVerbShow", "ATLCTL/ATL::IOleObjectImpl::OnPostVerbUIActivate", "ATLCTL/ATL::IOleObjectImpl::OnPreVerbDiscardUndo", "ATLCTL/ATL::IOleObjectImpl::OnPreVerbHide", "ATLCTL/ATL::IOleObjectImpl::OnPreVerbInPlaceActivate", "ATLCTL/ATL::IOleObjectImpl::OnPreVerbOpen", "ATLCTL/ATL::IOleObjectImpl::OnPreVerbShow", "ATLCTL/ATL::IOleObjectImpl::OnPreVerbUIActivate", "ATLCTL/ATL::IOleObjectImpl::SetClientSite", "ATLCTL/ATL::IOleObjectImpl::SetColorScheme", "ATLCTL/ATL::IOleObjectImpl::SetExtent", "ATLCTL/ATL::IOleObjectImpl::SetHostNames", "ATLCTL/ATL::IOleObjectImpl::SetMoniker", "ATLCTL/ATL::IOleObjectImpl::Unadvise", "ATLCTL/ATL::IOleObjectImpl::Update"] helpviewer_keywords: ["ActiveX controls [C++], communication between container and control", "IOleObject, ATL implementation", "IOleObjectImpl class"] -ms.assetid: 59750b2d-1633-4a51-a4c2-6455b6b90c45 --- # IOleObjectImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and is the principal interface through which a container communicates with a control. > [!IMPORTANT] diff --git a/docs/atl/reference/iperpropertybrowsingimpl-class.md b/docs/atl/reference/iperpropertybrowsingimpl-class.md index c5f0e2678ed..c1ca3e087dc 100644 --- a/docs/atl/reference/iperpropertybrowsingimpl-class.md +++ b/docs/atl/reference/iperpropertybrowsingimpl-class.md @@ -4,10 +4,11 @@ title: "IPerPropertyBrowsingImpl Class" ms.date: "11/04/2016" f1_keywords: ["IPerPropertyBrowsingImpl", "ATLCTL/ATL::IPerPropertyBrowsingImpl", "ATLCTL/ATL::IPerPropertyBrowsingImpl::GetDisplayString", "ATLCTL/ATL::IPerPropertyBrowsingImpl::GetPredefinedStrings", "ATLCTL/ATL::IPerPropertyBrowsingImpl::GetPredefinedValue", "ATLCTL/ATL::IPerPropertyBrowsingImpl::MapPropertyToPage"] helpviewer_keywords: ["IPerPropertyBrowsingImpl class", "property pages, accessing information", "IPerPropertyBrowsing, ATL implementation"] -ms.assetid: 0b1a9be3-d242-4767-be69-663a21e4b728 --- # IPerPropertyBrowsingImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and allows a client to access the information in an object's property pages. > [!IMPORTANT] diff --git a/docs/atl/reference/ipersistpropertybagimpl-class.md b/docs/atl/reference/ipersistpropertybagimpl-class.md index b9029c339df..84fb6c38136 100644 --- a/docs/atl/reference/ipersistpropertybagimpl-class.md +++ b/docs/atl/reference/ipersistpropertybagimpl-class.md @@ -4,10 +4,11 @@ title: "IPersistPropertyBagImpl Class" ms.date: "11/04/2016" f1_keywords: ["IPersistPropertyBagImpl", "ATLCOM/ATL::IPersistPropertyBagImpl", "ATLCOM/ATL::IPersistPropertyBagImpl::GetClassID", "ATLCOM/ATL::IPersistPropertyBagImpl::InitNew", "ATLCOM/ATL::IPersistPropertyBagImpl::Load", "ATLCOM/ATL::IPersistPropertyBagImpl::Save"] helpviewer_keywords: ["IPersistPropertyBagImpl class"] -ms.assetid: 712af24d-99f8-40f2-9811-53b3ff6e5b19 --- # IPersistPropertyBagImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and allows an object to save its properties to a client-supplied property bag. > [!IMPORTANT] diff --git a/docs/atl/reference/ipersiststorageimpl-class.md b/docs/atl/reference/ipersiststorageimpl-class.md index a5396bee533..ae95395147b 100644 --- a/docs/atl/reference/ipersiststorageimpl-class.md +++ b/docs/atl/reference/ipersiststorageimpl-class.md @@ -7,6 +7,8 @@ helpviewer_keywords: ["storage, ATL", "IPersistStorageImpl class"] --- # IPersistStorageImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements the [IPersistStorage](/windows/win32/api/objidl/nn-objidl-ipersiststorage) interface. > [!IMPORTANT] diff --git a/docs/atl/reference/ipersiststreaminitimpl-class.md b/docs/atl/reference/ipersiststreaminitimpl-class.md index 3eab5ba63c0..cf426de9552 100644 --- a/docs/atl/reference/ipersiststreaminitimpl-class.md +++ b/docs/atl/reference/ipersiststreaminitimpl-class.md @@ -4,10 +4,11 @@ title: "IPersistStreamInitImpl Class" ms.date: "11/04/2016" f1_keywords: ["IPersistStreamInitImpl", "ATLCOM/ATL::IPersistStreamInitImpl", "ATLCOM/ATL::IPersistStreamInitImpl::GetClassID", "ATLCOM/ATL::IPersistStreamInitImpl::GetSizeMax", "ATLCOM/ATL::IPersistStreamInitImpl::InitNew", "ATLCOM/ATL::IPersistStreamInitImpl::IsDirty", "ATLCOM/ATL::IPersistStreamInitImpl::Load", "ATLCOM/ATL::IPersistStreamInitImpl::Save"] helpviewer_keywords: ["IPersistStreamInit ATL implementation", "IPersistStreamInitImpl class", "streams, ATL"] -ms.assetid: ef217c3c-020f-4cf8-871e-ef68e57865b8 --- # IPersistStreamInitImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and provides a default implementation of the [IPersistStreamInit](/windows/win32/api/ocidl/nn-ocidl-ipersiststreaminit) interface. > [!IMPORTANT] diff --git a/docs/atl/reference/ipointerinactiveimpl-class.md b/docs/atl/reference/ipointerinactiveimpl-class.md index 71189491246..ed5fa3495e3 100644 --- a/docs/atl/reference/ipointerinactiveimpl-class.md +++ b/docs/atl/reference/ipointerinactiveimpl-class.md @@ -4,10 +4,11 @@ title: "IPointerInactiveImpl Class" ms.date: "11/04/2016" f1_keywords: ["IPointerInactiveImpl", "ATLCTL/ATL::IPointerInactiveImpl", "ATLCTL/ATL::IPointerInactiveImpl::GetActivationPolicy", "ATLCTL/ATL::IPointerInactiveImpl::OnInactiveMouseMove", "ATLCTL/ATL::IPointerInactiveImpl::OnInactiveSetCursor"] helpviewer_keywords: ["IPointerInactive ATL implementation", "inactive objects", "IPointerInactiveImpl class"] -ms.assetid: e1fe9ea6-d38a-4527-9112-eb344771e0b7 --- # IPointerInactiveImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and the [IPointerInactive](/windows/win32/api/ocidl/nn-ocidl-ipointerinactive) interface methods. > [!IMPORTANT] diff --git a/docs/atl/reference/ipropertynotifysinkcp-class.md b/docs/atl/reference/ipropertynotifysinkcp-class.md index b02d41d33b0..d4a74b402a9 100644 --- a/docs/atl/reference/ipropertynotifysinkcp-class.md +++ b/docs/atl/reference/ipropertynotifysinkcp-class.md @@ -4,10 +4,11 @@ title: "IPropertyNotifySinkCP Class" ms.date: "11/04/2016" f1_keywords: ["IPropertyNotifySinkCP", "atlctl/ATL::IPropertyNotifySinkCP"] helpviewer_keywords: ["connection points [C++], managing", "sinks, notifying of changes", "IPropertyNotifySinkCP class"] -ms.assetid: 1b41445e-bc88-4fa6-bb62-d68aacec2bd5 --- # IPropertyNotifySinkCP Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class exposes [IPropertyNotifySink](/windows/win32/api/ocidl/nn-ocidl-ipropertynotifysink) interface as an outgoing interface on a connectable object. > [!IMPORTANT] diff --git a/docs/atl/reference/ipropertypage2impl-class.md b/docs/atl/reference/ipropertypage2impl-class.md index f39eac4e87e..412048f8778 100644 --- a/docs/atl/reference/ipropertypage2impl-class.md +++ b/docs/atl/reference/ipropertypage2impl-class.md @@ -4,10 +4,11 @@ title: "IPropertyPage2Impl Class" ms.date: "11/04/2016" f1_keywords: ["IPropertyPage2Impl", "ATLCTL/ATL::IPropertyPage2Impl", "ATLCTL/ATL::IPropertyPage2Impl::EditProperty"] helpviewer_keywords: ["property pages", "IPropertyPage2 ATL implementation", "IPropertyPage2Impl class"] -ms.assetid: e89fbe90-203a-47f0-a5de-23616697e1ce --- # IPropertyPage2Impl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and inherits the default implementation of [IPropertyPageImpl](../../atl/reference/ipropertypageimpl-class.md). > [!IMPORTANT] diff --git a/docs/atl/reference/ipropertypageimpl-class.md b/docs/atl/reference/ipropertypageimpl-class.md index 8b217ed0d02..0cd5e4d87bf 100644 --- a/docs/atl/reference/ipropertypageimpl-class.md +++ b/docs/atl/reference/ipropertypageimpl-class.md @@ -4,10 +4,11 @@ title: "IPropertyPageImpl Class" ms.date: "11/04/2016" f1_keywords: ["IPropertyPageImpl", "ATLCTL/ATL::IPropertyPageImpl", "ATLCTL/ATL::IPropertyPageImpl::IPropertyPageImpl", "ATLCTL/ATL::IPropertyPageImpl::Activate", "ATLCTL/ATL::IPropertyPageImpl::Apply", "ATLCTL/ATL::IPropertyPageImpl::Deactivate", "ATLCTL/ATL::IPropertyPageImpl::GetPageInfo", "ATLCTL/ATL::IPropertyPageImpl::Help", "ATLCTL/ATL::IPropertyPageImpl::IsPageDirty", "ATLCTL/ATL::IPropertyPageImpl::Move", "ATLCTL/ATL::IPropertyPageImpl::SetDirty", "ATLCTL/ATL::IPropertyPageImpl::SetObjects", "ATLCTL/ATL::IPropertyPageImpl::SetPageSite", "ATLCTL/ATL::IPropertyPageImpl::Show", "ATLCTL/ATL::IPropertyPageImpl::TranslateAccelerator", "ATLCTL/ATL::IPropertyPageImpl::m_bDirty", "ATLCTL/ATL::IPropertyPageImpl::m_dwDocString", "ATLCTL/ATL::IPropertyPageImpl::m_dwHelpContext", "ATLCTL/ATL::IPropertyPageImpl::m_dwHelpFile", "ATLCTL/ATL::IPropertyPageImpl::m_dwTitle", "ATLCTL/ATL::IPropertyPageImpl::m_nObjects", "ATLCTL/ATL::IPropertyPageImpl::m_pPageSite", "ATLCTL/ATL::IPropertyPageImpl::m_ppUnk", "ATLCTL/ATL::IPropertyPageImpl::m_size"] helpviewer_keywords: ["property pages", "IPropertyPage ATL implementation", "IPropertyPageImpl class"] -ms.assetid: f9b7c8b1-7a04-4eab-aa63-63efddb740fa --- # IPropertyPageImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and provides a default implementation of the [IPropertyPage](/windows/win32/api/ocidl/nn-ocidl-ipropertypage) interface. > [!IMPORTANT] diff --git a/docs/atl/reference/iprovideclassinfo2impl-class.md b/docs/atl/reference/iprovideclassinfo2impl-class.md index c700c6a2809..3115d96f8e1 100644 --- a/docs/atl/reference/iprovideclassinfo2impl-class.md +++ b/docs/atl/reference/iprovideclassinfo2impl-class.md @@ -4,10 +4,11 @@ title: "IProvideClassInfo2Impl Class" ms.date: "11/04/2016" f1_keywords: ["IProvideClassInfo2Impl", "ATLCOM/ATL::IProvideClassInfo2Impl", "ATLCOM/ATL::IProvideClassInfo2Impl::IProvideClassInfo2Impl", "ATLCOM/ATL::IProvideClassInfo2Impl::GetClassInfo", "ATLCOM/ATL::IProvideClassInfo2Impl::GetGUID", "ATLCOM/ATL::IProvideClassInfo2Impl::_tih"] helpviewer_keywords: ["IProvideClassInfo2Impl class", "IProvideClassInfo2 ATL implementation", "class information, ATL"] -ms.assetid: d74956e8-9c69-4cba-b99d-ca1ac031bb9d --- # IProvideClassInfo2Impl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a default implementation of the [IProvideClassInfo](/windows/win32/api/ocidl/nn-ocidl-iprovideclassinfo) and [IProvideClassInfo2](/windows/win32/api/ocidl/nn-ocidl-iprovideclassinfo2) methods. ## Syntax diff --git a/docs/atl/reference/iquickactivateimpl-class.md b/docs/atl/reference/iquickactivateimpl-class.md index 55d408feadc..88ea87bc8d8 100644 --- a/docs/atl/reference/iquickactivateimpl-class.md +++ b/docs/atl/reference/iquickactivateimpl-class.md @@ -4,10 +4,11 @@ title: "IQuickActivateImpl Class" ms.date: "11/04/2016" f1_keywords: ["IQuickActivateImpl", "ATLCTL/ATL::IQuickActivateImpl", "ATLCTL/ATL::IQuickActivateImpl::GetContentExtent", "ATLCTL/ATL::IQuickActivateImpl::QuickActivate", "ATLCTL/ATL::IQuickActivateImpl::SetContentExtent"] helpviewer_keywords: ["activating ATL controls", "controls [ATL], activating", "IQuickActivateImpl class", "IQuickActivate ATL implementation"] -ms.assetid: aa80c056-1041-494e-b21d-2acca7dc27ea --- # IQuickActivateImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class combines containers' control initialization into a single call. > [!IMPORTANT] diff --git a/docs/atl/reference/iregistrar-class.md b/docs/atl/reference/iregistrar-class.md index 9c3ca2a9805..5f8c8909e23 100644 --- a/docs/atl/reference/iregistrar-class.md +++ b/docs/atl/reference/iregistrar-class.md @@ -4,10 +4,11 @@ title: "IRegistrar Interface" ms.date: "02/01/2017" f1_keywords: ["IRegistrar", "ATLIFASE/ATL::IRegistrar", "ATLIFASE/ATL::IRegistrar::ResourceRegisterSz", "ATLIFASE/ATL::IRegistrar::ResourceUnregisterSz", "ATLIFASE/ATL::IRegistrar::FileRegister", "ATLIFASE/ATL::IRegistrar::FileUnregister", "ATLIFASE/ATL::IRegistrar::StringRegister", "ATLIFASE/ATL::IRegistrar::StringUnregister", "ATLIFASE/ATL::IRegistrar::ResourceRegister", "ATLIFASE/ATL::IRegistrar::ResourceUnregister"] helpviewer_keywords: ["Iregistrar Interface"] -ms.assetid: e88c04b7-0c93-4ae8-aeb9-ecd78f87421e --- # IRegistrar Interface +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This interface is defined in atliface.h and is used internally by CAtlModule member functions such as [UpdateRegistryFromResourceD](catlmodule-class.md#updateregistryfromresourced). ## Syntax diff --git a/docs/atl/reference/irunnableobjectimpl-class.md b/docs/atl/reference/irunnableobjectimpl-class.md index 77b26a50729..ad0058aeb3c 100644 --- a/docs/atl/reference/irunnableobjectimpl-class.md +++ b/docs/atl/reference/irunnableobjectimpl-class.md @@ -4,10 +4,11 @@ title: "IRunnableObjectImpl Class" ms.date: "11/04/2016" f1_keywords: ["IRunnableObjectImpl", "ATLCTL/ATL::IRunnableObjectImpl", "ATLCTL/ATL::IRunnableObjectImpl::GetRunningClass", "ATLCTL/ATL::IRunnableObjectImpl::IsRunning", "ATLCTL/ATL::IRunnableObjectImpl::LockRunning", "ATLCTL/ATL::IRunnableObjectImpl::Run", "ATLCTL/ATL::IRunnableObjectImpl::SetContainedObject"] helpviewer_keywords: ["containers, running controls", "IRunnableObjectImpl class", "IRunnableObject, ATL implementation", "controls [ATL], running", "controls [C++], container running in ATL"] -ms.assetid: 305c7c3b-889e-49dd-aca1-34379c1b9931 --- # IRunnableObjectImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and provides a default implementation of the [IRunnableObject](/windows/win32/api/objidl/nn-objidl-irunnableobject) interface. > [!IMPORTANT] diff --git a/docs/atl/reference/iserviceproviderimpl-class.md b/docs/atl/reference/iserviceproviderimpl-class.md index 6cd8822fddc..682901b2c7d 100644 --- a/docs/atl/reference/iserviceproviderimpl-class.md +++ b/docs/atl/reference/iserviceproviderimpl-class.md @@ -4,10 +4,11 @@ title: "IServiceProviderImpl Class" ms.date: "11/04/2016" f1_keywords: ["IServiceProviderImpl", "ATLCOM/ATL::IServiceProviderImpl", "ATLCOM/ATL::IServiceProviderImpl::QueryService"] helpviewer_keywords: ["IServiceProviderImpl class", "IServiceProvider interface, ATL implementation"] -ms.assetid: 251254d3-c4ce-40d7-aee0-3d676d1d72f2 --- # IServiceProviderImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a default implementation of the `IServiceProvider` interface. ## Syntax diff --git a/docs/atl/reference/ispecifypropertypagesimpl-class.md b/docs/atl/reference/ispecifypropertypagesimpl-class.md index ae7b4481938..5549949feed 100644 --- a/docs/atl/reference/ispecifypropertypagesimpl-class.md +++ b/docs/atl/reference/ispecifypropertypagesimpl-class.md @@ -4,10 +4,11 @@ title: "ISpecifyPropertyPagesImpl Class" ms.date: "11/04/2016" f1_keywords: ["ISpecifyPropertyPagesImpl", "ATLCOM/ATL::ISpecifyPropertyPagesImpl", "ATLCOM/ATL::ISpecifyPropertyPagesImpl::GetPages"] helpviewer_keywords: ["property pages, CLSIDs associated with", "ISpecifyPropertyPages", "ISpecifyPropertyPagesImpl class"] -ms.assetid: 4e4b9795-b656-4d56-9b8c-85941e7731f9 --- # ISpecifyPropertyPagesImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and provides a default implementation of the [ISpecifyPropertyPages](/windows/win32/api/ocidl/nn-ocidl-ispecifypropertypages) interface. > [!IMPORTANT] diff --git a/docs/atl/reference/isupporterrorinfoimpl-class.md b/docs/atl/reference/isupporterrorinfoimpl-class.md index b9146cc6cf8..b9b4bcdb872 100644 --- a/docs/atl/reference/isupporterrorinfoimpl-class.md +++ b/docs/atl/reference/isupporterrorinfoimpl-class.md @@ -4,10 +4,11 @@ title: "ISupportErrorInfoImpl Class" ms.date: "06/13/2019" f1_keywords: ["ISupportErrorInfoImpl", "ATLCOM/ATL::ISupportErrorInfoImpl", "ATLCOM/ATL::ISupportErrorInfoImpl::InterfaceSupportsErrorInfo"] helpviewer_keywords: ["ISupportErrorInfo ATL implementation", "ISupportErrorInfoImpl class", "error information, ATL"] -ms.assetid: e33a4b11-a123-41cf-bcea-7b19743902af --- # ISupportErrorInfoImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides a default implementation of the [ISupportErrorInfo Interface](/windows/win32/api/oaidl/nn-oaidl-isupporterrorinfo) and can be used when only a single interface generates errors on an object. > [!IMPORTANT] diff --git a/docs/atl/reference/ithreadpoolconfig-interface.md b/docs/atl/reference/ithreadpoolconfig-interface.md index 3a3411e1366..1061b138d72 100644 --- a/docs/atl/reference/ithreadpoolconfig-interface.md +++ b/docs/atl/reference/ithreadpoolconfig-interface.md @@ -4,10 +4,11 @@ title: "IThreadPoolConfig Interface" ms.date: "11/04/2016" f1_keywords: ["IThreadPoolConfig", "ATLUTIL/ATL::IThreadPoolConfig", "ATLUTIL/ATL::GetSize", "ATLUTIL/ATL::GetTimeout", "ATLUTIL/ATL::SetSize", "ATLUTIL/ATL::SetTimeout"] helpviewer_keywords: ["IThreadPoolConfig interface"] -ms.assetid: 69e642bf-6925-46e6-9a37-cce52231b1cc --- # IThreadPoolConfig Interface +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This interface provides methods for configuring a thread pool. > [!IMPORTANT] diff --git a/docs/atl/reference/iviewobjecteximpl-class.md b/docs/atl/reference/iviewobjecteximpl-class.md index ad03e3ac103..b2faac4bb81 100644 --- a/docs/atl/reference/iviewobjecteximpl-class.md +++ b/docs/atl/reference/iviewobjecteximpl-class.md @@ -4,10 +4,11 @@ title: "IViewObjectExImpl Class" ms.date: "11/04/2016" f1_keywords: ["IViewObjectExImpl", "ATLCTL/ATL::IViewObjectExImpl", "ATLCTL/ATL::IViewObjectExImpl::Draw", "ATLCTL/ATL::IViewObjectExImpl::Freeze", "ATLCTL/ATL::IViewObjectExImpl::GetAdvise", "ATLCTL/ATL::IViewObjectExImpl::GetColorSet", "ATLCTL/ATL::IViewObjectExImpl::GetExtent", "ATLCTL/ATL::IViewObjectExImpl::GetNaturalExtent", "ATLCTL/ATL::IViewObjectExImpl::GetRect", "ATLCTL/ATL::IViewObjectExImpl::GetViewStatus", "ATLCTL/ATL::IViewObjectExImpl::QueryHitPoint", "ATLCTL/ATL::IViewObjectExImpl::QueryHitRect", "ATLCTL/ATL::IViewObjectExImpl::SetAdvise", "ATLCTL/ATL::IViewObjectExImpl::Unfreeze"] helpviewer_keywords: ["ActiveX controls [C++], drawing", "IViewObjectEx ATL implementation", "advise sinks", "IViewObjectExImpl class"] -ms.assetid: ad6de760-1ee5-4883-b033-ae57beffc369 --- # IViewObjectExImpl Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class implements `IUnknown` and provides default implementations of the [IViewObject](/windows/win32/api/oleidl/nn-oleidl-iviewobject), [IViewObject2](/windows/win32/api/oleidl/nn-oleidl-iviewobject2), and [IViewObjectEx](/windows/win32/api/ocidl/nn-ocidl-iviewobjectex) interfaces. > [!IMPORTANT] diff --git a/docs/atl/reference/iworkerthreadclient-interface.md b/docs/atl/reference/iworkerthreadclient-interface.md index c962eb0cdf8..46cf241e897 100644 --- a/docs/atl/reference/iworkerthreadclient-interface.md +++ b/docs/atl/reference/iworkerthreadclient-interface.md @@ -4,10 +4,11 @@ title: "IWorkerThreadClient Interface" ms.date: "11/04/2016" f1_keywords: ["IWorkerThreadClient", "ATLUTIL/ATL::IWorkerThreadClient", "ATLUTIL/ATL::CloseHandle", "ATLUTIL/ATL::Execute"] helpviewer_keywords: ["IWorkerThreadClient interface"] -ms.assetid: 56f4a2f5-007e-4a33-9e20-05187629f715 --- # IWorkerThreadClient Interface +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + `IWorkerThreadClient` is the interface implemented by clients of the [CWorkerThread](../../atl/reference/cworkerthread-class.md) class. > [!IMPORTANT] diff --git a/docs/atl/reference/making-an-atl-object-noncreatable.md b/docs/atl/reference/making-an-atl-object-noncreatable.md index 6a144323321..cda5e5b2a71 100644 --- a/docs/atl/reference/making-an-atl-object-noncreatable.md +++ b/docs/atl/reference/making-an-atl-object-noncreatable.md @@ -4,10 +4,11 @@ title: "Making an ATL Object Noncreatable" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.ATL.objects"] helpviewer_keywords: ["noncreatable ATL objects", "ATL projects, noncreatable objects"] -ms.assetid: 80d0bca2-dea0-4801-9a85-6243124437f6 --- # Making an ATL Object Noncreatable +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + You can change the attributes of an ATL-based COM object so that a client cannot directly create the object. In this case, the object would be returned through a method call on another object rather than created directly. ## To make an object noncreatable diff --git a/docs/atl/reference/marshaling-global-functions.md b/docs/atl/reference/marshaling-global-functions.md index 74ec8bf7143..721a8e52101 100644 --- a/docs/atl/reference/marshaling-global-functions.md +++ b/docs/atl/reference/marshaling-global-functions.md @@ -3,10 +3,11 @@ description: "Learn more about: Marshaling Global Functions" title: "Marshaling Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlbase/ATL::AtlFreeMarshalStream", "atlbase/ATL::AtlMarshalPtrInProc", "atlbase/ATL::AtlUnmarshalPtr"] -ms.assetid: 877100b5-6ad9-44c5-a2e0-09414f1720d0 --- # Marshaling Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions provide support for marshaling and converting marshaling data into interface pointers. > [!IMPORTANT] diff --git a/docs/atl/reference/message-map-macros-atl.md b/docs/atl/reference/message-map-macros-atl.md index 99775caee56..b94fb021afd 100644 --- a/docs/atl/reference/message-map-macros-atl.md +++ b/docs/atl/reference/message-map-macros-atl.md @@ -3,10 +3,11 @@ description: "Learn more about: Message Map Macros (ATL)" title: "Message Map Macros (ATL)" ms.date: "11/04/2016" f1_keywords: ["atlwin/ATL::ALT_MSG_MAP", "atlwin/ATL::BEGIN_MSG_MAP", "atlwin/ATL::CHAIN_MSG_MAP_ALT", "atlwin/ATL::CHAIN_MSG_MAP_ALT_MEMBER", "atlwin/ATL::CHAIN_MSG_MAP", "atlwin/ATL::CHAIN_MSG_MAP_DYNAMIC", "atlwin/ATL::CHAIN_MSG_MAP_MEMBER", "atlwin/ATL::COMMAND_CODE_HANDLER", "atlwin/ATL::COMMAND_HANDLER", "atlwin/ATL::COMMAND_ID_HANDLER", "atlwin/ATL::COMMAND_RANGE_CODE_HANDLER", "atlwin/ATL::COMMAND_RANGE_HANDLER", "atlwin/ATL::DECLARE_EMPTY_MSG_MAP", "atlwin/ATL::DEFAULT_REFLECTION_HANDLER", "atlwin/ATL::END_MSG_MAP", "atlwin/ATL::FORWARD_NOTIFICATIONS", "atlwin/ATL::MESSAGE_HANDLER", "atlwin/ATL::MESSAGE_RANGE_HANDLER", "atlwin/ATL::NOTIFY_CODE_HANDLER", "atlwin/ATL::NOTIFY_HANDLER", "atlwin/ATL::NOTIFY_ID_HANDLER", "atlwin/ATL::NOTIFY_RANGE_CODE_HANDLER", "atlwin/ATL::NOTIFY_RANGE_HANDLER", "atlwin/ATL::REFLECT_NOTIFICATIONS", "atlwin/ATL::REFLECTED_COMMAND_CODE_HANDLER", "atlwin/ATL::REFLECTED_COMMAND_HANDLER", "atlwin/ATL::REFLECTED_COMMAND_ID_HANDLER", "atlwin/ATL::REFLECTED_COMMAND_RANGE_CODE_HANDLER", "atlwin/ATL::REFLECTED_COMMAND_RANGE_HANDLER", "atlwin/ATL::REFLECTED_NOTIFY_CODE_HANDLER", "atlwin/ATL::REFLECTED_NOTIFY_HANDLER", "atlwin/ATL::REFLECTED_NOTIFY_ID_HANDLER", "atlwin/ATL::REFLECTED_NOTIFY_RANGE_CODE_HANDLER", "atlwin/ATL::REFLECTED_NOTIFY_RANGE_HANDLER", "ATLWIN/ALT_MSG_MAP", "ATLWIN/BEGIN_MSG_MAP", "ATLWIN/CHAIN_MSG_MAP_ALT", "ATLWIN/CHAIN_MSG_MAP_ALT_MEMBER", "ATLWIN/CHAIN_MSG_MAP", "ATLWIN/CHAIN_MSG_MAP_DYNAMIC", "ATLWIN/CHAIN_MSG_MAP_MEMBER", "ATLWIN/COMMAND_CODE_HANDLER", "ATLWIN/COMMAND_HANDLER", "ATLWIN/COMMAND_ID_HANDLER", "ATLWIN/COMMAND_RANGE_CODE_HANDLER", "ATLWIN/COMMAND_RANGE_HANDLER", "ATLWIN/DECLARE_EMPTY_MSG_MAP", "ATLWIN/DEFAULT_REFLECTION_HANDLER", "ATLWIN/END_MSG_MAP", "ATLWIN/FORWARD_NOTIFICATIONS", "ATLWIN/MESSAGE_HANDLER", "ATLWIN/MESSAGE_RANGE_HANDLER", "ATLWIN/NOTIFY_CODE_HANDLER", "ATLWIN/NOTIFY_HANDLER", "ATLWIN/NOTIFY_ID_HANDLER", "ATLWIN/NOTIFY_RANGE_CODE_HANDLER", "ATLWIN/NOTIFY_RANGE_HANDLER", "ATLWIN/REFLECT_NOTIFICATIONS", "ATLWIN/REFLECTED_COMMAND_CODE_HANDLER", "ATLWIN/REFLECTED_COMMAND_HANDLER", "ATLWIN/REFLECTED_COMMAND_ID_HANDLER", "ATLWIN/REFLECTED_COMMAND_RANGE_CODE_HANDLER", "ATLWIN/REFLECTED_COMMAND_RANGE_HANDLER", "ATLWIN/REFLECTED_NOTIFY_CODE_HANDLER", "ATLWIN/REFLECTED_NOTIFY_HANDLER", "ATLWIN/REFLECTED_NOTIFY_ID_HANDLER", "ATLWIN/REFLECTED_NOTIFY_RANGE_CODE_HANDLER", "ATLWIN/REFLECTED_NOTIFY_RANGE_HANDLER"] -ms.assetid: eefdd546-8934-4a30-b263-9c06a8addcbd --- # Message Map Macros (ATL) +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros define message maps and entries. |Name|Description| diff --git a/docs/atl/reference/mfc-support-in-atl-projects.md b/docs/atl/reference/mfc-support-in-atl-projects.md index c02e7ad566b..faa1b174097 100644 --- a/docs/atl/reference/mfc-support-in-atl-projects.md +++ b/docs/atl/reference/mfc-support-in-atl-projects.md @@ -4,10 +4,12 @@ title: "MFC Support in ATL Projects" ms.date: "11/04/2016" f1_keywords: ["vc.atl.addmfc"] helpviewer_keywords: ["ATL projects, MFC support"] -ms.assetid: f90b4276-cb98-4c11-902c-9ebcfe6f954b --- # MFC Support in ATL Projects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library and Active Template Library (ATL) continue to be supported. However, we're no longer adding features or updating the documentation. + If you select **Support MFC** in the ATL Project Wizard, your project declares the application as an MFC application object (class). The project initializes the MFC library and instantiates a class (class *ProjName*) that is derived from [CWinApp](../../mfc/reference/cwinapp-class.md). This option is available for nonattributed ATL DLL projects only. diff --git a/docs/atl/reference/object-map-macros.md b/docs/atl/reference/object-map-macros.md index e0d53e8236d..aec214fd6db 100644 --- a/docs/atl/reference/object-map-macros.md +++ b/docs/atl/reference/object-map-macros.md @@ -3,10 +3,11 @@ description: "Learn more about: Object Map Macros" title: "Object Map Macros" ms.date: "11/04/2016" f1_keywords: ["atlcom/ATL::DECLARE_OBJECT_DESCRIPTION", "atlcom/ATL::OBJECT_ENTRY_AUTO", "atlcom/ATL::OBJECT_ENTRY_NON_CREATEABLE_EX_AUTO", "ATLCOM/DECLARE_OBJECT_DESCRIPTION", "ATLCOM/OBJECT_ENTRY_AUTO", "ATLCOM/OBJECT_ENTRY_NON_CREATEABLE_EX_AUTO"] -ms.assetid: 680087f4-9894-41dd-a79c-6f337e1f13c1 --- # Object Map Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros define object maps and entries. |Name|Description| diff --git a/docs/atl/reference/object-status-macros.md b/docs/atl/reference/object-status-macros.md index 06a9bdb39fc..124d32d8e17 100644 --- a/docs/atl/reference/object-status-macros.md +++ b/docs/atl/reference/object-status-macros.md @@ -3,10 +3,11 @@ description: "Learn more about: Object Status Macros" title: "Object Status Macros" ms.date: "11/04/2016" f1_keywords: ["atlcom/ATL::DECLARE_OLEMISC_STATUS", "ATLCOM/DECLARE_OLEMISC_STATUS"] -ms.assetid: 727dbef2-a342-4157-9d64-a421805d9747 --- # Object Status Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This macro sets flags belonging to ActiveX controls. |Name|Description| diff --git a/docs/atl/reference/options-atl-active-server-page-component-wizard.md b/docs/atl/reference/options-atl-active-server-page-component-wizard.md index ee4d74799fe..7def4310f65 100644 --- a/docs/atl/reference/options-atl-active-server-page-component-wizard.md +++ b/docs/atl/reference/options-atl-active-server-page-component-wizard.md @@ -4,10 +4,11 @@ title: "Options, ATL Active Server Page Component Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.class.atl.asp.options"] helpviewer_keywords: ["ATL Active Server Page Component Wizard, options"] -ms.assetid: 54f34e26-53c7-4456-9675-cb86e356bde0 --- # Options, ATL Active Server Page Component Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Use this page of the ATL Active Server Page Component Wizard to design for increased efficiency and error support for the object. For more information on ATL projects and ATL COM classes, see [ATL COM Desktop Components](../../atl/atl-com-desktop-components.md). diff --git a/docs/atl/reference/options-atl-control-wizard.md b/docs/atl/reference/options-atl-control-wizard.md index b6ec7ec9d06..b2656d02218 100644 --- a/docs/atl/reference/options-atl-control-wizard.md +++ b/docs/atl/reference/options-atl-control-wizard.md @@ -4,10 +4,11 @@ title: "Options, ATL Control Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.class.atl.control.options"] helpviewer_keywords: ["ATL Control Wizard, options"] -ms.assetid: 4607c51a-992d-433e-9281-919c6f519a3d --- # Options, ATL Control Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Use this page of the wizard to define the type of control you are creating and the level of interface support it contains. ## UIElement List diff --git a/docs/atl/reference/options-atl-property-page-wizard.md b/docs/atl/reference/options-atl-property-page-wizard.md index a49caf9d072..cbf30f158dc 100644 --- a/docs/atl/reference/options-atl-property-page-wizard.md +++ b/docs/atl/reference/options-atl-property-page-wizard.md @@ -4,10 +4,11 @@ title: "Options, ATL Property Page Wizard" ms.date: "05/09/2019" f1_keywords: ["vc.codewiz.class.atl.ppg.options"] helpviewer_keywords: ["ATL Property Page Wizard, options"] -ms.assetid: a7107779-b2ea-4f99-b84b-7f3e0c504bc8 --- # Options, ATL Property Page Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" The ATL Property Page wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/options-atl-simple-object-wizard.md b/docs/atl/reference/options-atl-simple-object-wizard.md index a15ab0eccc0..b3e62ebf15c 100644 --- a/docs/atl/reference/options-atl-simple-object-wizard.md +++ b/docs/atl/reference/options-atl-simple-object-wizard.md @@ -4,10 +4,11 @@ title: "Options, ATL Simple Object Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.class.atl.simple.options"] helpviewer_keywords: ["ATL Simple Object Wizard, options"] -ms.assetid: 125fe179-942d-4181-8b82-33e92e1fd779 --- # Options, ATL Simple Object Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Use this page of the ATL Simple Object Wizard to design for increased efficiency and error support for the object. For more information on ATL projects and ATL COM classes, see [ATL COM Desktop Components](../../atl/atl-com-desktop-components.md). diff --git a/docs/atl/reference/pixel-himetric-conversion-global-functions.md b/docs/atl/reference/pixel-himetric-conversion-global-functions.md index 3e1c7e9264d..19634eccdff 100644 --- a/docs/atl/reference/pixel-himetric-conversion-global-functions.md +++ b/docs/atl/reference/pixel-himetric-conversion-global-functions.md @@ -3,10 +3,11 @@ description: "Learn more about: Pixel/HIMETRIC Conversion Global Functions" title: "Pixel-HIMETRIC Conversion Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlwin/ATL::AtlHiMetricToPixel", "atlwin/ATL::AtlPixelToHiMetric"] -ms.assetid: ecb1b1b2-7e9d-4fbc-a855-16252d2d794c --- # Pixel/HIMETRIC Conversion Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions provide support for converting to and from pixel and HIMETRIC units. > [!IMPORTANT] diff --git a/docs/atl/reference/property-map-macros.md b/docs/atl/reference/property-map-macros.md index c0e785543db..1556a46baaf 100644 --- a/docs/atl/reference/property-map-macros.md +++ b/docs/atl/reference/property-map-macros.md @@ -4,10 +4,11 @@ title: "Property Map Macros" ms.date: "11/04/2016" f1_keywords: ["atlcom/ATL::BEGIN_PROP_MAP", "atlcom/ATL::PROP_DATA_ENTRY", "atlcom/ATL::PROP_ENTRY_TYPE", "atlcom/ATL::PROP_ENTRY_TYPE_EX", "atlcom/ATL::PROP_PAGE", "atlcom/ATL::END_PROP_MAP", "ATLCOM/BEGIN_PROP_MAP", "ATLCOM/PROP_DATA_ENTRY", "ATLCOM/PROP_ENTRY_TYPE", "ATLCOM/PROP_ENTRY_TYPE_EX", "ATLCOM/PROP_PAGE", "ATLCOM/END_PROP_MAP"] helpviewer_keywords: ["property maps"] -ms.assetid: 128bc742-2b98-4b97-a243-684dbb83db77 --- # Property Map Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros define property maps and entries. |Name|Description| diff --git a/docs/atl/reference/registry-and-typelib-global-functions.md b/docs/atl/reference/registry-and-typelib-global-functions.md index c97812f48d0..74287bfd26f 100644 --- a/docs/atl/reference/registry-and-typelib-global-functions.md +++ b/docs/atl/reference/registry-and-typelib-global-functions.md @@ -4,10 +4,11 @@ title: "Registry and TypeLib Global Functions" ms.date: "03/27/2019" f1_keywords: ["atlbase/ATL::AtlGetPerUserRegistration", "afxpriv/ATL::AfxRegCreateKey", "afxpriv/ATL::AfxRegDeleteKey", "atlbase/ATL::AtlRegisterTypeLib", "afxpriv/ATL::AfxRegOpenKey", "afxpriv/ATL::AfxRegOpenKeyEx", "afxdisp/ATL::AfxUnregisterPreviewHandler", "atlbase/ATL::AtlSetPerUserRegistration", "atlbase/ATL::AtlUnRegisterTypeLib", "atlbase/ATL::AtlLoadTypeLib", "atlbase/ATL::AtlUpdateRegistryFromResourceD", "atlbase/ATL::RegistryDataExchange"] helpviewer_keywords: ["RegistryDataExchange function, global functions"] -ms.assetid: d58b8a4e-975c-4417-8b34-d3c847f679b3 --- # Registry and TypeLib Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions provide support for loading and registering a type library. > [!IMPORTANT] diff --git a/docs/atl/reference/registry-data-exchange-macros.md b/docs/atl/reference/registry-data-exchange-macros.md index 98857707a31..76afbece908 100644 --- a/docs/atl/reference/registry-data-exchange-macros.md +++ b/docs/atl/reference/registry-data-exchange-macros.md @@ -4,10 +4,11 @@ title: "Registry Data Exchange Macros" ms.date: "11/04/2016" f1_keywords: ["atlplus/ATL::BEGIN_RDX_MAP", "atlplus/ATL::END_RDX_MAP", "atlplus/ATL::RDX_BINARY", "atlplus/ATL::RDX_CSTRING_TEXT", "atlplus/ATL::RDX_DWORD", "atlplus/ATL::RDX_TEXT", "ATLPLUS/BEGIN_RDX_MAP", "ATLPLUS/END_RDX_MAP", "ATLPLUS/RDX_BINARY", "ATLPLUS/RDX_CSTRING_TEXT", "ATLPLUS/RDX_DWORD", "ATLPLUS/RDX_TEXT"] helpviewer_keywords: ["RegistryDataExchange function, macros"] -ms.assetid: c1bc5e79-2307-43d2-9d10-3a62ffadf473 --- # Registry Data Exchange Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros perform Registry Data Exchange operations. |Name|Description| diff --git a/docs/atl/reference/registry-macros.md b/docs/atl/reference/registry-macros.md index f18617f0fe5..1d5b75f746f 100644 --- a/docs/atl/reference/registry-macros.md +++ b/docs/atl/reference/registry-macros.md @@ -4,10 +4,11 @@ title: "Registry Macros" ms.date: "08/19/2019" f1_keywords: ["ATLBASE/_ATL_STATIC_REGISTRY", "ATLBASE/DECLARE_LIBID", "ATLBASE/DECLARE_NO_REGISTRY", "ATLBASE/DECLARE_REGISTRY", "ATLBASE/DECLARE_REGISTRY_APPID_RESOURCEID", "ATLBASE/DECLARE_REGISTRY_RESOURCE", "ATLBASE/DECLARE_REGISTRY_RESOURCEID", "_ATL_STATIC_REGISTRY", "DECLARE_LIBID", "DECLARE_NO_REGISTRY", "DECLARE_REGISTRY", "DECLARE_REGISTRY_APPID_RESOURCEID", "DECLARE_REGISTRY_RESOURCE", "DECLARE_REGISTRY_RESOURCEID"] helpviewer_keywords: ["registry, ATL macros"] -ms.assetid: 3ee041da-c63b-42a4-89cf-2a4b2a6f81ae --- # Registry Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros define useful type library and registry facilities. |Name|Description| diff --git a/docs/atl/reference/security-global-functions.md b/docs/atl/reference/security-global-functions.md index e42bcb30f72..25ea04d962f 100644 --- a/docs/atl/reference/security-global-functions.md +++ b/docs/atl/reference/security-global-functions.md @@ -4,10 +4,11 @@ title: "Security Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlsecurity/ATL::AtlGetDacl", "atlsecurity/ATL::AtlSetDacl", "atlsecurity/ATL::AtlGetGroupSid", "atlsecurity/ATL::AtlSetGroupSid", "atlsecurity/ATL::AtlGetOwnerSid", "atlsecurity/ATL::AtlSetOwnerSid", "atlsecurity/ATL::AtlGetSacl", "atlsecurity/ATL::AtlSetSacl", "atlsecurity/ATL::AtlGetSecurityDescriptor"] helpviewer_keywords: ["SIDs [C++], modifying SID objects", "ACL object global functions", "security IDs [C++]"] -ms.assetid: 6a584bfe-16b7-47f4-8439-9c789c41567a --- # Security Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions provide support for modifying SID and ACL objects. > [!IMPORTANT] diff --git a/docs/atl/reference/security-identifier-global-functions.md b/docs/atl/reference/security-identifier-global-functions.md index d429e27b2a4..c390c7f3951 100644 --- a/docs/atl/reference/security-identifier-global-functions.md +++ b/docs/atl/reference/security-identifier-global-functions.md @@ -4,10 +4,11 @@ title: "Security Identifier Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlsecurity/ATL::Sids::AccountOps", "atlsecurity/ATL::Sids::Admins", "atlsecurity/ATL::Sids::AnonymousLogon", "atlsecurity/ATL::Sids::AuthenticatedUser", "atlsecurity/ATL::Sids::BackupOps", "atlsecurity/ATL::Sids::Batch", "atlsecurity/ATL::Sids::CreatorGroup", "atlsecurity/ATL::Sids::CreatorGroupServer", "atlsecurity/ATL::Sids::CreatorOwner", "atlsecurity/ATL::Sids::CreatorOwnerServer", "atlsecurity/ATL::Sids::Dialup", "atlsecurity/ATL::Sids::Guests", "atlsecurity/ATL::Sids::Interactive", "atlsecurity/ATL::Sids::Local", "atlsecurity/ATL::Sids::Network", "atlsecurity/ATL::Sids::NetworkService", "atlsecurity/ATL::Sids::Null", "atlsecurity/ATL::Sids::PowerUsers", "atlsecurity/ATL::Sids::PrintOps", "atlsecurity/ATL::Sids::Proxy", "atlsecurity/ATL::Sids::RasServers", "atlsecurity/ATL::Sids::Replicator", "atlsecurity/ATL::Sids::RestrictedCode", "atlsecurity/ATL::Sids::Self", "atlsecurity/ATL::Sids::ServerLogon", "atlsecurity/ATL::Sids::Service", "atlsecurity/ATL::Sids::System", "atlsecurity/ATL::Sids::SystemOps", "atlsecurity/ATL::Sids::TerminalServer", "atlsecurity/ATL::Sids::Users", "atlsecurity/ATL::Sids::World"] helpviewer_keywords: ["security IDs [C++]", "SIDs [C++], returning SID objects"] -ms.assetid: 85404dcb-c59b-4535-ab3d-66cfa37e87de --- # Security Identifier Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions return common well-known SID objects. > [!IMPORTANT] diff --git a/docs/atl/reference/server-registration-global-functions.md b/docs/atl/reference/server-registration-global-functions.md index 4277c7c13a8..084c2b5257e 100644 --- a/docs/atl/reference/server-registration-global-functions.md +++ b/docs/atl/reference/server-registration-global-functions.md @@ -3,10 +3,11 @@ description: "Learn more about: Server Registration Global Functions" title: "Server Registration Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlbase/ATL::AtlComModuleRegisterServer", "atlbase/ATL::AtlComModuleUnregisterServer", "atlbase/ATL::AtlComModuleRegisterClassObjects", "atlbase/ATL::AtlComModuleRevokeClassObjects", "atlbase/ATL::AtlComModuleGetClassObject"] -ms.assetid: c2f0a35d-857c-4538-a44d-c4ea0db63b06 --- # Server Registration Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions provide support for registering and unregistering server objects in the object map. > [!IMPORTANT] diff --git a/docs/atl/reference/service-map-macros.md b/docs/atl/reference/service-map-macros.md index b42010306af..923b3b80708 100644 --- a/docs/atl/reference/service-map-macros.md +++ b/docs/atl/reference/service-map-macros.md @@ -3,10 +3,11 @@ description: "Learn more about: Service Map Macros" title: "Service Map Macros" ms.date: "11/04/2016" f1_keywords: ["atlcom/ATL::BEGIN_SERVICE_MAP", "atlcom/ATL::END_SERVICE_MAP", "atlcom/ATL::SERVICE_ENTRY", "atlcom/ATL::SERVICE_ENTRY_CHAIN", "ATLCOM/BEGIN_SERVICE_MAP", "ATLCOM/END_SERVICE_MAP", "ATLCOM/SERVICE_ENTRY", "ATLCOM/SERVICE_ENTRY_CHAIN"] -ms.assetid: ca02a125-454a-4cf6-aac2-1c5585025ed4 --- # Service Map Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros define service maps and entries. |Name|Description| diff --git a/docs/atl/reference/snap-in-object-macros.md b/docs/atl/reference/snap-in-object-macros.md index 380f4cf1169..d4a210f6777 100644 --- a/docs/atl/reference/snap-in-object-macros.md +++ b/docs/atl/reference/snap-in-object-macros.md @@ -3,10 +3,11 @@ description: "Learn more about: Snap-In Object Macros" title: "Snap-In Object Macros" ms.date: "11/04/2016" f1_keywords: ["atlsnap/ATL::BEGIN_EXTENSION_SNAPIN_NODEINFO_MAP", "atlsnap/ATL::BEGIN_SNAPINTOOLBARID_MAP", "atlsnap/ATL::END_EXTENSION_SNAPIN_NODEINFO_MAP", "atlsnap/ATL::END_SNAPINTOOLBARID_MAP", "atlsnap/ATL::EXTENSION_SNAPIN_DATACLASS", "atlsnap/ATL::EXTENSION_SNAPIN_NODEINFO_ENTRY", "atlsnap/ATL::SNAPINMENUID", "atlsnap/ATL::SNAPINTOOLBARID_ENTRY", "ATLSNAP/BEGIN_EXTENSION_SNAPIN_NODEINFO_MAP", "ATLSNAP/BEGIN_SNAPINTOOLBARID_MAP", "ATLSNAP/END_EXTENSION_SNAPIN_NODEINFO_MAP", "ATLSNAP/END_SNAPINTOOLBARID_MAP", "ATLSNAP/EXTENSION_SNAPIN_DATACLASS", "ATLSNAP/EXTENSION_SNAPIN_NODEINFO_ENTRY", "ATLSNAP/SNAPINMENUID", "ATLSNAP/SNAPINTOOLBARID_ENTRY"] -ms.assetid: 4e9850c0-e395-4929-86c9-584a81828053 --- # Snap-In Object Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros provide support for snap-in extensions. |Name|Description| diff --git a/docs/atl/reference/specifying-compiler-optimization-for-an-atl-project.md b/docs/atl/reference/specifying-compiler-optimization-for-an-atl-project.md index c59923486a7..faaa0a50052 100644 --- a/docs/atl/reference/specifying-compiler-optimization-for-an-atl-project.md +++ b/docs/atl/reference/specifying-compiler-optimization-for-an-atl-project.md @@ -4,10 +4,11 @@ title: "Specifying Compiler Optimization for an ATL Project" ms.date: "08/19/2019" f1_keywords: ["vc.appwiz.ATL.optimization", "vc.appwiz.ATL.vtable"] helpviewer_keywords: ["ATL_DISABLE_NO_VTABLE macro", "ATL projects, compiler optimization", "ATL_NO_VTABLE macro"] -ms.assetid: 7f379318-66d5-43dd-a53d-530758d3a228 --- # Specifying Compiler Optimization for an ATL Project +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + By default, the [ATL Control Wizard](../../atl/reference/atl-control-wizard.md) generates new classes with the ATL_NO_VTABLE macro, as follows: ``` diff --git a/docs/atl/reference/stock-properties-atl-control-wizard.md b/docs/atl/reference/stock-properties-atl-control-wizard.md index d71b29f1d24..b5e748c87a7 100644 --- a/docs/atl/reference/stock-properties-atl-control-wizard.md +++ b/docs/atl/reference/stock-properties-atl-control-wizard.md @@ -3,10 +3,11 @@ description: "Learn more about: Stock Properties, ATL Control Wizard" title: "Stock Properties, ATL Control Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.class.atl.control.stockprops"] -ms.assetid: b27b0e60-08a6-43f4-ba6e-0a4e45147693 --- # Stock Properties, ATL Control Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This page of the wizard identifies the stock properties supported for the control. By default, no properties are identified. - **Not supported** diff --git a/docs/atl/reference/string-conversion-macros.md b/docs/atl/reference/string-conversion-macros.md index 9b67e45e5f2..34e484087c7 100644 --- a/docs/atl/reference/string-conversion-macros.md +++ b/docs/atl/reference/string-conversion-macros.md @@ -3,10 +3,11 @@ description: "Learn more about: String Conversion Macros" title: "String Conversion Macros" ms.date: "11/04/2016" f1_keywords: ["atlconv/ATL::DEVMODEA2W", "atlconv/ATL::TEXTMETRICA2W", "atlconv/ATL::DEVMODEOLE2T", "atlconv/ATL::TEXTMETRICOLE2T", "atlconv/ATL::DEVMODET2OLE", "atlconv/ATL::TEXTMETRICT2OLE", "atlconv/ATL::DEVMODEW2A", "atlconv/ATL::TEXTMETRICW2A", "ATLCONV/DEVMODEA2W", "ATLCONV/TEXTMETRICA2W", "ATLCONV/DEVMODEOLE2T", "ATLCONV/TEXTMETRICOLE2T", "ATLCONV/DEVMODET2OLE", "ATLCONV/TEXTMETRICT2OLE", "ATLCONV/DEVMODEW2A", "ATLCONV/TEXTMETRICW2A"] -ms.assetid: 2ff7c0b6-2bde-45fe-897f-6128e18e0c27 --- # String Conversion Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros provide string conversion features. ## ATL and MFC String Conversion Macros diff --git a/docs/atl/reference/strings-atl-property-page-wizard.md b/docs/atl/reference/strings-atl-property-page-wizard.md index af7682dd9f2..c9ed6e81a2a 100644 --- a/docs/atl/reference/strings-atl-property-page-wizard.md +++ b/docs/atl/reference/strings-atl-property-page-wizard.md @@ -4,10 +4,11 @@ title: "Strings, ATL Property Page Wizard" ms.date: "05/09/2019" f1_keywords: ["vc.codewiz.class.atl.ppg.strings"] helpviewer_keywords: ["ATL Property Page Wizard, strings"] -ms.assetid: 00547db6-911f-49eb-92e1-2ba67079d4df --- # Strings, ATL Property Page Wizard +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + ::: moniker range=">=msvc-160" The ATL Property Page wizard is not available in Visual Studio 2019 and later. diff --git a/docs/atl/reference/u-menuorid-class.md b/docs/atl/reference/u-menuorid-class.md index cd2b60ec3e5..f20de6ecfa3 100644 --- a/docs/atl/reference/u-menuorid-class.md +++ b/docs/atl/reference/u-menuorid-class.md @@ -4,10 +4,11 @@ title: "_U_MENUorID Class" ms.date: "11/04/2016" f1_keywords: ["ATL._U_MENUorID", "ATL::_U_MENUorID", "_U_MENUorID"] helpviewer_keywords: ["U_MENUorID class", "_U_MENUorID class"] -ms.assetid: cfc8032b-61b4-4a68-ba3a-92b82500ccae --- # _U_MENUorID Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides wrappers for `CreateWindow` and `CreateWindowEx`. > [!IMPORTANT] diff --git a/docs/atl/reference/u-rect-class.md b/docs/atl/reference/u-rect-class.md index 515c8add351..2a86016dd22 100644 --- a/docs/atl/reference/u-rect-class.md +++ b/docs/atl/reference/u-rect-class.md @@ -4,10 +4,11 @@ title: "_U_RECT Class" ms.date: "11/04/2016" f1_keywords: ["ATL::_U_RECT", "_U_RECT", "ATL._U_RECT"] helpviewer_keywords: ["U_RECT class", "_U_RECT class"] -ms.assetid: 5f880a2d-09cf-4327-bf32-a3519c4dcd63 --- # _U_RECT Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This argument adapter class allows either `RECT` pointers or references to be passed to a function that is implemented in terms of pointers. > [!IMPORTANT] diff --git a/docs/atl/reference/u-stringorid-class.md b/docs/atl/reference/u-stringorid-class.md index d7148ff89ca..84488cd8aea 100644 --- a/docs/atl/reference/u-stringorid-class.md +++ b/docs/atl/reference/u-stringorid-class.md @@ -4,10 +4,11 @@ title: "_U_STRINGorID Class" ms.date: "11/04/2016" f1_keywords: ["ATL._U_STRINGorID", "ATL::_U_STRINGorID", "_U_STRINGorID"] helpviewer_keywords: ["_U_STRINGorID class", "U_STRINGorID class"] -ms.assetid: 443cdc00-d265-4b27-8ef3-2feb95f3e5e3 --- # _U_STRINGorID Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This argument adapter class allows either resource names (LPCTSTRs) or resource IDs (UINTs) to be passed to a function without requiring the caller to convert the ID to a string using the MAKEINTRESOURCE macro. > [!IMPORTANT] diff --git a/docs/atl/reference/win32threadtraits-class.md b/docs/atl/reference/win32threadtraits-class.md index 2d4f1fa008f..321d51e832c 100644 --- a/docs/atl/reference/win32threadtraits-class.md +++ b/docs/atl/reference/win32threadtraits-class.md @@ -4,10 +4,11 @@ title: "Win32ThreadTraits Class" ms.date: "11/04/2016" f1_keywords: ["Win32ThreadTraits", "ATLBASE/ATL::Win32ThreadTraits", "ATLBASE/ATL::Win32ThreadTraits::CreateThread"] helpviewer_keywords: ["threading [ATL], Windows threads", "threading [ATL], creation functions", "Win32ThreadTraits class"] -ms.assetid: 50279c38-eae1-4301-9ea6-97ccea580f3e --- # Win32ThreadTraits Class +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This class provides the creation function for a Windows thread. Use this class if the thread will not use CRT functions. > [!IMPORTANT] diff --git a/docs/atl/reference/window-class-macros.md b/docs/atl/reference/window-class-macros.md index 4804e4b723c..13224f77bbc 100644 --- a/docs/atl/reference/window-class-macros.md +++ b/docs/atl/reference/window-class-macros.md @@ -3,10 +3,11 @@ description: "Learn more about: Window Class Macros" title: "Window Class Macros" ms.date: "11/04/2016" f1_keywords: ["atlwin/ATL::DECLARE_WND_CLASS", "atlwin/ATL::DECLARE_WND_SUPERCLASS", "atlwin/ATL::DECLARE_WND_CLASS_EX", "ATLWIN/DECLARE_WND_CLASS", "ATLWIN/DECLARE_WND_SUPERCLASS", "ATLWIN/DECLARE_WND_CLASS_EX"] -ms.assetid: ce18681a-2bab-4453-9895-0f3ea47c2b24 --- # Window Class Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These macros define window class utilities. |Name|Description| diff --git a/docs/atl/reference/windows-messages-macros.md b/docs/atl/reference/windows-messages-macros.md index 06753053208..222363698ed 100644 --- a/docs/atl/reference/windows-messages-macros.md +++ b/docs/atl/reference/windows-messages-macros.md @@ -3,10 +3,11 @@ description: "Learn more about: Windows Messages Macros" title: "Windows Messages Macros" ms.date: "11/04/2016" f1_keywords: ["atlbase/ATL::WM_FORWARDMSG", "ATLBASE/WM_FORWARDMSG"] -ms.assetid: 63abd22c-372d-4148-bb04-c605950ae64f --- # Windows Messages Macros +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + This macro forwards window messages. |Name|Description| diff --git a/docs/atl/reference/winmodule-global-functions.md b/docs/atl/reference/winmodule-global-functions.md index c0708a6a568..2523f806fc7 100644 --- a/docs/atl/reference/winmodule-global-functions.md +++ b/docs/atl/reference/winmodule-global-functions.md @@ -3,10 +3,11 @@ description: "Learn more about: WinModule Global Functions" title: "WinModule Global Functions" ms.date: "11/04/2016" f1_keywords: ["atlbase/ATL::AtlWinModuleAddCreateWndData", "atlbase/ATL::AtlWinModuleExtractCreateWndData"] -ms.assetid: 8ce45a5b-26a7-491f-9096-c09ceca5f2c2 --- # WinModule Global Functions +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + These functions provide support for `_AtlCreateWndData` structure operations. > [!IMPORTANT] diff --git a/docs/atl/reference/worker-archetype.md b/docs/atl/reference/worker-archetype.md index e4a36e9702a..ec8e422243c 100644 --- a/docs/atl/reference/worker-archetype.md +++ b/docs/atl/reference/worker-archetype.md @@ -3,10 +3,11 @@ description: "Learn more about: Worker Archetype" title: "Worker Archetype" ms.date: "11/04/2016" helpviewer_keywords: ["Worker archetype"] -ms.assetid: 834145cd-09d3-4149-bc99-620e1871cbfb --- # Worker Archetype +[!INCLUDE[product-lifecycle-status](../includes/lifecycle-note.md)] + Classes that conform to the *worker* archetype provide the code to process work items queued on a thread pool. **Implementation** diff --git a/docs/atl/registry-entries.md b/docs/atl/registry-entries.md index 30fd6299398..2f59a898775 100644 --- a/docs/atl/registry-entries.md +++ b/docs/atl/registry-entries.md @@ -3,10 +3,11 @@ description: "Learn more about: Registry Entries" title: "Registry Entries (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["registry, ATL services entries", "registry, application IDs"] -ms.assetid: 881989b7-61bb-459a-a13e-3bfcb33e184e --- # Registry Entries +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + DCOM introduced the concept of Application IDs (AppIDs), which group configuration options for one or more DCOM objects into a centralized location in the registry. You specify an AppID by indicating its value in the AppID named value under the object's CLSID. By default, an ATL-generated service uses its CLSID as the GUID for its AppID. Under `HKEY_CLASSES_ROOT\AppID`, you can specify DCOM-specific entries. Initially, two entries exist: diff --git a/docs/atl/registry-scripting-examples.md b/docs/atl/registry-scripting-examples.md index 605b92f0df0..55053c58db8 100644 --- a/docs/atl/registry-scripting-examples.md +++ b/docs/atl/registry-scripting-examples.md @@ -3,10 +3,11 @@ description: "Learn more about: Registry Scripting Examples" title: "Registry Scripting Examples" ms.date: "11/04/2016" helpviewer_keywords: ["scripting, examples", "registrar scripts [ATL]", "scripts, Registrar scripts", "registry, Registrar"] -ms.assetid: b6df80e1-e08b-40ee-9243-9b381b172460 --- # Registry Scripting Examples +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The scripting examples in this topic demonstrate how to add a key to the system registry, register the Registrar COM server, and specify multiple parse trees. ## Add a Key to HKEY_CURRENT_USER diff --git a/docs/atl/registry-support-classes.md b/docs/atl/registry-support-classes.md index 1aafad7ccfc..2e0b86bd46e 100644 --- a/docs/atl/registry-support-classes.md +++ b/docs/atl/registry-support-classes.md @@ -4,10 +4,11 @@ title: "Registry Support Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["registry support classes, ATL", "ATL, registry", "registry support classes"] -ms.assetid: 4203c346-77a9-42bf-8683-a3c3351cc490 --- # Registry Support Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following class provides registry support: - [CRegKey](../atl/reference/cregkey-class.md) Contains methods for manipulating values in the system registry. diff --git a/docs/atl/running-objects-classes.md b/docs/atl/running-objects-classes.md index 8d7c92b99fe..f621bae5721 100644 --- a/docs/atl/running-objects-classes.md +++ b/docs/atl/running-objects-classes.md @@ -4,10 +4,11 @@ title: "Running Objects Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["object classes, running", "objects [C++], running objects classes"] -ms.assetid: b4d63c41-81fd-4000-96c5-ea0a011f4308 --- # Running Objects Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following class provides support for running objects: - [IRunnableObjectImpl](../atl/reference/irunnableobjectimpl-class.md) Determines if an object is running, forces it to run, or locks it into the running state. diff --git a/docs/atl/running-the-program-as-a-local-server.md b/docs/atl/running-the-program-as-a-local-server.md index 647555b4552..4d1bc97c64e 100644 --- a/docs/atl/running-the-program-as-a-local-server.md +++ b/docs/atl/running-the-program-as-a-local-server.md @@ -3,11 +3,12 @@ description: "Learn more about: Running the Program as a Local Server" title: "Running the Program as a Local Server" ms.date: "11/04/2016" helpviewer_keywords: ["debugging [ATL], running services as local server", "ATL services, running as local servers"] -ms.assetid: eb9701e6-e2a8-4666-897f-0c893aec8ac7 ms.topic: concept-article --- # Running the Program as a Local Server +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + If running the program as a service is inconvenient, you can temporarily change the registry so that the program is run as a normal local server. Simply rename the `LocalService` value under your AppID to `_LocalService` and ensure the `LocalServer32` key under your CLSID is set correctly. (Note that using DCOMCNFG to specify that your application should be run on a different computer renames your `LocalServer32` key to `_LocalServer32`.) Running your program as a local server takes a few more seconds on startup because the call to `StartServiceCtrlDispatcher` in `CAtlServiceModuleT::Start` takes a few seconds before it fails. ## See also diff --git a/docs/atl/scope-of-atl.md b/docs/atl/scope-of-atl.md index bf84207f3b3..34b054cdbb3 100644 --- a/docs/atl/scope-of-atl.md +++ b/docs/atl/scope-of-atl.md @@ -3,10 +3,11 @@ description: "Learn more about: Scope of ATL" title: "Scope of ATL" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, scope"] -ms.assetid: 381adf50-3cb0-4d0f-a79a-07da093bc280 --- # Scope of ATL +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL allows you to easily create COM objects, Automation servers, and ActiveX controls. ATL provides built-in support for many of the fundamental COM interfaces. ATL is shipped as source code which you include in your application. ATL also makes a DLL available (atl90.dll), which contains code that can be shared across components. However, this DLL is not necessary. diff --git a/docs/atl/security-classes.md b/docs/atl/security-classes.md index c4d3e1acab7..e44ab3c8040 100644 --- a/docs/atl/security-classes.md +++ b/docs/atl/security-classes.md @@ -4,10 +4,11 @@ title: "Security Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["security classes [C++]"] -ms.assetid: 0477f1a4-c1af-4c4f-bbca-08f7b844e028 --- # Security Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + These classes are wrappers for common Win32 security classes and objects. - [CAccessToken](../atl/reference/caccesstoken-class.md) This class is a wrapper for an access token. diff --git a/docs/atl/service-provider-support-classes.md b/docs/atl/service-provider-support-classes.md index 9cce29b4cd7..a46d539dbf4 100644 --- a/docs/atl/service-provider-support-classes.md +++ b/docs/atl/service-provider-support-classes.md @@ -4,10 +4,11 @@ title: "Service Provider Support Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["service provider support classes"] -ms.assetid: 190f598e-fb32-4d37-adf1-21de395b04d9 --- # Service Provider Support Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following class provides support for service providers: - [IServiceProviderImpl](../atl/reference/iserviceproviderimpl-class.md) Locates a service specified by its GUID and returns the interface pointer for the requested interface on the service. diff --git a/docs/atl/setting-up-a-static-link-to-the-registrar-code-cpp-only.md b/docs/atl/setting-up-a-static-link-to-the-registrar-code-cpp-only.md index e5797ef152c..6b56f346110 100644 --- a/docs/atl/setting-up-a-static-link-to-the-registrar-code-cpp-only.md +++ b/docs/atl/setting-up-a-static-link-to-the-registrar-code-cpp-only.md @@ -3,11 +3,12 @@ title: "Setting up a static link to the Registrar code (C++ only)" description: "How to statically link C++ code to the ATL Registrar code." ms.date: 09/03/2020 helpviewer_keywords: ["statically linking to ATL Registrar code", "linking [C++], to ATL Registrar code"] -ms.assetid: 835f5885-87a6-48fa-91e6-60988ee65538 ms.topic: how-to --- # Setting up a static link to the Registrar code (C++ Only) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + C++ clients can create a static link to the Registrar's code. Static linking of the Registrar's parser adds approximately 5K to a release build. The simplest way to set up static linking assumes you have specified [`DECLARE_REGISTRY_RESOURCEID`](reference/registry-macros.md#declare_registry_resourceid) in your object's declaration. (It's the default specification used by the ATL.) diff --git a/docs/atl/site-information-classes.md b/docs/atl/site-information-classes.md index 4ece835b060..620d587be46 100644 --- a/docs/atl/site-information-classes.md +++ b/docs/atl/site-information-classes.md @@ -4,10 +4,11 @@ title: "Site Information Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["site information classes"] -ms.assetid: 102eae20-7953-4efb-b27b-409885c9c064 --- # Site Information Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes allow an object to communicate with its site: - [IObjectWithSiteImpl](../atl/reference/iobjectwithsiteimpl-class.md) Retrieves and sets a pointer to an object's site. Used for objects that are not controls. diff --git a/docs/atl/specifying-property-pages.md b/docs/atl/specifying-property-pages.md index 0213211d07c..507024c56c7 100644 --- a/docs/atl/specifying-property-pages.md +++ b/docs/atl/specifying-property-pages.md @@ -3,11 +3,12 @@ description: "Learn more about: Specifying Property Pages" title: "Specifying Property Pages (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["ISpecifyPropertyPages method", "property pages, specifying"] -ms.assetid: ee8678cf-c708-49ab-b0ad-fc2db31f1ac3 ms.topic: how-to --- # Specifying Property Pages +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + When you create an ActiveX control, you will often want to associate it with property pages that can be used to set the properties of your control. Control containers use the `ISpecifyPropertyPages` interface to find out which property pages can be used to set your control's properties. You will need to implement this interface on your control. To implement `ISpecifyPropertyPages` using ATL, take the following steps: diff --git a/docs/atl/specifying-the-threading-model-for-a-project-atl.md b/docs/atl/specifying-the-threading-model-for-a-project-atl.md index f9d9ebeb3aa..690bb8c1a1e 100644 --- a/docs/atl/specifying-the-threading-model-for-a-project-atl.md +++ b/docs/atl/specifying-the-threading-model-for-a-project-atl.md @@ -3,11 +3,12 @@ description: "Learn more about: Specifying the Threading Model for a Project (AT title: "Specifying the Threading Model for a Project (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["_ATL_FREE_THREADED macro", "_ATL_APARTMENT_THREADED macro", "ATL, multithreading", "threading [ATL], models", "_ATL_SINGLE_THREADED macro"] -ms.assetid: 6b571078-521c-4f3e-9f08-482aa235a822 ms.topic: concept-article --- # Specifying the Threading Model for a Project (ATL) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following macros are available to specify the threading model of an ATL project: |Macro|Guidelines for using| diff --git a/docs/atl/string-and-text-classes.md b/docs/atl/string-and-text-classes.md index 3810a64d0d8..01bf9dde0e9 100644 --- a/docs/atl/string-and-text-classes.md +++ b/docs/atl/string-and-text-classes.md @@ -4,10 +4,11 @@ title: "ATL String and Text Classes" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["string conversion, ATL", "string classes [ATL]"] -ms.assetid: aa0cdc41-c953-4b17-82b6-59b908545571 --- # String and Text Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + These classes provide support for strings and text string conversions. - [CA2AEX](../atl/reference/ca2aex-class.md) This class is used by the string conversion macros CA2TEX and CT2AEX, and the typedef CA2A. diff --git a/docs/atl/supporting-idispatch-and-ierrorinfo.md b/docs/atl/supporting-idispatch-and-ierrorinfo.md index 97c49084358..97d5c06785d 100644 --- a/docs/atl/supporting-idispatch-and-ierrorinfo.md +++ b/docs/atl/supporting-idispatch-and-ierrorinfo.md @@ -3,11 +3,12 @@ description: "Learn more about: Supporting IDispatch and IErrorInfo" title: "Supporting IDispatch and IErrorInfo" ms.date: "11/04/2016" helpviewer_keywords: ["ISupportErrorInfoImpl method", "IErrorInfo class suppor in ATL", "IDispatchImpl class", "IDispatch class support in ATL"] -ms.assetid: 7db2220f-319d-4ce9-9382-d340019f14f7 ms.topic: concept-article --- # Supporting IDispatch and IErrorInfo +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + You can use the template class [IDispatchImpl](../atl/reference/idispatchimpl-class.md) to provide a default implementation of the `IDispatch Interface` portion of any dual interfaces on your object. If your object uses the `IErrorInfo` interface to report errors back to the client, then your object must support the `ISupportErrorInfo` interface. The template class [ISupportErrorInfoImpl](../atl/reference/isupporterrorinfoimpl-class.md) provides an easy way to implement this if you only have a single interface that generates errors on your object. diff --git a/docs/atl/supporting-idispeventimpl.md b/docs/atl/supporting-idispeventimpl.md index 261ffa445cd..dde4fa8ab69 100644 --- a/docs/atl/supporting-idispeventimpl.md +++ b/docs/atl/supporting-idispeventimpl.md @@ -3,11 +3,12 @@ description: "Learn more about: Supporting IDispEventImpl" title: "Supporting IDispEventImpl" ms.date: "11/04/2016" helpviewer_keywords: ["event sink maps, declaring", "IDispEventImpl class, advising and unadvising", "SINK_ENTRY macro", "type libraries, importing", "ATL, IDispEventImpl support in COM objects", "BEGIN_SINK_MAP macro", "IDispEventImpl class, declaring"] -ms.assetid: b957f930-6a5b-4598-8e4d-8027759957e7 ms.topic: concept-article --- # Supporting IDispEventImpl +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The template class [IDispEventImpl](../atl/reference/idispeventimpl-class.md) can be used to provide support for connection point sinks in your ATL class. A connection point sink allows your class to handle events fired from external COM objects. These connection point sinks are mapped with an event sink map, provided by your class. To properly implement a connection point sink for your class, the following steps must be completed: diff --git a/docs/atl/tear-off-interfaces-classes.md b/docs/atl/tear-off-interfaces-classes.md index 0f6c3667bd5..9de3758a0d8 100644 --- a/docs/atl/tear-off-interfaces-classes.md +++ b/docs/atl/tear-off-interfaces-classes.md @@ -4,10 +4,11 @@ title: "Tear-Off Interfaces Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["interfaces, tear-off", "tear-off interfaces classes"] -ms.assetid: 14e4ab01-9213-43e5-bef5-78af1e6206ff --- # Tear-Off Interfaces Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes provide support for tear-off interfaces: - [CComTearOffObject](../atl/reference/ccomtearoffobject-class.md) Implements `IUnknown` for a tear-off interface. diff --git a/docs/atl/testing-the-atl-dhtml-control.md b/docs/atl/testing-the-atl-dhtml-control.md index 1d223e24d1d..32fe9fae2ff 100644 --- a/docs/atl/testing-the-atl-dhtml-control.md +++ b/docs/atl/testing-the-atl-dhtml-control.md @@ -3,11 +3,12 @@ description: "Learn more about: Testing the ATL DHTML Control" title: "Testing the ATL DHTML Control" ms.date: "11/04/2016" helpviewer_keywords: ["HTML controls, testing", "testing controls", "DHTML controls", "DHTML controls, testing"] -ms.assetid: 0e4b4358-80ce-4505-8b06-ef4f30b1d1f0 ms.topic: how-to --- # Testing the ATL DHTML Control +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Once you have created your project, you can build and test the sample control. Before you do this, use **Class View** and **Solution Explorer** to examine the project. The elements of your project are described in greater detail in [Identifying the Elements of the DHTML Control Project](../atl/identifying-the-elements-of-the-dhtml-control-project.md). ## To build and test the ATL DHTML control diff --git a/docs/atl/testing-the-modified-atl-dhtml-control.md b/docs/atl/testing-the-modified-atl-dhtml-control.md index fe0809b88b7..b120c2d27bf 100644 --- a/docs/atl/testing-the-modified-atl-dhtml-control.md +++ b/docs/atl/testing-the-modified-atl-dhtml-control.md @@ -3,11 +3,12 @@ description: "Learn more about: Testing the Modified ATL DHTML Control" title: "Testing the Modified ATL DHTML Control" ms.date: "11/06/2018" helpviewer_keywords: ["HTML controls, testing", "testing controls", "DHTML controls, testing"] -ms.assetid: 42316118-9433-410f-9d8a-0efcc1eff824 ms.topic: how-to --- # Testing the Modified ATL DHTML Control +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Try out your new control to see how it works now. ## To build and test the modified control diff --git a/docs/atl/thread-pooling-classes.md b/docs/atl/thread-pooling-classes.md index ff62fdc9f8c..d78f5b29aa5 100644 --- a/docs/atl/thread-pooling-classes.md +++ b/docs/atl/thread-pooling-classes.md @@ -4,10 +4,11 @@ title: "Thread Pooling Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["thread pooling, classes", "threading [ATL], pooling", "pooling worker threads"] -ms.assetid: 01fa2c1c-12ae-4781-b772-0a74b6365a8c --- # Thread Pooling Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes support thread pooling: - [CComAutoThreadModule](../atl/reference/ccomautothreadmodule-class.md) Implements an EXE module, with support for multiple thread-pooled apartments. diff --git a/docs/atl/threading-models-and-critical-sections-classes.md b/docs/atl/threading-models-and-critical-sections-classes.md index 1bc26034ca9..21ebb6aafcb 100644 --- a/docs/atl/threading-models-and-critical-sections-classes.md +++ b/docs/atl/threading-models-and-critical-sections-classes.md @@ -3,11 +3,12 @@ description: "Learn more about: Threading Models and Critical Sections Classes" title: "Threading Models and Critical Sections Classes (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, critical sections", "ATL, multithreading", "threading [ATL], models", "critical sections"] -ms.assetid: 759f05ef-6285-4be6-a2cc-78572dd75146 ms.topic: concept-article --- # Threading Models and Critical Sections Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes define a threading model and critical section: - [CAtlAutoThreadModule](../atl/reference/catlautothreadmodule-class.md) Implements a thread-pooled, apartment-model COM server. diff --git a/docs/atl/ui-support-classes.md b/docs/atl/ui-support-classes.md index 8e5f56f4c4c..53a4941d0a5 100644 --- a/docs/atl/ui-support-classes.md +++ b/docs/atl/ui-support-classes.md @@ -4,10 +4,11 @@ title: "UI Support Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["user interfaces, support classes", "user interfaces, ATL classes"] -ms.assetid: 313dfc95-308a-4118-b919-5a3c3673b865 --- # UI Support Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes provide general UI support: - [IDocHostUIHandlerDispatch](../atl/reference/idochostuihandlerdispatch-interface.md) An interface to the Microsoft HTML parsing and rendering engine. diff --git a/docs/atl/understanding-backus-naur-form-bnf-syntax.md b/docs/atl/understanding-backus-naur-form-bnf-syntax.md index 7e5295bf9ec..3e218f2ade2 100644 --- a/docs/atl/understanding-backus-naur-form-bnf-syntax.md +++ b/docs/atl/understanding-backus-naur-form-bnf-syntax.md @@ -3,11 +3,12 @@ description: "Learn more about: Understanding Backus-Naur form (BNF) syntax" title: "ATL Registrar and Backus-Naur form (BNF) syntax" ms.date: "05/14/2019" helpviewer_keywords: ["BNF notation", "Backus-Naur form (BNF) syntax"] -ms.assetid: 994bbef0-9077-4aa8-bdfe-b7e830af9acc ms.topic: concept-article --- # Understanding Backus-Naur form (BNF) syntax +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The scripts used by the ATL Registrar are described in this topic using BNF syntax, which uses the notation shown in the following table. |Convention/symbol|Meaning| diff --git a/docs/atl/understanding-parse-trees.md b/docs/atl/understanding-parse-trees.md index a0eea7d823a..75544ab3c4e 100644 --- a/docs/atl/understanding-parse-trees.md +++ b/docs/atl/understanding-parse-trees.md @@ -7,6 +7,8 @@ ms.topic: concept-article --- # Understanding parse trees +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + You can define one or more parse trees in your registrar script, where each parse tree has the following form: > \{\}+ diff --git a/docs/atl/understanding-window-traits.md b/docs/atl/understanding-window-traits.md index df7884f8624..a6a391133f6 100644 --- a/docs/atl/understanding-window-traits.md +++ b/docs/atl/understanding-window-traits.md @@ -3,11 +3,12 @@ description: "Learn more about: Understanding Window Traits" title: "ATL Window Traits" ms.date: "11/04/2016" helpviewer_keywords: ["window traits"] -ms.assetid: c90cf850-9e91-49da-9cf3-ad4efb30347d ms.topic: concept-article --- # Understanding Window Traits +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Window traits classes provide a simple method for standardizing the styles used for the creation of an ATL window object. Window traits are accepted as template parameters by [CWindowImpl](../atl/reference/cwindowimpl-class.md) and other ATL window classes as a way of providing default window styles at the class level. If the creator of a window instance doesn't provide styles explicitly in the call to [Create](../atl/reference/cwindowimpl-class.md#create), you can use a traits class to ensure that the window is still created with the correct styles. You can even ensure that certain styles are set for all instances of that window class while permitting other styles to be set on a per-instance basis. diff --git a/docs/atl/using-a-template-library.md b/docs/atl/using-a-template-library.md index 11bd456ff96..7fae7aa5932 100644 --- a/docs/atl/using-a-template-library.md +++ b/docs/atl/using-a-template-library.md @@ -3,11 +3,12 @@ description: "Learn more about: Using a Template Library" title: "Using a Template Library (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["template libraries"] -ms.assetid: 5e80ec6e-a61c-41ce-b34b-9a6252c46265 ms.topic: concept-article --- # Using a Template Library +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + A template is somewhat like a macro. As with a macro, invoking a template causes it to expand (with appropriate parameter substitution) to code you have written. However, a template goes further than this to allow the creation of new classes based on types that you pass as parameters. These new classes implement type-safe ways of performing the operation expressed in your template code. Template libraries such as ATL differ from traditional C++ class libraries in that they are typically supplied only as source code (or as source code with a little, supporting run time) and are not inherently or necessarily hierarchical in nature. Rather than deriving from a class to get the functionality you desire, you instantiate a class from a template. diff --git a/docs/atl/using-a-window.md b/docs/atl/using-a-window.md index 69488133ae5..99a3e945018 100644 --- a/docs/atl/using-a-window.md +++ b/docs/atl/using-a-window.md @@ -3,11 +3,12 @@ description: "Learn more about: Using a Window" title: "Using a Window (ATL)" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, windows", "CWindow class, about CWindow class", "windows [C++], ATL"] -ms.assetid: b3b9cc8e-4287-486b-b080-38852bc2943a ms.topic: concept-article --- # Using a Window +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Class [CWindow](../atl/reference/cwindow-class.md) allows you to use a window. Once you attach a window to a `CWindow` object, you can then call `CWindow` methods to manipulate the window. `CWindow` also contains an HWND operator to convert a `CWindow` object to an HWND. Thus you can pass a `CWindow` object to any function that requires a handle to a window. You can easily mix `CWindow` method calls and Win32 function calls, without creating any temporary objects. Because `CWindow` has only two data member (a window handle and the default dimensions), it does not impose an overhead on your code. In addition, many of the `CWindow` methods simply wrap corresponding Win32 API functions. By using `CWindow`, the HWND member is automatically passed to the Win32 function. diff --git a/docs/atl/using-contained-windows.md b/docs/atl/using-contained-windows.md index 82894f8eeae..9de7cffd6db 100644 --- a/docs/atl/using-contained-windows.md +++ b/docs/atl/using-contained-windows.md @@ -3,11 +3,12 @@ description: "Learn more about: Using Contained Windows" title: "Using Contained Windows" ms.date: "11/04/2016" helpviewer_keywords: ["ATL, windows", "windows [C++], ATL", "contained windows in ATL"] -ms.assetid: 7b3d79e5-b569-413f-9b98-df4f14efbe2b ms.topic: concept-article --- # Using Contained Windows +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + ATL implements contained windows with [CContainedWindowT](../atl/reference/ccontainedwindowt-class.md). A contained window represents a window that delegates its messages to a container object instead of handling them in its own class. > [!NOTE] diff --git a/docs/atl/using-idispeventimpl.md b/docs/atl/using-idispeventimpl.md index 9e9c1537f24..10a6ef481e5 100644 --- a/docs/atl/using-idispeventimpl.md +++ b/docs/atl/using-idispeventimpl.md @@ -3,11 +3,12 @@ description: "Learn more about: Using IDispEventImpl" title: "Using IDispEventImpl (ATL)" ms.date: "08/19/2019" helpviewer_keywords: ["IDispEventImpl class, using"] -ms.assetid: 82d53b61-9d0d-45c5-aff9-2fafa468a9ca ms.topic: how-to --- # Using IDispEventImpl +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + When using `IDispEventImpl` to handle events, you will need to: - Derive your class from [IDispEventImpl](../atl/reference/idispeventimpl-class.md). diff --git a/docs/atl/using-idispeventsimpleimpl.md b/docs/atl/using-idispeventsimpleimpl.md index 3f50230f72c..875fb0cd26c 100644 --- a/docs/atl/using-idispeventsimpleimpl.md +++ b/docs/atl/using-idispeventsimpleimpl.md @@ -3,11 +3,12 @@ description: "Learn more about: Using IDispEventSimpleImpl" title: "Using IDispEventSimpleImpl (ATL)" ms.date: "08/19/2019" helpviewer_keywords: ["IDispEventSimpleImpl class, using"] -ms.assetid: 8640ad1a-4bd0-40a5-b5e4-7322685d7aab ms.topic: concept-article --- # Using IDispEventSimpleImpl +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + When using `IDispEventSimpleImpl` to handle events, you will need to: - Derive your class from [IDispEventSimpleImpl](../atl/reference/idispeventsimpleimpl-class.md). diff --git a/docs/atl/using-replaceable-parameters-the-registrar-s-preprocessor.md b/docs/atl/using-replaceable-parameters-the-registrar-s-preprocessor.md index 5541235e127..ea68a8f0ef7 100644 --- a/docs/atl/using-replaceable-parameters-the-registrar-s-preprocessor.md +++ b/docs/atl/using-replaceable-parameters-the-registrar-s-preprocessor.md @@ -3,11 +3,12 @@ description: "Learn more about: Using Replaceable Parameters (The Registrar's Pr title: "Using Replaceable Parameters (ATL Registrar)" ms.date: "11/04/2016" helpviewer_keywords: ["%MODULE%"] -ms.assetid: 0b376994-84a6-4967-8d97-8c01dfc94efe ms.topic: concept-article --- # Using Replaceable Parameters (The Registrar's Preprocessor) +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + Replaceable parameters allow a Registrar's client to specify run-time data. To do this, the Registrar maintains a replacement map into which it enters the values associated with the replaceable parameters in your script. The Registrar makes these entries at run time. ## Using %MODULE% diff --git a/docs/atl/using-task-manager.md b/docs/atl/using-task-manager.md index 31747f62825..37a86152888 100644 --- a/docs/atl/using-task-manager.md +++ b/docs/atl/using-task-manager.md @@ -3,11 +3,12 @@ description: "Learn more about: Using Task Manager" title: "Using Task Manager" ms.date: "11/04/2016" helpviewer_keywords: ["Task Manager", "breakpoints, Task Manager", "debugging [ATL], using Task Manager"] -ms.assetid: 773fccd5-308d-42c2-a17f-60ae94989062 ms.topic: how-to --- # Using Task Manager +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + One of the simplest ways to debug a service is through the use of the Task Manager. While the service is running, start the Task Manager and click the **Processes** tab. Right-click the name of the EXE and then click **Debug**. This launches Visual C++ attached to that running process. Now, click **Break** on the **Debug** menu to allow you to set breakpoints in your code. Click **Run** to run to your selected breakpoints. ## See also diff --git a/docs/atl/utility-classes.md b/docs/atl/utility-classes.md index df1f4375949..b454bb01a80 100644 --- a/docs/atl/utility-classes.md +++ b/docs/atl/utility-classes.md @@ -4,10 +4,11 @@ title: "Utility Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["utility classes"] -ms.assetid: 33d5da9d-89a5-49f9-a873-a26499299d17 --- # Utility Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following MFC-independent utility classes are provided: - [CImage](../atl-mfc-shared/reference/cimage-class.md) Provides enhanced bitmap support, including the ability to load and save images in JPEG, GIF, BMP, and Portable Network Graphics (PNG) formats. diff --git a/docs/atl/windows-support-classes.md b/docs/atl/windows-support-classes.md index caa906a9fb4..a8f615fa208 100644 --- a/docs/atl/windows-support-classes.md +++ b/docs/atl/windows-support-classes.md @@ -4,10 +4,11 @@ title: "Windows Support Classes (ATL)" ms.date: "11/04/2016" ms.topic: "reference" helpviewer_keywords: ["ATL, windows", "windows [C++], ATL"] -ms.assetid: 750b14d5-d787-4d2b-9728-ac199ccad489 --- # Windows Support Classes +[!INCLUDE[product-lifecycle-status](includes/lifecycle-note.md)] + The following classes provide support for windows: - [_U_MENUorID](../atl/reference/u-menuorid-class.md) Provides wrappers for `CreateWindow` and `CreateWindowEx`. diff --git a/docs/build-insights/build-performance.md b/docs/build-insights/build-performance.md new file mode 100644 index 00000000000..13a51332376 --- /dev/null +++ b/docs/build-insights/build-performance.md @@ -0,0 +1,183 @@ +--- +title: "Get Started with GitHub Copilot build performance for Windows" +description: "Learn how to use GitHub Copilot to improve build times." +ms.date: 01/21/2026 +helpviewer_keywords: ["GitHub Copilot build performance", "C++ Build Insights", "build time optimization", "header file analysis", "template instantiation", "Visual Studio build performance"] +ms.topic: how-to +--- + +# Get started with GitHub Copilot build performance for Windows  + +The GitHub Copilot build performance for Windows helps you make your builds faster. It finds expensive headers, template instantiations, and functions and can automatically make your builds more efficient. GitHub Copilot is integrated with Visual Studio. + +## Prerequisites  + +- Visual Studio 2026 version 18.3 Insiders 4, or later. +- MSVC Build Tools version 14.50 or later. +- An MSBuild or CMake project. +- Windows 10 or later. + +### Before you begin  + +In the Visual Studio 2026 Installer, ensure the following components are selected in the **Desktop development with C++** [workload](/visualstudio/install/install-visual-studio#step-4---choose-workloads): + +:::image type="complex" source="./media/vs-installer-options.png" alt-text="Screenshot of the Visual Studio installer."::: +The desktop development with C++ section is highlighted and C++ Build Insights, C++ profiling tools, and C++ CMake tools for Windows are selected. +:::image-end::: + +### Verify your GitHub Copilot subscription + +To use GitHub Copilot build performance for Windows, you need a GitHub Copilot Pro, Pro+, Business, or Enterprise subscription. + +Verify your GitHub Copilot subscription on GitHub, and then sign in to your GitHub account in Visual Studio 2026. + +1. Verify your GitHub Copilot subscription by signing in to [https://github.com](https://github.com/). Select your profile picture and then [Copilot settings](https://github.com/settings/copilot/features). Your plan type appears near the top of the page: + + :::image type="complex" source="./media/copilot-subscription.png" alt-text="Screenshot showing the user's GitHub Copilot information."::: + The Copilot settings page shows the type of subscription. In this case, the user has GitHub Copilot Enterprise. + :::image-end::: +1. In Visual Studio, sign in to your GitHub account: + - If you're not signed in to GitHub in Visual Studio, open the GitHub Copilot Chat and follow the sign-in instructions in the pop-up window. + - Confirm your GitHub sign-in status by selecting your profile picture in Visual Studio. You should see that your GitHub account is **Active**: + + :::image type="complex" source="./media/vs-account-authentication.png" alt-text="Screenshot of the account dropdown in Visual Studio."::: + The account dropdown shows that a Microsoft account and a GitHub account are both signed in and active. + :::image-end::: + +### Enable template collection + +To minimize analysis overhead, the template instantiation time collection is off by default. Turn it on: + + 1. In Visual Studio, go to **Tools** > **Options**. + 1. In the **Options** dialog, expand **Build Insights**. + 1. Select **Collect Template Instantiation**. + +:::image type="complex" source="./media/build-insights-options.png" alt-text="Screenshot of the Build Insights settings page in Visual Studio Options with the Collect template instantiation checkbox enabled, displaying trace collection configurations for analysis."::: +The dialog shows trace collection settings with the Collect template instantiation checkbox selected. +:::image-end::: + +For more information about template instantiation on build time, see [Troubleshoot template instantiation impact on build time | Microsoft Learn](/cpp/build-insights/tutorials/build-insights-template-view) + +## Troubleshoot build performance with GitHub Copilot + +To start the GitHub Copilot build performance agent: + +1. Open the GitHub Copilot chat pane and type '@'. One of the options is **@BuildPerfCpp**. Select it: + + :::image type="complex" source="./media/copilot-build-perf-select.png" alt-text="Screenshot of the GitHub Copilot chat pane."::: + The GitHub Copilot chat pane shows a list of agents to choose from. Build Perf C p p (optimize your c + + build) is selected. + :::image-end::: + +1. Select your preferred model in the model drop down menu: + + :::image type="complex" source="./media/model-select.png" alt-text="Screenshot of the model selection menu in the Copilot Chat window."::: + This dropdown lists various models like GPT-5, CLaude Sonnet 4, Gemini 3 Pro, and others. + :::image-end::: + +1. Instruct GitHub Copilot to improve the build performance of your selected project by typing something like **Help me improve the build performance of this project**. You can add extra context so that GitHub Copilot can better make suggestions to match the needs of your project. + + :::image type="complex" source="./media/copilot-build-request.png" alt-text="Screenshot of the GitHub Copilot Chat window."::: + The GitHub Copilot chat window shows @ Build Per Cpp: Help me improve the build performance of this project. + :::image-end::: + +### Permissions + +The first time you use GitHub Copilot build performance for Windows, you may need to enable Build Insights and grant elevated permissions to collect MSVC compiler traces. + +Visual Studio needs elevated permissions to analyze build performance and the Build Insights tool needs to be enabled. It stays enabled until you disable it. For more information about these permissions, see [Build Insights needs additional permissions](/cpp/build-insights/elevate-note). + +If GitHub Copilot prompts you to enable Build Insights and grant elevated permissions, choose **Confirm**: + +:::image type="complex" source="./media/build-insights-permission.png" alt-text="Screenshot of a GitHub Copilot dialog asking to elevate permissions."::: +The dialog indicates that Build Insights (vcperf) needs additional permissions to capture MSVC compiler traces. There are Confirm and Deny buttons. +:::image-end::: + +A Visual Studio dialog then appears prompting you to allow a one-time elevated request: + +:::image type="complex" source="./media/msvc-elevation.png" alt-text="Screenshot of a Microsoft Visual Studio prompt requesting elevated permissions."::: +The elevation prompt says: Build Insights (vcperf) needs additional permissions to capture MSVC compiler traces. Allow this one-time elevated request? There are Yes and No buttons. +:::image-end::: + +Choose **Yes**. The Windows User Account Control dialog then appears: + +:::image type="complex" source="./media/windows-user-account-control.png" alt-text="Screenshot of the User Account Control dialog."::: +The dialog asks for permission for the Windows Command Processor, verified publisher Microsoft, to allow this app to make changes to your device. There are Yes and No buttons. +:::image-end::: + +Choose **Yes** to grant permission to capture the MSVC compiler traces. Denying the elevated request cancels the build analysis. + +## Guide GitHub Copilot through the process of improving the build time + +As you guide GitHub Copilot through the process of improving the build time, it may ask you to provide permission to run tools such as PowerShell scripts: + +:::image type="complex" source="./media/terminal-permission.png" alt-text="Screenshot of a Copilot Chat notification."::: +The prompt asks the user to authorize running the command: ls ../src/ in the terminal. The Confirm dropdown offers: Always allow and Allow in this session. There's also a Deny button. +:::image-end::: + +Choose the level of permission you are comfortable with. If you deny the request, GitHub Copilot can't proceed with the build performance analysis. + +Copilot may go through multiple iterations to find the best way to make the build faster. In this chat example, Copilot made its first build performance improvement but recognizes more areas to optimize. + +:::image type="complex" source="./media/build-analysis-complete.png" alt-text="Screenshot of a message in the GitHub Copilot chat window."::: +The message indicates that analysis is complete and the build time improved from 78.6 seconds to 70.5 seconds (8.1 seconds faster, ~10.3% improvement). It indicates there's still room for improvement. +:::image-end::: + +When the analysis is done, GitHub Copilot displays a summary of the changes and build performance impact for that iteration: + +:::image type="complex" source="./media/build-summary.png" alt-text="Screenshot of the build performance summary."::: +The summary shows a before and after optimization summary indicating build time, the top bottleneck, and the top five headers that contributed the most to the build time. The report shows build time dropping from 110.7 seconds to 34.1 seconds. It highlights a 69.2% overall improvement and faster incremental rebuilds after enabling precompiled headers. +:::image-end::: + +In this example, build time dropped from **110.7s to 34.1s** after enabling precompiled headers for costly includes. A **69% improvement** and **3.2× faster builds** with near-instant incremental rebuilds. + +### Other ways to access GitHub Copilot build performance for Windows + +You can access the GitHub Copilot build performance for Windows in other ways: + +The **Build** menu: + + :::image type="complex" source="./media/build-menu-improve.png" alt-text="Screenshot of the Build menu."::: + The Build menu option Run Build Insights is expanded to show Build All, Rebuild All, and Improve Build Performance. The latter is selected. + :::image-end::: + + Select **Improve build performance on Solution** to open the GitHub Copilot chat window, which prompts you to optimize the build performance of your project. + :::image type="complex" source="./media/copilot-improve-prompt.png" alt-text="Screenshot of the Copilot chat window."::: + The chat window shows a prompt to Improve Build Performance. + :::image-end::: + +Or use the **Solution** window context menu which you can access by right-clicking the solution node: + + :::image type="complex" source="./media/solution-menu-improve.png" alt-text="A screenshot of the Solution explorer."::: + The context menu shows Build Solution, Build Solution, and so on. Improve build performance on Solution is highlighted. + :::image-end::: + + Select **Improve build performance on Solution** to open the GitHub Copilot chat window, which prompts you to optimize the build performance of your project. + + :::image type="complex" source="./media/copilot-improve-prompt.png" alt-text="Screenshot of the Copilot chat window."::: + The chat window shows a prompt to Improve Build Performance. + :::image-end::: + +Or from the **Build Insights** view: + + Select **Improve** from the Build Insights diagnostics session view to open the GitHub Copilot chat window, which prompts you to optimize the build performance of your project. This button uses data from the existing build insights trace results. It doesn't do a new analysis until the current changes are processed. + + :::image type="complex" source="./media/insights-improve-button.png" alt-text="Screenshot of the Build Insights view window."::: + The Improve link is highlighted. + :::image-end::: + + The GitHub Copilot chat window is prompted to optimize the build performance of your project, focusing on includes. + + :::image type="complex" source="./media/copilot-improve-includes.png" alt-text="Screenshot of the Copilot chat window with focusing on includes prompt."::: + The chat window shows a prompt to Improve Build Performance, focusing on includes. + :::image-end::: + +## Summary + +By combining MSVC Build Insights with GitHub Copilot, you can identify build bottlenecks and apply fixes without manually analyzing trace data or configuring precompiled headers yourself. The workflow handles trace collection, analysis, and code changes in an iterative loop until build times are reduced to your satisfaction. + +## See also + +[Build Insights function view](/cpp/build-insights/tutorials/build-insights-function-view)\ +[Build Insights included files view](/cpp/build-insights/tutorials/build-insights-included-files-view)\ +[vcperf and Windows Performance Analyzer](/cpp/build-insights/tutorials/vcperf-and-wpa)\ +[Windows Performance Analyzer basics](/cpp/build-insights/tutorials/wpa-basics) \ No newline at end of file diff --git a/docs/build-insights/elevate-note.md b/docs/build-insights/elevate-note.md new file mode 100644 index 00000000000..f13849c4b32 --- /dev/null +++ b/docs/build-insights/elevate-note.md @@ -0,0 +1,22 @@ +--- +title: "Build Insights needs additional permissions" +description: "To capture trace files, Build Insights needs additional permissions as described in this topic." +ms.topic: concept-article +ms.date: 12/9/2025 +ms.update-cycle: 3650-days +f1_keywords: + - bi_permissions +--- +# Build Insights needs additional permissions + +Starting with Visual Studio 2026, Build Insights and `vcperf` need extra permissions to capture traces. + +To allow `vcperf` to capture build traces, please accept the one time, per user, elevated prompt that appears when you first attempt to capture a trace: + +:::image type="content" source="./media/elevation-prompt.png" alt-text="A screenshot of the elevation prompt. It says: To capture trace files, Build Insights needs additional permissions. Allow this one-time elevated request?"::: + +Once you accept this elevation request, you can capture trace files with `vcperf`. You won't be prompted again to elevate permissions again. Accepting this request doesn't elevate permissions for Visual Studio--only for `vcperf` so it can to capture traces. + +## See also + +[Get started with C++ Build Insights](get-started-with-cpp-build-insights.md) \ No newline at end of file diff --git a/docs/build-insights/index.yml b/docs/build-insights/index.yml index 5020326898f..bf11ccdb5e3 100644 --- a/docs/build-insights/index.yml +++ b/docs/build-insights/index.yml @@ -25,6 +25,8 @@ landingContent: url: get-started-with-cpp-build-insights.md - linkListType: tutorial links: + - text: Get started with GitHub Copilot build performance for Windows + url: build-performance.md - text: Build Insights function view url: tutorials/build-insights-function-view.md - text: Build Insights included files view diff --git a/docs/build-insights/media/build-analysis-complete.png b/docs/build-insights/media/build-analysis-complete.png new file mode 100644 index 00000000000..18857c6d623 Binary files /dev/null and b/docs/build-insights/media/build-analysis-complete.png differ diff --git a/docs/build-insights/media/build-insights-options.png b/docs/build-insights/media/build-insights-options.png new file mode 100644 index 00000000000..e8fce846167 Binary files /dev/null and b/docs/build-insights/media/build-insights-options.png differ diff --git a/docs/build-insights/media/build-insights-permission.png b/docs/build-insights/media/build-insights-permission.png new file mode 100644 index 00000000000..4a54a2c87d1 Binary files /dev/null and b/docs/build-insights/media/build-insights-permission.png differ diff --git a/docs/build-insights/media/build-menu-improve.png b/docs/build-insights/media/build-menu-improve.png new file mode 100644 index 00000000000..14fd3cbe2fa Binary files /dev/null and b/docs/build-insights/media/build-menu-improve.png differ diff --git a/docs/build-insights/media/build-summary.png b/docs/build-insights/media/build-summary.png new file mode 100644 index 00000000000..fc7e0a51bff Binary files /dev/null and b/docs/build-insights/media/build-summary.png differ diff --git a/docs/build-insights/media/copilot-build-perf-select.png b/docs/build-insights/media/copilot-build-perf-select.png new file mode 100644 index 00000000000..4bda984a9ca Binary files /dev/null and b/docs/build-insights/media/copilot-build-perf-select.png differ diff --git a/docs/build-insights/media/copilot-build-request.png b/docs/build-insights/media/copilot-build-request.png new file mode 100644 index 00000000000..325ec315daa Binary files /dev/null and b/docs/build-insights/media/copilot-build-request.png differ diff --git a/docs/build-insights/media/copilot-improve-includes.png b/docs/build-insights/media/copilot-improve-includes.png new file mode 100644 index 00000000000..2a398182634 Binary files /dev/null and b/docs/build-insights/media/copilot-improve-includes.png differ diff --git a/docs/build-insights/media/copilot-improve-prompt.png b/docs/build-insights/media/copilot-improve-prompt.png new file mode 100644 index 00000000000..43a5194dc4a Binary files /dev/null and b/docs/build-insights/media/copilot-improve-prompt.png differ diff --git a/docs/build-insights/media/copilot-subscription.png b/docs/build-insights/media/copilot-subscription.png new file mode 100644 index 00000000000..9147ff7177c Binary files /dev/null and b/docs/build-insights/media/copilot-subscription.png differ diff --git a/docs/build-insights/media/elevation-prompt.png b/docs/build-insights/media/elevation-prompt.png new file mode 100644 index 00000000000..619c2999d87 Binary files /dev/null and b/docs/build-insights/media/elevation-prompt.png differ diff --git a/docs/build-insights/media/insights-improve-button.png b/docs/build-insights/media/insights-improve-button.png new file mode 100644 index 00000000000..ba4a0383b82 Binary files /dev/null and b/docs/build-insights/media/insights-improve-button.png differ diff --git a/docs/build-insights/media/model-select.png b/docs/build-insights/media/model-select.png new file mode 100644 index 00000000000..4c3db683c85 Binary files /dev/null and b/docs/build-insights/media/model-select.png differ diff --git a/docs/build-insights/media/msvc-elevation.png b/docs/build-insights/media/msvc-elevation.png new file mode 100644 index 00000000000..7404b6f41ab Binary files /dev/null and b/docs/build-insights/media/msvc-elevation.png differ diff --git a/docs/build-insights/media/solution-menu-improve.png b/docs/build-insights/media/solution-menu-improve.png new file mode 100644 index 00000000000..8b52818c8bb Binary files /dev/null and b/docs/build-insights/media/solution-menu-improve.png differ diff --git a/docs/build-insights/media/terminal-permission.png b/docs/build-insights/media/terminal-permission.png new file mode 100644 index 00000000000..4baf7683bf5 Binary files /dev/null and b/docs/build-insights/media/terminal-permission.png differ diff --git a/docs/build-insights/media/vs-account-authentication.png b/docs/build-insights/media/vs-account-authentication.png new file mode 100644 index 00000000000..3e62cf49c70 Binary files /dev/null and b/docs/build-insights/media/vs-account-authentication.png differ diff --git a/docs/build-insights/media/vs-installer-options.png b/docs/build-insights/media/vs-installer-options.png new file mode 100644 index 00000000000..6bd7c59e9f8 Binary files /dev/null and b/docs/build-insights/media/vs-installer-options.png differ diff --git a/docs/build-insights/media/windows-user-account-control.png b/docs/build-insights/media/windows-user-account-control.png new file mode 100644 index 00000000000..7bee87290d7 Binary files /dev/null and b/docs/build-insights/media/windows-user-account-control.png differ diff --git a/docs/build-insights/reference/sdk/functions/relog.md b/docs/build-insights/reference/sdk/functions/relog.md index 4bf0bb1dcee..c68f319545d 100644 --- a/docs/build-insights/reference/sdk/functions/relog.md +++ b/docs/build-insights/reference/sdk/functions/relog.md @@ -75,7 +75,7 @@ A result code from the [`RESULT_CODE`](../other-types/result-code-enum.md) enum. ### Remarks -The input trace is passed through the analyzer group *`numberOfAnalysisPasses`* times. There's no similar option for relogging passes. The trace is passed trough the relogger group only once, after all analysis passes are complete. +The input trace is passed through the analyzer group *`numberOfAnalysisPasses`* times. There's no similar option for relogging passes. The trace is passed through the relogger group only once, after all analysis passes are complete. The relogging of system events like CPU samples from within a relogger class isn't supported. Use the *`systemEventsRetentionFlags`* parameter to decide which system events to keep in the output trace. diff --git a/docs/build-insights/reference/sdk/functions/stop-and-relog-tracing-session.md b/docs/build-insights/reference/sdk/functions/stop-and-relog-tracing-session.md index b89dc7f62f5..10f6b58ae14 100644 --- a/docs/build-insights/reference/sdk/functions/stop-and-relog-tracing-session.md +++ b/docs/build-insights/reference/sdk/functions/stop-and-relog-tracing-session.md @@ -72,7 +72,7 @@ A result code from the [RESULT_CODE](../other-types/result-code-enum.md) enum. ### Remarks -The input trace is passed through the analyzer group *numberOfAnalysisPasses* times. There's no similar option for relogging passes. The trace is passed trough the relogger group only once, after all analysis passes are complete. +The input trace is passed through the analyzer group *numberOfAnalysisPasses* times. There's no similar option for relogging passes. The trace is passed through the relogger group only once, after all analysis passes are complete. The relogging of system events like CPU samples from within a relogger class isn't supported. Use the *systemEventsRetentionFlags* parameter to decide which system events to keep in the output trace. diff --git a/docs/build-insights/toc.yml b/docs/build-insights/toc.yml index d5f07030b96..f9c51225e1d 100644 --- a/docs/build-insights/toc.yml +++ b/docs/build-insights/toc.yml @@ -6,6 +6,8 @@ items: - name: "Tutorials" expanded: true items: + - name: "Get started with GitHub Copilot build performance for Windows" + href: ../build-insights/build-performance.md - name: "Troubleshoot function inlining impact on build time" href: ../build-insights/tutorials/build-insights-function-view.md - name: "Troubleshoot template instantiation impact on build time" diff --git a/docs/build-insights/tutorials/build-insights-tips.md b/docs/build-insights/tutorials/build-insights-tips.md index b9c2b0e6f6c..45b4517777f 100644 --- a/docs/build-insights/tutorials/build-insights-tips.md +++ b/docs/build-insights/tutorials/build-insights-tips.md @@ -4,7 +4,7 @@ description: "Learn time-saving tips for using Build Insights." ms.date: 1/8/2025 author: tylermsft ms.author: twhitney -ms.topic: article +ms.topic: concept-article helpviewer_keywords: ["C++ Build Insights tips and tricks"] --- # Build Insights tips and tricks diff --git a/docs/build/arm64-exception-handling.md b/docs/build/arm64-exception-handling.md index d459965ede4..dc383c44181 100644 --- a/docs/build/arm64-exception-handling.md +++ b/docs/build/arm64-exception-handling.md @@ -401,7 +401,7 @@ Step 6: Allocate remaining stack, including local area, `` pair, and out \* If **CR** == 01 and **RegI** is an odd number, step 3 and the last `save_reg` in step 2 are merged into one `save_regp`. -\*\* If **RegI** == **CR** == 0, and **RegF** != 0, the first `stp` for the floating-point does the predecrement. +\*\* If **RegI** == 0, **CR** != 01, and **RegF** != 0, the first `stp` for the floating-point does the predecrement to adjust sp to allocate space for the FP/SIMD save area. \*\*\* No instruction corresponding to `mov x29,sp` is present in the epilog. Packed unwind data can't be used if a function requires restoration of `sp` from `x29`. diff --git a/docs/build/arm64-windows-abi-conventions.md b/docs/build/arm64-windows-abi-conventions.md index b5357e9bf3f..0d4f98ff387 100644 --- a/docs/build/arm64-windows-abi-conventions.md +++ b/docs/build/arm64-windows-abi-conventions.md @@ -260,5 +260,5 @@ The cycle counter here is a true cycle counter, not a wall clock. The counting f ## See also -[Common Visual C++ ARM Migration Issues](common-visual-cpp-arm-migration-issues.md)
+[Common Microsoft C++ ARM Migration Issues](common-visual-cpp-arm-migration-issues.md)
[ARM64 exception handling](arm64-exception-handling.md) diff --git a/docs/build/arm64ec-windows-abi-conventions.md b/docs/build/arm64ec-windows-abi-conventions.md index 9c78bc39f54..4cd9117c777 100644 --- a/docs/build/arm64ec-windows-abi-conventions.md +++ b/docs/build/arm64ec-windows-abi-conventions.md @@ -9,7 +9,7 @@ ARM64EC is an application binary interface (ABI) that enables ARM64 binaries to For more information on the x64 and ARM64 ABIs, see [Overview of x64 ABI conventions](x64-software-conventions.md) and [Overview of ARM64 ABI conventions](arm64-windows-abi-conventions.md). -ARM64EC doesn't solve memory model differences between x64 and ARM based architectures. For more information, see [Common Visual C++ ARM migration issues](common-visual-cpp-arm-migration-issues.md). +ARM64EC doesn't solve memory model differences between x64 and ARM based architectures. For more information, see [Common Microsoft C++ ARM migration issues](common-visual-cpp-arm-migration-issues.md). ## Definitions @@ -188,5 +188,5 @@ The ARM64EC toolchain currently doesn't support `__vectorcall`. The compiler emi ## See also [Understanding ARM64EC ABI and assembly code](/windows/arm/arm64ec-abi)\ -[Common Visual C++ ARM migration issues](common-visual-cpp-arm-migration-issues.md)\ +[Common Microsoft C++ ARM migration issues](common-visual-cpp-arm-migration-issues.md)\ [Decorated names](./reference/decorated-names.md) diff --git a/docs/build/building-c-cpp-isolated-applications-and-side-by-side-assemblies.md b/docs/build/building-c-cpp-isolated-applications-and-side-by-side-assemblies.md index 01183ef9898..8a247863e48 100644 --- a/docs/build/building-c-cpp-isolated-applications-and-side-by-side-assemblies.md +++ b/docs/build/building-c-cpp-isolated-applications-and-side-by-side-assemblies.md @@ -10,9 +10,9 @@ ms.topic: concept-article Visual Studio supports a deployment model for Windows client applications based on the idea of [isolated applications](/windows/win32/SbsCs/isolated-applications) and [side-by-side assemblies](/windows/win32/SbsCs/about-side-by-side-assemblies-). By default, Visual Studio builds all native C/C++ applications as isolated applications that use [manifests](/windows/win32/sbscs/manifests) to describe their dependencies on Visual C++ libraries. -Building C/C++ programs as isolated applications presents a range of advantages. For example, an isolated application is unaffected when other C/C++ applications install or uninstall Visual C++ libraries. Visual C++ libraries used by isolated applications may still be redistributed in either the application's local folder, or by installation to the native assembly cache (WinSxS); however, servicing of Visual C++ libraries for already deployed applications can be simplified by using a [publisher configuration file](/windows/win32/SbsCs/publisher-configuration). The isolated application deployment model makes it easier to ensure that C/C++ applications that are running on a specific computer use the most recent version of Visual C++ libraries, while still leaving open the possibility for system administrators and application authors to control explicit version binding of applications to their dependent DLLs. +Building C/C++ programs as isolated applications presents a range of advantages. For example, an isolated application is unaffected when other C/C++ applications install or uninstall Microsoft C++ libraries. Microsoft C++ libraries used by isolated applications may still be redistributed in either the application's local folder, or by installation to the native assembly cache (WinSxS); however, servicing of Microsoft C++ libraries for already deployed applications can be simplified by using a [publisher configuration file](/windows/win32/SbsCs/publisher-configuration). The isolated application deployment model makes it easier to ensure that C/C++ applications that are running on a specific computer use the most recent version of Microsoft C++ libraries, while still leaving open the possibility for system administrators and application authors to control explicit version binding of applications to their dependent DLLs. -This section discusses how you can build your C/C++ application as an isolated application and ensure that it binds to Visual C++ libraries using a manifest. The information in this section primarily applies to native, or unmanaged, C++ applications. For information about deploying native C++ applications built with Visual Studio, see [Redistributing Visual C++ Files](../windows/redistributing-visual-cpp-files.md). +This section discusses how you can build your C/C++ application as an isolated application and ensure that it binds to Microsoft C++ libraries using a manifest. The information in this section primarily applies to native, or unmanaged, C++ applications. For information about deploying native C++ applications built with Visual Studio, see [Redistributing Microsoft C++ Files](../windows/redistributing-visual-cpp-files.md). ## In This Section diff --git a/docs/build/building-on-the-command-line.md b/docs/build/building-on-the-command-line.md index 7b4a452f29b..5f7a2fdff45 100644 --- a/docs/build/building-on-the-command-line.md +++ b/docs/build/building-on-the-command-line.md @@ -1,15 +1,14 @@ --- -title: "Use the Microsoft C++ toolset from the command line" -description: "Use the Microsoft C++ (MSVC) compiler toolset from the command line outside of the Visual Studio IDE." +title: "Use the Microsoft C++ Build Tools from the command line" +description: "Use the Microsoft C++ (MSVC) Build Tools from the command line outside of the Visual Studio IDE." ms.custom: "conceptual" ms.date: 04/07/2022 -helpviewer_keywords: ["command-line builds [C++]", "compiling source code [C++], command line", "builds [C++], command-line", "command line [C++], building from", "command line [C++], compilers"] -ms.assetid: 7ca9daed-a003-4162-842d-908f79058365 ms.topic: how-to +helpviewer_keywords: ["command-line builds [C++]", "compiling source code [C++], command line", "builds [C++], command-line", "command line [C++], building from", "command line [C++], compilers"] --- -# Use the Microsoft C++ toolset from the command line +# Use the Microsoft C++ Build Tools from the command line -You can build C and C++ applications on the command line by using tools that are included in Visual Studio. The Microsoft C++ (MSVC) compiler toolset is also downloadable as a standalone package. You don't need to install the Visual Studio IDE if you don't plan to use it. +You can build C and C++ applications on the command line by using tools that are included in Visual Studio. The Microsoft C++ (MSVC) Build Tools are also downloadable as a standalone package. You don't need to install the Visual Studio IDE if you don't plan to use it. > [!NOTE] > This article is about how to set up an environment to use the individual compilers, linkers, librarian, and other basic tools. The native project build system in Visual Studio, based on MSBuild, doesn't use the environment as described in this article. For more information on how to use MSBuild from the command line, see [MSBuild on the command line - C++](msbuild-visual-cpp.md). @@ -18,18 +17,18 @@ You can build C and C++ applications on the command line by using tools that are ::: moniker range=">=msvc-160" -If you've installed Visual Studio and a C++ workload, you have all the command-line tools. For information on how to install C++ and Visual Studio, see [Install C++ support in Visual Studio](vscpp-step-0-installation.md). If you only want the command-line toolset, download the [Build Tools for Visual Studio](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022). When you run the downloaded executable, it updates and runs the Visual Studio Installer. To install only the tools you need for C++ development, select the **Desktop development with C++** workload. You can select optional libraries and toolsets to include under **Installation details**. To build code by using the Visual Studio 2015, 2017, or 2019 toolsets, select the optional MSVC v140, v141, or v142 build tools. When you're satisfied with your selections, choose **Install**. +If you've installed Visual Studio and a C++ workload, you have all the command-line tools. For information on how to install C++ and Visual Studio, see [Install C++ support in Visual Studio](vscpp-step-0-installation.md). If you only want the command-line toolset, download the [Build Tools for Visual Studio](https://visualstudio.microsoft.com/downloads/). On the downloads page, expand the **Tools for Visual Studio** section to find the Build Tools download. When you run the downloaded executable, it updates and runs the Visual Studio Installer. To install only the tools you need for C++ development, select the **Desktop development with C++** workload. You can select optional libraries and toolsets to include under **Installation details**. To build code by using the Visual Studio 2015, 2017, or 2019 toolsets, select the optional MSVC v140, v141, or v142 build tools. When you're satisfied with your selections, choose **Install**. ::: moniker-end ::: moniker range="<=msvc-150" -If you've installed Visual Studio and a C++ workload, you have all the command-line tools. For information on how to install C++ and Visual Studio, see [Install C++ support in Visual Studio](vscpp-step-0-installation.md). If you only want the command-line toolset, download the [Build Tools for Visual Studio 2017](https://my.visualstudio.com/Downloads?q=2017). When you run the downloaded executable, it updates and runs the Visual Studio Installer. To install only the tools you need for C++ development, select the **Visual C++ build tools** workload. You can select optional libraries and toolsets to include under **Installation details**. To build code by using the Visual Studio 2015 toolset, select the optional MSVC v140 build tools. When you're satisfied with your selections, choose **Install**. +If you've installed Visual Studio and a C++ workload, you have all the command-line tools. For information on how to install C++ and Visual Studio, see [Install C++ support in Visual Studio](vscpp-step-0-installation.md). If you only want the command-line toolset, download the [Build Tools for Visual Studio 2017](https://my.visualstudio.com/Downloads?q=2017). When you run the downloaded executable, it updates and runs the Visual Studio Installer. To install only the tools you need for C++ development, select the **Desktop development with C++** workload. You can select optional libraries and toolsets to include under **Installation details**. To build code by using the Visual Studio 2015 toolset, select the optional MSVC v140 build tools. When you're satisfied with your selections, choose **Install**. ::: moniker-end ## How to use the command-line tools -When you choose one of the C++ workloads in the Visual Studio Installer, it installs the Visual Studio *platform toolset*. A platform toolset has all the C and C++ tools for a specific Visual Studio version. The tools include the C/C++ compilers, linkers, assemblers, and other build tools, and matching libraries and header files. You can use all of these tools at the command line. They're also used internally by the Visual Studio IDE. There are separate x86-hosted and x64-hosted compilers and tools to build code for x86, x64, ARM, and ARM64 targets. Each set of tools for a particular host and target build architecture is stored in its own directory. +When you choose one of the C++ workloads in the Visual Studio Installer, by default, it installs a particular version of the MSVC Build Tools package. For Visual Studio 2022 and earlier, this is organized by a *platform toolset* (v### version format) that has all the C and C++ tools for a specific version of Visual Studio. For Visual Studio 2026 and later, this consists of the MSVC version (v##.## version format), which has all the C and C++ tools for that particular MSVC package. The MSVC version is decoupled from the Visual Studio version. The tools include the C/C++ compilers, linkers, assemblers, and other build tools, and matching libraries and header files. You can use all of these tools at the command-line. They're also used internally by the Visual Studio IDE. There are separate x86-hosted and x64-hosted compilers and tools that build code for x86, x64, ARM, and ARM64 targets. Each set of tools for a particular host and target build architecture is stored in its own directory. To work correctly, the tools require several specific environment variables to be set. These variables are used to add the tools to the path, and to set the locations of include files, library files, and SDKs. To make it easy to set these environment variables, the installer creates customized *command files*, or batch files, during installation. You can run one of these command files to set a specific host and target build architecture, Windows SDK version, and platform toolset. For convenience, the installer also creates shortcuts in your Start menu. The shortcuts open developer command prompt windows by using these command files for specific combinations of host and target. These shortcuts ensure all the required environment variables are set and ready to use. @@ -81,7 +80,7 @@ The Start menu folder and shortcut names vary depending on the installed version For an even faster way to open a developer command prompt, enter *developer command prompt* in the desktop search box. Then choose the result you want. > [!NOTE] -> By default, the current working directory in a developer command prompt is the root of your Visual Studio installation in the Program Files directory. This isn't an appropriate location for your code and projects. Change the current working directory to another location before you create a project. The IDE creates projects in your user directory, typically in *%USERPROFILE%\\source\\repos*. +> By default, the current working directory in a developer command prompt is the root of your Visual Studio installation in the Program Files directory. This isn't an appropriate location for your code and projects. Change the current working directory to another location before you create a project. The IDE creates projects in your user directory, typically in *`%USERPROFILE%\source\repos`*. ## Developer command file locations @@ -89,7 +88,7 @@ If you prefer to set the build environment in an existing command prompt window, ::: moniker range=">= msvc-170" -The command file location depends on the version of Visual Studio you installed, and on choices you made during installation. For Visual Studio 2019, the typical installation location on a 64-bit system is in *`\Program Files\Microsoft Visual Studio\2022\`*. The *``* may be Community, Professional, Enterprise, BuildTools, or another nickname you supplied. +The command file location depends on the version of Visual Studio you installed, and on choices you made during installation. For Visual Studio 2022, the typical installation location on a 64-bit system is in *`\Program Files\Microsoft Visual Studio\2022\`*. The *``* may be Community, Professional, Enterprise, BuildTools, or another nickname you supplied. ::: moniker-end ::: moniker range="= msvc-160" @@ -112,12 +111,12 @@ The primary developer command prompt command file, *`VsDevCmd.bat`*, is located ::: moniker range=">= msvc-150" -More command files are available to set up specific build architectures. The command files available depend on the Visual Studio workloads and options you've installed. In Visual Studio 2017 and Visual Studio 2019, you'll find them in the VC\\Auxiliary\\Build subdirectory. +More command files are available to set up specific build architectures. The command files available depend on the Visual Studio workloads and options you've installed. In Visual Studio 2017 and Visual Studio 2019, you'll find them in the *`VC\Auxiliary\Build`* subdirectory. ::: moniker-end ::: moniker range="< msvc-150" -More command files are available to set up specific build architectures. The command files available depend on the Visual Studio workloads and options you've installed. In Visual Studio 2015, they're located in the VC, VC\\bin, or VC\\bin\\*architecture* subdirectories, where *architecture* is one of the native or cross-compiler options. +More command files are available to set up specific build architectures. The command files available depend on the Visual Studio workloads and options you've installed. In Visual Studio 2015, they're located in the *`VC`*, *`VC\bin`*, or *`VC\bin\`* subdirectories, where *``* is one of the native or cross-compiler options. ::: moniker-end @@ -150,8 +149,8 @@ When used with no arguments, *`vcvarsall.bat`* configures the environment variab > **`vcvarsall.bat`** [*`architecture`*] [*`platform_type`*] [*`winsdk_version`*] [**`-vcvars_ver=`***`vcversion`*] [*`spectre_mode`*] -*`architecture`*
-This optional argument specifies the host and target architecture to use. If *architecture* isn't specified, the default build environment is used. These arguments are supported: +*`architecture`*\ +This optional argument specifies the host and target architecture to use. If *`architecture`* isn't specified, the default build environment is used. These arguments are supported: | *`architecture`* | Compiler | Host computer architecture | Build output (target) architecture | |--|--|--|--| @@ -164,13 +163,13 @@ This optional argument specifies the host and target architecture to use. If *ar | `amd64_arm` or `x64_arm` | ARM on x64 cross | x64 | ARM | | `amd64_arm64` or `x64_arm64` | ARM64 on x64 cross | x64 | ARM64 | -*`platform_type`*
+*`platform_type`*\ This optional argument allows you to specify **`store`** or **`uwp`** as the platform type. By default, the environment is set to build desktop or console apps. -*`winsdk_version`*
+*`winsdk_version`*\ Optionally specifies the version of the Windows SDK to use. By default, the latest installed Windows SDK is used. To specify the Windows SDK version, you can use a full Windows SDK number such as **`10.0.10240.0`**, or specify **`8.1`** to use the Windows 8.1 SDK. -*`vcversion`*
+*`vcversion`*\ Optionally specifies the Visual Studio compiler toolset to use. By default, the environment is set to use the current Visual Studio compiler toolset. ::: moniker range=">= msvc-160" @@ -195,11 +194,13 @@ Leave this parameter out to use libraries without Spectre mitigations. Use the v #### To set up the build environment in an existing command prompt window -1. At the command prompt, use the CD command to change to the Visual Studio installation directory. Then, use CD again to change to the subdirectory that contains the configuration-specific command files. For Visual Studio 2019 and Visual Studio 2017, use the *VC\\Auxiliary\\Build* subdirectory. For Visual Studio 2015, use the *VC* subdirectory. +1. At the command prompt, use the `CD` command to change to the Visual Studio installation directory. Then, use `CD` again to change to the subdirectory that contains the configuration-specific command files. For Visual Studio 2019 and Visual Studio 2017, use the *`VC\Auxiliary\Build`* subdirectory. For Visual Studio 2015, use the *`VC`* subdirectory. 1. Enter the command for your preferred developer environment. For example, to build ARM code for UWP on a 64-bit platform, using the latest Windows SDK and Visual Studio compiler toolset, use this command line: - `vcvarsall.bat amd64_arm uwp` + ```cmd + vcvarsall.bat amd64_arm uwp + ``` ## Create your own command prompt shortcut @@ -207,21 +208,27 @@ Leave this parameter out to use libraries without Spectre mitigations. Use the v Open the Properties dialog for a developer command prompt shortcut to see the command target used. For example, the target for the **x64 Native Tools Command Prompt for VS 2019** shortcut is something similar to: -`%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"` +```cmd +%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat" +``` ::: moniker-end ::: moniker range="= msvc-150" Open the Properties dialog for a developer command prompt shortcut to see the command target used. For example, the target for the **x64 Native Tools Command Prompt for VS 2017** shortcut is something similar to: -`%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"` +```cmd +%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat" +``` ::: moniker-end ::: moniker range="< msvc-150" Open the Properties dialog for a developer command prompt shortcut to see the command target used. For example, the target for the **VS2015 x64 Native Tools Command Prompt** shortcut is something similar to: -`%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64` +```cmd +%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64 +``` ::: moniker-end @@ -229,31 +236,37 @@ The architecture-specific batch files set the *`architecture`* parameter and cal ::: moniker range=">= msvc-160" -`%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" amd64_arm uwp -vcvars_ver=14.29` +```cmd +%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" amd64_arm uwp -vcvars_ver=14.29 +``` ::: moniker-end ::: moniker range="= msvc-150" -`%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvarsall.bat" amd64_arm uwp -vcvars_ver=14.19` +```cmd +%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvarsall.bat" amd64_arm uwp -vcvars_ver=14.19 +``` ::: moniker-end ::: moniker range="< msvc-150" -`%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64 -vcvars_ver=14.0` +```cmd +%comspec% /k "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64 -vcvars_ver=14.0 +``` ::: moniker-end -Adjust the path to reflect your Visual Studio installation directory. The vcvarsall.bat file has additional information about specific version numbers. +Adjust the path to reflect your Visual Studio installation directory. The *`vcvarsall.bat`* file has additional information about specific version numbers. ## Command-line tools To build a C/C++ project at a command prompt, Visual Studio provides these command-line tools: -[`CL`](reference/compiling-a-c-cpp-program.md)
-Use the compiler (cl.exe) to compile and link source code files into apps, libraries, and DLLs. +[`CL`](reference/compiling-a-c-cpp-program.md)\ +Use the compiler (`cl.exe`) to compile and link source code files into apps, libraries, and DLLs. -[`Link`](reference/linking.md)
-Use the linker (link.exe) to link compiled object files and libraries into apps and DLLs. +[`Link`](reference/linking.md)\ +Use the linker (`link.exe`) to link compiled object files and libraries into apps and DLLs. When you build on the command line, the F1 command isn't available for instant help. Instead, you can use a search engine to get information about warnings, errors, and messages. You can also download and use the offline help files. To use the search in Microsoft Learn, enter your query in the search box at the top of any article. @@ -262,16 +275,16 @@ When you build on the command line, the F1 command isn't available for instant h By default, the Visual Studio IDE uses native project build systems based on MSBuild. You can invoke MSBuild directly to build projects without using the IDE. You can also use the `devenv` command to use Visual Studio to build projects and solutions. Visual Studio also supports build systems based on CMake or NMake. [`MSBuild`](msbuild-visual-cpp.md)\ -Use MSBuild (msbuild.exe) and a project file (.vcxproj) to configure a build and invoke the toolset without loading the Visual Studio IDE. It's equivalent to running the **Build** project or **Build Solution** command in the Visual Studio IDE. MSBuild has advantages over the IDE when you build at the command line. You don't have to install the full IDE on all your build servers and build pipelines. You avoid the extra overhead of the IDE. MSBuild runs in containerized build environments, and supports a [binary logger](https://msbuildlog.com/). +Use MSBuild (`msbuild.exe`) and a project file (`.vcxproj`) to configure a build and invoke the toolset without loading the Visual Studio IDE. It's equivalent to running the **Build** project or **Build Solution** command in the Visual Studio IDE. MSBuild has advantages over the IDE when you build at the command line. You don't have to install the full IDE on all your build servers and build pipelines. You avoid the extra overhead of the IDE. MSBuild runs in containerized build environments, and supports a [binary logger](https://msbuildlog.com/). [`DEVENV`](/visualstudio/ide/reference/devenv-command-line-switches)\ -Use DEVENV (devenv.exe) combined with a command-line switch such as **`/Build`** or **`/Clean`** to execute certain build commands without displaying the Visual Studio IDE. +Use DEVENV (`devenv.exe`) combined with a command-line switch such as **`/Build`** or **`/Clean`** to execute certain build commands without displaying the Visual Studio IDE. [`CMake`](../build/cmake-projects-in-visual-studio.md)\ -CMake (cmake.exe) is a cross-platform, open-source tool for defining build processes that run on multiple platforms. CMake can configure and control native build tools for its supported platforms, such as MSBuild and Make. For more information about CMake, see the [CMake documentation](https://cmake.org/cmake/help/latest/index.html#). +CMake (`cmake.exe`) is a cross-platform, open-source tool for defining build processes that run on multiple platforms. CMake can configure and control native build tools for its supported platforms, such as MSBuild and Make. For more information about CMake, see the [CMake documentation](https://cmake.org/cmake/help/latest/index.html#). [`NMAKE`](reference/nmake-reference.md)\ -Use NMAKE (nmake.exe) to build C++ projects by using a traditional makefile. +Use NMAKE (`nmake.exe`) to build C++ projects by using a traditional makefile. > [!NOTE] > Starting in Visual Studio 2019 version 16.5, MSBuild and DEVENV don't use the command-line environment to control the toolset and libraries used. @@ -280,36 +293,36 @@ Use NMAKE (nmake.exe) to build C++ projects by using a traditional makefile. These articles show how to build apps on the command line, and describe how to customize the command-line build environment. Some show how to use 64-bit toolsets, and target x86, x64, ARM, and ARM64 platforms. They also describe use of the command-line build tools MSBuild and NMAKE. -[Walkthrough: Compiling a native C++ program on the command line](walkthrough-compiling-a-native-cpp-program-on-the-command-line.md)
+[Walkthrough: Compiling a native C++ program on the command line](walkthrough-compiling-a-native-cpp-program-on-the-command-line.md)\ Gives an example that shows how to create and compile a C++ program on the command line. -[Walkthrough: Compile a C program on the command line](walkthrough-compile-a-c-program-on-the-command-line.md)
+[Walkthrough: Compile a C program on the command line](walkthrough-compile-a-c-program-on-the-command-line.md)\ Describes how to compile a program written in the C programming language. -[Walkthrough: Compiling a C++/CLI program on the command line](walkthrough-compiling-a-cpp-cli-program-on-the-command-line.md)
+[Walkthrough: Compiling a C++/CLI program on the command line](walkthrough-compiling-a-cpp-cli-program-on-the-command-line.md)\ Describes how to create and compile a C++/CLI program that uses the .NET Framework. -[Walkthrough: Compiling a C++/CX program on the command line](walkthrough-compiling-a-cpp-cx-program-on-the-command-line.md)
+[Walkthrough: Compiling a C++/CX program on the command line](walkthrough-compiling-a-cpp-cx-program-on-the-command-line.md)\ Describes how to create and compile a C++/CX program that uses the Windows Runtime. -[NMAKE reference](reference/nmake-reference.md)
-Provides links to articles that describe the Microsoft Program Maintenance Utility (NMAKE.EXE). +[NMAKE reference](reference/nmake-reference.md)\ +Provides links to articles that describe the Microsoft Program Maintenance Utility (`NMAKE.EXE`). -[MSBuild on the command line - C++](msbuild-visual-cpp.md)
-Provides links to articles that discuss how to use msbuild.exe from the command line. +[MSBuild on the command line - C++](msbuild-visual-cpp.md)\ +Provides links to articles that discuss how to use `msbuild.exe` from the command line. ## Related sections -[/MD, /MT, /LD (Use run-time library)](reference/md-mt-ld-use-run-time-library.md)
+[`/MD`, `/MT`, `/LD` (Use run-time library)](reference/md-mt-ld-use-run-time-library.md)\ Describes how to use these compiler options to use a Debug or Release run-time library. -[C/C++ compiler options](reference/compiler-options.md)
-Provides links to articles that discuss the C and C++ compiler options and CL.exe. +[C/C++ compiler options](reference/compiler-options.md)\ +Provides links to articles that discuss the C and C++ compiler options and `CL.exe`. -[MSVC linker options](reference/linker-options.md)
-Provides links to articles that discuss the linker options and LINK.exe. +[MSVC linker options](reference/linker-options.md)\ +Provides links to articles that discuss the linker options and `LINK.exe`. -[Additional MSVC build tools](reference/c-cpp-build-tools.md)
+[Additional MSVC build tools](reference/c-cpp-build-tools.md)\ Provides links to the C/C++ build tools that are included in Visual Studio. ## See also diff --git a/docs/build/clang-support-msbuild.md b/docs/build/clang-support-msbuild.md index 6e44fbb42ab..8741b608e9b 100644 --- a/docs/build/clang-support-msbuild.md +++ b/docs/build/clang-support-msbuild.md @@ -1,7 +1,7 @@ --- title: "Clang/LLVM support in Visual Studio projects" description: "Learn more about: Clang/LLVM support in Visual Studio projects" -ms.date: 03/13/2024 +ms.date: 12/11/2025 ms.description: "Configure a Visual Studio MSBuild project to use the Clang/LLVM toolchain." helpviewer_keywords: ["Clang support for C++ MSBuild projects"] --- @@ -49,6 +49,10 @@ The Individual components tab is selected in the installer. C++ Clang Compiler f ::: moniker range=">=msvc-160" Later versions of Visual Studio provide newer versions of the Clang toolset. The bundled version of Clang gets updated automatically to stay current with updates in the Microsoft implementation of the Standard Library. For example, Visual Studio 2019 version 16.11 includes Clang v12. +The LLVM experience in Visual Studio delivers seamless build support, project system integration, and design-time features that work with your choice of LLVM distributions. For acquisition convenience, we provide an optional LLVM binary distribution with Visual Studio. This LLVM toolset is provided as-is, sourced directly from the [LLVM Foundation’s release page](https://github.com/llvm/llvm-project/releases) without modifications by Microsoft. The installed binaries are digitally signed with a third-party Microsoft code signing certificate to mark their third-party status and to confirm that they were obtained from the LLVM Foundation’s release page. + +LLVM updates in Visual Studio are typically aligned with major LLVM releases ahead of a Visual Studio general release. However, if the community or partners report security or critical blocking issues addressed in a minor LLVM release, we prioritize updating the bundled LLVM toolset to a newer minor version containing the fix. Visual Studio’s build and project system supports using your own custom LLVM installation if needed. + ## Configure a Windows project to use Clang tools To configure a Visual Studio project to use Clang, right-click on the project node in **Solution Explorer** and choose **Properties**. Typically, you should first choose **All configurations** at the top of the dialog. Then, under **General** > **Platform Toolset**, choose **LLVM (clang-cl)** and then **OK**. @@ -111,12 +115,12 @@ When you add a `Directory.build.props` file to a project or solution, the settin ## Set properties, edit, build, and debug -After you have set up a Clang configuration, right-click again on the project node and choose **Reload project**. You can now build and debug the project using the Clang tools. Visual Studio detects that you're using the Clang compiler and provides IntelliSense, highlighting, navigation, and other editing features. Errors and warnings are displayed in the **Output Window**. The project property pages for a Clang configuration are similar to the ones for MSVC. However, some compiler-dependent features such as Edit and Continue aren't available for Clang configurations. You can set a Clang compiler or linker option that isn't available in the property pages. Add it manually in the property pages under **Configuration Properties** > **C/C++ (or Linker)** > **Command Line** > **Additional Options**. +After you set up a Clang configuration, right-click again on the project node and choose **Reload project**. You can now build and debug the project using the Clang tools. Visual Studio detects that you're using the Clang compiler and provides IntelliSense, highlighting, navigation, and other editing features. Errors and warnings are displayed in the **Output Window**. The project property pages for a Clang configuration are similar to the ones for MSVC. However, some compiler-dependent features such as Edit and Continue aren't available for Clang configurations. You can set a Clang compiler or linker option that isn't available in the property pages. Add it manually in the property pages under **Configuration Properties** > **C/C++ (or Linker)** > **Command Line** > **Additional Options**. When debugging, you can use breakpoints, memory and data visualization, and most other debugging features. :::image type="complex" source="media/clang-debug-msbuild.png" alt-text="Screenshot of Visual Studio debugging a sample app"::: -The portion of the app that is visible creates a string vector and adds some strings to it. Execution has stopped on a breakpoint for the code: v.push_back("Clang/LLVM");. +The portion of the app that's visible creates a string vector and adds some strings to it. Execution stopped on a breakpoint for the code v.push_back("Clang/LLVM");. :::image-end::: ::: moniker-end diff --git a/docs/build/cmake-presets-vs.md b/docs/build/cmake-presets-vs.md index b5f46cac1be..62d80010a54 100644 --- a/docs/build/cmake-presets-vs.md +++ b/docs/build/cmake-presets-vs.md @@ -4,6 +4,7 @@ description: "Reference for using CMake Presets to configure and build CMake pro ms.date: 06/09/2023 ms.topic: reference ms.custom: sfi-image-nochange +ai-usage: ai-assisted --- # Configure and build with CMake Presets in Visual Studio @@ -265,7 +266,7 @@ For more information on generators that support the `toolset` specification, see To reproduce these builds outside Visual Studio, see [Run CMake from the command line or a CI pipeline](#run-cmake-from-the-command-line-or-a-ci-pipeline). -To build on Linux or without the Visual C++ toolset, specify the name of a compiler on your `PATH` instance, or an environment variable that evaluates to the full path of a compiler. Full paths are discouraged so that the file can remain shareable. A preset that builds with GCC version 8 might look like this: +To build on Linux or without the Microsoft C++ (MSVC) Build Tools, specify the name of a compiler on your `PATH` instance, or an environment variable that evaluates to the full path of a compiler. Full paths are discouraged so that the file can remain shareable. A preset that builds with GCC version 8 might look like this: ```json "environment": { @@ -290,7 +291,7 @@ Set `architecture.strategy` and `toolset.strategy` to `set` when you're building You can set the configuration type (`Debug` or `Release`) for single configuration generators by using `cacheVariables.CMAKE_BUILD_TYPE`. It's equivalent to passing `-D CMAKE_BUILD_TYPE=` to CMake from the command line. For more information, see [`CMAKE_BUILD_TYPE`](https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html). -### Select your target and host architecture when building with the Visual C++ toolset +### Select your target and host architecture when building with the Microsoft C++ Build Tools You can set the target architecture (x64, Win32, ARM64, or ARM) by using `architecture.value`. It's equivalent to passing `-A` to CMake from the command line. For more information, see [Platform Selection](https://cmake.org/cmake/help/latest/generator/Visual%20Studio%2016%202019.html#platform-selection). @@ -460,13 +461,45 @@ The `` part lists other compilation flags, like `"-fno-omit- Pass runtime flags to AddressSanitizer by using the `ASAN_OPTIONS` field in *`launch.vs.json`*. `ASAN_OPTIONS` defaults to `detect_leaks=0` when no other runtime options are specified because LeakSanitizer isn't supported in Visual Studio. +## Enable Segment Heap + +The Segment Heap is a Windows heap implementation that reduces memory usage and fragmentation. Visual Studio ships a CMake script that enables Segment Heap for your project by adding the required manifest settings. New C++ CMake projects enable Segment Heap by default. + +To enable Segment Heap, set `CMAKE_PROJECT_TOP_LEVEL_INCLUDES` in the `cacheVariables` map of your Configure Preset in *`CMakePresets.json`*. Optionally, set the `VS_SEGMENT_HEAP_ALLOWLIST` and `VS_SEGMENT_HEAP_EXCLUDE` environment variables to control which targets in the project use Segment Heap. Separate target names with semicolons: + + ```json +{ + "configurePresets": [ + { + // ... + "environment": { + "VS_SEGMENT_HEAP_ALLOWLIST": "target1;target2;", + "VS_SEGMENT_HEAP_EXCLUDE": "target3;" + }, + "cacheVariables": { + "CMAKE_PROJECT_TOP_LEVEL_INCLUDES": "$env{VSINSTALLDIR}Common7/IDE/CommonExtensions/Microsoft/CMake/cmake/Microsoft/SegmentHeap.cmake" + } + } + ] +} + +``` + +> [!NOTE] +> `CMAKE_PROJECT_TOP_LEVEL_INCLUDES` is available in CMake 3.24 or later. + +- `VS_SEGMENT_HEAP_ALLOWLIST` — Apply the Segment Heap manifest entry only to the listed targets. Exclude all other targets. +- `VS_SEGMENT_HEAP_EXCLUDE` — Exclude the listed targets from using the Segment Heap. + +In this example, `CMAKE_PROJECT_TOP_LEVEL_INCLUDES` points to the Visual Studio-provided `SegmentHeap.cmake` script. The optional `VS_SEGMENT_HEAP_ALLOWLIST` and `VS_SEGMENT_HEAP_EXCLUDE` variables show how to include or exclude specific targets. If neither variable is set, Visual Studio enables Segment Heap for all targets. If both variables are set, `VS_SEGMENT_HEAP_ALLOWLIST` takes precedence. + ## Run CMake from the command line or a CI pipeline You can use the same *`CMakePresets.json`* and *`CMakeUserPresets.json`* files to invoke CMake in Visual Studio and from the command line. The [CMake](https://cmake.org/cmake/help/latest/manual/cmake.1.html) and [CTest](https://cmake.org/cmake/help/latest/manual/ctest.1.html) documentation are the best resources for invoking CMake and CTest with `--preset`. CMake version 3.20 or later is required. ### Sourcing the environment when building with command-line generators on Windows -It's up to the user to configure the environment before CMake is invoked in building with a command-line generator. If you're building with Ninja and the Visual C++ toolset on Windows, set the environment before CMake is called to generate the build system. You can do it by calling *`vcvarsall.bat`* with the `architecture` argument. The `architecture` argument specifies the host and target architecture to use. For more information, see [`vcvarsall` syntax](./building-on-the-command-line.md#vcvarsall-syntax). If you build on Linux or on Windows with a Visual Studio Generator, you don't need to take this step. +It's up to the user to configure the environment before CMake is invoked in building with a command-line generator. If you're building with Ninja and the Microsoft C++ Build Tools on Windows, set the environment before CMake is called to generate the build system. You can do it by calling *`vcvarsall.bat`* with the `architecture` argument. The `architecture` argument specifies the host and target architecture to use. For more information, see [`vcvarsall` syntax](./building-on-the-command-line.md#vcvarsall-syntax). If you build on Linux or on Windows with a Visual Studio Generator, you don't need to take this step. It's the same step that Visual Studio takes for you when the IDE invokes CMake. Visual Studio parses the active Configure Preset for the host and target architecture specified by `toolset` and `architecture`. Visual Studio then sources the specified environment from *`vcvarsall.bat`*. When you build from the Windows command line with Ninja, you'll need to take this step yourself. diff --git a/docs/build/cmake-projects-in-visual-studio.md b/docs/build/cmake-projects-in-visual-studio.md index 0ca5262c430..5dcd6b75af3 100644 --- a/docs/build/cmake-projects-in-visual-studio.md +++ b/docs/build/cmake-projects-in-visual-studio.md @@ -147,7 +147,7 @@ You can customize a CMake debugging session by setting properties in the *`launc ### Just My Code for CMake projects -When you build for Windows using the MSVC compiler, CMake projects have support for Just My Code debugging. To change the Just My Code setting, go to **Tools** > **Options** > **Debugging** > **General**. For more information on Just My Code debugging, see [Debug only user code with Just My Code](/visualstudio/debugger/just-my-code). +When you build for Windows using the Microsoft C++ (MSVC) compiler, CMake projects have support for Just My Code debugging. To change the Just My Code setting, go to **Tools** > **Options** > **Debugging** > **General**. For more information on Just My Code debugging, see [Debug only user code with Just My Code](/visualstudio/debugger/just-my-code). ### Edit and Continue for CMake projects diff --git a/docs/build/cmakesettings-reference.md b/docs/build/cmakesettings-reference.md index e9a6acdb8ff..274b0237bf1 100644 --- a/docs/build/cmakesettings-reference.md +++ b/docs/build/cmakesettings-reference.md @@ -122,7 +122,7 @@ By default, when the active configuration specifies a Visual Studio generator, i - `remotePreGenerateCommand`: Specifies the command to run before running CMake to parse the *`CMakeLists.txt`* file. - `remotePrebuildCommand`: Specifies the command to run on the remote machine before building. - `remotePostbuildCommand`: Specifies the command to run on the remote machine after building. -- `variables`: Contains a name-value pair of CMake variables that get passed as **`-D name=value`** to CMake. If your CMake project build instructions specify the addition of any variables directly to the *`CMakeCache.txt`* file, we recommend you add them here instead. This example shows how to specify the name-value pairs to use the 14.14.26428 MSVC toolset: +- `variables`: Contains a name-value pair of CMake variables that get passed as **`-D name=value`** to CMake. If your CMake project build instructions specify the addition of any variables directly to the *`CMakeCache.txt`* file, we recommend you add them here instead. This example shows how to specify the name-value pairs to use the 14.14.26428 MSVC Build Tools: ```json "variables": [ diff --git a/docs/build/common-visual-cpp-64-bit-migration-issues.md b/docs/build/common-visual-cpp-64-bit-migration-issues.md index 531a59ee624..7d8603ea722 100644 --- a/docs/build/common-visual-cpp-64-bit-migration-issues.md +++ b/docs/build/common-visual-cpp-64-bit-migration-issues.md @@ -1,13 +1,13 @@ --- -description: "Learn more about: Common Visual C++ 64-bit Migration Issues" -title: "Common Visual C++ 64-bit Migration Issues" +description: "Learn more about: Common Microsoft C++ 64-bit Migration Issues" +title: "Common Microsoft C++ 64-bit Migration Issues" ms.date: "05/06/2019" helpviewer_keywords: ["64-bit programming [C++], migration", "64-bit compiler [C++], migration", "porting 32-bit code to 64-bit code", "migration [C++], 64-bit code issues", "32-bit code porting [C++]", "64-bit applications [C++]", "64-bit compiler [C++], porting 32-bit code", "Win64 [C++]"] ms.assetid: d17fb838-7513-4e2d-8b27-a1666f17ad76 --- -# Common Visual C++ 64-bit Migration Issues +# Common Microsoft C++ 64-bit Migration Issues -When you use the Microsoft C++ compiler (MSVC) to create applications to run on a 64-bit Windows operating system, you should be aware of the following issues: +When you use the Microsoft C++ (MSVC) compiler to create applications to run on a 64-bit Windows operating system, you should be aware of the following issues: - An **`int`** and a **`long`** are 32-bit values on 64-bit Windows operating systems. For programs that you plan to compile for 64-bit platforms, you should be careful not to assign pointers to 32-bit variables. Pointers are 64-bit on 64-bit platforms, and you will truncate the pointer value if you assign it to a 32-bit variable. @@ -34,4 +34,4 @@ For more information, see: ## See also [Configure C++ projects for 64-bit, x64 targets](configuring-programs-for-64-bit-visual-cpp.md)
-[Visual C++ Porting and Upgrading Guide](../porting/visual-cpp-porting-and-upgrading-guide.md) +[Microsoft C++ Porting and Upgrading Guide](../porting/visual-cpp-porting-and-upgrading-guide.md) diff --git a/docs/build/common-visual-cpp-arm-migration-issues.md b/docs/build/common-visual-cpp-arm-migration-issues.md index 36035c044bf..bd39965f08d 100644 --- a/docs/build/common-visual-cpp-arm-migration-issues.md +++ b/docs/build/common-visual-cpp-arm-migration-issues.md @@ -1,9 +1,9 @@ --- -description: "Learn more about: Common Visual C++ ARM Migration Issues" -title: "Common Visual C++ ARM Migration Issues" +description: "Learn more about: Common Microsoft C++ ARM Migration Issues" +title: "Common Microsoft C++ ARM Migration Issues" ms.date: "05/06/2019" --- -# Common Visual C++ ARM migration issues +# Common Microsoft C++ ARM migration issues This document describes some of the common issues that you might encounter when you migrate code from x86 or x64 architectures to the ARM architecture. It also describes how to avoid these issues, and how to use the compiler to help identify them. @@ -89,7 +89,7 @@ And if there's a dependency between `operator->(memory_handle)` and `operator*(p ### `volatile` keyword default behavior -The MSVC compiler supports two different interpretations of the **`volatile`** storage qualifier that you can specify by using compiler switches. The [/volatile:ms](reference/volatile-volatile-keyword-interpretation.md) switch selects the Microsoft extended volatile semantics that guarantee strong ordering, as has been the traditional case for x86 and x64 because of the strong memory model on those architectures. The [/volatile:iso](reference/volatile-volatile-keyword-interpretation.md) switch selects the strict C++ standard volatile semantics that don't guarantee strong ordering. +The Microsoft C++ (MSVC) compiler supports two different interpretations of the **`volatile`** storage qualifier that you can specify by using compiler switches. The [/volatile:ms](reference/volatile-volatile-keyword-interpretation.md) switch selects the Microsoft extended volatile semantics that guarantee strong ordering, as has been the traditional case for x86 and x64 because of the strong memory model on those architectures. The [/volatile:iso](reference/volatile-volatile-keyword-interpretation.md) switch selects the strict C++ standard volatile semantics that don't guarantee strong ordering. On the ARM architecture (except ARM64EC), the default is **/volatile:iso** because ARM processors have a weakly ordered memory model, and because ARM software doesn't have a legacy of relying on the extended semantics of **/volatile:ms** and doesn't usually have to interface with software that does. However, it's still sometimes convenient or even required to compile an ARM program to use the extended semantics. For example, it may be too costly to port a program to use the ISO C++ semantics, or driver software might have to adhere to the traditional semantics to function correctly. In these cases, you can use the **/volatile:ms** switch; however, to recreate the traditional volatile semantics on ARM targets, the compiler must insert memory barriers around each read or write of a **`volatile`** variable to enforce strong ordering, which can have a negative impact on performance. @@ -97,4 +97,4 @@ On the x86, x64, and ARM64EC architectures, the default is **/volatile:ms** beca ## See also -[Configure Visual C++ for ARM processors](configuring-programs-for-arm-processors-visual-cpp.md) +[Configure Microsoft C++ for ARM processors](configuring-programs-for-arm-processors-visual-cpp.md) diff --git a/docs/build/compare-inclusion-methods.md b/docs/build/compare-inclusion-methods.md index 8c16032aee4..2f8c25c5b6a 100644 --- a/docs/build/compare-inclusion-methods.md +++ b/docs/build/compare-inclusion-methods.md @@ -40,4 +40,4 @@ If you can't use C++20 features, use `#include` and consider precompiled headers [Overview of modules in C++](../cpp/modules-cpp.md)\ [Tutorial: Import the C++ standard library using modules](../cpp/tutorial-import-stl-named-module.md)\ [Walkthrough: Import STL libraries as header units](walkthrough-import-stl-header-units.md#approach1)\ -[Walkthrough: Build and import header units in your Visual C++ projects](walkthrough-header-units.md) \ No newline at end of file +[Walkthrough: Build and import header units in your Microsoft C++ projects](walkthrough-header-units.md) \ No newline at end of file diff --git a/docs/build/concepts-of-isolated-applications-and-side-by-side-assemblies.md b/docs/build/concepts-of-isolated-applications-and-side-by-side-assemblies.md index ef50625ae8d..2993d7abb37 100644 --- a/docs/build/concepts-of-isolated-applications-and-side-by-side-assemblies.md +++ b/docs/build/concepts-of-isolated-applications-and-side-by-side-assemblies.md @@ -24,9 +24,9 @@ At execution time, Windows uses assembly information from the application manife You can change side-by-side assembly dependencies after an application has been deployed by modifying the [Publisher Configuration Files](/windows/win32/SbsCs/publisher-configuration-files) and [Application Configuration Files](/windows/win32/SbsCs/application-configuration-files). A publisher configuration file, also known as a publisher policy file, is an XML file that globally redirects applications and assemblies from using one version of a side-by-side assembly to using another version of the same assembly. For example, you could change a dependency when a bug fix or security fix is deployed for a side-by-side assembly and you want to redirect all applications to use the fixed version. An application configuration file is an XML file that redirects a specific application from using one version of a side-by-side assembly to using another version of the same assembly. You can use an application configuration file to redirect a particular application to use a version of a side-by-side assembly that's different from the one that's defined in the publisher configuration file. For more information, see [Configuration](/windows/win32/SbsCs/configuration). -## Visual C++ libraries +## Microsoft C++ libraries -In Visual Studio 2005 and Visual Studio 2008, redistributable libraries such as ATL, MFC, CRT, Standard C++, OpenMP, and MSDIA were deployed as shared side-by-side assemblies to the native assembly cache. In the current version, the redistributable libraries use central deployment. By default, all applications that are built by using Visual Studio are built with the manifest embedded in the final binary, and the manifest describes the dependencies of the binary on the Visual C++ libraries. To understand manifest generation for C++ applications, see [Understanding Manifest Generation for C/C++ Programs](understanding-manifest-generation-for-c-cpp-programs.md). A manifest is not required for applications that are statically linked to the libraries that they use, or that use local deployment. For more information about deployment, see [Deployment in Visual C++](../windows/deployment-in-visual-cpp.md). +In Visual Studio 2005 and Visual Studio 2008, redistributable libraries such as ATL, MFC, CRT, Standard C++, OpenMP, and MSDIA were deployed as shared side-by-side assemblies to the native assembly cache. In the current version, the redistributable libraries use central deployment. By default, all applications that are built by using Visual Studio are built with the manifest embedded in the final binary, and the manifest describes the dependencies of the binary on the Microsoft C++ libraries. To understand manifest generation for C++ applications, see [Understanding Manifest Generation for C/C++ Programs](understanding-manifest-generation-for-c-cpp-programs.md). A manifest is not required for applications that are statically linked to the libraries that they use, or that use local deployment. For more information about deployment, see [Deployment in Microsoft C++](../windows/deployment-in-visual-cpp.md). ## See also diff --git a/docs/build/configuring-programs-for-64-bit-visual-cpp.md b/docs/build/configuring-programs-for-64-bit-visual-cpp.md index e922af4027d..845be402593 100644 --- a/docs/build/configuring-programs-for-64-bit-visual-cpp.md +++ b/docs/build/configuring-programs-for-64-bit-visual-cpp.md @@ -7,15 +7,15 @@ ms.assetid: cb99f72b-8c74-48f4-846a-8921b37b97e9 --- # Configure C++ projects for 64-bit, x64 targets -This section contains topics about targeting 64-bit x64 hardware with the Visual C++ build tools. +This section contains topics about targeting 64-bit x64 hardware with the Microsoft C++ (MSVC) Build Tools. ## In This Section -- [How to: Configure Visual C++ Projects to Target 64-Bit, x64 Platforms](how-to-configure-visual-cpp-projects-to-target-64-bit-platforms.md) +- [How to: Configure Microsoft C++ Projects to Target 64-Bit, x64 Platforms](how-to-configure-visual-cpp-projects-to-target-64-bit-platforms.md) - [How to: Enable a 64-bit, x64-hosted MSVC toolset on the command line](how-to-enable-a-64-bit-visual-cpp-toolset-on-the-command-line.md) -- [Common Visual C++ 64-bit Migration Issues](common-visual-cpp-64-bit-migration-issues.md) +- [Common Microsoft C++ 64-bit Migration Issues](common-visual-cpp-64-bit-migration-issues.md) - [x64 Software Conventions](x64-software-conventions.md) diff --git a/docs/build/configuring-programs-for-arm-processors-visual-cpp.md b/docs/build/configuring-programs-for-arm-processors-visual-cpp.md index fc99baa1b25..bb6e7c40dc9 100644 --- a/docs/build/configuring-programs-for-arm-processors-visual-cpp.md +++ b/docs/build/configuring-programs-for-arm-processors-visual-cpp.md @@ -5,7 +5,7 @@ ms.date: "07/11/2018" --- # Configure C++ projects for ARM processors -This section of the documentation contains information about how to use the MSVC build tools to target ARM hardware. +This section of the documentation contains information about how to use the Microsoft C++ (MSVC) Build Tools to target ARM hardware. ## In This Section diff --git a/docs/build/cppproperties-schema-reference.md b/docs/build/cppproperties-schema-reference.md index cafd37a1e78..8ab040779a0 100644 --- a/docs/build/cppproperties-schema-reference.md +++ b/docs/build/cppproperties-schema-reference.md @@ -93,7 +93,7 @@ You can optionally use the `environments` property to define sets of variables i "mingw_64" ], "name": "Mingw64", - "includePath ,": [ + "includePath": [ "${env.INCLUDE}", "${workspaceRoot}\\**", ], diff --git a/docs/build/creating-precompiled-header-files.md b/docs/build/creating-precompiled-header-files.md index 2b0f1f5ebe1..ec450093ce7 100644 --- a/docs/build/creating-precompiled-header-files.md +++ b/docs/build/creating-precompiled-header-files.md @@ -348,5 +348,5 @@ int main( void ) [MSVC compiler options](reference/compiler-options.md)\ [Overview of modules in C++](../cpp/modules-cpp.md)\ [Tutorial: Import the C++ standard library using modules](../cpp/tutorial-import-stl-named-module.md)\ -[Walkthrough: Build and import header units in your Visual C++ projects](walkthrough-header-units.md)\ +[Walkthrough: Build and import header units in your Microsoft C++ projects](walkthrough-header-units.md)\ [Walkthrough: Import STL libraries as header units](walkthrough-import-stl-header-units.md#approach1) diff --git a/docs/build/customize-cmake-settings.md b/docs/build/customize-cmake-settings.md index 6b56804360f..5c8cd24cf4a 100644 --- a/docs/build/customize-cmake-settings.md +++ b/docs/build/customize-cmake-settings.md @@ -7,7 +7,17 @@ ms.topic: how-to --- # Customize CMake build settings -::: moniker range=">=msvc-160" +::: moniker range=">=msvc-180" + +The CMake settings editor has been deprecated in Visual Studio 2026. + +To learn about changing the *`CMakePresets.json`* file, see [CMakePresets.json and CMakeUserPresets.json Microsoft vendor maps](/cpp/build/cmake-presets-json-reference). + +For Visual Studio 2019 to 2022, select your version by using the version selector in the sidebar menu. + +::: moniker-end + +::: moniker range=">=msvc-160 <=msvc-170" Visual Studio uses a CMake configuration file to drive CMake generation and build. *`CMakePresets.json`* is supported by Visual Studio 2019 version 16.10 or later and is the recommended CMake configuration file. *`CMakePresets.json`* is supported directly by CMake and can be used to drive CMake generation and build from Visual Studio, from VS Code, in a Continuous Integration pipeline, and from the command line on Windows, Linux, and Mac. For more information on *`CMakePresets.json`*, see [Configure and build with CMake Presets](cmake-presets-vs.md). @@ -23,6 +33,10 @@ Now you see the **Settings Editor** with the installed configurations on the lef The left pane shows the installed configurations (x86-Debug). The right pane shows the settings for the selected configuration. The settings include the configuration name, configuration type (set to Debug), toolset (set to msvc_x86), CMake toolchain file (empty), build root (contains ${env:USERPROFILE}\CMakeBuilds\${workspaceHash}\build\${name}), CMake command arguments (empty), and build command arguments (-v). :::image-end::: +> [!NOTE] +> If a JSON editor opens instead of the **Settings Editor** when you select **Manage Configurations**, you need to enable the CMakeSettings mode. Under **Tools** > **Options** > **CMake**, select **Never use CMake Presets**, and then close and reopen your CMake project. Alternatively, you can choose **Use CMake Presets if available, otherwise use CMakeSettings.json**, and then delete the *CMakePresets.json* file from the project folder. +> :::image type="content" source="media/options-configuration-file.png" alt-text="Screenshot of the C make options pane."::: + Visual Studio provides one `x64-Debug` configuration by default. You can add more configurations by choosing the green plus sign. The settings that you see in the editor might vary depending on which configuration is selected. The options that you choose in the editor are written to a file called *`CMakeSettings.json`*. This file provides command-line arguments and environment variables that are passed to CMake when you build the projects. Visual Studio never modifies *`CMakeLists.txt`* automatically; by using *`CMakeSettings.json`* you can customize the build through Visual Studio while leaving the CMake project files untouched so that others on your team can consume them with whatever tools they're using. @@ -201,11 +215,11 @@ For more information about each of the properties in the file, see [`CMakeSettin ::: moniker-end -## See also +## Related content -[CMake Projects in Visual Studio](cmake-projects-in-visual-studio.md)
-[Configure a Linux CMake project](../linux/cmake-linux-project.md)
-[Connect to your remote Linux computer](../linux/connect-to-your-remote-linux-computer.md)
-[Configure CMake debugging sessions](configure-cmake-debugging-sessions.md)
-[Deploy, run, and debug your Linux project](../linux/deploy-run-and-debug-your-linux-project.md)
-[CMake predefined configuration reference](cmake-predefined-configuration-reference.md) +- [CMake Projects in Visual Studio](cmake-projects-in-visual-studio.md) +- [Configure a Linux CMake project](../linux/cmake-linux-project.md) +- [Connect to your remote Linux computer](../linux/connect-to-your-remote-linux-computer.md) +- [Configure CMake debugging sessions](configure-cmake-debugging-sessions.md) +- [Deploy, run, and debug your Linux project](../linux/deploy-run-and-debug-your-linux-project.md) +- [CMake predefined configuration reference](cmake-predefined-configuration-reference.md) diff --git a/docs/build/determining-which-exporting-method-to-use.md b/docs/build/determining-which-exporting-method-to-use.md index 58d6c4432c2..f34d60e3e3b 100644 --- a/docs/build/determining-which-exporting-method-to-use.md +++ b/docs/build/determining-which-exporting-method-to-use.md @@ -19,7 +19,7 @@ Exporting functions in a .def file gives you control over the export ordinals. W Another advantage to using a .def file is that you can use the `NONAME` attribute to export a function. This puts only the ordinal in the exports table in the DLL. For DLLs that have a large number of exported functions, using the `NONAME` attribute can reduce the size of the DLL file. For information about how to write a module definition statement, see [Rules for Module-Definition Statements](reference/rules-for-module-definition-statements.md). For information about ordinal export, see [Exporting Functions from a DLL by Ordinal Rather Than by Name](exporting-functions-from-a-dll-by-ordinal-rather-than-by-name.md). -A disadvantage of using a .def file is that if you are exporting functions in a C++ file, you either have to put the decorated names in the .def file or define the exported functions by using extern "C" to avoid the name decoration that's done by the MSVC compiler. +A disadvantage of using a .def file is that if you are exporting functions in a C++ file, you either have to put the decorated names in the .def file or define the exported functions by using extern "C" to avoid the name decoration that's done by the Microsoft C++ (MSVC) compiler. If you put the decorated names in the .def file, you can obtain them by using the [DUMPBIN](reference/dumpbin-reference.md) tool or by using the linker [/MAP](reference/map-generate-mapfile.md) option. The decorated names that are produced by the compiler are compiler-specific; therefore, if you put the decorated names that are produced by the compiler into a .def file, the applications that link to the DLL must also be built by using the same version of the compiler so that the decorated names in the calling application match the exported names in the .def file of the DLL. diff --git a/docs/build/dlls-in-visual-cpp.md b/docs/build/dlls-in-visual-cpp.md index a1974a8268a..cf7683b6c21 100644 --- a/docs/build/dlls-in-visual-cpp.md +++ b/docs/build/dlls-in-visual-cpp.md @@ -68,7 +68,7 @@ Describes explicit and implicit linking to a DLL. [Initialize a DLL](run-time-library-behavior.md#initializing-a-dll)\ Discusses DLL initialization code that must execute when your DLL loads. -[DLLs and Visual C++ run-time library behavior](run-time-library-behavior.md)\ +[DLLs and Microsoft C++ run-time library behavior](run-time-library-behavior.md)\ Describes the run-time library DLL startup sequence. [LoadLibrary and AfxLoadLibrary](loadlibrary-and-afxloadlibrary.md)\ diff --git a/docs/build/exception-handling-x64.md b/docs/build/exception-handling-x64.md index 41a6e29b6e4..efb1eac2d73 100644 --- a/docs/build/exception-handling-x64.md +++ b/docs/build/exception-handling-x64.md @@ -7,29 +7,33 @@ ms.assetid: 41fecd2d-3717-4643-b21c-65dcd2f18c93 --- # x64 exception handling -An overview of structured exception handling and C++ exception handling coding conventions and behavior on the x64. For general information on exception handling, see [Exception Handling in Visual C++](../cpp/exception-handling-in-visual-cpp.md). +An overview of structured exception handling and C++ exception handling coding conventions and behavior on the x64. For general information on exception handling, see [Exception Handling in Microsoft C++](../cpp/exception-handling-in-visual-cpp.md). -## Unwind data for exception handling, debugger support +## Unwind data for exception handling and debugger support -Several data structures are required for exception handling and debugging support. +To recover nonvolatile registers when an exception is handled, nonleaf functions are annotated with static data. This data, commonly referred to as "Function Unwind Information", describes how to properly unwind the function at an arbitrary instruction. This data is stored as *pdata*, or procedure data, which in turn refers to *xdata*, the exception handling data. + +The Function Unwind Information is composed of several data structures, described next. + +For Unwind Information supporting the Intel APX (Advanced Performance Extensions), see the [Unwind V3 Preview Specification](../build/x64-unwind-information-v3.md). ### struct RUNTIME_FUNCTION Table-based exception handling requires a table entry for all functions that allocate stack space or call another function (for example, nonleaf functions). Function table entries have the format: -|Size|Value| +| Size | Value | |-|-| |ULONG|Function start address| |ULONG|Function end address| |ULONG|Unwind info address| -The RUNTIME_FUNCTION structure must be DWORD aligned in memory. All addresses are image relative, that is, they're 32-bit offsets from the starting address of the image that contains the function table entry. These entries are sorted, and put in the .pdata section of a PE32+ image. For dynamically generated functions [JIT compilers], the runtime to support these functions must either use RtlInstallFunctionTableCallback or RtlAddFunctionTable to provide this information to the operating system. Failure to do so will result in unreliable exception handling and debugging of processes. +The `RUNTIME_FUNCTION` structure must be `DWORD` aligned in memory. All addresses are image relative, that is, they're 32-bit offsets from the starting address of the image that contains the function table entry. These entries are sorted, and put in the `.pdata` section of a PE32+ image. For dynamically generated functions [JIT compilers], the runtime to support these functions must either use `RtlInstallFunctionTableCallback` or `RtlAddFunctionTable` to provide this information to the operating system. Failure to do so results in unreliable exception handling and debugging of processes. ### struct UNWIND_INFO -The unwind data info structure is used to record the effects a function has on the stack pointer, and where the nonvolatile registers are saved on the stack: +The unwind data info structure records the effects a function has on the stack pointer and where the nonvolatile registers are saved on the stack: -|Size|Value| +| Size | Value | |-|-| |UBYTE: 3|Version| |UBYTE: 5|Flags| @@ -42,20 +46,20 @@ The unwind data info structure is used to record the effects a function has on t (1) Exception Handler -|Size|Value| +| Size | Value | |-|-| |ULONG|Address of exception handler| |variable|Language-specific handler data (optional)| (2) Chained Unwind Info -|Size|Value| +| Size | Value | |-|-| |ULONG|Function start address| |ULONG|Function end address| |ULONG|Unwind info address| -The UNWIND_INFO structure must be DWORD aligned in memory. Here's what each field means: +The `UNWIND_INFO` structure must be `DWORD` aligned in memory. Here's what each field means: - **Version** @@ -67,9 +71,9 @@ The UNWIND_INFO structure must be DWORD aligned in memory. Here's what each fiel |Flag|Description| |-|-| - |`UNW_FLAG_EHANDLER`| The function has an exception handler that should be called when looking for functions that need to examine exceptions.| - |`UNW_FLAG_UHANDLER`| The function has a termination handler that should be called when unwinding an exception.| - |`UNW_FLAG_CHAININFO`| This unwind info structure is not the primary one for the procedure. Instead, the chained unwind info entry is the contents of a previous RUNTIME_FUNCTION entry. For information, see [Chained unwind info structures](#chained-unwind-info-structures). If this flag is set, then the UNW_FLAG_EHANDLER and UNW_FLAG_UHANDLER flags must be cleared. Also, the frame register and fixed-stack allocation fields must have the same values as in the primary unwind info.| + |`UNW_FLAG_EHANDLER`| The function has an exception handler that the operating system calls to examine the state of the exception and potentially handle it. Language features such as the C `__try` clause register such a handler.| + |`UNW_FLAG_UHANDLER`| The function has a termination handler that the operation system calls when unwinding the stack. This handler could release resources allocated by the function in exception safe code. Language features such as local C++ object destructors and C `__finally` clauses register such a termination handler. | + |`UNW_FLAG_CHAININFO`| This unwind info structure isn't the primary one for the procedure. Instead, the chained unwind info entry is the contents of a previous `RUNTIME_FUNCTION` entry. For information, see [Chained unwind info structures](#chained-unwind-info-structures). If this flag is set, then the `UNW_FLAG_EHANDLER` and `UNW_FLAG_UHANDLER` flags must be cleared. Also, the frame register and fixed-stack allocation fields must have the same values as in the primary unwind info.| - **Size of prolog** @@ -77,23 +81,23 @@ The UNWIND_INFO structure must be DWORD aligned in memory. Here's what each fiel - **Count of unwind codes** - The number of slots in the unwind codes array. Some unwind codes, for example, UWOP_SAVE_NONVOL, require more than one slot in the array. + The number of slots in the unwind codes array. Some unwind codes, such as `UWOP_SAVE_NONVOL`, require more than one slot in the array. - **Frame register** - If nonzero, then the function uses a frame pointer (FP), and this field is the number of the nonvolatile register used as the frame pointer, using the same encoding for the operation info field of UNWIND_CODE nodes. + If nonzero, the function uses a frame pointer (FP), and this field is the number of the nonvolatile register used as the frame pointer, using the same encoding for the operation info field of `UNWIND_CODE` nodes. - **Frame register offset (scaled)** - If the frame register field is nonzero, this field is the scaled offset from RSP that is applied to the FP register when it's established. The actual FP register is set to RSP + 16 \* this number, allowing offsets from 0 to 240. This offset permits pointing the FP register into the middle of the local stack allocation for dynamic stack frames, allowing better code density through shorter instructions. (That is, more instructions can use the 8-bit signed offset form.) + This field is a scaled offset between the `RSP` register value and the selected Frame Pointer (FP) register value. The selected FP register is set to `RSP` + 16 * this number, which means you can use offsets from 0 to 240. This offset points the FP register into the middle of the local stack allocation for dynamic stack frames, so you get better code density through shorter instructions. (That is, more instructions can use the 8-bit signed offset form.) - **Unwind codes array** - An array of items that explains the effect of the prolog on the nonvolatile registers and RSP. See the section on UNWIND_CODE for the meanings of individual items. For alignment purposes, this array always has an even number of entries, and the final entry is potentially unused. In that case, the array is one longer than indicated by the count of unwind codes field. + An array of items that explains the effect of the prolog on the nonvolatile registers and `RSP`. See the section on [Unwind operations code](#unwind-operation-code) for the meanings of individual items. To maintain proper data alignment, this array always contains an even number of entries, and the final entry may be unused. In that case, the array is one longer than indicated by the count of unwind codes field. - **Address of exception handler** - An image-relative pointer to either the function's language-specific exception or termination handler, if flag UNW_FLAG_CHAININFO is clear and one of the flags UNW_FLAG_EHANDLER or UNW_FLAG_UHANDLER is set. + An image-relative pointer to either the function's language-specific exception or termination handler, if flag `UNW_FLAG_CHAININFO` is clear and one of the flags `UNW_FLAG_EHANDLER` or `UNW_FLAG_UHANDLER` is set. - **Language-specific handler data** @@ -101,13 +105,13 @@ The UNWIND_INFO structure must be DWORD aligned in memory. Here's what each fiel - **Chained Unwind Info** - If flag UNW_FLAG_CHAININFO is set, then the UNWIND_INFO structure ends with three UWORDs. These UWORDs represent the RUNTIME_FUNCTION information for the function of the chained unwind. + If flag `UNW_FLAG_CHAININFO` is set, the `UNWIND_INFO` structure ends with three `UWORD`s. These `UWORD`s represent the `RUNTIME_FUNCTION` information for the function of the chained unwind. ### struct UNWIND_CODE -The unwind code array is used to record the sequence of operations in the prolog that affect the nonvolatile registers and RSP. Each code item has this format: +Use the unwind code array to record the sequence of operations in the prolog that affect the nonvolatile registers and `RSP`. Each code item has this format: -|Size|Value| +| Size | Value | |-|-| |UBYTE|Offset in prolog| |UBYTE: 4|Unwind operation code| @@ -121,17 +125,17 @@ Offset (from the beginning of the prolog) of the end of the instruction that per #### Unwind operation code -Note: Certain operation codes require an unsigned offset to a value in the local stack frame. This offset is from the start, that is, the lowest address of the fixed stack allocation. If the Frame Register field in the UNWIND_INFO is zero, this offset is from RSP. If the Frame Register field is nonzero, this offset is from where RSP was located when the FP register was established. It equals the FP register minus the FP register offset (16 \* the scaled frame register offset in the UNWIND_INFO). If an FP register is used, then any unwind code taking an offset must only be used after the FP register is established in the prolog. +Certain operation codes require an unsigned offset to a value in the local stack frame. This offset is from the start, that is, the lowest address of the fixed stack allocation. If the Frame Register field in the `UNWIND_INFO` is zero, this offset is from `RSP`. If the Frame Register field is nonzero, this offset is from where `RSP` was located when the FP register was established. It equals the FP register minus the FP register offset (16 \* the scaled frame register offset in the `UNWIND_INFO`). If an FP register is used, then any unwind code taking an offset must only be used after the FP register is established in the prolog. -For all opcodes except `UWOP_SAVE_XMM128` and `UWOP_SAVE_XMM128_FAR`, the offset is always a multiple of 8, because all stack values of interest are stored on 8-byte boundaries (the stack itself is always 16-byte aligned). For operation codes that take a short offset (less than 512K), the final USHORT in the nodes for this code holds the offset divided by 8. For operation codes that take a long offset (512K <= offset < 4GB), the final two USHORT nodes for this code hold the offset (in little-endian format). +For all opcodes except `UWOP_SAVE_XMM128` and `UWOP_SAVE_XMM128_FAR`, the offset is always a multiple of 8, because all stack values of interest are stored on 8-byte boundaries (the stack itself is always 16-byte aligned). For operation codes that take a short offset (less than 512K), the final `USHORT` in the nodes for this code holds the offset divided by 8. For operation codes that take a long offset (512K <= offset < 4GB), the final two `USHORT` nodes for this code hold the offset (in little-endian format). -For the opcodes `UWOP_SAVE_XMM128` and `UWOP_SAVE_XMM128_FAR`, the offset is always a multiple of 16, since all 128-bit XMM operations must occur on 16-byte aligned memory. Therefore, a scale factor of 16 is used for `UWOP_SAVE_XMM128`, permitting offsets of less than 1M. +For the opcodes `UWOP_SAVE_XMM128` and `UWOP_SAVE_XMM128_FAR`, the offset is always a multiple of 16, since all 128-bit `XMM` operations must occur on 16-byte aligned memory. Therefore, a scale factor of 16 is used for `UWOP_SAVE_XMM128`, permitting offsets of less than 1M. The unwind operation code is one of these values: - `UWOP_PUSH_NONVOL` (0) 1 node - Push a nonvolatile integer register, decrementing RSP by 8. The operation info is the number of the register. Because of the constraints on epilogs, `UWOP_PUSH_NONVOL` unwind codes must appear first in the prolog and correspondingly, last in the unwind code array. This relative ordering applies to all other unwind codes except `UWOP_PUSH_MACHFRAME`. + Push a nonvolatile integer register, decrementing `RSP` by 8. The operation info is the number of the register. Because of the constraints on epilogs, `UWOP_PUSH_NONVOL` unwind codes must appear first in the prolog and correspondingly, last in the unwind code array. This relative ordering applies to all other unwind codes except `UWOP_PUSH_MACHFRAME`. - `UWOP_ALLOC_LARGE` (1) 2 or 3 nodes @@ -151,7 +155,7 @@ The unwind operation code is one of these values: - `UWOP_SET_FPREG` (3) 1 node - Establish the frame pointer register by setting the register to some offset of the current RSP. The offset is equal to the Frame Register offset (scaled) field in the UNWIND_INFO \* 16, allowing offsets from 0 to 240. The use of an offset permits establishing a frame pointer that points to the middle of the fixed stack allocation, helping code density by allowing more accesses to use short instruction forms. The operation info field is reserved and shouldn't be used. + Establish the frame pointer register by setting the register to some offset of the current `RSP`. The offset is equal to the Frame Register offset (scaled) field in the `UNWIND_INFO` \* 16, allowing offsets from 0 to 240. The use of an offset permits establishing a frame pointer that points to the middle of the fixed stack allocation, helping code density by allowing more accesses to use short instruction forms. The operation info field is reserved and shouldn't be used. - `UWOP_SAVE_NONVOL` (4) 2 nodes @@ -163,52 +167,52 @@ The unwind operation code is one of these values: - `UWOP_SAVE_XMM128` (8) 2 nodes - Save all 128 bits of a nonvolatile XMM register on the stack. The operation info is the number of the register. The scaled-by-16 stack offset is recorded in the next slot. + Save all 128 bits of a nonvolatile `XMM` register on the stack. The operation info is the number of the register. The scaled-by-16 stack offset is recorded in the next slot. - `UWOP_SAVE_XMM128_FAR` (9) 3 nodes - Save all 128 bits of a nonvolatile XMM register on the stack with a long offset. The operation info is the number of the register. The unscaled stack offset is recorded in the next two slots. + Save all 128 bits of a nonvolatile `XMM` register on the stack with a long offset. The operation info is the number of the register. The unscaled stack offset is recorded in the next two slots. - `UWOP_PUSH_MACHFRAME` (10) 1 node - Push a machine frame. This unwind code is used to record the effect of a hardware interrupt or exception. There are two forms. If the operation info equals 0, one of these frames has been pushed on the stack: + Push a machine frame. This unwind code records the effect of a hardware interrupt or exception. It has two forms. A value of 0, indicates hardware has pushed a frame such as this on the stack: |Location|Value| |-|-| - |RSP+32|SS| - |RSP+24|Old RSP| - |RSP+16|EFLAGS| - |RSP+8|CS| - |RSP|RIP| + |`RSP`+32|`SS`| + |`RSP`+24|Old `RSP`| + |`RSP`+16|`EFLAGS`| + |`RSP`+8|`CS`| + |`RSP`|`RIP`| - If the operation info equals 1, then one of these frames has been pushed: + A value of 1, indicates hardware has pushed a frame such as this on the stack: |Location|Value| |-|-| - |RSP+40|SS| - |RSP+32|Old RSP| - |RSP+24|EFLAGS| - |RSP+16|CS| - |RSP+8|RIP| - |RSP|Error code| + |`RSP`+40|`SS`| + |`RSP`+32|Old `RSP`| + |`RSP`+24|`EFLAGS`| + |`RSP`+16|`CS`| + |`RSP`+8|`RIP`| + |`RSP`|Error code| This unwind code always appears in a dummy prolog, which is never actually executed, but instead appears before the real entry point of an interrupt routine, and exists only to provide a place to simulate the push of a machine frame. `UWOP_PUSH_MACHFRAME` records that simulation, which indicates the machine has conceptually done this operation: - 1. Pop RIP return address from top of stack into *Temp* + 1. Pop `RIP` return address from top of stack into *Temp* - 1. Push SS + 1. Push `SS` - 1. Push old RSP + 1. Push old `RSP` - 1. Push EFLAGS + 1. Push `EFLAGS` - 1. Push CS + 1. Push `CS` 1. Push *Temp* 1. Push Error Code (if op info equals 1) - The simulated `UWOP_PUSH_MACHFRAME` operation decrements RSP by 40 (op info equals 0) or 48 (op info equals 1). + The simulated `UWOP_PUSH_MACHFRAME` operation decrements `RSP` by 40 (if op info equals 0) or 48 (if op info equals 1). #### Operation info @@ -216,57 +220,57 @@ The meaning of the operation info bits depends upon the operation code. To encod |Bit|Register| |-|-| -|0|RAX| -|1|RCX| -|2|RDX| -|3|RBX| -|4|RSP| -|5|RBP| -|6|RSI| -|7|RDI| -|8 to 15|R8 to R15| +|0|`RAX`| +|1|`RCX`| +|2|`RDX`| +|3|`RBX`| +|4|`RSP`| +|5|`RBP`| +|6|`RSI`| +|7|`RDI`| +|8 to 15|`R8` to `R15`| ### Chained unwind info structures -If the UNW_FLAG_CHAININFO flag is set, then an unwind info structure is a secondary one, and the shared exception-handler/chained-info address field contains the primary unwind information. This sample code retrieves the primary unwind information, assuming that `unwindInfo` is the structure that has the UNW_FLAG_CHAININFO flag set. +If the `UNW_FLAG_CHAININFO` flag is set, then an unwind info structure is a secondary one, and the shared exception-handler/chained-info address field contains the primary unwind information. This sample code retrieves the primary unwind information, assuming that `unwindInfo` is the structure that has the `UNW_FLAG_CHAININFO` flag set. ```cpp PRUNTIME_FUNCTION primaryUwindInfo = (PRUNTIME_FUNCTION)&(unwindInfo->UnwindCode[( unwindInfo->CountOfCodes + 1 ) & ~1]); ``` -Chained info is useful in two situations. First, it can be used for noncontiguous code segments. By using chained info, you can reduce the size of the required unwind information, because you do not have to duplicate the unwind codes array from the primary unwind info. +Chained info is useful in two situations. First, it can be used for noncontiguous code segments. By using chained info, you can reduce the size of the required unwind information, because you don't have to duplicate the unwind codes array from the primary unwind info. -You can also use chained info to group volatile register saves. The compiler may delay saving some volatile registers until it is outside of the function entry prolog. You can record them by having primary unwind info for the portion of the function before the grouped code, and then setting up chained info with a non-zero size of prolog, where the unwind codes in the chained info reflect saves of the nonvolatile registers. In that case, the unwind codes are all instances of UWOP_SAVE_NONVOL. A grouping that saves nonvolatile registers by using a PUSH or modifies the RSP register by using an additional fixed stack allocation is not supported. +You can also use chained info to group volatile register saves. The compiler might delay saving some volatile registers until it is outside of the function entry prolog. You can record them by having primary unwind info for the portion of the function before the grouped code, and then setting up chained info with a nonzero size of prolog, where the unwind codes in the chained info reflect saves of the nonvolatile registers. In that case, the unwind codes are all instances of `UWOP_SAVE_NONVOL`. A grouping that saves nonvolatile registers by using a `PUSH` or modifies the `RSP` register by using an additional fixed stack allocation isn't supported. -An UNWIND_INFO item that has UNW_FLAG_CHAININFO set can contain a RUNTIME_FUNCTION entry whose UNWIND_INFO item also has UNW_FLAG_CHAININFO set, sometimes called *multiple shrink-wrapping*. Eventually, the chained unwind info pointers arrive at an UNWIND_INFO item that has UNW_FLAG_CHAININFO cleared. This item is the primary UNWIND_INFO item, which points to the actual procedure entry point. +An `UNWIND_INFO` item that has `UNW_FLAG_CHAININFO` set can contain a `RUNTIME_FUNCTION` entry whose `UNWIND_INFO` item also has `UNW_FLAG_CHAININFO` set, sometimes called *multiple shrink-wrapping*. Eventually, the chained unwind info pointers arrive at an `UNWIND_INFO` item that has `UNW_FLAG_CHAININFO` cleared. This item is the primary `UNWIND_INFO` item, which points to the actual procedure entry point. ## Unwind procedure -The unwind code array is sorted into descending order. When an exception occurs, the complete context is stored by the operating system in a context record. The exception dispatch logic is then invoked, which repeatedly executes these steps to find an exception handler: +The unwind code array is sorted into descending order. When an exception occurs, the operating system stores the complete context in a context record. The exception dispatch logic is then invoked, which repeatedly executes these steps to find an exception handler: -1. Use the current RIP stored in the context record to search for a RUNTIME_FUNCTION table entry that describes the current function (or function portion, for chained UNWIND_INFO entries). +1. Use the current `RIP` stored in the context record to search for a `RUNTIME_FUNCTION` table entry that describes the current function (or function portion, for chained `UNWIND_INFO` entries). -1. If no function table entry is found, then it's in a leaf function, and RSP directly addresses the return pointer. The return pointer at [RSP] is stored in the updated context, the simulated RSP is incremented by 8, and step 1 is repeated. +1. If the search doesn't find a function table entry, the code is assumed to be part of a leaf function, and `RSP` directly addresses the return pointer. The return pointer at [`RSP`] is stored in the updated context, the simulated `RSP` is incremented by 8, and step 1 is repeated. -1. If a function table entry is found, RIP can lie within three regions: a) in an epilog, b) in the prolog, or c) in code that may be covered by an exception handler. +1. If the search finds a function table entry, `RIP` can lie within three regions: a) in an epilog, b) in the prolog, or c) in code that might be covered by an exception handler. - - Case a) If the RIP is within an epilog, then control is leaving the function, there can be no exception handler associated with this exception for this function, and the effects of the epilog must be continued to compute the context of the caller function. To determine if the RIP is within an epilog, the code stream from RIP onward is examined. If that code stream can be matched to the trailing portion of a legitimate epilog, then it's in an epilog, and the remaining portion of the epilog is simulated, with the context record updated as each instruction is processed. After this processing, step 1 is repeated. + - Case a) If the `RIP` is within an epilog, control is leaving the function. There can be no exception handler associated with this exception for this function. The effects of the epilog must continue to compute the context of the caller function. To determine if the `RIP` is within an epilog, the code stream from `RIP` onward is examined. If that code stream matches the trailing portion of a legitimate epilog, it's in an epilog. The remaining portion of the epilog is simulated, with the context record updated as each instruction is processed. After this processing, step 1 is repeated. - - Case b) If the RIP lies within the prologue, then control hasn't entered the function, there can be no exception handler associated with this exception for this function, and the effects of the prolog must be undone to compute the context of the caller function. The RIP is within the prolog if the distance from the function start to the RIP is less than or equal to the prolog size encoded in the unwind info. The effects of the prolog are unwound by scanning forward through the unwind codes array for the first entry with an offset less than or equal to the offset of the RIP from the function start, then undoing the effect of all remaining items in the unwind code array. Step 1 is then repeated. + - Case b) If the `RIP` lies within the prolog, control hasn't entered the function. There can be no exception handler associated with this exception for this function. The effects of the prolog must be undone to compute the context of the caller function. The `RIP` is within the prolog if the distance from the function start to the `RIP` is less than or equal to the prolog size encoded in the unwind info. The unwinder scans forward through the unwind codes array for the first entry with an offset less than or equal to the offset of the `RIP` from the function start, then undoes the effect of all remaining items in the unwind code array. Step 1 is then repeated. - - Case c) If the RIP isn't within a prolog or epilog, and the function has an exception handler (UNW_FLAG_EHANDLER is set), then the language-specific handler is called. The handler scans its data and calls filter functions as appropriate. The language-specific handler can return that the exception was handled or that the search is to be continued. It can also initiate an unwind directly. + - Case c) If the `RIP` isn't within a prolog or epilog, and the function has an exception handler (`UNW_FLAG_EHANDLER` is set), the language-specific handler is called. The handler scans its data and calls filter functions as appropriate. The language-specific handler can return that the exception was handled or that the search is to be continued. It can also initiate an unwind directly. -1. If the language-specific handler returns a handled status, then execution is continued using the original context record. +1. If the language-specific handler returns a handled status, execution continues by using the original context record. -1. If there's no language-specific handler or the handler returns a "continue search" status, then the context record must be unwound to the state of the caller. It's done by processing all of the unwind code array elements, undoing the effect of each. Step 1 is then repeated. +1. If there's no language-specific handler or the handler returns a "continue search" status, the context record must be unwound to the state of the caller. The unwinder undoes the effect of each element in the unwind code array. Step 1 is then repeated. -When chained unwind info is involved, these basic steps are still followed. The only difference is that, while walking the unwind code array to unwind a prolog's effects, once the end of the array is reached, it's then linked to the parent unwind info and the entire unwind code array found there is walked. This linking continues until arriving at an unwind info without the UNW_CHAINED_INFO flag, and then it finishes walking its unwind code array. +When chained unwind info is involved, these basic steps are still followed. The only difference is that, while walking the unwind code array to unwind a prolog's effects, once the process reaches the end of the array, it links to the parent unwind info and walks the entire unwind code array found there. This linking continues until arriving at an unwind info without the `UNW_CHAINED_INFO` flag, and then it finishes walking its unwind code array. -The smallest set of unwind data is 8 bytes. This would represent a function that only allocated 128 bytes of stack or less, and possibly saved one nonvolatile register. It's also the size of a chained unwind info structure for a zero-length prolog with no unwind codes. +The smallest set of unwind data is 8 bytes. Such set represents a function that only allocated 128 bytes of stack or less, and possibly saved one nonvolatile register. It's also the size of a chained unwind info structure for a zero-length prolog with no unwind codes. ## Language-specific handler -The relative address of the language-specific handler is present in the UNWIND_INFO whenever flags UNW_FLAG_EHANDLER or UNW_FLAG_UHANDLER are set. As described in the previous section, the language-specific handler is called as part of the search for an exception handler or as part of an unwind. It has this prototype: +The `UNWIND_INFO` structure provides the relative address of the language-specific handler when either `UNW_FLAG_EHANDLER` or `UNW_FLAG_UHANDLER` flags are set. As described in the previous section, the search for an exception handler or the process of unwinding calls the language-specific handler. The handler uses this prototype: ```cpp typedef EXCEPTION_DISPOSITION (*PEXCEPTION_ROUTINE) ( @@ -298,15 +302,15 @@ typedef struct _DISPATCHER_CONTEXT { } DISPATCHER_CONTEXT, *PDISPATCHER_CONTEXT; ``` -**ControlPc** is the value of RIP within this function. This value is either an exception address or the address at which control left the establishing function. The RIP is used to determine if control is within some guarded construct inside this function, for example, a **`__try`** block for **`__try`**/**`__except`** or **`__try`**/**`__finally`**. +**ControlPc** is the value of `RIP` within this function. This value is either an exception address or the address at which control left the establishing function. The `RIP` is used to determine if control is within some guarded construct inside this function, for example, a **`__try`** block for **`__try`**/**`__except`** or **`__try`**/**`__finally`**. -**ImageBase** is the image base (load address) of the module containing this function, to be added to the 32-bit offsets used in the function entry and unwind info to record relative addresses. +**ImageBase** is the image base (load address) of the module containing this function. The 32-bit offsets used in the function entry and unwind info should be added to the ImageBase obtain the final address. -**FunctionEntry** supplies a pointer to the RUNTIME_FUNCTION function entry holding the function and unwind info image-base relative addresses for this function. +**FunctionEntry** supplies a pointer to the `RUNTIME_FUNCTION` function entry holding the function and unwind info image-base relative addresses for this function. **EstablisherFrame** is the address of the base of the fixed stack allocation for this function. -**TargetIp** Supplies an optional instruction address that specifies the continuation address of the unwind. This address is ignored if **EstablisherFrame** isn't specified. +**TargetIp** supplies an optional instruction address that specifies the continuation address of the unwind. This address is ignored if **EstablisherFrame** isn't specified. **ContextRecord** points to the exception context, for use by the system exception dispatch/unwind code. @@ -316,19 +320,19 @@ typedef struct _DISPATCHER_CONTEXT { ## Unwind helpers for MASM -In order to write proper assembly routines, there's a set of pseudo-operations that can be used in parallel with the actual assembly instructions to create the appropriate .pdata and .xdata. And, there's a set of macros that provide simplified use of the pseudo-operations for their most common uses. +To write proper assembly routines, use a set of pseudo-operations alongside the actual assembly instructions. These pseudo-operations create the appropriate `.pdata` and `.xdata`. Also, use a set of macros that simplify the use of these pseudo-operations for their most common uses. ### Raw pseudo-operations |Pseudo operation|Description| |-|-| -|PROC FRAME \[:*ehandler*]|Causes MASM to generate a function table entry in .pdata and unwind information in .xdata for a function's structured exception handling unwind behavior. If *ehandler* is present, this proc is entered in the .xdata as the language-specific handler.

When the FRAME attribute is used, it must be followed by an .ENDPROLOG directive. If the function is a leaf function (as defined in [Function types](../build/stack-usage.md#function-types)) the FRAME attribute is unnecessary, as are the remainder of these pseudo-operations.| -|.PUSHREG *register*|Generates a UWOP_PUSH_NONVOL unwind code entry for the specified register number using the current offset in the prologue.

Only use it with nonvolatile integer registers. For pushes of volatile registers, use an .ALLOCSTACK 8, instead| -|.SETFRAME *register*, *offset*|Fills in the frame register field and offset in the unwind information using the specified register and offset. The offset must be a multiple of 16 and less than or equal to 240. This directive also generates a UWOP_SET_FPREG unwind code entry for the specified register using the current prologue offset.| -|.ALLOCSTACK *size*|Generates a UWOP_ALLOC_SMALL or a UWOP_ALLOC_LARGE with the specified size for the current offset in the prologue.

The *size* operand must be a multiple of 8.| -|.SAVEREG *register*, *offset*|Generates either a UWOP_SAVE_NONVOL or a UWOP_SAVE_NONVOL_FAR unwind code entry for the specified register and offset using the current prologue offset. MASM chooses the most efficient encoding.

*offset* must be positive, and a multiple of 8. *offset* is relative to the base of the procedure's frame, which is generally in RSP, or, if using a frame pointer, the unscaled frame pointer.| -|.SAVEXMM128 *register*, *offset*|Generates either a UWOP_SAVE_XMM128 or a UWOP_SAVE_XMM128_FAR unwind code entry for the specified XMM register and offset using the current prologue offset. MASM chooses the most efficient encoding.

*offset* must be positive, and a multiple of 16. *offset* is relative to the base of the procedure's frame, which is generally in RSP, or, if using a frame pointer, the unscaled frame pointer.| -|.PUSHFRAME \[*code*]|Generates a UWOP_PUSH_MACHFRAME unwind code entry. If the optional *code* is specified, the unwind code entry is given a modifier of 1. Otherwise the modifier is 0.| +|PROC FRAME \[:*ehandler*]|Causes MASM to generate a function table entry in `.pdata` and unwind information in `.xdata` for a function's structured exception handling unwind behavior. If *ehandler* is present, this proc is entered in the .xdata as the language-specific handler.

When you use the FRAME attribute, follow it with an .ENDPROLOG directive. If the function is a leaf function (as defined in [Function types](../build/stack-usage.md#function-types)), the FRAME attribute is unnecessary, as are the remainder of these pseudo-operations.| +|.PUSHREG *register*|Generates a `UWOP_PUSH_NONVOL` unwind code entry for the specified register number using the current offset in the prologue.

Only use it with nonvolatile integer registers. For pushes of volatile registers, use an .ALLOCSTACK 8, instead.| +|.SETFRAME *register*, *offset*|Fills in the frame register field and offset in the unwind information using the specified register and offset. The offset must be a multiple of 16 and less than or equal to 240. This directive also generates a `UWOP_SET_FPREG` unwind code entry for the specified register using the current prologue offset.| +|.ALLOCSTACK *size*|Generates a `UWOP_ALLOC_SMALL` or a `UWOP_ALLOC_LARGE` with the specified size for the current offset in the prologue.

The *size* operand must be a multiple of 8.| +|.SAVEREG *register*, *offset*|Generates either a `UWOP_SAVE_NONVOL` or a `UWOP_SAVE_NONVOL_FAR` unwind code entry for the specified register and offset using the current prologue offset. MASM chooses the most efficient encoding.

*offset* must be positive, and a multiple of 8. *offset* is relative to the base of the procedure's frame, which is generally in `RSP`, or, if using a frame pointer, the unscaled frame pointer.| +|.SAVEXMM128 *register*, *offset*|Generates either a `UWOP_SAVE_XMM128` or a `UWOP_SAVE_XMM128_FAR` unwind code entry for the specified `XMM` register and offset using the current prologue offset. MASM chooses the most efficient encoding.

*offset* must be positive, and a multiple of 16. *offset* is relative to the base of the procedure's frame, which is generally in `RSP`, or, if using a frame pointer, the unscaled frame pointer.| +|.PUSHFRAME \[*code*]|Generates a `UWOP_PUSH_MACHFRAME` unwind code entry. If you specify the optional *code*, the unwind code entry gets a modifier of 1. Otherwise the modifier is 0.| |.ENDPROLOG|Signals the end of the prologue declarations. Must occur in the first 255 bytes of the function.| Here's a sample function prolog with proper usage of most of the opcodes: @@ -384,19 +388,19 @@ For more information about the epilog example, see [Epilog code](prolog-and-epil ### MASM macros -In order to simplify the use of the [Raw pseudo-operations](#raw-pseudo-operations), there's a set of macros, defined in ksamd64.inc, which can be used to create typical procedure prologues and epilogues. +To simplify the use of [Raw pseudo-operations](#raw-pseudo-operations), use the set of macros defined in `ksamd64.inc`. These macros help you create typical procedure prologues and epilogues. |Macro|Description| |-|-| -|alloc_stack(n)|Allocates a stack frame of n bytes (using `sub rsp, n`), and emits the appropriate unwind information (.allocstack n)| -|save_reg *reg*, *loc*|Saves a nonvolatile register *reg* on the stack at RSP offset *loc*, and emits the appropriate unwind information. (.savereg reg, loc)| -|push_reg *reg*|Pushes a nonvolatile register *reg* on the stack, and emits the appropriate unwind information. (.pushreg reg)| -|rex_push_reg *reg*|Saves a nonvolatile register on the stack using a 2-byte push, and emits the appropriate unwind information (.pushreg reg). Use this macro if the push is the first instruction in the function, to ensure that the function is hot-patchable.| -|save_xmm128 *reg*, *loc*|Saves a nonvolatile XMM register *reg* on the stack at RSP offset *loc*, and emits the appropriate unwind information (.savexmm128 reg, loc)| -|set_frame *reg*, *offset*|Sets the frame register *reg* to be the RSP + *offset* (using a `mov`, or an `lea`), and emits the appropriate unwind information (.set_frame reg, offset)| -|push_eflags|Pushes the eflags with a `pushfq` instruction, and emits the appropriate unwind information (.alloc_stack 8)| - -Here's a sample function prolog with proper usage of the macros: +|alloc_stack(n)|Allocates a stack frame of *n* bytes (using `sub rsp, n`), and emits the appropriate unwind information (.allocstack n)| +|save_reg *reg*, *loc*|Saves a nonvolatile register *reg* on the stack at `RSP` offset *loc*, and emits the appropriate unwind information (.savereg reg, loc)| +|push_reg *reg*|Pushes a nonvolatile register *reg* on the stack, and emits the appropriate unwind information (.pushreg reg)| +|rex_push_reg *reg*|Saves a nonvolatile register on the stack by using a 2-byte push, and emits the appropriate unwind information (.pushreg reg). Use this macro if the push is the first instruction in the function, to ensure that the function is hot-patchable.| +|save_xmm128 *reg*, *loc*|Saves a nonvolatile `XMM` register *reg* on the stack at `RSP` offset *loc*, and emits the appropriate unwind information (.savexmm128 reg, loc)| +|set_frame *reg*, *offset*|Sets the frame register *reg* to be the `RSP` + *offset* (using a `mov` or an `lea`), and emits the appropriate unwind information (.set_frame reg, offset)| +|push_eflags|Pushes the eflags by using a `pushfq` instruction, and emits the appropriate unwind information (.alloc_stack 8)| + +Here's a sample function prologue with proper usage of the macros: ```MASM sampleFrame struct diff --git a/docs/build/exporting-from-a-dll-using-def-files.md b/docs/build/exporting-from-a-dll-using-def-files.md index ce1b224eede..653273a5fe2 100644 --- a/docs/build/exporting-from-a-dll-using-def-files.md +++ b/docs/build/exporting-from-a-dll-using-def-files.md @@ -29,7 +29,7 @@ EXPORTS If you use the [MFC DLL Wizard](../mfc/reference/mfc-dll-wizard.md) to create an MFC DLL, the wizard creates a skeleton DEF file for you and automatically adds it to your project. Add the names of the functions to be exported to this file. For non-MFC DLLs, create the DEF file yourself and add it to your project. Then go to **Project** > **Properties** > **Linker** > **Input** > **Module Definition File** and enter the name of the DEF file. Repeat this step for each configuration and platform, or do it all at once by selecting **Configuration = All Configurations**, and **Platform = All Platforms**. -If you are exporting functions in a C++ file, you have to either place the decorated names in the DEF file or define your exported functions with standard C linkage by using extern "C". If you need to place the decorated names in the DEF file, you can obtain them by using the [DUMPBIN](../build/reference/dumpbin-reference.md) tool or by using the linker [/MAP](../build/reference/map-generate-mapfile.md) option. Note that the decorated names produced by the compiler are compiler specific. If you place the decorated names produced by the Microsoft C++ compiler (MSVC) into a DEF file, applications that link to your DLL must also be built using the same version of MSVC so that the decorated names in the calling application match the exported names in the DLL's DEF file. +If you are exporting functions in a C++ file, you have to either place the decorated names in the DEF file or define your exported functions with standard C linkage by using extern "C". If you need to place the decorated names in the DEF file, you can obtain them by using the [DUMPBIN](../build/reference/dumpbin-reference.md) tool or by using the linker [/MAP](../build/reference/map-generate-mapfile.md) option. Note that the decorated names produced by the compiler are compiler specific. If you place the decorated names produced by the Microsoft C++ (MSVC) compiler into a DEF file, applications that link to your DLL must also be built using the same version of MSVC so that the decorated names in the calling application match the exported names in the DLL's DEF file. > [!NOTE] > A DLL built with Visual Studio 2015 can be consumed by applications built with Visual Studio 2017 or Visual Studio 2019. diff --git a/docs/build/how-to-enable-a-64-bit-visual-cpp-toolset-on-the-command-line.md b/docs/build/how-to-enable-a-64-bit-visual-cpp-toolset-on-the-command-line.md index 4e5fb870095..e551b430faf 100644 --- a/docs/build/how-to-enable-a-64-bit-visual-cpp-toolset-on-the-command-line.md +++ b/docs/build/how-to-enable-a-64-bit-visual-cpp-toolset-on-the-command-line.md @@ -27,7 +27,7 @@ Any of the native or cross compiler tools build configurations can be used on th > [!NOTE] > For information about the specific tools that are included with each Visual Studio edition, see [Visual C++ Tools and Features in Visual Studio Editions](../overview/visual-cpp-tools-and-features-in-visual-studio-editions.md). > -> For information about how to use the Visual Studio IDE to create 64-bit applications, see [How to: Configure Visual C++ Projects to Target 64-Bit, x64 Platforms](how-to-configure-visual-cpp-projects-to-target-64-bit-platforms.md). +> For information about how to use the Visual Studio IDE to create 64-bit applications, see [How to: Configure Microsoft C++ Projects to Target 64-Bit, x64 Platforms](how-to-configure-visual-cpp-projects-to-target-64-bit-platforms.md). When you install a C++ workload in the Visual Studio installer, it always installs 32-bit, x86-hosted, native and cross compiler tools to build x86 and x64 code. If you include the Universal Windows Platform workload, it also installs x86-hosted cross compiler tools to build ARM code. If you install these workloads on a 64-bit, x64 processor, you also get 64-bit native and cross compiler tools to build x86, x64, and ARM code. The 32-bit and 64-bit tools generate identical code, but the 64-bit tools support more memory for precompiled header symbols and the Whole Program Optimization ([/GL](reference/gl-whole-program-optimization.md) and [/LTCG](reference/ltcg-link-time-code-generation.md)) options. If you run into memory limits when you use the 32-bit tools, try the 64-bit tools. diff --git a/docs/build/how-to-modify-the-target-framework-and-platform-toolset.md b/docs/build/how-to-modify-the-target-framework-and-platform-toolset.md index a91d9d91583..3c80c787b4a 100644 --- a/docs/build/how-to-modify-the-target-framework-and-platform-toolset.md +++ b/docs/build/how-to-modify-the-target-framework-and-platform-toolset.md @@ -10,7 +10,7 @@ You can edit a Visual Studio C++ project file to target different versions of th ## Platform toolset -The platform toolset consists of the C++ compiler (cl.exe) and linker (link.exe), along with the C/C++ standard libraries. Visual Studio 2015, Visual Studio 2017, and Visual Studio 2019 are binary-compatible. It's shown by the major version of the toolset, which has remained at 14. Projects compiled in Visual Studio 2019 or Visual Studio 2017 are ABI-backwards-compatible with 2017 and 2015 projects. The minor version has updated by 1 for each version since Visual Studio 2015: +The platform toolset consists of the Microsoft C++ (MSVC) compiler (cl.exe) and linker (link.exe), along with the C/C++ standard libraries. Visual Studio 2015, Visual Studio 2017, and Visual Studio 2019 are binary-compatible. It's shown by the major version of the toolset, which has remained at 14. Projects compiled in Visual Studio 2019 or Visual Studio 2017 are ABI-backwards-compatible with 2017 and 2015 projects. The minor version has updated by 1 for each version since Visual Studio 2015: - Visual Studio 2015: v140 - Visual Studio 2017: v141 @@ -25,7 +25,7 @@ Visual Studio also supports multitargeting for C++ projects. You can use the lat When you change the target Framework, also change the platform toolset to a version that supports that Framework. For example, to target the .NET Framework 4.5, you must use a compatible platform toolset. These toolsets include Visual Studio 2015 (v140), Visual Studio 2013 (v120), or Visual Studio 2012 (v110). You can use the [Windows 7.1 SDK](https://www.microsoft.com/en-us/download/details.aspx?id=8442) to target .NET Framework 2.0, 3.0, 3.5, and 4. -You can extend the target platform further by creating a custom platform toolset. For more information, see [C++ Native Multi-Targeting](https://devblogs.microsoft.com/cppblog/c-native-multi-targeting/) on the Visual C++ blog. +You can extend the target platform further by creating a custom platform toolset. For more information, see [C++ Native Multi-Targeting](https://devblogs.microsoft.com/cppblog/c-native-multi-targeting/) on the Microsoft C++ Team blog. ### To change the target Framework diff --git a/docs/build/image.png b/docs/build/image.png new file mode 100644 index 00000000000..f892839fa3f Binary files /dev/null and b/docs/build/image.png differ diff --git a/docs/build/importing-using-def-files.md b/docs/build/importing-using-def-files.md index 877708fe77e..f8cd00daca4 100644 --- a/docs/build/importing-using-def-files.md +++ b/docs/build/importing-using-def-files.md @@ -50,7 +50,7 @@ if (ulDataInDll == 0L) /*sample code fragment*/ Using CONSTANT is more risky because if you forget to use the extra level of indirection, you could potentially access the import address table's pointer to the variable — not the variable itself. This type of problem can often manifest as an access violation because the import address table is currently made read-only by the compiler and linker. -The current MSVC linker issues a warning if it sees CONSTANT in the .def file to account for this case. The only real reason to use CONSTANT is if you cannot recompile some object file where the header file did not list **`__declspec(dllimport)`** on the prototype. +The current Microsoft C++ (MSVC) linker issues a warning if it sees CONSTANT in the .def file to account for this case. The only real reason to use CONSTANT is if you cannot recompile some object file where the header file did not list **`__declspec(dllimport)`** on the prototype. ## See also diff --git a/docs/build/media/desktop-development-cpp-workload.png b/docs/build/media/desktop-development-cpp-workload.png new file mode 100644 index 00000000000..a321200feb5 Binary files /dev/null and b/docs/build/media/desktop-development-cpp-workload.png differ diff --git a/docs/build/media/github-copilot-fix-warning-accept.png b/docs/build/media/github-copilot-fix-warning-accept.png new file mode 100644 index 00000000000..bb8f3ded876 Binary files /dev/null and b/docs/build/media/github-copilot-fix-warning-accept.png differ diff --git a/docs/build/media/github-copilot-fix-warning.png b/docs/build/media/github-copilot-fix-warning.png new file mode 100644 index 00000000000..4751bafdf01 Binary files /dev/null and b/docs/build/media/github-copilot-fix-warning.png differ diff --git a/docs/build/media/github-copilot-open-chat.png b/docs/build/media/github-copilot-open-chat.png new file mode 100644 index 00000000000..c89019f9abc Binary files /dev/null and b/docs/build/media/github-copilot-open-chat.png differ diff --git a/docs/build/media/life-exe.png b/docs/build/media/life-exe.png new file mode 100644 index 00000000000..94bad16e7d6 Binary files /dev/null and b/docs/build/media/life-exe.png differ diff --git a/docs/build/media/normal-build-process.png b/docs/build/media/normal-build-process.png new file mode 100644 index 00000000000..fbf6c0d1796 Binary files /dev/null and b/docs/build/media/normal-build-process.png differ diff --git a/docs/build/media/options-configuration-file.png b/docs/build/media/options-configuration-file.png new file mode 100644 index 00000000000..2a22a033a17 Binary files /dev/null and b/docs/build/media/options-configuration-file.png differ diff --git a/docs/build/media/sample-profile-guided-optimization-build-process.png b/docs/build/media/sample-profile-guided-optimization-build-process.png new file mode 100644 index 00000000000..9de3effdc4b Binary files /dev/null and b/docs/build/media/sample-profile-guided-optimization-build-process.png differ diff --git a/docs/build/msbuild-visual-cpp.md b/docs/build/msbuild-visual-cpp.md index 0066c81f6d9..858b524a7e4 100644 --- a/docs/build/msbuild-visual-cpp.md +++ b/docs/build/msbuild-visual-cpp.md @@ -44,7 +44,7 @@ Lists the MSBuild XML Schema elements, together with their attributes, and paren Describes the command-line arguments and options that you can use with msbuild.exe. - [Task Reference](/visualstudio/msbuild/msbuild-task-reference) -Describes MSBuild tasks. Especially note these tasks, which are specific to Visual C++: [BscMake Task](/visualstudio/msbuild/bscmake-task), [CL Task](/visualstudio/msbuild/cl-task), [CPPClean Task](/visualstudio/msbuild/cppclean-task), [LIB Task](/visualstudio/msbuild/lib-task), [Link Task](/visualstudio/msbuild/link-task), [MIDL Task](/visualstudio/msbuild/midl-task), [MT Task](/visualstudio/msbuild/mt-task), [RC Task](/visualstudio/msbuild/rc-task), [SetEnv Task](/visualstudio/msbuild/setenv-task), [VCMessage Task](/visualstudio/msbuild/vcmessage-task) +Describes MSBuild tasks. Especially note these tasks, which are specific to Microsoft C++: [BscMake Task](/visualstudio/msbuild/bscmake-task), [CL Task](/visualstudio/msbuild/cl-task), [CPPClean Task](/visualstudio/msbuild/cppclean-task), [LIB Task](/visualstudio/msbuild/lib-task), [Link Task](/visualstudio/msbuild/link-task), [MIDL Task](/visualstudio/msbuild/midl-task), [MT Task](/visualstudio/msbuild/mt-task), [RC Task](/visualstudio/msbuild/rc-task), [SetEnv Task](/visualstudio/msbuild/setenv-task), [VCMessage Task](/visualstudio/msbuild/vcmessage-task) ## In This Section diff --git a/docs/build/overview-of-arm-abi-conventions.md b/docs/build/overview-of-arm-abi-conventions.md index 5ab221541eb..0b80497f7ac 100644 --- a/docs/build/overview-of-arm-abi-conventions.md +++ b/docs/build/overview-of-arm-abi-conventions.md @@ -8,7 +8,7 @@ ms.date: "07/11/2018" The application binary interface (ABI) for code compiled for Windows on ARM processors is based on the standard ARM EABI. This article highlights key differences between Windows on ARM and the standard. This document covers the ARM32 ABI. For information about the ARM64 ABI, see [Overview of ARM64 ABI conventions](arm64-windows-abi-conventions.md). For more information about the standard ARM EABI, see [Application Binary Interface (ABI) for the ARM Architecture](https://github.com/ARM-software/abi-aa) (external link). > [!NOTE] -> Using the Microsoft Visual C++ (MSVC) build tools to target ARM32 is deprecated starting with Visual Studio 2026. If you need to target ARM32, use the Visual Studio 2022 v143 build tools. +> Using the Microsoft C++ (MSVC) Build Tools to target ARM32 is deprecated starting with Visual Studio 2026. If you need to target ARM32, use the Visual Studio 2022 v143 build tools. ## Base Requirements @@ -196,5 +196,5 @@ The counter is a true cycle counter, not a clock; therefore, the counting freque ## See also -[Common Visual C++ ARM Migration Issues](common-visual-cpp-arm-migration-issues.md)
+[Common Microsoft C++ ARM Migration Issues](common-visual-cpp-arm-migration-issues.md)
[ARM Exception Handling](arm-exception-handling.md) diff --git a/docs/build/profile-guided-optimizations.md b/docs/build/profile-guided-optimizations.md index 065565ef0d9..2da31ddff99 100644 --- a/docs/build/profile-guided-optimizations.md +++ b/docs/build/profile-guided-optimizations.md @@ -1,18 +1,20 @@ --- description: "Learn more about: Profile-guided optimizations" title: "Profile-guided optimizations" -ms.date: "04/23/2019" +ms.date: 05/11/2026 helpviewer_keywords: ["profile-guided optimizations", "optimization, profile-guided [C++]"] -ms.assetid: 2225c307-d3ae-42c1-8345-a5a959d132dc --- # Profile-guided optimizations -Profile-guided optimization (PGO) lets you optimize a whole executable file, where the optimizer uses data from test runs of the .exe or .dll file. The data represents the likely performance of the program in a production environment. +Profile-guided optimization (PGO) lets you optimize a whole executable file. The optimizer uses data from test runs of the .exe or .dll file. The data represents the likely performance of the program in a production environment. + +> [!NOTE] +> SPGO (Sample Profile-Guided Optimization) is an alternative approach that uses hardware CPU Windows Performance Counters instead of instrumentation. SPGO requires no instrumented build - you profile an existing release binary by using `xperf`. For more information, see [Introducing Sample Profile Guided Optimization in MSVC](https://devblogs.microsoft.com/cppblog/introducing-sample-profile-guided-optimization-in-msvc/) and [Sample Profile-Guided Optimization (SPGO) tutorial](sample-profile-guided-optimization.md). Profile-guided optimizations are only available for x86, x64, or ARM64 native targets. Profile-guided optimizations aren't available for executable files that run on the common language runtime. Even if you produce an assembly with mixed native and managed code (by using the **/clr** compiler option), you can't use profile-guided optimization on just the native code. If you attempt to build a project with these options set in the IDE, a build error results. > [!NOTE] -> Information that's gathered from profiling test runs overrides optimizations that would otherwise be in effect if you specify **/Ob**, **/Os**, or **/Ot**. For more information, see [/Ob (Inline Function Expansion)](reference/ob-inline-function-expansion.md) and [/Os, /Ot (Favor Small Code, Favor Fast Code)](reference/os-ot-favor-small-code-favor-fast-code.md). +> Information gathered from profiling test runs overrides optimizations that would otherwise be in effect if you specify **/Ob**, **/Os**, or **/Ot**. For more information, see [/Ob (Inline Function Expansion)](reference/ob-inline-function-expansion.md) and [/Os, /Ot (Favor Small Code, Favor Fast Code)](reference/os-ot-favor-small-code-favor-fast-code.md). ## Steps to optimize your app @@ -20,36 +22,36 @@ To use profile-guided optimization, follow these steps to optimize your app: - Compile one or more source code files with [/GL](reference/gl-whole-program-optimization.md). - Each module built with **/GL** can be examined during profile-guided optimization test runs to capture run-time behavior. Every module in a profile-guided optimization build doesn't have to be compiled with **/GL**. However, only those modules compiled with **/GL** are instrumented and later available for profile-guided optimizations. + The compiler examines each module built with **/GL** during profile-guided optimization test runs to capture run-time behavior. You don't need to compile every module in a profile-guided optimization build with **/GL**. However, only modules compiled with **/GL** are instrumented and later available for profile-guided optimizations. -- Link using [/LTCG](reference/ltcg-link-time-code-generation.md) and [/GENPROFILE or /FASTGENPROFILE](reference/genprofile-fastgenprofile-generate-profiling-instrumented-build.md). +- Link by using [/LTCG](reference/ltcg-link-time-code-generation.md) and [/GENPROFILE or /FASTGENPROFILE](reference/genprofile-fastgenprofile-generate-profiling-instrumented-build.md). - Using both **/LTCG** and **/GENPROFILE** or **/FASTGENPROFILE** creates a `.pgd` file when the instrumented app is run. After test-run data is added to the `.pgd` file, it can be used as input to the next link step (creating the optimized image). When specifying **/GENPROFILE**, you can optionally add a **PGD=**_filename_ argument to specify a nondefault name or location for the `.pgd` file. The combination of **/LTCG** and **/GENPROFILE** or **/FASTGENPROFILE** linker options replaces the deprecated **/LTCG:PGINSTRUMENT** linker option. + When you use both **/LTCG** and **/GENPROFILE** or **/FASTGENPROFILE**, the instrumented app creates a `.pgd` file when it runs. After test-run data is added to the `.pgd` file, you can use it as input to the next link step (creating the optimized image). When you specify **/GENPROFILE**, you can optionally add a **PGD=**_filename_ argument to specify a nondefault name or location for the `.pgd` file. The combination of **/LTCG** and **/GENPROFILE** or **/FASTGENPROFILE** linker options replaces the deprecated **/LTCG:PGINSTRUMENT** linker option. - Profile the application. - Each time a profiled EXE session ends, or a profiled DLL is unloaded, a `appname!N.pgc` file is created. A `.pgc` file contains information about a particular application test run. *appname* is the name of your app, and *N* is a number starting with 1 that's incremented based on the number of other `appname!N.pgc` files in the directory. You can delete a `.pgc` file if the test run doesn't represent a scenario you want to optimize. + Each time a profiled EXE session ends, or a profiled DLL unloads, the process creates an `appname!N.pgc` file. A `.pgc` file contains information about a particular application test run. *appname* is the name of your app, and *N* is a number starting with 1. It increments based on the number of other `appname!N.pgc` files in the directory. You can delete a `.pgc` file if the test run doesn't represent a scenario you want to optimize. - During a test run, you can force closure of the currently open `.pgc` file and the creation of a new `.pgc` file with the [pgosweep](pgosweep.md) utility (for example, when the end of a test scenario doesn't coincide with application shutdown). + During a test run, you can force closure of the currently open `.pgc` file and the creation of a new `.pgc` file by using the [pgosweep](pgosweep.md) utility (for example, when the end of a test scenario doesn't coincide with application shutdown). Your application can also directly invoke a PGO function, [PgoAutoSweep](pgoautosweep.md), to capture the profile data at the point of the call as a `.pgc` file. It can give you finer control over the code covered by the captured data in your `.pgc` files. For an example of how to use this function, see the [PgoAutoSweep](pgoautosweep.md) documentation. When you create your instrumented build, by default, data collection is done in non-thread-safe mode, which is faster but may be imprecise. By using the **EXACT** argument to **/GENPROFILE** or **/FASTGENPROFILE**, you can specify data collection in thread-safe mode, which is more precise, but slower. This option is also available if you set the deprecated [PogoSafeMode](environment-variables-for-profile-guided-optimizations.md#pogosafemode) environment variable, or the deprecated **/POGOSAFEMODE** linker option, when you create your instrumented build. -- Link using **/LTCG** and **/USEPROFILE**. +- Link by using **/LTCG** and **/USEPROFILE**. - Use both the **/LTCG** and [/USEPROFILE](reference/useprofile.md) linker options to create the optimized image. This step takes as input the `.pgd` file. When you specify **/USEPROFILE**, you can optionally add a **PGD=**_filename_ argument to specify a non-default name or location for the `.pgd` file. You can also specify this name by using the deprecated **/PGD** linker option. The combination of **/LTCG** and **/USEPROFILE** replaces the deprecated **/LTCG:PGOPTIMIZE** and **/LTCG:PGUPDATE** linker options. + Use both the **/LTCG** and [/USEPROFILE](reference/useprofile.md) linker options to create the optimized image. This step takes the `.pgd` file as input. When you specify **/USEPROFILE**, you can optionally add a **PGD=**_filename_ argument to specify a nondefault name or location for the `.pgd` file. You can also specify this name by using the deprecated **/PGD** linker option. The combination of **/LTCG** and **/USEPROFILE** linker options replaces the deprecated **/LTCG:PGOPTIMIZE** and **/LTCG:PGUPDATE** linker options. -It's even possible to create the optimized executable file and later determine that additional profiling would be useful to create a more optimized image. If the instrumented image and its `.pgd` file are available, you can do additional test runs and rebuild the optimized image with the newer `.pgd` file, by using the same **/LTCG** and **/USEPROFILE** linker options. +It's even possible to create the optimized executable file and later determine that more profiling would be useful to create a more optimized image. If the instrumented image and its `.pgd` file are available, you can do more test runs and rebuild the optimized image with the newer `.pgd` file by using the same **/LTCG** and **/USEPROFILE** linker options. > [!NOTE] -> Both `.pgc` and `.pgd` files are binary file types. If stored in a source control system, avoid any automatic transformation that may be made to text files. +> Both `.pgc` and `.pgd` files are binary file types. If you store them in a source control system, avoid any automatic transformation that might be made to text files. ## Optimizations performed by PGO -The profile-guided optimizations include these checks and improvements: +Profile-guided optimizations include these checks and improvements: -- **Inlining** - For example, if a function A frequently calls function B, and function B is relatively small, then profile-guided optimizations inline function B in function A. +- **Inlining** - For example, if function A frequently calls function B, and function B is relatively small, the profile-guided optimizations inline function B in function A. - **Virtual Call Speculation** - If a virtual call, or other call through a function pointer, frequently targets a certain function, a profile-guided optimization can insert a conditionally executed direct call to the frequently targeted function, and the direct call can be inlined. @@ -61,33 +63,36 @@ The profile-guided optimizations include these checks and improvements: - **Function Layout** - Based on the call graph and profiled caller/callee behavior, functions that tend to be along the same execution path are placed in the same section. -- **Conditional Branch Optimization** - With the value probes, profile-guided optimizations can find if a given value in a switch statement is used more often than other values. This value can then be pulled out of the switch statement. The same can be done with **`if`**...**`else`** instructions where the optimizer can order the **`if`**...**`else`** so that either the **`if`** or **`else`** block is placed first, depending on which block is more frequently true. +- **Conditional Branch Optimization** - With the value probes, profile-guided optimizations can find if a given value in a switch statement is used more often than other values. This value can then be pulled out of the switch statement. The same optimization can be done with **`if`**...**`else`** instructions where the optimizer can order the **`if`**...**`else`** so that either the **`if`** or **`else`** block is placed first, depending on which block is more frequently true. -- **Dead Code Separation** - Code that isn't called during profiling is moved to a special section that's appended to the end of the set of sections. It effectively keeps this section out of the often-used pages. +- **Dead Code Separation** - Profile-guided optimization moves code that isn't called during profiling to a special section at the end of the section set. It effectively keeps this section out of the often-used pages. -- **EH Code Separation** - Because EH code is only exceptionally executed, it can often be moved to a separate section. It's moved when profile-guided optimizations can determine that the exceptions occur only on exceptional conditions. +- **EH Code Separation** - Because EH code is only exceptionally executed, it can often be moved to a separate section. Profile-guided optimizations move it when they determine that the exceptions occur only on exceptional conditions. -- **Memory Intrinsics** - Whether to expand an intrinsic or not depends on whether it's called frequently. An intrinsic can also be optimized based on the block size of moves or copies. +- **Memory Intrinsics** - Whether to expand an intrinsic or not depends on whether it gets called frequently. An intrinsic can also be optimized based on the block size of moves or copies. ## Next steps -Read more about these environment variables, functions, and tools you can use in profile-guided optimizations: +To learn more about these environment variables, functions, and tools you can use in profile-guided optimizations, see the following resources: -[Environment variables for profile-guided optimizations](environment-variables-for-profile-guided-optimizations.md)
-These variables were used to specify run-time behavior of testing scenarios. They're now deprecated and replaced by new linker options. This document shows you how to move from the environment variables to the linker options. +[Environment variables for profile-guided optimizations](environment-variables-for-profile-guided-optimizations.md)\ +These variables specify the run-time behavior of testing scenarios. They're now deprecated and replaced by new linker options. This document shows you how to move from the environment variables to the linker options. -[PgoAutoSweep](pgoautosweep.md)
+[PgoAutoSweep](pgoautosweep.md)\ A function you can add to your app to provide fine-grained `.pgc` file data capture control. -[pgosweep](pgosweep.md)
+[pgosweep](pgosweep.md)\ A command-line utility that writes all profile data to the `.pgc` file, closes the `.pgc` file, and opens a new `.pgc` file. -[pgomgr](pgomgr.md)
+[pgomgr](pgomgr.md)\ A command-line utility that adds profile data from one or more `.pgc` files to the `.pgd` file. -[How to: Merge multiple PGO profiles into a single profile](how-to-merge-multiple-pgo-profiles-into-a-single-profile.md)
+[How to: Merge multiple PGO profiles into a single profile](how-to-merge-multiple-pgo-profiles-into-a-single-profile.md)\ Examples of **pgomgr** usage. +[Sample Profile-Guided Optimization (SPGO) tutorial](sample-profile-guided-optimization.md)\ +Use CPU hardware performance counters instead of instrumentation. No instrumented build required - profile your existing release binary with `xperf`. + ## See also [Additional MSVC build tools](reference/c-cpp-build-tools.md) diff --git a/docs/build/projects-and-build-systems-cpp.md b/docs/build/projects-and-build-systems-cpp.md index 156cd4acfd8..0e429325991 100644 --- a/docs/build/projects-and-build-systems-cpp.md +++ b/docs/build/projects-and-build-systems-cpp.md @@ -1,37 +1,36 @@ --- title: "C/C++ projects and build systems in Visual Studio" description: "Use Visual Studio to compile and build C++ projects for Windows, ARM, or Linux based on any project system." -ms.date: "07/17/2019" -helpviewer_keywords: ["builds [C++]", "C++ projects, building", "projects [C++], building", "builds [C++], options", "C++, build options"] -ms.assetid: fa6ed4ff-334a-4d99-b5e2-a1f83d2b3008 +ms.date: 07/17/2019 ms.topic: "overview" ms.custom: intro-overview +helpviewer_keywords: ["builds [C++]", "C++ projects, building", "projects [C++], building", "builds [C++], options", "C++, build options"] --- # C/C++ projects and build systems in Visual Studio -You can use Visual Studio to edit, compile, and build any C++ code base with full IntelliSense support without having to convert that code into a Visual Studio project or compile with the MSVC toolset. For example, you can edit a cross-platform CMake project in Visual Studio on a Windows machine, then compile it for Linux using g++ on a remote Linux machine. +You can use Visual Studio to edit, compile, and build any C++ code base with full IntelliSense support without having to convert that code into a Visual Studio project or compile with the Microsoft C++ (MSVC) Build Tools. For example, you can edit a cross-platform CMake project in Visual Studio on a Windows machine, then compile it for Linux using g++ on a remote Linux machine. ## C++ compilation -To *build* a C++ program means to compile source code from one or more files and then link those files into an executable file (.exe), a dynamic-load library (.dll) or a static library (.lib). +To *build* a C++ program means to compile source code from one or more files and then link those files into an executable file (`.exe`), a dynamic-link library (`.dll`) or a static library (`.lib`). Basic C++ compilation involves three main steps: - The C++ preprocessor transforms all the #directives and macro definitions in each source file. This creates a *translation unit*. -- The C++ compiler compiles each translation unit into object files (.obj), applying whatever compiler options have been set. +- The C++ compiler compiles each translation unit into object files (`.obj`), applying whatever compiler options have been set. - The *linker* merges the object files into a single executable, applying the linker options that have been set. -## The MSVC toolset +## The Microsoft C++ (MSVC) Build Tools -The Microsoft C++ compiler, linker, standard libraries, and related utilities make up the MSVC compiler toolset (also called a toolchain or "build tools"). These are included in Visual Studio. You can also download and use the command-line toolset as a free standalone package. For more information, see [Build Tools for Visual Studio](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) on the Visual Studio Downloads page. +The Microsoft C++ compiler, linker, standard libraries, and related utilities make up the Microsoft C++ (MSVC) Build Tools (also called a toolchain or toolset). These are included in Visual Studio. You can also download and use the command-line toolset as a free standalone package. For more information, see [Build Tools for Visual Studio](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) on the Visual Studio Downloads page. -You can build simple programs by invoking the MSVC compiler (cl.exe) directly from the command line. The following command accepts a single source code file, and invokes cl.exe to build an executable called *hello.exe*: +You can build simple programs by invoking the MSVC compiler (`cl.exe`) directly from the command line. The following command accepts a single source code file, and invokes `cl.exe` to build an executable called *`hello.exe`*: ```cmd cl /EHsc hello.cpp ``` -Here the compiler (cl.exe) automatically invokes the C++ preprocessor and the linker to produce the final output file. For more information, see [Building on the command line](building-on-the-command-line.md). +Here the compiler (`cl.exe`) automatically invokes the C++ preprocessor and the linker to produce the final output file. For more information, see [Building on the command line](building-on-the-command-line.md). ## Build systems and projects @@ -39,19 +38,19 @@ Most real-world programs use some kind of *build system* to manage complexities The following list shows various options for Visual Studio Projects - C++: -- create a Visual Studio project by using the Visual Studio IDE and configure it by using property pages. Visual Studio projects produce programs that run on Windows. For an overview, see [Compiling and Building](/visualstudio/ide/compiling-and-building-in-visual-studio) in the Visual Studio documentation. +- Create a Visual Studio project by using the Visual Studio IDE and configure it by using property pages. Visual Studio projects produce programs that run on Windows. For an overview, see [Compiling and Building](/visualstudio/ide/compiling-and-building-in-visual-studio) in the Visual Studio documentation. -- open a folder that contains a CMakeLists.txt file. CMake support is integrated into Visual Studio. You can use the IDE to edit, test, and debug without modifying the CMake files in any way. This enables you to work in the same CMake project as others who might be using different editors. CMake is the recommended approach for cross-platform development. For more information, see [CMake projects](cmake-projects-in-visual-studio.md). +- Open a folder that contains a `CMakeLists.txt` file. CMake support is integrated into Visual Studio. You can use the IDE to edit, test, and debug without modifying the CMake files in any way. This enables you to work in the same CMake project as others who might be using different editors. CMake is the recommended approach for cross-platform development. For more information, see [CMake projects](cmake-projects-in-visual-studio.md). -- open a loose folder of source files with no project file. Visual Studio will use heuristics to build the files. This is an easy way to compile and run small console applications. For more information, see [Open Folder projects](open-folder-projects-cpp.md). +- Open a loose folder of source files with no project file. Visual Studio will use heuristics to build the files. This is an easy way to compile and run small console applications. For more information, see [Open Folder projects](open-folder-projects-cpp.md). -- open a folder that contains a makefile, or any other build system configuration file. You can configure Visual Studio to invoke any arbitrary build commands by adding JSON files to the folder. For more information, see [Open Folder projects](open-folder-projects-cpp.md). +- Open a folder that contains a makefile, or any other build system configuration file. You can configure Visual Studio to invoke any arbitrary build commands by adding JSON files to the folder. For more information, see [Open Folder projects](open-folder-projects-cpp.md). - Open a Windows makefile in Visual Studio. For more information, see [NMAKE Reference](reference/nmake-reference.md). ## MSBuild from the command line -You can invoke MSBuild from the command line by passing it a .vcxproj file along with command-line options. This approach requires a good understanding of MSBuild, and is recommended only when necessary. For more information, see [MSBuild](msbuild-visual-cpp.md). +You can invoke MSBuild from the command line by passing it a `.vcxproj` file along with command-line options. This approach requires a good understanding of MSBuild, and is recommended only when necessary. For more information, see [MSBuild](msbuild-visual-cpp.md). ## In This Section @@ -74,7 +73,7 @@ Discusses how to use the C/C++ compiler and build tools directly from the comman How to create, debug, and deploy C/C++ DLLs (shared libraries) in Visual Studio. [Walkthrough: Creating and Using a Static Library](walkthrough-creating-and-using-a-static-library-cpp.md)\ -How to create a **.lib** binary file. +How to create a `.lib` binary file. [Building C/C++ Isolated Applications and Side-by-side Assemblies](building-c-cpp-isolated-applications-and-side-by-side-assemblies.md)\ Describes the deployment model for Windows Desktop applications, based on the idea of isolated applications and side-by-side assemblies. @@ -83,10 +82,10 @@ Describes the deployment model for Windows Desktop applications, based on the id How to target 64-bit x64 hardware with the MSVC build tools. [Configure C++ projects for ARM processors](configuring-programs-for-arm-processors-visual-cpp.md)\ -How to use the MSVC build tools to target ARM hardware. +How to use the MSVC Build Tools to target ARM hardware. [Optimizing Your Code](optimizing-your-code.md)\ -How to optimize your code in various ways including program guided optimizations. +How to optimize your code in various ways including profile-guided optimization (PGO). [Configuring Programs for Windows XP](configuring-programs-for-windows-xp.md)\ How to target Windows XP with the MSVC build tools. diff --git a/docs/build/reference/arch-x64.md b/docs/build/reference/arch-x64.md index 0bcf4ff2022..da9e57733f8 100644 --- a/docs/build/reference/arch-x64.md +++ b/docs/build/reference/arch-x64.md @@ -1,9 +1,9 @@ --- description: "Learn more about: /arch (x64)" title: "/arch (x64)" -ms.date: 06/30/2022 -f1_keywords: ["/arch:SSE2", "/arch:SSE4.2", "/arch:AVX", "/arch:AVX2", "/arch:AVX512", "/arch:AVX10.1"] -helpviewer_keywords: ["/arch:SSE2 compiler option [C++]", "/arch:SSE4.2 compiler option [C++]", "/arch:AVX compiler option [C++]", "/arch:AVX2 compiler option [C++]", "/arch:AVX512 compiler option [C++]", "/arch:AVX10.1 compiler option [C++]"] +ms.date: 10/21/2025 +f1_keywords: ["/arch:SSE2", "/arch:SSE4.2", "/arch:AVX", "/arch:AVX2", "/arch:AVX512", "/arch:AVX10.1", "/arch:AVX10.2"] +helpviewer_keywords: ["/arch:SSE2 compiler option [C++]", "/arch:SSE4.2 compiler option [C++]", "/arch:AVX compiler option [C++]", "/arch:AVX2 compiler option [C++]", "/arch:AVX512 compiler option [C++]", "/arch:AVX10.1 compiler option [C++]", "/arch:AVX10.2 compiler option [C++]"] --- # `/arch` (x64) @@ -11,7 +11,7 @@ Specifies the architecture for code generation on x64. These switches apply to t ## Syntax -> **`/arch:`**\[**`SSE2`**|**`SSE4.2`**|**`AVX`**|**`AVX2`**|**`AVX512`**|**`AVX10.1`**] +> **`/arch:`**\[**`SSE2`**|**`SSE4.2`**|**`AVX`**|**`AVX2`**|**`AVX512`**|**`AVX10.1`**|**`AVX10.2`**] ## Arguments @@ -33,6 +33,9 @@ Enables Intel Advanced Vector Extensions 512. **`/arch:AVX10.1`**\ Enables Intel Advanced Vector Extensions 10 version 1. +**`/arch:AVX10.2`**\ +Enables Intel Advanced Vector Extensions 10 version 2. + ## Remarks The **`/arch`** option enables the use of certain instruction set extensions, particularly for vector calculation, available in processors from Intel and AMD. In general, more recently introduced processors may support extensions beyond the ones supported by older processors, although you should consult the documentation for a particular processor or test for instruction set extension support using [`__cpuid`](../../intrinsics/cpuid-cpuidex.md) before executing code using an instruction set extension. You can also use the [`__check_isa_support`](../../intrinsics/check-isa-arch-support.md) intrinsic to check for more frequently used CPU features. @@ -51,17 +54,20 @@ The processor extensions have the following characteristics: - **`AVX-512`** introduced another instruction encoding form that allows 512-bit vectors, masking, embedded rounding/broadcast, and new instructions. The default vector length for **`AVX-512`** is 512 bits and can be changed to 256 bits using the [`/vlen`](vlen.md) flag. -- **`AVX10.1`** adds more instructions on top of **`AVX-512`**. The default vector length for **`AVX10.1`** is 256 bits and can be changed to 512 bits using the [`/vlen`](vlen.md) flag. +- **`AVX10.1`** adds more instructions on top of **`AVX-512`**. The default vector length for **`AVX10.1`** is 256 bits and can be changed to 512 bits using the [`/vlen`](vlen.md) flag. This option was introduced in Visual Studio 2022 17.13. + +- **`AVX10.2`** expands the instruction set introduced in `AVX10.1`. The default vector length for **`AVX10.2`** is 256 bits and can be increased to 512 bits using the [`/vlen`](vlen.md) flag. +`AVX10.2` adds instructions that are enhancements of legacy instructions and media acceleration instructions. For more information about the new instructions, see section 3.1.4 in the [Intel Advanced Vector Extensions 10.2 Architecture Specification](https://www.intel.com/content/www/us/en/content-details/856721/intel-advanced-vector-extensions-10-2-intel-avx10-2-architecture-specification.html). The AI related instructions in that document are supported via MSVC intrinsics instead of being directly emitted because MSVC doesn't support their data types. This compiler option was introduced in Visual Studio 2026. -Each **`/arch`** option may also enable the use of other non-vector instructions that are associated with that option. An example is the use of certain BMI instructions when **`/arch:AVX2`** is specified. +Each **`/arch`** option may also enable the use of other nonvector instructions that are associated with that option. An example is the use of certain BMI instructions when **`/arch:AVX2`** is specified. -The `__AVX__` preprocessor symbol is defined when the **`/arch:AVX`**, **`/arch:AVX2`**, **`/arch:AVX512`**, or **`/arch:AVX10.1`** compiler option is specified. -The `__AVX2__` preprocessor symbol is defined when the **`/arch:AVX2`**, **`/arch:AVX512`**, or **`/arch:AVX10.1`** compiler option is specified. -The `__AVX512F__`, `__AVX512CD__`, `__AVX512BW__`, `__AVX512DQ__`, and `__AVX512VL__` preprocessor symbols are defined when the **`/arch:AVX512`**, or **`/arch:AVX10.1`** compiler option is specified. -The `__AVX10_VER__` preprocessor symbol is defined when the **`/arch:AVX10.1`** compiler option is specified. It indicates the AVX10 version the compiler is targeting. For more information, see [Predefined macros](../../preprocessor/predefined-macros.md). +The `__AVX__` preprocessor symbol is defined when the **`/arch:AVX`**, **`/arch:AVX2`**, **`/arch:AVX512`**, **`/arch:AVX10.1`**, or **`/arch:AVX10.2`** compiler option is specified. +The `__AVX2__` preprocessor symbol is defined when the **`/arch:AVX2`**, **`/arch:AVX512`**, **`/arch:AVX10.1`**, or **`/arch:AVX10.2`** compiler option is specified. +The `__AVX512F__`, `__AVX512CD__`, `__AVX512BW__`, `__AVX512DQ__`, and `__AVX512VL__` preprocessor symbols are defined when the **`/arch:AVX512`**, **`/arch:AVX10.1`**, or **`/arch:AVX10.2`** compiler option is specified. +The `__AVX10_VER__` preprocessor symbol is defined when the **`/arch:AVX10.1`** or **`/arch:AVX10.2`** compiler option is specified. It indicates the AVX10 version the compiler is targeting. For more information, see [Predefined macros](../../preprocessor/predefined-macros.md). The **`/arch:AVX2`** option was introduced in Visual Studio 2013 Update 2, version 12.0.34567.1. Limited support for **`/arch:AVX512`** was added in Visual Studio 2017, and expanded in Visual Studio 2019. -Support for **`/arch:AVX10.1`** was added in Visual Studio 2022. +Support for **`/arch:AVX10.1`** was added in Visual Studio 2022. Support for **`/arch:AVX10.2`** was added in Visual Studio 2026. ### To set the `/arch` compiler option in Visual Studio @@ -78,5 +84,6 @@ Support for **`/arch:AVX10.1`** was added in Visual Studio 2022. ## See also [`/arch` (Minimum CPU Architecture)](arch-minimum-cpu-architecture.md)\ +[`/feature` (x64)](feature-x64.md)\ [MSVC compiler options](compiler-options.md)\ [MSVC compiler command-line syntax](compiler-command-line-syntax.md) diff --git a/docs/build/reference/arch-x86.md b/docs/build/reference/arch-x86.md index cb71ce0716b..a133eda92db 100644 --- a/docs/build/reference/arch-x86.md +++ b/docs/build/reference/arch-x86.md @@ -1,9 +1,9 @@ --- description: "Learn more about: /arch (x86)" title: "/arch (x86)" -ms.date: 06/30/2022 -f1_keywords: ["/arch:IA32", "/arch:SSE", "/arch:SSE2", "/arch:AVX", "/arch:AVX2", "/arch:AVX512", "/arch:AVX10.1"] -helpviewer_keywords: ["/arch:IA32 compiler option [C++]", "/arch:SSE compiler option [C++]", "/arch:SSE2 compiler option [C++]", "/arch:AVX compiler option [C++]", "/arch:AVX2 compiler option [C++]", "/arch:AVX512 compiler option [C++]", "/arch:AVX10.1 compiler option [C++]"] +ms.date: 10/21/2025 +f1_keywords: ["/arch:IA32", "/arch:SSE", "/arch:SSE2", "/arch:AVX", "/arch:AVX2", "/arch:AVX512", "/arch:AVX10.1", /arch:AVX10.2"] +helpviewer_keywords: ["/arch:IA32 compiler option [C++]", "/arch:SSE compiler option [C++]", "/arch:SSE2 compiler option [C++]", "/arch:AVX compiler option [C++]", "/arch:AVX2 compiler option [C++]", "/arch:AVX512 compiler option [C++]", "/arch:AVX10.1 compiler option [C++]", "/arch:AVX10.2 compiler option [C++]"] --- # `/arch` (x86) @@ -11,7 +11,7 @@ Specifies the architecture for code generation on x86. These switches apply to t ## Syntax -> **`/arch:`**\[**`IA32`**|**`SSE`**|**`SSE2`**|**`AVX`**|**`AVX2`**|**`AVX512`**|**`AVX10.1`**] +> **`/arch:`**\[**`IA32`**|**`SSE`**|**`SSE2`**|**`AVX`**|**`AVX2`**|**`AVX512`**|**`AVX10.1`**|**`AVX10.2`**] ## Arguments @@ -36,6 +36,9 @@ Enables Intel Advanced Vector Extensions 512. **`/arch:AVX10.1`**\ Enables Intel Advanced Vector Extensions 10 version 1. +**`/arch:AVX10.2`**\ +Enables Intel Advanced Vector Extensions 10 version 2. + ## Remarks The **`/arch`** option enables or disables the use of certain instruction set extensions, particularly for vector calculation, available in processors from Intel and AMD. In general, more recently introduced processors may support extensions beyond the ones supported by older processors. You should consult the documentation for a particular processor or test for instruction set extension support using [`__cpuid`](../../intrinsics/cpuid-cpuidex.md) before executing code using an instruction set extension. You can also use the [`__check_isa_support`](../../intrinsics/check-isa-arch-support.md) intrinsic to check for more frequently used CPU features. @@ -56,11 +59,14 @@ The **`/arch`** options refer to instruction set extensions with the following c - **`AVX512`** introduced another instruction encoding form that allows 512-bit vectors, masking, embedded rounding/broadcast, and new instructions. The default vector length for **`AVX512`** is 512 bits and can be changed to 256 bits using the [`/vlen`](vlen.md) flag. -- **`AVX10.1`** adds more instructions on top of **`AVX-512`**. The default vector length for **`AVX10.1`** is 256 bits and can be changed to 512 bits using the [`/vlen`](vlen.md) flag. +- **`AVX10.1`** adds more instructions on top of **`AVX-512`**. The default vector length for **`AVX10.1`** is 256 bits and can be changed to 512 bits using the [`/vlen`](vlen.md) flag. This option was introduced in Visual Studio 2022 17.13. + +- **`AVX10.2`** expands the instruction set introduced in `AVX10.1`. The default vector length for **`AVX10.2`** is 256 bits and can be increased to 512 bits using the [`/vlen`](vlen.md) flag. +`AVX10.2` adds instructions that are enhancements of legacy instructions and media acceleration instructions. For more information about the new instructions, see section 3.1.4 in the [Intel Advanced Vector Extensions 10.2 Architecture Specification](https://www.intel.com/content/www/us/en/content-details/856721/intel-advanced-vector-extensions-10-2-intel-avx10-2-architecture-specification.html) The AI related instructions in that document are supported via MSVC intrinsics instead of being directly emitted because MSVC doesn't support their data types. This compiler option was introduced in Visual Studio 2026. The optimizer chooses when and how to use vector instructions depending on which **`/arch`** is specified. Scalar floating-point computations are usually performed with SSE or AVX instructions when available. Some calling conventions specify passing floating-point arguments on the x87 stack, and as a result, your code may use a mixture of both x87 and SSE/AVX instructions for floating-point computations. Integer vector instructions can also be used for some 64-bit integer operations when available. -In addition to the vector and floating-point scalar instructions, each **`/arch`** option may also enable the use of other non-vector instructions that are associated with that option. An example is the CMOVcc instruction family that first appeared on the Intel Pentium Pro processors. Because SSE instructions were introduced with the subsequent Intel Pentium III processor, CMOVcc instructions may be generated except when **`/arch:IA32`** is specified. +In addition to the vector and floating-point scalar instructions, each **`/arch`** option may also enable the use of other nonvector instructions that are associated with that option. An example is the CMOVcc instruction family that first appeared on the Intel Pentium Pro processors. Because SSE instructions were introduced with the subsequent Intel Pentium III processor, CMOVcc instructions may be generated except when **`/arch:IA32`** is specified. Floating-point operations are normally rounded to double-precision (64-bit) in x87 code, but you can use `_controlfp` to modify the FP control word, including setting the precision control to extended precision (80-bit) or single-precision (32-bit). For more information, see [`_control87`, `_controlfp`, `__control87_2`](../../c-runtime-library/reference/control87-controlfp-control87-2.md). SSE and AVX have separate single-precision and double-precision instructions for each operation, so there's no equivalent for SSE/AVX code. It can change how results are rounded when the result of a floating-point operation is used directly in further calculation instead of assigning it to a user variable. Consider the following operations: diff --git a/docs/build/reference/c-cpp-prop-page.md b/docs/build/reference/c-cpp-prop-page.md index 4f92e38d17f..dce5341a0ff 100644 --- a/docs/build/reference/c-cpp-prop-page.md +++ b/docs/build/reference/c-cpp-prop-page.md @@ -1,7 +1,7 @@ --- title: "C/C++ Project Properties (Visual Studio)" description: "Reference guide to the Visual Studio Microsoft C/C++ project Property Pages properties." -ms.date: 6/9/2023 +ms.date: 3/26/2026 ms.topic: "article" f1_keywords: ["VC.Project.VCCLCompilerTool.AdditionalModuleDirectories", "VC.Project.VCCLCompilerTool.ScanSourceForModuleDependencies"] --- @@ -47,15 +47,19 @@ Specifies the type of debugging information generated by the compiler. This pro #### Choices -- **None** - Produces no debugging information, so compilation may be faster. -- **C7 compatible** - Select the type of debugging information created for your program and whether this information is kept in object (.obj) files or in a program database (PDB). -- **Program Database** - Produces a program database (PDB) that contains type information and symbolic debugging information for use with the debugger. The symbolic debugging information includes the names and types of variables and functions, and line numbers. -- **Program Database for Edit And Continue** - Produces a program database, as described previously, in a format that supports the [Edit and Continue](/visualstudio/debugger/edit-and-continue) feature. +- **None** (`None`) - Produces no debugging information, so compilation may be faster. +- **C7 compatible** (`OldStyle`) - Produces object files that contain full symbolic debugging information. No PDB file is produced. +- **Program Database** (`ProgramDatabase`) - Produces a program database (PDB) that contains type information and symbolic debugging information for use with the debugger. The symbolic debugging information includes the names and types of variables and functions, and line numbers. +- **Program Database for Edit And Continue** (`EditAndContinue`) - Produces a program database, as described previously, in a format that supports the [Edit and Continue](/visualstudio/debugger/edit-and-continue) feature. ### Support Just My Code Debugging Adds supporting code for enabling [Just My Code](/visualstudio/debugger/just-my-code) debugging in this compilation unit. Sets [`/JMC`](jmc.md). +### Support C++ Dynamic Debugging + +(Preview) Sets compiler flag [`/dynamicdeopt`](dynamic-deopt.md) to turn on [C++ Dynamic Debugging](/visualstudio/debugger/cpp-dynamic-debugging). Place deoptimized breakpoints and step in anywhere with on-demand function deoptimization. Use this mode for debugging optimized code. + ### Common Language RunTime Support Use the .NET runtime service. This switch is incompatible with some other switches; see the documentation on the [`/clr`](clr-common-language-runtime-compilation.md) family of switches for details. @@ -118,6 +122,10 @@ Enable multi-processor compilation. Sets the [`/MP`](mp-build-with-multiple-proc Compiles and links the program with AddressSanitizer instrumentation. This property currently supports x86 and x64 target builds. Sets the [`/fsanitize`](fsanitize.md) compiler option. +### Enable Fuzzer Support (Experimental) + +Compiles programs with the Fuzzer. Enable AddressSanitizer for best results. Currently available for x86 and x64 builds. Sets [`/fsanitize=fuzzer`](fsanitize.md). + ## C/C++ Optimization Properties ### Optimization @@ -199,6 +207,10 @@ Preprocess without #line directives. Suppresses comment strip from source code; requires setting at least one of the **Preprocessing** options. Sets [`/C`](c-preserve-comments-during-preprocessing.md). +### Use Standard Conforming Preprocessor + +Use a standard conforming preprocessor ([`/Zc:preprocessor`](zc-preprocessor.md)). Currently implied by [`/std:c11`](std-specify-language-standard-version.md) and later versions. To use legacy preprocessor set this property to 'No'. + ## C/C++ Code Generation Properties ### Enable String Pooling @@ -298,6 +310,10 @@ Enable use of instructions found on processors that support enhanced instruction - **No Enhanced Instructions** - No Enhanced Instructions. Sets **`/arch:IA32`** - **Not Set** - Not Set. +### Enable Vector Length + +Enable choosing vector length for [`/arch:AVX512`](arch-x86.md) and [`/arch:AVX10.x`](arch-x86.md) flags. Allowed values are 256 and 512 bits (X86/X64). + ### Floating Point Model Sets the floating point model. Sets [`/fp:precise`, `/fp:strict`, `/fp:fast`](fp-specify-floating-point-behavior.md). @@ -325,6 +341,18 @@ Spectre mitigations for CVE 2017-5753. Sets [`/Qspectre`](qspectre.md). - **Enabled** - Enable Spectre mitigation feature for CVE 2017-5753 - **Disabled** - Not Set. +### Enable Intel JCC Erratum Mitigation + +Software mitigation for the performance impact caused by the Intel JCC erratum microcode update. Sets [`/QIntel-jcc-erratum`](qintel-jcc-erratum.md). + +### Enable EH Continuation Metadata + +Generates a sorted list of all the valid exception handling continuation targets for a binary, used during runtime for RIP validation. Currently available for x64 builds. Sets [`/guard:ehcont`](guard-enable-eh-continuation-metadata.md). + +### Enable Signed Returns + +Enables signed returns which help detect and prevent attempts to dispatch to illegal blocks from function returns. Currently available for ARM64 builds. Sets `/guard:signret`. + ## C/C++ Language Properties ### Disable Language Extensions @@ -365,7 +393,8 @@ Determines the C++ language standard that the compiler enables. The default valu - **ISO C++14 Standard (/std:c++14)** - **ISO C++17 Standard (/std:c++17)** - **ISO C++20 Standard (/std:c++20)** -- **Preview - Features from the Latest C++ Working Draft (/std:c++latest)** +- **Preview - ISO C++23 Standard (/std:c++23preview)** +- **Preview - Features from the Latest C++ Working Draft (/std:c++latest)** ### C Language Standard @@ -376,6 +405,7 @@ Determines the C language standard that the compiler enables. The default value - **Default (Legacy MSVC)** - **ISO C11 Standard (/std:c11)** - **ISO C17 (2018) Standard (/std:c17)** +- **Preview - Features from the Latest C Working Draft (/std:clatest)** ### Conformance mode @@ -387,7 +417,7 @@ Experimental support for the C++ Modules TS and Standard Library modules. ### Build ISO C++23 Standard Library Modules -Starting in Visual Studio 17.6, when this property is enabled and [C++ Language Standard](#cpplang) is set to `/std:c++latest`, Visual C++ projects automatically find and build ISO C++23 Standard Library modules. This enables you to `import std` or `import std.compat` in your C++ code. +Starting in Visual Studio 17.6, when this property is enabled and [C++ Language Standard](#cpplang) is set to `/std:c++latest`, Microsoft C++ projects automatically find and build ISO C++23 Standard Library modules. This enables you to `import std` or `import std.compat` in your C++ code. ## C/C++ Precompiled Headers Properties @@ -435,6 +465,14 @@ Causes the output file to be created in UTF-8 format. Specifies relative path or name for ASM listing file; can be file or directory name. Sets [`/Fa`](fa-fa-listing-file.md). +### Module Output File Name + +Module or header unit output (BMI) file location; can be file or directory name. Sets [`/ifcOutput[name]`](ifc-output.md). + +### Module Dependencies File Name + +Specifies the path and/or name of the generated module dependencies file. Sets [`/scanDependencies[path]`](scandependencies.md). + ### Object File Name Specifies a name to override the default object file name; can be file or directory name. Sets [`/Fo`](fo-object-file-name.md). @@ -451,6 +489,14 @@ Specifies that the compiler should generate XML documentation comment files (.XD Specifies the name of the generated XML documentation files; can be file or directory name. Sets [`/doc:`\](doc-process-documentation-comments-c-cpp.md). +### Generate Source Dependencies File + +Generates a json file with the list of all files the compiler used for the compilation of the source. Sets [`/sourceDependencies`](sourcedependencies.md). + +### Source Dependencies File Name + +Specifies the path and/or name of the generated source dependencies file. Sets [`/sourceDependencies[path]`](sourcedependencies.md). + ## C/C++ Browse Information Properties ### Enable Browse Information @@ -461,7 +507,7 @@ Specifies level of browse information in *`.bsc`* file. Sets [`/FR`](fr-fr-creat Specifies optional name for browser information file. Sets [`/FR`\](fr-fr-create-dot-sbr-file.md). -## External Includes +## C/C++ External Includes Properties ### Treat Files Included with Angle Brackets as External diff --git a/docs/build/reference/cetcompat.md b/docs/build/reference/cetcompat.md index d5c8870b4c0..984e60d83ad 100644 --- a/docs/build/reference/cetcompat.md +++ b/docs/build/reference/cetcompat.md @@ -23,7 +23,7 @@ Specifies that the executable shouldn't be marked compatible with CET Shadow Sta Control-flow Enforcement Technology (CET) Shadow Stack is a computer processor feature. It provides capabilities to defend against return-oriented programming (ROP) based malware attacks. For more information, see [A Technical Look at Intel's Control-flow Enforcement Technology](https://software.intel.com/content/www/us/en/develop/articles/technical-look-control-flow-enforcement-technology.html). -The **`/CETCOMPAT`** linker option tells the linker to mark the binary as CET Shadow Stack-compatible. **`/CETCOMPAT:NO`** marks the binary as not compatible with CET Shadow Stack. If both options are specified on the command line, the last one specified is used. This switch is currently only applicable to x86 and x64 architectures. +The **`/CETCOMPAT`** linker option tells the linker to mark the binary as CET Shadow Stack-compatible. **`/CETCOMPAT:NO`** marks the binary as not compatible with CET Shadow Stack. If both options are specified on the command line, the last one specified is used. This switch is currently only applicable to the x64 architecture. The **`/CETCOMPAT`** option is available beginning in Visual Studio 2019. diff --git a/docs/build/reference/cgthreads-code-generation-threads.md b/docs/build/reference/cgthreads-code-generation-threads.md index d169b1d3419..20091542bd9 100644 --- a/docs/build/reference/cgthreads-code-generation-threads.md +++ b/docs/build/reference/cgthreads-code-generation-threads.md @@ -4,11 +4,10 @@ title: "/cgthreads (Code generation threads)" ms.date: 07/31/2020 f1_keywords: ["/cgthreads"] helpviewer_keywords: ["/cgthreads compiler option (C++)", "-cgthreads compiler option (C++)", "cgthreads compiler option (C++)", "cgthreads"] -ms.assetid: 64bc768c-6caa-4baf-9dea-7cfa1ffb01c2 --- # `/cgthreads` (Code generation threads) -Sets number of cl.exe threads to use for optimization and code generation. +Sets number of `cl.exe` threads to use for optimization and code generation. ## Syntax @@ -24,20 +23,18 @@ Sets number of cl.exe threads to use for optimization and code generation. ## Arguments **`cgthreadsN`**\ -The maximum number of threads for cl.exe to use, where *N* is a number in the range 1 to 8. +The maximum number of threads for `cl.exe` to use, where *N* is a number in the range 1 to 8. ## Remarks -The **`cgthreads`** option specifies the maximum number of threads cl.exe uses in parallel for the optimization and code generation phases of compilation. Notice that there can be no space between **`cgthreads`** and the *number* argument. By default, cl.exe uses four threads, as if **`/cgthreads4`** were specified. If more processor cores are available, a larger *number* value can improve build times. This option is especially useful when it's combined with [`/GL` (Whole Program Optimization)](gl-whole-program-optimization.md). +The **`cgthreads`** option specifies the maximum number of threads `cl.exe` uses in parallel for the optimization and code generation phases of compilation. Notice that there can be no space between **`cgthreads`** and the *number* argument. By default, `cl.exe` uses four threads, as if **`/cgthreads4`** were specified. If more processor cores are available, a larger *number* value can improve build times. This option is especially useful when it's combined with [`/GL` (Whole Program Optimization)](gl-whole-program-optimization.md). -Multiple levels of parallelism can be specified for a build. The msbuild.exe switch **`/maxcpucount`** specifies the number of MSBuild processes that can be run in parallel. The [`/MP` (Build with Multiple Processes)](mp-build-with-multiple-processes.md) compiler flag specifies the number of cl.exe processes that simultaneously compile the source files. The **`cgthreads`** option specifies the number of threads used by each cl.exe process. The processor can only run as many threads at the same time as there are processor cores. It's not useful to specify larger values for all of these options at the same time, and it can be counterproductive. For more information about how to build projects in parallel, see [Building Multiple Projects in Parallel](/visualstudio/msbuild/building-multiple-projects-in-parallel-with-msbuild). +Multiple levels of parallelism can be specified for a build. The msbuild.exe switch **`/maxcpucount`** specifies the number of MSBuild processes that can be run in parallel. The [`/MP` (Build with Multiple Processes)](mp-build-with-multiple-processes.md) compiler flag specifies the number of `cl.exe` processes that simultaneously compile the source files. The **`cgthreads`** option specifies the number of threads used by each `cl.exe` process. The processor can only run as many threads at the same time as there are processor cores. It's not useful to specify larger values for all of these options at the same time, and it can be counterproductive. For more information about how to build projects in parallel, see [Building Multiple Projects in Parallel](/visualstudio/msbuild/building-multiple-projects-in-parallel-with-msbuild). ### To set this compiler option in the Visual Studio development environment 1. Open the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md). - 1. Select the **Configuration Properties** > **C/C++** > **Command Line** property page. - 1. Modify the **Additional Options** property to include **`cgthreadsN`**, where *`N`* is a value from 1 to 8, and then select **OK**. ### To set this compiler option programmatically @@ -46,5 +43,5 @@ Multiple levels of parallelism can be specified for a build. The msbuild.exe swi ## See also -[MSVC compiler options](compiler-options.md)
+[MSVC compiler options](compiler-options.md)\ [MSVC compiler command-line syntax](compiler-command-line-syntax.md) diff --git a/docs/build/reference/common-macros-for-build-commands-and-properties.md b/docs/build/reference/common-macros-for-build-commands-and-properties.md index dfe8c6a5c01..5f3cd0fc40d 100644 --- a/docs/build/reference/common-macros-for-build-commands-and-properties.md +++ b/docs/build/reference/common-macros-for-build-commands-and-properties.md @@ -2,7 +2,7 @@ description: "Learn more about: Common macros for MSBuild commands and properties" title: "Common macros for MSBuild commands and properties" ms.date: 01/12/2024 -helpviewer_keywords: ["$(FrameworkSDKDir) macro", "ProjectName macro $(ProjectName)", "DevEnvDir macro $(DevEnvDir)", "$(DevEnvDir) macro", "TargetPath macro $(TargetPath)", "VSInstallDir macro $(VSInstallDir)", "$(InputFileName) macro", "$(SolutionFileName) macro", "macros [C++], build macros", "InputFileName macro $(InputFileName)", "$(VCInstallDir) macro", "$(IntDir) macro", "$(ConfigurationName) macro", "SolutionDir macro $(SolutionDir)", "$(TargetPath) macro", "$(Inherit) macro", "$(SolutionPath) macro", "WebDeployRoot macro $(WebDeployRoot)", "WebDeployPath macro $(WebDeployPath)", "StopEvaluating macro $(StopEvaluating)", "$(RootNamespace) macro", "$(WebDeployRoot) macro", "ProjectPath macro $(ProjectPath)", "$(ProjectPath) macro", "$(InputDir) macro", "SolutionName macro $(SolutionName)", "ProjectExt macro $(ProjectExt)", "$(TargetExt) macro", "$(ProjectFileName) macro", "TargetName macro $(TargetName)", "$(References) macro", "References macro $(References)", "TargetExt macro $(TargetExt)", "ProjectDir macro $(ProjectDir)", "$(TargetDir) macro", "SolutionExt macro $(SolutionExt)", "$(SolutionDir) macro", "ProjectFileName macro $(ProjectFileName)", "VCInstallDir macro $(VCInstallDir)", "$(InputExt) macro", "$(TargetFileName) macro", "$(SolutionExt) macro", "PlatformName macro $(PlatformName)", "IntDir macro $(IntDir)", "$(FrameworkVersion) macro", "$(ProjectDir) macro", "build macros [C++]", "InputPath macro $(InputPath)", "$(VSInstallDir) macro", "$(WebDeployPath) macro", "TargetFileName macro $(TargetFileName)", "NoInherit macro $(NoInherit)", "ConfigurationName macro $(ConfigurationName)", "$(ProjectExt) macro", "TargetDir macro $(TargetDir)", "InputName macro $(InputName)", "$(ProjectName) macro", "FrameworkSDKDir macro $(FrameworkSDKDir)", "$(ParentName) macro", "InputExt macro $(InputExt)", "$(SafeRootNamespace) macro", "InputDir macro $(InputDir)", "$(FxCopDir) macro", "$(RemoteMachine) macro", "Inherit macro $(Inherit)", "FrameworkVersion macro $(FrameworkVersion)", "$(StopEvaluating) macro", "$(OutDir) macro", "FrameworkDir macro $(FrameworkDir)", "SolutionFileName macro $(SolutionFileName)", "$(NoInherit) macro", "RemoteMachine macro $(RemoteMachine)", "properties [C++], build property macros", "$(TargetName) macro", "$(SolutionName) macro", "$(InputPath) macro", "ParentName macro $(ParentName)", "OutDir macro $(OutDir)", "SafeRootNamespace macro $(SafeRootNamespace)", "FxCopDir macro $(FxCopDir)", "$(InputName) macro", "RootNamespace macro $(RootNamespace)", "builds [C++], macros", "$(FrameworkDir) macro", "$(PlatformName) macro", "$(PlatformShortName) macro","SolutionPath macro $(SolutionPath)"] +helpviewer_keywords: ["$(FrameworkSDKDir) macro", "ProjectName macro $(ProjectName)", "DevEnvDir macro $(DevEnvDir)", "$(DevEnvDir) macro", "TargetPath macro $(TargetPath)", "VSInstallDir macro $(VSInstallDir)", "$(InputFileName) macro", "$(SolutionFileName) macro", "macros [C++], build macros", "InputFileName macro $(InputFileName)", "$(VCInstallDir) macro", "$(IntDir) macro", "$(ConfigurationName) macro", "SolutionDir macro $(SolutionDir)", "$(TargetPath) macro", "$(Inherit) macro", "$(SolutionPath) macro", "WebDeployRoot macro $(WebDeployRoot)", "WebDeployPath macro $(WebDeployPath)", "StopEvaluating macro $(StopEvaluating)", "$(RootNamespace) macro", "$(WebDeployRoot) macro", "ProjectPath macro $(ProjectPath)", "$(ProjectPath) macro", "$(InputDir) macro", "SolutionName macro $(SolutionName)", "ProjectExt macro $(ProjectExt)", "$(TargetExt) macro", "$(ProjectFileName) macro", "TargetName macro $(TargetName)", "$(References) macro", "References macro $(References)", "TargetExt macro $(TargetExt)", "ProjectDir macro $(ProjectDir)", "$(TargetDir) macro", "SolutionExt macro $(SolutionExt)", "$(SolutionDir) macro", "ProjectFileName macro $(ProjectFileName)", "VCInstallDir macro $(VCInstallDir)", "$(InputExt) macro", "$(TargetFileName) macro", "$(SolutionExt) macro", "PlatformName macro $(PlatformName)", "IntDir macro $(IntDir)", "$(FrameworkVersion) macro", "$(ProjectDir) macro", "build macros [C++]", "InputPath macro $(InputPath)", "$(VSInstallDir) macro", "$(WebDeployPath) macro", "TargetFileName macro $(TargetFileName)", "NoInherit macro $(NoInherit)", "ConfigurationName macro $(ConfigurationName)", "$(ProjectExt) macro", "TargetDir macro $(TargetDir)", "InputName macro $(InputName)", "$(ProjectName) macro", "FrameworkSDKDir macro $(FrameworkSDKDir)", "$(ParentName) macro", "InputExt macro $(InputExt)", "$(SafeRootNamespace) macro", "InputDir macro $(InputDir)", "$(FxCopDir) macro", "$(RemoteMachine) macro", "Inherit macro $(Inherit)", "FrameworkVersion macro $(FrameworkVersion)", "$(StopEvaluating) macro", "$(OutDir) macro", "FrameworkDir macro $(FrameworkDir)", "SolutionFileName macro $(SolutionFileName)", "$(NoInherit) macro", "RemoteMachine macro $(RemoteMachine)", "properties [C++], build property macros", "$(TargetName) macro", "$(SolutionName) macro", "$(InputPath) macro", "ParentName macro $(ParentName)", "OutDir macro $(OutDir)", "SafeRootNamespace macro $(SafeRootNamespace)", "FxCopDir macro $(FxCopDir)", "$(InputName) macro", "RootNamespace macro $(RootNamespace)", "builds [C++], macros", "$(FrameworkDir) macro", "$(PlatformName) macro", "$(PlatformShortName) macro","SolutionPath macro $(SolutionPath)", "ShortProjectName macro $(ShortProjectName)"] --- # Common macros for MSBuild commands and properties @@ -44,6 +44,7 @@ This table describes a commonly used subset of the available macros; there are m | **`$(ProjectExt)`** | The file extension of the project. It includes the '.' before the file extension. | | **`$(ProjectFileName)`** | The file name of the project (defined as base name + file extension). | | **`$(ProjectName)`** | The base name of the project. | +| **`$(ShortProjectName)`** | Shortened project name used when `IntDir` is unset; defaults to `$(ProjectName)` but truncates long names to `ProjectName.Substring(0,8).ProjectGuid.Substring(1,8)` to keep intermediate paths short and unique. | | **`$(ProjectPath)`** | The absolute path name of the project (defined as drive + path + base name + file extension). | | **`$(PublishDir)`** | The output location for the publish target; includes the trailing backslash (\\). Defaults to the **`$(OutDir)app.publish\`** folder. | | **`$(RemoteMachine)`** | Set to the value of the **Remote Machine** property on the Debug property page. For more information, see [Changing Project Settings for a C/C++ Debug Configuration](/visualstudio/debugger/project-settings-for-a-cpp-debug-configuration). | @@ -58,8 +59,8 @@ This table describes a commonly used subset of the available macros; there are m | **`$(TargetFileName)`** | The file name of the primary output file for the build (defined as base name + file extension). | | **`$(TargetName)`** | The base name of the primary output file for the build. | | **`$(TargetPath)`** | The absolute path name of the primary output file for the build (defined as drive + path + base name + file extension). | -| **`$(VCInstallDir)`** | The directory that contains the C++ content of your Visual Studio installation. This property contains the version of the targeted Microsoft C++ (MSVC) toolset, which might be different that the host Visual Studio. For example, when building with `$(PlatformToolset) = v140`, **`$(VCInstallDir)`** contains the path to the Visual Studio 2015 installation. | -| **`$(VSInstallDir)`** | The directory into which you installed Visual Studio. This property contains the version of the targeted Visual Studio toolset, which might be different that the host Visual Studio. For example, when building with `$(PlatformToolset) = v110`, **`$(VSInstallDir)`** contains the path to the Visual Studio 2012 installation. | +| **`$(VCInstallDir)`** | The directory that contains the C++ content of your Visual Studio installation. This property contains the version of the targeted Microsoft C++ (MSVC) toolset, which might be different than the host Visual Studio. For example, when building with `$(PlatformToolset) = v140`, **`$(VCInstallDir)`** contains the path to the Visual Studio 2015 installation. | +| **`$(VSInstallDir)`** | The directory into which you installed Visual Studio. This property contains the version of the targeted Visual Studio toolset, which might be different than the host Visual Studio. For example, when building with `$(PlatformToolset) = v110`, **`$(VSInstallDir)`** contains the path to the Visual Studio 2012 installation. | | **`$(WebDeployPath)`** | The relative path from the web deployment root to where the project outputs belong. | | **`$(WebDeployRoot)`** | The absolute path to the location of **``**. For example, *`c:\inetpub\wwwroot`*. | diff --git a/docs/build/reference/compiler-options-listed-alphabetically.md b/docs/build/reference/compiler-options-listed-alphabetically.md index 193a21544b1..8e518cb266b 100644 --- a/docs/build/reference/compiler-options-listed-alphabetically.md +++ b/docs/build/reference/compiler-options-listed-alphabetically.md @@ -66,7 +66,7 @@ This table contains an alphabetical list of compiler options. For a list of comp | [`/FC`](fc-full-path-of-source-code-file-in-diagnostics.md) | Displays the full path of source code files passed to *cl.exe* in diagnostic text. | | [`/Fd`](fd-program-database-file-name.md) | Renames program database file. | | [`/Fe`](fe-name-exe-file.md) | Renames the executable file. | -| [`/feature`](feature-arm64.md) | Enable architecture features.17.10 | +| [`/feature`](feature-enable-architecture-features.md) | Enable architecture features. | | [`/forceInterlockedFunctions`](force-interlocked-functions.md) | Dynamically selects between Armv8.0 load, store exclusive instructions or Armv8.1 LSE atomic instructions based on target CPU.17.14 | | [`/FI`](fi-name-forced-include-file.md) | Preprocesses the specified include file. | | [`/Fi`](fi-preprocess-output-file-name.md) | Specifies the preprocessed output file name. | @@ -251,7 +251,7 @@ This table contains an alphabetical list of compiler options. For a list of comp | [`/Zc:zeroSizeArrayNew[-]`](zc-zerosizearraynew.md) | Call member `new`/`delete` for zero-size arrays of objects (on by default). | | [`/Ze`](za-ze-disable-language-extensions.md) | Deprecated. Enables C89 language extensions. | | [`/Zf`](zf.md) | Improves PDB generation time in parallel builds. | -| [`/ZH:[MD5|SHA1|SHA_256]`](zh.md) | Specifies MD5, SHA-1, or SHA-256 for checksums in debug info. | +| [`/ZH:[MD5|SHA1|SHA_256|SHA384|SHA512]`](zh.md) | Specifies MD5, SHA-1, SHA-256, SHA-384, or SHA-512 for checksums in debug info. | | [`/ZI`](z7-zi-zi-debug-information-format.md) | Includes debug information in a program database compatible with Edit and Continue. (x86 only) | | [`/Zi`](z7-zi-zi-debug-information-format.md) | Generates complete debugging information. | | [`/Zl`](zl-omit-default-library-name.md) | Removes the default library name from the *`.obj`* file. | @@ -261,7 +261,6 @@ This table contains an alphabetical list of compiler options. For a list of comp | [`/Zs`](zs-syntax-check-only.md) | Checks syntax only. | | [`/ZW`](zw-windows-runtime-compilation.md) | Produces an output file to run on the Windows Runtime. | -17.10 This option is available starting in Visual Studio 2022 version 17.10.\ 17.14 This option is available starting in Visual Studio 2022 version 17.14. ## See also diff --git a/docs/build/reference/compiler-options-listed-by-category.md b/docs/build/reference/compiler-options-listed-by-category.md index 5b2a78c030d..f7a5bde9e64 100644 --- a/docs/build/reference/compiler-options-listed-by-category.md +++ b/docs/build/reference/compiler-options-listed-by-category.md @@ -43,7 +43,7 @@ This article contains a categorical list of compiler options. For an alphabetica | [`/EHc`](eh-exception-handling-model.md) | `extern "C"` defaults to `nothrow`. | | [`/EHr`](eh-exception-handling-model.md) | Always generate `noexcept` runtime termination checks. | | [`/EHs`](eh-exception-handling-model.md) | Enable C++ exception handling (no SEH exceptions). | -| [`/feature`](feature-arm64.md) | Enable architecture features.17.10 | +| [`/feature`](feature-enable-architecture-features.md) | Enable architecture features. | | [`/forceInterlockedFunctions`](force-interlocked-functions.md) | Dynamically selects between Armv8.0 load, store exclusive instructions or Armv8.1 LSE atomic instructions based on target CPU.17.14 | | [`/fp:contract`](fp-specify-floating-point-behavior.md) | Consider floating-point contractions when generating code. | | [`/fp:except[-]`](fp-specify-floating-point-behavior.md) | Consider floating-point exceptions when generating code. | @@ -210,7 +210,7 @@ This article contains a categorical list of compiler options. For an alphabetica | [`/Zc:zeroSizeArrayNew[-]`](zc-zerosizearraynew.md) | Call member `new`/`delete` for 0-size arrays of objects (on by default). | | [`/Ze`](za-ze-disable-language-extensions.md) | Deprecated. Enables C89 language extensions. | | [`/Zf`](zf.md) | Improves PDB generation time in parallel builds. | -| [`/ZH`:[MD5|SHA1|SHA_256]](zh.md) | Specifies MD5, SHA-1, or SHA-256 for checksums in debug info. | +| [`/ZH`:[MD5|SHA1|SHA_256|SHA384|SHA512]](zh.md) | Specifies MD5, SHA-1, SHA-256, SHA-384, or SHA-512 for checksums in debug info. | | [`/ZI`](z7-zi-zi-debug-information-format.md) | Includes debug information in a program database compatible with Edit and Continue. (x86 only) | | [`/Zi`](z7-zi-zi-debug-information-format.md) | Generates complete debugging information. | | [`/Zl`](zl-omit-default-library-name.md) | Removes the default library name from the *`.obj`* file. | @@ -329,7 +329,6 @@ Experimental options may only be supported by certain versions of the compiler. | [`/Ze`](za-ze-disable-language-extensions.md) | Deprecated. Enables language extensions. | | [`/Zg`](zg-generate-function-prototypes.md) | Removed in Visual Studio 2015. Generates function prototypes. | -17.10 This option is available starting in Visual Studio 2022 version 17.10.\ 17.14 This option is available starting in Visual Studio 2022 version 17.14. ## See also diff --git a/docs/build/reference/creating-a-makefile-project.md b/docs/build/reference/creating-a-makefile-project.md index 1f88156dfd8..566ed5e134c 100644 --- a/docs/build/reference/creating-a-makefile-project.md +++ b/docs/build/reference/creating-a-makefile-project.md @@ -30,7 +30,13 @@ The output file that you specify in the project has no effect on the name that t ### To create a makefile project in Visual Studio -1. From the Visual Studio main menu, choose **File** > **New** > **Project** and type "makefile" into the search box. If you see more than one project template, select from the options depending on your target platform. +1. From the Visual Studio main menu, choose **File** > **New** > **Project/Solution**. + + :::image type="content" source="media/file-new-project.png" alt-text="Screenshot of the File > New > Project/Solution menu item."::: + +1. Type *makefile* into the search box. If you see more than one project template, select the option for your target platform. + + :::image type="content" source="media/create-project.png" alt-text="Screenshot of the Create a new project dialog. The Create a new project text field text box contains the text: makefile."::: 1. **Windows only**: In the Makefile project **Debug Configuration Settings** page, provide the command, output, clean, and rebuild information for debug and retail builds. Choose **Next** if you want to specify different settings for a Release configuration. diff --git a/docs/build/reference/decorated-names.md b/docs/build/reference/decorated-names.md index 6370302c0d6..4b5a674a640 100644 --- a/docs/build/reference/decorated-names.md +++ b/docs/build/reference/decorated-names.md @@ -53,10 +53,11 @@ The form of decoration for a C function depends on the calling convention used i | Calling convention | Decoration | |--|--| -| **`__cdecl`** | Leading underscore (**`_`**) | -| **`__stdcall`** | Leading underscore (**`_`**) and a trailing at sign (**`@`**) followed by the number of bytes in the parameter list in decimal | -| **`__fastcall`** | Leading and trailing at signs (**`@`**) followed by a decimal number representing the number of bytes in the parameter list | -| **`__vectorcall`** | Two trailing at signs (**`@@`**) followed by a decimal number of bytes in the parameter list | +| [**`__cdecl`**](../../cpp/cdecl.md) | Leading underscore (**`_`**) | +| [**`__stdcall`**](../../cpp/stdcall.md) | Leading underscore (**`_`**) and a trailing at sign (**`@`**) followed by the number of bytes in the parameter list in decimal | +| [**`__fastcall`**](../../cpp/fastcall.md) | Leading and trailing at signs (**`@`**) followed by a decimal number representing the number of bytes in the parameter list | +| [**`__vectorcall`**](../../cpp/vectorcall.md) | Two trailing at signs (**`@@`**) followed by a decimal number of bytes in the parameter list | +| [**`__preserve_none`**](../../cpp/preserve-none.md) | Two trailing at signs, an underscore and the 'A' character (**`@@_A`**) | For ARM64EC functions with C linkage (whether compiled as C or by using `extern "C"`), a **`#`** is prepended to the decorated name. diff --git a/docs/build/reference/feature-enable-architecture-features.md b/docs/build/reference/feature-enable-architecture-features.md new file mode 100644 index 00000000000..b9ca7324c68 --- /dev/null +++ b/docs/build/reference/feature-enable-architecture-features.md @@ -0,0 +1,23 @@ +--- +description: "Learn more about: /feature (Enable architecture features)" +title: "/feature (Enable architecture features)" +ms.date: 05/11/2026 +f1_keywords: ["/feature"] +helpviewer_keywords: ["-feature compiler option [C++]", "/feature compiler option [C++]", "feature compiler option [C++]"] +--- +# `/feature` (Enable architecture features) + +The **`/feature`** option enables specific architecture features for code generation. Select the target platform you're working with to see **`/feature`** options for that platform. + +- [`/feature` (ARM64)](feature-arm64.md)17.10 + +- [`/feature` (x64)](feature-x64.md)14.51 + +17.10 This option is available starting in Visual Studio 2022 version 17.10.\ +14.51 This option ships with MSVC Build Tools version 14.51. Available as part of Visual Studio starting with version 18.6. + +## See also + +[`/arch` (Minimum CPU architecture)](arch-minimum-cpu-architecture.md)\ +[MSVC compiler options](compiler-options.md)\ +[MSVC compiler command-line syntax](compiler-command-line-syntax.md) diff --git a/docs/build/reference/feature-x64.md b/docs/build/reference/feature-x64.md new file mode 100644 index 00000000000..676648ce4b5 --- /dev/null +++ b/docs/build/reference/feature-x64.md @@ -0,0 +1,57 @@ +--- +description: "Learn more about: /feature (x64)" +title: "/feature (x64)" +ms.date: 05/21/2026 +--- +# `/feature` (x64) + +Enable one or more architecture features for x64 code generation. + +> [!NOTE] +> **`/feature:APX`** support is experimental and subject to change. + +## Syntax + +> **`/feature:`** + +## Arguments + +To enable one or more features the x64 target supports, specify one or more of the following feature arguments: + +| Feature argument | Description | Supported in version | +|--|--|--| +| **`APX`** | Enables preview support for Intel APX (Advanced Performance Extensions). Enables the compiler to target various APX features like Extended General-Purpose Registers (EGPRs), New Data Destination (NDD), No-Flags Update (NF), new conditional ISA and optimized registers save/restore operations. For more information, see [Intel Advanced Performance Extensions (APX)](https://www.intel.com/content/www/us/en/developer/articles/technical/advanced-performance-extensions-apx.html). | MSVC Build Tools 14.51 (Preview Support) | + +## Remarks + +Example usage: to enable APX, specify **`/feature:APX`**. + +When **`/feature:APX`** is specified, the following preprocessor macros are defined: `__APX_F__`, `__CCMP__`, `__CF__`, `__EGPR__`, `__NDD__`, `__NF__`, `__PPX__`, `__PUSH2POP2__`, and `__ZU__`. For more information, see [Microsoft-specific predefined macros](../../preprocessor/predefined-macros.md). + +APX extends the x64 architecture with new registers and instructions, which affects how the compiler generates calls, preserves state across function boundaries, and emits unwind metadata. The following articles describe the x64 conventions and unwind information related to APX: + +- [Caller/callee saved registers](../x64-calling-convention.md#callercallee-saved-registers)\ + Describes which registers a callee must preserve and which the caller is responsible for saving across a call on x64. +- [setjmp/longjmp](../x64-calling-convention.md#setjmplongjmp)\ + Explains how nonlocal jumps capture and restore nonvolatile register state on x64, including the registers that participate in the jump buffer. +- [Register volatility and preservation](../x64-software-conventions.md#register-volatility-and-preservation)\ + Summarizes the x64 software conventions for volatile and nonvolatile general-purpose, `XMM`, `YMM`, and `ZMM` registers, and the rules callees must follow to preserve them. +- [Exception handling unwind information V3](../x64-unwind-information-v3.md)\ + Preview specification of the V3 unwind information format used to describe prologs, epilogs, and frame layout for x64 code, including the extended state introduced by APX. + +### To set the `/feature` compiler option in Visual Studio + +1. Open the **Property Pages** dialog box for the project. For more information, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md). +1. Select the **Configuration Properties** > **C/C++** > **Command Line** property page. +1. In the **Additional options** box, add *`/feature:APX`*. Choose **OK** to save your changes. + +### To set this compiler option programmatically + +- See . + +## See also + +[`/arch` (x64)](arch-x64.md)\ +[`/arch` (Minimum CPU architecture)](arch-minimum-cpu-architecture.md)\ +[MSVC compiler options](compiler-options.md)\ +[MSVC compiler command-line syntax](compiler-command-line-syntax.md) diff --git a/docs/build/reference/fsanitize.md b/docs/build/reference/fsanitize.md index 6e9e8c94395..e1eef40728d 100644 --- a/docs/build/reference/fsanitize.md +++ b/docs/build/reference/fsanitize.md @@ -37,7 +37,7 @@ The **`/fsanitize-address-use-after-return`**, **`/fno-sanitize-address-vcasan-l 1. Select the **Configuration Properties** > **C/C++** > **General** property page. -1. Modify the **Enable Address Sanitizer** property. To enable it, choose **Yes (/fsanitize=address)**. +1. Modify the **Enable AddressSanitizer** property. To enable it, choose **Yes (/fsanitize=address)**. 1. Choose **OK** or **Apply** to save your changes. diff --git a/docs/build/reference/general-property-page-project.md b/docs/build/reference/general-property-page-project.md index 5fd0640279f..b06af7088be 100644 --- a/docs/build/reference/general-property-page-project.md +++ b/docs/build/reference/general-property-page-project.md @@ -77,7 +77,7 @@ You can use project macros to change the directory location. For more informatio ### Platform Toolset -Specifies the toolset used for building the current configuration. This property allows the project to target a different version of the Visual C++ libraries and compiler. By default, Visual Studio C++ projects target the latest toolset installed by Visual Studio. You can choose one of the toolsets installed by several previous versions of Visual Studio instead. Some older toolsets can create executables that run on Windows XP or Vista. For more information on how to change the platform toolset, see [How to: Modify the target framework and platform toolset](../how-to-modify-the-target-framework-and-platform-toolset.md). +Specifies the toolset used for building the current configuration. This property allows the project to target a different version of the Microsoft C++ libraries and compiler. By default, Visual Studio C++ projects target the latest toolset installed by Visual Studio. You can choose one of the toolsets installed by several previous versions of Visual Studio instead. Some older toolsets can create executables that run on Windows XP or Vista. For more information on how to change the platform toolset, see [How to: Modify the target framework and platform toolset](../how-to-modify-the-target-framework-and-platform-toolset.md). ### Enable Managed Incremental Build diff --git a/docs/build/reference/gm-enable-minimal-rebuild.md b/docs/build/reference/gm-enable-minimal-rebuild.md index f0ec29080de..392220656af 100644 --- a/docs/build/reference/gm-enable-minimal-rebuild.md +++ b/docs/build/reference/gm-enable-minimal-rebuild.md @@ -1,14 +1,13 @@ --- description: "Learn more about: /Gm (Enable Minimal Rebuild)" title: "/Gm (Enable Minimal Rebuild)" -ms.date: "11/12/2018" +ms.date: 04/14/2026 f1_keywords: ["VC.Project.VCCLCompilerTool.MinimalRebuild", "/Gm", "VC.Project.VCCLWCECompilerTool.MinimalRebuild"] helpviewer_keywords: ["/Gm compiler option [C++]", "minimal rebuild", "enable minimal rebuild compiler option [C++]", "Gm compiler option [C++]", "-Gm compiler option [C++]"] -ms.assetid: d8869ce0-d2ea-40eb-8dae-6d2cdb61dd59 --- # /Gm (Enable Minimal Rebuild) -Deprecated. Enables minimal rebuild, which determines whether C++ source files that include changed C++ class definitions (stored in header (.h) files) need to be recompiled. +Deprecated in Visual Studio 2019 version 16.0. Enables minimal rebuild, which determines whether C++ source files that include changed C++ class definitions (stored in header (.h) files) need to be recompiled. ## Syntax @@ -18,7 +17,7 @@ Deprecated. Enables minimal rebuild, which determines whether C++ source files t ## Remarks -**/Gm** is deprecated. It may not trigger a build for certain kinds of header file changes. You may safely remove this option from your projects. To improve build times, we recommend you use precompiled headers and incremental and parallel build options instead. For a list of deprecated compiler options, see the **Deprecated and Removed Compiler Options** section in [Compiler Options Listed by Category](compiler-options-listed-by-category.md). +**/Gm** is deprecated as of Visual Studio 2019 version 16.0. Using it produces compiler warning D9035. It may not trigger a build for certain kinds of header file changes. You may safely remove this option from your projects. To improve build times, we recommend you use precompiled headers and incremental and parallel build options instead. For a list of deprecated compiler options, see the **Deprecated and Removed Compiler Options** section in [Compiler Options Listed by Category](compiler-options-listed-by-category.md). The compiler stores dependency information between source files and class definitions in the project's .idb file during the first compile. (Dependency information tells which source file is dependent on which class definition, and which .h file the definition is located in.) Subsequent compiles use the information stored in the .idb file to determine whether a source file needs to be compiled, even if it includes a modified .h file. @@ -30,9 +29,7 @@ Because the incremental linker does not support the Windows metadata included in ### To set this compiler option in the Visual Studio development environment 1. Open the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md). - 1. Select the **Configuration Properties** > **C/C++** > **Code Generation** property page. - 1. Modify the **Enable Minimal Rebuild** property. ### To set this compiler option programmatically @@ -41,5 +38,5 @@ Because the incremental linker does not support the Windows metadata included in ## See also -[MSVC Compiler Options](compiler-options.md)
+[MSVC Compiler Options](compiler-options.md)\ [MSVC Compiler Command-Line Syntax](compiler-command-line-syntax.md) diff --git a/docs/build/reference/integritycheck-require-signature-check.md b/docs/build/reference/integritycheck-require-signature-check.md index 2e154fe9607..0820e55c26c 100644 --- a/docs/build/reference/integritycheck-require-signature-check.md +++ b/docs/build/reference/integritycheck-require-signature-check.md @@ -17,7 +17,7 @@ The **`/INTEGRITYCHECK`** linker option sets a flag, `IMAGE_DLLCHARACTERISTICS_F ### Signing `/INTEGRITYCHECK` files -Microsoft has new signing guidance for DLL and executable files linked by using **`/INTEGRITYCHECK`**. The guidance used to recommend a cross-signed certificate from the [cross-signing program](/windows-hardware/drivers/install/cross-certificates-for-kernel-mode-code-signing). However, the [cross-signing program is now deprecated](/windows-hardware/drivers/install/deprecation-of-software-publisher-certificates-and-commercial-release-certificates). You must now sign your **`/INTEGRITYCHECK`** files by using the Microsoft [Trusted Signing service](/azure/trusted-signing/) program instead. +Microsoft has new signing guidance for DLL and executable files linked by using **`/INTEGRITYCHECK`**. The guidance used to recommend a cross-signed certificate from the [cross-signing program](/windows-hardware/drivers/install/cross-certificates-for-kernel-mode-code-signing). However, the [cross-signing program is now deprecated](/windows-hardware/drivers/install/deprecation-of-software-publisher-certificates-and-commercial-release-certificates). You must now sign your **`/INTEGRITYCHECK`** files by using the [Azure Artifact Signing service](https://azure.microsoft.com/products/artifact-signing) program instead. ### To set this linker option in Visual Studio diff --git a/docs/build/reference/linker-options.md b/docs/build/reference/linker-options.md index 5749d0c2364..a647917101a 100644 --- a/docs/build/reference/linker-options.md +++ b/docs/build/reference/linker-options.md @@ -7,7 +7,7 @@ helpviewer_keywords: ["linker [C++]", "linker [C++], options listed", "libraries --- # Linker options -LINK.exe links Common Object File Format (COFF) object files and libraries to create an executable (EXE) file or a dynamic-link library (DLL). +`LINK.exe` links Common Object File Format (COFF) object files and libraries to create an executable (EXE) file or a dynamic-link library (DLL). The following table lists options for `LINK.exe`. For more information about LINK, see: @@ -16,9 +16,9 @@ The following table lists options for `LINK.exe`. For more information about LIN - [LINK output](link-output.md) - [Reserved words](reserved-words.md) -Linker options aren't case-sensitive; for example, `/base` and `/BASE` mean the same thing. For details on how to specify each option on the command line or in Visual Studio, see the documentation for that option. +Linker options aren't case-sensitive. For example, `/base` and `/BASE` mean the same thing. For details on how to specify each option on the command line or in Visual Studio, see the documentation for that option. -You can use the [`comment`](../../preprocessor/comment-c-cpp.md) pragma to specify some linker options. +Use the [`comment`](../../preprocessor/comment-c-cpp.md) pragma to specify some linker options. ## Linker options listed alphabetically @@ -112,6 +112,10 @@ You can use the [`comment`](../../preprocessor/comment-c-cpp.md) pragma to speci | [`/SAFESEH`](safeseh-image-has-safe-exception-handlers.md) | Specifies that the image will contain a table of safe exception handlers. | | [`/SECTION`](section-specify-section-attributes.md) | Overrides the attributes of a section. | | [`/SOURCELINK`](sourcelink.md) | Specifies a SourceLink file to add to the PDB. | +| [`/SPD`](spd-specify-sample-profile-database.md) | Specifies the name and location of the *`.spd`* file for Sample Profile-Guided Optimization. | +| [`/SPDEMBED`](spdembed-embed-sample-profile-database.md) | Embeds the Sample Profile Database into the PDB file during a Sample Profile-Guided Optimization (SPGO) build. | +| [`/SPDIN`](spdin-use-sample-profile-database.md) | Specifies a *`.spd`* file containing profiling data for an optimized Sample Profile-Guided Optimization (SPGO) build. | +| [`/SPGO`](spgo-enable-sample-profile-guided-optimization.md) | Enables Sample Profile-Guided Optimization and creates an empty *`.spd`* file. | | [`/STACK`](stack-stack-allocations.md) | Sets the size of the stack in bytes. | | [`/STUB`](stub-ms-dos-stub-file-name.md) | Attaches an MS-DOS stub program to a Win32 program. | | [`/SUBSYSTEM`](subsystem-specify-subsystem.md) | Tells the operating system how to run the *`.exe`* file. | diff --git a/docs/build/reference/linker-property-pages.md b/docs/build/reference/linker-property-pages.md index 27a8a52d11c..316eb3ed75d 100644 --- a/docs/build/reference/linker-property-pages.md +++ b/docs/build/reference/linker-property-pages.md @@ -37,6 +37,10 @@ The [`/VERSION`](version-version-information.md) option tells the linker to put Enables incremental linking. ([`/INCREMENTAL, /INCREMENTAL:NO`](incremental-link-incrementally.md)) +### Incremental Link Database File + +Specifies incremental link database file location. ([`/ILK:[name]`](ilk-name-incremental-database-file.md)) + ### Suppress Startup Banner The [`/NOLOGO`](nologo-suppress-startup-banner-linker.md) option prevents display of the copyright message and version number. @@ -223,6 +227,10 @@ The [`/MAPINFO`](mapinfo-include-information-in-mapfile.md) option tells the lin [`/ASSEMBLYDEBUG`](assemblydebug-add-debuggableattribute.md) emits the `DebuggableAttribute` attribute with debug information tracking and disables JIT optimizations. +### Support C++ Dynamic Debugging + +(Preview) Set linker flag [`/DYNAMICDEOPT`](dynamic-deopt-linker.md) to turn on [C++ Dynamic Debugging](/visualstudio/debugger/cpp-dynamic-debugging). Place deoptimized breakpoints and step in anywhere with on-demand function deoptimization. Use this mode for debugging optimized code. + ## System Property Page ### SubSystem @@ -319,6 +327,10 @@ Specifies link-time code generation. ([`/LTCG`](ltcg-link-time-code-generation.m - **Profile Guided Optimization - Optimization** - Specifies that the linker should use the profile data created after running the instrumented binary to create an optimized image. - **Profile Guided Optimization - Update** - Allows and tracks list of input files to be added or modified from what was specified in the `:PGINSTRUMENT` phase. +### Link Time Code Generation Object File + +Specifies *`.iobj`* file location. ([`/LTCGOUT:[name]`](ltcgout.md)) + ## Embedded IDL Property Page ### MIDL Commands @@ -504,6 +516,10 @@ The [`/ALIGN`](align-section-alignment.md) option specifies the alignment of eac - **Disabled** - Disable **`/CLRSupportLastError`**. - **System DLLs Only** - Enable **`/CLRSupportLastError`** for system DLLs only. +### CET Shadow Stack Compatible + +Specifies whether to mark an executable image as compatible with Control-flow Enforcement Technology (CET) Shadow Stack. ([`/CETCOMPAT`](cetcompat.md)) + ### Image Has Safe Exception Handlers When [`/SAFESEH`](safeseh-image-has-safe-exception-handlers.md) is specified, the linker will only produce an image if it can also produce a table of the image's safe exception handlers. This table specifies for the operating system which exception handlers are valid for the image. diff --git a/docs/build/reference/linking.md b/docs/build/reference/linking.md index 8891ebf554d..1934bea919d 100644 --- a/docs/build/reference/linking.md +++ b/docs/build/reference/linking.md @@ -68,8 +68,8 @@ link /dll @objlist.txt @liblist.txt @exports.txt The linker recognizes the following environment variables: - `LINK` and `_LINK_`, if defined. The linker prepends the options and arguments defined in the `LINK` environment variable and appends the options and arguments defined in the `_LINK_` environment variable to the command line arguments before processing. -- `LIB`, if defined. The linker uses the `LIB` path when it searches for an object, library, or other file specified on the command line or by the [`/BASE`](base-base-address.md) option. It also uses the `LIB` path to find a `.pdb` file named in an object. The `LIB` variable can contain one or more path specifications, separated by semicolons. One path must point to the `\lib` subdirectory of your Visual C++ installation. -- `PATH`, if the tool needs to run `CVTRES` and can't find the file in the same directory as `link.exe` itself. (`link.exe` requires `CVTRES` to link a `.res` file.) `PATH` must point to the `\bin` subdirectory of your Visual C++ installation. +- `LIB`, if defined. The linker uses the `LIB` path when it searches for an object, library, or other file specified on the command line or by the [`/BASE`](base-base-address.md) option. It also uses the `LIB` path to find a `.pdb` file named in an object. The `LIB` variable can contain one or more path specifications, separated by semicolons. One path must point to the `\lib` subdirectory of your Microsoft C++ installation. +- `PATH`, if the tool needs to run `CVTRES` and can't find the file in the same directory as `link.exe` itself. (`link.exe` requires `CVTRES` to link a `.res` file.) `PATH` must point to the `\bin` subdirectory of your Microsoft C++ installation. - `TMP`, to specify a directory when linking OMF or `.res` files. ## See also diff --git a/docs/build/reference/manifest-tool-property-pages.md b/docs/build/reference/manifest-tool-property-pages.md index cdf705d3d85..fc70cc16669 100644 --- a/docs/build/reference/manifest-tool-property-pages.md +++ b/docs/build/reference/manifest-tool-property-pages.md @@ -22,6 +22,7 @@ f1_keywords: - VC.Project.VCManifestTool.ReplacementsFile - VC.Project.VCManifestTool.UpdateFileHashes - VC.Project.VCManifestTool.UpdateFileHashesSearchPath + - VC.Project.VCManifestTool.EnableSegmentHeap --- # Manifest Tool Property Pages @@ -97,6 +98,10 @@ Specifies whether the application is DPI-aware. By default, the setting is **Yes - **High DPI Aware** - **Per Monitor High DPI Aware** +### Segment Heap + +Specifies whether the application utilizes the Segment Heap. When enabled, applications benefit from improved memory efficiency, reduced fragmentation, and enhanced memory security. For new C++ projects, the setting is **Yes** by default. + ## Isolated COM Property Page For more information about isolated COM, see [Isolated applications](/windows/win32/SbsCs/isolated-applications) and [How to: Build isolated applications to consume COM components](../how-to-build-isolated-applications-to-consume-com-components.md). diff --git a/docs/build/reference/media/create-project.png b/docs/build/reference/media/create-project.png new file mode 100644 index 00000000000..e3398e80f7d Binary files /dev/null and b/docs/build/reference/media/create-project.png differ diff --git a/docs/build/reference/media/file-new-project.png b/docs/build/reference/media/file-new-project.png new file mode 100644 index 00000000000..d42284e46a5 Binary files /dev/null and b/docs/build/reference/media/file-new-project.png differ diff --git a/docs/build/reference/microsoft-extensions-to-c-and-cpp.md b/docs/build/reference/microsoft-extensions-to-c-and-cpp.md index 77eceff58eb..57eab588697 100644 --- a/docs/build/reference/microsoft-extensions-to-c-and-cpp.md +++ b/docs/build/reference/microsoft-extensions-to-c-and-cpp.md @@ -6,7 +6,7 @@ helpviewer_keywords: ["or_eq operator", "~ operator, extensions to C/C++", "& op --- # Microsoft extensions to C and C++ -Microsoft Visual C++ (MSVC) extends the C and C++ language standards in several ways, detailed in this article. +Microsoft C++ (MSVC) extends the C and C++ language standards in several ways, detailed in this article. The MSVC C++ compiler defaults to support for ISO C++14 with some ISO C++17 features and some Microsoft-specific language extensions. For more information on supported features, see [Microsoft C/C++ language conformance by Visual Studio version](../../overview/visual-cpp-language-conformance.md). You can use the **`/std`** compiler option to enable full support for ISO C++17 and ISO C++20 language features. For more information, see [`/std` (Specify language standard version)](std-specify-language-standard-version.md). diff --git a/docs/build/reference/msbuild-visual-cpp-overview.md b/docs/build/reference/msbuild-visual-cpp-overview.md index e614f2f98a6..7ea809fa747 100644 --- a/docs/build/reference/msbuild-visual-cpp-overview.md +++ b/docs/build/reference/msbuild-visual-cpp-overview.md @@ -84,7 +84,7 @@ To use MSBuild effectively, it helps to know which properties and targets are us ### `PlatformToolset` property -The `PlatformToolset` property determines which MSVC toolset is used in the build. By default, the current toolset is used. When this property is set, its value gets concatenated with literal strings to form the path. It's the directory that contains the property and target files required to build a project for a particular platform. The platform toolset must be installed to build by using that platform toolset version. +The `PlatformToolset` property determines which Microsoft C++ (MSVC) toolset is used in the build. By default, the current toolset is used. When this property is set, its value gets concatenated with literal strings to form the path. It's the directory that contains the property and target files required to build a project for a particular platform. The platform toolset must be installed to build by using that platform toolset version. For example, set the `PlatformToolset` property to `v140` to use Visual Studio 2015 tools and libraries to build your application: diff --git a/docs/build/reference/rtc-run-time-error-checks.md b/docs/build/reference/rtc-run-time-error-checks.md index 265e61d945e..0bff5139a6e 100644 --- a/docs/build/reference/rtc-run-time-error-checks.md +++ b/docs/build/reference/rtc-run-time-error-checks.md @@ -42,7 +42,7 @@ int main() { } ``` -Because **`/RTCc`** rejects code that conforms to the standard, it's not supported by the C++ Standard Library. Code that uses **`/RTCc`** and the C++ Standard Library may cause compiler error [C1189](../../error-messages/compiler-errors-1/fatal-error-c1189.md). You can define `_ALLOW_RTCc_IN_STL` to silence the warning and use the **`/RTCc`** option. +Because **`/RTCc`** rejects code that conforms to the standard, it's not supported by the C++ Standard Library. Code that uses **`/RTCc`** and the C++ Standard Library may cause compiler error [C1189](../../error-messages/compiler-errors-1/fatal-error-c1189.md) or [C2338](../../error-messages/compiler-errors-1/compiler-error-c2338.md). Remove the **`/RTCc`** option to use the C++ Standard Library. **`/RTCs`**
Enables stack frame run-time error checking, as follows: diff --git a/docs/build/reference/spd-specify-sample-profile-database.md b/docs/build/reference/spd-specify-sample-profile-database.md new file mode 100644 index 00000000000..f6afb2d2407 --- /dev/null +++ b/docs/build/reference/spd-specify-sample-profile-database.md @@ -0,0 +1,46 @@ +--- +title: "/SPD (Specify Sample Profile Database)" +description: "Learn more about: /SPD (Specify Sample Profile Database)" +ms.date: 05/05/2026 +ai-usage: ai-assisted +helpviewer_keywords: ["/SPD linker option", "-SPD linker option", "sample profile-guided optimization, /SPD"] +--- +# /SPD (Specify Sample Profile Database) + +Specifies the name and location of the Sample Profile Database (SPD) file used by the Sample Profile-Guided Optimization (SPGO) workflow. + +## Syntax + +> **/SPD:**_filename_ + +## Argument + +`filename`\ +Specifies the name of the `.spd` file. When expanded, the fully qualified path must not exceed `MAX_PATH` (260 characters). + +## Remarks + +When you build with [`/SPGO`](spgo-enable-sample-profile-guided-optimization.md), the linker creates an empty SPD file alongside the output binary. By default, the SPD file uses the same base name as the output file and is created in the directory where you invoked the link. Use `/SPD` to specify a different name or path. + +When linking with [`/SPDIN`](spdin-use-sample-profile-database.md), use `/SPDIN` to specify the input SPD file and `/SPD` to specify the output SPD file. + +For more information about the SPGO workflow, see [Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](../sample-profile-guided-optimization.md). + +### To set this linker option in the Visual Studio development environment + +1. Open the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md). +1. Select the **Configuration Properties** > **Linker** > **Command Line** property page. +1. Add `/SPD:filename` to the **Additional Options** box. Choose **OK** to save your changes. + +### To set this linker option programmatically + +- See . + +## See also + +[MSVC linker reference](linking.md)\ +[MSVC Linker Options](linker-options.md)\ +[/SPDEMBED (Embed Sample Profile Database)](spdembed-embed-sample-profile-database.md)\ +[/SPDIN (Use Sample Profile Database)](spdin-use-sample-profile-database.md)\ +[/SPGO (Enable Sample Profile-Guided Optimization)](spgo-enable-sample-profile-guided-optimization.md)\ +[Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](../sample-profile-guided-optimization.md) \ No newline at end of file diff --git a/docs/build/reference/spdembed-embed-sample-profile-database.md b/docs/build/reference/spdembed-embed-sample-profile-database.md new file mode 100644 index 00000000000..db91e8359f1 --- /dev/null +++ b/docs/build/reference/spdembed-embed-sample-profile-database.md @@ -0,0 +1,41 @@ +--- +title: "/SPDEMBED (Embed Sample Profile Database)" +description: "Learn more about: /SPDEMBED (Embed Sample Profile Database)" +ms.date: 05/05/2026 +ai-usage: ai-assisted +helpviewer_keywords: ["/SPDEMBED linker option", "-SPDEMBED linker option", "sample profile-guided optimization, /SPDEMBED"] +--- +# /SPDEMBED (Embed Sample Profile Database) + +Embeds the Sample Profile Database (SPD) data into the Program Database (PDB) file during a Sample Profile-Guided Optimization (SPGO) build. + +## Syntax + +> **/SPDEMBED** + +## Remarks + +When you build with [`/SPDIN`](spdin-use-sample-profile-database.md), the linker uses the profile data in the SPD file to make optimization decisions. Use `/SPDEMBED` together with `/SPGO` to embed the SPD data into the PDB file produced by the build. Embedding the SPD in the PDB keeps the profile data together with the debug symbols, which simplifies distribution and archiving of build artifacts. + +To extract an SPD file that you embedded in a PDB, use [`SPDConvert /extract`](../spdconvert.md). + +For more information about the SPGO workflow, see [Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](../sample-profile-guided-optimization.md). + +### To set this linker option in the Visual Studio development environment + +1. Open the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md). +1. Select the **Configuration Properties** > **Linker** > **Command Line** property page. +1. Add `/SPDEMBED` to the **Additional Options** box. Choose **OK** to save your changes. + +### To set this linker option programmatically + +- See . + +## See also + +[MSVC linker reference](linking.md)\ +[MSVC Linker Options](linker-options.md)\ +[/SPD (Specify Sample Profile Database)](spd-specify-sample-profile-database.md)\ +[/SPDIN (Use Sample Profile Database)](spdin-use-sample-profile-database.md)\ +[/SPGO (Enable Sample Profile-Guided Optimization)](spgo-enable-sample-profile-guided-optimization.md)\ +[Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](../sample-profile-guided-optimization.md) \ No newline at end of file diff --git a/docs/build/reference/spdin-use-sample-profile-database.md b/docs/build/reference/spdin-use-sample-profile-database.md new file mode 100644 index 00000000000..b8ba7989923 --- /dev/null +++ b/docs/build/reference/spdin-use-sample-profile-database.md @@ -0,0 +1,52 @@ +--- +title: "/SPDIN (Use Sample Profile Database)" +description: "Learn more about linker option: /SPDIN (Use Sample Profile Database)" +ms.date: 05/05/2026 +ai-usage: ai-assisted +helpviewer_keywords: ["/SPDIN linker option", "-SPDIN linker option", "sample profile-guided optimization, /SPDIN"] +--- +# /SPDIN (Use Sample Profile Database) + +Specifies a Sample Profile Database (SPD) file that contains profiling data for use in a Sample Profile-Guided Optimization (SPGO) build. +Also used to override the default or file specified with `/SPD` for reading the sample profile database. + +## Syntax + +> **/SPDIN:**_filename_ + +## Argument + +`filename`\ +Specifies the path to the `.spd` file that contains the profiling data to use for optimization. When expanded, the fully qualified path must not exceed `MAX_PATH` (260 characters).\ +If the file doesn't exist, the linker creates an empty file that will be used to collect data. + +## Remarks + +After collecting a performance trace by using `xperf`, converting it by using [`SPTAggregate`](../sptaggregate.md), and importing the data into an SPD file by using [`SPDConvert`](../spdconvert.md), use `/SPDIN` and [`/SPGO`](spgo-enable-sample-profile-guided-optimization.md) to produce an optimized binary. + +The GUID and age of the binary recorded in the SPD file must match the SPT file. If they don't match, you may see a "SPD version incompatible" error. To diagnose this error, use [`SPTDump /progid`](../sptdump.md) to inspect the binary identifiers in the SPT file, and [`SPDDump /header`](../spddump.md) to inspect the SPD file. The linker uses a valid SPD file to the extent possible. Minor updates to the code that don't alter the program's control flow are tolerated. Unchanged functions also use the data for optimization. If you provide a valid, but otherwise unrelated SPD, the process works, but likely no data is usable for optimization. + +Use [`/SPDEMBED`](spdembed-embed-sample-profile-database.md) together with `/SPGO` to embed the SPD data into the PDB file produced by the build. + +Use [`/SPD`](spd-specify-sample-profile-database.md) to specify a nondefault name or location for the SPD file. `/SPDIN` overrides this option, if specified. + +For more information about the SPGO workflow, see [Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](../sample-profile-guided-optimization.md). + +### To set this linker option in the Visual Studio development environment + +1. Open the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md). +1. Select the **Configuration Properties** > **Linker** > **Command Line** property page. +1. Add `/SPDIN:filename` to the **Additional Options** box. Choose **OK** to save your changes. + +### To set this linker option programmatically + +- See . + +## See also + +[MSVC linker reference](linking.md)\ +[MSVC Linker Options](linker-options.md)\ +[/SPD (Specify Sample Profile Database)](spd-specify-sample-profile-database.md)\ +[/SPDEMBED (Embed Sample Profile Database)](spdembed-embed-sample-profile-database.md)\ +[/SPGO (Enable Sample Profile-Guided Optimization)](spgo-enable-sample-profile-guided-optimization.md)\ +[Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](../sample-profile-guided-optimization.md) \ No newline at end of file diff --git a/docs/build/reference/spgo-enable-sample-profile-guided-optimization.md b/docs/build/reference/spgo-enable-sample-profile-guided-optimization.md new file mode 100644 index 00000000000..e2eeaa48ed2 --- /dev/null +++ b/docs/build/reference/spgo-enable-sample-profile-guided-optimization.md @@ -0,0 +1,51 @@ +--- +title: "/SPGO (Enable Sample Profile-Guided Optimization)" +description: "Learn more about: /SPGO (Enable Sample Profile-Guided Optimization)" +ms.date: 05/05/2026 +ai-usage: ai-assisted +helpviewer_keywords: ["/SPGO linker option", "-SPGO linker option", "sample profile-guided optimization, /SPGO"] +--- +# /SPGO (Enable Sample Profile-Guided Optimization) + +Enables Sample Profile-Guided Optimization (SPGO) and creates an empty Sample Profile Database (SPD) file alongside the output binary. + +## Syntax + +> **/SPGO** + +## Remarks + +The `/SPGO` linker option starts the SPGO workflow. It directs the linker to create an empty `.spd` file that acts as a placeholder for profiling data. After building with `/SPGO`, you collect a performance trace by using `xperf`, convert it to an SPT file by using [`SPTAggregate`](../sptaggregate.md), and then import the data into the SPD file by using [`SPDConvert`](../spdconvert.md). Once the SPD file contains profile data, rebuild by using the SPD file to produce an optimized binary. The compiler and linker look for an SPD input file, either default or specified by [`/SPD`](spd-specify-sample-profile-database.md). The [/SPDIN (Use Sample Profile Database)](spdin-use-sample-profile-database.md) option is available as a convenience when the input file is over-written and that isn't desirable. + +When you build by using `/SPGO` but the SPD file contains no profile data yet, you see a message such as: + +``` +Result: SPD .spd does not contain sample profile, compiling without profile guided optimizations +``` + +This message is expected on the first build and indicates that the SPD file is ready to receive profiling data. + +By default, the build process creates the SPD file with the same base name as the output file in the directory from which the link was invoked. Use [`/SPD`](spd-specify-sample-profile-database.md) to specify a different name or location. + +Use [`/SPDEMBED`](spdembed-embed-sample-profile-database.md) to embed the SPD data into the PDB file after profile data is collected. Ensure that the linker is producing a PDB file by specifying the `/DEBUG` option. + +For more information about the SPGO workflow, see [Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](../sample-profile-guided-optimization.md). + +### To set this linker option in the Visual Studio development environment + +1. Open the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md). +1. Select the **Configuration Properties** > **Linker** > **Command Line** property page. +1. Add `/SPGO` to the **Additional Options** box. Choose **OK** to save your changes. + +### To set this linker option programmatically + +- See . + +## See also + +[MSVC linker reference](linking.md)\ +[MSVC Linker Options](linker-options.md)\ +[/SPD (Specify Sample Profile Database)](spd-specify-sample-profile-database.md)\ +[/SPDEMBED (Embed Sample Profile Database)](spdembed-embed-sample-profile-database.md)\ +[/SPDIN (Use Sample Profile Database)](spdin-use-sample-profile-database.md)\ +[Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](../sample-profile-guided-optimization.md) \ No newline at end of file diff --git a/docs/build/reference/vcxproj-file-structure.md b/docs/build/reference/vcxproj-file-structure.md index d2ba07e23ff..2071e7e393d 100644 --- a/docs/build/reference/vcxproj-file-structure.md +++ b/docs/build/reference/vcxproj-file-structure.md @@ -7,7 +7,7 @@ ms.assetid: 14d0c552-29db-480e-80c1-7ea89d6d8e9c --- # `.vcxproj` and `.props` file structure -[MSBuild](../msbuild-visual-cpp.md) is the default project system in Visual Studio; when you choose **File** > **New Project** in Visual C++ you're creating an MSBuild project whose settings are stored in an XML project file that has the extension *`.vcxproj`*. The project file may also import *`.props`* files and *`.targets`* files where settings can be stored. +[MSBuild](../msbuild-visual-cpp.md) is the default project system in Visual Studio; when you choose **File** > **New Project**, in most cases you're creating an MSBuild project whose settings are stored in an XML project file that has the extension *`.vcxproj`*. The project file may also import *`.props`* files and *`.targets`* files where settings can be stored. If you intend to maintain your project properties in the IDE, we recommend you only create and modify your *`.vcxproj`* projects in the IDE, and avoid manual edits to the files. In most cases, you never need to manually edit the project file. Manual edits may break the project connections required to modify project settings in the Visual Studio property pages, and can cause build errors that are difficult to debug and repair. For more information about using the property pages, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md). @@ -188,7 +188,7 @@ The `PropertySheets` group contains the imports for user property sheets. These ``` -`UserMacros` contains properties you create as variables that are used to customize your build process. For example, you can define a user macro to define your custom output path as $(CustomOutputPath) and use it to define other variables. This property group houses such properties. In Visual Studio, this group isn't populated in the project file because Visual C++ doesn't support user macros for configurations. User macros are supported in property sheets. +`UserMacros` contains properties you create as variables that are used to customize your build process. For example, you can define a user macro to define your custom output path as $(CustomOutputPath) and use it to define other variables. This property group houses such properties. In Visual Studio, this group isn't populated in the project file because Microsoft C++ doesn't support user macros for configurations. User macros are supported in property sheets. ### Per-configuration PropertyGroup elements diff --git a/docs/build/reference/visual-cpp-project-types.md b/docs/build/reference/visual-cpp-project-types.md index 41e998d56e9..baebf7c6045 100644 --- a/docs/build/reference/visual-cpp-project-types.md +++ b/docs/build/reference/visual-cpp-project-types.md @@ -1,6 +1,6 @@ --- description: "Learn more about: C++ project templates" -title: "Visual C++ Project Types" +title: "Microsoft C++ Project Types" ms.date: "08/13/2019" helpviewer_keywords: ["programs [C++], projects", "project templates [Visual Studio], C++", "TODO comments [C++]", "projects [C++], types", "templates [C++], projects", "applications [C++], projects", "C++ projects, types"] ms.assetid: 7337987e-1e7b-4120-9a4b-94f0401f15e7 diff --git a/docs/build/reference/vlen.md b/docs/build/reference/vlen.md index 6557c219ef9..fbc7abdf60e 100644 --- a/docs/build/reference/vlen.md +++ b/docs/build/reference/vlen.md @@ -9,6 +9,7 @@ helpviewer_keywords: ["specify vector length", "-vlen compiler option [C++]", "v Specifies the vector length for code generation on x86 and x64. For more information about **`/arch`** for x86 and x64, see [`/arch` (x86)](arch-x86.md) and [`/arch` (x64)](arch-x64.md). + ## Syntax > **`/vlen=`**\[**`256`**|**`512`**] @@ -18,24 +19,26 @@ Specifies the vector length for code generation on x86 and x64. For more informa ## Arguments **`/vlen=256`**\ -Specify a vector length of 256 bits for auto-vectorization and other optimizations. +Specify a vector length of 256 bits for autovectorization and other optimizations. **`/vlen=512`**\ -Specify a vector length of 512 bits for auto-vectorization and other optimizations. +Specify a vector length of 512 bits for autovectorization and other optimizations. **`/vlen`**\ Specify the default vector length for the selected **`/arch`** setting. ## Remarks -If a specific **`/vlen`** value isn't specified, the default vector length depends on the **`/arch`** flag setting. The **`/vlen`** flag can override the default vector length specified by **`/arch:AVX512`** or **`/arch:AVX10.1`** flag. For example: +This compiler option was introduced in Visual Studio 2022 17.13. + +If a specific **`/vlen`** value isn't specified, the default vector length depends on the **`/arch`** compiler option setting. The **`/vlen`** compiler option can override the default vector length specified by **`/arch:AVX512`**, **`/arch:AVX10.1`**, or **`/arch:AVX10.2`** compiler option. For example: - **`/arch:AVX512 /vlen=256`** overrides the default vector length of 512 bits specified by **`/arch:AVX512`** to be 256 bits. - **`/arch:AVX10.1 /vlen=512`** overrides the default vector length of 256 bits specified by **`/arch:AVX10.1`** to be 512 bits. -When the specified **`/vlen`** value is incompatible with specified **`/arch`** flag, a warning is generated and default vector length for the **`/arch`** setting is used. For example: +When the specified **`/vlen`** value is incompatible with specified **`/arch`** compiler option, a warning is generated and default vector length for the **`/arch`** setting is used. For example: -- **`/arch:AVX2 /vlen=512`** generates a warning because AVX2 doesn't support 512-bit vectors. Vector length of 256 bits is used in this case. +- **`/arch:AVX2 /vlen=512`** generates a warning because AVX2 doesn't support 512-bit vectors. A 256-bit vector length is used in this case. ### To set the `/vlen=256` or `/vlen=512` compiler option in Visual Studio diff --git a/docs/build/reference/z7-zi-zi-debug-information-format.md b/docs/build/reference/z7-zi-zi-debug-information-format.md index 6cc70e4d4c8..4cf63809f02 100644 --- a/docs/build/reference/z7-zi-zi-debug-information-format.md +++ b/docs/build/reference/z7-zi-zi-debug-information-format.md @@ -1,7 +1,7 @@ --- description: "Learn more about: /Z7, /Zi, /ZI (Debug Information Format)" title: "/Z7, /Zi, /ZI (Debug Information Format)" -ms.date: 12/09/2021 +ms.date: 3/26/2026 f1_keywords: ["VC.Project.VCCLCompilerTool.DebugInformationFormat", "/ZI", "/Zi", "/Z7", "VC.Project.VCCLWCECompilerTool.DebugInformationFormat"] helpviewer_keywords: ["C7 compatible compiler option [C++]", "Debug Information Format compiler option", "ZI compiler option", "-Zi compiler option [C++]", "/ZI compiler option [C++]", "Z7 compiler option [C++]", "debugging [C++], debug information files", "Zi compiler option [C++]", "/Zi compiler option [C++]", "program database compiler option [C++]", "full symbolic debugging information", "/Z7 compiler option [C++]", "line numbers only compiler option [C++]", "cl.exe compiler, debugging options", "-Z7 compiler option [C++]"] --- @@ -62,6 +62,27 @@ The **`/ZI`** option forces both the [`/Gy` (Enable Function-Level Linking)](gy- 1. Modify the **Debug Information Format** property. Choose **OK** to save your changes. +### To set this compiler option in a project file + +To set the debug information format in a `.vcxproj` project file, use the `` property within a `` item definition. The following table shows the MSBuild XML values and their corresponding compiler options: + +| MSBuild XML value | Compiler option | Description | +|---|---|---| +| `None` | *(none)* | No debug information | +| `OldStyle` | **`/Z7`** | Full symbolic debug information embedded in .obj files, no PDB | +| `ProgramDatabase` | **`/Zi`** | Program database (PDB) | +| `EditAndContinue` | **`/ZI`** | PDB with Edit and Continue support | + +For example, to set the debug information format to program database in a release configuration: + +```xml + + + ProgramDatabase + + +``` + ### To set this compiler option programmatically - See . diff --git a/docs/build/reference/zc-conformance.md b/docs/build/reference/zc-conformance.md index 7c3d4f27a88..77534192bb9 100644 --- a/docs/build/reference/zc-conformance.md +++ b/docs/build/reference/zc-conformance.md @@ -30,7 +30,7 @@ Here are the **`/Zc`** compiler options: | [`/Zc:checkGwOdr[-]`](zc-check-gwodr.md) | Enforce Standard C++ ODR violations under `/Gw`. | | [`/Zc:enumTypes[-]`](zc-enumtypes.md) | Enable Standard C++ rules for `enum` type deduction. Off by default. | | [`/Zc:externC[-]`](zc-externc.md) | Enforce Standard C++ rules for `extern "C"` functions. Off by default unless **`/permissive-`** is specified. | -| [`/Zc:externConstexpr[-]`](zc-externconstexpr.md) | Enable external linkage for **`constexpr`** variables. Off by default. | +| [`/Zc:externConstexpr[-]`](zc-externconstexpr.md) | Enable external linkage for **`constexpr`** variables. Off by default unless **`/permissive-`** is specified. | | [`/Zc:forScope[-]`](zc-forscope-force-conformance-in-for-loop-scope.md) | Enforce Standard C++ **`for`** scoping rules. On by default. | | [`/Zc:gotoScope[-]`](zc-gotoscope.md) | Enforce Standard C++ **`goto`** rules around local variable initialization. Off by default unless **`/permissive-`** is specified. | | [`/Zc:hiddenFriend[-]`](zc-hiddenfriend.md) | Enforce Standard C++ hidden friend rules. Off by default unless **`/permissive-`** is specified. | diff --git a/docs/build/reference/zf.md b/docs/build/reference/zf.md index d15547b2e8c..cb7b1c17ec3 100644 --- a/docs/build/reference/zf.md +++ b/docs/build/reference/zf.md @@ -19,7 +19,7 @@ The **/Zf** option enables compiler support for faster generation of PDB files w Because the **/Zf** option only applies to PDB generation, it requires the [/Zi](z7-zi-zi-debug-information-format.md) or [/ZI](z7-zi-zi-debug-information-format.md) option. -The **/Zf** option is available beginning in Visual Studio 2017 version 15.1, where it is off by default. Starting in Visual Studio 2017 version 15.7, this option is on by default when the **/Zi** or **/ZI** option is enabled. +The **/Zf** option is available beginning in Visual Studio 2017 version 15.1, where it is off by default. Starting in Visual Studio 2017 version 15.7, this option is on by default when the **/Zi** or **/ZI** option is enabled. To explicitly disable this option, use **/Zf-**. ### To set this compiler option in the Visual Studio development environment diff --git a/docs/build/reference/zh.md b/docs/build/reference/zh.md index 3cefaf8e712..d30cd5a3651 100644 --- a/docs/build/reference/zh.md +++ b/docs/build/reference/zh.md @@ -1,9 +1,9 @@ --- title: "/ZH (Hash algorithm for calculation of file checksum in debug info)" -description: "Use the /ZH compiler option to enable MD5, SHA-1, or SHA-256 source file checksums in debug info" -ms.date: 02/01/2022 -f1_keywords: ["/ZH", "/ZH:MD5", "/ZH:SHA1", "/ZH:SHA_256"] -helpviewer_keywords: ["/ZH", "/ZH:MD5", "/ZH:SHA1", "/ZH:SHA_256", "/ZH compiler option", "/ZH:MD5 compiler option", "/ZH:SHA1 compiler option", "/ZH:SHA_256 compiler option", "Hash algorithm for file checksum in debug info"] +description: "Use the /ZH compiler option to enable MD5, SHA-1, SHA-256, SHA-384, or SHA-512 source file checksums in debug info" +ms.date: 04/13/2026 +f1_keywords: ["/ZH", "/ZH:MD5", "/ZH:SHA1", "/ZH:SHA_256", "/ZH:SHA384", "/ZH:SHA512"] +helpviewer_keywords: ["/ZH", "/ZH:MD5", "/ZH:SHA1", "/ZH:SHA_256", "/ZH:SHA384", "/ZH:SHA512", "/ZH compiler option", "/ZH:MD5 compiler option", "/ZH:SHA1 compiler option", "/ZH:SHA_256 compiler option", "/ZH:SHA384 compiler option", "/ZH:SHA512 compiler option", "Hash algorithm for file checksum in debug info"] --- # `/ZH` (Hash algorithm for calculation of file checksum in debug info) @@ -13,7 +13,9 @@ Specifies which cryptographic hash algorithm to use to generate a checksum of ea > **`/ZH:MD5`**\ > **`/ZH:SHA1`**\ -> **`/ZH:SHA_256`** +> **`/ZH:SHA_256`**\ +> **`/ZH:SHA384`**\ +> **`/ZH:SHA512`** ## Arguments @@ -26,11 +28,20 @@ Use an SHA-1 hash for the checksum. **`/ZH:SHA_256`**\ Use an SHA-256 hash for the checksum. This option is the default in Visual Studio 2022 version 17.0 and later. +**`/ZH:SHA384`**\ +Use an SHA-384 hash for the checksum. + +**`/ZH:SHA512`**\ +Use an SHA-512 hash for the checksum. + ## Remarks -PDB files store a checksum for each source file, compiled into the object code in the associated executable. The checksum allows the debugger to verify that the source code it loads matches the executable. The compiler and debugger support MD5, SHA-1, and SHA-256 hash algorithms. By default, in Visual Studio 2019 the compiler uses an MD5 hash to generate the checksum. To specify this hash algorithm explicitly, use the **`/ZH:MD5`** option. +PDB files store a checksum for each source file, compiled into the object code in the associated executable. The checksum allows the debugger to verify that the source code it loads matches the executable. The compiler and debugger support MD5, SHA-1, SHA-256, SHA-384, and SHA-512 hash algorithms. By default, in Visual Studio 2019 the compiler uses an MD5 hash to generate the checksum. To specify this hash algorithm explicitly, use the **`/ZH:MD5`** option. + +Because of a risk of collision problems in MD5 and SHA-1, use the **`/ZH:SHA_256`** option or stronger. The SHA-384 and SHA-512 options provide stronger checksums but can increase compile time. The **`/ZH:SHA_256`** option is the default in Visual Studio 2022 version 17.0 and later. -Because of a risk of collision problems in MD5 and SHA-1, Microsoft recommends you use the **`/ZH:SHA_256`** option. The SHA-256 hash might result in a small increase in compile times. The **`/ZH:SHA_256`** option is the default in Visual Studio 2022 version 17.0 and later. +> [!NOTE] +> The **`/ZH:SHA384`** and **`/ZH:SHA512`** options aren't supported for IFC (module interface) files. If you compile modules with one of these options, the compiler emits [fatal error C1029](../../error-messages/compiler-errors-1/fatal-error-c1029.md). Use **`/ZH:SHA_256`** or a smaller hash algorithm when you compile C++ modules. When more than one **`/ZH`** option is specified, the last option is used. @@ -44,9 +55,10 @@ The **`/ZH`** option is available in Visual Studio 2019 version 16.4 and later. 1. Select the **Configuration Properties** > **C/C++** > **Command Line** property page. -1. Modify the **Additional options** property to add a **`/ZH:MD5`**, **`/ZH:SHA1`**, or **`/ZH:SHA_256`** option, and then choose **OK**. +1. Modify the **Additional options** property to add a **`/ZH:MD5`**, **`/ZH:SHA1`**, **`/ZH:SHA_256`**, **`/ZH:SHA384`**, or **`/ZH:SHA512`** option, and then choose **OK**. ## See also [Compiler options](compiler-options.md)\ +[Debug Interface Access SDK - IDiaSourceFile::get_checksumType](/visualstudio/debugger/debug-interface-access/idiasourcefile-get-checksumtype)\ [Source server](/windows/win32/debug/source-server-and-source-indexing) diff --git a/docs/build/reference/zw-windows-runtime-compilation.md b/docs/build/reference/zw-windows-runtime-compilation.md index 6bba2c712c5..b535b3e7c78 100644 --- a/docs/build/reference/zw-windows-runtime-compilation.md +++ b/docs/build/reference/zw-windows-runtime-compilation.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: /ZW (Windows Runtime Compilation)" title: "/ZW (Windows Runtime Compilation)" +description: "Learn more about: /ZW (Windows Runtime Compilation)" ms.date: 06/22/2023 f1_keywords: ["VC.Project.VCCLCompilerTool.CompileAsWinRT", "/zw"] helpviewer_keywords: ["/ZW", "-ZW compiler option", "/ZW compiler option", "-ZW", "Windows Runtime compiler option"] @@ -9,19 +9,19 @@ helpviewer_keywords: ["/ZW", "-ZW compiler option", "/ZW compiler option", "-ZW" Compiles source code to support Microsoft C++ component extensions C++/CX for the creation of Universal Windows Platform (UWP) apps. -When you use **`/ZW`** to compile, always specify **`/EHsc`** as well.\ -**`/ZW`** isn't compatible with **`/std:c++20`**. +When you use **`/ZW`** to compile, always specify [`/EHsc`](eh-exception-handling-model.md) as well.\ +**`/ZW`** isn't compatible with [`/std:c++20`](std-specify-language-standard-version.md) or later. ## Syntax -```cpp +``` /ZW /EHsc /ZW:nostdlib /EHsc ``` ## Arguments -**`nostdlib`**\ +*`nostdlib`*\ Indicates that `Platform.winmd`, `Windows.Foundation.winmd`, and other default Windows metadata (`.winmd`) files aren't automatically included in the compilation. Instead, you must use the [`/FU` (Name Forced #using File)](fu-name-forced-hash-using-file.md) compiler option to explicitly specify Windows metadata files. ## Remarks @@ -32,11 +32,9 @@ When you specify the **`/ZW`** option, the compiler supports these features: - Automatic reference-counting of Windows Runtime objects, and automatic discarding of an object when its reference count goes to zero. -Because the incremental linker doesn't support the Windows metadata included in .obj files by using the **`/ZW`** option, the deprecated [/Gm (Enable Minimal Rebuild)](gm-enable-minimal-rebuild.md) option is incompatible with **`/ZW`**. - -For more information, see [Visual C++ Language Reference](../../cppcx/visual-c-language-reference-c-cx.md). +Because the incremental linker doesn't support the Windows metadata included in `.obj` files by using the **`/ZW`** option, the deprecated [`/Gm` (Enable Minimal Rebuild)](gm-enable-minimal-rebuild.md) option is incompatible with **`/ZW`**. -## Requirements +For more information, see [C++/CX Language Reference](../../cppcx/visual-c-language-reference-c-cx.md). ## See also diff --git a/docs/build/regular-dlls-statically-linked-to-mfc.md b/docs/build/regular-dlls-statically-linked-to-mfc.md index d3d90f05184..4faae4e7bb4 100644 --- a/docs/build/regular-dlls-statically-linked-to-mfc.md +++ b/docs/build/regular-dlls-statically-linked-to-mfc.md @@ -9,7 +9,7 @@ ms.assetid: 2eed531c-726a-4b8a-b936-f721dc00a7fa A regular MFC DLL statically linked to MFC is a DLL that uses MFC internally, and the exported functions in the DLL can be called by either MFC or non-MFC executables. As the name describes, this kind of DLL is built using the static link library version of MFC. Functions are usually exported from a regular MFC DLL using the standard C interface. For an example of how to write, build, and use a regular MFC DLL, see the sample [DLLScreenCap](https://github.com/Microsoft/VCSamples/tree/master/VC2010Samples/MFC/advanced/DllScreenCap). -Note that the term USRDLL is no longer used in the Visual C++ documentation. A regular MFC DLL that is statically linked to MFC has the same characteristics as the former USRDLL. +Note that the term USRDLL is no longer used in the Microsoft C++ documentation. A regular MFC DLL that is statically linked to MFC has the same characteristics as the former USRDLL. A regular MFC DLL, statically linked to MFC, has the following features: diff --git a/docs/build/run-time-library-behavior.md b/docs/build/run-time-library-behavior.md index 1a85ae8d849..1b755df2623 100644 --- a/docs/build/run-time-library-behavior.md +++ b/docs/build/run-time-library-behavior.md @@ -1,31 +1,30 @@ --- -description: "Learn more about: DLLs and Visual C++ run-time library behavior" -title: "DLLs and Visual C++ run-time library behavior" -ms.date: "08/19/2019" +description: "Learn more about: DLLs and Microsoft C++ runtime library behavior" +title: "DLLs and Visual C++ runtime library behavior" +ms.date: 02/23/2026 f1_keywords: ["_DllMainCRTStartup", "CRT_INIT"] helpviewer_keywords: ["DLLs [C++], entry point function", "process detach [C++]", "process attach [C++]", "DLLs [C++], run-time library behavior", "DllMain function", "_CRT_INIT macro", "_DllMainCRTStartup method", "run-time [C++], DLL startup sequence", "DLLs [C++], startup sequence"] -ms.assetid: e06f24ab-6ca5-44ef-9857-aed0c6f049f2 --- -# DLLs and Visual C++ run-time library behavior +# DLLs and Visual C++ runtime library behavior -When you build a Dynamic-link Library (DLL) by using Visual Studio, by default, the linker includes the Visual C++ run-time library (VCRuntime). The VCRuntime contains code required to initialize and terminate a C/C++ executable. When linked into a DLL, the VCRuntime code provides an internal DLL entry-point function called `_DllMainCRTStartup` that handles Windows OS messages to the DLL to attach to or detach from a process or thread. The `_DllMainCRTStartup` function performs essential tasks such as stack buffer security set up, C run-time library (CRT) initialization and termination, and calls to constructors and destructors for static and global objects. `_DllMainCRTStartup` also calls hook functions for other libraries such as WinRT, MFC, and ATL to perform their own initialization and termination. Without this initialization, the CRT and other libraries, as well as your static variables, would be left in an uninitialized state. The same VCRuntime internal initialization and termination routines are called whether your DLL uses a statically linked CRT or a dynamically linked CRT DLL. +When you build a Dynamic-link Library (DLL) using Visual Studio, by default, the linker includes the Visual C++ runtime library (VCRuntime). The VCRuntime contains code required to initialize and terminate a C/C++ executable. When linked into a DLL, the VCRuntime code provides an internal DLL entry-point function called `_DllMainCRTStartup` that handles Windows OS messages to the DLL to attach to or detach from a process or thread. The `_DllMainCRTStartup` function performs essential tasks such as stack buffer security setup, C runtime library (CRT) initialization and termination, and calls to constructors and destructors for static and global objects. `_DllMainCRTStartup` also calls hook functions for other libraries such as WinRT, MFC, and ATL to perform their own initialization and termination. Without this initialization, the CRT and other libraries, and your static variables, would be left in an uninitialized state. The same VCRuntime internal initialization and termination routines are called whether your DLL uses a statically linked CRT or a dynamically linked CRT DLL. ## Default DLL entry point _DllMainCRTStartup -In Windows, all DLLs can contain an optional entry-point function, usually called `DllMain`, that is called for both initialization and termination. This gives you an opportunity to allocate or release additional resources as needed. Windows calls the entry-point function in four situations: process attach, process detach, thread attach, and thread detach. When a DLL is loaded into a process address space, either when an application that uses it is loaded, or when the application requests the DLL at runtime, the operating system creates a separate copy of the DLL data. This is called *process attach*. *Thread attach* occurs when the process the DLL is loaded in creates a new thread. *Thread detach* occurs when the thread terminates, and *process detach* is when the DLL is no longer required and is released by an application. The operating system makes a separate call to the DLL entry point for each of these events, passing a *reason* argument for each event type. For example, the OS sends `DLL_PROCESS_ATTACH` as the *reason* argument to signal process attach. +In Windows, all DLLs can contain an optional entry-point function, usually called `DllMain`, that is called for both initialization and termination. This gives you an opportunity to allocate or release other resources as needed. Windows calls the entry-point function in four situations: process attach, process detach, thread attach, and thread detach. When a DLL is loaded into a process address space, either when an application that uses it's loaded, or when the application requests the DLL at runtime, the operating system creates a separate copy of the DLL data. This is called *process attach*. *Thread attach* occurs when the process the DLL is loaded in creates a new thread. *Thread detach* occurs when the thread terminates, and *process detach* is when the DLL is no longer required and is released by an application. The operating system makes a separate call to the DLL entry point for each of these events, passing a *reason* argument for each event type. For example, the OS sends `DLL_PROCESS_ATTACH` as the *reason* argument to signal process attach. -The VCRuntime library provides an entry-point function called `_DllMainCRTStartup` to handle default initialization and termination operations. On process attach, the `_DllMainCRTStartup` function sets up buffer security checks, initializes the CRT and other libraries, initializes run-time type information, initializes and calls constructors for static and non-local data, initializes thread-local storage, increments an internal static counter for each attach, and then calls a user- or library-supplied `DllMain`. On process detach, the function goes through these steps in reverse. It calls `DllMain`, decrements the internal counter, calls destructors, calls CRT termination functions and registered `atexit` functions, and notifies any other libraries of termination. When the attachment counter goes to zero, the function returns `FALSE` to indicate to Windows that the DLL can be unloaded. The `_DllMainCRTStartup` function is also called during thread attach and thread detach. In these cases, the VCRuntime code does no additional initialization or termination on its own, and just calls `DllMain` to pass the message along. If `DllMain` returns `FALSE` from process attach, signaling failure, `_DllMainCRTStartup` calls `DllMain` again and passes `DLL_PROCESS_DETACH` as the *reason* argument, then goes through the rest of the termination process. +The VCRuntime library provides an entry-point function called `_DllMainCRTStartup` to handle default initialization and termination operations. On process attach, the `_DllMainCRTStartup` function sets up buffer security checks, initializes the CRT and other libraries, initializes runtime type information, initializes and calls constructors for static and nonlocal data, initializes thread-local storage, increments an internal static counter for each attach, and then calls a user- or library-supplied `DllMain`. On process detach, the function goes through these steps in reverse. It calls `DllMain`, decrements the internal counter, calls destructors, calls CRT termination functions and registered `atexit` functions, and notifies any other libraries of termination. When the attachment counter goes to zero, the function returns `FALSE` to indicate to Windows that the DLL can be unloaded. The `_DllMainCRTStartup` function is also called during thread attach and thread detach. In these cases, the VCRuntime code does no other initialization or termination on its own, and just calls `DllMain` to pass the message along. If `DllMain` returns `FALSE` from process attach, signaling failure, `_DllMainCRTStartup` calls `DllMain` again and passes `DLL_PROCESS_DETACH` as the *reason* argument, then goes through the rest of the termination process. -When building DLLs in Visual Studio, the default entry point `_DllMainCRTStartup` supplied by VCRuntime is linked in automatically. You do not need to specify an entry-point function for your DLL by using the [/ENTRY (Entry point symbol)](reference/entry-entry-point-symbol.md) linker option. +When building DLLs in Visual Studio, the default entry point `_DllMainCRTStartup` supplied by VCRuntime is linked in automatically. You don't need to specify an entry-point function for your DLL by using the [`/ENTRY` (Entry point symbol)](reference/entry-entry-point-symbol.md) linker option. > [!NOTE] -> While it is possible to specify another entry-point function for a DLL by using the /ENTRY: linker option, we do not recommend it, because your entry-point function would have to duplicate everything that `_DllMainCRTStartup` does, in the same order. The VCRuntime provides functions that allow you to duplicate its behavior. For example, you can call [__security_init_cookie](../c-runtime-library/reference/security-init-cookie.md) immediately on process attach to support the [/GS (Buffer security check)](reference/gs-buffer-security-check.md) buffer checking option. You can call the `_CRT_INIT` function, passing the same parameters as the entry point function, to perform the rest of the DLL initialization or termination functions. +> While it's possible to specify another entry-point function for a DLL by using the `/ENTRY`: linker option, we don't recommend it, because your entry-point function would have to duplicate everything that `_DllMainCRTStartup` does, in the same order. The VCRuntime provides functions that allow you to duplicate its behavior. For example, you can call [__security_init_cookie](../c-runtime-library/reference/security-init-cookie.md) immediately on process attach to support the [/GS (Buffer security check)](reference/gs-buffer-security-check.md) buffer checking option. You can call the `_CRT_INIT` function, passing the same parameters as the entry point function, to perform the rest of the DLL initialization or termination functions. ## Initialize a DLL -Your DLL may have initialization code that must execute when your DLL loads. In order for you to perform your own DLL initialization and termination functions, `_DllMainCRTStartup` calls a function called `DllMain` that you can provide. Your `DllMain` must have the signature required for a DLL entry point. The default entry point function `_DllMainCRTStartup` calls `DllMain` using the same parameters passed by Windows. By default, if you do not provide a `DllMain` function, Visual Studio provides one for you and links it in so that `_DllMainCRTStartup` always has something to call. This means that if you do not need to initialize your DLL, there is nothing special you have to do when building your DLL. +Your DLL may have initialization code that must execute when your DLL loads. In order for you to perform your own DLL initialization and termination functions, `_DllMainCRTStartup` calls a function called `DllMain` that you can provide. Your `DllMain` must have the signature required for a DLL entry point. The default entry point function `_DllMainCRTStartup` calls `DllMain` using the same parameters passed by Windows. By default, if you don't provide a `DllMain` function, Visual Studio provides one for you and links it in so that `_DllMainCRTStartup` always has something to call. This means that if you don't need to initialize your DLL, there's nothing special you have to do when building your DLL. This is the signature used for `DllMain`: @@ -38,10 +37,10 @@ extern "C" BOOL WINAPI DllMain ( LPVOID const reserved); // reserved ``` -Some libraries wrap the `DllMain` function for you. For example, in a regular MFC DLL, implement the `CWinApp` object's `InitInstance` and `ExitInstance` member functions to perform initialization and termination required by your DLL. For more details, see the [Initialize regular MFC DLLs](#initializing-regular-dlls) section. +Some libraries wrap the `DllMain` function for you. For example, in a regular MFC DLL, implement the `CWinApp` object's `InitInstance` and `ExitInstance` member functions to perform initialization and termination required by your DLL. For more information, see the [Initialize regular MFC DLLs](#initializing-regular-dlls) section. > [!WARNING] -> There are significant limits on what you can safely do in a DLL entry point. For more information about specific Windows APIs that are unsafe to call in `DllMain`, see [General Best Practices](/windows/win32/Dlls/dynamic-link-library-best-practices). If you need anything but the simplest initialization then do that in an initialization function for the DLL. You can require applications to call the initialization function after `DllMain` has run and before they call any other functions in the DLL. +> There are significant limits on what you can safely do in a DLL entry point. For more information about specific Windows APIs that are unsafe to call in `DllMain`, see [General Best Practices](/windows/win32/Dlls/dynamic-link-library-best-practices). If you need anything but the simplest initialization, then do that in an initialization function for the DLL. You can require applications to call the initialization function after `DllMain` has run and before they call any other functions in the DLL. @@ -82,17 +81,64 @@ extern "C" BOOL WINAPI DllMain ( ``` > [!NOTE] -> Older Windows SDK documentation says that the actual name of the DLL entry-point function must be specified on the linker command-line with the /ENTRY option. With Visual Studio, you do not need to use the /ENTRY option if the name of your entry-point function is `DllMain`. In fact, if you use the /ENTRY option and name your entry-point function something other than `DllMain`, the CRT does not get initialized properly unless your entry-point function makes the same initialization calls that `_DllMainCRTStartup` makes. +> Older Windows SDK documentation says that the actual name of the DLL entry-point function must be specified on the linker command-line with the `/ENTRY` option. With Visual Studio, you don't need to use the `/ENTRY` option if the name of your entry-point function is `DllMain`. In fact, if you use the `/ENTRY` option and name your entry-point function something other than `DllMain`, the CRT doesn't get initialized properly unless your entry-point function makes the same initialization calls that `_DllMainCRTStartup` makes. + +### Manual CRT initialization with `_CRT_INIT` + +When building a DLL that uses any of the C runtime libraries, in order to ensure that the CRT is properly initialized, either: + +- The initialization function must be named `DllMain()` and the entry point must be specified with the linker option `-entry:_DllMainCRTStartup@12` This is the default behavior when building a DLL (the `@12` is x86-only because that platform uses `stdcall`), or +- The DLL's entry point must explicitly call `_CRT_INIT()` on process attach and process detach. This is only relevant if you are using `/NOENTRY` or have a custom entry point. We don't recommend using `/NOENTRY` or a custom entry point, if possible, because you would have to duplicate all of the initialization and termination code that `_DllMainCRTStartup` provides, in the same order. + +This permits the C runtime libraries to properly allocate and initialize C runtime data when a process or thread is attaching to the DLL, to properly clean up C runtime data when a process is detaching from the DLL, and for global C++ objects in the DLL to be properly constructed and destructed. + +The Win32 SDK samples all use the first method. Refer to the Win32 Programmer's Reference for `DllEntryPoint()` and the Visual C++ documentation for `DllMain()`. `DllMainCRTStartup()` calls `_CRT_INIT()` and `_CRT_INIT()` calls your application's `DllMain()`, if it exists. + +If you wish to use the second method and call the CRT initialization code yourself, instead of using `DllMainCRTStartup()` and `DllMain()`, there are two techniques: + +1. If you do have your own DLL entry point, do the following in the entry point: + + a. Use this prototype (defined in `process.h` when `_DECL_DLLMAIN` is defined) for `_CRT_INIT()`: `BOOL WINAPI _CRT_INIT(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpReserved);` + + For information on `_CRT_INIT()` return values, see the documentation for `DllEntryPoint`; the same values are returned. + + b. On `DLL_PROCESS_ATTACH` and `DLL_THREAD_ATTACH`, call `_CRT_INIT()` first, before any C runtime functions are called or any floating-point operations are performed. + + c. Call your own process/thread initialization/termination code. + + d. On `DLL_PROCESS_DETACH` and `DLL_THREAD_DETACH`, call `_CRT_INIT()` last, after all C runtime functions have been called and all floating-point operations are completed. + +Be sure to pass on to `_CRT_INIT()` all of the parameters of the entry point; `_CRT_INIT()` expects those parameters, so things may not work reliably if they're omitted (in particular, `fdwReason` is required to determine whether process initialization or termination is needed). + +Below is a skeleton sample entry point function that shows when and how to make these calls to `_CRT_INIT()` in the DLL entry point: + +```cpp +BOOL WINAPI DllEntryPoint(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpReserved) +{ + if (fdwReason == DLL_PROCESS_ATTACH || fdwReason == DLL_THREAD_ATTACH) + if (!_CRT_INIT(hinstDLL, fdwReason, lpReserved)) + return(FALSE); + + if (fdwReason == DLL_PROCESS_DETACH || fdwReason == DLL_THREAD_DETACH) + if (!_CRT_INIT(hinstDLL, fdwReason, lpReserved)) + return(FALSE); + + return(TRUE); +} +``` + +> [!NOTE] +> This isn't necessary if you're using `DllMain()` and `-entry:_DllMainCRTStartup@12`. ### Initialize regular MFC DLLs -Because regular MFC DLLs have a `CWinApp` object, they should perform their initialization and termination tasks in the same location as an MFC application: in the `InitInstance` and `ExitInstance` member functions of the DLL's `CWinApp`-derived class. Because MFC provides a `DllMain` function that is called by `_DllMainCRTStartup` for `DLL_PROCESS_ATTACH` and `DLL_PROCESS_DETACH`, you should not write your own `DllMain` function. The MFC-provided `DllMain` function calls `InitInstance` when your DLL is loaded and it calls `ExitInstance` before the DLL is unloaded. +Because regular MFC DLLs have a `CWinApp` object, they should perform their initialization and termination tasks in the same location as an MFC application: in the `InitInstance` and `ExitInstance` member functions of the DLL's `CWinApp`-derived class. Because MFC provides a `DllMain` function that is called by `_DllMainCRTStartup` for `DLL_PROCESS_ATTACH` and `DLL_PROCESS_DETACH`, you shouldn't write your own `DllMain` function. The MFC-provided `DllMain` function calls `InitInstance` when your DLL is loaded and it calls `ExitInstance` before the DLL is unloaded. A regular MFC DLL can keep track of multiple threads by calling [TlsAlloc](/windows/win32/api/processthreadsapi/nf-processthreadsapi-tlsalloc) and [TlsGetValue](/windows/win32/api/processthreadsapi/nf-processthreadsapi-tlsgetvalue) in its `InitInstance` function. These functions allow the DLL to track thread-specific data. -In your regular MFC DLL that dynamically links to MFC, if you are using any MFC OLE, MFC Database (or DAO), or MFC Sockets support, respectively, the debug MFC extension DLLs MFCO*version*D.dll, MFCD*version*D.dll, and MFCN*version*D.dll (where *version* is the version number) are linked in automatically. You must call one of the following predefined initialization functions for each of these DLLs that you are using in your regular MFC DLL's `CWinApp::InitInstance`. +In your regular MFC DLL that dynamically links to MFC, if you're using any MFC OLE, MFC Database (or DAO), or MFC Sockets support, respectively, the debug MFC extension DLLs MFCO*version*D.dll, MFCD*version*D.dll, and MFCN*version*D.dll (where *version* is the version number) are linked in automatically. You must call one of the following predefined initialization functions for each of these DLLs that you're using in your regular MFC DLL's `CWinApp::InitInstance`. |Type of MFC support|Initialization function to call| |-------------------------|-------------------------------------| @@ -104,7 +150,7 @@ In your regular MFC DLL that dynamically links to MFC, if you are using any MFC ### Initialize MFC extension DLLs -Because MFC extension DLLs do not have a `CWinApp`-derived object (as do regular MFC DLLs), you should add your initialization and termination code to the `DllMain` function that the MFC DLL Wizard generates. +Because MFC extension DLLs don't have a `CWinApp`-derived object (as do regular MFC DLLs), you should add your initialization and termination code to the `DllMain` function that the MFC DLL Wizard generates. The wizard provides the following code for MFC extension DLLs. In the code, `PROJNAME` is a placeholder for the name of your project. @@ -143,27 +189,27 @@ DllMain(HINSTANCE hInstance, DWORD dwReason, LPVOID lpReserved) Creating a new `CDynLinkLibrary` object during initialization allows the MFC extension DLL to export `CRuntimeClass` objects or resources to the client application. -If you are going to use your MFC extension DLL from one or more regular MFC DLLs, you must export an initialization function that creates a `CDynLinkLibrary` object. That function must be called from each of the regular MFC DLLs that use the MFC extension DLL. An appropriate place to call this initialization function is in the `InitInstance` member function of the regular MFC DLL's `CWinApp`-derived object before using any of the MFC extension DLL's exported classes or functions. +If you're going to use your MFC extension DLL from one or more regular MFC DLLs, you must export an initialization function that creates a `CDynLinkLibrary` object. That function must be called from each of the regular MFC DLLs that use the MFC extension DLL. An appropriate place to call this initialization function is in the `InitInstance` member function of the regular MFC DLL's `CWinApp`-derived object before using any of the MFC extension DLL's exported classes or functions. -In the `DllMain` that the MFC DLL Wizard generates, the call to `AfxInitExtensionModule` captures the module's run-time classes (`CRuntimeClass` structures) as well as its object factories (`COleObjectFactory` objects) for use when the `CDynLinkLibrary` object is created. You should check the return value of `AfxInitExtensionModule`; if a zero value is returned from `AfxInitExtensionModule`, return zero from your `DllMain` function. +In the `DllMain` that the MFC DLL Wizard generates, the call to `AfxInitExtensionModule` captures the module's runtime classes (`CRuntimeClass` structures) and its object factories (`COleObjectFactory` objects) for use when the `CDynLinkLibrary` object is created. You should check the return value of `AfxInitExtensionModule`; if a zero value is returned from `AfxInitExtensionModule`, return zero from your `DllMain` function. -If your MFC extension DLL will be explicitly linked to an executable (meaning the executable calls `AfxLoadLibrary` to link to the DLL), you should add a call to `AfxTermExtensionModule` on `DLL_PROCESS_DETACH`. This function allows MFC to clean up the MFC extension DLL when each process detaches from the MFC extension DLL (which happens when the process exits or when the DLL is unloaded as a result of a `AfxFreeLibrary` call). If your MFC extension DLL will be linked implicitly to the application, the call to `AfxTermExtensionModule` is not necessary. +If your MFC extension DLL is explicitly linked to an executable (meaning the executable calls `AfxLoadLibrary` to link to the DLL), you should add a call to `AfxTermExtensionModule` on `DLL_PROCESS_DETACH`. This function allows MFC to clean up the MFC extension DLL when each process detaches from the MFC extension DLL (which happens when the process exits or when the DLL is unloaded as a result of a `AfxFreeLibrary` call). If your MFC extension DLL is linked implicitly to the application, the call to `AfxTermExtensionModule` isn't necessary. -Applications that explicitly link to MFC extension DLLs must call `AfxTermExtensionModule` when freeing the DLL. They should also use `AfxLoadLibrary` and `AfxFreeLibrary` (instead of the Win32 functions `LoadLibrary` and `FreeLibrary`) if the application uses multiple threads. Using `AfxLoadLibrary` and `AfxFreeLibrary` ensures that the startup and shutdown code that executes when the MFC extension DLL is loaded and unloaded does not corrupt the global MFC state. +Applications that explicitly link to MFC extension DLLs must call `AfxTermExtensionModule` when freeing the DLL. They should also use `AfxLoadLibrary` and `AfxFreeLibrary` (instead of the Win32 functions `LoadLibrary` and `FreeLibrary`) if the application uses multiple threads. Using `AfxLoadLibrary` and `AfxFreeLibrary` ensures that the startup and shutdown code that executes when the MFC extension DLL is loaded and unloaded doesn't corrupt the global MFC state. Because the MFCx0.dll is fully initialized by the time `DllMain` is called, you can allocate memory and call MFC functions within `DllMain` (unlike the 16-bit version of MFC). -Extension DLLs can take care of multithreading by handling the `DLL_THREAD_ATTACH` and `DLL_THREAD_DETACH` cases in the `DllMain` function. These cases are passed to `DllMain` when threads attach and detach from the DLL. Calling [TlsAlloc](/windows/win32/api/processthreadsapi/nf-processthreadsapi-tlsalloc) when a DLL is attaching allows the DLL to maintain thread local storage (TLS) indexes for every thread attached to the DLL. +Extension DLLs can take care of multithreading by handling the `DLL_THREAD_ATTACH` and `DLL_THREAD_DETACH` cases in the `DllMain` function. These cases are passed to `DllMain` when threads attach and detach from the DLL. Calling [`TlsAlloc`](/windows/win32/api/processthreadsapi/nf-processthreadsapi-tlsalloc) when a DLL is attaching allows the DLL to maintain thread local storage (TLS) indexes for every thread attached to the DLL. -Note that the header file Afxdllx.h contains special definitions for structures used in MFC extension DLLs, such as the definition for `AFX_EXTENSION_MODULE` and `CDynLinkLibrary`. You should include this header file in your MFC extension DLL. +The header file `Afxdllx.h` contains special definitions for structures used in MFC extension DLLs, such as the definition for `AFX_EXTENSION_MODULE` and `CDynLinkLibrary`. You should include this header file in your MFC extension DLL. > [!NOTE] -> It is important that you neither define nor undefine any of the `_AFX_NO_XXX` macros in *pch.h* (*stdafx.h* in Visual Studio 2017 and earlier). These macros exist only for the purpose of checking whether a particular target platform supports that feature or not. You can write your program to check these macros (for example, `#ifndef _AFX_NO_OLE_SUPPORT`), but your program should never define or undefine these macros. +> It's important that you don't define or undefine any of the `_AFX_NO_XXX` macros in `pch.h` (`stdafx.h` in Visual Studio 2017 and earlier). These macros exist only to check whether a particular target platform supports that feature or not. You can write your program to check these macros (for example, `#ifndef _AFX_NO_OLE_SUPPORT`), but your program should never define or undefine these macros. -A sample initialization function that handles multithreading is included in [Using Thread Local Storage in a Dynamic-Link Library](/windows/win32/Dlls/using-thread-local-storage-in-a-dynamic-link-library) in the Windows SDK. Note that the sample contains an entry-point function called `LibMain`, but you should name this function `DllMain` so that it works with the MFC and C run-time libraries. +A sample initialization function that handles multithreading is included in [Using Thread Local Storage in a Dynamic-Link Library](/windows/win32/Dlls/using-thread-local-storage-in-a-dynamic-link-library) in the Windows SDK. Note that the sample contains an entry-point function called `LibMain`, but you should name this function `DllMain` so that it works with the MFC and C runtime libraries. ## See also -[Create C/C++ DLLs in Visual Studio](dlls-in-visual-cpp.md)
-[DllMain entry point](/windows/win32/Dlls/dllmain)
+[Create C/C++ DLLs in Visual Studio](dlls-in-visual-cpp.md)\ +[DllMain entry point](/windows/win32/Dlls/dllmain)\ [Dynamic-link Library Best Practices](/windows/win32/Dlls/dynamic-link-library-best-practices) diff --git a/docs/build/sample-profile-guided-optimization.md b/docs/build/sample-profile-guided-optimization.md new file mode 100644 index 00000000000..9a9b7babe60 --- /dev/null +++ b/docs/build/sample-profile-guided-optimization.md @@ -0,0 +1,715 @@ +--- +description: "Learn how to use Sample Profile-Guided Optimization (SPGO) to improve the performance of C and C++ applications." +title: "Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve C++ performance" +ms.date: 05/20/2026 +ms.topic: tutorial +ai-usage: ai-assisted +helpviewer_keywords: ["SPGO", "sample profile-guided optimization", "profiling, SPGO", "SPDConvert", "SPTAggregate"] +--- +# Use Sample Profile Guided Optimization (SPGO) to improve C++ performance + +Profile-Guided Optimization (PGO) uses runtime data to help the compiler make better optimization decisions. By using execution profile data collected from representative workloads, PGO enables the compiler to make smarter decisions about inlining, code layout, and hot/cold code separation. These decisions are impossible to make from static analysis alone. + +SPGO takes a different approach. Instead of instrumenting your binary and running it through synthetic training scenarios, SPGO uses hardware performance counter sampling collected from your actual release binaries. Modern processors provide hardware sampling capabilities. You can collect these samples with negligible runtime overhead, making it practical to gather runtime profiles directly from production code. + +Because SPGO profiles release bits instead of instrumented builds, it enables much more flexibility in where and how you collect data. You can gather runtime profiles from production servers, developer machines, performance labs, or any combination. The result is a binary that runs hot paths more efficiently, with a typical performance speedup of 5-15% depending on the quality of the profile data. + +For more information about Sample Profile‑Guided Optimization (PGO) in MSVC and how it improves performance using sampling‑based profiling, see [Introducing Sample Profile Guided Optimization in MSVC](https://devblogs.microsoft.com/cppblog/introducing-sample-profile-guided-optimization-in-msvc/) + +In this tutorial, you walk through the complete SPGO workflow: build a sample app, profile it by using `xperf`, prepare the profile data, and rebuild with the profile data. When you finish, you can apply the same process to your own projects. + +## Prerequisites + +Before you start, make sure you have the following software and hardware. + +### Software + +- **MSVC build tools for x64/x86/ARM64 v14.51 or later**—Install them through the Visual Studio Installer. Under **Individual Components**, search for "MSVC build tools." +- **Windows Performance Toolkit (xperf.exe)**—The `xperf` profiler collects sample data during your program's execution. Download the Windows Assessment and Deployment Kit (ADK) from [ADK install](/windows-hardware/get-started/adk-install). When you run the ADK installer, select the **Windows Performance Toolkit** component to get `xperf`. You don't need to install the full ADK. +- **War and Peace text file**—Used as the sample workload to generate profiling data. Download it from Project Gutenberg: [https://www.gutenberg.org/ebooks/2600](https://www.gutenberg.org/ebooks/2600). Save it as a plain text file in your working directory. + +### Hardware requirements + +The tutorial has three profiling paths. Which path you use depends on your hardware. You run detection commands in [Choose your profiling method](#choose-your-profiling-method) to find out which path your machine supports. For now, use this table to confirm you meet at least one of the requirements. + +| Path | CPU requirement | Notes | +|------|----------------|-------| +| **LBR** (best results) | Last Branch Records (LBR) are performance counters provided on Intel Haswell CPUs (4th gen Core, 2013) or later; AMD Zen 4 (2022) or later, ARM64 ARMv9.2-A (2020) or later | Provides the best branch data. For more information about LBR, see [An introduction to last branch records](https://lwn.net/Articles/680985/) | +| **PMC/IP mode** (good results) | Performance Monitoring Counters (PMC) are supported on any x64 CPU with a performance monitoring unit (PMU) | Works on most modern CPUs where LBR is unavailable. For more information about PMC, see [Recording Hardware Performance (PMU) Events](/windows-hardware/test/wpt/recording-pmu-events) and [Recording Hardware Performance (PMU) Events with Complete Examples](https://devblogs.microsoft.com/performance-diagnostics/recording-hardware-performance-pmu-events-with-complete-examples/#configuring-extended-pmu-counter-configurations5) | +| **OS timer** (works everywhere) | Any x64 or ARM64 CPU, including Azure VMs and virtual machines | Lower-fidelity samples, but always available | + +Most developers on modern x64 desktop hardware have LBR support. VMs and some older hardware have PMC or an OS timer. + +## How SPGO works + +SPGO collects profile data from your running binary and feeds it back to the compiler when you next build. The compiler uses that data to make better decisions about inlining, code layout, and branch prediction. A convenience is that no instrumentation is required. + +The workflow is: + +1. Build your binary with the [/spgo](./reference/spgo-enable-sample-profile-guided-optimization.md) linker flag. This step creates an empty **sample profile database** (`.spd` file). +1. Profile the binary by using `xperf` to produce an ETL trace file. +1. Convert the ETL to an **SPT** file by using [`SPTAggregate.exe`](sptaggregate.md), then convert the SPT to an **SPD** file by using [`SPDConvert.exe`](spdconvert.md). +1. Rebuild with the [/spdin](./reference/spdin-use-sample-profile-database.md) linker flag pointing to the populated sample profile database (SPD). The linker applies SPGO optimizations. + +The optimizer uses the SPD to answer questions like: which branches are taken most often? Which functions are called in hot loops? This process produces better code layout and inlining decisions than static analysis alone. + +SPGO works with both C and C++. The workflow and flags are identical for both languages. + +**Best candidates for SPGO:** Large, branch-filled C/C++ applications with tight inner loops. Gains scale with codebase size and branch complexity. The small sample in this tutorial shows around 7% improvement. Larger production codebases often see more improvement. + +## Build Process Comparison + +This section covers how SPGO fits into the build pipeline if you want to understand the mechanics. + +### Normal build process + +In a standard C/C++ release build: + +- **Inputs:** Source code files (`.cpp`, `.h`) and release-mode compiler flags (`/O2`, `/GL`, and so on). +- **Process:** The compiler applies standard optimizations such as inlining heuristics, branch prediction assumptions, and code layout decisions based on static analysis alone. It has no data about how the program actually behaves when it runs. +- **Output:** Executable (`.exe`), DLL files (`.dll`), debug information (`.pdb`). + +:::image type="content" source="media/normal-build-process.png" alt-text="Diagram of the normal release build process showing source code files and example compiler switch /GL as inputs flowing to a build step, which produces .exe, .dll, and .pdb outputs." lightbox="media/normal-build-process.png"::: + +Without runtime data, hot paths and cold paths receive similar treatment. + +### SPGO-enabled build process + +SPGO adds profiling data as a new input to the build pipeline: + +- **Inputs:** Source code, the `.spd` profile file (sample counts from a profiling run), release-mode compiler flags, `/link /spgo`, and `/spdin:` to specify an input SPD file (if not specified, defaults to a .spd using the binary name and located in the obj folder). +- **Process:** The linker reads the SPD alongside the intermediate code. It uses branch-frequency data to make better inlining, code layout, and branch-ordering decisions. Hot functions get laid out for fast access; cold code moves out of the critical path. +- **Output:** Optimized executable (`.exe`), optimized DLL files (`.dll`), debug information (`.pdb`), **and a new `.spd` file** for future profiling iterations. + +:::image type="content" source="media/sample-profile-guided-optimization-build-process.png" alt-text="Diagram of the SPGO-enabled build process showing source code and profile data files (.spd) as inputs to the build step with an additional linker switch /spgo. The build process outputs optimized .exe, .dll, debug information (.pdb), and new profile data files (.spd)." lightbox="media/sample-profile-guided-optimization-build-process.png"::: + +The key insight: SPGO moves optimization decisions from compiler and linker heuristics to data-driven choices based on real execution. + +### Key flags + +| Flag | Type | Purpose | +|------|------|---------| +| [`/spgo`](./reference/spgo-enable-sample-profile-guided-optimization.md) | Linker | Enables SPGO. Embeds SPGO metadata in the binary and creates an empty `.spd` output file unless `/spdin` is specified, in which case the specified `.spd` file is used as input. | +| [`/spdin:`](./reference/spdin-use-sample-profile-database.md) | Linker | Input SPD - provides profile data to the linker for optimization | +| [`/spd:`](./reference/spd-specify-sample-profile-database.md) | Linker | Output SPD path - specifies where the new SPD is written (optional; defaults to the same directory as the binary). Serves as the input SPD path if `/spdin` isn't specified. | +| [`/GL`](./reference/gl-whole-program-optimization.md) | Compiler | Whole-program optimization-required for SPGO to work across translation units | +| [`/O1`, `/O2` (Minimize Size, Maximize Speed)](./reference/o1-o2-minimize-size-maximize-speed.md) | Compiler | Optimize for speed; enables aggressive optimizations that SPGO can enhance | + +### How SPGO differs from PGO + +PGO (Profile-Guided Optimization) requires you to compile your binary with instrumentation flags (`/GENPROFILE`), run the slower instrumented binary to collect `.pgc` execution count files, then relink with `/USEPROFILE`. The compiler gets exact execution counts but you have to instrument the code first. For more information about this process, see [Profile-guided optimizations](profile-guided-optimizations.md). + +SPGO uses hardware CPU performance counters to collect statistical samples from your uninstrumented release binary. Run your existing binary, profile it by using `xperf`, convert the trace to an SPD file, and rebuild. There's no instrumented build and no slowdown during profiling. The compiler gets statistical sampling data instead of exact counts, which is less precise but easier to get and requires no code changes. It also allows profiling of system components or realtime components that are difficult to collect data for with an instrumented approach. You can also profile final/shipping binaries. + +This tutorial covers three profiling methods: LBR, PMC, and OS timer. You choose your method in [Choose your profiling method](#choose-your-profiling-method). For a detailed comparison of the normal build process versus the SPGO build process, including a flag reference table, see [Build Process Comparison](#build-process-comparison). + +## Configure `perfcore.ini` + +> **⚠️ Required:** Without this step, `xperf` doesn't provide the necessary profiling data. Complete this step before running `xperf`. + +The Windows Performance Toolkit (WPT) uses `perfcore.ini`, located if you installed the WPT in the default location at `C:\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\perfcore.ini`, to register the DLL providers it needs for SPGO. + +Open Windows Notepad as Administrator. Then open `perfcore.ini`. Find the DLL list section and add the following entries, one per line: + +``` +perf_lbr.dll +perf_spt.dll +perf_hv.dll +``` + +If `xperf.exe` isn't installed, see [General issues](#general-issues-all-paths) to install it. + +Save and close `perfcore.ini`. The DLL files already ship in the same directory as `xperf.exe` so you don't need to copy them anywhere. You're only registering them in `perfcore.ini`. Ensure that `xperf` is in your path. + +## Create the sample app + +The sample app for this tutorial is a C++ program that reads text from standard input and produces a line count, word count, total character count, a character frequency table, and elapsed time to process the file in milliseconds. It's written in C++, but SPGO also works with C. The workflow is identical for C projects. + +Create a file named `textCount.cpp` in your working directory and add the following source code: + +```cpp +// textCount.cpp : Text Statistics Counter +// Counts words, lines, and character frequencies from standard input +// Usage: textCount < file.txt + +#include +#include +#include +#include +#include + +int main() +{ + auto start = std::chrono::steady_clock::now(); + + std::map charFrequency; + int wordCount = 0; + int lineCount = 0; + int totalChars = 0; + + std::string line; + bool inWord = false; + + while (std::getline(std::cin, line)) + { + lineCount++; + + for (char c : line) + { + totalChars++; + unsigned char uc = static_cast(c); + charFrequency[uc]++; + + if (std::isspace(static_cast(c))) + { + inWord = false; + } + else + { + if (!inWord) + { + wordCount++; + inWord = true; + } + } + } + + inWord = false; + } + + std::cout << "\n=== TEXT STATISTICS ===" << std::endl; + std::cout << "Lines: " << lineCount << std::endl; + std::cout << "Words: " << wordCount << std::endl; + std::cout << "Total Characters: " << totalChars << std::endl; + + std::cout << "\n=== CHARACTER FREQUENCIES ===" << std::endl; + + std::cout << "\nLetters:" << std::endl; + for (unsigned char ch = 'a'; ch <= 'z'; ch++) + { + unsigned char upperCh = static_cast(std::toupper(ch)); + int count = charFrequency[ch] + charFrequency[upperCh]; + if (count > 0) + { + std::cout << static_cast(ch) << ": " << count << std::endl; + } + } + + std::cout << "\nDigits:" << std::endl; + for (unsigned char ch = '0'; ch <= '9'; ch++) + { + if (charFrequency[ch] > 0) + { + std::cout << static_cast(ch) << ": " << charFrequency[ch] << std::endl; + } + } + + std::cout << "\nSpecial Characters:" << std::endl; + for (const auto& pair : charFrequency) + { + unsigned char ch = pair.first; + if (!std::isalnum(ch)) + { + std::string displayChar; + switch (ch) + { + case ' ': displayChar = "[space]"; break; + case '\t': displayChar = "[tab]"; break; + case '\n': displayChar = "[newline]"; break; + case '\r': displayChar = "[return]"; break; + default: + if (ch >= 32 && ch < 127) + { + displayChar = std::string(1, static_cast(ch)); + } + else + { + displayChar = "[byte:" + std::to_string(static_cast(ch)) + "]"; + } + break; + } + std::cout << displayChar << ": " << pair.second << std::endl; + } + } + + auto end = std::chrono::steady_clock::now(); + + auto elapsed = std::chrono::duration(end - start); + std::cout << "Elapsed time: " << std::fixed; + std::cout.precision(3); + std::cout << elapsed.count() << " ms\n"; + + return 0; +} +``` + +## Build and run the sample to get a baseline + +Before applying SPGO, build `textCount` and run it against a large text file, such as *War and Peace* (you can download it from Project Gutenberg), to see how fast it runs. This step shows you the performance before you optimize it by using SPGO: + +**Build:** + +```cmd +cl /Zi /EHsc /GL /O2 textCount.cpp /link /debug +``` + +**Run:** + +```cmd +textCount.exe < warAndPeace.txt +``` + +You see output similar to: + +``` +=== TEXT STATISTICS === +Lines: 66041 +Words: 566333 +Total Characters: 3227531 + +=== CHARACTER FREQUENCIES === + +Letters: +a: 202719 +... + +Elapsed time: 512.000 ms +``` + +Record the `Elapsed time` value. You'll compare it to the SPGO-optimized time in [Measure the results](#measure-the-results). + +## Build textCount with /spgo + +Now build textCount with SPGO enabled. This step lays the groundwork to gather profiling data. + +```cmd +cl /Zi /EHsc /GL /O2 textCount.cpp /link /debug /spgo +``` + +When the build finishes, you see a message like: + +``` +SPD textCount.spd not found, compiling without profile guided optimizations +``` + +This message appears on the first `/spgo` build. The linker creates the SPD file but it's still empty, so it doesn't apply any SPGO optimizations yet. After you run the binary, collect profile data, and convert it to SPD, you won't see this message. + +**Flag explanations:** + +| Flag | Purpose | +|------|---------| +| `/Zi` | Generate complete debugging information. This is necessary for SPGO to map profiling samples to source code. | +| `/EHsc` | Enable C++ exception handling | +| `/GL` | Whole-program optimization — required for SPGO. Defers final optimization to link time, enabling cross-module inlining, code layout, and dead code elimination decisions. | +| `/O2` | Optimize for speed — enables aggressive inlining, loop optimization, dead code removal, and related transforms. | +| `/link /debug` | Pass `/debug` to the linker to generate debug information (`.pdb`), which xperf uses to map profiling samples to source code. | +| `/spgo` | SPGO linker flag—embeds SPGO metadata in the binary and creates an empty `textCount.spd` file alongside the executable. | + +> [!NOTE] +> `/spgo` is a linker flag. Pass it to the linker via `/link /spgo` in the `cl` command. + +The `/spgo` flag doesn't optimize the binary yet. It prepares it for profiling. The optimization happens in [Rebuild textCount with /spdin](#rebuild-textcount-with-spdin) after the SPD is populated with real runtime data. + +> [!NOTE] +> To write the SPD to a specific location, add the optional `/spd:` linker flag. For example: `/link /debug /spgo /spd:.\profiles\textCount.spd`. If you omit this flag, the SPD is created alongside the `.exe`. + +## Choose your profiling method + +SPGO supports three profiling methods. Which method you use depends on your hardware. + +### The three profiling methods + +| Method | Sample quality | Hardware requirement | Best for | +|--------|----------------|---------------------|----------| +| **LBR** (Last Branch Record) | Highest—records sequences of recently taken branches, giving the optimizer rich control-flow data per sample | Intel Haswell (2013) or later; AMD Zen 4 (2022) or later; ARM64 ARMv9.2-A (2020) or later | Most modern desktop hardware | +| **PMC / IP mode** (Performance Monitoring Counter/Instruction pointer mode) | Good. Captures instruction-pointer samples with call stacks using the CPU's Performance Monitoring Unit (PMU), collected through Event Tracing for Windows (ETW) | Any x64 or ARM64 CPU with a PMU | Hardware without LBR support | +| **OS timer** | Basic—timer-based samples | Any x64 or ARM64 CPU, VMs without PMU passthrough | VMs and older hardware | + +With PMC / IP mode, each hardware interrupt gives you just one data point: "the CPU was at address 0x1A2B3C4D when the interrupt fired". With LBR, each interrupt gives you a stack of the last 16–32 branches the CPU took before the interrupt fired. The optimizer gets better control-flow data and can make better inlining and layout decisions. + +### Detect your path + +Run the following two commands to determine which profiling path your machine supports. These commands don't require an elevated prompt. + +**Step 1: Check for LBR support. This test works on Intel/AMD/ARM64.** + +Run the following from an **administrator** Visual Studio developer command prompt: + +```cmd +xperf.exe -on PMC_PROFILE -pmcprofile TotalIssues -LastBranch PmcInterrupt -setProfInt TotalIssues 2560000 +xperf -stop -d lbrtest.etl +xperf -tle -i lbrtest.etl -a dumper | findstr "LBR, TimeStamp" +``` + +- If this command finds a line containing `LBR, TimeStamp`, then your machine supports LBR. **Use the LBR path.** +- Otherwise, continue to Step 2. + +**Step 2: Check for PMC support (no LBR)** + +```cmd +xperf.exe -pmcsources | findstr TotalIssues +``` + +- If this command produces output, then your machine supports PMC counters but not LBR. **Use the PMC path.** +- If this command produces no output, then **Use the OS timer path.** + +For more information about PMU event collection with xperf, see [Recording hardware PMU events with xperf](https://devblogs.microsoft.com/performance-diagnostics/recording-hardware-performance-pmu-events-with-complete-examples/#configuring-extended-pmu-counter-configurations5). + +### Decision table + +| `LBR, TimeStamp` output | `TotalIssues` output | Your path | +|---------------------|-----------------------------|-----------| +| Not empty | (not checked) | LBR | +| Empty | Not empty | PMC | +| Empty | Empty | OS timer | +| ARM64 processor | N/A | PMC (if PMU available) or OS timer | + +### Choose your approach + +Decide whether to use the LBR, PMC, or OS timer path based on the detection results. Each path has different `xperf` start parameters to collect the appropriate profiling data. Follow the path that matches your hardware capabilities. + +> **Your path:** +> - **LBR users** (LBR detected in Step 1): Go to [LBR path](#lbr-path). +> - **PMC users** (InstructionRetired detected in Step 2): Go to [PMC path (no LBR)](#pmc-path-no-lbr). +> - **OS timer users** (VM or hardware without PMU): Go to [OS timer path](#os-timer-path). +> +> All paths rejoin at [Run the workload and stop xperf](#run-the-workload-and-stop-xperf-all-paths). + +The commands in this section depend on the profiling path you identified in [Choose your profiling method](#choose-your-profiling-method). Find the subsection that matches your path, run the `xperf` start command, and then continue to [Run the workload and stop xperf](#run-the-workload-and-stop-xperf-all-paths) to run the workload and stop xperf. + +> **⚠️ Run as Administrator:** `xperf` requires an elevated (Administrator) developer command prompt. Without elevation, `xperf` returns `"failed to configure counters"`. + +### LBR path + +Start `xperf` with LBR collection: + +```cmd +xperf -on LOADER+PROC_THREAD+PMC_PROFILE -MinBuffers 4096 -MaxBuffers 4096 -BufferSize 4096 -pmcprofile BranchInstructionRetired -LastBranch PmcInterrupt -setProfInt BranchInstructionRetired 16384 +``` + +**Parameter explanation:** + +| Parameter | Purpose | +|-----------|---------| +| `LOADER+PROC_THREAD+PMC_PROFILE` | Kernel providers: loader events (module mapping), process/thread events (execution context), and PMC profiling events | +| `-MinBuffers 4096 -MaxBuffers 4096 -BufferSize 4096` | Large ring buffers to avoid dropped samples during a full War and Peace run | +| `-pmcprofile BranchInstructionRetired` | PMC event trigger: generate a sample on every Nth retired branch instruction | +| `-LastBranch PmcInterrupt` | Enables LBR hardware recording: on each PMC interrupt, capture the hardware last-branch record stack | +| `-setProfInt BranchInstructionRetired 16384` | Sample interval: fire an interrupt every 16,384 retired branch instructions | + +After starting xperf, continue to [Run the workload and stop xperf](#run-the-workload-and-stop-xperf-all-paths). + +### PMC path (no LBR) + +Start `xperf` with PMC / IP-mode collection: + +```cmd +xperf -on LOADER+PROC_THREAD+PMC_PROFILE+PROFILE -MinBuffers 4096 -BufferSize 4096 -pmcprofile InstructionRetired -setProfInt InstructionRetired 16384 -stackwalk profile +``` + +**Parameter explanation:** + +| Parameter | Purpose | +|-----------|---------| +| `LOADER+PROC_THREAD+PMC_PROFILE+PROFILE` | Adds `PROFILE` (CPU sampling) and `PMC_PROFILE` for PMC events; no `-LastBranch` | +| `-pmcprofile InstructionRetired` | PMC event trigger: sample on retired instructions (instruction pointer mode) | +| `-setProfInt InstructionRetired 16384` | Fire an interrupt every 16,384 retired instructions | +| `-stackwalk profile` | Capture a call stack on each profile interrupt, providing call-chain data instead of branch sequences | + +Compared to LBR: no `-LastBranch` flag; uses `InstructionRetired` instead of `BranchInstructionRetired`. The result is instruction-pointer samples with call stacks, not branch sequences. This path still provides effective data for the optimizer, but it's slightly less rich. + +After starting `xperf`, continue to [Run the workload and stop xperf](#run-the-workload-and-stop-xperf-all-paths). + +### OS timer path + +Start xperf with OS timer-based sampling: + +```cmd +xperf -on LOADER+PROC_THREAD+PROFILE -MinBuffers 4096 -BufferSize 4096 -setProfInt Timer 1221 -stackwalk profile +``` + +**Parameter explanation:** + +| Parameter | Purpose | +|-----------|---------| +| `LOADER+PROC_THREAD+PROFILE` | No PMC events; CPU sampling via OS timer interrupt only | +| `-setProfInt Timer 1221` | Fire on the OS timer interrupt every 1,221 timer ticks (approximately 1 kHz) | +| `-stackwalk profile` | Capture a call stack on each timer interrupt | + +Compared to LBR and PMC, this method doesn't use hardware performance counters. The OS timer fires at roughly fixed time intervals regardless of CPU activity. Samples are less densely correlated to hot code but still provide useful control-flow data for the optimizer. + +### Run the workload and stop xperf (all paths) + +With `xperf` running, run `textCount` against War and Peace: + +```cmd +textCount.exe < warAndPeace.txt +``` + +After `textCount` finishes, stop `xperf` and write the trace file. Letting other processes run during profiling dilutes sample quality. For best results, close unnecessary applications before running the workload. + +```cmd +xperf -stop -d textCount.etl +``` + +After stopping `xperf` (it can take a while to write out the etl file), confirm that `textCount.etl` was created in the current directory. + +## Convert the ETL file to SPT + +This step is the same for all three profiling paths. + +Run `SPTAggregate.exe` to process the raw ETL trace and create an SPT profile file: + +```cmd +SPTAggregate.exe /binary textCount.exe /etl textCount.etl textCount.spt +``` + +**Parameter explanation:** + +| Parameter | Purpose | +|-----------|---------| +| `/binary textCount.exe` | The binary to extract samples from. The ETL might contain samples from all processes that ran during profiling | +| `/etl textCount.etl` | Input ETL trace file | +| `textCount.spt` | Output SPT profile file | + +`SPTAggregate` outputs a summary that shows how many samples it collected. This summary is your first confirmation that profiling worked. + +Check the output from `SPTAggregate` against the path you took: + +- **LBR path:** Look for a nonzero Used LBR Samples count. +- **PMC path:** Look for a nonzero PMC or stack sample count. +- **OS timer path:** Look for a nonzero used stack samples count. + +If all counts are zero, see [Troubleshooting](#troubleshooting) before continuing. + +## Convert the SPT file to SPD + +> **Your path:** +> - **LBR users** (use `/mode:LBR`): [LBR mode](#lbr-mode) +> - **PMC users** (use `/mode:IP`): [IP mode (PMC and OS timer)](#ip-mode-pmc-and-os-timer) +> - **OS timer users** (use `/mode:IP`): [IP mode (PMC and OS timer)](#ip-mode-pmc-and-os-timer) +> +> Both PMC and OS timer paths use `/mode:IP` because both produce instruction-pointer samples. + +The next step branches by profiling path, specifically on the `/mode` flag passed to `SPDConvert.exe`. + +### LBR mode + +```cmd +SPDConvert.exe /mode:LBR textCount.spd textCount.spt +``` + +`/mode:LBR` tells `SPDConvert` to interpret the SPT as containing LBR branch sequence data. + +### IP mode (PMC and OS timer) + +Both PMC and OS timer produce instruction-pointer samples, so both use the same conversion command: + +```cmd +SPDConvert.exe /mode:IP textCount.spd textCount.spt +``` + +`/mode:IP` tells `SPDConvert` to interpret the SPT as containing instruction-pointer samples. + +> [!WARNING] +> Using the wrong mode for your data type can produce an empty or malformed SPD. If you profiled with LBR, use `/mode:LBR`. +> If you profiled with PMC or OS timer, use `/mode:IP`. The `SPTAggregate` summary output from [Convert the ETL file to SPT](#convert-the-etl-file-to-spt) shows which sample types were collected and confirms the correct mode to use. + +After running `SPDConvert`, confirm that `textCount.spd` was created (or updated) in the current directory. + +### Interpreting SPDConvert output + +The command `SPDConvert textCount.spd textCount.spt` prints a before-and-after block coverage summary, for example: + +``` +Block coverage (before) : 33.90% ( 4507/ 13294) +Block coverage (after) : 45.64% ( 6067/ 13294) +``` + +This summary shows the percentage of the binary's code blocks that have associated profile data. A higher percentage is better. Coverage above 70% is excellent, while coverage below 40% might limit optimization effectiveness. If coverage is low, run the profiling workload longer or combine multiple SPT files from separate runs with different workloads. For example, you could run `textCount` against multiple text files to exercise different code paths. + +You might see a warning from `SPDConvert` like the following: + +``` +Compiler may be conservative on some hot functions due to sparse sample coverage. +SPGO is estimated to optimize better if sample density is increased to 5.4x of current level. +Sample density can be increased by sampling for longer period, or increasing sample rate. +``` + +This warning means your profiling run didn't collect enough samples for the optimizer to confidently optimize all hot functions. The SPD is still usable, but you can improve results by: + +- Running the workload longer (for example, 5 or more minutes instead of 1 minute) or using different workloads. +- Lowering the `-setProfInt` value in the `xperf` command to increase the sampling rate. The tradeoff is that this change produces a larger ETL file, which takes longer to process. +- Combining multiple SPT files from separate profiling runs by passing them all to `SPDConvert`. + +The SPT file is a binary format. To inspect its contents, you can run `SPTDump.exe textCount.spt`. Similarly, `PTDump.exe textCount.spt` shows the compiled profile data after running `SPDConvert`. Both tools are useful for verifying nonzero samples before proceeding. + +## Rebuild textCount with /spdin + +Rebuild `textCount` by using the populated SPD file. The linker reads the profile data and applies SPGO optimizations. + +This step is the same for all three profiling paths. + +```cmd +cl /Zi /EHsc /GL /O2 textCount.cpp /link /debug /spgo /spdin:textCount.spd +``` + +**New flag (compared to [Build textCount with /spgo](#build-textcount-with-spgo)):** + +| Flag | Purpose | +|------|---------| +| `/spdin:textCount.spd` | Provide the SPD profile data to the linker for optimization | + +The command still includes `/spgo`. It generates a new SPD file alongside the optimized binary, which you can use as the starting point for subsequent profiling iterations. + +> [!WARNING] +> The SPD file is associated with the exact binary it profiles against. If you rebuild `textCount` without `/spdin`, or rebuild from changed source, you must generate a new SPD file. The existing one doesn't match the new binary's GUID, and the linker won't use it. + +After the rebuild with `/spdin`, the linker outputs statistics about how much of your code was optimized using profile data. For example: + +``` +221 of 221 (100.00%) profiled functions will be compiled for speed +201 of 1383 inline instances were from dead/cold paths +474 of 474 profiled functions (100.0%) were optimized using profile data +202738780 of 202738780 instructions (100.0%) were optimized using profile data +``` + +A high percentage means the SPD covers your binary well. If the percentage is low (for example, below 90%), either the profiling workload didn't exercise enough of the binary, or the binary has changed significantly since the profile was collected. In both cases, reprofile against the current binary. + +### What SPGO does with your profile data + +SPGO uses the collected sample data to populate counts on each block and edge in the program's control flow graph. These counts drive optimizations such as: +- **Profile-guided inlining**: Aggressively inline hot call sites while avoiding code bloat from inlining cold paths. +- **Hot/cold code separation**: Move rarely executed code to separate sections of the binary, improving instruction cache utilization and paging behavior. +- **Function layout**: Place functions that call each other frequently near each other in the binary, reducing page faults and improving locality. Optimized functions are organized into high affinity COFF groups in the binary. +- **Size/speed decisions**: Compile hot functions for speed and cold functions for size. Routines with no observed profile hits might be compiled for size rather than speed, limiting optimizations like inlining and loop unrolling in those cold paths. +- **Speculative devirtualization**: When sampling reveals that an indirect call consistently targets the same function, SPGO can speculate on that target and inline it, with a fallback for the uncommon case. + +## Measure the results + +Run `textCount` again and compare elapsed times. + +```cmd +textCount.exe < warAndPeace.txt +``` + +Collect multiple runs for each configuration and use the median. A single run isn't reliable because OS scheduling and system noise can skew individual measurements. + +| Build | Representative elapsed time | +|-------|-----------------------------| +| Baseline (`cl /Zi /EHsc /O2 /link /debug`) | *(your measurement)* | +| `/spgo` build (no profile data yet) | *(should be close to baseline)* | +| SPGO-optimized (`/spdin`) | *(should show improvement)* | + +In one test, SPGO using the LBR method delivered approximately 7% reduction in elapsed time. Your results might vary with your own projects because SPGO gains depend on how well the profiling workload represents typical execution. Larger, branch filled codebases tend to see more improvement within the 5–10% range. The profiling method affects optimization quality. LBR typically produces better results than PMC, which produces better results than OS timer. If you're on the OS timer path, expect smaller gains. + +The LBR path followed in this tutorial was applied to the [SQLite](https://github.com/sqlite/sqlite) project, which is a production database library. The SPGO-optimized SQLite binary showed approximately a 7% improvement. + +## Apply SPGO to your own project + +Use this checklist to apply SPGO to your own C or C++ application. + +1. **Add `/Zi /link /debug /spgo` to your existing release build command.** Modify your build script or project file: + + ```cmd + cl /Zi /EHsc /GL /O2 myapp.cpp /link /debug /spgo + ``` + +1. **Choose a representative workload.** Select a real usage scenario that exercises the hot paths of your application. Use production-like data. Avoid the following as your primary profiling workload: code coverage tests (they don't stress performance bottlenecks), uncommon error paths, startup and shutdown phases, and deprecated code paths. This workload drives the profile that feeds the optimizer. +1. **Run xperf using your detected path.** Use the path you identified in [Choose your profiling method](#choose-your-profiling-method) (LBR, PMC, or OS timer). Start `xperf`, run the workload once, stop `xperf`, and capture the ETL file. +1. For the PMC or OS timer path, **run SPTAggregate and SPDConvert with the correct `/mode` flag.** Convert ETL to SPT then to SPD. Use `/mode:LBR` for LBR data; use `/mode:IP` for PMC or OS timer data. +1. **Rebuild with `/spdin:`.** Compile your application with the populated SPD: + + ```cmd + cl /Zi /EHsc /GL /O2 yourApp.cpp /link /debug /spgo /spdin:yourApp.spd + ``` + +1. **Measure before and after.** Run your workload with both the nonoptimized and SPGO-optimized binaries. Collect the **median of multiple runs** for each configuration. A single run isn't reliable for benchmarking. +1. **Store the `.spd` file in source control.** Check the `.spd` file into your source control system alongside your source code. +1. **Enable SPGO in developer Release builds.** Have your team's Release builds use the same SPGO-optimized binaries as production. This helps catch performance regressions early. +1. Disable SPGO in Debug builds. +1. **Watch the linker's profile completeness statistics.** After each build with `/spgo`, note the percentage of profiled functions optimized using profile data. If this drops significantly (below 90%), reprofile the current binary. Code changes accumulate and the SPD can become stale. + +### Alternative to using `xperf` + +Another way to gather profile data is to use a sampling profiler like Windows Performance Recorder (WPR). WPR is installed by default on Windows 10 and later. It collects similar data to `xperf`. You can configure WPR to collect CPU samples with call stacks, and then export the data to an ETL file that you can process with `SPTAggregate` and `SPDConvert` like the `xperf` ETL. Here's an example of using WPR to collect profile data: + +```cmd +wpr -start CPU.light -filemode +textCount.exe < warAndPeace.txt +wpr -stop spgo_data.etl +``` +For more information on using WPR, see [Using Windows Performance Recorder](/windows-hardware/test/wpt/recording-pmu-events). + +### SPD distribution + +You can: + +- Check the `.spd` file directly into source control alongside your source code. +- Share the `.spd` file with teammates so they can build with SPGO optimizations without reprofiling. +- Package the `.spd` file with your binaries as a versioned artifact (for example, a NuGet package) and record which version corresponds to which binary. +- Regenerate the `.spd` file at any time by repeating the profiling workflow. + +The SPD ties to the exact binary it was built from. After significant code changes, reprofile to generate a fresh SPD. During the `/spdin` build, the compiler also produces a new `.spd` file. Save this new SPD as a build artifact - it's the starting point for your next profiling iteration. + +## Reusing SPD information across builds + +The "carry forward" concept in SPGO allows you to add profiling data to an existing SPD file without profiling all your scenarios over again from scratch and without losing existing profile information. You can also adjust how much weight to give to older profile data. This flexibility is useful when there might be behavioral changes over time and you don't want to completely lose the profiling information from earlier scenario runs. For instance, a DLL might see different APIs called as the application that calls it evolves. You still want the optimizations from how it used to behave, but want to mix in optimization opportunities for how it sometimes behaves differently now. You can evolve the profile over time by mixing old and new data. + +When you run `SPDConvert` with a new SPT file, pass the name of the existing SPD file. Then use the `/retire:N` option to control how aggressively `SPDConvert` de-emphasizes older profile data when you add new SPT files: +- The default (`/retire:8`) weights newer data more heavily. +- Use `/retire:0` to give equal weight to all runs. +- Use `/retire:16` to let only the newest data count. + +## Troubleshooting + +> **Find your issue:** +> - **LBR path problems:** [LBR path problems](#lbr-path-problems) +> - **PMC path problems:** [PMC path problems](#pmc-path-problems) +> - **OS timer problems:** [OS timer path problems](#os-timer-path-problems) +> - **Issues affecting all paths:** [General issues](#general-issues-all-paths) + +### LBR path problems + +| Problem | Likely cause | Fix | +|---------|-------------|-----| +| Zero LBR samples in `SPTAggregate` output | CPU doesn't support LBR, or VM doesn't expose LBR | Run the detection command from [Detect your path](#detect-your-path). If in a Hyper-V VM, run `Set-VMProcessor MyVMName -Perfmon @("pmu", "lbr")` on the host. If LBR isn't available, switch to the PMC or OS timer path. | +| Processor supports LBR but `SPTAggregate` shows 0 LBR samples | `perfcore.ini` DLL registration incomplete | Complete the `perfcore.ini` setup in [Configure perfcore.ini](#configure-perfcoreini). Ensure `perf_lbr.dll` is registered. | +| `SPDConvert` fails or produces an empty SPD | Wrong `/mode` flag, or SPT contains only IP-mode samples | Confirm `SPTAggregate` output showed LBR samples. If the output shows only IP-mode samples, switch to `/mode:IP`. | + +### PMC path problems + +| Problem | Likely cause | Fix | +|---------|-------------|-----| +| Zero PMC samples in `SPTAggregate` output | `perfcore.ini` DLL registration incorrect | Complete the `perfcore.ini` setup in [Configure perfcore.ini](#configure-perfcoreini). Ensure `perf_spt.dll` is registered. Without this DLL, `xperf` produces zero PMC samples without an error message.
Run `xperf.exe -pmcsources` to see the list of Performance Counters sources available on your CPU. If you don't see entries like `SPT_OP_RETIRE_INSTR` or `SPT_OP_RETIRE_BR_INSTR` or `SPT_OP_ETW_INSTR`, then the DLL registration in `perfcore.ini` might be incomplete or your CPU might not support PMC. If you can't resolve the DLL registration, try the OS timer path, instead. | +| `findstr InstructionRetired` returns output but `xperf` produces no samples | VM masking PMC counters | Check if running in a VM. Enable PMU in Hyper-V with `Set-VMProcessor`, or switch to the OS timer path. | +| `SPDConvert` fails on PMC path | Using `/mode:LBR` on an IP-only SPT | Switch to `/mode:IP`. | + +### OS timer path problems + +| Problem | Likely cause | Fix | +|---------|-------------|-----| +| Less improvement than expected | Expected - OS timer is lower fidelity | This is normal. The optimizer has less branch-flow information from timer samples than from LBR or PMC. Performance gains are smaller. Consider upgrading to PMC or LBR if hardware supports it. | +| Zero timer samples | `xperf` wasn't run in an elevated prompt, or `PROFILE` provider missing | Confirm running as Administrator. Confirm `-stackwalk profile` was provided to the `xperf` command. | + +### General issues (all paths) + +| Problem | Likely cause | Fix | +|---------|-------------|-----| +| `"failed to configure counters"` error | `xperf` not running as administrator | Restart the command prompt as **Administrator** (right-click > Run as administrator). xperf requires elevated privileges to configure hardware performance counters. | +| `xperf` not found | `xperf.exe` not on PATH | Confirm the Windows ADK is installed. Check `C:\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\`. Add that directory to your PATH, or run xperf from it directly. | +| `textCount.etl` not created | xperf failed silently | Confirm running as administrator. Rerun the xperf start command and check for error output. | +| `SPTAggregate` fails with "binary not found" | `textCount.exe` not in current directory or wrong path | Confirm you're in the same directory as `textCount.exe`, or provide the full path to the `/binary` parameter. | +| SPD file not created | `SPDConvert` failed | Check that `textCount.spt` size is nonzero. Run `SPTDump.exe textCount.spt` to inspect its contents. | +| `/spdin` build produces no improvement | GUID/age mismatch between SPD and binary | The SPD was built from a different `textCount.exe`. Profile the current build again to generate a fresh SPD. | +| MSVC version error on `/spgo` | MSVC toolset earlier than v14.51 | Open the Visual Studio Installer > **Individual Components** > install **MSVC v14.51** or later. Reopen the Developer Command Prompt. | + +## Next steps + +After completing this tutorial, explore these capabilities to get more from SPGO: + +- **Profile blending:** Run multiple workloads, accumulate SPT files from each run, and pass all of them to `SPDConvert`. A blended SPD reflects the full range of real usage patterns and produces better optimizations than a single-scenario profile. Use the `/retire:N` option to control how aggressively `SPDConvert` de-emphasizes older profile data when you add new SPT files. The default (`/retire:8`) weights newer data more heavily. Use `/retire:0` to give equal weight to all runs; use `/retire:16` to let only the newest data count. +- The best results come from blending profiles from multiple sources such as benchmarks that stress key scenarios plus real-world data (where available). Pass SPT files from all sources to `SPDConvert`. Repeat an SPT file in the argument list to give it more weight (for example, `SPDConvert myapp.spd critical.spt critical.spt common.spt` weights `critical.spt` twice as heavily as `common.spt`). +- **Iterative optimization:** Each rebuild with `/spdin` produces a new SPD. You can repeat the run, profile, rebuild cycle. Later iterations might show diminishing returns, but a second pass can sometimes capture patterns the first missed. +- **Code changes:** After significant source changes, recollect profile data. The existing SPD is tied to the binary it was profiled against. It won't match a substantially rebuilt binary. +- **Profile freshness:** The linker reports the percentage of profiled functions optimized using profile data after each `/spdin` build. If this percentage drops significantly, it's a signal that the code has diverged from the profile. Reprofile the current binary. \ No newline at end of file diff --git a/docs/build/spdconvert.md b/docs/build/spdconvert.md new file mode 100644 index 00000000000..e886c1e1846 --- /dev/null +++ b/docs/build/spdconvert.md @@ -0,0 +1,119 @@ +--- +description: "Learn more about: SPDConvert" +title: "SPDConvert" +ms.date: 05/08/2026 +ai-usage: ai-assisted +helpviewer_keywords: ["SPDConvert program", "sample profile-guided optimizations, SPDConvert", "SPGO"] +--- +# SPDConvert + +Use `SPDConvert` to prepare and manage sample profile data for Sample Profile-Guided Optimization (SPGO). + +This tool correlates the raw hardware samples in SPT files against the code structure in the SPD. This step performs sample correlation, flow smoothing, and size/speed decisions, and produces an enriched SPD file with execution counts annotated on the flow graph. + +You can combine data from multiple sources such as lab benchmarks, internal monitoring, and production telemetry, in a single conversion. To emphasize the importance of a particular scenario, you can specify its SPT file multiple times. Listing a critical benchmark SPT three times effectively triples its weight. + +This tool operates in three modes: + +- *import* .SPT data into an .SPD file for [/SPGO](sample-profile-guided-optimization.md) builds +- *extract* an embedded .SPD file from a .PDB +- *merge* multiple .SPD files from separate profiling runs + +`SPDConvert` works with three file types: +- **ETL** (Event Trace Log) Raw hardware performance events recorded by `xperf` +- **SPT** (Sample Profile Trace) Packaged sample events produced by [`SPTAggregate`](sptaggregate.md) from ETL files +- **SPD** (Sample Profile Database) Processed profile data used by the compiler during an optimized build. You can also embed SPD files in PDB symbol files during a `/spdembed` build + +## Syntax + +Import SPT data into an existing SPD file: + +> `SPDConvert` [*options*] *spdfile* *sptfile(s)* + +Extract an embedded SPD file from a PDB: + +> `SPDConvert` **/extract** *pdbfile* *spdfile* + +Merge multiple SPD files into one: + +> `SPDConvert` **/merge** *outputspdfile* *spdfile(s)* + +### Parameters + +**IMPORT MODE** + +*options*\ +Specify the following options in import mode: + +- **/mode:**\<**IP**\|**LBR**\> Select the profile mode. Use **IP** for instruction pointer profile data (default) or **LBR** for last branch record profile data. +- **/reset:** Reset the count to 0. This action ignores SPTs. Use this option to reset an SPD file before importing new data, or to create an empty SPD file if the specified file doesn't exist. +- **/sptlist:**\<*file*\> Specify SPT file names in a text file, with one file name per line. +- **/summary** Print a summary of the SPD file. +- **/help** Display help information. + +*spdfile*\ +The SPD file to import sample data into. + +*sptfiles*\ +One or more SPT files to import. SPT files are produced by [SPTAggregate](sptaggregate.md). + +**EXTRACT MODE (/extract)** + +*pdbfile*\ +The PDB file that contains an embedded SPD. + +*spdfile*\ +The output SPD file to create. + +**MERGE MODE (/merge)** + +*outputspdfile*\ +The output SPD file to create. + +**/retire:**\<*N*\> Set the profile data retire rate to *N*/16, where 0 ≤ *N* ≤ 16. The default is 8. This value controls how much of the existing data in an SPD to delete when adding new SPT data. For example, `/retire:8` deletes 8/16 (half) of the existing data before adding new SPT data. This setting weights newer profile data more heavily because it discards half of the older data. The two most common usages are `/retire:0` which gives equal weight to all profile runs, or `/retire:16` to make only the newest data count because it deletes all the old data. Use `/retire:N` to control how aggressively `SPDConvert` de-emphasizes older profile data. This "carry forward" concept allows you to refresh a profile using existing SPD data without starting over with new profiling data, which is time-consuming. This concept is discussed more in the [SPGO tutorial - Reusing SPD information across builds](sample-profile-guided-optimization.md#reusing-spd-information-across-builds). + +*spdfiles*\ +One or more SPD files to merge. + +## Remarks + +> [!NOTE] +> Run this tool from a Visual Studio developer command prompt. + +`SPDConvert` is the main conversion tool in the SPGO workflow. After collecting a trace by using `xperf` and converting it to an SPT file by using [`SPTAggregate`](sptaggregate.md), use `SPDConvert` to import the sample data into an SPD file. Pass the resulting SPD file to the compiler by using the [`/SPGO`](sample-profile-guided-optimization.md) flag to build an optimized binary. + +Use `/extract` to recover an SPD file that was embedded in a PDB during a `/SPGO` build. +Use `/merge` to combine SPD files from multiple profiling sessions before rebuilding. + +The GUID and age of a binary must match between the SPT and SPD files. If they don't match, `SPDConvert` reports an "SPD version incompatible" error. Use [`SPTDump /progid`](sptdump.md) to check the binary identifiers in the SPT file, and [`SPDDump /header`](spddump.md) to check the SPD file. + +The GUID and age of the binary recorded in the SPD file must match the SPT file. To diagnose this error, use [`SPTDump /progid`](sptdump.md) to inspect the binary identifiers in the SPT file, and [`SPDDump /header`](spddump.md) to inspect the SPD file. A valid SPD file is used to the extent possible. Minor updates to the code that don't alter the program's control flow are tolerated. Unchanged functions also use the data for optimization. If you provide a valid, but otherwise unrelated SPD, the process works, but likely no data is usable for optimization. + +## Example + +This example imports LBR profile data from an SPT file into an SPD file: + +`SPDConvert /mode:LBR sample.spd sample.spt` + +This example imports IP profile data by using a list of SPT files: + +`SPDConvert /mode:IP /sptlist:mysptfiles.txt sample.spd` + +This example prints a summary of the profile data in an SPD file: + +`SPDConvert /summary sample.spd` + +This example extracts the embedded SPD from a PDB file: + +`SPDConvert /extract sample.pdb sample_extracted.spd` + +This example merges two SPD files from different profiling runs: + +`SPDConvert /merge combined.spd run1.spd run2.spd` + +## See also + +[Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](sample-profile-guided-optimization.md)\ +[`SPDDump`](spddump.md)\ +[`SPTAggregate`](sptaggregate.md)\ +[`SPTDump`](sptdump.md) diff --git a/docs/build/spddump.md b/docs/build/spddump.md new file mode 100644 index 00000000000..f3cfdade2b3 --- /dev/null +++ b/docs/build/spddump.md @@ -0,0 +1,68 @@ +--- +description: "Learn more about: SPDDump" +title: "SPDDump" +ms.date: 04/30/2026 +ai-usage: ai-assisted +helpviewer_keywords: ["SPDDump program", "sample profile-guided optimizations, SPDDump", "SPGO"] +--- +# SPDDump + +Use `SPDDump` to inspect Sample Profile Database (SPD) files and object files that contain sample profile data for Sample Profile-Guided Optimization (SPGO). Use this tool to verify SPD contents, troubleshoot SPD/PDB compatibility problems, and view profile details such as functions, flow graphs, coverage, and dynamic instruction estimates. Run `SPDDump` from a Visual Studio Developer Command Prompt. + +An SPD file contains processed profile data that the compiler uses to make optimization decisions during a build. + +## Syntax + +> `SPDDump` [*options*] *spdfile* + +### Parameters + +*options*\ +Specify the following options for `SPDDump`: + +- **/all** Output the entire SPD file. This option is the default. +- **/header** Output the SPD file header. +- **/module** Output the module header in the SPD file. Implies **/header**. +- **/symbol** Output the module symbol table. Implies **/module**. +- **/func** Output the function profile. Implies **/module**. +- **/funcid:**\<*fid*\> Output the function profile for the function with the given function ID. +- **/cg** Include callee information in function profile output. Implies **/func**. +- **/fg** Include the flow graph in function profile output. Implies **/func**. +- **/data** Output the data profile. Implies **/module**. +- **/minidump** Exclude sample correlation information such as RVA ranges from output. +- **/coverage** Output basic block coverage information. +- **/dyninst**[**:**\<*n*\>] Output a dynamic instruction estimate for the top 50 functions, or the top *n* functions if specified. +- **/help** Display help information. + +*spdfile*\ +The path to the SPD file or object file to inspect. + +## Remarks + +> [!NOTE] +> Run this tool from a Visual Studio developer command prompt. + +Use `SPDDump` to inspect the contents of a Sample Profile Database (SPD) file. [`SPDConvert`](spdconvert.md) produces SPD files. The build process that uses [`/SPGO`](sample-profile-guided-optimization.md) embeds these files in PDB files. + +To diagnose an "SPD version incompatible" error, use `/header` to examine the PDB GUID and age stored in the SPD file. Then, compare those values against the SPT file by using [`SPTDump /progid`](sptdump.md). + +## Example + +This example outputs estimated basic block coverage information for an SPD file: + +`SPDDump /coverage filename.spd` + +This example outputs the SPD header to check the PDB GUID and age: + +`SPDDump /header filename.spd` + +This example outputs a dynamic instruction estimate for the top 10 functions: + +`SPDDump /dyninst:10 filename.spd` + +## See also + +[Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](sample-profile-guided-optimization.md)\ +[SPDConvert](spdconvert.md)\ +[SPTDump](sptdump.md)\ +[SPTAggregate](sptaggregate.md) diff --git a/docs/build/sptaggregate.md b/docs/build/sptaggregate.md new file mode 100644 index 00000000000..1d5a67e8a6b --- /dev/null +++ b/docs/build/sptaggregate.md @@ -0,0 +1,69 @@ +--- +description: "Learn more about: SPTAggregate" +title: "SPTAggregate" +ms.date: 05/01/2026 +ai-usage: ai-assisted +helpviewer_keywords: ["SPTAggregate program", "sample profile-guided optimizations, SPTAggregate", "SPGO"] +--- +# SPTAggregate + +`SPTAggregate` is a command-line tool for Sample Profile-Guided Optimization (SPGO). Use it to combine one or more ETL (Event Trace Log) files that `xperf` collects into a single SPT (Sample Profile Trace) file. You can optionally filter data by process or binary name and exclude kernel events. After you create the SPT file, use [SPDConvert](spdconvert.md) to import it into an SPD (Sample Profile Database) file for optimization workflows. + +ETL (Event Trace Log) files contain raw hardware performance events that `xperf` records. `SPTAggregate` converts those ETL files into SPT format, which packages the sample events for import into an SPD (Sample Profile Database) file by [SPDConvert](spdconvert.md). + +## Syntax + +> `SPTAggregate` [*options*] **/etl** *etlfiles* *sptfile* + +### Parameters + +*options*\ +Specify the following options to `SPTAggregate`: + +- **/process:**\<*processes*\> Filter events by process name. Specify one or more process names as a comma-separated list.\ + Example: `/process:myapp.exe` +- **/binary:**\<*binaries*\> Filter events by binary name. Specify one or more binary names as a comma-separated list.\ + Example: `/binary:mylib.dll,myapp.exe` +- **/nokernel** Exclude OS kernel events. +- **/help** Display help information. + +*etlfiles*\ +A comma-separated list of ETL (Event Trace Log) files to process. Collect ETL files by using `xperf`. + +*sptfile*\ +The output SPT file to create. + +## Remarks + +> [!NOTE] +> Run this tool from a Visual Studio developer command prompt. + +Use `SPTAggregate` to convert one or more ETL files collected by `xperf` into an SPT file. The `/etl` flag is required and must precede the list of ETL files. You can import the resulting SPT file into an SPD file by using [`SPDConvert`](spdconvert.md). + +`SPTAggregate` uses `xperf`, which must be in your path and set up with the `perfcore.ini` changes as described in [Configure perfcore.ini](sample-profile-guided-optimization.md#configure-perfcoreini). + +When `SPTAggregate` runs `xperf`, it uses parameters like: `xperf -a spt -genSPT outputfile.spt -binary application.exe,support.dll,companion.dll` where `-a spt` specifies generate a sample profile trace analysis report, `-genSPT` specifies the output SPT file, and `-binary` focuses analysis on the specified binaries. + +For more information about `xperf` flags, see the [Xperf Command-Line Reference](/windows-hardware/test/wpt/xperf-command-line-reference) documentation. + +## Example + +This example converts a single ETL file into an SPT file: + +`SPTAggregate /etl filename.etl filename.spt` + +This example filters events to a specific process: + +`SPTAggregate /process:filename.exe /etl filename.etl filename.spt` + +This example aggregates two ETL files and excludes kernel events: + +`SPTAggregate /nokernel /etl run1.etl,run2.etl filename.spt` + +## See also + +[Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](sample-profile-guided-optimization.md)\ +[Profile-Guided Optimizations](profile-guided-optimizations.md)\ +[`SPDConvert`](spdconvert.md)\ +[`SPDDump`](spddump.md)\ +[`SPTDump`](sptdump.md) diff --git a/docs/build/sptdump.md b/docs/build/sptdump.md new file mode 100644 index 00000000000..7ba096eee51 --- /dev/null +++ b/docs/build/sptdump.md @@ -0,0 +1,110 @@ +--- +description: "Learn more about: SPTDump" +title: "SPTDump" +ms.date: 05/05/2026 +ai-usage: ai-assisted +helpviewer_keywords: ["SPTDump program", "sample profile-guided optimizations, SPTDump", "SPGO"] +--- +# SPTDump + +`SPTDump` is a command-line tool for inspecting Sample Profile Trace (SPT) files used in Sample Profile-Guided Optimization (SPGO) workflows. Use it to view SPT metadata and sample data. Validate trace contents before conversion to SPD, and troubleshoot issues such as SPD version mismatches. + +An SPT file contains raw hardware performance sample events collected from an application workload. + +## Syntax + +> `SPTDump` [*options*] *sptfile* + +### Parameters + +*options*\ +Specify the following options to `SPTDump`: + +- **/all** Output the entire SPT file. This option is the default. +- **/header** Output the SPT file header. +- **/progid** Output program IDs (GUID and age for each binary). +- **/strtab** Output the string table. +- **/event** Output sample events. +- **/help** Display help information. + +*sptfile*\ +The path to the SPT file to inspect. + +## Remarks + +> [!NOTE] +> Start this tool from a Visual Studio developer command prompt. + +Use `SPTDump` to inspect the contents of a Sample Profile Trace (SPT) file. [SPTAggregate](sptaggregate.md) produces SPT files from ETL event trace logs collected by `xperf`. Import SPT files into an SPD file (Sample Profile Database) by using [SPDConvert](spdconvert.md). + +To diagnose an "SPD version incompatible" error, use `/progid` to display the GUID and age for each binary in the SPT file, and then compare those values against the SPD file by using [`SPDDump /header`](spddump.md). + +## Example + +This example outputs the full contents of an SPT file: + +`SPTDump sample.spt` + +This example outputs only the program IDs (GUID and age) for binaries in an SPT file: + +`SPTDump /progid sample.spt` + +## SPT header format + +SPT file is a binary format with a 32-byte header, string table, program ID table, and sample event data stream. This document describes version 1 of the format. The version field updates if the layout changes in the future. + +The SPT header is 32 bytes: + +- `[0x00-0x03]` Signature (uint32 LE) = 0x5350543A ("SPT:") +- `[0x04-0x07]` Version (uint32 LE) = 1 +- `[0x08-0x0B]` RawDataId (uint32 LE) = 0 (unused/reserved) +- `[0x0C-0x0F]` TargetArch (uint32 LE) = 0 (unused/reserved) +- `[0x10-0x13]` StringTableOffset (uint32 LE) = offset to binary name string table (typically 0x20) +- `[0x14-0x17]` ProgramIdTableOffset (uint32 LE) = offset to RSDSKEY table (typically StringTableOffset+StringTableCapacity) +- `[0x18-0x19]` StringTableUsed (uint16 LE) = bytes used in string table +- `[0x1A-0x1B]` StringTableCapacity (uint16 LE) = bytes allocated in string table (typically 0x4000) +- `[0x1C-0x1D]` ProgramIdsUsed (uint16 LE) = number of program IDs (often just 1) +- `[0x1E-0x1F]` ProgramIdCapacity (uint16 LE) = capacity in count (not bytes) for program IDs (typically 0x100) + +The StringTable immediately follows the header at the specified offset. It contains a null-terminated UTF-8 binary filename. + +The ProgramIdTable follows the StringTable at the specified offset. Each entry is 24 bytes: 16-byte Rich Signature Data Stream (RSDS) GUID + 4-byte age + 4-byte string index into StringTable. + +The data stream starts at `ProgramIdTableOffset + (ProgramIdCapacity * 24)`, and starts with a `SPT_OP_BINARY_ID` opcode. + +**SPT Opcodes** + +In the following descriptions: +- RVA means the 32-bit relative virtual address of an instruction in the binary, that is, it's offset in the module. +- LE means little-endian byte order. + +`SPT_OP_REPEAT` (0x82)\ +Repeat the next record for the specified number of times. A repeat count of 2 means that there are 3 identical records in total. The repeat count resets after processing it.\ +Layout: 1 byte: opcode 0x82. 1 byte: padding. 8 bytes: repeat count (uint64 LE) + +`SPT_OP_UNHALT_CYCLE`, `SPT_OP_RETIRE_INSTR`, `SPT_OP_RETIRE_BR_INSTR`, `SPT_OP_L1_ICACHE_MISS`, `SPT_OP_L1_DCACHE_MISS`, `SPT_OP_ETW_INSTR` (0x01, 0x02, 0x03, 0x04, 0x05, 0x41)\ +Layout: 1 byte: opcode. 1 byte: RVA count (N). 4N bytes: N RVAs (uint32 LE each)\ +Each RVA represents an IP sample hit count = 1 + repeat count. + +`SPT_OP_LBR` (0x10)\ +Layout: 1 byte: opcode 0x10. 1 byte: event count (N). 8N bytes: N LBR pairs, each pair is: 4 bytes: To RVA (uint32 LE), 4 bytes: From RVA (uint32 LE)\ +Each pair represents a branch arc with hit count = 1 + repeat count. + +`SPT_OP_ETW_CALLSTACK` (0x42)\ +Layout: 1 byte: opcode 0x42. 1 byte: RVA count (N). 4N bytes: N RVAs (uint32 LE each, representing stack frames).\ +When: +- N = 2: Two RVAs form a single stack arc (RVA[0], RVA[1]) +- N > 2: Creates N-1 arcs from consecutive pairs: (RVA[0]->RVA[1]), (RVA[1]->RVA[2]), ..., (RVA[N-2]->RVA[N-1]) +Each series, whether it's a single arc or consecutive pairs, has hit count = 1 + repeat count. + +`SPT_OP_BINARY_ID` (0x81)\ +Layout: 1 byte: opcode 0x81. 1 byte: padding. 2 bytes: program ID (uint16 LE). 4 bytes: total data length in this segment (uint32 LE).\ +Marks the start of data records for a specific binary specified by an index ID. The index ID refers back to the RSDSKey and binary name string table in the SPT header.\ +The data length includes the 4-byte length field itself. This opcode can occur multiple times in a data stream. + +## See also + +[Tutorial: Use Sample Profile-Guided Optimization (SPGO) to improve performance](sample-profile-guided-optimization.md)\ +[`SPDConvert`](spdconvert.md)\ +[`SPDDump`](spddump.md)\ +[`SPTAggregate`](sptaggregate.md) \ No newline at end of file diff --git a/docs/build/stack-usage.md b/docs/build/stack-usage.md index 8a2a87b36dd..59c102e5ec9 100644 --- a/docs/build/stack-usage.md +++ b/docs/build/stack-usage.md @@ -41,7 +41,7 @@ A leaf function is one that does not require a function table entry. It can't ma ## malloc alignment -[malloc](../c-runtime-library/reference/malloc.md) is guaranteed to return memory that's suitably aligned for storing any object that has a fundamental alignment and that could fit in the amount of memory that's allocated. A *fundamental alignment* is an alignment that's less than or equal to the largest alignment that's supported by the implementation without an alignment specification. (In Visual C++, this is the alignment that's required for a **`double`**, or 8 bytes. In code that targets 64-bit platforms, it's 16 bytes.) For example, a four-byte allocation would be aligned on a boundary that supports any four-byte or smaller object. +[malloc](../c-runtime-library/reference/malloc.md) is guaranteed to return memory that's suitably aligned for storing any object that has a fundamental alignment and that could fit in the amount of memory that's allocated. A *fundamental alignment* is an alignment that's less than or equal to the largest alignment that's supported by the implementation without an alignment specification. (In Microsoft C++, this is the alignment that's required for a **`double`**, or 8 bytes. In code that targets 64-bit platforms, it's 16 bytes.) For example, a four-byte allocation would be aligned on a boundary that supports any four-byte or smaller object. Visual C++ permits types that have *extended alignment*, which are also known as *over-aligned* types. For example, the SSE types [__m128](../cpp/m128.md) and `__m256`, and types that are declared by using `__declspec(align( n ))` where `n` is greater than 8, have extended alignment. Memory alignment on a boundary that's suitable for an object that requires extended alignment is not guaranteed by `malloc`. To allocate memory for over-aligned types, use [_aligned_malloc](../c-runtime-library/reference/aligned-malloc.md) and related functions. diff --git a/docs/build/toc.yml b/docs/build/toc.yml index b5614f10a74..639c828118b 100644 --- a/docs/build/toc.yml +++ b/docs/build/toc.yml @@ -83,7 +83,7 @@ items: - name: "Header units" expanded: false items: - - name: "Walkthrough: Build and import header units in Visual C++ projects" + - name: "Walkthrough: Build and import header units in Microsoft C++ projects" href: ../build/walkthrough-header-units.md - name: "Walkthrough: Import STL libraries as header units" href: ../build/walkthrough-import-stl-header-units.md @@ -137,6 +137,8 @@ items: items: - name: Profile-guided optimizations href: ../build/profile-guided-optimizations.md + - name: Sample profile-guided optimization tutorial + href: ../build/sample-profile-guided-optimization.md - name: Environment variables for profile-guided optimizations href: ../build/environment-variables-for-profile-guided-optimizations.md - name: PgoAutoSweep @@ -145,6 +147,14 @@ items: href: ../build/pgomgr.md - name: pgosweep href: ../build/pgosweep.md + - name: SPDConvert + href: ../build/spdconvert.md + - name: SPDDump + href: ../build/spddump.md + - name: SPTAggregate + href: ../build/sptaggregate.md + - name: SPTDump + href: ../build/sptdump.md - name: "How to: Merge multiple PGO profiles into a single profile" href: ../build/how-to-merge-multiple-pgo-profiles-into-a-single-profile.md - name: Use the MSVC toolset from the command line @@ -314,6 +324,8 @@ items: href: ../build/prolog-and-epilog.md - name: x64 exception handling href: ../build/exception-handling-x64.md + - name: x64 Unwind Information V3 + href: ../build/x64-unwind-information-v3.md - name: Configure C++ projects for ARM processors expanded: false items: @@ -561,7 +573,12 @@ items: - name: /FC (Full path of source code file in diagnostics) href: ../build/reference/fc-full-path-of-source-code-file-in-diagnostics.md - name: /feature (Enable architecture features) - href: ../build/reference/feature-arm64.md + href: ../build/reference/feature-enable-architecture-features.md + items: + - name: /feature (ARM64) + href: ../build/reference/feature-arm64.md + - name: /feature (x64) + href: ../build/reference/feature-x64.md - name: /forceInterlockedFunctions (Generate and link with out-of-line atomic functions) href: ./reference/force-interlocked-functions.md @@ -1098,6 +1115,14 @@ items: href: ../build/reference/section-specify-section-attributes.md - name: /SOURCELINK (Include Sourcelink file in PDB) href: ../build/reference/sourcelink.md + - name: /SPD + href: ../build/reference/spd-specify-sample-profile-database.md + - name: /SPDEMBED + href: ../build/reference/spdembed-embed-sample-profile-database.md + - name: /SPDIN + href: ../build/reference/spdin-use-sample-profile-database.md + - name: /SPGO + href: ../build/reference/spgo-enable-sample-profile-guided-optimization.md - name: /STACK (Stack allocations) href: ../build/reference/stack-stack-allocations.md - name: /STUB (MS-DOS stub file name) diff --git a/docs/build/troubleshooting-c-cpp-isolated-applications-and-side-by-side-assemblies.md b/docs/build/troubleshooting-c-cpp-isolated-applications-and-side-by-side-assemblies.md index e6b026bfbad..77c17b97ece 100644 --- a/docs/build/troubleshooting-c-cpp-isolated-applications-and-side-by-side-assemblies.md +++ b/docs/build/troubleshooting-c-cpp-isolated-applications-and-side-by-side-assemblies.md @@ -24,7 +24,7 @@ If your application has no manifest and depends on a DLL that Windows can't find If your application is deployed on a computer that doesn't have Visual Studio, and it crashes with error messages that resemble the previous ones, check these things: -1. Follow the steps that are described in [Understanding the Dependencies of a Visual C++ Application](../windows/understanding-the-dependencies-of-a-visual-cpp-application.md). The dependency walker can show most dependencies for an application or DLL. If you observe that some DLLs are missing, install them on the computer on which you are trying to run your application. +1. Follow the steps that are described in [Understanding the Dependencies of a Microsoft C++ Application](../windows/understanding-the-dependencies-of-a-visual-cpp-application.md). The dependency walker can show most dependencies for an application or DLL. If you observe that some DLLs are missing, install them on the computer on which you are trying to run your application. 1. The operating system loader uses the application manifest to load assemblies that the application depends on. The manifest can either be embedded in the binary as a resource, or installed as a separate file in the application folder. To check whether the manifest is embedded in the binary, open the binary in Visual Studio and look for RT_MANIFEST in its list of resources. If you can't find an embedded manifest, look in the application folder for a file that's named something like .\.manifest. @@ -41,7 +41,7 @@ If your application is deployed on a computer that doesn't have Visual Studio, a ## Example -Assume we have an application, appl.exe, that's built by using Visual C++. The application manifest either is embedded in appl.exe as the binary resource RT_MANIFEST, which has an ID equal to 1, or is stored as the separate file appl.exe.manifest. The content of this manifest resembles this: +Assume we have an application, appl.exe, that's built using Microsoft C++ Build Tools. The application manifest either is embedded in appl.exe as the binary resource RT_MANIFEST, which has an ID equal to 1, or is stored as the separate file appl.exe.manifest. The content of this manifest resembles this: ``` diff --git a/docs/build/understanding-custom-build-steps-and-build-events.md b/docs/build/understanding-custom-build-steps-and-build-events.md index 7827264c812..78632dad4e1 100644 --- a/docs/build/understanding-custom-build-steps-and-build-events.md +++ b/docs/build/understanding-custom-build-steps-and-build-events.md @@ -8,7 +8,7 @@ ms.topic: how-to --- # Understanding Custom Build Steps and Build Events -From within the Visual C++ development environment, there are three basic ways to customize the build process: +Within the C++ development environment, there are three basic ways to customize the build process: - **Custom Build Steps** diff --git a/docs/build/understanding-manifest-generation-for-c-cpp-programs.md b/docs/build/understanding-manifest-generation-for-c-cpp-programs.md index c0bc39deb76..0db61f8486a 100644 --- a/docs/build/understanding-manifest-generation-for-c-cpp-programs.md +++ b/docs/build/understanding-manifest-generation-for-c-cpp-programs.md @@ -9,7 +9,7 @@ ms.topic: how-to A [manifest](/windows/win32/sbscs/manifests) is an XML document that uniquely identifies an assembly. It contains information used for binding and activation, such as COM classes, interfaces, and type libraries. A manifest can be an external XML file or a resource embedded inside an application or an assembly. The manifest of an [isolated application](/windows/win32/SbsCs/isolated-applications) is used to manage the names and versions of shared side-by-side assemblies the application should bind to at run time. The manifest of a side-by-side assembly specifies its dependencies on names, versions, resources, and other assemblies. -There are two ways to create a manifest for an isolated application or a side-by-side assembly. First, the author of the assembly can manually create a manifest file by following the rules and naming requirements. For more information, see [Manifest files reference](/windows/win32/sbscs/manifest-files-reference). Alternatively, if a program only depends on MSVC assemblies such as CRT, MFC, ATL or others, then the linker can generate a manifest automatically. +There are two ways to create a manifest for an isolated application or a side-by-side assembly. First, the author of the assembly can manually create a manifest file by following the rules and naming requirements. For more information, see [Manifest files reference](/windows/win32/sbscs/manifest-files-reference). Alternatively, if a program only depends on Microsoft C++ (MSVC) assemblies such as CRT, MFC, ATL or others, then the linker can generate a manifest automatically. The headers of MSVC libraries contain assembly information, and when the libraries are included in application code, this assembly information is used by the linker to form a manifest for the final binary. By default, the linker doesn't embed the manifest file inside the binary. Having a manifest as an external file may not work for all scenarios. For example, it's recommended that private assemblies have embedded manifests. In command line builds such as ones that use NMAKE to build code, you can use the [`/MANIFEST:EMBED`](./reference/manifest-create-side-by-side-assembly-manifest.md) linker option to embed the manifest. Alternatively, a manifest can be embedded using the manifest tool. For more information, see [Manifest generation at the command line](#manifest-generation-at-the-command-line). When you build in Visual Studio, a manifest can be embedded by setting a property for the manifest tool in the **Project Properties** dialog, as described in the next section. @@ -29,7 +29,7 @@ The build system in Visual Studio allows the manifest to be embedded in the fina 1. If the manifest embedded in the binary is the same as the manifest generated by the manifest tool, the build continues to the next build steps. -The manifest is embedded inside the final binary as a text resource. You can view it by opening the final binary as a file in Visual Studio. To ensure that the manifest points to the correct libraries, follow the steps described in [Understanding the dependencies of a Visual C++ application](../windows/understanding-the-dependencies-of-a-visual-cpp-application.md). Or, follow the suggestions described in the [Troubleshooting](troubleshooting-c-cpp-isolated-applications-and-side-by-side-assemblies.md) article. +The manifest is embedded inside the final binary as a text resource. You can view it by opening the final binary as a file in Visual Studio. To ensure that the manifest points to the correct libraries, follow the steps described in [Understanding the dependencies of a Microsoft C++ application](../windows/understanding-the-dependencies-of-a-visual-cpp-application.md). Or, follow the suggestions described in the [Troubleshooting](troubleshooting-c-cpp-isolated-applications-and-side-by-side-assemblies.md) article. ## Manifest generation at the command line diff --git a/docs/build/use-github-copilot-create-cpp-console-app.md b/docs/build/use-github-copilot-create-cpp-console-app.md new file mode 100644 index 00000000000..ab3637cfa2b --- /dev/null +++ b/docs/build/use-github-copilot-create-cpp-console-app.md @@ -0,0 +1,251 @@ +--- +title: Use AI to create a C++ console application in Visual Studio +description: "Learn how to use GitHub Copilot to create a C++ app using Microsoft C++ in Visual Studio." +ms.date: 10/24/2025 +ms.topic: "tutorial" +ms.collection: ce-skilling-ai-copilot +ms.custom: + - ai-assisted + - copilot-scenario-highlight +ms.update-cycle: 180-days +--- + +# Use AI to create a C++ console application in Visual Studio + +This tutorial shows you how to use GitHub Copilot to quickly create a C++ console application in Visual Studio. You create a console version of Conway's Game of Life, a classic cellular automaton. + +Conway's Game of Life was devised by mathematician John Conway. It consists of a grid of cells that can be either alive or dead. The game evolves automatically based on simple rules and produces complex, evolving patterns that demonstrate how intricate behavior can emerge from basic mathematical rules. + +GitHub Copilot is an AI-powered coding assistant that helps you write code faster, reduce errors, and explore new solutions. Some benefits of using Copilot when coding in C++: +- Generate entire C++ functions or classes as you type. +- Suggest code completions based on plain-language comments or prompts. +- Get help with complex algorithms, data structures, and standard library usage. +- Learn new APIs and modern C++ patterns through in-context examples. +- Receive context-aware suggestions based on your comments or code. +- Debug errors in your code. +- Simplify and refactor existing code. + +## Prerequisites + +- Visual Studio 2022 or later with the **Desktop development with C++** workload installed. +- GitHub Copilot. For more information, see [Get started with GitHub Copilot](/visualstudio/ide/visual-studio-github-copilot-get-started). + +To verify you have the C++ workload installed: +1. Open Visual Studio Installer +1. Select **Modify** next to your Visual Studio installation +1. Ensure **Desktop development with C++** is checked: + + :::image type="content" source="media/desktop-development-cpp-workload.png" alt-text="Screenshot of the Visual Studio Installer with the Workloads tab selected. Desktop development with c++ is selected."::: + +1. If it isn't installed, select it and choose **Modify**. + +For more information about installing Copilot, see [Manage GitHub Copilot installation and state](/visualstudio/ide/visual-studio-github-copilot-install-and-states). + +## Create a project + +Visual Studio uses *projects* to organize the code for an app, and *solutions* to organize your projects. A project contains all the options, configurations, and rules used to build your apps. It manages the relationship between all the project's files and any external files. To create your app, first, create a new project and solution. + +1. Open Visual Studio and select **Create a new project**. +1. Search for "Console App" and select the **Console App** template for C++. + + :::image type="complex" source="media/vs2019-choose-console-app.png" alt-text="Screenshot of the Create a new project dialog."::: + The Create a new project dialog is shown with the Console App template selected. The template says: Run code in a windows terminal. Prints hello world by default. Has the tags c++, Windows, and Console. + :::image-end::: + +1. Select **Next**. +1. Set the project name to **Life** and choose the location for the project. +1. Select **Create**. +1. Once the project opens, find the `Life.cpp` file in Solution Explorer. +1. Open `Life.cpp` and delete the default "Hello, World!" code to start with a clean slate. + +## Use Copilot to create an app + +You prompt Copilot by describing the functionality you want. In this section, you'll learn how to prompt Copilot to generate an implementation of Conway's Game of Life. + +1. Open the Copilot chat window by selecting the Copilot icon in the toolbar: + + :::image type="content" source="media/github-copilot-open-chat.png" alt-text="Screenshot of the GitHub icon dropdown. Open Chat Window is selected."::: + +1. In the chat window, enter the following prompt: + ```copilot-prompt + Create a C++ console application that implements Conway's Game of Life. The program should: + - Use a 40x20 grid displayed with asterisks (*) for live cells and spaces for dead cells + - Start with a random initial pattern + - Display each generation for 500ms before showing the next + - Allow the user to press any key to exit the program + - Include proper headers and use standard C++ practices + - Clear the console between generations to provide an animation effect + ``` +1. Copilot generates C++ code for Conway's Game of Life. +1. Copy the generated code and paste it into your empty `Life.cpp` file. +1. Build the project by pressing **F6** or selecting **Build > Build Solution**. +1. Run the program by pressing **F5** or **Ctrl+F5**. + +> [!NOTE] +> The exact code generated by Copilot may vary slightly from run to run and model to model, but the core functionality should be consistent. If the generated code doesn't compile immediately, you can ask Copilot to fix any compilation errors. Copilot is powered by AI, so surprises and mistakes are possible. For more information, see [Copilot FAQs](https://aka.ms/copilot-general-use-faqs). + +### Example of typical generated code structure + +Your generated code will likely include these key components: + +- Headers for console manipulation, random number generation, and timing +- A 2D array or vector to represent the game grid +- Functions to initialize the grid, apply Conway's rules, and display the current state +- A main loop that continues until a key is pressed + +Here's an example of the code that Copilot generated using the previous prompt: + +```cpp +// Code generated by GitHub Copilot +#include +#include +#include +#include // for _kbhit and _getch + +using namespace std; + +int step = 0; +const int rows = 20; +const int cols = 40; + +void printGrid(int grid[rows][cols]) +{ + cout << "Step: " << step << endl; + for (int i = 0; i < rows; ++i) + { + for (int j = 0; j < cols; ++j) + { + cout << (grid[i][j] ? '*' : ' '); + } + cout << endl; + } +} + +int countNeighbors(int grid[rows][cols], int x, int y) +{ + int count = 0; + for (int i = -1; i <= 1; ++i) + { + for (int j = -1; j <= 1; ++j) + { + if (i == 0 && j == 0) + { + continue; + } + + int ni = x + i; + int nj = y + j; + if (ni >= 0 && ni < rows && nj >= 0 && nj < cols) + { + count += grid[ni][nj]; + } + } + } + return count; +} + +void updateGrid(int grid[rows][cols]) +{ + int newGrid[rows][cols] = { 0 }; + for (int i = 0; i < rows; ++i) + { + for (int j = 0; j < cols; ++j) + { + int neighbors = countNeighbors(grid, i, j); + if (grid[i][j] == 1) + { + newGrid[i][j] = (neighbors < 2 || neighbors > 3) ? 0 : 1; + } + else + { + newGrid[i][j] = (neighbors == 3) ? 1 : 0; + } + } + } + // Copy newGrid back to grid + for (int i = 0; i < rows; ++i) + { + for (int j = 0; j < cols; ++j) + { + grid[i][j] = newGrid[i][j]; + } + } +} + +int main() +{ + int grid[rows][cols] = { 0 }; + + // Initial configuration (a simple glider) + grid[1][2] = 1; + grid[2][3] = 1; + grid[3][1] = 1; + grid[3][2] = 1; + grid[3][3] = 1; + + while (true) + { + if (_kbhit()) // Check if a key has been pressed + { + _getch(); // Consume the key + break; // Exit the loop + } + printGrid(grid); + updateGrid(grid); + std::this_thread::sleep_for(std::chrono::milliseconds(100)); + cout << "\033[H\033[J"; // Clear the screen + step++; + } + + return 0; +} +``` +When you run the application, you should see an animated display of Conway's Game of Life with patterns evolving over time. To exit the program, press a key. + +:::image type="content" source="./media/life-exe.png" alt-text="Screenshot of Conway Life running in a command window, displaying the evolving grid of cells."::: + +In the preceding code example, the code generates a warning: `Return value ignored: '_getch'`. You can ask Copilot to fix it. Select the code editor and press **Alt+/** (Windows) to open the Copilot chat, then enter: + +:::image type="content" source="./media/github-copilot-fix-warning.png" alt-text="Screenshot of the Copilot chat window. The text: Fix warning C6031 is in the chat window."::: + +Copilot suggests a fix to handle the return value properly. To accept the changes, select **Tab**: + +:::image type="content" source="./media/github-copilot-fix-warning-accept.png" alt-text="Screenshot of the Copilot proposed changes. Tab to accept. Alt+Del to discard."::: + +Congratulations! You successfully used GitHub Copilot to create a fully functional Conway's Game of Life console application in C++. You learned how to: + +- Craft an effective prompt to generate C++ code +- Use Copilot's chat interface to create an entire application from scratch +- Fix compilation warnings with AI assistance + +## Improve your prompting skills + +For better results with Copilot, see these prompting resources: + +- [GitHub Copilot documentation](https://docs.github.com/en/copilot) - Official best practices and tips +- [OpenAI's GPT best practices](https://platform.openai.com/docs/guides/prompt-engineering) - General AI prompting techniques +- [Copilot prompting guide](https://github.blog/2023-06-20-how-to-write-better-prompts-for-github-copilot/) - Specific guidance for code generation + +## Troubleshooting + +### Missing console app template + +The **New Project** dialog should show a **Console App** template that has **C++**, **Windows**, and **Console** tags. If you don't see it, it might be filtered out of the list, or it might not be installed. First, check the filter dropdowns at the top of the list of templates. Set them to **C++**, **Windows**, and **Console**. The C++ **Console App** template should appear; otherwise, the **Desktop development with C++** workload isn't installed. + +To install **Desktop development with C++**, you can run the installer right from the **Create a new project** dialog. Choose the **Install more tools and features** link at the bottom of the **Create a new project** dialog, beneath the list of templates. If the **User Account Control** dialog requests permissions, choose **Yes**. In the installer, make sure the **Desktop development with C++** workload is checked. Then choose **Modify** to update your Visual Studio installation. + +### Copilot not responding + +- Ensure you have an active GitHub Copilot subscription. +- Try signing out and back into your GitHub account in Visual Studio + +### Generated code doesn't compile + +- Ask Copilot to fix specific compilation errors by pasting the error message into Copilot chat. +- Try refining your prompt to be more specific about what you want the app to do. + +## Next steps + +- [GitHub Copilot in Visual Studio](/visualstudio/ide/visual-studio-github-copilot-install-and-states) +- [GitHub Copilot documentation](https://docs.github.com/en/copilot) - Dive deeper into AI-assisted development +- [Awesome ChatGPT Prompts](https://github.com/f/awesome-chatgpt-prompts) - Community-driven prompting examples for inspiration \ No newline at end of file diff --git a/docs/build/vscpp-step-0-installation.md b/docs/build/vscpp-step-0-installation.md index 0a5311c1fd1..903016883ab 100644 --- a/docs/build/vscpp-step-0-installation.md +++ b/docs/build/vscpp-step-0-installation.md @@ -128,7 +128,7 @@ Some benefits of using Copilot for your C++ coding scenarios: - Debug errors in your code. - Simplify and refactor existing code. -To install GitHub Copilot, see [Manage GitHub Copilot installation and state](/visualstudio/ide/visual-studio-github-copilot-install-and-states). +To try GitHub copilot to create a C++ app, follow the instructions in [Use AI to create a C++ console application in Visual Studio](../build/use-github-copilot-create-cpp-console-app.md). ::: moniker-end @@ -225,9 +225,7 @@ You can reduce the installation footprint of Visual Studio on your system drive. ### Step 8 - Start developing 1. After Visual Studio installation is complete, choose the **Launch** button to get started developing with Visual Studio. - 1. On the start window, choose **Create a new project**. - 1. In the search box, enter the type of app you want to create to see a list of available templates. The list of templates depends on the workloads that you chose during installation. To see different templates, choose different workloads. You can also filter your search for a specific programming language by using the **Language** dropdown list. You can filter by using the **Platform** list and the **Project type** list, too. diff --git a/docs/build/vscpp-step-2-build.md b/docs/build/vscpp-step-2-build.md index e708ea80e02..174615c346b 100644 --- a/docs/build/vscpp-step-2-build.md +++ b/docs/build/vscpp-step-2-build.md @@ -1,6 +1,6 @@ --- title: Build and run a C++ console app project -description: "Build and run a Hello World console app in Visual C++" +description: "Build and run a Hello World console app in Microsoft C++" ms.custom: "mvc" ms.date: 06/28/2024 ms.topic: "tutorial" diff --git a/docs/build/walkthrough-build-debug-wsl2.md b/docs/build/walkthrough-build-debug-wsl2.md index 66dfa46bd3b..ad9e42efd9c 100644 --- a/docs/build/walkthrough-build-debug-wsl2.md +++ b/docs/build/walkthrough-build-debug-wsl2.md @@ -24,17 +24,18 @@ CMake Presets integration in Visual Studio supports the WSL 2 toolset. To learn ## Install the build tools -Install the tools necessary to build and debug on WSL 2. You'll install a recent version of CMake using Visual Studio's CMake binary deployment in a later step. +Install the tools necessary to build and debug on WSL 2. You install a recent version of CMake using Visual Studio's CMake binary deployment in a later step. 1. Install WSL and a WSL 2 distro by following the instructions at [Install WSL](/windows/wsl/install-win10). +1. In the Visual Studio installer, verify that **C++ CMake tools for Linux** is installed. To do that, choose **Modify** for your version of Visual Studio. Under the **Individual components** tab, search for **C++ CMake tools for Linux and Mac** and make sure it's selected and installed. This component is required for Visual Studio to detect your WSL installations. 1. Assuming your distro uses `apt` (this walkthrough uses Ubuntu), use the following commands to install the required build tools on your WSL 2 distro: ```bash sudo apt update - sudo apt install g++ gdb make ninja-build rsync zip + sudo apt install cmake g++ gdb make ninja-build rsync zip ``` - The `apt` commands above install: + Which installs: * A C++ compiler * `gdb` @@ -49,57 +50,57 @@ This walkthrough uses GCC and Ninja on Ubuntu. And Visual Studio 2022 version 17 Visual Studio defines a CMake project as a folder with a `CMakeLists.txt` file at the project root. In this walkthrough, you create a new CMake project by using the Visual Studio **CMake Project** template: -3. From the Visual Studio **Get started** screen, select **Create a new project**. +1. From the Visual Studio **Get started** screen, select **Create a new project**. :::image type="content" source="media/vs2022-get-started.png" alt-text="Screenshot of the Visual Studio 2022 get started dialog box."::: The available options are: Clone a repository, Open a project or solution, Open a local folder, Create a new project, or Continue without code."::: -4. In the **Search for templates** textbox, type "cmake". Choose the **CMake Project** type and select **Next**. Give the project a name and location, and then select **Create**. +1. In the **Search for templates** textbox, type "cmake". Choose the **CMake Project** type and select **Next**. Give the project a name and location, and then select **Create**. -5. Enable Visual Studio's CMake Presets integration. Select **Tools** > **Options** > **CMake** > **General**. Select **Prefer using CMake Presets for configure, build, and test**, then select **OK**. Instead, you could have added a `CMakePresets.json` file to the root of the project. For more information, see [Enable CMake Presets integration](cmake-presets-vs.md#enable-cmakepresets-json-integration). +1. Enable Visual Studio's CMake Presets integration. Select **Tools** > **Options** > **CMake** > **General**. Select **Prefer using CMake Presets for configure, build, and test**, then select **OK**. Alternatively, you could add a `CMakePresets.json` file to the root of the project. For more information, see [Enable CMake Presets integration](cmake-presets-vs.md#enable-cmakepresets-json-integration). :::image type="complex" source="media/cmake-general-prefer-cmake-presets.png" alt-text="Screenshot of the Visual Studio project options. Cmake > General is selected."::: In the CMake configuration file group, 'Use CMake Presets if available, otherwise use CMakeSettings.json' is called out and is selected. :::image-end::: -6. To activate the integration: from the main menu, select **File** > **Close Folder**. The **Get started** page appears. Under **Open recent**, select the folder you just closed to reopen the folder. +1. To activate the integration: from the main menu, select **File** > **Close Folder**. The **Get started** page appears. Under **Open recent**, select the folder you just closed to reopen the folder. -7. There are three dropdowns across the Visual Studio main menu bar. Use the dropdown on the left to select your active target system. This is the system where CMake is invoked to configure and build the project. Visual Studio queries for WSL installations with `wsl -l -v`. In the following image, **WSL2: Ubuntu-20.04** is shown selected as the **Target System**. +1. There are three dropdowns across the Visual Studio main menu bar. Use the dropdown on the left to select your active target system. This is the system where CMake is invoked to configure and build the project. Visual Studio queries for WSL installations with `wsl -l -v`. In the following image, **WSL2: Ubuntu-20.04** is shown selected as the **Target System**. :::image type="content" source="media/vs2022-target-system-dropdown.png" alt-text="Screenshot of the Visual Studio target system dropdown. WSL2: Ubuntu-20.04 is the selected."::: > [!NOTE] - > If Visual Studio starts to configure your project automatically, read step 11 to manage CMake binary deployment, and then continue to the step below. To customize this behavior, see [Modify automatic configuration and cache notifications](cmake-presets-vs.md#modify-automatic-configuration-and-cache-notifications). + > If Visual Studio starts to configure your project automatically, read step 11 to manage CMake binary deployment, and then continue to the following step. To customize this behavior, see [Modify automatic configuration and cache notifications](cmake-presets-vs.md#modify-automatic-configuration-and-cache-notifications). -8. Use the dropdown in the middle to select your active Configure Preset. Configure Presets tell Visual Studio how to invoke CMake and generate the underlying build system. In step 7, the active Configure Preset is the **linux-default** Preset created by Visual Studio. To create a custom Configure Preset, select **Manage Configurations…** For more information about Configure Presets, see [Select a Configure Preset](cmake-presets-vs.md#select-a-configure-preset) and [Edit Presets](cmake-presets-vs.md#edit-presets). +1. Use the dropdown in the middle to select your active Configure Preset. Configure Presets tell Visual Studio how to invoke CMake and generate the underlying build system. In step 7, the active Configure Preset is the **linux-default** Preset created by Visual Studio. To create a custom Configure Preset, select **Manage Configurations…** For more information about Configure Presets, see [Select a Configure Preset](cmake-presets-vs.md#select-a-configure-preset) and [Edit Presets](cmake-presets-vs.md#edit-presets). :::image type="content" source="media/vs2022-ActivePresetDropdown.png" alt-text="Screenshot of the Visual Studio active configure preset dropdown. Manage Configurations... is selected."::: -9. Use the dropdown on the right to select your active Build Preset. Build Presets tell Visual Studio how to invoke build. In the illustration for step 7, the active Build Preset is the **Default** Build Preset created by Visual Studio. For more information about Build Presets, see [Select a Build Preset](cmake-presets-vs.md#select-a-build-preset). +1. Use the dropdown on the right to select your active Build Preset. Build Presets tell Visual Studio how to invoke build. In the illustration for step 7, the active Build Preset is the **Default** Build Preset created by Visual Studio. For more information about Build Presets, see [Select a Build Preset](cmake-presets-vs.md#select-a-build-preset). -10. Configure the project on WSL 2. If project generation doesn't start automatically, then manually invoke configure with **Project** > **Configure** *project-name* +1. Configure the project on WSL 2. If project generation doesn't start automatically, then manually invoke configure with **Project** > **Configure** *project-name* :::image type="content" source="media/vs2022-project-configure.png" alt-text="Screenshot of the Visual Studio project configure dropdown. Configure CMakeProject is selected."::: -11. If you don't have a supported version of CMake installed on your WSL 2 distro, then Visual Studio prompts you beneath the main menu ribbon to deploy a recent version of CMake. Select **Yes** to deploy CMake binaries to your WSL 2 distro. +1. If you don't have a supported version of CMake installed on your WSL 2 distro, then Visual Studio prompts you beneath the main menu ribbon to deploy a recent version of CMake. Select **Yes** to deploy CMake binaries to your WSL 2 distro. :::image type="complex" source="media/vs2022-supported-cmake-not-present-prompt.png" alt-text="Screenshot of a prompt beneath the Visual Studio toolbar"::: The user is prompted whether to install the latest C Make binaries from C make . org because the supported C Make version isn't installed." :::image-end::: -12. Confirm that the configure step completed and that you can see the **CMake generation finished** message in the **Output** window under the **CMake** pane. Build files are written to a directory in the WSL 2 distro's file system. +1. Confirm that the configure step completed and that you can see the **CMake generation finished** message in the **Output** window under the **CMake** pane. Build files are written to a directory in the WSL 2 distro's file system. :::image type="content" source="media/vs-output-window-cmake-generation.png" alt-text="Screenshot of the Visual Studio Output window. It contains messages generated during the configure step, including that C Make generation is complete."::: -13. Select the active debug target. The debug dropdown menu lists all the CMake targets available to the project. +1. Select the active debug target. The debug dropdown menu lists all the CMake targets available to the project. :::image type="content" source="media/vs-debug-dropdown-menu-cmake.png" alt-text="Screenshot of the Visual Studio debug dropdown menu. CMakeProject is selected."::: -14. Expand the project subfolder in the **Solution Explorer**. In the `CMakeProject.cpp` file, set a breakpoint in `main()`. You can also navigate to CMake targets view by selecting the View Picker button in the **Solution Explorer**, highlighted in following screenshot: +1. Expand the project subfolder in the **Solution Explorer**. In the `CMakeProject.cpp` file, set a breakpoint in `main()`. You can also navigate to CMake targets view by selecting the View Picker button in the **Solution Explorer**, highlighted in following screenshot: :::image type="content" source="media/solution-explorer-switch-view.png" alt-text="Screenshot of the Visual Studio solution explorer showing the button to switch views. It's located to the right of the home button."::: -15. Select **Debug** > **Start**, or press **F5**. Your project builds, the executable launches on your WSL 2 distro, and Visual Studio halts execution at the breakpoint. The output of your program (in this case, `"Hello CMake."`) is visible in the Linux Console Window: +1. Select **Debug** > **Start**, or press **F5**. Your project builds, the executable launches on your WSL 2 distro, and Visual Studio halts execution at the breakpoint. The output of your program (in this case, `"Hello CMake."`) is visible in the Linux Console Window: :::image type="complex" source="media/walkthrough-build-debug-wsl2-breakpoint.png" alt-text="Screenshot of a running hello world program."::: The Visual Studio Linux console window displays the output of the program: 'Hello C Make.' The editor window shows the hello world program. Execution stopped at a breakpoint on the line that says return 0;." @@ -133,7 +134,7 @@ If you have a MSBuild-based Linux project, then you can upgrade to the WSL 2 too :::image type="content" source="media/wsl-platform-toolset-selection.png" alt-text="Screenshot of a Visual Studio dropdown with Platform Toolset selected, and to the right, another dropdown with WSL2 Toolset selected."::: -If you're targeting a WSL 2 distribution and you don't want to use the WSL 2 toolset, then in the **Platform Toolset** dropdown, select the **GCC for Windows Subsystem for Linux** or **Clang for Windows Subsystem for Linux** toolset. If either of these toolsets are selected, Visual Studio doesn't maintain a copy of your source files in the WSL file system and instead accesses source files over the mounted Windows drive (`/mnt/`…). System headers are still automatically copied to the Windows file system to provide a native IntelliSense experience. Customize the headers that are included or excluded from this copy in **Property Pages** > **General**. +If you're targeting a WSL 2 distribution and you don't want to use the WSL 2 toolset, then in the **Platform Toolset** dropdown, select the **GCC for Windows Subsystem for Linux** or **Clang for Windows Subsystem for Linux** toolset. If either of these toolsets are selected, Visual Studio doesn't maintain a copy of your source files in the WSL file system, and instead accesses source files over the mounted Windows drive (`/mnt/`…). System headers are still automatically copied to the Windows file system to provide a native IntelliSense experience. Customize the headers that are included or excluded from this copy in **Property Pages** > **General**. In most cases, it's best to use the WSL 2 toolset with WSL 2 distributions because WSL 2 is slower when project files are stored in the Windows file system. To learn more, see [Comparing WSL 1 and WSL 2](/windows/wsl/compare-versions). diff --git a/docs/build/walkthrough-compile-a-c-program-on-the-command-line.md b/docs/build/walkthrough-compile-a-c-program-on-the-command-line.md index 16e71d6fea8..ab7d92e680f 100644 --- a/docs/build/walkthrough-compile-a-c-program-on-the-command-line.md +++ b/docs/build/walkthrough-compile-a-c-program-on-the-command-line.md @@ -9,7 +9,7 @@ ms.topic: how-to --- # Walkthrough: Compile a C program on the command line -The Visual Studio build tools include a C compiler that you can use to create everything from basic console programs to full Windows desktop applications and mobile apps. Microsoft C/C++ (MSVC) is a C and C++ compiler that, in its latest versions, conforms to some of the latest C language standards, including C11 and C17. +The Visual Studio Build Tools include a C compiler that you can use to create everything from basic console programs to full Windows desktop applications and mobile apps. Microsoft C++ (MSVC) Build Tools contains a C and C++ compiler that, in its latest versions, conforms to some of the latest C language standards, including C11 and C17. This guide explains how to create a basic *Hello, World*-style C program by using a text editor, and then compile it on the command line. If you'd rather work in C++ on the command line, see [Walkthrough: Compiling a Native C++ Program on the Command Line](walkthrough-compiling-a-native-cpp-program-on-the-command-line.md). If you'd like to try the Visual Studio IDE instead of using the command line, see [Walkthrough: Working with Projects and Solutions (C++)](../ide/walkthrough-working-with-projects-and-solutions-cpp.md) or [Using the Visual Studio IDE for C++ Desktop Development](../ide/using-the-visual-studio-ide-for-cpp-desktop-development.md). diff --git a/docs/build/walkthrough-compiling-a-cpp-cli-program-on-the-command-line.md b/docs/build/walkthrough-compiling-a-cpp-cli-program-on-the-command-line.md index 1bf1c0904fd..f450214e366 100644 --- a/docs/build/walkthrough-compiling-a-cpp-cli-program-on-the-command-line.md +++ b/docs/build/walkthrough-compiling-a-cpp-cli-program-on-the-command-line.md @@ -6,7 +6,7 @@ ms.assetid: cef41c88-faf9-439d-8423-25aa3f5674dd --- # Walkthrough: Compiling a C++/CLI Program on the Command Line -You can create Visual C++ programs that target the Common Language Runtime (CLR) and use the .NET Framework, and build them on the command line. Visual C++ supports the C++/CLI programming language, which has additional types and operators to target the .NET programming model. For general information about the C++/CLI language, see [.NET Programming with C++/CLI (Visual C++)](../dotnet/dotnet-programming-with-cpp-cli-visual-cpp.md). +You can create Microsoft C++ programs that target the Common Language Runtime (CLR) and use the .NET Framework, and build them on the command line. Microsoft C++ supports the C++/CLI programming language, which has additional types and operators to target the .NET programming model. For general information about the C++/CLI language, see [.NET Programming with C++/CLI (Visual C++)](../dotnet/dotnet-programming-with-cpp-cli-visual-cpp.md). In this walkthrough, you use a text editor to create a basic C++/CLI program, and then compile it on the command line. (You can use your own C++/CLI program instead of typing the one that's shown, or you can use a C++/CLI code sample from another help article. This technique is useful for building and testing small modules that have no UI elements.) @@ -18,7 +18,7 @@ You understand the fundamentals of the C++ language. The following steps show how to compile a C++/CLI console application that uses .NET Framework classes. -To enable compilation for C++/CLI, you must use the [/clr](reference/clr-common-language-runtime-compilation.md) compiler option. The MSVC compiler generates an .exe file that contains MSIL code—or mixed MSIL and native code—and links to the required .NET Framework libraries. +To enable compilation for C++/CLI, you must use the [/clr](reference/clr-common-language-runtime-compilation.md) compiler option. The Microsoft C++ (MSVC) compiler generates an .exe file that contains MSIL code—or mixed MSIL and native code—and links to the required .NET Framework libraries. ### To compile a C++/CLI application on the command line @@ -43,7 +43,7 @@ To enable compilation for C++/CLI, you must use the [/clr](reference/clr-common- 1. On the menu bar, choose **File** > **Save**. - You've created a Visual C++ source file that uses a .NET Framework class () in the namespace. + You've created a C++ source file that uses a .NET Framework class () in the namespace. 1. At the command prompt, enter `cl /clr basicclr.cpp`. The cl.exe compiler compiles the source code into an .obj file that contains MSIL, and then runs the linker to generate an executable program named basicclr.exe. diff --git a/docs/build/walkthrough-compiling-a-native-cpp-program-on-the-command-line.md b/docs/build/walkthrough-compiling-a-native-cpp-program-on-the-command-line.md index 5cd2502e96e..f2bf932a35e 100644 --- a/docs/build/walkthrough-compiling-a-native-cpp-program-on-the-command-line.md +++ b/docs/build/walkthrough-compiling-a-native-cpp-program-on-the-command-line.md @@ -22,7 +22,7 @@ Visual Studio is an *integrated development environment* (IDE). It supports a fu The Build Tools for Visual Studio installs only the command-line compilers, tools, and libraries you need to build C and C++ programs. It's perfect for build labs or classroom exercises and installs relatively quickly. To install only the command-line tools, look for Build Tools for Visual Studio on the [Visual Studio Downloads](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) page. -Before you can build a C or C++ program on the command line, verify that the tools are installed, and you can access them from the command line. Visual C++ has complex requirements for the command-line environment to find the tools, headers, and libraries it uses. **You can't use Visual C++ in a plain command prompt window** without doing some preparation. Fortunately, Visual C++ installs shortcuts for you to launch a developer command prompt that has the environment set up for command line builds. Unfortunately, the names of the developer command prompt shortcuts and where they're located are different in almost every version of Visual C++ and on different versions of Windows. Your first walkthrough task is finding the right one to use. +Before you can build a C or C++ program on the command line, verify that the tools are installed, and you can access them from the command line. Microsoft C++ (MSVC) has complex requirements for the command-line environment to find the tools, headers, and libraries it uses. **You can't use Microsoft C++ in a plain command prompt window** without doing some preparation. Fortunately, Microsoft C++ installs shortcuts for you to launch a developer command prompt that has the environment set up for command line builds. Unfortunately, the names of the developer command prompt shortcuts and where they're located are different in almost every version of Visual Studio and on different versions of Windows. Your first walkthrough task is finding the right one to use. > [!NOTE] > A developer command prompt shortcut automatically sets the correct paths for the compiler and tools, and for any required headers and libraries. You must set these environment values yourself if you use a regular **Command Prompt** window. For more information, see [Use the MSVC toolset from the command line](./building-on-the-command-line.md). We recommend you use a developer command prompt shortcut instead of building your own. @@ -31,11 +31,11 @@ Before you can build a C or C++ program on the command line, verify that the too 1. If you have installed Visual Studio 2017 or later on Windows 10 or later, open the Start menu and choose **All apps**. Scroll down and open the **Visual Studio** folder (not the Visual Studio application). Choose **Developer Command Prompt for VS** to open the command prompt window. - If you have installed Microsoft Visual C++ Build Tools 2015 on Windows 10 or later, open the **Start** menu and choose **All apps**. Scroll down and open the **Visual C++ Build Tools** folder. Choose **Visual C++ 2015 x86 Native Tools Command Prompt** to open the command prompt window. + If you have installed Microsoft Visual Studio Build Tools 2015 on Windows 10 or later, open the **Start** menu and choose **All apps**. Scroll down and open the **Visual Studio Build Tools** folder. Choose **x86 Native Tools Command Prompt** to open the command prompt window. You can also use the Windows search function to search for "developer command prompt" and choose one that matches your installed version of Visual Studio. Use the shortcut to open the command prompt window. -1. Next, verify that the Visual C++ developer command prompt is set up correctly. In the command prompt window, enter `cl` and verify that the output looks something like this: +1. Next, verify that the C++ developer command prompt is set up correctly. In the command prompt window, enter `cl` and verify that the output looks something like this: ```Output C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise>cl @@ -45,17 +45,17 @@ Before you can build a C or C++ program on the command line, verify that the too usage: cl [ option... ] filename... [ /link linkoption... ] ``` - There may be differences in the current directory or version numbers. These values depend on the version of Visual C++ and any updates installed. If the above output is similar to what you see, then you're ready to build C or C++ programs at the command line. + There may be differences in the current directory or version numbers. These values depend on the version of MSVC and any updates installed. If the above output is similar to what you see, then you're ready to build C or C++ programs at the command line. > [!NOTE] - > If you get an error such as "'cl' is not recognized as an internal or external command, operable program or batch file," error C1034, or error LNK1104 when you run the **`cl`** command, then either you are not using a developer command prompt, or something is wrong with your installation of Visual C++. You must fix this issue before you can continue. + > If you get an error such as "'cl' is not recognized as an internal or external command, operable program or batch file," error C1034, or error LNK1104 when you run the **`cl`** command, then either you are not using a developer command prompt, or something is wrong with your installation of MSVC. You must fix this issue before you can continue. - If you can't find the developer command prompt shortcut, or if you get an error message when you enter `cl`, then your Visual C++ installation may have a problem. Try reinstalling the Visual C++ component in Visual Studio, or reinstall the Microsoft Visual C++ Build Tools. Don't go on to the next section until the **`cl`** command works. For more information about installing and troubleshooting Visual C++, see [Install Visual Studio](/visualstudio/install/install-visual-studio). + If you can't find the developer command prompt shortcut, or if you get an error message when you enter `cl`, then your MSVC installation may have a problem. Try reinstalling the MSVC component in Visual Studio or Visual Studio Build Tools. Don't go on to the next section until the **`cl`** command works. For more information about installing and troubleshooting MSVC, see [Install Visual Studio](/visualstudio/install/install-visual-studio). > [!NOTE] > Depending on the version of Windows on the computer and the system security configuration, you might have to right-click to open the shortcut menu for the developer command prompt shortcut and then choose **Run as administrator** to successfully build and run the program that you create by following this walkthrough. -### Create a Visual C++ source file and compile it on the command line +### Create a C++ source file and compile it on the command line 1. In the developer command prompt window, enter `md c:\hello` to create a directory, and then enter `cd c:\hello` to change to that directory. This directory is where both your source file and the compiled program get created. @@ -70,7 +70,7 @@ Before you can build a C or C++ program on the command line, verify that the too using namespace std; int main() { - cout << "Hello, world, from Visual C++!" << endl; + cout << "Hello, world, from Microsoft C++!" << endl; } ``` @@ -130,7 +130,7 @@ Before you can build a C or C++ program on the command line, verify that the too The program displays this text and exits: ```Output - Hello, world, from Visual C++! + Hello, world, from Microsoft C++! ``` Congratulations, you've compiled and run a C++ program by using the command-line tools. diff --git a/docs/build/walkthrough-creating-and-using-a-dynamic-link-library-cpp.md b/docs/build/walkthrough-creating-and-using-a-dynamic-link-library-cpp.md index e777914ccdb..ac858bc073f 100644 --- a/docs/build/walkthrough-creating-and-using-a-dynamic-link-library-cpp.md +++ b/docs/build/walkthrough-creating-and-using-a-dynamic-link-library-cpp.md @@ -571,7 +571,7 @@ Press any key to dismiss the command window. Now that you've created a DLL and a client application, you can experiment. Try setting breakpoints in the code of the client app, and run the app in the debugger. See what happens when you step into a library call. Add other functions to the library, or write another client app that uses your DLL. -When you deploy your app, you must also deploy the DLLs it uses. The simplest way to make the DLLs that you build, or that you include from third parties, available is to put them in the same directory as your app. It's known as *app-local deployment*. For more information about deployment, see [Deployment in Visual C++](../windows/deployment-in-visual-cpp.md). +When you deploy your app, you must also deploy the DLLs it uses. The simplest way to make the DLLs that you build, or that you include from third parties, available is to put them in the same directory as your app. It's known as *app-local deployment*. For more information about deployment, see [Deployment in Microsoft C++](../windows/deployment-in-visual-cpp.md). ## See also diff --git a/docs/build/walkthrough-header-units.md b/docs/build/walkthrough-header-units.md index 2a21f566b61..4e7de18c974 100644 --- a/docs/build/walkthrough-header-units.md +++ b/docs/build/walkthrough-header-units.md @@ -1,6 +1,6 @@ --- description: "Learn more about C++ header units. Convert a header file to a header unit using Visual Studio 2022." -title: "Walkthrough: Build and import header units in Visual C++ projects" +title: "Walkthrough: Build and import header units in Microsoft C++ projects" ms.date: 09/29/2022 ms.custom: "conceptual" author: "tylermsft" @@ -9,7 +9,7 @@ helpviewer_keywords: ["import", "header unit", "ifc"] monikerRange: '>=msvc-160' --- -# Walkthrough: Build and import header units in Microsoft Visual C++ +# Walkthrough: Build and import header units in Microsoft C++ This article is about building and importing header units with Visual Studio 2022. To learn how to import C++ standard library headers as header units, see [Walkthrough: Import STL libraries as header units](walkthrough-import-stl-header-units.md). For an even faster and more robust way to import the standard library, see [Tutorial: Import the C++ standard library using modules](../cpp/tutorial-import-stl-named-module.md). diff --git a/docs/build/walkthrough-import-stl-header-units.md b/docs/build/walkthrough-import-stl-header-units.md index 3c2fd2d7e57..1f50e2518f9 100644 --- a/docs/build/walkthrough-import-stl-header-units.md +++ b/docs/build/walkthrough-import-stl-header-units.md @@ -221,5 +221,5 @@ The main consideration for whether to use this approach is the balance between c [Compare header units, modules, and precompiled headers](compare-inclusion-methods.md)\ [Tutorial: Import the C++ standard library using modules](../cpp/tutorial-import-stl-named-module.md)\ -[Walkthrough: Build and import header units in your Visual C++ projects](walkthrough-header-units.md)\ +[Walkthrough: Build and import header units in your Microsoft C++ projects](walkthrough-header-units.md)\ [`/translateInclude`](./reference/translateinclude.md) diff --git a/docs/build/walkthrough-using-msbuild-to-create-a-visual-cpp-project.md b/docs/build/walkthrough-using-msbuild-to-create-a-visual-cpp-project.md index 2e210281852..b96564b5d3c 100644 --- a/docs/build/walkthrough-using-msbuild-to-create-a-visual-cpp-project.md +++ b/docs/build/walkthrough-using-msbuild-to-create-a-visual-cpp-project.md @@ -4,9 +4,9 @@ description: "A walkthrough that shows how to create a command-line MSBuild C++ ms.date: 10/08/2020 helpviewer_keywords: ["MSBuild (C++), walkthrough: create a project"] --- -# Walkthrough: Using MSBuild to Create a Visual C++ Project +# Walkthrough: Using MSBuild to Create a Visual Studio C++ Project -This walkthrough demonstrates how to use MSBuild in a command prompt to build a Visual Studio C++ project. You'll learn how to create an XML-based *`.vcxproj`* project file for a Visual C++ console application. After building the project, you'll learn how to customize the build process. +This walkthrough demonstrates how to use MSBuild in a command prompt to build a Visual Studio C++ project. You'll learn how to create an XML-based *`.vcxproj`* project file for a C++ console application. After building the project, you'll learn how to customize the build process. > [!IMPORTANT] > Don't use this approach if you intend to edit the project file later by using the Visual Studio IDE. If you create a *`.vcxproj`* file manually, the Visual Studio IDE might not be able to edit or load it, especially if the project uses wildcards in project items. For more information, see [`.vcxproj` and `.props` file structure](./reference/vcxproj-file-structure.md) and [`.vcxproj` files and wildcards](./reference/vcxproj-files-and-wildcards.md). @@ -78,7 +78,7 @@ In this walkthrough, you'll create a project that has a source file and a header An MSBuild project file is an XML file that contains a project root element (``). In the example project you'll build, the `` element contains seven child elements: - Three item group tags (``) that specify project configuration and platform, source file name, and header file name. -- Three import tags (``) that specify the location of Microsoft Visual C++ settings. +- Three import tags (``) that specify the location of Microsoft C++ settings. - A property group tag (``) that specifies project settings. ### To create the MSBuild project file @@ -249,7 +249,7 @@ At the command prompt, enter this command to use the 64-bit tools to build your ### Using MSBuild with a different toolset -If you have the toolsets and libraries for other versions of Visual C++ installed, MSBuild can build applications for either the current Visual C++ version or for the other installed versions. For example, if you have installed Visual Studio 2012, to specify the Visual C++ 11.0 toolset for Windows XP, add this property group element to the *`Myproject.vcxproj`* project file after the *`Microsoft.Cpp.props`* file `` element: +If you have the toolsets and libraries for other versions of Microsoft C++ (MSVC) installed, MSBuild can build applications for either the current MSVC version or for the other installed versions. For example, if you have installed Visual Studio 2012, to specify the Visual C++ 11.0 toolset for Windows XP, add this property group element to the *`Myproject.vcxproj`* project file after the *`Microsoft.Cpp.props`* file `` element: ```xml diff --git a/docs/build/why-floating-point-numbers-may-lose-precision.md b/docs/build/why-floating-point-numbers-may-lose-precision.md index 7fc2eb91e9a..45605f0aa43 100644 --- a/docs/build/why-floating-point-numbers-may-lose-precision.md +++ b/docs/build/why-floating-point-numbers-may-lose-precision.md @@ -17,7 +17,7 @@ This behavior is the result of one of the following: To resolve the behavior, most programmers either ensure that the value is greater or less than what is needed, or they get and use a Binary Coded Decimal (BCD) library that will maintain the precision. -Binary representation of floating-point values affects the precision and accuracy of floating-point calculations. Microsoft Visual C++ uses [IEEE floating-point format](ieee-floating-point-representation.md). +Binary representation of floating-point values affects the precision and accuracy of floating-point calculations. Microsoft C++ uses [IEEE floating-point format](ieee-floating-point-representation.md). ## Example diff --git a/docs/build/working-with-project-properties.md b/docs/build/working-with-project-properties.md index 3540aad87db..b6ca518f4c8 100644 --- a/docs/build/working-with-project-properties.md +++ b/docs/build/working-with-project-properties.md @@ -41,7 +41,7 @@ For more information about setting properties for a Debug build, see: - [Project settings for a C++ debug configuration](/visualstudio/debugger/project-settings-for-a-cpp-debug-configuration) - [Debugger Settings and Preparation](/visualstudio/debugger/debugger-settings-and-preparation) -- [Debugging Preparation: Visual C++ Project Types](/visualstudio/debugger/debugging-preparation-visual-cpp-project-types) +- [Debugging Preparation: Microsoft C++ Project Types](/visualstudio/debugger/debugging-preparation-visual-cpp-project-types) - [Specify symbol (.pdb) and source files in the Visual Studio debugger](/visualstudio/debugger/specify-symbol-dot-pdb-and-source-files-in-the-visual-studio-debugger) ## C++ compiler and linker options diff --git a/docs/build/x64-calling-convention.md b/docs/build/x64-calling-convention.md index bf4a575b47f..a1265ca7cfc 100644 --- a/docs/build/x64-calling-convention.md +++ b/docs/build/x64-calling-convention.md @@ -8,7 +8,8 @@ ms.topic: concept-article This article describes the standard processes and conventions that one function (the caller) uses to make calls into another function (the callee) in x64 code. -For more information about the `__vectorcall` calling convention, see [__vectorcall](../cpp/vectorcall.md). +For more information about the `__vectorcall` calling convention, see [__vectorcall](../cpp/vectorcall.md). +For more information about the `__preserve_none` calling convention, see [__preserve_none](../cpp/preserve-none.md). ## Calling convention defaults @@ -18,7 +19,7 @@ There's a strict one-to-one correspondence between a function call's arguments a The x87 register stack is unused. It might be used by the callee, but consider it volatile across function calls. All floating point operations are done using the 16 XMM registers. -Integer arguments are passed in registers RCX, RDX, R8, and R9. Floating point arguments are passed in XMM0L, XMM1L, XMM2L, and XMM3L. 16-byte arguments are passed by reference. Parameter passing is described in detail in [Parameter passing](#parameter-passing). These registers, and RAX, R10, R11, XMM4, and XMM5, are considered *volatile*, or potentially changed by a callee on return. Register usage is documented in detail in [x64 register usage](x64-software-conventions.md#x64-register-usage) and [Caller/callee saved registers](#callercallee-saved-registers). +Integer arguments are passed in registers `RCX`, `RDX`, `R8`, and `R9`. Floating point arguments are passed in `XMM0L`, `XMM1L`, `XMM2L`, and `XMM3L`. 16-byte arguments are passed by reference. Parameter passing is described in detail in [Parameter passing](#parameter-passing). These registers, and `RAX`, `R10`, `R11`, `XMM4`, and `XMM5`, are considered *volatile*, or potentially changed by a callee on return. Register usage is documented in detail in [x64 register usage](x64-software-conventions.md#x64-register-usage) and [Caller/callee saved registers](#callercallee-saved-registers). For prototyped functions, all arguments are converted to the expected callee types before passing. The caller is responsible for allocating space for the callee's parameters. The caller must always allocate sufficient space to store four register parameters, even if the callee doesn't take that many parameters. This convention simplifies support for unprototyped C-language functions and vararg C/C++ functions. For vararg or unprototyped functions, any floating point values must be duplicated in the corresponding general-purpose register. Any parameters beyond the first four must be stored on the stack after the shadow store before the call. Vararg function details can be found in [Varargs](#varargs). Unprototyped function information is detailed in [Unprototyped functions](#unprototyped-functions). @@ -28,17 +29,17 @@ Most structures are aligned to their natural alignment. The primary exceptions a ## Unwindability -Leaf functions are functions that don't change any nonvolatile registers. A nonleaf function might change nonvolatile RSP, for example, by calling a function. Or, it could change RSP by allocating more stack space for local variables. To recover nonvolatile registers when an exception is handled, nonleaf functions are annotated with static data. The data describes how to properly unwind the function at an arbitrary instruction. This data is stored as *pdata*, or procedure data, which in turn refers to *xdata*, the exception handling data. The xdata contains the unwinding information, and can point to additional pdata or an exception handler function. +Leaf functions are functions that don't change any nonvolatile registers. A nonleaf function might change nonvolatile `RSP`, for example, by calling a function. Or, it could change `RSP` by allocating more stack space for local variables. To recover nonvolatile registers when an exception is handled, nonleaf functions are annotated with static data. The data describes how to properly unwind the function at an arbitrary instruction. This data is stored as *pdata*, or procedure data, which in turn refers to *xdata*, the exception handling data. The xdata contains the unwinding information, and can point to additional pdata or an exception handler function. Prologs and epilogs are highly restricted so that they can be properly described in xdata. The stack pointer must remain 16-byte aligned in any region of code that isn't part of an epilog or prolog, except within leaf functions. Leaf functions can be unwound simply by simulating a return, so pdata and xdata aren't required. For details about the proper structure of function prologs and epilogs, see [x64 prolog and epilog](../build/prolog-and-epilog.md). For more information about exception handling, and the exception handling and unwinding of pdata and xdata, see [x64 exception handling](../build/exception-handling-x64.md). ## Parameter passing -By default, the x64 calling convention passes the first four arguments to a function in registers. The registers used for these arguments depend on the position and type of the argument. Remaining arguments get pushed on the stack in right-to-left order. All arguments passed on the stack are 8-byte aligned. +By default, the x64 calling convention passes the first four arguments to a function in registers. The registers used for these arguments depend on the position and type of the argument. Remaining arguments are passed on the stack in right-to-left order. The caller reserves the required stack space and writes these arguments to stack memory using store or move instructions, maintaining 8-byte alignment for each argument. -Integer valued arguments in the leftmost four positions are passed in left-to-right order in RCX, RDX, R8, and R9, respectively. The fifth and higher arguments are passed on the stack as previously described. All integer arguments in registers are right-justified, so the callee can ignore the upper bits of the register and access only the portion of the register necessary. +Integer valued arguments in the leftmost four positions are passed in left-to-right order in `RCX`, `RDX`, `R8`, and `R9`, respectively. The fifth and higher arguments are passed on the stack as previously described. All integer arguments in registers are right-justified, so the callee can ignore the upper bits of the register and access only the portion of the register necessary. -Any floating-point and double-precision arguments in the first four parameters are passed in XMM0 - XMM3, depending on position. Floating-point values are only placed in the integer registers RCX, RDX, R8, and R9 when there are varargs arguments. For details, see [Varargs](#varargs). Similarly, the XMM0 - XMM3 registers are ignored when the corresponding argument is an integer or pointer type. +Any floating-point and double-precision arguments in the first four parameters are passed in `XMM0` - `XMM3`, depending on position. Floating-point values are only placed in the integer registers `RCX`, `RDX`, `R8`, and `R9` when there are varargs arguments. For details, see [Varargs](#varargs). Similarly, the `XMM0` - `XMM3` registers are ignored when the corresponding argument is an integer or pointer type. [`__m128`](../cpp/m128.md) types, arrays, and strings are never passed by immediate value. Instead, a pointer is passed to memory allocated by the caller. Structs and unions of size 8, 16, 32, or 64 bits, and **`__m64`** types, are passed as if they were integers of the same size. Structs or unions of other sizes are passed as a pointer to memory allocated by the caller. For these aggregate types passed as a pointer, including **`__m128`**, the caller-allocated temporary memory must be 16-byte aligned. @@ -50,31 +51,31 @@ The following table summarizes how parameters are passed, by type and position f | Parameter type | fifth and higher | fourth | third | second | leftmost | |-|-|-|-|-|-| -| floating-point | stack | XMM3 | XMM2 | XMM1 | XMM0 | -| integer | stack | R9 | R8 | RDX | RCX | -| Aggregates (8, 16, 32, or 64 bits) and **`__m64`** | stack | R9 | R8 | RDX | RCX | -| Other aggregates, as pointers | stack | R9 | R8 | RDX | RCX | -| **`__m128`**, as a pointer | stack | R9 | R8 | RDX | RCX | +| floating-point | stack | `XMM3` | `XMM2` | `XMM1` | `XMM0` | +| integer | stack | `R9` | `R8` | `RDX` | `RCX` | +| Aggregates (8, 16, 32, or 64 bits) and **`__m64`** | stack | `R9` | `R8` | `RDX` | `RCX` | +| Other aggregates, as pointers | stack | `R9` | `R8` | `RDX` | `RCX` | +| **`__m128`**, as a pointer | stack | `R9` | `R8` | `RDX` | `RCX` | ### Example of argument passing 1 - all integers ```cpp func1(int a, int b, int c, int d, int e, int f); -// a in RCX, b in RDX, c in R8, d in R9, f then e pushed on stack +// a in RCX, b in RDX, c in R8, d in R9, f then e passed on stack ``` ### Example of argument passing 2 - all floats ```cpp func2(float a, double b, float c, double d, float e, float f); -// a in XMM0, b in XMM1, c in XMM2, d in XMM3, f then e pushed on stack +// a in XMM0, b in XMM1, c in XMM2, d in XMM3, f then e passed on stack ``` ### Example of argument passing 3 - mixed ints and floats ```cpp func3(int a, double b, int c, float d, int e, float f); -// a in RCX, b in XMM1, c in R8, d in XMM3, f then e pushed on stack +// a in RCX, b in XMM1, c in R8, d in XMM3, f then e passed on stack ``` ### Example of argument passing 4 - `__m64`, `__m128`, and aggregates @@ -82,7 +83,7 @@ func3(int a, double b, int c, float d, int e, float f); ```cpp func4(__m64 a, __m128 b, struct c, float d, __m128 e, __m128 f); // a in RCX, ptr to b in RDX, ptr to c in R8, d in XMM3, -// ptr to f pushed on stack, then ptr to e pushed on stack +// ptr to f passed on stack, then ptr to e passed on stack ``` ## Varargs @@ -102,9 +103,9 @@ func2() { // RCX = 2, RDX = XMM1 = 1.0, and R8 = 7 ## Return values -A scalar return value that can fit into 64 bits, including the `__m64` type, is returned through RAX. Nonscalar types including floats, doubles, and vector types such as [`__m128`](../cpp/m128.md), [`__m128i`](../cpp/m128i.md), [`__m128d`](../cpp/m128d.md) are returned in XMM0. The state of unused bits in the value returned in RAX or XMM0 is undefined. +A scalar return value that can fit into 64 bits, including the `__m64` type, is returned through `RAX`. Nonscalar types including floats, doubles, and vector types such as [`__m128`](../cpp/m128.md), [`__m128i`](../cpp/m128i.md), [`__m128d`](../cpp/m128d.md) are returned in `XMM0`. The state of unused bits in the value returned in `RAX` or `XMM0` is undefined. -User-defined types can be returned by value from global functions and static member functions. To return a user-defined type by value in RAX, it must have a length of 1, 2, 4, 8, 16, 32, or 64 bits. It must also have no user-defined constructor, destructor, or copy assignment operator. It can have no private or protected nonstatic data members, and no nonstatic data members of reference type. It can't have base classes or virtual functions. And, it can only have data members that also meet these requirements. This definition is essentially the same as a C++03 POD type. Because the definition has changed in the C++11 standard, we don't recommend using `std::is_pod` for this test. Otherwise, the caller must allocate memory for the return value and pass a pointer to it as the first argument. The remaining arguments are then shifted one argument to the right. The same pointer must be returned by the callee in RAX. +User-defined types can be returned by value from global functions and static member functions. To return a user-defined type by value in `RAX`, it must have a length of 1, 2, 4, 8, 16, 32, or 64 bits. It must also have no user-defined constructor, destructor, or copy assignment operator. It can have no private or protected nonstatic data members, and no nonstatic data members of reference type. It can't have base classes or virtual functions. And, it can only have data members that also meet these requirements. This definition is essentially the same as a C++03 POD type. Because the definition has changed in the C++11 standard, we don't recommend using `std::is_pod` for this test. Otherwise, the caller must allocate memory for the return value and pass a pointer to it as the first argument. The remaining arguments are then shifted one argument to the right. The same pointer must be returned by the callee in `RAX`. These examples show how parameters and return values are passed for functions with the specified declarations: @@ -112,7 +113,7 @@ These examples show how parameters and return values are passed for functions wi ```cpp __int64 func1(int a, float b, int c, int d, int e); -// Caller passes a in RCX, b in XMM1, c in R8, d in R9, e pushed on stack, +// Caller passes a in RCX, b in XMM1, c in R8, d in R9, e passed on stack, // callee returns __int64 result in RAX. ``` @@ -132,7 +133,7 @@ struct Struct1 { }; Struct1 func3(int a, double b, int c, float d); // Caller allocates memory for Struct1 returned and passes pointer in RCX, -// a in RDX, b in XMM2, c in R9, d pushed on the stack; +// a in RDX, b in XMM2, c in R9, d passed on the stack; // callee returns pointer to Struct1 result in RAX. ``` @@ -149,9 +150,11 @@ Struct2 func4(int a, double b, int c, float d); ## Caller/callee saved registers -The x64 ABI considers the registers RAX, RCX, RDX, R8, R9, R10, R11, and XMM0-XMM5 volatile. When present, the upper portions of YMM0-YMM15 and ZMM0-ZMM15 are also volatile. On AVX512VL, the ZMM, YMM, and XMM registers 16-31 are also volatile. When AMX support is present, the TMM tile registers are volatile. Consider volatile registers destroyed on function calls unless otherwise safety-provable by analysis such as whole program optimization. +The x64 ABI considers the registers `RAX`, `RCX`, `RDX`, `R8`, `R9`, `R10`, `R11`, and `XMM0`-`XMM5` volatile. When present, the upper portions of `YMM0`-`YMM15` and `ZMM0`-`ZMM15` are also volatile. On AVX512VL, the `ZMM`, `YMM`, and `XMM` registers 16-31 are also volatile. When AMX support is present, the `TMM` tile registers are volatile. Consider volatile registers destroyed on function calls unless otherwise safety-provable by analysis such as whole program optimization. -The x64 ABI considers registers RBX, RBP, RDI, RSI, RSP, R12, R13, R14, R15, and XMM6-XMM15 nonvolatile. They must be saved and restored by a function that uses them. +The x64 ABI considers registers `RBX`, `RBP`, `RDI`, `RSI`, `RSP`, `R12`, `R13`, `R14`, `R15`, and `XMM6`-`XMM15` nonvolatile. They must be saved and restored by a function that uses them. + +When APX support is present, registers `R16`-`R29` are volatile. `R30` and `R31` are nonvolatile. ## Function pointers @@ -159,7 +162,7 @@ Function pointers are simply pointers to the label of the respective function. T ## Floating-point support for older code -The MMX and floating-point stack registers (MM0-MM7/ST0-ST7) are preserved across context switches. There's no explicit calling convention for these registers. The use of these registers is strictly prohibited in kernel mode code. +The MMX and floating-point stack registers (`MM0`-`MM7`/`ST0`-`ST7`) are preserved across context switches. There's no explicit calling convention for these registers. The use of these registers is strictly prohibited in kernel mode code. ## FPCSR @@ -169,48 +172,84 @@ The x87 FPU control word register gets set using the following standard values a | Register\[bits] | Setting | |-|-| -| FPCSR\[0:6] | Exception masks all 1s (all exceptions masked) | -| FPCSR\[7] | Reserved - 0 | -| FPCSR\[8:9] | Precision Control - 10B (double precision) | -| FPCSR\[10:11] | Rounding control - 0 (round to nearest) | -| FPCSR\[12] | Infinity control - 0 (not used) | +| `FPCSR\[0:6]` | Exception masks all 1s (all exceptions masked) | +| `FPCSR\[7]` | Reserved - 0 | +| `FPCSR\[8:9]` | Precision Control - 10B (double precision) | +| `FPCSR\[10:11]` | Rounding control - 0 (round to nearest) | +| `FPCSR\[12]` | Infinity control - 0 (not used) | -A callee that modifies any of the fields within FPCSR must restore them before returning to its caller. Furthermore, a caller that has modified any of these fields must restore them to their standard values before invoking a callee, unless by agreement the callee expects the modified values. +A callee that modifies any of the fields within `FPCSR` must restore them before returning to its caller. Furthermore, a caller that has modified any of these fields must restore them to their standard values before invoking a callee, unless by agreement the callee expects the modified values. There are two exceptions to the rules about the nonvolatility of the control flags: -- In functions where the documented purpose of the given function is to modify the nonvolatile FPCSR flags. +- In functions where the documented purpose of the given function is to modify the nonvolatile `FPCSR` flags. - When it's provably correct that the violation of these rules results in a program that behaves the same as a program that doesn't violate the rules, for example, through whole-program analysis. +Despite being considered nonvolatile, there is no static unwind descriptor describing where it was saved and where it should be restored from. Exception-safe code which modifies `FPCSR` should resort to an exception finalizer (e.g. C++ destructor or a `__finally` clause) to restore it explicitly, when unwinding the stack. + ## MXCSR -The register state also includes MXCSR. The calling convention divides this register into a volatile portion and a nonvolatile portion. The volatile portion consists of the six status flags, in MXCSR\[0:5], while the rest of the register, MXCSR\[6:15], is considered nonvolatile. +The register state also includes `MXCSR`. The calling convention divides this register into a volatile portion and a nonvolatile portion. The volatile portion consists of the six status flags, in `MXCSR\[0:5]`, while the rest of the register, `MXCSR\[6:15]`, is considered nonvolatile. The nonvolatile portion is set to the following standard values at the start of program execution: | Register\[bits] | Setting | |-|-| -| MXCSR\[6] | Denormals are zeros - 0 | -| MXCSR\[7:12] | Exception masks all 1s (all exceptions masked) | -| MXCSR\[13:14] | Rounding control - 0 (round to nearest) | -| MXCSR\[15] | Flush to zero for masked underflow - 0 (off) | +| `MXCSR\[6]` | Denormals are zeros - 0 | +| `MXCSR\[7:12]` | Exception masks all 1s (all exceptions masked) | +| `MXCSR\[13:14]` | Rounding control - 0 (round to nearest) | +| `MXCSR\[15]` | Flush to zero for masked underflow - 0 (off) | -A callee that modifies any of the nonvolatile fields within MXCSR must restore them before returning to its caller. Furthermore, a caller that has modified any of these fields must restore them to their standard values before invoking a callee, unless by agreement the callee expects the modified values. +A callee that modifies any of the nonvolatile fields within `MXCSR` must restore them before returning to its caller. Furthermore, a caller that has modified any of these fields must restore them to their standard values before invoking a callee, unless by agreement the callee expects the modified values. There are two exceptions to the rules about the nonvolatility of the control flags: -- In functions where the documented purpose of the given function is to modify the nonvolatile MXCSR flags. +- In functions where the documented purpose of the given function is to modify the nonvolatile `MXCSR` flags. - When it's provably correct that the violation of these rules results in a program that behaves the same as a program that doesn't violate the rules, for example, through whole-program analysis. -Make no assumptions about the MXCSR register's volatile portion state across a function boundary, unless the function documentation explicitly describes it. +Make no assumptions about the `MXCSR` register's volatile portion state across a function boundary, unless the function documentation explicitly describes it. + +Despite parts of `MXCSR` being considered nonvolatile, there is no static unwind descriptor describing where it was saved and where it should be restored from. Exception-safe code which modifies the nonvolatile portions of `MXCSR` should resort to an exception finalizer (e.g. C++ destructor or a `__finally` clause) to restore it explicitly, when unwinding the stack. ## setjmp/longjmp When you include `setjmpex.h` or `setjmp.h`, all calls to [`setjmp`](../c-runtime-library/reference/setjmp.md) or [`longjmp`](../c-runtime-library/reference/longjmp.md) result in an unwind that invokes destructors and `__finally` calls. This behavior differs from x86, where including `setjmp.h` results in `__finally` clauses and destructors not being invoked. -A call to `setjmp` preserves the current stack pointer, nonvolatile registers, and MXCSR registers. Calls to `longjmp` return to the most recent `setjmp` call site and resets the stack pointer, nonvolatile registers, and MXCSR registers, back to the state as preserved by the most recent `setjmp` call. +A call to `setjmp` preserves the current stack pointer, nonvolatile registers, and `MXCSR` registers. Calls to `longjmp` return to the most recent `setjmp` call site and resets the stack pointer, nonvolatile registers, and `MXCSR` registers, back to the state as preserved by the most recent `setjmp` call. + +If APX is supported, `R30` and `R31` should not be modified in a function from the point `setjmp` is called to the point where the call which ultimately results in `longjmp` is made. This limitation is the result of `R30` and `R31` not being saved as part of `jmp_buf` - this structure definition cannot change. Instead, they are restored via the unwinder. The following example demonstrates how the difference on how the data is restored influences this restriction: + +```c +jmp_buf jmpbuffer; + +void function_a() { + ... + + int val = setjmp(jmpbuffer); // At this time R30 is 10 + + ... + + if (val == 0) { + function_b(); // At this time R30 is 20 + } + + ... +} + +void function_b() { + ... + + longjmp(jmpbuffer, 1); + + ... +} +``` + +In this example, the value of `R30` changes from the point where `setjmp` is called to the point `function_b` is called. In `function_b`, `longjmp` unwinds the stack until it reaches the function which called `setjmp` (`function_a` in this case). The value restored for `R30` will be `20` (the value at the point `function_b` was called), not `10` (the value at which `setjmp` was called). This means that when `setjmp` returns for the second time (as the result of `longjmp`) the value of `R30` will be set to `20` instead of `10`, which is incorrect. This is why compilers must ensure `R30` and `R31` remain constant from the point `setjmp` is called to the last place in the function which could ultimately result in `longjmp` being called. + +Since `longjmp` can be called from an exception filter (not just a sub-routine), this effectively dictates that `R30` and `R31` should remain constant from the point `setjmp` is called through the rest of the function. ## See also diff --git a/docs/build/x64-software-conventions.md b/docs/build/x64-software-conventions.md index 7f8229a5313..fdb9f859bd9 100644 --- a/docs/build/x64-software-conventions.md +++ b/docs/build/x64-software-conventions.md @@ -187,7 +187,7 @@ If you require more strict alignment, use `__declspec(align(N))` on your variabl ## x64 register usage -The x64 architecture provides for 16 general-purpose registers (hereafter referred to as integer registers) as well as 16 XMM/YMM registers available for floating-point use. Volatile registers are scratch registers presumed by the caller to be destroyed across a call. Nonvolatile registers are required to retain their values across a function call and must be saved by the callee if used. +The x64 architecture provides for 16 general-purpose registers (hereafter referred to as integer registers) as well as 16 `XMM`/`YMM` registers available for floating-point use. Volatile registers are scratch registers presumed by the caller to be destroyed across a call. Nonvolatile registers are required to retain their values across a function call and must be saved by the callee if used. ### Register volatility and preservation @@ -195,25 +195,27 @@ The following table describes how each register is used across function calls: |Register|Status|Use| |-|-|-| -|RAX|Volatile|Return value register| -|RCX|Volatile|First integer argument| -|RDX|Volatile|Second integer argument| -|R8|Volatile|Third integer argument| -|R9|Volatile|Fourth integer argument| -|R10:R11|Volatile|Must be preserved as needed by caller; used in syscall/sysret instructions| -|R12:R15|Nonvolatile|Must be preserved by callee| -|RDI|Nonvolatile|Must be preserved by callee| -|RSI|Nonvolatile|Must be preserved by callee| -|RBX|Nonvolatile|Must be preserved by callee| -|RBP|Nonvolatile|May be used as a frame pointer; must be preserved by callee| -|RSP|Nonvolatile|Stack pointer| -|XMM0, YMM0|Volatile|First FP argument; first vector-type argument when **`__vectorcall`** is used| -|XMM1, YMM1|Volatile|Second FP argument; second vector-type argument when **`__vectorcall`** is used| -|XMM2, YMM2|Volatile|Third FP argument; third vector-type argument when **`__vectorcall`** is used| -|XMM3, YMM3|Volatile|Fourth FP argument; fourth vector-type argument when **`__vectorcall`** is used| -|XMM4, YMM4|Volatile|Must be preserved as needed by caller; fifth vector-type argument when **`__vectorcall`** is used| -|XMM5, YMM5|Volatile|Must be preserved as needed by caller; sixth vector-type argument when **`__vectorcall`** is used| -|XMM6:XMM15, YMM6:YMM15|Nonvolatile (XMM), Volatile (upper half of YMM)|Must be preserved by callee. YMM registers must be preserved as needed by caller.| +|`RAX`|Volatile|Return value register| +|`RCX`|Volatile|First integer argument| +|`RDX`|Volatile|Second integer argument| +|`R8`|Volatile|Third integer argument| +|`R9`|Volatile|Fourth integer argument| +|`R10`:`R11`|Volatile|Must be preserved as needed by caller; used in syscall/sysret instructions| +|`R12`:`R15`|Nonvolatile|Must be preserved by callee| +|`R16`:`R29`|Volatile|Must be preserved by callee (APX Register)| +|`R30`:`R31`|Nonvolatile|Must be preserved by callee (APX Register)| +|`RDI`|Nonvolatile|Must be preserved by callee| +|`RSI`|Nonvolatile|Must be preserved by callee| +|`RBX`|Nonvolatile|Must be preserved by callee| +|`RBP`|Nonvolatile|May be used as a frame pointer; must be preserved by callee| +|`RSP`|Nonvolatile|Stack pointer| +|`XMM0`, `YMM0`|Volatile|First FP argument; first vector-type argument when **`__vectorcall`** is used| +|`XMM1`, `YMM1`|Volatile|Second FP argument; second vector-type argument when **`__vectorcall`** is used| +|`XMM2`, `YMM2`|Volatile|Third FP argument; third vector-type argument when **`__vectorcall`** is used| +|`XMM3`, `YMM3`|Volatile|Fourth FP argument; fourth vector-type argument when **`__vectorcall`** is used| +|`XMM4`, `YMM4`|Volatile|Must be preserved as needed by caller; fifth vector-type argument when **`__vectorcall`** is used| +|`XMM5`, `YMM5`|Volatile|Must be preserved as needed by caller; sixth vector-type argument when **`__vectorcall`** is used| +|`XMM6`:`XMM15`, `YMM6`:`YMM15`|Nonvolatile (`XMM`), Volatile (upper half of `YMM`)|Must be preserved by callee. `YMM` registers must be preserved as needed by caller.| On function exit and on function entry to C Runtime Library calls and Windows system calls, the direction flag in the CPU flags register is expected to be cleared. diff --git a/docs/build/x64-unwind-information-v3.md b/docs/build/x64-unwind-information-v3.md new file mode 100644 index 00000000000..246d81ca455 --- /dev/null +++ b/docs/build/x64-unwind-information-v3.md @@ -0,0 +1,422 @@ +--- +title: x64 Unwind Information V3 +description: Exception Handling Unwind Information V3 - Preview Specification +ms.date: 05/18/2026 +author: pmsjt +ms.author: pedrot +ms.reviewer: pedrot +--- + +# Exception Handling Unwind Information V3 + +## Scope + +Unwind Information V3 adds support for the Intel APX (Advanced Performance Extensions). It also brings additional flexibility to the code generation allowed in both function prologues and epilogues, enabling compilers to better optimize functions as a whole. + +Unwind V3 is required for code supporting APX. Non-APX enabled code should still use the [conventional (pre-V3) Unwind Information](../build/exception-handling-x64.md). + +> [!WARNING] +> Unwind Information V3 is a preview specification. There's still a risk of breaking changes or omissions. Code produced under this guidance should itself be considered preview code. + +## Terminology + +| Term | Definition | +|------|------------| +| **Fragment** | A contiguous region of machine code described by a single `RUNTIME_FUNCTION` / `UNWIND_INFO_V3` pair. A function might consist of a *main fragment* and zero or more *subfragments* chained together. For more information, see [Chained unwind info structures](../build/exception-handling-x64.md#chained-unwind-info-structures). | +| **WOD** | The Winding Operation Descriptor is a variable-length packed encoding of a single unwind operation (push, alloc, save, and so on). | +| **WOD pool** | The byte array within the payload that stores all WODs for a fragment's prolog and epilog(s). | +| **IP Offset** | The unsigned byte offset of an instruction relative to the start of the prolog or epilog. | +| **Payload** | The variable-length region immediately after the 4-byte `UNWIND_INFO_V3` header, sized by `PayloadWords` 16-bit words. Contains the large prolog extension, prolog IP offsets, epilog descriptors (with their IP offsets), and the WOD pool. | +| **RVA** | Relative Virtual Address is the offset from the base address of the image at load time. | + +## Overall Object-File Layout + +Unwind V3 reuses the existing PE/COFF `.pdata` and `.xdata` section conventions unchanged: + +``` +.pdata - sorted array of IMAGE_AMD64_RUNTIME_FUNCTION_ENTRY (12 bytes each) +.xdata - UNWIND_INFO_V3 structures referenced by .pdata entries +``` + +Each `RUNTIME_FUNCTION` entry is: + +| Offset | Size | Field | +|--------|------|-------| +| 0 | 4 | `BeginAddress` - RVA of fragment start | +| 4 | 4 | `EndAddress` - RVA of first byte past fragment end | +| 8 | 4 | `UnwindInfoAddress` - RVA of `UNWIND_INFO_V3` in `.xdata` | + +No changes from V1 or V2. + +## `UNWIND_INFO_V3` Header + +All multi-byte fields are little-endian. Bit 0 is the LSB of each byte. + +| Byte | Bits | Field | Width | +|------|------|-------|-------| +| 0 | [2:0] | `Version` (= 3) | 3 bits | +| 0 | [7:3] | `Flags` | 5 bits | +| 1 | [7:0] | `SizeOfProlog` | 8 bits | +| 2 | [7:0] | `PayloadWords` | 8 bits | +| 3 | [4:0] | `NumberOfOps` | 5 bits | +| 3 | [7:5] | `NumberOfEpilogs` | 3 bits | + +### Field Semantics + +| Field | Description | +|-------|-------------| +| `Version` | Must be `3`. | +| `Flags` | Same flag definitions as V1 or V2: `UNW_FLAG_EHANDLER` (0x01), `UNW_FLAG_UHANDLER` (0x02), `UNW_FLAG_CHAININFO` (0x04). New in V3: `UNW_FLAG_LARGE` (0x08). Bit 4 reserved (zero). | +| `SizeOfProlog` | Byte offset to the start of the first instruction that isn't part of the prolog. When `UNW_FLAG_LARGE` is set, this 8-bit field is the low byte of a 16-bit prolog size. For more information on the 16-bit form, see [`UNW_FLAG_LARGE` and `UNWIND_INFO_LARGE_V3`](#unw_flag_large-and-unwind_info_large_v3). | +| `PayloadWords` | Number of 16-bit words of payload following this header. The payload contains prolog IP offsets, all epilog descriptors (including their IP offsets), and the WOD pool. Doesn't include the exception-handler RVA or chained `RUNTIME_FUNCTION` that might follow. The algorithm to locate the handler/chain data is the same as V1 or V2: `header + 4 + PayloadWords * 2`, DWORD-aligned. | +| `NumberOfOps` | Count of WODs in the prolog (0–31). Zero means no prolog. If a function needs more than 31 prolog operations, use a subfragment. | +| `NumberOfEpilogs` | Count of `EPILOG_INFO_V3` descriptors that follow the prolog IP offsets (0–7). Zero means no epilogs in this fragment. If more than 7 are needed, use a subfragment. | + +### `UNW_FLAG_LARGE` and `UNWIND_INFO_LARGE_V3` + +When `UNW_FLAG_LARGE` is set in the header `Flags`, the first byte of the payload is a 1-byte `UNWIND_INFO_LARGE_V3` extension: + +| Byte | Bits | Field | Width | +|------|------|-------|-------| +| 0 | [7:0] | `SizeOfPrologHighByte` | 8 bits | + +`SizeOfPrologHighByte` is combined with `UNWIND_INFO_V3.SizeOfProlog` to form a 16-bit prolog size: `SizeOfProlog16 = (SizeOfPrologHighByte << 8) | SizeOfProlog`. + +Additionally, when `UNW_FLAG_LARGE` is set: + +- Prolog IP offset entries are 16-bit unsigned (2 bytes each) instead of 8-bit. + +The `UNWIND_INFO_LARGE_V3` byte is part of the payload and is included in `PayloadWords`. The handler-offset formula remains unchanged. + +This flag is only necessary for prologs exceeding 255 bytes. + +### Locating Exception Handler / Chain Info + +Identical to V1 or V2: + +``` +handler_offset = ALIGN_UP(sizeof(UNWIND_INFO_V3) + PayloadWords * 2, 4) +``` + +If `UNW_FLAG_EHANDLER` or `UNW_FLAG_UHANDLER` is set, a 4-byte handler RVA is at `handler_offset`, followed by language-specific handler data. + +If `UNW_FLAG_CHAININFO` is set, a 12-byte `RUNTIME_FUNCTION` is at `handler_offset`. + +## Payload Layout + +Immediately after the 4-byte header, the payload is arranged in the following order (all packed, `#pragma pack(1)` semantics): + +1. `UNWIND_INFO_LARGE_V3` - 1 byte, present only if `UNW_FLAG_LARGE` is set. +1. Prolog IP Offsets - `NumberOfOps` bytes (or 16-bit words if `UNW_FLAG_LARGE`). +1. For each epilog (repeated `NumberOfEpilogs` times): + - `EPILOG_INFO_V3` descriptor. + - `EPILOG_INFO_EX_V3` or `EPILOG_INFO_LARGE_EX_V3` extended descriptor (present only when `NumberOfOps > 0`). + - IP Offset array - `NumberOfOps` bytes (or 16-bit words if `EPILOG_INFO_LARGE`). +1. WOD Pool - remaining bytes. + +Total size = `PayloadWords` × 2 bytes (may include padding to fill words). + +### Prolog IP Offsets + +An array of `NumberOfOps` entries. Each entry is an unsigned byte giving the IP offset from the start of the fragment of the instruction that performs the corresponding unwind operation. When `UNW_FLAG_LARGE` is set, each entry is an unsigned 16-bit word instead. + +**Ordering:** The first entry corresponds to the operation closest to the function body (the *last* prolog instruction with an unwind effect). The last entry corresponds to the operation closest to the function entry point (the *first* prolog instruction). This matches the V1 or V2 convention of listing unwind codes in reverse execution order. The prolog WODs always start at byte offset zero of the WOD pool, and this same ordering applies. + +### Epilog Descriptors + +Zero or more `EPILOG_INFO_V3` structures follow the prolog IP offsets. Each can have an optional `EPILOG_INFO_EX_V3` (or `EPILOG_INFO_LARGE_EX_V3` when the `EPILOG_INFO_LARGE` flag is set) plus its own variable-size IP offset array, of size `NumberOfOps`: + +#### When `NumberOfOps > 0` (full descriptor) + +**Standard form** (`EPILOG_INFO_LARGE` not set): + +`EPILOG_INFO_V3`: + +| Byte | Bits | Field | Width | +|------|------|-------|-------| +| 0 | [2:0] | `Flags` | 3 bits | +| 0 | [7:3] | `NumberOfOps` | 5 bits | +| 1–2 | [15:0] | `EpilogOffset` | 16-bit signed | + +`EPILOG_INFO_EX_V3`: + +| Byte | Bits | Field | Width | +|------|------|-------|-------| +| 0–1 | [15:0] | `FirstOp` | 16-bit unsigned | +| 2 | [7:0] | `IpOffsetOfLastInstruction` | 8 bits unsigned | +| 3 .. | - | IP Offset array | `NumberOfOps` bytes, unsigned | + +**Large form** (`EPILOG_INFO_LARGE` set): + +`EPILOG_INFO_V3`: + +| Byte | Bits | Field | Width | +|------|------|-------|-------| +| 0 | [2:0] | `Flags` | 3 bits | +| 0 | [7:3] | `NumberOfOps` | 5 bits | +| 1–2 | [15:0] | `EpilogOffset` | 16-bit signed | + +`EPILOG_INFO_LARGE_EX_V3`: + +| Byte | Bits | Field | Width | +|------|------|-------|-------| +| 0–1 | [15:0] | `FirstOp` | 16-bit unsigned | +| 2–3 | [15:0] | `IpOffsetOfLastInstruction` | 16 bits unsigned | +| 4 .. | - | IP Offset array | `NumberOfOps` × 2 bytes, unsigned 16-bit | + +#### When `NumberOfOps == 0` (inherited descriptor) + +`EPILOG_INFO_V3`: + +| Byte | Bits | Field | Width | +|------|------|-------|-------| +| 0 | [2:0] | `Flags` | 3 bits | +| 0 | [7:3] | `NumberOfOps` (= 0) | 5 bits | +| 1–2 | [15:0] | `EpilogOffset` | 16-bit signed | + +The `Flags` bits 0 and 1, `FirstOp`, `IpOffsetOfLastInstruction`, and IP offset array are inherited from the immediately preceding `EPILOG_INFO_V3`. + +#### Epilog Field Semantics + +| Field | Description | +|-------|-------------| +| `Flags` | Bit 0: `EPILOG_INFO_PARENT_FRAGMENT_TRANSFER` - set if this epilog transfers control back to the parent fragment (for example, via JMP) rather than returning to the caller. Bit 1: `EPILOG_INFO_LARGE` - when set, the extended descriptor uses `EPILOG_INFO_LARGE_EX_V3` (16-bit `IpOffsetOfLastInstruction`) and each IP offset entry is 16-bit, accommodating epilogs exceeding 255 bytes. Bit 2: reserved (zero). | +| `NumberOfOps` | Number of WODs for this epilog (0–31). Zero is a special value meaning "inherit from previous epilog descriptor." | +| `EpilogOffset` | 16-bit signed displacement to the first instruction of this epilog. For the first epilog descriptor: positive values are byte offsets from the fragment start, and negative values are byte offsets from the fragment tail, that is, the first byte past the end. For subsequent epilog descriptors: delta from the start of the previous epilog. All epilogs must use the same sign - either all sorted ascending from start, or all sorted descending from tail. | +| `FirstOp` | Byte index into the WOD pool where the first WOD for this epilog resides. This is a byte offset, not a WOD index. Epilogs may share WODs with the prolog or with each other by pointing into the same pool region. | +| `IpOffsetOfLastInstruction` | Unsigned byte offset from the epilog start of the last instruction in the epilog, typically RET, or JMP. 8-bit in `EPILOG_INFO_EX_V3`; 16-bit in `EPILOG_INFO_LARGE_EX_V3`. The unwinder uses this value to determine where the epilog ends and the function body resumes. | + +#### Epilog IP Offsets + +Immediately after each full epilog descriptor (when `NumberOfOps > 0`), an array of `NumberOfOps` entries gives the IP offset of each epilog instruction that has a corresponding WOD. Each entry is an unsigned byte, or an unsigned 16-bit word when `EPILOG_INFO_LARGE` is set. Ordering: first entry = operation closest to the body (first epilog instruction with an unwind effect), last entry = operation closest to the control-transfer instruction. + +### WOD Pool + +The remaining bytes in the payload form the WOD pool. The prolog's WODs implicitly start at byte offset 0 of this pool. Each epilog's WOD list start at the byte offset given by its `FirstOp` field. WODs are packed with no alignment or padding between them. + +The number of WODs consumed for the prolog is `UNWIND_INFO_V3.NumberOfOps`. The number consumed for each epilog is its respective `EPILOG_INFO_V3.NumberOfOps` (or inherited). + +## WOD Encoding Reference + +WODs are variable-length (1–5 bytes), packed with `#pragma pack(1)`. The opcode is encoded in the **low-order bits** of the first byte. Decoding requires multi-level bit inspection. + +### Opcode Dispatch Table + +To decode a WOD, read the first byte and test its low bits in the following order: + +| Test | Opcode Value | WOD Type | Size | +|------|--------------|----------|------| +| `byte[0] == 0x00` | 0 | `WOD_SET_FPREG` | 2 bytes | +| `byte[0] == 0x01` | 1 | `WOD_ALLOC_HUGE` | 5 bytes | +| `byte[0] == 0x02` | 2 | `WOD_ALLOC_LARGE` | 3 bytes | +| `byte[0] == 0x03` | 3 | `WOD_PUSH_CANONICAL_FRAME` | 2 bytes | +| `(byte[0] & 0x07) == 0x04` | 4 | `WOD_PUSH` | 1 byte | +| `(byte[0] & 0x07) == 0x05` | 5 | `WOD_SAVE_NONVOL_FAR` | 5 bytes | +| `(byte[0] & 0x07) == 0x06` | 6 | `WOD_SAVE_NONVOL` | 3 bytes | +| `(byte[0] & 0x07) == 0x07` | 7 | `WOD_PUSH_CONSECUTIVE_2` | 1 byte | +| `(byte[0] & 0x0F) == 0x08` | 8 | `WOD_ALLOC_SMALL` | 1 byte | +| `(byte[0] & 0x0F) == 0x09` | 9 | `WOD_SAVE_XMM128_FAR` | 5 bytes | +| `(byte[0] & 0x0F) == 0x0A` | 10 | `WOD_SAVE_XMM128` | 3 bytes | +| `(byte[0] & 0x3F) == 0x20` | 32 | `WOD_PUSH2` | 2 bytes | + +** WOD decoding algorithm (pseudocode):** + +```c +uint8_t b0 = pool[offset]; +uint8_t op3 = b0 & 0x07; + +switch (op3) +{ +case 4: return WOD_PUSH; // 3-bit opcode = 100b +case 5: return WOD_SAVE_NONVOL_FAR;// 3-bit opcode = 101b +case 6: return WOD_SAVE_NONVOL; // 3-bit opcode = 110b +case 7: return WOD_PUSH_CONSECUTIVE_2; // 3-bit opcode = 111b +default: break; // bits[2:0] are 0b000, 0b001, 0b010, or 0b011 +} + +uint8_t op4 = b0 & 0x0F; +switch (op4) +{ +case 0x08: return WOD_ALLOC_SMALL; +case 0x09: return WOD_SAVE_XMM128_FAR; +case 0x0A: return WOD_SAVE_XMM128; +default: break; +} + +uint8_t op6 = b0 & 0x3F; +if (op6 == 0x20) return WOD_PUSH2; + +// 8-bit opcode (full byte match) +switch (b0) +{ +case 0x00: return WOD_SET_FPREG; +case 0x01: return WOD_ALLOC_HUGE; +case 0x02: return WOD_ALLOC_LARGE; +case 0x03: return WOD_PUSH_CANONICAL_FRAME; +default: return INVALID; +} +``` + +### WOD layouts (Bit-Level) + +All bit positions are numbered LSB-first within each byte. Multi-byte integer fields are little-endian. + +#### `WOD_PUSH` - 1 byte + +``` +Byte 0: [2:0] = 100b (opcode 4) + [7:3] = Register (5 bits, AMD64 integer register number) +``` + +**Effect:** `PUSH ` adjusts RSP by 8 and stores register. + +#### `WOD_PUSH2` - 2 bytes + +``` +Byte 0: [5:0] = 100000b (opcode 32) + [7:6] = Register1[1:0] (low 2 bits) +Byte 1: [2:0] = Register1[4:2] (high 3 bits) + [7:3] = Register2 (5 bits) +``` + +**Effect:** `PUSH2 , ` pushes two registers with a single instruction (APX). Adjusts RSP by 16. + +#### `WOD_PUSH_CONSECUTIVE_2` - 1 byte + +``` +Byte 0: [2:0] = 111b (opcode 7) + [7:3] = Register (5 bits) +``` + +**Effect:** Pushes `Register` and `Register+1` consecutively. Adjusts `RSP` by 16 total. `Register` value must be limited to [0, 30], as value of 31 would place `Register+1` out of bounds. + +#### `WOD_ALLOC_SMALL` - 1 byte + +``` +Byte 0: [3:0] = 1000b (opcode 8) + [7:4] = Size (4 bits) +``` + +**Actual allocation:** `(Size + 1) * 8` bytes. Range: 8–128 bytes in steps +of 8. + +#### `WOD_ALLOC_LARGE` - 3 bytes + +``` +Byte 0: [7:0] = 0x02 (opcode 2) +Bytes 1–2: Size (16-bit unsigned, little-endian) +``` + +**Actual allocation:** `Size * 8` bytes. Range: up to 524,280 bytes. + +#### `WOD_ALLOC_HUGE` - 5 bytes + +``` +Byte 0: [7:0] = 0x01 (opcode 1) +Bytes 1–4: Size (32-bit unsigned, little-endian) +``` + +**Actual allocation:** Raw byte count (no scaling). Range: up to 4 GiB. + +#### `WOD_SET_FPREG` - 2 bytes + +``` +Byte 0: [7:0] = 0x00 (opcode 0) +Byte 1: [3:0] = Register (4 bits, 0–15) + [7:4] = Offset (4 bits) +``` + +**Effect:** Establishes a frame pointer. ` = RSP + Offset * 16`. + +#### `WOD_SAVE_NONVOL` - 3 bytes + +``` +Byte 0: [2:0] = 110b (opcode 6) + [7:3] = Register (5 bits) +Bytes 1–2: Displacement (16-bit unsigned, little-endian) +``` + +**Effect:** `MOV [RSP + Displacement * 8], ` saves a nonvolatile +integer register to the stack. + +#### `WOD_SAVE_NONVOL_FAR` - 5 bytes + +``` +Byte 0: [2:0] = 101b (opcode 5) + [7:3] = Register (5 bits) +Bytes 1–4: Displacement (32-bit unsigned, little-endian) +``` + +**Effect:** Same as `WOD_SAVE_NONVOL` but with a 32-bit unscaled byte displacement. Used when the offset doesn't fit in 16 bits scaled by 8. + +#### `WOD_SAVE_XMM128` - 3 bytes + +``` +Byte 0: [3:0] = 1010b (opcode 10) + [7:4] = Register (4 bits, XMM0–XMM15) +Bytes 1–2: Displacement (16-bit unsigned, little-endian) +``` + +**Effect:** `MOVAPS [RSP + Displacement * 16], ` saves a 128-bit +XMM register. + +#### `WOD_SAVE_XMM128_FAR` - 5 bytes + +``` +Byte 0: [3:0] = 1001b (opcode 9) + [7:4] = Register (4 bits, XMM0–XMM15) +Bytes 1–4: Displacement (32-bit unsigned, little-endian) +``` + +**Effect:** Same as `WOD_SAVE_XMM128` but with a 32-bit unscaled byte displacement. + +#### `WOD_PUSH_CANONICAL_FRAME` - 2 bytes + +``` +Byte 0: [7:0] = 0x03 (opcode 3) +Byte 1: [7:0] = Type (8 bits) +``` + +**Effect:** Indicates the hardware/OS pushed a canonical frame onto the stack. Type values distinguish: +- Machine frame without error code +- Machine frame with error code +- Machine frame with shadow-stack push +- Context record + +(Exact type values are defined by the OS; consult the Windows SDK headers.) + +### Opcode Constant Summary + +```c +#define WOD_OP_SET_FPREG 0 // 8-bit opcode, 2 bytes +#define WOD_OP_ALLOC_HUGE 1 // 8-bit opcode, 5 bytes +#define WOD_OP_ALLOC_LARGE 2 // 8-bit opcode, 3 bytes +#define WOD_OP_PUSH_CANONICAL_FRAME 3 // 8-bit opcode, 2 bytes +#define WOD_OP_PUSH 4 // 3-bit opcode, 1 byte +#define WOD_OP_SAVE_NONVOL_FAR 5 // 3-bit opcode, 5 bytes +#define WOD_OP_SAVE_NONVOL 6 // 3-bit opcode, 3 bytes +#define WOD_OP_PUSH_CONSECUTIVE_2 7 // 3-bit opcode, 1 byte +#define WOD_OP_ALLOC_SMALL 8 // 4-bit opcode, 1 byte +#define WOD_OP_SAVE_XMM128_FAR 9 // 4-bit opcode, 5 bytes +#define WOD_OP_SAVE_XMM128 10 // 4-bit opcode, 3 bytes +#define WOD_OP_PUSH2 32 // 6-bit opcode, 2 bytes +``` + +### Register Encoding + +Integer registers use the standard AMD64 numbering (5 bits, 0–31): + +| Value | Register | +|-------|----------| +| 0 | RAX | +| 1 | RCX | +| 2 | RDX | +| 3 | RBX | +| 4 | RSP | +| 5 | RBP | +| 6 | RSI | +| 7 | RDI | +| 8 - 15 | R8 - R15 +| 16 - 31 | R16 - R31 (APX) | + +XMM register fields are 4 bits (0–15), mapping directly to XMM0–XMM15. diff --git a/docs/c-language/c-pragmas.md b/docs/c-language/c-pragmas.md index e98dccbd721..bb5cb70aee4 100644 --- a/docs/c-language/c-pragmas.md +++ b/docs/c-language/c-pragmas.md @@ -1,9 +1,8 @@ --- -description: "Learn more about: C Pragmas" title: "C Pragmas" +description: "Learn more about: C Pragmas" ms.date: 07/26/2020 helpviewer_keywords: ["pragmas, C/C++"] -ms.assetid: 3d6d36b4-d565-4632-a4cd-e39aeaded5ad --- # C Pragmas @@ -59,7 +58,7 @@ A *pragma* instructs the compiler to perform a particular action at compile time :::column-end::: :::row-end::: -See [Pragma Directives and the `__Pragma` Keyword](../preprocessor/pragma-directives-and-the-pragma-keyword.md) for a description of the Microsoft C compiler pragmas. +See [Pragma directives and the `__pragma` and `_Pragma` keywords](../preprocessor/pragma-directives-and-the-pragma-keyword.md) for a description of the Microsoft C compiler pragmas. **END Microsoft Specific** diff --git a/docs/c-language/summary-of-declarations.md b/docs/c-language/summary-of-declarations.md index 117a5baaaab..975beb742bc 100644 --- a/docs/c-language/summary-of-declarations.md +++ b/docs/c-language/summary-of-declarations.md @@ -21,7 +21,7 @@ ms.assetid: 53a5e9e5-1a33-40b5-9dea-7f669b479329  *`attribute`*1 *`attribute-seq`*opt1 *`attribute`*1, 2: one of\ - **`__asm`** **`__based`** **`__cdecl`** **`__clrcall`** **`__fastcall`** **`__inline`** **`__stdcall`** **`__thiscall`** **`__vectorcall`** + **`__asm`** **`__based`** **`__cdecl`** **`__clrcall`** **`__fastcall`** **`__inline`** **`__stdcall`** **`__thiscall`** **`__vectorcall`** **`__preserve_none`** *`init-declarator-list`*:\  *`init-declarator`*\ @@ -209,7 +209,7 @@ ms.assetid: 53a5e9e5-1a33-40b5-9dea-7f669b479329  **`_Static_assert`** **`(`** *`constant-expression`* **`,`** *`string-literal`* **`)`** **`;`** 1 This grammar element is Microsoft-specific.\ -2 For more information about these elements, see [`__asm`](../assembler/inline/asm.md), [`__clrcall`](../cpp/clrcall.md), [`__stdcall`](../cpp/stdcall.md), [`__based`](../cpp/based-grammar.md), [`__fastcall`](../cpp/fastcall.md), [`__thiscall`](../cpp/thiscall.md), [`__cdecl`](../cpp/cdecl.md), [`__inline`](../cpp/inline-functions-cpp.md), and [`__vectorcall`](../cpp/vectorcall.md).\ +2 For more information about these elements, see [`__asm`](../assembler/inline/asm.md), [`__clrcall`](../cpp/clrcall.md), [`__stdcall`](../cpp/stdcall.md), [`__based`](../cpp/based-grammar.md), [`__fastcall`](../cpp/fastcall.md), [`__thiscall`](../cpp/thiscall.md), [`__cdecl`](../cpp/cdecl.md), [`__inline`](../cpp/inline-functions-cpp.md), [`__preserve_none`](../cpp/preserve-none.md) and [`__vectorcall`](../cpp/vectorcall.md).\ 3 This style is obsolete. ## See also diff --git a/docs/c-runtime-library/debug.md b/docs/c-runtime-library/debug.md index 049cce0df2b..f3d187ab4ff 100644 --- a/docs/c-runtime-library/debug.md +++ b/docs/c-runtime-library/debug.md @@ -1,16 +1,16 @@ --- -description: "Learn more about: _DEBUG" title: "_DEBUG" -ms.date: "11/04/2016" +description: "Learn more about: _DEBUG" +ms.date: 11/04/2016 helpviewer_keywords: ["DEBUG macro", "_DEBUG macro"] -ms.assetid: a9901568-4846-4731-a404-399d947e2e7a --- # `_DEBUG` -The compiler defines `_DEBUG` when you specify the /MTd or /MDd option. These options specify debug versions of the C run-time library. +The compiler defines `_DEBUG` when you specify the [`/MTd`](../build/reference/md-mt-ld-use-run-time-library.md), [`/MDd`](../build/reference/md-mt-ld-use-run-time-library.md), or [`/LDd`](../build/reference/md-mt-ld-use-run-time-library.md) option. These options specify debug versions of the C run-time library. -For more information, see [CRT debugging techniques](./crt-debugging-techniques.md). +For more information, see [CRT debugging techniques](crt-debugging-techniques.md). ## See also -[Control flags](./control-flags.md) +[Control flags](control-flags.md)\ +[Predefined macros](../preprocessor/predefined-macros.md) diff --git a/docs/c-runtime-library/errno-constants.md b/docs/c-runtime-library/errno-constants.md index 57db146f7bd..20b1f808cd2 100644 --- a/docs/c-runtime-library/errno-constants.md +++ b/docs/c-runtime-library/errno-constants.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: errno constants" title: "errno constants" +description: "Learn more about: errno constants" ms.date: 04/26/2021 f1_keywords: ["E2BIG", "EACCES", "EAGAIN", "EBADF", "EBUSY", "ECHILD", "EDEADLK", "EDEADLOCK", "EDOM", "EEXIST", "EFAULT", "EFBIG", "EILSEQ", "EINTR", "EINVAL", "EIO", "EISDIR", "EMFILE", "EMLINK", "ENAMETOOLONG", "ENFILE", "ENODEV", "ENOENT", "ENOEXEC", "ENOLCK", "ENOMEM", "ENOSPC", "ENOSYS", "ENOTDIR", "ENOTEMPTY", "ENOTTY", "ENXIO", "EPERM", "EPIPE", "ERANGE", "EROFS", "ESPIPE", "ESRCH", "EXDEV", "STRUNCATE", "EADDRINUSE", "EADDRNOTAVAIL", "EAFNOSUPPORT", "EALREADY", "EBADMSG", "ECANCELED", "ECONNABORTED", "ECONNREFUSED", "ECONNRESET", "EDESTADDRREQ", "EHOSTUNREACH", "EIDRM", "EINPROGRESS", "EISCONN", "ELOOP", "EMSGSIZE", "ENETDOWN", "ENETRESET", "ENETUNREACH", "ENOBUFS", "ENODATA", "ENOLINK", "ENOMSG", "ENOPROTOOPT", "ENOSR", "ENOSTR", "ENOTCONN", "ENOTRECOVERABLE", "ENOTSOCK", "ENOTSUP", "EOPNOTSUPP", "EOTHER", "EOVERFLOW", "EOWNERDEAD", "EPROTO", "EPROTONOSUPPORT", "EPROTOTYPE", "ETIME", "ETIMEDOUT", "ETXTBSY", "EWOULDBLOCK"] helpviewer_keywords: ["E2BIG constant", "EACCES constant", "EAGAIN constant", "EBADF constant", "EBUSY constant", "ECHILD constant", "EDEADLK constant", "EDEADLOCK constant", "EDOM constant", "EEXIST constant", "EFAULT constant", "EFBIG constant", "EILSEQ constant", "EINTR constant", "EINVAL constant", "EIO constant", "EISDIR constant", "EMFILE constant", "EMLINK constant", "ENAMETOOLONG constant", "ENFILE constant", "ENODEV constant", "ENOENT constant", "ENOEXEC constant", "ENOLCK constant", "ENOMEM constant", "ENOSPC constant", "ENOSYS constant", "ENOTDIR constant", "ENOTEMPTY constant", "ENOTTY constant", "ENXIO constant", "EPERM constant", "EPIPE constant", "ERANGE constant", "EROFS constant", "ESPIPE constant", "ESRCH constant", "EXDEV constant", "STRUNCATE constant", "EADDRINUSE constant", "EADDRNOTAVAIL constant", "EAFNOSUPPORT constant", "EALREADY constant", "EBADMSG constant", "ECANCELED constant", "ECONNABORTED constant", "ECONNREFUSED constant", "ECONNRESET constant", "EDESTADDRREQ constant", "EHOSTUNREACH constant", "EIDRM constant", "EINPROGRESS constant", "EISCONN constant", "ELOOP constant", "EMSGSIZE constant", "ENETDOWN constant", "ENETRESET constant", "ENETUNREACH constant", "ENOBUFS constant", "ENODATA constant", "ENOLINK constant", "ENOMSG constant", "ENOPROTOOPT constant", "ENOSR constant", "ENOSTR constant", "ENOTCONN constant", "ENOTRECOVERABLE constant", "ENOTSOCK constant", "ENOTSUP constant", "EOPNOTSUPP constant", "EOTHER constant", "EOVERFLOW constant", "EOWNERDEAD constant", "EPROTO constant", "EPROTONOSUPPORT constant", "EPROTOTYPE constant", "ETIME constant", "ETIMEDOUT constant", "ETXTBSY constant", "EWOULDBLOCK constant"] @@ -15,11 +15,11 @@ helpviewer_keywords: ["E2BIG constant", "EACCES constant", "EAGAIN constant", "E ## Remarks -The `errno` constants are values assigned to [`errno`](./errno-doserrno-sys-errlist-and-sys-nerr.md) for various error conditions. +The `errno` constants are values assigned to [`errno`](errno-doserrno-sys-errlist-and-sys-nerr.md) for various error conditions. `ERRNO.H` contains the definitions of the `errno` values. However, not all the definitions given in `ERRNO.H` are used in 32-bit Windows operating systems. Some of the values in `ERRNO.H` are present to maintain compatibility with the UNIX family of operating systems. The `errno` values in a 32-bit Windows operating system are a subset of the values for `errno` in UNIX systems. -The `errno` value isn't necessarily the same as the actual error code returned by a system call from the Windows operating system. To access the actual operating system error code, use the [`_doserrno`](./errno-doserrno-sys-errlist-and-sys-nerr.md) variable, which contains this value. +The `errno` value isn't necessarily the same as the actual error code returned by a system call from the Windows operating system. To access the actual operating system error code, use the [`_doserrno`](errno-doserrno-sys-errlist-and-sys-nerr.md) variable, which contains this value. The following `errno` values are supported: @@ -34,7 +34,7 @@ The following `errno` values are supported: | `EDEADLK` | Resource deadlock would occur. | 36 | | `EDEADLOCK` | Same as `EDEADLK` for compatibility with older Microsoft C versions. | 36 | | `EDOM` | Math argument. The argument to a math function isn't in the domain of the function. | 33 | -| `EEXIST` | Files exists. An attempt has been made to create a file that already exists. For example, the `_O_CREAT` and `_O_EXCL` flags are specified in an `_open` call, but the named file already exists. | 17 | +| `EEXIST` | File exists. An attempt has been made to create a file that already exists. For example, the `_O_CREAT` and `_O_EXCL` flags are specified in an `_open` call, but the named file already exists. | 17 | | `EFAULT` | Bad address. | 14 | | `EFBIG` | File too large. | 27 | | `EILSEQ` | Illegal sequence of bytes (for example, in an `MBCS` string). | 42 | @@ -50,7 +50,7 @@ The following `errno` values are supported: | `ENOENT` | No such file or directory. The specified file or directory doesn't exist or can't be found. This message can occur whenever a specified file doesn't exist or a component of a path doesn't specify an existing directory. | 2 | | `ENOEXEC` | Exec format error. An attempt was made to execute a file that isn't executable or that has an invalid executable-file format. | 8 | | `ENOLCK` | No locks available. | 39 | -| `ENOMEM` | Not enough memory is available for the attempted operator. For example, this message can occur when insufficient memory is available to execute a child process, or when the allocation request in a `_getcwd` call can't be satisfied. | 12 | +| `ENOMEM` | Not enough memory is available for the attempted operation. For example, this message can occur when insufficient memory is available to execute a child process, or when the allocation request in a `_getcwd` call can't be satisfied. | 12 | | `ENOSPC` | No space left on device. No more space for writing is available on the device (for example, when the disk is full). | 28 | | `ENOSYS` | Function not supported. | 40 | | `ENOTDIR` | Not a directory. | 20 | @@ -60,11 +60,11 @@ The following `errno` values are supported: | `EPERM` | Operation not permitted. | 1 | | `EPIPE` | Broken pipe. | 32 | | `ERANGE` | Result too large. An argument to a math function is too large, resulting in partial or total loss of significance in the result. This error can also occur in other functions when an argument is larger than expected (for example, when the *`buffer`* argument to `_getcwd` is longer than expected). | 34 | -| `EROFS` | Read only file system. | 30 | +| `EROFS` | Read-only file system. | 30 | | `ESPIPE` | Invalid seek. | 29 | | `ESRCH` | No such process. | 3 | | `EXDEV` | Cross-device link. An attempt was made to move a file to a different device (using the `rename` function). | 18 | -| `STRUNCATE` | A string copy or concatenation resulted in a truncated string. See [`_TRUNCATE`](./truncate.md). | 80 | +| `STRUNCATE` | A string copy or concatenation resulted in a truncated string. See [`_TRUNCATE`](truncate.md). | 80 | The following values are supported for compatibility with POSIX: @@ -84,8 +84,8 @@ The following values are supported for compatibility with POSIX: | `EIDRM` | Identifier removed. | 111 | | `EINPROGRESS` | Operation in progress. | 112 | | `EISCONN` | Already connected. | 113 | -| `ELOOP` | Too many symbolic link levels. | 114 | -| `EMSGSIZE` | Message size. | 115 | +| `ELOOP` | Too many levels of symbolic links. | 114 | +| `EMSGSIZE` | Message too long. | 115 | | `ENETDOWN` | Network down. | 116 | | `ENETRESET` | Network reset. | 117 | | `ENETUNREACH` | Network unreachable. | 118 | @@ -114,4 +114,4 @@ The following values are supported for compatibility with POSIX: ## See also -[Global constants](./global-constants.md) +[Global constants](global-constants.md) diff --git a/docs/c-runtime-library/reference/abort.md b/docs/c-runtime-library/reference/abort.md index 436a39de910..70885616878 100644 --- a/docs/c-runtime-library/reference/abort.md +++ b/docs/c-runtime-library/reference/abort.md @@ -46,7 +46,7 @@ By default, in non-debug builds of desktop or console apps, **`abort`** then inv If the Windows error reporting handler isn't invoked, then **`abort`** calls [`_exit`](exit-exit-exit.md) to terminate the process with exit code 3 and returns control to the parent process or the operating system. `_exit` doesn't flush stream buffers or do `atexit`/`_onexit` processing. -For Windows compatibility reasons, when **`abort`** calls `_exit`, it may invoke the Windows [`ExitProcess`](/windows/win32/api/processthreadsapi/nf-processthreadsapi-exitprocess) API, which in turn allows DLL termination routines to run. Destructors aren't run in the executable, but the same may not be true of DLLs loaded in the executable's process space. This behavior doesn't strictly conform to the C++ standard. To immediately terminate a process including any DLLs, use the Windows [`TerminateProcess`](/windows/desktop/api/processthreadsapi/nf-processthreadsapi-terminateprocess) API. You can also register an abort signal handler that invokes `TerminateProcess` for standard-compliant behavior. Compliant behavior may come at some cost in Windows compatibility. +For Windows compatibility reasons, when **`abort`** calls `_exit`, it may invoke the Windows [`ExitProcess`](/windows/win32/api/processthreadsapi/nf-processthreadsapi-exitprocess) API, which in turn allows DLL termination routines to run. Destructors aren't run in the executable, but the same may not be true of DLLs loaded in the executable's process space. This behavior doesn't strictly conform to the C++ standard. To immediately terminate a process including any DLLs, use the Windows [`TerminateProcess`](/windows/desktop/api/processthreadsapi/nf-processthreadsapi-terminateprocess) API. You can also register an abort signal handler that invokes `TerminateProcess` for standard-conforming behavior. Conforming behavior may come at some cost in Windows compatibility. For more information about CRT debugging, see [CRT debugging techniques](../crt-debugging-techniques.md). diff --git a/docs/c-runtime-library/reference/calloc-dbg.md b/docs/c-runtime-library/reference/calloc-dbg.md index fbff456b61b..1b02d2cf193 100644 --- a/docs/c-runtime-library/reference/calloc-dbg.md +++ b/docs/c-runtime-library/reference/calloc-dbg.md @@ -68,9 +68,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -| Routine | Required header | -|---|---| -| **`_calloc_dbg`** | \ | +| Routine | Required header | Required library | +|---|---|---| +| **`_calloc_dbg`** | `` | The debug C Runtime Library (for example, `ucrtd.lib`). Only available in debug builds. For information about Microsoft C runtime library `.lib` files, see [CRT library features](../crt-library-features.md). | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md b/docs/c-runtime-library/reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md index 0b2cc7c948b..3f03733bda5 100644 --- a/docs/c-runtime-library/reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md +++ b/docs/c-runtime-library/reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md @@ -8,7 +8,6 @@ api_type: ["DLLExport"] topic_type: ["apiref"] f1_keywords: ["_wctime64", "_ctime32", "_tctime", "_wctime", "_wctime32", "_tctime64", "_ctime64", "ctime"] helpviewer_keywords: ["tctime64 function", "_ctime32 function", "ctime32 function", "_wctime function", "wctime64 function", "_tctime64 function", "_tctime32 function", "_ctime64 function", "_wctime64 function", "ctime function", "wctime32 function", "ctime64 function", "_wctime32 function", "_tctime function", "tctime32 function", "tctime function", "wctime function", "time, converting"] -ms.assetid: 2423de37-a35c-4f0a-a378-3116bc120a9d --- # `ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64` @@ -17,10 +16,10 @@ Convert a time value to a string and adjust for local time zone settings. More s ## Syntax ```C -char *ctime( const time_t *sourceTime ); +char *ctime( const time_t *sourceTime ); // See note in remarks section about linkage char *_ctime32( const __time32_t *sourceTime ); char *_ctime64( const __time64_t *sourceTime ); -wchar_t *_wctime( const time_t *sourceTime ); +wchar_t *_wctime( const time_t *sourceTime ); // See note in remarks section about linkage wchar_t *_wctime32( const __time32_t *sourceTime ); wchar_t *_wctime64( const __time64_t *sourceTime ); ``` @@ -62,9 +61,14 @@ These functions validate their parameters. If *`sourceTime`* is a null pointer, By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `ctime` and `_wctime` are no longer `static inline` (internal linkage). Instead, they're `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ### Generic-text routine mappings -| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | |---|---|---|---| | `_tctime` | **`ctime`** | **`ctime`** | **`_wctime`** | | `_tctime32` | **`_ctime32`** | **`_ctime32`** | **`_wctime32`** | @@ -74,12 +78,12 @@ By default, this function's global state is scoped to the application. To change | Routine | Required header | |---|---| -| **`ctime`** | \ | -| **`_ctime32`** | \ | -| **`_ctime64`** | \ | -| **`_wctime`** | \ or \ | -| **`_wctime32`** | \ or \ | -| **`_wctime64`** | \ or \ | +| **`ctime`** | `` | +| **`_ctime32`** | `` | +| **`_ctime64`** | `` | +| **`_wctime`** | `` or `` | +| **`_wctime32`** | `` or `` | +| **`_wctime64`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md b/docs/c-runtime-library/reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md index fcf23eb2ceb..12965dc90e2 100644 --- a/docs/c-runtime-library/reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md +++ b/docs/c-runtime-library/reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md @@ -16,7 +16,7 @@ Convert a time value to a string and adjust for local time zone settings. These ## Syntax ```C -errno_t ctime_s( +errno_t ctime_s( // See note in remarks section about linkage char* buffer, size_t numberOfElements, const time_t *sourceTime @@ -31,7 +31,7 @@ errno_t _ctime64_s( size_t numberOfElements, const __time64_t *sourceTime ); -errno_t _wctime_s( +errno_t _wctime_s( // See note in remarks section about linkage wchar_t* buffer, size_t numberOfElements, const time_t *sourceTime @@ -124,6 +124,11 @@ The debug library versions of these functions first fill the buffer with 0xFE. T By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `ctime_s` and `_wctime_s` are no longer `static inline` (internal linkage). Instead, they're `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ### Generic-text routine mappings | TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | diff --git a/docs/c-runtime-library/reference/difftime-difftime32-difftime64.md b/docs/c-runtime-library/reference/difftime-difftime32-difftime64.md index b5825758e25..b1512299fa8 100644 --- a/docs/c-runtime-library/reference/difftime-difftime32-difftime64.md +++ b/docs/c-runtime-library/reference/difftime-difftime32-difftime64.md @@ -8,7 +8,6 @@ api_type: ["DLLExport"] topic_type: ["apiref"] f1_keywords: ["_difftime64", "difftime", "difftime64", "_difftime32", "difftime32"] helpviewer_keywords: ["_difftime32 function", "difftime function", "time, finding the difference", "difftime64 function", "_difftime64 function", "difftime32 function"] -ms.assetid: 4cc0ac2b-fc7b-42c0-8283-8c9d10c566d0 --- # `difftime`, `_difftime32`, `_difftime64` @@ -17,7 +16,7 @@ Finds the difference between two times. ## Syntax ```C -double difftime( time_t timeEnd, time_t timeStart ); +double difftime( time_t timeEnd, time_t timeStart ); // See note in remarks section about linkage double _difftime32( __time32_t timeEnd, __time32_t timeStart ); double _difftime64( __time64_t timeEnd, __time64_t timeStart ); ``` @@ -46,13 +45,18 @@ These functions validate their parameters. If either of the parameters is zero o By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> If you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `difftime` is no longer `static inline` (internal linkage). Instead, it's `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ## Requirements | Routine | Required header | |---|---| -| **`difftime`** | \ | -| **`_difftime32`** | \ | -| **`_difftime64`** | \ | +| **`difftime`** | `` | +| **`_difftime32`** | `` | +| **`_difftime64`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/futime-futime32-futime64.md b/docs/c-runtime-library/reference/futime-futime32-futime64.md index a8b38058097..43712b04947 100644 --- a/docs/c-runtime-library/reference/futime-futime32-futime64.md +++ b/docs/c-runtime-library/reference/futime-futime32-futime64.md @@ -17,7 +17,7 @@ Sets the modification time on an open file. ## Syntax ```C -int _futime( +int _futime( // See note in remarks section about linkage int fd, struct _utimbuf *filetime ); @@ -51,13 +51,18 @@ The **`_futime`** routine sets the modification date and the access time on the By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> If you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `_futime` is no longer `static inline` (internal linkage). Instead, it's `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ## Requirements | Function | Required header | Optional header | |---|---|---| -| **`_futime`** | \ | \ | -| **`_futime32`** | \ | \ | -| **`_futime64`** | \ | \ | +| **`_futime`** | `` | `` | +| **`_futime32`** | `` | `` | +| **`_futime64`** | `` | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/gmtime-gmtime32-gmtime64.md b/docs/c-runtime-library/reference/gmtime-gmtime32-gmtime64.md index 1d0656b3f72..82ac3231da3 100644 --- a/docs/c-runtime-library/reference/gmtime-gmtime32-gmtime64.md +++ b/docs/c-runtime-library/reference/gmtime-gmtime32-gmtime64.md @@ -16,7 +16,7 @@ Converts a `time_t` time value to a `tm` structure. More secure versions of thes ## Syntax ```C -struct tm *gmtime( const time_t *sourceTime ); +struct tm *gmtime( const time_t *sourceTime ); // See note in remarks section about linkage struct tm *_gmtime32( const __time32_t *sourceTime ); struct tm *_gmtime64( const __time64_t *sourceTime ); ``` @@ -56,6 +56,11 @@ The **`_gmtime32`** function breaks down the *`sourceTime`* value and stores it By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `gmtime` is no longer `static inline` (internal linkage). Instead, it's `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ## Requirements | Routine | Required C header | Required C++ header | diff --git a/docs/c-runtime-library/reference/gmtime-s-gmtime32-s-gmtime64-s.md b/docs/c-runtime-library/reference/gmtime-s-gmtime32-s-gmtime64-s.md index 91517017143..2ce6ef33317 100644 --- a/docs/c-runtime-library/reference/gmtime-s-gmtime32-s-gmtime64-s.md +++ b/docs/c-runtime-library/reference/gmtime-s-gmtime32-s-gmtime64-s.md @@ -16,7 +16,7 @@ Converts a time value to a `tm` structure. These functions are versions of [`_gm ## Syntax ```C -errno_t gmtime_s( +errno_t gmtime_s( // See note in remarks section about linkage struct tm* tmDest, const __time_t* sourceTime ); @@ -72,10 +72,18 @@ Each of the structure fields is of type **`int`**, as shown in the following tab **`_gmtime64_s`**, which uses the **`__time64_t`** structure, allows dates to be expressed up through 23:59:59, December 31, 3000, UTC; whereas **`gmtime32_s`** only represent dates through 23:59:59 January 18, 2038, UTC. Midnight, January 1, 1970, is the lower bound of the date range for both these functions. +The Microsoft-specific **`gmtime_s`** has a different signature than the C standard version. To enable the standard-conforming variant, define **`_CRT_USE_CONFORMING_ANNEX_K_TIME`** to a nonzero value before including **``**. + + **`gmtime_s`** is an inline function that evaluates to **`_gmtime64_s`** and **`time_t`** is equivalent to **`__time64_t`**. If you need to force the compiler to interpret **`time_t`** as the old 32-bit **`time_t`**, you can define `_USE_32BIT_TIME_T`. `_USE_32BIT_TIME_T` causes **`gmtime_s`** to be inlined as **`_gmtime32_s`**. We don't recommend `_USE_32BIT_TIME_T`, because your application may fail after January 18, 2038, and because it isn't allowed on 64-bit platforms. By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `gmtime_s` is no longer `static inline` (internal linkage). Instead, it's `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ## Requirements | Routine | Required C header | Required C++ header | diff --git a/docs/c-runtime-library/reference/localtime-localtime32-localtime64.md b/docs/c-runtime-library/reference/localtime-localtime32-localtime64.md index 746082c2ad8..b5f537a55a0 100644 --- a/docs/c-runtime-library/reference/localtime-localtime32-localtime64.md +++ b/docs/c-runtime-library/reference/localtime-localtime32-localtime64.md @@ -17,7 +17,7 @@ Converts a time value and corrects for the local time zone. More secure versions ## Syntax ```C -struct tm *localtime( const time_t *sourceTime ); +struct tm *localtime( const time_t *sourceTime ); // See note in remarks section about linkage struct tm *_localtime32( const __time32_t *sourceTime ); struct tm *_localtime64( const __time64_t *sourceTime ); ``` @@ -72,6 +72,11 @@ These functions validate their parameters. If *`sourceTime`* is a null pointer, By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `localtime` is no longer `static inline` (internal linkage). Instead, it's `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ## Requirements | Routine | Required C header | Required C++ header | diff --git a/docs/c-runtime-library/reference/localtime-s-localtime32-s-localtime64-s.md b/docs/c-runtime-library/reference/localtime-s-localtime32-s-localtime64-s.md index 64aebc449d6..14d4aaaa5df 100644 --- a/docs/c-runtime-library/reference/localtime-s-localtime32-s-localtime64-s.md +++ b/docs/c-runtime-library/reference/localtime-s-localtime32-s-localtime64-s.md @@ -17,7 +17,7 @@ Converts a **`time_t`** time value to a **`tm`** structure, and corrects for the ## Syntax ```C -errno_t localtime_s( +errno_t localtime_s( // See note in remarks section about linkage struct tm* const tmDest, time_t const* const sourceTime ); @@ -62,6 +62,8 @@ The **`localtime_s`** function converts a time stored as a [`time_t`](../standar > [!NOTE] > The target environment should try to determine whether daylight saving time is in effect. +The Microsoft-specific **`localtime_s`** has a different signature than the C standard version. To enable the standard-conforming variant, define **`_CRT_USE_CONFORMING_ANNEX_K_TIME`** to a nonzero value before including **``**. + **`_localtime64_s`**, which uses the **`__time64_t`** structure, allows dates to be expressed up through 23:59:59, January 18, 3001, coordinated universal time (UTC), whereas **`_localtime32_s`** represents dates through 23:59:59 January 18, 2038, UTC. **`localtime_s`** is an inline function that evaluates to **`_localtime64_s`**, and **`time_t`** is equivalent to **`__time64_t`**. If you need to force the compiler to interpret **`time_t`** as the old 32-bit **`time_t`**, you can define `_USE_32BIT_TIME_T`, which causes **`localtime_s`** to evaluate to **`_localtime32_s`**. We don't recommend `_USE_32BIT_TIME_T`, because your application may fail after January 18, 2038, and it isn't allowed on 64-bit platforms. @@ -84,6 +86,11 @@ If the **`TZ`** environment variable is set, the C run-time library assumes rule By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `localtime_s` is no longer `static inline` (internal linkage). Instead, it's `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ## Requirements | Routine | Required C header | Required C++ header | diff --git a/docs/c-runtime-library/reference/mkgmtime-mkgmtime32-mkgmtime64.md b/docs/c-runtime-library/reference/mkgmtime-mkgmtime32-mkgmtime64.md index c692db99002..037c907886b 100644 --- a/docs/c-runtime-library/reference/mkgmtime-mkgmtime32-mkgmtime64.md +++ b/docs/c-runtime-library/reference/mkgmtime-mkgmtime32-mkgmtime64.md @@ -16,7 +16,7 @@ Converts a UTC time represented by a **`struct tm`** to a UTC time represented b ## Syntax ```C -time_t _mkgmtime( +time_t _mkgmtime( // See note in remarks section about linkage struct tm* timeptr ); __time32_t _mkgmtime32( @@ -48,6 +48,11 @@ The range of the **`_mkgmtime32`** function is from midnight, January 1, 1970, U Both **`gmtime`** and **`localtime`** use a common static buffer for the conversion. If you supply this buffer to **`_mkgmtime`**, the previous contents are destroyed. +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `_mkgmtime` is no longer `static inline` (internal linkage). Instead, it's `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ## Examples ```C diff --git a/docs/c-runtime-library/reference/mktime-mktime32-mktime64.md b/docs/c-runtime-library/reference/mktime-mktime32-mktime64.md index 51d9a4265a6..7f7bb31a6c9 100644 --- a/docs/c-runtime-library/reference/mktime-mktime32-mktime64.md +++ b/docs/c-runtime-library/reference/mktime-mktime32-mktime64.md @@ -16,7 +16,7 @@ Convert the local time to a calendar value. ## Syntax ```C -time_t mktime( +time_t mktime( // See note in remarks section about linkage struct tm *timeptr ); __time32_t _mktime32( @@ -62,6 +62,11 @@ These functions validate their parameter. If *`timeptr`* is a null pointer, the By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `mktime` is no longer `static inline` (internal linkage). Instead, it's `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ## Requirements | Routine | Required header | diff --git a/docs/c-runtime-library/reference/set-abort-behavior.md b/docs/c-runtime-library/reference/set-abort-behavior.md index 957edb74302..dc00ccec9be 100644 --- a/docs/c-runtime-library/reference/set-abort-behavior.md +++ b/docs/c-runtime-library/reference/set-abort-behavior.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: _set_abort_behavior" title: "_set_abort_behavior" +description: "Learn more about: _set_abort_behavior" ms.date: 07/07/2022 api_name: ["_set_abort_behavior", "_o__set_abort_behavior"] api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-runtime-l1-1-0.dll"] @@ -41,7 +41,7 @@ The old value of the flags. There are two [`abort`](abort.md) flags: `_WRITE_ABORT_MSG` and `_CALL_REPORTFAULT`. `_WRITE_ABORT_MSG` determines whether a helpful text message is printed when a program is abnormally terminated. The message states that the application has called the `abort` function. The default behavior is to print the message. `_CALL_REPORTFAULT`, if set, invokes the Windows Error Reporting Service mechanism (formerly known as Dr. Watson) to report failures to Microsoft when `abort` is called. By default, crash dump reporting is enabled in non-DEBUG builds. If the Windows error reporting handler isn't invoked, then `abort` calls [`_exit`](exit-exit-exit.md) to terminate the process with exit code 3 and returns control to the parent process or the operating system. `_exit` doesn't flush stream buffers or do `atexit`/`_onexit` processing. -For Windows compatibility reasons, when `abort` calls `_exit`, it may invoke the Windows [`ExitProcess`](/windows/win32/api/processthreadsapi/nf-processthreadsapi-exitprocess) API, which in turn allows DLL termination routines to run. Destructors aren't run in the executable, but the same may not be true of DLLs loaded in the executable's process space. This behavior doesn't strictly conform to the C++ standard. To immediately terminate a process including any DLLs, use the Windows [`TerminateProcess`](/windows/desktop/api/processthreadsapi/nf-processthreadsapi-terminateprocess) API. You can also register an abort signal handler that invokes `TerminateProcess` for standard-compliant behavior. Compliant behavior may come at some cost in Windows compatibility. +For Windows compatibility reasons, when `abort` calls `_exit`, it may invoke the Windows [`ExitProcess`](/windows/win32/api/processthreadsapi/nf-processthreadsapi-exitprocess) API, which in turn allows DLL termination routines to run. Destructors aren't run in the executable, but the same may not be true of DLLs loaded in the executable's process space. This behavior doesn't strictly conform to the C++ standard. To immediately terminate a process including any DLLs, use the Windows [`TerminateProcess`](/windows/desktop/api/processthreadsapi/nf-processthreadsapi-terminateprocess) API. You can also register an abort signal handler that invokes `TerminateProcess` for standard-conforming behavior. Conforming behavior may come at some cost in Windows compatibility. By default, this function's global state is scoped to the application. To change it, see [Global state in the CRT](../global-state.md). diff --git a/docs/c-runtime-library/reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md b/docs/c-runtime-library/reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md index a9ceb9d7a60..ee4a0b52726 100644 --- a/docs/c-runtime-library/reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md +++ b/docs/c-runtime-library/reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md @@ -109,7 +109,7 @@ For more information, see [Format specification syntax: `printf` and `wprintf` f ## Return value -The number of characters that which would have been written to the buffer if `count` was ignored. The count doesn't include the terminating `NULL` character. +The number of characters that would have been written to the buffer if `count` was ignored. The count doesn't include the terminating `NULL` character. Let **`len`** be the length of the formatted data string, not including the terminating `NULL`.\ For all functions, if `len < count`, then **`len`** characters are stored in *`buffer`*, a null-terminator is appended, and the number of characters written, not including the terminating `NULL`, is returned. @@ -120,7 +120,12 @@ See [Behavior summary](#behavior-summary) for details. ## Remarks -Beginning with the UCRT in Visual Studio 2015 and Windows 10, **`snprintf`** is no longer identical to **`_snprintf`**. The **`snprintf`** behavior is now C99 standard conformant. The difference is that if you run out of buffer, `snprintf` null-terminates the end of the buffer and returns the number of characters that would have been required whereas `_snprintf` doesn't null-terminate the buffer and returns -1. Also, `_snprintf()` includes one more character in the output because it doesn't null-terminate the buffer. +Beginning with the UCRT in Visual Studio 2015 and Windows 10, **`snprintf`** is no longer identical to **`_snprintf`**. The **`snprintf`** behavior is now C99 standard conformant. The differences are: + +- **`snprintf`** always null-terminates the buffer (even when truncating), and returns the total number of characters that would have been written if the buffer were large enough (not counting the null-terminator). +- **`_snprintf`** doesn't null-terminate the buffer when the output is truncated, and returns `-1` when truncation occurs. + +Because `_snprintf` doesn't write a null-terminator when it truncates, it can fit one more character into the same buffer size. However, the resulting string is not null-terminated, so you must handle termination yourself. - **`snprintf`** and the **`_snprintf`** family of functions format and store *`count`* or fewer characters in *`buffer`*. - **`snprintf`** always stores a terminating `NULL` character, truncating the output if necessary. diff --git a/docs/c-runtime-library/reference/stat-functions.md b/docs/c-runtime-library/reference/stat-functions.md index b1a5efc58ff..19b26217c48 100644 --- a/docs/c-runtime-library/reference/stat-functions.md +++ b/docs/c-runtime-library/reference/stat-functions.md @@ -1,7 +1,7 @@ --- title: "_stat, _stat32, _stat64, _stati64, _stat32i64, _stat64i32, _wstat, _wstat32, _wstat64, _wstati64, _wstat32i64, _wstat64i32" description: "Learn more about: _stat, _stat32, _stat64, _stati64, _stat32i64, _stat64i32, _wstat, _wstat32, _wstat64, _wstati64, _wstat32i64, _wstat64i32" -ms.date: "5/25/2023" +ms.date: 03/20/2026 api_name: ["_wstat64", "_stati64", "_stat32", "_stat32i64", "_stat", "_wstati64", "_wstat32", "_wstat64i32", "_wstat", "_stat64", "_stat64i32", "_wstat32i64", "_o__stat32", "_o__stat32i64", "_o__stat64", "_o__stat64i32", "_o__wstat32", "_o__wstat32i64", "_o__wstat64", "_o__wstat64i32"] api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-filesystem-l1-1-0.dll"] api_type: ["DLLExport"] @@ -162,13 +162,14 @@ For more compatibility information, see [Compatibility](../compatibility.md). #include #include #include +#include int main( void ) { struct _stat buf; int result; char timebuf[26]; - char* filename = "crt_stat.c"; + const char* filename = "crt_stat.c"; errno_t err; // Get data associated with "crt_stat.c": diff --git a/docs/c-runtime-library/reference/strnlen-strnlen-s.md b/docs/c-runtime-library/reference/strnlen-strnlen-s.md index d74f2d71dc1..ba5972caaec 100644 --- a/docs/c-runtime-library/reference/strnlen-strnlen-s.md +++ b/docs/c-runtime-library/reference/strnlen-strnlen-s.md @@ -24,7 +24,7 @@ size_t strnlen( const char *str, size_t numberOfElements ); -size_t strnlen_s( +size_t strnlen_s( // See note in remarks section about linkage const char *str, size_t numberOfElements ); @@ -32,7 +32,7 @@ size_t wcsnlen( const wchar_t *str, size_t numberOfElements ); -size_t wcsnlen_s( +size_t wcsnlen_s( // See note in remarks section about linkage const wchar_t *str, size_t numberOfElements ); @@ -88,6 +88,11 @@ Each of these functions returns the number of characters in *`str`*, not includi By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `strnlen_s` and `wcsnlen_s` are no longer `static inline` (internal linkage). Instead, they are `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ### Generic-text routine mappings | `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | diff --git a/docs/c-runtime-library/reference/time-time32-time64.md b/docs/c-runtime-library/reference/time-time32-time64.md index 782e7aa8359..8db058298e9 100644 --- a/docs/c-runtime-library/reference/time-time32-time64.md +++ b/docs/c-runtime-library/reference/time-time32-time64.md @@ -8,7 +8,6 @@ api_type: ["DLLExport"] topic_type: ["apiref"] f1_keywords: ["TIME/time", "TIME/_time32", "TIME/_time64", "time", "_time32", "_time64"] helpviewer_keywords: ["time32 function", "_time32 function", "_time64 function", "time functions", "system time", "time64 function"] -ms.assetid: 280e00f2-2b93-4ece-94cd-e048484c6cc7 --- # `time`, `_time32`, `_time64` @@ -17,7 +16,7 @@ Gets the system time. ## Syntax ```C -time_t time( time_t *destTime ); +time_t time( time_t *destTime ); // See note in remarks section about linkage __time32_t _time32( __time32_t *destTime ); __time64_t _time64( __time64_t *destTime ); ``` @@ -35,7 +34,14 @@ Returns the time as seconds elapsed since midnight, January 1, 1970, or -1 if th The **`time`** function returns the number of seconds elapsed since midnight (00:00:00), January 1, 1970, Coordinated Universal Time (UTC), according to the system clock. The return value is stored in the location given by *`destTime`*. This parameter may be `NULL`, in which case the return value isn't stored. -**`time`** is a wrapper for **`_time64`** and **`time_t`** is, by default, equivalent to **`__time64_t`**. If you need to force the compiler to interpret **`time_t`** as the old 32-bit **`time_t`**, you can define `_USE_32BIT_TIME_T`. We don't recommend `_USE_32BIT_TIME_T`, because your application may fail after January 18, 2038; the use of this macro isn't allowed on 64-bit platforms. +**`time_t`** is defined in `` and ``. It represents time as an integer count of seconds. It's equivalent to **`__time64_t`** by default, which is a 64-bit signed integer that supports dates through 23:59:59, December 31, 3000 UTC. If you need the compiler to interpret **`time_t`** as the old 32-bit **`time_t`**, define `_USE_32BIT_TIME_T`. We don't recommend `_USE_32BIT_TIME_T` because your application may fail after January 18, 2038. This macro isn't allowed on 64-bit platforms. + +**`time`** is a wrapper for **`_time64`**. + +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `time` is no longer `static inline` (internal linkage). Instead, it's `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. ## Requirements diff --git a/docs/c-runtime-library/reference/timespec-get-timespec32-get-timespec64-get1.md b/docs/c-runtime-library/reference/timespec-get-timespec32-get-timespec64-get1.md index e14e404ae67..fea1cd33a5a 100644 --- a/docs/c-runtime-library/reference/timespec-get-timespec32-get-timespec64-get1.md +++ b/docs/c-runtime-library/reference/timespec-get-timespec32-get-timespec64-get1.md @@ -17,7 +17,7 @@ Sets the interval pointed to by the first argument to the current calendar time, ## Syntax ```C -int timespec_get( +int timespec_get( // See note in remarks section about linkage struct timespec* const time_spec, int const base ); @@ -55,6 +55,11 @@ These functions support only `TIME_UTC` as the *`base`* value. `TIME_UTC` sets t By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `timespec_get` is no longer `static inline` (internal linkage). Instead, it's `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ## Requirements | Routine | Required header | diff --git a/docs/c-runtime-library/reference/utime-utime32-utime64-wutime-wutime32-wutime64.md b/docs/c-runtime-library/reference/utime-utime32-utime64-wutime-wutime32-wutime64.md index d5a82ee0b63..84b91e8d2ea 100644 --- a/docs/c-runtime-library/reference/utime-utime32-utime64-wutime-wutime32-wutime64.md +++ b/docs/c-runtime-library/reference/utime-utime32-utime64-wutime-wutime32-wutime64.md @@ -8,7 +8,6 @@ api_type: ["DLLExport"] topic_type: ["apiref"] f1_keywords: ["UTIME/_utime", "UTIME/_utime32", "UTIME/_utime64", "UTIME/_wutime", "UTIME/_wutime32", "UTIME/_wutime64", "TCHAR/_tutime", "TCHAR/_tutime32", "TCHAR/_tutime64", "_utime", "_utime32", "_utime64", "_wutime", "_wutime32", "_wutime64", "_tutime", "_tutime32", "_tutime64"] helpviewer_keywords: ["tutime function", "utime32 function", "utime64 function", "_utime function", "_tutime32 function", "time [C++], file modification", "wutime function", "_wutime function", "_wutime32 function", "_tutime64 function", "_tutime function", "files [C++], modification time", "_wutime64 function", "_utime32 function", "utime function", "_utime64 function", "wutime64 function", "wutime32 function", "tutime64 function", "tutime32 function"] -ms.assetid: 8d482d40-19b9-4591-bfee-5d7f601d1a9e --- # `_utime`, `_utime32`, `_utime64`, `_wutime`, `_wutime32`, `_wutime64` @@ -17,7 +16,7 @@ Set the file modification time. ## Syntax ```C -int _utime( +int _utime( // See note in remarks section about linkage const char *filename, struct _utimbuf *times ); @@ -29,7 +28,7 @@ int _utime64( const char *filename, struct __utimbuf64 *times ); -int _wutime( +int _wutime( // See note in remarks section about linkage const wchar_t *filename, struct _utimbuf *times ); @@ -85,6 +84,11 @@ Specific versions of the `_utimbuf` structure (`__utimbuf32` and `__utimbuf64`) By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md). +> [!Note] +> When you use Windows SDK version 10.0.26100.6901 and Visual Studio 2026 or later together, `_utime` and `_wutime` are no longer `static inline` (internal linkage). Instead, they're `inline` (external linkage).\ +> To return to the previous behavior, `#define _STATIC_INLINE_UCRT_FUNCTIONS=1` before including any CRT headers. By default, `_STATIC_INLINE_UCRT_FUNCTIONS` is set to 0.\ +> This change increases UCRT conformance with the C++ standard and improves compatibility with C++ modules. + ### Generic-text routine mappings | TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | diff --git a/docs/c-runtime-library/reference/vcprintf-p-vcprintf-p-l-vcwprintf-p-vcwprintf-p-l.md b/docs/c-runtime-library/reference/vcprintf-p-vcprintf-p-l-vcwprintf-p-vcwprintf-p-l.md index 99103757608..04735adbee7 100644 --- a/docs/c-runtime-library/reference/vcprintf-p-vcprintf-p-l-vcwprintf-p-vcwprintf-p-l.md +++ b/docs/c-runtime-library/reference/vcprintf-p-vcprintf-p-l-vcwprintf-p-vcwprintf-p-l.md @@ -62,7 +62,7 @@ Each of these functions takes a pointer to an argument list, and then uses the ` The versions of these functions that have the `_l` suffix are identical except that they use the locale parameter that's passed in instead of the current locale. -Each *`argument`* (if any) is converted and is output according to the corresponding format specification in *`format`*. The format specification supports positional parameters so that you can specify the order in which the arguments are used in the format string. For more information, see [printf_p Positional Parameters](../printf-p-positional-parameters.md). +Each *`argument`* (if any) is converted and is output according to the corresponding format specification in *`format`*. The format specification supports positional parameters so that you can specify the order in which the arguments are used in the format string. For more information, see [`printf_p` positional parameters](../printf-p-positional-parameters.md). These functions don't translate line-feed characters on output into carriage return-line feed (CR-LF) combinations. @@ -73,7 +73,7 @@ These functions validate the input pointer and the format string. If *`format`* ### Generic-text routine mappings -| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | |---|---|---|---| | `_vtcprintf_p` | **`_vcprintf_p`** | **`_vcprintf_p`** | **`_vcwprintf_p`** | | `_vtcprintf_p_l` | **`_vcprintf_p_l`** | **`_vcprintf_p_l`** | **`_vcwprintf_p_l`** | @@ -82,8 +82,8 @@ These functions validate the input pointer and the format string. If *`format`* | Routine | Required header | |---|---| -| **`_vcprintf_p`**, **`_vcprintf_p_l`** | \ and \ | -| **`_vcwprintf_p`**, **`_vcwprintf_p_l`** | \ and \ | +| **`_vcprintf_p`**, **`_vcprintf_p_l`** | `` and `` | +| **`_vcwprintf_p`**, **`_vcwprintf_p_l`** | `` and `` | For more compatibility information, see [Compatibility](../compatibility.md). @@ -101,18 +101,18 @@ For more compatibility information, see [Compatibility](../compatibility.md). // An error formatting function that's used to print to the console. int eprintf(const char* format, ...) { - va_list args; - va_start(args, format); - int result = _vcprintf_p(format, args); - va_end(args); - return result; + va_list args; + va_start(args, format); + int result = _vcprintf_p(format, args); + va_end(args); + return result; } int main() { - int n = eprintf("parameter 2 = %2$d; parameter 1 = %1$s\r\n", - "one", 222); - _cprintf_s("%d characters printed\r\n"); + int n = eprintf("parameter 2 = %2$d; parameter 1 = %1$s\r\n", + "one", 222); + _cprintf_s("%d characters printed\r\n", n); } ``` @@ -126,4 +126,4 @@ parameter 2 = 222; parameter 1 = one [Console and port I/O](../console-and-port-i-o.md)\ [`_cprintf`, `_cprintf_l`, `_cwprintf`, `_cwprintf_l`](cprintf-cprintf-l-cwprintf-cwprintf-l.md)\ [`va_arg`, `va_copy`, `va_end`, `va_start`](va-arg-va-copy-va-end-va-start.md)\ -[printf_p Positional Parameters](../printf-p-positional-parameters.md) +[`printf_p` positional parameters](../printf-p-positional-parameters.md) diff --git a/docs/c-runtime-library/reference/wcstombs-s-wcstombs-s-l.md b/docs/c-runtime-library/reference/wcstombs-s-wcstombs-s-l.md index 058ddb9ccbf..aed6aa514a8 100644 --- a/docs/c-runtime-library/reference/wcstombs-s-wcstombs-s-l.md +++ b/docs/c-runtime-library/reference/wcstombs-s-wcstombs-s-l.md @@ -114,9 +114,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -| Routine | Required header | -|---|---| -| **`wcstombs_s`** | `` | +| Routine | Required header | Required library | +|---|---|---| +| **`wcstombs_s`** | `` | ucrt.lib (the Universal C Runtime Library) | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/sal-annotations.md b/docs/c-runtime-library/sal-annotations.md index 3b7f7b24999..5c145f5c570 100644 --- a/docs/c-runtime-library/sal-annotations.md +++ b/docs/c-runtime-library/sal-annotations.md @@ -1,14 +1,13 @@ --- title: "SAL Annotations" description: "A brief description of the Microsoft source-code annotation language (SAL)." -ms.date: "11/04/2016" +ms.date: 11/04/2016 ms.topic: "concept-article" helpviewer_keywords: ["__z annotation", "ref annotation", "_opt annotation", "__checkreturn annotatioin", "__deref_opt annotation", "deref_opt annotation", "__deref annotation", "__in annotation", "annotations [C++]", "z annotation", "_inout annotation", "__ref annotation", "full annotation", "_in annotation", "_ref annotation", "__out annotation", "_ecount annotation", "SAL annotations", "__opt annotation", "inout annotation", "in annotation", "_CA_SHOULD_CHECK_RETURN", "__bcount annotation", "_full annotation", "_bcount annotation", "deref annotation", "part annotation", "_out annotation", "__nz annotation", "__part annotation", "opt annotation", "__full annotation", "_nz annotation", "_z annotation", "out annotation", "__ecount annotation", "__inout annotation", "SAL annotations, _CA_SHOULD_CHECK_RETURN", "_deref_opt annotation", "_deref annotation", "nz annotation", "_part annotation", "ecount annotation", "bcount annotation"] -ms.assetid: 81893638-010c-41a0-9cb3-666fe360f3e0 --- # SAL annotations -If you examine the library header files, you may notice some unusual annotations, for example, `_In_z` and `_Out_z_cap_(_Size)`. These annotations are examples of the Microsoft source-code annotation language (SAL). SAL provides a set of annotations to describe how a function uses its parameters and return type. For example, it indicates the assumptions it makes about them and the guarantees it makes on finishing. The header file \ defines the annotations. +If you examine the library header files, you may notice some unusual annotations, for example, `_In_z_` and `_Out_z_cap_(_Size)`. These annotations are examples of the Microsoft source-code annotation language (SAL). SAL provides a set of annotations to describe how a function uses its parameters and return type. For example, it indicates the assumptions it makes about them and the guarantees it makes on finishing. The header file \ defines the annotations. For more information about using SAL annotations in Visual Studio, see [Using SAL annotations to reduce C/C++ code defects](../code-quality/using-sal-annotations-to-reduce-c-cpp-code-defects.md). diff --git a/docs/cloud/cloud-and-web-programming-in-visual-cpp.md b/docs/cloud/cloud-and-web-programming-in-visual-cpp.md index f2c9b0519be..3259d2638e5 100644 --- a/docs/cloud/cloud-and-web-programming-in-visual-cpp.md +++ b/docs/cloud/cloud-and-web-programming-in-visual-cpp.md @@ -1,25 +1,28 @@ --- -title: "Cloud and Web Programming in Visual C++" -description: "Learn more about: Cloud and Web Programming in Visual C++" -ms.date: "05/14/2019" +title: "Cloud and Web Programming in Microsoft C++" +description: "Learn more about: Cloud and Web Programming in Microsoft C++" +ms.date: "11/06/2025" ms.topic: "overview" ms.custom: intro-overview --- -# Cloud and Web Programming in Visual C++ +# Cloud and web programming in Microsoft C++ In C++, you have several options for connecting to the web and the cloud. ## Microsoft Azure SDKs and REST services -- [Microsoft Azure Storage Client Library for C++](https://azure.github.io/azure-storage-cpp/) +- [Azure SDK for C++](/azure/developer/cpp/sdk/overview) - The Azure Storage Client Library for C++ provides a comprehensive API for working with Azure storage, including but not limited to the following abilities: + The Azure SDK for C++ provides a set of client libraries that enable your C++ applications to interact seamlessly with Azure services, whether in local or cloud environments. These libraries, built on top of the Azure REST API, offer familiar C++ syntax and implement common cloud patterns such as authentication, logging, and retries. The SDK provides a consistent interface for working with Azure services including: - - Create, read, delete, and list blob containers, tables, and queues. - - Create, read, delete, list and copy blobs plus read and write blob ranges. - - Insert, delete, replace, merge, and query entities in an Azure table. - - Enqueue and dequeue messages in an Azure queue. - - Lazily list containers, blobs, tables, and queues, and lazily query entities + - Azure Core + - Azure Identity + - Azure Attestation + - Azure Event Hubs + - Azure Storage + - Azure Key Vault + + To get started, see [Install and integrate from the Azure SDK for C++](/azure/developer/cpp/sdk/install-and-integrate-the-sdk/). - The ANSI C99 [Azure IoT Hub SDKs](/azure/iot-hub/iot-hub-devguide-sdks) for Internet of Things enable IoT applications to run on the device or on the backend. @@ -42,7 +45,7 @@ In C++, you have several options for connecting to the web and the cloud. - [Windows::Web::Http::HttpClient](/uwp/api/windows.web.http.httpclient) - A Windows Runtime HTTP client class modeled on the .NET Framework class of the same name in the System.Web namespace. `HttpClient` fully supports asynchronous upload and download over HTTP, and pipeline filters that enable the insertion of custom HTTP handlers into the pipeline. The Windows SDK includes sample filters for metered networks, OAuth authentication, and more. For apps that target only Universal Windows Platform, we recommend that you use the `Windows::Web::Http::HttpClient` class. + A Windows Runtime HTTP client class modeled on the .NET Framework class of the same name in the System.Web namespace. `HttpClient` fully supports asynchronous upload and download over HTTP, and pipeline filters that enable the insertion of custom HTTP handlers into the pipeline. The Windows SDK includes sample filters for metered networks, OAuth authentication, and more. For apps that target only Universal Windows Platform, use the `Windows::Web::Http::HttpClient` class. - [IXMLHTTPRequest2 interface](/windows/win32/api/msxml6/nn-msxml6-ixmlhttprequest2) @@ -55,5 +58,5 @@ In C++, you have several options for connecting to the web and the cloud. ## See also [C++ in Visual Studio](../overview/visual-cpp-in-visual-studio.md)\ -[Microsoft Azure C and C++ Developer Center](https://azure.microsoft.com/develop/cpp/)\ +[Microsoft Azure C++ Developer Center](/azure/developer/cpp/)\ [Networks and web services (UWP)](/windows/uwp/networking/) diff --git a/docs/code-quality/annotating-function-parameters-and-return-values.md b/docs/code-quality/annotating-function-parameters-and-return-values.md index 5c0a0531f02..2514f7ef61b 100644 --- a/docs/code-quality/annotating-function-parameters-and-return-values.md +++ b/docs/code-quality/annotating-function-parameters-and-return-values.md @@ -1,5 +1,5 @@ --- -title: Annotating function parameters and return values +title: "Annotating function parameters and return values" description: "Reference guide to function parameter and return value annotations." ms.date: 10/15/2019 ms.topic: "concept-article" @@ -102,7 +102,7 @@ f1_keywords: - "_In_" - "_Inout_updates_bytes_" - "_In_reads_to_ptr_z_" - - "_Ret_writes_bytes_to_maybenull" + - "_Ret_writes_bytes_to_maybenull_" - "_Outptr_opt_result_nullonfailure_" - "_In_reads_to_ptr_" - "_Outptr_result_buffer_" @@ -123,7 +123,6 @@ f1_keywords: - "_Scanf_format_string_" - "_Scanf_s_format_string_" - "_Printf_format_string_" -ms.assetid: 82826a3d-0c81-421c-8ffe-4072555dca3a --- # Annotating function parameters and return values diff --git a/docs/code-quality/build-reliable-secure-programs.md b/docs/code-quality/build-reliable-secure-programs.md index 94181eb5c90..2f31f19fc15 100644 --- a/docs/code-quality/build-reliable-secure-programs.md +++ b/docs/code-quality/build-reliable-secure-programs.md @@ -114,8 +114,8 @@ Tests that do deeper verification and take longer to run, such as static analysi **Key tools** Be aware of and use the following: - [Code analysis documentation - C++ and .NET](/visualstudio/code-quality/) -- [`/analyze` - Visual C++ compiler](../build/reference/analyze-code-analysis.md) -- [`/W4` and `/WX` - Visual C++ compiler](../build/reference/compiler-option-warning-level.md) +- [`/analyze` - Microsoft C++ compiler](../build/reference/analyze-code-analysis.md) +- [`/W4` and `/WX` - Microsoft C++ compiler](../build/reference/compiler-option-warning-level.md) - [Use the C++ Core Guidelines Checkers](using-the-cpp-core-guidelines-checkers.md) - [CodeQL | GitHub](https://codeql.github.com/) - [Binskim user guide | GitHub](https://github.com/microsoft/binskim/blob/main/docs/UserGuide.md) @@ -123,7 +123,7 @@ Tests that do deeper verification and take longer to run, such as static analysi Notes: -- `/analyze` enables static analysis of C++ code at compile time to identify critical security and reliability code vulnerabilities. It should be enabled throughout a C++ program's entire development timeline. Start by enabling at least the "Microsoft Native Recommended" by default as a minimum baseline. Then consult the documentation for how to specify more rules, especially the C++ Core Guidelines rules, as required by your engineering policies. The source code Static Analysis capability is available in both the Visual C++ IDE and in the command-line Build Tools. +- `/analyze` enables static analysis of C++ code at compile time to identify critical security and reliability code vulnerabilities. It should be enabled throughout a C++ program's entire development timeline. Start by enabling at least the "Microsoft Native Recommended" by default as a minimum baseline. Then consult the documentation for how to specify more rules, especially the C++ Core Guidelines rules, as required by your engineering policies. The source code Static Analysis capability is available in both the Visual Studio IDE and in the command-line Build Tools. - `/W4` and `/WX` should be enabled wherever possible, to ensure you compile your code cleanly at high warning levels (`W4`) and treat warnings as errors that must be fixed (`WX`). These options enable finding uninitialized data errors that other static analysis tools can't check, because the errors only become visible after the compiler back-end performs interprocedural analysis and inlining. - BinSkim binary analysis ensures that projects enable a broad range of security features. BinSkim generates PDBs and other outputs that make it easier to verify chain-of-custody and to respond efficiently to security issues. Microsoft recommends running the BinSkim tool to analyze all executable binaries (`.sys`, `.dll` or `.exe`) produced for or consumed by your programs. The BinSkim User Guide includes a list of supported security standards. Microsoft recommends that you fix all issues reported as "errors" by the BinSkim tool. Issues reported as "warnings" should be evaluated selectively, because resolving them can have performance implications or might not be necessary. @@ -249,14 +249,14 @@ Binaries shouldn't link to insecure libraries and dependencies. Development team Compilation should enable strong code provenance guarantees to help detect and prevent introduction of backdoors and other malicious code. The resulting data, also critical to debugging and investigation, should be archived for all software releases to drive efficient security response if they're compromised. The following compiler switches generate information that is critical to a security response: -- [`/ZH:SHA_SHA256` in Visual C++](../build/reference/zh.md) - Ensures that a cryptographically secure algorithm is used to generate all PDB source file hashes. -- [`/Zi`, `/ZI` (Debug Information Format) in Visual C++](../build/reference/z7-zi-zi-debug-information-format.md) - In addition to publishing stripped symbols for collecting crash data and other public use scenarios, ensure that builds produce and archive private PDBs for all released binaries. Binary analysis tools require full symbols to verify whether many security mitigations were enabled at compile-time. Private symbols are critical in security response, and lower debugging and investigation costs when engineers are racing to assess and limit damage when an exploit happens. -- [`/SOURCELINK` in Visual C++ Linker - Include Sourcelink file in PDB](../build/reference/sourcelink.md): Source link is a language- and source-control agnostic system providing source debugging for binaries. Source debugging greatly increases the efficiency the range of prerelease security validations and post-release incident response. +- [`/ZH:SHA_SHA256` in Microsoft C++](../build/reference/zh.md) - Ensures that a cryptographically secure algorithm is used to generate all PDB source file hashes. +- [`/Zi`, `/ZI` (Debug Information Format) in Microsoft C++](../build/reference/z7-zi-zi-debug-information-format.md) - In addition to publishing stripped symbols for collecting crash data and other public use scenarios, ensure that builds produce and archive private PDBs for all released binaries. Binary analysis tools require full symbols to verify whether many security mitigations were enabled at compile-time. Private symbols are critical in security response, and lower debugging and investigation costs when engineers are racing to assess and limit damage when an exploit happens. +- [`/SOURCELINK` in Microsoft C++ Linker - Include Sourcelink file in PDB](../build/reference/sourcelink.md): Source link is a language- and source-control agnostic system providing source debugging for binaries. Source debugging greatly increases the efficiency the range of prerelease security validations and post-release incident response. **Enable compiler errors to prevent issues at code authoring time** Compilation should enable security-relevant compiler checks as breaking errors, for example: -- [`/sdl` in Visual C++ - Enable additional security checks](https://aka.ms/AdditionalSecurityChecks) elevates many security-relevant warnings into errors and enables advanced secure code-generation features. +- [`/sdl` in Microsoft C++ - Enable additional security checks](https://aka.ms/AdditionalSecurityChecks) elevates many security-relevant warnings into errors and enables advanced secure code-generation features. - [BinSkim BA2007.EnableCriticalCompilerWarnings | GitHub](https://github.com/microsoft/binskim/blob/main/src/BinSkim.Rules/PERules/BA2007.EnableCriticalCompilerWarnings.cs) maintains a list of Microsoft-recommended C/C++ compiler warnings that should always be enabled and elevated to errors. **Mark binaries as compatible with OS runtime security mitigations** @@ -401,7 +401,7 @@ Modify your build(s) to support continuous creation of executables that use LibF **Summary** -Within the scope of Microsoft Visual C++ on Windows, Microsoft recommends: +Within the scope of Microsoft C++ on Windows, Microsoft recommends: - Prefer TypeScript, JavaScript, and ASP.NET for web applications. - Don't write web extensions in C++. Microsoft has deprecated ActiveX. diff --git a/docs/code-quality/c26116.md b/docs/code-quality/c26116.md index 5282963f532..b6d60a75544 100644 --- a/docs/code-quality/c26116.md +++ b/docs/code-quality/c26116.md @@ -1,20 +1,19 @@ --- +title: "Warning C26116" description: "Learn more about: Warning C26116" -title: Warning C26116 ms.date: 11/04/2016 f1_keywords: ["C26116"] helpviewer_keywords: ["C26116"] -ms.assetid: 43e99d2c-405e-4913-b6bd-47f5858b2877 --- # Warning C26116 > Failing to acquire or to hold lock '*lock*' in '*func*'. -Enforcement of syntactically scoped lock *acquire* and lock *release* pairs in C/C++ programs isn't performed by the language. A function may introduce a locking side effect by making an observable modification to the concurrency state. For example, a lock wrapper function increments the number of lock acquisitions, or lock count, for a given lock. You can annotate a function that has a side effect from a lock acquire or lock release by using `_Acquires_lock_` or `_Requires_lock_held`, respectively. Without such annotations, a function is expected not to change any lock count after it returns. If acquires and releases aren't balanced, they're considered to be *orphaned*. Warning C26116 is issued when a function has been annotated with `_Acquires_lock_`, but it doesn't acquire a lock, or when a function is annotated with `_Requires_lock_held` and releases the lock. +Enforcement of syntactically scoped lock *acquire* and lock *release* pairs in C/C++ programs isn't performed by the language. A function may introduce a locking side effect by making an observable modification to the concurrency state. For example, a lock wrapper function increments the number of lock acquisitions, or lock count, for a given lock. You can annotate a function that has a side effect from a lock acquire or lock release by using `_Acquires_lock_` or `_Requires_lock_held_`, respectively. Without such annotations, a function is expected not to change any lock count after it returns. If acquires and releases aren't balanced, they're considered to be *orphaned*. Warning C26116 is issued when a function has been annotated with `_Acquires_lock_`, but it doesn't acquire a lock, or when a function is annotated with `_Requires_lock_held_` and releases the lock. ## Example -The following example generates warning C26116 because the function `DoesNotLock` was annotated with `_Acquires_lock_` but doesn't acquire it. The function `DoesNotHoldLock` generates the warning because it's annotated with `_Requires_lock_held` and doesn't hold it. +The following example generates warning C26116 because the function `DoesNotLock` was annotated with `_Acquires_lock_` but doesn't acquire it. The function `DoesNotHoldLock` generates the warning because it's annotated with `_Requires_lock_held_` and doesn't hold it. ```cpp typedef struct _DATA diff --git a/docs/code-quality/c26498.md b/docs/code-quality/c26498.md index 417a4254275..7bb0edb9750 100644 --- a/docs/code-quality/c26498.md +++ b/docs/code-quality/c26498.md @@ -1,5 +1,5 @@ --- -title: Warning C26498 +title: "Warning C26498" description: "Learn more about: Warning C26498 USE_CONSTEXPR_FOR_FUNCTIONCALL" ms.date: 08/18/2020 f1_keywords: ["C26498", "USE_CONSTEXPR_FOR_FUNCTIONCALL"] @@ -58,6 +58,6 @@ void foo() ## See also -[C26497](c26407.md)\ +[C26497](c26497.md)\ [C26814](c26814.md)\ [Con.5: Use `constexpr` for values that can be computed at compile time](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rconst-constexpr) diff --git a/docs/code-quality/c26865.md b/docs/code-quality/c26865.md new file mode 100644 index 00000000000..0e9bd9d213a --- /dev/null +++ b/docs/code-quality/c26865.md @@ -0,0 +1,54 @@ +--- +description: "Learn more about: Warning C26865" +title: Warning C26865 +ms.date: 10/03/2022 +f1_keywords: ["C26865", "ALLOCATION_DEALLOCATION_MISMATCH", "__WARNING_ALLOCATION_DEALLOCATION_MISMATCH"] +helpviewer_keywords: ["C26865"] +ms.assetid: 2fbe9dc5-fa43-47b9-97a7-3f8215da1d40 +--- +# Warning C26865 + +> Memory allocated with '\' is being deallocated with '\'. Use '\' instead. + +This rule was added in Visual Studio 2026 18.0. + +## Remarks + +This warning indicates that the memory was allocated with one family of allocation functions, but was freed with a deallocation function from a different family. This usage results in undefined behavior according to C/C++ and the Microsoft MSVC implementation. + +The exact ramifications of this defect are difficult to predict. It might result in leaks for classes with destructors that perform memory deallocation. It could cause inconsistent behavior for classes with destructors that perform semantically significant operations, or memory corruptions and crashes. In other cases the mismatch might be unimportant, depending on the implementation of the compiler and its libraries. Analysis tools can't always distinguish between these situations. + +If memory is allocated with one family of allocation functions, it should be freed with a matching deallocation function. + +C26865 covers the following allocation/deallocation pairs: + +- C++ scalar new (`new`) must be deallocated with scalar delete (`delete`). +- C++ array new (`new[]`) must be deallocated with array delete (`delete[]`). +- C/C++ `malloc`/`calloc`/`realloc` must be deallocated with `free` (or `realloc`). +- Windows `HeapAlloc` must be deallocated with `HeapFree`. +- Windows `GlobalAlloc` must be deallocated with `GlobalFree`. +- Windows `LocalAlloc` must be deallocated with `LocalFree`. +- Windows `MIDL_user_allocate` must be deallocated with `MIDL_user_free`. +- Component Object Model (COM) `CoTaskMemAlloc` must be deallocated with `CoTaskMemFree`. + +Code analysis name: `ALLOCATION_DEALLOCATION_MISMATCH` + +## Example + +The following sample code generates warning C26865: + +```cpp +void f() { + int *pInt = (int *)calloc(10, sizeof(int)); + // code ... + delete pInt; // C26865: Memory allocated with 'calloc' is being deallocated with 'delete'. Use 'free' instead. +} + +void g() { + char * str = new char[50]; + // code ... + delete str; // C26865: Memory allocated with 'new[]' is being deallocated with 'delete'. Use 'delete[]' instead. +} +``` + +Manual memory management has many pitfalls in terms of memory leaks and exceptions. To avoid these kinds of potential leaks altogether, use the mechanisms that are provided by the C++ Standard Library (STL). These mechanisms include [`shared_ptr`](../standard-library/shared-ptr-class.md), [`unique_ptr`](../standard-library/unique-ptr-class.md), and containers such as [`vector`](../standard-library/vector.md). For more information, see [Smart pointers](../cpp/smart-pointers-modern-cpp.md) and [C++ Standard Library](../standard-library/cpp-standard-library-reference.md). diff --git a/docs/code-quality/c6064.md b/docs/code-quality/c6064.md index 48f04cb99aa..2bf2c32b05d 100644 --- a/docs/code-quality/c6064.md +++ b/docs/code-quality/c6064.md @@ -1,5 +1,5 @@ --- -title: Warning C6064 +title: "Warning C6064" description: "Learn more about: Warning C6064" ms.date: 9/29/2025 f1_keywords: ["C6064", "MISSING_INTEGER_ARGUMENT_TO_FORMAT_FUNCTION", "__WARNING_MISSING_INTEGER_ARGUMENT_TO_FORMAT_FUNCTION"] @@ -21,7 +21,7 @@ Code analysis name: `MISSING_INTEGER_ARGUMENT_TO_FORMAT_FUNCTION` ## Example -The following code generates this warning by passing the wrong number of arguments to `sprintf_s` and the missing argument is an integer. If the unsafe function `sprintf` was used instead of the safer variant `sprintf_s`, this code would likely cause a stack overflow instead of just unexpected output: +The following code generates this warning when code analysis is enabled (Project properties > **Configuration Properties** > **Code Analysis ** > **General** > **Enable Code Analysis on Build**) because it uses an incorrect number of arguments in the call to `sprintf_s` and the missing argument is an integer. If the unsafe function `sprintf` was used instead of the safer variant `sprintf_s`, this code would likely cause a stack overflow instead of just an unexpected output: ```cpp void f() diff --git a/docs/code-quality/c6200.md b/docs/code-quality/c6200.md index 0003197a5fd..945df12b0be 100644 --- a/docs/code-quality/c6200.md +++ b/docs/code-quality/c6200.md @@ -70,3 +70,16 @@ void f() ``` Code analysis doesn't warn with just `rand()` because it doesn't have any information about its return value. On the other hand, `rand() % 15` and `rand() % 14` provide hints as to the range of the return value of `rand()` and code analysis can use that information to determine that the index is out of bounds in the first case but not the second. + +## Disable warning C6200 + +You can disable this warning project-wide by passing the compiler switch `/wd6200`. If you want a more targeted solution, surround the code that generates the warning with: + +```cpp + #pragma warning(push) // save which warnings are enabled/disabled + #pragma warning(disable: 6200) // suppress this warning only in this block + // ... code that intentionally generates C6200 + #pragma warning(pop) // restore the warning state saved with the previous push +``` + +To learn more about pragma directives, see [warning pragma](../preprocessor/warning.md). diff --git a/docs/code-quality/c6278.md b/docs/code-quality/c6278.md index 55e0ddb1a28..44f9604a392 100644 --- a/docs/code-quality/c6278.md +++ b/docs/code-quality/c6278.md @@ -9,6 +9,10 @@ helpviewer_keywords: ["C6278"] > '*variable*' is allocated with array new [], but deleted with scalar delete. Destructors will not be called. +## Notice + +Warning C6278 was removed in Visual Studio 2026. Use the more generic warning [`C26865`](../code-quality/C26865.md) instead. + ## Remarks This warning appears only in C++ code and indicates that the calling function has inconsistently allocated memory with the array **`new []`** operator, but freed it with the scalar **`delete`** operator. This usage is undefined behavior according to the C++ standard and the Microsoft C++ implementation. diff --git a/docs/code-quality/c6279.md b/docs/code-quality/c6279.md index 8c9b92fc129..4107dd19b22 100644 --- a/docs/code-quality/c6279.md +++ b/docs/code-quality/c6279.md @@ -9,6 +9,12 @@ helpviewer_keywords: ["C6279"] > '*variable-name*' is allocated with scalar new, deleted with array delete [] +This warning appears only in C++ code and indicates that the calling function has inconsistently allocated memory with the scalar `new` operator, but freed it with the array `delete[]` operator. If memory is allocated with scalar `new`, it should typically be freed with scalar `delete`. + +## Notice + +Warning C6279 was removed in Visual Studio 2026. Use the more generic warning [`C26865`](../code-quality/C26865.md) instead. + ## Remarks This warning appears only in C++ code and indicates that the calling function has inconsistently allocated memory with the scalar `new` operator, but freed it with the array `delete[]` operator. If memory is allocated with scalar `new`, it should typically be freed with scalar `delete`. diff --git a/docs/code-quality/c6280.md b/docs/code-quality/c6280.md index 0fa6146b704..8d30cbf344f 100644 --- a/docs/code-quality/c6280.md +++ b/docs/code-quality/c6280.md @@ -9,6 +9,12 @@ helpviewer_keywords: ["C6280"] > '*variable-name*' is allocated with '*function-name-1*', but deleted with '*function-name-2*' +This warning indicates that the calling function has inconsistently allocated memory by using a function from one family and freed it by using a function from another. + +## Notice + +Warning C6280 was removed in Visual Studio 2026. Use the more generic warning [`C26865`](../code-quality/C26865.md) instead. + ## Remarks This warning indicates that the calling function has inconsistently allocated memory by using a function from one family and freed it by using a function from another. diff --git a/docs/code-quality/c6283.md b/docs/code-quality/c6283.md index 4607e25d0ce..5ae2a64d214 100644 --- a/docs/code-quality/c6283.md +++ b/docs/code-quality/c6283.md @@ -9,6 +9,12 @@ helpviewer_keywords: ["C6283"] > '*variable-name*' is allocated with array new [], but deleted with scalar delete +This warning appears only in C++ code and indicates that the calling function has inconsistently allocated memory with the array `new []` operator, but freed it with the scalar `delete` operator. + +## Notice + +Warning C6283 was removed in Visual Studio 2026. Use the more generic warning [`C26865`](../code-quality/C26865.md) instead. + ## Remarks This warning appears only in C++ code and indicates that the calling function has inconsistently allocated memory with the array `new []` operator, but freed it with the scalar `delete` operator. diff --git a/docs/code-quality/c6387.md b/docs/code-quality/c6387.md index fc082680d9d..b6aa4f4bc65 100644 --- a/docs/code-quality/c6387.md +++ b/docs/code-quality/c6387.md @@ -1,9 +1,10 @@ --- title: "Warning C6387" description: "Learn more about: Warning C6387" -ms.date: 11/04/2016 +ms.date: 04/10/2026 f1_keywords: ["C6387", "INVALID_PARAM_VALUE_1", "__WARNING_INVALID_PARAM_VALUE_1"] helpviewer_keywords: ["C6387"] +ai-usage: ai-assisted --- # Warning C6387 @@ -13,42 +14,88 @@ helpviewer_keywords: ["C6387"] This warning is raised if an annotated function parameter is being passed an unexpected value. For example, passing a potentially null value to a parameter that is marked with `_In_` annotation generates this warning. +This commonly happens when one function is annotated with `_Post_ _Null_` on its return value (meaning it may return null), and the result is then passed to another function that expects a non-null `_In_` parameter. To fix the issue, either change the first function's annotation to `_Post_ _Notnull_` if it truly never returns null, or add a null check before passing the value to the second function. + +> [!NOTE] +> The SAL annotations (`_Post_ _Null_`, `_Post_ _Notnull_`, `_In_`, and so on) are used on function declarations to describe the contract of the function's parameters and return values. They do not apply to local variable declarations. + Code analysis name: `INVALID_PARAM_VALUE_1` ## Example -The following code generates this warning because a null parameter is passed to `f(char *)`: +The following code generates this warning because the function `g` is annotated as potentially returning null (`_Post_ _Null_`), and the result is passed to `f`, which requires a non-null input (`_In_`): ```cpp #include +#include -_Post_ _Null_ char * g(); +_Post_ _Null_ char* g() +{ + return nullptr; +} -void f(_In_ char *pch); +void f(_In_ char* pch) +{ + printf("%s\n", pch);; +} int main() { - char *pCh = g(); + char* pCh = g(); f(pCh); // Warning C6387 } ``` -To correct this warning, use the following code: +To correct this warning, you can change the annotation on `g` if it never actually returns null: ```cpp #include +#include + +_Post_ _Notnull_ char* g() +{ + static char buf[] = "hello"; + return buf; +} + +void f(_In_ char* pch) +{ + printf("%s\n", pch); +} -_Post_ _Notnull_ char * g(); +int main() +{ + char* pCh = g(); + f(pCh); // No warning C6387 +} +``` + +Alternatively, you can add a null check before passing the value: + +```cpp +#include +#include -void f(_In_ char *pch); +_Post_ _Null_ char* g() +{ + return nullptr; +} + +void f(_In_ char* pch) +{ + printf("%s\n", pch); +} int main() { - char *pCh = g(); - f(pCh); + char* pCh = g(); + if (pCh != nullptr) + { + f(pCh); // No warning C6387 + } } ``` ## See also -[strlen, wcslen, _mbslen, _mbslen_l, _mbstrlen, _mbstrlen_l](../c-runtime-library/reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md) +[`strlen`, `wcslen`, `_mbslen`, `_mbslen_l`, `_mbstrlen`, `_mbstrlen_l`](../c-runtime-library/reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md) diff --git a/docs/code-quality/code-analysis-for-c-cpp-overview.md b/docs/code-quality/code-analysis-for-c-cpp-overview.md index 33c4a8e91e1..fffa6d3ad8b 100644 --- a/docs/code-quality/code-analysis-for-c-cpp-overview.md +++ b/docs/code-quality/code-analysis-for-c-cpp-overview.md @@ -20,7 +20,7 @@ ms.assetid: 81f0c9e8-f471-4de5-aac4-99db336a8809 --- # Code analysis for C/C++ overview -The C/C++ Code Analysis tool provides information about possible defects in your C/C++ source code. Common coding errors reported by the tool include buffer overruns, uninitialized memory, null pointer dereferences, and memory and resource leaks. The tool can also run checks against the [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines). +The Microsoft C++ Code Analysis tool provides information about possible defects in your C/C++ source code. Common coding errors reported by the tool include buffer overruns, uninitialized memory, null pointer dereferences, and memory and resource leaks. The tool can also run checks against the [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines). ## IDE (integrated development environment) integration diff --git a/docs/code-quality/code-analysis-for-cpp-corecheck.md b/docs/code-quality/code-analysis-for-cpp-corecheck.md index 82158f2233b..c57ae64393f 100644 --- a/docs/code-quality/code-analysis-for-cpp-corecheck.md +++ b/docs/code-quality/code-analysis-for-cpp-corecheck.md @@ -1,11 +1,10 @@ --- +title: "C++ Core Guidelines checker reference" description: "Learn more about: C++ Core Guidelines checker reference" -title: C++ Core Guidelines checker reference ms.date: 03/22/2018 ms.topic: reference helpviewer_keywords: - "code analysis, C++ core check" -ms.assetid: f1429463-136e-41ed-8a75-a8dbf0b4fd89 --- # C++ Core Guidelines checker reference @@ -214,7 +213,7 @@ Do not use function style C-casts. See [C++ Core Guidelines ES.49](https://isocp [C26490 NO_REINTERPRET_CAST](c26490.md)\ Don't use `reinterpret_cast`. See [C++ Core Guidelines Type.1](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Pro-type-reinterpretcast). -[C26491 NO_STATIC_DOWNCAST](c26490.md)\ +[C26491 NO_STATIC_DOWNCAST](c26491.md)\ Don't use `static_cast` downcasts. See [C++ Core Guidelines Type.2](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Pro-type-downcast). [C26492 NO_CONST_CAST](c26492.md)\ diff --git a/docs/code-quality/quick-start-code-analysis-for-c-cpp.md b/docs/code-quality/quick-start-code-analysis-for-c-cpp.md index 7c2a7c05f31..1a8f22e7f2c 100644 --- a/docs/code-quality/quick-start-code-analysis-for-c-cpp.md +++ b/docs/code-quality/quick-start-code-analysis-for-c-cpp.md @@ -17,7 +17,7 @@ You can improve the quality of your application by running code analysis regular 1. Optionally, in the **Configuration** and **Platform** lists, choose the build configuration and target platform. -1. To run code analysis every time the project is built using the selected configuration, select the **Enable Code Analysis on Build** check box. You can also run code analysis manually by opening the **Analyze** menu and then choosing **Run Code Analysis on** *ProjectName* or **Run Code Analysis on File**. +1. To run code analysis every time the project is built using the selected configuration, select **Configuration Properties** > **Code Analysis**, then select the **Enable Code Analysis on Build** check box. You can also run code analysis manually by opening the **Analyze** menu and then choosing **Run Code Analysis on** *ProjectName* or **Run Code Analysis on File**. 1. Choose the [rule set](using-rule-sets-to-specify-the-cpp-rules-to-run.md) that you want to use or create a [custom rule set](using-rule-sets-to-specify-the-cpp-rules-to-run.md#to-create-a-rule-set-in-a-text-editor). If using LLVM/clang-cl, see [Using Clang-Tidy in Visual Studio](clang-tidy.md) to configure Clang-Tidy analysis options. @@ -92,7 +92,7 @@ To run code analysis on a file: 1. In the **Build** menu, choose **Run Code Analysis on File** or press **Ctrl+Shift+Alt+F7**. - The project or solution is compiled and code analysis runs. Results appear in the Error List window. +The project or solution is compiled and code analysis runs. Results appear in the **Error List** window. ## Analyze and resolve code analysis warnings diff --git a/docs/code-quality/toc.yml b/docs/code-quality/toc.yml index 61bafc57ca1..948d04dcb78 100644 --- a/docs/code-quality/toc.yml +++ b/docs/code-quality/toc.yml @@ -661,6 +661,8 @@ items: href: ../code-quality/c26863.md - name: Warning C26864 href: ../code-quality/c26864.md + - name: Warning C26865 + href: ../code-quality/c26865.md - name: Warning C28020 href: ../code-quality/c28020.md - name: Warning C28021 diff --git a/docs/code-quality/using-the-cpp-core-guidelines-checkers.md b/docs/code-quality/using-the-cpp-core-guidelines-checkers.md index fefa3144ce2..34cdcc545ff 100644 --- a/docs/code-quality/using-the-cpp-core-guidelines-checkers.md +++ b/docs/code-quality/using-the-cpp-core-guidelines-checkers.md @@ -8,7 +8,7 @@ dev_langs: --- # Use the C++ Core Guidelines checkers -The C++ Core Guidelines are a portable set of guidelines, rules, and best practices about coding in C++ created by C++ experts and designers. Visual Studio currently supports a subset of these rules as part of its code analysis tools for C++. The core guideline checkers are installed by default in Visual Studio 2017 and Visual Studio 2019. They're [available as a NuGet package for Visual Studio 2015](#vs2015_corecheck). +The C++ Core Guidelines are a portable set of guidelines, rules, and best practices about coding in C++ created by C++ experts and designers. Visual Studio currently supports a subset of these rules as part of its Microsoft C++ Code Analysis tools. The core guideline checkers are installed by default in Visual Studio 2017 and Visual Studio 2019. They're [available as a NuGet package for Visual Studio 2015](#vs2015_corecheck). ## The C++ Core Guidelines Project diff --git a/docs/cpp/abstract-classes-cpp.md b/docs/cpp/abstract-classes-cpp.md index dd7181e7171..af5343782dd 100644 --- a/docs/cpp/abstract-classes-cpp.md +++ b/docs/cpp/abstract-classes-cpp.md @@ -31,13 +31,15 @@ The only difference between this declaration and the previous one is that `Print Abstract classes can't be used for: -- Variables or member data +- Variables or member data (you can't declare a variable of an abstract class type) -- Argument types +- Argument types (you can't pass an abstract class by value as a function parameter) -- Function return types +- Function return types (a function can't return an abstract class by value) -- Types of explicit conversions +- Types of explicit conversions (you can't cast to an abstract class type) + +In each case, you can use pointers or references to the abstract class type instead. For example, a function can take `AbstractBase&` or `AbstractBase*` as a parameter, and you can declare pointers or references of the abstract class type. If the constructor for an abstract class calls a pure virtual function, either directly or indirectly, the result is undefined. However, constructors and destructors for abstract classes can call other member functions. diff --git a/docs/cpp/argument-passing-and-naming-conventions.md b/docs/cpp/argument-passing-and-naming-conventions.md index aea3e8d3a15..11dfa80a2e9 100644 --- a/docs/cpp/argument-passing-and-naming-conventions.md +++ b/docs/cpp/argument-passing-and-naming-conventions.md @@ -31,6 +31,7 @@ The following calling conventions are supported by the Visual C/C++ compiler. |[__fastcall](../cpp/fastcall.md)|Callee|Stored in registers, then pushed on stack| |[__thiscall](../cpp/thiscall.md)|Callee|Pushed on stack; **`this`** pointer stored in ECX| |[__vectorcall](../cpp/vectorcall.md)|Callee|Stored in registers, then pushed on stack in reverse order (right to left)| +|[__preserve_none](../cpp/preserve-none.md)|Callee|Stored in registers only| For related information, see [Obsolete Calling Conventions](../cpp/obsolete-calling-conventions.md). diff --git a/docs/cpp/attributes.md b/docs/cpp/attributes.md index 8ed976529a0..5e6cfc32fc0 100644 --- a/docs/cpp/attributes.md +++ b/docs/cpp/attributes.md @@ -1,9 +1,9 @@ --- title: "Attributes in C++" description: "Learn more about: Attributes in C++" -f1_keywords: ["deprecated", "noreturn", "carries_dependency", "fallthrough", "nodiscard", "maybe_unused", "likely", "unlikely", "gsl::suppress", "msvc::flatten", "msvc::forceinline", "msvc::forceinline_calls", "msvc::intrinsic", "msvc::noinline", "msvc::noinline_calls", "msvc::no_tls_guard"] -helpviewer_keywords: ["deprecated", "noreturn", "carries_dependency", "fallthrough", "nodiscard", "maybe_unused", "likely", "unlikely", "gsl::suppress", "msvc::flatten", "msvc::forceinline", "msvc::forceinline_calls", "msvc::intrinsic", "msvc::noinline", "msvc::noinline_calls", "msvc::no_tls_guard"] -ms.date: 4/13/2023 +f1_keywords: ["deprecated", "noreturn", "carries_dependency", "fallthrough", "nodiscard", "maybe_unused", "likely", "unlikely", "gsl::suppress", "msvc::disable", "msvc::enable", "msvc::flatten", "msvc::forceinline", "msvc::forceinline_calls", "msvc::intrinsic", "msvc::noinline", "msvc::noinline_calls", "msvc::no_tls_guard", "msvc::musttail"] +helpviewer_keywords: ["deprecated", "noreturn", "carries_dependency", "fallthrough", "nodiscard", "maybe_unused", "likely", "unlikely", "gsl::suppress", "msvc::disable", "msvc::enable", "msvc::flatten", "msvc::forceinline", "msvc::forceinline_calls", "msvc::intrinsic", "msvc::noinline", "msvc::noinline_calls", "msvc::no_tls_guard", "msvc::musttail"] +ms.date: 05/15/2026 --- # Attributes in C++ @@ -46,7 +46,7 @@ The `[[carries_dependency]]` attribute specifies that the function propagates da ### `[[likely]]` -**Visual Studio 2019 version 16.6 and later:** (Available with [`/std:c++20`](../build/reference/std-specify-language-standard-version.md) and later.) The `[[likely]]` attribute specifies a hint to the compiler that the code path for the attributed label or statement is more likely to execute than alternatives. In the Microsoft compiler, the `[[likely]]` attribute marks blocks as "hot code", which increments an internal optimization score. The score is incremented more when optimizing for speed, and not as much when optimizing for size. The net score affects the likelihood of inlining, loop unrolling, and vectorizing optimizations. The effect of `[[likely]]` and `[[unlikely]]` is similar to [Profile-guided optimization](../build/profile-guided-optimizations.md), but limited in scope to the current translation unit. The block reordering optimization isn't implemented yet for this attribute. +**Visual Studio 2019 version 16.6 and later:** (Available with [`/std:c++20`](../build/reference/std-specify-language-standard-version.md) and later.) The `[[likely]]` attribute specifies a hint to the compiler that the code path for the attributed label or statement is more likely to execute than alternatives. In the Microsoft compiler, the `[[likely]]` attribute marks blocks as "hot code," which increments an internal optimization score. The score is incremented more when optimizing for speed, and not as much when optimizing for size. The net score affects the likelihood of inlining, loop unrolling, and vectorizing optimizations. The effect of `[[likely]]` and `[[unlikely]]` is similar to [Profile-guided optimization](../build/profile-guided-optimizations.md), but limited in scope to the current translation unit. The block reordering optimization isn't implemented yet for this attribute. ### `[[maybe_unused]]` @@ -79,9 +79,11 @@ The `[[noreturn]]` attribute specifies that a function never returns; in other w ### `[[gsl::suppress( [, justification: ])]]` -`` is a string that specifies the name of the rule to suppress. The optional `justification` field allows you to explain why a warning is being disabled or suppressed. This value will appear in the SARIF output when the `/analyze:log:includesuppressed` option is specified. Its value is a UTF-8 encoded narrow string literal. The `[[gsl::suppress]]` attribute is available in Visual Studio 2022 version 17.14 and later versions. +This Microsoft-specific attribute, introduced in Visual Studio 2022 version 17.14, suppresses warnings from checkers that enforce [Guidelines Support Library (GSL)](https://github.com/Microsoft/GSL) rules. The attribute can be applied to a statement, a block, or a declaration. It's only available for C++. For C code, use [`#pragma warning(suppress)`](../preprocessor/warning.md) instead. -The Microsoft-specific `[[gsl::suppress]]` attribute is used to suppress warnings from checkers that enforce [Guidelines Support Library (GSL)](https://github.com/Microsoft/GSL) rules in code. For example, consider this code snippet: +`` is a string that specifies the name of the rule to suppress. The optional `justification` field allows you to explain why a warning is being disabled or suppressed. This value appears in the Static Analysis Results Interchange Format ([SARIF](https://sarif.info/)) output when the `/analyze:log:includesuppressed` option is specified. Its value is a UTF-8 encoded narrow string literal. To generate a SARIF file, use the `/analyze:log:format:sarif` compiler option. + +Example: ```cpp int main() @@ -96,19 +98,82 @@ int main() } ``` -The example raises these warnings: +This example raises these warnings: - [C26494](../code-quality/c26494.md) (Type Rule 5: Always initialize an object.) - - [C26485](../code-quality/c26485.md) (Bounds Rule 3: No array to pointer decay.) - - [C26481](../code-quality/c26481.md) (Bounds Rule 1: Don't use pointer arithmetic. Use span instead.) -The first two warnings fire when you compile this code with the CppCoreCheck code analysis tool installed and activated. But the third warning doesn't fire because of the attribute. You can suppress the entire bounds profile by writing `[[gsl::suppress("bounds")]]` without including a specific rule number. The C++ Core Guidelines are designed to help you write better and safer code. The suppress attribute makes it easy to turn off the warnings when they aren't wanted. +The first two warnings occur when you compile this code with the CppCoreCheck code analysis tool installed and activated. But the third warning doesn't fire because of the attribute. You can suppress the entire bounds profile by writing `[[gsl::suppress("bounds")]]` without including a specific rule number. The C++ Core Guidelines are designed to help you write better and safer code. The suppress attribute makes it easy to turn off the warnings when they aren't wanted. + +**Choosing between `#pragma warning` and `[[gsl::suppress]]`** + +Both `#pragma warning(suppress)` and `[[gsl::suppress]]` offer fine-grained control over warning suppression: +- `[[gsl::suppress]]` only suppresses warnings emitted by Microsoft C++ Code Analysis. Use it with the C++ Core Guidelines checks, which can be applied to a scope or a specific declaration. +- `#pragma warning(suppress)` can be used for any compiler warning. It’s useful when you need to suppress a warning in a specific code block without altering the code’s structure significantly. + +Whenever possible, use `[[gsl::suppress]]` for suppressing Microsoft C++ Code Analysis warnings. + +### `[[msvc::disable(feature:APX)]]` + +The `[[msvc::disable(feature:APX)]]` attribute, introduced in [MSVC Build Tools version 14.51](../overview/what-s-new-for-msvc.md#whats-new-for-msvc-build-tools-version-1451) (Visual Studio version 18.6.0), is an x64-only Microsoft-specific attribute that disables Intel Advanced Performance Extensions (APX) instruction generation for a specific function. When applied to a function declaration or definition, it prevents the compiler from emitting APX instructions in that function's body, even if APX is globally enabled via the `/feature:APX` compiler option. Other functions in the same translation unit continue to use APX instructions unless they are similarly attributed. If a function with `[[msvc::disable(feature:APX)]]` calls inlined functions, the inlined code is also compiled without APX instructions. + +#### Example + +```cpp +// The following shows how to disable APX instructions for specific functions, +// even when APX is enabled globally with /feature:APX +​int test(int argc) +{ + auto lambda = + [] + [[msvc::disable(feature:APX)]] + (int argc) + { + return argc + 42; + }; + return lambda(argc); +} + +[[msvc::disable(feature:APX)]] +int test2(int x) +{ + return x + 42; +} +``` + +### `[[msvc::enable(feature:APX)]]` + +The `[[msvc::enable(feature:APX)]]` attribute, introduced in [MSVC Build Tools version 14.51](../overview/what-s-new-for-msvc.md#whats-new-for-msvc-build-tools-version-1451) (Visual Studio version 18.6.0), is an x64-only Microsoft-specific attribute that enables Intel Advanced Performance Extensions (APX) instruction generation for a specific function. When applied to a function declaration or definition, it allows the compiler to emit APX instructions in that function's body, even when APX is not globally enabled. This provides per-function opt-in to APX features without requiring `/arch:APX` for the entire translation unit. If a function with `[[msvc::enable(feature:APX)]]` has calls that are inlined into it, the inlined code is also compiled with APX instructions. + +#### `[[msvc::enable(feature:APX)]]` example + +```cpp +// The following shows how to enable APX instructions for specific functions, +// even when APX isn't enabled globally with /feature:APX + +​int test(int argc) +{ + auto lambda = + [] + [[msvc::enable(feature:APX)]] + (int argc) + { + return argc + 42; + }; + return lambda(argc); +} + +[[msvc::enable(feature:APX), msvc::noinline]] +int test2(int x) +{ + return x + 42; +} +``` ### `[[msvc::flatten]]` -The Microsoft-specific attribute `[[msvc::flatten]]` is very similar to `[[msvc::forceinline_calls]]`, and can be used in the same places and in the same way. The difference is that `[[msvc::flatten]]` will `[[msvc::forceinline_calls]]` all calls in the scope it's applied to recursively, until no calls are left. This may have consequences for the resulting code size growth of the function or the throughput of the compiler, which you must manage manually. +The Microsoft-specific attribute `[[msvc::flatten]]` is similar to `[[msvc::forceinline_calls]]`, and can be used in the same places and in the same way. The difference is that `[[msvc::flatten]]` will `[[msvc::forceinline_calls]]` all calls in the scope it's applied to recursively, until no calls are left. This may have consequences for the resulting code size growth of the function or the throughput of the compiler, which you must manage manually. ### `[[msvc::forceinline]]` @@ -159,6 +224,56 @@ void f() { } ``` +### `[[msvc::musttail]]` + +The `[[msvc::musttail]]` attribute, introduced in [MSVC Build Tools version 14.50](../overview/what-s-new-for-msvc.md#whats-new-for-msvc-build-tools-version-1450), is an experimental x64-only Microsoft-specific attribute that enforces tail-call optimization. When applied to a qualifying return statement, it instructs the compiler to emit the call as a tail call. If the compiler can't emit the tail call, it produces a compilation error. The `[[msvc::musttail]]` attribute enforces a tail call instead of inlining the function. + +`[[msvc::musttail]]` requirements: +- The caller and callee must have matching return types. +- The calling conventions must be compatible. +- The tail call must be the final action in the calling function. +- The callee can't use more stack space than the calling function. +- If more than four integer parameters are passed, the calling function must allocate enough stack space for the other arguments. +- Compile with `/O2` or `/O2 /GL` optimization level. + +#### Example + +Tail calls are a compiler optimization that's possible when a function call is the last action performed before returning. Instead of creating a new stack frame to call the function, the current function's stack frame is reused. This reduces stack usage and improves performance—especially in recursive scenarios. + +In the following code, the `[[msvc::musttail]]` attribute applied to `return increment(x)` causes control to transfer directly to `increment`. When `increment` reaches the `return x+1;` statement, its result is provided directly to the caller of `incrementIfPositive`, that is `main`. This replaces inlining `increment` into `incrementIfPositive` or calling `increment` from `incrementIfPositive` and returning to `incrementIfPositive` before returning to `main`. The tail call optimization eliminates the need for `incrementIfPositive` to regain control after `increment` finishes. This is a performance optimization that reduces stack usage, especially useful in recursive scenarios. + +```cpp +// compile with /O2 +#include + +int increment(int x) +{ + return x + 1; +} + +int incrementIfPositive(int x) +{ + if (x > 0) + { + [[msvc::musttail]] + return increment(x); + } + return -1; +} + +int main() +{ + int result = incrementIfPositive(42); + if (result < 0) + { + return -1; + } + + std::cout << result; // outputs 43 + return 0; +} +``` + ### `[[msvc::noinline]]` When placed before a function declaration, the Microsoft-specific attribute `[[msvc::noinline]]` has the same meaning as `__declspec(noinline)`. diff --git a/docs/cpp/c-cpp-language-and-standard-libraries.md b/docs/cpp/c-cpp-language-and-standard-libraries.md index 59218ff5e3e..ee3ccbc4ab2 100644 --- a/docs/cpp/c-cpp-language-and-standard-libraries.md +++ b/docs/cpp/c-cpp-language-and-standard-libraries.md @@ -61,7 +61,7 @@ Classes that simplify the writing of programs that use data parallelism or task Reference for the Microsoft implementation of the OpenMP API. [Proxy library](https://github.com/microsoft/proxy)\ -A header-only C++20 library for using polymorphism in C++ without inheritance. For API reference information, see [Proxy 3 Specifications](https://microsoft.github.io/proxy/docs/specifications.html) +A header-only C++20 library for using polymorphism in C++ without inheritance. For API reference information, see [Proxy 4 Specifications](https://github.com/microsoft/proxy/tree/main/docs/spec#readme) [SafeInt library](../safeint/safeint-library.md)\ A portable library that can be used with MSVC, GCC, or Clang to help prevent integer overflows. diff --git a/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_1.cpp b/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_1.cpp index 3ca09b621c1..838fe5a5607 100644 --- a/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_1.cpp +++ b/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_1.cpp @@ -1,20 +1,43 @@ -unique_ptr SongFactory(const std::wstring& artist, const std::wstring& title) -{ - // Implicit move operation into the variable that stores the result. - return make_unique(artist, title); +// Compile with: cl /EHsc /std:c++17 + +#include +#include +#include + +struct Song { + std::string artist; + std::string title; + Song(const std::string& a, const std::string& t) : artist(a), title(t) { + std::cout << "Created: " << title << "\n"; + } + ~Song() { std::cout << "Destroyed: " << title << "\n"; } +}; + +// Returning a unique_ptr by value transfers ownership to the caller. +std::unique_ptr SongFactory(const std::string& artist, const std::string& title) { + return std::make_unique(artist, title); +} + +// Passing a unique_ptr by value transfers ownership to the function. +// The Song is automatically destroyed when the function exits. +void SingSong(std::unique_ptr song) { + std::cout << "Singing: " << song->title << " by " << song->artist << "\n"; } -void MakeSongs() -{ +int main() { // Create a new unique_ptr with a new object. - auto song = make_unique(L"Mr. Children", L"Namonaki Uta"); + auto song = std::make_unique("Mr. Children", "Namonaki Uta"); + std::cout << "song points to: " << song->title << "\n"; - // Use the unique_ptr. - vector titles = { song->title }; + // Move ownership from one unique_ptr to another. + std::unique_ptr song2 = std::move(song); + std::cout << "After move, song is " << (song ? "not null" : "null") << "\n"; + std::cout << "song2 points to: " << song2->title << "\n"; - // Move raw pointer from one unique_ptr to another. - unique_ptr song2 = std::move(song); + // Obtain unique_ptr from a factory function that returns by value. + auto song3 = SongFactory("Michael Jackson", "Beat It"); - // Obtain unique_ptr from function that returns by value. - auto song3 = SongFactory(L"Michael Jackson", L"Beat It"); + // Transfer ownership to a function. + SingSong(std::move(song3)); + std::cout << "After SingSong, song3 is " << (song3 ? "not null" : "null") << "\n"; } \ No newline at end of file diff --git a/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_2.cpp b/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_2.cpp index b1f6a067f95..862c0293cd8 100644 --- a/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_2.cpp +++ b/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_2.cpp @@ -1,17 +1,32 @@ -void SongVector() -{ - vector> songs; - - // Create a few new unique_ptr instances - // and add them to vector using implicit move semantics. - songs.push_back(make_unique(L"B'z", L"Juice")); - songs.push_back(make_unique(L"Namie Amuro", L"Funky Town")); - songs.push_back(make_unique(L"Kome Kome Club", L"Kimi ga Iru Dake de")); - songs.push_back(make_unique(L"Ayumi Hamasaki", L"Poker Face")); +// Compile with: cl /EHsc /std:c++17 - // Pass by const reference when possible to avoid copying. - for (const auto& song : songs) - { - wcout << L"Artist: " << song->artist << L" Title: " << song->title << endl; - } +#include +#include +#include +#include + +struct Song { + std::string artist; + std::string title; + Song(const std::string& a, const std::string& t) : artist(a), title(t) {} +}; + +int main() { + std::vector> songs; + + // Create unique_ptr instances and add them to the vector + // using implicit move semantics. + songs.push_back(std::make_unique("B'z", "Juice")); + songs.push_back(std::make_unique("Namie Amuro", "Funky Town")); + songs.push_back(std::make_unique("Kome Kome Club", "Kimi ga Iru Dake de")); + songs.push_back(std::make_unique("Ayumi Hamasaki", "Poker Face")); + + // Pass by const reference to avoid copying. + // Passing by value causes a compile error because + // the unique_ptr copy constructor is deleted. + for (const auto& song : songs) { + std::cout << "Artist: " << song->artist + << " Title: " << song->title << "\n"; + } + // The unique_ptr instances in the vector are automatically destroyed when the vector goes out of scope at the end of main() } \ No newline at end of file diff --git a/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_3.cpp b/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_3.cpp index 29baefa191f..35b67cc059c 100644 --- a/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_3.cpp +++ b/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_3.cpp @@ -1,17 +1,29 @@ -class MyClass -{ -private: - // MyClass owns the unique_ptr. - unique_ptr factory; +// Compile with: cl /EHsc /std:c++17 + +#include +#include + +class Engine { public: + Engine() { std::cout << "Engine created\n"; } + ~Engine() { std::cout << "Engine destroyed\n"; } + void Run() { std::cout << "Engine running\n"; } +}; - // Initialize by using make_unique with ClassFactory default constructor. - MyClass() : factory (make_unique()) - { - } +class Car { +private: + // Car owns the unique_ptr. + std::unique_ptr engine; +public: + // Initialize by using make_unique in the member initializer list. + Car() : engine(std::make_unique()) {} - void MakeClass() - { - factory->DoSomething(); + void Start() { + engine->Run(); } }; + +int main() { + Car car; + car.Start(); +} \ No newline at end of file diff --git a/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_4.cpp b/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_4.cpp index c7d62f9ca60..4637f942998 100644 --- a/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_4.cpp +++ b/docs/cpp/codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_4.cpp @@ -1,9 +1,17 @@ +// Compile with: cl /EHsc /std:c++17 + +#include +#include + +int main() { // Create a unique_ptr to an array of 5 integers. - auto p = make_unique(5); + // The elements are value-initialized to 0. + auto p = std::make_unique(5); - // Initialize the array. - for (int i = 0; i < 5; ++i) - { + // Assign values to the array elements. + for (int i = 0; i < 5; ++i) { p[i] = i; - wcout << p[i] << endl; - } \ No newline at end of file + std::cout << p[i] << "\n"; + } + // The array is automatically deleted when p goes out of scope. +} \ No newline at end of file diff --git a/docs/cpp/how-to-create-and-use-unique-ptr-instances.md b/docs/cpp/how-to-create-and-use-unique-ptr-instances.md index b679190aeee..f0c566944c2 100644 --- a/docs/cpp/how-to-create-and-use-unique-ptr-instances.md +++ b/docs/cpp/how-to-create-and-use-unique-ptr-instances.md @@ -2,25 +2,39 @@ description: "Learn more about: How to: Create and use unique_ptr instances" title: "How to: Create and use unique_ptr instances" ms.custom: "how-to" -ms.date: "11/19/2018" -ms.assetid: 9a373030-e587-452f-b9a5-c5f9d58b7673 +ms.date: 04/10/2026 +ai-usage: ai-assisted --- # How to: Create and use unique_ptr instances -A [unique_ptr](../standard-library/unique-ptr-class.md) does not share its pointer. It cannot be copied to another `unique_ptr`, passed by value to a function, or used in any C++ Standard Library algorithm that requires copies to be made. A `unique_ptr` can only be moved. This means that the ownership of the memory resource is transferred to another `unique_ptr` and the original `unique_ptr` no longer owns it. We recommend that you restrict an object to one owner, because multiple ownership adds complexity to the program logic. Therefore, when you need a smart pointer for a plain C++ object, use `unique_ptr`, and when you construct a `unique_ptr`, use the [make_unique](../standard-library/memory-functions.md#make_unique) helper function. +A [unique_ptr](../standard-library/unique-ptr-class.md) doesn't share its pointer. It can't be copied to another `unique_ptr`, passed by value to a function, or used in any C++ Standard Library algorithm that requires copies to be made. A `unique_ptr` can only be moved. This means that the ownership of the memory resource is transferred to another `unique_ptr` and the original `unique_ptr` no longer owns it. We recommend that you restrict an object to one owner, because multiple ownership adds complexity. When you need a smart pointer for a plain C++ object, use `unique_ptr`, and when you construct a `unique_ptr`, use the [`make_unique`](../standard-library/memory-functions.md#make_unique) helper function. The following diagram illustrates the transfer of ownership between two `unique_ptr` instances. ![Diagram that shows moving the ownership of a unique pointer.](media/unique_ptr.png) -`unique_ptr` is defined in the `` header in the C++ Standard Library. It is exactly as efficient as a raw pointer and can be used in C++ Standard Library containers. The addition of `unique_ptr` instances to C++ Standard Library containers is efficient because the move constructor of the `unique_ptr` eliminates the need for a copy operation. +`unique_ptr` is defined in the `` header in the C++ Standard Library. It's exactly as efficient as a raw pointer and can be used in C++ Standard Library containers. The addition of `unique_ptr` instances to C++ Standard Library containers is efficient because the move constructor of the `unique_ptr` eliminates the need for a copy operation. + +To use `unique_ptr` and `make_unique`, include the `` header. The following examples each compile and run as standalone programs. ## Example 1 -The following example shows how to create `unique_ptr` instances and pass them between functions. +The following example shows how to create `unique_ptr` instances and pass them between functions. Returning a `unique_ptr` by value transfers ownership to the caller. Passing a `unique_ptr` by value to a function transfers ownership to the callee. [!code-cpp[stl_smart_pointers#210](codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_1.cpp)] +```output +Created: Namonaki Uta +song points to: Namonaki Uta +After move, song is null +song2 points to: Namonaki Uta +Created: Beat It +Singing: Beat It by Michael Jackson +Destroyed: Beat It +After SingSong, song3 is null +Destroyed: Namonaki Uta +``` + These examples demonstrate this basic characteristic of `unique_ptr`: it can be moved, but not copied. "Moving" transfers ownership to a new `unique_ptr` and resets the old `unique_ptr`. ## Example 2 @@ -29,7 +43,18 @@ The following example shows how to create `unique_ptr` instances and use them in [!code-cpp[stl_smart_pointers#211](codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_2.cpp)] -In the range for loop, notice that the `unique_ptr` is passed by reference. If you try to pass by value here, the compiler will throw an error because the `unique_ptr` copy constructor is deleted. +```output +Artist: B'z Title: Juice +Artist: Namie Amuro Title: Funky Town +Artist: Kome Kome Club Title: Kimi ga Iru Dake de +Artist: Ayumi Hamasaki Title: Poker Face +Destroyed: Juice +Destroyed: Funky Town +Destroyed: Kimi ga Iru Dake de +Destroyed: Poker Face +``` + +In the range for loop, notice that the `unique_ptr` is passed by reference. If you try to pass by value here, the compiler reports an error because the `unique_ptr` copy constructor is deleted. ## Example 3 @@ -37,12 +62,26 @@ The following example shows how to initialize a `unique_ptr` that is a class mem [!code-cpp[stl_smart_pointers#212](codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_3.cpp)] +```output +Engine created +Engine running +Engine destroyed +``` + ## Example 4 -You can use [make_unique](../standard-library/memory-functions.md#make_unique) to create a `unique_ptr` to an array, but you cannot use `make_unique` to initialize the array elements. +You can use [make_unique](../standard-library/memory-functions.md#make_unique) to create a `unique_ptr` to an array. `make_unique(5)` creates a five element array that is value-initialized to zero. You can't pass individual element values to `make_unique`, so assign them after creation. [!code-cpp[stl_smart_pointers#213](codesnippet/CPP/how-to-create-and-use-unique-ptr-instances_4.cpp)] +```output +0 +1 +2 +3 +4 +``` + For more examples, see [make_unique](../standard-library/memory-functions.md#make_unique). ## See also diff --git a/docs/cpp/inline-functions-cpp.md b/docs/cpp/inline-functions-cpp.md index edfd41def2e..f67599ff01b 100644 --- a/docs/cpp/inline-functions-cpp.md +++ b/docs/cpp/inline-functions-cpp.md @@ -1,7 +1,7 @@ --- title: "Inline Functions (C++)" description: "The C++ inline keyword can be used to suggest inline functions to the compiler." -ms.date: 12/07/2023 +ms.date: 02/05/2026 f1_keywords: ["__forceinline_cpp", "__inline_cpp", "inline_cpp", "__inline", "_inline", "__forceinline", "_forceinline"] helpviewer_keywords: ["inline functions [C++], class members"] --- @@ -11,13 +11,47 @@ The **`inline`** keyword suggests that the compiler substitute the code within t In theory, using inline functions can make your program faster because they eliminate the overhead associated with function calls. Calling a function requires pushing the return address on the stack, pushing arguments onto the stack, jumping to the function body, and then executing a return instruction when the function finishes. This process is eliminated by inlining the function. The compiler also has different opportunities to optimize functions expanded inline versus those that aren't. A tradeoff of inline functions is that the overall size of your program can increase. -Inline code substitution is done at the compiler's discretion. For example, the compiler won't inline a function if its address is taken or if the compiler decides it's too large. +Inline code substitution is done at the compiler's discretion. For example, the compiler doesn't inline a function if its address is taken or if the compiler decides it's too large. -A function defined in the body of a class declaration is implicitly an inline function. +## The `inline` keyword and the One Definition Rule (ODR) -## Example +The original meaning of **`inline`** is a hint to the compiler to prefer code expansion at the call site over function call instructions. This remains one of the meanings of **`inline`**. -In the following class declaration, the `Account` constructor is an inline function because it is defined in the body of the class declaration. The member functions `GetBalance`, `Deposit`, and `Withdraw` are specified `inline` in their definitions. The `inline` keyword is optional in the function declarations in the class declaration. +However, the **`inline`** keyword also has implications for the One Definition Rule (ODR). Normally, a function can only be defined once across all translation units. When a function is marked **`inline`**, it can be defined in multiple translation units (typically via a header file) if all the definitions are identical. The linker then selects one definition and discards the duplicates rather than reporting an error. + +This dual nature of **`inline`**—as both an optimization hint and an ODR mechanism—can cause confusion. The ODR aspect is a practical necessity where the same header (containing an inline function definition) may be included in multiple source files. + +## Implicitly inline functions + +Certain functions are implicitly **`inline`** without requiring the keyword: + +- **Functions defined at class scope**: A function defined in the body of a class declaration is implicitly an inline function. This allows small accessor functions and to be defined directly in class definitions without incurring function call overhead—a priority since the early days of C++. + +- **`constexpr` functions**: Functions declared **`constexpr`** (introduced in C++11) are implicitly **`inline`**. Because **`constexpr`** functions are typically defined in header files to allow compile-time evaluation, they must follow the same ODR rules as inline functions. + +- **`consteval` functions**: Functions declared **`consteval`** (introduced in C++20) are implicitly **`inline`**. + +## Inline variables (C++17) + +C++17 extended the **`inline`** keyword to variables. An **`inline`** variable can be defined in multiple translation units, and like inline functions, the linker selects one definition and discards the rest. + +Inline variables are useful for defining constants or static data members in header files: + +```cpp +// constants.h +inline constexpr double pi = 3.14159265358979323846; + +struct MyClass +{ + static inline int instanceCount = 0; // Can be defined in header +}; +``` + +Before C++17, such variables required a separate definition in a single source file to avoid linker errors. + +## Example: Inline class member functions + +In the following class declaration, the `Account` constructor is an inline function because it's defined in the body of the class declaration. The member functions `GetBalance`, `Deposit`, and `Withdraw` are specified **`inline`** in their definitions. The **`inline`** keyword is optional in the function declarations in the class declaration. ```cpp // account.h @@ -60,7 +94,7 @@ inline double Account::Withdraw(double amount) A given inline member function must be declared the same way in every compilation unit. There must be exactly one definition of an inline function. -A class member function defaults to external linkage unless a definition for that function contains the **`inline`** specifier. The preceding example shows that you don't have to declare these functions explicitly with the **`inline`** specifier. Using **`inline`** in the function definition suggests to the compiler that it be treated as an inline function. However, you can't redeclare a function as **`inline`** after a call to that function. +A class member function defaults to external linkage unless a definition for that function contains the **`inline`** specifier. The preceding example shows that you don't have to declare these functions explicitly with the **`inline`** specifier. Using **`inline`** in the function definition suggests to the compiler to treat it as an inline function. However, you can't redeclare a function as **`inline`** after a call to that function. ## `inline`, `__inline`, and `__forceinline` @@ -68,11 +102,11 @@ The **`inline`** and **`__inline`** specifiers suggest to the compiler that it i The insertion, called *inline expansion* or *inlining*, occurs only if the compiler's own cost-benefit analysis shows it's worthwhile. Inline expansion minimizes the function-call overhead at the potential cost of larger code size. -The **`__forceinline`** keyword overrides the cost-benefit analysis and relies on the judgment of the programmer instead. Exercise caution when using **`__forceinline`**. Indiscriminate use of **`__forceinline`** can result in larger code with only marginal performance gains or, in some cases, even performance losses (because of the increased paging of a larger executable, for example). +The **`__forceinline`** keyword (or [`[msvc::forceinline]`](/cpp/cpp/attributes#msvcforceinline) attribute) overrides the cost-benefit analysis and relies on the judgment of the programmer instead. Exercise caution when using **`__forceinline`**. Indiscriminate use of **`__forceinline`** can result in larger code with only marginal performance gains or, in some cases, even performance losses (because of the increased paging of a larger executable, for example). The compiler treats the inline expansion options and keywords as suggestions. There's no guarantee that functions will be inlined. You can't force the compiler to inline a particular function, even with the **`__forceinline`** keyword. When you compile with **`/clr`**, the compiler won't inline a function if there are security attributes applied to the function. -For compatibility with previous versions, **`_inline`** and **`_forceinline`** are synonyms for **`__inline`** and **`__forceinline`**, respectively, unless compiler option [`/Za` \(Disable language extensions)](../build/reference/za-ze-disable-language-extensions.md) is specified. +For compatibility with previous versions, **`_inline`** and **`_forceinline`** are synonyms for **`__inline`** and **`__forceinline`** (two leading underscores), respectively, unless compiler option [`/Za` \(Disable language extensions)](../build/reference/za-ze-disable-language-extensions.md) is specified. The **`inline`** keyword tells the compiler that inline expansion is preferred. However, the compiler can ignore it. Two cases where this behavior can happen are: @@ -140,6 +174,18 @@ If the compiler can't inline a function declared with **`__forceinline`**, it ge Recursive functions can be replaced with inline code to a depth specified by the [`inline_depth`](../preprocessor/inline-depth.md) pragma, up to a maximum of 16 calls. After that depth, recursive function calls are treated as calls to an instance of the function. The depth to which recursive functions are examined by the inline heuristic can't exceed 16. The [`inline_recursion`](../preprocessor/inline-recursion.md) pragma controls the inline expansion of a function currently under expansion. See the [Inline-Function Expansion](../build/reference/ob-inline-function-expansion.md) (/Ob) compiler option for related information. +The C++ Standard defines a common set of attributes. It also allows compiler vendors to define their own attributes within a vendor-specific (in our case, `msvc`) namespace. The following Microsoft-specific attributes can be used to control inlining behavior: + +## Microsoft-specific attributes for controlling inlining behavior + +|Attribute | Meaning | +|---------|---------| +| [`[msvc::forceinline]`](/cpp/cpp/attributes#msvcforceinline)| Has the same meaning as **`__forceinline`**.| +| [`[msvc::forceinline_calls]`](/cpp/cpp/attributes#msvcforceinline_calls) | Can be placed on or before a statement or block to cause the inline heuristic to force-inline all calls in that statement or block.| +| [`[msvc::flatten]`](/cpp/cpp/attributes#msvcflatten) | Similar to `[[msvc::forceinline_calls]]`, but recursively force-inlines all calls in the scope it's applied to until no calls are left. | +| [`[msvc::noinline]`](/cpp/cpp/attributes#msvcnoinline) | When placed before a function declaration, has the same meaning as `__declspec(noinline)`. | +| [`[msvc::noinline_calls]`](/cpp/cpp/attributes#msvcnoinline_calls) | Can be placed before any statement or block to turn off inlining for all calls in the scope it's applied to. | + **END Microsoft Specific** For more information on using the **`inline`** specifier, see: @@ -228,8 +274,8 @@ int main() Here are some of the differences between the macro and the inline function: -- Macros are always expanded inline. However, an inline function is only inlined when the compiler determines it is the optimal thing to do. -- The macro may result in unexpected behavior, which can lead to subtle bugs. For example, the expression `mult1(2 + 2, 3 + 3)` expands to `2 + 2 * 3 + 3` which evaluates to 11, but the expected result is 24. A seemingly valid fix is to add parentheses around both arguments of the function macro, resulting in `#define mult2(a, b) (a) * (b)`, which will solve the issue at hand but can still cause surprising behavior when part of a larger expression. That was demonstrated in the preceding example, and the problem could be addressed by defining the macro as such `#define mult3(a, b) ((a) * (b))`. +- Macros are always expanded inline. However, an inline function is only inlined when the compiler determines it's the optimal thing to do. +- The macro may result in unexpected behavior, which can lead to subtle bugs. For example, the expression `mult1(2 + 2, 3 + 3)` expands to `2 + 2 * 3 + 3` which evaluates to 11, but the expected result is 24. A seemingly valid fix is to add parentheses around both arguments of the function macro, resulting in `#define mult2(a, b) (a) * (b)`, which solves the issue at hand but can still cause surprising behavior when part of a larger expression. That was demonstrated in the preceding example, and the problem could be addressed by defining the macro as such `#define mult3(a, b) ((a) * (b))`. - An inline function is subject to semantic processing by the compiler, whereas the preprocessor expands macros without that same benefit. Macros aren't type-safe, whereas functions are. - Expressions passed as arguments to inline functions are evaluated once. In some cases, expressions passed as arguments to macros can be evaluated more than once. For example, consider the following: @@ -272,4 +318,9 @@ In this example, the function `increment` is called twice as the expression `sqr ## See also [`noinline`](../cpp/noinline.md)\ -[`auto_inline`](../preprocessor/auto-inline.md) +[`auto_inline`](../preprocessor/auto-inline.md)\ +[`[msvc::forceinline]`](/cpp/cpp/attributes#msvcforceinline)\ +[`[msvc::forceinline_calls]`](/cpp/cpp/attributes#msvcforceinline_calls)\ +[`[msvc::flatten]`](/cpp/cpp/attributes#msvcflatten)\ +[`[msvc::nolinline]`](/cpp/cpp/attributes#msvcnoinline)\ +[`[msvc::nolinline_calls]`](/cpp/cpp/attributes#msvcnoinline_calls) \ No newline at end of file diff --git a/docs/cpp/keywords-cpp.md b/docs/cpp/keywords-cpp.md index 0bb5fff6c04..8d9269c07fb 100644 --- a/docs/cpp/keywords-cpp.md +++ b/docs/cpp/keywords-cpp.md @@ -115,9 +115,9 @@ Keywords are predefined reserved identifiers that have special meanings. They ca :::column-end::: :::row-end::: -a The Microsoft-specific **`__asm`** keyword replaces C++ **`asm`** syntax. **`asm`** is reserved for compatibility with other C++ implementations, but not implemented. Use **`__asm`** for inline assembly on x86 targets. Microsoft C++ doesn't support Inline assembly for other targets. +a The Microsoft-specific **`__asm`** keyword replaces C++ **`asm`** syntax. **`asm`** is reserved for compatibility with other C++ implementations, but not implemented. Use **`__asm`** for inline assembly on x86 targets. Microsoft C++ doesn't support inline assembly for other targets. -b The extended operator synonyms are keywords when [`/permissive-`](../build/reference/permissive-standards-conformance.md) or [`/Za` \(Disable language extensions)](../build/reference/za-ze-disable-language-extensions.md) is specified. They aren't keywords when Microsoft extensions are enabled. +b The extended operator synonyms are keywords when [`/permissive-`](../build/reference/permissive-standards-conformance.md) or [`/Za` (Disable language extensions)](../build/reference/za-ze-disable-language-extensions.md) is specified. They aren't keywords when Microsoft extensions are enabled. c Supported when [`/std:c++20`](../build/reference/std-specify-language-standard-version.md) or later (such as **`/std:c++latest`**) is specified. @@ -125,7 +125,7 @@ Keywords are predefined reserved identifiers that have special meanings. They ca In C++, identifiers that contain two consecutive underscores are reserved for compiler implementations. The Microsoft convention is to precede Microsoft-specific keywords with double underscores. These words can't be used as identifier names. -Microsoft extensions are enabled by default. To ensure that your programs are fully portable, you can disable Microsoft extensions by specifying the [`/permissive-`](../build/reference/permissive-standards-conformance.md) or [`/Za` \(Disable language extensions)](../build/reference/za-ze-disable-language-extensions.md) option during compilation. These options disable some Microsoft-specific keywords. +Microsoft extensions are enabled by default. To ensure that your programs are fully portable, you can disable Microsoft extensions by specifying the [`/permissive-`](../build/reference/permissive-standards-conformance.md) or [`/Za` (Disable language extensions)](../build/reference/za-ze-disable-language-extensions.md) option during compilation. These options disable some Microsoft-specific keywords. When Microsoft extensions are enabled, you can use the Microsoft-specific keywords in your programs. For ANSI conformance, these keywords are prefaced by a double underscore. For backward compatibility, single-underscore versions of many of the double-underscored keywords are supported. The **`__cdecl`** keyword is available with no leading underscore. @@ -166,11 +166,11 @@ The **`__based`** keyword has limited uses for 32-bit and 64-bit target compilat [`__m64`](m64.md)\ [`__multiple_inheritance`](inheritance-keywords.md) e\ [`__ptr32`](ptr32-ptr64.md) e\ - [`__ptr64`](ptr32-ptr64.md)e\ + [`__ptr64`](ptr32-ptr64.md) e\ [`__raise`](raise.md)\ [`__restrict`](extension-restrict.md) e\ - [`__single_inheritance`](inheritance-keywords.md)e\ - [`__sptr`](sptr-uptr.md)e\ + [`__single_inheritance`](inheritance-keywords.md) e\ + [`__sptr`](sptr-uptr.md) e\ [`__stdcall`](stdcall.md) e :::column-end::: :::column::: @@ -191,7 +191,7 @@ The **`__based`** keyword has limited uses for 32-bit and 64-bit target compilat e For backward compatibility with previous versions, these keywords are available both with two leading underscores and a single leading underscore when Microsoft extensions are enabled (the default). -## Microsoft keywords in __declspec modifiers +## Microsoft keywords in `__declspec` modifiers These identifiers are extended attributes for the **`__declspec`** modifier. They're considered keywords within that context. diff --git a/docs/cpp/preserve-none.md b/docs/cpp/preserve-none.md new file mode 100644 index 00000000000..ba7d97cf3b4 --- /dev/null +++ b/docs/cpp/preserve-none.md @@ -0,0 +1,74 @@ +--- +description: "Learn more about: __preserve_none" +title: "__preserve_none" +ms.date: 02/11/2026 +f1_keywords: ["__preserve_none", "register spilling", "non preserving calling convention"] +helpviewer_keywords: ["__preserve_none keyword"] +--- +# __preserve_none + +**Microsoft Specific** + +> [!IMPORTANT] +> The **`__preserve_none`** calling convention is experimental and subject to change. + +The **`__preserve_none`** calling convention specifies that arguments to functions are to be passed in registers, with most general-purpose registers treated as volatile. This calling convention is only supported for C programs and only applies to x64 code. + +This calling convention is designed to minimize register spilling and improve performance. + +The following list shows the behavior of this calling convention. + +| Element | Behavior | +|---------|----------------| +| Argument-passing order | Arguments are passed in up to 10 registers in the following order: `r13`, `r14`, `r15`, `rbx`, `rsi`, `rdi`, `r9`, `r8`, `rdx`, `rcx`. If a hidden parameter is required for struct returns, it's passed in `r13` (the first parameter register), reducing available parameter registers to 9. Registers `r10`-`r12` are reserved for various CRT and Windows runtimes. All parameters must be passed through registers; stack-based parameters aren't currently supported. | +| Register allocation strategy | To help minimize register spilling when calling functions with different calling conventions, the allocator assigns `rcx`, `rdx`, `r8`, and `r9` only after other registers have been used, since those registers are used first by the [__vectorcall](vectorcall.md) and [__cdecl](cdecl.md) calling conventions. | +| Argument limit | Functions are restricted to a maximum of 10 parameters. An error is generated if this limit is exceeded. | +| Return value convention | Follows the regular x64 calling convention rules. Scalar return values are returned in `rax`. Structs of size 1, 2, 4, or 8 bytes are returned through the `rax` register. For structs of other sizes, a pointer to memory allocated by the caller and passed through the hidden parameter is returned in `rax`. | +| Volatile registers | All general-purpose registers except `r12`, `rsp` (stack pointer) and `rbp` (base pointer) are treated as volatile and don't need to be preserved across function calls. While `r10` and `r11` are volatile, they aren't used for parameter passing to maintain compatibility with existing programs. | +| Nonvolatile registers | Only `rsp`, `rbp`, and `r12` are nonvolatile. | +| Stack alignment | The stack must maintain 16-byte alignment. | +| Frame pointer | The `rbp` register and frame chain follow the [/Gy switch](../build/reference/gy-enable-function-level-linking.md) settings. | +| Stack-maintenance responsibility | The callee is responsible for cleaning up its own stack space. | +| Shadow space | 32 bytes are reserved on the stack as a shadow space to maintain compatibility with profilers and debugging tools. *(Shadow space is a reserved area on the stack where register parameters can be spilled if needed. It's typically 32 bytes (4 registers × 8 bytes each) that the caller reserves for the first four register parameters.)* | +| Floating-point support | Floating-point parameters aren't supported. | +| Name-decoration convention | Function names are decorated with @@_A suffix. | +| Case-translation convention | No case translation performed. | + +## Restrictions and Limitations + +The **`__preserve_none`** calling convention has the following restrictions: + +- **C only**: Only supported for C programs. +- **x64 only**: Only supported on x64. +- **No floating-point**: Floating-point parameters aren't supported. +- **No variadic functions**: Variadic functions (varargs) aren't supported. +- **Parameter limit**: Maximum of 10 parameters, all passed through registers. + +## Use Cases + +The **`__preserve_none`** calling convention is designed for performance-critical scenarios where: + +- Most functions in the codebase use the **`__preserve_none`** calling convention +- Used with `msvc::musttail` to tail call between functions with no stack usage +- Minimizing register spilling is important for performance +- The codebase is compatible with treating most registers as volatile + +## Example + +In the following example, the function `ProcessData` uses the **`__preserve_none`** calling convention: + +```c +// Example of the __preserve_none keyword +void __preserve_none ProcessData(int a, int b, int c, int d, int e); + +// Example of the __preserve_none keyword on function pointer +typedef int (__preserve_none *callback_ptr)(void* context, int value, int flags); +``` + +**END Microsoft Specific** + +## See also + +[Argument Passing and Naming Conventions](argument-passing-and-naming-conventions.md)\ +[x64 Calling Convention](../build/x64-calling-convention.md)\ +[Keywords](keywords-cpp.md) diff --git a/docs/cpp/ptr32-ptr64.md b/docs/cpp/ptr32-ptr64.md index 08fc2cedc23..a41c67307da 100644 --- a/docs/cpp/ptr32-ptr64.md +++ b/docs/cpp/ptr32-ptr64.md @@ -1,16 +1,17 @@ --- description: "Learn more about: __ptr32, __ptr64" title: "__ptr32, __ptr64" -ms.date: "10/09/2018" +ms.date: 12/16/2025 f1_keywords: ["__ptr32_cpp", "__ptr64_cpp", "__ptr32", "__ptr64", "_ptr32", "_ptr64"] helpviewer_keywords: ["__ptr64 keyword [C++]", "_ptr32 keyword [C++]", "ptr32 keyword [C++]", "ptr64 keyword [C++]", "_ptr64 keyword [C++]", "__ptr32 keyword [C++]"] -ms.assetid: afb563d8-7458-4fe7-9c30-bd4b5385a59f --- # __ptr32, __ptr64 -**Microsoft Specific** +**Microsoft specific** -**`__ptr32`** represents a native pointer on a 32-bit system, while **`__ptr64`** represents a native pointer on a 64-bit system. +Use **`__ptr32`** to represent a native pointer on a 32-bit system. Use **`__ptr64`** to represent a native pointer on a 64-bit system. + +The `__ptr32` and `__ptr64` modifiers are Microsoft-specific extensions for interop scenarios. For standard 32-bit (x86) or standard x64 code, use native pointers, instead. The following example shows how to declare each of these pointer types: @@ -19,17 +20,22 @@ int * __ptr32 p32; int * __ptr64 p64; ``` -On a 32-bit system, a pointer declared with **`__ptr64`** is truncated to a 32-bit pointer. On a 64-bit system, a pointer declared with **`__ptr32`** is coerced to a 64-bit pointer. +On a 32-bit system, a pointer declared with **`__ptr64`** is treated as a 32-bit pointer and truncates the upper 32 bits of any 64-bit address assigned to it. On a 64-bit system, a pointer declared with **`__ptr32`** is treated as a 32-bit pointer and truncates the upper 32 bits of any 64-bit address assigned to it. This truncation can lead to an invalid pointer if the 64-bit address is above 4GB. > [!NOTE] -> You cannot use **`__ptr32`** or **`__ptr64`** when compiling with **/clr:pure**. Otherwise, Compiler Error C2472 will be generated. The **/clr:pure** and **/clr:safe** compiler options are deprecated in Visual Studio 2015 and unsupported in Visual Studio 2017. +> You can't use **`__ptr32`** or **`__ptr64`** when compiling with **`/clr:pure`**. Otherwise, the compiler generates error C2472. The **/clr:pure** and **/clr:safe** compiler options are deprecated in Microsoft Visual Studio 2015 and unsupported in Microsoft Visual Studio 2017. -For compatibility with previous versions, **_ptr32** and **_ptr64** are synonyms for **`__ptr32`** and **`__ptr64`** unless compiler option [/Za \(Disable language extensions)](../build/reference/za-ze-disable-language-extensions.md) is specified. +For compatibility with previous versions, **`_ptr32`** and **`_ptr64`** are synonyms for **`__ptr32`** and **`__ptr64`** unless you specify compiler option [/Za \(Disable language extensions)](../build/reference/za-ze-disable-language-extensions.md). ## Example The following example shows how to declare and allocate pointers with the **`__ptr32`** and **`__ptr64`** keywords. +This code works on x86 but might crash on x64. + +- It works when compiled for 32-bit because **`__ptr64`** pointers are treated as 32-bit pointers on x86. On x86 (32-bit), `malloc` returns a 32-bit address which fits in `p64`. +- It might crash when compiled for 64-bit because on x64, `malloc` returns a 64-bit pointer which is truncated to 32 bits by this line: `p32 = (int* __ptr32)malloc(4);`. Truncating a 64-bit address to a 32-bit address could result in an invalid pointer if the allocation happened above 4GB. In that case, `*p32 = 32` could attempt to access a truncated address that isn't part of your process's address space, causing an access violation. Even if it works once, it could fail later if the memory allocator returns a higher address. + ```cpp #include #include @@ -38,22 +44,22 @@ int main() { using namespace std; - int * __ptr32 p32; - int * __ptr64 p64; + int* __ptr32 p32; + int* __ptr64 p64; - p32 = (int * __ptr32)malloc(4); - *p32 = 32; + p64 = (int* __ptr64)malloc(4); + *p64 = 64; // Works on x86 and x64 + cout << *p64 << endl; + + p32 = (int* __ptr32)malloc(4); + *p32 = 32; // Works on x86. Possible exception on x64 cout << *p32 << endl; - - p64 = (int * __ptr64)malloc(4); - *p64 = 64; - cout << *p64 << endl; } ``` ```Output -32 64 +32 ``` **END Microsoft Specific** diff --git a/docs/cpp/raw-pointers.md b/docs/cpp/raw-pointers.md index c12c7051c64..3c4d07c50e6 100644 --- a/docs/cpp/raw-pointers.md +++ b/docs/cpp/raw-pointers.md @@ -19,7 +19,7 @@ A pointer can also be *dereferenced* to retrieve the value of the object that it int j = *p; // dereference p to retrieve the value at its address ``` -A pointer can point to a typed object or to **`void`**. When a program allocates an object on the [heap](https://wikipedia.org/wiki/Heap) in memory, it receives the address of that object in the form of a pointer. Such pointers are called *owning pointers*. An owning pointer (or a copy of it) must be used to explicitly free the heap-allocated object when it's no longer needed. Failure to free the memory results in a *memory leak*, and renders that memory location unavailable to any other program on the machine. Memory allocated using **`new`** must be freed by using **`delete`** (or **`delete[]`**). For more information, see [`new` and `delete` operators](new-and-delete-operators.md). +A pointer can point to a typed object or to **`void`**. When a program allocates an object on the [heap](https://wikipedia.org/wiki/Heap) in memory, it receives the address of that object in the form of a pointer. Such pointers are called *owning pointers*. An owning pointer (or a copy of it) must be used to explicitly free the heap-allocated object when it's no longer needed. Failure to free the memory results in a *memory leak*, and renders that memory location unavailable to any other program on the machine. Memory allocated with **`new`** must be freed using **`delete`**, and memory allocated with **`new[]`** must be freed using **`delete[]`**. For more information, see [`new` and `delete` operators](new-and-delete-operators.md). ```cpp MyClass* mc = new MyClass(); // allocate object on the heap @@ -78,7 +78,7 @@ void func_B(MyClass mc) // This statement modifies only the local copy of mc. mc.num = 21; std::cout << "Local copy of mc:"; - mc.print(); // "Erika, 21" + mc.print(); // "Erika:21" } int main() @@ -99,28 +99,28 @@ int main() MyClass* pcopy = &mc; // Use the -> operator to access the object's public members - pmc->print(); // "Nick, 108" + pmc->print(); // "Nick:108" // Copy the pointer. Now pmc and pmc2 point to same object! MyClass* pmc2 = pmc; // Use copied pointer to modify the original object pmc2->name = "Erika"; - pmc->print(); // "Erika, 108" - pmc2->print(); // "Erika, 108" + pmc->print(); // "Erika:108" + pmc2->print(); // "Erika:108" // Pass the pointer to a function. func_A(pmc); - pmc->print(); // "Erika, 3" - pmc2->print(); // "Erika, 3" + pmc->print(); // "Erika:3" + pmc2->print(); // "Erika:3" // Dereference the pointer and pass a copy // of the pointed-to object to a function func_B(*pmc); - pmc->print(); // "Erika, 3" (original not modified by function) + pmc->print(); // "Erika:3" (original not modified by function) - delete(pmc); // don't forget to give memory back to operating system! - // delete(pmc2); //crash! memory location was already deleted + delete pmc; // don't forget to give memory back to operating system! + // delete pmc2; //crash! memory location was already deleted } ``` @@ -156,7 +156,11 @@ int main() } ``` -Certain arithmetic operations can be used on non-`const` pointers to make them point to another memory location. Pointers are incremented and decremented using the **`++`**, **`+=`**, **`-=`** and **`--`** operators. This technique can be used in arrays and is especially useful in buffers of untyped data. A `void*` gets incremented by the size of a **`char`** (1 byte). A typed pointer gets incremented by size of the type it points to. +```Output +1 2 3 4 5 +``` + +Certain arithmetic operations can be used on non-`const` pointers to make them point to another memory location. Pointers are incremented and decremented using the **`++`**, **`+=`**, **`-=`** and **`--`** operators. This technique can be used in arrays and is especially useful in buffers of untyped data. A typed pointer gets incremented by size of the type it points to. The following example demonstrates how pointer arithmetic can be used to access individual pixels in a bitmap on Windows. Note the use of **`new`** and **`delete`**, and the dereference operator. @@ -264,7 +268,7 @@ int main() void* p = static_cast(mc); MyClass* mc2 = static_cast(p); std::cout << mc2->name << std::endl; // "Marian" - delete(mc); + delete mc; // use operator new to allocate untyped memory block void* pvoid = operator new(1000); @@ -332,6 +336,11 @@ int main() } ``` +```Output +hello world from MSVC +Good morning and hello world from MSVC +``` + ## See also [Smart pointers](smart-pointers-modern-cpp.md)\ diff --git a/docs/cpp/rvalue-reference-declarator-amp-amp.md b/docs/cpp/rvalue-reference-declarator-amp-amp.md index c9dd311f112..441521e11c2 100644 --- a/docs/cpp/rvalue-reference-declarator-amp-amp.md +++ b/docs/cpp/rvalue-reference-declarator-amp-amp.md @@ -1,10 +1,9 @@ --- -description: "Learn more about: Rvalue reference declarator: &&" title: "Rvalue reference declarator: &&" +description: "Learn more about: Rvalue reference declarator: &&" ms.date: 09/27/2022 f1_keywords: ["&&"] helpviewer_keywords: ["&& rvalue reference declarator"] -ms.assetid: eab0ce3a-c5a3-4992-aa70-6a8ab1f7491d --- # Rvalue reference declarator: `&&` @@ -223,7 +222,7 @@ int main() This example produces the following output: -```cpp +```Output In g(const MemoryBlock&). In g(MemoryBlock&&). ``` @@ -266,7 +265,7 @@ int main() This example produces the following output: -```cpp +```Output In g(const MemoryBlock&). In g(MemoryBlock&&). ``` @@ -360,7 +359,7 @@ int main() This example produces the following output: -```cpp +```Output print: first print: second print: third diff --git a/docs/cpp/scope-visual-cpp.md b/docs/cpp/scope-visual-cpp.md index 6a735944423..3e160bde303 100644 --- a/docs/cpp/scope-visual-cpp.md +++ b/docs/cpp/scope-visual-cpp.md @@ -1,9 +1,8 @@ --- -description: "Learn more about: Scope (C++)" title: "Scope (C++)" -ms.date: "11/19/2018" +description: "Learn more about: Scope (C++)" +ms.date: 11/19/2018 helpviewer_keywords: ["classes [C++], scope", "scope [C++]", "function prototypes [C++], scope", "class scope", "prototype scope", "functions [C++], scope", "scope, C++ names"] -ms.assetid: 81fecbb0-338b-4325-8332-49f33e716352 --- # Scope (C++) @@ -34,7 +33,7 @@ Block scope and name hiding The output from the program shown in the figure is: -```cpp +```Output i = 0 i = 7 j = 9 diff --git a/docs/cpp/toc.yml b/docs/cpp/toc.yml index 1c9d0872d8e..1f17ade4e51 100644 --- a/docs/cpp/toc.yml +++ b/docs/cpp/toc.yml @@ -644,6 +644,8 @@ items: href: ../cpp/thiscall.md - name: __vectorcall href: ../cpp/vectorcall.md + - name: __preserve_none + href: ../cpp/preserve-none.md - name: "Calling example: Function prototype and call" items: - name: "Calling example: Function prototype and call" diff --git a/docs/cpp/tutorial-import-stl-named-module.md b/docs/cpp/tutorial-import-stl-named-module.md index b2c961353f2..717ad7e3d43 100644 --- a/docs/cpp/tutorial-import-stl-named-module.md +++ b/docs/cpp/tutorial-import-stl-named-module.md @@ -1,11 +1,11 @@ --- title: "Tutorial: Import the standard library (STL) using modules from the command line (C++)" +description: "Learn how to import the C++ standard library (STL) using modules from the command line." ms.date: 01/29/2024 ms.topic: "tutorial" author: "tylermsft" ms.author: "twhitney" -helpviewer_keywords: ["modules [C++]", "modules [C++]", "named modules [C++], import standard library (STL) using named modules"] -description: Learn how to import the C++ standard library (STL) using modules from the command line +helpviewer_keywords: ["modules [C++]", "named modules [C++], import standard library (STL) using named modules"] --- # Tutorial: Import the C++ standard library using modules from the command line @@ -26,7 +26,7 @@ This tutorial requires Visual Studio 2022 17.5 or later. Header file semantics can change depending on macro definitions, the order in which you include them, and they slow compilation. Modules solve these problems. -It's now possible to import the standard library as a module instead of as a tangle of header files. This is much faster and more robust than including header files or header units or precompiled headers (PCH). +It's now possible to import the standard library as a module instead of as a tangle of header files. This is much faster and more robust than including header files, header units, or precompiled headers (PCH). The C++23 standard library introduces two named modules: `std` and `std.compat`: @@ -49,7 +49,7 @@ This article demonstrates the new and best way to consume the standard library. ## Import the standard library with `std` -The following examples demonstrate how to consume the standard library as a module using the command line compiler. For information about how to do this in the Visual Studio IDE, see [Build ISO C++23 Standard Library Modules](..\build\reference\c-cpp-prop-page.md#build-iso-c23-standard-library-modules). +The following examples demonstrate how to consume the standard library as a module using the command line compiler. For information about how to do this in the Visual Studio IDE, see [Build ISO C++23 Standard Library Modules](../build/reference/c-cpp-prop-page.md#build-iso-c23-standard-library-modules). The statement `import std;` or `import std.compat;` imports the standard library into your application. But first, you must compile the standard library named modules into binary form. The following steps demonstrate how. @@ -75,9 +75,9 @@ The statement `import std;` or `import std.compat;` imports the standard library | Switch | Meaning | |---|---| - | [`/std:c++:latest`](../build/reference/std-specify-language-standard-version.md) | Use the latest version of the C++ language standard and library. Although module support is available under `/std:c++20`, you need the latest standard library to get support for standard library named modules. | + | [`/std:c++latest`](../build/reference/std-specify-language-standard-version.md) | Use the latest version of the C++ language standard and library. Although module support is available under `/std:c++20`, you need the latest standard library to get support for standard library named modules. | | [`/EHsc`](../build/reference/eh-exception-handling-model.md) | Use C++ exception handling, except for functions marked `extern "C"`. | - | [`/W4`](../build/reference//compiler-option-warning-level.md) | Using /W4 is generally recommended, especially for new projects because it enables all level 1, level 2, level 3, and most level 4 (informational) warnings, which can help you catch potential issues early. It essentially provides lint-like warnings that can help ensure the fewest possible hard-to-find code defects. | + | [`/W4`](../build/reference/compiler-option-warning-level.md) | Using `/W4` is generally recommended, especially for new projects because it enables all level 1, level 2, level 3, and most level 4 (informational) warnings, which can help you catch potential issues early. It essentially provides lint-like warnings that can help ensure the fewest possible hard-to-find code defects. | | [`/c`](../build/reference/c-compile-without-linking.md) | Compile without linking, because we're just building the binary named module interface at this point. | You can control the object file name and the named module interface file name with the following switches: @@ -159,7 +159,7 @@ Before you can use `import std.compat;` you must compile the module interface fi - `std.compat.obj` contains implementation. However, most of the implementation is provided by `std.obj`. Add `std.obj` to the command line when you compile the sample app to statically link the functionality that you use from the standard library into your application. You can control the object file name and the named module interface file name with the following switches: - - [`/Fo`](../build/reference/fo-object-file-name.md) sets the name of the object file. For example, `/Fo:"somethingelse"`. By default, the compiler uses the same name for the object file as the module source file (`.ixx`) you're compiling. In the example, the object file names are `std.obj` and `std.compat.obj` by default because we're compiling the module files `std.ixx` and `std.compat.obj`. + - [`/Fo`](../build/reference/fo-object-file-name.md) sets the name of the object file. For example, `/Fo:"somethingelse"`. By default, the compiler uses the same name for the object file as the module source file (`.ixx`) you're compiling. In the example, the object file names are `std.obj` and `std.compat.obj` by default because we're compiling the module files `std.ixx` and `std.compat.ixx`. - [`/ifcOutput`](../build/reference/ifc-output.md) sets the name of the named module interface file (`.ifc`). For example, `/ifcOutput "somethingelse.ifc"`. By default, the compiler uses the same name for the module interface file (`.ifc`) as the module source file (`.ixx`) you're compiling. In the example, the generated `ifc` files are `std.ifc` and `std.compat.ifc` by default because we're compiling the module files `std.ixx` and `std.compat.ixx`. 1. Import the `std.compat` library by first creating a file named `stdCompatExample.cpp` with the following content: @@ -210,7 +210,7 @@ Before you can use `import std.compat;` you must compile the module interface fi ## Standard library named module considerations -Versioning for named modules is the same as for headers. The `.ixx` named module files are installed alongside the headers, for example: `"%VCToolsInstallDir%\modules\std.ixx`, which resolves to `C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.38.33130\modules\std.ixx` in the version of the tools used at the time of this writing. Select the version of the named module the same way you choose the version of the header file to use--by the directory you refer to them from. +Versioning for named modules is the same as for headers. The `.ixx` named module files are installed alongside the headers, for example: `"%VCToolsInstallDir%\modules\std.ixx"`, which resolves to `C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.38.33130\modules\std.ixx` in the version of the tools used at the time of this writing. Select the version of the named module the same way you choose the version of the header file to use--by the directory you refer to them from. Don't mix and match importing header units and named modules. For example, don't `import ;` and `import std;` in the same file. @@ -222,7 +222,7 @@ If you need to use the `assert()` macro, then `#include `. If you need to use the `errno` macro, `#include `. Because named modules don't expose macros, this is the workaround if you need to check for errors from ``, for example. -Macros such as `NAN`, `INFINITY`, and `INT_MIN` are defined by ``, which you can include. However, if you `import std;` you can use `numeric_limits::quiet_NaN()` and `numeric_limits::infinity()` instead of `NAN` and `INFINITY`, and `std::numeric_limits::min()` instead of `INT_MIN`. +Macros such as `NAN`, `INFINITY`, and `INT_MIN` are defined by ``, which you can include. However, if you `import std;` you can use `std::numeric_limits::quiet_NaN()` and `std::numeric_limits::infinity()` instead of `NAN` and `INFINITY`, and `std::numeric_limits::min()` instead of `INT_MIN`. ## Summary diff --git a/docs/cpp/unary-plus-and-negation-operators-plus-and.md b/docs/cpp/unary-plus-and-negation-operators-plus-and.md index be1f3402345..16c5a8ce9d8 100644 --- a/docs/cpp/unary-plus-and-negation-operators-plus-and.md +++ b/docs/cpp/unary-plus-and-negation-operators-plus-and.md @@ -27,12 +27,8 @@ The unary negation operator (**`-`**) produces the negative of its operand. The Integral promotion is performed on integral operands, and the resultant type is the type to which the operand is promoted. See [Standard Conversions](standard-conversions.md) for more information about how the promotion is performed. -**Microsoft Specific** - Unary negation of unsigned quantities is performed by subtracting the value of the operand from 2^n, where n is the number of bits in an object of the given unsigned type. -**END Microsoft Specific** - ## See also [Expressions with Unary Operators](../cpp/expressions-with-unary-operators.md)\ diff --git a/docs/cppcx/namespaces-and-type-visibility-c-cx.md b/docs/cppcx/namespaces-and-type-visibility-c-cx.md index 83ed1947d70..c225de9e734 100644 --- a/docs/cppcx/namespaces-and-type-visibility-c-cx.md +++ b/docs/cppcx/namespaces-and-type-visibility-c-cx.md @@ -1,21 +1,20 @@ --- -description: "Learn more about: Namespaces and Type Visibility (C++/CX )" -title: "Namespaces and Type Visibility (C++/CX )" -ms.date: "12/30/2016" -ms.assetid: cbc01a3a-3b69-4ded-9c42-ecbf0fd0a00e +title: "Namespaces and Type Visibility (C++/CX)" +description: "Learn more about: Namespaces and Type Visibility (C++/CX)" +ms.date: 12/30/2016 --- -# Namespaces and Type Visibility (C++/CX ) +# Namespaces and Type Visibility (C++/CX) A namespace is a standard C++ construct for grouping types that have related functionality and for preventing name collisions in libraries. The Windows Runtime type system requires that all public Windows Runtime types, including those in your own code, must be declared in a namespace at namespace scope. Public types that are declared at global scope or nested inside another class will cause a compile-time error. -A .winmd file must have the same name that the root namespace has. For example, a class that's named A.B.C.MyClass can be instantiated only if it's defined in a metadata file that's named A.winmd or A.B.winmd or A.B.C.winmd. The name of the executable is not required to match the .winmd file name. +A `.winmd` file must have the same name that the root namespace has. For example, a class that's named `A.B.C.MyClass` can be instantiated only if it's defined in a metadata file that's named `A.winmd` or `A.B.winmd` or `A.B.C.winmd`. The name of the executable is not required to match the `.winmd` file name. ## Type visibility In a namespace, Windows Runtime types—unlike standard C++ types—have either private or public accessibility. By default, the accessibility is private. Only a public type is visible to metadata and is therefore consumable from apps and components that might be written in languages other than C++. In general, the rules for visible types are more restrictive than the rules for non-visible types because visible types cannot expose C++-specific concepts that are not supported in .NET languages or JavaScript. > [!NOTE] -> Metadata is only consumed at run time by .NET languages and JavaScript. When a C++ app or component is talking to another C++ app or component—this includes Windows components ,which are all written in C++—then no run-time consumption of metadata is required. +> Metadata is only consumed at run time by .NET languages and JavaScript. When a C++ app or component is talking to another C++ app or component—this includes Windows components, which are all written in C++—then no run-time consumption of metadata is required. ## Member accessibility and visibility @@ -34,7 +33,7 @@ Use the following access modifiers to control both metadata visibility and sourc ## Windows Runtime namespaces -The Windows API consists of types that are declared in the Windows::\* namespaces. These namespaces are reserved for Windows, and types cannot be added to them. In the **Object Browser**, you can view these namespaces in the windows.winmd file. For documentation about these namespaces, see [Windows API](/uwp/api/). +The Windows API consists of types that are declared in the `Windows::*` namespaces. These namespaces are reserved for Windows, and types cannot be added to them. In the **Object Browser**, you can view these namespaces in the `windows.winmd` file. For documentation about these namespaces, see [Windows API](/uwp/api/). ## C++/CX namespaces @@ -44,9 +43,9 @@ The C++/CX define certain types in these namespaces as part of the projection of |--|--| | default | Contains the built-in numeric and char16 types. These types are in scope in every namespace and a **`using`** statement is never required. | | `Platform` | Contains primarily public types that correspond to Windows Runtime types such as `Array`, `String`, `Guid`, and `Boolean`. Also includes specialized helper types such as `Platform::Agile` and `Platform::Box`. | -| `Platform::Collections` | Contains the concrete collection classes that implement the Windows Runtime collection interfaces `IVector`, `IMap`, and so on. These types are defined in a header file, collection.h, not in platform.winmd. | +| `Platform::Collections` | Contains the concrete collection classes that implement the Windows Runtime collection interfaces `IVector`, `IMap`, and so on. These types are defined in a header file, `collection.h`, not in `platform.winmd`. | | `Platform::Details` | Contains types that are used by the compiler and are not meant for public consumption. | ## See also -[Type System (C++/CX)](../cppcx/type-system-c-cx.md) +[Type System (C++/CX)](type-system-c-cx.md) diff --git a/docs/cppcx/toc.yml b/docs/cppcx/toc.yml index edc76e601e7..12708f934f9 100644 --- a/docs/cppcx/toc.yml +++ b/docs/cppcx/toc.yml @@ -13,7 +13,7 @@ items: items: - name: Type system overview href: ../cppcx/type-system-c-cx.md - - name: Namespaces and type visibility (C++/CX ) + - name: Namespaces and type visibility (C++/CX) href: ../cppcx/namespaces-and-type-visibility-c-cx.md - name: Fundamental types href: ../cppcx/fundamental-types-c-cx.md diff --git a/docs/cross-platform/build-an-opengl-es-application-on-android-and-ios.md b/docs/cross-platform/build-an-opengl-es-application-on-android-and-ios.md index 319b56d17d1..8f2c0764404 100644 --- a/docs/cross-platform/build-an-opengl-es-application-on-android-and-ios.md +++ b/docs/cross-platform/build-an-opengl-es-application-on-android-and-ios.md @@ -8,13 +8,14 @@ ms.custom: sfi-image-nochange # Build an OpenGL ES application on Android and iOS +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. +> OpenGL support is no longer available. It was last available in Visual Studio 17.3. + You can create Visual Studio solutions and projects for iOS apps and Android apps that share common code. This article guides you through a combined solution template. It creates both an iOS app, and an Android Native Activity app. The apps have C++ code in common that uses OpenGL ES to display the same animated rotating cube on each platform. OpenGL ES (OpenGL for Embedded Systems or GLES) is a 2D and 3D graphics API. It's supported on many mobile devices. ## Requirements -> [!IMPORTANT] -> OpenGL support is no longer available. It was last available in Visual Studio 17.3. - Here are the system requirements to create an OpenGL ES app for iOS and Android. If you haven't already, install the Mobile Development with C++ workload in the Visual Studio Installer. To get the OpenGL ES templates, and to build for iOS, include the optional C++ iOS development tools. To build for Android, install the C++ Android development tools and the required third-party tools: Android NDK, Apache Ant, and Google Android Emulator. For better emulator performance on Intel platforms, one option is to install the Intel Hardware Accelerated Execution Manager (HAXM). For detailed instructions, see [Install cross-platform mobile development with C++](../cross-platform/install-visual-cpp-for-cross-platform-mobile-development.md). diff --git a/docs/cross-platform/create-an-android-native-activity-app.md b/docs/cross-platform/create-an-android-native-activity-app.md index d8741577f0b..095a2a7735a 100644 --- a/docs/cross-platform/create-an-android-native-activity-app.md +++ b/docs/cross-platform/create-an-android-native-activity-app.md @@ -2,11 +2,13 @@ description: "Learn more about: Create an Android Native Activity App" title: "Create an Android Native Activity App" ms.date: "10/17/2019" -ms.assetid: 884014b1-5208-45ec-b0da-ad0070d2c24d ms.topic: how-to --- # Create an Android Native Activity App +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + When you install the cross-platform **Mobile development with C++** workload, Visual Studio can be used to create fully functional Android Native Activity apps. The Android Native Development Kit (NDK) is a toolset that allows you to implement the majority of your Android app using pure C/C++ code. Some Java JNI code acts as glue to allow your C/C++ code to interact with Android. The Android NDK introduced the ability to create Native Activity apps with Android API Level 9. Native Activity code is popular for creating gaming and graphic intensive apps that use Unreal Engine or OpenGL. This topic will guide you through creation of a simple Native Activity app that uses OpenGL. Additional topics walk through the developer lifecycle of editing, building, debugging and deploying Native Activity code. ## Requirements diff --git a/docs/cross-platform/cross-platform-mobile-development-examples.md b/docs/cross-platform/cross-platform-mobile-development-examples.md index 7eb5ea368ab..4a53fea00e5 100644 --- a/docs/cross-platform/cross-platform-mobile-development-examples.md +++ b/docs/cross-platform/cross-platform-mobile-development-examples.md @@ -5,6 +5,9 @@ ms.date: 03/04/2024 --- # Cross-platform mobile development examples +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + Several of the templates installed by the **Mobile development with C++** workload generate complete examples that you can use to learn from. Additionally, here are some example applications that you can download and try out in Visual Studio. - [hello-jni Android Application Sample](https://github.com/android/ndk-samples/tree/master/hello-jni) diff --git a/docs/cross-platform/general-android-prop-page.md b/docs/cross-platform/general-android-prop-page.md index 3bbadb70d3a..df6f9dd5a42 100644 --- a/docs/cross-platform/general-android-prop-page.md +++ b/docs/cross-platform/general-android-prop-page.md @@ -2,7 +2,6 @@ description: "Learn more about: General Project Properties (Android C++)" title: "General Project Properties (Android C++)" ms.date: "10/23/2017" -ms.assetid: 65f4868b-b864-4989-a275-1e51869ef599 f1_keywords: - VC.Project.VCConfiguration.Android.OutputDirectory - VC.Project.VCConfiguration.Android.IntermediateDirectory @@ -17,6 +16,9 @@ f1_keywords: --- # General Project Properties (Android C++) +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + | Property | Description | Choices | |--|--|--| | Output Directory | Specifies a relative path to the output file directory; can include environment variables. | diff --git a/docs/cross-platform/import-an-xcode-project.md b/docs/cross-platform/import-an-xcode-project.md index b4bff9ac579..1ea0c5c2e8b 100644 --- a/docs/cross-platform/import-an-xcode-project.md +++ b/docs/cross-platform/import-an-xcode-project.md @@ -2,11 +2,13 @@ description: "Learn more about: Import an Xcode project" title: "Import an Xcode project" ms.date: "10/17/2019" -ms.assetid: aa4b8161-d98f-4a1a-9db3-520133bfc82f ms.topic: how-to --- # Import an Xcode project +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + The Visual Studio tools for cross-platform mobile development with C++ include support for moving your Xcode projects into Visual Studio, where you can create cross-platform libraries and share code with other projects. The Import from Xcode wizard simplifies the process of importing projects and splitting out the C++ code in your Xcode targets for use as a static library or shared code project. You can manage your iOS-specific code in Visual Studio and still use Xcode to do storyboards and builds. For information on how to easily move code back and forth between Visual Studio and Xcode, see [Sync changes between Xcode and Visual Studio](sync-changes-between-xcode-and-visual-studio.md). ## Use the Import From Xcode wizard diff --git a/docs/cross-platform/install-and-configure-tools-to-build-using-ios.md b/docs/cross-platform/install-and-configure-tools-to-build-using-ios.md index 4e7f878b3a2..b0adf51b595 100644 --- a/docs/cross-platform/install-and-configure-tools-to-build-using-ios.md +++ b/docs/cross-platform/install-and-configure-tools-to-build-using-ios.md @@ -2,7 +2,6 @@ description: "Learn more about: Install and configure tools to build using iOS" title: "Install and configure tools to build using iOS" ms.date: 12/18/2022 -ms.assetid: d0c311c9-9eb9-42c5-ba07-25604362cd28 ms.topic: install-set-up-deploy ms.custom: - intro-installation @@ -10,6 +9,9 @@ ms.custom: --- # Install and configure tools to build using iOS +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + You can use Visual Studio with the cross-platform **Mobile development with C++** tools to edit, debug, and deploy iOS code to the iOS Simulator or to an iOS device. But, because of licensing restrictions, the code must be built and run remotely on a Mac. To build and run iOS apps using Visual Studio, you need to set up and configure the remote agent, [vcremote](https://www.npmjs.com/package/vcremote), on your Mac. The vcremote remote agent handles build requests from Visual Studio and runs the app on an iOS device connected to the Mac, or in the iOS Simulator on the Mac. > [!NOTE] diff --git a/docs/cross-platform/install-visual-cpp-for-cross-platform-mobile-development.md b/docs/cross-platform/install-visual-cpp-for-cross-platform-mobile-development.md index 08239a91208..abd451551b8 100644 --- a/docs/cross-platform/install-visual-cpp-for-cross-platform-mobile-development.md +++ b/docs/cross-platform/install-visual-cpp-for-cross-platform-mobile-development.md @@ -7,6 +7,9 @@ ms.topic: install-set-up-deploy --- # Install cross-platform mobile development with C++ +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + You can use C++ in Visual Studio to build Windows Desktop apps, Universal Windows Platform (UWP) apps, and Linux apps. And now, you can build C++ apps for Android and iOS. The **Mobile development with C++** workload is an installable set of components in Visual Studio. It includes cross-platform iOS, Android, and UWP Visual Studio templates. The workload installs the cross-platform tools and SDKs you need to get started quickly. You don't have to locate, download, and configure them yourself. You can use these tools in Visual Studio to easily create, edit, debug, and test your cross-platform projects. This article describes how to install the tools and third-party software required to develop cross-platform apps in C++ using Visual Studio. For an overview, see [Visual C++ cross-platform mobile](https://visualstudio.microsoft.com/vs/features/cplusplus-mdd/) diff --git a/docs/cross-platform/sync-changes-between-xcode-and-visual-studio.md b/docs/cross-platform/sync-changes-between-xcode-and-visual-studio.md index 834a4af4463..415ec583ea6 100644 --- a/docs/cross-platform/sync-changes-between-xcode-and-visual-studio.md +++ b/docs/cross-platform/sync-changes-between-xcode-and-visual-studio.md @@ -2,10 +2,12 @@ description: "Learn more about: Sync changes between Xcode and Visual Studio" title: "Sync changes between Xcode and Visual Studio" ms.date: "10/17/2019" -ms.assetid: c71a4d7c-120e-4559-a114-3a99c4b860a9 --- # Sync changes between Xcode and Visual Studio +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + The mobile development with C++ components in Visual Studio include remote capabilities for syncing your work between your PC and your Mac. When your Visual Studio and Mac machines are paired, new options are available for iOS Application projects in Visual Studio that you can use to open your project in Xcode, move your code between Xcode and Visual Studio, and clean the temporary Xcode project directory. To use the Remote Machine options, your project must be an iOS Application project, and Visual Studio must be paired with your Mac. For prerequisites and instructions on how to pair a Mac, see [Install and configure tools to build using iOS](../cross-platform/install-and-configure-tools-to-build-using-ios.md). diff --git a/docs/cross-platform/visual-cpp-for-cross-platform-mobile-development.md b/docs/cross-platform/visual-cpp-for-cross-platform-mobile-development.md index 561a0d7c2d8..997d8893371 100644 --- a/docs/cross-platform/visual-cpp-for-cross-platform-mobile-development.md +++ b/docs/cross-platform/visual-cpp-for-cross-platform-mobile-development.md @@ -1,11 +1,13 @@ --- description: "Learn more about: Cross-platform mobile development with C++" title: "Cross-platform mobile development with C++" -ms.date: "11/14/2019" -ms.assetid: 0bb872d6-981b-4c96-9143-fcec5336bf0d +ms.date: 11/07/2025 --- # Cross-platform mobile development with C++ +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + You can build native C++ apps for iOS, Android, and Windows devices by using the cross-platform tools available in Visual Studio. **Mobile development with C++** is a workload available in the Visual Studio installer. It installs the SDKs and tools you need for cross-platform development of shared libraries and native apps. When it's installed, you can use C++ to create code that runs on iOS and Android devices and platforms, Windows, Windows Store, and Xbox. Writing code for multiple platforms is often frustrating. The primary development languages and tools for iOS, Android, and Windows are different on each platform. However, all platforms support writing code in C++. It's the common denominator that can enable reuse of core code across platforms. Native code written in C++ can be both more performant and resistant to reverse engineering. Code reuse can save both time and effort when creating apps for multiple platforms. diff --git a/docs/data/data-access-in-cpp.md b/docs/data/data-access-in-cpp.md index 30bf4163522..f9f8add32c0 100644 --- a/docs/data/data-access-in-cpp.md +++ b/docs/data/data-access-in-cpp.md @@ -20,15 +20,15 @@ Describes legacy data access programming with Visual C++, where the preferred wa The Microsoft Foundation Classes (MFC) library supplies classes for programming with Open Database Connectivity (ODBC). [OLE DB Programming](oledb/ole-db-programming.md)
-A mostly legacy interface which is still required in some scenarios, specifically when you are programming against linked servers. +A mostly legacy interface which is still required in some scenarios, specifically when you're programming against linked servers. ## Related Topics [Connect to SQL Database using C and C++](/azure/sql-database/sql-database-develop-cplusplus-simple)
Connect to Azure SQL Database from C or C++ applications. -[Microsoft Azure Storage Client Library for C++](https://github.com/Azure/azure-storage-cpp)
-[Azure Storage](/azure/storage/common/storage-introduction) is a cloud storage solution for modern applications that rely on durability, availability, and scalability to meet the needs of their customers. Connect to Azure Storage from C++ by using the Azure Storage Client Library for C++. +[Azure SDK for C++](/azure/developer/cpp/sdk/overview)
+[Azure Storage](/azure/storage/common/storage-introduction) is a cloud storage solution for modern applications that rely on durability, availability, and scalability to meet the needs of their customers. Connect to Azure Storage from C++ by using the Azure SDK for C++. [ODBC Driver for SQL Server](/sql/connect/odbc/microsoft-odbc-driver-for-sql-server)
The latest ODBC driver provides robust data access to Microsoft SQL Server and Microsoft Azure SQL Database for C/C++ based applications. Provides support for features including always encrypted, Azure Active Directory, and AlwaysOn Availability Groups. Also available for macOS and Linux. diff --git a/docs/data/data-access-programming-mfc-atl.md b/docs/data/data-access-programming-mfc-atl.md index c2dda6ed1d6..f98e765142a 100644 --- a/docs/data/data-access-programming-mfc-atl.md +++ b/docs/data/data-access-programming-mfc-atl.md @@ -3,10 +3,12 @@ description: "Learn more about: Data Access Programming (MFC/ATL)" title: "Data Access Programming (MFC-ATL)" ms.date: "11/16/2018" helpviewer_keywords: ["MFC [C++], data access applications", "databases [C++], MFC", "OLE DB [C++], data access technologies", "data [C++], data access technologies", "data access [C++], class libraries for databases"] -ms.assetid: def97b2c-b5a6-445f-afeb-308050fd4852 --- # Data Access Programming (MFC/ATL) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) and Active Template Library (ATL) libraries continue to be supported. However, we're no longer adding features or updating the documentation. + Over the years, Visual C++ has provided several ways to work with databases. In 2011 Microsoft announced that it is aligning on Open Database Connectivity (ODBC) as the preferred technology for accessing SQL Server products from native code. ODBC is an industry standard, and by using it you gain maximum portability of your code over multiple platforms and data sources. Most SQL database products and many NoSQL products support ODBC. You can use ODBC directly by calling the low-level ODBC APIs, or you can use the MFC ODBC wrapper classes, or a third-party C++ wrapper library. OLE DB is a low-level, high-performance API based on the COM specification, and is only supported on Windows. Use OLE DB if your program is accessing [linked servers](/sql/relational-databases/linked-servers/linked-servers-database-engine). ATL provides OLE DB templates that make it easier to create custom OLE DB providers and consumers. The most recent provider for Microsoft SQL Server can be found in the documentation for the [OLE DB Driver for SQL Server](/sql/connect/oledb/oledb-driver-for-sql-server). diff --git a/docs/data/odbc/recordset-fetching-records-in-bulk-odbc.md b/docs/data/odbc/recordset-fetching-records-in-bulk-odbc.md index bea45e7ed94..83ad1f4bc73 100644 --- a/docs/data/odbc/recordset-fetching-records-in-bulk-odbc.md +++ b/docs/data/odbc/recordset-fetching-records-in-bulk-odbc.md @@ -1,9 +1,8 @@ --- -description: "Learn more about: Recordset: Fetching Records in Bulk (ODBC)" title: "Recordset: Fetching Records in Bulk (ODBC)" -ms.date: "11/04/2016" +description: "Learn more about: Recordset: Fetching Records in Bulk (ODBC)" +ms.date: 11/04/2016 helpviewer_keywords: ["bulk row fetching, implementing", "ODBC recordsets, bulk row fetching", "bulk record field exchange", "bulk row fetching", "bulk RFX functions", "recordsets, bulk row fetching", "DoBulkFieldExchange method", "fetching ODBC records in bulk", "RFX (ODBC), bulk", "rowsets, bulk row fetching", "RFX (ODBC), bulk row fetching"] -ms.assetid: 20d10fe9-c58a-414a-b675-cdf9aa283e4f --- # Recordset: Fetching Records in Bulk (ODBC) @@ -74,7 +73,7 @@ public: . . . -} +}; ``` You can either allocate these storage buffers manually or have the framework do the allocation. To allocate the buffers yourself, you must specify the `CRecordset::userAllocMultiRowBuffers` option of the *dwOptions* parameter in the `Open` member function. Be sure to set the sizes of the arrays at least equal to the rowset size. If you want to have the framework do the allocation, you should initialize your pointers to NULL. This is typically done in the recordset object's constructor: diff --git a/docs/data/oledb/dynamically-determining-columns-returned-to-the-consumer.md b/docs/data/oledb/dynamically-determining-columns-returned-to-the-consumer.md index 9ae135a598a..14175fae5ef 100644 --- a/docs/data/oledb/dynamically-determining-columns-returned-to-the-consumer.md +++ b/docs/data/oledb/dynamically-determining-columns-returned-to-the-consumer.md @@ -1,15 +1,14 @@ --- -description: "Learn more about: Dynamically Determining Columns Returned to the Consumer" title: "Dynamically Determining Columns Returned to the Consumer" -ms.date: "10/26/2018" +description: "Learn more about: Dynamically Determining Columns Returned to the Consumer" +ms.date: 10/26/2018 helpviewer_keywords: ["bookmarks [C++], dynamically determining columns", "dynamically determining columns [C++]"] -ms.assetid: 58522b7a-894e-4b7d-a605-f80e900a7f5f --- # Dynamically Determining Columns Returned to the Consumer -The PROVIDER_COLUMN_ENTRY macros normally handle the `IColumnsInfo::GetColumnsInfo` call. However, because a consumer might choose to use bookmarks, the provider must be able to change the columns returned depending on whether the consumer asks for a bookmark. +The `PROVIDER_COLUMN_ENTRY` macros normally handle the `IColumnsInfo::GetColumnsInfo` call. However, because a consumer might choose to use bookmarks, the provider must be able to change the columns returned depending on whether the consumer asks for a bookmark. -To handle the `IColumnsInfo::GetColumnsInfo` call, delete the PROVIDER_COLUMN_MAP, which defines a function `GetColumnInfo`, from the `CCustomWindowsFile` user record in *Custom*RS.h and replace it with the definition for your own `GetColumnInfo` function: +To handle the `IColumnsInfo::GetColumnsInfo` call, delete the `PROVIDER_COLUMN_MAP`, which defines a function `GetColumnInfo`, from the `CCustomWindowsFile` user record in *Custom*RS.h and replace it with the definition for your own `GetColumnInfo` function: ```cpp //////////////////////////////////////////////////////////////////////// @@ -23,7 +22,7 @@ public: TCHAR szText[iSize]; TCHAR szCommand2[iSize]; TCHAR szText2[iSize]; - + static ATLCOLUMNINFO* GetColumnInfo(void* pThis, ULONG* pcCols); bool operator==(const CCustomWindowsFile& am) { @@ -36,7 +35,7 @@ Next, implement the `GetColumnInfo` function in *Custom*RS.cpp, as shown in the `GetColumnInfo` checks first to see if the OLE DB property `DBPROP_BOOKMARKS` is set. To get the property, `GetColumnInfo` uses a pointer (`pRowset`) to the rowset object. The `pThis` pointer represents the class that created the rowset, which is the class where the property map is stored. `GetColumnInfo` typecasts the `pThis` pointer to an `RCustomRowset` pointer. -To check for the `DBPROP_BOOKMARKS` property, `GetColumnInfo` uses the `IRowsetInfo` interface, which you can get by calling `QueryInterface` on the `pRowset` interface. As an alternative, you can use an ATL [CComQIPtr](../../atl/reference/ccomqiptr-class.md) method instead. +To check for the `DBPROP_BOOKMARKS` property, `GetColumnInfo` uses the `IRowsetInfo` interface, which you can get by calling `QueryInterface` on the `pRowset` interface. As an alternative, you can use an ATL [`CComQIPtr`](../../atl/reference/ccomqiptr-class.md) method instead. ```cpp //////////////////////////////////////////////////////////////////// @@ -45,27 +44,27 @@ ATLCOLUMNINFO* CCustomWindowsFile::GetColumnInfo(void* pThis, ULONG* pcCols) { static ATLCOLUMNINFO _rgColumns[5]; ULONG ulCols = 0; - + // Check the property flag for bookmarks; if it is set, set the zero // ordinal entry in the column map with the bookmark information. CCustomRowset* pRowset = (CCustomRowset*) pThis; CComQIPtr spRowsetProps = pRowset; - + CDBPropIDSet set(DBPROPSET_ROWSET); set.AddPropertyID(DBPROP_BOOKMARKS); DBPROPSET* pPropSet = NULL; ULONG ulPropSet = 0; HRESULT hr; - + if (spRowsetProps) hr = spRowsetProps->GetProperties(1, &set, &ulPropSet, &pPropSet); - + if (pPropSet) { CComVariant var = pPropSet->rgProperties[0].vValue; CoTaskMemFree(pPropSet->rgProperties); CoTaskMemFree(pPropSet); - + if (SUCCEEDED(hr) && (var.boolVal == VARIANT_TRUE)) { ADD_COLUMN_ENTRY_EX(ulCols, OLESTR("Bookmark"), 0, sizeof(DWORD), @@ -74,7 +73,7 @@ ATLCOLUMNINFO* CCustomWindowsFile::GetColumnInfo(void* pThis, ULONG* pcCols) ulCols++; } } - + // Next, set the other columns up. ADD_COLUMN_ENTRY(ulCols, OLESTR("Command"), 1, 256, DBTYPE_STR, 0xFF, 0xFF, GUID_NULL, CCustomWindowsFile, szCommand) @@ -82,50 +81,50 @@ ATLCOLUMNINFO* CCustomWindowsFile::GetColumnInfo(void* pThis, ULONG* pcCols) ADD_COLUMN_ENTRY(ulCols, OLESTR("Text"), 2, 256, DBTYPE_STR, 0xFF, 0xFF, GUID_NULL, CCustomWindowsFile, szText) ulCols++; - + ADD_COLUMN_ENTRY(ulCols, OLESTR("Command2"), 3, 256, DBTYPE_STR, 0xFF, 0xFF, GUID_NULL, CCustomWindowsFile, szCommand2) ulCols++; ADD_COLUMN_ENTRY(ulCols, OLESTR("Text2"), 4, 256, DBTYPE_STR, 0xFF, 0xFF, GUID_NULL, CCustomWindowsFile, szText2) ulCols++; - + if (pcCols != NULL) *pcCols = ulCols; - + return _rgColumns; } ``` -This example uses a static array to hold the column information. If the consumer doesn't want the bookmark column, one entry in the array is unused. To handle the information, you create two array macros: ADD_COLUMN_ENTRY and ADD_COLUMN_ENTRY_EX. ADD_COLUMN_ENTRY_EX takes an extra parameter, *flags*, that is needed if you designate a bookmark column. +This example uses a static array to hold the column information. If the consumer doesn't want the bookmark column, one entry in the array is unused. To handle the information, you create two array macros: `ADD_COLUMN_ENTRY` and `ADD_COLUMN_ENTRY_EX`. `ADD_COLUMN_ENTRY_EX` takes an extra parameter, *`flags`*, that is needed if you designate a bookmark column. ```cpp -//////////////////////////////////////////////////////////////////////// -// CustomRS.h - -#define ADD_COLUMN_ENTRY(ulCols, name, ordinal, colSize, type, precision, scale, guid, dataClass, member) \ - _rgColumns[ulCols].pwszName = (LPOLESTR)name; \ - _rgColumns[ulCols].pTypeInfo = (ITypeInfo*)NULL; \ - _rgColumns[ulCols].iOrdinal = (ULONG)ordinal; \ - _rgColumns[ulCols].dwFlags = 0; \ - _rgColumns[ulCols].ulColumnSize = (ULONG)colSize; \ - _rgColumns[ulCols].wType = (DBTYPE)type; \ - _rgColumns[ulCols].bPrecision = (BYTE)precision; \ - _rgColumns[ulCols].bScale = (BYTE)scale; \ - _rgColumns[ulCols].cbOffset = offsetof(dataClass, member); - -#define ADD_COLUMN_ENTRY_EX(ulCols, name, ordinal, colSize, type, precision, scale, guid, dataClass, member, flags) \ - _rgColumns[ulCols].pwszName = (LPOLESTR)name; \ - _rgColumns[ulCols].pTypeInfo = (ITypeInfo*)NULL; \ - _rgColumns[ulCols].iOrdinal = (ULONG)ordinal; \ - _rgColumns[ulCols].dwFlags = flags; \ - _rgColumns[ulCols].ulColumnSize = (ULONG)colSize; \ - _rgColumns[ulCols].wType = (DBTYPE)type; \ - _rgColumns[ulCols].bPrecision = (BYTE)precision; \ - _rgColumns[ulCols].bScale = (BYTE)scale; \ - _rgColumns[ulCols].cbOffset = offsetof(dataClass, member); \ - memset(&(_rgColumns[ulCols].columnid), 0, sizeof(DBID)); \ - _rgColumns[ulCols].columnid.uName.pwszName = (LPOLESTR)name; +//////////////////////////////////////////////////////////////////////// +// CustomRS.h + +#define ADD_COLUMN_ENTRY(ulCols, name, ordinal, colSize, type, precision, scale, guid, dataClass, member) \ + _rgColumns[ulCols].pwszName = (LPOLESTR)name; \ + _rgColumns[ulCols].pTypeInfo = (ITypeInfo*)NULL; \ + _rgColumns[ulCols].iOrdinal = (ULONG)ordinal; \ + _rgColumns[ulCols].dwFlags = 0; \ + _rgColumns[ulCols].ulColumnSize = (ULONG)colSize; \ + _rgColumns[ulCols].wType = (DBTYPE)type; \ + _rgColumns[ulCols].bPrecision = (BYTE)precision; \ + _rgColumns[ulCols].bScale = (BYTE)scale; \ + _rgColumns[ulCols].cbOffset = offsetof(dataClass, member); + +#define ADD_COLUMN_ENTRY_EX(ulCols, name, ordinal, colSize, type, precision, scale, guid, dataClass, member, flags) \ + _rgColumns[ulCols].pwszName = (LPOLESTR)name; \ + _rgColumns[ulCols].pTypeInfo = (ITypeInfo*)NULL; \ + _rgColumns[ulCols].iOrdinal = (ULONG)ordinal; \ + _rgColumns[ulCols].dwFlags = flags; \ + _rgColumns[ulCols].ulColumnSize = (ULONG)colSize; \ + _rgColumns[ulCols].wType = (DBTYPE)type; \ + _rgColumns[ulCols].bPrecision = (BYTE)precision; \ + _rgColumns[ulCols].bScale = (BYTE)scale; \ + _rgColumns[ulCols].cbOffset = offsetof(dataClass, member); \ + memset(&(_rgColumns[ulCols].columnid), 0, sizeof(DBID)); \ + _rgColumns[ulCols].columnid.uName.pwszName = (LPOLESTR)name; ``` In the `GetColumnInfo` function, the bookmark macro is used like this: @@ -136,8 +135,8 @@ ADD_COLUMN_ENTRY_EX(ulCols, OLESTR("Bookmark"), 0, sizeof(DWORD), DBCOLUMNFLAGS_ISBOOKMARK) ``` -You can now compile and run the enhanced provider. To test the provider, modify the test consumer as described in [Implementing a Simple Consumer](../../data/oledb/implementing-a-simple-consumer.md). Run the test consumer with the provider and verify that the test consumer retrieves the proper strings from the provider. +You can now compile and run the enhanced provider. To test the provider, modify the test consumer as described in [Implementing a Simple Consumer](implementing-a-simple-consumer.md). Run the test consumer with the provider and verify that the test consumer retrieves the proper strings from the provider. ## See also -[Enhancing the Simple Read-Only Provider](../../data/oledb/enhancing-the-simple-read-only-provider.md)
+[Enhancing the Simple Read-Only Provider](enhancing-the-simple-read-only-provider.md) diff --git a/docs/docfx.json b/docs/docfx.json index e3765f2f722..e450d439f85 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -6,15 +6,15 @@ "**/*.md", "**/*.yml" ], - "group": "group-vc2015", - "src": ".", "exclude": [ "**/2019/**", "**/2017/**", "**/obj/**", "vcppdocs/**", "**/includes/**" - ] + ], + "src": ".", + "group": "group-vc2015" } ], "resource": [ @@ -25,13 +25,13 @@ "**/*.gif", "**/*.svg" ], - "group": "group-vc2015", - "src": ".", "exclude": [ "**/obj/**", "vcppdocs/**", "**/includes/**" - ] + ], + "src": ".", + "group": "group-vc2015" } ], "overwrite": [], @@ -42,7 +42,7 @@ "ROBOTS": "INDEX,FOLLOW", "manager": "coxford", "ms.date": "11/16/2016", - "ms.topic": "article", + "ms.topic": "concept-article", "audience": "developer", "ms.service": "visual-cpp", "ms.tgt_pltfrm": "Windows", @@ -63,9 +63,9 @@ }, "fileMetadata": { "feedback_help_link_url": { - "dotnet/*.md": "https://learn.microsoft.com/en-us/answers/tags/308/dotnetcli", - "ide/*.md": "https://learn.microsoft.com/en-us/answers/tags/176/vs", - "windows/*.md": "https://learn.microsoft.com/en-us/answers/tags/184/windows-app-sdk" + "dotnet/*.md": "https://learn.microsoft.com/en-us/answers/tags/308/dotnetcli", + "ide/*.md": "https://learn.microsoft.com/en-us/answers/tags/176/vs", + "windows/*.md": "https://learn.microsoft.com/en-us/answers/tags/184/windows-app-sdk" }, "ms.tgt_pltfrm": { "linux/**.md": "Linux" @@ -116,7 +116,7 @@ "intrinsics/**.md": "reference", "mfc/reference/**.md": "reference", "overview/**.md": "overview", - "parallel/**.md": "reference", + "parallel/**.md": "how-to", "preprocessor/**.md": "reference", "safeint/**.md": "reference", "sanitizers/**.md": "reference", @@ -175,7 +175,7 @@ "c-runtime-library/**.md": "3650-days", "c-runtime-library/**.yml": "3650-days", "cpp/**.md": "1095-days", - "cpp/**.yml": "1095-days", + "cpp/**.yml": "1095-days", "cppcx/**.md": "3650-days", "cppcx/**.yml": "3650-days", "cross-platform/**.md": "1825-days", @@ -345,14 +345,14 @@ } }, "template": [], + "markdownEngineName": "markdig", "xref": [], - "dest": "vcppdocs", "groups": { "group-vc2015": { - "moniker_range": ">= msvc-140", - "dest": "vcppdocs-2015" + "dest": "vcppdocs-2015", + "moniker_range": ">= msvc-140" } }, - "markdownEngineName": "markdig" + "dest": "vcppdocs" } -} +} \ No newline at end of file diff --git a/docs/embedded/download-and-install-the-embedded-tooling.md b/docs/embedded/download-and-install-the-embedded-tooling.md index 1fe6ea96d53..3e7d613e7ae 100644 --- a/docs/embedded/download-and-install-the-embedded-tooling.md +++ b/docs/embedded/download-and-install-the-embedded-tooling.md @@ -15,6 +15,9 @@ ms.topic: install-set-up-deploy In Visual Studio 2022 and later versions, you can use the Visual Studio IDE on Windows to edit and debug embedded projects. Use tools such as the [Peripheral View](./peripheral-view.md), [RTOS View](./rtos-view.md), and the [Serial Monitor](./serial-monitor.md) to help interact with and debug your embedded projects. +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + To use the embedded development tools in Visual Studio, you must install the required **Linux and embedded development with C++** workload. ## To install the Linux and embedded development with C++ workload @@ -25,7 +28,7 @@ To use the embedded development tools in Visual Studio, you must install the req 1. Open the Visual Studio Installer. In Visual Studio Installer, choose **Modify** next to your installation of Visual Studio, and then select the **Workloads** tab. Scroll down to **Other toolsets** and select the **Linux and embedded development with C++** workload. - ![Screenshot showing the Visual C++ for Linux Development workload item in Visual Studio Installer.](media/linux-and-embedded-workload.png) + ![Screenshot showing the Microsoft C++ for Linux Development workload item in Visual Studio Installer.](media/linux-and-embedded-workload.png) 1. Choose **Modify** to continue with the installation. diff --git a/docs/embedded/serial-monitor.md b/docs/embedded/serial-monitor.md index 6ec62acf7ed..48d55fb9c04 100644 --- a/docs/embedded/serial-monitor.md +++ b/docs/embedded/serial-monitor.md @@ -8,12 +8,17 @@ monikerRange: '>=msvc-170' --- # Serial Monitor +> [!NOTE] +> This article is no longer maintained. It references a non-Microsoft extension and might not reflect the current state of the Serial Monitor 2 extension. + ## Overview The Serial Monitor allows users to configure, monitor, and communicate with serial ports. # [Visual Studio](#tab/visual-studio) +To install Serial Monitor in Visual Studio, go to **Extensions** > **Manage Extensions**. Search for **Serial Monitor 2** in the extensions marketplace. Select **Install** and then restart Visual Studio to complete the installation. + :::image type="complex" source="./media/serial-monitor.png" alt-text="Screenshot of the Visual Studio Serial Monitor window."::: The window is split into two sections. The top section shows the monitoring mode (serial), Port (virtual COM port COM3), baud rate (115200), line ending (None), and a Stop monitoring button. The bottom section shows the messages, consisting of four lines of the text Hello, World! :::image-end::: @@ -44,6 +49,8 @@ The window is split into two sections. The top section shows the monitoring mode # [Visual Studio Code](#tab/visual-studio-code) +To install Serial Monitor in Visual Studio Code, open the extensions marketplace and then search for **Serial Monitor**. Select **Install**. + :::image type="complex" source="./media/serial-monitor-vscode.png" alt-text="Screenshot of the VS Code Serial Monitor window."::: The window is split into two sections. The top section shows the monitoring mode (serial), Port (virtual COM port COM3), baud rate (115200), line ending (None), and a Stop monitoring button. The bottom section where messages are displayed is empty. :::image-end::: diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2014.md b/docs/error-messages/compiler-errors-1/compiler-error-c2014.md index 32eb37bf33e..0bbac771005 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2014.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2014.md @@ -1,7 +1,7 @@ --- title: "Compiler Error C2014" description: "Learn more about: Compiler Error C2014" -ms.date: 11/04/2016 +ms.date: 08/25/2025 f1_keywords: ["C2014"] helpviewer_keywords: ["C2014"] --- @@ -11,7 +11,7 @@ helpviewer_keywords: ["C2014"] ## Remarks -The `#` sign of a preprocessor directive must be the first character on a line that is not white space. +The `#` sign of a [preprocessor directive](../../preprocessor/preprocessor-directives.md) must be the first character on a line that is not white space. Ensure that the previous line doesn't contain a trailing escape. ## Example @@ -19,14 +19,13 @@ The following example generates C2014: ```cpp // C2014.cpp -int k; #include // C2014 -``` +// compile with: /c -Possible resolution: +int a; #define A // C2014 -```cpp -// C2014b.cpp -// compile with: /c -int k; -#include +int b;\ +#define B // C2014 + +int c; +#define C // OK ``` diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2033.md b/docs/error-messages/compiler-errors-1/compiler-error-c2033.md index 87aaa08b7b5..110b499acd5 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2033.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2033.md @@ -1,17 +1,17 @@ --- title: "Compiler Error C2033" description: "Learn more about: Compiler Error C2033" -ms.date: 11/04/2016 +ms.date: 09/10/2025 f1_keywords: ["C2033"] helpviewer_keywords: ["C2033"] --- # Compiler Error C2033 -> 'identifier' : bit field cannot have indirection +> '*identifier*': bit field cannot have indirection ## Remarks -The bit field was declared as a pointer, which is not allowed. +Bit fields can't be declared as a pointer, reference, or array. For more information, see [C++ Bit Fields](../../cpp/cpp-bit-fields.md). ## Example @@ -19,17 +19,15 @@ The following example generates C2033: ```cpp // C2033.cpp -struct S { - int *b : 1; // C2033 +// compile with: /c + +struct S +{ + int* ptr : 1; // C2033 + int arr[3] : 1; // C2033 }; ``` -Possible resolution: +## See also -```cpp -// C2033b.cpp -// compile with: /c -struct S { - int b : 1; -}; -``` +[Compiler Error C2531](../compiler-errors-2/compiler-error-c2531.md) diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2135.md b/docs/error-messages/compiler-errors-1/compiler-error-c2135.md index 4af1d4f1b40..aff3621ccb1 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2135.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2135.md @@ -1,17 +1,17 @@ --- title: "Compiler Error C2135" description: "Learn more about: Compiler Error C2135" -ms.date: 11/04/2016 +ms.date: 08/13/2025 f1_keywords: ["C2135"] helpviewer_keywords: ["C2135"] --- # Compiler Error C2135 -> 'bit operator' : illegal bit field operation +> '*identifier*': you cannot apply '*operator*' to a bit-field ## Remarks -The address-of operator (`&`) cannot be applied to a bit field. +The [address-of operator (`&`)](../../cpp/address-of-operator-amp.md), [unary plus operator (`+`)](../../cpp/unary-plus-and-negation-operators-plus-and.md), [unary negation operator (`-`)](../../cpp/unary-plus-and-negation-operators-plus-and.md), [logical negation operator (`!`)](../../cpp/logical-negation-operator-exclpt.md), [one's complement operator (`~`)](../../cpp/one-s-complement-operator-tilde.md), and [indirection operator (`*`)](../../cpp/indirection-operator-star.md) cannot be applied to a bit-field in this context. ## Example @@ -19,15 +19,20 @@ The following example generates C2135: ```cpp // C2135.cpp -struct S { - int i : 1; -}; -struct T { - int j; +struct S +{ + int bit_field : 1; + int integer; }; -int main() { - &S::i; // C2135 address of a bit field - &T::j; // OK + +int main() +{ + &S::bit_field; // C2135 + &S::integer; // OK } ``` + +## See also + +[C2104](compiler-error-c2104.md) diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2154.md b/docs/error-messages/compiler-errors-1/compiler-error-c2154.md index 021703b64ec..38192df4ca8 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2154.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2154.md @@ -1,16 +1,36 @@ --- title: "Compiler Error C2154" description: "Learn more about: Compiler Error C2154" -ms.date: 11/04/2016 +ms.date: 09/21/2025 f1_keywords: ["C2154"] helpviewer_keywords: ["C2154"] --- # Compiler Error C2154 -> 'type' : only enumeration type is allowed as an argument to compiler intrinsic type trait '__underlying_type' +> '*type*': only enumeration type is allowed as an argument to compiler intrinsic type trait '__underlying_type' ## Remarks -You can only get the underlying type of an enumeration type. +You can only get the underlying type of an [enumeration](../../cpp/enumerations-cpp.md) type. -For more information, see [Compiler Support for Type Traits](../../extensions/compiler-support-for-type-traits-cpp-component-extensions.md). +## Example + +The following example generates C2154: + +```cpp +// C2154.cpp +// compile with: /c + +struct S {}; +enum E {}; +enum class EC {}; + +__underlying_type(S) s; // C2154 +__underlying_type(int) i; // C2154 +__underlying_type(E) e; // OK +__underlying_type(EC) ec; // OK +``` + +## See also + +[`underlying_type` class](../../standard-library/underlying-type-class.md) diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2178.md b/docs/error-messages/compiler-errors-1/compiler-error-c2178.md index ce0dfb543fd..4c93e6c79d6 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2178.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2178.md @@ -1,7 +1,7 @@ --- title: "Compiler Error C2178" description: "Learn more about: Compiler Error C2178" -ms.date: 05/08/2017 +ms.date: 08/11/2025 f1_keywords: ["C2178"] helpviewer_keywords: ["C2178"] --- @@ -11,23 +11,41 @@ helpviewer_keywords: ["C2178"] ## Remarks -A **`mutable`** specifier was used in a declaration, but the specifier is not allowed in this context. +A **`mutable`** specifier was used in a declaration, but the specifier is not allowed in this context. It can only be applied to non-static, non-const, and non-reference data members. For more information, see [Mutable Data Members](../../cpp/mutable-data-members-cpp.md). -The **`mutable`** specifier can be applied only to names of class data members, and cannot be applied to names declared **`const`** or **`static`**, and cannot be applied to reference members. +A **`consteval`** specifier was used on a [destructor](../../cpp/destructors-cpp.md), allocation function, or deallocation function. -## Example +## Example: `mutable` -The following example shows how C2178 may occur, and how to fix it. +The following example shows how C2178 may occur with the **`mutable`** specifier, and how to resolve it: ```cpp -// C2178.cpp -// compile with: cl /c /W4 C2178.cpp +// C2178_mutable.cpp +// compile with: /c -class S { - mutable const int i; // C2178 - // To fix, declare either const or mutable, not both. +struct S +{ + mutable const int i; // C2178, remove mutable or const to resolve }; -mutable int x = 4; // C2178 -// To fix, remove mutable keyword +mutable int x = 4; // C2178, remove mutable to resolve +``` + +## Example: `consteval` + +The following example shows how C2178 may occur with the **`consteval`** specifier. To resolve this error, remove all **`consteval`** specifiers: + +```cpp +// C2178_consteval.cpp +// compile with: /c /std:c++20 + +#include + +struct S +{ + consteval ~S() {} // C2178 + + consteval static void* operator new(std::size_t size); // C2178 + consteval static void operator delete(void* ptr); // C2178 +}; ``` diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2182.md b/docs/error-messages/compiler-errors-1/compiler-error-c2182.md index 86a4d0259c6..cbe5f56228d 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2182.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2182.md @@ -1,17 +1,17 @@ --- title: "Compiler Error C2182" description: "Learn more about: Compiler Error C2182" -ms.date: 11/04/2016 +ms.date: 08/22/2025 f1_keywords: ["C2182"] helpviewer_keywords: ["C2182"] --- # Compiler Error C2182 -> 'identifier' : illegal use of type 'void' +> '*identifier*': this use of 'void' is not valid ## Remarks -A variable is declared type **`void`**. +You can't create a variable or array of type **`void`**. Only pointers to **`void`** are allowed. ## Example @@ -20,9 +20,9 @@ The following example generates C2182: ```cpp // C2182.cpp // compile with: /c -int main() { - int i = 10; - void &ir = i; // C2182 cannot have a reference to type void - int &ir = i; // OK -} + +void var; // C2182 +void arr[5]; // C2182 + +void* ptr; // OK ``` diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2190.md b/docs/error-messages/compiler-errors-1/compiler-error-c2190.md index b1b5022b249..8c9adb4ad4c 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2190.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2190.md @@ -1,7 +1,7 @@ --- title: "Compiler Error C2190" description: "Learn more about: Compiler Error C2190" -ms.date: 11/04/2016 +ms.date: 08/22/2025 f1_keywords: ["C2190"] helpviewer_keywords: ["C2190"] --- @@ -11,7 +11,7 @@ helpviewer_keywords: ["C2190"] ## Remarks -A C function was declared a second time with a shorter parameter list. C does not support overloaded functions. +A C function was declared a second time with a shorter parameter list. C does not support overloaded functions. Without [`/Za`](../../build/reference/za-ze-disable-language-extensions.md), the compiler emits [Compiler Warning (level 1) C4030](../compiler-warnings/compiler-warning-level-1-c4030.md) instead. ## Example @@ -20,7 +20,13 @@ The following example generates C2190: ```c // C2190.c // compile with: /Za /c -void func( int, float ); -void func( int ); // C2190, different parameter list -void func2( int ); // OK + +void func1(int, float); +void func1(int); // C2190, shorter parameter list + +void func2(int); // OK ``` + +## See also + +[Compiler Error C2191](compiler-error-c2191.md) diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2191.md b/docs/error-messages/compiler-errors-1/compiler-error-c2191.md index 26511d59b3e..9644cee4889 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2191.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2191.md @@ -1,7 +1,7 @@ --- title: "Compiler Error C2191" description: "Learn more about: Compiler Error C2191" -ms.date: 11/04/2016 +ms.date: 08/22/2025 f1_keywords: ["C2191"] helpviewer_keywords: ["C2191"] --- @@ -11,7 +11,7 @@ helpviewer_keywords: ["C2191"] ## Remarks -A C function was declared a second time with a longer parameter list. C does not support overloaded functions. +A C function was declared a second time with a longer parameter list. C does not support overloaded functions. Without [`/Za`](../../build/reference/za-ze-disable-language-extensions.md), the compiler emits [Compiler Warning (level 1) C4031](../compiler-warnings/compiler-warning-level-1-c4031.md) instead. ## Example @@ -20,7 +20,13 @@ The following example generates C2191: ```c // C2191.c // compile with: /Za /c -void func( int ); -void func( int, float ); // C2191 different parameter list -void func2( int, float ); // OK + +void func1(int); +void func1(int, float); // C2191, longer parameter list + +void func2(int, float); // OK ``` + +## See also + +[Compiler Error C2190](compiler-error-c2190.md) diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2201.md b/docs/error-messages/compiler-errors-1/compiler-error-c2201.md index 01983a4cf4a..4be33f800de 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2201.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2201.md @@ -15,7 +15,7 @@ The exported identifier is **`static`**. ## Example -The following example generates C2286, and shows how to fix it: +The following example generates C2201, and shows how to fix it: ```cpp // C2201.cpp diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2250.md b/docs/error-messages/compiler-errors-1/compiler-error-c2250.md index 90762d9a529..5e30d649e82 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2250.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2250.md @@ -15,7 +15,7 @@ The derived class inherits more than one override of a virtual function of a vir ## Example -The following example generates C2286: +The following example generates C2250: ```cpp // C2250.cpp diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2277.md b/docs/error-messages/compiler-errors-1/compiler-error-c2277.md index 1f56b60b30e..20429c174ac 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2277.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2277.md @@ -1,27 +1,29 @@ --- title: "Compiler Error C2277" description: "Learn more about: Compiler Error C2277" -ms.date: 11/04/2016 +ms.date: 08/27/2025 f1_keywords: ["C2277"] helpviewer_keywords: ["C2277"] --- # Compiler Error C2277 -> 'identifier' : cannot take address of this member function +> '*function*': cannot take address of this member function ## Remarks -You cannot take the address of a member function. +You cannot take the address of a [constructor](../../cpp/constructors-cpp.md) or [destructor](../../cpp/destructors-cpp.md). For more information, see [Address-of operator: `&`](../../cpp/address-of-operator-amp.md) and [Pointers to Members](../../cpp/pointers-to-members.md). ## Example The following example generates C2277: ```cpp -// C2277.cpp -class A { +// compile with: /c + +class A +{ public: A(); }; -(*pctor)() = &A::A; // C2277 +(*pctor)() = &A::A; // C2277 ``` diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2290.md b/docs/error-messages/compiler-errors-1/compiler-error-c2290.md index 5742c5e234c..41f755959b1 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2290.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2290.md @@ -1,14 +1,29 @@ --- title: "Compiler Error C2290" description: "Learn more about: Compiler Error C2290" -ms.date: 11/04/2016 +ms.date: 12/5/2025 f1_keywords: ["C2290"] helpviewer_keywords: ["C2290"] --- # Compiler Error C2290 -> C++ asm syntax ignored. Use __asm. +> C++ 'asm' syntax ignored. Use __asm. ## Remarks -The **`asm`** syntax is reserved for future use. +The **`asm`** syntax is reserved for future use. Try [`__asm`](../../assembler/inline/asm.md) instead. For more information, see [Inline Assembler](../../assembler/inline/inline-assembler.md). + +## Example + +The following example generates C2290: + +```cpp +// C2290.cpp +// Compile for 32 bit, i.e. x86 instead of x64 + +int main() +{ + asm("nop"); // C2290 + __asm { nop } // OK +} +``` diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2380.md b/docs/error-messages/compiler-errors-1/compiler-error-c2380.md index 9b317bd13db..a0745e12c88 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2380.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2380.md @@ -15,7 +15,7 @@ A constructor returns a value or redefines the class name. ## Example -The following example generates C2326: +The following example generates C2380: ```cpp // C2380.cpp diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2391.md b/docs/error-messages/compiler-errors-1/compiler-error-c2391.md index dcf10dedd8e..283aeb7e762 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2391.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2391.md @@ -15,7 +15,7 @@ The **`friend`** declaration includes a complete class declaration. A **`friend` ## Example -The following example generates C2326: +The following example generates C2391: ```cpp // C2391.cpp diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2449.md b/docs/error-messages/compiler-errors-1/compiler-error-c2449.md index aee2034191e..b99392c66d8 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2449.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2449.md @@ -17,7 +17,7 @@ This error can be caused by a semicolon between a function header and the openin ## Example -The following example generates C2499: +The following example generates C2449: ```c // C2449.c diff --git a/docs/error-messages/compiler-errors-1/compiler-error-c2469.md b/docs/error-messages/compiler-errors-1/compiler-error-c2469.md index 46ce44d6ee3..1a340f4bf07 100644 --- a/docs/error-messages/compiler-errors-1/compiler-error-c2469.md +++ b/docs/error-messages/compiler-errors-1/compiler-error-c2469.md @@ -1,23 +1,38 @@ --- -description: "Learn more about: Compiler Error C2469" title: "Compiler Error C2469" -ms.date: "11/04/2016" +description: "Learn more about: Compiler Error C2469" +ms.date: 2/27/2026 f1_keywords: ["C2469"] helpviewer_keywords: ["C2469"] -ms.assetid: 3814bdff-581a-4d3e-8b47-8de6887cea69 --- # Compiler Error C2469 -'operator': cannot allocate 'type' object +> '`new`': cannot allocate '`void`' objects + +## Remarks + +The [`new` operator](../../cpp/new-operator-cpp.md) allocates memory and constructs an object of the specified type. Since `void` isn't a constructible type, use `::operator new(size)` to allocate raw memory without object construction. + +## Example: Wrong allocation type + +```cpp +// compile with /c +int main() +{ + void* ptr1 = new void; // C2469 + int* ptr2 = new int; // OK +} +``` -An operator was passed an invalid type. +## Example: Allocate untyped memory -The following sample generates C2469: +To allocate untyped memory, use `::operator new`: ```cpp -// C2469.cpp -int main() { - int *i = new void; // C2469 - int *i = new int; // OK +// compile with /c +int main() +{ + void* ptr1 = new void; // C2469 + void* ptr2 = ::operator new(4); // OK } ``` diff --git a/docs/error-messages/compiler-errors-1/compiler-errors-c2100-through-c2199.md b/docs/error-messages/compiler-errors-1/compiler-errors-c2100-through-c2199.md index ef2e8e4b3f9..66e44a4ebeb 100644 --- a/docs/error-messages/compiler-errors-1/compiler-errors-c2100-through-c2199.md +++ b/docs/error-messages/compiler-errors-1/compiler-errors-c2100-through-c2199.md @@ -1,7 +1,7 @@ --- title: "Compiler errors C2100 through C2199" description: "Learn more about: Compiler errors C2100 through C2199" -ms.date: "04/21/2019" +ms.date: 04/21/2019 f1_keywords: ["C2119", "C2123", "C2125", "C2126", "C2127", "C2136", "C2176", "C2187", "C2189"] helpviewer_keywords: ["C2119", "C2123", "C2125", "C2126", "C2127", "C2136", "C2176", "C2187", "C2189"] --- @@ -69,7 +69,7 @@ The articles in this section of the documentation explain a subset of the error |[Compiler error C2151](compiler-error-c2151.md)|more than one language attribute| |[Compiler error C2152](compiler-error-c2152.md)|'*identifier*': pointers to functions with different attributes| |[Compiler error C2153](compiler-error-c2153.md)|integer literals must have at least one digit| -|[Compiler error C2154](compiler-error-c2154.md)|'*type*': only enumeration type is allowed as an argument to compiler intrinsic type trait '*trait*'| +|[Compiler error C2154](compiler-error-c2154.md)|'*type*': only enumeration type is allowed as an argument to compiler intrinsic type trait '__underlying_type'| |[Compiler error C2155](compiler-error-c2155.md)|'?': invalid left operand, expected arithmetic or pointer type| |[Compiler error C2156](compiler-error-c2156.md)|pragma must be outside function| |[Compiler error C2157](compiler-error-c2157.md)|'*identifier*': must be declared before use in pragma list| @@ -97,7 +97,7 @@ The articles in this section of the documentation explain a subset of the error |[Compiler error C2179](compiler-error-c2179.md)|'*type*': an attribute argument cannot use type parameters| |[Compiler error C2180](compiler-error-c2180.md)|controlling expression has type '*type*'| |[Compiler error C2181](compiler-error-c2181.md)|illegal else without matching if| -|[Compiler error C2182](compiler-error-c2182.md)|'*identifier*': illegal use of type 'void'| +|[Compiler error C2182](compiler-error-c2182.md)|'*identifier*': this use of 'void' is not valid| |[Compiler error C2183](compiler-error-c2183.md)|syntax error: translation unit is empty| |[Compiler error C2184](compiler-error-c2184.md)|'*type*': illegal type for __except expression| |[Compiler error C2185](compiler-error-c2185.md)|'*identifier*': illegal based allocation| diff --git a/docs/error-messages/compiler-errors-1/compiler-fatal-errors-c999-through-c1999.md b/docs/error-messages/compiler-errors-1/compiler-fatal-errors-c999-through-c1999.md index 8ba3fceb817..d19b4ce9368 100644 --- a/docs/error-messages/compiler-errors-1/compiler-fatal-errors-c999-through-c1999.md +++ b/docs/error-messages/compiler-errors-1/compiler-fatal-errors-c999-through-c1999.md @@ -43,6 +43,7 @@ The articles in this section of the documentation explain a subset of the error | [Fatal error C1026](fatal-error-c1026.md) | parser stack overflow, program too complex | | Fatal error C1027 | **(Obsolete)** Inconsistent values for /Ym between creation and use of precompiled header | | Fatal error C1028 | missing IFC for analysis. Please rebuild *module* '*ifc filename*' with `/analyze`. | +| [Fatal error C1029](fatal-error-c1029.md) | '*filename*': source file hash (*number* bytes) exceeds the IFC format's maximum supported hash size (*number* bytes); use a smaller hash algorithm such as SHA-256 | | Fatal error C1030 | WMMX types not allowed in the function signature by the calling convention | | Fatal error C1032 | `__eabi` requires VFP code generation (`/QRfpe-`) | | [Fatal error C1033](fatal-error-c1033.md) | cannot open program database '*file*' | diff --git a/docs/error-messages/compiler-errors-1/fatal-error-c1029.md b/docs/error-messages/compiler-errors-1/fatal-error-c1029.md new file mode 100644 index 00000000000..0e52957dfe2 --- /dev/null +++ b/docs/error-messages/compiler-errors-1/fatal-error-c1029.md @@ -0,0 +1,16 @@ +--- +title: "Fatal error C1029" +description: "Learn more about: Fatal error C1029" +ms.date: 04/13/2026 +f1_keywords: ["C1029"] +helpviewer_keywords: ["C1029"] +--- +# Fatal error C1029 + +> '*filename*': source file hash (*number* bytes) exceeds the IFC format's maximum supported hash size (*number* bytes); use a smaller hash algorithm such as SHA-256 + +## Remarks + +This error occurs when you compile a C++ module (or header unit) with a [`/ZH`](../../build/reference/zh.md) hash algorithm that produces a checksum larger than the current IFC format supports. The **`/ZH:SHA384`** and **`/ZH:SHA512`** options produce checksums that exceed this limit. + +To fix this error, use **`/ZH:SHA_256`** or a smaller hash algorithm (such as **`/ZH:SHA1`** or **`/ZH:MD5`**) when you compile modules or header units. The default **`/ZH:SHA_256`** option works correctly with IFC files. diff --git a/docs/error-messages/compiler-errors-2/compiler-error-c2652.md b/docs/error-messages/compiler-errors-2/compiler-error-c2652.md index 062e00a09ed..5e7e2f0ee85 100644 --- a/docs/error-messages/compiler-errors-2/compiler-error-c2652.md +++ b/docs/error-messages/compiler-errors-2/compiler-error-c2652.md @@ -15,7 +15,7 @@ The first parameter in the copy constructor has the same type as the class, stru ## Example -The following example generates C2651: +The following example generates C2652: ```cpp // C2652.cpp diff --git a/docs/error-messages/compiler-errors-2/compiler-error-c2698.md b/docs/error-messages/compiler-errors-2/compiler-error-c2698.md index 464373f1458..dbc7eef8618 100644 --- a/docs/error-messages/compiler-errors-2/compiler-error-c2698.md +++ b/docs/error-messages/compiler-errors-2/compiler-error-c2698.md @@ -30,5 +30,5 @@ struct B { struct C : A, B { using A::x; using B::x; // C2698 -} +}; ``` diff --git a/docs/error-messages/compiler-errors-2/compiler-error-c3083.md b/docs/error-messages/compiler-errors-2/compiler-error-c3083.md index 35cefa54416..8b0ec411136 100644 --- a/docs/error-messages/compiler-errors-2/compiler-error-c3083.md +++ b/docs/error-messages/compiler-errors-2/compiler-error-c3083.md @@ -1,32 +1,31 @@ --- -description: "Learn more about: Compiler Error C3083" title: "Compiler Error C3083" -ms.date: "11/04/2016" +description: "Learn more about: Compiler Error C3083" +ms.date: 08/14/2025 f1_keywords: ["C3083"] helpviewer_keywords: ["C3083"] -ms.assetid: 05ff791d-52bb-41eb-9511-3ef89d7f4710 --- # Compiler Error C3083 -'function': the symbol to the left of a '::' must be a type +> '*identifier*': the symbol to the left of a '::' must be a type -A function was called incorrectly. +## Remarks + +The qualification used is invalid. Ensure that no extra symbols were used in the qualification and that you included all required headers. ## Example -The following sample generates C3083. +The following example generates C3083: ```cpp // C3083.cpp // compile with: /c -struct N { - ~N(); -}; -struct N1 { - ~N1(); +struct S +{ + S(); }; -N::N::~N() {} // C3083 -N1::~N1() {} // OK +S::Extra::S() {} // C3083 +S::S() {} // OK ``` diff --git a/docs/error-messages/compiler-errors-2/compiler-error-c3187.md b/docs/error-messages/compiler-errors-2/compiler-error-c3187.md index 4ef3efeedb4..1bb673cd78a 100644 --- a/docs/error-messages/compiler-errors-2/compiler-error-c3187.md +++ b/docs/error-messages/compiler-errors-2/compiler-error-c3187.md @@ -1,15 +1,39 @@ --- -description: "Learn more about: Compiler Error C3187" title: "Compiler Error C3187" -ms.date: "11/04/2016" +description: "Learn more about: Compiler Error C3187" +ms.date: 01/28/2026 f1_keywords: ["C3187"] helpviewer_keywords: ["C3187"] -ms.assetid: 9d2ebf55-1a6a-4087-bf5b-5274baae6351 --- # Compiler Error C3187 -> '`__func__`' : is only available within the body of a function +> '`__func__`': is only available within the body of a function + +## Remarks + +The predefined identifier [`__func__`](../../cpp/func.md) is not available outside the body of a function. + +To correct this error, move the identifier inside the body of a function. + +## Example + +The following example generates C3187: + +```cpp +// compile with: /c + +#include + +auto global = __func__; // C3187, usage in global scope +void func(const char* f = __func__); // C3187, usage in parameter list + +// correct usage inside a function +void test() +{ + std::cout << __func__; // outputs: test +} +``` -The predefined macro is not available outside the body of a function. +## See also -To correct this error, move the macro inside the body of a function. +[C2457](../compiler-errors-1/compiler-error-c2457.md) diff --git a/docs/error-messages/compiler-errors-2/compiler-error-c3239.md b/docs/error-messages/compiler-errors-2/compiler-error-c3239.md index 58302dfdb41..c214f06fe32 100644 --- a/docs/error-messages/compiler-errors-2/compiler-error-c3239.md +++ b/docs/error-messages/compiler-errors-2/compiler-error-c3239.md @@ -15,7 +15,7 @@ The compiler encountered an invalid type. ## Example -The following example generates C3229: +The following example generates C3239: ```cpp // C3239.cpp diff --git a/docs/error-messages/compiler-errors-2/compiler-error-c3295.md b/docs/error-messages/compiler-errors-2/compiler-error-c3295.md index 422e2296b2b..262bb7979b0 100644 --- a/docs/error-messages/compiler-errors-2/compiler-error-c3295.md +++ b/docs/error-messages/compiler-errors-2/compiler-error-c3295.md @@ -1,16 +1,15 @@ --- -description: "Learn more about: Compiler Error C3295" title: "Compiler Error C3295" -ms.date: "11/04/2016" +description: "Learn more about: Compiler Error C3295" +ms.date: 11/04/2016 f1_keywords: ["C3295"] helpviewer_keywords: ["C3295"] -ms.assetid: 83f0aa4d-0e0a-4905-9f66-fcf9991fc07a --- # Compiler Error C3295 '#pragma pragma' can only be used at global or namespace scope -Some pragmas cannot be used in a function. See [Pragma Directives and the __Pragma Keyword](../../preprocessor/pragma-directives-and-the-pragma-keyword.md) for more information. +Some pragmas cannot be used in a function. See [Pragma directives and the `__pragma` and `_Pragma` keywords](../../preprocessor/pragma-directives-and-the-pragma-keyword.md) for more information. ## Example diff --git a/docs/error-messages/compiler-errors-2/compiler-error-c3469.md b/docs/error-messages/compiler-errors-2/compiler-error-c3469.md index 3977e7f2c58..e835ecfbecf 100644 --- a/docs/error-messages/compiler-errors-2/compiler-error-c3469.md +++ b/docs/error-messages/compiler-errors-2/compiler-error-c3469.md @@ -28,7 +28,7 @@ public ref class GR {}; public ref class GR2 {}; ``` -The following example generates C3466. +The following example generates C3469. ```cpp // C3469_b.cpp diff --git a/docs/error-messages/compiler-errors-2/compiler-errors-c2500-through-c2599.md b/docs/error-messages/compiler-errors-2/compiler-errors-c2500-through-c2599.md index d6a27711af8..d018f827b7c 100644 --- a/docs/error-messages/compiler-errors-2/compiler-errors-c2500-through-c2599.md +++ b/docs/error-messages/compiler-errors-2/compiler-errors-c2500-through-c2599.md @@ -1,9 +1,9 @@ --- title: "Compiler errors C2500 Through C2599" -description: "Learn more about: Compiler errors C2500 Through C2599" +description: "Learn more about: Compiler errors C2500 through C2599" ms.date: 04/21/2019 -f1_keywords: ["C2501", "C2508", "C2515", "C2519", "C2520", "C2522", "C2525", "C2527", "C2536", "C2538", "C2539", "C2546", "C2547", "C2559", "C2560", "C2564", "C2565", "C2576", "C2578", "C2580", "C2590", "C2591", "C2595", "C2596"] -helpviewer_keywords: ["C2501", "C2508", "C2515", "C2519", "C2520", "C2522", "C2525", "C2527", "C2536", "C2538", "C2539", "C2546", "C2547", "C2559", "C2560", "C2564", "C2565", "C2576", "C2578", "C2580", "C2590", "C2591", "C2595", "C2596"] +f1_keywords: ["C2501", "C2508", "C2515", "C2519", "C2520", "C2522", "C2525", "C2527", "C2536", "C2538", "C2539", "C2546", "C2547", "C2554", "C2559", "C2560", "C2564", "C2565", "C2576", "C2578", "C2580", "C2590", "C2591", "C2595", "C2596"] +helpviewer_keywords: ["C2501", "C2508", "C2515", "C2519", "C2520", "C2522", "C2525", "C2527", "C2536", "C2538", "C2539", "C2546", "C2547", "C2554", "C2559", "C2560", "C2564", "C2565", "C2576", "C2578", "C2580", "C2590", "C2591", "C2595", "C2596"] --- # Compiler errors C2500 Through C2599 diff --git a/docs/error-messages/compiler-errors-2/compiler-errors-c3100-through-c3199.md b/docs/error-messages/compiler-errors-2/compiler-errors-c3100-through-c3199.md index 338e4eceb9f..92e4a1b994d 100644 --- a/docs/error-messages/compiler-errors-2/compiler-errors-c3100-through-c3199.md +++ b/docs/error-messages/compiler-errors-2/compiler-errors-c3100-through-c3199.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: Compiler errors C3100 Through C3199" title: "Compiler errors C3100 Through C3199" +description: "Learn more about: Compiler errors C3100 Through C3199" ms.date: 06/01/2022 f1_keywords: ["C3102", "C3105", "C3107", "C3108", "C3109", "C3111", "C3112", "C3119", "C3122", "C3123", "C3124", "C3125", "C3127", "C3128", "C3129", "C3143", "C3144", "C3146", "C3147", "C3148", "C3151", "C3158", "C3164", "C3165", "C3169", "C3177", "C3178", "C3184", "C3186", "C3188", "C3191", "C3193"] helpviewer_keywords: ["C3102", "C3105", "C3107", "C3108", "C3109", "C3111", "C3112", "C3119", "C3122", "C3123", "C3124", "C3125", "C3127", "C3128", "C3129", "C3143", "C3144", "C3146", "C3147", "C3148", "C3151", "C3158", "C3164", "C3165", "C3169", "C3177", "C3178", "C3184", "C3186", "C3188", "C3191", "C3193"] @@ -102,7 +102,7 @@ The articles in this section of the documentation explain a subset of the error | Compiler error C3184 | Obsolete. | | [Compiler error C3185](compiler-error-c3185.md) | 'typeid': used on managed/WinRT type '*type*', use '*operator*' instead | | Compiler error C3186 | Obsolete. | -| [Compiler error C3187](compiler-error-c3187.md) | '*identifier*': is only available within the body of a function | +| [Compiler error C3187](compiler-error-c3187.md) | '`__func__`': is only available within the body of a function | | Compiler error C3188 | Obsolete. | | [Compiler error C3189](compiler-error-c3189.md) | 'typeid<*declarator*>': this syntax is no longer supported, use::typeid instead (Obsolete in Visual Studio 2022.) | | [Compiler error C3190](compiler-error-c3190.md) | '*declarator*' with the provided template arguments is not the explicit instantiation of any member function of '*type*' | diff --git a/docs/error-messages/compiler-errors-2/compiler-errors-c7500-through-c7999.md b/docs/error-messages/compiler-errors-2/compiler-errors-c7500-through-c7999.md index 984ce5a3d8f..02b5801c7bd 100644 --- a/docs/error-messages/compiler-errors-2/compiler-errors-c7500-through-c7999.md +++ b/docs/error-messages/compiler-errors-2/compiler-errors-c7500-through-c7999.md @@ -1,9 +1,9 @@ --- -description: "Learn more about: Compiler errors C7500 through C7999" title: "Compiler errors C7500 through C7999" +description: "Learn more about: Compiler errors C7500 through C7999" ms.date: 10/13/2023 -f1_keywords: ["C7500", "C7501", "C7502", "C7503", "C7504", "C7505", "C7506", "C7507", "C7508", "C7509", "C7511", "C7512", "C7513", "C7514", "C7515", "C7516", "C7517", "C7518", "C7519", "C7520", "C7521", "C7522", "C7523", "C7524", "C7525", "C7526", "C7527", "C7528", "C7529", "C7530", "C7531", "C7532", "C7533", "C7534", "C7535", "C7537", "C7538", "C7539", "C7540", "C7541", "C7542", "C7543", "C7544", "C7545", "C7546", "C7547", "C7548", "C7549", "C7550", "C7551", "C7552", "C7554", "C7555", "C7556", "C7557", "C7558", "C7559", "C7560", "C7561", "C7562", "C7563", "C7564", "C7565", "C7566", "C7567", "C7568", "C7569", "C7570", "C7571", "C7572", "C7573", "C7574", "C7575", "C7576", "C7577", "C7578", "C7579", "C7580", "C7581", "C7582", "C7583", "C7584", "C7585", "C7586", "C7587", "C7588", "C7589", "C7590", "C7591", "C7592", "C7593", "C7594", "C7595", "C7596", "C7597", "C7599", "C7600", "C7601", "C7602", "C7603", "C7604", "C7605", "C7606", "C7607", "C7608", "C7609", "C7610", "C7611", "C7612", "C7613", "C7614", "C7615", "C7616", "C7617", "C7618", "C7619", "C7620", "C7621", "C7622", "C7623", "C7624", "C7625", "C7627", "C7628", "C7629", "C7630", "C7631", "C7632", "C7633", "C7634", "C7635", "C7636", "C7637", "C7638", "C7639", "C7640", "C7641", "C7642", "C7643", "C7644", "C7645", "C7646", "C7647", "C7648", "C7649", "C7650", "C7651", "C7652", "C7653", "C7654", "C7655", "C7656", "C7657", "C7658", "C7659", "C7660", "C7661", "C7662", "C7686", "C7700", "C7701", "C7702", "C7703", "C7704"] -helpviewer_keywords: ["C7500", "C7501", "C7502", "C7503", "C7504", "C7505", "C7506", "C7507", "C7508", "C7509", "C7511", "C7512", "C7513", "C7514", "C7515", "C7516", "C7517", "C7518", "C7519", "C7520", "C7521", "C7522", "C7523", "C7524", "C7525", "C7526", "C7527", "C7528", "C7529", "C7530", "C7531", "C7532", "C7533", "C7534", "C7535", "C7537", "C7538", "C7539", "C7540", "C7541", "C7542", "C7543", "C7544", "C7545", "C7546", "C7547", "C7548", "C7549", "C7550", "C7551", "C7552", "C7554", "C7555", "C7556", "C7557", "C7558", "C7559", "C7560", "C7561", "C7562", "C7563", "C7564", "C7565", "C7566", "C7567", "C7568", "C7569", "C7570", "C7571", "C7572", "C7573", "C7574", "C7575", "C7576", "C7577", "C7578", "C7579", "C7580", "C7581", "C7582", "C7583", "C7584", "C7585", "C7586", "C7587", "C7588", "C7589", "C7590", "C7591", "C7592", "C7593", "C7594", "C7595", "C7596", "C7597", "C7599", "C7600", "C7601", "C7602", "C7603", "C7604", "C7605", "C7606", "C7607", "C7608", "C7609", "C7610", "C7611", "C7612", "C7613", "C7614", "C7615", "C7616", "C7617", "C7618", "C7619", "C7620", "C7621", "C7622", "C7623", "C7624", "C7625", "C7627", "C7628", "C7629", "C7630", "C7631", "C7632", "C7633", "C7634", "C7635", "C7636", "C7637", "C7638", "C7639", "C7640", "C7641", "C7642", "C7643", "C7644", "C7645", "C7646", "C7647", "C7648", "C7649", "C7650", "C7651", "C7652", "C7653", "C7654", "C7655", "C7656", "C7657", "C7658", "C7659", "C7660", "C7661", "C7662", "C7686", "C7700", "C7701", "C7702", "C7703", "C7704"] +f1_keywords: ["C7500", "C7501", "C7502", "C7503", "C7504", "C7505", "C7506", "C7507", "C7508", "C7509", "C7511", "C7512", "C7513", "C7514", "C7515", "C7516", "C7517", "C7518", "C7519", "C7520", "C7521", "C7522", "C7523", "C7524", "C7525", "C7526", "C7527", "C7528", "C7529", "C7530", "C7531", "C7532", "C7533", "C7534", "C7535", "C7537", "C7538", "C7539", "C7540", "C7541", "C7542", "C7543", "C7544", "C7545", "C7546", "C7547", "C7548", "C7549", "C7550", "C7551", "C7552", "C7554", "C7555", "C7556", "C7557", "C7558", "C7559", "C7560", "C7561", "C7562", "C7563", "C7564", "C7565", "C7566", "C7567", "C7568", "C7569", "C7570", "C7571", "C7572", "C7573", "C7574", "C7575", "C7576", "C7577", "C7578", "C7579", "C7580", "C7581", "C7582", "C7583", "C7584", "C7585", "C7586", "C7587", "C7588", "C7589", "C7590", "C7591", "C7592", "C7593", "C7594", "C7595", "C7596", "C7597", "C7598", "C7599", "C7600", "C7601", "C7602", "C7603", "C7604", "C7605", "C7606", "C7607", "C7608", "C7609", "C7610", "C7611", "C7612", "C7613", "C7614", "C7615", "C7616", "C7617", "C7618", "C7619", "C7620", "C7621", "C7622", "C7623", "C7624", "C7625", "C7627", "C7628", "C7629", "C7630", "C7631", "C7632", "C7633", "C7634", "C7635", "C7636", "C7637", "C7638", "C7639", "C7640", "C7641", "C7642", "C7643", "C7644", "C7645", "C7646", "C7647", "C7648", "C7649", "C7650", "C7651", "C7652", "C7653", "C7654", "C7655", "C7656", "C7657", "C7658", "C7659", "C7660", "C7661", "C7662", "C7665", "C7666", "C7667", "C7668", "C7669", "C7670", "C7671", "C7672", "C7673", "C7674", "C7675", "C7676", "C7677", "C7678", "C7679", "C7680", "C7682", "C7683", "C7684", "C7685", "C7686", "C7687", "C7689", "C7690", "C7691", "C7692", "C7693", "C7694", "C7695", "C7696", "C7697", "C7698", "C7699", "C7700", "C7701", "C7702", "C7703", "C7704", "C7705", "C7706", "C7707", "C7708", "C7709", "C7710", "C7711", "C7712", "C7713", "C7714", "C7720", "C7730", "C7731", "C7732", "C7733", "C7734", "C7735", "C7736", "C7737", "C7738", "C7739", "C7740", "C7741", "C7800", "C7801", "C7802", "C7803", "C7804", "C7806", "C7807"] +helpviewer_keywords: ["C7500", "C7501", "C7502", "C7503", "C7504", "C7505", "C7506", "C7507", "C7508", "C7509", "C7511", "C7512", "C7513", "C7514", "C7515", "C7516", "C7517", "C7518", "C7519", "C7520", "C7521", "C7522", "C7523", "C7524", "C7525", "C7526", "C7527", "C7528", "C7529", "C7530", "C7531", "C7532", "C7533", "C7534", "C7535", "C7537", "C7538", "C7539", "C7540", "C7541", "C7542", "C7543", "C7544", "C7545", "C7546", "C7547", "C7548", "C7549", "C7550", "C7551", "C7552", "C7554", "C7555", "C7556", "C7557", "C7558", "C7559", "C7560", "C7561", "C7562", "C7563", "C7564", "C7565", "C7566", "C7567", "C7568", "C7569", "C7570", "C7571", "C7572", "C7573", "C7574", "C7575", "C7576", "C7577", "C7578", "C7579", "C7580", "C7581", "C7582", "C7583", "C7584", "C7585", "C7586", "C7587", "C7588", "C7589", "C7590", "C7591", "C7592", "C7593", "C7594", "C7595", "C7596", "C7597", "C7598", "C7599", "C7600", "C7601", "C7602", "C7603", "C7604", "C7605", "C7606", "C7607", "C7608", "C7609", "C7610", "C7611", "C7612", "C7613", "C7614", "C7615", "C7616", "C7617", "C7618", "C7619", "C7620", "C7621", "C7622", "C7623", "C7624", "C7625", "C7627", "C7628", "C7629", "C7630", "C7631", "C7632", "C7633", "C7634", "C7635", "C7636", "C7637", "C7638", "C7639", "C7640", "C7641", "C7642", "C7643", "C7644", "C7645", "C7646", "C7647", "C7648", "C7649", "C7650", "C7651", "C7652", "C7653", "C7654", "C7655", "C7656", "C7657", "C7658", "C7659", "C7660", "C7661", "C7662", "C7665", "C7666", "C7667", "C7668", "C7669", "C7670", "C7671", "C7672", "C7673", "C7674", "C7675", "C7676", "C7677", "C7678", "C7679", "C7680", "C7682", "C7683", "C7684", "C7685", "C7686", "C7687", "C7689", "C7690", "C7691", "C7692", "C7693", "C7694", "C7695", "C7696", "C7697", "C7698", "C7699", "C7700", "C7701", "C7702", "C7703", "C7704", "C7705", "C7706", "C7707", "C7708", "C7709", "C7710", "C7711", "C7712", "C7713", "C7714", "C7720", "C7730", "C7731", "C7732", "C7733", "C7734", "C7735", "C7736", "C7737", "C7738", "C7739", "C7740", "C7741", "C7800", "C7801", "C7802", "C7803", "C7804", "C7806", "C7807"] --- # Compiler errors C7500 through C7999 @@ -241,6 +241,7 @@ The articles in this section of the documentation explain a subset of the error | Compiler error C7740 | cannot jump to case label | | Compiler error C7741 | ABI inconsistency: '*function*' was originally assumed to use '`C`' return semantics but now it requires '`C++`' return semantics | | [Compiler error C7742](compiler-error-c7742.md) | '*identifier*': a forward declaration of an enum can only use a simple identifier | +| Compiler error C7743 | [`__preserve_none` calling convention](../../cpp/preserve-none.md) is not supported | | Compiler error C7800 | duplicate explicit instantiation definition of '*name*' | | Compiler error C7801 | '*function*': if one declaration of '*identifier*' has the '`[[msvc::disptach]]`' attribute then all functions must have the attribute | | Compiler error C7802 | '*identifier*': a capability must resolve to an enumerator | diff --git a/docs/error-messages/compiler-warnings/c4473.md b/docs/error-messages/compiler-warnings/c4473.md index b10194290b8..5dfe94c2862 100644 --- a/docs/error-messages/compiler-warnings/c4473.md +++ b/docs/error-messages/compiler-warnings/c4473.md @@ -1,7 +1,7 @@ --- -description: "Learn more about: Compiler Warning (level 1) C4473" title: "Compiler Warning C4473" -ms.date: "02/16/2018" +description: "Learn more about: Compiler Warning (level 1) C4473" +ms.date: 02/16/2018 f1_keywords: ["C4473"] helpviewer_keywords: ["C4473"] --- @@ -54,3 +54,7 @@ void scan_func(int a, float f) ``` In this example, **scanf_s** requires two arguments for each placeholder, one to supply the address to write to, and a second to supply the size of the first. Check the documentation for each library function for an explanation of the required arguments. + +## See also + +[C6064](../../code-quality/c6064.md) diff --git a/docs/error-messages/compiler-warnings/compiler-warning-c5072.md b/docs/error-messages/compiler-warnings/compiler-warning-c5072.md index 0ae2c93e6f6..ad186122f61 100644 --- a/docs/error-messages/compiler-warnings/compiler-warning-c5072.md +++ b/docs/error-messages/compiler-warnings/compiler-warning-c5072.md @@ -1,7 +1,7 @@ --- title: "Compiler Warning (level 1) C5072" description: "Learn more about: Compiler Warning (level 1) C5072" -ms.date: 02/09/2024 +ms.date: 09/10/2025 f1_keywords: ["C5072"] helpviewer_keywords: ["C5072"] --- @@ -15,13 +15,17 @@ This warning occurs when you compile with [Address Sanitizer](../../sanitizers/a ## Example -The following command line generates warning `C5072`: +The following command line generates warning C5072: -```cpp - cl /fsanitize=address /EHsc test.cpp +```cmd +cl /fsanitize=address /EHsc test.cpp ``` -To fix it, have the compiler generate debug information by using a switch like [`/Zi`](../../build/reference/z7-zi-zi-debug-information-format.md#zi) or [`/Z7`](../../build/reference/z7-zi-zi-debug-information-format.md#z7), like this: `cl /fsanitize=address /EHsc /Zi test.cpp` +To fix it, have the compiler generate debug information by using a switch like [`/Zi`](../../build/reference/z7-zi-zi-debug-information-format.md#zi) or [`/Z7`](../../build/reference/z7-zi-zi-debug-information-format.md#z7), like this: + +```cmd +cl /fsanitize=address /EHsc /Zi test.cpp +``` ## See also diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4541.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4541.md index ed2547e029a..5b5982d38a6 100644 --- a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4541.md +++ b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4541.md @@ -1,13 +1,43 @@ --- -description: "Learn more about: Compiler Warning (level 1) C4541" title: "Compiler Warning (level 1) C4541" -ms.date: "11/04/2016" +description: "Learn more about: Compiler Warning (level 1) C4541" +ms.date: 08/24/2025 f1_keywords: ["C4541"] helpviewer_keywords: ["C4541"] -ms.assetid: b57b8f3e-117d-4fc2-bba6-faec17e5fa9d --- # Compiler Warning (level 1) C4541 -'identifier' used on polymorphic type 'type' with /GR-; unpredictable behavior may result +> '*operator*' used on polymorphic type '*type*' with /GR-; unpredictable behavior may result + +## Remarks + +You tried to use the [`dynamic_cast` operator](../../cpp/dynamic-cast-operator.md) or [`typeid` operator](../../cpp/typeid-operator.md), which requires [Run-Time Type Information](../../cpp/run-time-type-information.md) (RTTI), without enabling it. To enable RTTI, recompile with [`/GR`](../../build/reference/gr-enable-run-time-type-information.md). + +## Example + +The following example generates C4541: + +```cpp +// C4541.cpp +// compile with: /W1 /GR- + +#include + +struct Base +{ + virtual ~Base() {} +}; + +struct Derived : Base {}; + +int main() +{ + Derived derived; + Base* pointer_to_base = &derived; + + dynamic_cast(pointer_to_base); // C4541 -You tried to use a feature that requires run-time type information without enabling run-time type information. Recompile with [/GR](../../build/reference/gr-enable-run-time-type-information.md). + typeid(*pointer_to_base); // C4541 + typeid(pointer_to_base); // OK +} +``` diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4544.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4544.md index 0ba1ee5249a..d8c3396c024 100644 --- a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4544.md +++ b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4544.md @@ -15,7 +15,7 @@ A default template argument was specified in an incorrect location and was ignor ## Example -This example generates C4545, and the next example shows how to fix it: +This example generates C4544, and the next example shows how to fix it: ```cpp // C4544.cpp diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4789.md b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4789.md index 504b06f47e3..65ff8705ae4 100644 --- a/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4789.md +++ b/docs/error-messages/compiler-warnings/compiler-warning-level-1-c4789.md @@ -32,7 +32,7 @@ Visual C++ might generate this warning for a code path that never executes. You #pragma warning( pop ) ``` -This idiom keeps Visual C++ from generating the warning for that specific block of code. The `#pragma warning(push)` preserves the existing state before `#pragma warning(disable: 4789)` changes it. The `#pragma warning(pop)` restores the pushed state, and removes the effects of the `#pragma warning(disable:4789)`. For more information about the C++ preprocessor directive `#pragma`, see [`warning`](../../preprocessor/warning.md) and [Pragma Directives and the `__Pragma` Keyword](../../preprocessor/pragma-directives-and-the-pragma-keyword.md). +This idiom keeps Visual C++ from generating the warning for that specific block of code. The `#pragma warning(push)` preserves the existing state before `#pragma warning(disable: 4789)` changes it. The `#pragma warning(pop)` restores the pushed state, and removes the effects of the `#pragma warning(disable:4789)`. For more information about the C++ preprocessor directive `#pragma`, see [`warning`](../../preprocessor/warning.md) and [Pragma directives and the `__pragma` and `_Pragma` keywords](../../preprocessor/pragma-directives-and-the-pragma-keyword.md). The [`/sdl` (Enable Additional Security Checks)](../../build/reference/sdl-enable-additional-security-checks.md) compiler option elevates this warning to an error. diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-3-c4580.md b/docs/error-messages/compiler-warnings/compiler-warning-level-3-c4580.md index 479016f20c6..f8d07e1f61a 100644 --- a/docs/error-messages/compiler-warnings/compiler-warning-level-3-c4580.md +++ b/docs/error-messages/compiler-warnings/compiler-warning-level-3-c4580.md @@ -15,7 +15,7 @@ helpviewer_keywords: ["C4580"] ## Example -The following example generates C3454 and shows how to fix it. +The following example generates C4580 and shows how to fix it. ```cpp // C4580.cpp diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4235.md b/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4235.md index b555d0df57e..b1fa9f92226 100644 --- a/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4235.md +++ b/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4235.md @@ -1,7 +1,7 @@ --- -description: "Learn more about: Compiler Warning (level 1, Error) C4235" title: "Compiler Warning (level 1, Error) C4235" -ms.date: "11/04/2016" +description: "Learn more about: Compiler Warning (level 1, Error) C4235" +ms.date: 07/27/2025 f1_keywords: ["C4235"] helpviewer_keywords: ["C4235"] --- @@ -9,6 +9,22 @@ helpviewer_keywords: ["C4235"] > nonstandard extension used: '*keyword*' keyword not supported on this architecture -The compiler doesn't support the keyword you used on the architecture your build is targeting. +## Remarks + +The compiler doesn't support the keyword you used on the architecture your build is targeting. For example, the [`__asm`](../../assembler/inline/asm.md) keyword is not supported in x64 builds. This warning is always issued as an error. Use the [warning](../../preprocessor/warning.md) pragma to disable. + +## Example + +The following example generates C4235 as the [Inline Assembler](../../assembler/inline/inline-assembler.md) is only supported on x86: + +```cpp +// C4235.cpp +// processor: x64 (set compiler environment with vcvars64.bat) + +int main() +{ + __asm nop // C4235 +} +``` diff --git a/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4324.md b/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4324.md index f2f4076e29a..0d36a85e2ca 100644 --- a/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4324.md +++ b/docs/error-messages/compiler-warnings/compiler-warning-level-4-c4324.md @@ -1,27 +1,49 @@ --- -description: "Learn more about: Compiler Warning (level 4) C4324" title: "Compiler Warning (level 4) C4324" -ms.date: "11/04/2016" +description: "Learn more about: Compiler Warning (level 4) C4324" +ms.date: 07/22/2025 f1_keywords: ["C4324"] helpviewer_keywords: ["C4324"] --- # Compiler Warning (level 4) C4324 -> '*structname*': structure was padded due to alignment specifier +> '*type*': structure was padded due to alignment specifier + +## Remarks -Padding was added at the end of a structure because you specified an alignment specifier, such as [__declspec(align)](../../cpp/align-cpp.md). +Padding was added at the end of a class/struct/union because you specified an alignment specifier, such as [`alignas`](../../cpp/alignas-specifier.md) or [`__declspec(align)`](../../cpp/align-cpp.md). -For example, the following code generates C4324: +## Example + +For example, `S1`, `U1`, and `C1` generate C4324 because padding is added when the specified alignment is greater than the natural alignment for each. `S2` doesn't generate a warning because the specified alignment matches the natural alignment: ```cpp // C4324.cpp -// compile with: /W4 -struct __declspec(align(32)) A +// compile with: /W4 /c + +// natural 4 byte alignment +struct alignas(8) S1 // C4324 { - char a; + int i; }; // C4324 -int main() +// natural 4 byte alignment +struct alignas(4) S2 +{ + int i; +}; // OK + +// natural 4 byte alignment +union alignas(16) U1 +{ + int i; + char c; +}; // C4324 + +// natural 4 byte alignment +class alignas(8) C1 { -} +public: + int i = 0; +}; // C4324 ``` diff --git a/docs/error-messages/compiler-warnings/compiler-warnings-by-compiler-version.md b/docs/error-messages/compiler-warnings/compiler-warnings-by-compiler-version.md index f68e772b833..d5706dfc19c 100644 --- a/docs/error-messages/compiler-warnings/compiler-warnings-by-compiler-version.md +++ b/docs/error-messages/compiler-warnings/compiler-warnings-by-compiler-version.md @@ -12,6 +12,7 @@ These versions of the compiler introduced new warnings: | Product | Compiler version number | |--|--| +| Visual Studio 2022 version 17.14 | 19.44 | | Visual Studio 2022 version 17.13 | 19.43 | | Visual Studio 2022 version 17.12 | 19.42 | | Visual Studio 2022 version 17.11 | 19.41 | @@ -63,6 +64,14 @@ The following sections list the warnings introduced by each version of Visual C+ ::: moniker range=">= msvc-170" +## Warnings introduced in Visual Studio 2022 version 17.14 (compiler version 19.44) + +These warnings, and all warnings in later versions, are suppressed by using the compiler option **`/Wv:19.43`**. + +| Warning | Message | +|--|--| +| C4862 | justification property is not allowed with more than one warning number | + ## Warnings introduced in Visual Studio 2022 version 17.13 (compiler version 19.43) These warnings, and all warnings in later versions, are suppressed by using the compiler option **`/Wv:19.42`**. diff --git a/docs/error-messages/compiler-warnings/compiler-warnings-c4200-through-c4399.md b/docs/error-messages/compiler-warnings/compiler-warnings-c4200-through-c4399.md index 03ae1478d6a..e91e5e89600 100644 --- a/docs/error-messages/compiler-warnings/compiler-warnings-c4200-through-c4399.md +++ b/docs/error-messages/compiler-warnings/compiler-warnings-c4200-through-c4399.md @@ -113,7 +113,7 @@ The articles in this section describe Microsoft C/C++ compiler warning messages |Compiler warning (level 1) C4321|automatically generating an IID for interface '*interface*'| |Compiler warning (level 1) C4322|automatically generating a CLSID for class '*class*'| |Compiler warning (level 1) C4323|re-using registered CLSID for class '*class*'| -|[Compiler warning (level 4) C4324](compiler-warning-level-4-c4324.md)|'*structname*': structure was padded due to alignment specifier| +|[Compiler warning (level 4) C4324](compiler-warning-level-4-c4324.md)|'*type*': structure was padded due to alignment specifier| |[Compiler warning (level 1) C4325](compiler-warning-level-1-c4325.md)|attributes for standard section '*section*' ignored| |[Compiler warning (level 1) C4326](compiler-warning-level-1-c4326.md)|return type of '*function*' should be '*type1*' instead of '*type2*'| |Compiler warning C4327|'*assignment*': indirection alignment of LHS ('*alignment1*') is greater than RHS ('*alignment2*')| diff --git a/docs/error-messages/compiler-warnings/compiler-warnings-c4400-through-c4599.md b/docs/error-messages/compiler-warnings/compiler-warnings-c4400-through-c4599.md index 03b421b60ea..e0ce42c2539 100644 --- a/docs/error-messages/compiler-warnings/compiler-warnings-c4400-through-c4599.md +++ b/docs/error-messages/compiler-warnings/compiler-warnings-c4400-through-c4599.md @@ -1,7 +1,7 @@ --- title: "Microsoft C/C++ compiler (MSVC) warnings C4400 through C4599" description: "Table of Microsoft C/C++ compiler (MSVC) warnings C4400 through C4599" -ms.date: "1/22/2025" +ms.date: 1/22/2025 f1_keywords: ["C4413", "C4415", "C4416", "C4417", "C4418", "C4419", "C4421", "C4423", "C4424", "C4425", "C4426", "C4427", "C4438", "C4442", "C4443", "C4444", "C4446", "C4447", "C4448", "C4449", "C4450", "C4451", "C4452", "C4453", "C4454", "C4455", "C4466", "C4467", "C4468", "C4472", "C4474", "C4475", "C4476", "C4478", "C4480", "C4482", "C4483", "C4491", "C4492", "C4493", "C4494", "C4495", "C4496", "C4497", "C4498", "C4499", "C4509", "C4519", "C4531", "C4542", "C4562", "C4568", "C4569", "C4573", "C4574", "C4575", "C4576", "C4578", "C4582", "C4583", "C4585", "C4586", "C4587", "C4588", "C4589", "C4591", "C4592", "C4593", "C4594", "C4595", "C4598", "C4599"] helpviewer_keywords: ["C4413", "C4415", "C4416", "C4417", "C4418", "C4419", "C4421", "C4423", "C4424", "C4425", "C4426", "C4427", "C4438", "C4442", "C4443", "C4444", "C4446", "C4447", "C4448", "C4449", "C4450", "C4451", "C4452", "C4453", "C4454", "C4455", "C4466", "C4467", "C4468", "C4472", "C4474", "C4475", "C4476", "C4478", "C4480", "C4482", "C4483", "C4491", "C4492", "C4493", "C4494", "C4495", "C4496", "C4497", "C4498", "C4499", "C4509", "C4519", "C4531", "C4542", "C4562", "C4568", "C4569", "C4573", "C4574", "C4575", "C4576", "C4578", "C4582", "C4583", "C4585", "C4586", "C4587", "C4588", "C4589", "C4591", "C4592", "C4593", "C4594", "C4595", "C4598", "C4599"] --- @@ -139,7 +139,7 @@ The articles in this section describe Microsoft C/C++ compiler warning messages |[Compiler warning (level 1) C4537](compiler-warning-level-1-c4537.md)|'*object*': '`.`' applied to non-UDT type| |[Compiler warning (level 3) C4538](compiler-warning-level-3-c4538.md)|'*type*': `const`/`volatile` qualifiers on this type are not supported| |[Compiler warning (level 1) C4540](compiler-warning-level-1-c4540.md)|`dynamic_cast` used to convert to inaccessible or ambiguous base; run-time test will fail ('*type1*' to '*type2*')| -|[Compiler warning (level 1) C4541](compiler-warning-level-1-c4541.md)|'*identifier*' used on polymorphic type '*type*' with `/GR-`; unpredictable behavior may result| +|[Compiler warning (level 1) C4541](compiler-warning-level-1-c4541.md)|'*operator*' used on polymorphic type '*type*' with /GR-; unpredictable behavior may result| |Compiler warning (level 1) C4542|Skipping generation of merged injected text file, cannot write *filetype* file: '*issue*': *message*| |[Compiler warning (level 3) C4543](compiler-warning-level-3-c4543.md)|Injected text suppressed by attribute '`no_injected_text`'| |[Compiler warning (level 1) C4544](compiler-warning-level-1-c4544.md)|the default template argument for '*declaration*' is ignored on this template declaration| diff --git a/docs/error-messages/compiler-warnings/compiler-warnings-c4600-through-c4799.md b/docs/error-messages/compiler-warnings/compiler-warnings-c4600-through-c4799.md index 073da826414..26ff337deb2 100644 --- a/docs/error-messages/compiler-warnings/compiler-warnings-c4600-through-c4799.md +++ b/docs/error-messages/compiler-warnings/compiler-warnings-c4600-through-c4799.md @@ -134,6 +134,7 @@ The articles in this section describe Microsoft C/C++ compiler warning messages |Compiler warning C4734|More than 64k line numbers in a COFF debug info section; stop emitting COFF debug line numbers for module 'module'| |Compiler warning C4735|`align_function` attribute argument '*argument*' is not a power of two and is not positive. Ignoring attribute| |Compiler warning C4736|`align_function` attribute ignored because `/Gy` was not specified| +|Compiler warning C4737| Unable to perform required tail call. Performance may be degraded. See [`[[msvc::musttail]]`](../../cpp/attributes.md#msvcmusttail)| |[Compiler warning (Level 3) C4738](compiler-warning-level-3-c4738.md)|storing 32-bit float result in memory, possible loss of performance| |[Compiler warning (level 1) C4739](compiler-warning-level-1-c4739.md)|reference to variable 'var' exceeds its storage space| |[Compiler warning (Level 4) C4740](compiler-warning-level-4-c4740.md)|flow in or out of inline asm code suppresses global optimization| @@ -175,4 +176,4 @@ The articles in this section describe Microsoft C/C++ compiler warning messages ## See also [C/C++ Compiler and build tools errors and warnings](../compiler-errors-1/c-cpp-build-errors.md)\ -[Compiler warnings C4000 - C5999](compiler-warnings-c4000-c5999.md) \ No newline at end of file +[Compiler warnings C4000 - C5999](compiler-warnings-c4000-c5999.md) diff --git a/docs/error-messages/compiler-warnings/compiler-warnings-c4800-through-c4999.md b/docs/error-messages/compiler-warnings/compiler-warnings-c4800-through-c4999.md index 604fdbc580c..3ac4f3718a5 100644 --- a/docs/error-messages/compiler-warnings/compiler-warnings-c4800-through-c4999.md +++ b/docs/error-messages/compiler-warnings/compiler-warnings-c4800-through-c4999.md @@ -2,8 +2,8 @@ title: "Microsoft C/C++ compiler (MSVC) warnings C4800 through C4999" description: "Table of Microsoft C/C++ compiler (MSVC) warnings C4800 through C4999." ms.date: 04/17/2024 -f1_keywords: ["C4801", "C4808", "C4809", "C4815", "C4826", "C4827", "C4828", "C4837", "C4842", "C4844", "C4845", "C4846", "C4847", "C4848", "C4849", "C4854", "C4855", "C4856", "C4857", "C4858", "C4859", "C4860", "C4861", "C4869", "C4872", "C4880", "C4881", "C4882", "C4883", "C4907", "C4916", "C4921", "C4934", "C4954", "C4955", "C4963", "C4966", "C4970", "C4971", "C4973", "C4974", "C4975", "C4976", "C4981", "C4983", "C4987", "C4988", "C4989", "C4990", "C4991", "C4992", "C4998"] -helpviewer_keywords: ["C4801", "C4808", "C4809", "C4815", "C4826", "C4827", "C4828", "C4837", "C4842", "C4844", "C4845", "C4846", "C4847", "C4848", "C4849", "C4854", "C4855", "C4856", "C4857", "C4858", "C4859", "C4860", "C4861", "C4869", "C4872", "C4880", "C4881", "C4882", "C4883", "C4907", "C4916", "C4921", "C4934", "C4954", "C4955", "C4963", "C4966", "C4970", "C4971", "C4973", "C4974", "C4975", "C4976", "C4981", "C4983", "C4987", "C4988", "C4989", "C4990", "C4991", "C4992", "C4998"] +f1_keywords: ["C4801", "C4808", "C4809", "C4815", "C4826", "C4827", "C4828", "C4837", "C4842", "C4844", "C4845", "C4846", "C4847", "C4848", "C4849", "C4854", "C4855", "C4856", "C4857", "C4858", "C4859", "C4860", "C4861", "C4862", "C4869", "C4872", "C4880", "C4881", "C4882", "C4883", "C4907", "C4916", "C4921", "C4934", "C4954", "C4955", "C4963", "C4966", "C4970", "C4971", "C4973", "C4974", "C4975", "C4976", "C4981", "C4983", "C4987", "C4988", "C4989", "C4990", "C4991", "C4992", "C4998"] +helpviewer_keywords: ["C4801", "C4808", "C4809", "C4815", "C4826", "C4827", "C4828", "C4837", "C4842", "C4844", "C4845", "C4846", "C4847", "C4848", "C4849", "C4854", "C4855", "C4856", "C4857", "C4858", "C4859", "C4860", "C4861", "C4862", "C4869", "C4872", "C4880", "C4881", "C4882", "C4883", "C4907", "C4916", "C4921", "C4934", "C4954", "C4955", "C4963", "C4966", "C4970", "C4971", "C4973", "C4974", "C4975", "C4976", "C4981", "C4983", "C4987", "C4988", "C4989", "C4990", "C4991", "C4992", "C4998"] --- # Microsoft C/C++ compiler warnings C4800 through C4999 @@ -63,6 +63,7 @@ The articles in this section describe Microsoft C/C++ compiler warning messages | Compiler warning (level 4) C4859 | '*value*' is not a valid argument for '`/presetWarn`': it must be a decimal value > 0. Command-line flag ignored | | Compiler warning (level 4) C4860 | '*object name*': compiler zero initialized '*number*' bytes of storage | | Compiler warning (level 4) C4861 | compiler zero initialized '*number*' bytes of storage | +| Compiler warning (level 1) C4862 | justification property is not allowed with more than one warning number | | [Compiler warning (level 4) C4866](c4866.md) | compiler may not enforce left-to-right evaluation order for call to *operator_name* | | [Compiler warning (level 1, error) C4867](compiler-warning-c4867.md) |'*function name*': non-standard syntax; use '`&`' to create a pointer to member| | [Compiler warning (level 4) C4868](compiler-warning-c4868.md) | '*file*(*line_number*)' compiler may not enforce left-to-right evaluation order in braced initialization list | diff --git a/docs/error-messages/compiler-warnings/compiler-warnings-c5200-through-c5399.md b/docs/error-messages/compiler-warnings/compiler-warnings-c5200-through-c5399.md index 1b66790fb1e..0bebc97caa6 100644 --- a/docs/error-messages/compiler-warnings/compiler-warnings-c5200-through-c5399.md +++ b/docs/error-messages/compiler-warnings/compiler-warnings-c5200-through-c5399.md @@ -2,8 +2,8 @@ title: "Microsoft C/C++ compiler (MSVC) compiler warnings C5200 through C5399" description: "Table of Microsoft C/C++ compiler (MSVC) warnings C5200 through C5399." ms.date: 04/19/2024 -f1_keywords: ["C5200", "C5201", "C5202", "C5203", "C5204", "C5205", "C5206", "C5207", "C5209", "C5210", "C5212", "C5213", "C5214", "C5215", "C5216", "C5217", "C5218", "C5219", "C5220", "C5221", "C5222", "C5223", "C5224", "C5225", "C5226", "C5227", "C5228", "C5229", "C5230", "C5231", "C5232", "C5233", "C5234", "C5235", "C5236", "C5237", "C5238", "C5239", "C5241", "C5242", "C5244", "C5245", "C5246", "C5249", "C5250", "C5251", "C5252", "C5253", "C5254", "C5255", "C5256", "C5257", "C5258", "C5259", "C5260", "C5261", "C5263", "C5264", "C5265", "C5268", "C5269", "C5270", "C5271", "C5272", "C5273", "C5274", "C5275", "C5300", "C5303", "C5304", "C5305"] -helpviewer_keywords: ["C5200", "C5201", "C5202", "C5203", "C5204", "C5205", "C5206", "C5207", "C5209", "C5210", "C5212", "C5213", "C5214", "C5215", "C5216", "C5217", "C5218", "C5219", "C5220", "C5221", "C5222", "C5223", "C5224", "C5225", "C5226", "C5227", "C5228", "C5229", "C5230", "C5231", "C5232", "C5233", "C5234", "C5235", "C5236", "C5237", "C5238", "C5239", "C5241", "C5242", "C5244", "C5245", "C5246", "C5249", "C5250", "C5251", "C5252", "C5253", "C5254", "C5255", "C5256", "C5257", "C5258", "C5259", "C5260", "C5261", "C5263", "C5264", "C5265", "C5268", "C5269", "C5270", "C5271", "C5272", "C5273", "C5274", "C5275", "C5300", "C5303", "C5304", "C5305"] +f1_keywords: ["C5200", "C5201", "C5202", "C5203", "C5204", "C5205", "C5206", "C5207", "C5209", "C5210", "C5212", "C5213", "C5214", "C5215", "C5216", "C5217", "C5218", "C5219", "C5220", "C5221", "C5222", "C5223", "C5224", "C5225", "C5226", "C5227", "C5228", "C5229", "C5230", "C5231", "C5232", "C5233", "C5234", "C5235", "C5236", "C5237", "C5238", "C5239", "C5241", "C5242", "C5244", "C5245", "C5246", "C5249", "C5250", "C5251", "C5252", "C5253", "C5254", "C5255", "C5256", "C5257", "C5258", "C5259", "C5260", "C5261", "C5263", "C5264", "C5265", "C5268", "C5269", "C5270", "C5271", "C5272", "C5273", "C5274", "C5275", "C5276", "C5277", "C5278", "C5279", "C5280", "C5281", "C5282", "C5283", "C5284", "C5285", "C5286", "C5287", "C5300", "C5303", "C5304", "C5305", "C5306", "C5307", "C5308", "C5309"] +helpviewer_keywords: ["C5200", "C5201", "C5202", "C5203", "C5204", "C5205", "C5206", "C5207", "C5209", "C5210", "C5212", "C5213", "C5214", "C5215", "C5216", "C5217", "C5218", "C5219", "C5220", "C5221", "C5222", "C5223", "C5224", "C5225", "C5226", "C5227", "C5228", "C5229", "C5230", "C5231", "C5232", "C5233", "C5234", "C5235", "C5236", "C5237", "C5238", "C5239", "C5241", "C5242", "C5244", "C5245", "C5246", "C5249", "C5250", "C5251", "C5252", "C5253", "C5254", "C5255", "C5256", "C5257", "C5258", "C5259", "C5260", "C5261", "C5263", "C5264", "C5265", "C5268", "C5269", "C5270", "C5271", "C5272", "C5273", "C5274", "C5275", "C5276", "C5277", "C5278", "C5279", "C5280", "C5281", "C5282", "C5283", "C5284", "C5285", "C5286", "C5287", "C5300", "C5303", "C5304", "C5305", "C5306", "C5307", "C5308", "C5309"] --- # Microsoft C/C++ compiler warnings C5200 through C5399 diff --git a/docs/error-messages/toc.yml b/docs/error-messages/toc.yml index acb65fcdd54..fe34e4d9634 100644 --- a/docs/error-messages/toc.yml +++ b/docs/error-messages/toc.yml @@ -136,6 +136,8 @@ items: href: compiler-errors-1/fatal-error-c1025-c1115.md - name: Fatal error C1026 href: compiler-errors-1/fatal-error-c1026.md + - name: Fatal error C1029 + href: compiler-errors-1/fatal-error-c1029.md - name: Fatal error C1033 href: compiler-errors-1/fatal-error-c1033.md - name: Fatal error C1035 diff --git a/docs/error-messages/tool-errors/c-runtime-errors-r6002-through-r6035.md b/docs/error-messages/tool-errors/c-runtime-errors-r6002-through-r6035.md index cbac9569743..8eac48f7d14 100644 --- a/docs/error-messages/tool-errors/c-runtime-errors-r6002-through-r6035.md +++ b/docs/error-messages/tool-errors/c-runtime-errors-r6002-through-r6035.md @@ -23,6 +23,8 @@ The C Runtime library (CRT) may report a runtime error when your app is loaded o | [C Runtime Error R6019](c-runtime-error-r6019.md) | unable to open console device | | [C Runtime Error R6024](c-runtime-error-r6024.md) | not enough space for _onexit/atexit table | | [C Runtime Error R6025](c-runtime-error-r6025.md) | pure virtual function call | +| [C Runtime Error R6026](c-runtime-error-r6026.md) | not enough space for stdio initialization | +| [C Runtime Error R6027](c-runtime-error-r6027.md) | not enough space for lowio initialization | | [C Runtime Error R6028](c-runtime-error-r6028.md) | unable to initialize heap | | [C Runtime Error R6030](c-runtime-error-r6030.md) | CRT not initialized | | [C Runtime Error R6031](c-runtime-error-r6031.md) | Attempt to initialize the CRT more than once. This indicates a bug in your application. | diff --git a/docs/error-messages/tool-errors/command-line-errors-d8000-through-d9999.md b/docs/error-messages/tool-errors/command-line-errors-d8000-through-d9999.md index af66c940222..14a992e335f 100644 --- a/docs/error-messages/tool-errors/command-line-errors-d8000-through-d9999.md +++ b/docs/error-messages/tool-errors/command-line-errors-d8000-through-d9999.md @@ -27,7 +27,8 @@ The articles in this section provide a reference to the command-line errors and | Warning | Message | |--|--| -| [Command-Line Warning D9024](command-line-warning-d9024.md) | unrecognized source file type 'filename', object file assumed | +| Command-Line Warning D9014 | invalid value for 'processMax'. The compiler ignores the invalid value and assumes a value of 1.| +| [Command-Line Warning D9024](command-line-warning-d9024.md) | unrecognized source file type 'filename', object file assumed. Occurs when a command‑line argument looks like a filename but doesn’t match a recognized source or object file extension. The compiler assumes it's an object file and passes it to the linker. | | [Command-Line Warning D9025](command-line-warning-d9025.md) | overriding 'option1' with 'option2' | | [Command-Line Warning D9026](command-line-warning-d9026.md) | options apply to entire command line | | [Command-Line Warning D9027](command-line-warning-d9027.md) | source file '\' ignored | diff --git a/docs/error-messages/tool-errors/command-line-warning-d9043.md b/docs/error-messages/tool-errors/command-line-warning-d9043.md index 73931bcab16..099489e25ac 100644 --- a/docs/error-messages/tool-errors/command-line-warning-d9043.md +++ b/docs/error-messages/tool-errors/command-line-warning-d9043.md @@ -11,7 +11,7 @@ helpviewer_keywords: ["D9043"] ## Example -The following example generates C9043. +The following example generates D9043. ```cpp // D9043.cpp diff --git a/docs/error-messages/tool-errors/expression-evaluator-errors-cxx0000-through-cxx0072.md b/docs/error-messages/tool-errors/expression-evaluator-errors-cxx0000-through-cxx0072.md index 3347b385f8a..a35f769cf05 100644 --- a/docs/error-messages/tool-errors/expression-evaluator-errors-cxx0000-through-cxx0072.md +++ b/docs/error-messages/tool-errors/expression-evaluator-errors-cxx0000-through-cxx0072.md @@ -1,84 +1,85 @@ --- -description: "Learn more about: Expression evaluator errors (CXXxxxx)" title: "Expression evaluator errors" -ms.date: "04/16/2019" -ms.assetid: a47a9866-7fb2-4b21-978c-2b77402c7105 +description: "Learn more about: Expression evaluator errors (CXXxxxx)" +ms.date: 04/16/2019 --- # Expression evaluator errors (CXXxxxx) This section is a reference to the errors generated by the debugger and diagnostics tools. These tools generate errors of the form CXX*xxxx* or CAN*xxxx*, where *xxxx* is a four-digit number. -[!INCLUDE[error-boilerplate](../../error-messages/includes/error-boilerplate.md)] +[!INCLUDE[error-boilerplate](../includes/error-boilerplate.md)] ## Expression evaluator error messages -[Expression evaluator error CXX0000](expression-evaluator-error-cxx0000.md) \ -[Expression evaluator error CXX0001](expression-evaluator-error-cxx0001.md) \ -[Expression evaluator error CXX0002](expression-evaluator-error-cxx0002.md) \ -[Expression evaluator error CXX0004](expression-evaluator-error-cxx0004.md) \ -[Expression evaluator error CXX0005](expression-evaluator-error-cxx0005.md) \ -[Expression evaluator error CXX0006](expression-evaluator-error-cxx0006.md) \ -[Expression evaluator error CXX0007](expression-evaluator-error-cxx0007.md) \ -[Expression evaluator error CXX0008](expression-evaluator-error-cxx0008.md) \ -[Expression evaluator error CXX0009](expression-evaluator-error-cxx0009.md) \ -[Expression evaluator error CXX0010](expression-evaluator-error-cxx0010.md) \ -[Expression evaluator error CXX0011](expression-evaluator-error-cxx0011.md) \ -[Expression evaluator error CXX0012](expression-evaluator-error-cxx0012.md) \ -[Expression evaluator error CXX0013](expression-evaluator-error-cxx0013.md) \ -[Expression evaluator error CXX0014](expression-evaluator-error-cxx0014.md) \ -[Expression evaluator error CXX0015](expression-evaluator-error-cxx0015.md) \ -[Expression evaluator error CXX0016](expression-evaluator-error-cxx0016.md) \ -[Expression evaluator error CXX0017](expression-evaluator-error-cxx0017.md) \ -[Expression evaluator error CXX0018](expression-evaluator-error-cxx0018.md) \ -[Expression evaluator error CXX0019](expression-evaluator-error-cxx0019.md) \ -[Expression evaluator error CXX0020](expression-evaluator-error-cxx0020.md) \ -[Expression evaluator error CXX0021](expression-evaluator-error-cxx0021.md) \ -[Expression evaluator error CXX0022](expression-evaluator-error-cxx0022.md) \ -[Expression evaluator error CXX0023](expression-evaluator-error-cxx0023.md) \ -[Expression evaluator error CXX0024](expression-evaluator-error-cxx0024.md) \ -[Expression evaluator error CXX0025](expression-evaluator-error-cxx0025.md) \ -[Expression evaluator error CXX0026](expression-evaluator-error-cxx0026.md) \ -[Expression evaluator error CXX0027](expression-evaluator-error-cxx0027.md) \ -[Expression evaluator error CXX0028](expression-evaluator-error-cxx0028.md) \ -[Expression evaluator error CXX0029](expression-evaluator-error-cxx0029.md) \ -[Expression evaluator error CXX0030](expression-evaluator-error-cxx0030.md) \ -[Expression evaluator error CXX0031](expression-evaluator-error-cxx0031.md) \ -[Expression evaluator error CXX0032](expression-evaluator-error-cxx0032.md) \ -[Expression evaluator error CXX0033](expression-evaluator-error-cxx0033.md) \ -[Expression evaluator error CXX0034](expression-evaluator-error-cxx0034.md) \ -[Expression evaluator error CXX0036](expression-evaluator-error-cxx0036.md) \ -[Expression evaluator error CXX0037](expression-evaluator-error-cxx0037.md) \ -[Expression evaluator error CXX0038](expression-evaluator-error-cxx0038.md) \ -[Expression evaluator error CXX0039](expression-evaluator-error-cxx0039.md) \ -[Expression evaluator error CXX0040](expression-evaluator-error-cxx0040.md) \ -[Expression evaluator error CXX0041](expression-evaluator-error-cxx0041.md) \ -[Expression evaluator error CXX0043](expression-evaluator-error-cxx0043.md) \ -[Expression evaluator error CXX0044](expression-evaluator-error-cxx0044.md) \ -[Expression evaluator error CXX0045](expression-evaluator-error-cxx0045.md) \ -[Expression evaluator error CXX0046](expression-evaluator-error-cxx0046.md) \ -[Expression evaluator error CXX0047](expression-evaluator-error-cxx0047.md) \ -[Expression evaluator error CXX0048](expression-evaluator-error-cxx0048.md) \ -[Expression evaluator error CXX0049](expression-evaluator-error-cxx0049.md) \ -[Expression evaluator error CXX0050](expression-evaluator-error-cxx0050.md) \ -[Expression evaluator error CXX0051](expression-evaluator-error-cxx0051.md) \ -[Expression evaluator error CXX0052](expression-evaluator-error-cxx0052.md) \ -[Expression evaluator error CXX0053](expression-evaluator-error-cxx0053.md) \ -[Expression evaluator error CXX0054](expression-evaluator-error-cxx0054.md) \ -[Expression evaluator error CXX0055](expression-evaluator-error-cxx0055.md) \ -[Expression evaluator error CXX0056](expression-evaluator-error-cxx0056.md) \ -[Expression evaluator error CXX0057](expression-evaluator-error-cxx0057.md) \ -[Expression evaluator error CXX0058](expression-evaluator-error-cxx0058.md) \ -[Expression evaluator error CXX0059](expression-evaluator-error-cxx0059.md) \ -[Expression evaluator error CXX0060](expression-evaluator-error-cxx0060.md) \ -[Expression evaluator error CXX0061](expression-evaluator-error-cxx0061.md) \ -[Expression evaluator error CXX0062](expression-evaluator-error-cxx0062.md) \ -[Expression evaluator error CXX0063](expression-evaluator-error-cxx0063.md) \ -[Expression evaluator error CXX0064](expression-evaluator-error-cxx0064.md) \ -[Expression evaluator error CXX0065](expression-evaluator-error-cxx0065.md) \ -[Expression evaluator error CXX0066](expression-evaluator-error-cxx0066.md) \ -[Expression evaluator error CXX0067](expression-evaluator-error-cxx0067.md) \ -[Expression evaluator error CXX0069](expression-evaluator-error-cxx0069.md) \ -[Expression evaluator error CXX0072](expression-evaluator-error-cxx0072.md) +| Error | Message | +|--|--| +| [Expression evaluator error CXX0000](expression-evaluator-error-cxx0000.md) | no error condition | +| [Expression evaluator error CXX0001](expression-evaluator-error-cxx0001.md) | exception executing user function | +| [Expression evaluator error CXX0002](expression-evaluator-error-cxx0002.md) | error accessing user memory | +| [Expression evaluator error CXX0004](expression-evaluator-error-cxx0004.md) | syntax error | +| [Expression evaluator error CXX0005](expression-evaluator-error-cxx0005.md) | operator not supported | +| [Expression evaluator error CXX0006](expression-evaluator-error-cxx0006.md) | missing left parenthesis | +| [Expression evaluator error CXX0007](expression-evaluator-error-cxx0007.md) | missing right parenthesis | +| [Expression evaluator error CXX0008](expression-evaluator-error-cxx0008.md) | missing " at end of string | +| [Expression evaluator error CXX0009](expression-evaluator-error-cxx0009.md) | missing ' after character constant | +| [Expression evaluator error CXX0010](expression-evaluator-error-cxx0010.md) | missing left bracket | +| [Expression evaluator error CXX0011](expression-evaluator-error-cxx0011.md) | missing right bracket | +| [Expression evaluator error CXX0012](expression-evaluator-error-cxx0012.md) | missing left curly brace | +| [Expression evaluator error CXX0013](expression-evaluator-error-cxx0013.md) | missing operator | +| [Expression evaluator error CXX0014](expression-evaluator-error-cxx0014.md) | missing operand | +| [Expression evaluator error CXX0015](expression-evaluator-error-cxx0015.md) | expression too complex (stack overflow) | +| [Expression evaluator error CXX0016](expression-evaluator-error-cxx0016.md) | constant too big | +| [Expression evaluator error CXX0017](expression-evaluator-error-cxx0017.md) | symbol not found | +| [Expression evaluator error CXX0018](expression-evaluator-error-cxx0018.md) | bad register name | +| [Expression evaluator error CXX0019](expression-evaluator-error-cxx0019.md) | bad type cast | +| [Expression evaluator error CXX0020](expression-evaluator-error-cxx0020.md) | operand types bad for this operation | +| [Expression evaluator error CXX0021](expression-evaluator-error-cxx0021.md) | struct or union used as scalar | +| [Expression evaluator error CXX0022](expression-evaluator-error-cxx0022.md) | function call before _main | +| [Expression evaluator error CXX0023](expression-evaluator-error-cxx0023.md) | bad radix | +| [Expression evaluator error CXX0024](expression-evaluator-error-cxx0024.md) | operation needs l-value | +| [Expression evaluator error CXX0025](expression-evaluator-error-cxx0025.md) | operator needs struct/union | +| [Expression evaluator error CXX0026](expression-evaluator-error-cxx0026.md) | bad format string | +| [Expression evaluator error CXX0027](expression-evaluator-error-cxx0027.md) | tp addr not l-value | +| [Expression evaluator error CXX0028](expression-evaluator-error-cxx0028.md) | not struct/union element | +| [Expression evaluator error CXX0029](expression-evaluator-error-cxx0029.md) | not struct pointer | +| [Expression evaluator error CXX0030](expression-evaluator-error-cxx0030.md) | expression not evaluatable | +| [Expression evaluator error CXX0031](expression-evaluator-error-cxx0031.md) | expression not expandable | +| [Expression evaluator error CXX0032](expression-evaluator-error-cxx0032.md) | divide by 0 | +| [Expression evaluator error CXX0033](expression-evaluator-error-cxx0033.md) | error in OMF type information | +| [Expression evaluator error CXX0034](expression-evaluator-error-cxx0034.md) | types incompatible with operator | +| [Expression evaluator error CXX0036](expression-evaluator-error-cxx0036.md) | bad context {...} specification | +| [Expression evaluator error CXX0037](expression-evaluator-error-cxx0037.md) | out of memory | +| [Expression evaluator error CXX0038](expression-evaluator-error-cxx0038.md) | function argument count and/or type mismatch | +| [Expression evaluator error CXX0039](expression-evaluator-error-cxx0039.md) | symbol is ambiguous | +| [Expression evaluator error CXX0040](expression-evaluator-error-cxx0040.md) | function requires implicit conversion | +| [Expression evaluator error CXX0041](expression-evaluator-error-cxx0041.md) | class element must be static member or member function | +| [Expression evaluator error CXX0043](expression-evaluator-error-cxx0043.md) | this pointer used outside member function | +| [Expression evaluator error CXX0044](expression-evaluator-error-cxx0044.md) | use of _based(void) pointer requires :> operator | +| [Expression evaluator error CXX0045](expression-evaluator-error-cxx0045.md) | not a function | +| [Expression evaluator error CXX0046](expression-evaluator-error-cxx0046.md) | argument list required for member function | +| [Expression evaluator error CXX0047](expression-evaluator-error-cxx0047.md) | argument list does not match a function | +| [Expression evaluator error CXX0048](expression-evaluator-error-cxx0048.md) | calling sequence not supported | +| [Expression evaluator error CXX0049](expression-evaluator-error-cxx0049.md) | obsolete OMF - please relink program | +| [Expression evaluator error CXX0050](expression-evaluator-error-cxx0050.md) | left side of :: must be class/struct/union | +| [Expression evaluator error CXX0051](expression-evaluator-error-cxx0051.md) | more than one overloaded symbol specified in breakpoint | +| [Expression evaluator error CXX0052](expression-evaluator-error-cxx0052.md) | member function not present | +| [Expression evaluator error CXX0053](expression-evaluator-error-cxx0053.md) | nonfunction symbol match while binding breakpoints | +| [Expression evaluator error CXX0054](expression-evaluator-error-cxx0054.md) | register in breakpoint expression illegal | +| [Expression evaluator error CXX0055](expression-evaluator-error-cxx0055.md) | ambiguous symbol in context operator | +| [Expression evaluator error CXX0056](expression-evaluator-error-cxx0056.md) | error in line number | +| [Expression evaluator error CXX0057](expression-evaluator-error-cxx0057.md) | no code at line number | +| [Expression evaluator error CXX0058](expression-evaluator-error-cxx0058.md) | overloaded operator not found | +| [Expression evaluator error CXX0059](expression-evaluator-error-cxx0059.md) | left operand is class not a function name | +| [Expression evaluator error CXX0060](expression-evaluator-error-cxx0060.md) | register is not available | +| [Expression evaluator error CXX0061](expression-evaluator-error-cxx0061.md) | function nesting depth exceeded | +| [Expression evaluator error CXX0062](expression-evaluator-error-cxx0062.md) | constructor calls not supported | +| [Expression evaluator error CXX0063](expression-evaluator-error-cxx0063.md) | overloaded operator -> not supported | +| [Expression evaluator error CXX0064](expression-evaluator-error-cxx0064.md) | can't set breakpoint on bound virtual member function | +| [Expression evaluator error CXX0065](expression-evaluator-error-cxx0065.md) | variable needs stack frame | +| [Expression evaluator error CXX0066](expression-evaluator-error-cxx0066.md) | static member not present | +| [Expression evaluator error CXX0067](expression-evaluator-error-cxx0067.md) | function evaluation not supported | +| [Expression evaluator error CXX0069](expression-evaluator-error-cxx0069.md) | variable needs stack frame | +| [Expression evaluator error CXX0072](expression-evaluator-error-cxx0072.md) | Error: type information missing or unknown | ## See also diff --git a/docs/error-messages/tool-errors/linker-tools-error-lnk1140.md b/docs/error-messages/tool-errors/linker-tools-error-lnk1140.md index 32776a589dc..28bd6c168d8 100644 --- a/docs/error-messages/tool-errors/linker-tools-error-lnk1140.md +++ b/docs/error-messages/tool-errors/linker-tools-error-lnk1140.md @@ -11,12 +11,13 @@ helpviewer_keywords: ["LNK1140"] ## Remarks -The project contains more than 4096 modules. +The project exceeds the maximum number of modules allowed in a program database (PDB) file. This limit was originally 4,096 modules and was later increased to 65,533. + +This error can also occur when other PDB size limits are exceeded, such as too many symbols or an excessive number of types. ### To fix by using the following possible solutions 1. Relink using [/PDB:NONE](../../build/reference/pdb-use-program-database.md). - 1. Compile some modules without debugging information. - 1. Reduce the number of modules. +1. Split your project into multiple smaller libraries or DLLs. diff --git a/docs/error-messages/tool-errors/name-decoration.md b/docs/error-messages/tool-errors/name-decoration.md index b6f77174881..2a4b3e4f6cf 100644 --- a/docs/error-messages/tool-errors/name-decoration.md +++ b/docs/error-messages/tool-errors/name-decoration.md @@ -19,6 +19,7 @@ The following table shows the linker name for various calling conventions. |Fast call naming convention (**`__fastcall`**)|`@test@0`|`?test@@YIXXZ`| |Standard call naming convention (**`__stdcall`**)|`_test@0`|`?test@@YGXXZ`| |Vector call naming convention (**`__vectorcall`**)|`test@@0`|`?test@@YQXXZ`| +|Preserve None naming convention (**`__preserve_none`**)|`test@@_A`|`NA`| Use `extern "C"` to call a C function from C++. `extern "C"` forces use of the C naming convention for non-class C++ functions. Be aware of compiler switches **/Tc** or **/Tp**, which tell the compiler to ignore the filename extension and compile the file as C or C++, respectively. These options may cause linker names you don't expect. diff --git a/docs/error-messages/tool-errors/resource-compiler-errors-rc1000-through-rc4413.md b/docs/error-messages/tool-errors/resource-compiler-errors-rc1000-through-rc4413.md index bc1f2f17fe6..74e0908987d 100644 --- a/docs/error-messages/tool-errors/resource-compiler-errors-rc1000-through-rc4413.md +++ b/docs/error-messages/tool-errors/resource-compiler-errors-rc1000-through-rc4413.md @@ -1,95 +1,101 @@ --- title: "Resource compiler errors and warnings" description: "Learn more about: Resource compiler errors and warnings (RCxxxx, RWxxxx)" -ms.date: "04/17/2019" +ms.date: 04/17/2019 --- # Resource compiler errors and warnings (RCxxxx, RWxxxx) This section is a reference to the errors generated by the resource compiler. Resource compiler errors and warnings have the form RC*xxxx* or RW*xxxx*, where *xxxx* is a four-digit number. -[!INCLUDE[error-boilerplate](../../error-messages/includes/error-boilerplate.md)] +[!INCLUDE[error-boilerplate](../includes/error-boilerplate.md)] ## Resource compiler fatal errors -[Resource compiler fatal error RC1002](resource-compiler-fatal-error-rc1002.md) \ -[Resource compiler fatal error RC1004](resource-compiler-fatal-error-rc1004.md) \ -[Resource compiler fatal error RC1009](resource-compiler-fatal-error-rc1009.md) \ -[Resource compiler fatal error RC1011](resource-compiler-fatal-error-rc1011.md) \ -[Resource compiler fatal error RC1015](resource-compiler-fatal-error-rc1015.md) \ -[Resource compiler fatal error RC1017](resource-compiler-fatal-error-rc1017.md) \ -[Resource compiler fatal error RC1018](resource-compiler-fatal-error-rc1018.md) \ -[Resource compiler fatal error RC1019](resource-compiler-fatal-error-rc1019.md) \ -[Resource compiler fatal error RC1020](resource-compiler-fatal-error-rc1020.md) \ -[Resource compiler fatal error RC1021](resource-compiler-fatal-error-rc1021.md) \ -[Resource compiler fatal error RC1022](resource-compiler-fatal-error-rc1022.md) \ -[Resource compiler fatal error RC1047](resource-compiler-fatal-error-rc1047.md) \ -[Resource compiler fatal error RC1052](resource-compiler-fatal-error-rc1052.md) \ -[Resource compiler fatal error RC1067](resource-compiler-fatal-error-rc1067.md) \ -[Resource compiler fatal error RC1101](resource-compiler-fatal-error-rc1101.md) \ -[Resource compiler fatal error RC1102](resource-compiler-fatal-error-rc1102.md) \ -[Resource compiler fatal error RC1105](resource-compiler-fatal-error-rc1105.md) \ -[Resource compiler fatal error RC1109](resource-compiler-fatal-error-rc1109.md) \ -[Resource compiler fatal error RC1116](resource-compiler-fatal-error-rc1116.md) \ -[Resource compiler fatal error RC1120](resource-compiler-fatal-error-rc1120.md) \ -[Resource compiler fatal error RC1121](resource-compiler-fatal-error-rc1121.md) \ -[Resource compiler fatal error RC1203](resource-compiler-fatal-error-rc1203.md) \ -[Resource compiler fatal error RC1205](resource-compiler-fatal-error-rc1205.md) \ -[Resource compiler fatal error RC1208](resource-compiler-fatal-error-rc1208.md) \ -[Resource compiler fatal error RW1004](resource-compiler-fatal-error-rw1004.md) \ -[Resource compiler fatal error RW1009](resource-compiler-fatal-error-rw1009.md) \ -[Resource compiler fatal error RW1016](resource-compiler-fatal-error-rw1016.md) \ -[Resource compiler fatal error RW1022](resource-compiler-fatal-error-rw1022.md) \ -[Resource compiler fatal error RW1023](resource-compiler-fatal-error-rw1023.md) \ -[Resource compiler fatal error RW1025](resource-compiler-fatal-error-rw1025.md) \ -[Resource compiler fatal error RW1030](resource-compiler-fatal-error-rw1030.md) +| Error | Message | +|--|--| +| [Resource compiler fatal error RC1002](resource-compiler-fatal-error-rc1002.md) | out of heap space | +| [Resource compiler fatal error RC1004](resource-compiler-fatal-error-rc1004.md) | unexpected end of file found | +| [Resource compiler fatal error RC1009](resource-compiler-fatal-error-rc1009.md) | compiler limit : macros too deeply nested 'macro' | +| [Resource compiler fatal error RC1011](resource-compiler-fatal-error-rc1011.md) | compiler limit : 'identifier' : macro definition too big | +| [Resource compiler fatal error RC1015](resource-compiler-fatal-error-rc1015.md) | cannot open include file 'filename' | +| [Resource compiler fatal error RC1017](resource-compiler-fatal-error-rc1017.md) | invalid integer constant expression | +| [Resource compiler fatal error RC1018](resource-compiler-fatal-error-rc1018.md) | unexpected '#elif' | +| [Resource compiler fatal error RC1019](resource-compiler-fatal-error-rc1019.md) | unexpected '#else' | +| [Resource compiler fatal error RC1020](resource-compiler-fatal-error-rc1020.md) | unexpected '#endif' | +| [Resource compiler fatal error RC1021](resource-compiler-fatal-error-rc1021.md) | invalid preprocessor command 'string' | +| [Resource compiler fatal error RC1022](resource-compiler-fatal-error-rc1022.md) | expected '#endif' | +| [Resource compiler fatal error RC1047](resource-compiler-fatal-error-rc1047.md) | too many option options, 'string' | +| [Resource compiler fatal error RC1052](resource-compiler-fatal-error-rc1052.md) | compiler limit : `#if` or `#ifdef` blocks nested too deeply | +| [Resource compiler fatal error RC1067](resource-compiler-fatal-error-rc1067.md) | compiler limit : identifier overflowed internal buffer | +| [Resource compiler fatal error RC1101](resource-compiler-fatal-error-rc1101.md) | no resource binary filename specified | +| [Resource compiler fatal error RC1102](resource-compiler-fatal-error-rc1102.md) | internal error : too many arguments to RCPP | +| [Resource compiler fatal error RC1105](resource-compiler-fatal-error-rc1105.md) | invalid switch, option: too many /d switches | +| [Resource compiler fatal error RC1109](resource-compiler-fatal-error-rc1109.md) | error creating resource-name | +| [Resource compiler fatal error RC1116](resource-compiler-fatal-error-rc1116.md) | RC terminating after preprocessor errors | +| [Resource compiler fatal error RC1120](resource-compiler-fatal-error-rc1120.md) | out of memory, needed number bytes | +| [Resource compiler fatal error RC1121](resource-compiler-fatal-error-rc1121.md) | I/O error reading file | +| [Resource compiler fatal error RC1203](resource-compiler-fatal-error-rc1203.md) | invalid hexadecimal default language ID specified. | +| [Resource compiler fatal error RC1205](resource-compiler-fatal-error-rc1205.md) | invalid code page | +| [Resource compiler fatal error RC1208](resource-compiler-fatal-error-rc1208.md) | input file has .RES extension | +| [Resource compiler fatal error RW1004](resource-compiler-fatal-error-rw1004.md) | Unexpected end of file | +| [Resource compiler fatal error RW1009](resource-compiler-fatal-error-rw1009.md) | Error creating resource-name | +| [Resource compiler fatal error RW1016](resource-compiler-fatal-error-rw1016.md) | RC terminating after preprocessor errors | +| [Resource compiler fatal error RW1022](resource-compiler-fatal-error-rw1022.md) | I/O error writing file | +| [Resource compiler fatal error RW1023](resource-compiler-fatal-error-rw1023.md) | I/O error writing file, drive full | +| [Resource compiler fatal error RW1025](resource-compiler-fatal-error-rw1025.md) | Out of far heap memory | +| [Resource compiler fatal error RW1030](resource-compiler-fatal-error-rw1030.md) | Output Error | ## Resource compiler errors -[Resource compiler error RC2001](resource-compiler-error-rc2001.md) \ -[Resource compiler error RC2007](resource-compiler-error-rc2007.md) \ -[Resource compiler error RC2015](resource-compiler-error-rc2015.md) \ -[Resource compiler error RC2017](resource-compiler-error-rc2017.md) \ -[Resource compiler error RC2101](resource-compiler-error-rc2101.md) \ -[Resource compiler error RC2103](resource-compiler-error-rc2103.md) \ -[Resource compiler error RC2104](resource-compiler-error-rc2104.md) \ -[Resource compiler error RC2107](resource-compiler-error-rc2107.md) \ -[Resource compiler error RC2109](resource-compiler-error-rc2109.md) \ -[Resource compiler error RC2111](resource-compiler-error-rc2111.md) \ -[Resource compiler error RC2112](resource-compiler-error-rc2112.md) \ -[Resource compiler error RC2113](resource-compiler-error-rc2113.md) \ -[Resource compiler error RC2114](resource-compiler-error-rc2114.md) \ -[Resource compiler error RC2116](resource-compiler-error-rc2116.md) \ -[Resource compiler error RC2122](resource-compiler-error-rc2122.md) \ -[Resource compiler error RC2124](resource-compiler-error-rc2124.md) \ -[Resource compiler error RC2127](resource-compiler-error-rc2127.md) \ -[Resource compiler error RC2135](resource-compiler-error-rc2135.md) \ -[Resource compiler error RC2144](resource-compiler-error-rc2144.md) \ -[Resource compiler error RC2147](resource-compiler-error-rc2147.md) \ -[Resource compiler error RC2148](resource-compiler-error-rc2148.md) \ -[Resource compiler error RC2151](resource-compiler-error-rc2151.md) \ -[Resource compiler error RC2152](resource-compiler-error-rc2152.md) \ -[Resource compiler error RC2162](resource-compiler-error-rc2162.md) \ -[Resource compiler error RC2163](resource-compiler-error-rc2163.md) \ -[Resource compiler error RC2164](resource-compiler-error-rc2164.md) \ -[Resource compiler error RC2165](resource-compiler-error-rc2165.md) \ -[Resource compiler error RC2167](resource-compiler-error-rc2167.md) \ -[Resource compiler error RC2169](resource-compiler-error-rc2169.md) \ -[Resource compiler error RC2170](resource-compiler-error-rc2170.md) \ -[Resource compiler error RC2171](resource-compiler-error-rc2171.md) \ -[Resource compiler error RC2175](resource-compiler-error-rc2175.md) \ -[Resource compiler error RW2001](resource-compiler-error-rw2001.md) \ -[Resource compiler error RW2002](resource-compiler-error-rw2002.md) \ -[Resource compiler error RW2003](resource-compiler-error-rw2003.md) +| Error | Message | +|--|--| +| [Resource compiler error RC2001](resource-compiler-error-rc2001.md) | newline in constant | +| [Resource compiler error RC2007](resource-compiler-error-rc2007.md) | #define syntax | +| [Resource compiler error RC2015](resource-compiler-error-rc2015.md) | too many chars in constant | +| [Resource compiler error RC2017](resource-compiler-error-rc2017.md) | illegal escape sequence | +| [Resource compiler error RC2101](resource-compiler-error-rc2101.md) | Invalid directive in preprocessed RC file | +| [Resource compiler error RC2103](resource-compiler-error-rc2103.md) | unexpected end of file in string literal | +| [Resource compiler error RC2104](resource-compiler-error-rc2104.md) | undefined keyword or key name: key | +| [Resource compiler error RC2107](resource-compiler-error-rc2107.md) | expected numeric command value | +| [Resource compiler error RC2109](resource-compiler-error-rc2109.md) | expected numerical dialog constant | +| [Resource compiler error RC2111](resource-compiler-error-rc2111.md) | invalid control type | +| [Resource compiler error RC2112](resource-compiler-error-rc2112.md) | `BEGIN` expected in dialog | +| [Resource compiler error RC2113](resource-compiler-error-rc2113.md) | `END` expected in dialog | +| [Resource compiler error RC2114](resource-compiler-error-rc2114.md) | expected control class name | +| [Resource compiler error RC2116](resource-compiler-error-rc2116.md) | expecting number for ID | +| [Resource compiler error RC2122](resource-compiler-error-rc2122.md) | unknown menu subtype | +| [Resource compiler error RC2124](resource-compiler-error-rc2124.md) | empty menus not allowed | +| [Resource compiler error RC2127](resource-compiler-error-rc2127.md) | version WORDs separated by commas expected | +| [Resource compiler error RC2135](resource-compiler-error-rc2135.md) | file not found: filename | +| [Resource compiler error RC2144](resource-compiler-error-rc2144.md) | PRIMARY LANGUAGE ID not a number | +| [Resource compiler error RC2147](resource-compiler-error-rc2147.md) | SUBLANGUAGE ID not a number | +| [Resource compiler error RC2148](resource-compiler-error-rc2148.md) | SUBLANGUAGE ID too large | +| [Resource compiler error RC2151](resource-compiler-error-rc2151.md) | cannot re-use string constants | +| [Resource compiler error RC2152](resource-compiler-error-rc2152.md) | invalid control character | +| [Resource compiler error RC2162](resource-compiler-error-rc2162.md) | expected macro formal parameter | +| [Resource compiler error RC2163](resource-compiler-error-rc2163.md) | accelerator type required [ASCII or VIRTKEY] | +| [Resource compiler error RC2164](resource-compiler-error-rc2164.md) | unexpected value in `RCDATA` | +| [Resource compiler error RC2165](resource-compiler-error-rc2165.md) | string not found in `DLGINCLUDE` statement | +| [Resource compiler error RC2167](resource-compiler-error-rc2167.md) | unrecognized `VERSIONINFO` field; `BEGIN` or comma expected | +| [Resource compiler error RC2169](resource-compiler-error-rc2169.md) | resource file filename is not in 2.03 format | +| [Resource compiler error RC2170](resource-compiler-error-rc2170.md) | bitmap file filename is not in 3.00 format | +| [Resource compiler error RC2171](resource-compiler-error-rc2171.md) | unknown DIB header format | +| [Resource compiler error RC2175](resource-compiler-error-rc2175.md) | resource file filename is not in 3.00 format | +| [Resource compiler error RW2001](resource-compiler-error-rw2001.md) | Invalid directive in preprocessed RC file | +| [Resource compiler error RW2002](resource-compiler-error-rw2002.md) | Parsing error | +| [Resource compiler error RW2003](resource-compiler-error-rw2003.md) | Generation Error | ## Resource compiler warnings -[Resource compiler warning RC4002](resource-compiler-warning-rc4002.md) \ -[Resource compiler warning RC4005](resource-compiler-warning-rc4005.md) \ -[Resource compiler warning RC4093](resource-compiler-warning-rc4093.md) \ -[Resource compiler warning RC4214](resource-compiler-warning-rc4214.md) \ -[Resource compiler warning RW4001](resource-compiler-warning-rw4001.md) \ -[Resource compiler warning RW4003](resource-compiler-warning-rw4003.md) \ -[Resource compiler warning RW4004](resource-compiler-warning-rw4004.md) +| Warning | Message | +|--|--| +| [Resource compiler warning RC4002](resource-compiler-warning-rc4002.md) | too many actual parameters for macro 'identifier' | +| [Resource compiler warning RC4005](resource-compiler-warning-rc4005.md) | 'identifier' : macro redefinition | +| [Resource compiler warning RC4093](resource-compiler-warning-rc4093.md) | unescaped newline in character constant in inactive code | +| [Resource compiler warning RC4214](resource-compiler-warning-rc4214.md) | Codepage not valid : ignored | +| [Resource compiler warning RW4001](resource-compiler-warning-rw4001.md) | .EXE processing options (/L /M /P /T /K /E /31 or /30) | +| [Resource compiler warning RW4003](resource-compiler-warning-rw4003.md) | `SHIFT` or `CONTROL` used without `VIRTKEY` | +| [Resource compiler warning RW4004](resource-compiler-warning-rw4004.md) | ASCII character not equivalent to virtual key code | ## See also diff --git a/docs/error-messages/tool-errors/vectorizer-and-parallelizer-messages.md b/docs/error-messages/tool-errors/vectorizer-and-parallelizer-messages.md index 07ff21fb4e3..c364ea1966d 100644 --- a/docs/error-messages/tool-errors/vectorizer-and-parallelizer-messages.md +++ b/docs/error-messages/tool-errors/vectorizer-and-parallelizer-messages.md @@ -30,12 +30,16 @@ The 5*xx* reason codes apply to both the parallelizer and the vectorizer. | Reason code | Explanation | |--|--| -| 500 | A generic message that covers several cases: For example, the loop includes multiple exits, or the loop header doesn't end by incrementing the induction variable. | +| 500 | Induction variable discovery or recurrence failure. | | 501 | Induction variable isn't local; or upper bound isn't loop-invariant. | | 502 | Induction variable is stepped in some manner other than a simple +1. | | 503 | Loop includes exception-handling or switch statements. | | 504 | Loop body may throw an exception that requires destruction of a C++ object. | | 505 | Outer loop has a pre-incremented induction variable. Exiting analysis. | +| 506 | Loop structural or canonical form failure. | +| 507 | Bounds, initialization, termination, or compare consistency failure. | +| 508 | Stride derivation or usage failure | +| 509 | Loop direction acceptability failure. | ```cpp void code_500(int *A) diff --git a/docs/get-started/toc.yml b/docs/get-started/toc.yml index 49961e13203..32d38ad40ef 100644 --- a/docs/get-started/toc.yml +++ b/docs/get-started/toc.yml @@ -1,11 +1,13 @@ items: -- name: Get started with Visual C++ +- name: Get started with Microsoft C++ expanded: true items: - name: Install C++ support in Visual Studio href: ../build/vscpp-step-0-installation.md - name: Visual Studio guided tour href: /visualstudio/get-started/visual-studio-ide + - name: Use AI to create a C++ console application in Visual Studio + href: ../build/use-github-copilot-create-cpp-console-app.md - name: Create and edit a C++ console app project href: ../build/vscpp-step-1-create.md - name: Build and run a C++ console app project diff --git a/docs/get-started/tutorial-console-cpp.md b/docs/get-started/tutorial-console-cpp.md index db968eefaa5..608ab706e06 100644 --- a/docs/get-started/tutorial-console-cpp.md +++ b/docs/get-started/tutorial-console-cpp.md @@ -1,6 +1,6 @@ --- title: "Create a console calculator in C++" -description: "Create a Hello World console app and a calculator app in Visual C++" +description: "Create a Hello World console app and a calculator app in Visual Studio C++" ms.custom: "acquisition, mvc" ms.date: 10/08/2024 ms.topic: "tutorial" diff --git a/docs/ide/cpp-linter-overview.md b/docs/ide/cpp-linter-overview.md index 07057453ac3..e6c987576c8 100644 --- a/docs/ide/cpp-linter-overview.md +++ b/docs/ide/cpp-linter-overview.md @@ -2,7 +2,7 @@ description: "Learn more about: IntelliSense code linter for C++" title: IntelliSense code linter for C++ overview ms.date: 09/30/2021 -ms.topic: conceptual +ms.topic: overview helpviewer_keywords: - "C/C++, linter" - "C++, linter" diff --git a/docs/ide/include-cleanup-config.md b/docs/ide/include-cleanup-config.md index 5d4e2813902..0f2b6d59871 100644 --- a/docs/ide/include-cleanup-config.md +++ b/docs/ide/include-cleanup-config.md @@ -1,7 +1,7 @@ --- title: "Configure C/C++ Include Cleanup in Visual Studio" description: "Learn how to configure C/C++ Include Cleanup." -ms.date: 10/10/2023 +ms.date: 01/23/2026 ms.topic: "how-to" f1_keywords: ["config include cleanup"] helpviewer_keywords: ["config include cleanup"] @@ -59,7 +59,7 @@ The `.editorconfig` settings that you can use with Include Cleanup are: | `cpp_include_cleanup_excluded_files`

Excludes the specified files from Include Cleanup messages. You won't get a suggestion related to the header at all, whether to add it or that it's unused. | *filename* | `cpp_include_cleanup_excluded_files = vcruntime.h, vcruntime_string.h` | | `cpp_include_cleanup_required_files`

Specify that usage of *file1* requires *file2*. For example, specify that if you use `atlwin.h` that `altbase.h` must also be included. | *file1*:*file2* | `cpp_include_cleanup_required_files = atlwin.h:altbase.h, atlcom.h:altbase.h` | | `cpp_include_cleanup_replacement_files`

Replaces *file1* with *file2* during Include Cleanup processing. For example, you may prefer using `cstdio` over `stdio.h`. If you have a file with both `#include ` and `#include ` and you consume content only from `stdio.h`, with this setting Include Cleanup will tell you to remove `stdio.h` because it replaced the usage of `cstdio` with `stdio.h` during processing. If you don't use the contents from either, Include Cleanup will tell you to remove both.| *file1*:*file2* | `cpp_include_cleanup_replacement_files = stdio.h:cstdio,stdint.h:cstdint` | -| `cpp_include_cleanup_alternate_files`

Don't generate a message for indirect include *file2* if *file1* is included. For example, if you `#include ` and are only using something from its indirectly included header `winerror.h`, Include Cleanup won't prompt to add `winerror.h`. Useful when you prefer to include a facade header file instead of the indirect includes it contains. | *file1*:*file2* | `cpp_include_cleanup_alternate_files = windows.h:winerror.h, windows.h:minwindef.h` | +| `cpp_include_cleanup_alternate_files`

Suppress messages for indirect includes. For example, if you `#include ` and only use content from its indirectly included headers `winerror.h` or `minwindef.h`, the tool won't suggest adding them. | *file1*:*file2*[:*file3*...][,*file4*:*file5*...] | `cpp_include_cleanup_alternate_files = windows.h:winerror.h:minwindef.h`
or
`cpp_include_cleanup_alternate_files = windows.h:winerror.h:minwindef.h,umbrella.h:internal.h`| ## See also diff --git a/docs/ide/using-the-visual-studio-ide-for-cpp-desktop-development.md b/docs/ide/using-the-visual-studio-ide-for-cpp-desktop-development.md index 45a30a66416..5f115d743cc 100644 --- a/docs/ide/using-the-visual-studio-ide-for-cpp-desktop-development.md +++ b/docs/ide/using-the-visual-studio-ide-for-cpp-desktop-development.md @@ -16,7 +16,7 @@ If you haven't installed Visual Studio yet, now is the time. For download links These walkthroughs assume that you've installed Visual Studio and the C++ components required for Windows Desktop development. We also assume you understand the fundamentals of the C++ language. If you need to learn C++, there are many books and web resources available. One good place to start is the [Get Started](https://isocpp.org/get-started) page of the Standard C++ Foundation website. -In general, we highly recommend that you use the latest version of Visual Studio even if you need to compile your code using an earlier version of the compiler toolset. For more information, see [Use native multi-targeting in Visual Studio to build old projects](../porting/use-native-multi-targeting.md). +In general, we highly recommend that you use the latest version of Visual Studio even if you need to compile your code using an earlier version of the Microsoft C++ (MSVC) Build Tools. For more information, see [Use native multi-targeting in Visual Studio to build old projects](../porting/use-native-multi-targeting.md). Once your Visual Studio installation is complete, you are ready to continue. @@ -36,7 +36,7 @@ To get started using the Visual Studio IDE to build C++ apps, work through each ## Next steps -Once you've completed these walkthroughs, you're ready to start building your own projects. For more information and resources for C++ development, see [Visual C++ in Visual Studio](../overview/visual-cpp-in-visual-studio.md). +Once you've completed these walkthroughs, you're ready to start building your own projects. For more information and resources for C++ development, see [Microsoft C++ in Visual Studio](../overview/visual-cpp-in-visual-studio.md). ## See also diff --git a/docs/ide/writing-and-refactoring-code-cpp.md b/docs/ide/writing-and-refactoring-code-cpp.md index 72dc71d8b4f..cfb3dbfdead 100644 --- a/docs/ide/writing-and-refactoring-code-cpp.md +++ b/docs/ide/writing-and-refactoring-code-cpp.md @@ -22,7 +22,7 @@ search for "IntelliSense" in **Quick Launch** (Ctrl + Q) and choose the **Text E The **Member List Filter Mode** option controls what kinds of IntelliSense autocomplete suggestions you see. By default, it's set to **Fuzzy**. In a fuzzy search, if you have a symbol called *MyAwesomeClass*, you can type "MAC" and find the class in your autocomplete suggestions. The fuzzy algorithm sets a minimum threshold that symbols must meet to show up in the list. **Smart** filtering displays all symbols containing substrings that match what you typed. **Prefix** filtering searches for strings that begin with what you typed. -For more information about C++ IntelliSense, see [Visual C++ IntelliSense](/visualstudio/ide/visual-cpp-intellisense) and [Configure a C++ project for IntelliSense](/visualstudio/ide/visual-cpp-intellisense-configuration). +For more information about C++ IntelliSense, see [Visual Studio C++ IntelliSense](/visualstudio/ide/visual-cpp-intellisense) and [Configure a C++ project for IntelliSense](/visualstudio/ide/visual-cpp-intellisense-configuration). ## IntelliCode diff --git a/docs/index.yml b/docs/index.yml index 94be641a2bf..a2bdc2a4d8b 100644 --- a/docs/index.yml +++ b/docs/index.yml @@ -10,7 +10,7 @@ metadata: ms.topic: hub-page author: tylermsft ms.author: twhitney - ms.date: 06/04/2020 + ms.date: 11/06/2025 ms.custom: intro-landing-hub # highlightedContent section (optional) @@ -205,6 +205,8 @@ additionalContent: url: parallel/parallel-programming-in-visual-cpp.md - text: Cloud and networking libraries url: cloud/cloud-and-web-programming-in-visual-cpp.md + - text: Azure SDK for C++ + url: /azure/developer/cpp/sdk/overview/ - text: Universal Windows Platform libraries url: cppcx/namespaces-reference-c-cx.md - text: vcpkg package manager diff --git a/docs/intrinsics/arm-intrinsics.md b/docs/intrinsics/arm-intrinsics.md index f2a248f9a97..bde0f7c5627 100644 --- a/docs/intrinsics/arm-intrinsics.md +++ b/docs/intrinsics/arm-intrinsics.md @@ -7,7 +7,7 @@ helpviewer_keywords: ["cl.exe compiler, ARM intrinsics", "intrinsics, ARM", "__c --- # ARM intrinsics -The Microsoft C++ compiler (MSVC) makes the following intrinsics available on the ARM architecture. For more information about ARM, see the Architecture and Software Development Tools sections of the [ARM Developer Documentation](https://developer.arm.com/docs) website. +The Microsoft C++ (MSVC) compiler makes the following intrinsics available on the ARM architecture. For more information about ARM, see the Architecture and Software Development Tools sections of the [ARM Developer Documentation](https://developer.arm.com/docs) website. ## NEON diff --git a/docs/intrinsics/arm64-intrinsics.md b/docs/intrinsics/arm64-intrinsics.md index 8300ceea360..c610e426be3 100644 --- a/docs/intrinsics/arm64-intrinsics.md +++ b/docs/intrinsics/arm64-intrinsics.md @@ -9,7 +9,7 @@ ms.date: "11/14/2019" --- # ARM64 intrinsics -The Microsoft C++ compiler (MSVC) makes the following intrinsics available on the ARM64 architecture. For more information about ARM, see the Architecture and Software Development Tools sections of the [ARM Developer Documentation](https://developer.arm.com/docs) website. +The Microsoft C++ (MSVC) compiler makes the following intrinsics available on the ARM64 architecture. For more information about ARM, see the Architecture and Software Development Tools sections of the [ARM Developer Documentation](https://developer.arm.com/docs) website. ## NEON diff --git a/docs/intrinsics/compiler-intrinsics.md b/docs/intrinsics/compiler-intrinsics.md index ea886301346..381e8610042 100644 --- a/docs/intrinsics/compiler-intrinsics.md +++ b/docs/intrinsics/compiler-intrinsics.md @@ -13,7 +13,7 @@ Most functions are contained in libraries, but some functions are built in (that If a function is an intrinsic, the code for that function is usually inserted inline, avoiding the overhead of a function call and allowing highly efficient machine instructions to be emitted for that function. An intrinsic is often faster than the equivalent inline assembly, because the optimizer has a built-in knowledge of how many intrinsics behave, so some optimizations can be available that are not available when inline assembly is used. Also, the optimizer can expand the intrinsic differently, align buffers differently, or make other adjustments depending on the context and arguments of the call. -The use of intrinsics affects the portability of code, because intrinsics that are available in Visual C++ might not be available if the code is compiled with other compilers and some intrinsics that might be available for some target architectures are not available for all architectures. However, intrinsics are usually more portable than inline assembly. The intrinsics are required on 64-bit architectures where inline assembly is not supported. +The use of intrinsics affects the portability of code, because intrinsics that are available in Microsoft C++ might not be available if the code is compiled with other compilers and some intrinsics that might be available for some target architectures are not available for all architectures. However, intrinsics are usually more portable than inline assembly. The intrinsics are required on 64-bit architectures where inline assembly is not supported. Some intrinsics, such as **`__assume`** and `__ReadWriteBarrier`, provide information to the compiler, which affects the behavior of the optimizer. diff --git a/docs/linux/set-up-fips-compliant-secure-remote-linux-development.md b/docs/linux/set-up-fips-compliant-secure-remote-linux-development.md index aa4ba4bf66e..c771087b836 100644 --- a/docs/linux/set-up-fips-compliant-secure-remote-linux-development.md +++ b/docs/linux/set-up-fips-compliant-secure-remote-linux-development.md @@ -147,7 +147,7 @@ It's possible to enable FIPS mode globally in Windows. 1. In the **Local Security Setting** tab, select **Enabled** or **Disabled**, and then choose **OK** to save your changes. > [!WARNING] -> Enabling FIPS mode may cause some applications to break or behave unexpectedly. For more information, see the blog post [Why We're Not Recommending "FIPS mode" Anymore](https://techcommunity.microsoft.com/t5/microsoft-security-baselines/why-we-8217-re-not-recommending-8220-fips-mode-8221-anymore/ba-p/701037). +> Enabling FIPS mode may cause some applications to break or behave unexpectedly. ## Additional resources @@ -157,8 +157,6 @@ It's possible to enable FIPS mode globally in Windows. [Cryptographic Algorithm Validation Program: Validation Notes](https://csrc.nist.gov/projects/cryptographic-algorithm-validation-program/Validation-Notes) (from NIST) -Microsoft blog post on [Why We're Not Recommending "FIPS mode" Anymore](https://techcommunity.microsoft.com/t5/microsoft-security-baselines/why-we-8217-re-not-recommending-8220-fips-mode-8221-anymore/ba-p/701037) - [SSH Server Configuration](https://www.ssh.com/ssh/sshd_config) ## See also diff --git a/docs/mfc/a-portrait-of-the-document-view-architecture.md b/docs/mfc/a-portrait-of-the-document-view-architecture.md index 2fa6b524004..de319b5b0da 100644 --- a/docs/mfc/a-portrait-of-the-document-view-architecture.md +++ b/docs/mfc/a-portrait-of-the-document-view-architecture.md @@ -3,10 +3,12 @@ description: "Learn more about: A Portrait of the Document/View Architecture" title: "A Portrait of the Document-View Architecture" ms.date: "11/04/2016" helpviewer_keywords: ["documents [MFC], views", "multiple views [MFC], updating from document", "document/view architecture [MFC]", "views [MFC], and user input", "documents [MFC], accessing data from view", "views [MFC], updating", "input [MFC], view class", "documents [MFC], multiple views", "document/view architecture [MFC], accessing data from view", "document/view architecture [MFC], about document/view architecture", "views [MFC], accessing document data from"] -ms.assetid: 4e7f65dc-b166-45d8-bcd5-9bb0d399b946 --- # A Portrait of the Document/View Architecture +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Documents and views are paired in a typical MFC application. Data is stored in the document, but the view has privileged access to the data. The separation of document from view separates the storage and maintenance of data from its display. ## Gaining Access to Document Data from the View diff --git a/docs/mfc/accessing-all-members-of-a-collection.md b/docs/mfc/accessing-all-members-of-a-collection.md index 0cd39499410..3ee1f74208c 100644 --- a/docs/mfc/accessing-all-members-of-a-collection.md +++ b/docs/mfc/accessing-all-members-of-a-collection.md @@ -3,11 +3,13 @@ description: "Learn more about: Accessing All Members of a Collection" title: "Accessing All Members of a Collection" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, collections", "enumerations [MFC]", "enumerating collections [MFC]", "collections [MFC], accessing", "collection classes [MFC]", ", ", ", ", ", ", ", ", ", ", ", ", ", "] -ms.assetid: 7bbae518-062e-4393-81f9-b22abd2e5f59 ms.topic: how-to --- # Accessing All Members of a Collection +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The MFC array collection classes — both template-based and not — use indexes to access their elements. The MFC list and map collection classes — both template-based and not — use an indicator of type **POSITION** to describe a given position within the collection. To access one or more members of these collections, you first initialize the position indicator and then repeatedly pass that position to the collection and ask it to return the next element. The collection is not responsible for maintaining state information about the progress of the iteration. That information is kept in the position indicator. But, given a particular position, the collection is responsible for returning the next element. The following procedures show how to iterate over the three main types of collections provided with MFC: diff --git a/docs/mfc/accessing-file-status.md b/docs/mfc/accessing-file-status.md index f582a6558bc..6e75ed88b8d 100644 --- a/docs/mfc/accessing-file-status.md +++ b/docs/mfc/accessing-file-status.md @@ -3,11 +3,13 @@ description: "Learn more about: Accessing File Status" title: "Accessing File Status" ms.date: "11/04/2016" helpviewer_keywords: ["files [MFC], status information", "examples [MFC], file status", "files [MFC], accessing", "file status [MFC]", "status of files [MFC]"] -ms.assetid: 1b8891d6-eb0f-4037-a837-4928fe595222 ms.topic: how-to --- # Accessing File Status +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + `CFile` also supports getting file status, including whether the file exists, creation and modification dates and times, logical size, and path. ### To get file status diff --git a/docs/mfc/accessing-run-time-class-information.md b/docs/mfc/accessing-run-time-class-information.md index e0981fe062a..167bf60b463 100644 --- a/docs/mfc/accessing-run-time-class-information.md +++ b/docs/mfc/accessing-run-time-class-information.md @@ -3,11 +3,13 @@ description: "Learn more about: Accessing Run-Time Class Information" title: "Accessing Run-Time Class Information" ms.date: "11/04/2016" helpviewer_keywords: ["CObject class [MFC], and RTTI", "CObject class [MFC], using IsKindOf method [MFC]", "run time [MFC], class information", "RUNTIME_CLASS macro [MFC]", "CObject class [MFC], using RUNTIME_CLASS macro [MFC]", "RTTI compiler option [MFC]", "CObject class [MFC], accessing run-time class information", "run time [MFC]", "IsKindOf method method [MFC]", "run-time class [MFC], accessing information", "classes [MFC], run-time class information", "run-time class [MFC]", "RUNTIME_CLASS macro, using"] -ms.assetid: 3445a9af-0bd6-4496-95c3-aa59b964570b ms.topic: how-to --- # Accessing Run-Time Class Information +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to access information about the class of an object at run time. > [!NOTE] diff --git a/docs/mfc/accessing-the-embedded-month-calendar-control.md b/docs/mfc/accessing-the-embedded-month-calendar-control.md index c8c09084768..d325e55ce73 100644 --- a/docs/mfc/accessing-the-embedded-month-calendar-control.md +++ b/docs/mfc/accessing-the-embedded-month-calendar-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Accessing the Embedded Month Calendar Control" title: "Accessing the Embedded Month Calendar Control" ms.date: "11/04/2016" helpviewer_keywords: ["DateTimePicker control [MFC], accessing month calendar", "CDateTimeCtrl class [MFC], accessing embedded control", "month calendar controls [MFC], embedded in date/time picker", "CMonthCalCtrl class [MFC], changing the font", "month calendar controls [MFC], changing the font", "DateTimePicker control [MFC]"] -ms.assetid: 355e97ed-cf81-4df3-a2f8-9ddbbde93227 ms.topic: concept-article --- # Accessing the Embedded Month Calendar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The embedded month calendar control object can be accessed from the `CDateTimeCtrl` object with a call to the [GetMonthCalCtrl](reference/cdatetimectrl-class.md#getmonthcalctrl) member function. > [!NOTE] diff --git a/docs/mfc/activation-cpp.md b/docs/mfc/activation-cpp.md index 89aafcdbd30..d40b7871b57 100644 --- a/docs/mfc/activation-cpp.md +++ b/docs/mfc/activation-cpp.md @@ -3,10 +3,12 @@ description: "Learn more about: Activation (C++)" title: "Activation (C++)" ms.date: "11/04/2016" helpviewer_keywords: ["OLE server applications [MFC], activation", "OLE items [MFC], visual editing", "activation [MFC]", "OLE [MFC], in-place activation", "OLE [MFC], activation", "in-place activation, embedded and linked items", "activating objects", "visual editing, activation", "visual editing", "documents [MFC], OLE", "embedded objects [MFC]", "OLE [MFC], editing", "in-place activation", "activation [MFC], embedded OLE items", "OLE activation [MFC]"] -ms.assetid: ed8357d9-e487-4aaa-aa6b-2edc4de25dfa --- # Activation (C++) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the role of activation in the visual editing of OLE items. After a user has embedded an OLE item in a container document, it may need to be used. To do this, the user double-clicks the item, which activates that item. The most frequent activity for activation is editing. Many current OLE items, when activated for editing, cause the menus and toolbars in the current frame window to change to reflect those belonging to the server application that created the item. This behavior, known as in-place activation, allows the user to edit any embedded item in a compound document without leaving the container document's window. It is also possible to edit embedded OLE items in a separate window. This will happen if either the container or server application does not support in-place activation. In this case, when the user double-clicks an embedded item, the server application is launched in a separate window and the embedded item appears as its own document. The user edits the item in this window. When editing is complete, the user closes the server application and returns to the container application. diff --git a/docs/mfc/activation-verbs.md b/docs/mfc/activation-verbs.md index 31e35ddfed5..44f8e4f2030 100644 --- a/docs/mfc/activation-verbs.md +++ b/docs/mfc/activation-verbs.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["verbs [MFC]", "OLE [MFC], activation", "edit verb [MFC]", --- # Activation: Verbs +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the role primary and secondary verbs play in OLE [activation](activation-cpp.md). Usually, double-clicking an embedded item allows the user to edit it. However, certain items do not behave this way. For example, double-clicking an item created with the Sound Recorder application does not open the server in a separate window; instead, it plays the sound. diff --git a/docs/mfc/active-document-classes.md b/docs/mfc/active-document-classes.md index b5d917abefd..2e21e90ff3e 100644 --- a/docs/mfc/active-document-classes.md +++ b/docs/mfc/active-document-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Active Document Classes" title: "Active Document Classes" ms.date: "11/04/2016" helpviewer_keywords: ["Active document classes [MFC]"] -ms.assetid: cc20af37-b658-406d-8148-7670737f4c03 --- # Active Document Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Active documents can be displayed either in the entire client window of a Web browser, such as Internet Explorer 5.5, or in an Active container, such as the Microsoft Office Binder, that supports Active documents. [CDocObjectServer](reference/cdocobjectserver-class.md)
diff --git a/docs/mfc/active-document-containers.md b/docs/mfc/active-document-containers.md index 1a73274136f..04fd6aedac2 100644 --- a/docs/mfc/active-document-containers.md +++ b/docs/mfc/active-document-containers.md @@ -3,10 +3,12 @@ description: "Learn more about: Active Document Containers" title: "Active Document Containers" ms.date: "11/19/2018" helpviewer_keywords: ["active documents [MFC], containers", "active document containers [MFC]", "containers [MFC], active document", "MFC COM, active document containment"] -ms.assetid: ba20183a-8b4c-440f-9031-e5fcc41d391b --- # Active Document Containers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An active document container, such as Microsoft Office Binder or Internet Explorer, allows you to work with several documents of different application types within a single frame (instead of forcing you to create and use multiple application frames for each document type). MFC provides full support for active document containers in the `COleDocObjectItem` class. You can use the MFC Application Wizard to create an active document container by selecting the **Active document container** check box on the **Compound Document Support** page of the MFC Application Wizard. For more information, see [Creating an Active Document Container Application](creating-an-active-document-container-application.md). diff --git a/docs/mfc/active-document-containment.md b/docs/mfc/active-document-containment.md index 0220c7fe079..457e75cb97b 100644 --- a/docs/mfc/active-document-containment.md +++ b/docs/mfc/active-document-containment.md @@ -3,10 +3,12 @@ description: "Learn more about: Active Document Containment" title: "Active Document Containment" ms.date: "11/04/2016" helpviewer_keywords: ["active documents [MFC], containers", "containers [MFC], active document", "MFC, COM support", "active document containers [MFC], about active document containers", "MFC COM, active document containment"] -ms.assetid: b8dfa74b-75ce-47df-b75e-fc87b7f7d687 --- # Active Document Containment +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Active document containment is a technology that provides a single frame in which to work with documents, instead of forcing you to create and use multiple application frames for each document type. It differs from basic OLE technology in that OLE works with embedded objects within a compound document in which only a single piece of content can be active. With active document containment, you activate an entire document (that is, an entire application, including associated menus, toolbars, and so on) within the context of a single frame. The active document containment technology was originally developed for Microsoft Office to implement Office Binder. However, the technology is flexible enough to support active document containers other than Office Binder and can support document servers other than Office and Office-compatible applications. diff --git a/docs/mfc/active-document-servers.md b/docs/mfc/active-document-servers.md index e277d81825e..441a9c8f1be 100644 --- a/docs/mfc/active-document-servers.md +++ b/docs/mfc/active-document-servers.md @@ -3,10 +3,12 @@ description: "Learn more about: Active Document Servers" title: "Active Document Servers" ms.date: "11/04/2016" helpviewer_keywords: ["active documents [MFC], servers", "servers [MFC], active document", "active document servers [MFC]"] -ms.assetid: 131fec1e-02a0-4305-a7ab-903b911232a7 --- # Active Document Servers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Active document servers such as Word, Excel, or PowerPoint host documents of other application types called active documents. Unlike OLE embedded objects (which are simply displayed within the page of another document), Active documents provide the full interface and complete native functionality of the server application that creates them. Users can create documents using the full power of their favorite applications (if they are active document enabled), yet can treat the resulting project as a single entity. Active documents can have more than one page and are always in-place active. Active documents control part of the user interface, merging their menus with the **File** and **Help** menus of the container. They occupy the entire editing area of the container and control the views and the layout of the printer page (margins, footers, and so on). diff --git a/docs/mfc/active-documents.md b/docs/mfc/active-documents.md index bbaebd0e747..235ed0d653c 100644 --- a/docs/mfc/active-documents.md +++ b/docs/mfc/active-documents.md @@ -3,10 +3,12 @@ description: "Learn more about: Active Documents" title: "Active Documents" ms.date: "11/04/2016" helpviewer_keywords: ["active documents [MFC]", "active documents [MFC], requirements", "view objects [MFC], requirements", "OLE [MFC], active documents", "views [MFC], active documents", "active documents [MFC], views"] -ms.assetid: 1378f18e-aaa6-420b-8501-4b974905baa0 --- # Active Documents +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Active documents extend the compound document technology of OLE. These extensions are provided in the form of additional interfaces that manage views, so that objects can function within containers and yet retain control over their display and printing functions. This process makes it possible to display documents both in foreign frames (such as the Microsoft Office Binder or Microsoft Internet Explorer) and in native frames (such as the product's own view ports). This section describes the functional [requirements for active documents](#requirements_for_active_documents). The active document owns a set of data and has access to storage where the data can be saved and retrieved. It can create and manage one or more views on its data. In addition to supporting the usual embedding and in-place activation interfaces of OLE documents, the active document communicates its ability to create views through `IOleDocument`. Through this interface, the container can ask to create (and possibly enumerate) the views that the active document can display. Through this interface, the active document can also provide miscellaneous information about itself, such as whether it supports multiple views or complex rectangles. diff --git a/docs/mfc/active-technology-on-the-internet.md b/docs/mfc/active-technology-on-the-internet.md index 6a0a0ae5513..18e010b6426 100644 --- a/docs/mfc/active-technology-on-the-internet.md +++ b/docs/mfc/active-technology-on-the-internet.md @@ -3,10 +3,12 @@ description: "Learn more about: Active Technology on the Internet" title: "Active Technology on the Internet" ms.date: "09/12/2018" helpviewer_keywords: ["Internet applications [MFC], Active technology"] -ms.assetid: 6f782aa1-5c2f-47a2-9e63-ddd0829d5a08 --- # Active Technology on the Internet +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Active technology is an open platform that lets developers create exciting, dynamic content and applications for the global Internet, or for a company's internal network, known as an intranet. The major technologies provided by Microsoft for Internet programming are described below. >[!IMPORTANT] diff --git a/docs/mfc/activex-control-containers-connecting-an-activex-control-to-a-member-variable.md b/docs/mfc/activex-control-containers-connecting-an-activex-control-to-a-member-variable.md index 1fa92bf4510..cd88ec1938a 100644 --- a/docs/mfc/activex-control-containers-connecting-an-activex-control-to-a-member-variable.md +++ b/docs/mfc/activex-control-containers-connecting-an-activex-control-to-a-member-variable.md @@ -3,10 +3,12 @@ description: "Learn more about: ActiveX Control Containers: Connecting an Active title: "ActiveX Control Containers: Connecting an ActiveX Control to a Member Variable" ms.date: "11/04/2016" helpviewer_keywords: ["ActiveX control containers [MFC], accessing ActiveX controls", "ActiveX controls [MFC], member variables of project", "connecting ActiveX controls to container member variables", "ActiveX controls [MFC], accessing", "member variables [MFC], ActiveX controls in project", "ActiveX control containers [MFC], ActiveX controls as member variables"] -ms.assetid: 7898a336-440d-4a60-be43-cb062b807aee --- # ActiveX Control Containers: Connecting an ActiveX Control to a Member Variable +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The easiest way to access an ActiveX control from within its control container application is to associate the ActiveX control with a member variable of the dialog class that will contain the control. > [!NOTE] diff --git a/docs/mfc/activex-control-containers-handling-events-from-an-activex-control.md b/docs/mfc/activex-control-containers-handling-events-from-an-activex-control.md index 5052a8c4c3d..acd9cb66f89 100644 --- a/docs/mfc/activex-control-containers-handling-events-from-an-activex-control.md +++ b/docs/mfc/activex-control-containers-handling-events-from-an-activex-control.md @@ -3,10 +3,12 @@ description: "Learn more about: ActiveX Control Containers: Handling Events from title: "ActiveX Control Containers: Handling Events from an ActiveX Control" ms.date: "09/12/2018" helpviewer_keywords: ["event handlers [MFC], ActiveX controls", "ActiveX control containers [MFC], event sinks", "event handling [MFC], ActiveX controls", "ON_EVENT macro [MFC]", "ActiveX controls [MFC], events [MFC]", "END_EVENTSINK_MAP macro, using", "events [MFC], ActiveX controls", "BEGIN_EVENTSINK_MAP macro"] -ms.assetid: f9c106db-052f-4e32-82ad-750646aa760b --- # ActiveX Control Containers: Handling Events from an ActiveX Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article discusses using the **Properties** window (in **Class View**) to install event handlers for ActiveX controls in an ActiveX control container. The event handlers are used to receive notifications (from the control) of certain events and perform some action in response. This notification is called "firing" the event. >[!IMPORTANT] @@ -15,7 +17,7 @@ This article discusses using the **Properties** window (in **Class View**) to in > [!NOTE] > This article uses a dialog-based ActiveX control container project named Container and an embedded control named Circ as examples in the procedures and code. -Using the Events button in the **Properties** window (in **Class View**), you can create a map of events that can occur in your ActiveX control container application. This map, called an "event sink map,'' is created and maintained by Visual C++ when you add event handlers to the control container class. Each event handler, implemented with an event map entry, maps a specific event to a container event handler member function. This event handler function is called when the specified event is fired by the ActiveX control object. +Using the Events button in the **Properties** window (in **Class View**), you can create a map of events that can occur in your ActiveX control container application. This map, called an "event sink map,'' is created and maintained by Visual Studio when you add event handlers to the control container class. Each event handler, implemented with an event map entry, maps a specific event to a container event handler member function. This event handler function is called when the specified event is fired by the ActiveX control object. For more information on event sink maps, see [Event Sink Maps](reference/event-sink-maps.md) in the *Class Library Reference*. diff --git a/docs/mfc/activex-control-containers-manually-enabling-activex-control-containment.md b/docs/mfc/activex-control-containers-manually-enabling-activex-control-containment.md index f4e37044710..f7cb6480473 100644 --- a/docs/mfc/activex-control-containers-manually-enabling-activex-control-containment.md +++ b/docs/mfc/activex-control-containers-manually-enabling-activex-control-containment.md @@ -3,10 +3,12 @@ description: "Learn more about: ActiveX Control Containers: Manually Enabling Ac title: "ActiveX Control Containers: Manually Enabling ActiveX Control Containment" ms.date: "09/12/2018" helpviewer_keywords: ["AfxEnableControlContainer method [MFC]", "ActiveX control containers [MFC], enabling", "ActiveX controls [MFC], enabling containers"] -ms.assetid: 833bcde9-c9ad-4709-ad12-2fc2150fb6a5 --- # ActiveX Control Containers: Manually Enabling ActiveX Control Containment +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If you did not enable ActiveX control support when you used the MFC Application Wizard to generate your application, you will have to add this support manually. This article describes the process for manually adding ActiveX control containment to an existing OLE container application. If you know in advance that you want ActiveX control support in your OLE container, see the article [Creating an MFC ActiveX Control Container](reference/creating-an-mfc-activex-control-container.md). >[!IMPORTANT] diff --git a/docs/mfc/activex-control-containers-using-controls-in-a-non-dialog-container.md b/docs/mfc/activex-control-containers-using-controls-in-a-non-dialog-container.md index 9c54a250016..516e4ac55a1 100644 --- a/docs/mfc/activex-control-containers-using-controls-in-a-non-dialog-container.md +++ b/docs/mfc/activex-control-containers-using-controls-in-a-non-dialog-container.md @@ -3,11 +3,13 @@ description: "Learn more about: ActiveX Control Containers: Using Controls in a title: "ActiveX Control Containers: Using Controls in a Non-Dialog Container" ms.date: "11/04/2016" helpviewer_keywords: ["Create method [MFC], ActiveX controls", "CreateControl method [MFC]", "ActiveX controls [MFC], creating", "ActiveX control containers [MFC], non-dialog containers", "ActiveX control containers [MFC], inserting controls"] -ms.assetid: 46f195b0-b8ca-4409-8cca-fbfaf2c9ab9f --- # ActiveX Control Containers: Using Controls in a Non-Dialog Container -In some applications, such as an SDI or MDI application, you will want to embed a control in a window of the application. The **Create** member function of the wrapper class, inserted by Visual C++, can create an instance of the control dynamically, without the need for a dialog box. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +In some applications, such as an SDI or MDI application, you will want to embed a control in a window of the application. The **Create** member function of the wrapper class, inserted by Visual Studio, can create an instance of the control dynamically, without the need for a dialog box. The **Create** member function has the following parameters: diff --git a/docs/mfc/activex-control-containers-viewing-and-modifying-control-properties.md b/docs/mfc/activex-control-containers-viewing-and-modifying-control-properties.md index a9609867536..201a108b84d 100644 --- a/docs/mfc/activex-control-containers-viewing-and-modifying-control-properties.md +++ b/docs/mfc/activex-control-containers-viewing-and-modifying-control-properties.md @@ -3,11 +3,13 @@ description: "Learn more about: ActiveX Control Containers: Viewing and Modifyin title: "ActiveX Control Containers: Viewing and Modifying Control Properties" ms.date: "11/04/2016" helpviewer_keywords: ["properties [MFC], viewing and modifying", "ActiveX control containers [MFC], viewing and modifying properties", "resource editors, viewing and modifying ActiveX controls", "ActiveX controls [MFC], properties", "controls [MFC], properties"] -ms.assetid: 14ce5152-742b-4e0d-a9ab-c7b456e32918 --- # ActiveX Control Containers: Viewing and Modifying Control Properties -When you insert an ActiveX control into a project, it is useful to view and change the properties supported by the ActiveX control. This article discusses how to use the Visual C++ resource editor to do this. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +When you insert an ActiveX control into a project, it is useful to view and change the properties supported by the ActiveX control. This article discusses how to use the Visual Studio resource editor to do this. If your ActiveX control container application uses embedded controls, you can view and modify the control's properties while in the resource editor. You can also use the resource editor to set property values during design time. The resource editor then automatically saves these values in the project's resource file. Any instance of the control will then have its properties initialized to these values. diff --git a/docs/mfc/activex-control-containers.md b/docs/mfc/activex-control-containers.md index 0201f13955c..30261c43b4f 100644 --- a/docs/mfc/activex-control-containers.md +++ b/docs/mfc/activex-control-containers.md @@ -3,10 +3,12 @@ description: "Learn more about: ActiveX Control Containers" title: "ActiveX Control Containers" ms.date: "09/12/2018" helpviewer_keywords: ["ActiveX control containers [MFC]", "OLE controls [MFC], containers"] -ms.assetid: 0eb1a713-e607-4c79-a0c7-67c5f1fd5fab --- # ActiveX Control Containers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An ActiveX control container is a container that fully supports ActiveX controls and can incorporate them into its own windows or dialogs. An ActiveX control is a reusable software element that you can use in many development projects. Controls allow your application's user to access databases, monitor data, and make various selections within your applications. For more information on ActiveX controls, see the article [MFC ActiveX Controls](mfc-activex-controls.md). >[!IMPORTANT] @@ -20,7 +22,7 @@ Control containers typically take two forms in a project: The ActiveX control container interacts with the control via exposed [methods](mfc-activex-controls-methods.md) and [properties](mfc-activex-controls-properties.md). These methods and properties, which can be accessed and modified by the control container, are accessed through a wrapper class in the ActiveX control container project. The embedded ActiveX control can also interact with the container by firing (sending) [events](mfc-activex-controls-events.md) to notify the container that an action has occurred. The control container can choose to act upon these notifications or not. -Additional articles discuss several topics, from creating an ActiveX control container project to basic implementation issues related to ActiveX control containers built with Visual C++: +Additional articles discuss several topics, from creating an ActiveX control container project to basic implementation issues related to ActiveX control containers built with Visual Studio: - [Creating an MFC ActiveX Control Container](reference/creating-an-mfc-activex-control-container.md) @@ -42,7 +44,7 @@ Additional articles discuss several topics, from creating an ActiveX control con For more information about using ActiveX controls in a dialog box, see the [Dialog Editor](../windows/dialog-editor.md) topics. -For a list of articles that explain the details of developing ActiveX controls using Visual C++ and the MFC ActiveX control classes, see [MFC ActiveX controls](mfc-activex-controls.md). The articles are grouped by functional categories. +For a list of articles that explain the details of developing ActiveX controls using Visual Studio and the MFC ActiveX control classes, see [MFC ActiveX controls](mfc-activex-controls.md). The articles are grouped by functional categories. ## See also diff --git a/docs/mfc/activex-controls-on-the-internet.md b/docs/mfc/activex-controls-on-the-internet.md index 9a73da8ce82..915bab82eb5 100644 --- a/docs/mfc/activex-controls-on-the-internet.md +++ b/docs/mfc/activex-controls-on-the-internet.md @@ -3,10 +3,12 @@ description: "Learn more about: ActiveX Controls on the Internet" title: "ActiveX Controls on the Internet" ms.date: "09/12/2018" helpviewer_keywords: ["ActiveX controls [MFC], creating", "ActiveX controls [MFC], Internet", "downloading data with ActiveX controls", "OLE controls [MFC], upgrading to ActiveX", "Internet applications [MFC], ActiveX controls", "networks [MFC], downloading with ActiveX controls"] -ms.assetid: 7ab943c8-2022-41df-9065-d629b616eeec --- # ActiveX Controls on the Internet +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + ActiveX controls are the updated version of the OLE control specification. >[!IMPORTANT] diff --git a/docs/mfc/activex-controls.md b/docs/mfc/activex-controls.md index af9ca221c6c..936df4c4773 100644 --- a/docs/mfc/activex-controls.md +++ b/docs/mfc/activex-controls.md @@ -3,17 +3,18 @@ description: "Learn more about: ActiveX Controls" title: "ActiveX Controls" ms.date: "09/12/2018" helpviewer_keywords: ["ActiveX controls [MFC]"] -ms.assetid: 52aaec4d-3889-402e-b57d-758078f8ac57 --- # ActiveX Controls -In Visual C++ you can create ActiveX controls using MFC or ATL. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library and Active Template Library (ATL) continue to be supported. However, we're no longer adding features or updating the documentation. + +In Visual Studio you can create ActiveX controls using MFC or ATL. >[!IMPORTANT] > ActiveX is a legacy technology that should not be used for new development. Many capabilities of ActiveX controls can be performed in a simpler and much more secure way with modern technologies such as HTML5 and JavaScript, modern browser extensions, or WebAssembly modules. For more information, see [A break from the past, part 2: Saying goodbye to ActiveX, VBScript, attachEvent](https://blogs.windows.com/msedgedev/2015/05/06/a-break-from-the-past-part-2-saying-goodbye-to-activex-vbscript-attachevent/) and [Native Messaging](/microsoft-edge/extensions/guides/native-messaging) and [Microsoft Edge extensions](/microsoft-edge/extensions) and [WebAssembly](https://webassembly.org/). - [MFC ActiveX Controls](mfc-activex-controls.md) - - [ATL](../atl/active-template-library-atl-concepts.md) ## See also diff --git a/docs/mfc/adding-columns-to-the-control-report-view.md b/docs/mfc/adding-columns-to-the-control-report-view.md index 829a912284b..825e9915515 100644 --- a/docs/mfc/adding-columns-to-the-control-report-view.md +++ b/docs/mfc/adding-columns-to-the-control-report-view.md @@ -3,11 +3,13 @@ description: "Learn more about: Adding Columns to the Control (Report View)" title: "Adding Columns to the Control (Report View)" ms.date: "11/04/2016" helpviewer_keywords: ["CListCtrl class [MFC], adding columns", "report view in CListCtrl class [MFC]", "views [MFC], report", "columns [MFC], adding to CListCtrl", "CListCtrl class [MFC], report view"] -ms.assetid: 7392c0d7-f8a5-4e7b-9ae7-b53dc9dd80ae ms.topic: concept-article --- # Adding Columns to the Control (Report View) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following procedure applies to either a [CListView](reference/clistview-class.md) or [CListCtrl](reference/clistctrl-class.md) object. diff --git a/docs/mfc/adding-controls-by-hand.md b/docs/mfc/adding-controls-by-hand.md index 8945ca7e2a3..1ccec0f6760 100644 --- a/docs/mfc/adding-controls-by-hand.md +++ b/docs/mfc/adding-controls-by-hand.md @@ -3,11 +3,13 @@ description: "Learn more about: Adding Controls By Hand" title: "Adding Controls By Hand" ms.date: "11/04/2016" helpviewer_keywords: ["Windows common controls [MFC], adding", "dialog box controls [MFC], adding to dialog boxes", "controlling input focus", "input focus control", "focus, controlling input [MFC]", "controls [MFC], adding to dialog boxes", "common controls [MFC], adding"] -ms.assetid: bc843e59-0c51-4b5b-8bf2-343f716469d2 ms.topic: concept-article --- # Adding Controls By Hand +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can either [add controls to a dialog box with the dialog editor](using-the-dialog-editor-to-add-controls.md) or add them yourself, with code. To create a control object yourself, you will usually embed the C++ control object in a C++ dialog or frame-window object. Like many other objects in the framework, controls require two-stage construction. You should call the control's **Create** member function as part of creating the parent dialog box or frame window. For dialog boxes, this is usually done in [OnInitDialog](reference/cdialog-class.md#oninitdialog), and for frame windows, in [OnCreate](reference/cwnd-class.md#oncreate). diff --git a/docs/mfc/adding-controls-to-a-property-sheet.md b/docs/mfc/adding-controls-to-a-property-sheet.md index f9fd7130061..c9f162f38b7 100644 --- a/docs/mfc/adding-controls-to-a-property-sheet.md +++ b/docs/mfc/adding-controls-to-a-property-sheet.md @@ -3,11 +3,13 @@ description: "Learn more about: Adding Controls to a Property Sheet" title: "Adding Controls to a Property Sheet" ms.date: "11/04/2016" helpviewer_keywords: ["controls [MFC], adding to property sheets", "property sheets, adding controls"] -ms.assetid: 24ad4c0b-c1db-4850-b9f0-34aae8d74571 ms.topic: concept-article --- # Adding Controls to a Property Sheet +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + By default, a property sheet allocates window area for the property pages, the tab index, and the OK, Cancel, and Apply buttons. (A modeless property sheet does not have the OK, Cancel, and Apply buttons.) You can add other controls to the property sheet. For example, you can add a preview window to the right of the property page area to show the user what the current settings would look like if applied to an external object. You can add controls to the property sheet dialog in the `OnCreate` handler. Accommodating additional controls usually requires expanding the size of the property sheet dialog. After calling the base class **CPropertySheet::OnCreate**, call [GetWindowRect](reference/cwnd-class.md#getwindowrect) to get the width and height of the currently allocated property sheet window, expand the rectangle's dimensions, and call [MoveWindow](reference/cwnd-class.md#movewindow) to change the size of the property sheet window. diff --git a/docs/mfc/adding-items-to-the-control.md b/docs/mfc/adding-items-to-the-control.md index 9019df5d8f5..8d8a14a0003 100644 --- a/docs/mfc/adding-items-to-the-control.md +++ b/docs/mfc/adding-items-to-the-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Adding Items to the Control" title: "Adding Items to the Control" ms.date: "11/04/2016" helpviewer_keywords: ["CListCtrl class [MFC], adding items"] -ms.assetid: 715994bd-340d-4ad2-9882-411654137830 ms.topic: concept-article --- # Adding Items to the Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To add items to the list control ([CListCtrl](reference/clistctrl-class.md)), call one of several versions of the [InsertItem](reference/clistctrl-class.md#insertitem) member function, depending on what information you have. One version takes a [LVITEM](/windows/win32/api/commctrl/ns-commctrl-lvitemw) structure that you prepare. Because the `LVITEM` structure contains numerous members, you have greater control over the attributes of the list control item. Two important members (in regard to the report view) of the `LVITEM` structure are the `iItem` and `iSubItem` members. The `iItem` member is the zero-based index of the item the structure is referencing and the `iSubItem` member is the one-based index of a subitem, or zero if the structure contains information about an item. With these two members you determine, per item, the type and value of subitem information that is displayed when the list control is in report view. For more information, see [CListCtrl::SetItem](reference/clistctrl-class.md#setitem). diff --git a/docs/mfc/adding-items-to-the-header-control.md b/docs/mfc/adding-items-to-the-header-control.md index ad9b3d20dc5..359e8a45b4f 100644 --- a/docs/mfc/adding-items-to-the-header-control.md +++ b/docs/mfc/adding-items-to-the-header-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Adding Items to the Header Control" title: "Adding Items to the Header Control" ms.date: "11/04/2016" helpviewer_keywords: ["controls [MFC], header", "CHeaderCtrl class [MFC], adding items", "header controls [MFC], adding items to"] -ms.assetid: 2e9a28b1-7302-4a93-8037-c5a4183e589a ms.topic: how-to --- # Adding Items to the Header Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + After creating your header control ([CHeaderCtrl](reference/cheaderctrl-class.md)) in its parent window, add as many "header items" as you need: usually one per column. ### To add a header item diff --git a/docs/mfc/adding-multiple-views-to-a-single-document.md b/docs/mfc/adding-multiple-views-to-a-single-document.md index b8e7fd427b4..500f35c74f9 100644 --- a/docs/mfc/adding-multiple-views-to-a-single-document.md +++ b/docs/mfc/adding-multiple-views-to-a-single-document.md @@ -3,11 +3,13 @@ description: "Learn more about: Adding Multiple Views to a Single Document" title: "Adding Multiple Views to a Single Document" ms.date: "11/04/2016" helpviewer_keywords: ["multiple views [MFC], SDI applications", "documents [MFC], multiple views", "single document interface (SDI), adding views", "views [MFC], SDI applications"] -ms.assetid: 86d0c134-01d5-429c-b672-36cfb956dc01 ms.topic: concept-article --- # Adding Multiple Views to a Single Document +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In a single-document interface (SDI) application created with the Microsoft Foundation Class (MFC) Library, each document type is associated with a single view type. In some cases, it is desirable to have the ability to switch the current view of a document with a new view. > [!TIP] diff --git a/docs/mfc/adding-tabs-to-a-tab-control.md b/docs/mfc/adding-tabs-to-a-tab-control.md index b4312763c36..860f6ce1ea2 100644 --- a/docs/mfc/adding-tabs-to-a-tab-control.md +++ b/docs/mfc/adding-tabs-to-a-tab-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Adding Tabs to a Tab Control" title: "Adding Tabs to a Tab Control" ms.date: "11/04/2016" helpviewer_keywords: ["tab controls [MFC], adding tabs", "putting tabs on CTabCtrls [MFC]", "CTabCtrl class [MFC], adding tabs", "tabs [MFC], adding to CTabCtrl class [MFC]"] -ms.assetid: 7f3d9340-e3c7-4c71-9912-be57534ecc78 ms.topic: how-to --- # Adding Tabs to a Tab Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + After creating the tab control ([CTabCtrl](reference/ctabctrl-class.md)), add as many tabs as you need. ### To add a tab item diff --git a/docs/mfc/advantages-of-the-document-view-architecture.md b/docs/mfc/advantages-of-the-document-view-architecture.md index 68755dbc77f..5baaa817716 100644 --- a/docs/mfc/advantages-of-the-document-view-architecture.md +++ b/docs/mfc/advantages-of-the-document-view-architecture.md @@ -3,10 +3,12 @@ description: "Learn more about: Advantages of the Document/View Architecture" title: "Advantages of the Document-View Architecture" ms.date: "11/04/2016" helpviewer_keywords: ["views [MFC], advantages", "document/view architecture [MFC], advantages of"] -ms.assetid: 0bc27071-e120-4889-939c-ce1e61fb9cb3 --- # Advantages of the Document/View Architecture +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The key advantage to using the MFC document/view architecture is that the architecture supports multiple views of the same document particularly well. (If you don't need multiple views and the small overhead of document/view is excessive in your application, you can avoid the architecture. [Alternatives to the Document/View Architecture](alternatives-to-the-document-view-architecture.md).) Suppose your application lets users view numerical data either in spreadsheet form or in chart form. A user might want to see simultaneously both the raw data, in spreadsheet form, and a chart that results from the data. You display these separate views in separate frame windows or in splitter panes within a single window. Now suppose the user can edit the data in the spreadsheet and see the changes instantly reflected in the chart. diff --git a/docs/mfc/allocating-and-deallocating-window-memory.md b/docs/mfc/allocating-and-deallocating-window-memory.md index 5e5645446a9..c8fb0b9f318 100644 --- a/docs/mfc/allocating-and-deallocating-window-memory.md +++ b/docs/mfc/allocating-and-deallocating-window-memory.md @@ -3,11 +3,13 @@ description: "Learn more about: Allocating and Deallocating Window Memory" title: "Allocating and Deallocating Window Memory" ms.date: "11/04/2016" helpviewer_keywords: ["memory allocation, window objects", "memory deallocation", "storage for window objects [MFC]", "memory deallocation, window memory", "window objects [MFC], deallocating memory for", "storage for window objects [MFC], allocating"] -ms.assetid: 7c962539-8461-4846-b5ca-fe3b15c313dc ms.topic: concept-article --- # Allocating and Deallocating Window Memory +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Do not use the C++ **`delete`** operator to destroy a frame window or view. Instead, call the `CWnd` member function `DestroyWindow`. Frame windows, therefore, should be allocated on the heap with operator **`new`**. Be careful when allocating frame windows on the stack frame or globally. Other windows should be allocated on the stack frame whenever possible. ## What do you want to know more about diff --git a/docs/mfc/allocating-gdi-resources.md b/docs/mfc/allocating-gdi-resources.md index d9b1a739458..fb4dc60d44d 100644 --- a/docs/mfc/allocating-gdi-resources.md +++ b/docs/mfc/allocating-gdi-resources.md @@ -3,11 +3,13 @@ description: "Learn more about: Allocating GDI Resources" title: "Allocating GDI Resources" ms.date: "06/03/2019" helpviewer_keywords: ["resources [MFC], printing", "GDI objects [MFC], allocating during printing", "printing [MFC], allocating GDI resources"] -ms.assetid: cef7e94d-5a27-4aea-a9ee-8369fc895d3a ms.topic: concept-article --- # Allocating GDI Resources +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to allocate and deallocate the Windows graphics device interface (GDI) objects needed for printing. > [!NOTE] diff --git a/docs/mfc/alternatives-to-the-document-view-architecture.md b/docs/mfc/alternatives-to-the-document-view-architecture.md index 5254b76bd37..aea82ec47b9 100644 --- a/docs/mfc/alternatives-to-the-document-view-architecture.md +++ b/docs/mfc/alternatives-to-the-document-view-architecture.md @@ -3,10 +3,12 @@ description: "Learn more about: Alternatives to the Document/View Architecture" title: "Alternatives to the Document-View Architecture" ms.date: "11/04/2016" helpviewer_keywords: ["documents [MFC], applications without", "CDocument class [MFC], space requirements", "views [MFC], applications without"] -ms.assetid: 2c22f352-a137-45ce-9971-c142173496fb --- # Alternatives to the Document/View Architecture +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC applications normally use the document/view architecture to manage information, file formats, and the visual representation of data to users. For the majority of desktop applications, the document/view architecture is an appropriate and efficient application architecture. This architecture separates data from viewing and, in most cases, simplifies your application and reduces redundant code. However, the document/view architecture is not appropriate for some situations. Consider these examples: @@ -22,7 +24,7 @@ To create an application that does not use the document/view architecture, clear > [!NOTE] > Dialog-based applications produced by the MFC Application Wizard do not use the document/view architecture, so the **Document/View architecture support** check box is disabled if you select the dialog application type. -The Visual C++ wizards, as well as the source and dialog editors, work with the generated application just as they would with any other Wizard-generated application. The application can support toolbars, scrollbars, and a status bar, and has an **About** box. Your application will not register any document templates, and it will not contain a document class. +The Visual Studio wizards, as well as the source and dialog editors, work with the generated application just as they would with any other Wizard-generated application. The application can support toolbars, scrollbars, and a status bar, and has an **About** box. Your application will not register any document templates, and it will not contain a document class. Note that your generated application has a view class, `CChildView`, derived from `CWnd`. MFC creates and positions one instance of the view class within the frame windows created by your application. MFC still enforces using a view window, because it simplifies positioning and managing the application's content. You can add painting code to the `OnPaint` member of this class. Your code should add scrollbars to the view rather than to the frame. diff --git a/docs/mfc/application-and-thread-support-classes.md b/docs/mfc/application-and-thread-support-classes.md index b05bbbcc85f..dd028a163fd 100644 --- a/docs/mfc/application-and-thread-support-classes.md +++ b/docs/mfc/application-and-thread-support-classes.md @@ -4,10 +4,12 @@ title: "Application and Thread Support Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.support"] helpviewer_keywords: ["application objects [MFC], thread support classes", "lock classes [MFC]", "thread support classes [MFC]", "threading [MFC]", "synchronization classes [MFC], multithreading", "application support classes [MFC]"] -ms.assetid: 3c1d14fd-c35c-48f1-86ce-1e0f9a32c36d --- # Application and Thread Support Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Each application has one and only one application object; this object coordinates other objects in the running program and is derived from `CWinApp`. The Microsoft Foundation Class (MFC) Library supports multiple threads of execution within an application. All applications must have at least one thread; the thread used by your `CWinApp` object is this primary thread. diff --git a/docs/mfc/application-design-choices.md b/docs/mfc/application-design-choices.md index 398024a1216..c4d54447abd 100644 --- a/docs/mfc/application-design-choices.md +++ b/docs/mfc/application-design-choices.md @@ -3,10 +3,12 @@ description: "Learn more about: Application Design Choices" title: "Application Design Choices" ms.date: "09/12/2019" helpviewer_keywords: ["design", "application design [MFC], design goals", "application design [MFC], Internet applications", "Internet applications [MFC], designing applications", "Internet [MFC], vs. intranets", "applications [MFC], Internet", "server applications [MFC], vs. client applications on Internet", "client applications [MFC], vs. server applications on Internet"] -ms.assetid: 9b96172c-b4d4-4c69-bfb2-226ce0de6d08 --- # Application Design Choices +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article discusses some of the design issues to consider when programming for the Internet. Topics covered in this article include: diff --git a/docs/mfc/application-framework.md b/docs/mfc/application-framework.md index 3d7b573f4a3..247ee9f23cd 100644 --- a/docs/mfc/application-framework.md +++ b/docs/mfc/application-framework.md @@ -3,10 +3,12 @@ description: "Learn more about: Application Framework" title: "Application Framework" ms.date: "11/04/2016" helpviewer_keywords: ["application framework [MFC], building applications", "applications [MFC]", "application framework [MFC]"] -ms.assetid: 912684e6-4418-49dc-9877-a4cd19d69d20 --- # Application Framework +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The core of the Microsoft Foundation Class (MFC) Library is an encapsulation of a large portion of the Windows API in C++ form. Library classes represent windows, dialog boxes, device contexts, common GDI objects such as brushes and pens, controls, and other standard Windows items. These classes provide a convenient C++ member function interface to the structures in Windows that they encapsulate. For more about using these classes, see [Window Object Topics](window-objects.md). But the MFC Library also supplies a layer of additional application functionality built on the C++ encapsulation of the Windows API. This layer is a working application framework for Windows that provides most of the common user interface expected of programs for Windows, including toolbars, status bars, printing, print preview, database support, and ActiveX support. [Using the Classes to Write Applications for Windows](using-the-classes-to-write-applications-for-windows.md) explains the framework in detail. diff --git a/docs/mfc/array-list-and-map-classes.md b/docs/mfc/array-list-and-map-classes.md index b0fa8481746..381ad523acb 100644 --- a/docs/mfc/array-list-and-map-classes.md +++ b/docs/mfc/array-list-and-map-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Array, List, and Map Classes" title: "Array, List, and Map Classes" ms.date: "11/04/2016" helpviewer_keywords: ["arrays [MFC], classes", "list classes [MFC]", "collection classes [MFC], maps", "map classes [MFC]", "collection classes [MFC], lists"] -ms.assetid: 81a13a7f-0c2c-4efd-b6bb-b4e624a0743d --- # Array, List, and Map Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For handling aggregates of data, the class library provides a group of collection classes — arrays, lists, and maps — that can hold a variety of object and predefined types. The collections are dynamically sized. These classes can be used in any program, whether written for Windows or not. However, they are most useful for implementing the data structures that define your document classes in the application framework. You can readily derive specialized collection classes from these, or you can create them based on the template classes. For more information about these approaches, see the article [Collections](collections.md). For a list of the template collection classes, see the article [Template Classes for Arrays, Lists, and Maps](template-classes-for-arrays-lists-and-maps.md). Arrays are one-dimensional data structures that are stored contiguously in memory. They support very fast random access since the memory address of any given element can be calculated by multiplying the index of the element by the size of an element and adding the result to the base address of the array. But arrays are very expensive if you have to insert elements into the array, since the entire array past the element inserted has to be moved to make room for the element to be inserted. Arrays can grow and shrink as necessary. diff --git a/docs/mfc/asynchronous-monikers-on-the-internet.md b/docs/mfc/asynchronous-monikers-on-the-internet.md index f9ea5ad99cd..0387ba229f9 100644 --- a/docs/mfc/asynchronous-monikers-on-the-internet.md +++ b/docs/mfc/asynchronous-monikers-on-the-internet.md @@ -3,10 +3,12 @@ description: "Learn more about: Asynchronous Monikers on the Internet" title: "Asynchronous Monikers on the Internet" ms.date: "11/04/2016" helpviewer_keywords: ["ActiveX controls [MFC], asynchronous", "MFC, asynchronous monikers", "asynchronous monikers [MFC]", "Web applications [MFC], asynchronous", "downloading Internet resources and asynchronous monikers", "optimization [MFC], asynchronous downloading across Internet", "Internet [MFC], asynchronous downloading"] -ms.assetid: 418b0c64-0046-4dae-8118-c9c762b5822e --- # Asynchronous Monikers on the Internet +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Internet requires new approaches to application design because of its slow network access. Applications should perform network access asynchronously to avoid stalling the user interface. The MFC class [CAsyncMonikerFile](reference/casyncmonikerfile-class.md) provides asynchronous support for downloading files. With asynchronous monikers, you can extend your COM application to download asynchronously across the Internet and to provide progressive rendering of large objects such as bitmaps and VRML objects. Asynchronous monikers enable an ActiveX control property or a file on the Internet to be downloaded without blocking the response of the user interface. diff --git a/docs/mfc/automation-clients-using-type-libraries.md b/docs/mfc/automation-clients-using-type-libraries.md index d5c6ccb2cc8..5f0c32dc7aa 100644 --- a/docs/mfc/automation-clients-using-type-libraries.md +++ b/docs/mfc/automation-clients-using-type-libraries.md @@ -4,19 +4,21 @@ title: "Automation Clients: Using Type Libraries" ms.date: "11/04/2016" f1_keywords: ["MkTypLib"] helpviewer_keywords: ["clients, Automation", "dispatch class [MFC]", "Automation clients, type libraries", "type libraries, Automation clients", "ODL (Object Description Language)", "ODL files", "classes [MFC], dispatch", "MkTypLib tool", ".odl files"] -ms.assetid: d405bc47-118d-4786-b371-920d035b2047 --- # Automation Clients: Using Type Libraries +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Automation clients must have information about server objects' properties and methods if the clients are to manipulate the servers' objects. Properties have data types; methods often return values and accept parameters. The client requires information about the data types of all of these in order to statically bind to the server object type. This type information can be made known in several ways. The recommended way is to create a type library. For information on [MkTypLib](/windows/win32/Midl/differences-between-midl-and-mktyplib), see the Windows SDK. -Visual C++ can read a type-library file and create a dispatch class derived from [COleDispatchDriver](reference/coledispatchdriver-class.md). An object of that class has properties and operations duplicating those of the server object. Your application calls this object's properties and operations, and functionality inherited from `COleDispatchDriver` routes these calls to the OLE system, which in turn routes them to the server object. +Visual Studio can read a type-library file and create a dispatch class derived from [COleDispatchDriver](reference/coledispatchdriver-class.md). An object of that class has properties and operations duplicating those of the server object. Your application calls this object's properties and operations, and functionality inherited from `COleDispatchDriver` routes these calls to the OLE system, which in turn routes them to the server object. -Visual C++ automatically maintains this type-library file for you if you chose to include Automation when the project was created. As part of each build, the .tlb file will be built with MkTypLib. +Visual Studio automatically maintains this type-library file for you if you chose to include Automation when the project was created. As part of each build, the .tlb file will be built with MkTypLib. ### To create a dispatch class from a type-library (.tlb) file diff --git a/docs/mfc/automation-clients.md b/docs/mfc/automation-clients.md index 989c65eed90..f54f51f9a75 100644 --- a/docs/mfc/automation-clients.md +++ b/docs/mfc/automation-clients.md @@ -3,10 +3,12 @@ description: "Learn more about: Automation Clients" title: "Automation Clients" ms.date: "11/04/2016" helpviewer_keywords: ["clients, Automation", "Automation clients", "type libraries, Automation clients", "clients"] -ms.assetid: 84e34a79-06f6-4752-a33b-ae0ede1d8ecf --- # Automation Clients +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Automation makes it possible for your application to manipulate objects implemented in another application, or to expose objects so they can be manipulated. An Automation client is an application that can manipulate exposed objects belonging to another application. The application that exposes the objects is called the Automation server. The client manipulates the server application's objects by accessing those objects' properties and functions. ### Types of Automation Clients diff --git a/docs/mfc/automation-servers-object-lifetime-issues.md b/docs/mfc/automation-servers-object-lifetime-issues.md index 457ac5ea555..6f33844414c 100644 --- a/docs/mfc/automation-servers-object-lifetime-issues.md +++ b/docs/mfc/automation-servers-object-lifetime-issues.md @@ -3,10 +3,12 @@ description: "Learn more about: Automation Servers: Object-Lifetime Issues" title: "Automation Servers: Object-Lifetime Issues" ms.date: "11/04/2016" helpviewer_keywords: ["objects [MFC], lifetime", "lifetime, automation server", "Automation servers, object lifetime", "servers, lifetime of Automation"] -ms.assetid: 342baacf-4015-4a0e-be2f-321424f1cb43 --- # Automation Servers: Object-Lifetime Issues +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When an Automation client creates or activates an OLE item, the server passes the client a pointer to that object. The client establishes a reference to the object through a call to the OLE function [IUnknown::AddRef](/windows/win32/api/unknwn/nf-unknwn-iunknown-addref). This reference is in effect until the client calls [IUnknown::Release](/windows/win32/api/unknwn/nf-unknwn-iunknown-release). (Client applications written with the Microsoft Foundation Class Library's OLE classes need not make these calls; the framework does so.) The OLE system and the server itself may establish references to the object. A server should not destroy an object as long as external references to the object remain in effect. The framework maintains an internal count of the number of references to any server object derived from [CCmdTarget](reference/ccmdtarget-class.md). This count is updated when an Automation client or other entity adds or releases a reference to the object. diff --git a/docs/mfc/automation-servers.md b/docs/mfc/automation-servers.md index 5a8b3b31a32..18100344f5f 100644 --- a/docs/mfc/automation-servers.md +++ b/docs/mfc/automation-servers.md @@ -3,10 +3,12 @@ description: "Learn more about: Automation Servers" title: "Automation Servers" ms.date: "11/04/2016" helpviewer_keywords: ["Automation servers", "COM components, Automation servers", "dispatch maps [MFC], Automation servers", "servers, Automation"] -ms.assetid: 523fd155-51ce-4f91-b986-b74bdbdd7d92 --- # Automation Servers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Automation makes it possible for your application to manipulate objects implemented in another application, or to expose objects so they can be manipulated. An Automation server is an application that exposes programmable objects (called Automation objects) to other applications (called [Automation clients](automation-clients.md)). Automation servers are sometimes called Automation components. Exposing Automation objects enables clients to automate certain procedures by directly accessing the objects and functionality the server makes available. Exposing objects this way is beneficial when applications provide functionality that is useful for other applications. For example, a word processor might expose its spell-checking functionality so that other programs can use it. Exposure of objects thus enables vendors to improve their applications' functionality by using the ready-made functionality of other applications. @@ -20,7 +22,7 @@ By exposing application functionality through a common, well-defined interface, ## Support for Automation Servers -Visual C++ and the MFC framework provide extensive support for Automation servers. They handle much of the overhead involved in making an Automation server, so you can focus your efforts on the functionality of your application. +Visual Studio and the MFC framework provide extensive support for Automation servers. They handle much of the overhead involved in making an Automation server, so you can focus your efforts on the functionality of your application. The framework's principal mechanism for supporting Automation is the dispatch map, a set of macros that expands into the declarations and calls needed to expose methods and properties for OLE. A typical dispatch map looks like this: diff --git a/docs/mfc/automation.md b/docs/mfc/automation.md index beca853d89d..82f2e62b4e8 100644 --- a/docs/mfc/automation.md +++ b/docs/mfc/automation.md @@ -3,10 +3,12 @@ description: "Learn more about: Automation" title: "Automation" ms.date: "11/04/2016" helpviewer_keywords: ["Automation servers, about Automation servers", "clients, Automation", "programmatic control [MFC]", "properties [MFC], Automation", "MFC, COM support", "OLE Automation", "Automation", "servers [MFC], Automation", "Automation clients", "sample applications [MFC], Automation", "methods [MFC]", "passing parameters, Automation", "Automation method [MFC]", "Automation, passing parameters", "Automation property [MFC]", "MFC COM, Automation", "methods [MFC], Automation"] -ms.assetid: 329117f0-c1aa-4680-a901-bfb71277dfba --- # Automation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Automation (formerly known as OLE Automation) makes it possible for one application to manipulate objects implemented in another application, or to expose objects so they can be manipulated. An [Automation server](automation-servers.md) is an application (a type of COM server) that exposes its functionality through COM interfaces to other applications, called [Automation clients](automation-clients.md). The exposure enables Automation clients to automate certain functions by directly accessing objects and using the services they provide. @@ -23,7 +25,7 @@ As another example, a word processor might expose its spell-checking functionali More important is the support Automation provides to users and solution providers. By exposing application functionality through a common, well-defined interface, Automation makes it possible to build comprehensive solutions in a single general programming language, such as Microsoft Visual Basic, instead of in diverse application-specific macro languages. -Many commercial applications, such as Microsoft Excel and Microsoft Visual C++, allow you to automate much of their functionality. For example, in Visual C++, you can write VBScript macros to automate builds, aspects of code editing, or debugging tasks. +Many commercial applications, such as Microsoft Excel and Visual Studio, allow you to automate much of their functionality. For example, in Visual Studio, you can write VBScript macros to automate builds, aspects of code editing, or debugging tasks. ## Passing Parameters in Automation diff --git a/docs/mfc/bottomless-rich-edit-controls.md b/docs/mfc/bottomless-rich-edit-controls.md index c157bbf3bd6..a967cd0b048 100644 --- a/docs/mfc/bottomless-rich-edit-controls.md +++ b/docs/mfc/bottomless-rich-edit-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Bottomless Rich Edit Controls" title: "Bottomless Rich Edit Controls" ms.date: "11/04/2016" helpviewer_keywords: ["bottomless rich edit controls", "rich edit controls [MFC], bottomless", "CRichEditCtrl class [MFC], bottomless"] -ms.assetid: 2877dd32-1e9a-4fd1-98c0-66dcbbeef1de --- # Bottomless Rich Edit Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Your application can resize a rich edit control ([CRichEditCtrl](reference/cricheditctrl-class.md)) as needed so that it is always the same size as its contents. A rich edit control supports this so-called "bottomless" functionality by sending its parent window an [EN_REQUESTRESIZE](/windows/win32/Controls/en-requestresize) notification message whenever the size of its contents changes. When processing the **EN_REQUESTRESIZE** notification message, an application should resize the control to the dimensions in the specified [REQRESIZE](/windows/win32/api/richedit/ns-richedit-reqresize) structure. An application might also move any information near the control to accommodate the control's change in height. To resize the control, you can use the `CWnd` function [SetWindowPos](reference/cwnd-class.md#setwindowpos). diff --git a/docs/mfc/build-requirements-for-windows-vista-common-controls.md b/docs/mfc/build-requirements-for-windows-vista-common-controls.md index 1120d633c74..b54c1c9796d 100644 --- a/docs/mfc/build-requirements-for-windows-vista-common-controls.md +++ b/docs/mfc/build-requirements-for-windows-vista-common-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Build Requirements for Windows Common Controls" title: "Build Requirements for Windows Common Controls" ms.date: "08/19/2019" helpviewer_keywords: ["Common Controls (MFC), build requirements", "Common Controls (MFC)"] -ms.assetid: 025f7d55-55a2-4dcd-8f62-02424e3dcc04 ms.topic: how-to --- # Build Requirements for Windows Common Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class (MFC) library supports [Windows Common Controls](/windows/win32/controls/common-controls-intro). The Common Controls are included in Windows and the library is included in Visual Studio. The MFC library provides new methods that enhance existing classes, and additional classes and methods that support Windows Common Controls. When you build your application, you should follow the compilation and migration requirements that are described in the following sections. ## Compilation Requirements diff --git a/docs/mfc/building-on-the-framework.md b/docs/mfc/building-on-the-framework.md index 7b339c588e9..e11f3d9f318 100644 --- a/docs/mfc/building-on-the-framework.md +++ b/docs/mfc/building-on-the-framework.md @@ -3,11 +3,13 @@ description: "Learn more about: Building on the Framework" title: "Building on the Framework" ms.date: "11/04/2016" helpviewer_keywords: ["application-specific classes [MFC]", "application framework [MFC], building applications", "applications [MFC]", "MFC, application development"] -ms.assetid: 883f0f19-866f-4221-8a3d-5607941dc8d0 ms.topic: concept-article --- # Building on the Framework +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Your role in configuring an application with the MFC framework is to supply the application-specific source code and to connect the components by defining what messages and commands to which they respond. You use the C++ language and standard C++ techniques to derive your own application-specific classes from those supplied by the class library and to override and augment the base class's behavior. In related topics, the following tables describe the general sequence of operations you will typically follow and your responsibilities versus the framework's responsibilities: diff --git a/docs/mfc/bypassing-the-serialization-mechanism.md b/docs/mfc/bypassing-the-serialization-mechanism.md index 045392c70cc..0ea67bc23c5 100644 --- a/docs/mfc/bypassing-the-serialization-mechanism.md +++ b/docs/mfc/bypassing-the-serialization-mechanism.md @@ -3,11 +3,13 @@ description: "Learn more about: Bypassing the Serialization Mechanism" title: "Bypassing the Serialization Mechanism" ms.date: "11/04/2016" helpviewer_keywords: ["archive objects [MFC]", "bypassing serialization", "archives [MFC], serialization", "serialization [MFC], bypassing", "archives [MFC]", "serialization [MFC], role of framework", "serialization [MFC], overriding"] -ms.assetid: 48d4a279-b51c-4ba5-81cd-ed043312b582 ms.topic: concept-article --- # Bypassing the Serialization Mechanism +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As you have seen, the framework provides a default way to read and write data to and from files. Serializing through an archive object suits the needs of a great many applications. Such an application reads a file entirely into memory, lets the user update the file, and then writes the updated version to disk again. However, some applications operate on data very differently, and for these applications serialization through an archive is not suitable. Examples include database programs, programs that edit only parts of large files, programs that write text-only files, and programs that share data files. diff --git a/docs/mfc/callback-items-and-the-callback-mask.md b/docs/mfc/callback-items-and-the-callback-mask.md index d94e970a78f..b130b9c51b1 100644 --- a/docs/mfc/callback-items-and-the-callback-mask.md +++ b/docs/mfc/callback-items-and-the-callback-mask.md @@ -3,10 +3,12 @@ description: "Learn more about: Callback Items and the Callback Mask" title: "Callback Items and the Callback Mask" ms.date: "11/04/2016" helpviewer_keywords: ["callback items in CListCtrl class [MFC]", "CListCtrl class [MFC], callback item and callback mask"] -ms.assetid: 67c1f76f-6144-453e-9376-6712f89430ae --- # Callback Items and the Callback Mask +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For each of its items, a list view control typically stores the label text, the image list index of the item's icons, and a set of bit flags for the item's state. You can define individual items as callback items, which are useful if your application already stores some of the information for an item. You define an item as a callback item by specifying appropriate values for the `pszText` and `iImage` members of the `LVITEM` structure (see [CListCtrl::GetItem](reference/clistctrl-class.md#getitem)). If the application maintains the item's or subitem's text, specify the **LPSTR_TEXTCALLBACK** value for the `pszText` member. If the application keeps track of the icon for the item, specify the **I_IMAGECALLBACK** value for the `iImage` member. diff --git a/docs/mfc/changing-list-control-styles.md b/docs/mfc/changing-list-control-styles.md index 3f64060811f..3dbf36eb17a 100644 --- a/docs/mfc/changing-list-control-styles.md +++ b/docs/mfc/changing-list-control-styles.md @@ -3,11 +3,13 @@ description: "Learn more about: Changing List Control Styles" title: "Changing List Control Styles" ms.date: "11/04/2016" helpviewer_keywords: ["styles [MFC], CListCtrl", "CListCtrl class [MFC], styles", "CListCtrl class [MFC], changing styles"] -ms.assetid: be74a005-0795-417c-9056-f6342aa74b26 ms.topic: concept-article --- # Changing List Control Styles +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can change the window style of a list control ([CListCtrl](reference/clistctrl-class.md)) at any time after you create it. By changing the window style, you change the kind of view the control uses. For example, to emulate the Explorer, you might supply menu items or toolbar buttons for switching the control between different views: icon view, list view, and so on. For example, when the user selects your menu item, you could make a call to [GetWindowLong](/windows/win32/api/winuser/nf-winuser-getwindowlongw) to retrieve the current style of the control and then call [SetWindowLong](/windows/win32/api/winuser/nf-winuser-setwindowlongw) to reset the style. For more information, see [Using List View Controls](/windows/win32/Controls/using-list-view-controls) in the Windows SDK. diff --git a/docs/mfc/changing-the-styles-of-a-window-created-by-mfc.md b/docs/mfc/changing-the-styles-of-a-window-created-by-mfc.md index eb6d87a53c4..cd497f782a3 100644 --- a/docs/mfc/changing-the-styles-of-a-window-created-by-mfc.md +++ b/docs/mfc/changing-the-styles-of-a-window-created-by-mfc.md @@ -3,11 +3,13 @@ description: "Learn more about: Changing the Styles of a Window Created by MFC" title: "Changing the Styles of a Window Created by MFC" ms.date: "11/04/2016" helpviewer_keywords: ["window styles [MFC]", "WS_OVERLAPPEDWINDOW macro [MFC]", "single document interface (SDI), changing window attributes", "MDI [MFC], window styles", "windows [MFC], MFC", "child windows [MFC], styles", "MFC, windows", "CFrameWnd class [MFC], window styles", "CREATESTRUCT macro [MFC]", "CMDIChildWnd class [MFC], changing window styles", "multidocument interface style", "PreCreateWindow method [MFC], window styles", "single document interface (SDI), style", "default window style", "defaults [MFC], window style", "PreCreateWindow method [MFC], changing window styles", "CMainFrame class [MFC]", "styles [MFC], windows"] -ms.assetid: 77fa4f03-96b4-4687-9ade-41e46f7e4b0a ms.topic: concept-article --- # Changing the Styles of a Window Created by MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In its version of the `WinMain` function, MFC registers several standard window classes for you. Because you don't normally edit MFC's `WinMain`, that function gives you no opportunity to change the MFC default window styles. This article explains how you can change the styles of such a preregistered window class in an existing application. ## Changing Styles in a New MFC Application diff --git a/docs/mfc/character-formatting-in-rich-edit-controls.md b/docs/mfc/character-formatting-in-rich-edit-controls.md index 640717720d1..ed92e73f6da 100644 --- a/docs/mfc/character-formatting-in-rich-edit-controls.md +++ b/docs/mfc/character-formatting-in-rich-edit-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Character Formatting in Rich Edit Controls" title: "Character Formatting in Rich Edit Controls" ms.date: "11/04/2016" helpviewer_keywords: ["formatting [MFC], characters", "rich edit controls [MFC], character formatting in", "CRichEditCtrl class [MFC], character formatting in"] -ms.assetid: c80f4305-75ad-45f9-8d17-d83d0fe79be5 --- # Character Formatting in Rich Edit Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can use member functions of the rich edit control ([CRichEditCtrl](reference/cricheditctrl-class.md)) to format characters and to retrieve formatting information. For characters, you can specify typeface, size, color, and effects such as bold, italic, and protected. You can apply character formatting by using the [SetSelectionCharFormat](reference/cricheditctrl-class.md#setselectioncharformat) and [SetWordCharFormat](reference/cricheditctrl-class.md#setwordcharformat) member functions. To determine the current character formatting for the selected text, use the [GetSelectionCharFormat](reference/cricheditctrl-class.md#getselectioncharformat) member function. The [CHARFORMAT](/windows/win32/api/richedit/ns-richedit-charformata) structure is used with these member functions to specify character attributes. One of the important members of **CHARFORMAT** is **dwMask**. In `SetSelectionCharFormat` and `SetWordCharFormat`, **dwMask** specifies which character attributes will be set by this function call. `GetSelectionCharFormat` reports the attributes of the first character in the selection; **dwMask** specifies the attributes that are consistent throughout the selection. diff --git a/docs/mfc/class-library-overview.md b/docs/mfc/class-library-overview.md index 514443b1180..95f1076e12d 100644 --- a/docs/mfc/class-library-overview.md +++ b/docs/mfc/class-library-overview.md @@ -4,11 +4,13 @@ title: "Class Library Overview" ms.date: "09/17/2019" f1_keywords: ["vc.classes.mfc"] helpviewer_keywords: ["grouping MFC classes", "MFC, class library", "classes [MFC], MFC", "class libraries, MFC", "class libraries"] -ms.assetid: 9b0e3152-ac39-4f52-91b4-f20aa3a674aa ms.topic: concept-article --- # Class Library Overview +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This overview categorizes and describes the classes in the Microsoft Foundation Class Library (MFC) version 9.0. The classes in MFC, taken together, constitute an application framework — the framework of an application written for the Windows API. Your programming task is to fill in the code that is specific to your application. The library's classes are presented here in the following categories: diff --git a/docs/mfc/classes-related-to-rich-edit-controls.md b/docs/mfc/classes-related-to-rich-edit-controls.md index 2f7155637b6..de2b4a37401 100644 --- a/docs/mfc/classes-related-to-rich-edit-controls.md +++ b/docs/mfc/classes-related-to-rich-edit-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Classes Related to Rich Edit Controls" title: "Classes Related to Rich Edit Controls" ms.date: "11/04/2016" helpviewer_keywords: ["rich edit controls [MFC], and CRichEditItem", "CRichEditCtrl class [MFC], related classes", "CRichEditDoc class [MFC], Rich Edit controls", "rich edit controls [MFC], classes related to", "classes [MFC], related to rich edit controls", "rich edit controls [MFC], and CRichEditView", "CRichEditCtrlItem class and CRichEditCtrl", "rich edit controls [MFC], and CRichEditDoc", "CRichEditView class [MFC], and CRichEditCtrl"] -ms.assetid: 4b31c2cc-6ea1-4146-b7c5-b0b5b419f14d --- # Classes Related to Rich Edit Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [CRichEditView](reference/cricheditview-class.md), [CRichEditDoc](reference/cricheditdoc-class.md), and [CRichEditCntrItem](reference/cricheditcntritem-class.md) classes provide the functionality of the rich edit control ([CRichEditCtrl](reference/cricheditctrl-class.md)) within the context of MFC's document/view architecture. `CRichEditView` maintains the text and formatting characteristic of text. `CRichEditDoc` maintains the list of OLE client items that are in the view. `CRichEditCntrItem` provides container-side access to the OLE client item. To modify the contents of a `CRichEditView`, use [CRichEditView::GetRichEditCtrl](reference/cricheditview-class.md#getricheditctrl) to access the underlying rich edit control. ## See also diff --git a/docs/mfc/cleaning-up-documents-and-views.md b/docs/mfc/cleaning-up-documents-and-views.md index ff3d94b0ca2..91b6ec01c28 100644 --- a/docs/mfc/cleaning-up-documents-and-views.md +++ b/docs/mfc/cleaning-up-documents-and-views.md @@ -3,11 +3,13 @@ description: "Learn more about: Cleaning Up Documents and Views" title: "Cleaning Up Documents and Views" ms.date: "11/04/2016" helpviewer_keywords: ["views [MFC], cleaning up", "documents [MFC], cleaning up", "documents [MFC], closing"] -ms.assetid: 0c454db2-3644-434d-9e53-8108a7aedfe1 ms.topic: concept-article --- # Cleaning Up Documents and Views +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When a document is closing, the framework first calls its [DeleteContents](reference/cdocument-class.md#deletecontents) member function. If you allocated any memory on the heap during the course of the document's operation, `DeleteContents` is the best place to deallocate it. > [!NOTE] diff --git a/docs/mfc/clipboard-adding-other-formats.md b/docs/mfc/clipboard-adding-other-formats.md index f3e9ef9e30b..235d391e58c 100644 --- a/docs/mfc/clipboard-adding-other-formats.md +++ b/docs/mfc/clipboard-adding-other-formats.md @@ -3,10 +3,12 @@ description: "Learn more about: Clipboard: Adding Other Formats" title: "Clipboard: Adding Other Formats" ms.date: "11/04/2016" helpviewer_keywords: ["formats [MFC], Clipboard", "Clipboard, formats", "custom formats, placing on Clipboard", "custom formats", "registering custom Clipboard data formats", "custom Clipboard data formats"] -ms.assetid: aea58159-65ed-4385-aeaa-3d9d5281903b --- # Clipboard: Adding Other Formats +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic explains how to expand the list of supported formats, particularly for OLE support. The topic [Clipboard: Copying and Pasting Data](clipboard-copying-and-pasting-data.md) describes the minimum implementation necessary to support copying and pasting from the Clipboard. If this is all you implement, the only formats placed on the Clipboard are **CF_METAFILEPICT**, **CF_EMBEDSOURCE**, **CF_OBJECTDESCRIPTOR**, and possibly **CF_LINKSOURCE**. Most applications will need more formats on the Clipboard than these three. ## Registering Custom Formats diff --git a/docs/mfc/clipboard-copying-and-pasting-data.md b/docs/mfc/clipboard-copying-and-pasting-data.md index 4225da141bf..f2e50f84159 100644 --- a/docs/mfc/clipboard-copying-and-pasting-data.md +++ b/docs/mfc/clipboard-copying-and-pasting-data.md @@ -3,10 +3,12 @@ description: "Learn more about: Clipboard: Copying and Pasting Data" title: "Clipboard: Copying and Pasting Data" ms.date: "11/04/2016" helpviewer_keywords: ["Clipboard, copying data to", "Clipboard, pasting"] -ms.assetid: 580e10be-241f-4f9f-94cf-8302edc5beef --- # Clipboard: Copying and Pasting Data +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic describes the minimum work necessary to implement copying to and pasting from the Clipboard in your OLE application. It is recommended that you read the [Data Objects and Data Sources (OLE)](data-objects-and-data-sources-ole.md) topics before proceeding. Before you can implement either copying or pasting, you must first provide functions to handle the Copy, Cut, and Paste options on the Edit menu. diff --git a/docs/mfc/clipboard-operations-in-rich-edit-controls.md b/docs/mfc/clipboard-operations-in-rich-edit-controls.md index 972af313345..08b46730de2 100644 --- a/docs/mfc/clipboard-operations-in-rich-edit-controls.md +++ b/docs/mfc/clipboard-operations-in-rich-edit-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Clipboard Operations in Rich Edit Controls" title: "Clipboard Operations in Rich Edit Controls" ms.date: "11/04/2016" helpviewer_keywords: ["pasting Clipboard data", "CRichEditCtrl class [MFC], paste operation", "cut operation in CRichEditCtrl class [MFC]", "CRichEditCtrl class [MFC], Clipboard operations", "copy operations in rich edit controls", "Clipboard, operations in CRichEditCtrl", "rich edit controls [MFC], Clipboard operations"] -ms.assetid: 15ce66bc-2636-4a35-a2ae-d52285dc1af6 --- # Clipboard Operations in Rich Edit Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Your application can paste the contents of the Clipboard into a rich edit control ([CRichEditCtrl](reference/cricheditctrl-class.md)) using either the best available Clipboard format or a specific Clipboard format. You can also determine whether a rich edit control is capable of pasting a Clipboard format. You can copy or cut the contents of the current selection by using the [Copy](reference/cricheditctrl-class.md#copy) or [Cut](reference/cricheditctrl-class.md#cut) member function. Similarly, you can paste the contents of the Clipboard into a rich edit control by using the [Paste](reference/cricheditctrl-class.md#paste) member function. The control pastes the first available format that it recognizes, which presumably is the most descriptive format. diff --git a/docs/mfc/clipboard-using-the-ole-clipboard-mechanism.md b/docs/mfc/clipboard-using-the-ole-clipboard-mechanism.md index 53da3be2654..288e42cffd2 100644 --- a/docs/mfc/clipboard-using-the-ole-clipboard-mechanism.md +++ b/docs/mfc/clipboard-using-the-ole-clipboard-mechanism.md @@ -3,10 +3,12 @@ description: "Learn more about: Clipboard: Using the OLE Clipboard Mechanism" title: "Clipboard: Using the OLE Clipboard Mechanism" ms.date: "11/04/2016" helpviewer_keywords: ["applications [OLE], Clipboard", "OLE Clipboard", "Clipboard [MFC], OLE formats", "OLE Clipboard, formats", "formats [MFC], Clipboard for OLE"] -ms.assetid: 229cc610-5bb1-435e-bd20-2c8b9964d1af --- # Clipboard: Using the OLE Clipboard Mechanism +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + OLE uses standard formats and some OLE-specific formats for transferring data through the Clipboard. When you cut or copy data from an application, the data is stored on the Clipboard to be used later in paste operations. This data is in a variety of formats. When a user chooses to paste data from the Clipboard, the application can choose which of these formats to use. The application should be written to choose the format that provides the most information, unless the user specifically asks for a certain format, using Paste Special. Before continuing, you may want to read the [Data Objects and Data Sources (OLE)](data-objects-and-data-sources-ole.md) topics. They describe the fundamentals of how data transfers work, and how to implement them in your applications. diff --git a/docs/mfc/clipboard-using-the-windows-clipboard.md b/docs/mfc/clipboard-using-the-windows-clipboard.md index 64d3123609b..648e989ca4f 100644 --- a/docs/mfc/clipboard-using-the-windows-clipboard.md +++ b/docs/mfc/clipboard-using-the-windows-clipboard.md @@ -3,10 +3,12 @@ description: "Learn more about: Clipboard: Using the Windows Clipboard" title: "Clipboard: Using the Windows Clipboard" ms.date: "11/04/2016" helpviewer_keywords: ["Clipboard commands", "Cut/Copy and Paste command handler functions [MFC]", "handler functions, Cut/Copy and Paste commands", "Clipboard [MFC], commands", "commands [MFC], implementing Edit", "Clipboard commands [MFC], implementing", "Windows Clipboard [MFC]", "Clipboard [MFC], Windows Clipboard API"] -ms.assetid: 24415b42-9301-4a70-b69a-44c97918319f --- # Clipboard: Using the Windows Clipboard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic describes how to use the standard Windows Clipboard API within your MFC application. Most applications for Windows support cutting or copying data to the Windows Clipboard and pasting data from the Clipboard. The Clipboard data formats vary among applications. The framework supports only a limited number of Clipboard formats for a limited number of classes. You will normally implement the Clipboard-related commands — Cut, Copy, and Paste — on the Edit menu for your view. The class library defines the command IDs for these commands: **ID_EDIT_CUT**, **ID_EDIT_COPY**, and **ID_EDIT_PASTE**. Their message-line prompts are also defined. @@ -19,7 +21,7 @@ The Cut, Copy, and Paste commands are only meaningful in certain contexts. The C The Microsoft Foundation Class Library does provide Clipboard support for text editing with the `CEdit` and `CEditView` classes. The OLE classes also simplify implementing Clipboard operations that involve OLE items. For more information on the OLE classes, see [Clipboard: Using the OLE Clipboard Mechanism](clipboard-using-the-ole-clipboard-mechanism.md). -Implementing other Edit menu commands, such as Undo (**ID_EDIT_UNDO**) and Redo (**ID_EDIT_REDO**), is also left to you. If your application does not support these commands, you can easily delete them from your resource file using the Visual C++ resource editors. +Implementing other Edit menu commands, such as Undo (**ID_EDIT_UNDO**) and Redo (**ID_EDIT_REDO**), is also left to you. If your application does not support these commands, you can easily delete them from your resource file using the Visual Studio resource editors. ## What do you want to know more about diff --git a/docs/mfc/clipboard-when-to-use-each-clipboard-mechanism.md b/docs/mfc/clipboard-when-to-use-each-clipboard-mechanism.md index b9c8f734ae9..28de3cdfcfc 100644 --- a/docs/mfc/clipboard-when-to-use-each-clipboard-mechanism.md +++ b/docs/mfc/clipboard-when-to-use-each-clipboard-mechanism.md @@ -3,10 +3,12 @@ description: "Learn more about: Clipboard: When to Use Each Clipboard Mechanism" title: "Clipboard: When to Use Each Clipboard Mechanism" ms.date: "11/04/2016" helpviewer_keywords: ["applications [OLE], Clipboard", "OLE Clipboard, guidelines", "Clipboard [MFC], mechanisms", "OLE Clipboard, formats", "formats [MFC], Clipboard for OLE", "Clipboard [MFC], formats"] -ms.assetid: fd071996-ef8c-488b-81bd-89057095a201 --- # Clipboard: When to Use Each Clipboard Mechanism +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Follow these guidelines in using the Clipboard: - Use the OLE Clipboard mechanism now to enable new capabilities in the future. While the standard Clipboard API will be maintained, the OLE mechanism is the future of data transfer. diff --git a/docs/mfc/clipboard.md b/docs/mfc/clipboard.md index 9e667377481..cbbc987570c 100644 --- a/docs/mfc/clipboard.md +++ b/docs/mfc/clipboard.md @@ -3,10 +3,12 @@ description: "Learn more about: Clipboard" title: "Clipboard" ms.date: "11/04/2016" helpviewer_keywords: ["cutting and copying data", "copying data", "Clipboard", "Clipboard, programming", "transferring data"] -ms.assetid: a71b2824-1f14-4914-8816-54578d73ad4e --- # Clipboard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This family of articles explains how to implement support for the Windows Clipboard in MFC applications. The Windows Clipboard is used in two ways: - Implementing standard Edit menu commands, such as Cut, Copy, and Paste. diff --git a/docs/mfc/closing-files.md b/docs/mfc/closing-files.md index 2e72fde16a9..84f96abc670 100644 --- a/docs/mfc/closing-files.md +++ b/docs/mfc/closing-files.md @@ -3,11 +3,13 @@ description: "Learn more about: Closing Files" title: "Closing Files" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, file operations", "files [MFC], closing"] -ms.assetid: 8415a3a8-3c75-45b0-ac2a-d5385f49bdb3 ms.topic: how-to --- # Closing Files +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As usual in I/O operations, once you finish with a file, you must close it. #### To close a file diff --git a/docs/mfc/closing-the-dialog-box.md b/docs/mfc/closing-the-dialog-box.md index 38ab0e8290a..bd987c2dd53 100644 --- a/docs/mfc/closing-the-dialog-box.md +++ b/docs/mfc/closing-the-dialog-box.md @@ -3,11 +3,13 @@ description: "Learn more about: Closing the Dialog Box" title: "Closing the Dialog Box" ms.date: "11/04/2016" helpviewer_keywords: ["MFC dialog boxes [MFC], closing", "dialog boxes [MFC], closing"] -ms.assetid: 946f5675-c482-46a4-a5dd-34fe138ffae5 ms.topic: concept-article --- # Closing the Dialog Box +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A modal dialog box closes when the user chooses one of its buttons, typically the OK button or the Cancel button. Choosing the OK or Cancel button causes Windows to send the dialog object a **BN_CLICKED** control-notification message with the button's ID, either **IDOK** or **IDCANCEL**. `CDialog` provides default handler functions for these messages: `OnOK` and `OnCancel`. The default handlers call the `EndDialog` member function to close the dialog window. You can also call `EndDialog` from your own code. For more information, see the [EndDialog](reference/cdialog-class.md#enddialog) member function of class `CDialog` in the *MFC Reference*. To arrange for closing and deleting a modeless dialog box, override `PostNcDestroy` and invoke the **`delete`** operator on the **`this`** pointer. [Destroying the Dialog Box](destroying-the-dialog-box.md) explains what happens next. diff --git a/docs/mfc/cobject-class-frequently-asked-questions.md b/docs/mfc/cobject-class-frequently-asked-questions.md index 2689374466d..9e356260f82 100644 --- a/docs/mfc/cobject-class-frequently-asked-questions.md +++ b/docs/mfc/cobject-class-frequently-asked-questions.md @@ -3,11 +3,13 @@ description: "Learn more about: CObject Class: Frequently Asked Questions" title: "CObject Class: Frequently Asked Questions" ms.date: "11/04/2016" helpviewer_keywords: ["CObject class [MFC], FAQ"] -ms.assetid: 809a8b99-a2f8-4e16-8b4b-023c94f4125c ms.topic: faq --- # CObject Class: Frequently Asked Questions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This section covers questions on class `CObject`. ## What do you want to know more about diff --git a/docs/mfc/codesnippet/CPP/clistbox-class_23.cpp b/docs/mfc/codesnippet/CPP/clistbox-class_23.cpp index 7301b4da087..f7c839534b6 100644 --- a/docs/mfc/codesnippet/CPP/clistbox-class_23.cpp +++ b/docs/mfc/codesnippet/CPP/clistbox-class_23.cpp @@ -1,6 +1,6 @@ -// Initialize the storage of the list box to be 256 strings with -// about 10 characters per string, performance improvement. -int n = m_myListBox.InitStorage(256, 16 * sizeof(TCHAR)); +// Reserve space in the list box for 256 additional strings with +// about 15 characters per string. +int n = m_myListBox.InitStorage(256, 256 * (15 + 1) * sizeof(TCHAR)); ASSERT(n != LB_ERRSPACE); // Add 256 items to the list box. diff --git a/docs/mfc/collections.md b/docs/mfc/collections.md index 7d2d849f052..233816a3beb 100644 --- a/docs/mfc/collections.md +++ b/docs/mfc/collections.md @@ -3,10 +3,12 @@ description: "Learn more about: Collections" title: "Collections" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, collections", "arrays [MFC], classes", "MFC collection classes", "shapes, collection", "collection classes [MFC], MFC", "collections, about collections", "array templates [MFC]", "collection classes [MFC], template-based", "collection classes [MFC], about collection classes", "collection classes [MFC], maps", "collection classes [MFC], arrays", "shapes", "collection classes [MFC], lists", "collection classes [MFC], shapes"] -ms.assetid: 02586e4c-851d-41d0-a722-feb11c17c74c --- # Collections +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class Library provides collection classes to manage groups of objects. These classes are of two types: - [Collection classes created from C++ templates](#_core_the_template_based_collection_classes) diff --git a/docs/mfc/com-interface-entry-points.md b/docs/mfc/com-interface-entry-points.md index 1a35f4c9324..b91a767e41c 100644 --- a/docs/mfc/com-interface-entry-points.md +++ b/docs/mfc/com-interface-entry-points.md @@ -3,10 +3,12 @@ description: "Learn more about: COM Interface Entry Points" title: "COM Interface Entry Points" ms.date: "03/27/2019" helpviewer_keywords: ["entry points, COM interfaces", "state management, OLE/COM interfaces", "MFC COM, COM interface entry points", "OLE, interface entry points", "MFC, managing state data", "COM interfaces, entry points"] -ms.assetid: 9e7421dc-0731-4748-9e1b-90acbaf26d77 --- # COM Interface Entry Points +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For member functions of a COM interface, use the `METHOD_PROLOGUE` macro to maintain the proper global state when calling methods of an exported interface. Typically, member functions of interfaces implemented by `CCmdTarget`-derived objects already use this macro to provide automatic initialization of the `pThis` pointer. For example: diff --git a/docs/mfc/command-ids.md b/docs/mfc/command-ids.md index aacb5c805f9..250be8c082e 100644 --- a/docs/mfc/command-ids.md +++ b/docs/mfc/command-ids.md @@ -3,15 +3,17 @@ description: "Learn more about: Command IDs" title: "Command IDs" ms.date: "11/04/2016" helpviewer_keywords: ["command IDs, MFC", "command IDs"] -ms.assetid: e0171a2b-45b9-41fa-945d-ec2f7602ded0 --- # Command IDs +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A command is fully described by its command ID alone (encoded in the **WM_COMMAND** message). This ID is assigned to the user-interface object that generates the command. Typically, IDs are named for the functionality of the user-interface object they are assigned to. For example, a Clear All item in the Edit menu might be assigned an ID such as **ID_EDIT_CLEAR_ALL**. The class library predefines some IDs, particularly for commands that the framework handles itself, such as **ID_EDIT_CLEAR_ALL** or **ID_FILE_OPEN**. You will create other command IDs yourself. -When you create your own menus in the Visual C++ menu editor, it is a good idea to follow the class library's naming convention as illustrated by **ID_FILE_OPEN**. [Standard Commands](standard-commands.md) explains the standard commands defined by the class library. +When you create your own menus in the Visual Studio menu editor, it is a good idea to follow the class library's naming convention as illustrated by **ID_FILE_OPEN**. [Standard Commands](standard-commands.md) explains the standard commands defined by the class library. ## See also diff --git a/docs/mfc/command-routing-classes.md b/docs/mfc/command-routing-classes.md index 267d4b9b8ef..e77f0a2b5bd 100644 --- a/docs/mfc/command-routing-classes.md +++ b/docs/mfc/command-routing-classes.md @@ -4,10 +4,12 @@ title: "Command Routing Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.command"] helpviewer_keywords: ["MFC, command routing", "command routing [MFC], classes"] -ms.assetid: 4b50e689-2c54-4e6c-90f0-37333e22b2a1 --- # Command Routing Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As the user interacts with the application by choosing menus or control-bar buttons with the mouse, the application sends messages from the affected user-interface object to an appropriate command-target object. Command-target classes derived from `CCmdTarget` include [CWinApp](reference/cwinapp-class.md), [CWnd](reference/cwnd-class.md), [CDocTemplate](reference/cdoctemplate-class.md), [CDocument](reference/cdocument-class.md), [CView](reference/cview-class.md), and the classes derived from them. The framework supports automatic command routing so that commands can be handled by the most appropriate object currently active in the application. An object of class `CCmdUI` is passed to your command targets' update command UI ([ON_UPDATE_COMMAND_UI](reference/message-map-macros-mfc.md#on_update_command_ui)) handlers to allow you to update the state of the user interface for a particular command (for instance, to check or remove the check from menu items). You call member functions of the `CCmdUI` object to update the state of the UI object. This process is the same whether the UI object associated with a particular command is a menu item or a button or both. diff --git a/docs/mfc/command-routing-illustration.md b/docs/mfc/command-routing-illustration.md index 29ae9a7f00a..4274d6930bd 100644 --- a/docs/mfc/command-routing-illustration.md +++ b/docs/mfc/command-routing-illustration.md @@ -3,11 +3,13 @@ description: "Learn more about: Command Routing Illustration" title: "Command Routing Illustration" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, command routing", "command handling [MFC], routing commands", "command routing [MFC], OnCmdMsg handler"] -ms.assetid: 4b7b4741-565f-4878-b076-fd85c670f87f ms.topic: how-to --- # Command Routing Illustration +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To illustrate, consider a command message from a Clear All menu item in an MDI application's Edit menu. Suppose the handler function for this command happens to be a member function of the application's document class. Here's how that command reaches its handler after the user chooses the menu item: 1. The main frame window receives the command message first. diff --git a/docs/mfc/command-routing.md b/docs/mfc/command-routing.md index a3514eb4e28..8f140daaf38 100644 --- a/docs/mfc/command-routing.md +++ b/docs/mfc/command-routing.md @@ -3,11 +3,13 @@ description: "Learn more about: Command Routing" title: "Command Routing" ms.date: "09/06/2019" helpviewer_keywords: ["MFC, command routing", "command handling [MFC], routing commands", "handlers [MFC]", "handlers, command [MFC]", "command routing"] -ms.assetid: 9393a956-bdd4-47c5-9013-dbd680433f93 ms.topic: how-to --- # Command Routing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Your responsibility in working with commands is limited to making message-map connections between commands and their handler functions, a task for which you use the [MFC Class Wizard](reference/mfc-class-wizard.md). You must also write the code for the command handlers. Windows messages are usually sent to the main frame window, but command messages are then routed to other objects. The framework routes commands through a standard sequence of command-target objects, one of which is expected to have a handler for the command. Each command-target object checks its message map to see if it can handle the incoming message. diff --git a/docs/mfc/command-targets.md b/docs/mfc/command-targets.md index 5e7a2bf8afd..74b9485cd3e 100644 --- a/docs/mfc/command-targets.md +++ b/docs/mfc/command-targets.md @@ -3,10 +3,12 @@ description: "Learn more about: Command Targets" title: "Command Targets" ms.date: "11/04/2016" helpviewer_keywords: ["command targets", "command mapping", "messages, command [MFC]", "command routing [MFC], command targets"] -ms.assetid: b0f784e5-c6dc-4391-9e71-aa7b7dcbe9f0 --- # Command Targets +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The figure [Commands in the Framework](user-interface-objects-and-command-ids.md) shows the connection between a user-interface object, such as a menu item, and the handler function that the framework calls to carry out the resulting command when the object is clicked. Windows sends messages that are not command messages directly to a window whose handler for the message is then called. However, the framework routes commands to a number of candidate objects — called "command targets" — one of which normally invokes a handler for the command. The handler functions work the same way for both commands and standard Windows messages, but the mechanisms by which they are called are different, as explained in [How the Framework Calls a Handler](how-the-framework-calls-a-handler.md). diff --git a/docs/mfc/common-control-sample-list.md b/docs/mfc/common-control-sample-list.md index 4f4e326f4d2..b28e441457f 100644 --- a/docs/mfc/common-control-sample-list.md +++ b/docs/mfc/common-control-sample-list.md @@ -3,10 +3,12 @@ description: "Learn more about: Common Control Sample List" title: "Common Control Sample List" ms.date: "11/04/2016" helpviewer_keywords: ["sample applications [MFC], common controls"] -ms.assetid: 8ae39e2d-12a8-4b17-909d-5bf155749123 --- # Common Control Sample List +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + See the following sample programs that illustrate common controls: - [CMNCTRL1](../overview/visual-cpp-samples.md) diff --git a/docs/mfc/common-dialog-classes.md b/docs/mfc/common-dialog-classes.md index f6221b488d6..329144187af 100644 --- a/docs/mfc/common-dialog-classes.md +++ b/docs/mfc/common-dialog-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Common Dialog Classes" title: "Common Dialog Classes" ms.date: "11/04/2016" helpviewer_keywords: ["dialog classes [MFC]", "dialog boxes [MFC], Windows common dialogs", "common dialog boxes [MFC], common dialog classes", "common dialog classes [MFC]", "MFC dialog boxes [MFC], Windows common dialogs", "Windows common dialogs [MFC]", "dialog classes [MFC], common", "common dialog boxes [MFC]"] -ms.assetid: 5c4f6443-896c-4b05-a7df-8169fdadc71d --- # Common Dialog Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In addition to class [CDialog](reference/cdialog-class.md), MFC supplies several classes derived from `CDialog` that encapsulate commonly used dialog boxes, as shown in the following table. The dialog boxes encapsulated are called the "common dialog boxes" and are part of the Windows common dialog library (COMMDLG.DLL). The dialog-template resources and code for these classes are provided in the Windows common dialog boxes that are part of Windows versions 3.1 and later. ### Common Dialog Classes diff --git a/docs/mfc/commonly-added-member-functions.md b/docs/mfc/commonly-added-member-functions.md index b5fb6d99fda..0fb89df0040 100644 --- a/docs/mfc/commonly-added-member-functions.md +++ b/docs/mfc/commonly-added-member-functions.md @@ -3,10 +3,12 @@ description: "Learn more about: Commonly Added Member Functions" title: "Commonly Added Member Functions" ms.date: "11/04/2016" helpviewer_keywords: ["CDialog class [MFC], members", "MFC dialog boxes [MFC], control-notification messages", "dialog classes [MFC], commonly added member functions"] -ms.assetid: f6bd50e8-872a-4039-9996-a85bfccea18d --- # Commonly Added Member Functions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If your dialog box contains pushbuttons other than OK or Cancel, you need to write message-handler member functions in your dialog class to respond to the control-notification messages they generate. For an example, see the [Scribble](../overview/visual-cpp-samples.md) sample program. You can also handle control-notification messages from other controls in your dialog box. ## See also diff --git a/docs/mfc/commonly-overridden-member-functions.md b/docs/mfc/commonly-overridden-member-functions.md index 41cd982858e..5e25df0d7ef 100644 --- a/docs/mfc/commonly-overridden-member-functions.md +++ b/docs/mfc/commonly-overridden-member-functions.md @@ -3,10 +3,12 @@ description: "Learn more about: Commonly Overridden Member Functions" title: "Commonly Overridden Member Functions" ms.date: "09/06/2019" helpviewer_keywords: ["CDialog class [MFC], members", "OnInitDialog function", "dialog classes [MFC], commonly overridden member functions", "OnCancel function", "overriding, dialog class members", "OnOK function", "MFC dialog boxes [MFC], overriding member functions"] -ms.assetid: 78eb566c-e361-4c86-8db5-c7e2791b249a --- # Commonly Overridden Member Functions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table lists the most likely member functions to override in your `CDialog`-derived class. ### Commonly Overridden Member Functions of Class CDialog diff --git a/docs/mfc/communicating-with-a-tree-control.md b/docs/mfc/communicating-with-a-tree-control.md index 959c9f1fbd6..cc35ab04f2f 100644 --- a/docs/mfc/communicating-with-a-tree-control.md +++ b/docs/mfc/communicating-with-a-tree-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Communicating with a Tree Control" title: "Communicating with a Tree Control" ms.date: "11/04/2016" helpviewer_keywords: ["tree controls [MFC], communicating with", "CTreeCtrl class [MFC], calling member functions", "communications, tree controls", "tree controls"] -ms.assetid: 680ad9ee-b11f-452d-93fa-501ca7d7e069 ms.topic: concept-article --- # Communicating with a Tree Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You use different methods for calling member functions in a [CTreeCtrl](reference/ctreectrl-class.md) object depending on how the object was created: - If the tree control is in a dialog box, use a member variable of type `CTreeCtrl` that you create in the dialog box class. diff --git a/docs/mfc/connection-points.md b/docs/mfc/connection-points.md index fff0b34d7c8..239f9206513 100644 --- a/docs/mfc/connection-points.md +++ b/docs/mfc/connection-points.md @@ -4,10 +4,12 @@ title: "Connection Points" ms.date: "11/19/2018" f1_keywords: ["IConnectionPoint"] helpviewer_keywords: ["IConnectionPoint interface", "connections, connection points", "OLE COM connection points", "MFC COM, connection points", "COM, connection points", "interfaces, IConnectionPoint", "MFC, COM support", "connection points [MFC]", "CCmdTarget class [MFC], and connection points", "sinks, connection points"] -ms.assetid: bc9fd7c7-8df6-4752-ac8c-0b177442c88d --- # Connection Points +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to implement connection points (formerly known as OLE connection points) using the MFC classes `CCmdTarget` and `CConnectionPoint`. In the past, the Component Object Model (COM) defined a general mechanism (`IUnknown::QueryInterface`*) that allowed objects to implement and expose functionality in interfaces. However, a corresponding mechanism that allowed objects to expose their capability to call specific interfaces was not defined. That is, COM defined how incoming pointers to objects (pointers to that object's interfaces) were handled, but it did not have an explicit model for outgoing interfaces (pointers the object holds to other objects' interfaces). COM now has a model, called connection points, that supports this functionality. diff --git a/docs/mfc/containers-advanced-features.md b/docs/mfc/containers-advanced-features.md index 41c1ce872bf..e4eff569a72 100644 --- a/docs/mfc/containers-advanced-features.md +++ b/docs/mfc/containers-advanced-features.md @@ -3,10 +3,12 @@ description: "Learn more about: Containers: Advanced Features" title: "Containers: Advanced Features" ms.date: "11/04/2016" helpviewer_keywords: ["links [MFC], to embedded OLE objects", "containers [MFC], links to embedded OLE objects", "containers [MFC], advanced features", "container/server applications [MFC]", "embedded objects [MFC]", "OLE controls [MFC], containers", "OLE containers [MFC], advanced features", "server/container applications [MFC]", "containers [MFC], container applications"] -ms.assetid: 221fd99c-b138-40fa-ad6a-974e3b3ad1f8 --- # Containers: Advanced Features +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the steps necessary to incorporate optional advanced features into existing container applications. These features are: - [An application that is both a container and a server](#_core_creating_a_container_server_application) diff --git a/docs/mfc/containers-client-item-notifications.md b/docs/mfc/containers-client-item-notifications.md index aff7be898fc..81b3d44d4b9 100644 --- a/docs/mfc/containers-client-item-notifications.md +++ b/docs/mfc/containers-client-item-notifications.md @@ -3,10 +3,12 @@ description: "Learn more about: Containers: Client-Item Notifications" title: "Containers: Client-Item Notifications" ms.date: "11/04/2016" helpviewer_keywords: ["notifications [MFC], container client item", "OLE containers [MFC], client-item notifications", "client items and OLE containers"] -ms.assetid: e1f1c427-01f5-45f2-b496-c5bce3d76340 --- # Containers: Client-Item Notifications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article discusses the overridable functions that the MFC framework calls when server applications modify items in your client application's document. [COleClientItem](reference/coleclientitem-class.md) defines several overridable functions that are called in response to requests from the component application, which is also called the server application. These overridables usually act as notifications. They inform the container application of various events, such as scrolling, activation, or a change of position, and of changes that the user makes when editing or otherwise manipulating the item. diff --git a/docs/mfc/containers-client-item-states.md b/docs/mfc/containers-client-item-states.md index 3c0cd589309..a457c8b1b25 100644 --- a/docs/mfc/containers-client-item-states.md +++ b/docs/mfc/containers-client-item-states.md @@ -3,10 +3,12 @@ description: "Learn more about: Containers: Client-Item States" title: "Containers: Client-Item States" ms.date: "11/04/2016" helpviewer_keywords: ["OLE containers [MFC], client-item states", "states, OLE container client-item", "lifetime, lifetime states and OLE container client items", "client items and OLE containers"] -ms.assetid: e7021caa-bd07-4adb-976e-f5f3d025bc53 --- # Containers: Client-Item States +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the different states a client item passes through in its lifetime. A client item passes through several states as it is created, activated, modified, and saved. Each time the item's state changes, the framework calls [COleClientItem::OnChange](reference/coleclientitem-class.md#onchange) with the **OLE_CHANGED_STATE** notification. The second parameter is a value from the `COleClientItem::ItemState` enumeration. It can be one of the following: diff --git a/docs/mfc/containers-client-items.md b/docs/mfc/containers-client-items.md index f2e17257faa..9778f9c51c1 100644 --- a/docs/mfc/containers-client-items.md +++ b/docs/mfc/containers-client-items.md @@ -3,10 +3,12 @@ description: "Learn more about: Containers: Client Items" title: "Containers: Client Items" ms.date: "11/04/2016" helpviewer_keywords: ["OLE containers [MFC], client items", "client items and OLE containers"] -ms.assetid: 231528b5-0744-4f83-8897-083bf55ed087 --- # Containers: Client Items +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains what client items are and from what classes your application should derive its client items. Client items are data items belonging to another application that are either contained in or referenced by an OLE container application's document. Client items whose data is contained within the document are embedded; those whose data is stored in another location referenced by the container document are linked. diff --git a/docs/mfc/containers-compound-files.md b/docs/mfc/containers-compound-files.md index 0ae34087ac0..bfd759966e5 100644 --- a/docs/mfc/containers-compound-files.md +++ b/docs/mfc/containers-compound-files.md @@ -3,10 +3,12 @@ description: "Learn more about: Containers: Compound Files" title: "Containers: Compound Files" ms.date: "11/04/2016" helpviewer_keywords: ["compound files [MFC]", "compound documents", "containers [MFC], compound files", "OLE documents [MFC], compound files", "performance [MFC], compound files", "files [MFC], compound", "standardized file structure compound files", "documents [MFC], compound", "documents [MFC], OLE", "OLE containers [MFC], compound files", "access modes for files [MFC]"] -ms.assetid: 8b83cb3e-76c8-4bbe-ba16-737092b36f49 --- # Containers: Compound Files +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the components and implementation of compound files and the advantages and disadvantages of using compound files in your OLE applications. Compound files are an integral part of OLE. They are used to facilitate data transfer and OLE document storage. Compound files are an implementation of the Active structured storage model. Consistent interfaces exist that support serialization to a storage, a stream, or a file object. Compound files are supported in the Microsoft Foundation Class Library by the classes `COleStreamFile` and `COleDocument`. diff --git a/docs/mfc/containers-for-activex-controls.md b/docs/mfc/containers-for-activex-controls.md index 6f6926c793a..08fb52eff64 100644 --- a/docs/mfc/containers-for-activex-controls.md +++ b/docs/mfc/containers-for-activex-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Containers for ActiveX Controls" title: "Containers for ActiveX Controls" ms.date: "09/12/2018" helpviewer_keywords: ["ActiveX control containers [MFC], application support"] -ms.assetid: 5ff0bf37-07f4-49aa-ad9c-c63d3756243a --- # Containers for ActiveX Controls -You can use ActiveX controls developed in Visual C++ in other applications, as long as they support ActiveX control containment. A number of Microsoft applications, beginning with the versions listed, support ActiveX control containment. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +You can use ActiveX controls developed in Visual Studio in other applications, as long as they support ActiveX control containment. A number of Microsoft applications, beginning with the versions listed, support ActiveX control containment. >[!IMPORTANT] > ActiveX is a legacy technology that should not be used for new development. For more information about modern technologies that supersede ActiveX, see [ActiveX Controls](activex-controls.md). diff --git a/docs/mfc/containers-implementing-a-container.md b/docs/mfc/containers-implementing-a-container.md index c6dbc10dc32..4fa39bc520c 100644 --- a/docs/mfc/containers-implementing-a-container.md +++ b/docs/mfc/containers-implementing-a-container.md @@ -3,10 +3,12 @@ description: "Learn more about: Containers: Implementing a Container" title: "Containers: Implementing a Container" ms.date: "11/04/2016" helpviewer_keywords: ["applications [OLE], OLE container", "OLE containers [MFC], implementing"] -ms.assetid: af1e2079-619a-4eac-9327-985ad875823a --- # Containers: Implementing a Container +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article summarizes the procedure for implementing a container and points you to other articles that provide more detailed explanations about implementing containers. It also lists some optional OLE features you may want to implement and the articles describing these features. #### To prepare your CWinApp-derived class diff --git a/docs/mfc/containers-user-interface-issues.md b/docs/mfc/containers-user-interface-issues.md index 1e9cd232f72..94b3f0aa1d9 100644 --- a/docs/mfc/containers-user-interface-issues.md +++ b/docs/mfc/containers-user-interface-issues.md @@ -3,10 +3,12 @@ description: "Learn more about: Containers: User-Interface Issues" title: "Containers: User-Interface Issues" ms.date: "11/04/2016" helpviewer_keywords: ["containers [MFC], user-interface issues", "OLE containers [MFC], user interface", "user interface issues"] -ms.assetid: c833c249-a633-4f1c-82d6-ec6b4892863a --- # Containers: User-Interface Issues +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You must add a number of features to a container application's user interface to adequately manage linked and embedded items. These features involve changes to the menu structure and to the events that the application handles. For detailed information about them, see the following articles: |For information on|See| diff --git a/docs/mfc/containers.md b/docs/mfc/containers.md index a7fff2b8a52..8936ef14fca 100644 --- a/docs/mfc/containers.md +++ b/docs/mfc/containers.md @@ -3,10 +3,12 @@ description: "Learn more about: Containers" title: "Containers" ms.date: "11/04/2016" helpviewer_keywords: ["containers [MFC]", "OLE containers", "application containers [MFC]", "containers [MFC], OLE container applications", "containers [MFC], container applications"] -ms.assetid: b19d7c05-4d02-44bd-b76a-4a6c25994a62 --- # Containers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A container application is an application that can incorporate embedded or linked items into its own documents. The documents managed by a container application must be able to store and display OLE compound document components as well as data created by the application itself. A container application must also allow users to insert new items or edit existing items. ## In This Section diff --git a/docs/mfc/control-bar-classes.md b/docs/mfc/control-bar-classes.md index 83d7dc63c7e..e24776d9fd5 100644 --- a/docs/mfc/control-bar-classes.md +++ b/docs/mfc/control-bar-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Control Bar Classes" title: "Control Bar Classes" ms.date: "11/04/2016" helpviewer_keywords: ["control bars [MFC], classes"] -ms.assetid: 11009103-cad8-4309-85ce-3d2e858e1818 --- # Control Bar Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Control bars are attached to a frame window. They contain buttons, status panes, or a dialog template. Free-floating control bars, also called tool palettes, are implemented by attaching them to a [CMiniFrameWnd](reference/cminiframewnd-class.md) object. ## Framework Control Bars diff --git a/docs/mfc/control-bars.md b/docs/mfc/control-bars.md index 70b65d5e778..d4aa5c879e2 100644 --- a/docs/mfc/control-bars.md +++ b/docs/mfc/control-bars.md @@ -3,10 +3,12 @@ description: "Learn more about: Control Bars" title: "Control Bars" ms.date: "11/04/2016" helpviewer_keywords: ["command bars [MFC], types of", "toolbars [MFC], control bars", "control bars [MFC]", "MFC, control bars", "control bars [MFC], types of", "CDialogBar class [MFC], control bars", "status bars [MFC], control bars", "CControlBar class [MFC], MFC control bars", "dialog bars [MFC], control bars", "CToolBar class [MFC], control bars", "CStatusBar class [MFC], control bars"] -ms.assetid: 31831910-3d23-4d70-9e71-03cc02f01ec4 --- # Control Bars +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + "Control bar" is the general name for toolbars, status bars, and dialog bars. MFC classes `CToolBar`, `CStatusBar`, `CDialogBar`, `COleResizeBar`, and `CReBar` derive from class [CControlBar](reference/ccontrolbar-class.md), which implements their common functionality. Control bars are windows that display rows of controls with which users can select options, execute commands, or obtain program information. Types of control bars include toolbars, dialog bars, and status bars. diff --git a/docs/mfc/control-classes.md b/docs/mfc/control-classes.md index 39a211802cc..10517c135b1 100644 --- a/docs/mfc/control-classes.md +++ b/docs/mfc/control-classes.md @@ -4,10 +4,12 @@ title: "Control Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.control"] helpviewer_keywords: ["static display controls [MFC]", "control classes [MFC]", "buttons, MFC control classes", "controls [MFC], MFC control classes", "controls [MFC]", "list boxes [MFC], MFC control classes", "control classes [MFC], MFC", "text, controls for input [MFC]", "user input [MFC], MFC control classes"] -ms.assetid: f9876606-9f5b-44cb-9135-213298d1df8f --- # Control Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Control classes encapsulate a wide variety of standard Windows controls ranging from static text controls to tree controls. In addition, MFC provides some new controls, including buttons with bitmaps and control bars. The controls whose class names end in "**Ctrl**" were new in Windows 95 and Windows NT version 3.51. diff --git a/docs/mfc/controls-mfc.md b/docs/mfc/controls-mfc.md index fda1eeccf12..c5801b29796 100644 --- a/docs/mfc/controls-mfc.md +++ b/docs/mfc/controls-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Controls (MFC)" title: "Controls (MFC)" ms.date: "11/04/2016" helpviewer_keywords: ["Windows common controls [MFC]", "common controls [MFC]", "controls [MFC]"] -ms.assetid: b2842884-6435-4b8f-933b-21671bf8af95 --- # Controls (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Controls are objects that users can interact with to enter or manipulate data. They commonly appear in dialog boxes or on toolbars. This topic family covers three main kinds of controls: - Windows common controls, including owner-drawn controls @@ -17,7 +19,7 @@ Controls are objects that users can interact with to enter or manipulate data. T ## Windows Common Controls -The Windows operating system has always provided a number of Windows common controls. These control objects are programmable, and the Visual C++ dialog editor supports adding them to your dialog boxes. The Microsoft Foundation Class Library (MFC) supplies classes that encapsulate each of these controls, as shown in the table [Windows Common Controls and MFC Classes](#_core_windows_common_controls_and_mfc_classes). (Some items in the table have related topics that describe them further. For controls that lack topics, see the documentation for the MFC class.) +The Windows operating system has always provided a number of Windows common controls. These control objects are programmable, and the Visual Studio dialog editor supports adding them to your dialog boxes. The Microsoft Foundation Class Library (MFC) supplies classes that encapsulate each of these controls, as shown in the table [Windows Common Controls and MFC Classes](#_core_windows_common_controls_and_mfc_classes). (Some items in the table have related topics that describe them further. For controls that lack topics, see the documentation for the MFC class.) Class [CWnd](reference/cwnd-class.md) is the base class of all window classes, including all of the control classes. diff --git a/docs/mfc/creating-a-ctoolbarctrl-object.md b/docs/mfc/creating-a-ctoolbarctrl-object.md index a474106b412..f5bc8b35611 100644 --- a/docs/mfc/creating-a-ctoolbarctrl-object.md +++ b/docs/mfc/creating-a-ctoolbarctrl-object.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating a CToolBarCtrl Object" title: "Creating a CToolBarCtrl Object" ms.date: "11/04/2016" helpviewer_keywords: ["toolbar controls [MFC], creating", "CToolBarCtrl class [MFC], creating toolbars"] -ms.assetid: a4f6bf0c-0195-4dbf-a09e-aee503e19dc3 ms.topic: how-to --- # Creating a CToolBarCtrl Object +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + [CToolBarCtrl](reference/ctoolbarctrl-class.md) objects contain several internal data structures — a list of button image bitmaps, a list of button label strings, and a list of `TBBUTTON` structures — that associate an image and/or string with the position, style, state, and command ID of the button. Each of the elements of these data structures is referred to by a zero-based index. Before you can use a `CToolBarCtrl` object, you must set up these data structures. For a list of the data structures, see [Toolbar Controls](controls-mfc.md) in the Windows SDK. The list of strings can only be used for button labels; you cannot retrieve strings from the toolbar. To use a `CToolBarCtrl` object, you will typically follow these steps: diff --git a/docs/mfc/creating-a-dialog-class-with-code-wizards.md b/docs/mfc/creating-a-dialog-class-with-code-wizards.md index b57a8a37d9f..392782ede1d 100644 --- a/docs/mfc/creating-a-dialog-class-with-code-wizards.md +++ b/docs/mfc/creating-a-dialog-class-with-code-wizards.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating a Dialog Class with Code Wizards" title: "Creating a Dialog Class with Code Wizards" ms.date: "11/04/2016" helpviewer_keywords: ["dialog boxes [MFC], creating", "MFC dialog boxes, creating", "code wizards", "dialog classes [MFC], creating"] -ms.assetid: a7157b9d-f1a8-4381-a4cf-180cd2c7f1b2 ms.topic: concept-article --- # Creating a Dialog Class with Code Wizards +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table lists dialog-related tasks that Code Wizards help you manage. ### Dialog-Related Tasks diff --git a/docs/mfc/creating-a-modeless-property-sheet.md b/docs/mfc/creating-a-modeless-property-sheet.md index 923076c45a7..0301f3ffcbc 100644 --- a/docs/mfc/creating-a-modeless-property-sheet.md +++ b/docs/mfc/creating-a-modeless-property-sheet.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating a Modeless Property Sheet" title: "Creating a Modeless Property Sheet" ms.date: "11/04/2016" helpviewer_keywords: ["modeless property sheets", "property sheets, modeless", "Create method [MFC], property sheets"] -ms.assetid: eafd8a92-cc67-4a69-a5fb-742c920d1ae8 ms.topic: concept-article --- # Creating a Modeless Property Sheet +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Normally, the property sheets you create will be modal. When using a modal property sheet, the user must close the property sheet before using any other part of the application. This article describes methods you can use to create a modeless property sheet that allows the user to keep the property sheet open while using other parts of the application. To display a property sheet as a modeless dialog box instead of as a modal dialog box, call [CPropertySheet::Create](reference/cpropertysheet-class.md#create) instead of [DoModal](reference/cpropertysheet-class.md#domodal). You must also implement some extra tasks to support a modeless property sheet. diff --git a/docs/mfc/creating-a-rebar-control.md b/docs/mfc/creating-a-rebar-control.md index ecbd59c97a3..08b253503eb 100644 --- a/docs/mfc/creating-a-rebar-control.md +++ b/docs/mfc/creating-a-rebar-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating a Rebar Control" title: "Creating a Rebar Control" ms.date: "11/04/2016" helpviewer_keywords: ["rebar controls [MFC], creating", "CReBarCtrl class [MFC], creating"] -ms.assetid: 0a012e08-772b-4f6a-af86-7cb651d11d3e ms.topic: how-to --- # Creating a Rebar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + [CReBarCtrl](reference/crebarctrl-class.md) objects should be created before the parent object is visible. This minimizes the possibilities of painting problems. For instance, rebar controls (used in frame window objects) are commonly used as parent windows for toolbar controls. Therefore, the parent of the rebar control is the frame window object. Because the frame window object is the parent, the `OnCreate` member function (of the parent) is an excellent place to create the rebar control. diff --git a/docs/mfc/creating-an-active-document-container-application.md b/docs/mfc/creating-an-active-document-container-application.md index c1ef6e9ac2d..397172bbc4c 100644 --- a/docs/mfc/creating-an-active-document-container-application.md +++ b/docs/mfc/creating-an-active-document-container-application.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating an Active Document Container Applicatio title: "Creating an Active Document Container Application" ms.date: "11/04/2016" helpviewer_keywords: ["active documents [MFC], containers", "containers [MFC], active document", "active document containers [MFC], creating", "MFC COM, active document containment", "applications [MFC], active document container"] -ms.assetid: 14e2d022-a6c5-4249-8712-706b0f4433f7 ms.topic: how-to --- # Creating an Active Document Container Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The simplest and most recommended way to create an active document container application is to create an MFC EXE container application using the MFC Application Wizard, then modify the application to support active document containment. #### To create an active document container application diff --git a/docs/mfc/creating-an-extended-combo-box-control.md b/docs/mfc/creating-an-extended-combo-box-control.md index c39f606ba2e..3d49c2a16d3 100644 --- a/docs/mfc/creating-an-extended-combo-box-control.md +++ b/docs/mfc/creating-an-extended-combo-box-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating an Extended Combo Box Control" title: "Creating an Extended Combo Box Control" ms.date: "11/04/2016" helpviewer_keywords: ["extended combo boxes", "CComboBoxEx class [MFC], creating extended combo box controls", "extended combo boxes [MFC], creating"] -ms.assetid: a964267e-97b6-4e77-9f89-55bb5c68913f ms.topic: how-to --- # Creating an Extended Combo Box Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + How the extended combo box control is created depends on whether you are using the control in a dialog box or creating it in a nondialog window. ### To use CComboBoxEx directly in a dialog box diff --git a/docs/mfc/creating-and-displaying-dialog-boxes.md b/docs/mfc/creating-and-displaying-dialog-boxes.md index 233faf62b31..cb4c355f408 100644 --- a/docs/mfc/creating-and-displaying-dialog-boxes.md +++ b/docs/mfc/creating-and-displaying-dialog-boxes.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating and Displaying Dialog Boxes" title: "Creating and Displaying Dialog Boxes" ms.date: "11/04/2016" helpviewer_keywords: ["modal dialog boxes [MFC], creating", "opening dialog boxes", "modeless dialog boxes [MFC], creating", "MFC dialog boxes [MFC], creating", "MFC dialog boxes [MFC], displaying"] -ms.assetid: 1c5219ee-8b46-44bc-9708-83705d4f248b ms.topic: concept-article --- # Creating and Displaying Dialog Boxes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Creating a dialog object is a two-phase operation. First, construct the dialog object, then create the dialog window. Modal and modeless dialog boxes differ somewhat in the process used to create and display them. The following table lists how modal and modeless dialog boxes are normally constructed and displayed. ### Dialog Creation diff --git a/docs/mfc/creating-document-frame-windows.md b/docs/mfc/creating-document-frame-windows.md index 5c2f43a082b..8004e63a1ac 100644 --- a/docs/mfc/creating-document-frame-windows.md +++ b/docs/mfc/creating-document-frame-windows.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating Document Frame Windows" title: "Creating Document Frame Windows" ms.date: "11/04/2016" helpviewer_keywords: ["frame windows [MFC], creating", "document templates [MFC], and document frame windows", "windows [MFC], creating", "runtime, class information", "run-time class [MFC], and document frame window creation", "document frame windows [MFC], creating", "MFC, frame windows"] -ms.assetid: 8671e239-b76f-4dea-afa8-7024e6e58ff5 ms.topic: concept-article --- # Creating Document Frame Windows +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + [Document/View Creation](document-view-creation.md) shows how the [CDocTemplate](reference/cdoctemplate-class.md) object orchestrates creating the frame window, document, and view and connecting them all together. Three [CRuntimeClass](reference/cruntimeclass-structure.md) arguments to the `CDocTemplate` constructor specify the frame window, document, and view classes that the document template creates dynamically in response to user commands such as the New command on the File menu or the New Window command on an MDI Window menu. The document template stores this information for later use when it creates a frame window for a view and document. For the [RUNTIME_CLASS](reference/run-time-object-model-services.md#runtime_class) mechanism to work correctly, your derived frame-window classes must be declared with the [DECLARE_DYNCREATE](reference/run-time-object-model-services.md#declare_dyncreate) macro. This is because the framework needs to create document frame windows using the dynamic construction mechanism of class `CObject`. diff --git a/docs/mfc/creating-modal-dialog-boxes.md b/docs/mfc/creating-modal-dialog-boxes.md index 6275a7e461f..a9a4c045f99 100644 --- a/docs/mfc/creating-modal-dialog-boxes.md +++ b/docs/mfc/creating-modal-dialog-boxes.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating Modal Dialog Boxes" title: "Creating Modal Dialog Boxes" ms.date: "11/04/2016" helpviewer_keywords: ["modal dialog boxes [MFC], creating", "MFC dialog boxes [MFC], creating", "MFC dialog boxes [MFC], modal"] -ms.assetid: 26c7a68c-79f6-4862-a5a8-6024984644d2 ms.topic: concept-article --- # Creating Modal Dialog Boxes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To create a modal dialog box, call either of the two public constructors declared in [CDialog](reference/cdialog-class.md). Next, call the dialog object's [DoModal](reference/cdialog-class.md#domodal) member function to display the dialog box and manage interaction with it until the user chooses OK or Cancel. This management by `DoModal` is what makes the dialog box modal. For modal dialog boxes, `DoModal` loads the dialog resource. ## See also diff --git a/docs/mfc/creating-modeless-dialog-boxes.md b/docs/mfc/creating-modeless-dialog-boxes.md index 92236e26218..4c730a660a6 100644 --- a/docs/mfc/creating-modeless-dialog-boxes.md +++ b/docs/mfc/creating-modeless-dialog-boxes.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating Modeless Dialog Boxes" title: "Creating Modeless Dialog Boxes" ms.date: "11/04/2016" helpviewer_keywords: ["MFC dialog boxes [MFC], modeless", "modeless dialog boxes [MFC], creating", "MFC dialog boxes [MFC], creating"] -ms.assetid: 70d78c7f-3d40-477b-9f78-0f33c359f88b ms.topic: concept-article --- # Creating Modeless Dialog Boxes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For a modeless dialog box, you must provide your own public constructor in your dialog class. To create a modeless dialog box, call your public constructor and then call the dialog object's [Create](reference/cdialog-class.md#create) member function to load the dialog resource. You can call **Create** either during or after the constructor call. If the dialog resource has the property **WS_VISIBLE**, the dialog box appears immediately. If not, you must call its [ShowWindow](reference/cwnd-class.md#showwindow) member function. ## See also diff --git a/docs/mfc/creating-new-documents-windows-and-views.md b/docs/mfc/creating-new-documents-windows-and-views.md index c5a9792921f..43a0eca8ee3 100644 --- a/docs/mfc/creating-new-documents-windows-and-views.md +++ b/docs/mfc/creating-new-documents-windows-and-views.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating New Documents, Windows, and Views" title: "Creating New Documents, Windows, and Views" ms.date: "11/19/2018" helpviewer_keywords: ["MDI [MFC], creating windows", "window objects [MFC], creating", "objects [MFC], creating document objects", "MFC default objects", "frame windows [MFC], creating", "windows [MFC], MDI", "MFC, documents", "view objects [MFC], creating", "windows [MFC], creating", "overriding, default view behavior", "views [MFC], initializing", "customizing MFC default objects", "MFC, frame windows", "MFC, views", "MDI [MFC], frame windows", "child windows [MFC], creating MDI", "view objects [MFC]", "document objects [MFC], creating", "MFC default objects [MFC], customizing", "views [MFC], overriding default behavior", "initializing views [MFC]"] -ms.assetid: 88aa1f5f-2078-4603-b16b-a2b4c7b4a2a3 ms.topic: concept-article --- # Creating New Documents, Windows, and Views +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following figures give an overview of the creation process for documents, views, and frame windows. Other articles that focus on the participating objects provide further details. Upon completion of this process, the cooperating objects exist and store pointers to each other. The following figures show the sequence in which objects are created. You can follow the sequence from figure to figure. diff --git a/docs/mfc/creating-stack-and-queue-collections.md b/docs/mfc/creating-stack-and-queue-collections.md index e0e1c818970..f61a62a9391 100644 --- a/docs/mfc/creating-stack-and-queue-collections.md +++ b/docs/mfc/creating-stack-and-queue-collections.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating Stack and Queue Collections" title: "Creating Stack and Queue Collections" ms.date: "11/04/2016" helpviewer_keywords: ["MFC collection classes [MFC], stack collections", "collections, stack", "stack", "collection classes [MFC], creating", "queue collections", "MFC collection classes [MFC], queue collections", "stack collections", "collections, queue"] -ms.assetid: 3c7bc198-35f0-4fc3-aaed-6005a0f22638 ms.topic: how-to --- # Creating Stack and Queue Collections +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to create other data structures, such as [stacks](#_core_stacks) and [queues](#_core_queues), from MFC list classes. The examples use classes derived from `CList`, but you can use `CList` directly unless you need to add functionality. ## Stacks diff --git a/docs/mfc/creating-the-date-and-time-picker-control.md b/docs/mfc/creating-the-date-and-time-picker-control.md index 1c30cd048b0..633c5441142 100644 --- a/docs/mfc/creating-the-date-and-time-picker-control.md +++ b/docs/mfc/creating-the-date-and-time-picker-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating the Date and Time Picker Control" title: "Creating the Date and Time Picker Control" ms.date: "11/04/2016" helpviewer_keywords: ["DateTimePicker control [MFC], creating", "CDateTimeCtrl class [MFC], creating"] -ms.assetid: 764ec2fb-98cd-478b-a5f2-d63f0bb12279 ms.topic: how-to --- # Creating the Date and Time Picker Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + How the date and time picker control is created depends on whether you are using the control in a dialog box or creating it in a nondialog window. ### To use CDateTimeCtrl directly in a dialog box diff --git a/docs/mfc/creating-the-dialog-resource.md b/docs/mfc/creating-the-dialog-resource.md index 7aa4d5179b2..811a843a8aa 100644 --- a/docs/mfc/creating-the-dialog-resource.md +++ b/docs/mfc/creating-the-dialog-resource.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating the Dialog Resource" title: "Creating the Dialog Resource" ms.date: "11/04/2016" helpviewer_keywords: ["dialog resources", "MFC dialog boxes [MFC], creating", "dialog templates [MFC], creating dialog resource", "templates [MFC], creating", "resources [MFC], creating dialog boxes", "MFC dialog boxes [MFC], dialog resource"] -ms.assetid: 0b83bd33-14d3-4611-8129-fccdae18053e ms.topic: concept-article --- # Creating the Dialog Resource +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To design the [dialog box](dialog-boxes.md) and create the dialog resource, you use the [dialog editor](../windows/dialog-editor.md). In the dialog editor, you can: - Adjust the size and location your dialog box will have when it appears. diff --git a/docs/mfc/creating-the-header-control.md b/docs/mfc/creating-the-header-control.md index e16b83e1204..9ed0680f794 100644 --- a/docs/mfc/creating-the-header-control.md +++ b/docs/mfc/creating-the-header-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating the Header Control" title: "Creating the Header Control" ms.date: "11/04/2016" helpviewer_keywords: ["CHeaderCtrl class [MFC], creating", "header controls [MFC], creating"] -ms.assetid: 7864d9d2-4a2c-4622-b58b-7b110a1e28d2 ms.topic: how-to --- # Creating the Header Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The header control is not directly available in the dialog editor (although you can add a list control, which includes a header control). ### To put a header control in a dialog box diff --git a/docs/mfc/creating-the-image-lists.md b/docs/mfc/creating-the-image-lists.md index da8197206e5..39744f3dc26 100644 --- a/docs/mfc/creating-the-image-lists.md +++ b/docs/mfc/creating-the-image-lists.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating the Image Lists" title: "Creating the Image Lists" ms.date: "11/04/2016" helpviewer_keywords: ["CListCtrl class [MFC], creating image lists for", "image lists [MFC], creating for CListCtrl", "lists [MFC], image"] -ms.assetid: c2768515-deba-49e8-a6f3-5be6482afb19 ms.topic: concept-article --- # Creating the Image Lists +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Creating image lists is the same whether you use [CListView](reference/clistview-class.md) or [CListCtrl](reference/clistctrl-class.md). > [!NOTE] diff --git a/docs/mfc/creating-the-list-control.md b/docs/mfc/creating-the-list-control.md index cd17ed745c3..d5944f1b37b 100644 --- a/docs/mfc/creating-the-list-control.md +++ b/docs/mfc/creating-the-list-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating the List Control" title: "Creating the List Control" ms.date: "11/04/2016" helpviewer_keywords: ["CListCtrl class [MFC], creating control", "list controls [MFC]"] -ms.assetid: a4cb1729-31b6-4d2b-a44b-367474848a39 ms.topic: how-to --- # Creating the List Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + How the list control ([CListCtrl](reference/clistctrl-class.md)) is created depends on whether you're using the control directly or using class [CListView](reference/clistview-class.md) instead. If you use `CListView`, the framework constructs the view as part of its document/view creation sequence. Creating the list view creates the list control as well (the two are the same thing). The control is created in the view's [OnCreate](reference/cwnd-class.md#oncreate) handler function. In this case, the control is ready for you to add items, via a call to [GetListCtrl](reference/clistview-class.md#getlistctrl). ### To use CListCtrl directly in a dialog box diff --git a/docs/mfc/creating-the-month-calendar-control.md b/docs/mfc/creating-the-month-calendar-control.md index 21319b9e5bf..92ff0854f8e 100644 --- a/docs/mfc/creating-the-month-calendar-control.md +++ b/docs/mfc/creating-the-month-calendar-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating the Month Calendar Control" title: "Creating the Month Calendar Control" ms.date: "11/04/2016" helpviewer_keywords: ["CMonthCalCtrl class [MFC], creating", "month calendar controls [MFC], creating", "month calendar controls [MFC]"] -ms.assetid: 185cc642-85e9-4365-8a4c-d90b75b010f7 ms.topic: how-to --- # Creating the Month Calendar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + How the month calendar control is created depends on whether you are using the control in a dialog box or creating it in a nondialog window. ### To use CMonthCalCtrl directly in a dialog box diff --git a/docs/mfc/creating-the-tab-control.md b/docs/mfc/creating-the-tab-control.md index ec4d8a7626b..f8db4aabfc9 100644 --- a/docs/mfc/creating-the-tab-control.md +++ b/docs/mfc/creating-the-tab-control.md @@ -4,11 +4,13 @@ title: "Creating the Tab Control" ms.date: "11/04/2016" f1_keywords: ["TCS_EX_REGISTERDROP", "TCS_EX_FLATSEPARATORS"] helpviewer_keywords: ["TCS_EX_REGISTERDROP extended style [MFC]", "tab controls [MFC], creating", "CTabCtrl class [MFC], creating", "TCS_EX_FLATSEPARATORS extended style"] -ms.assetid: 3a9c2d64-f5f4-41ea-84ab-fceb73c3dbdc ms.topic: how-to --- # Creating the Tab Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + How the tab control is created depends on whether you are using the control in a dialog box or creating it in a nondialog window. ### To use CTabCtrl directly in a dialog box diff --git a/docs/mfc/creating-windows.md b/docs/mfc/creating-windows.md index ffa63d22eda..0c1a016b3bb 100644 --- a/docs/mfc/creating-windows.md +++ b/docs/mfc/creating-windows.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating Windows" title: "Creating Windows" ms.date: "11/04/2016" helpviewer_keywords: ["object creation [MFC], windows", "windows [MFC], creating", "CWnd objects [MFC]", "CWnd objects [MFC], creating"] -ms.assetid: f5ff91a6-4069-47d7-9177-1e6c80d3792c ms.topic: concept-article --- # Creating Windows +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The framework automatically creates most of the windows you need in a framework program. [Document/View Creation](document-view-creation.md) shows how the framework creates the frame windows associated with documents and views. But for special purposes you can create your own windows — including your own child windows of frame windows or views — in addition to the windows supplied by the framework. ## What do you want to know more about diff --git a/docs/mfc/creating-your-dialog-class.md b/docs/mfc/creating-your-dialog-class.md index 904e6f42875..c637e47bc34 100644 --- a/docs/mfc/creating-your-dialog-class.md +++ b/docs/mfc/creating-your-dialog-class.md @@ -3,11 +3,13 @@ description: "Learn more about: Creating Your Dialog Class" title: "Creating Your Dialog Class" ms.date: "09/06/2019" helpviewer_keywords: ["dialog boxes [MFC], creating", "MFC dialog boxes [MFC], creating", "files [MFC], creating", "dialog classes [MFC], Add Class Wizard", "dialog classes [MFC], creating"] -ms.assetid: d5321741-da41-47a8-bb1c-6a0e8b28c4c1 ms.topic: concept-article --- # Creating Your Dialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For each dialog box in your program, create a new dialog class to work with the dialog resource. [Adding a Class](../ide/adding-a-class-visual-cpp.md) explains how to create a new dialog class. When you create a dialog class with the [Class Wizard](reference/mfc-class-wizard.md), it writes the following items in the .h and .cpp files you specify: diff --git a/docs/mfc/crebar-vs-crebarctrl.md b/docs/mfc/crebar-vs-crebarctrl.md index 6750c3db526..8e03bf97fca 100644 --- a/docs/mfc/crebar-vs-crebarctrl.md +++ b/docs/mfc/crebar-vs-crebarctrl.md @@ -3,15 +3,17 @@ description: "Learn more about: CReBar vs. CReBarCtrl" title: "CReBar vs. CReBarCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["CReBar class [MFC], vs. CReBarCtrl", "rebar controls [MFC], CReBarCtrl class [MFC]", "GetReBarCtrl class [MFC]"] -ms.assetid: 7f9c1d7e-5d5f-4956-843c-69ed3df688d0 --- # CReBar vs. CReBarCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC provides two classes to create rebars: [CReBar](reference/crebar-class.md) and [CReBarCtrl](reference/crebarctrl-class.md) (which wraps the Windows common control API). `CReBar` provides all of the functionality of the rebar common control, and it handles many of the required common control settings and structures for you. `CReBarCtrl` is a wrapper class for the Win32 rebar control, and therefore may be easier to implement if you do not intend to integrate the rebar into the MFC architecture. If you plan to use `CReBarCtrl` and integrate the rebar into the MFC architecture, you must take additional care to communicate rebar control manipulations to MFC. This communication is not difficult; however, it is additional work that is unneeded when you use `CReBar`. -Visual C++ provides two ways to take advantage of the rebar common control. +Visual Studio provides two ways to take advantage of the rebar common control. - Create the rebar using `CReBar`, and then call [CReBar::GetReBarCtrl](reference/crebar-class.md#getrebarctrl) to get access to the `CReBarCtrl` member functions. diff --git a/docs/mfc/ctreectrl-vs-ctreeview.md b/docs/mfc/ctreectrl-vs-ctreeview.md index bc46617de0a..08205c2d697 100644 --- a/docs/mfc/ctreectrl-vs-ctreeview.md +++ b/docs/mfc/ctreectrl-vs-ctreeview.md @@ -3,10 +3,12 @@ description: "Learn more about: CTreeCtrl vs. CTreeView" title: "CTreeCtrl vs. CTreeView" ms.date: "11/04/2016" helpviewer_keywords: ["tree view controls", "CTreeCtrl class [MFC], vs. CTreeView class [MFC]", "CTreeView class [MFC], vs. CTreeCtrl class [MFC]", "tree controls [MFC], and tree view"] -ms.assetid: bba5af25-103f-4b53-84d3-071bc9bd6494 --- # CTreeCtrl vs. CTreeView +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC provides two classes that encapsulate tree controls: [CTreeCtrl](reference/ctreectrl-class.md) and [CTreeView](reference/ctreeview-class.md). Each class is useful in different situations. Use `CTreeCtrl` when you need a plain child window control; for instance, in a dialog box. You'd especially want to use `CTreeCtrl` if there will be other child controls in the window, as in a typical dialog box. diff --git a/docs/mfc/current-selection-in-a-rich-edit-control.md b/docs/mfc/current-selection-in-a-rich-edit-control.md index 71ba0c09d26..77b23d0394b 100644 --- a/docs/mfc/current-selection-in-a-rich-edit-control.md +++ b/docs/mfc/current-selection-in-a-rich-edit-control.md @@ -3,10 +3,12 @@ description: "Learn more about: Current Selection in a Rich Edit Control" title: "Current Selection in a Rich Edit Control" ms.date: "11/04/2016" helpviewer_keywords: ["current selection in CRichEditCtrls", "CRichEditCtrl class [MFC], current selection in", "rich edit controls [MFC], current selection in", "selection, current in CRichEditCtrl"] -ms.assetid: f6b2a2b6-5481-4ad3-9720-6dd772ea6fc8 --- # Current Selection in a Rich Edit Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The user can select text in a rich edit control ([CRichEditCtrl](reference/cricheditctrl-class.md)) by using the mouse or the keyboard. The current selection is the range of selected characters, or the position of the insertion point if no characters are selected. An application can get information about the current selection, set the current selection, determine when the current selection changes, and show or hide the selection highlight. To determine the current selection in a rich edit control, use the [GetSel](reference/cricheditctrl-class.md#getsel) member function. To set the current selection, use the [SetSel](reference/cricheditctrl-class.md#setsel) member function. The [CHARRANGE](/windows/win32/api/richedit/ns-richedit-charrange) structure is used with these functions to specify a range of characters. To retrieve information about the contents of the current selection, you can use the [GetSelectionType](reference/cricheditctrl-class.md#getselectiontype) member function. diff --git a/docs/mfc/customization-for-mfc.md b/docs/mfc/customization-for-mfc.md index 2ab4a09f1d1..f8e4330ef35 100644 --- a/docs/mfc/customization-for-mfc.md +++ b/docs/mfc/customization-for-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Customization for MFC" title: "Customization for MFC" ms.date: "11/04/2016" helpviewer_keywords: ["customizations, MFC Extensions"] -ms.assetid: 3b1b7532-8cc9-48dc-9bbe-7fd4060530b5 --- # Customization for MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic provides tips for customizing an MFC application. ## General Customizations diff --git a/docs/mfc/customizing-the-appearance-of-a-toolbar-control.md b/docs/mfc/customizing-the-appearance-of-a-toolbar-control.md index 7a40c5a6116..5825ee08448 100644 --- a/docs/mfc/customizing-the-appearance-of-a-toolbar-control.md +++ b/docs/mfc/customizing-the-appearance-of-a-toolbar-control.md @@ -4,11 +4,13 @@ title: "Customizing the Appearance of a Toolbar Control" ms.date: "11/04/2016" f1_keywords: ["TBSTYLE_"] helpviewer_keywords: ["flat toolbars", "CToolBar class [MFC], styles", "transparent toolbars", "TBSTYLE_ styles [MFC]", "CToolBarCtrl class [MFC], object styles", "toolbar controls [MFC], style"] -ms.assetid: fd0a73db-7ad1-4fe4-889b-02c3980f49e8 ms.topic: concept-article --- # Customizing the Appearance of a Toolbar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Class `CToolBarCtrl` provides many styles that affect the appearance (and, occasionally, the behavior) of the toolbar object. Modify the toolbar object by setting the `dwCtrlStyle` parameter of the `CToolBarCtrl::Create` (or `CToolBar::CreateEx`) member function, when you first create the toolbar control. The following styles affect the "3D" aspect of the toolbar buttons and the placement of the button text: diff --git a/docs/mfc/customizing-the-header-item-s-appearance.md b/docs/mfc/customizing-the-header-item-s-appearance.md index 7324136f93a..990ecb305fe 100644 --- a/docs/mfc/customizing-the-header-item-s-appearance.md +++ b/docs/mfc/customizing-the-header-item-s-appearance.md @@ -3,11 +3,13 @@ description: "Learn more about: Customizing the Header Item's Appearance" title: "Customizing the Header Item's Appearance" ms.date: "11/04/2016" helpviewer_keywords: ["header controls [MFC], customization of items", "CHeaderCtrl class [MFC], customizing the items", "HDS_ styles"] -ms.assetid: b1e1e326-ec7d-4dbd-a46f-96a3e2055618 ms.topic: concept-article --- # Customizing the Header Item's Appearance +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + By setting the *dwStyle* parameter when you first create a header control ([CHeaderCtrl::Create](reference/cheaderctrl-class.md#create)), you can define the appearance and behavior of header items or of the header control itself. Here is a sampling of the styles you can set, and their purpose: diff --git a/docs/mfc/cwinapp-and-the-mfc-application-wizard.md b/docs/mfc/cwinapp-and-the-mfc-application-wizard.md index 530934f7d79..7e8e4cd5464 100644 --- a/docs/mfc/cwinapp-and-the-mfc-application-wizard.md +++ b/docs/mfc/cwinapp-and-the-mfc-application-wizard.md @@ -3,10 +3,12 @@ description: "Learn more about: CWinApp and the MFC Application Wizard" title: "CWinApp and the MFC Application Wizard" ms.date: "11/04/2016" helpviewer_keywords: ["application wizards [MFC], and CWinApp", "CWinApp class [MFC], and MFC Application Wizard", "MFC, wizards"] -ms.assetid: f8ac0491-3302-4e46-981d-0790624eb8a2 --- # CWinApp and the MFC Application Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When it creates a skeleton application, the MFC Application Wizard declares an application class derived from [CWinApp](reference/cwinapp-class.md). The MFC Application Wizard also generates an implementation file that contains the following items: - A message map for the application class. diff --git a/docs/mfc/cwinapp-the-application-class.md b/docs/mfc/cwinapp-the-application-class.md index ba5a5f0062f..b24b92f4b3f 100644 --- a/docs/mfc/cwinapp-the-application-class.md +++ b/docs/mfc/cwinapp-the-application-class.md @@ -3,10 +3,12 @@ description: "Learn more about: CWinApp: The Application Class" title: "CWinApp: The Application Class" ms.date: "11/04/2016" helpviewer_keywords: ["application class [MFC]", "CWinApp class [MFC], CWinThread", "MFC, WinMain and", "CWinApp class [MFC], multithreading", "CWinThread class [MFC], and CWinApp", "InitApplication method [MFC]", "WinMain method [MFC]", "WinMain method [MFC], in MFC", "CWinApp class [MFC], WinMain"] -ms.assetid: 935822bb-d463-481b-a5f6-9719d68ed1d5 --- # CWinApp: The Application Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The main application class in MFC encapsulates the initialization, running, and termination of an application for the Windows operating system. An application built on the framework must have one and only one object of a class derived from [CWinApp](reference/cwinapp-class.md). This object is constructed before windows are created. `CWinApp` is derived from `CWinThread`, which represents the main thread of execution for your application, which might have one or more threads. In recent versions of MFC, the `InitInstance`, **Run**, `ExitInstance`, and `OnIdle` member functions are actually in class `CWinThread`. These functions are discussed here as if they were `CWinApp` members instead, because the discussion concerns the object's role as application object rather than as primary thread. @@ -19,7 +21,7 @@ Like any program for the Windows operating system, your framework application ha To initialize the application, `WinMain` calls your application object's `InitApplication` and `InitInstance` member functions. To run the application's message loop, `WinMain` calls the **Run** member function. On termination, `WinMain` calls the application object's `ExitInstance` member function. > [!NOTE] -> Names shown in **bold** in this documentation indicate elements supplied by the Microsoft Foundation Class Library and Visual C++. Names shown in `monospaced` type indicate elements that you create or override. +> Names shown in **bold** in this documentation indicate elements supplied by the Microsoft Foundation Class Library and Visual Studio. Names shown in `monospaced` type indicate elements that you create or override. ## See also diff --git a/docs/mfc/dao-classes.md b/docs/mfc/dao-classes.md index ad16f3fe673..f7dcafbd128 100644 --- a/docs/mfc/dao-classes.md +++ b/docs/mfc/dao-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: DAO Classes" title: "DAO Classes" ms.date: "09/17/2019" helpviewer_keywords: ["database classes [MFC], DAO", "DAO [MFC], classes"] -ms.assetid: b15d0cd6-328b-4288-9c19-d037a795db57 --- # DAO Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + DAO is used with Access databases and is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. These classes work with the other application framework classes to give easy access to Data Access Object (DAO) databases, which use the same database engine as Microsoft Visual Basic and Microsoft Access. The DAO classes can also access a wide variety of databases for which Open Database Connectivity (ODBC) drivers are available. @@ -14,7 +16,7 @@ These classes work with the other application framework classes to give easy acc Programs that use DAO databases will have at least a `CDaoDatabase` object and a `CDaoRecordset` object. > [!NOTE] -> The Visual C++ environment and wizards no longer support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use ODBC for new MFC projects. You should only use DAO in maintaining existing applications. +> The Visual Studio environment and wizards no longer support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use ODBC for new MFC projects. You should only use DAO in maintaining existing applications. [CDaoWorkspace](reference/cdaoworkspace-class.md)
Manages a named, password-protected database session from login to logoff. Most programs use the default workspace. diff --git a/docs/mfc/data-objects-and-data-sources-creation-and-destruction.md b/docs/mfc/data-objects-and-data-sources-creation-and-destruction.md index 440ec543ee4..55a6a472b33 100644 --- a/docs/mfc/data-objects-and-data-sources-creation-and-destruction.md +++ b/docs/mfc/data-objects-and-data-sources-creation-and-destruction.md @@ -3,10 +3,12 @@ description: "Learn more about: Data Objects and Data Sources: Creation and Dest title: "Data Objects and Data Sources: Creation and Destruction" ms.date: "11/04/2016" helpviewer_keywords: ["destroying data objects [MFC]", "object creation [MFC], data source objects", "data sources [MFC], and data objects", "data source objects [MFC], creating", "destruction [MFC], data sources", "data source objects [MFC], destroying", "data objects [MFC], creating", "data objects [MFC], destroying", "data sources [MFC], role", "data sources [MFC], destroying", "destruction [MFC], data objects", "data sources [MFC], creating"] -ms.assetid: ac216d54-3ca5-4ce7-850d-cd1f6a90d4f1 --- # Data Objects and Data Sources: Creation and Destruction +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As explained in the article [Data Objects and Data Sources (OLE)](data-objects-and-data-sources-ole.md), data objects and data sources represent both sides of a data transfer. This article explains when to create and destroy these objects and sources to perform your data transfers properly, including: - [Creating data objects](#_core_creating_data_objects) diff --git a/docs/mfc/data-objects-and-data-sources-manipulation.md b/docs/mfc/data-objects-and-data-sources-manipulation.md index 012da4d435b..44b560e727f 100644 --- a/docs/mfc/data-objects-and-data-sources-manipulation.md +++ b/docs/mfc/data-objects-and-data-sources-manipulation.md @@ -3,10 +3,12 @@ description: "Learn more about: Data Objects and Data Sources: Manipulation" title: "Data Objects and Data Sources: Manipulation" ms.date: "11/04/2016" helpviewer_keywords: ["data objects [MFC], manipulating", "data sources [MFC], data operations", "data sources [MFC], inserting data", "Clipboard [MFC], determining available formats", "OLE [MFC], data objects", "Clipboard [MFC], passing format information", "data sources [MFC], determining available formats", "delayed rendering [MFC]", "OLE [MFC], data sources"] -ms.assetid: f7f27e77-bb5d-4131-b819-d71bf929ebaf --- # Data Objects and Data Sources: Manipulation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + After a data object or data source has been created, you can perform a number of common operations on the data, such as inserting and removing data, enumerating the formats the data is in, and more. This article describes the techniques necessary to complete the most common operations. Topics include: - [Inserting data into a data source](#_core_inserting_data_into_a_data_source) diff --git a/docs/mfc/data-objects-and-data-sources-ole.md b/docs/mfc/data-objects-and-data-sources-ole.md index 5b5e949d4f0..a3b803d8bd8 100644 --- a/docs/mfc/data-objects-and-data-sources-ole.md +++ b/docs/mfc/data-objects-and-data-sources-ole.md @@ -3,10 +3,12 @@ description: "Learn more about: Data Objects and Data Sources (OLE)" title: "Data Objects and Data Sources (OLE)" ms.date: "11/04/2016" helpviewer_keywords: ["data objects [MFC], definition", "data transfer [MFC]", "OLE [MFC], data transfer", "data sources [MFC], definition", "data transfer [MFC], definition", "OLE [MFC], data objects", "OLE [MFC], data sources"] -ms.assetid: 8f68eed8-0ce8-4489-a4cc-f95554f89090 --- # Data Objects and Data Sources (OLE) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you perform a data transfer, either by using the Clipboard or drag and drop, the data has a source and a destination. One application provides the data for copying and another application accepts it for pasting. Each side of the transfer needs to perform different operations on the same data for the transfer to succeed. The Microsoft Foundation Class (MFC) Library provides two classes that represent each side of this transfer: - Data sources (as implemented by `COleDataSource` objects) represent the source side of the data transfer. They are created by the source application when data is to be copied to the Clipboard, or when data is provided for a drag-and-drop operation. diff --git a/docs/mfc/date-and-time-picker-control-examples.md b/docs/mfc/date-and-time-picker-control-examples.md index 26eb0b317a0..10d189a5237 100644 --- a/docs/mfc/date-and-time-picker-control-examples.md +++ b/docs/mfc/date-and-time-picker-control-examples.md @@ -3,10 +3,12 @@ description: "Learn more about: Date and Time Picker Control Examples" title: "Date and Time Picker Control Examples" ms.date: "11/04/2016" helpviewer_keywords: ["DateTimePicker control [MFC]"] -ms.assetid: f03c3a22-7725-45eb-8f8e-dddb2d15c3ca --- # Date and Time Picker Control Examples +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [CMNCTRL1](../overview/visual-cpp-samples.md) sample demonstrates the various attributes of the `CDateTimeCtrl` class. A separate page contains a date and time picker control that the user can manipulate by changing various attributes and testing the basic functionality of the control. ## See also diff --git a/docs/mfc/debugging-and-exception-classes.md b/docs/mfc/debugging-and-exception-classes.md index 95670e20ee0..aa2e150d6cf 100644 --- a/docs/mfc/debugging-and-exception-classes.md +++ b/docs/mfc/debugging-and-exception-classes.md @@ -4,11 +4,13 @@ title: "Debugging and Exception Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.debug"] helpviewer_keywords: ["debugging [MFC], exception classes", "debugging [MFC], classes for debugging"] -ms.assetid: 0d158efd-2e62-452e-9d2a-d3c30dfee7f9 ms.topic: concept-article --- # Debugging and Exception Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes provide support for debugging dynamic memory allocation and for passing exception information from the function where the exception is thrown to the function where it is caught. Use classes [CDumpContext](reference/cdumpcontext-class.md) and [CMemoryState](reference/cmemorystate-structure.md) during development to assist with debugging, as described in [Debugging MFC Applications](/visualstudio/debugger/mfc-debugging-techniques). Use [CRuntimeClass](reference/cruntimeclass-structure.md) to determine the class of any object at run time, as described in the article [Accessing Run-Time Class Information](accessing-run-time-class-information.md). The framework uses `CRuntimeClass` to create objects of a particular class dynamically. diff --git a/docs/mfc/debugging-support-classes.md b/docs/mfc/debugging-support-classes.md index e9b03065b8c..1e40250262b 100644 --- a/docs/mfc/debugging-support-classes.md +++ b/docs/mfc/debugging-support-classes.md @@ -3,11 +3,13 @@ description: "Learn more about: Debugging Support Classes" title: "Debugging Support Classes" ms.date: "11/04/2016" helpviewer_keywords: ["debugging memory leaks, MFC", "memory allocation, debugging dynamic", "debugging [MFC], classes for debugging", "memory allocation, debugging dynamic allocation", "dynamic memory allocation", "debugging [MFC], memory leaks", "memory leaks, MFC debug classes"] -ms.assetid: d79e084a-8326-4251-8700-4efac07c511e ms.topic: concept-article --- # Debugging Support Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC provides the following classes to help you debug dynamic memory allocation problems. [CDumpContext](reference/cdumpcontext-class.md)
diff --git a/docs/mfc/declaring-message-handler-functions.md b/docs/mfc/declaring-message-handler-functions.md index cc9258d87a0..d917ba04e53 100644 --- a/docs/mfc/declaring-message-handler-functions.md +++ b/docs/mfc/declaring-message-handler-functions.md @@ -3,11 +3,13 @@ description: "Learn more about: Declaring Message Handler Functions" title: "Declaring Message Handler Functions" ms.date: "11/04/2016" helpviewer_keywords: ["declaring functions, message handler functions [MFC]"] -ms.assetid: f8d3dbc1-4500-4f1e-a18d-7371edf36386 ms.topic: concept-article --- # Declaring Message Handler Functions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Certain rules and conventions govern the names of your message-handler functions. These depend on the message category, as described in the following topics: - [Handlers for standard Windows messages](handlers-for-standard-windows-messages.md) diff --git a/docs/mfc/deleting-all-objects-in-a-cobject-collection.md b/docs/mfc/deleting-all-objects-in-a-cobject-collection.md index d57fae1c586..8e78fc10564 100644 --- a/docs/mfc/deleting-all-objects-in-a-cobject-collection.md +++ b/docs/mfc/deleting-all-objects-in-a-cobject-collection.md @@ -3,11 +3,13 @@ description: "Learn more about: Deleting All Objects in a CObject Collection" title: "Deleting All Objects in a CObject Collection" ms.date: "11/04/2016" helpviewer_keywords: ["objects [MFC], deleting in collections", "objects in CObject collections, deleting", "CObject class [MFC], deleting in collection", "collection classes [MFC], deleting all objects", "CObject class collection", "objects in CObject collections", "collection classes [MFC], shared objects"] -ms.assetid: 81d2c1d5-a0a5-46e1-8ab9-82b45cf7afd2 ms.topic: how-to --- # Deleting All Objects in a CObject Collection +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to delete all objects in a collection (without deleting the collection object itself). To delete all the objects in a collection of `CObject`s (or of objects derived from `CObject`), you use one of the iteration techniques described in the article [Accessing All Members of a Collection](accessing-all-members-of-a-collection.md) to delete each object in turn. diff --git a/docs/mfc/deprecated-ansi-apis.md b/docs/mfc/deprecated-ansi-apis.md index 6268b9613e7..6fd26ff2d70 100644 --- a/docs/mfc/deprecated-ansi-apis.md +++ b/docs/mfc/deprecated-ansi-apis.md @@ -3,10 +3,12 @@ description: "Learn more about: Deprecated ANSI APIs" title: "Deprecated ANSI APIs" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, ANSI deprecated methods"] -ms.assetid: c7c5a6fd-95e4-4bee-b3d5-d3826c30947d --- # Deprecated ANSI APIs +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class (MFC) library is migrating toward classes and methods that are based on the Unicode character set. Consequently, the ANSI versions of several MFC methods are deprecated. Use the Unicode versions of these methods in your future applications. Starting with Windows Common Controls version 6.1, which ships in Windows Vista, the following ANSI methods are deprecated. diff --git a/docs/mfc/derived-message-maps.md b/docs/mfc/derived-message-maps.md index 97dd244acdc..f178feedb75 100644 --- a/docs/mfc/derived-message-maps.md +++ b/docs/mfc/derived-message-maps.md @@ -3,10 +3,12 @@ title: "Derived Message Maps" description: "Describes MFC message handling." ms.date: "09/23/2020" helpviewer_keywords: ["message handling [MFC], derived message handlers", "messages, routing", "message maps [MFC], derived", "derived message maps"] -ms.assetid: 21829556-6e64-40c3-8279-fed85d99de77 --- # Derived Message Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + During message handling, checking a class's own message map is not the end of the message-map story. What happens if class `CMyView` (derived from `CView`) has no matching entry for a message? Keep in mind that `CView`, the base class of `CMyView`, is derived in turn from `CWnd`. Thus `CMyView` *is* a `CView` and *is* a `CWnd`. Each of those classes has its own message map. The figure below shows the hierarchical relationship of the classes, but keep in mind that a `CMyView` object is a single object that has the characteristics of all three classes. diff --git a/docs/mfc/derived-view-classes-available-in-mfc.md b/docs/mfc/derived-view-classes-available-in-mfc.md index e0831af6ac6..852150b4b4a 100644 --- a/docs/mfc/derived-view-classes-available-in-mfc.md +++ b/docs/mfc/derived-view-classes-available-in-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Derived View Classes Available in MFC" title: "Derived View Classes Available in MFC" ms.date: "11/04/2016" helpviewer_keywords: ["CView class [MFC], classes derived from", "classes [MFC], derived", "derived classes [MFC], view classes", "view classes [MFC], derived"] -ms.assetid: dba42178-7459-4ccc-b025-f3d9b8a4b737 --- # Derived View Classes Available in MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table shows MFC's view classes and their relationships to one another. The capabilities of your view class depend on the MFC view class from which it derives. ### View Classes @@ -18,7 +20,7 @@ The following table shows MFC's view classes and their relationships to one anot |[CEditView](reference/ceditview-class.md)|A simple view based on the Windows edit box control. Allows entering and editing text and can be used as the basis for a simple text editor application. See also `CRichEditView`.| |[CRichEditView](reference/cricheditview-class.md)|A view containing a [CRichEditCtrl](reference/cricheditctrl-class.md) object. This class is analogous to `CEditView`, but unlike `CEditView`, `CRichEditView` handles formatted text.| |[CListView](reference/clistview-class.md)|A view containing a [CListCtrl](reference/clistctrl-class.md) object.| -|[CTreeView](reference/ctreeview-class.md)|A view containing a [CTreeCtrl](reference/ctreectrl-class.md) object, for views that resemble the Solution Explorer window in Visual C++.| +|[CTreeView](reference/ctreeview-class.md)|A view containing a [CTreeCtrl](reference/ctreectrl-class.md) object, for views that resemble the Solution Explorer window in Visual Studio.| |[CScrollView](reference/cscrollview-class.md)|Base class of `CFormView`, `CRecordView`, and `CDaoRecordView`. Implements scrolling the view's contents.| |[CFormView](reference/cformview-class.md)|A form view, a view that contains controls. A forms-based application provides one or more such form interfaces.| |[CHtmlView](reference/chtmlview-class.md)|A Web browser view with which the application's user can browse sites on the World Wide Web, as well as folders in the local file system and on a network. The Web browser view can also work as an Active document container.| diff --git a/docs/mfc/derived-window-classes.md b/docs/mfc/derived-window-classes.md index 8102ecae4f0..2f6f1b9221c 100644 --- a/docs/mfc/derived-window-classes.md +++ b/docs/mfc/derived-window-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Derived window classes" title: "Derived window classes" ms.date: "11/04/2016" helpviewer_keywords: ["window class hierarchy", "hierarchies, window classes", "classes [MFC], derived", "CWnd class [MFC], classes derived from", "derived classes [MFC], window classes", "window classes [MFC], derived"] -ms.assetid: 6f7e437e-fbde-4a06-bfab-72d9dbf05292 --- # Derived window classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can create windows directly from [`CWnd`](reference/cwnd-class.md), or derive new window classes from `CWnd`. It's how you typically create your own custom windows. However, most windows used in a framework program are instead created from one of the `CWnd`-derived frame-window classes supplied by MFC. ## Frame window classes diff --git a/docs/mfc/deriving-a-class-from-cobject.md b/docs/mfc/deriving-a-class-from-cobject.md index bde7b72bbb9..20793426d80 100644 --- a/docs/mfc/deriving-a-class-from-cobject.md +++ b/docs/mfc/deriving-a-class-from-cobject.md @@ -3,11 +3,13 @@ description: "Learn more about: Deriving a Class from CObject" title: "Deriving a Class from CObject" ms.date: "11/04/2016" helpviewer_keywords: ["DECLARE_DYNCREATE macro [MFC]", "DECLARE_SERIAL macro [MFC]", "macros [MFC], serialization", "serialization [MFC], macros", "DECLARE_DYNAMIC macro [MFC]", "derived classes [MFC], from CObject", "CObject class [MFC], deriving serializable classes", "CObject class [MFC], deriving from"] -ms.assetid: 5ea4ea41-08b5-4bd8-b247-c5de8c152a27 ms.topic: how-to --- # Deriving a Class from CObject +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the minimum steps necessary to derive a class from [CObject](reference/cobject-class.md). Other `CObject` class articles describe the steps needed to take advantage of specific `CObject` features, such as serialization and diagnostic debugging support. In the discussions of `CObject`, the terms "interface file" and "implementation file" are used frequently. The interface file (often called the header file, or .H file) contains the class declaration and any other information needed to use the class. The implementation file (or .CPP file) contains the class definition as well as the code that implements the class member functions. For example, for a class named `CPerson`, you would typically create an interface file named PERSON.H and an implementation file named PERSON.CPP. However, for some small classes that will not be shared among applications, it is sometimes easier to combine the interface and implementation into a single .CPP file. diff --git a/docs/mfc/deriving-a-document-class-from-cdocument.md b/docs/mfc/deriving-a-document-class-from-cdocument.md index 1184517b913..67e3cbdb776 100644 --- a/docs/mfc/deriving-a-document-class-from-cdocument.md +++ b/docs/mfc/deriving-a-document-class-from-cdocument.md @@ -3,11 +3,13 @@ description: "Learn more about: Deriving a Document Class from CDocument" title: "Deriving a Document Class from CDocument" ms.date: "11/04/2016" helpviewer_keywords: ["CDocument class [MFC], deriving from", "classes [MFC], deriving from CDocument", "document objects [MFC], derived", "derived classes [MFC], functions often overridden", "document classes [MFC], functions often overridden"] -ms.assetid: e6a198e0-9799-43c0-83c5-04174d8b532c ms.topic: concept-article --- # Deriving a Document Class from CDocument +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Documents contain and manage your application's data. To use the MFC Application Wizard-supplied document class, you must do the following: - Derive a class from `CDocument` for each type of document. diff --git a/docs/mfc/deriving-controls-from-a-standard-control.md b/docs/mfc/deriving-controls-from-a-standard-control.md index 3489abe0ff7..eec1f103ace 100644 --- a/docs/mfc/deriving-controls-from-a-standard-control.md +++ b/docs/mfc/deriving-controls-from-a-standard-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Deriving Controls from a Standard Control" title: "Deriving Controls from a Standard Control" ms.date: "11/04/2016" helpviewer_keywords: ["standard controls [MFC], deriving controls from", "common controls [MFC], deriving from", "derived controls", "controls [MFC], derived", "Windows common controls [MFC], deriving from", "standard controls"] -ms.assetid: a6f84315-7007-4e0e-8576-78be81254802 ms.topic: how-to --- # Deriving Controls from a Standard Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As with any [CWnd](reference/cwnd-class.md)-derived class, you can modify a control's behavior by deriving a new class from an existing control class. ### To create a derived control class diff --git a/docs/mfc/destroying-frame-windows.md b/docs/mfc/destroying-frame-windows.md index 4bd96d2b29f..ae0d33b240c 100644 --- a/docs/mfc/destroying-frame-windows.md +++ b/docs/mfc/destroying-frame-windows.md @@ -4,11 +4,13 @@ title: "Destroying Frame Windows" ms.date: "11/04/2016" f1_keywords: ["PostNcDestroy"] helpviewer_keywords: ["Default method [MFC]", "DestroyWindow method [MFC]", "frame windows [MFC], destroying", "OnNcDestroy method, and frame windows", "document frame windows [MFC], destroying", "destroying frame windows", "MFC, frame windows", "windows [MFC], destroying", "OnClose method [MFC]", "PostNcDestroy method [MFC]"] -ms.assetid: 5affca77-1999-4507-a2b2-9aa226611b4b ms.topic: concept-article --- # Destroying Frame Windows +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The MFC framework manages window destruction as well as creation for those windows associated with framework documents and views. If you create additional windows, you are responsible for destroying them. In the framework, when the user closes the frame window, the window's default [OnClose](reference/cwnd-class.md#onclose) handler calls [DestroyWindow](reference/cwnd-class.md#destroywindow). The last member function called when the Windows window is destroyed is [OnNcDestroy](reference/cwnd-class.md#onncdestroy), which does some cleanup, calls the [Default](reference/cwnd-class.md#default) member function to perform Windows cleanup, and lastly calls the virtual member function [PostNcDestroy](reference/cwnd-class.md#postncdestroy). The [CFrameWnd](reference/cframewnd-class.md) implementation of `PostNcDestroy` deletes the C++ window object. You should never use the C++ **`delete`** operator on a frame window. Use `DestroyWindow` instead. diff --git a/docs/mfc/destroying-the-dialog-box.md b/docs/mfc/destroying-the-dialog-box.md index c8a2f0dbfbf..b519e064233 100644 --- a/docs/mfc/destroying-the-dialog-box.md +++ b/docs/mfc/destroying-the-dialog-box.md @@ -3,11 +3,13 @@ description: "Learn more about: Destroying the Dialog Box" title: "Destroying the Dialog Box" ms.date: "11/04/2016" helpviewer_keywords: ["dialog boxes [MFC], deleting", "destruction, dialog box", "dialog boxes [MFC], destroying", "dialog boxes [MFC], removing", "modeless dialog boxes [MFC], destroying", "MFC dialog boxes [MFC], destroying", "modal dialog boxes [MFC], destroying"] -ms.assetid: dabceee7-3639-4d85-bf34-73515441b3d0 ms.topic: concept-article --- # Destroying the Dialog Box +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Modal dialog boxes are normally created on the stack frame and destroyed when the function that created them ends. The dialog object's destructor is called when the object goes out of scope. Modeless dialog boxes are normally created and owned by a parent view or frame window — the application's main frame window or a document frame window. The default [OnClose](reference/cwnd-class.md#onclose) handler calls [DestroyWindow](reference/cwnd-class.md#destroywindow), which destroys the dialog-box window. If the dialog box stands alone, with no pointers to it or other special ownership semantics, you should override [PostNcDestroy](reference/cwnd-class.md#postncdestroy) to destroy the C++ dialog object. You should also override [OnCancel](reference/cdialog-class.md#oncancel) and call `DestroyWindow` from within it. If not, the owner of the dialog box should destroy the C++ object when it is no longer necessary. diff --git a/docs/mfc/destroying-the-list-control.md b/docs/mfc/destroying-the-list-control.md index 760823ee5d8..38792c165d3 100644 --- a/docs/mfc/destroying-the-list-control.md +++ b/docs/mfc/destroying-the-list-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Destroying the List Control" title: "Destroying the List Control" ms.date: "11/04/2016" helpviewer_keywords: ["list controls [MFC], destroying", "CListCtrl class [MFC], destroying controls"] -ms.assetid: 513ec820-3a02-49d2-b073-a6a7a3fc91b3 ms.topic: concept-article --- # Destroying the List Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If you embed your [CListCtrl](reference/clistctrl-class.md) object as a data member of a view or dialog class, it is destroyed when its owner is destroyed. If you use a [CListView](reference/clistview-class.md), the framework destroys the control when it destroys the view. If you arrange for some of your list data to be stored in the application rather than the list control, you will need to arrange for its deallocation. For more information, see [Callback Items and the Callback Mask](/windows/win32/Controls/using-list-view-controls) in the Windows SDK. diff --git a/docs/mfc/destroying-window-objects.md b/docs/mfc/destroying-window-objects.md index 3a02e91f0bc..9ef30b2dc40 100644 --- a/docs/mfc/destroying-window-objects.md +++ b/docs/mfc/destroying-window-objects.md @@ -3,11 +3,13 @@ description: "Learn more about: Destroying Window Objects" title: "Destroying Window Objects" ms.date: "11/04/2016" helpviewer_keywords: ["frame windows [MFC], destroying", "window objects [MFC], deleting", "window objects [MFC], destroying", "window objects [MFC], removing"] -ms.assetid: 3241fea0-c614-4a25-957d-20f21bd5fd0c ms.topic: concept-article --- # Destroying Window Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Care must be taken with your own child windows to destroy the C++ window object when the user is finished with the window. If these objects are not destroyed, your application will not recover their memory. Fortunately, the framework manages window destruction as well as creation for frame windows, views, and dialog boxes. If you create additional windows, you are responsible for destroying them. ## What do you want to know more about diff --git a/docs/mfc/detaching-a-cwnd-from-its-hwnd.md b/docs/mfc/detaching-a-cwnd-from-its-hwnd.md index abacdcd81f5..ce2d2c3d3e2 100644 --- a/docs/mfc/detaching-a-cwnd-from-its-hwnd.md +++ b/docs/mfc/detaching-a-cwnd-from-its-hwnd.md @@ -3,11 +3,13 @@ description: "Learn more about: Detaching a CWnd from Its HWND" title: "Detaching a CWnd from Its HWND" ms.date: "11/04/2016" helpviewer_keywords: ["HWND, detaching CWnd from", "removing HWNDs from CWnds", "CWnd objects [MFC], detaching from HWND", "detaching CWnds from HWNDs", "Detach method (CWnd class)"] -ms.assetid: 6efadf84-0517-4a3f-acfd-216e088f19c6 ms.topic: concept-article --- # Detaching a CWnd from Its HWND +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If you need to circumvent the object-`HWND` relationship, MFC provides another `CWnd` member function, [Detach](reference/cwnd-class.md#detach), which disconnects the C++ window object from the Windows window. This prevents the destructor from destroying the Windows window when the object is destroyed. ## What do you want to know more about diff --git a/docs/mfc/device-contexts.md b/docs/mfc/device-contexts.md index 6662d7c60ec..535c3f4debf 100644 --- a/docs/mfc/device-contexts.md +++ b/docs/mfc/device-contexts.md @@ -3,10 +3,12 @@ description: "Learn more about: Device Contexts" title: "Device Contexts" ms.date: "11/04/2016" helpviewer_keywords: ["OnPrepareDC method [MFC]", "windows [MFC], and device context", "drawing [MFC], device context", "CClientDC class [MFC], and GetDC method [MFC]", "drawing [MFC], in mouse and device contexts", "CDC class [MFC], objects", "device contexts [MFC]", "client areas", "CMetaFileDC class [MFC], and OnPrepareDC method [MFC]", "GDI objects [MFC], device contexts", "graphic objects [MFC], device contexts", "frame windows [MFC], device contexts", "metafiles and device contexts", "EndPaint method [MFC]", "printers [MFC], device contexts", "mouse [MFC], drawing and device contexts", "BeginPaint method, CPaintDC", "CPaintDC class [MFC], device context for painting", "windows [MFC], drawing directly into", "client areas, and device context", "device contexts [MFC], CDC class [MFC]", "user interface [MFC], device contexts", "device-independent drawing", "GetDC method and CClientDC class [MFC]", "CClientDC class [MFC], and ReleaseDC method [MFC]", "ReleaseDC method [MFC]", "device contexts [MFC], about device contexts", "drawing [MFC], directly into windows", "painting and device context"] -ms.assetid: d0cd51f1-f778-4c7e-bf50-d738d10433c7 --- # Device Contexts +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A device context is a Windows data structure containing information about the drawing attributes of a device such as a display or a printer. All drawing calls are made through a device-context object, which encapsulates the Windows APIs for drawing lines, shapes, and text. Device contexts allow device-independent drawing in Windows. Device contexts can be used to draw to the screen, to the printer, or to a metafile. [CPaintDC](reference/cpaintdc-class.md) objects encapsulate the common idiom of Windows, calling the `BeginPaint` function, then drawing in the device context, then calling the `EndPaint` function. The `CPaintDC` constructor calls `BeginPaint` for you, and the destructor calls `EndPaint`. The simplified process is to create the [CDC](reference/cdc-class.md) object, draw, and then destroy the `CDC` object. In the framework, much of even this process is automated. In particular, your `OnDraw` function is passed a `CPaintDC` already prepared (via `OnPrepareDC`), and you simply draw into it. It is destroyed by the framework and the underlying device context is released to Windows upon return from the call to your `OnDraw` function. diff --git a/docs/mfc/dialog-bars.md b/docs/mfc/dialog-bars.md index 3e1b3cb5fba..269c5c03e94 100644 --- a/docs/mfc/dialog-bars.md +++ b/docs/mfc/dialog-bars.md @@ -3,13 +3,15 @@ description: "Learn more about: Dialog Bars" title: "Dialog Bars" ms.date: "11/19/2018" helpviewer_keywords: ["MFC, control bars", "CDialogBar class [MFC], dialog bars", "control bars [MFC], dialog bars", "dialog bars", "dialog bars [MFC], about dialog bars"] -ms.assetid: 485c8055-6bb0-4051-8417-dd2971499321 --- # Dialog Bars +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A dialog bar is a toolbar, a kind of [control bar](control-bars.md) that can contain any kind of control. Because it has the characteristics of a modeless dialog box, a [CDialogBar](reference/cdialogbar-class.md) object provides a more powerful toolbar. -There are several key differences between a toolbar and a `CDialogBar` object. A `CDialogBar` object is created from a dialog-template resource, which you can create with the Visual C++ dialog editor and which can contain any kind of Windows control. The user can tab from control to control. And you can specify an alignment style to align the dialog bar with any part of the parent frame window or even to leave it in place if the parent is resized. The following figure shows a dialog bar with a variety of controls. +There are several key differences between a toolbar and a `CDialogBar` object. A `CDialogBar` object is created from a dialog-template resource, which you can create with the Visual Studio dialog editor and which can contain any kind of Windows control. The user can tab from control to control. And you can specify an alignment style to align the dialog bar with any part of the parent frame window or even to leave it in place if the parent is resized. The following figure shows a dialog bar with a variety of controls. ![Example of a VC Dialog Bar.](../mfc/media/vc378t1.gif "VC Dialog Bar")
A Dialog Bar diff --git a/docs/mfc/dialog-box-classes.md b/docs/mfc/dialog-box-classes.md index 2924f1f55a3..d0bb082decc 100644 --- a/docs/mfc/dialog-box-classes.md +++ b/docs/mfc/dialog-box-classes.md @@ -4,10 +4,12 @@ title: "Dialog Box Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.dialog"] helpviewer_keywords: ["property sheet classes", "dialog box classes", "OLE common dialog classes", "common dialog classes [MFC]", "tab dialog boxes"] -ms.assetid: db75da23-4eff-4c6c-beae-79cf046fbce9 --- # Dialog Box Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Class `CDialog` and its derived classes encapsulate dialog-box functionality. Since a dialog box is a special kind of window, `CDialog` is derived from `CWnd`. Derive your dialog classes from `CDialog` or use one of the common dialog classes for standard dialog boxes, such as opening or saving a file, printing, selecting a font or color, initiating a search-and-replace operation, or performing various OLE-related operations. [CDialog](reference/cdialog-class.md)
diff --git a/docs/mfc/dialog-box-components-in-the-framework.md b/docs/mfc/dialog-box-components-in-the-framework.md index 84a07119c71..3f47a6a863e 100644 --- a/docs/mfc/dialog-box-components-in-the-framework.md +++ b/docs/mfc/dialog-box-components-in-the-framework.md @@ -3,10 +3,12 @@ description: "Learn more about: Dialog-Box Components in the Framework" title: "Dialog-Box Components in the Framework" ms.date: "11/04/2016" helpviewer_keywords: ["MFC dialog boxes [MFC], creating", "dialog classes [MFC], dialog box components", "MFC dialog boxes [MFC], about MFC dialog boxes", "dialog templates [MFC], MFC framework", "MFC dialog boxes [MFC], dialog resource"] -ms.assetid: 592db160-0a8a-49be-ac72-ead278aca53f --- # Dialog-Box Components in the Framework +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In the MFC framework, a dialog box has two components: - A dialog-template resource that specifies the dialog box's controls and their placement. diff --git a/docs/mfc/dialog-boxes-in-ole.md b/docs/mfc/dialog-boxes-in-ole.md index dbd432b73d1..c9bbb23247c 100644 --- a/docs/mfc/dialog-boxes-in-ole.md +++ b/docs/mfc/dialog-boxes-in-ole.md @@ -3,10 +3,12 @@ description: "Learn more about: Dialog boxes in OLE" title: "Dialog boxes in OLE" ms.date: "11/04/2016" helpviewer_keywords: ["MFC dialog boxes [MFC], OLE dialog boxes", "OLE dialog boxes", "dialog boxes", "OLE dialog boxes [MFC], about OLE dialog boxes", "dialog boxes [MFC], about dialog boxes", "dialog boxes [MFC], OLE", "Insert object"] -ms.assetid: 73c41eb8-738a-4d02-9212-d3395bb09a3a --- # Dialog boxes in OLE +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + While a user runs an OLE-enabled application, there are times when the application needs information from the user to carry out the operation. The MFC OLE classes provide default dialog boxes to gather the required information. This article lists the tasks handled by the OLE dialog boxes and the classes needed to display those dialog boxes. For details on OLE dialog boxes and the structures used to customize their behavior, see [MFC Reference](mfc-desktop-applications.md). ## Common dialog boxes diff --git a/docs/mfc/dialog-boxes.md b/docs/mfc/dialog-boxes.md index 780520efb62..542ef59b938 100644 --- a/docs/mfc/dialog-boxes.md +++ b/docs/mfc/dialog-boxes.md @@ -3,11 +3,13 @@ description: "Learn more about: Dialog Boxes" title: "Dialog Boxes" ms.date: "11/04/2016" helpviewer_keywords: ["modeless dialog boxes [MFC], MFC dialog boxes", "MFC, dialog boxes", "modal dialog boxes [MFC], MFC dialog boxes", "CDialog class [MFC], MFC dialog boxes", "MFC dialog boxes"] -ms.assetid: e4feea1a-8360-4ccb-9b84-507f1ccd9ef3 --- # Dialog Boxes -Applications for Windows frequently communicate with the user through dialog boxes. Class [CDialog](reference/cdialog-class.md) provides an interface for managing dialog boxes, the Visual C++ dialog editor makes it easy to design dialog boxes and create their dialog-template resources, and Code wizards simplify the process of initializing and validating the controls in a dialog box and of gathering the values entered by the user. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +Applications for Windows frequently communicate with the user through dialog boxes. Class [CDialog](reference/cdialog-class.md) provides an interface for managing dialog boxes, the Visual Studio dialog editor makes it easy to design dialog boxes and create their dialog-template resources, and Code wizards simplify the process of initializing and validating the controls in a dialog box and of gathering the values entered by the user. Dialog boxes contain controls, including: diff --git a/docs/mfc/dialog-data-exchange-and-validation.md b/docs/mfc/dialog-data-exchange-and-validation.md index 7ed85e5f7ed..c8742600b4a 100644 --- a/docs/mfc/dialog-data-exchange-and-validation.md +++ b/docs/mfc/dialog-data-exchange-and-validation.md @@ -3,10 +3,12 @@ description: "Learn more about: Dialog Data Exchange and Validation" title: "Dialog Data Exchange and Validation" ms.date: "11/04/2016" helpviewer_keywords: ["data validation [MFC], dialog boxes", "dialog box data [MFC]", "dialog boxes [MFC], validating data", "validating data [MFC], dialog box data entry", "DDX (dialog data exchange) [MFC], data validation", "dialog box data [MFC], retrieving", "Windows common controls [MFC], dialog boxes", "DDV (dialog data validation) [MFC]", "data [MFC], dialog boxes", "common controls [MFC], dialog boxes", "dialog boxes [MFC], retrieving data", "retrieving dialog box data"] -ms.assetid: 7d373554-7330-43ae-abf1-4bb14e437b4a --- # Dialog Data Exchange and Validation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Dialog data exchange (DDX) is an easy way to initialize the controls in your dialog box and to gather data input by the user. Dialog data validation (DDV) is an easy way to validate data entry in a dialog box. To take advantage of DDX and DDV in your dialog boxes, use the [Add Member Variable Wizard](../ide/adding-a-member-variable-visual-cpp.md#add-member-variable-wizard) to create the data members and set their data types and specify validation rules. ## What do you want to know more about diff --git a/docs/mfc/dialog-data-exchange.md b/docs/mfc/dialog-data-exchange.md index ca1f737fc19..0e039bd13c1 100644 --- a/docs/mfc/dialog-data-exchange.md +++ b/docs/mfc/dialog-data-exchange.md @@ -3,10 +3,12 @@ description: "Learn more about: Dialog Data Exchange" title: "Dialog Data Exchange" ms.date: "11/19/2018" helpviewer_keywords: ["initializing dialog boxes", "canceling data exchange", "dialog box data, retrieving", "DDX (dialog data exchange), data exchange mechanism", "dialog boxes [MFC], initializing", "dialog boxes [MFC], retrieving user input using DDX", "dialog box data", "dialog boxes [MFC], data exchange", "CDataExchange class [MFC], using DDX", "DoDataExchange method [MFC]", "user input [MFC], retrieving from MFC dialog boxes", "capturing user input [MFC]", "transferring dialog box data", "DDX (dialog data exchange), canceling", "UpdateData method [MFC]", "retrieving dialog box data [MFC]"] -ms.assetid: 4675f63b-41d2-45ed-b6c3-235ad8ab924b --- # Dialog Data Exchange +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If you use the DDX mechanism, you set the initial values of the dialog object's member variables, typically in your `OnInitDialog` handler or the dialog constructor. Immediately before the dialog is displayed, the framework's DDX mechanism transfers the values of the member variables to the controls in the dialog box, where they appear when the dialog box itself appears in response to `DoModal` or `Create`. The default implementation of `OnInitDialog` in `CDialog` calls the `UpdateData` member function of class `CWnd` to initialize the controls in the dialog box. The same mechanism transfers values from the controls to the member variables when the user clicks the OK button (or whenever you call the `UpdateData` member function with the argument **TRUE**). The dialog data validation mechanism validates any data items for which you specified validation rules. diff --git a/docs/mfc/dialog-data-validation.md b/docs/mfc/dialog-data-validation.md index 0be1815d2cc..9814f2715db 100644 --- a/docs/mfc/dialog-data-validation.md +++ b/docs/mfc/dialog-data-validation.md @@ -3,10 +3,12 @@ description: "Learn more about: Dialog Data Validation" title: "Dialog Data Validation" ms.date: "11/04/2016" helpviewer_keywords: ["validating data [MFC], message boxes", "data validation [MFC], dialog boxes", "dialog boxes [MFC], validating data", "validating data [MFC], dialog box data entry", "DDV (dialog data validation) [MFC]", "data validation [MFC], message boxes"] -ms.assetid: f070c309-2044-4ff2-8c92-1ec1ea84af58 --- # Dialog Data Validation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can specify validation in addition to data exchange by calling DDV functions, as shown in the example in [Dialog Data Exchange](dialog-data-exchange.md). The `DDV_MaxChars` call in the example validates that the string entered in the text-box control is not longer than 20 characters. The DDV function typically alerts the user with a message box if the validation fails and puts the focus on the offending control so the user can reenter the data. A DDV function for a given control must be called immediately after the DDX function for the same control. You can also define your own custom DDX and DDV routines. For details on this and other aspects of DDX and DDV, see [MFC Technical Note 26](tn026-ddx-and-ddv-routines.md). diff --git a/docs/mfc/dialog-sample-list.md b/docs/mfc/dialog-sample-list.md index f68785df172..cc8169fc3c6 100644 --- a/docs/mfc/dialog-sample-list.md +++ b/docs/mfc/dialog-sample-list.md @@ -3,10 +3,12 @@ description: "Learn more about: Dialog Sample List" title: "Dialog Sample List" ms.date: "11/04/2016" helpviewer_keywords: ["sample applications [MFC], dialog boxes"] -ms.assetid: 3fc7dd7c-d758-4c43-96bb-0ea638ca1ad7 --- # Dialog Sample List +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + See the following sample programs that illustrate dialog boxes and property sheets: *MDI Sample Application with Dialog Boxes* diff --git a/docs/mfc/do-i-have-to-derive-new-classes-from-cobject-q.md b/docs/mfc/do-i-have-to-derive-new-classes-from-cobject-q.md index 4881b3a4054..9e391415b09 100644 --- a/docs/mfc/do-i-have-to-derive-new-classes-from-cobject-q.md +++ b/docs/mfc/do-i-have-to-derive-new-classes-from-cobject-q.md @@ -3,10 +3,12 @@ description: "Learn more about: Do I Have to Derive New Classes from CObject?" title: "Do I Have to Derive New Classes from CObject?" ms.date: "11/04/2016" helpviewer_keywords: ["derived classes [MFC], from CObject", "CObject class [MFC], when to use"] -ms.assetid: 26021031-feaf-424c-80d1-9547c4409d6a --- # Do I Have to Derive New Classes from CObject? +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + No, you don't. Derive a class from [CObject](reference/cobject-class.md) when you need the facilities it provides, such as serialization or dynamic creatability. Many data classes need to be serialized to files, so it's often a good idea to derive them from `CObject`. For an example of a class derived from `CObject`, see the [Scribble sample](../overview/visual-cpp-samples.md). diff --git a/docs/mfc/docking-and-floating-toolbars.md b/docs/mfc/docking-and-floating-toolbars.md index 2dc9f54a2a7..ed02a6e6554 100644 --- a/docs/mfc/docking-and-floating-toolbars.md +++ b/docs/mfc/docking-and-floating-toolbars.md @@ -4,11 +4,13 @@ title: "Docking and Floating Toolbars" ms.date: "11/04/2016" f1_keywords: ["CBRS_SIZE_DYNAMIC", "CBRS_SIZE_FIXED"] helpviewer_keywords: ["size [MFC], toolbars", "size", "frame windows [MFC], toolbar docking", "CBRS_ALIGN_ANY constant [MFC]", "palettes, floating", "toolbars [MFC], docking", "CBRS_SIZE_DYNAMIC constant [MFC]", "floating toolbars", "toolbars [MFC], size", "toolbars [MFC], floating", "fixed-size toolbars", "CBRS_SIZE_FIXED constant [MFC]", "toolbar controls [MFC], wrapping", "toolbars [MFC], wrapping", "floating palettes"] -ms.assetid: b7f9f9d4-f629-47d2-a3c4-2b33fa6b51e4 ms.topic: concept-article --- # Docking and Floating Toolbars +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class Library supports dockable toolbars. A dockable toolbar can be attached, or docked, to any side of its parent window, or it can be detached, or floated, in its own mini-frame window. This article explains how to use dockable toolbars in your applications. If you use the Application Wizard to generate the skeleton of your application, you are asked to choose whether you want dockable toolbars. By default, the Application Wizard generates the code that performs the three actions necessary to place a dockable toolbar in your application: diff --git a/docs/mfc/document-and-view-classes-created-by-the-mfc-application-wizard.md b/docs/mfc/document-and-view-classes-created-by-the-mfc-application-wizard.md index 6003a3f8dc8..926435cf6f8 100644 --- a/docs/mfc/document-and-view-classes-created-by-the-mfc-application-wizard.md +++ b/docs/mfc/document-and-view-classes-created-by-the-mfc-application-wizard.md @@ -3,11 +3,13 @@ description: "Learn more about: Document and View Classes Created by the MFC App title: "Document and View Classes Created by the MFC Application Wizard" ms.date: "11/04/2016" helpviewer_keywords: ["document classes [MFC]", "document classes [MFC], created by application wizards", "application wizards [MFC], document/view classes created", "view classes [MFC], created by application wizards"] -ms.assetid: 70c34a60-2701-4981-acea-c08a5787d8e6 --- # Document and View Classes Created by the MFC Application Wizard -The MFC Application Wizard gives you a head start on your program development by creating skeletal document and view classes for you. You can then [map commands and messages to these classes](reference/mapping-messages-to-functions.md) and use the Visual C++ source code editor to write their member functions. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +The MFC Application Wizard gives you a head start on your program development by creating skeletal document and view classes for you. You can then [map commands and messages to these classes](reference/mapping-messages-to-functions.md) and use the Visual Studio source code editor to write their member functions. The document class created by the MFC Application Wizard is derived from class [CDocument](reference/cdocument-class.md). The view class is derived from [CView](reference/cview-class.md). The names that the Application Wizard gives these classes and the files that contain them are based on the project name you supply in the Application Wizard dialog box. In the Application Wizard, you can use the Generated Classes page to alter the default names. diff --git a/docs/mfc/document-classes.md b/docs/mfc/document-classes.md index 7e160a90e8c..85f0ffe26cf 100644 --- a/docs/mfc/document-classes.md +++ b/docs/mfc/document-classes.md @@ -4,10 +4,12 @@ title: "Document Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.document"] helpviewer_keywords: ["document classes [MFC]"] -ms.assetid: 4bf19b02-0a4f-4319-b68e-cddcba2705cb --- # Document Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Document class objects, created by document-template objects, manage the application's data. You will derive a class for your documents from one of these classes. Document class objects interact with view objects. View objects represent the client area of a window, display a document's data, and allow users to interact with it. Documents and views are created by a document-template object. diff --git a/docs/mfc/document-template-classes.md b/docs/mfc/document-template-classes.md index d4eb01a7d6e..ba612259b59 100644 --- a/docs/mfc/document-template-classes.md +++ b/docs/mfc/document-template-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Document-Template Classes" title: "Document-Template Classes" ms.date: "11/04/2016" helpviewer_keywords: ["document templates [MFC], classes"] -ms.assetid: 901749e9-8048-44a0-b5e2-361554650a73 --- # Document-Template Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Document-template objects coordinate the creation of document, view, and frame window objects when a new document or view is created. [CDocTemplate](reference/cdoctemplate-class.md)
diff --git a/docs/mfc/document-template-creation.md b/docs/mfc/document-template-creation.md index 5efdb1673b1..1aab92815f0 100644 --- a/docs/mfc/document-template-creation.md +++ b/docs/mfc/document-template-creation.md @@ -3,10 +3,12 @@ description: "Learn more about: Document Template Creation" title: "Document Template Creation" ms.date: "11/04/2016" helpviewer_keywords: ["document templates [MFC]", "constructors [MFC], document template", "document templates [MFC], creating", "MFC, document templates", "templates [MFC], document templates"] -ms.assetid: c87f1821-7cbf-442e-9690-f126ae7fb783 --- # Document Template Creation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When creating a new document in response to a **New** or **Open** command from the **File** menu, the document template also creates a new frame window through which to view the document. The document-template constructor specifies what types of documents, windows, and views the template will be able to create. This is determined by the arguments you pass to the document-template constructor. The following code illustrates creation of a [CMultiDocTemplate](reference/cmultidoctemplate-class.md) for a sample application: diff --git a/docs/mfc/document-templates-and-the-document-view-creation-process.md b/docs/mfc/document-templates-and-the-document-view-creation-process.md index a768e96d1e7..977df497b81 100644 --- a/docs/mfc/document-templates-and-the-document-view-creation-process.md +++ b/docs/mfc/document-templates-and-the-document-view-creation-process.md @@ -3,10 +3,12 @@ description: "Learn more about: Document Templates and the Document/View Creatio title: "Document Templates and the Document-View Creation Process" ms.date: "11/19/2018" helpviewer_keywords: ["icons, for multiple document templates", "document templates [MFC], and views", "document/view architecture [MFC], creating document/view", "single document template", "MFC, document templates", "multiple document template", "CDocTemplate class [MFC]", "templates [MFC], document templates"] -ms.assetid: 311ce4cd-fbdf-4ea1-a51b-5bb043abbcee --- # Document Templates and the Document/View Creation Process +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To manage the complex process of creating documents with their associated views and frame windows, the framework uses two document template classes: [CSingleDocTemplate](reference/csingledoctemplate-class.md) for SDI applications and [CMultiDocTemplate](reference/cmultidoctemplate-class.md) for MDI applications. A `CSingleDocTemplate` can create and store one document of one type at a time. A `CMultiDocTemplate` keeps a list of many open documents of one type. Some applications support multiple document types. For example, an application might support text documents and graphics documents. In such an application, when the user chooses the New command on the File menu, a dialog box shows a list of possible new document types to open. For each supported document type, the application uses a distinct document template object. The following figure illustrates the configuration of an MDI application that supports two document types and shows several open documents. diff --git a/docs/mfc/document-view-architecture.md b/docs/mfc/document-view-architecture.md index 1f09850246f..e782f90ac5b 100644 --- a/docs/mfc/document-view-architecture.md +++ b/docs/mfc/document-view-architecture.md @@ -3,10 +3,12 @@ description: "Learn more about: Document/View Architecture" title: "Document-View Architecture" ms.date: "11/19/2018" helpviewer_keywords: ["CView class [MFC], view architecture", "CDocument class [MFC]", "MFC, views", "views [MFC], MFC document/view model", "document objects [MFC]", "document objects [MFC], MFC document/view model", "MFC, documents", "documents [MFC], MFC document/view model", "document objects [MFC], document/view architecture"] -ms.assetid: 6127768a-553f-462a-b01b-a5ee6068c81e --- # Document/View Architecture +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + By default, the MFC Application Wizard creates an application skeleton with a document class and a view class. MFC separates data management into these two classes. The document stores the data and manages printing the data and coordinates updating multiple views of the data. The view displays the data and manages user interaction with it, including selection and editing. In this model, an MFC document object reads and writes data to persistent storage. The document may also provide an interface to the data wherever it resides (such as in a database). A separate view object manages data display, from rendering the data in a window to user selection and editing of data. The view obtains display data from the document and communicates back to the document any data changes. diff --git a/docs/mfc/document-view-creation.md b/docs/mfc/document-view-creation.md index 094a7ff5e85..dbdaa81bd3b 100644 --- a/docs/mfc/document-view-creation.md +++ b/docs/mfc/document-view-creation.md @@ -3,10 +3,12 @@ description: "Learn more about: Document/View Creation" title: "Document-View Creation" ms.date: "11/04/2016" helpviewer_keywords: ["documents [MFC], creating", "views [MFC], and frame windows", "views [MFC], creating", "tables [MFC]", "MFC, views", "document/view architecture [MFC], creating document/view", "object creators", "MFC, documents", "tables [MFC], objects each MFC object creates"] -ms.assetid: bda14f41-ed50-439d-af9e-591174e7dd64 --- # Document/View Creation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The framework supplies implementations of the **New** and **Open** commands (among others) on the **File** menu. Creation of a new document and its associated view and frame window is a cooperative effort among the application object, a document template, the newly created document, and the newly created frame window. The following table summarizes which objects create what. ### Object Creators diff --git a/docs/mfc/document-view-sample-list.md b/docs/mfc/document-view-sample-list.md index c72a073f76c..9bb5f66511c 100644 --- a/docs/mfc/document-view-sample-list.md +++ b/docs/mfc/document-view-sample-list.md @@ -2,10 +2,12 @@ description: "Learn more about: Document/View Sample List" title: "Document-View Sample List" ms.date: "11/04/2016" -ms.assetid: 6f087ce8-2f46-433c-b674-4c110743b289 --- # Document/View Sample List +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + See the following sample programs that illustrate using MFC's document/view architecture in interesting ways: *Document/View Variations* diff --git a/docs/mfc/documents-views-and-the-framework.md b/docs/mfc/documents-views-and-the-framework.md index 4c9fca0aceb..cf396b37ddd 100644 --- a/docs/mfc/documents-views-and-the-framework.md +++ b/docs/mfc/documents-views-and-the-framework.md @@ -3,10 +3,12 @@ title: "Documents, views, and the Microsoft Foundation Class (MFC) library frame description: "A description of documents and views in the Microsoft Foundation Class (MFC) library." ms.date: "09/25/2020" helpviewer_keywords: ["document templates [MFC], template objects", "applications [MFC]", "MFC, application framework", "application objects [MFC], relation to other MFC objects", "documents [MFC]", "MFC, documents", "document objects [MFC], in relation to other MFC objects", "view objects [MFC], relation to other MFC objects", "MFC, views", "document/view architecture [MFC], about document/view architecture", "objects [MFC], MFC applications", "MFC object relationships", "thread objects [MFC]"] -ms.assetid: 409ddd9b-66ad-4625-84f7-bf55a41d697b --- # Documents, views, and the framework +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + At the heart of the MFC framework are the concepts of document and view. A document is a data object with which the user interacts in an editing session. It's created by the **New** or **Open** command on the **File** menu and is typically saved in a file. (Standard MFC documents, derived from class `CDocument`, are different from Active documents and OLE compound documents.) A view is a window object through which the user interacts with a document. The key objects in a running application are: diff --git a/docs/mfc/drag-and-drop-ole.md b/docs/mfc/drag-and-drop-ole.md index 3e7d26ae827..f87bbd28647 100644 --- a/docs/mfc/drag-and-drop-ole.md +++ b/docs/mfc/drag-and-drop-ole.md @@ -3,10 +3,12 @@ title: "OLE drag and drop" description: "Overview of Microsoft Foundation Classes (MFC) OLE drag and drop, how to implement a drop source, a drop target, and how to customize drag and drop." ms.date: "02/09/2020" helpviewer_keywords: ["OLE server applications [MFC], drag and drop", "drag and drop [MFC]", "OLE applications [MFC], drag and drop", "File Manager drag and drop support [MFC]", "drag and drop [MFC], about OLE drag and drop", "OLE drag and drop [MFC]", ] -ms.assetid: a4595350-ca06-4400-88a1-f0175c76b77b --- # OLE drag and drop +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The drag-and-drop feature of OLE is primarily a shortcut for copying and pasting data. When you use the Clipboard to copy or paste data, a number of steps are required. You select the data, and choose **Cut** or **Copy** from the **Edit** menu. Then you move to the destination app or window, and place the cursor in the target location. Finally, you choose **Edit** > **Paste** from the menu. The OLE drag-and-drop feature is different from the File Manager drag-and-drop mechanism. The File Manager can only handle filenames, and is designed specifically to pass filenames to applications. Drag and drop in OLE is much more general. It allows you to drag and drop any data that could also be placed on the Clipboard. diff --git a/docs/mfc/dragging-and-dropping-files-in-a-frame-window.md b/docs/mfc/dragging-and-dropping-files-in-a-frame-window.md index f3ecc1650ed..d59c75f98b1 100644 --- a/docs/mfc/dragging-and-dropping-files-in-a-frame-window.md +++ b/docs/mfc/dragging-and-dropping-files-in-a-frame-window.md @@ -3,11 +3,13 @@ description: "Learn more about: Dragging and Dropping Files in a Frame Window" title: "Dragging and Dropping Files in a Frame Window" ms.date: "11/04/2016" helpviewer_keywords: ["drag and drop [MFC], files", "drag and drop [MFC], File Manager", "Windows Explorer [MFC]", "File Manager drag and drop support [MFC]", "files [MFC], drag and drop", "frame windows [MFC], dragging and dropping files in", "drag and drop [MFC], Windows Explorer"] -ms.assetid: 85560fe9-121b-4105-bd7b-216b966e19fa ms.topic: concept-article --- # Dragging and Dropping Files in a Frame Window +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The frame window manages a relationship with File Explorer or File Manager. By adding a few initializing calls in your override of the `CWinApp` member function `InitInstance`, as described in [CWinApp: The Application Class](cwinapp-the-application-class.md), you can have your frame window indirectly open files dragged from File Explorer or File Manager and dropped in the frame window. See [File Manager Drag and Drop](special-cwinapp-services.md). diff --git a/docs/mfc/dragging-images-from-an-image-list.md b/docs/mfc/dragging-images-from-an-image-list.md index ecea5051da3..3d782945ac2 100644 --- a/docs/mfc/dragging-images-from-an-image-list.md +++ b/docs/mfc/dragging-images-from-an-image-list.md @@ -3,11 +3,13 @@ description: "Learn more about: Dragging Images from an Image List" title: "Dragging Images from an Image List" ms.date: "11/04/2016" helpviewer_keywords: ["CImageList class [MFC], dragging images from", "dragging images from image lists [MFC]", "image lists [MFC], dragging images from", "images [MFC], dragging from image lists"] -ms.assetid: af691db8-e4f0-4046-b7b9-9acc68d3713d ms.topic: concept-article --- # Dragging Images from an Image List +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + [CImageList](reference/cimagelist-class.md) includes functions for dragging an image on the screen. The dragging functions move an image smoothly, in color, and without any flashing of the cursor. Both masked and unmasked images can be dragged. The [BeginDrag](reference/cimagelist-class.md#begindrag) member function begins a drag operation. The parameters include the index of the image to drag and the location of the hot spot within the image. The hot spot is a single pixel that the dragging functions recognize as the exact screen location of the image. Typically, an application sets the hot spot so that it coincides with the hot spot of the mouse cursor. The [DragMove](reference/cimagelist-class.md#dragmove) member function moves the image to a new location. diff --git a/docs/mfc/drawing-and-printing-classes.md b/docs/mfc/drawing-and-printing-classes.md index d43f6e9affa..97c8131d852 100644 --- a/docs/mfc/drawing-and-printing-classes.md +++ b/docs/mfc/drawing-and-printing-classes.md @@ -3,11 +3,13 @@ description: "Learn more about: Drawing and Printing Classes" title: "Drawing and Printing Classes" ms.date: "11/04/2016" helpviewer_keywords: ["output [MFC], graphical classes", "drawing [MFC], classes", "printing classes [MFC]", "graphics [MFC], graphical output classes"] -ms.assetid: 2781c599-a038-462a-98ca-634b07ee22b0 ms.topic: concept-article --- # Drawing and Printing Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In Windows, all graphical output is drawn on a virtual drawing area called a device context (DC). MFC provides classes to encapsulate the various types of DCs, as well as encapsulations for Windows drawing tools such as bitmaps, brushes, palettes, and pens. ## See also diff --git a/docs/mfc/drawing-images-from-an-image-list.md b/docs/mfc/drawing-images-from-an-image-list.md index 0f0e5cd6019..a2e7dc7581a 100644 --- a/docs/mfc/drawing-images-from-an-image-list.md +++ b/docs/mfc/drawing-images-from-an-image-list.md @@ -3,11 +3,13 @@ description: "Learn more about: Drawing Images from an Image List" title: "Drawing Images from an Image List" ms.date: "11/04/2016" helpviewer_keywords: ["CImageList class [MFC], drawing images from", "drawing [MFC], images from image lists", "image lists [MFC], drawing images from", "images [MFC], drawing"] -ms.assetid: 2f6063fb-1c28-45f8-a333-008c064db11c ms.topic: concept-article --- # Drawing Images from an Image List +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To draw an image, use the [CImageList::Draw](reference/cimagelist-class.md#draw) member function. You'll specify a pointer to a device context object, the index of the image to draw, the location in the device context at which to draw the image, and a set of flags to indicate the drawing style. When you specify the **ILD_TRANSPARENT** style, `Draw` uses a two-step process to draw a masked image. First, it performs a logical-AND operation on the bits of the image and the bits of the mask. Then it performs a logical-XOR operation on the results of the first operation and the background bits of the destination device context. This process creates transparent areas in the resulting image; that is, each white bit in the mask causes the corresponding bit in the resulting image to be transparent. diff --git a/docs/mfc/drawing-in-a-view.md b/docs/mfc/drawing-in-a-view.md index ecd59ea9512..5993704da68 100644 --- a/docs/mfc/drawing-in-a-view.md +++ b/docs/mfc/drawing-in-a-view.md @@ -3,11 +3,13 @@ description: "Learn more about: Drawing in a View" title: "Drawing in a View" ms.date: "11/04/2016" helpviewer_keywords: ["drawing [MFC], in views", "views [MFC], printing", "views [MFC], updating", "printing [MFC], views", "views [MFC], rendering", "printing views [MFC]", "paint messages in view class [MFC]", "device contexts, screen drawings"] -ms.assetid: e3761db6-0f19-4482-a4cd-ac38ef7c4d3a ms.topic: how-to --- # Drawing in a View +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Nearly all drawing in your application occurs in the view's `OnDraw` member function, which you must override in your view class. (The exception is mouse drawing, discussed in [Interpreting User Input Through a View](interpreting-user-input-through-a-view.md).) Your `OnDraw` override: 1. Gets data by calling the document member functions you provide. diff --git a/docs/mfc/drawing-tool-classes.md b/docs/mfc/drawing-tool-classes.md index 0e33ab2346e..05411c8d738 100644 --- a/docs/mfc/drawing-tool-classes.md +++ b/docs/mfc/drawing-tool-classes.md @@ -4,11 +4,13 @@ title: "Drawing Tool Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.drawing"] helpviewer_keywords: ["drawing [MFC], tool classes", "screen output classes [MFC]", "output classes [MFC]"] -ms.assetid: e907bd89-38b5-47c9-b76a-95e0bf3bb41d ms.topic: concept-article --- # Drawing Tool Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes encapsulate drawing tools that are used to draw on a device context. [CGdiObject](reference/cgdiobject-class.md)
diff --git a/docs/mfc/dynamic-layout.md b/docs/mfc/dynamic-layout.md index f92eca0ea56..460b4f46d7f 100644 --- a/docs/mfc/dynamic-layout.md +++ b/docs/mfc/dynamic-layout.md @@ -2,10 +2,12 @@ description: "Learn more about: Dynamic Layout" title: "Dynamic Layout" ms.date: "09/09/2019" -ms.assetid: 8598cfb2-c8d4-4f5a-bf2b-59dc4653e042 --- # Dynamic Layout +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + With MFC in Visual Studio 2015, you can create dialogs that the user can resize, and you can control the way the layout adjusts to the change in size. For example, you can attach buttons at the bottom of a dialog to the bottom edge so they always stay at the bottom. You can also set up certain controls such as listboxes, editboxes, and text fields to expand as the user expands the dialog. ## Specifying dynamic layout settings for an MFC dialog box diff --git a/docs/mfc/dynamic-object-creation.md b/docs/mfc/dynamic-object-creation.md index a7e77c3fe66..e41eb57dc31 100644 --- a/docs/mfc/dynamic-object-creation.md +++ b/docs/mfc/dynamic-object-creation.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["object creation [MFC], dynamically at run time", "CObject --- # Dynamic Object Creation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to create an object dynamically at run time. The procedure uses run-time class information, as discussed in the article [Accessing Run-Time Class Information](accessing-run-time-class-information.md). #### Dynamically create an object given its run-time class diff --git a/docs/mfc/enabling-tool-tips.md b/docs/mfc/enabling-tool-tips.md index 4f59728c5a1..f29d9439621 100644 --- a/docs/mfc/enabling-tool-tips.md +++ b/docs/mfc/enabling-tool-tips.md @@ -3,11 +3,13 @@ description: "Learn more about: Enabling Tool Tips" title: "Enabling Tool Tips" ms.date: "11/04/2016" helpviewer_keywords: ["initializing tool tips [MFC]", "enabling tool tips [MFC]", "tool tips [MFC], initializing", "tool tips [MFC], enabling"] -ms.assetid: 06b7c889-7722-4ce6-8b88-9efa50fe6369 ms.topic: how-to --- # Enabling Tool Tips +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can enable tool tip support for the child controls of a window (such as the controls on a form view or dialog box). ### To enable tool tips for the child controls of a window diff --git a/docs/mfc/example-displaying-a-dialog-box-via-a-menu-command.md b/docs/mfc/example-displaying-a-dialog-box-via-a-menu-command.md index b357a9e58f3..03c56551940 100644 --- a/docs/mfc/example-displaying-a-dialog-box-via-a-menu-command.md +++ b/docs/mfc/example-displaying-a-dialog-box-via-a-menu-command.md @@ -3,10 +3,12 @@ description: "Learn more about: Example: Displaying a Dialog Box via a Menu Comm title: "Example: Displaying a Dialog Box via a Menu Command" ms.date: "09/07/2019" helpviewer_keywords: ["MFC dialog boxes [MFC], examples", "MFC dialog boxes [MFC], displaying", "modeless dialog boxes [MFC], displaying", "dialog boxes [MFC], MFC", "modal dialog boxes [MFC], displaying", "examples [MFC], dialog boxes", "menu items [MFC], examples"] -ms.assetid: e8692549-acd7-478f-9c5e-ba310ce8cccd --- # Example: Displaying a Dialog Box via a Menu Command +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic contains procedures to: - Display a modal dialog box through a menu command. diff --git a/docs/mfc/example-of-active-document-containment-office-binder.md b/docs/mfc/example-of-active-document-containment-office-binder.md index 81ef5fd2faf..e09e13f91c3 100644 --- a/docs/mfc/example-of-active-document-containment-office-binder.md +++ b/docs/mfc/example-of-active-document-containment-office-binder.md @@ -3,10 +3,12 @@ description: "Learn more about: Example of Active Document Containment: Office B title: "Example of Active Document Containment: Office Binder" ms.date: "11/04/2016" helpviewer_keywords: ["active documents [MFC], containers", "examples [MFC], active document containment", "containers [MFC], active document", "active document containers [MFC], examples", "Office Binder [MFC]", "MFC COM, active document containment"] -ms.assetid: 70dd8568-e8bc-44ac-bf5e-678767efe8e3 --- # Example of Active Document Containment: Office Binder +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Office Binder is an example of an active document container. An Office Binder includes two primary panes, as containers typically do. The left pane contains icons that correspond to active documents in the Binder. Each document is called a *section* within the Binder. For example, a Binder can contain Word documents, PowerPoint files, Excel spreadsheets, and so on. Clicking an icon in the left pane activates the corresponding active document. The right pane of the Binder then displays the contents of the currently selected active document. diff --git a/docs/mfc/exception-classes.md b/docs/mfc/exception-classes.md index beaf14841a8..2b4a56ffe2a 100644 --- a/docs/mfc/exception-classes.md +++ b/docs/mfc/exception-classes.md @@ -4,10 +4,12 @@ title: "Exception Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.exception"] helpviewer_keywords: ["exception classes [MFC]", "exception handling [MFC], exception classes", "MFC, exceptions"] -ms.assetid: 1a2caf12-b3e9-4189-86d2-bf7a595bf025 --- # Exception Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The class library provides an exception-handling mechanism based on class `CException`. The application framework uses exceptions in its code; you can also use them in yours. For more information, see the article [Exceptions](exception-handling-in-mfc.md). You can derive your own exception types from `CException`. MFC provides an exception class from which you can derive your own exception as well as exception classes for all of the exceptions it supports. diff --git a/docs/mfc/exception-handling-in-mfc.md b/docs/mfc/exception-handling-in-mfc.md index 29b8e759bf4..e91a99ec97f 100644 --- a/docs/mfc/exception-handling-in-mfc.md +++ b/docs/mfc/exception-handling-in-mfc.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["DAO [MFC], exceptions", "assertions [MFC], When to use ex --- # Exception Handling in MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the exception-handling mechanisms available in MFC. Two mechanisms are available: - C++ exceptions, available in MFC version 3.0 and later diff --git a/docs/mfc/exceptions-catching-and-deleting-exceptions.md b/docs/mfc/exceptions-catching-and-deleting-exceptions.md index cd5ef814784..afd5555844f 100644 --- a/docs/mfc/exceptions-catching-and-deleting-exceptions.md +++ b/docs/mfc/exceptions-catching-and-deleting-exceptions.md @@ -3,10 +3,12 @@ description: "Learn more about: Exceptions: Catching and Deleting Exceptions" title: "Exceptions: Catching and Deleting Exceptions" ms.date: "11/04/2016" helpviewer_keywords: ["exceptions [MFC], deleting", "AND_CATCH macro [MFC]", "try-catch exception handling [MFC], catching and deleting exceptions", "exception handling [MFC], catching and deleting exceptions", "catch blocks [MFC], catching and deleting exceptions", "execution [MFC], returns from within catch block"] -ms.assetid: 7c233ff0-89de-4de0-a68a-9e9cdb164311 --- # Exceptions: Catching and Deleting Exceptions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following instructions and examples show you how to catch and delete exceptions. For more information on the **`try`**, **`catch`**, and **`throw`** keywords, see [Modern C++ best practices for exceptions and error handling](../cpp/errors-and-exception-handling-modern-cpp.md). Your exception handlers must delete exception objects they handle, because failure to delete the exception causes a memory leak whenever that code catches an exception. diff --git a/docs/mfc/exceptions-changes-to-exception-macros-in-version-3-0.md b/docs/mfc/exceptions-changes-to-exception-macros-in-version-3-0.md index 0dde24bae2e..9304a90cde0 100644 --- a/docs/mfc/exceptions-changes-to-exception-macros-in-version-3-0.md +++ b/docs/mfc/exceptions-changes-to-exception-macros-in-version-3-0.md @@ -3,10 +3,12 @@ description: "Learn more about: Exceptions: Changes to Exception Macros in Versi title: "Exceptions: Changes to Exception Macros in Version 3.0" ms.date: "11/04/2016" helpviewer_keywords: ["C++ exception handling [MFC], upgrade considerations", "CATCH macro [MFC]", "exceptions [MFC], what's changed", "THROW_LAST macro [MFC]"] -ms.assetid: 3aa20d8c-229e-449c-995c-ab879eac84bc --- # Exceptions: Changes to Exception Macros in Version 3.0 +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This is an advanced topic. In MFC version 3.0 and later, the exception-handling macros have been changed to use C++ exceptions. This article tells how those changes can affect the behavior of existing code that uses the macros. diff --git a/docs/mfc/exceptions-converting-from-mfc-exception-macros.md b/docs/mfc/exceptions-converting-from-mfc-exception-macros.md index 70337d79971..e258734d362 100644 --- a/docs/mfc/exceptions-converting-from-mfc-exception-macros.md +++ b/docs/mfc/exceptions-converting-from-mfc-exception-macros.md @@ -3,10 +3,12 @@ description: "Learn more about: Exceptions: Converting from MFC Exception Macros title: "Exceptions: Converting from MFC Exception Macros" ms.date: "08/27/2018" helpviewer_keywords: ["converting exceptions [MFC]", "exception objects [MFC]", "conversions [MFC], code written with MFC macros", "keywords [MFC], macros", "macrosv, C++ keywords", "exception objects [MFC], deleting", "CException class [MFC], deleting CException class objects", "exceptions [MFC], converting", "exceptions [MFC], deleting exception objects", "catch blocks [MFC], delimiting", "exception handling [MFC], converting exceptions"] -ms.assetid: bd3ac3b3-f3ce-4fdd-a168-a2cff13ed796 --- # Exceptions: Converting from MFC Exception Macros +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This is an advanced topic. This article explains how to convert existing code written with Microsoft Foundation Class macros — **TRY**, **CATCH**, **THROW**, and so on — to use the C++ exception-handling keywords **`try`**, **`catch`**, and **`throw`**. Topics include: diff --git a/docs/mfc/exceptions-database-exceptions.md b/docs/mfc/exceptions-database-exceptions.md index 097ddc2d7ff..ceb25baab4d 100644 --- a/docs/mfc/exceptions-database-exceptions.md +++ b/docs/mfc/exceptions-database-exceptions.md @@ -3,10 +3,12 @@ description: "Learn more about: Exceptions: Database Exceptions" title: "Exceptions: Database Exceptions" ms.date: "09/17/2019" helpviewer_keywords: ["DAO [MFC], exceptions", "exceptions [MFC], database", "exception handling [MFC], databases", "ODBC exceptions [MFC]", "ODBC [MFC], exceptions", "database exceptions [MFC]", "databases [MFC], exception handling", "error codes [MFC], database exception handling"] -ms.assetid: 28daf260-f824-4be6-aecc-1f859e6dec26 --- # Exceptions: Database Exceptions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to handle database exceptions. Most of the material in this article applies whether you are working with the MFC classes for Open Database Connectivity (ODBC) or the MFC classes for Data Access Objects (DAO). Material specific to one or the other model is explicitly marked. Topics include: - [Approaches to exception handling](#_core_approaches_to_exception_handling) diff --git a/docs/mfc/exceptions-examining-exception-contents.md b/docs/mfc/exceptions-examining-exception-contents.md index f2bedc83ebb..ea65efd6985 100644 --- a/docs/mfc/exceptions-examining-exception-contents.md +++ b/docs/mfc/exceptions-examining-exception-contents.md @@ -3,10 +3,12 @@ description: "Learn more about: Exceptions: Examining Exception Contents" title: "Exceptions: Examining Exception Contents" ms.date: "11/04/2016" helpviewer_keywords: ["exception handling [MFC], MFC", "try-catch exception handling [MFC], MFC function exceptions", "catch blocks, MFC function exceptions", "CException class [MFC], class exceptions", "try-catch exception handling [MFC], exception contents", "throwing exceptions [MFC], exception contents"] -ms.assetid: dfda4782-b969-4f60-b867-cc204ea7f33a --- # Exceptions: Examining Exception Contents +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Although a **`catch`** block's argument can be of almost any data type, the MFC functions throw exceptions of types derived from the class `CException`. To catch an exception thrown by an MFC function, then, you write a **`catch`** block whose argument is a pointer to a `CException` object (or an object derived from `CException`, such as `CMemoryException`). Depending on the exact type of the exception, you can examine the data members of the exception object to gather information about the specific cause of the exception. For example, the `CFileException` type has the `m_cause` data member, which contains an enumerated type that specifies the cause of the file exception. Some examples of the possible return values are `CFileException::fileNotFound` and `CFileException::readOnly`. diff --git a/docs/mfc/exceptions-exceptions-in-constructors.md b/docs/mfc/exceptions-exceptions-in-constructors.md index 239bf4c5625..e2d860490cf 100644 --- a/docs/mfc/exceptions-exceptions-in-constructors.md +++ b/docs/mfc/exceptions-exceptions-in-constructors.md @@ -3,10 +3,12 @@ description: "Learn more about: Exceptions: Exceptions in Constructors" title: "Exceptions: Exceptions in Constructors" ms.date: "11/04/2016" helpviewer_keywords: ["constructors [MFC], exceptions", "throwing exceptions [MFC], in constructors", "exceptions [MFC], in constructors"] -ms.assetid: a78eae5a-5821-4b27-9478-1436320ed1e1 --- # Exceptions: Exceptions in Constructors +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When throwing an exception in a constructor, clean up whatever objects and memory allocations you have made prior to throwing the exception, as explained in [Exceptions: Throwing Exceptions from Your Own Functions](exceptions-throwing-exceptions-from-your-own-functions.md). When throwing an exception in a constructor, the memory for the object itself has already been allocated by the time the constructor is called. So, the compiler will automatically deallocate the memory occupied by the object after the exception is thrown. diff --git a/docs/mfc/exceptions-freeing-objects-in-exceptions.md b/docs/mfc/exceptions-freeing-objects-in-exceptions.md index de0c17158d3..f3057b12262 100644 --- a/docs/mfc/exceptions-freeing-objects-in-exceptions.md +++ b/docs/mfc/exceptions-freeing-objects-in-exceptions.md @@ -3,10 +3,12 @@ description: "Learn more about: Exceptions: Freeing Objects in Exceptions" title: "Exceptions: Freeing Objects in Exceptions" ms.date: "11/04/2016" helpviewer_keywords: ["throwing exceptions [MFC], freeing objects in exceptions", "local exception handling", "memory leaks, caused by exception", "try-catch exception handling [MFC], destroying objects", "destroying objects [MFC]", "freeing objects [MFC]", "throwing exceptions [MFC], after destroying", "exception handling [MFC], destroying objects"] -ms.assetid: 3b14b4ee-e789-4ed2-b8e3-984950441d97 --- # Exceptions: Freeing Objects in Exceptions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the need and the method of freeing objects when an exception occurs. Topics include: - [Handling the exception locally](#_core_handling_the_exception_locally) diff --git a/docs/mfc/exceptions-ole-exceptions.md b/docs/mfc/exceptions-ole-exceptions.md index edf6080508e..0f58a8466ee 100644 --- a/docs/mfc/exceptions-ole-exceptions.md +++ b/docs/mfc/exceptions-ole-exceptions.md @@ -3,10 +3,12 @@ description: "Learn more about: Exceptions: OLE Exceptions" title: "Exceptions: OLE Exceptions" ms.date: "11/04/2016" helpviewer_keywords: ["OLE, exceptions", "OLE exceptions [MFC]", "exceptions [MFC], OLE", "exception handling [MFC], OLE", "OLE exceptions [MFC], classes for handling"] -ms.assetid: 2f8e0161-b94f-48bb-a5a2-6f644b192527 --- # Exceptions: OLE Exceptions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The techniques and facilities for handling exceptions in OLE are the same as those for handling other exceptions. For further information on exception handling, see the article [Modern C++ best practices for exceptions and error handling](../cpp/errors-and-exception-handling-modern-cpp.md). All exception objects are derived from the abstract base class `CException`. MFC provides two classes for handling OLE exceptions: diff --git a/docs/mfc/exceptions-throwing-exceptions-from-your-own-functions.md b/docs/mfc/exceptions-throwing-exceptions-from-your-own-functions.md index acc4fcb8df0..2eeea63f2be 100644 --- a/docs/mfc/exceptions-throwing-exceptions-from-your-own-functions.md +++ b/docs/mfc/exceptions-throwing-exceptions-from-your-own-functions.md @@ -3,10 +3,12 @@ description: "Learn more about: Exceptions: Throwing Exceptions from Your Own Fu title: "Exceptions: Throwing Exceptions from Your Own Functions" ms.date: "11/04/2016" helpviewer_keywords: ["throwing exceptions [MFC], from functions", "functions [MFC], throwing exceptions", "exceptions [MFC], throwing"] -ms.assetid: 492976e8-8804-4234-8e8f-30dffd0501be --- # Exceptions: Throwing Exceptions from Your Own Functions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + It is possible to use the MFC exception-handling paradigm solely to catch exceptions thrown by functions in MFC or other libraries. In addition to catching exceptions thrown by library code, you can throw exceptions from your own code if you are writing functions that can encounter exceptional conditions. When an exception is thrown, execution of the current function is stopped and jumps directly to the **`catch`** block of the innermost exception frame. The exception mechanism bypasses the normal exit path from a function. Therefore, you must be sure to delete those memory blocks that would be deleted in a normal exit. diff --git a/docs/mfc/exceptions-using-mfc-macros-and-cpp-exceptions.md b/docs/mfc/exceptions-using-mfc-macros-and-cpp-exceptions.md index e8816115764..5a1929373cb 100644 --- a/docs/mfc/exceptions-using-mfc-macros-and-cpp-exceptions.md +++ b/docs/mfc/exceptions-using-mfc-macros-and-cpp-exceptions.md @@ -3,10 +3,12 @@ description: "Learn more about: Exceptions: Using MFC Macros and C++ Exceptions" title: "Exceptions: Using MFC Macros and C++ Exceptions" ms.date: "11/04/2016" helpviewer_keywords: ["exception objects [MFC]", "memory leaks [MFC], exception object not deleted", "exception handling [MFC], MFC", "try-catch exception handling [MFC], mixing MFC macros and C++ keywords", "exception objects [MFC], deleting", "exceptions [MFC], MFC macros vs. C++ keywords", "catch blocks [MFC], mixed", "exception handling [MFC], mixed-language", "nested try blocks [MFC]", "catch blocks [MFC], explicitly deleting code in", "try-catch exception handling [MFC], nested try blocks", "heap corruption [MFC]", "nested catch blocks [MFC]"] -ms.assetid: d664a83d-879b-44d4-bdf0-029f0aca69e9 --- # Exceptions: Using MFC Macros and C++ Exceptions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article discusses considerations for writing code that uses both the MFC exception-handling macros and the C++ exception-handling keywords. This article covers the following topics: diff --git a/docs/mfc/exchanging-data.md b/docs/mfc/exchanging-data.md index 8ea303ddf53..82d3ffc820b 100644 --- a/docs/mfc/exchanging-data.md +++ b/docs/mfc/exchanging-data.md @@ -3,11 +3,13 @@ description: "Learn more about: Exchanging Data" title: "Exchanging Data" ms.date: "11/04/2016" helpviewer_keywords: ["property sheets [MFC], data exchange", "exchanging data with property sheets [MFC]", "DDX (dialog data exchange) [MFC], property sheets"] -ms.assetid: 689f02d0-51a9-455b-8ffb-5b44f0aefa28 ms.topic: concept-article --- # Exchanging Data +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As with most dialog boxes, the exchange of data between the property sheet and the application is one of the most important functions of the property sheet. This article describes how to accomplish this task. Exchanging data with a property sheet is actually a matter of exchanging data with the individual property pages of the property sheet. The procedure for exchanging data with a property page is the same as for exchanging data with a dialog box, since a [CPropertyPage](reference/cpropertypage-class.md) object is just a specialized [CDialog](reference/cdialog-class.md) object. The procedure takes advantage of the framework's dialog data exchange (DDX) facility, which exchanges data between controls in a dialog box and member variables of the dialog box object. diff --git a/docs/mfc/exitinstance-member-function.md b/docs/mfc/exitinstance-member-function.md index 7cf3e1afdee..fe4fa52c6b6 100644 --- a/docs/mfc/exitinstance-member-function.md +++ b/docs/mfc/exitinstance-member-function.md @@ -4,10 +4,12 @@ title: "ExitInstance Member Function" ms.date: "11/04/2016" f1_keywords: [] helpviewer_keywords: ["programs [MFC], terminating", "CWinApp class [MFC], ExitInstance", "ExitInstance method [MFC]"] -ms.assetid: 5bb597bd-8dab-4d49-8bcf-9c45aa8be4a2 --- # ExitInstance Member Function +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [ExitInstance](reference/cwinapp-class.md#exitinstance) member function of class [CWinApp](reference/cwinapp-class.md) is called each time a copy of your application terminates, usually as a result of the user quitting the application. Override `ExitInstance` if you need special cleanup processing, such as freeing graphics device interface (GDI) resources or deallocating memory used during program execution. Cleanup of standard items such as documents and views, however, is provided by the framework, with other overridable functions for doing special cleanup specific to those objects. diff --git a/docs/mfc/exported-dll-function-entry-points.md b/docs/mfc/exported-dll-function-entry-points.md index 0a9cbd7ae47..92c099b46ed 100644 --- a/docs/mfc/exported-dll-function-entry-points.md +++ b/docs/mfc/exported-dll-function-entry-points.md @@ -3,10 +3,12 @@ description: "Learn more about: Exported DLL Function Entry Points" title: "Exported DLL Function Entry Points" ms.date: "11/04/2016" helpviewer_keywords: ["exporting DLLs [MFC], functions", "MFC, managing state data", "state management [MFC], exported DLLs"] -ms.assetid: 3268666e-d24b-44f2-80e8-7c80f73b93ca --- # Exported DLL Function Entry Points +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For exported functions of a DLL, use the [AFX_MANAGE_STATE](reference/extension-dll-macros.md#afx_manage_state) macro to maintain the proper global state when switching from the DLL module to the calling application's DLL. When called, this macro sets `pModuleState`, a pointer to an `AFX_MODULE_STATE` structure containing global data for the module, as the effective module state for the remainder of the containing scope of the function. Upon leaving the scope containing the macro, the previous effective module state is automatically restored. diff --git a/docs/mfc/file-and-database-classes.md b/docs/mfc/file-and-database-classes.md index 0ac75d36c90..59b0f159140 100644 --- a/docs/mfc/file-and-database-classes.md +++ b/docs/mfc/file-and-database-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: File and Database Classes" title: "File and Database Classes" ms.date: "11/04/2016" helpviewer_keywords: ["database classes [MFC], MFC", "database classes [MFC]", "file classes [MFC]"] -ms.assetid: 580b169c-e26e-4395-b128-5408d08c98fe --- # File and Database Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes allow you to store information to a database or a disk file. There are three sets of database classes — OLE DB, ODBC, and DAO — that provide similar functionality. The OLE DB group is implemented using OLE DB and works with the OLE DB consumer templates, the DAO group is implemented using the Data Access Object, and the ODBC group is implemented using Open Database Connectivity. There are also a set of classes for manipulating standard files, Active streams, and HTML streams. The following categories of classes support data persistence. diff --git a/docs/mfc/file-i-o-classes.md b/docs/mfc/file-i-o-classes.md index f9b697305f7..6a988af054b 100644 --- a/docs/mfc/file-i-o-classes.md +++ b/docs/mfc/file-i-o-classes.md @@ -4,10 +4,12 @@ title: "File I-O Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.file"] helpviewer_keywords: ["disk file classes [MFC]", "stdio classes [MFC]", "OLE streams [MFC]", "I/O [MFC], MFC classes", "translated stream classes [MFC]", "file I/O classes [MFC]", "I/O [MFC], classes", "sockets classes [MFC]", "stream classes [MFC]", "memory file classes [MFC]"] -ms.assetid: 92821c3f-d9e1-47f6-98c9-3b632d86e811 --- # File I/O Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes provide an interface to traditional disk files, in-memory files, Active streams, and Windows sockets. All of the classes derived from `CFile` can be used with a `CArchive` object to perform serialization. Use the following classes, particularly `CArchive` and `CFile`, if you write your own input/output processing. Normally you do not need to derive from these classes. If you use the application framework, the default implementations of the **Open** and **Save** commands on the **File** menu will handle file I/O (using class `CArchive`), as long as you override your document's `Serialize` function to supply details about how a document serializes its contents. For more information about the file classes and serialization, see the article [Files in MFC](files-in-mfc.md) and the article [Serialization](serialization-in-mfc.md). diff --git a/docs/mfc/file-menu-in-an-mfc-database-application.md b/docs/mfc/file-menu-in-an-mfc-database-application.md index adfb60edf14..c246ff31b94 100644 --- a/docs/mfc/file-menu-in-an-mfc-database-application.md +++ b/docs/mfc/file-menu-in-an-mfc-database-application.md @@ -3,10 +3,12 @@ description: "Learn more about: File Menu in an MFC Database Application" title: "File Menu in an MFC Database Application" ms.date: "11/04/2016" helpviewer_keywords: ["File menu", "database applications [MFC], File menu commands"] -ms.assetid: 92dafb75-c1b3-4860-80a0-87a83bfc36f2 --- # File Menu in an MFC Database Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If you create an MFC database application and don't use serialization, how should you interpret the Open, Close, Save, and Save As commands on the File menu While there are no style guidelines for this question, here are a few suggestions: - Eliminate the File menu's Open command entirely. diff --git a/docs/mfc/files-in-mfc.md b/docs/mfc/files-in-mfc.md index e942e997405..8c6b346b7e6 100644 --- a/docs/mfc/files-in-mfc.md +++ b/docs/mfc/files-in-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Files in MFC" title: "Files in MFC" ms.date: "11/04/2016" helpviewer_keywords: ["serialization [MFC], MFC files", "I/O [MFC], MFC classes", "files [MFC], MFC", "files [MFC], serialization", "binary access, binary file operations in MFC", "file I/O classes [MFC]", "I/O [MFC]", "persistence [MFC]", "MFC, file operations", "files [MFC], manipulating", "binary access [MFC]"] -ms.assetid: ae25e2c5-2859-4679-ab97-438824e93ce1 --- # Files in MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In the Microsoft Foundation Class Library (MFC), class [CFile](reference/cfile-class.md) handles normal file I/O operations. This family of articles explains how to open and close files as well as read and write data to those files. It also discusses file status operations. For a description of how to use the object-based serialization features of MFC as an alternative way of reading and writing data in files, see the article [Serialization](serialization-in-mfc.md). > [!NOTE] diff --git a/docs/mfc/form-views-mfc.md b/docs/mfc/form-views-mfc.md index 05801af5441..d776257f447 100644 --- a/docs/mfc/form-views-mfc.md +++ b/docs/mfc/form-views-mfc.md @@ -3,18 +3,20 @@ description: "Learn more about: Form Views (MFC)" title: "Form Views (MFC)" ms.date: "11/04/2016" helpviewer_keywords: ["user interfaces [MFC], forms", "forms [MFC]", "applications [MFC], forms-based", "forms-based applications [MFC]", "forms [MFC], adding to applications"] -ms.assetid: efbe73c1-4ca4-4613-aac2-30d916e92c0e --- # Form Views (MFC) -You can add forms to any Visual C++ application that supports the MFC libraries, including a [forms-based application](reference/creating-a-forms-based-mfc-application.md) (one whose view class is derived from `CFormView`). If you did not initially create your application to support forms, Visual C++ will add this support for you when you insert a new form. In an SDI or MDI application, which implements the default [document/view architecture](document-view-architecture.md), when the user chooses the **New** command (by default, on the **File** menu), Visual C++ prompts the user to choose from the available forms. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +You can add forms to any Visual C++ application that supports the MFC libraries, including a [forms-based application](reference/creating-a-forms-based-mfc-application.md) (one whose view class is derived from `CFormView`). If you did not initially create your application to support forms, Visual Studio will add this support for you when you insert a new form. In an SDI or MDI application, which implements the default [document/view architecture](document-view-architecture.md), when the user chooses the **New** command (by default, on the **File** menu), Visual Studio prompts the user to choose from the available forms. With an SDI application, when the user chooses the **New** command, the current instance of the form continues to run but a new instance of the application with the selected form is created if one is not found. In an MDI application, the current instance of the form continues to run when the user chooses the **New** command. > [!NOTE] -> You can insert a form into a dialog-based application (one whose dialog class is based on `CDialog` and one in which no view class is implemented). However, without the document/view architecture, Visual C++ does not automatically implement the **File** > **New** functionality. You must create a way for the user to view additional forms, such as by implementing a tabbed dialog box with various property pages. +> You can insert a form into a dialog-based application (one whose dialog class is based on `CDialog` and one in which no view class is implemented). However, without the document/view architecture, Visual Studio does not automatically implement the **File** > **New** functionality. You must create a way for the user to view additional forms, such as by implementing a tabbed dialog box with various property pages. -When you insert a new form into your application, Visual C++ does the following: +When you insert a new form into your application, Visual Studio does the following: - Creates a class based on one of the form-style classes that you choose (`CFormView`, `CRecordView`, `CDaoRecordView`, or `CDialog`). @@ -42,7 +44,7 @@ For applications based on the document/view architecture, the **New Form** comma - Adds a call to `AddDocumentTemplate` in your application's `InitInstance` code. - Visual C++ adds this code for each new form you create, which adds the form to the list of available forms when the user chooses the **New** command. This code includes the form's associated resource ID and the names of the associated document, view, and frame classes that together make up the new form object. + Visual Studio adds this code for each new form you create, which adds the form to the list of available forms when the user chooses the **New** command. This code includes the form's associated resource ID and the names of the associated document, view, and frame classes that together make up the new form object. Document templates serve as the connection between documents, frame windows, and views. For a single document, you can create many templates. diff --git a/docs/mfc/frame-window-classes-architecture.md b/docs/mfc/frame-window-classes-architecture.md index 9ec58fb318a..0ce3de51c25 100644 --- a/docs/mfc/frame-window-classes-architecture.md +++ b/docs/mfc/frame-window-classes-architecture.md @@ -3,10 +3,12 @@ description: "Learn more about: Frame Window Classes (Architecture)" title: "Frame Window Classes (Architecture)" ms.date: "11/04/2016" helpviewer_keywords: ["frame window classes [MFC], document/view architecture"] -ms.assetid: 5da01fb4-f531-46cc-914f-e422e4f07f5d --- # Frame Window Classes (Architecture) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In document/view architecture, frame windows are windows that contain a view window. They also support having control bars attached to them. In multiple document interface (MDI) applications, the main window is derived from `CMDIFrameWnd`. It indirectly contains the documents' frames, which are `CMDIChildWnd` objects. The `CMDIChildWnd` objects, in turn, contain the documents' views. diff --git a/docs/mfc/frame-window-classes-created-by-the-application-wizard.md b/docs/mfc/frame-window-classes-created-by-the-application-wizard.md index 746bebc3b4e..d6ff9610d4c 100644 --- a/docs/mfc/frame-window-classes-created-by-the-application-wizard.md +++ b/docs/mfc/frame-window-classes-created-by-the-application-wizard.md @@ -4,10 +4,12 @@ title: "Frame-Window Classes Created by the Application Wizard" ms.date: "11/04/2016" f1_keywords: ["CMainFrame"] helpviewer_keywords: ["application wizards [MFC], frame window classes created by", "window classes [MFC]", "classes [MFC], frame-window", "CMDIFrameWnd class [MFC], frame windows", "window classes [MFC], frame", "CFrameWnd class [MFC], frame windows", "CMDIChildWnd class [MFC], frame windows", "frame window classes [MFC], created by application wizards", "CMainFrame class [MFC]"] -ms.assetid: 9947df73-4470-49a0-ac61-7b6ee401a74e --- # Frame-Window Classes Created by the Application Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you to create a new MFC project from the **New Project** dialog, in addition to application, document, and view classes, the Application Wizard creates a derived frame-window class for your application's main frame window. The class is called `CMainFrame` by default, and the files that contain it are named MAINFRM.H and MAINFRM.CPP. If your application is SDI, your `CMainFrame` class is derived from class [CFrameWnd](reference/cframewnd-class.md). diff --git a/docs/mfc/frame-window-classes-windows.md b/docs/mfc/frame-window-classes-windows.md index 0f875746e21..ee535bfbb9d 100644 --- a/docs/mfc/frame-window-classes-windows.md +++ b/docs/mfc/frame-window-classes-windows.md @@ -4,10 +4,12 @@ title: "Frame Window Classes (Windows)" ms.date: "11/04/2016" f1_keywords: ["vc.classes.frame"] helpviewer_keywords: ["frame window classes [MFC], reference"] -ms.assetid: 6342ec5f-f922-4da8-a78e-2f5f994c7142 --- # Frame Window Classes (Windows) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Frame windows are windows that frame an application or a part of an application. Frame windows usually contain other windows, such as views, tool bars, and status bars. In the case of `CMDIFrameWnd`, they may contain `CMDIChildWnd` objects indirectly. [CFrameWnd](reference/cframewnd-class.md)
diff --git a/docs/mfc/frame-window-classes.md b/docs/mfc/frame-window-classes.md index b0c19b7b4d5..6b3ddcc18b3 100644 --- a/docs/mfc/frame-window-classes.md +++ b/docs/mfc/frame-window-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Frame-Window Classes" title: "Frame-Window Classes" ms.date: "11/04/2016" helpviewer_keywords: ["frame window classes [MFC], about frame window classes", "frame window classes [MFC]", "windows [MFC], MDI", "document frame windows [MFC], classes", "single document interface (SDI), frame windows", "window classes [MFC], frame", "MFC, frame windows", "MDI [MFC], frame windows", "classes [MFC], window"] -ms.assetid: c27e43a7-8ad0-4759-b1b7-43f4725f4132 --- # Frame-Window Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Each application has one "main frame window," a desktop window that usually has the application name in its caption. Each document usually has one "document frame window." A document frame window contains at least one view, which presents the document's data. ## Frame Windows in SDI and MDI Applications diff --git a/docs/mfc/frame-window-styles-cpp.md b/docs/mfc/frame-window-styles-cpp.md index 68735c8e2b4..8a8c08fbcb7 100644 --- a/docs/mfc/frame-window-styles-cpp.md +++ b/docs/mfc/frame-window-styles-cpp.md @@ -3,10 +3,12 @@ description: "Learn more about: Frame-Window Styles (C++)" title: "Frame-Window Styles (C++)" ms.date: "11/04/2016" helpviewer_keywords: ["window styles [MFC]", "PreCreateWindow method, setting window styles", "windows [MFC], MFC", "frame windows [MFC], styles", "MFC, frame windows", "styles [MFC], windows"] -ms.assetid: fc5058c1-eec8-48d8-9f76-3fc01cfa53f7 --- # Frame-Window Styles (C++) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The frame windows you get with the framework are suitable for most programs, but you can gain additional flexibility by using the advanced functions [PreCreateWindow](reference/cwnd-class.md#precreatewindow) and the MFC global function [AfxRegisterWndClass](reference/application-information-and-management.md#afxregisterwndclass). `PreCreateWindow` is a member function of `CWnd`. If you apply the **WS_HSCROLL** and **WS_VSCROLL** styles to the main frame window, they are instead applied to the **MDICLIENT** window so users can scroll the **MDICLIENT** area. diff --git a/docs/mfc/frame-windows.md b/docs/mfc/frame-windows.md index 8c8089e2eac..1bd2f9d2309 100644 --- a/docs/mfc/frame-windows.md +++ b/docs/mfc/frame-windows.md @@ -3,10 +3,12 @@ description: "Learn more about: Frame Windows" title: "Frame Windows" ms.date: "11/19/2018" helpviewer_keywords: ["document frame windows [MFC]", "windows [MFC], MDI", "window classes [MFC], frame", "single document interface (SDI) [MFC]", "single document interface (SDI) [MFC], frame windows", "views [MFC], and frame windows", "CFrameWnd class [MFC], frame windows", "frame windows [MFC]", "frame windows [MFC], about frame windows", "MFC, frame windows", "MDI [MFC], frame windows", "splitter windows [MFC], and frame windows"] -ms.assetid: 40677339-8135-4f5e-aba6-3fced3078077 --- # Frame Windows +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When an application runs under Windows, the user interacts with documents displayed in frame windows. A document frame window has two major components: the frame and the contents that it frames. A document frame window can be a [single document interface](sdi-and-mdi.md) (SDI) frame window or a [multiple document interface](sdi-and-mdi.md) (MDI) child window. Windows manages most of the user's interaction with the frame window: moving and resizing the window, closing it, and minimizing and maximizing it. You manage the contents inside the frame. ## Frame Windows and Views diff --git a/docs/mfc/framework-mfc.md b/docs/mfc/framework-mfc.md index 0bd459a85d7..e7db2e8352d 100644 --- a/docs/mfc/framework-mfc.md +++ b/docs/mfc/framework-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Framework (MFC)" title: "Framework (MFC)" ms.date: "09/17/2019" helpviewer_keywords: ["encapsulation [MFC], Win32 API", "MFC, application framework", "wrapper classes [MFC], explained", "Win32 [MFC], API encapsulation by MFC", "application framework [MFC], about MFC application framework", "APIs [MFC], encapsulation by MFC Win32", "encapsulation [MFC]", "Windows API [MFC], encapsulation by MFC", "encapsulated Win32 API [MFC]"] -ms.assetid: 3be0fec8-9843-4119-ae42-ece993ef500b --- # Framework (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Your work with the Microsoft Foundation Class (MFC) Library framework is based largely on a few major classes and several Visual C++ tools. Some classes encapsulate a large portion of the Win32 application programming interface (API). Other classes encapsulate application concepts such as documents, views, and the application itself. Still others encapsulate OLE features and ODBC and DAO data-access functionality. (DAO is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete.) For example, Win32's concept of window is encapsulated by MFC class `CWnd`. That is, a C++ class called `CWnd` encapsulates or "wraps" the `HWND` handle that represents a Windows window. Likewise, class `CDialog` encapsulates Win32 dialog boxes. diff --git a/docs/mfc/general-class-design-philosophy.md b/docs/mfc/general-class-design-philosophy.md index 0057725329e..f38f1d3c423 100644 --- a/docs/mfc/general-class-design-philosophy.md +++ b/docs/mfc/general-class-design-philosophy.md @@ -3,10 +3,12 @@ description: "Learn more about: General Class Design Philosophy" title: "General Class Design Philosophy" ms.date: "11/04/2016" helpviewer_keywords: ["designing classes [MFC]", "MFC, Windows API", "Visual C, Windows API calls", "classes [MFC], MFC class design", "Windows API [MFC], and MFC"] -ms.assetid: e6861ae0-1581-4d9c-9ddf-63f9afcdb913 --- # General Class Design Philosophy +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Microsoft Windows was designed long before the C++ language became popular. Because thousands of applications use the C-language Windows application programming interface (API), that interface will be maintained for the foreseeable future. Any C++ Windows interface must therefore be built on top of the procedural C-language API. This guarantees that C++ applications will be able to coexist with C applications. The Microsoft Foundation Class Library is an object-oriented interface to Windows that meets the following design goals: diff --git a/docs/mfc/general-mfc-topics.md b/docs/mfc/general-mfc-topics.md index d1164397dce..2f263111a30 100644 --- a/docs/mfc/general-mfc-topics.md +++ b/docs/mfc/general-mfc-topics.md @@ -3,10 +3,12 @@ description: "Learn more about: General MFC Topics" title: "General MFC Topics" ms.date: "09/17/2019" helpviewer_keywords: ["MFC", "class libraries [MFC], MFC", "MFC, application development"] -ms.assetid: 617e9945-9bb3-471d-a3ba-e235fcfb55d1 --- # General MFC Topics +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This family of articles includes technical details about the Microsoft Foundation Class (MFC) Library and provides an overview of the MFC framework and its key components and subsystems. The Microsoft Foundation Class Library is an application framework for programming in Microsoft Windows. Written in C++, MFC provides much of the code necessary for managing windows, menus, and dialog boxes; performing basic input/output; storing collections of data objects; and so on. All you need to do is add your application-specific code into this framework. Given the nature of C++ class programming, it is easy to extend or override the basic functionality that [the MFC framework](framework-mfc.md) supplies. diff --git a/docs/mfc/general-window-creation-sequence.md b/docs/mfc/general-window-creation-sequence.md index ae89ab7bece..b8c0f220f2c 100644 --- a/docs/mfc/general-window-creation-sequence.md +++ b/docs/mfc/general-window-creation-sequence.md @@ -3,10 +3,12 @@ description: "Learn more about: General Window Creation Sequence" title: "General Window Creation Sequence" ms.date: "11/04/2016" helpviewer_keywords: ["sequence [MFC], window creation", "frame windows [MFC], creating", "windows [MFC], creating", "sequence [MFC]"] -ms.assetid: 9cd8c7ea-5e24-429e-b6d9-d7b6041d8ba6 --- # General Window Creation Sequence +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you create a window of your own, such as a child window, the framework uses much the same process as that described in [Document/View Creation](document-view-creation.md). All the window classes provided by MFC employ [two-stage construction](one-stage-and-two-stage-construction-of-objects.md). That is, during an invocation of the C++ **`new`** operator, the constructor allocates and initializes a C++ object but does not create a corresponding Windows window. That is done afterward by calling the [Create](reference/cwnd-class.md#create) member function of the window object. diff --git a/docs/mfc/global-hot-keys.md b/docs/mfc/global-hot-keys.md index 004ba568eab..4387b3750b4 100644 --- a/docs/mfc/global-hot-keys.md +++ b/docs/mfc/global-hot-keys.md @@ -3,10 +3,12 @@ description: "Learn more about: Global Hot Keys" title: "Global Hot Keys" ms.date: "11/04/2016" helpviewer_keywords: ["keyboard shortcuts [MFC], hot keys", "CHotKeyCtrl class [MFC], global hot keys", "access keys [MFC], hot keys", "global hot keys [MFC]"] -ms.assetid: e0b95d14-c571-4c9a-9cd1-e7fc1f0e278d --- # Global Hot Keys +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A global hot key is associated with a particular nonchild window. It allows the user to activate the window from any part of the system. An application sets a global hot key for a particular window by sending the [WM_SETHOTKEY](/windows/win32/inputdev/wm-sethotkey) message to that window. For instance, if `m_HotKeyCtrl` is the [CHotKeyCtrl](reference/chotkeyctrl-class.md) object and `pMainWnd` is a pointer to the window to be activated when the hot key is pressed, you could use the following code to associate the hot key specified in the control with the window pointed to by `pMainWnd`. [!code-cpp[NVC_MFCControlLadenDialog#18](codesnippet/cpp/global-hot-keys_1.cpp)] diff --git a/docs/mfc/graphic-objects.md b/docs/mfc/graphic-objects.md index 5d7445e9f6e..196ecb4edba 100644 --- a/docs/mfc/graphic-objects.md +++ b/docs/mfc/graphic-objects.md @@ -4,10 +4,12 @@ title: "Graphic Objects" ms.date: "11/04/2016" f1_keywords: ["HRGN", "HFONT", "HBITMAP"] helpviewer_keywords: ["CRgn class [MFC], HRGN handle type", "HPEN [MFC]", "objects [MFC], graphic", "palettes [MFC], creating in device context", "pens [MFC], creating in device context", "bitmaps [MFC], creating in device contexts", "palette objects [MFC]", "memory [MFC], display contexts", "MFC, graphic objects", "regions [MFC], creating in device context", "CPen class [MFC], HPEN handle type", "GDI objects [MFC]", "HRGN [MFC]", "graphic objects [MFC]", "GDI objects [MFC], graphic-object classes", "CFont class [MFC], HFONT handle type", "HFONT and class CFont [MFC]", "HBITMAP and class CBitmap [MFC]", "fonts [MFC], creating in device context", "images [MFC], graphic objects [MFC]", "CBitmap class [MFC], HBITMAP handle type", "HPALETTE and class CPalette [MFC]", "CBrush class [MFC], HBRUSH handle type", "objects [MFC], graphic objects", "drawing [MFC], in device contexts", "device contexts [MFC], graphic objects [MFC]", "brushes [MFC], creating in device context", "region objects [MFC]", "pen objects [MFC]", "GDI [MFC], graphic-object classes", "graphic objects [MFC], creating in device context", "HBRUSH and class CBrush [MFC]", "painting and device context [MFC]", "CPalette class [MFC], HPALETTE handle type"] -ms.assetid: 41963b25-34b7-4343-8446-34ba516b83ca --- # Graphic Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Windows provides a variety of drawing tools to use in device contexts. It provides pens to draw lines, brushes to fill interiors, and fonts to draw text. MFC provides graphic-object classes equivalent to the drawing tools in Windows. The table below shows the available classes and the equivalent Windows graphics device interface (GDI) handle types. > [!NOTE] diff --git a/docs/mfc/handlers-for-commands-and-control-notifications.md b/docs/mfc/handlers-for-commands-and-control-notifications.md index 739d0f6dcf0..dda508b3e70 100644 --- a/docs/mfc/handlers-for-commands-and-control-notifications.md +++ b/docs/mfc/handlers-for-commands-and-control-notifications.md @@ -3,10 +3,12 @@ description: "Learn more about: Handlers for Commands and Control Notifications" title: "Handlers for Commands and Control Notifications" ms.date: "11/04/2016" helpviewer_keywords: ["commands [MFC], handlers for", "functions [MFC], handler", "handlers [MFC]", "controls [MFC], notifications", "handlers [MFC], control notification [MFC]", "notifications [MFC], handlers for control", "handlers [MFC], command"] -ms.assetid: 20f57f4a-f577-4c09-80a2-43faf32a1c2e --- # Handlers for Commands and Control Notifications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + There are no default handlers for commands or control-notification messages. Therefore, you are bound only by convention in naming your handlers for these categories of messages. When you map the command or control notification to a handler, the [Class Wizard](reference/mfc-class-wizard.md) proposes a name based on the command ID or control-notification code. You can accept the proposed name, change it, or replace it. Convention suggests that you name handlers in both categories for the user-interface object they represent. Thus a handler for the Cut command on the Edit menu might be named diff --git a/docs/mfc/handlers-for-message-map-ranges.md b/docs/mfc/handlers-for-message-map-ranges.md index 6e74a048aaf..d7e36d824a8 100644 --- a/docs/mfc/handlers-for-message-map-ranges.md +++ b/docs/mfc/handlers-for-message-map-ranges.md @@ -3,10 +3,12 @@ description: "Learn more about: Handlers for Message-Map Ranges" title: "Handlers for Message-Map Ranges" ms.date: "11/04/2016" helpviewer_keywords: ["message handlers [MFC]", "handlers [MFC], message-map ranges", "message maps [MFC], message handler functions", "message maps [MFC], ranges", "control-notification messages [MFC]", "command IDs [MFC], message mapping", "message-map ranges [MFC]", "handlers [MFC]", "message handling [MFC], message handler functions", "mappings [MFC], message ranges", "command handling [MFC], command update handlers", "controls [MFC], notifications", "handler functions [MFC], message-map ranges", "handler functions [MFC]", "command update handlers [MFC]", "command routing [MFC], command update handlers", "message ranges [MFC]", "handler functions [MFC], declaring", "message ranges [MFC], mapping"] -ms.assetid: a271478b-5e1c-46f5-9f29-e5be44b27d08 --- # Handlers for Message-Map Ranges +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to map a range of messages to a single message handler function (instead of mapping one message to only one function). There are times when you need to process more than one message or control notification in exactly the same way. At such times, you might wish to map all of the messages to a single handler function. Message-map ranges allow you to do this for a contiguous range of messages: diff --git a/docs/mfc/handlers-for-standard-windows-messages.md b/docs/mfc/handlers-for-standard-windows-messages.md index 7554c3d59ea..5292702cde8 100644 --- a/docs/mfc/handlers-for-standard-windows-messages.md +++ b/docs/mfc/handlers-for-standard-windows-messages.md @@ -4,10 +4,12 @@ title: "Handlers for Standard Windows Messages" ms.date: "11/04/2016" f1_keywords: ["afx_msg"] helpviewer_keywords: ["Windows messages [MFC], handlers", "message handling [MFC], Windows message handlers", "handler functions, standard Windows messages", "functions [MFC], handler", "messages [MFC], Windows"] -ms.assetid: 19412a8b-2c38-4502-81da-13c823c7e36c --- # Handlers for Standard Windows Messages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Default handlers for standard Windows messages (**WM_**) are predefined in class `CWnd`. The class library bases names for these handlers on the message name. For example, the handler for the **WM_PAINT** message is declared in `CWnd` as: `afx_msg void OnPaint();` diff --git a/docs/mfc/handling-commands-in-the-document.md b/docs/mfc/handling-commands-in-the-document.md index f821152d3ec..48f29840f9e 100644 --- a/docs/mfc/handling-commands-in-the-document.md +++ b/docs/mfc/handling-commands-in-the-document.md @@ -3,11 +3,13 @@ description: "Learn more about: Handling Commands in the Document" title: "Handling Commands in the Document" ms.date: "11/04/2016" helpviewer_keywords: ["message maps [MFC], in document class", "command handling [MFC]", "documents [MFC], message maps", "message handling [MFC], WM_COMMAND messages", "command handling [MFC], commands in documents", "documents [MFC], handling messages in"] -ms.assetid: c7375584-27af-4275-b2fd-afea476785d0 ms.topic: concept-article --- # Handling Commands in the Document +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Your document class may also handle certain commands generated by menu items, toolbar buttons, or accelerator keys. By default, `CDocument` handles the Save and Save As commands on the File menu, using serialization. Other commands that affect the data may also be handled by member functions of your document. For example, in the Scribble program, class `CScribDoc` provides a handler for the Edit Clear All command, which deletes all of the data currently stored in the document. Documents can have message maps, but unlike views, documents cannot handle standard Windows messages — only **WM_COMMAND** messages, or "commands." ## See also diff --git a/docs/mfc/handling-customization-notifications.md b/docs/mfc/handling-customization-notifications.md index 1d2ffb237db..9a28ecd13b4 100644 --- a/docs/mfc/handling-customization-notifications.md +++ b/docs/mfc/handling-customization-notifications.md @@ -4,11 +4,13 @@ title: "Handling Customization Notifications" ms.date: "11/04/2016" f1_keywords: ["TBN_CUSTHELP", "TBN_QUERYINSERT", "TBNOTIFY", "NMHDR", "TBN_TOOLBARCHANGE", "TBN_ENDDRAG", "NM_SETFOCUS", "TBN_RESET", "NM_RETURN", "NM_ENDWAIT", "NM_STARTWAIT", "TBN_BEGINDRAG", "NM_OUTOFMEMORY", "TBN_QUERYDELETE", "NM_DBLCLK", "TBN_ENDADJUST", "NM_KILLFOCUS", "NM_RCLICK", "TBN_BEGINADJUST", "NM_CLICK"] helpviewer_keywords: ["TBN_ENDADJUST notification [MFC]", "TBNOTIFY notification [MFC]", "TBN_BEGINDRAG notification [MFC]", "TBN_TOOLBARCHANGE notification [MFC]", "NM_CLICK notification [MFC]", "NM_RETURN notification [MFC]", "NM_RCLICK notification [MFC]", "TBN_ENDDRAG notification [MFC]", "TBN_BEGINADJUST notification [MFC]", "NM_ENDWAIT notification [MFC]", "NM_KILLFOCUS notification [MFC]", "NM_SETFOCUS notification [MFC]", "NM_OUTOFMEMORY notification [MFC]", "TBN_QUERYINSERT notification [MFC]", "NMHDR [MFC]", "NM_STARTWAIT notification [MFC]", "CToolBarCtrl class [MFC], handling notifications", "TBN_CUSTHELP notification [MFC]", "TBN_RESET notification [MFC]", "NM_DBLCLK notification [MFC]", "TBN_QUERYDELETE notification [MFC]", "NM_RDBLCLK notification [MFC]", "TBN_GETBUTTONINFO notification [MFC]"] -ms.assetid: 219ea08e-7515-4b98-85cb-47120f08c0a2 ms.topic: concept-article --- # Handling Customization Notifications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A Windows toolbar common control has built-in customization features, including a system-defined customization dialog box, which allow the user to insert, delete, or rearrange toolbar buttons. The application determines whether the customization features are available and controls the extent to which the user can customize the toolbar. You can make these customization features available to the user by giving the toolbar the **CCS_ADJUSTABLE** style. The customization features allow the user to drag a button to a new position or to remove a button by dragging it off the toolbar. In addition, the user can double-click the toolbar to display the **Customize Toolbar** dialog box, which allows the user to add, delete, and rearrange toolbar buttons. The application can display the dialog box by using the [Customize](reference/ctoolbarctrl-class.md#customize) member function. diff --git a/docs/mfc/handling-reflected-messages.md b/docs/mfc/handling-reflected-messages.md index f7d74de5c86..ccb42f01c17 100644 --- a/docs/mfc/handling-reflected-messages.md +++ b/docs/mfc/handling-reflected-messages.md @@ -3,11 +3,13 @@ description: "Learn more about: Handling Reflected Messages" title: "Handling Reflected Messages" ms.date: "11/04/2016" helpviewer_keywords: ["message handling [MFC], reflected messages", "reflected messages, handling"] -ms.assetid: 147a4e0c-51cc-4447-a8e1-c28b4cece578 ms.topic: concept-article --- # Handling Reflected Messages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Message reflection lets you handle messages for a control, such as **WM_CTLCOLOR**, **WM_COMMAND**, and **WM_NOTIFY**, within the control itself. This makes the control more self-contained and portable. The mechanism works with Windows common controls as well as with ActiveX controls (formerly called OLE controls). Message reflection lets you reuse your `CWnd`-derived classes more readily. Message reflection works via [CWnd::OnChildNotify](reference/cwnd-class.md#onchildnotify), using special **ON_XXX_REFLECT** message map entries: for example, **ON_CTLCOLOR_REFLECT** and **ON_CONTROL_REFLECT**. [Technical Note 62](tn062-message-reflection-for-windows-controls.md) explains message reflection in more detail. diff --git a/docs/mfc/handling-the-apply-button.md b/docs/mfc/handling-the-apply-button.md index 3cfdef6bf9d..bb46aa7c06c 100644 --- a/docs/mfc/handling-the-apply-button.md +++ b/docs/mfc/handling-the-apply-button.md @@ -3,11 +3,13 @@ description: "Learn more about: Handling the Apply Button" title: "Handling the Apply Button" ms.date: "11/04/2016" helpviewer_keywords: ["Apply button in property sheet", "property sheets, Apply button"] -ms.assetid: 7e977015-59b8-406f-b545-aad0bfd8d55b ms.topic: concept-article --- # Handling the Apply Button +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Property sheets have a capability that standard dialog boxes do not: They allow the user to apply changes they have made before closing the property sheet. This is done using the Apply button. This article discusses methods you can use to implement this feature properly. Modal dialog boxes usually apply the settings to an external object when the user clicks OK to close the dialog box. The same is true for a property sheet: When the user clicks OK, the new settings in the property sheet take effect. diff --git a/docs/mfc/handling-tool-tip-notifications.md b/docs/mfc/handling-tool-tip-notifications.md index 8c1ed327ee5..8d03fb75ae9 100644 --- a/docs/mfc/handling-tool-tip-notifications.md +++ b/docs/mfc/handling-tool-tip-notifications.md @@ -3,11 +3,13 @@ description: "Learn more about: Handling Tool Tip Notifications" title: "Handling Tool Tip Notifications" ms.date: "11/04/2016" helpviewer_keywords: ["TOOLTIPTEXT structure [MFC]", "CToolBarCtrl class [MFC], handling notifications", "notifications [MFC], tool tips", "tool tips [MFC], notifications"] -ms.assetid: ddb93b5f-2e4f-4537-8053-3453c86e2bbb ms.topic: concept-article --- # Handling Tool Tip Notifications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you specify the **TBSTYLE_TOOLTIPS** style, the toolbar creates and manages a tool tip control. A tool tip is a small pop-up window that contains a line of text describing a toolbar button. The tool tip is hidden, appearing only when the user puts the cursor on a toolbar button and leaves it there for approximately one-half second. The tool tip is displayed near the cursor. Before the tool tip is displayed, the **TTN_NEEDTEXT** notification message is sent to the toolbar's owner window to retrieve the descriptive text for the button. If the toolbar's owner window is a `CFrameWnd` window, tool tips are displayed without any extra effort, because `CFrameWnd` has a default handler for the **TTN_NEEDTEXT** notification. If the toolbar's owner window is not derived from `CFrameWnd`, such as a dialog box or form view, you must add an entry to your owner window's message map and provide a notification handler in the message map. The entry to your owner window's message map is as follows: diff --git a/docs/mfc/handling-ttn-needtext-notification-for-tool-tips.md b/docs/mfc/handling-ttn-needtext-notification-for-tool-tips.md index 12058fb2d4e..8e0115299df 100644 --- a/docs/mfc/handling-ttn-needtext-notification-for-tool-tips.md +++ b/docs/mfc/handling-ttn-needtext-notification-for-tool-tips.md @@ -4,11 +4,13 @@ title: "Handling TTN_NEEDTEXT Notification for Tool Tips" ms.date: "11/04/2016" f1_keywords: ["TTN_NEEDTEXT"] helpviewer_keywords: ["TTN_NEEDTEXT message [MFC]", "notifications [MFC], tool tips", "tool tips [MFC], notifications"] -ms.assetid: d0370a65-21ba-4676-bcc5-8cf851bbb15c ms.topic: concept-article --- # Handling TTN_NEEDTEXT Notification for Tool Tips +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As part of [enabling tool tips](enabling-tool-tips.md), you handle the **TTN_NEEDTEXT** message by adding the following entry to your owner window's message map: [!code-cpp[NVC_MFCControlLadenDialog#40](codesnippet/cpp/handling-ttn-needtext-notification-for-tool-tips_1.cpp)] diff --git a/docs/mfc/handling-windows-messages-in-your-dialog-box.md b/docs/mfc/handling-windows-messages-in-your-dialog-box.md index 66db7e66085..d2c9173a4d9 100644 --- a/docs/mfc/handling-windows-messages-in-your-dialog-box.md +++ b/docs/mfc/handling-windows-messages-in-your-dialog-box.md @@ -3,11 +3,13 @@ description: "Learn more about: Handling Windows Messages in Your Dialog Box" title: "Handling Windows Messages in Your Dialog Box" ms.date: "09/05/2019" helpviewer_keywords: ["MFC dialog boxes [MFC], Windows messages", "Windows messages [MFC], handling", "message handling [MFC], in dialog boxes"] -ms.assetid: 4af0c9cb-09da-4b15-97df-a1cfb89def79 ms.topic: concept-article --- # Handling Windows Messages in Your Dialog Box +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Dialog boxes are windows, so they can handle Windows messages if you supply the appropriate handler functions. When you create your dialog class with the [Class Wizard](reference/mfc-class-wizard.md), the wizard adds an empty message map to the class. Use the wizard to map any Windows messages or commands you want your class to handle. See [Mapping Windows Messages to Your Dialog Class](mapping-windows-messages-to-your-class.md) for more information. diff --git a/docs/mfc/header-control-and-list-control.md b/docs/mfc/header-control-and-list-control.md index 447a06ef773..fe9450fb237 100644 --- a/docs/mfc/header-control-and-list-control.md +++ b/docs/mfc/header-control-and-list-control.md @@ -3,10 +3,12 @@ description: "Learn more about: Header Control and List Control" title: "Header Control and List Control" ms.date: "11/04/2016" helpviewer_keywords: ["CListCtrl class [MFC], with CHeaderCtrl", "CListCtrl class [MFC], header controls", "CHeaderCtrl class [MFC], with CListCtrl", "controls [MFC], header", "header controls [MFC]", "header controls [MFC], list controls used with"] -ms.assetid: b20194b1-1a6b-4e2f-b890-1b3cca6650bc --- # Header Control and List Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In most cases, you will use the header control that is embedded in a [CListCtrl](reference/clistctrl-class.md) or [CListView](reference/clistview-class.md) object. However, there are cases where a separate header control object is desirable, such as manipulating data, arranged in columns or rows, in a [CView](reference/cview-class.md)-derived object. In these cases, you need greater control over the appearance and default behavior of an embedded header control. In the common case that you want a header control to provide standard, default behavior, you may want to use [CListCtrl](reference/clistctrl-class.md) or [CListView](reference/clistview-class.md) instead. Use `CListCtrl` when you want the functionality of a default header control, embedded in a list view common control. Use [CListView](reference/clistview-class.md) when you want the functionality of a default header control, embedded in a view object. diff --git a/docs/mfc/header-control-examples.md b/docs/mfc/header-control-examples.md index 19e93cf27ee..831c040b22e 100644 --- a/docs/mfc/header-control-examples.md +++ b/docs/mfc/header-control-examples.md @@ -3,10 +3,12 @@ description: "Learn more about: Header Control Examples" title: "Header Control Examples" ms.date: "11/04/2016" helpviewer_keywords: ["sample applications [MFC], header controls", "controls [MFC], header"] -ms.assetid: 30050732-d53e-4eab-88d7-61aac52914c9 --- # Header Control Examples +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For examples of header controls, see the [Header Controls](/windows/win32/Controls/header-controls) in the Windows SDK. ## See also diff --git a/docs/mfc/header-items-in-a-header-control.md b/docs/mfc/header-items-in-a-header-control.md index 86592027737..6090d24d31c 100644 --- a/docs/mfc/header-items-in-a-header-control.md +++ b/docs/mfc/header-items-in-a-header-control.md @@ -3,10 +3,12 @@ description: "Learn more about: Header Items in a Header Control" title: "Header Items in a Header Control" ms.date: "11/04/2016" helpviewer_keywords: ["header controls [MFC], header items in", "header items in header controls [MFC]", "CHeaderCtrl class [MFC], header items in", "controls [MFC], header"] -ms.assetid: ac79ef1f-a671-4ab2-93e9-b1aa016a48bf --- # Header Items in a Header Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You have considerable control over the appearance and behavior of the header items that make up a header control ([CHeaderCtrl](reference/cheaderctrl-class.md)). Each header item can have a string, a bitmapped image, an image from an associated image list, or an application-defined 32-bit value associated with it. The string, bitmap, or image is displayed in the header item. You can customize the appearance and contents of new items when they are created by making a call [CHeaderCtrl::InsertItem](reference/cheaderctrl-class.md#insertitem) or by modifying an existing item, with a call to [CHeaderCtrl::GetItem](reference/cheaderctrl-class.md#getitem) and [CHeaderCtrl::SetItem](reference/cheaderctrl-class.md#setitem). diff --git a/docs/mfc/headers-and-footers.md b/docs/mfc/headers-and-footers.md index 52ce6bbb624..56c7002ac02 100644 --- a/docs/mfc/headers-and-footers.md +++ b/docs/mfc/headers-and-footers.md @@ -3,10 +3,12 @@ description: "Learn more about: Headers and Footers" title: "Headers and Footers" ms.date: "11/04/2016" helpviewer_keywords: ["printing [MFC], multipage documents", "page headers [MFC], printing", "headers [MFC], printing", "footers [MFC], printing", "page footers [MFC], printing", "page headers [MFC]", "printing [MFC], headers and footers", "page footers [MFC]"] -ms.assetid: b0be9c53-5773-4955-a777-3c15da745128 --- # Headers and Footers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to add headers and footers to a printed document. When you look at a document on the screen, the name of the document and your current location in the document are commonly displayed in a title bar and a status bar. When looking at a printed copy of a document, it's useful to have the name and page number shown in a header or footer. This is a common way in which even WYSIWYG programs differ in how they perform printing and screen display. diff --git a/docs/mfc/help-menu-merging.md b/docs/mfc/help-menu-merging.md index 39addc15747..4034238ed17 100644 --- a/docs/mfc/help-menu-merging.md +++ b/docs/mfc/help-menu-merging.md @@ -3,10 +3,12 @@ description: "Learn more about: Help Menu Merging" title: "Help Menu Merging" ms.date: "11/04/2016" helpviewer_keywords: ["menus [MFC], merging", "merging Help menus [MFC]", "Help [MFC], for active document containers"] -ms.assetid: 9d615999-79ba-471a-9288-718f0c903d49 --- # Help Menu Merging +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When an object is active within a container, the menu merging protocol of OLE Documents gives the object complete control of the **Help** menu. As a result, the container's Help topics are not available unless the user deactivates the object. The active document containment architecture expands on the rules for in-place menu merging to allow both the container and an active document that is active to share the menu. The new rules are simply additional conventions about what component owns what part of the menu and how the shared menu is constructed. The new convention is simple. In active documents, the **Help** menu has two top-level menu items organized as follows: diff --git a/docs/mfc/hierarchy-chart-categories.md b/docs/mfc/hierarchy-chart-categories.md index 288eb786579..4dc22030a09 100644 --- a/docs/mfc/hierarchy-chart-categories.md +++ b/docs/mfc/hierarchy-chart-categories.md @@ -3,10 +3,12 @@ description: "Learn more about: Hierarchy Chart Categories" title: "Hierarchy Chart Categories" ms.date: "11/19/2018" helpviewer_keywords: ["MFC, hierarchy"] -ms.assetid: 1f109428-4b84-4f7c-90a9-e71fe071311e --- # Hierarchy Chart Categories +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + ![MFC hierarchy chart categories.](../mfc/media/vc369r1.png "MFC hierarchy chart categories") ## See also diff --git a/docs/mfc/hierarchy-chart.md b/docs/mfc/hierarchy-chart.md index 7f7b93ff509..97e09c128bd 100644 --- a/docs/mfc/hierarchy-chart.md +++ b/docs/mfc/hierarchy-chart.md @@ -3,10 +3,12 @@ description: "See the MFC class hierarchy in chart form." title: "MFC class hierarchy chart" ms.date: 09/10/2021 helpviewer_keywords: ["object models, MFC", "classes [MFC], MFC hierarchy", "MFC, object model"] -ms.assetid: 19d70341-e391-4a72-94c6-35755ce975d4 --- # MFC class hierarchy chart +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following illustration represents the MFC classes derived from `CObject`: :::image type="content" source="../mfc/media/mfc-hierarchy-chart-part-1-of-3.png" alt-text="Chart that lists the MFC classes derived from CObject."::: diff --git a/docs/mfc/how-default-printing-is-done.md b/docs/mfc/how-default-printing-is-done.md index 1226570b146..df9f6291768 100644 --- a/docs/mfc/how-default-printing-is-done.md +++ b/docs/mfc/how-default-printing-is-done.md @@ -3,10 +3,12 @@ description: "Learn more about: How Default Printing Is Done" title: "How Default Printing Is Done" ms.date: "11/04/2016" helpviewer_keywords: ["default printing", "printing [MFC], default", "defaults, printing"] -ms.assetid: 0f698459-0fc9-4d43-97da-29cf0f65daa2 --- # How Default Printing Is Done +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the default printing process in Windows in terms of the MFC framework. In MFC applications, the view class has a member function named `OnDraw` that contains all the drawing code. `OnDraw` takes a pointer to a [CDC](reference/cdc-class.md) object as a parameter. That `CDC` object represents the device context to receive the image produced by `OnDraw`. When the window displaying the document receives a [WM_PAINT](/windows/win32/gdi/wm-paint) message, the framework calls `OnDraw` and passes it a device context for the screen (a [CPaintDC](reference/cpaintdc-class.md) object, to be specific). Accordingly, `OnDraw`'s output goes to the screen. diff --git a/docs/mfc/how-mfc-makes-it-easier-to-create-internet-client-applications.md b/docs/mfc/how-mfc-makes-it-easier-to-create-internet-client-applications.md index 543a3124945..ec12c0c8a4c 100644 --- a/docs/mfc/how-mfc-makes-it-easier-to-create-internet-client-applications.md +++ b/docs/mfc/how-mfc-makes-it-easier-to-create-internet-client-applications.md @@ -3,10 +3,12 @@ description: "Learn more about: How MFC Makes It Easier to Create Internet Clien title: "How MFC Makes It Easier to Create Internet Client Applications" ms.date: "11/04/2016" helpviewer_keywords: ["Internet client applications [MFC], MFC", "Internet applications [MFC], MFC", "MFC, Internet applications"] -ms.assetid: 94437b3f-f15c-437d-b5fd-264a2efec9ab --- # How MFC Makes It Easier to Create Internet Client Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Classes encapsulate the Win32 Internet Extension (WinInet) functions in a manner that provides a familiar context for MFC programmers. MFC provides three Internet file classes ([CInternetFile](reference/cinternetfile-class.md), [CHttpFile](reference/chttpfile-class.md), and [CGopherFile](reference/cgopherfile-class.md)) derived from the [CStdioFile](reference/cstdiofile-class.md) class. Not only do these classes make retrieving and manipulating Internet data familiar to programmers who have used `CStdioFile` for local files, but with these classes you can handle local files and Internet files in a consistent, transparent manner. The MFC WinInet classes provide the same functionality as `CStdioFile` for data that is transferred across the Internet. These classes abstract the Internet protocols for HTTP, FTP, and gopher into a high-level application programming interface, providing a fast and straightforward path to making applications Internet-aware. For example, connecting to an FTP server still requires several steps at a low level, but as an MFC developer, you only need to make one call to `CInternetSession::GetFTPConnection` to create that connection. diff --git a/docs/mfc/how-noncommand-messages-reach-their-handlers.md b/docs/mfc/how-noncommand-messages-reach-their-handlers.md index 8f7350006f1..ff32666a224 100644 --- a/docs/mfc/how-noncommand-messages-reach-their-handlers.md +++ b/docs/mfc/how-noncommand-messages-reach-their-handlers.md @@ -3,10 +3,12 @@ description: "Learn more about: How Noncommand Messages Reach Their Handlers" title: "How Noncommand Messages Reach Their Handlers" ms.date: "11/04/2016" helpviewer_keywords: ["messages [MFC], routing", "noncommand messages", "Windows messages [MFC], routing", "message handling [MFC], noncommand messages"] -ms.assetid: e7df8aef-9fae-41f4-9c11-881d8465f602 --- # How Noncommand Messages Reach Their Handlers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Unlike commands, standard Windows messages do not get routed through a chain of command targets but are usually handled by the window to which Windows sends the message. The window might be a main frame window, an MDI child window, a standard control, a dialog box, a view, or some other kind of child window. At run time, each Windows window is attached to a window object (derived directly or indirectly from `CWnd`) that has its own associated message map and handler functions. The framework uses the message map — as for a command — to map incoming messages to handlers. diff --git a/docs/mfc/how-the-framework-calls-a-handler.md b/docs/mfc/how-the-framework-calls-a-handler.md index 9faf7aa2bb0..b3989ca0b58 100644 --- a/docs/mfc/how-the-framework-calls-a-handler.md +++ b/docs/mfc/how-the-framework-calls-a-handler.md @@ -3,10 +3,12 @@ description: "Learn more about: How the Framework Calls a Handler" title: "How the Framework Calls a Handler" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, command routing", "handler functions, MFC framework", "command handling [MFC], calling handlers and code in MFC", "command routing [MFC], MFC"] -ms.assetid: d79bceba-4ff6-417a-9d52-6b6af62a909d --- # How the Framework Calls a Handler +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following topics first examine how the framework routes commands, then examine how other messages and control notifications are sent to windows: - [Message sending and receiving](message-sending-and-receiving.md) diff --git a/docs/mfc/how-the-framework-calls-your-code.md b/docs/mfc/how-the-framework-calls-your-code.md index af6f336b695..eb3f6d02366 100644 --- a/docs/mfc/how-the-framework-calls-your-code.md +++ b/docs/mfc/how-the-framework-calls-your-code.md @@ -3,10 +3,12 @@ description: "Learn more about: How the Framework Calls Your Code" title: "How the Framework Calls Your Code" ms.date: "11/04/2016" helpviewer_keywords: ["control flow [MFC], MFC framework and your code", "events [MFC], command routing in MFC", "command routing [MFC], framework", "command handling [MFC], calling handlers and code in MFC", "events [MFC], event-driven programming", "MFC, calling code from", "MFC, calling code", "application-specific events [MFC]", "command routing [MFC], MFC"] -ms.assetid: 39e68189-a580-40d0-9e35-bf5cd24a8ecf --- # How the Framework Calls Your Code +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + It is crucial to understand the relationship between your source code and the code in the MFC framework. When your application runs, most of the flow of control resides in the framework's code. The framework manages the message loop that gets messages from Windows as the user chooses commands and edits data in a view. Events that the framework can handle by itself do not rely on your code at all. For example, the framework knows how to close windows and how to exit the application in response to user commands. As it handles these tasks, the framework uses message handlers and C++ virtual functions to give you opportunities to respond to these events as well. Your code is not in control, however; the framework is. The framework calls your code for application-specific events. For example, when the user chooses a menu command, the framework routes the command along a sequence of C++ objects: the current view and frame window, the document associated with the view, the document's document template, and the application object. If one of these objects can handle the command, it does so, calling the appropriate message-handler function. For any given command, the code called may be yours or it may be the framework's. diff --git a/docs/mfc/how-the-framework-searches-message-maps.md b/docs/mfc/how-the-framework-searches-message-maps.md index f5b25c415ba..02d172cda6d 100644 --- a/docs/mfc/how-the-framework-searches-message-maps.md +++ b/docs/mfc/how-the-framework-searches-message-maps.md @@ -3,10 +3,12 @@ description: "Learn more about: How the Framework Searches Message Maps" title: "How the Framework Searches Message Maps" ms.date: "11/04/2016" helpviewer_keywords: ["message maps [MFC], searching"] -ms.assetid: fd1df878-5601-45d7-bd1f-b8f8e65b9a17 --- # How the Framework Searches Message Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The framework searches the message-map table for matches with incoming messages. Once you write a message-map entry for each message you want a class to handle and write the corresponding handlers, the framework calls your handlers automatically. The following topics explain message-map searching: - [Where to find message maps](where-to-find-message-maps.md) diff --git a/docs/mfc/how-to-add-restart-manager-support.md b/docs/mfc/how-to-add-restart-manager-support.md index f568efe5421..18bf6bfd20f 100644 --- a/docs/mfc/how-to-add-restart-manager-support.md +++ b/docs/mfc/how-to-add-restart-manager-support.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Add Restart Manager Support" title: "How to: Add Restart Manager Support" ms.date: "11/04/2016" helpviewer_keywords: ["Restart manager [MFC]", "C++, application crash support"] -ms.assetid: 7f3f5867-d4bc-4ba8-b3c9-dc1e7be93642 --- # How to: Add Restart Manager Support +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The restart manager is a feature added to Visual Studio for Windows Vista or later operating systems. The restart manager adds support for your application if it unexpectedly closes or restarts. The behavior of the restart manager depends on the type of your application. If your application is a document editor, the restart manager enabled your application to automatically save the state and content of any open documents and restarts your application after an unexpected closure. If your application is not a document editor, the restart manager will restart the application, but it cannot save the state of the application by default. After restart, the application displays a task dialog box if the application is Unicode. If it is an ANSI application, the application displays a Windows Message box. At this point, the user chooses whether to restore the automatically saved documents. If the user does not restore the automatically saved documents, the restart manager discards the temporary files. diff --git a/docs/mfc/how-to-add-ribbon-controls-and-event-handlers.md b/docs/mfc/how-to-add-ribbon-controls-and-event-handlers.md index 803855f0314..ce22746e9f4 100644 --- a/docs/mfc/how-to-add-ribbon-controls-and-event-handlers.md +++ b/docs/mfc/how-to-add-ribbon-controls-and-event-handlers.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Add Ribbon Controls and Event Handlers" title: "How to: Add Ribbon Controls and Event Handlers" ms.date: "11/04/2016" helpviewer_keywords: ["event handlers [MFC], adding", "ribbon controls [MFC], adding"] -ms.assetid: b31f25bc-ede7-49c3-9e3c-dffe4e174a69 --- # How to: Add Ribbon Controls and Event Handlers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Ribbon controls are elements, such as buttons and combo boxes, that you add to panels. Panels are areas of the ribbon bar that display a group of related controls. In this topic, you will open the Ribbon Designer, add a button, and then link an event that displays "Hello World". diff --git a/docs/mfc/how-to-convert-an-existing-mfc-ribbon-to-a-ribbon-resource.md b/docs/mfc/how-to-convert-an-existing-mfc-ribbon-to-a-ribbon-resource.md index e0e84a33917..c33c9d6e5f6 100644 --- a/docs/mfc/how-to-convert-an-existing-mfc-ribbon-to-a-ribbon-resource.md +++ b/docs/mfc/how-to-convert-an-existing-mfc-ribbon-to-a-ribbon-resource.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Convert an Existing MFC Ribbon to a Ribb title: "How to: Convert an Existing MFC Ribbon to a Ribbon Resource" ms.date: "11/04/2016" helpviewer_keywords: ["ribbon resource, converting from an MFC ribbon", "MFC ribbon, converting to a ribbon resource"] -ms.assetid: 324b7ff6-58f9-4691-96a9-9836a79d0fb6 --- # How to: Convert an Existing MFC Ribbon to a Ribbon Resource +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Ribbon resources are easier to visualize, modify, and maintain than manually coded ribbons. This topic describes how to convert a manually coded ribbon in an MFC Project into a ribbon resource. You must have an existing MFC project that has code that uses the MFC ribbon classes, for example, [CMFCRibbonBar Class](reference/cmfcribbonbar-class.md). diff --git a/docs/mfc/how-to-create-a-message-map-for-a-template-class.md b/docs/mfc/how-to-create-a-message-map-for-a-template-class.md index 39e4c4ec594..56465c75912 100644 --- a/docs/mfc/how-to-create-a-message-map-for-a-template-class.md +++ b/docs/mfc/how-to-create-a-message-map-for-a-template-class.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Create a Message Map for a Template Clas title: "How to: Create a Message Map for a Template Class" ms.date: "11/04/2016" helpviewer_keywords: ["template classes [MFC], creating message maps", "message maps [MFC], template classes"] -ms.assetid: 4e7e24f8-06df-4b46-82aa-7435c8650de3 --- # How to: Create a Message Map for a Template Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Message mapping in MFC provides an efficient way to direct Windows messages to an appropriate C++ object instance. Examples of MFC message map targets include application classes, document and view classes, control classes, and so on. Traditional MFC message maps are declared using the [BEGIN_MESSAGE_MAP](reference/message-map-macros-mfc.md#begin_message_map) macro to declare the start of the message map, a macro entry for each message-handler class method, and finally the [END_MESSAGE_MAP](reference/message-map-macros-mfc.md#end_message_map) macro to declare the end of the message map. diff --git a/docs/mfc/how-to-customize-the-application-button.md b/docs/mfc/how-to-customize-the-application-button.md index 8a9c8abbdae..9685a0d1b5b 100644 --- a/docs/mfc/how-to-customize-the-application-button.md +++ b/docs/mfc/how-to-customize-the-application-button.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Customize the Application Button" title: "How to: Customize the Application Button" ms.date: "09/07/2019" helpviewer_keywords: ["application button [MFC], customizing"] -ms.assetid: ebb11180-ab20-43df-a234-801feca9eb38 --- # How to: Customize the Application Button +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you click the Application button, a menu of commands is displayed. Typically, the menu contains file-related commands such as **Open**, **Save**, **Print**, and **Exit**. ![MFC Ribbon Application Button.](../mfc/media/application_button.png "MFC Ribbon Application Button") diff --git a/docs/mfc/how-to-customize-the-quick-access-toolbar.md b/docs/mfc/how-to-customize-the-quick-access-toolbar.md index fd1992a269c..432b7813070 100644 --- a/docs/mfc/how-to-customize-the-quick-access-toolbar.md +++ b/docs/mfc/how-to-customize-the-quick-access-toolbar.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Customize the Quick Access Toolbar" title: "How to: Customize the Quick Access Toolbar" ms.date: "09/07/2019" helpviewer_keywords: ["quick access toolbar [MFC], customization"] -ms.assetid: 2554099b-0c89-4605-9249-31bf9cbcefe0 --- # How to: Customize the Quick Access Toolbar +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Quick Access Toolbar (QAT) is a customizable toolbar that contains a set of commands that are either displayed next to the Application button or under the category tabs. The following illustration shows a typical Quick Access Toolbar. ![MFC Ribbon Quick Access Toolbar.](../mfc/media/quick_access_toolbar.png "MFC Ribbon Quick Access Toolbar") diff --git a/docs/mfc/how-to-display-command-information-in-the-status-bar.md b/docs/mfc/how-to-display-command-information-in-the-status-bar.md index 88c1169ad69..04bda0d0edd 100644 --- a/docs/mfc/how-to-display-command-information-in-the-status-bar.md +++ b/docs/mfc/how-to-display-command-information-in-the-status-bar.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Display Command Information in the Statu title: "How to: Display Command Information in the Status Bar" ms.date: "11/04/2016" helpviewer_keywords: ["prompts [MFC]", "displaying command status [MFC]", "status bars [MFC], message area", "status bars [MFC], displaying command information"] -ms.assetid: de895cbe-61ee-46bf-9787-76b247527d6d --- # How to: Display Command Information in the Status Bar +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you run the Application Wizard to create the skeleton of your application, you can support a toolbar and a status bar. Just one option in the Application Wizard supports both. When a status bar is present, the application automatically provides helpful feedback as the user moves the pointer over items on the menus. The application automatically displays a prompt string in the status bar when the menu item is highlighted. For example, when the user moves the pointer over the **Cut** command on the **Edit** menu, the status bar might display "Cuts the selection and puts it on the Clipboard" in the message area of the status bar. The prompt helps the user understand the purpose of the menu item. This also works when the user clicks a toolbar button. You can add to this status-bar help by defining prompt strings for menu items that you add to the program. To do this, provide the prompt strings when you edit the properties of the menu item in the menu editor. The strings you define are stored in the application resource file; they have the same IDs as the commands they explain. diff --git a/docs/mfc/how-to-implement-tracking-in-your-code.md b/docs/mfc/how-to-implement-tracking-in-your-code.md index 7d46e6634e7..b007c680d57 100644 --- a/docs/mfc/how-to-implement-tracking-in-your-code.md +++ b/docs/mfc/how-to-implement-tracking-in-your-code.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Implement Tracking in Your Code" title: "How to: Implement Tracking in Your Code" ms.date: "11/04/2016" helpviewer_keywords: ["CRectTracker class [MFC], implementing trackers"] -ms.assetid: baaeca2c-5114-485f-bf58-8807db1bc973 --- # How to: Implement Tracking in Your Code +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To track an OLE item, you must handle certain events related to the item, such as clicking the item or updating the view of the document. In all cases, it is sufficient to declare a temporary [CRectTracker](reference/crecttracker-class.md) object and manipulate the item by means of this object. When a user selects an item or inserts an object with a menu command, you must initialize the tracker with the proper styles to represent the state of the OLE item. The following table outlines the conventions used by the OCLIENT sample. For more information on these styles, see `CRectTracker`. diff --git a/docs/mfc/how-to-load-a-ribbon-resource-from-an-mfc-application.md b/docs/mfc/how-to-load-a-ribbon-resource-from-an-mfc-application.md index f86fcec8eeb..10204cff33c 100644 --- a/docs/mfc/how-to-load-a-ribbon-resource-from-an-mfc-application.md +++ b/docs/mfc/how-to-load-a-ribbon-resource-from-an-mfc-application.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Load a Ribbon Resource from an MFC Appli title: "How to: Load a Ribbon Resource from an MFC Application" ms.date: "11/04/2016" helpviewer_keywords: ["ribbon resource [MFC], loading"] -ms.assetid: 1c76bb8f-6345-414a-9f3f-128815ceadc5 --- # How to: Load a Ribbon Resource from an MFC Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To use the ribbon resource in your application, modify the application to load the ribbon resource. ### To load a ribbon resource diff --git a/docs/mfc/how-to-make-a-type-safe-collection.md b/docs/mfc/how-to-make-a-type-safe-collection.md index 3b507e6d543..c1c4dac4865 100644 --- a/docs/mfc/how-to-make-a-type-safe-collection.md +++ b/docs/mfc/how-to-make-a-type-safe-collection.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Make a Type-Safe Collection" title: "How to: Make a Type-Safe Collection" ms.date: "11/04/2016" helpviewer_keywords: ["type-safe collections [MFC]", "serializing collection-class elements [MFC]", "collection classes [MFC], type safety", "SerializeElements function [MFC]", "collection classes [MFC], template-based", "serialization [MFC], collection classes", "collection classes [MFC], deriving from nontemplate"] -ms.assetid: 7230b2db-4283-4083-b098-eb231bf5b89e --- # How to: Make a Type-Safe Collection +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to make type-safe collections for your own data types. Topics include: - [Using template-based classes for type safety](#_core_using_template.2d.based_classes_for_type_safety) diff --git a/docs/mfc/how-to-update-user-interface-objects.md b/docs/mfc/how-to-update-user-interface-objects.md index 2b5fa11a2d1..0a9e902847d 100644 --- a/docs/mfc/how-to-update-user-interface-objects.md +++ b/docs/mfc/how-to-update-user-interface-objects.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Update User-Interface Objects" title: "How to: Update User-Interface Objects" ms.date: "11/04/2016" helpviewer_keywords: ["menus [MFC], updating as context changes", "user interface objects [MFC], updating", "user interface objects [MFC]", "update handlers [MFC]", "enabling UI elements [MFC]", "disabling menus [MFC]", "updating user-interface objects [MFC]", "disabling UI elements [MFC]", "commands [MFC], updating UI", "enabling menus [MFC]"] -ms.assetid: 82f09773-c978-427b-b321-05a6143b7369 --- # How to: Update User-Interface Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Typically, menu items and toolbar buttons have more than one state. For example, a menu item is grayed (dimmed) if it is unavailable in the present context. Menu items can also be checked or unchecked. A toolbar button can also be disabled if unavailable, or it can be checked. Who updates the state of these items as program conditions change Logically, if a menu item generates a command that is handled by, say, a document, it makes sense to have the document update the menu item. The document probably contains the information on which the update is based. diff --git a/docs/mfc/how-wininet-makes-it-easier-to-create-internet-client-applications.md b/docs/mfc/how-wininet-makes-it-easier-to-create-internet-client-applications.md index 4b8cec07283..ac1c59f2b1d 100644 --- a/docs/mfc/how-wininet-makes-it-easier-to-create-internet-client-applications.md +++ b/docs/mfc/how-wininet-makes-it-easier-to-create-internet-client-applications.md @@ -3,10 +3,12 @@ description: "Learn more about: How WinInet Makes It Easier to Create Internet C title: "How WinInet Makes It Easier to Create Internet Client Applications" ms.date: "11/04/2016" helpviewer_keywords: ["Windows Sockets [MFC], vs. WinInet", "WinInet classes [MFC], vs. WinSock", "WinInet classes [MFC], Internet client applications"] -ms.assetid: dc0f9f47-3184-4e7a-8074-2c63e0359885 --- # How WinInet Makes It Easier to Create Internet Client Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Win32 Internet Extensions, or WinInet, provide access to common Internet protocols, including gopher, FTP, and HTTP. Using WinInet, you can write Internet client applications at a higher level of programming, without having to deal with WinSock, TCP/IP, or the details of specific Internet protocols. WinInet provides a consistent set of functions for all three protocols, with a familiar Win32 API interface. This consistency minimizes code changes you need to make if the underlying protocol changes (for example, from FTP to HTTP). Visual C++ provides two ways for you to use WinInet. You can call the Win32 Internet functions directly (see the OLE documentation in the Windows SDK for more information) or you can use WinInet through the [MFC WinInet classes](mfc-classes-for-creating-internet-client-applications.md). diff --git a/docs/mfc/html-basics.md b/docs/mfc/html-basics.md index 88e3e02b5ad..52a2ba0cd3c 100644 --- a/docs/mfc/html-basics.md +++ b/docs/mfc/html-basics.md @@ -3,10 +3,12 @@ description: "Learn more about: HTML Basics" title: "HTML Basics" ms.date: "11/04/2016" helpviewer_keywords: ["HTML [MFC], about HTML"] -ms.assetid: aab8ea9f-12d4-4bdd-a585-ac3124081a2a --- # HTML Basics +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Most browsers have the capability of examining the HTML source of the pages you browse. When you view the source you will see a number of HTML (Hypertext markup language) tags, surrounded by angle brackets(<>), interspersed with text. The steps below use HTML tags to build a simple Web page. In these steps, you'll type plain text into a file in Notepad, make a few changes, save the file, and reload your page in the browser to see your changes. diff --git a/docs/mfc/html-help-context-sensitive-help-for-your-programs.md b/docs/mfc/html-help-context-sensitive-help-for-your-programs.md index ecadee9898f..592b23b3a8d 100644 --- a/docs/mfc/html-help-context-sensitive-help-for-your-programs.md +++ b/docs/mfc/html-help-context-sensitive-help-for-your-programs.md @@ -3,10 +3,12 @@ description: "Learn more about: HTML Help: Context-Sensitive Help for Your Progr title: "HTML Help: Context-Sensitive Help for Your Programs" ms.date: "11/04/2016" helpviewer_keywords: ["context-sensitive Help [MFC], HTML Help", "HTML Help [MFC], context-sensitive"] -ms.assetid: f2eabbbb-0796-43f3-a483-5f7cf00f2e7c --- # HTML Help: Context-Sensitive Help for Your Programs +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!IMPORTANT] > HTML Help is not supported in this version of MFC. diff --git a/docs/mfc/idle-loop-processing.md b/docs/mfc/idle-loop-processing.md index 33d16f0956d..abf173d9f42 100644 --- a/docs/mfc/idle-loop-processing.md +++ b/docs/mfc/idle-loop-processing.md @@ -3,10 +3,12 @@ description: "Learn more about: Idle Loop Processing" title: "Idle Loop Processing" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, background processing", "PeekMessage method [MFC], elsewhere than message loop", "PeekMessage method [MFC]", "MFC, messages", "messages [MFC], loops", "OnIdle method [MFC]", "processing [MFC], background", "idle loop processing [MFC]", "idle processing [MFC]", "threading [MFC], alternatives to multithreading", "processing, during idle loop", "processing [MFC]", "background processing [MFC]"] -ms.assetid: 5c7c46c1-6107-4304-895f-480983bb1e44 --- # Idle Loop Processing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Many applications perform lengthy processing "in the background." Sometimes performance considerations dictate using multithreading for such work. Threads involve extra development overhead, so they are not recommended for simple tasks like the idle-time work that MFC does in the [OnIdle](reference/cwinthread-class.md#onidle) function. This article focuses on idle processing. For more information about multithreading, see [Multithreading Topics](../parallel/multithreading-support-for-older-code-visual-cpp.md). Some kinds of background processing are appropriately done during intervals that the user is not otherwise interacting with the application. In an application developed for the Microsoft Windows operating system, an application can perform idle-time processing by splitting a lengthy process into many small fragments. After processing each fragment, the application yields execution control to Windows using a [PeekMessage](/windows/win32/api/winuser/nf-winuser-peekmessagew) loop. @@ -32,7 +34,7 @@ Another method for performing idle processing in an application involves embeddi [!code-cpp[NVC_MFCDocView#8](codesnippet/cpp/idle-loop-processing_1.cpp)] -This code, embedded in a function, loops as long as there is idle processing to do. Within that loop, a nested loop repeatedly calls `PeekMessage`. As long as that call returns a nonzero value, the loop calls `CWinThread::PumpMessage` to perform normal message translation and dispatching. Although `PumpMessage` is undocumented, you can examine its source code in the ThrdCore.Cpp file in the \atlmfc\src\mfc directory of your Visual C++ installation. +This code, embedded in a function, loops as long as there is idle processing to do. Within that loop, a nested loop repeatedly calls `PeekMessage`. As long as that call returns a nonzero value, the loop calls `CWinThread::PumpMessage` to perform normal message translation and dispatching. Although `PumpMessage` is undocumented, you can examine its source code in the ThrdCore.Cpp file in the \atlmfc\src\mfc directory of your Visual Studio installation. Once the inner loop ends, the outer loop performs idle processing with one or more calls to `OnIdle`. The first call is for MFC's purposes. You can make additional calls to `OnIdle` to do your own background work. diff --git a/docs/mfc/image-information-in-image-lists.md b/docs/mfc/image-information-in-image-lists.md index 85fb338f183..11ca2a4de11 100644 --- a/docs/mfc/image-information-in-image-lists.md +++ b/docs/mfc/image-information-in-image-lists.md @@ -3,10 +3,12 @@ description: "Learn more about: Image Information in Image Lists" title: "Image Information in Image Lists" ms.date: "11/04/2016" helpviewer_keywords: ["CImageList class [MFC], image information in", "image lists [MFC], image information in"] -ms.assetid: 73c41543-fa91-405d-b15b-0feffa6a72c1 --- # Image Information in Image Lists +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + [CImageList](reference/cimagelist-class.md) includes a number of functions that retrieve information from an image list. The [GetImageInfo](reference/cimagelist-class.md#getimageinfo) member function fills an `IMAGEINFO` structure with information about a single image, including the handles of the image and mask bitmaps, the number of color planes and bits per pixel, and the bounding rectangle of the image within the image bitmap. You can use this information to directly manipulate the bitmaps for the image. The [GetImageCount](reference/cimagelist-class.md#getimagecount) member function retrieves the number of images in an image list. diff --git a/docs/mfc/image-overlays-in-image-lists.md b/docs/mfc/image-overlays-in-image-lists.md index 808d498a425..1822b3e0149 100644 --- a/docs/mfc/image-overlays-in-image-lists.md +++ b/docs/mfc/image-overlays-in-image-lists.md @@ -3,10 +3,12 @@ description: "Learn more about: Image Overlays in Image Lists" title: "Image Overlays in Image Lists" ms.date: "11/04/2016" helpviewer_keywords: ["overlays [MFC]", "image lists [MFC], image overlays in", "CImageList class [MFC], image overlays in"] -ms.assetid: aaf4e1c4-cd12-42c8-9af4-1bb458889b4e --- # Image Overlays in Image Lists +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Every image list ([CImageList](reference/cimagelist-class.md)) includes a list of images to use as overlay masks. An "overlay mask" is an image drawn transparently over another image. Any image can be used as an overlay mask. You can specify up to four overlay masks per image list. You add the index of an image to the list of overlay masks by using the [SetOverlayImage](reference/cimagelist-class.md#setoverlayimage) member function, the index of an image, and the index of an overlay mask. Note that the indices for the overlay masks are one-based rather than zero-based. diff --git a/docs/mfc/implementing-working-areas-in-list-controls.md b/docs/mfc/implementing-working-areas-in-list-controls.md index 0ee8d8fcbfa..5379ff13fea 100644 --- a/docs/mfc/implementing-working-areas-in-list-controls.md +++ b/docs/mfc/implementing-working-areas-in-list-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Implementing Working Areas in List Controls" title: "Implementing Working Areas in List Controls" ms.date: "11/04/2016" helpviewer_keywords: ["list controls [MFC], working areas", "working areas in list control [MFC]"] -ms.assetid: fbbb356b-3359-4348-8603-f1cb114cadde ms.topic: concept-article --- # Implementing Working Areas in List Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + By default, a list control arranges all items in a standard grid fashion. However, another method is supported, working areas, that arranges the list items into rectangular groups. For an image of a list control that implements working areas, see Using List-View Controls in the Windows SDK. > [!NOTE] diff --git a/docs/mfc/initializing-and-cleaning-up-documents-and-views.md b/docs/mfc/initializing-and-cleaning-up-documents-and-views.md index 9245198be4d..a5475344903 100644 --- a/docs/mfc/initializing-and-cleaning-up-documents-and-views.md +++ b/docs/mfc/initializing-and-cleaning-up-documents-and-views.md @@ -3,11 +3,13 @@ description: "Learn more about: Initializing and Cleaning Up Documents and Views title: "Initializing and Cleaning Up Documents and Views" ms.date: "11/04/2016" helpviewer_keywords: ["initializing documents [MFC]", "views [MFC], cleaning up", "documents [MFC], initializing", "documents [MFC], cleaning up", "views [MFC], initializing", "initializing objects [MFC], document objects", "document objects [MFC], life cycle of", "initializing views [MFC]"] -ms.assetid: 95d6f09b-a047-4079-856a-ae7d0548e9d2 ms.topic: how-to --- # Initializing and Cleaning Up Documents and Views +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use the following guidelines for initializing and cleaning up after your documents and views: - The MFC framework initializes documents and views; you initialize any data you add to them. diff --git a/docs/mfc/initializing-documents-and-views.md b/docs/mfc/initializing-documents-and-views.md index 43ac07fab7a..9df47617166 100644 --- a/docs/mfc/initializing-documents-and-views.md +++ b/docs/mfc/initializing-documents-and-views.md @@ -3,11 +3,13 @@ description: "Learn more about: Initializing Documents and Views" title: "Initializing Documents and Views" ms.date: "11/04/2016" helpviewer_keywords: ["initializing documents [MFC]", "documents [MFC], initializing", "views [MFC], initializing", "initializing objects [MFC], document objects", "initializing views [MFC]"] -ms.assetid: 33cb8643-8a16-478c-bc26-eccc734e3661 ms.topic: concept-article --- # Initializing Documents and Views +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Documents are created in two different ways, so your document class must support both ways. First, the user can create a new, empty document with the File New command. In that case, initialize the document in your override of the [OnNewDocument](reference/cdocument-class.md#onnewdocument) member function of class [CDocument](reference/cdocument-class.md). Second, the user can use the Open command on the File menu to create a new document whose contents are read from a file. In that case, initialize the document in your override of the [OnOpenDocument](reference/cdocument-class.md#onopendocument) member function of class `CDocument`. If both initializations are the same, you can call a common member function from both overrides, or `OnOpenDocument` can call `OnNewDocument` to initialize a clean document and then finish the open operation. Views are created after their documents are created. The best time to initialize a view is after the framework has finished creating the document, frame window, and view. You can initialize your view by overriding the [OnInitialUpdate](reference/cview-class.md#oninitialupdate) member function of [CView](reference/cview-class.md). If you need to reinitialize or adjust anything each time the document changes, you can override [OnUpdate](reference/cview-class.md#onupdate). diff --git a/docs/mfc/initializing-the-dialog-box.md b/docs/mfc/initializing-the-dialog-box.md index ba9d129545f..a023246ae63 100644 --- a/docs/mfc/initializing-the-dialog-box.md +++ b/docs/mfc/initializing-the-dialog-box.md @@ -3,11 +3,13 @@ description: "Learn more about: Initializing the Dialog Box" title: "Initializing the Dialog Box" ms.date: "11/04/2016" helpviewer_keywords: ["initializing dialog boxes [MFC]", "OnInitDialog method [MFC]", "modal dialog boxes [MFC], initializing", "modeless dialog boxes [MFC], initializing", "MFC dialog boxes [MFC], initializing"] -ms.assetid: 968142f5-19f9-4b34-a1d4-8e6412d4379b ms.topic: concept-article --- # Initializing the Dialog Box +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + After the dialog box and all of its controls are created but just before the dialog box (of either type) appears on the screen, the dialog object's [OnInitDialog](reference/cdialog-class.md#oninitdialog) member function is called. For a modal dialog box, this occurs during the `DoModal` call. For a modeless dialog box, `OnInitDialog` is called when `Create` is called. You typically override `OnInitDialog` to initialize the dialog box's controls, such as setting the initial text of an edit box. You must call the `OnInitDialog` member function of the base class, `CDialog`, from your `OnInitDialog` override. If you want to set your dialog box's background color (and that of all other dialog boxes in your application), see [Setting the Dialog Box's Background Color](setting-the-dialog-boxs-background-color.md). diff --git a/docs/mfc/initializing-the-parts-of-a-cstatusbarctrl-object.md b/docs/mfc/initializing-the-parts-of-a-cstatusbarctrl-object.md index af5b7bc529b..fb6a19352f3 100644 --- a/docs/mfc/initializing-the-parts-of-a-cstatusbarctrl-object.md +++ b/docs/mfc/initializing-the-parts-of-a-cstatusbarctrl-object.md @@ -3,11 +3,13 @@ description: "Learn more about: Initializing the Parts of a CStatusBarCtrl Objec title: "Initializing the Parts of a CStatusBarCtrl Object" ms.date: "11/04/2016" helpviewer_keywords: ["CStatusBarCtrl class [MFC], simple mode", "status bars [MFC], declaring parts of", "simple status bars [MFC]", "status bars [MFC], icons", "status bars [MFC], simple mode", "icons, using in status bars", "CStatusBarCtrl class [MFC], declaring parts of"] -ms.assetid: 60e8f285-d2d8-424a-a6ea-2fc548370303 ms.topic: concept-article --- # Initializing the Parts of a CStatusBarCtrl Object +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + By default, a status bar displays status information using separate panes. These panes (also referred to as parts) can contain either a text string, an icon, or both. Use [SetParts](reference/cstatusbarctrl-class.md#setparts) to define how many parts, and the length, the status bar will have. After you have created the parts of the status bar, make calls to [SetText](reference/cstatusbarctrl-class.md#settext) and [SetIcon](reference/cstatusbarctrl-class.md#seticon) to set the text or icon for a specific part of the status bar. Once the part has been successfully set, the control is automatically redrawn. diff --git a/docs/mfc/initinstance-member-function.md b/docs/mfc/initinstance-member-function.md index adea53e37d0..a9b498541b8 100644 --- a/docs/mfc/initinstance-member-function.md +++ b/docs/mfc/initinstance-member-function.md @@ -4,10 +4,12 @@ title: "InitInstance Member Function" ms.date: "11/04/2016" f1_keywords: ["InitInstance"] helpviewer_keywords: ["InitInstance method [MFC]", "applications [MFC], initializing", "MFC, initializing", "initializing MFC applications"] -ms.assetid: 4ef09267-ff7f-4c39-91a0-57454a264f83 --- # InitInstance Member Function +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Windows operating system allows you to run more than one copy, or "instance," of the same application. `WinMain` calls [InitInstance](reference/cwinapp-class.md#initinstance) every time a new instance of the application starts. The standard `InitInstance` implementation created by the MFC Application Wizard performs the following tasks: diff --git a/docs/mfc/inserting-a-control-into-a-control-container-application.md b/docs/mfc/inserting-a-control-into-a-control-container-application.md index dd5b98f83e8..d53eaffac01 100644 --- a/docs/mfc/inserting-a-control-into-a-control-container-application.md +++ b/docs/mfc/inserting-a-control-into-a-control-container-application.md @@ -3,10 +3,12 @@ description: "Learn more about: ActiveX Control Containers: Inserting a Control title: "ActiveX Control Containers: Inserting a Control into a Control Container Application" ms.date: "11/04/2016" helpviewer_keywords: ["ActiveX control containers [MFC], inserting controls", "ActiveX controls [MFC], adding to projects"] -ms.assetid: bbb617ff-872f-43d8-b4d6-c49adb16b148 --- # ActiveX Control Containers: Inserting a Control into a Control Container Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Before you can access an ActiveX control from an ActiveX control container application, you must add the ActiveX control to the container application using the [Insert ActiveX Control](../windows/adding-editing-or-deleting-controls.md) dialog box. To add an ActiveX control to the ActiveX control container project, see [Viewing and Adding ActiveX Controls to a Dialog Box](../windows/adding-editing-or-deleting-controls.md). diff --git a/docs/mfc/inserting-a-form-into-a-project.md b/docs/mfc/inserting-a-form-into-a-project.md index 0166e9f5d36..657302adc43 100644 --- a/docs/mfc/inserting-a-form-into-a-project.md +++ b/docs/mfc/inserting-a-form-into-a-project.md @@ -3,11 +3,13 @@ description: "Learn more about: Inserting a Form into a Project" title: "Inserting a Form into a Project" ms.date: "11/04/2016" helpviewer_keywords: ["inserting forms [MFC]", "Insert New dialog box [MFC]", "forms, adding to projects"] -ms.assetid: f3bd2998-3ce2-496d-ac5c-57ca70eec7cb ms.topic: how-to --- # Inserting a Form into a Project +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Forms provide a convenient container for controls. You can easily insert an MFC-based form into your application as long as the application supports the MFC libraries. ### To insert a form into your project @@ -22,7 +24,7 @@ Forms provide a convenient container for controls. You can easily insert an MFC- 1. Using the MFC Class Wizard, make the new class derive from [CFormView](reference/cformview-class.md). -Visual C++ adds the form to your application, opening it inside the Dialog editor so that you can begin adding controls and working on its overall design. +Visual Studio adds the form to your application, opening it inside the Dialog editor so that you can begin adding controls and working on its overall design. You may want to perform the following additional steps (not applicable for dialog-based applications): diff --git a/docs/mfc/interface-elements.md b/docs/mfc/interface-elements.md index 28c6b293ffe..04cd91cdafe 100644 --- a/docs/mfc/interface-elements.md +++ b/docs/mfc/interface-elements.md @@ -3,10 +3,12 @@ description: "Learn more about: Interface Elements" title: "Interface Elements" ms.date: "11/19/2018" helpviewer_keywords: ["architecture [MFC], MFC Feature Pack", "MFC Feature Pack, architecture"] -ms.assetid: eead6827-9602-40a3-8038-8986e8207385 --- # Interface Elements +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This document describes interface elements that were introduced in Visual Studio 2008 SP1, and also describes differences with the earlier version of the library. The following illustration shows an application that was built by using the new interface elements. diff --git a/docs/mfc/internet-and-networking-classes.md b/docs/mfc/internet-and-networking-classes.md index 4832f616532..a7f0d4040c6 100644 --- a/docs/mfc/internet-and-networking-classes.md +++ b/docs/mfc/internet-and-networking-classes.md @@ -4,10 +4,12 @@ title: "Internet and Networking Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.net"] helpviewer_keywords: ["Internet classes [MFC]", "networking classes [MFC]"] -ms.assetid: 1acf793d-ebf2-4fac-97be-703d62e3897e --- # Internet and Networking Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes allow you to exchange information with another computer using a Windows Socket or Win32 Internet (WinInet). There are also a set of classes for manipulating Windows Sockets. The following categories of classes support connectivity. diff --git a/docs/mfc/internet-information-by-task.md b/docs/mfc/internet-information-by-task.md index 7493ce32c50..246ca26a540 100644 --- a/docs/mfc/internet-information-by-task.md +++ b/docs/mfc/internet-information-by-task.md @@ -3,10 +3,12 @@ description: "Learn more about: Internet Information by Task" title: "Internet Information by Task" ms.date: "09/12/2018" helpviewer_keywords: ["MFC, Internet applications"] -ms.assetid: da078bf5-53c3-4167-b1ef-509b5a544ad9 --- # Internet Information by Task +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The tasks listed in this topic are sorted based on the task you want to accomplish. >[!IMPORTANT] diff --git a/docs/mfc/internet-information-by-topic.md b/docs/mfc/internet-information-by-topic.md index c23fba8b600..a8b769f525f 100644 --- a/docs/mfc/internet-information-by-topic.md +++ b/docs/mfc/internet-information-by-topic.md @@ -3,10 +3,12 @@ description: "Learn more about: Internet Information by Topic" title: "Internet Information by Topic" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, Internet applications"] -ms.assetid: 93a8b6c9-d274-492a-90b3-cf43a77edb1d --- # Internet Information by Topic +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For information on programming with a specific Internet technology, see: ## WinInet diff --git a/docs/mfc/internet-related-mfc-classes.md b/docs/mfc/internet-related-mfc-classes.md index 25f83f8c5cc..9dbcbb7a9ca 100644 --- a/docs/mfc/internet-related-mfc-classes.md +++ b/docs/mfc/internet-related-mfc-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Internet-Related MFC Classes" title: "Internet-Related MFC Classes" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, Internet classes"] -ms.assetid: e50c6b39-4b65-4b8a-8101-8934d0780723 --- # Internet-Related MFC Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For information about Internet-related classes and functions, see: ## Global functions diff --git a/docs/mfc/internet-security-cpp.md b/docs/mfc/internet-security-cpp.md index c66886c7db5..8aed9355989 100644 --- a/docs/mfc/internet-security-cpp.md +++ b/docs/mfc/internet-security-cpp.md @@ -3,10 +3,12 @@ description: "Learn more about: Internet Security (C++)" title: "Internet Security (C++)" ms.date: "11/04/2016" helpviewer_keywords: ["code signing [MFC], Internet security", "sandboxing [MFC]", "digital signatures [MFC], Internet security", "code signing [MFC]", "Web application security [MFC]", "code access security [MFC], Internet security considerations", "security [MFC]", "security [MFC], Internet", "Internet applications [MFC], security", "Web application security [MFC], Internet security approaches"] -ms.assetid: bf0da697-81bc-41f0-83fa-d7f82ed83df8 --- # Internet Security (C++) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Code safety is a major issue for developers and for users of Internet applications. There are risks: malicious code, code that has been tampered with, and code from unknown sites or authors. There are two basic approaches to security when developing for the Internet. The first is called "sandboxing." In this approach, an application is restricted to a particular set of APIs, and excluded from potentially dangerous ones such as file I/O where a program could destroy data on a user's computer. The second is implemented using digital signatures. This approach is referred to as "shrinkwrap" for the Internet. Code is verified and signed using private key/public key technology. Before the code is run, its digital signature is verified to ensure that the code is from a known authenticated source, and that the code has not been altered since it has been signed. diff --git a/docs/mfc/interpreting-user-input-through-a-view.md b/docs/mfc/interpreting-user-input-through-a-view.md index 6e1086bbe15..190fcef5aef 100644 --- a/docs/mfc/interpreting-user-input-through-a-view.md +++ b/docs/mfc/interpreting-user-input-through-a-view.md @@ -3,11 +3,13 @@ description: "Learn more about: Interpreting User Input Through a View" title: "Interpreting User Input Through a View" ms.date: "11/04/2016" helpviewer_keywords: ["interpreting user input through views [MFC]", "views [MFC], user interface and input", "input [MFC], view class [MFC]", "CView class [MFC], interpreting user input", "user input [MFC], interpreting through view class [MFC]"] -ms.assetid: f0302a70-661f-4781-8fe7-78f082bef2a5 ms.topic: concept-article --- # Interpreting User Input Through a View +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Other member functions of the view handle and interpret all user input. You will usually define message-handler member functions in your view class to process: - Windows [messages](messages.md) generated by mouse and keyboard actions. diff --git a/docs/mfc/isolation-of-the-mfc-common-controls-library.md b/docs/mfc/isolation-of-the-mfc-common-controls-library.md index 9f038e52807..7fac241cdb5 100644 --- a/docs/mfc/isolation-of-the-mfc-common-controls-library.md +++ b/docs/mfc/isolation-of-the-mfc-common-controls-library.md @@ -3,10 +3,12 @@ description: "Learn more about: Isolation of the MFC Common Controls Library" title: "Isolation of the MFC Common Controls Library" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, Common Controls library"] -ms.assetid: 7471e6f0-49b0-47f7-86e7-8d6bc3541694 --- # Isolation of the MFC Common Controls Library +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Common Controls library is now isolated within MFC, allowing different modules (such as user DLLs) to use different versions of the Common Controls library by specifying the version in their manifests. An MFC application (or user code called by MFC) makes calls to Common Controls library APIs through wrapper functions named `Afx`*FunctionName*, where *FunctionName* is the name of a Common Controls API. Those wrapper functions are defined in afxcomctl32.h and afxcomctl32.inl. diff --git a/docs/mfc/keyboard-and-mouse-customization.md b/docs/mfc/keyboard-and-mouse-customization.md index 9e1e28242fb..749fbb102eb 100644 --- a/docs/mfc/keyboard-and-mouse-customization.md +++ b/docs/mfc/keyboard-and-mouse-customization.md @@ -3,10 +3,12 @@ description: "Learn more about: Keyboard and Mouse Customization" title: "Keyboard and Mouse Customization" ms.date: "11/19/2018" helpviewer_keywords: ["customizations [MFC], keyboard and mouse (MFC Extensions)", "keyboard and mouse customizations (MFC Extensions)"] -ms.assetid: 1f789f1b-5f2e-4b11-b974-e3e2a2e49d82 --- # Keyboard and Mouse Customization +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC allows the user of your application to customize how it handles keyboard and mouse input. The user can customize keyboard input by assigning keyboard shortcuts to commands. The user can also customize the mouse input by selecting the command that should be executed when the user double-clicks inside specific windows of the application. This topic explains how to customize the input for your application. In the **Customization** dialog box, the user can change the custom controls for the mouse and the keyboard. To display this dialog box, the user points to **Customize** on the **View** menu and then clicks **Toolbars and Docking**. In the dialog box, the user clicks either the **Keyboard** tab or the **Mouse** tab. diff --git a/docs/mfc/life-cycle-of-a-dialog-box.md b/docs/mfc/life-cycle-of-a-dialog-box.md index f178c1f0676..38d347f2d30 100644 --- a/docs/mfc/life-cycle-of-a-dialog-box.md +++ b/docs/mfc/life-cycle-of-a-dialog-box.md @@ -3,11 +3,13 @@ description: "Learn more about: Working with Dialog Boxes in MFC" title: "Working with Dialog Boxes in MFC" ms.date: "09/27/2019" helpviewer_keywords: ["dialog boxes [MFC], life cycle", "modal dialog boxes [MFC], life cycle", "modeless dialog boxes [MFC], life cycle", "MFC dialog boxes [MFC], life cycle", "life cycle of dialog boxes [MFC]"] -ms.assetid: e16fd78e-238d-4f31-8c9d-8564f3953bd9 ms.topic: concept-article --- # Working with Dialog Boxes in MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + During the life cycle of a dialog box, the user invokes the dialog box, typically inside a command handler that creates and initializes the dialog object, the user interacts with the dialog box, then dialog box closes. For modal dialog boxes, your handler gathers any data the user entered once the dialog box closes. Since the dialog object exists after its dialog window has closed, you can simply use the member variables of your dialog class to extract the data. diff --git a/docs/mfc/list-control-and-list-view.md b/docs/mfc/list-control-and-list-view.md index 80c769cd219..20e0d4b2792 100644 --- a/docs/mfc/list-control-and-list-view.md +++ b/docs/mfc/list-control-and-list-view.md @@ -3,10 +3,12 @@ description: "Learn more about: List Control and List View" title: "List Control and List View" ms.date: "11/04/2016" helpviewer_keywords: ["CListView class [MFC], and CListCtrl", "views [MFC], list and list control", "CListCtrl class [MFC], and CListView", "list views [MFC]", "list controls [MFC], List view"] -ms.assetid: 7aee1c48-b158-4399-be0b-be366993665e --- # List Control and List View +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For convenience, MFC encapsulates the list control in two ways. You can use list controls: - Directly, by embedding a [CListCtrl](reference/clistctrl-class.md) object in a dialog class. diff --git a/docs/mfc/list-items-and-image-lists.md b/docs/mfc/list-items-and-image-lists.md index 27c772c67c3..9c6bf25f89a 100644 --- a/docs/mfc/list-items-and-image-lists.md +++ b/docs/mfc/list-items-and-image-lists.md @@ -3,10 +3,12 @@ description: "Learn more about: List Items and Image Lists" title: "List Items and Image Lists" ms.date: "11/04/2016" helpviewer_keywords: ["CImageList class [MFC], and list items", "image lists [MFC], list items", "CListCtrl class [MFC], image lists", "list items [MFC], image lists"] -ms.assetid: 317d095f-f978-47da-acb6-7bfe7dd3bc69 --- # List Items and Image Lists +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An "item" in a list control ([CListCtrl](reference/clistctrl-class.md)) consists of an icon, a label, and possibly other information (in "subitems"). The icons for list control items are contained in image lists. One image list contains full-sized icons used in icon view. A second, optional, image list contains smaller versions of the same icons for use in other views of the control. A third optional list contains "state" images, such as check boxes, for display in front of the small icons in certain views. A fourth optional list contains images that are displayed in individual header items of the list control. diff --git a/docs/mfc/making-and-using-controls.md b/docs/mfc/making-and-using-controls.md index 6e88beb322b..e09293f71d9 100644 --- a/docs/mfc/making-and-using-controls.md +++ b/docs/mfc/making-and-using-controls.md @@ -3,12 +3,14 @@ description: "Learn more about: Making and Using Controls" title: "Making and Using Controls" ms.date: "11/04/2016" helpviewer_keywords: ["controls [MFC], creating for dialog boxes", "Windows common controls [MFC], about common controls", "common controls [MFC], about common controls"] -ms.assetid: a252acad-3cc0-440e-bbc6-43eaaf8cb7bb ms.topic: concept-article --- # Making and Using Controls -You make most controls for dialog boxes in the Visual C++ [dialog editor](../windows/dialog-editor.md). But you can also create controls in any dialog box or window. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +You make most controls for dialog boxes in the Visual Studio [dialog editor](../windows/dialog-editor.md). But you can also create controls in any dialog box or window. ## What do you want to know more about diff --git a/docs/mfc/making-owner-drawn-header-controls.md b/docs/mfc/making-owner-drawn-header-controls.md index 68a3e251f9d..e57f2484f92 100644 --- a/docs/mfc/making-owner-drawn-header-controls.md +++ b/docs/mfc/making-owner-drawn-header-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Making Owner-Drawn Header Controls" title: "Making Owner-Drawn Header Controls" ms.date: "11/04/2016" helpviewer_keywords: ["header controls [MFC], owner-drawn", "drawing [MFC], header controls", "CHeaderCtrl class [MFC], making owner-drawn", "controls [MFC], header", "owner-drawn header controls [MFC]"] -ms.assetid: 455c113b-e8d0-400c-8690-dbb92cba0d05 ms.topic: concept-article --- # Making Owner-Drawn Header Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can define individual items of a header control ([CHeaderCtrl](reference/cheaderctrl-class.md)) to be owner-drawn items. For more information, see [Owner-Drawn Header Controls](/windows/win32/Controls/header-controls) in the Windows SDK. ## See also diff --git a/docs/mfc/making-owner-drawn-tabs.md b/docs/mfc/making-owner-drawn-tabs.md index f3421ab838c..31d9bdfbc57 100644 --- a/docs/mfc/making-owner-drawn-tabs.md +++ b/docs/mfc/making-owner-drawn-tabs.md @@ -3,11 +3,13 @@ description: "Learn more about: Making Owner-Drawn Tabs" title: "Making Owner-Drawn Tabs" ms.date: "11/04/2016" helpviewer_keywords: ["owner-drawn tabs [MFC]", "tabs [MFC], owner-drawn", "CTabCtrl class [MFC], owner-drawn tabs", "drawing [MFC], tabs"] -ms.assetid: 11af2926-41d7-47e3-9eec-c595283f6371 ms.topic: concept-article --- # Making Owner-Drawn Tabs +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can define individual items of a tab control ([CTabCtrl](reference/ctabctrl-class.md)) to be owner-drawn items. For more information, see [Owner-Drawn Tabs](/windows/win32/Controls/tab-controls) in the Windows SDK. ## See also diff --git a/docs/mfc/managing-data-with-document-data-variables.md b/docs/mfc/managing-data-with-document-data-variables.md index be73faee851..0375973e8be 100644 --- a/docs/mfc/managing-data-with-document-data-variables.md +++ b/docs/mfc/managing-data-with-document-data-variables.md @@ -3,11 +3,13 @@ description: "Learn more about: Managing Data with Document Data Variables" title: "Managing Data with Document Data Variables" ms.date: "11/04/2016" helpviewer_keywords: ["documents [MFC], data storage", "friend classes [MFC]", "classes [MFC], friend", "data [MFC]", "data [MFC], documents", "collection classes [MFC], used by document object", "document data [MFC]", "member variables [MFC], document class [MFC]"] -ms.assetid: e70b87f4-8c30-49e5-8986-521c2ff91704 ms.topic: concept-article --- # Managing Data with Document Data Variables +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implement your document's data as member variables of your document class. For example, the Scribble program declares a data member of type `CObList` — a linked list that stores pointers to `CObject` objects. This list is used to store arrays of points that make up a freehand line drawing. How you implement your document's member data depends on the nature of your application. To help you out, MFC supplies a group of "collection classes" — arrays, lists, and maps (dictionaries), including collections based on C++ templates — along with classes that encapsulate a variety of common data types such as `CString`, `CRect`, `CPoint`, `CSize`, and `CTime`. For more information about these classes, see the [Class Library Overview](class-library-overview.md) in the *MFC Reference*. diff --git a/docs/mfc/managing-mdi-child-windows.md b/docs/mfc/managing-mdi-child-windows.md index beca42fc238..f0426cace5d 100644 --- a/docs/mfc/managing-mdi-child-windows.md +++ b/docs/mfc/managing-mdi-child-windows.md @@ -4,11 +4,13 @@ title: "Managing MDI Child Windows" ms.date: "11/19/2018" f1_keywords: ["MDICLIENT"] helpviewer_keywords: ["MDI [MFC], child windows", "child windows [MFC], and MDICLIENT window", "MDICLIENT window [MFC]", "windows [MFC], MDI", "frame windows [MFC], MDI child windows", "child windows [MFC]", "MDI [MFC], frame windows"] -ms.assetid: 1828d96e-a561-48ae-a661-ba9701de6bee ms.topic: concept-article --- # Managing MDI Child Windows +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MDI main frame windows (one per application) contain a special child window called the MDICLIENT window. The MDICLIENT window manages the client area of the main frame window, and itself has child windows: the document windows, derived from `CMDIChildWnd`. Because the document windows are frame windows themselves (MDI child windows), they can also have their own children. In all of these cases, the parent window manages its child windows and forwards some commands to them. In an MDI frame window, the frame window manages the MDICLIENT window, repositioning it in conjunction with control bars. The MDICLIENT window, in turn, manages all MDI child frame windows. The following figure shows the relationship between an MDI frame window, its MDICLIENT window, and its child document frame windows. diff --git a/docs/mfc/managing-menus-control-bars-and-accelerators.md b/docs/mfc/managing-menus-control-bars-and-accelerators.md index 329610e659a..4830ec1e010 100644 --- a/docs/mfc/managing-menus-control-bars-and-accelerators.md +++ b/docs/mfc/managing-menus-control-bars-and-accelerators.md @@ -3,11 +3,13 @@ description: "Learn more about: Managing Menus, Control Bars, and Accelerators" title: "Managing Menus, Control Bars, and Accelerators" ms.date: "11/04/2016" helpviewer_keywords: ["MDI [MFC], frame windows", "control bars [MFC], updating in frame windows", "menus [MFC], updating as context changes", "user interface objects [MFC], updating", "accelerator tables [MFC]", "sharing menus [MFC]", "updating user-interface objects [MFC]", "frame windows [MFC], updating", "status bars [MFC], updating"] -ms.assetid: 97ca1997-06df-4373-b023-4f7ecd81047b ms.topic: concept-article --- # Managing Menus, Control Bars, and Accelerators +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The frame window manages updating user-interface objects, including menus, toolbar buttons, the status bar, and accelerators. It also manages sharing the menu bar in MDI applications. ## Managing Menus diff --git a/docs/mfc/managing-the-current-view.md b/docs/mfc/managing-the-current-view.md index ecd15ad51ec..59c278a4d13 100644 --- a/docs/mfc/managing-the-current-view.md +++ b/docs/mfc/managing-the-current-view.md @@ -3,11 +3,13 @@ description: "Learn more about: Managing the Current View" title: "Managing the Current View" ms.date: "11/04/2016" helpviewer_keywords: ["views [MFC], and OnActivateView method [MFC]", "views [MFC], deactivating", "views [MFC], activating", "frame windows [MFC], current view", "OnActivateView method [MFC]", "views [MFC], current", "deactivating views [MFC]", "current view in frame window [MFC]"] -ms.assetid: 0a1cc22d-d646-4536-9ad2-3cb6d7092e4a ms.topic: concept-article --- # Managing the Current View +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As part of the default implementation of frame windows, a frame window keeps track of a currently active view. If the frame window contains more than one view, as for example in a splitter window, the current view is the most recent view in use. The active view is independent of the active window in Windows or the current input focus. When the active view changes, the framework notifies the current view by calling its [OnActivateView](reference/cview-class.md#onactivateview) member function. You can tell whether the view is being activated or deactivated by examining `OnActivateView`'s *bActivate* parameter. By default, `OnActivateView` sets the focus to the current view on activation. You can override `OnActivateView` to perform any special processing when the view is deactivated or reactivated. For example, you might want to provide special visual cues to distinguish the active view from other, inactive views. diff --git a/docs/mfc/managing-the-state-data-of-mfc-modules.md b/docs/mfc/managing-the-state-data-of-mfc-modules.md index 37c7bead209..31871e32640 100644 --- a/docs/mfc/managing-the-state-data-of-mfc-modules.md +++ b/docs/mfc/managing-the-state-data-of-mfc-modules.md @@ -3,11 +3,13 @@ description: "Learn more about: Managing the State Data of MFC Modules" title: "Managing the State Data of MFC Modules" ms.date: "11/19/2018" helpviewer_keywords: ["global state [MFC]", "data management [MFC], MFC modules", "window procedure entry points [MFC]", "exported interfaces and global state [MFC]", "module states [MFC], saving and restoring", "data management [MFC]", "MFC, managing state data", "multiple modules [MFC]", "module state restored [MFC]"] -ms.assetid: 81889c11-0101-4a66-ab3c-f81cf199e1bb ms.topic: concept-article --- # Managing the State Data of MFC Modules +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article discusses the state data of MFC modules and how this state is updated when the flow of execution (the path code takes through an application when executing) enters and leaves a module. Switching module states with the AFX_MANAGE_STATE and METHOD_PROLOGUE macros is also discussed. > [!NOTE] diff --git a/docs/mfc/manipulating-image-lists.md b/docs/mfc/manipulating-image-lists.md index 6d92caf6d4f..2f2e7a0d6a3 100644 --- a/docs/mfc/manipulating-image-lists.md +++ b/docs/mfc/manipulating-image-lists.md @@ -3,11 +3,13 @@ description: "Learn more about: Manipulating Image Lists" title: "Manipulating Image Lists" ms.date: "11/04/2016" helpviewer_keywords: ["image lists [MFC], manipulating", "lists [MFC], image", "CImageList class [MFC], manipulating"] -ms.assetid: 043418f8-077e-4dce-b8bb-2b7b0d7b5156 ms.topic: concept-article --- # Manipulating Image Lists +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [Replace](reference/cimagelist-class.md#replace) member function replaces an image in an image list ([CImageList](reference/cimagelist-class.md)) with a new image. This function is also useful if you need to dynamically increase the number of images in an image list object. The [SetImageCount](reference/cimagelist-class.md#setimagecount) function dynamically changes the number of images stored in the image list. If you increase the size of the image list, call `Replace` to add images to the new image slots. If you decrease the size of the image list, the images beyond the new size are freed. The [Remove](reference/cimagelist-class.md#remove) member function removes an image from an image list. The [Copy](reference/cimagelist-class.md#copy) member function can copy or swap images within an image list. This function allows you to indicate whether the source image should be copied to the destination index or the source and destination images should be swapped. diff --git a/docs/mfc/manipulating-menus-during-program-execution.md b/docs/mfc/manipulating-menus-during-program-execution.md index 830ad98dea8..272a383e298 100644 --- a/docs/mfc/manipulating-menus-during-program-execution.md +++ b/docs/mfc/manipulating-menus-during-program-execution.md @@ -3,11 +3,13 @@ description: "Learn more about: Manipulating Menus During Program Execution" title: "Manipulating Menus During Program Execution" ms.date: "11/04/2016" helpviewer_keywords: ["menus [MFC], editing during execution", "menus during execution [MFC], deleting", "CMenu class [MFC], manipulating menus during execution", "menus [MFC], manipulating during execution", "menus during execution"] -ms.assetid: 722c7c00-4be2-4967-877d-f96aaa604396 ms.topic: concept-article --- # Manipulating Menus During Program Execution +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use class `CMenu` to manipulate menus and menu items on the fly. `CMenu` encapsulates a Windows HMENU handle and supplies member functions for working with menus. See the overview for class [CMenu](reference/cmenu-class.md) for details. diff --git a/docs/mfc/manipulating-the-progress-control.md b/docs/mfc/manipulating-the-progress-control.md index 364d495b2c7..ab103759dc1 100644 --- a/docs/mfc/manipulating-the-progress-control.md +++ b/docs/mfc/manipulating-the-progress-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Manipulating the Progress Control" title: "Manipulating the Progress Control" ms.date: "11/04/2016" helpviewer_keywords: ["CProgressCtrl class [MFC], working with", "progress controls [MFC], manipulating", "CProgressCtrl class [MFC], manipulating", "controlling progress controls [MFC]", "CProgressCtrl class [MFC], using"] -ms.assetid: 9af561d1-980b-4003-a6da-ff79be15bf23 ms.topic: how-to --- # Manipulating the Progress Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + There are three ways to change the current position of a progress control ([CProgressCtrl](reference/cprogressctrl-class.md)). - The position can be changed by a preset increment amount. diff --git a/docs/mfc/manipulating-the-tool-tip-control.md b/docs/mfc/manipulating-the-tool-tip-control.md index a368c8f8955..ea50fc35323 100644 --- a/docs/mfc/manipulating-the-tool-tip-control.md +++ b/docs/mfc/manipulating-the-tool-tip-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Manipulating the Tool Tip Control" title: "Manipulating the Tool Tip Control" ms.date: "11/04/2016" helpviewer_keywords: ["CToolTipCtrl class [MFC], manipulating tool tip attributes", "tool tips [MFC], attributes"] -ms.assetid: 3600afe5-712a-4b56-8456-96e85fe879af ms.topic: concept-article --- # Manipulating the Tool Tip Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Class `CToolTipCtrl` provides a group of member functions that control the various attributes of the `CToolTipCtrl` object and the tool tip window. The initial, pop-up, and reshow durations for the tool tip windows can be set and retrieved with calls to [GetDelayTime](reference/ctooltipctrl-class.md#getdelaytime) and [SetDelayTime](reference/ctooltipctrl-class.md#setdelaytime). diff --git a/docs/mfc/mapi-samples.md b/docs/mfc/mapi-samples.md index cf952047442..87c7684e026 100644 --- a/docs/mfc/mapi-samples.md +++ b/docs/mfc/mapi-samples.md @@ -3,10 +3,12 @@ description: "Learn more about: MAPI Samples" title: "MAPI Samples" ms.date: "11/04/2016" helpviewer_keywords: ["MAPI, MFC", "sample applications [MFC], MAPI"] -ms.assetid: 3af3085c-8c8f-47c9-a966-b82311a20bf6 --- # MAPI Samples +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + See the following sample programs that illustrate Microsoft Messaging Application Programming Interface (MAPI) functionality: - [NPP](../overview/visual-cpp-samples.md) diff --git a/docs/mfc/mapi-support-in-mfc.md b/docs/mfc/mapi-support-in-mfc.md index cdb9d8b6388..b241e223917 100644 --- a/docs/mfc/mapi-support-in-mfc.md +++ b/docs/mfc/mapi-support-in-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: MAPI Support in MFC" title: "MAPI Support in MFC" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, MAPI support", "MAPI support in MFC", "CDocument class [MFC], and MAPI", "OnUpdateFileSendMail method [MFC]", "MAPI, MFC", "OnFileSendMail method [MFC]"] -ms.assetid: cafbecb1-0427-4077-b4b8-159bae5b49b8 --- # MAPI Support in MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC supplies support for a subset of the Microsoft Messaging Application Program Interface (MAPI) in class `CDocument`. Specifically, `CDocument` has member functions that determine whether mail support is present on the end-user's machine and, if so, enable a Send Mail command whose standard command ID is ID_FILE_SEND_MAIL. The MFC handler function for this command allows the user to send a document through electronic mail. > [!TIP] @@ -21,7 +23,7 @@ MAPI needs to read the file to send the attachment. If the application keeps its #### To implement a Send Mail command with MFC -1. Use the Visual C++ menu editor to add a menu item whose command ID is ID_FILE_SEND_MAIL. +1. Use the Visual Studio menu editor to add a menu item whose command ID is ID_FILE_SEND_MAIL. This command ID is provided by the framework in AFXRES.H. The command can be added to any menu, but it is usually added to the **File** menu. diff --git a/docs/mfc/mapi.md b/docs/mfc/mapi.md index 70bc8612b7c..55667986b9f 100644 --- a/docs/mfc/mapi.md +++ b/docs/mfc/mapi.md @@ -3,10 +3,12 @@ description: "Learn more about: MAPI" title: "MAPI" ms.date: "11/04/2016" helpviewer_keywords: ["messaging [MFC], client applications", "enabling applications for MAPI [MFC]", "MAPI support in MFC", "e-mail [MFC], enabling", "mail [MFC], enabling your application", "MAPI, MFC", "enabling applications for mail [MFC]"] -ms.assetid: 193449f7-b131-4ab0-9301-8d4f6cd1e7c4 --- # MAPI +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the Microsoft Messaging Application Programming Interface (MAPI) for client message application developers. MFC supplies support for a subset of MAPI in class `CDocument` but does not encapsulate the entire API. For more information, see [MAPI Support in MFC](mapi-support-in-mfc.md). MAPI is a set of functions that mail-enabled and mail-aware applications use to create, manipulate, transfer, and store mail messages. It gives application developers the tools to define the purpose and content of mail messages and gives them flexibility in their management of stored mail messages. MAPI also provides a common interface that application developers can use to create mail-enabled and mail-aware applications independent of the underlying messaging system. diff --git a/docs/mfc/mapping-messages.md b/docs/mfc/mapping-messages.md index 2f59ba6b40e..ebd242a4c18 100644 --- a/docs/mfc/mapping-messages.md +++ b/docs/mfc/mapping-messages.md @@ -3,11 +3,13 @@ description: "Learn more about: Mapping Messages" title: "Mapping Messages" ms.date: "11/04/2016" helpviewer_keywords: ["message maps [MFC], about message maps", "mappings [MFC], commands", "commands [MFC], mapping", "command mapping [MFC]", "message handling [MFC], connecting to handler functions", "commands [MFC], connecting to handler functions", "mappings [MFC], messages", "messages [MFC], mapping"] -ms.assetid: 996f0652-0698-4b8c-b893-cdaa836d9d0f ms.topic: concept-article --- # Mapping Messages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Each framework class that can receive messages or commands has its own "message map." The framework uses message maps to connect messages and commands to their handler functions. Any class derived from class `CCmdTarget` can have a message map. Other articles explain message maps in detail and describe how to use them. In spite of the name "message map," message maps handle both messages and commands — all three categories of messages listed in [Message Categories](message-categories.md). diff --git a/docs/mfc/mapping-windows-messages-to-your-class.md b/docs/mfc/mapping-windows-messages-to-your-class.md index f34a3d5da29..115e49cc2d1 100644 --- a/docs/mfc/mapping-windows-messages-to-your-class.md +++ b/docs/mfc/mapping-windows-messages-to-your-class.md @@ -3,11 +3,13 @@ description: "Learn more about: Mapping Windows Messages to Your Class" title: "Mapping Windows Messages to Your Class" ms.date: "09/06/2019" helpviewer_keywords: ["MFC dialog boxes [MFC], Windows messages", "message maps [MFC], in dialog class", "Windows messages [MFC], mapping in dialog classes", "messages to dialog class [MFC]", "mappings [MFC], messages to dialog class [MFC]", "message maps [MFC], mapping Windows messages to classes", "messages to dialog class [MFC], mapping", "Class Wizard [MFC]"] -ms.assetid: a4c6fd1f-1d33-47c9-baa0-001755746d6d ms.topic: concept-article --- # Mapping Windows Messages to Your Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If you need your dialog box to handle Windows messages, override the appropriate handler functions. To do so, choose the **Class View** tab in **Solution Explorer**, right click on the class that represents the dialog box, and choose [Class Wizard](reference/mfc-class-wizard.md). Use the wizard to [map the messages](reference/mapping-messages-to-functions.md) to the dialog class. This writes a message-map entry for each message and adds the message-handler member functions to the class. Use the code editor to write code in the message handlers. You can also override member functions of [CDialog](reference/cdialog-class.md) and its base classes, especially [CWnd](reference/cwnd-class.md). diff --git a/docs/mfc/mdi-tabbed-groups.md b/docs/mfc/mdi-tabbed-groups.md index c4b435c6ecf..ad7e811bbfb 100644 --- a/docs/mfc/mdi-tabbed-groups.md +++ b/docs/mfc/mdi-tabbed-groups.md @@ -3,10 +3,12 @@ description: "Learn more about: MDI Tabbed Groups" title: "MDI Tabbed Groups" ms.date: "11/04/2016" helpviewer_keywords: ["mdi [MFC], tabbed groups", "tabbed grous [MFC]"] -ms.assetid: 0a464f36-39b7-4e68-8b67-ec175de28377 --- # MDI Tabbed Groups +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The multiple document interface (MDI) tabbed groups feature enables multiple document interface (MDI) applications to display one or more tabbed windows (or groups of tabbed windows, known as *tabbed groups*) in the MDI client area. The tabbed windows can be aligned vertically or horizontally. If an application hosts more than one MDI tabbed group, the groups are separated by splitters. ## Features diff --git a/docs/mfc/memory-management-examples.md b/docs/mfc/memory-management-examples.md index c76643dce83..398fc193af1 100644 --- a/docs/mfc/memory-management-examples.md +++ b/docs/mfc/memory-management-examples.md @@ -3,10 +3,12 @@ description: "Learn more about: Memory Management: Examples" title: "Memory Management: Examples" ms.date: "11/04/2016" helpviewer_keywords: ["objects [MFC], memory allocation", "data structures [MFC]", "arrays [MFC], allocating resources", "objects [MFC], allocating memory", "data structures [MFC], allocating memory", "examples [MFC], memory allocation", "heap allocation [MFC], examples", "memory allocation [MFC], arrays", "MFC, memory management", "struct memory allocation [MFC]", "types [MFC], memory allocation", "memory allocation [MFC], objects", "memory allocation [MFC], examples", "arrays [MFC], memory management", "frame allocation [MFC]", "memory allocation [MFC], data structures"] -ms.assetid: f10240f8-b698-4c83-9288-97a54318930b --- # Memory Management: Examples +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes how MFC performs frame allocations and heap allocations for each of the three typical kinds of memory allocations: - [An array of bytes](#_core_allocation_of_an_array_of_bytes) diff --git a/docs/mfc/memory-management-frame-allocation.md b/docs/mfc/memory-management-frame-allocation.md index dc3cfa5d7a0..0bb639b12c0 100644 --- a/docs/mfc/memory-management-frame-allocation.md +++ b/docs/mfc/memory-management-frame-allocation.md @@ -3,10 +3,12 @@ description: "Learn more about: Memory Management: Frame Allocation" title: "Memory Management: Frame Allocation" ms.date: "11/04/2016" helpviewer_keywords: ["memory leaks [MFC], frame allocation", "memory [MFC], detecting leaks", "memory [MFC], reclaiming", "memory allocation [MFC], frames", "frame variables [MFC], automatic deletion of", "scope [MFC], frame variables", "heap allocation [MFC], vs. frame allocation", "variables [MFC], frame variables", "memory leaks [MFC], detecting", "memory, releasing [MFC]", "stack frames [MFC]", "memory leaks [MFC], allocating objects on the frame", "detecting memory leaks [MFC]", "frame allocation [MFC]", "frame variables [MFC]"] -ms.assetid: 945a211a-6f4f-4679-bb6a-b0f2a0d4a6c1 --- # Memory Management: Frame Allocation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Allocation on the frame takes its name from the "stack frame" that is set up whenever a function is called. The stack frame is an area of memory that temporarily holds the arguments to the function as well as any variables that are defined local to the function. Frame variables are often called "automatic" variables because the compiler automatically allocates the space for them. There are two key characteristics of frame allocations. First, when you define a local variable, enough space is allocated on the stack frame to hold the entire variable, even if it is a large array or data structure. Second, frame variables are automatically deleted when they go out of scope: diff --git a/docs/mfc/memory-management-heap-allocation.md b/docs/mfc/memory-management-heap-allocation.md index 4d0992fab1f..d9fe3cec85e 100644 --- a/docs/mfc/memory-management-heap-allocation.md +++ b/docs/mfc/memory-management-heap-allocation.md @@ -3,10 +3,12 @@ description: "Learn more about: Memory Management: Heap Allocation" title: "Memory Management: Heap Allocation" ms.date: "11/04/2016" helpviewer_keywords: ["memory [MFC], detecting leaks", "delete operator [MFC], using with debug MFC", "heap allocation [MFC], described", "memory allocation [MFC], heap memory", "memory leaks [MFC], detecting", "new operator [MFC], using with debug MFC", "heap allocation [MFC]", "detecting memory leaks [MFC]"] -ms.assetid: a5d949c6-1b79-476e-9c66-513a558203d9 --- # Memory Management: Heap Allocation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The heap is reserved for the memory allocation needs of the program. It is an area apart from the program code and the stack. Typical C programs use the functions **malloc** and **free** to allocate and deallocate heap memory. The Debug version of MFC provides modified versions of the C++ built-in operators **`new`** and **`delete`** to allocate and deallocate objects in heap memory. When you use **`new`** and **`delete`** instead of **malloc** and **free**, you are able to take advantage of the class library's memory-management debugging enhancements, which can be useful in detecting memory leaks. When you build your program with the Release version of MFC, the standard versions of the **`new`** and **`delete`** operators provide an efficient way to allocate and deallocate memory (the Release version of MFC does not provide modified versions of these operators). diff --git a/docs/mfc/memory-management-resizable-memory-blocks.md b/docs/mfc/memory-management-resizable-memory-blocks.md index 7223f4180ad..6ac07cbf65b 100644 --- a/docs/mfc/memory-management-resizable-memory-blocks.md +++ b/docs/mfc/memory-management-resizable-memory-blocks.md @@ -3,10 +3,12 @@ description: "Learn more about: Memory Management: Resizable Memory Blocks" title: "Memory Management: Resizable Memory Blocks" ms.date: "11/04/2016" helpviewer_keywords: ["memory blocks [MFC], resizable", "memory [MFC], corruption", "memory allocation [MFC], memory block size", "memory blocks [MFC], allocating", "blocks [MFC], memory allocation", "resizable memory blocks [MFC]"] -ms.assetid: f0efe6f4-a3ed-4541-9195-51ec1291967a --- # Memory Management: Resizable Memory Blocks +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The **`new`** and **`delete`** operators, described in the article [Memory Management: Examples](memory-management-examples.md), are good for allocating and deallocating fixed-size memory blocks and objects. Occasionally, your application may need resizable memory blocks. You must use the standard C run-time library functions [malloc](../c-runtime-library/reference/malloc.md), [realloc](../c-runtime-library/reference/realloc.md), and [free](../c-runtime-library/reference/free.md) to manage resizable memory blocks on the heap. > [!IMPORTANT] diff --git a/docs/mfc/memory-management.md b/docs/mfc/memory-management.md index 89b67110a51..7e8e4f29121 100644 --- a/docs/mfc/memory-management.md +++ b/docs/mfc/memory-management.md @@ -3,10 +3,12 @@ description: "Learn more about: Memory Management" title: "Memory Management" ms.date: "11/04/2016" helpviewer_keywords: ["memory [MFC]", "MFC, memory management", "memory allocation [MFC]", "memory [MFC], managing", "memory allocation [MFC], MFC"] -ms.assetid: 934ac81b-d630-4232-88e5-ea74f7187987 --- # Memory Management +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This group of articles describes how to take advantage of the general-purpose services of the Microsoft Foundation Class Library (MFC) related to memory management. Memory allocation can be divided into two main categories: frame allocations and heap allocations. One main difference between the two allocation techniques is that with frame allocation you typically work with the actual memory block itself, while with heap allocation you are always given a pointer to the memory block. Another major difference between the two schemes is that frame objects are automatically deleted, while heap objects must be explicitly deleted by the programmer. diff --git a/docs/mfc/menu-sample-list.md b/docs/mfc/menu-sample-list.md index 5c9810c792f..5cccff447db 100644 --- a/docs/mfc/menu-sample-list.md +++ b/docs/mfc/menu-sample-list.md @@ -3,10 +3,12 @@ description: "Learn more about: Menu Sample List" title: "Menu Sample List" ms.date: "11/04/2016" helpviewer_keywords: ["sample applications [MFC], menus"] -ms.assetid: 6d89c723-03d6-474e-8ca5-e98f93bd41cc --- # Menu Sample List +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + See the following sample programs that illustrate creating, editing, and updating menus: *MDI Sample: Enable and Disable Menu Items* diff --git a/docs/mfc/menus-and-resources-container-additions.md b/docs/mfc/menus-and-resources-container-additions.md index 7ece3400513..09b822aea90 100644 --- a/docs/mfc/menus-and-resources-container-additions.md +++ b/docs/mfc/menus-and-resources-container-additions.md @@ -4,10 +4,12 @@ title: "Menus and Resources: Container Additions" ms.date: "11/04/2016" f1_keywords: ["IDP_OLE_INIT_FAILED", "IDP_FAILED_TO_CREATE", "VK_ESCAPE"] helpviewer_keywords: ["application accelerator table [MFC]", "VK_ESCAPE key [MFC]", "IDP_FAILED_TO_CREATE macro [MFC]", "visual editing, application menus and resources", "OLE containers [MFC], menus and resources", "accelerator tables [MFC], container applications", "IDP_OLE_INIT_FAILED macro [MFC]", "CONTAIN tutorial [MFC]", "Links menu item [MFC]"] -ms.assetid: 425448be-8ca0-412e-909a-a3a9ce845288 --- # Menus and Resources: Container Additions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the changes that need to be made to the menus and other resources in a visual editing container application. In container applications, two types of changes need to be made: modifications to existing resources to support OLE visual editing and addition of new resources used for in-place activation. If you use the application wizard to create your container application, these steps will be done for you, but they may require some customization. diff --git a/docs/mfc/menus-and-resources-menu-merging.md b/docs/mfc/menus-and-resources-menu-merging.md index b418a729ab0..523cbbb818e 100644 --- a/docs/mfc/menus-and-resources-menu-merging.md +++ b/docs/mfc/menus-and-resources-menu-merging.md @@ -3,10 +3,12 @@ description: "Learn more about: Menus and Resources: Menu Merging" title: "Menus and Resources: Menu Merging" ms.date: "11/04/2016" helpviewer_keywords: ["status bars [MFC], OLE document applications", "visual editing [MFC], application menus and resources", "coordinating menu layouts [MFC]", "OLE containers [MFC], menus and resources", "toolbars [MFC], OLE document applications", "merging toolbar and status bar [MFC]", "menus [MFC], OLE document applications"] -ms.assetid: 80b6bb17-d830-4122-83f0-651fc112d4d1 --- # Menus and Resources: Menu Merging +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article details the steps necessary for OLE document applications to handle visual editing and in-place activation properly. In-place activation poses a challenge for both container and server (component) applications. The user remains in the same frame window (within the context of the container document) but is actually running another application (the server). This requires coordination between the resources of the container and server applications. Topics covered in this article include: diff --git a/docs/mfc/menus-and-resources-ole.md b/docs/mfc/menus-and-resources-ole.md index 8cc71f8bc8a..577625c40ba 100644 --- a/docs/mfc/menus-and-resources-ole.md +++ b/docs/mfc/menus-and-resources-ole.md @@ -3,10 +3,12 @@ description: "Learn more about: Menus and Resources (OLE)" title: "Menus and Resources (OLE)" ms.date: "11/04/2016" helpviewer_keywords: ["OLE visual editing servers [MFC]", "status bars [MFC], OLE document applications", "visual editing [MFC], application menus and resources", "string tables [MFC], visual editing applications", "OLE containers [MFC], menus and resources", "OLE applications [MFC], menus and resources", "OLE server applications [MFC], menus and resources", "toolbars [MFC], OLE document applications", "string editing [MFC], visual editing applications", "server applications [MFC], OLE menus and resources", "applications [OLE], menus and resources", "menus [MFC], OLE document applications", "in-place activation [MFC], OLE menus and resources", "containers [MFC], OLE container applications", "OLE menus and resources [MFC]"] -ms.assetid: 52bfa086-7d3d-466f-94c7-c7061f3bdb3a --- # Menus and Resources (OLE) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This group of articles explains the use of menus and resources in MFC OLE document applications. OLE visual editing places additional requirements on the menu and other resources provided by OLE document applications because there are a number of modes in which both container and server (component) applications can be started and used. For example, a full-server application can run in any of these three modes: diff --git a/docs/mfc/menus-and-resources-server-additions.md b/docs/mfc/menus-and-resources-server-additions.md index dda5aca9ad4..0bdebe03ea2 100644 --- a/docs/mfc/menus-and-resources-server-additions.md +++ b/docs/mfc/menus-and-resources-server-additions.md @@ -3,10 +3,12 @@ description: "Learn more about: Menus and Resources: Server Additions" title: "Menus and Resources: Server Additions" ms.date: "11/04/2016" helpviewer_keywords: ["OLE visual editing servers [MFC]", "accelerator tables [MFC], server applications", "visual editing [MFC], application menus and resources", "server applications [MFC], accelerator table", "string tables [MFC], visual editing applications", "servers [MFC], menu additions", "resources [MFC], server applications", "OLE server applications [MFC], menus and resources", "string editing [MFC], visual editing applications", "IDP_OLE_INIT_FAILED macro [MFC]", "server applications [MFC], OLE menus and resources", "OLE initialization failure [MFC]"] -ms.assetid: 56ce9e8d-8f41-4db8-8dee-e8b0702d057c --- # Menus and Resources: Server Additions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the changes that need to be made to the menus and other resources in a visual editing server (component) application. A server application requires many additions to the menu structure and other resources because it can be started in one of three modes: stand alone, embedded, or in place. As described in the [Menus and Resources (OLE)](menus-and-resources-ole.md) article, there are a maximum of four sets of menus. All four are used for an MDI full-server application, while only three are used for a miniserver. The application wizard will create the menu layout necessary for the type of server you want. Some customization may be necessary. If you do not use the application wizard, you may want to look at HIERSVR.RC, the resource script for the MFC sample application [HIERSVR](../overview/visual-cpp-samples.md), to see how these changes are implemented. diff --git a/docs/mfc/menus-mfc.md b/docs/mfc/menus-mfc.md index 5cbfe9db0ff..c1abbae69f7 100644 --- a/docs/mfc/menus-mfc.md +++ b/docs/mfc/menus-mfc.md @@ -3,17 +3,19 @@ description: "Learn more about: Menus (MFC)" title: "Menus (MFC)" ms.date: "11/04/2016" helpviewer_keywords: ["menus [MFC], updating as context changes", "menus [MFC], MFC resources for working with", "menus [MFC], manipulating during execution", "menus [MFC]"] -ms.assetid: 6a181495-47a9-4356-83fc-b89152d6cb4c --- # Menus (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC supplies two elements to help you work with menus: - Class [CMenu](reference/cmenu-class.md) for manipulating your program's menus at run time. Use the documentation for `CMenu` and the sample to learn how to use `CMenu` effectively. - A mechanism for updating menus and toolbar buttons: enabling or disabling them on the fly to suit current program conditions. -Visual C++ also provides a [menu editor](../windows/menu-editor.md) for creating and editing your program's menu resources. +Visual Studio also provides a [menu editor](../windows/menu-editor.md) for creating and editing your program's menu resources. ## What do you want to know more about diff --git a/docs/mfc/message-categories.md b/docs/mfc/message-categories.md index 8f26f6242e0..ad100f126fb 100644 --- a/docs/mfc/message-categories.md +++ b/docs/mfc/message-categories.md @@ -3,11 +3,13 @@ description: "Learn more about: Message Categories" title: "Message Categories" ms.date: "11/04/2016" helpviewer_keywords: ["messages [MFC], categories", "control-notification messages [MFC]", "Windows messages [MFC], categories", "controls [MFC], notifications", "command messages [MFC]", "messages [MFC], Windows", "message handling [MFC], message types"] -ms.assetid: 68e1db75-9da6-4a4d-b2c2-dc4d59f8d87b ms.topic: how-to --- # Message Categories +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + What kinds of messages do you write handlers for There are three main categories: 1. Windows messages diff --git a/docs/mfc/message-handlers.md b/docs/mfc/message-handlers.md index 80bf4659c7d..60944d82359 100644 --- a/docs/mfc/message-handlers.md +++ b/docs/mfc/message-handlers.md @@ -3,17 +3,19 @@ description: "Learn more about: Message Handlers" title: "Message Handlers" ms.date: "11/04/2016" helpviewer_keywords: ["message handlers [MFC]", "command handling [MFC], message handlers", "handlers [MFC]", "message handling [MFC], message handler functions", "handlers [MFC], command", "handlers [MFC], message"] -ms.assetid: 51bc4e76-dbe3-4cc2-b026-3199d56b2fa9 --- # Message Handlers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In MFC, a dedicated *handler* function processes each separate message. Message-handler functions are member functions of a class. This documentation uses the terms *message-handler member function*, *message-handler function*, *message handler*, and *handler* interchangeably. Some kinds of message handlers are also called "command handlers." Writing message handlers accounts for a large proportion of your work in writing a framework application. This article family describes how the message-processing mechanism works. What does the handler for a message do It does whatever you want done in response to that message. You can create the handlers by using the [Class Wizard](reference/mfc-class-wizard.md) of the class, and then fill in the handler's code using the source code editor. -You can use all of the facilities of Microsoft Visual C++ and MFC to write your handlers. For a list of all classes, see [Class Library Overview](class-library-overview.md) in the *MFC Reference*. +You can use all of the facilities of Visual Studio and MFC to write your handlers. For a list of all classes, see [Class Library Overview](class-library-overview.md) in the *MFC Reference*. ## See also diff --git a/docs/mfc/message-handling-and-command-targets.md b/docs/mfc/message-handling-and-command-targets.md index b6f6fe862a7..f53661b8363 100644 --- a/docs/mfc/message-handling-and-command-targets.md +++ b/docs/mfc/message-handling-and-command-targets.md @@ -4,10 +4,12 @@ title: "Message Handling and Command Targets" ms.date: "11/04/2016" f1_keywords: ["IOleCommandTarget"] helpviewer_keywords: ["command targets [MFC]", "message handling [MFC], active documents", "IOleCommandTarget interface [MFC]", "command routing [MFC], command targets"] -ms.assetid: e45ce14c-e6b6-4262-8f3b-4e891e0ec2a3 --- # Message Handling and Command Targets +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The command dispatch interface `IOleCommandTarget` defines a simple and extensible mechanism to query and execute commands. This mechanism is simpler than Automation's `IDispatch` because it relies entirely on a standard set of commands; commands rarely have arguments, and no type information is involved (type safety is diminished for command arguments as well). In the command dispatch interface design, each command belongs to a "command group" which is itself identified with a **GUID**. Therefore, anyone can define a new group and define all the commands within that group without any need to coordinate with Microsoft or any other vendor. (This is essentially the same means of definition as a **dispinterface** plus **dispIDs** in Automation. There is overlap here, although this command routing mechanism is only for command routing and not for scripting/programmability on a large scale as Automation handles.) diff --git a/docs/mfc/message-handling-and-mapping.md b/docs/mfc/message-handling-and-mapping.md index bbbbaee3203..ee575c92be8 100644 --- a/docs/mfc/message-handling-and-mapping.md +++ b/docs/mfc/message-handling-and-mapping.md @@ -3,10 +3,12 @@ description: "Learn more about: Message Handling and Mapping" title: "Message Handling and Mapping" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, messages", "message handling [MFC]", "message maps [MFC]"] -ms.assetid: 62fe2a1b-944c-449d-a0f0-63c11ee0a3cb --- # Message Handling and Mapping +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article family describes how messages and commands are processed by the MFC framework and how you connect them to their handler functions. In traditional programs for Windows, Windows messages are handled in a large switch statement in a window procedure. MFC instead uses [message maps](message-categories.md) to map direct messages to distinct class member functions. Message maps are more efficient than virtual functions for this purpose, and they allow messages to be handled by the most appropriate C++ object — application, document, view, and so on. You can map a single message or a range of messages, command IDs, or control IDs. diff --git a/docs/mfc/message-sending-and-receiving.md b/docs/mfc/message-sending-and-receiving.md index 0aa04b4cd8e..95b7873283f 100644 --- a/docs/mfc/message-sending-and-receiving.md +++ b/docs/mfc/message-sending-and-receiving.md @@ -3,10 +3,12 @@ description: "Learn more about: Message Sending and Receiving" title: "Message Sending and Receiving" ms.date: "11/04/2016" helpviewer_keywords: ["Windows messages [MFC], handling in MFC", "control-notification messages [MFC]", "messages [MFC], receiving", "messages [MFC], MFC", "MFC, messages", "messages [MFC], sending"] -ms.assetid: 9ce189cb-b259-4c3b-b6f2-9cfbed18b98b --- # Message Sending and Receiving +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Consider the sending part of the process and how the framework responds. Most messages result from user interaction with the program. Commands are generated by mouse clicks in menu items or toolbar buttons or by accelerator keystrokes. The user also generates Windows messages by, for example, moving or resizing a window. Other Windows messages are sent when events such as program startup or termination occur, as windows get or lose the focus, and so on. Control-notification messages are generated by mouse clicks or other user interactions with a control, such as a button or list-box control in a dialog box. diff --git a/docs/mfc/messages-and-commands-in-the-framework.md b/docs/mfc/messages-and-commands-in-the-framework.md index 9cb53a25e9f..023b2947a2e 100644 --- a/docs/mfc/messages-and-commands-in-the-framework.md +++ b/docs/mfc/messages-and-commands-in-the-framework.md @@ -3,10 +3,12 @@ description: "Learn more about: Messages and Commands in the Framework" title: "Messages and Commands in the Framework" ms.date: "11/04/2016" helpviewer_keywords: ["events [MFC], command routing in MFC", "event-driven programming [MFC]", "events [MFC], event-driven programming", "message-driven programming [MFC]"] -ms.assetid: d799ed8c-6a9f-4f05-be5d-29cb5bc6d185 --- # Messages and Commands in the Framework +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Applications written for Microsoft Windows are "message driven." In response to events such as mouse clicks, keystrokes, window movements, and so on, Windows sends messages to the proper window. Framework applications process Windows messages like any other application for Windows. But the framework also provides some enhancements that make processing messages easier, more maintainable, and better encapsulated. The following topics introduce the key terms used in the rest of the article family to discuss messages and commands: diff --git a/docs/mfc/messages.md b/docs/mfc/messages.md index 2d0f33dd300..13d244746fa 100644 --- a/docs/mfc/messages.md +++ b/docs/mfc/messages.md @@ -3,10 +3,12 @@ description: "Learn more about: Messages" title: "Messages" ms.date: "11/04/2016" helpviewer_keywords: ["messages, MFC", "messages [MFC]"] -ms.assetid: b1476310-a135-42ca-817c-444fb3675491 --- # Messages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The message loop in the `Run` member function of class `CWinApp` retrieves queued messages generated by various events. For example, when the user clicks the mouse, Windows sends several mouse-related messages, such as WM_LBUTTONDOWN when the left mouse button is pressed and WM_LBUTTONUP when the left mouse button is released. The framework's implementation of the application message loop dispatches the message to the appropriate window. The important categories of messages are described in [Message Categories](message-categories.md). diff --git a/docs/mfc/methods-of-creating-a-status-bar.md b/docs/mfc/methods-of-creating-a-status-bar.md index 7d4e9bc4cf0..0eaad577a3f 100644 --- a/docs/mfc/methods-of-creating-a-status-bar.md +++ b/docs/mfc/methods-of-creating-a-status-bar.md @@ -3,10 +3,12 @@ description: "Learn more about: Methods of Creating a Status Bar" title: "Methods of Creating a Status Bar" ms.date: "11/04/2016" helpviewer_keywords: ["CStatusBar class [MFC], vs. CStatusBarCtrl", "methods [MFC], creating status bars", "CStatusBarCtrl class [MFC], vs. CStatusBar", "CStatusBarCtrl class [MFC], creating", "methods [MFC]", "status bars [MFC], creating"] -ms.assetid: 9aeaf290-7099-4762-a5ba-9c26705333c9 --- # Methods of Creating a Status Bar +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC provides two classes to create status bars: [CStatusBar](reference/cstatusbar-class.md) and [CStatusBarCtrl](reference/cstatusbarctrl-class.md) (which wraps the Windows common control API). `CStatusBar` provides all of the functionality of the status bar common control, it automatically interacts with menus and toolbars, and it handles many of the required common control settings and structures for you; however, your resulting executable usually will be larger than that created by using `CStatusBarCtrl`. `CStatusBarCtrl` usually results in a smaller executable, and you may prefer to use `CStatusBarCtrl` if you do not intend to integrate the status bar into the MFC architecture. If you plan to use `CStatusBarCtrl` and integrate the status bar into the MFC architecture, you must take additional care to communicate status bar control manipulations to MFC. This communication is not difficult; however, it is additional work that is unneeded when you use `CStatusBar`. diff --git a/docs/mfc/methods-of-creating-a-toolbar.md b/docs/mfc/methods-of-creating-a-toolbar.md index aca7ea41dc3..b3c940a3ae1 100644 --- a/docs/mfc/methods-of-creating-a-toolbar.md +++ b/docs/mfc/methods-of-creating-a-toolbar.md @@ -3,10 +3,12 @@ description: "Learn more about: Methods of Creating a Toolbar" title: "Methods of Creating a Toolbar" ms.date: "11/04/2016" helpviewer_keywords: ["CToolBarCtrl class [MFC], and CToolBar class [MFC]", "CToolBar class [MFC], creating toolbars", "MFC toolbars", "toolbar controls [MFC]", "toolbar controls [MFC], creating", "CToolBarCtrl class [MFC], creating toolbars"] -ms.assetid: f19d8d65-d49f-445c-abe8-d47d3e4101c8 --- # Methods of Creating a Toolbar +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC provides two classes to create toolbars: [CToolBar](reference/ctoolbar-class.md) and [CToolBarCtrl](reference/ctoolbarctrl-class.md) (which wraps the Windows common control API). `CToolBar` provides all of the functionality of the toolbar common control, and it handles many of the required common control settings and structures for you; however, your resulting executable usually will be larger than that created by using `CToolBarCtrl`. `CToolBarCtrl` usually results in a smaller executable, and you may prefer to use `CToolBarCtrl` if you do not intend to integrate the toolbar into the MFC architecture. If you plan to use `CToolBarCtrl` and integrate the toolbar into the MFC architecture, you must take additional care to communicate toolbar control manipulations to MFC. This communication is not difficult; however, it is additional work that is unneeded when you use `CToolBar`. diff --git a/docs/mfc/methods-of-creating-tool-tips.md b/docs/mfc/methods-of-creating-tool-tips.md index a51f80a85ad..7d3de35c5cd 100644 --- a/docs/mfc/methods-of-creating-tool-tips.md +++ b/docs/mfc/methods-of-creating-tool-tips.md @@ -3,10 +3,12 @@ description: "Learn more about: Methods of Creating Tool Tips" title: "Methods of Creating Tool Tips" ms.date: "11/04/2016" helpviewer_keywords: ["CToolTipCtrl class [MFC], creating tool tips", "tool tips [MFC], tool tip controls", "tool tips [MFC], creating"] -ms.assetid: b015e9f4-ddfb-49a4-a5a6-fa2d45e4d328 --- # Methods of Creating Tool Tips +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC provides three classes to create and manage the tool tip control: [CWnd](reference/cwnd-class.md), [CToolBarCtrl](reference/ctoolbarctrl-class.md), [CToolTipCtrl](reference/ctooltipctrl-class.md) and [CMFCToolTipCtrl](reference/cmfctooltipctrl-class.md). The tool tip member functions in these classes wrap the Windows common control API. Class `CToolBarCtrl` and class `CToolTipCtrl` are derived from class `CWnd`. `CWnd` provides four member functions to create and manage tool tips: [EnableToolTips](reference/cwnd-class.md#enabletooltips), [CancelToolTips](reference/cwnd-class.md#canceltooltips), [FilterToolTipMessage](reference/cwnd-class.md#filtertooltipmessage), and [OnToolHitTest](reference/cwnd-class.md#ontoolhittest). See these individual member functions for more information about how they implement tool tips. diff --git a/docs/mfc/mfc-activex-controls-accessing-ambient-properties.md b/docs/mfc/mfc-activex-controls-accessing-ambient-properties.md index 1d6babaf05f..613eacca7a6 100644 --- a/docs/mfc/mfc-activex-controls-accessing-ambient-properties.md +++ b/docs/mfc/mfc-activex-controls-accessing-ambient-properties.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Accessing Ambient Properti title: "MFC ActiveX Controls: Accessing Ambient Properties" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], accessing ambient properties", "properties [MFC], accessing ambient"] -ms.assetid: fdc9db29-e6b0-45d2-a879-8bd60e2058a7 --- # MFC ActiveX Controls: Accessing Ambient Properties +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article discusses how an ActiveX control can access the ambient properties of its control container. A control can obtain information about its container by accessing the container's ambient properties. These properties expose visual characteristics, such as the container's background color, the current font used by the container, and operational characteristics, such as whether the container is currently in user mode or designer mode. A control can use ambient properties to tailor its appearance and behavior to the particular container in which it is embedded. However, a control should never assume that its container will support any particular ambient property. In fact, some containers may not support any ambient properties at all. In the absence of an ambient property, a control should assume a reasonable default value. diff --git a/docs/mfc/mfc-activex-controls-adding-another-custom-property-page.md b/docs/mfc/mfc-activex-controls-adding-another-custom-property-page.md index 7cac0772199..1cc40a9fbaf 100644 --- a/docs/mfc/mfc-activex-controls-adding-another-custom-property-page.md +++ b/docs/mfc/mfc-activex-controls-adding-another-custom-property-page.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Adding Another Custom Prop title: "MFC ActiveX Controls: Adding Another Custom Property Page" ms.date: "11/04/2016" helpviewer_keywords: ["property pages [MFC], MFC ActiveX controls", "custom property pages [MFC]", "ActiveX controls [MFC], property pages", "MFC ActiveX controls [MFC], property pages"] -ms.assetid: fcf7e119-9f29-41a9-908d-e9b1607e08af --- # MFC ActiveX Controls: Adding Another Custom Property Page +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Occasionally, an ActiveX control will have more properties than can reasonably fit on one property page. In this case, you can add property pages to the ActiveX control to display these properties. This article discusses adding new property pages to an ActiveX control that already has at least one property page. For more information on adding stock property pages (font, picture, or color), see the article [MFC ActiveX Controls: Using Stock Property Pages](mfc-activex-controls-using-stock-property-pages.md). diff --git a/docs/mfc/mfc-activex-controls-adding-custom-events.md b/docs/mfc/mfc-activex-controls-adding-custom-events.md index c89a3bcb620..034ada14256 100644 --- a/docs/mfc/mfc-activex-controls-adding-custom-events.md +++ b/docs/mfc/mfc-activex-controls-adding-custom-events.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Adding Custom Events" title: "MFC ActiveX Controls: Adding Custom Events" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], events [MFC]", "EVENT_CUSTOM prefix [MFC]", "custom events [MFC], adding to ActiveX controls", "EVENT_CUSTOM macro [MFC]", "InCircle method [MFC]", "ClickIn event", "FireClickIn event", "COleControl class [MFC], custom events [MFC]", "Click event, custom events [MFC]", "events [MFC], ActiveX controls", "custom events [MFC]", "FireEvent method, adding custom events"] -ms.assetid: c584d053-1e34-47aa-958e-37d3e9b85892 --- # MFC ActiveX Controls: Adding Custom Events +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Custom events differ from stock events in that they are not automatically fired by class `COleControl`. A custom event recognizes a certain action, determined by the control developer, as an event. The event map entries for custom events are represented by the EVENT_CUSTOM macro. The following section implements a custom event for an ActiveX control project that was created using the ActiveX Control Wizard. ## Adding a Custom Event with the Add Event Wizard diff --git a/docs/mfc/mfc-activex-controls-adding-custom-methods.md b/docs/mfc/mfc-activex-controls-adding-custom-methods.md index 3886e34488c..a1b2c458c84 100644 --- a/docs/mfc/mfc-activex-controls-adding-custom-methods.md +++ b/docs/mfc/mfc-activex-controls-adding-custom-methods.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Adding Custom Methods" title: "MFC ActiveX Controls: Adding Custom Methods" ms.date: "09/12/2018" helpviewer_keywords: ["MFC ActiveX controls [MFC], methods", "PtInCircle custom method [MFC]"] -ms.assetid: 8f8dc344-44a0-4021-8db5-4cdd3d700e18 --- # MFC ActiveX Controls: Adding Custom Methods +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Custom methods differ from stock methods in that they are not already implemented by `COleControl`. You must supply the implementation for each custom method you add to your control. >[!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-adding-custom-properties.md b/docs/mfc/mfc-activex-controls-adding-custom-properties.md index a14b72ef64c..f6f15299fde 100644 --- a/docs/mfc/mfc-activex-controls-adding-custom-properties.md +++ b/docs/mfc/mfc-activex-controls-adding-custom-properties.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Adding Custom Properties" title: "MFC ActiveX Controls: Adding Custom Properties" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], properties", "properties [MFC], custom"] -ms.assetid: 85af5167-74c7-427b-b8f3-e0d7b73942e5 --- # MFC ActiveX Controls: Adding Custom Properties +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Custom properties differ from stock properties in that custom properties are not already implemented by the `COleControl` class. A custom property is used to expose a certain state or appearance of an ActiveX control to a programmer using the control. This article describes how to add a custom property to the ActiveX control using the Add Property Wizard and explains the resulting code modifications. Topics include: diff --git a/docs/mfc/mfc-activex-controls-adding-stock-events-to-an-activex-control.md b/docs/mfc/mfc-activex-controls-adding-stock-events-to-an-activex-control.md index 6199bcbffa9..ee97fd6f354 100644 --- a/docs/mfc/mfc-activex-controls-adding-stock-events-to-an-activex-control.md +++ b/docs/mfc/mfc-activex-controls-adding-stock-events-to-an-activex-control.md @@ -4,10 +4,12 @@ title: "MFC ActiveX Controls: Adding Stock Events to an ActiveX Control" ms.date: "11/04/2016" f1_keywords: ["EVENT__STOCK_ERROR", "EVENT__STOCK_READYSTATECHANGE", "ReadyStateChange", "EVENT__STOCK_MOUSEMOVE", "EVENT__STOCK_MOUSEUP", "EVENT__STOCK_DBLCLICK", "KeyPress", "EVENT__STOCK_KEYDOWN", "EVENT__STOCK", "EVENT__STOCK_MOUSEDOWN", "EVENT__STOCK_KEYPRESS", "EVENT__STOCK_CLICK", "EVENT__STOCK_KEYUP"] helpviewer_keywords: ["MFC ActiveX controls [MFC], events", "KeyPress event", "FireDblClick event", "FireMouseDown event", "events [MFC], stock", "FireKeyPress event", "EVENT_STOCK_MOUSEMOVE event", "EVENT_STOCK_CLICK event", "FireClick event", "FireKeyUp event", "FireMouseUp event", "EVENT_STOCK_ERROREVENT event", "EVENT_STOCK_KEYDOWN event", "EVENT_STOCK_MOUSEDOWN event", "EVENT_STOCK_KEYPRESS macro [MFC]", "EVENT_STOCK_KEYUP event", "EVENT_STOCK_DBLCLICK event", "FireError event", "FireKeyDown event", "ReadyStateChange event", "EVENT_STOCK_MOUSEUP event", "FireMouseMove event", "EVENT_STOCK prefix", "EVENT_STOCK_READYSTATECHANGE event", "EVENT_STOCK_KEYPRESS event"] -ms.assetid: 3eeadc67-4b3d-4444-8caa-53054073988a --- # MFC ActiveX Controls: Adding Stock Events to an ActiveX Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Stock events differ from custom events in that they are automatically fired by class [COleControl](reference/colecontrol-class.md). `COleControl` contains predefined member functions that fire events resulting from common actions. Some common actions implemented by `COleControl` include single- and double-clicks on the control, keyboard events, and changes in the state of the mouse buttons. Event map entries for stock events are always preceded by the EVENT_STOCK prefix. ## Stock Events Supported by the Add Event Wizard diff --git a/docs/mfc/mfc-activex-controls-adding-stock-methods.md b/docs/mfc/mfc-activex-controls-adding-stock-methods.md index 7764a1a974e..408b9945866 100644 --- a/docs/mfc/mfc-activex-controls-adding-stock-methods.md +++ b/docs/mfc/mfc-activex-controls-adding-stock-methods.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Adding Stock Methods" title: "MFC ActiveX Controls: Adding Stock Methods" ms.date: "09/12/2018" helpviewer_keywords: ["MFC ActiveX controls [MFC], stock methods", "MFC ActiveX controls [MFC], methods", "DoClick method [MFC]"] -ms.assetid: bc4fad78-cabd-4cc0-a798-464b1a682f0b --- # MFC ActiveX Controls: Adding Stock Methods +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A stock method differs from a custom method in that it is already implemented by class [COleControl](reference/colecontrol-class.md). For example, `COleControl` contains a predefined member function that supports the Refresh method for your control. The dispatch map entry for this stock method is DISP_STOCKFUNC_REFRESH. >[!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-adding-stock-properties.md b/docs/mfc/mfc-activex-controls-adding-stock-properties.md index 8d70bbf4929..574cf734613 100644 --- a/docs/mfc/mfc-activex-controls-adding-stock-properties.md +++ b/docs/mfc/mfc-activex-controls-adding-stock-properties.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Adding Stock Properties" title: "MFC ActiveX Controls: Adding Stock Properties" ms.date: "11/04/2016" helpviewer_keywords: ["BackColor property [MFC]", "properties [MFC], adding stock", "ForeColor property [MFC]", "MFC ActiveX controls [MFC], properties", "foreground colors, ActiveX controls", "foreground colors [MFC]"] -ms.assetid: 8b98c8c5-5b69-4366-87bf-0e61e6668ecb --- # MFC ActiveX Controls: Adding Stock Properties +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Stock properties differ from custom properties in that they are already implemented by the class `COleControl`. `COleControl` contains predefined member functions that support common properties for the control. Some common properties include the control's caption and the foreground and background colors. For information on other stock properties, see [Stock Properties Supported by the Add Property Wizard](#_core_stock_properties_supported_by_classwizard) later in this article. The dispatch map entries for stock properties are always prefixed by DISP_STOCKPROP. This article describes how to add a stock property (in this case, Caption) to an ActiveX control using the Add Property Wizard and explains the resulting code modifications. Topics include: diff --git a/docs/mfc/mfc-activex-controls-advanced-property-implementation.md b/docs/mfc/mfc-activex-controls-advanced-property-implementation.md index 03227889216..d9fd955fb6f 100644 --- a/docs/mfc/mfc-activex-controls-advanced-property-implementation.md +++ b/docs/mfc/mfc-activex-controls-advanced-property-implementation.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Advanced Property Implemen title: "MFC ActiveX Controls: Advanced Property Implementation" ms.date: "09/12/2018" helpviewer_keywords: ["MFC ActiveX controls [MFC], error codes", "properties [MFC], ActiveX controls", "MFC ActiveX controls [MFC], properties"] -ms.assetid: ec2e6759-5a8e-41d8-a275-99af8ff6f32e --- # MFC ActiveX Controls: Advanced Property Implementation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes topics related to implementing advanced properties in an ActiveX control. >[!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-advanced-topics.md b/docs/mfc/mfc-activex-controls-advanced-topics.md index 12416853047..4cf57c98d20 100644 --- a/docs/mfc/mfc-activex-controls-advanced-topics.md +++ b/docs/mfc/mfc-activex-controls-advanced-topics.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Advanced Topics" title: "MFC ActiveX Controls: Advanced Topics" ms.date: "09/12/2018" helpviewer_keywords: ["MFC ActiveX controls [MFC], error codes", "MFC ActiveX controls [MFC], accessing invisible dialog controls", "MFC ActiveX controls [MFC], advanced topics", "FireError method [MFC]", "MFC ActiveX controls [MFC], database classes", "MFC ActiveX controls [MFC], special keys", "PreTranslateMessage method [MFC]", "MFC ActiveX controls [MFC], parameterized property", "ThrowError method [MFC]"] -ms.assetid: e9e34abb-8e2d-461e-bb9c-a1aec5dcecbd --- # MFC ActiveX Controls: Advanced Topics +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article covers advanced topics related to developing ActiveX controls. These include: - [Using Database Classes in ActiveX Controls](#_core_using_database_classes_in_activex_controls) @@ -29,7 +31,7 @@ Because the ActiveX control classes are part of the class library, you can apply For a general overview of the MFC database classes, see [MFC Database Classes (DAO and ODBC)](../data/mfc-database-classes-odbc-and-dao.md). The article introduces both the MFC ODBC classes and the MFC DAO classes and directs you to more details on either. > [!NOTE] -> DAO is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. The Visual C++ environment and wizards do not support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use [OLE DB Templates](../data/oledb/ole-db-programming.md) or [ODBC and MFC](../data/odbc/odbc-and-mfc.md) for new projects. You should only use DAO in maintaining existing applications. +> DAO is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. The Visual Studio environment and wizards do not support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use [OLE DB Templates](../data/oledb/ole-db-programming.md) or [ODBC and MFC](../data/odbc/odbc-and-mfc.md) for new projects. You should only use DAO in maintaining existing applications. ## Implementing a Parameterized Property diff --git a/docs/mfc/mfc-activex-controls-creating-an-automation-server.md b/docs/mfc/mfc-activex-controls-creating-an-automation-server.md index 732f948b9d1..a3a405fd699 100644 --- a/docs/mfc/mfc-activex-controls-creating-an-automation-server.md +++ b/docs/mfc/mfc-activex-controls-creating-an-automation-server.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Creating an Automation Ser title: "MFC ActiveX Controls: Creating an Automation Server" ms.date: "11/04/2016" helpviewer_keywords: ["Automation servers [MFC], MFC ActiveX controls", "ActiveX controls [MFC], Automation server", "MFC ActiveX controls [MFC], Automation server"] -ms.assetid: e0c24ed2-d61c-49ad-a4fa-4e1098d1d39b --- # MFC ActiveX Controls: Creating an Automation Server +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can develop an MFC ActiveX control as an Automation server for the purpose of programmatically embedding that control in another application and calling methods in the control from the application. Such a control would still be available to be hosted in an ActiveX control container. ### To create a control as an Automation server diff --git a/docs/mfc/mfc-activex-controls-distributing-activex-controls.md b/docs/mfc/mfc-activex-controls-distributing-activex-controls.md index a82f3d13a4c..e1a83f2a393 100644 --- a/docs/mfc/mfc-activex-controls-distributing-activex-controls.md +++ b/docs/mfc/mfc-activex-controls-distributing-activex-controls.md @@ -4,10 +4,12 @@ title: "MFC ActiveX Controls: Distributing ActiveX Controls" ms.date: "09/12/2018" f1_keywords: ["GetWindowsDirectory", "GetSystemDirectory"] helpviewer_keywords: ["MFC ActiveX controls [MFC], ANSI or Unicode versions", "RegSvr32.exe", "MFC ActiveX controls [MFC], distributing", "distributing MFC ActiveX controls", "redistributable files, MFC ActiveX controls", "GetSystemDirectory method [MFC]", "registering ActiveX controls", "MSVCRT40.dll", "registry [MFC], registering controls", "LoadLibrary method, registering ActiveX controls", "MFC40U.DLL", "MFC40.DLL", "GetWindowsDirectory method [MFC]", "installing ActiveX controls", "GetProcAddress method, registering ActiveX controls", "MFC ActiveX controls [MFC], installing", "MFC ActiveX controls [MFC], registering", "registering controls", "OLEPRO32.DLL"] -ms.assetid: cd70ac9b-f613-4879-9e81-6381fdfda2a1 --- # MFC ActiveX Controls: Distributing ActiveX Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article discusses several issues related to redistributing ActiveX controls: - [ANSI or Unicode Control Versions](#_core_ansi_or_unicode_control_versions) diff --git a/docs/mfc/mfc-activex-controls-events.md b/docs/mfc/mfc-activex-controls-events.md index 6a6162a9272..0861f1f6ae8 100644 --- a/docs/mfc/mfc-activex-controls-events.md +++ b/docs/mfc/mfc-activex-controls-events.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Events" title: "MFC ActiveX Controls: Events" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], events", "notifications [MFC], notifying containers of events", "custom events [MFC], adding to ActiveX controls", "events [MFC], mapping", "COleControl class [MFC], handling of events", "mappings [MFC], events", "stock events [MFC]", "container events [MFC]", "events [MFC], ActiveX controls", "OLE events [MFC]"] -ms.assetid: e1e57e0c-206b-4923-a0b5-682c26564f74 --- # MFC ActiveX Controls: Events +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + ActiveX controls use events to notify a container that something has happened to the control. Common examples of events include clicks on the control, data entered using the keyboard, and changes in the control's state. When these actions occur, the control fires an event to alert the container. Events are also called messages. diff --git a/docs/mfc/mfc-activex-controls-licensing-an-activex-control.md b/docs/mfc/mfc-activex-controls-licensing-an-activex-control.md index 45eb20a4fa8..c2241ffecc3 100644 --- a/docs/mfc/mfc-activex-controls-licensing-an-activex-control.md +++ b/docs/mfc/mfc-activex-controls-licensing-an-activex-control.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Licensing an ActiveX Contr title: "MFC ActiveX Controls: Licensing an ActiveX Control" ms.date: "11/19/2018" helpviewer_keywords: ["COleObjectFactory class [MFC], licensing controls", "MFC ActiveX controls [MFC], licensing", "VerifyLicenseKey method [MFC]", "VerifyUserLicense method [MFC]", "GetLicenseKey method [MFC]", "licensing ActiveX controls"] -ms.assetid: cacd9e45-701a-4a1f-8f1f-b0b39f6ac303 --- # MFC ActiveX Controls: Licensing an ActiveX Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Licensing support, an optional feature of ActiveX controls, allows you to control who is able to use or distribute the control. (For additional discussion of licensing issues, see Licensing Issues in [Upgrading an Existing ActiveX Control](upgrading-an-existing-activex-control.md).) > [!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-localizing-an-activex-control.md b/docs/mfc/mfc-activex-controls-localizing-an-activex-control.md index 7e25d900478..b226aba58f7 100644 --- a/docs/mfc/mfc-activex-controls-localizing-an-activex-control.md +++ b/docs/mfc/mfc-activex-controls-localizing-an-activex-control.md @@ -4,10 +4,12 @@ title: "MFC ActiveX Controls: Localizing an ActiveX Control" ms.date: "09/12/2018" f1_keywords: ["LocaleID", "AfxOleRegisterTypeLib"] helpviewer_keywords: ["localization, ActiveX controls", "MFC ActiveX controls [MFC], localizing", "LocaleID ambient property [MFC]", "LOCALIZE sample [MFC]"] -ms.assetid: a44b839a-c652-4ec5-b824-04392708a5f9 --- # MFC ActiveX Controls: Localizing an ActiveX Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article discusses procedures for localizing ActiveX control interfaces. >[!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-methods.md b/docs/mfc/mfc-activex-controls-methods.md index a4719418053..6c38e501a25 100644 --- a/docs/mfc/mfc-activex-controls-methods.md +++ b/docs/mfc/mfc-activex-controls-methods.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Methods" title: "MFC ActiveX Controls: Methods" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], methods"] -ms.assetid: e20271de-6ffa-4ba0-848b-bafe6c9e510c --- # MFC ActiveX Controls: Methods +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An ActiveX control fires events to communicate between itself and its control container. A container can also communicate with a control by means of methods and properties. Methods are also called functions. Methods and properties provide an exported interface for use by other applications, such as Automation clients and ActiveX control containers. For more information on ActiveX control properties, see the article [MFC ActiveX Controls: Properties](mfc-activex-controls-properties.md). diff --git a/docs/mfc/mfc-activex-controls-optimization.md b/docs/mfc/mfc-activex-controls-optimization.md index a93fa67f5ef..eae4188a105 100644 --- a/docs/mfc/mfc-activex-controls-optimization.md +++ b/docs/mfc/mfc-activex-controls-optimization.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Optimization" title: "MFC ActiveX Controls: Optimization" ms.date: "09/12/2018" helpviewer_keywords: ["MFC ActiveX controls [MFC], windowless", "flicker-free ActiveX controls", "MFC ActiveX controls [MFC], mouse interaction", "device contexts, unclipped for MFC ActiveX controls", "MFC ActiveX controls [MFC], optimizing", "performance, ActiveX controls", "optimization, ActiveX controls", "MFC ActiveX controls [MFC], flicker-free", "windowless MFC ActiveX controls", "MFC ActiveX controls [MFC], active/inactive state", "optimizing performance, ActiveX controls"] -ms.assetid: 8b11f26a-190d-469b-b594-5336094a0109 --- # MFC ActiveX Controls: Optimization +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains techniques you can use to optimize your ActiveX controls for better performance. >[!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-painting-an-activex-control.md b/docs/mfc/mfc-activex-controls-painting-an-activex-control.md index 6a5ae990337..2e850615b59 100644 --- a/docs/mfc/mfc-activex-controls-painting-an-activex-control.md +++ b/docs/mfc/mfc-activex-controls-painting-an-activex-control.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Painting an ActiveX Contro title: "MFC ActiveX Controls: Painting an ActiveX Control" ms.date: "09/12/2018" helpviewer_keywords: ["MFC ActiveX controls [MFC], painting", "MFC ActiveX controls [MFC], optimizing"] -ms.assetid: 25fff9c0-4dab-4704-aaae-8dfb1065dee3 --- # MFC ActiveX Controls: Painting an ActiveX Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the ActiveX control painting process and how you can alter paint code to optimize the process. (See [Optimizing Control Drawing](optimizing-control-drawing.md) for techniques on how to optimize drawing by not having controls individually restore previously selected GDI objects. After all of the controls have been drawn, the container can automatically restore the original objects.) >[!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-properties.md b/docs/mfc/mfc-activex-controls-properties.md index 6779f249c19..839b34e745b 100644 --- a/docs/mfc/mfc-activex-controls-properties.md +++ b/docs/mfc/mfc-activex-controls-properties.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Properties" title: "MFC ActiveX Controls: Properties" ms.date: "11/04/2016" helpviewer_keywords: ["properties [MFC], ActiveX controls", "MFC ActiveX controls [MFC], properties", "properties [MFC]"] -ms.assetid: b678a53c-0d9e-476f-8aa0-23b80baaba46 --- # MFC ActiveX Controls: Properties +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An ActiveX control fires events to communicate with its control container. The container, in return, uses methods and properties to communicate with the control. Methods and properties are similar in use and purpose, respectively, to member functions and member variables of a C++ class. Properties are data members of the ActiveX control that are exposed to any container. Properties provide an interface for applications that contain ActiveX controls, such as Automation clients and ActiveX control containers. Properties are also called attributes. diff --git a/docs/mfc/mfc-activex-controls-property-pages.md b/docs/mfc/mfc-activex-controls-property-pages.md index 3fcbd9e8f72..e1514eb2968 100644 --- a/docs/mfc/mfc-activex-controls-property-pages.md +++ b/docs/mfc/mfc-activex-controls-property-pages.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ActiveX Controls: Property Pages" title: "MFC ActiveX Controls: Property Pages" ms.date: "11/19/2018" helpviewer_keywords: ["DDP_ functions [MFC]", "MFC ActiveX controls [MFC], properties", "property pages [MFC], MFC ActiveX controls", "DoDataExchange method [MFC]", "OLEIVERB_PROPERTIES", "CPropertyPageDialog class [MFC]", "MFC ActiveX controls [MFC], property pages"] -ms.assetid: 1506f87a-9fd6-4505-8380-0dbc9636230e --- # MFC ActiveX Controls: Property Pages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Property pages allow an ActiveX control user to view and change ActiveX control properties. These properties are accessed by invoking a control properties dialog box, which contains one or more property pages that provide a customized, graphical interface for viewing and editing the control properties. >[!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-returning-error-codes-from-a-method.md b/docs/mfc/mfc-activex-controls-returning-error-codes-from-a-method.md index e657b702672..7aa30785a26 100644 --- a/docs/mfc/mfc-activex-controls-returning-error-codes-from-a-method.md +++ b/docs/mfc/mfc-activex-controls-returning-error-codes-from-a-method.md @@ -3,11 +3,13 @@ description: "Learn more about: MFC ActiveX Controls: Returning Error Codes From title: "MFC ActiveX Controls: Returning Error Codes From a Method" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], error codes", "SetNotSupported method, using", "errors [MFC], ActiveX control error codes", "GetNotSupported method [MFC]", "FireError method [MFC]", "SCODE, MFC ActiveX controls", "ThrowError method [MFC]"] -ms.assetid: 771fb9c9-2413-4dcc-b386-7bc4c4adeafd ms.topic: troubleshooting-error-codes --- # MFC ActiveX Controls: Returning Error Codes From a Method +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes how to return error codes from an ActiveX control method. To indicate that an error has occurred within a method, you should use the [COleControl::ThrowError](reference/colecontrol-class.md#throwerror) member function, which takes an SCODE (status code) as a parameter. You can use a predefined SCODE or define one of your own. diff --git a/docs/mfc/mfc-activex-controls-serializing.md b/docs/mfc/mfc-activex-controls-serializing.md index 95877d684b8..3cc9f82efc1 100644 --- a/docs/mfc/mfc-activex-controls-serializing.md +++ b/docs/mfc/mfc-activex-controls-serializing.md @@ -4,10 +4,12 @@ title: "MFC ActiveX Controls: Serializing" ms.date: "09/12/2018" f1_keywords: ["_wVerMinor", "DoPropExchange", "_wVerMajor"] helpviewer_keywords: ["MFC ActiveX controls [MFC], version support", "wVerMinor global constant [MFC]", "GetVersion method [MFC]", "ExchangeVersion method [MFC]", "MFC ActiveX controls [MFC], serializing", "DoPropExchange method [MFC]", "versioning ActiveX controls", "wVerMajor global constant"] -ms.assetid: 9d57c290-dd8c-4853-b552-6f17f15ebedd --- # MFC ActiveX Controls: Serializing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article discusses how to serialize an ActiveX control. Serialization is the process of reading from or writing to a persistent storage medium, such as a disk file. The Microsoft Foundation Class (MFC) Library provides built-in support for serialization in class `CObject`. `COleControl` extends this support to ActiveX controls through the use of a property exchange mechanism. >[!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-subclassing-a-windows-control.md b/docs/mfc/mfc-activex-controls-subclassing-a-windows-control.md index 8a871b2d5f9..04ee60c3058 100644 --- a/docs/mfc/mfc-activex-controls-subclassing-a-windows-control.md +++ b/docs/mfc/mfc-activex-controls-subclassing-a-windows-control.md @@ -4,10 +4,12 @@ title: "MFC ActiveX Controls: Subclassing a Windows Control" ms.date: "09/12/2018" f1_keywords: ["precreatewindow", "IsSubclassed"] helpviewer_keywords: ["OnDraw method, MFC ActiveX controls", "subclassing", "DoSuperclassPaint method [MFC]", "subclassing Windows controls", "subclassing, Windows controls", "reflected messages, in ActiveX controls", "PreCreateWindow method, overriding", "MFC ActiveX controls [MFC], subclassed controls", "MFC ActiveX controls [MFC], creating", "IsSubclassed method [MFC]"] -ms.assetid: 3236d4de-401f-49b7-918d-c84559ecc426 --- # MFC ActiveX Controls: Subclassing a Windows Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the process for subclassing a common Windows control to create an ActiveX control. Subclassing an existing Windows control is a quick way to develop an ActiveX control. The new control will have the abilities of the subclassed Windows control, such as painting and responding to mouse clicks. The MFC ActiveX controls sample [BUTTON](../overview/visual-cpp-samples.md) is an example of subclassing a Windows control. >[!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-using-data-binding-in-an-activex-control.md b/docs/mfc/mfc-activex-controls-using-data-binding-in-an-activex-control.md index b979bc1a9a8..95155d02712 100644 --- a/docs/mfc/mfc-activex-controls-using-data-binding-in-an-activex-control.md +++ b/docs/mfc/mfc-activex-controls-using-data-binding-in-an-activex-control.md @@ -4,10 +4,12 @@ title: "MFC ActiveX Controls: Using Data Binding in an ActiveX Control" ms.date: "11/19/2018" f1_keywords: ["bindable", "requestedit", "defaultbind", "displaybind", "dispid"] helpviewer_keywords: ["MFC ActiveX controls [MFC], data binding", "data binding [MFC], MFC ActiveX controls", "data-bound controls [MFC], MFC ActiveX controls", "controls [MFC], data binding", "bound controls [MFC], MFC ActiveX"] -ms.assetid: 476b590a-bf2a-498a-81b7-dd476bd346f1 --- # MFC ActiveX Controls: Using Data Binding in an ActiveX Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + One of the more powerful uses of ActiveX controls is data binding, which allows a property of the control to bind with a specific field in a database. When a user modifies data in this bound property, the control notifies the database and requests that the record field be updated. The database then notifies the control of the success or failure of the request. >[!IMPORTANT] diff --git a/docs/mfc/mfc-activex-controls-using-fonts.md b/docs/mfc/mfc-activex-controls-using-fonts.md index dc16f5d4526..1848b68f49d 100644 --- a/docs/mfc/mfc-activex-controls-using-fonts.md +++ b/docs/mfc/mfc-activex-controls-using-fonts.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["notifications [MFC], MFC ActiveX controls fonts", "OnDraw --- # MFC ActiveX Controls: Using Fonts +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If your ActiveX control displays text, you can allow the control user to change the text appearance by changing a font property. Font properties are implemented as font objects and can be one of two types: stock or custom. Stock Font properties are preimplemented font properties that you can add using the Add Property Wizard. Custom Font properties are not preimplemented and the control developer determines the property's behavior and usage. This article covers the following topics: diff --git a/docs/mfc/mfc-activex-controls-using-pictures-in-an-activex-control.md b/docs/mfc/mfc-activex-controls-using-pictures-in-an-activex-control.md index 6703e6d5431..6f3f143caa9 100644 --- a/docs/mfc/mfc-activex-controls-using-pictures-in-an-activex-control.md +++ b/docs/mfc/mfc-activex-controls-using-pictures-in-an-activex-control.md @@ -4,10 +4,12 @@ title: "MFC ActiveX Controls: Using Pictures in an ActiveX Control" ms.date: "11/04/2016" f1_keywords: ["LPPICTUREDISP"] helpviewer_keywords: ["OnDraw method, MFC ActiveX controls", "MFC ActiveX controls [MFC], pictures", "OnDraw method [MFC]", "OnResetState method [MFC]", "CLSID_CPicturePropPage [MFC]"] -ms.assetid: 2e49735c-21b9-4442-bb3d-c82ef258eec9 --- # MFC ActiveX Controls: Using Pictures in an ActiveX Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the common Picture type and how to implement it in your ActiveX control. Topics include: - [Overview of Custom Picture Properties](#_core_overview_of_custom_picture_properties) diff --git a/docs/mfc/mfc-activex-controls-using-stock-property-pages.md b/docs/mfc/mfc-activex-controls-using-stock-property-pages.md index e9553c4cef5..0ce6947ce86 100644 --- a/docs/mfc/mfc-activex-controls-using-stock-property-pages.md +++ b/docs/mfc/mfc-activex-controls-using-stock-property-pages.md @@ -4,10 +4,12 @@ title: "MFC ActiveX Controls: Using Stock Property Pages" ms.date: "09/12/2018" f1_keywords: ["CLSID_CPicturePropPage", "CLSID_CColorPropPage", "CLSID_CFontPropPage"] helpviewer_keywords: ["picture stock property pages [MFC]", "CLSID_CFontPropPage [MFC]", "color stock property pages [MFC]", "CLSID_CColorPropPage [MFC]", "fonts [MFC], ActiveX controls", "stock properties [MFC], stock property pages", "CLSID_CPicturePropPage [MFC]", "MFC ActiveX controls [MFC], property pages"] -ms.assetid: 22638d86-ff3e-4124-933e-54b7c2a25968 --- # MFC ActiveX Controls: Using Stock Property Pages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article discusses the stock property pages available for ActiveX controls and how to use them. >[!IMPORTANT] @@ -30,7 +32,7 @@ Note that the count of property pages, in the BEGIN_PROPPAGEIDS macro, is 4. Thi After these modifications have been made, rebuild your project. Your control now has property pages for the font, picture, and color properties. > [!NOTE] -> If the control stock property pages cannot be accessed, it may be because the MFC DLL (MFCxx.DLL) has not been properly registered with the current operating system. This usually results from installing Visual C++ under an operating system different from the one currently running. +> If the control stock property pages cannot be accessed, it may be because the MFC DLL (MFCxx.DLL) has not been properly registered with the current operating system. This usually results from installing Visual Studio under an operating system different from the one currently running. > [!TIP] > If your stock property pages are not visible (see previous Note), register the DLL by running RegSvr32.exe from the command line with the full path name to the DLL. diff --git a/docs/mfc/mfc-activex-controls.md b/docs/mfc/mfc-activex-controls.md index fb744cd66d4..f08cd1629c3 100644 --- a/docs/mfc/mfc-activex-controls.md +++ b/docs/mfc/mfc-activex-controls.md @@ -4,10 +4,12 @@ title: "MFC ActiveX Controls" ms.date: "11/19/2018" f1_keywords: ["MFC ActiveX Controls (MFC)"] helpviewer_keywords: ["COleControl class [MFC], MFC ActiveX controls", "ActiveX controls [MFC], MFC", "containers [MFC], MFC ActiveX controls", "MFC ActiveX controls [MFC], serializing", "MFC ActiveX controls [MFC], containers", "serialization [MFC], MFC ActiveX controls", "dispatch maps [MFC], for MFC ActiveX controls", "MFC ActiveX controls [MFC], active/inactive state", "events [MFC], ActiveX controls", "MFC ActiveX controls [MFC]"] -ms.assetid: c911fb74-3afc-4bf3-a0f5-7922b14d9a1b --- # MFC ActiveX Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An ActiveX control is a reusable software component based on the Component Object Model (COM) that supports a wide variety of OLE functionality and can be customized to fit many software needs. >[!IMPORTANT] @@ -80,7 +82,7 @@ Note that a control is not responsible for obtaining access to the storage mediu ## Installing ActiveX Control Classes and Tools -When you install Visual C++, the MFC ActiveX control classes and retail and debug ActiveX control run-time DLLs are automatically installed if ActiveX controls are selected in Setup (they are selected by default). +When you install Visual Studio, the MFC ActiveX control classes and retail and debug ActiveX control run-time DLLs are automatically installed if ActiveX controls are selected in Setup (they are selected by default). By default, the ActiveX control classes and tools are installed in the following subdirectories under \Program Files\Microsoft Visual Studio .NET: diff --git a/docs/mfc/mfc-and-atl.md b/docs/mfc/mfc-and-atl.md index d9e499ac1bd..424ca2dd106 100644 --- a/docs/mfc/mfc-and-atl.md +++ b/docs/mfc/mfc-and-atl.md @@ -2,15 +2,17 @@ description: "Learn more about: MFC and ATL" title: "MFC and ATL" ms.date: "01/24/2018" -ms.assetid: 31b1a3a8-4154-4c4a-af10-fafc23ecdc5c ms.topic: "overview" ms.custom: intro-overview --- # MFC and ATL +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library and Active Template Library (ATL) continue to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Classes (MFC) provide a C++ object-oriented wrapper over Win32 for rapid development of native desktop applications. The Active Template Library (ATL) is a wrapper library that simplifies COM development and is used extensively for creating ActiveX controls. -You can create MFC or ATL programs with Visual Studio Community Edition or higher. The Express editions do not support MFC or ATL. +You can create MFC or ATL programs with Visual Studio Community Edition or higher. The Express editions don't support MFC or ATL. In Visual Studio 2015, Visual C++ is an optional component, and MFC and ATL components are optional sub-components under Visual C++. If you do not select these components when you first install Visual Studio, you will be prompted to install them the first time you attempt to create or open an MFC or ATL project. diff --git a/docs/mfc/mfc-application-architecture-classes.md b/docs/mfc/mfc-application-architecture-classes.md index 6ec1f95b61a..197201a873d 100644 --- a/docs/mfc/mfc-application-architecture-classes.md +++ b/docs/mfc/mfc-application-architecture-classes.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["MFC, classes", "MFC, application development", "classes [ --- # MFC application architecture classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class library (MFC) classes in this category contribute to the architecture of an MFC application. They supply functionality common to most applications. You fill in the framework to add application-specific functionality. Typically, you do so by deriving new classes from the architecture classes, and then adding new members or overriding existing member functions. [Application wizards](reference/mfc-application-wizard.md) generate several types of applications, all of which use the application framework in differing ways. SDI (single document interface) and MDI (multiple document interface) applications make full use of the document/view part of the framework. Other types of applications, such as dialog-based applications, form-based applications, and DLLs, use only some of document/view architecture features. diff --git a/docs/mfc/mfc-classes-for-creating-internet-client-applications.md b/docs/mfc/mfc-classes-for-creating-internet-client-applications.md index f3a6c837e05..d4d0530b4fa 100644 --- a/docs/mfc/mfc-classes-for-creating-internet-client-applications.md +++ b/docs/mfc/mfc-classes-for-creating-internet-client-applications.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC Classes for Creating Internet Client Applica title: "MFC Classes for Creating Internet Client Applications" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, WinInet classes", "WinInet classes [MFC], classes", "classes [MFC], MFC", "Internet client applications [MFC], MFC", "Internet applications [MFC], MFC"] -ms.assetid: 67d34117-9839-4f4b-8bb8-0e4a9471c606 --- # MFC Classes for Creating Internet Client Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC provides the following classes and global functions for writing Internet client applications. Indentation indicates a class is derived from the unindented class above it. `CGopherFile` and `CHttpFile` derive from `CInternetFile`, for example. These classes and global functions are declared in AFXINET.H, except `CFileFind`, which is declared in AFX.H. ## Classes diff --git a/docs/mfc/mfc-com.md b/docs/mfc/mfc-com.md index 9f5a4136d12..4737b866ce6 100644 --- a/docs/mfc/mfc-com.md +++ b/docs/mfc/mfc-com.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["MFC, COM support", "MFC ActiveX controls [MFC], COM suppo --- # MFC COM +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A subset of MFC is designed to support COM, while most of the Active Template Library (ATL) is designed for COM programming. This section of topics describes MFC's support for COM. Active technologies (such as ActiveX controls, Active document containment, OLE, and so on) use the Component Object Model (COM) to enable software components to interact with one another in a networked environment, regardless of the language with which they were created. Active technologies can be used to create applications that run on the desktop or the Internet. For more information, see [Introduction to COM](../atl/introduction-to-com.md) or [The Component Object Model](/windows/win32/com/the-component-object-model). diff --git a/docs/mfc/mfc-concepts.md b/docs/mfc/mfc-concepts.md index 837ceb34f69..3de9b5e8e42 100644 --- a/docs/mfc/mfc-concepts.md +++ b/docs/mfc/mfc-concepts.md @@ -7,6 +7,9 @@ ms.topic: concept-article --- # MFC Concepts +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This section provides conceptual and task-based topics to help you program using the Microsoft Foundation Class (MFC) Library. ## In This Section diff --git a/docs/mfc/mfc-desktop-applications.md b/docs/mfc/mfc-desktop-applications.md index d1876d18607..73e8b385257 100644 --- a/docs/mfc/mfc-desktop-applications.md +++ b/docs/mfc/mfc-desktop-applications.md @@ -4,10 +4,12 @@ title: "MFC Desktop Applications" ms.date: "07/28/2019" f1_keywords: ["MFC"] helpviewer_keywords: ["libraries, MFC", "class libraries, MFC", "MFC, about MFC"] -ms.assetid: 7101cb18-a681-495c-8f2b-069ad20c72f7 --- # MFC Desktop Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class (MFC) Library provides an object-oriented wrapper over much of the Win32 and COM APIs. Although it can be used to create very simple desktop applications, it is most useful when you need to develop more complex user interfaces with multiple controls. You can use MFC to create applications with Office-style user interfaces. For documentation on the Windows platform itself, see [Windows documentation](/windows/index). For information on building Windows applications in C++ without MFC, see [Build desktop Windows apps using the Win32 API](/windows/win32/index). The MFC Reference covers the classes, global functions, global variables, and macros that make up the Microsoft Foundation Class Library. @@ -72,8 +74,8 @@ Provides links to classes that are shared between MFC and ATL. [MFC Samples](../overview/visual-cpp-samples.md#mfc-samples)
Provides links to samples that demonstrate how to use MFC. -[Visual C++ Libraries Reference](../standard-library/cpp-standard-library-reference.md)
-Provides links to the various libraries provided with Visual C++, including ATL, MFC, OLE DB Templates, the C run-time library, and the C++ Standard Library. +[C++ Libraries Reference](../standard-library/cpp-standard-library-reference.md)
+Provides links to the various libraries provided with Visual Studio, including ATL, MFC, OLE DB Templates, the C run-time library, and the C++ Standard Library. [Debugging in Visual Studio](/visualstudio/debugger/debugging-in-visual-studio)
Provides links to using the Visual Studio debugger to correct logic errors in your application or stored procedures. diff --git a/docs/mfc/mfc-internet-programming-basics.md b/docs/mfc/mfc-internet-programming-basics.md index 60d8a09587a..c5619509e17 100644 --- a/docs/mfc/mfc-internet-programming-basics.md +++ b/docs/mfc/mfc-internet-programming-basics.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC Internet Programming Basics" title: "MFC Internet Programming Basics" ms.date: "11/19/2018" helpviewer_keywords: ["ISAPI extensions, programming with ISAPI", "Internet applications [MFC]", "ISAPI", "ActiveX controls [MFC], Internet", "programming [MFC], Internet", "Web applications [MFC], MFC classes", "ISAPI filters [MFC], programming with ISAPI", "Internet applications [MFC], ActiveX controls", "Internet applications [MFC], writing", "Internet applications [MFC], Active technology", "Active technology [MFC]", "Internet content [MFC]", "WinInet classes [MFC]"] -ms.assetid: 6df2dfd0-6e3f-4587-9d01-2a32f00f8a6f --- # MFC Internet Programming Basics +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Microsoft provides many APIs for programming both client and server applications. Many new applications are being written for the Internet, and as technologies, browser capabilities, and security options change, new types of applications will be written. Browsers run on client computers, providing access to the World Wide Web and displaying HTML pages that contain text, graphics, ActiveX controls, and documents. Servers provide FTP, HTTP, and gopher services, and run server extension applications using CGI. Your custom application can retrieve information and provide data on the Internet. >[!IMPORTANT] diff --git a/docs/mfc/mfc-internet-programming-tasks.md b/docs/mfc/mfc-internet-programming-tasks.md index 7498fd45c93..3685e6ac8db 100644 --- a/docs/mfc/mfc-internet-programming-tasks.md +++ b/docs/mfc/mfc-internet-programming-tasks.md @@ -3,13 +3,15 @@ description: "Learn more about: MFC Internet Programming Tasks" title: "MFC Internet Programming Tasks" ms.date: "09/12/2018" helpviewer_keywords: ["Internet applications [MFC], getting started", "Internet applications [MFC], first steps"] -ms.assetid: 6377e9b8-07c4-4380-b63b-05f5a9061313 --- # MFC Internet Programming Tasks +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This section contains detailed steps for adding Internet support to your applications. Topics include how to use the MFC classes to Internet-enable your existing applications, and how to add Active document support to your existing COM component. Do you want to create a document with up-to-the-minute stock quotes, Pittsburgh's football scores, and the latest temperature in Antarctica Microsoft provides a number of technologies to help you do that over the Internet. -Active technologies include ActiveX controls (formerly OLE controls) and Active documents; WinInet for easily retrieving and saving files across the Internet; and asynchronous monikers for efficient data downloading. Visual C++ provides wizards to help you get started quickly with a starter application. For an introduction to these technologies, see [MFC Internet Programming Basics](mfc-internet-programming-basics.md) and [MFC COM](mfc-com.md). +Active technologies include ActiveX controls (formerly OLE controls) and Active documents; WinInet for easily retrieving and saving files across the Internet; and asynchronous monikers for efficient data downloading. Visual Studio provides wizards to help you get started quickly with a starter application. For an introduction to these technologies, see [MFC Internet Programming Basics](mfc-internet-programming-basics.md) and [MFC COM](mfc-com.md). Have you always wanted to FTP a file but haven't learned WinSock and network programming protocols WinInet classes encapsulate these protocols, providing you with a simple set of functions you can use to write a client application on the Internet to download files using HTTP, FTP, and gopher. You can use WinInet to search directories on your hard drive or around the world. You can transparently collect data of several different types, and present it to the user in an integrated interface. diff --git a/docs/mfc/mfc-library-versions.md b/docs/mfc/mfc-library-versions.md index bafc3f49141..e266541499b 100644 --- a/docs/mfc/mfc-library-versions.md +++ b/docs/mfc/mfc-library-versions.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["class libraries [MFC], building versions", "version infor --- # MFC Library Versions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The MFC Library is available in versions that support ANSI single-byte and multibyte character set (MBCS) code, as well as versions that support Unicode (encoded as UTF-16LE, the Windows-native character set). Each MFC version is available as a static library or as a shared DLL. There is also a smaller MFC static library version that leaves out MFC controls for dialogs, for applications that are very sensitive to size and don't need those controls. The MFC libraries are available in both debug and release versions for supported architectures that include x86, x64, and ARM processors. You can create both applications (.exe files) and DLLs with any version of the MFC libraries. There is also a set of MFC libraries compiled for interfacing with managed code. The MFC shared DLLs include a version number to indicate library binary compatibility. ## Automatic linking of MFC library versions @@ -100,7 +103,7 @@ Debugger files that have the same base name and a .pdb extension are also availa The MFC shared DLLs also follow a structured naming convention. This makes it easier to know which DLL or library you should be using for which purpose. -The MFC DLLs have *version* numbers that indicate binary compatibility. Use MFC DLLs that have the same version as your other libraries and compiler toolset to guarantee compatibility within a project. +The MFC DLLs have *version* numbers that indicate binary compatibility. Use MFC DLLs that have the same version as your other libraries and compiler build tools to guarantee compatibility within a project. |DLL|Description| |---------|-----------------| diff --git a/docs/mfc/mfc-mbcs-dll-add-on.md b/docs/mfc/mfc-mbcs-dll-add-on.md index 154e05d42f4..9a8b5621b3c 100644 --- a/docs/mfc/mfc-mbcs-dll-add-on.md +++ b/docs/mfc/mfc-mbcs-dll-add-on.md @@ -6,11 +6,14 @@ helpviewer_keywords: ["MBCS", "MFC"] --- # MFC MBCS DLL Add-on +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Support for MFC and its multibyte character set (MBCS) libraries requires an additional step during Visual Studio installation in Visual Studio 2013 and later. **Visual Studio 2013**: By default, the MFC libraries installed in Visual Studio 2013 only support Unicode development. You need the MBCS DLLs in order to build an MFC project in Visual Studio 2013 that has the **Character Set** property set to **Use Multi-Byte Character Set** or **Not Set**. Download the DLL at [Multibyte MFC Library for Visual Studio 2013](https://www.microsoft.com/download/details.aspx?id=40770). -**Visual Studio 2015**: Both Unicode and MBCS MFC DLLs are included in the Visual C++ setup components, but support for MFC is not installed by default. Visual C++ and MFC are optional install configurations in Visual Studio setup. To make sure that MFC is installed, choose **Custom** in setup, and under **Programming Languages**, make sure that **Visual C++** and **Microsoft Foundation Classes for C++** are selected. If you have already installed Visual Studio, you will be prompted to install Visual C++ and/or MFC when you attempt to create an MFC project. +**Visual Studio 2015**: Both Unicode and MBCS MFC DLLs are included in the Visual C++ setup components, but support for MFC is not installed by default. Visual C++ and MFC are optional install configurations in Visual Studio setup. To make sure that MFC is installed, choose **Custom** in setup, and under **Programming Languages**, make sure that **Visual C++** and ****Microsoft Foundation Classes for C++** are selected. If you have already installed Visual Studio, you will be prompted to install Visual C++ and/or MFC when you attempt to create an MFC project. **Visual Studio 2017 and later**: The Unicode and MBCS MFC DLLs are installed with the **Desktop development with C++** workload when you select **MFC and ATL support** from the **Optional Components** pane in the Visual Studio Installer program. If your installation does not include these components, navigate to the **File | New Projects** dialog and click the **Open Visual Studio Installer** link. For more information, see [Install Visual Studio](/visualstudio/install/install-visual-studio). diff --git a/docs/mfc/mfc-technical-notes.md b/docs/mfc/mfc-technical-notes.md index f11bc35414a..57d42e99c87 100644 --- a/docs/mfc/mfc-technical-notes.md +++ b/docs/mfc/mfc-technical-notes.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC Technical Notes" title: "MFC Technical Notes" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, technical notes", "technical notes, MFC", "technical notes [MFC]"] -ms.assetid: 8aa01d66-0b07-4d0a-a080-4bb00c7baaac --- # MFC Technical Notes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A technical note is a document written for programmers by programmers. Each technical note describes a problem or feature that is beyond the scope of the rest of the MFC documentation. The technical notes supplied reflect requests for information from users, as well as specialized information that the MFC developers anticipate advanced users will want. diff --git a/docs/mfc/mfc-toolbar-implementation.md b/docs/mfc/mfc-toolbar-implementation.md index 696dfdd3cd3..a97b5840b3c 100644 --- a/docs/mfc/mfc-toolbar-implementation.md +++ b/docs/mfc/mfc-toolbar-implementation.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC Toolbar Implementation" title: "MFC Toolbar Implementation" ms.date: "11/04/2016" helpviewer_keywords: ["toolbars [MFC], creating", "buttons [MFC], MFC toolbars", "toolbars [MFC], docking", "CToolBar class [MFC], creating toolbars", "MFC toolbars", "floating toolbars [MFC]", "toolbars [MFC], floating", "docking toolbars [MFC]", "bitmaps [MFC], toolbar", "toolbar controls [MFC]", "CToolBarCtrl class [MFC], implementing toolbars", "tool tips [MFC], enabling", "toolbars [MFC]", "toolbars [MFC], implementing MFC toolbars"] -ms.assetid: af3319ad-c430-4f90-8361-e6a2c06fd084 --- # MFC Toolbar Implementation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A toolbar is a [control bar](control-bars.md) that contains the bitmap images of controls. These images can behave like pushbuttons, check boxes, or radio buttons. MFC supplies class [CToolbar](reference/ctoolbar-class.md) to manage toolbars. If you enable it, users of MFC toolbars can dock them to the edge of a window or "float" them anywhere within the application window. MFC doesn't support customizable toolbars like those in the development environment. @@ -69,7 +71,7 @@ Also see the MFC General sample [DOCKTOOL](../overview/visual-cpp-samples.md). ## The Toolbar Bitmap -Once constructed, a `CToolBar` object creates the toolbar image by loading a single bitmap that contains one image for each button. The Application Wizard creates a standard toolbar bitmap that you can customize with the Visual C++ [toolbar editor](../windows/toolbar-editor.md). +Once constructed, a `CToolBar` object creates the toolbar image by loading a single bitmap that contains one image for each button. The Application Wizard creates a standard toolbar bitmap that you can customize with the Visual Studio [toolbar editor](../windows/toolbar-editor.md). ### What do you want to know more about diff --git a/docs/mfc/modal-and-modeless-dialog-boxes.md b/docs/mfc/modal-and-modeless-dialog-boxes.md index 018ff95a740..c939871ca9d 100644 --- a/docs/mfc/modal-and-modeless-dialog-boxes.md +++ b/docs/mfc/modal-and-modeless-dialog-boxes.md @@ -3,10 +3,12 @@ description: "Learn more about: Modal and Modeless Dialog Boxes" title: "Modal and Modeless Dialog Boxes" ms.date: "11/04/2016" helpviewer_keywords: ["MFC dialog boxes [MFC], modeless", "modeless dialog boxes [MFC]", "MFC dialog boxes [MFC], modal", "modal dialog boxes [MFC]"] -ms.assetid: e83df336-5994-4b8f-8233-7942f997315b --- # Modal and Modeless Dialog Boxes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can use class [CDialog](reference/cdialog-class.md) to manage two kinds of dialog boxes: - *Modal dialog boxes*, which require the user to respond before continuing the program diff --git a/docs/mfc/month-calendar-control-examples.md b/docs/mfc/month-calendar-control-examples.md index 3881ae480f1..8085cecad97 100644 --- a/docs/mfc/month-calendar-control-examples.md +++ b/docs/mfc/month-calendar-control-examples.md @@ -3,10 +3,12 @@ description: "Learn more about: Month Calendar Control Examples" title: "Month Calendar Control Examples" ms.date: "11/04/2016" helpviewer_keywords: ["month calendar controls [MFC], examples", "CMonthCalCtrl class [MFC], examples"] -ms.assetid: 1af7fb59-d6fd-46e0-aaa5-b0394a0a3ed5 --- # Month Calendar Control Examples +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [CMNCTRL1](../overview/visual-cpp-samples.md) sample application demonstrates the various attributes of the `CMonthCalCtrl` class. The control, found on a separate tab in the sample, demonstrates basic functionality and allows the user to dynamically modify certain attributes. ## See also diff --git a/docs/mfc/multipage-documents.md b/docs/mfc/multipage-documents.md index 664450ef076..4953a61ee3a 100644 --- a/docs/mfc/multipage-documents.md +++ b/docs/mfc/multipage-documents.md @@ -3,10 +3,12 @@ description: "Learn more about: Multipage Documents" title: "Multipage Documents" ms.date: "11/19/2018" helpviewer_keywords: ["pagination [MFC]", "overriding [MFC], View class functions for printing", "OnPrepareDC method [MFC]", "CPrintInfo structure [MFC], multipage documents", "OnEndPrinting method [MFC]", "protocols [MFC], printing protocol", "document pages vs. printer pages [MFC]", "printer mode [MFC]", "printing [MFC], multipage documents", "printers [MFC], printer mode", "documents [MFC], printing", "OnPreparePrinting method [MFC]", "OnPrint method [MFC]", "DoPreparePrinting method and pagination [MFC]", "OnDraw method [MFC], printing", "pagination [MFC], printing multipage documents", "printing [MFC], protocol", "pages [MFC], printing", "OnBeginPrinting method [MFC]", "multipage documents [MFC]", "printing [MFC], pagination", "documents [MFC], paginating"] -ms.assetid: 69626b86-73ac-4b74-b126-9955034835ef --- # Multipage Documents +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the Windows printing protocol and explains how to print documents that contain more than one page. The article covers the following topics: - [Printing protocol](#_core_the_printing_protocol) diff --git a/docs/mfc/multiple-document-types-views-and-frame-windows.md b/docs/mfc/multiple-document-types-views-and-frame-windows.md index f24bb3620a6..cb992a563d4 100644 --- a/docs/mfc/multiple-document-types-views-and-frame-windows.md +++ b/docs/mfc/multiple-document-types-views-and-frame-windows.md @@ -3,10 +3,12 @@ description: "Learn more about: Multiple Document Types, Views, and Frame Window title: "Multiple Document Types, Views, and Frame Windows" ms.date: "11/19/2018" helpviewer_keywords: ["static splitter windows [MFC]", "multiple views [MFC]", "multiple document types [MFC]", "multiple views [MFC], frame windows", "document classes [MFC], multiple", "documents [MFC], multiple types of", "splitter windows [MFC], dynamic", "dynamic splitter windows [MFC]", "windows [MFC], dynamic splitter", "windows [MFC], static splitter", "multiple frame windows [MFC]", "splitter windows [MFC], static"] -ms.assetid: c6b9e4e0-7c9c-45f1-a804-aeac39c9a128 --- # Multiple Document Types, Views, and Frame Windows +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The standard relationship among a document, its view, and its frame window is described in [Document/View Creation](document-view-creation.md). Many applications support a single document type (but possibly multiple open documents of that type) with a single view on the document and only one frame window per document. But some applications may need to alter one or more of those defaults. ## What do you want to know more about @@ -64,7 +66,7 @@ In a splitter window, the window is, or can be, split into two or more scrollabl Dynamic splitter windows, with views of the same class, allow the user to split a window into multiple panes at will and then scroll different panes to see different parts of the document. The user can also unsplit the window to remove the additional views. The splitter windows added to the [Scribble sample](../overview/visual-cpp-samples.md) are an example. That topic describes the technique for creating dynamic splitter windows. A dynamic splitter window is shown in part b of the figure Multiple-View User Interfaces. -Static splitter windows, with views of different classes, start with the window split into multiple panes, each with a different purpose. For example, in the Visual C++ bitmap editor, the image window shows two panes side by side. The left-hand pane displays a life-sized image of the bitmap. The right-hand pane displays a zoomed or magnified image of the same bitmap. The panes are separated by a "splitter bar" that the user can drag to change the relative sizes of the panes. A static splitter window is shown in part c of the figure Multiple-View User Interfaces. +Static splitter windows, with views of different classes, start with the window split into multiple panes, each with a different purpose. For example, in the Visual Studio bitmap editor, the image window shows two panes side by side. The left-hand pane displays a life-sized image of the bitmap. The right-hand pane displays a zoomed or magnified image of the same bitmap. The panes are separated by a "splitter bar" that the user can drag to change the relative sizes of the panes. A static splitter window is shown in part c of the figure Multiple-View User Interfaces. For more information, see class [CSplitterWnd](reference/csplitterwnd-class.md) in the *MFC Reference* and [MFC Samples](../overview/visual-cpp-samples.md#mfc-samples). diff --git a/docs/mfc/notifications-from-a-rich-edit-control.md b/docs/mfc/notifications-from-a-rich-edit-control.md index a7478300fc8..f5278d8e970 100644 --- a/docs/mfc/notifications-from-a-rich-edit-control.md +++ b/docs/mfc/notifications-from-a-rich-edit-control.md @@ -3,10 +3,12 @@ description: "Learn more about: Notifications from a Rich Edit Control" title: "Notifications from a Rich Edit Control" ms.date: "11/04/2016" helpviewer_keywords: ["messages [MFC], notification [MFC]", "CRichEditCtrl class [MFC], notifications", "rich edit controls [MFC], notifications", "notifications [MFC], from CRichEditCtrl"] -ms.assetid: eb5304fe-f4f3-4557-9ebf-3095dea383c4 --- # Notifications from a Rich Edit Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Notification messages report events affecting a rich edit control ([CRichEditCtrl](reference/cricheditctrl-class.md)). They can be processed by the parent window or, using message reflection, by the rich edit control itself. Rich edit controls support all of the notification messages used with edit controls as well as several additional ones. You can determine which notification messages a rich edit control sends its parent window by setting its "event mask." To set the event mask for a rich edit control, use the [SetEventMask](reference/cricheditctrl-class.md#seteventmask) member function. You can retrieve the current event mask for a rich edit control by using the [GetEventMask](reference/cricheditctrl-class.md#geteventmask) member function. diff --git a/docs/mfc/notifications-sent-by-animation-controls.md b/docs/mfc/notifications-sent-by-animation-controls.md index a6881465bd3..e900b18a8d9 100644 --- a/docs/mfc/notifications-sent-by-animation-controls.md +++ b/docs/mfc/notifications-sent-by-animation-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Notifications Sent by Animation Controls" title: "Notifications Sent by Animation Controls" ms.date: "11/04/2016" helpviewer_keywords: ["notifications [MFC], animation controls", "CAnimateCtrl class [MFC], notifications", "controls [MFC], animation", "animation controls [MFC], notifications"] -ms.assetid: 584f5824-446b-4a1a-85f7-ef61842c8186 --- # Notifications Sent by Animation Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An animation control ([CAnimateCtrl](reference/canimatectrl-class.md)) sends two different types of notification messages. The notifications are sent in the form of [WM_COMMAND](/windows/win32/menurc/wm-command) messages. The [ACN_START](/windows/win32/Controls/acn-start) message is sent when the animation control has started playing a clip. The [ACN_STOP](/windows/win32/Controls/acn-stop) message is sent when the animation control has finished or stopped playing a clip. diff --git a/docs/mfc/odbc-classes.md b/docs/mfc/odbc-classes.md index c2df2b212e5..d0a77096e4a 100644 --- a/docs/mfc/odbc-classes.md +++ b/docs/mfc/odbc-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: ODBC Classes" title: "ODBC Classes" ms.date: "11/04/2016" helpviewer_keywords: ["database classes [MFC], ODBC", "ODBC classes [MFC]"] -ms.assetid: 6c40fca8-3033-4873-9abe-7f51725de0e0 --- # ODBC Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes work with the other application framework classes to give easy access to a wide variety of databases for which Open Database Connectivity (ODBC) drivers are available. Programs that use ODBC databases will have at least a `CDatabase` object and a `CRecordset` object. diff --git a/docs/mfc/ole-automation-classes.md b/docs/mfc/ole-automation-classes.md index 7422cd998f9..e2d74d8d030 100644 --- a/docs/mfc/ole-automation-classes.md +++ b/docs/mfc/ole-automation-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE Automation Classes" title: "OLE Automation Classes" ms.date: "11/04/2016" helpviewer_keywords: ["Automation, classes", "Automation classes [MFC], OLE classes", "OLE Automation [MFC], classes", "Automation classes [MFC]", "OLE Automation [MFC]"] -ms.assetid: 96e5372b-ff8a-4da1-933b-4d9bbf4dceb3 --- # OLE Automation Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes support automation clients (applications that control other applications). Automation servers (applications that can be controlled by other applications) are supported through [dispatch maps](reference/dispatch-maps.md). [COleDispatchDriver](reference/coledispatchdriver-class.md)
diff --git a/docs/mfc/ole-background-containers-and-servers.md b/docs/mfc/ole-background-containers-and-servers.md index 298221f6c60..b9cc3c392e8 100644 --- a/docs/mfc/ole-background-containers-and-servers.md +++ b/docs/mfc/ole-background-containers-and-servers.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE Background: Containers and Servers" title: "OLE Background: Containers and Servers" ms.date: "11/04/2016" helpviewer_keywords: ["OLE full-server applications [MFC]", "server applications [MFC], communication with containers", "full-server [MFC]", "server applications [MFC], requirements", "server applications [MFC], defined", "OLE server applications [MFC], about server applications", "server applications [MFC], full-server vs. mini-server", "OLE server applications [MFC], mini-server applications", "OLE containers [MFC], container applications", "containers [MFC], OLE container applications", "server applications [MFC]"] -ms.assetid: dafbb31d-096c-4654-b774-12900d832919 --- # OLE Background: Containers and Servers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A container application is an application that can incorporate embedded or linked items into its own documents. The documents managed by a container application must be able to store and display OLE document components as well as the data created by the application itself. A container application must also allow users to insert new items or edit existing items by activating server applications when necessary. The user-interface requirements of a container application are listed in the article [Containers: User-Interface Issues](containers-user-interface-issues.md). A server application or component application is an application that can create OLE document components for use by container applications. Server applications usually support drag and drop or copying their data to the Clipboard so that a container application can insert the data as an embedded or linked item. An application can be both a container and a server. diff --git a/docs/mfc/ole-background-implementation-strategies.md b/docs/mfc/ole-background-implementation-strategies.md index e23b0f862da..57fe6adffab 100644 --- a/docs/mfc/ole-background-implementation-strategies.md +++ b/docs/mfc/ole-background-implementation-strategies.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE Background: Implementation Strategies" title: "OLE Background: Implementation Strategies" ms.date: "11/04/2016" helpviewer_keywords: ["OLE [MFC], development strategy", "OLE applications [MFC], implementing OLE", "applications [OLE], implementing OLE"] -ms.assetid: 0875ddae-99df-488c-82c6-164074a81058 --- # OLE Background: Implementation Strategies +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Depending on your application, there are four possible implementation strategies for adding OLE support: - You are writing a new application. diff --git a/docs/mfc/ole-background-linking-and-embedding.md b/docs/mfc/ole-background-linking-and-embedding.md index 78b8429ce8e..d39790a77ee 100644 --- a/docs/mfc/ole-background-linking-and-embedding.md +++ b/docs/mfc/ole-background-linking-and-embedding.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE Background: Linking and Embedding" title: "OLE Background: Linking and Embedding" ms.date: "11/04/2016" helpviewer_keywords: ["OLE embedded items [MFC]", "item types [MFC], defined", "item types [MFC]", "OLE [MFC], linked items", "linked items (OLE) [MFC]", "embedded objects [MFC]", "OLE items [MFC], types"] -ms.assetid: 11107711-eb96-4099-8f5c-7910bb3ecb75 --- # OLE Background: Linking and Embedding +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Using the Paste command in a container application can create an embedded component, or embedded item. The source data for an embedded item is stored as part of the OLE document that contains it. In this way, a document file for a word processor document can contain text and also can contain bitmaps, graphs, formulas, or any other type of data. OLE provides another way to incorporate data from another application: creating a linked component, or linked item, or a link. The steps for creating a linked item are similar to those for creating an embedded item, except that you use the Paste Link command instead of the Paste command. Unlike an embedded component, a linked component stores a path to the original data, which is often in a separate file. diff --git a/docs/mfc/ole-background-mfc-implementation.md b/docs/mfc/ole-background-mfc-implementation.md index 0076752ca40..5f1bce62a1e 100644 --- a/docs/mfc/ole-background-mfc-implementation.md +++ b/docs/mfc/ole-background-mfc-implementation.md @@ -4,10 +4,12 @@ title: "OLE Background: MFC Implementation" ms.date: "11/04/2016" f1_keywords: ["IMarshall", "IMoniker"] helpviewer_keywords: ["MFC libraries, implementing", "OLE MFC library implementation", "OLE IMarshal interface", "IMoniker interface, MFC", "IMarshall class [MFC]", "OLE, compound files", "OLE IMoniker interface", "OLE IUnknown"] -ms.assetid: 2b67016a-d78e-4d60-925f-c28ec8fb6180 --- # OLE Background: MFC Implementation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Because of the size and complexity of the raw OLE API, calling it directly to write OLE applications can be very time consuming. The goal of the Microsoft Foundation Class Library implementation of OLE is to reduce the amount of work you have to do to write full-featured, OLE-capable applications. This article explains the parts of the OLE API that have not been implemented inside MFC. The discussion also explains how what is implemented maps to the OLE section of the Windows SDK. diff --git a/docs/mfc/ole-background.md b/docs/mfc/ole-background.md index 2d89820a306..86be5ffa153 100644 --- a/docs/mfc/ole-background.md +++ b/docs/mfc/ole-background.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE Background" title: "OLE Background" ms.date: "11/04/2016" helpviewer_keywords: ["OLE, about OLE"] -ms.assetid: 5f654eb5-66b1-40c9-9215-bb85356a67f8 --- # OLE Background +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + OLE is a mechanism that allows users to create and edit documents containing items or "objects" created by multiple applications. > [!NOTE] diff --git a/docs/mfc/ole-classes.md b/docs/mfc/ole-classes.md index 78d380ba5cc..77233aff1ca 100644 --- a/docs/mfc/ole-classes.md +++ b/docs/mfc/ole-classes.md @@ -4,10 +4,12 @@ title: "OLE Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.ole"] helpviewer_keywords: ["ActiveX classes [MFC]", "classes [MFC], OLE", "OLE classes [MFC]", "OLE [MFC], classes"] -ms.assetid: 4c2b2bca-fafb-4d2d-8498-9ed1e04011d2 --- # OLE Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The OLE classes work with the other application framework classes to provide easy access to the ActiveX API, giving your programs an easy way to provide the power of ActiveX to your users. Using ActiveX, you can: - Create compound documents, which allow users to create and edit documents containing data created by multiple applications, including text, graphics, spreadsheets, sound, or other types of data. diff --git a/docs/mfc/ole-common-dialog-classes.md b/docs/mfc/ole-common-dialog-classes.md index 3c51dfb89b5..da438438f5b 100644 --- a/docs/mfc/ole-common-dialog-classes.md +++ b/docs/mfc/ole-common-dialog-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE Common Dialog Classes" title: "OLE Common Dialog Classes" ms.date: "11/04/2016" helpviewer_keywords: ["ActiveX classes [MFC]", "dialog classes [MFC], OLE", "OLE common dialog classes [MFC]", "common dialog classes [MFC]"] -ms.assetid: 706526ae-f94f-4909-a0f8-6b5fe954fd97 --- # OLE Common Dialog Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes handle common OLE tasks by implementing a number of standard OLE dialog boxes. They also provide a consistent user interface for OLE functionality. [COleDialog](reference/coledialog-class.md)
diff --git a/docs/mfc/ole-container-classes.md b/docs/mfc/ole-container-classes.md index 7a9ad84150c..f5186d11cf6 100644 --- a/docs/mfc/ole-container-classes.md +++ b/docs/mfc/ole-container-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE Container Classes" title: "OLE Container Classes" ms.date: "11/04/2016" helpviewer_keywords: ["ActiveX classes [MFC]", "container classes [MFC]", "OLE classes [MFC]", "visual editing [MFC], classes", "OLE [MFC], classes", "containers [MFC], OLE container applications"] -ms.assetid: 1e27e1ab-4c22-41eb-8547-6915c72668ae --- # OLE Container Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes are used by container applications. Both `COleLinkingDoc` and `COleDocument` manage collections of `COleClientItem` objects. Rather than deriving your document class from `CDocument`, you'll derive it from `COleLinkingDoc` or `COleDocument`, depending on whether you want support for links to objects embedded in your document. Use a `COleClientItem` object to represent each OLE item in your document that is embedded from another document or is a link to another document. diff --git a/docs/mfc/ole-control-classes.md b/docs/mfc/ole-control-classes.md index 3d29bc98e80..a527fc6d11b 100644 --- a/docs/mfc/ole-control-classes.md +++ b/docs/mfc/ole-control-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE Control Classes" title: "OLE Control Classes" ms.date: "11/04/2016" helpviewer_keywords: ["ActiveX classes [MFC]", "custom controls [MFC], classes", "ActiveX controls [MFC], OLE control classes", "ActiveX control classes [MFC]", "OLE controls [MFC], classes", "OLE control classes [MFC]", "reusable component classes [MFC]"] -ms.assetid: 96495ec3-319e-4163-b839-1af0428ed9dd --- # OLE Control Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These are the primary classes you use when writing OLE controls. The `COleControlModule` class in an OLE control module is like the [CWinApp](reference/cwinapp-class.md) class in an application. Each module implements one or more OLE controls; these controls are represented by `COleControl` objects. These controls communicate with their containers using `CConnectionPoint` objects. The `CPictureHolder` and `CFontHolder` classes encapsulate COM interfaces for pictures and fonts, while the `COlePropertyPage` and `CPropExchange` classes help you implement property pages and property persistence for your control. diff --git a/docs/mfc/ole-db-classes.md b/docs/mfc/ole-db-classes.md index 64191ae0fc7..03b1ec49670 100644 --- a/docs/mfc/ole-db-classes.md +++ b/docs/mfc/ole-db-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE DB Classes" title: "OLE DB Classes" ms.date: "11/04/2016" helpviewer_keywords: ["OLE DB consumers, support", "COleDBRecordView class [MFC]"] -ms.assetid: 65245d26-8743-4efd-9a72-90e19aef3c3a --- # OLE DB Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The OLE DB support in MFC currently consists of the class [COLEDBRecordView](reference/coledbrecordview-class.md). `COleDBRecordView` displays database records in controls, through a form view directly connected to a [CRowset](../data/oledb/crowset-class.md) object. For more information about the OLE DB consumer templates, see [List of OLE DB Consumer Templates](../data/oledb/ole-db-consumer-templates-reference.md). ## See also diff --git a/docs/mfc/ole-drag-and-drop-and-data-transfer-classes.md b/docs/mfc/ole-drag-and-drop-and-data-transfer-classes.md index ae1305da27a..ef61be8434f 100644 --- a/docs/mfc/ole-drag-and-drop-and-data-transfer-classes.md +++ b/docs/mfc/ole-drag-and-drop-and-data-transfer-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE Drag-and-Drop and Data Transfer Classes" title: "OLE Drag-and-Drop and Data Transfer Classes" ms.date: "11/04/2016" helpviewer_keywords: ["ActiveX classes [MFC]", "OLE drag and drop [MFC], and data transfer classes", "drag and drop [MFC], classes", "data transfer [MFC], OLE", "data transfer classes [MFC]"] -ms.assetid: c8ab2825-ed69-4b88-8ae6-f368b94726b8 --- # OLE Drag-and-Drop and Data Transfer Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes are used in OLE data transfers. They allow data to be transferred between applications by using the Clipboard or through drag and drop. [COleDropSource](reference/coledropsource-class.md)
diff --git a/docs/mfc/ole-in-mfc.md b/docs/mfc/ole-in-mfc.md index 537e4c14f83..d347fe7617b 100644 --- a/docs/mfc/ole-in-mfc.md +++ b/docs/mfc/ole-in-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE in MFC" title: "OLE in MFC" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, OLE and", "OLE items", "OLE applications [MFC], about OLE", "OLE [MFC]", "OLE containers [MFC], about OLE", "applications [OLE], about OLE", "OLE component object model (COM)"] -ms.assetid: 5193479d-1239-4697-aea4-e82f92c707ab --- # OLE in MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These articles explain the fundamentals of OLE programming using MFC. MFC provides the easiest way to write programs that use OLE: - To use OLE visual editing (in-place activation). diff --git a/docs/mfc/ole-mfc.md b/docs/mfc/ole-mfc.md index 263a4d2b59e..1eaa373f3dc 100644 --- a/docs/mfc/ole-mfc.md +++ b/docs/mfc/ole-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE (MFC)" title: "OLE (MFC)" ms.date: "11/04/2016" helpviewer_keywords: ["OLE [MFC], user-interface topics", "OLE applications [MFC], user interface", "user interfaces, OLE", "applications [OLE], user interface"] -ms.assetid: 61cb5d3e-1108-4e9b-b301-a8d8fcc586cb --- # OLE (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implementing OLE functionality in your program affects your user interface in several ways: - Visual editing (in-place activation) displays the user interface of another program in your program's windows and modifies your program's menus with items from the other program. diff --git a/docs/mfc/ole-related-classes.md b/docs/mfc/ole-related-classes.md index d8b67b66a5e..e2cd7c17f1c 100644 --- a/docs/mfc/ole-related-classes.md +++ b/docs/mfc/ole-related-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE-Related Classes" title: "OLE-Related Classes" ms.date: "11/04/2016" helpviewer_keywords: ["ActiveX classes [MFC]", "OLE classes [MFC]", "OLE [MFC], classes"] -ms.assetid: 2135cf54-1d9d-4e0e-91b4-943b3440effa --- # OLE-Related Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes provide a number of different services, ranging from exceptions to file input and output. [COleObjectFactory](reference/coleobjectfactory-class.md)
diff --git a/docs/mfc/ole-server-classes.md b/docs/mfc/ole-server-classes.md index bb867adb855..01e1a9e5862 100644 --- a/docs/mfc/ole-server-classes.md +++ b/docs/mfc/ole-server-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: OLE Server Classes" title: "OLE Server Classes" ms.date: "11/04/2016" helpviewer_keywords: ["OLE server applications [MFC], server classes", "OLE server documents", "COM components, classes [MFC]", "component classes [MFC]"] -ms.assetid: 8e9b67a2-c0ff-479c-a8d6-19b36c5e6fc6 --- # OLE Server Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes are used by server applications. Server documents are derived from `COleServerDoc` rather than from `CDocument`. Note that because `COleServerDoc` is derived from `COleLinkingDoc`, server documents can also be containers that support linking. The `COleServerItem` class represents a document or portion of a document that can be embedded in another document or linked to. diff --git a/docs/mfc/on-update-command-ui-macro.md b/docs/mfc/on-update-command-ui-macro.md index 12493f28551..0bc1fcfc69f 100644 --- a/docs/mfc/on-update-command-ui-macro.md +++ b/docs/mfc/on-update-command-ui-macro.md @@ -4,11 +4,13 @@ title: "ON_UPDATE_COMMAND_UI Macro" ms.date: "09/06/2019" f1_keywords: ["ON_UPDATE_COMMAND_UI"] helpviewer_keywords: ["ON_UPDATE_COMMAND_UI macro [MFC]", "update handlers [MFC]", "command-handler macros", "updating user-interface objects [MFC]"] -ms.assetid: 3e72b50f-4119-4c82-81cf-6e09b132de05 ms.topic: reference --- # ON_UPDATE_COMMAND_UI Macro +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To connect a user-interface object to a command-update handler in a command-target object, open **Class View**, then right-click on the class to which the handler will be added, and choose **Class Wizard**. Find the user-interface object's ID in the list on the left, then choose **UPDATE_COMMAND_UI** in the right pane and click **Add Handler**. This creates a handler function in the class and adds the appropriate entry in the message map. See [Mapping Messages to Functions](reference/mapping-messages-to-functions.md) for more information. You can specify additional messages to handle in the **Messages** pane. For example, to update a Clear All command in your program's Edit menu, use the **Class Wizard** to add a message-map entry in the selected class, a function declaration for a command-update handler called `OnUpdateEditClearAll` in the class declaration, and an empty function template in the class's implementation file. The function prototype looks like this: diff --git a/docs/mfc/oncmdmsg-handler.md b/docs/mfc/oncmdmsg-handler.md index 86b362ec27e..b40687263d1 100644 --- a/docs/mfc/oncmdmsg-handler.md +++ b/docs/mfc/oncmdmsg-handler.md @@ -4,10 +4,12 @@ title: "OnCmdMsg Handler" ms.date: "11/04/2016" f1_keywords: ["OnCmdMsg"] helpviewer_keywords: ["messages, routing", "handlers [MFC]", "command routing [MFC], OnCmdMsg handler", "handlers, OnCmdMessage [MFC]", "OnCmdMessage method [MFC]"] -ms.assetid: 8df07024-506f-47e7-bba9-1c3bc5ad8ab6 --- # OnCmdMsg Handler +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To accomplish the routing of commands, each command target calls the `OnCmdMsg` member function of the next command target in the sequence. Command targets use `OnCmdMsg` to determine whether they can handle a command and to route it to another command target if they cannot handle it. Each command-target class may override the `OnCmdMsg` member function. The overrides let each class route commands to a particular next target. A frame window, for example, always routes commands to its current child window or view, as shown in the table [Standard Command Route](command-routing.md). diff --git a/docs/mfc/one-stage-and-two-stage-construction-of-objects.md b/docs/mfc/one-stage-and-two-stage-construction-of-objects.md index 7afd60556d4..b1b0ad5b6dd 100644 --- a/docs/mfc/one-stage-and-two-stage-construction-of-objects.md +++ b/docs/mfc/one-stage-and-two-stage-construction-of-objects.md @@ -3,10 +3,12 @@ description: "Learn more about: One-Stage and Two-Stage Construction of Objects" title: "One-Stage and Two-Stage Construction of Objects" ms.date: "11/04/2016" helpviewer_keywords: ["objects [MFC], creating graphic objects", "object creation [MFC], graphic objects", "objects [MFC], graphic objects", "one-stage and two-stage construction of objects [MFC]"] -ms.assetid: 5a1c410c-4a4b-4dd9-a2ec-ced831aa7f21 --- # One-Stage and Two-Stage Construction of Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You have a choice between two techniques for creating graphic objects, such as pens and brushes: - *One-stage construction*: Construct and initialize the object in one stage, all with the constructor. diff --git a/docs/mfc/onidle-member-function.md b/docs/mfc/onidle-member-function.md index 2c69006b57c..8f81ef6c73a 100644 --- a/docs/mfc/onidle-member-function.md +++ b/docs/mfc/onidle-member-function.md @@ -4,10 +4,12 @@ title: "OnIdle Member Function" ms.date: "11/19/2018" f1_keywords: ["OnIdle"] helpviewer_keywords: ["processing messages [MFC]", "OnIdle method [MFC]", "idle loop processing [MFC]", "CWinApp class [MFC], OnIdle method [MFC]", "message handling [MFC], OnIdle method [MFC]"] -ms.assetid: 51adc874-0075-4f76-be1c-79283f46c10b --- # OnIdle Member Function +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When no Windows messages are being processed, the framework calls the [CWinApp](reference/cwinapp-class.md) member function [OnIdle](reference/cwinapp-class.md#onidle) (described in the MFC Library Reference). Override `OnIdle` to perform background tasks. The default version updates the state of user-interface objects such as toolbar buttons and performs cleanup of temporary objects created by the framework in the course of its operations. The following figure illustrates how the message loop calls `OnIdle` when there are no messages in the queue. diff --git a/docs/mfc/opening-files.md b/docs/mfc/opening-files.md index 1901d6e2ee4..364e80e69c4 100644 --- a/docs/mfc/opening-files.md +++ b/docs/mfc/opening-files.md @@ -3,11 +3,13 @@ description: "Learn more about: Opening Files" title: "Opening Files" ms.date: "11/04/2016" helpviewer_keywords: ["Open member functions [MFC]", "CFile class [MFC], variable", "opening files, in MFC", "Open calls [MFC]", "Open method, CFile class [MFC]", "examples [MFC], opening files", "opening files, handling exceptions", "exception handling [MFC], when opening files", "files [MFC], opening", "file objects [MFC]", "MFC, file operations", "opening files [MFC]", "exception handling [MFC], opening files"] -ms.assetid: a991b8ec-b04a-4766-b47e-7485b5dd0b01 ms.topic: how-to --- # Opening Files +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In MFC, the most common way to open a file is a two-stage process. #### To open a file diff --git a/docs/mfc/optimizing-control-drawing.md b/docs/mfc/optimizing-control-drawing.md index f66c88ff25b..0ed7b644291 100644 --- a/docs/mfc/optimizing-control-drawing.md +++ b/docs/mfc/optimizing-control-drawing.md @@ -3,11 +3,13 @@ description: "Learn more about: Optimizing Control Drawing" title: "Optimizing Control Drawing" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], optimizing"] -ms.assetid: 29ff985d-9bf5-4678-b62d-aad12def75fb ms.topic: concept-article --- # Optimizing Control Drawing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When a control is instructed to draw itself into a container-supplied device context, it typically selects GDI objects (such as pens, brushes, and fonts) into the device context, performs its drawing operations, and restores the previous GDI objects. If the container has multiple controls that are to be drawn into the same device context, and each control selects the GDI objects it requires, time can be saved if the controls do not individually restore previously selected objects. After all the controls have been drawn, the container can automatically restore the original objects. To detect whether a container supports this technique, a control can call the [COleControl::IsOptimizedDraw](reference/colecontrol-class.md#isoptimizeddraw) member function. If this function returns **TRUE**, the control can skip the normal step of restoring the previously selected objects. diff --git a/docs/mfc/optimizing-persistence-and-initialization.md b/docs/mfc/optimizing-persistence-and-initialization.md index 6fa231bfd5b..88bfbbbf03a 100644 --- a/docs/mfc/optimizing-persistence-and-initialization.md +++ b/docs/mfc/optimizing-persistence-and-initialization.md @@ -3,11 +3,13 @@ description: "Learn more about: Optimizing Persistence and Initialization" title: "Optimizing Persistence and Initialization" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], optimizing", "performance, ActiveX controls", "optimization, ActiveX controls", "optimizing performance, ActiveX controls"] -ms.assetid: e821e19e-b9eb-49ab-b719-0743420ba80b ms.topic: concept-article --- # Optimizing Persistence and Initialization +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + By default, persistence and initialization in a control are handled by the `DoPropExchange` member function. In a typical control, this function contains calls to several **PX_** functions (`PX_Color`, `PX_Font`, and so on), one for each property. This approach has the advantage that a single `DoPropExchange` implementation can be used for initialization, for persistence in binary format, and for persistence in the so-called "property-bag" format used by some containers. This one function provides all information about the properties and their default values in one convenient place. diff --git a/docs/mfc/orchestrating-other-window-actions.md b/docs/mfc/orchestrating-other-window-actions.md index d58e98acd28..0f909d0693e 100644 --- a/docs/mfc/orchestrating-other-window-actions.md +++ b/docs/mfc/orchestrating-other-window-actions.md @@ -3,11 +3,13 @@ description: "Learn more about: Orchestrating Other Window Actions" title: "Orchestrating Other Window Actions" ms.date: "11/04/2016" helpviewer_keywords: ["frame windows [MFC], print preview", "context-sensitive Help [MFC], frame windows", "print preview [MFC], and frame windows", "frame windows [MFC], context-sensitive Help", "frame windows [MFC], semimodal states", "context-sensitive Help [MFC]"] -ms.assetid: 5f34eea8-2bf8-4479-95c7-45e8f443db8f ms.topic: concept-article --- # Orchestrating Other Window Actions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The frame window orchestrates semimodal states such as context-sensitive help and print preview. For a description of the frame window's role in print preview, see [Printing and Print Preview](printing-and-print-preview.md). ## See also diff --git a/docs/mfc/ordering-items-in-the-header-control.md b/docs/mfc/ordering-items-in-the-header-control.md index 8fecf83fd9a..e17ef17634e 100644 --- a/docs/mfc/ordering-items-in-the-header-control.md +++ b/docs/mfc/ordering-items-in-the-header-control.md @@ -4,11 +4,13 @@ title: "Ordering Items in the Header Control" ms.date: "11/04/2016" f1_keywords: ["DS_DRAGDROP"] helpviewer_keywords: ["sequence [MFC]", "sequence [MFC], header control items", "OrderToIndex method [MFC]", "DS_DRAGDROP notification [MFC]", "GetOrderArray method [MFC]", "SetOrderArray method [MFC]", "header controls [MFC], ordering items"] -ms.assetid: 5aaef872-75b5-49c5-8fed-6f9a81fca812 ms.topic: concept-article --- # Ordering Items in the Header Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Once you've [added items to a header control](adding-items-to-the-header-control.md), you can manipulate or get information about their order with the following functions: - [CHeaderCtrl::GetOrderArray](reference/cheaderctrl-class.md#getorderarray) and [CHeaderCtrl::SetOrderArray](reference/cheaderctrl-class.md#setorderarray) diff --git a/docs/mfc/output-device-context-classes.md b/docs/mfc/output-device-context-classes.md index cdfed637a81..78ed227889d 100644 --- a/docs/mfc/output-device-context-classes.md +++ b/docs/mfc/output-device-context-classes.md @@ -4,10 +4,12 @@ title: "Output (Device Context) Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.output"] helpviewer_keywords: ["device contexts [MFC], classes", "screen output classes [MFC]", "printing classes [MFC]", "window drawing classes [MFC]", "painting classes [MFC]", "output classes [MFC]"] -ms.assetid: 35fd6435-a38e-42c6-a3fa-cd6f39370fc3 --- # Output (Device Context) Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These classes encapsulate the different types of device contexts available in Windows. Most of the following classes encapsulate a handle to a Windows device context. A device context is a Windows object that contains information about the drawing attributes of a device such as a display or a printer. All drawing calls are made through a device-context object. Additional classes derived from `CDC` encapsulate specialized device-context functionality, including support for Windows metafiles. diff --git a/docs/mfc/overridable-cwinapp-member-functions.md b/docs/mfc/overridable-cwinapp-member-functions.md index 9036701c9f0..fd923a07aac 100644 --- a/docs/mfc/overridable-cwinapp-member-functions.md +++ b/docs/mfc/overridable-cwinapp-member-functions.md @@ -3,10 +3,12 @@ description: "Learn more about: Overridable CWinApp Member Functions" title: "Overridable CWinApp Member Functions" ms.date: "11/04/2016" helpviewer_keywords: ["overriding [MFC], overridable functions in CWinApp", "application class [MFC]", "CWinApp class [MFC], overridables"] -ms.assetid: 07183d5e-734b-45d9-a8b6-9dde4adac0b4 --- # Overridable CWinApp Member Functions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + [CWinApp](reference/cwinapp-class.md) provides several key overridable member functions (`CWinApp` overrides these members from class [CWinThread](reference/cwinthread-class.md), from which `CWinApp` derives): - [InitInstance](initinstance-member-function.md) diff --git a/docs/mfc/overriding-the-standard-command-routing.md b/docs/mfc/overriding-the-standard-command-routing.md index ba18313793a..f813b8218cc 100644 --- a/docs/mfc/overriding-the-standard-command-routing.md +++ b/docs/mfc/overriding-the-standard-command-routing.md @@ -3,11 +3,13 @@ description: "Learn more about: Overriding the Standard Command Routing" title: "Overriding the Standard Command Routing" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, command routing", "command routing [MFC], overriding", "command handling [MFC], routing commands", "overriding, standard command routing"] -ms.assetid: 872b698a-7432-40c4-9008-68721e8effa5 ms.topic: concept-article --- # Overriding the Standard Command Routing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In rare cases when you must implement some variation of the standard framework routing, you can override it. The idea is to change the routing in one or more classes by overriding `OnCmdMsg` in those classes. Do so: - In the class that breaks the order to pass to a nondefault object. diff --git a/docs/mfc/overview-of-the-rich-edit-control.md b/docs/mfc/overview-of-the-rich-edit-control.md index ae897f634ab..dd13c02671d 100644 --- a/docs/mfc/overview-of-the-rich-edit-control.md +++ b/docs/mfc/overview-of-the-rich-edit-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Overview of the Rich Edit Control" title: "Overview of the Rich Edit Control" ms.date: "11/04/2016" helpviewer_keywords: ["rich edit controls [MFC]"] -ms.assetid: ad589b9f-a3fd-4820-bf1f-6b1965997e68 ms.topic: concept-article --- # Overview of the Rich Edit Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!IMPORTANT] > If you are using a rich edit control in a dialog box (regardless of whether your application is SDI, MDI, or dialog-based), you must call [AfxInitRichEdit](reference/application-information-and-management.md#afxinitrichedit) once before the dialog box is displayed. A typical place to call this function is in your program's `InitInstance` member function. You do not need to call it for each time you display the dialog box, only the first time. You do not have to call `AfxInitRichEdit` if you are working with `CRichEditView`. diff --git a/docs/mfc/paragraph-formatting-in-rich-edit-controls.md b/docs/mfc/paragraph-formatting-in-rich-edit-controls.md index bf891d8c81d..6d186474a34 100644 --- a/docs/mfc/paragraph-formatting-in-rich-edit-controls.md +++ b/docs/mfc/paragraph-formatting-in-rich-edit-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Paragraph Formatting in Rich Edit Controls" title: "Paragraph Formatting in Rich Edit Controls" ms.date: "11/04/2016" helpviewer_keywords: ["rich edit controls [MFC], paragraph formatting in", "paragraph formatting in CRichEditCtrl [MFC]", "CRichEditCtrl class [MFC], paragraph formatting in", "formatting [MFC], paragraphs"] -ms.assetid: 0df2e4c9-2074-4e41-b913-87cb8c1b4d43 --- # Paragraph Formatting in Rich Edit Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can use member functions of the rich edit control ([CRichEditCtrl](reference/cricheditctrl-class.md)) to format paragraphs and to retrieve formatting information. Paragraph formatting attributes include alignment, tabs, indents, and numbering. You can apply paragraph formatting by using the [SetParaFormat](reference/cricheditctrl-class.md#setparaformat) member function. To determine the current paragraph formatting for the selected text, use the [GetParaFormat](reference/cricheditctrl-class.md#getparaformat) member function. The [PARAFORMAT](/windows/win32/api/richedit/ns-richedit-paraformat) structure is used with these member functions to specify paragraph attributes. One of the important members of **PARAFORMAT** is *dwMask*. In `SetParaFormat`, *dwMask* specifies which paragraph attributes will be set by this function call. `GetParaFormat` reports the attributes of the first paragraph in the selection; *dwMask* specifies the attributes that are consistent throughout the selection. diff --git a/docs/mfc/prerequisites-for-internet-client-classes.md b/docs/mfc/prerequisites-for-internet-client-classes.md index 3cc4b6bc083..2f7a948b5b5 100644 --- a/docs/mfc/prerequisites-for-internet-client-classes.md +++ b/docs/mfc/prerequisites-for-internet-client-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Prerequisites for Internet Client Classes" title: "Prerequisites for Internet Client Classes" ms.date: "11/04/2016" helpviewer_keywords: ["Internet files [MFC], writing to", "Internet [MFC], connections", "FTP (File Transfer Protocol), MFC classes", "Gopher prerequisites [MFC]", "files [MFC], writing to", "classes [MFC], connections", "HTTP [MFC], prerequisites for Internet clients", "connections [MFC], classes for", "Internet client class prerequisites [MFC]", "files [MFC], reading", "URLs [MFC], Internet client applications", "prerequisites, Internet client classes [MFC]", "Gopher client applications [MFC]"] -ms.assetid: c51d1dfe-260c-4228-8100-e4efd90e9599 --- # Prerequisites for Internet Client Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Some actions taken by an Internet client (reading a file, for example) have prerequisite actions (in this case, establishing an Internet connection). The following tables list the prerequisites for some client actions. ### General Internet URL (FTP, Gopher, or HTTP) diff --git a/docs/mfc/print-preview-architecture.md b/docs/mfc/print-preview-architecture.md index 4ec11761f33..a47454457b8 100644 --- a/docs/mfc/print-preview-architecture.md +++ b/docs/mfc/print-preview-architecture.md @@ -3,10 +3,12 @@ description: "Learn more about: Print Preview Architecture" title: "Print Preview Architecture" ms.date: "11/04/2016" helpviewer_keywords: ["print preview [MFC], process", "previewing printing", "print preview [MFC], architecture", "printing [MFC], print preview", "print preview [MFC], modifications to MFC"] -ms.assetid: 0efc87e6-ff8d-43c5-9d72-9b729a169115 --- # Print Preview Architecture +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how the MFC framework implements print preview functionality. Topics covered include: - [Print preview process](#_core_the_print_preview_process) diff --git a/docs/mfc/printing-and-print-preview.md b/docs/mfc/printing-and-print-preview.md index b2ca6172204..fab2bc436e3 100644 --- a/docs/mfc/printing-and-print-preview.md +++ b/docs/mfc/printing-and-print-preview.md @@ -3,11 +3,13 @@ description: "Learn more about: Printing and Print Preview" title: "Printing and Print Preview" ms.date: "11/04/2016" helpviewer_keywords: ["printing [MFC]", "previewing printing", "printing [MFC]", "print preview", "printing [MFC], print preview"] -ms.assetid: d15059cd-32de-4450-95f7-e73aece238f6 ms.topic: concept-article --- # Printing and Print Preview +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC supports printing and print preview for your program's documents via class [CView](reference/cview-class.md). For basic printing and print preview, simply override your view class's [OnDraw](reference/cview-class.md#ondraw) member function, which you must do anyway. That function can draw to the view on the screen, to a printer device context for an actual printer, or to a device context that simulates your printer on the screen. You can also add code to manage multipage document printing and preview, to paginate your printed documents, and to add headers and footers to them. diff --git a/docs/mfc/printing-in-rich-edit-controls.md b/docs/mfc/printing-in-rich-edit-controls.md index b984736a3ff..f75b3796583 100644 --- a/docs/mfc/printing-in-rich-edit-controls.md +++ b/docs/mfc/printing-in-rich-edit-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Printing in Rich Edit Controls" title: "Printing in Rich Edit Controls" ms.date: "11/04/2016" helpviewer_keywords: ["printing [MFC], CRichEditCtrl", "rich edit controls [MFC], printing", "CRichEditCtrl class [MFC], printing"] -ms.assetid: dbda0e40-018f-424e-b5d8-7b489aaf27af ms.topic: concept-article --- # Printing in Rich Edit Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can tell a rich edit control ([CRichEditCtrl](reference/cricheditctrl-class.md)) to render its output for a specified device, such as a printer. You can also specify the output device for which a rich edit control formats its text. To format part of the contents of a rich edit control for a specific device, you can use the [FormatRange](reference/cricheditctrl-class.md#formatrange) member function. The [FORMATRANGE](/windows/win32/api/richedit/ns-richedit-formatrange) structure used with this function specifies the range of text to format as well as the device context (DC) for the target device. diff --git a/docs/mfc/printing.md b/docs/mfc/printing.md index 58d2fd9d619..9bb80b5f90e 100644 --- a/docs/mfc/printing.md +++ b/docs/mfc/printing.md @@ -3,11 +3,13 @@ description: "Learn more about: Printing" title: "Printing" ms.date: "11/04/2016" helpviewer_keywords: ["view classes [MFC], print operations", "documents [MFC], printing", "printing [MFC], from framework", "printing [MFC]"] -ms.assetid: be465e8d-b0c9-4fc5-9fa8-d10486064f76 ms.topic: concept-article --- # Printing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Microsoft Windows implements device-independent display. In MFC, this means that the same drawing calls, in the `OnDraw` member function of your view class, are responsible for drawing on the display and on other devices, such as printers. For print preview, the target device is a simulated printer output to the display. ## Your Role in Printing vs. the Framework's Role diff --git a/docs/mfc/processing-header-control-notifications.md b/docs/mfc/processing-header-control-notifications.md index 0c3aa456c2d..8fef663e015 100644 --- a/docs/mfc/processing-header-control-notifications.md +++ b/docs/mfc/processing-header-control-notifications.md @@ -3,11 +3,13 @@ description: "Learn more about: Processing Header-Control Notifications" title: "Processing Header-Control Notifications" ms.date: "11/04/2016" helpviewer_keywords: ["CHeaderCtrl class [MFC], processing notifications", "controls [MFC], header", "notifications [MFC], processing for CHeaderCtrl", "header controls [MFC], processing notifications", "header control notifications"] -ms.assetid: e6c6af7c-d458-4d33-85aa-48014ccde5f6 ms.topic: concept-article --- # Processing Header-Control Notifications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In your view or dialog class, use the [Class Wizard](reference/mfc-class-wizard.md) to create an [OnChildNotify](reference/cwnd-class.md#onchildnotify) handler function with a switch statement for any header-control ([CHeaderCtrl](reference/cheaderctrl-class.md)) notification messages you want to handle (see [Mapping Messages to Functions](reference/mapping-messages-to-functions.md)). Notifications are sent to the parent window when the user clicks or double-clicks a header item, drags a divider between items, and so on. The notification messages associated with a header control are listed in [Header Control Reference](/windows/win32/controls/header-control-reference) in the Windows SDK. diff --git a/docs/mfc/processing-notification-messages-in-a-rebar-control.md b/docs/mfc/processing-notification-messages-in-a-rebar-control.md index d4b1a732bd9..cd4bf9f3832 100644 --- a/docs/mfc/processing-notification-messages-in-a-rebar-control.md +++ b/docs/mfc/processing-notification-messages-in-a-rebar-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Processing Notification Messages in a Rebar Cont title: "Processing Notification Messages in a Rebar Control" ms.date: "11/04/2016" helpviewer_keywords: ["RBN_ notification messages, description of", "CReBarCtrl class [MFC], notification messages sent by", "RBN_ notification messages [MFC]", "notifications [MFC], CReBarCtrl"] -ms.assetid: 40f43a60-0c18-4d8d-8fab-213a095624f9 ms.topic: concept-article --- # Processing Notification Messages in a Rebar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In the parent class of the rebar control, create an `OnChildNotify` handler function with a switch statement for any rebar-control (`CReBarCtrl`) notification messages you want to handle. Notifications are sent to the parent window when the user drags objects over the rebar control, changes the layout of the rebar bands, deletes bands from the rebar control, and so on. The following notification messages can be sent by the rebar control object: diff --git a/docs/mfc/processing-notification-messages-in-date-and-time-picker-controls.md b/docs/mfc/processing-notification-messages-in-date-and-time-picker-controls.md index e8d46f354f6..52eadf5e783 100644 --- a/docs/mfc/processing-notification-messages-in-date-and-time-picker-controls.md +++ b/docs/mfc/processing-notification-messages-in-date-and-time-picker-controls.md @@ -4,11 +4,13 @@ title: "Processing Notification Messages in Date and Time Picker Controls" ms.date: "11/04/2016" f1_keywords: ["DTN_CLOSEUP", "DTN_DATETIMECHANGE", "DTN_DROPDOWN"] helpviewer_keywords: ["DTN_DROPDOWN notification [MFC]", "DTN_DATETIMECHANGE notification [MFC]", "DTN_CLOSEUP notification [MFC]", "DateTimePicker control [MFC], handling notifications", "CDateTimeCtrl class [MFC], handling notifications", "DTN_FORMAT notification [MFC]", "DateTimePicker control [MFC]"] -ms.assetid: ffbe29ab-ff80-4609-89f7-260b404439c4 ms.topic: concept-article --- # Processing Notification Messages in Date and Time Picker Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As users interact with the date and time picker control, the control (`CDateTimeCtrl`) sends notification messages to its parent window, usually a view or dialog object. Handle these messages if you want to do something in response. For example, when the user opens the date and time picker to display the embedded month calendar control, the DTN_DROPDOWN notification is sent. Use the [Class Wizard](reference/mfc-class-wizard.md) to add notification handlers to the parent class for those messages you want to implement. diff --git a/docs/mfc/processing-notification-messages-in-extended-combo-box-controls.md b/docs/mfc/processing-notification-messages-in-extended-combo-box-controls.md index 17f7c1247f2..6f0782a1f0f 100644 --- a/docs/mfc/processing-notification-messages-in-extended-combo-box-controls.md +++ b/docs/mfc/processing-notification-messages-in-extended-combo-box-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Processing Notification Messages in Extended Com title: "Processing Notification Messages in Extended Combo Box Controls" ms.date: "11/04/2016" helpviewer_keywords: ["extended combo boxes [MFC], notifications", "notifications [MFC], extended combo box controls"] -ms.assetid: 4e442758-d054-4746-bb1a-6ff84accb127 ms.topic: concept-article --- # Processing Notification Messages in Extended Combo Box Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As users interact with the extended combo box, the control (`CComboBoxEx`) sends notification messages to its parent window, usually a view or dialog object. Handle these messages if you want to do something in response. For example, when the user activates the drop-down list or clicks in the control's edit box, the CBEN_BEGINEDIT notification is sent. Use the [Class Wizard](reference/mfc-class-wizard.md) to add notification handlers to the parent class for those messages you want to implement. diff --git a/docs/mfc/processing-notification-messages-in-list-controls.md b/docs/mfc/processing-notification-messages-in-list-controls.md index 9381aeaa0e5..5b96ff8b84d 100644 --- a/docs/mfc/processing-notification-messages-in-list-controls.md +++ b/docs/mfc/processing-notification-messages-in-list-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Processing Notification Messages in List Control title: "Processing Notification Messages in List Controls" ms.date: "11/04/2016" helpviewer_keywords: ["processing notifications [MFC]", "CListCtrl class [MFC], processing notifications"] -ms.assetid: 1f0e296e-d2a3-48fc-ae38-51d7fb096f51 ms.topic: concept-article --- # Processing Notification Messages in List Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As users click column headers, drag icons, edit labels, and so on, the list control ([CListCtrl](../mfc/reference/clistctrl-class.md)) sends notification messages to its parent window. Handle these messages if you want to do something in response. For example, when the user clicks a column header, you might want to sort the items based on the contents of the clicked column, as in Microsoft Outlook. Process WM_NOTIFY messages from the list control in your view or dialog class. Use the [Class Wizard](reference/mfc-class-wizard.md) to create an [OnChildNotify](../mfc/reference/cwnd-class.md#onchildnotify) handler function with a switch statement based on which notification message is being handled. diff --git a/docs/mfc/processing-notification-messages-in-month-calendar-controls.md b/docs/mfc/processing-notification-messages-in-month-calendar-controls.md index 7f2c355b6a3..56632401488 100644 --- a/docs/mfc/processing-notification-messages-in-month-calendar-controls.md +++ b/docs/mfc/processing-notification-messages-in-month-calendar-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Processing Notification Messages in Month Calend title: "Processing Notification Messages in Month Calendar Controls" ms.date: "11/04/2016" helpviewer_keywords: ["CMonthCalCtrl class [MFC], notifications", "CMonthCalCtrl class [MFC], day states", "month calendar controls [MFC], notification messages", "notifications [MFC], for CMonthCalCtrl", "notifications [MFC], month calendar control"] -ms.assetid: 607c3e90-0756-493b-9503-ce835a50c7ab ms.topic: concept-article --- # Processing Notification Messages in Month Calendar Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As users interact with the month calendar control (selecting dates and/or viewing a different month), the control (`CMonthCalCtrl`) sends notification messages to its parent window, usually a view or dialog object. Handle these messages if you want to do something in response. For example, when the user selects a new month to view, you could provide a set of dates that should be emphasized. Use the [Class Wizard](reference/mfc-class-wizard.md) to add notification handlers to the parent class for those messages you want to implement. diff --git a/docs/mfc/processing-tab-control-notification-messages.md b/docs/mfc/processing-tab-control-notification-messages.md index 04bb96866dd..55e2b15e573 100644 --- a/docs/mfc/processing-tab-control-notification-messages.md +++ b/docs/mfc/processing-tab-control-notification-messages.md @@ -3,11 +3,13 @@ description: "Learn more about: Processing Tab Control Notification Messages" title: "Processing Tab Control Notification Messages" ms.date: "11/04/2016" helpviewer_keywords: ["notifications [MFC], tab controls", "CTabCtrl class [MFC], processing notifications", "notifications [MFC], processing in CTabCtrl", "processing notifications [MFC]", "tab controls [MFC], processing notifications"] -ms.assetid: 758ccb7a-9e73-48f8-9073-23f7cb09918c ms.topic: concept-article --- # Processing Tab Control Notification Messages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As users click tabs or buttons, the tab control ([CTabCtrl](../mfc/reference/ctabctrl-class.md)) sends notification messages to its parent window. Handle these messages if you want to do something in response. For example, when the user clicks a tab, you may want to preset control data on the page prior to displaying it. Process WM_NOTIFY messages from the tab control in your view or dialog class. Use the [Class Wizard](reference/mfc-class-wizard.md) to create an [OnChildNotify](../mfc/reference/cwnd-class.md#onchildnotify) handler function with a switch statement based on which notification message is being handled. For a list of the notifications a tab control can send to its parent window, see the **Notifications** section of [Tab Control Reference](/windows/win32/controls/tab-control-reference) in the Windows SDK. diff --git a/docs/mfc/programmatic-printing.md b/docs/mfc/programmatic-printing.md index 079ccaf4b9f..913dff44ca3 100644 --- a/docs/mfc/programmatic-printing.md +++ b/docs/mfc/programmatic-printing.md @@ -3,10 +3,12 @@ description: "Learn more about: Programmatic Printing" title: "Programmatic Printing" ms.date: "11/04/2016" helpviewer_keywords: ["printing [MFC], active documents", "active documents [MFC], printing", "printing [MFC], programmatic", "IPrint interface", "printing [MFC]"] -ms.assetid: 3db0945b-5e13-4be4-86a0-6aecdae565bd --- # Programmatic Printing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + OLE provided the means to uniquely identify persistent documents (`GetClassFile`) and load them into their associated code (`CoCreateInstance`, `QueryInterface(IID_IPersistFile)`, `QueryInterface(IID_IPersistStorage)`, `IPersistFile::Load`, and `IPersistStorage::Load`). To further enable printing documents, active document containment (using an existing OLE design not shipped with OLE 2.0 originally) introduces a base-standard printing interface, `IPrint`, generally available through any object that can load the persistent state of the document type. Each view of an active document can optionally support the `IPrint` interface to provide these capabilities. The `IPrint` interface is defined as follows: diff --git a/docs/mfc/programming-activex-controls-in-a-activex-control-container.md b/docs/mfc/programming-activex-controls-in-a-activex-control-container.md index 43334e14538..327d058bc67 100644 --- a/docs/mfc/programming-activex-controls-in-a-activex-control-container.md +++ b/docs/mfc/programming-activex-controls-in-a-activex-control-container.md @@ -3,10 +3,12 @@ description: "Learn more about: ActiveX Control Containers: Programming ActiveX title: "ActiveX Control Containers: Programming ActiveX Controls in an ActiveX Control Container" ms.date: "09/12/2018" helpviewer_keywords: ["ActiveX control containers [MFC], accessing ActiveX controls", "Confirm Classes dialog box", "wrapper classes [MFC], ActiveX controls", "ActiveX control containers [MFC], wrapper classes", "ActiveX controls [MFC], accessing", "MFC ActiveX controls [MFC], accessing in containers", "header files [MFC], for ActiveX control wrapper class", "wrapper classes [MFC], using", "ActiveX controls [MFC], wrapper classes"] -ms.assetid: ef9b2480-92d6-4191-b16e-8055c4fd7b73 --- # ActiveX Control Containers: Programming ActiveX Controls in an ActiveX Control Container +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the process for accessing the exposed [methods](../mfc/mfc-activex-controls-methods.md) and [properties](../mfc/mfc-activex-controls-properties.md) of embedded ActiveX controls. >[!IMPORTANT] @@ -44,7 +46,7 @@ Once the Circ control is inserted into the project (step 1), insert an instance ## Modifications to the Project -To enable the Container application to access the Circ control, Visual C++ automatically adds the wrapper class (`CCirc`) implementation file (.CPP) to the Container project and the wrapper class header (.H) file to the dialog box header file: +To enable the Container application to access the Circ control, Visual Studio automatically adds the wrapper class (`CCirc`) implementation file (.CPP) to the Container project and the wrapper class header (.H) file to the dialog box header file: [!code-cpp[NVC_MFC_AxCont#1](../mfc/codesnippet/cpp/programming-activex-controls-in-a-activex-control-container_1.h)] @@ -59,7 +61,7 @@ These functions can then be called from other of the application's procedures us ## Member Variable Modifications to the Project -Once the ActiveX control has been added to the project and embedded in a dialog box container, it can be accessed by other parts of the project. The easiest way to access the control is to [create a member variable](../mfc/activex-control-containers-connecting-an-activex-control-to-a-member-variable.md) of the dialog class, `CContainerDlg` (step 2), that is of the same type as the wrapper class added to the project by Visual C++. You can then use the member variable to access the embedded control at any time. +Once the ActiveX control has been added to the project and embedded in a dialog box container, it can be accessed by other parts of the project. The easiest way to access the control is to [create a member variable](../mfc/activex-control-containers-connecting-an-activex-control-to-a-member-variable.md) of the dialog class, `CContainerDlg` (step 2), that is of the same type as the wrapper class added to the project by Visual Studio. You can then use the member variable to access the embedded control at any time. When the **Add Member Variable** dialog box adds the *m_circctl* member variable to the project, it also adds the following lines to the header file (.H) of the `CContainerDlg` class: diff --git a/docs/mfc/property-sheets-and-property-pages-in-mfc.md b/docs/mfc/property-sheets-and-property-pages-in-mfc.md index d1ff2461a9e..26ba5d7997f 100644 --- a/docs/mfc/property-sheets-and-property-pages-in-mfc.md +++ b/docs/mfc/property-sheets-and-property-pages-in-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Property Sheets and Property Pages in MFC" title: "Property Sheets and Property Pages in MFC" ms.date: "11/04/2016" helpviewer_keywords: ["property pages [MFC], MFC", "controls [MFC], property sheets", "property sheets, MFC", "tab dialog boxes"] -ms.assetid: e1bede2b-0285-4b88-a052-0f8a372807a2 --- # Property Sheets and Property Pages in MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A property sheet, also known as a tab dialog box, is a dialog box that contains property pages. Each property page is based on a dialog template resource and contains controls. It is enclosed on a page with a tab on top. The tab names the page and indicates its purpose. Users click a tab in the property sheet to select a set of controls. Use pages to group the controls in the property sheet into meaningful sets. The contained property sheet typically has several controls of its own. These apply to all pages. diff --git a/docs/mfc/property-sheets-and-property-pages-mfc.md b/docs/mfc/property-sheets-and-property-pages-mfc.md index bf595657827..d2ab2c06422 100644 --- a/docs/mfc/property-sheets-and-property-pages-mfc.md +++ b/docs/mfc/property-sheets-and-property-pages-mfc.md @@ -3,11 +3,13 @@ description: "Learn more about: Property Sheets and Property Pages (MFC)" title: "Property Sheets and Property Pages (MFC)" ms.date: "11/04/2016" helpviewer_keywords: ["MFC dialog boxes [MFC], tabs", "property pages [MFC], property sheets", "CPropertyPage class [MFC], property sheets and pages", "CPropertySheet class [MFC], property sheets and pages", "property sheets, property pages"] -ms.assetid: de8fea12-6c35-4cef-8625-b8073a379446 --- # Property Sheets and Property Pages (MFC) -An MFC [dialog box](../mfc/dialog-boxes.md) can take on a "tab dialog" look by incorporating property sheets and property pages. Called a "property sheet" in MFC, this kind of dialog box, similar to many dialog boxes in Microsoft Word, Excel, and Visual C++, appears to contain a stack of tabbed sheets, much like a stack of file folders seen from front to back, or a group of cascaded windows. Controls on the front tab are visible; only the labeled tab is visible on the rear tabs. Property sheets are particularly useful for managing large numbers of properties or settings that fall fairly neatly into several groups. Typically, one property sheet can simplify a user interface by replacing several separate dialog boxes. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +An MFC [dialog box](../mfc/dialog-boxes.md) can take on a "tab dialog" look by incorporating property sheets and property pages. Called a "property sheet" in MFC, this kind of dialog box, similar to many dialog boxes in Microsoft Word, Excel, and Visual Studio, appears to contain a stack of tabbed sheets, much like a stack of file folders seen from front to back, or a group of cascaded windows. Controls on the front tab are visible; only the labeled tab is visible on the rear tabs. Property sheets are particularly useful for managing large numbers of properties or settings that fall fairly neatly into several groups. Typically, one property sheet can simplify a user interface by replacing several separate dialog boxes. As of MFC version 4.0, property sheets and property pages are implemented using the common controls that come with Windows 95 and Windows NT version 3.51 and later. diff --git a/docs/mfc/property-sheets-as-wizards.md b/docs/mfc/property-sheets-as-wizards.md index 30372a26477..028073f571a 100644 --- a/docs/mfc/property-sheets-as-wizards.md +++ b/docs/mfc/property-sheets-as-wizards.md @@ -3,10 +3,12 @@ description: "Learn more about: Property Sheets as Wizards" title: "Property Sheets as Wizards" ms.date: "11/04/2016" helpviewer_keywords: ["property sheets, as wizards"] -ms.assetid: 1ea66ecb-23b0-484a-838d-58671a2999b5 --- # Property Sheets as Wizards +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A key characteristic of a wizard property sheet is that navigation is provided with Next or Finish, Back, and Cancel buttons instead of tabs. You need to call [CPropertySheet::SetWizardMode](../mfc/reference/cpropertysheet-class.md#setwizardmode) before calling [CPropertySheet::DoModal](../mfc/reference/cpropertysheet-class.md#domodal) on the property sheet object to take advantage of this feature. The user receives the same [CPropertyPage::OnSetActive](../mfc/reference/cpropertypage-class.md#onsetactive) and [CPropertyPage::OnKillActive](../mfc/reference/cpropertypage-class.md#onkillactive) notifications while moving from one page to another page. Next and Finish buttons are mutually exclusive controls; that is, only one of them will be shown at a time. On the first page, the Next button should be enabled. If the user is on the last page, the Finish button should be enabled. This is not done automatically by the framework. You have to call [CPropertySheet::SetWizardButton](../mfc/reference/cpropertysheet-class.md#setwizardbuttons) on the last page to achieve this. diff --git a/docs/mfc/property-sheets-mfc.md b/docs/mfc/property-sheets-mfc.md index aaf53b3bab6..e387244b3fb 100644 --- a/docs/mfc/property-sheets-mfc.md +++ b/docs/mfc/property-sheets-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Property Sheets (MFC)" title: "Property Sheets (MFC)" ms.date: "11/04/2016" helpviewer_keywords: ["dialog boxes [MFC], tabs", "property sheets", "dialog boxes [MFC], property sheets", "tab dialog boxes"] -ms.assetid: 09439f65-921d-45a2-b3cc-e13884a087b1 --- # Property Sheets (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This family of articles explains how to implement support for property sheets in MFC applications. A property sheet, also known as a tab dialog box, provides a way to manage large numbers of controls in a dialog box. The property sheet contains property pages, each based on a separate dialog template resource. You can divide your dialog box's controls into logical groups and put each group on its own property page. ## What do you want to know more about diff --git a/docs/mfc/providing-drag-and-drop-support-for-header-items.md b/docs/mfc/providing-drag-and-drop-support-for-header-items.md index 0d8f5e116fa..283f10cc348 100644 --- a/docs/mfc/providing-drag-and-drop-support-for-header-items.md +++ b/docs/mfc/providing-drag-and-drop-support-for-header-items.md @@ -3,11 +3,13 @@ description: "Learn more about: Providing Drag-and-Drop Support for Header Items title: "Providing Drag-and-Drop Support for Header Items" ms.date: "11/04/2016" helpviewer_keywords: ["HDS_DRAGDROP style", "header items in header controls", "CHeaderCtrl class [MFC], drag and drop support", "HDN_ notifications [MFC]"] -ms.assetid: 93a152ec-804f-488f-b260-b3a438d0dc0f ms.topic: concept-article --- # Providing Drag-and-Drop Support for Header Items +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To provide drag-and-drop support for header items, specify the HDS_DRAGDROP style. Drag-and-drop support for header items gives the user the ability to reorder the header items of a header control. The default behavior provides a semitransparent drag image of the header item being dragged and a visual indicator of the new position, if the header item is dropped. As with common drag-and-drop functionality, you can extend the default drag-and-drop behavior by handling the HDN_BEGINDRAG and HDN_ENDDRAG notifications. You can also customize the appearance of the drag image by overriding the [CHeaderCtrl::CreateDragImage](../mfc/reference/cheaderctrl-class.md#createdragimage) member function. diff --git a/docs/mfc/providing-flicker-free-activation.md b/docs/mfc/providing-flicker-free-activation.md index 177d650be4e..edd2defede6 100644 --- a/docs/mfc/providing-flicker-free-activation.md +++ b/docs/mfc/providing-flicker-free-activation.md @@ -3,11 +3,13 @@ description: "Learn more about: Providing Flicker-Free Activation" title: "Providing Flicker-Free Activation" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], flicker-free", "flicker, MFC ActiveX controls", "activation [MFC], flicker-free"] -ms.assetid: bcb24b77-31d8-44a0-8c58-2ea6213b4c43 ms.topic: concept-article --- # Providing Flicker-Free Activation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If your control draws itself identically in the inactive and active states (and does not use windowless activation), you can eliminate the drawing operations and the accompanying visual flicker that normally occur when making the transition between the inactive and active states. To do this, include the **noFlickerActivate** flag in the set of flags returned by [COleControl::GetControlFlags](../mfc/reference/colecontrol-class.md#getcontrolflags). For example: [!code-cpp[NVC_MFC_AxOpt#5](../mfc/codesnippet/cpp/providing-flicker-free-activation_1.cpp)] diff --git a/docs/mfc/providing-mouse-interaction-while-inactive.md b/docs/mfc/providing-mouse-interaction-while-inactive.md index 21a2b685851..446aa4c6892 100644 --- a/docs/mfc/providing-mouse-interaction-while-inactive.md +++ b/docs/mfc/providing-mouse-interaction-while-inactive.md @@ -3,11 +3,13 @@ description: "Learn more about: Providing Mouse Interaction While Inactive" title: "Providing Mouse Interaction While Inactive" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], mouse interaction"] -ms.assetid: b09106bf-44c7-4b9b-a6d9-0d624f16f5b3 ms.topic: concept-article --- # Providing Mouse Interaction While Inactive +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If your control is not immediately activated, you may still want it to process WM_SETCURSOR and WM_MOUSEMOVE messages, even though the control has no window of its own. This can be accomplished by enabling `COleControl`'s implementation of the `IPointerInactive` interface, which is disabled by default. (See the *ActiveX SDK* for a description of this interface.) To enable it, include the pointerInactive flag in the set of flags returned by [COleControl::GetControlFlags](../mfc/reference/colecontrol-class.md#getcontrolflags): [!code-cpp[NVC_MFC_AxOpt#5](../mfc/codesnippet/cpp/providing-mouse-interaction-while-inactive_1.cpp)] diff --git a/docs/mfc/providing-windowless-activation.md b/docs/mfc/providing-windowless-activation.md index cf11fd11d9b..d30b308b309 100644 --- a/docs/mfc/providing-windowless-activation.md +++ b/docs/mfc/providing-windowless-activation.md @@ -3,11 +3,13 @@ description: "Learn more about: Providing Windowless Activation" title: "Providing Windowless Activation" ms.date: "11/04/2016" helpviewer_keywords: ["windowless activation of MFC ActiveX controls", "activation [MFC], MFC ActiveX controls", "MFC ActiveX controls [MFC], activate options", "activation [MFC], windowless"] -ms.assetid: 094903b5-c344-42fa-96ff-ce01e16891c5 ms.topic: concept-article --- # Providing Windowless Activation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Window creation code (that is, everything that happens when you call `CreateWindow`) is costly to execute. A control that maintains an on-screen window has to manage messages for the window. Windowless controls are therefore faster than controls with windows. A further advantage of windowless controls is that, unlike windowed controls, windowless controls support transparent painting and nonrectangular screen regions. A common example of a transparent control is a text control with a transparent background. The controls paints the text but not the background, so whatever is under the text shows through. Newer forms often make use of nonrectangular controls, such as arrows and round buttons. diff --git a/docs/mfc/reading-and-writing-files.md b/docs/mfc/reading-and-writing-files.md index 22afa9e55f8..1a536cdadb6 100644 --- a/docs/mfc/reading-and-writing-files.md +++ b/docs/mfc/reading-and-writing-files.md @@ -3,11 +3,13 @@ description: "Learn more about: Reading and Writing Files" title: "Reading and Writing Files" ms.date: "11/04/2016" helpviewer_keywords: ["CFile class [MFC], objects", "examples [MFC], reading files", "files [MFC], writing to", "examples [MFC], writing to files", "files [MFC], reading", "MFC, file operations", "CFile class [MFC], reading and writing CFile objects", "reading files", "writing to files [MFC]"] -ms.assetid: cac0c826-ba56-495f-99b3-ce6336f65763 ms.topic: how-to --- # Reading and Writing Files +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If you've used the C run-time library file-handling functions, MFC reading and writing operations will appear familiar. This article describes reading directly from and writing directly to a `CFile` object. You can also do buffered file I/O with the [CArchive](../mfc/reference/carchive-class.md) class. #### To read from and write to the file diff --git a/docs/mfc/ready-to-use-array-classes.md b/docs/mfc/ready-to-use-array-classes.md index 16f2460eccf..f63012d0816 100644 --- a/docs/mfc/ready-to-use-array-classes.md +++ b/docs/mfc/ready-to-use-array-classes.md @@ -4,10 +4,12 @@ title: "Ready-to-Use Array Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.array"] helpviewer_keywords: ["arrays [MFC], classes", "collection classes [MFC], arrays", "classes [MFC], array"] -ms.assetid: fdeabf95-2fe7-43a8-8f88-d954133caf52 --- # Ready-to-Use Array Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following classes are ready-to-use array classes. [CByteArray](../mfc/reference/cbytearray-class.md)
diff --git a/docs/mfc/ready-to-use-list-classes.md b/docs/mfc/ready-to-use-list-classes.md index 7e242c1ad12..50647fdfc75 100644 --- a/docs/mfc/ready-to-use-list-classes.md +++ b/docs/mfc/ready-to-use-list-classes.md @@ -4,10 +4,12 @@ title: "Ready-to-Use List Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.list"] helpviewer_keywords: ["classes [MFC], list", "list classes [MFC]", "collection classes [MFC], lists"] -ms.assetid: aed8e9bd-edb7-4620-84a2-77c20322abd7 --- # Ready-to-Use List Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following classes are ready-to-use list classes. [CObList](../mfc/reference/coblist-class.md)
diff --git a/docs/mfc/ready-to-use-map-classes.md b/docs/mfc/ready-to-use-map-classes.md index 2c2b8674f79..002957165bd 100644 --- a/docs/mfc/ready-to-use-map-classes.md +++ b/docs/mfc/ready-to-use-map-classes.md @@ -4,10 +4,12 @@ title: "Ready-to-Use Map Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.map"] helpviewer_keywords: ["collection classes [MFC], maps", "classes [MFC], map", "map classes [MFC]"] -ms.assetid: 3f0b1c05-2243-4d4d-98d4-429fc3310c9f --- # Ready-to-Use Map Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following classes are ready-to-use map classes. [CMapPtrToPtr](../mfc/reference/cmapptrtoptr-class.md)
diff --git a/docs/mfc/rebar-controls-and-bands.md b/docs/mfc/rebar-controls-and-bands.md index 4efeb0795a6..0b14f9dbb4a 100644 --- a/docs/mfc/rebar-controls-and-bands.md +++ b/docs/mfc/rebar-controls-and-bands.md @@ -3,10 +3,12 @@ description: "Learn more about: Rebar Controls and Bands" title: "Rebar Controls and Bands" ms.date: "11/04/2016" helpviewer_keywords: ["rebar controls [MFC], working with bands in", "bands, in rebar controls"] -ms.assetid: b647e7a5-9ea7-48b1-8e5f-096d104748f0 --- # Rebar Controls and Bands +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The main purpose of a rebar control is to act as a container for child windows, common dialog controls, menus, toolbars, and so on. This containment is supported by the concept of a "band." Each rebar band can contain any combination of a gripper bar, a bitmap, a text label, and a child window. Class `CReBarCtrl` has many member functions that you can use to retrieve, and manipulate, information for a specific rebar band: diff --git a/docs/mfc/receiving-notification-from-common-controls.md b/docs/mfc/receiving-notification-from-common-controls.md index 8e783462914..435756b0ced 100644 --- a/docs/mfc/receiving-notification-from-common-controls.md +++ b/docs/mfc/receiving-notification-from-common-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Receiving Notification from Common Controls" title: "Receiving Notification from Common Controls" ms.date: "11/04/2016" helpviewer_keywords: ["OnNotify method [MFC]", "common controls [MFC], notifications", "ON_NOTIFY macro [MFC]", "controls [MFC], notifications", "receiving notifications from common controls", "notifications [MFC], common controls", "Windows common controls [MFC], notifications", "WM_NOTIFY message"] -ms.assetid: 50194592-d60d-44d0-8ab3-338a2a2c63e7 ms.topic: concept-article --- # Receiving Notification from Common Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Common controls are child windows that send notification messages to the parent window when events, such as input from the user, occur in the control. The application relies on these notification messages to determine what action the user wants it to take. Most common controls send notification messages as WM_NOTIFY messages. Windows controls send most notification messages as WM_COMMAND messages. [CWnd::OnNotify](../mfc/reference/cwnd-class.md#onnotify) is the handler for the WM_NOTIFY message. As with `CWnd::OnCommand`, the implementation of `OnNotify` dispatches the notification message to `OnCmdMsg` for handling in message maps. The message-map entry for handling notifications is ON_NOTIFY. For more information, see [Technical Note 61: ON_NOTIFY and WM_NOTIFY Messages](../mfc/tn061-on-notify-and-wm-notify-messages.md). diff --git a/docs/mfc/recommendations-for-choosing-a-collection-class.md b/docs/mfc/recommendations-for-choosing-a-collection-class.md index aaf0201877d..081935d01d7 100644 --- a/docs/mfc/recommendations-for-choosing-a-collection-class.md +++ b/docs/mfc/recommendations-for-choosing-a-collection-class.md @@ -3,10 +3,12 @@ description: "Learn more about: Recommendations for Choosing a Collection Class" title: "Recommendations for Choosing a Collection Class" ms.date: "11/04/2016" helpviewer_keywords: ["type safety of collection classes [MFC]", "collection classes [MFC], serialization", "collection classes [MFC], speed", "collection classes [MFC], type safety", "collection classes [MFC], choosing", "collection classes [MFC], functionality", "shapes, collection", "collection classes [MFC], template-based", "MFC collection classes [MFC], characteristics", "collection classes [MFC], about collection classes [MFC]", "serialization [MFC], collection classes", "collection classes [MFC], duplicates allowed", "collection classes [MFC], shapes"] -ms.assetid: a82188cd-443f-40d8-a244-edf292a53db4 --- # Recommendations for Choosing a Collection Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article contains detailed information designed to help you choose a collection class for your particular application needs. Your choice of a collection class depends on a number of factors, including: diff --git a/docs/mfc/recommendations-for-handling-input-output.md b/docs/mfc/recommendations-for-handling-input-output.md index 891b0028419..151b6e1c4a6 100644 --- a/docs/mfc/recommendations-for-handling-input-output.md +++ b/docs/mfc/recommendations-for-handling-input-output.md @@ -3,10 +3,12 @@ description: "Learn more about: Recommendations for Handling Input/Output" title: "Recommendations for Handling Input-Output" ms.date: "11/04/2016" helpviewer_keywords: ["I/O [MFC], about I/O", "file-based I/O options", "I/O [MFC]", "I/O [MFC], options", "I/O [MFC], file-based options"] -ms.assetid: d664b175-3b4a-40c3-b14b-39de6b12e419 --- # Recommendations for Handling Input/Output +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Whether you use file-based I/O or not depends on how you respond to the questions in the following decision tree: **Does the primary data in your application reside in a disk file** diff --git a/docs/mfc/reference/add-class-from-typelib-wizard.md b/docs/mfc/reference/add-class-from-typelib-wizard.md index 1f45b4a023c..378a883f19a 100644 --- a/docs/mfc/reference/add-class-from-typelib-wizard.md +++ b/docs/mfc/reference/add-class-from-typelib-wizard.md @@ -3,11 +3,13 @@ description: "Learn more about: Add Class from Typelib Wizard" title: "Add Class from Typelib Wizard" ms.date: "03/10/2022" helpviewer_keywords: ["COM interfaces, adding classes"] -ms.assetid: 96152afd-9374-4649-a6ab-b0fa2a5592a3 ms.custom: devdivchpfy22 --- # Add Class from Typelib Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + ::: moniker range=">=msvc-160" The wizard creates a class for each interface you add from the selected type library. diff --git a/docs/mfc/reference/add-idl-mfc-method-wizard.md b/docs/mfc/reference/add-idl-mfc-method-wizard.md index 4a8592c7e2c..f93f1ee4b80 100644 --- a/docs/mfc/reference/add-idl-mfc-method-wizard.md +++ b/docs/mfc/reference/add-idl-mfc-method-wizard.md @@ -9,6 +9,9 @@ ms.custom: devdivchpfy22 # Add an IDL MFC method +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The **Add IDL MFC Method** wizard adds a method to an Interface Definition Library (IDL) interface defined in your Microsoft Framework Class (MFC) project. If the project contains a class associated with the interface, the wizard also adds the method to the class. To use this wizard, you must be in an MFC Project, ActiveX project, or an ATL project that supports MFC. For example, if you have a Microsoft ActiveX control project, you can use the following procedure to add a method to an IDL interface in the solution. diff --git a/docs/mfc/reference/add-interface-definition-library-mfc-property-wizard.md b/docs/mfc/reference/add-interface-definition-library-mfc-property-wizard.md index 91fc8ecb27e..6ecb599ae65 100644 --- a/docs/mfc/reference/add-interface-definition-library-mfc-property-wizard.md +++ b/docs/mfc/reference/add-interface-definition-library-mfc-property-wizard.md @@ -9,6 +9,9 @@ ms.custom: devdivchpfy22 # Add an IDL MFC property +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The **Add IDL MFC Property** wizard adds a property to an Interface Definition Library (IDL) interface defined in your Microsoft Framework Class (MFC) project. To use this wizard, you must be in an MFC Project, ActiveX project, or an ATL project that supports MFC. For example, if you have a Microsoft ActiveX control project, you can use the following procedure to add a property to an IDL interface in the solution. diff --git a/docs/mfc/reference/adding-an-mfc-class-from-a-type-library.md b/docs/mfc/reference/adding-an-mfc-class-from-a-type-library.md index db0802eea7c..533a9746542 100644 --- a/docs/mfc/reference/adding-an-mfc-class-from-a-type-library.md +++ b/docs/mfc/reference/adding-an-mfc-class-from-a-type-library.md @@ -7,6 +7,9 @@ ms.custom: devdivchpfy22 --- # Add an MFC class from a type library +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use this wizard to create an MFC class from an interface in a type library. You can add an MFC class to an [MFC application](../../mfc/reference/creating-an-mfc-application.md), an [MFC DLL](../../mfc/reference/creating-an-mfc-dll-project.md), or an [MFC ActiveX control](../../mfc/reference/creating-an-mfc-activex-control.md). > [!NOTE] diff --git a/docs/mfc/reference/adding-an-mfc-class.md b/docs/mfc/reference/adding-an-mfc-class.md index aa1ef1c78f2..45dea891a56 100644 --- a/docs/mfc/reference/adding-an-mfc-class.md +++ b/docs/mfc/reference/adding-an-mfc-class.md @@ -4,10 +4,12 @@ title: "Adding an MFC Class" ms.date: "09/06/2019" f1_keywords: ["vc.codewiz.classes.adding.mfc"] helpviewer_keywords: ["classes [MFC], adding MFC", "MFC, adding classes"] -ms.assetid: 9a96b67f-40bf-43d4-8872-2f8dfc5404f1 --- # Adding an MFC Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To add classes derived from Microsoft Foundation Class (MFC) library classes to your project, use the **Add Class** button in [Class Wizard](mfc-class-wizard.md). Specify the name of the new class, select the base class, and select the ID of the dialog box with which it is associated (if any). The wizard creates a header file and an implementation file and adds them to your project. > [!NOTE] diff --git a/docs/mfc/reference/adding-an-mfc-message-handler.md b/docs/mfc/reference/adding-an-mfc-message-handler.md index 3bfd45427da..6d413d2139e 100644 --- a/docs/mfc/reference/adding-an-mfc-message-handler.md +++ b/docs/mfc/reference/adding-an-mfc-message-handler.md @@ -4,10 +4,12 @@ title: "Adding an MFC Message Handler" ms.date: "09/06/2019" f1_keywords: ["vc.codewiz.adding.mfc.msghandler"] helpviewer_keywords: ["message handling [MFC], adding handlers"] -ms.assetid: 4251cfce-76ca-443d-bd2f-6303afa6d942 --- # Adding an MFC Message Handler +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can use the [Class Wizard](mfc-class-wizard.md) or the **Properties** window in **CLass View** to add a message handler (a member function that handles Windows messages) to a class and map Windows messages to the message handler. You can also add [an event handler for any dialog box control](../../windows/adding-editing-or-deleting-controls.md). By using the **Class Wizard** or **Properties** window (in **Class View**) to define message- and event-handling functions, you can automatically update the message-dispatch table (or message map) and your class header file. diff --git a/docs/mfc/reference/adding-an-mfc-odbc-consumer.md b/docs/mfc/reference/adding-an-mfc-odbc-consumer.md index 887931326d3..44a5ce4943a 100644 --- a/docs/mfc/reference/adding-an-mfc-odbc-consumer.md +++ b/docs/mfc/reference/adding-an-mfc-odbc-consumer.md @@ -3,10 +3,12 @@ description: "Learn more about: Adding an MFC ODBC Consumer" title: "Adding an MFC ODBC Consumer" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ODBC consumers"] -ms.assetid: 2dc97909-1f7e-43ee-9d47-99e612727058 --- # Adding an MFC ODBC Consumer +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An MFC ODBC consumer consists of an ODBC recordset class and data bindings necessary to access a data source. ### To add an MFC ODBC consumer diff --git a/docs/mfc/reference/adding-atl-support-to-your-mfc-project.md b/docs/mfc/reference/adding-atl-support-to-your-mfc-project.md index b994dd50d59..0648dcb7ea1 100644 --- a/docs/mfc/reference/adding-atl-support-to-your-mfc-project.md +++ b/docs/mfc/reference/adding-atl-support-to-your-mfc-project.md @@ -4,14 +4,14 @@ title: "Adding ATL Support to Your MFC Project" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.adding.atl.mfc"] helpviewer_keywords: ["MFC, ATL support", "ATL, MFC projects"] -ms.assetid: b5fe15d6-7752-4818-b9f9-62482ad35c95 --- # Adding ATL Support to Your MFC Project -If you have already created an MFC-based application, then you can add support for the Active Template Library (ATL) easily by using the IDE. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library and Active Template Library (ATL) continue to be supported. However, we're no longer adding features or updating the documentation. +> ATL support applies only to simple COM objects added to an MFC executable or DLL project. You can add other COM objects (including ActiveX controls) to MFC projects, but the objects might not operate as expected. -> [!NOTE] -> This support applies only to simple COM objects added to an MFC executable or DLL project. You can add other COM objects (including ActiveX controls) to MFC projects, but the objects might not operate as expected. +If you have already created an MFC-based application, then you can add support for the Active Template Library (ATL) easily by using the IDE. ::: moniker range=">=msvc-160" diff --git a/docs/mfc/reference/advanced-features-mfc-application-wizard.md b/docs/mfc/reference/advanced-features-mfc-application-wizard.md index 7a7c5bbdfe2..aa7ae813506 100644 --- a/docs/mfc/reference/advanced-features-mfc-application-wizard.md +++ b/docs/mfc/reference/advanced-features-mfc-application-wizard.md @@ -4,10 +4,12 @@ title: "Advanced Features, MFC Application Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.exe.advanced"] helpviewer_keywords: ["MFC Application Wizard, advanced features"] -ms.assetid: 8a6681c5-6576-4b12-841a-6862beee76fa --- # Advanced Features, MFC Application Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic lists options for additional features for your application, such as Help, printing support, and so on. In each section, specify additional support for these advanced features. - **Context-sensitive help (HTML)** diff --git a/docs/mfc/reference/afx-extension-module-structure.md b/docs/mfc/reference/afx-extension-module-structure.md index e64cd1da160..925e38e46c1 100644 --- a/docs/mfc/reference/afx-extension-module-structure.md +++ b/docs/mfc/reference/afx-extension-module-structure.md @@ -4,10 +4,12 @@ title: "AFX_EXTENSION_MODULE Structure" ms.date: "11/04/2016" f1_keywords: ["AFX_EXTENSION_MODULE"] helpviewer_keywords: ["AFX_EXTENSION_MODULE structure [MFC]"] -ms.assetid: b85a989c-d0c5-4b28-b53c-dad45b75704e --- # AFX_EXTENSION_MODULE Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `AFX_EXTENSION_MODULE` is used during initialization of MFC extension DLLs to hold the state of MFC extension DLL module. ## Syntax diff --git a/docs/mfc/reference/afx-global-data-structure.md b/docs/mfc/reference/afx-global-data-structure.md index 22f9fd769ea..1abc9996801 100644 --- a/docs/mfc/reference/afx-global-data-structure.md +++ b/docs/mfc/reference/afx-global-data-structure.md @@ -4,10 +4,12 @@ title: "AFX_GLOBAL_DATA Structure" ms.date: "11/04/2016" f1_keywords: ["AFX_GLOBAL_DATA", "AFXGLOBALS/AFX_GLOBAL_DATA::AFX_GLOBAL_DATA", "AFXGLOBALS/AFX_GLOBAL_DATA::~AFX_GLOBAL_DATA", "AFXGLOBALS/AFX_GLOBAL_DATA::CleanUp", "AFXGLOBALS/AFX_GLOBAL_DATA::D2D1MakeRotateMatrix", "AFXGLOBALS/AFX_GLOBAL_DATA::DrawParentBackground", "AFXGLOBALS/AFX_GLOBAL_DATA::DrawTextOnGlass", "AFXGLOBALS/AFX_GLOBAL_DATA::ExcludeTag", "AFXGLOBALS/AFX_GLOBAL_DATA::GetColor", "AFXGLOBALS/AFX_GLOBAL_DATA::GetDirect2dFactory", "AFXGLOBALS/AFX_GLOBAL_DATA::GetHandCursor", "AFXGLOBALS/AFX_GLOBAL_DATA::GetITaskbarList", "AFXGLOBALS/AFX_GLOBAL_DATA::GetITaskbarList3", "AFXGLOBALS/AFX_GLOBAL_DATA::GetNonClientMetrics", "AFXGLOBALS/AFX_GLOBAL_DATA::GetShellAutohideBars", "AFXGLOBALS/AFX_GLOBAL_DATA::GetTextHeight", "AFXGLOBALS/AFX_GLOBAL_DATA::GetWICFactory", "AFXGLOBALS/AFX_GLOBAL_DATA::GetWriteFactory", "AFXGLOBALS/AFX_GLOBAL_DATA::InitD2D", "AFXGLOBALS/AFX_GLOBAL_DATA::Is32BitIcons", "AFXGLOBALS/AFX_GLOBAL_DATA::IsD2DInitialized", "AFXGLOBALS/AFX_GLOBAL_DATA::IsDwmCompositionEnabled", "AFXGLOBALS/AFX_GLOBAL_DATA::IsHighContrastMode", "AFXGLOBALS/AFX_GLOBAL_DATA::OnSettingChange", "AFXGLOBALS/AFX_GLOBAL_DATA::RegisterWindowClass", "AFXGLOBALS/AFX_GLOBAL_DATA::ReleaseTaskBarRefs", "AFXGLOBALS/AFX_GLOBAL_DATA::Resume", "AFXGLOBALS/AFX_GLOBAL_DATA::SetLayeredAttrib", "AFXGLOBALS/AFX_GLOBAL_DATA::SetMenuFont", "AFXGLOBALS/AFX_GLOBAL_DATA::ShellCreateItemFromParsingName", "AFXGLOBALS/AFX_GLOBAL_DATA::UpdateFonts", "AFXGLOBALS/AFX_GLOBAL_DATA::UpdateSysColors", "AFXGLOBALS/AFX_GLOBAL_DATA::EnableAccessibilitySupport", "AFXGLOBALS/AFX_GLOBAL_DATA::IsAccessibilitySupport", "AFXGLOBALS/AFX_GLOBAL_DATA::IsWindowsLayerSupportAvailable", "AFXGLOBALS/AFX_GLOBAL_DATA::bIsOSAlphaBlendingSupport", "AFXGLOBALS/AFX_GLOBAL_DATA::bIsWindows7", "AFXGLOBALS/AFX_GLOBAL_DATA::clrActiveCaptionGradient", "AFXGLOBALS/AFX_GLOBAL_DATA::clrInactiveCaptionGradient", "AFXGLOBALS/AFX_GLOBAL_DATA::m_bUseBuiltIn32BitIcons", "AFXGLOBALS/AFX_GLOBAL_DATA::m_bUseSystemFont", "AFXGLOBALS/AFX_GLOBAL_DATA::m_hcurHand", "AFXGLOBALS/AFX_GLOBAL_DATA::m_hcurStretch", "AFXGLOBALS/AFX_GLOBAL_DATA::m_hcurStretchVert", "AFXGLOBALS/AFX_GLOBAL_DATA::m_hiconTool", "AFXGLOBALS/AFX_GLOBAL_DATA::m_nAutoHideToolBarMargin", "AFXGLOBALS/AFX_GLOBAL_DATA::m_nAutoHideToolBarSpacing", "AFXGLOBALS/AFX_GLOBAL_DATA::m_nDragFrameThicknessDock", "AFXGLOBALS/AFX_GLOBAL_DATA::m_nDragFrameThicknessFloat"] helpviewer_keywords: ["AFX_GLOBAL_DATA structure [MFC]", "AFX_GLOBAL_DATA constructor"] -ms.assetid: c7abf2fb-ad5e-4336-a01d-260c29ed53a2 --- # AFX_GLOBAL_DATA Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `AFX_GLOBAL_DATA` structure contains fields and methods that are used to manage the framework or customize the appearance and behavior of your application. ## Syntax diff --git a/docs/mfc/reference/afx-messages.md b/docs/mfc/reference/afx-messages.md index 8651a84d6d5..afb7cd8d516 100644 --- a/docs/mfc/reference/afx-messages.md +++ b/docs/mfc/reference/afx-messages.md @@ -4,10 +4,12 @@ title: "AFX Messages" ms.date: "11/04/2016" f1_keywords: ["SB_LINELEFT", "SB_THUMBTRACK", "AFX_TOOLTIP_TYPE_EDIT", "AFX_WM_ON_HSCROLL", "SB_PAGERIGHT", "AFX_WM_RESETPROMPT", "AFX_WM_CHANGE_RIBBON_CATEGORY", "AFX_TOOLTIP_TYPE_MINIFRAME", "AFX_WM_CUSTOMIZETOOLBAR", "AFX_WM_CHANGE_ACTIVE_TAB", "AFX_WM_ACCGETOBJECT", "AFX_WM_TOOLBARMENU", "AFX_TOOLTIP_TYPE_DOCKBAR", "AFX_WM_CUSTOMIZEHELP", "AFX_WM_ON_GET_TAB_TOOLTIP", "AFX_WM_ON_RIBBON_CUSTOMIZE", "AFX_WM_ON_DRAGCOMPLETE", "AFX_WM_RESETTOOLBAR", "AFX_WM_ON_MOVETOTABGROUP", "AFX_WM_CHECKEMPTYMINIFRAME", "AFX_WM_GETDOCUMENTCOLORS", "SB_RIGHT", "AFX_WM_ON_BEFORE_SHOW_RIBBON_ITEM_MENU", "AFX_WM_ACCGETSTATE", "SB_PAGELEFT", "SB_ENDSCROLL", "AFX_WM_ON_CANCELTABMOVE", "AFX_TOOLTIP_TYPE_TAB", "AFX_WM_WINDOW_HELP", "AFX_WM_HIGHLIGHT_RIBBON_LIST_ITEM", "AFX_WM_SHOWREGULARMENU", "AFX_TOOLTIP_TYPE_TOOLBAR", "AFX_WM_CHANGE_CURRENT_FOLDER", "AFX_WM_UPDATETOOLTIPS", "AFX_WM_ON_MOVE_TAB", "AFX_WM_CHANGING_ACTIVE_TAB", "AFX_WM_RESETMENU", "AFX_WM_GETDRAGBOUNDS", "AFX_WM_RESETCONTEXTMENU", "AFX_TOOLTIP_TYPE_BUTTON", "AFX_WM_ON_CLOSEPOPUPWINDOW", "AFX_TOOLTIP_TYPE_TOOLBOX", "AFX_WM_CHANGEVISUALMANAGER", "SB_LINERIGHT", "AFX_WM_ON_RENAME_TAB", "AFX_TOOLTIP_TYPE_DEFAULT", "AFX_WM_ON_TABGROUPMOUSEMOVE", "SB_LEFT", "AFX_WM_DELETETOOLBAR", "AFX_WM_PROPERTY_CHANGED", "AFX_TOOLTIP_TYPE_ALL", "AFX_WM_ACCHITTEST", "AFX_WM_ON_AFTER_SHELL_COMMAND", "AFX_WM_ON_PRESS_CLOSE_BUTTON", "AFX_WM_RESETKEYBOARD", "AFX_WM_ON_MOVETABCOMPLETE", "AFX_WM_CREATETOOLBAR", "SB_THUMBPOSITION", "AFX_WM_POSTSETPREVIEWFRAME"] helpviewer_keywords: ["AFX messages [MFC]"] -ms.assetid: 3d601f3c-af6d-47d3-8553-34f1318fa74f --- # AFX Messages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These messages are used in MFC. ## Messages diff --git a/docs/mfc/reference/application-control.md b/docs/mfc/reference/application-control.md index 71d0ea63f2b..94e130be1d1 100644 --- a/docs/mfc/reference/application-control.md +++ b/docs/mfc/reference/application-control.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["application control [MFC]"] --- # Application Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + OLE requires substantial control over applications and their objects. The OLE system DLLs must be able to launch and release applications automatically, coordinate their production and modification of objects, and so on. The functions in this topic meet those requirements. In addition to being called by the OLE system DLLs, these functions must sometimes be called by applications as well. ### Application Control diff --git a/docs/mfc/reference/application-information-and-management.md b/docs/mfc/reference/application-information-and-management.md index 444361085bc..1abddac4368 100644 --- a/docs/mfc/reference/application-information-and-management.md +++ b/docs/mfc/reference/application-information-and-management.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["applications [MFC], managing"] --- # Application Information and Management +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you write an application, you create a single [`CWinApp`](../../mfc/reference/cwinapp-class.md)-derived object. At times, you may want to get information about this object from outside the `CWinApp`-derived object. Or you may need access to other global "manager" objects. The Microsoft Foundation Class Library provides the following global functions to help you accomplish these tasks: @@ -414,7 +417,7 @@ This function is provided for backward compatibility. New applications should us `AfxInitRichEdit` loads `RICHED32.DLL` to initialize version 1.0 of the rich edit control. To use version 2.0 and 3.0 of the rich edit control, `RICHED20.DLL` needs to be loaded. It's loaded by making a call to [`AfxInitRichEdit2`](#afxinitrichedit2). -To update rich edit controls in existing Visual C++ applications to version 2.0, open the .RC file as text, change the class name of each rich edit control from "`RICHEDIT`" to "`RichEdit20a`". Then replace the call to `AfxInitRichEdit` with `AfxInitRichEdit2`. +To update rich edit controls in existing Visual Studio applications to version 2.0, open the .RC file as text, change the class name of each rich edit control from "`RICHEDIT`" to "`RichEdit20a`". Then replace the call to `AfxInitRichEdit` with `AfxInitRichEdit2`. This function also initializes the common controls library, if the library hasn't already been initialized for the process. If you use the rich edit control directly from your MFC application, call this function to assure that MFC has properly initialized the rich edit control runtime. If you call the `Create` method of [`CRichEditCtrl`](../../mfc/reference/cricheditctrl-class.md), [`CRichEditView`](../../mfc/reference/cricheditview-class.md), or [`CRichEditDoc`](../../mfc/reference/cricheditdoc-class.md), you typically don't need to call this function, but in some cases it might be necessary. diff --git a/docs/mfc/reference/application-settings-mfc-activex-control-wizard.md b/docs/mfc/reference/application-settings-mfc-activex-control-wizard.md index 47132045c6e..c4319681860 100644 --- a/docs/mfc/reference/application-settings-mfc-activex-control-wizard.md +++ b/docs/mfc/reference/application-settings-mfc-activex-control-wizard.md @@ -4,10 +4,12 @@ title: "Application Settings, MFC ActiveX Control Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.ctl.appset"] helpviewer_keywords: ["MFC ActiveX Control Wizard, application settings"] -ms.assetid: 48475194-cc63-467f-8499-f142269a4c1c --- # Application Settings, MFC ActiveX Control Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use this page of the MFC ActiveX Control Wizard to design and add basic features to a new MFC ActiveX project. These settings apply to the application itself and not to any specific feature or element of the control. - **Run-time license** diff --git a/docs/mfc/reference/application-settings-mfc-dll-wizard.md b/docs/mfc/reference/application-settings-mfc-dll-wizard.md index b954d26d00d..867e12a7058 100644 --- a/docs/mfc/reference/application-settings-mfc-dll-wizard.md +++ b/docs/mfc/reference/application-settings-mfc-dll-wizard.md @@ -4,10 +4,12 @@ title: "Application Settings, MFC DLL Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.dll.appset"] helpviewer_keywords: ["MFC DLL Wizard, application settings"] -ms.assetid: 0a96b94f-ae36-4975-951b-c9ffb3def21c --- # Application Settings, MFC DLL Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use this page of the MFC DLL wizard to design and add basic features to a new MFC DLL project. ## DLL type diff --git a/docs/mfc/reference/application-type-mfc-application-wizard.md b/docs/mfc/reference/application-type-mfc-application-wizard.md index ba1c3c9b273..4619680538f 100644 --- a/docs/mfc/reference/application-type-mfc-application-wizard.md +++ b/docs/mfc/reference/application-type-mfc-application-wizard.md @@ -4,10 +4,12 @@ title: "Application Type, MFC Application Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.exe.apptype"] helpviewer_keywords: ["static libraries, MFC"] -ms.assetid: c3f62b0e-3f13-42c5-9859-d3890d0c3e1d --- # Application Type, MFC Application Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use this page of the [MFC Application Wizard](../../mfc/reference/mfc-application-wizard.md) to design and add basic features to a new MFC application. - **Application type** diff --git a/docs/mfc/reference/buffercommand-enumeration.md b/docs/mfc/reference/buffercommand-enumeration.md index 23d430be1aa..755a0916ae5 100644 --- a/docs/mfc/reference/buffercommand-enumeration.md +++ b/docs/mfc/reference/buffercommand-enumeration.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["buffercommand enumeration [MFC]"] --- # BufferCommand enumeration +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used by [CMemFile::GetBufferPtr](cmemfile-class.md#getbufferptr) to determine what action to take on the file-backed memory buffer. ## Syntax diff --git a/docs/mfc/reference/cacceleratedeceleratetransition-class.md b/docs/mfc/reference/cacceleratedeceleratetransition-class.md index 2a1805bcab4..59271982e96 100644 --- a/docs/mfc/reference/cacceleratedeceleratetransition-class.md +++ b/docs/mfc/reference/cacceleratedeceleratetransition-class.md @@ -4,10 +4,12 @@ title: "CAccelerateDecelerateTransition Class" ms.date: "11/04/2016" f1_keywords: ["CAccelerateDecelerateTransition", "afxanimationcontroller/CAccelerateDecelerateTransition"] helpviewer_keywords: ["CAccelerateDecelerateTransition class [MFC]"] -ms.assetid: b1f31ee8-bb11-4ccc-b124-365fb02b025c --- # CAccelerateDecelerateTransition Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements an accelerate-decelerate transition. ## Syntax diff --git a/docs/mfc/reference/callback-functions-used-by-mfc.md b/docs/mfc/reference/callback-functions-used-by-mfc.md index 48c2ebd5c79..5beda34b607 100644 --- a/docs/mfc/reference/callback-functions-used-by-mfc.md +++ b/docs/mfc/reference/callback-functions-used-by-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Callback Functions Used by MFC" title: "Callback Functions Used by MFC" ms.date: "11/04/2016" helpviewer_keywords: ["callback functions [MFC], MFC", "MFC, callback functions", "functions [MFC], callback", "callback functions [MFC]"] -ms.assetid: b2a6857c-fdd3-45ec-8fd8-2e71fac77582 --- # Callback Functions Used by MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Three callback functions appear in the Microsoft Foundation Class Library. These callback functions are passed to [CDC::EnumObjects](../../mfc/reference/cdc-class.md#enumobjects), [CDC::GrayString](../../mfc/reference/cdc-class.md#graystring), and [CDC::SetAbortProc](../../mfc/reference/cdc-class.md#setabortproc). Note that all callback functions must trap MFC exceptions before returning to Windows, since exceptions cannot be thrown across callback boundaries. For more information about exceptions, see the article [Exceptions](../../mfc/exception-handling-in-mfc.md). [Callback Function for CDC::EnumObjects](#enum_objects)\ diff --git a/docs/mfc/reference/canimatectrl-class.md b/docs/mfc/reference/canimatectrl-class.md index 15e0d9893a9..5fa507210c2 100644 --- a/docs/mfc/reference/canimatectrl-class.md +++ b/docs/mfc/reference/canimatectrl-class.md @@ -4,10 +4,12 @@ title: "CAnimateCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CAnimateCtrl", "AFXCMN/CAnimateCtrl", "AFXCMN/CAnimateCtrl::CAnimateCtrl", "AFXCMN/CAnimateCtrl::Close", "AFXCMN/CAnimateCtrl::Create", "AFXCMN/CAnimateCtrl::CreateEx", "AFXCMN/CAnimateCtrl::IsPlaying", "AFXCMN/CAnimateCtrl::Open", "AFXCMN/CAnimateCtrl::Play", "AFXCMN/CAnimateCtrl::Seek", "AFXCMN/CAnimateCtrl::Stop"] helpviewer_keywords: ["CAnimateCtrl [MFC], CAnimateCtrl", "CAnimateCtrl [MFC], Close", "CAnimateCtrl [MFC], Create", "CAnimateCtrl [MFC], CreateEx", "CAnimateCtrl [MFC], IsPlaying", "CAnimateCtrl [MFC], Open", "CAnimateCtrl [MFC], Play", "CAnimateCtrl [MFC], Seek", "CAnimateCtrl [MFC], Stop"] -ms.assetid: 5e8eb1bd-96b7-47b8-8de2-6bcbb3cc299b --- # CAnimateCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common animation control. ## Syntax diff --git a/docs/mfc/reference/canimationbaseobject-class.md b/docs/mfc/reference/canimationbaseobject-class.md index cd986f2657d..7177f63f464 100644 --- a/docs/mfc/reference/canimationbaseobject-class.md +++ b/docs/mfc/reference/canimationbaseobject-class.md @@ -4,10 +4,12 @@ title: "CAnimationBaseObject Class" ms.date: "03/27/2019" f1_keywords: ["CAnimationBaseObject", "AFXANIMATIONCONTROLLER/CAnimationBaseObject", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::CAnimationBaseObject", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::ApplyTransitions", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::ClearTransitions", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::ContainsVariable", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::CreateTransitions", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::DetachFromController", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::EnableIntegerValueChangedEvent", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::EnableValueChangedEvent", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::GetAutodestroyTransitions", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::GetGroupID", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::GetObjectID", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::GetUserData", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::SetAutodestroyTransitions", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::SetID", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::SetUserData", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::GetAnimationVariableList", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::SetParentAnimationObjects", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::m_bAutodestroyTransitions", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::m_dwUserData", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::m_nGroupID", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::m_nObjectID", "AFXANIMATIONCONTROLLER/CAnimationBaseObject::m_pParentController"] helpviewer_keywords: ["CAnimationBaseObject [MFC], CAnimationBaseObject", "CAnimationBaseObject [MFC], ApplyTransitions", "CAnimationBaseObject [MFC], ClearTransitions", "CAnimationBaseObject [MFC], ContainsVariable", "CAnimationBaseObject [MFC], CreateTransitions", "CAnimationBaseObject [MFC], DetachFromController", "CAnimationBaseObject [MFC], EnableIntegerValueChangedEvent", "CAnimationBaseObject [MFC], EnableValueChangedEvent", "CAnimationBaseObject [MFC], GetAutodestroyTransitions", "CAnimationBaseObject [MFC], GetGroupID", "CAnimationBaseObject [MFC], GetObjectID", "CAnimationBaseObject [MFC], GetUserData", "CAnimationBaseObject [MFC], SetAutodestroyTransitions", "CAnimationBaseObject [MFC], SetID", "CAnimationBaseObject [MFC], SetUserData", "CAnimationBaseObject [MFC], GetAnimationVariableList", "CAnimationBaseObject [MFC], SetParentAnimationObjects", "CAnimationBaseObject [MFC], m_bAutodestroyTransitions", "CAnimationBaseObject [MFC], m_dwUserData", "CAnimationBaseObject [MFC], m_nGroupID", "CAnimationBaseObject [MFC], m_nObjectID", "CAnimationBaseObject [MFC], m_pParentController"] -ms.assetid: 76b25917-940e-4eba-940f-31d270702603 --- # CAnimationBaseObject Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class for all animation objects. ## Syntax diff --git a/docs/mfc/reference/canimationcolor-class.md b/docs/mfc/reference/canimationcolor-class.md index 776a4f94c5a..95cd12e9f5c 100644 --- a/docs/mfc/reference/canimationcolor-class.md +++ b/docs/mfc/reference/canimationcolor-class.md @@ -4,10 +4,12 @@ title: "CAnimationColor Class" ms.date: "11/04/2016" f1_keywords: ["CAnimationColor", "AFXANIMATIONCONTROLLER/CAnimationColor", "AFXANIMATIONCONTROLLER/CAnimationColor::CAnimationColor", "AFXANIMATIONCONTROLLER/CAnimationColor::AddTransition", "AFXANIMATIONCONTROLLER/CAnimationColor::GetB", "AFXANIMATIONCONTROLLER/CAnimationColor::GetDefaultValue", "AFXANIMATIONCONTROLLER/CAnimationColor::GetG", "AFXANIMATIONCONTROLLER/CAnimationColor::GetR", "AFXANIMATIONCONTROLLER/CAnimationColor::GetValue", "AFXANIMATIONCONTROLLER/CAnimationColor::SetDefaultValue", "AFXANIMATIONCONTROLLER/CAnimationColor::GetAnimationVariableList", "AFXANIMATIONCONTROLLER/CAnimationColor::m_bValue", "AFXANIMATIONCONTROLLER/CAnimationColor::m_gValue", "AFXANIMATIONCONTROLLER/CAnimationColor::m_rValue"] helpviewer_keywords: ["CAnimationColor [MFC], CAnimationColor", "CAnimationColor [MFC], AddTransition", "CAnimationColor [MFC], GetB", "CAnimationColor [MFC], GetDefaultValue", "CAnimationColor [MFC], GetG", "CAnimationColor [MFC], GetR", "CAnimationColor [MFC], GetValue", "CAnimationColor [MFC], SetDefaultValue", "CAnimationColor [MFC], GetAnimationVariableList", "CAnimationColor [MFC], m_bValue", "CAnimationColor [MFC], m_gValue", "CAnimationColor [MFC], m_rValue"] -ms.assetid: 88bfabd4-efeb-4652-87e8-304253d8e48c --- # CAnimationColor Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the functionality of a color whose red, green, and blue components can be animated. ## Syntax diff --git a/docs/mfc/reference/canimationcontroller-class.md b/docs/mfc/reference/canimationcontroller-class.md index efbcb21ccb4..e2fb90bb856 100644 --- a/docs/mfc/reference/canimationcontroller-class.md +++ b/docs/mfc/reference/canimationcontroller-class.md @@ -4,10 +4,12 @@ title: "CAnimationController Class" ms.date: "03/27/2019" f1_keywords: ["CAnimationController", "AFXANIMATIONCONTROLLER/CAnimationController", "AFXANIMATIONCONTROLLER/CAnimationController::CAnimationController", "AFXANIMATIONCONTROLLER/CAnimationController::AddAnimationObject", "AFXANIMATIONCONTROLLER/CAnimationController::AddKeyframeToGroup", "AFXANIMATIONCONTROLLER/CAnimationController::AnimateGroup", "AFXANIMATIONCONTROLLER/CAnimationController::CleanUpGroup", "AFXANIMATIONCONTROLLER/CAnimationController::CreateKeyframe", "AFXANIMATIONCONTROLLER/CAnimationController::EnableAnimationManagerEvent", "AFXANIMATIONCONTROLLER/CAnimationController::EnableAnimationTimerEventHandler", "AFXANIMATIONCONTROLLER/CAnimationController::EnablePriorityComparisonHandler", "AFXANIMATIONCONTROLLER/CAnimationController::EnableStoryboardEventHandler", "AFXANIMATIONCONTROLLER/CAnimationController::FindAnimationGroup", "AFXANIMATIONCONTROLLER/CAnimationController::FindAnimationObject", "AFXANIMATIONCONTROLLER/CAnimationController::GetKeyframeStoryboardStart", "AFXANIMATIONCONTROLLER/CAnimationController::GetUIAnimationManager", "AFXANIMATIONCONTROLLER/CAnimationController::GetUIAnimationTimer", "AFXANIMATIONCONTROLLER/CAnimationController::GetUITransitionFactory", "AFXANIMATIONCONTROLLER/CAnimationController::GetUITransitionLibrary", "AFXANIMATIONCONTROLLER/CAnimationController::IsAnimationInProgress", "AFXANIMATIONCONTROLLER/CAnimationController::IsValid", "AFXANIMATIONCONTROLLER/CAnimationController::OnAnimationIntegerValueChanged", "AFXANIMATIONCONTROLLER/CAnimationController::OnAnimationManagerStatusChanged", "AFXANIMATIONCONTROLLER/CAnimationController::OnAnimationTimerPostUpdate", "AFXANIMATIONCONTROLLER/CAnimationController::OnAnimationTimerPreUpdate", "AFXANIMATIONCONTROLLER/CAnimationController::OnAnimationTimerRenderingTooSlow", "AFXANIMATIONCONTROLLER/CAnimationController::OnAnimationValueChanged", "AFXANIMATIONCONTROLLER/CAnimationController::OnBeforeAnimationStart", "AFXANIMATIONCONTROLLER/CAnimationController::OnHasPriorityCancel", "AFXANIMATIONCONTROLLER/CAnimationController::OnHasPriorityCompress", "AFXANIMATIONCONTROLLER/CAnimationController::OnHasPriorityConclude", "AFXANIMATIONCONTROLLER/CAnimationController::OnHasPriorityTrim", "AFXANIMATIONCONTROLLER/CAnimationController::OnStoryboardStatusChanged", "AFXANIMATIONCONTROLLER/CAnimationController::OnStoryboardUpdated", "AFXANIMATIONCONTROLLER/CAnimationController::RemoveAllAnimationGroups", "AFXANIMATIONCONTROLLER/CAnimationController::RemoveAnimationGroup", "AFXANIMATIONCONTROLLER/CAnimationController::RemoveAnimationObject", "AFXANIMATIONCONTROLLER/CAnimationController::RemoveTransitions", "AFXANIMATIONCONTROLLER/CAnimationController::ScheduleGroup", "AFXANIMATIONCONTROLLER/CAnimationController::SetRelatedWnd", "AFXANIMATIONCONTROLLER/CAnimationController::UpdateAnimationManager", "AFXANIMATIONCONTROLLER/CAnimationController::OnAfterSchedule", "AFXANIMATIONCONTROLLER/CAnimationController::gkeyframeStoryboardStart", "AFXANIMATIONCONTROLLER/CAnimationController::m_bIsValid", "AFXANIMATIONCONTROLLER/CAnimationController::m_lstAnimationGroups", "AFXANIMATIONCONTROLLER/CAnimationController::m_pAnimationManager", "AFXANIMATIONCONTROLLER/CAnimationController::m_pAnimationTimer", "AFXANIMATIONCONTROLLER/CAnimationController::m_pRelatedWnd", "AFXANIMATIONCONTROLLER/CAnimationController::m_pTransitionFactory", "AFXANIMATIONCONTROLLER/CAnimationController::m_pTransitionLibrary"] helpviewer_keywords: ["CAnimationController [MFC], CAnimationController", "CAnimationController [MFC], AddAnimationObject", "CAnimationController [MFC], AddKeyframeToGroup", "CAnimationController [MFC], AnimateGroup", "CAnimationController [MFC], CleanUpGroup", "CAnimationController [MFC], CreateKeyframe", "CAnimationController [MFC], EnableAnimationManagerEvent", "CAnimationController [MFC], EnableAnimationTimerEventHandler", "CAnimationController [MFC], EnablePriorityComparisonHandler", "CAnimationController [MFC], EnableStoryboardEventHandler", "CAnimationController [MFC], FindAnimationGroup", "CAnimationController [MFC], FindAnimationObject", "CAnimationController [MFC], GetKeyframeStoryboardStart", "CAnimationController [MFC], GetUIAnimationManager", "CAnimationController [MFC], GetUIAnimationTimer", "CAnimationController [MFC], GetUITransitionFactory", "CAnimationController [MFC], GetUITransitionLibrary", "CAnimationController [MFC], IsAnimationInProgress", "CAnimationController [MFC], IsValid", "CAnimationController [MFC], OnAnimationIntegerValueChanged", "CAnimationController [MFC], OnAnimationManagerStatusChanged", "CAnimationController [MFC], OnAnimationTimerPostUpdate", "CAnimationController [MFC], OnAnimationTimerPreUpdate", "CAnimationController [MFC], OnAnimationTimerRenderingTooSlow", "CAnimationController [MFC], OnAnimationValueChanged", "CAnimationController [MFC], OnBeforeAnimationStart", "CAnimationController [MFC], OnHasPriorityCancel", "CAnimationController [MFC], OnHasPriorityCompress", "CAnimationController [MFC], OnHasPriorityConclude", "CAnimationController [MFC], OnHasPriorityTrim", "CAnimationController [MFC], OnStoryboardStatusChanged", "CAnimationController [MFC], OnStoryboardUpdated", "CAnimationController [MFC], RemoveAllAnimationGroups", "CAnimationController [MFC], RemoveAnimationGroup", "CAnimationController [MFC], RemoveAnimationObject", "CAnimationController [MFC], RemoveTransitions", "CAnimationController [MFC], ScheduleGroup", "CAnimationController [MFC], SetRelatedWnd", "CAnimationController [MFC], UpdateAnimationManager", "CAnimationController [MFC], CleanUpGroup", "CAnimationController [MFC], OnAfterSchedule", "CAnimationController [MFC], gkeyframeStoryboardStart", "CAnimationController [MFC], m_bIsValid", "CAnimationController [MFC], m_lstAnimationGroups", "CAnimationController [MFC], m_pAnimationManager", "CAnimationController [MFC], m_pAnimationTimer", "CAnimationController [MFC], m_pRelatedWnd", "CAnimationController [MFC], m_pTransitionFactory", "CAnimationController [MFC], m_pTransitionLibrary"] -ms.assetid: ed294c98-695e-40a6-b940-33ef1d40aa6b --- # CAnimationController Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the animation controller, which provides a central interface for creating and managing animations. ## Syntax diff --git a/docs/mfc/reference/canimationgroup-class.md b/docs/mfc/reference/canimationgroup-class.md index ec55261113d..e0465936f07 100644 --- a/docs/mfc/reference/canimationgroup-class.md +++ b/docs/mfc/reference/canimationgroup-class.md @@ -4,10 +4,12 @@ title: "CAnimationGroup Class" ms.date: "03/27/2019" f1_keywords: ["CAnimationGroup", "AFXANIMATIONCONTROLLER/CAnimationGroup", "AFXANIMATIONCONTROLLER/CAnimationGroup::CAnimationGroup", "AFXANIMATIONCONTROLLER/CAnimationGroup::Animate", "AFXANIMATIONCONTROLLER/CAnimationGroup::ApplyTransitions", "AFXANIMATIONCONTROLLER/CAnimationGroup::FindAnimationObject", "AFXANIMATIONCONTROLLER/CAnimationGroup::GetGroupID", "AFXANIMATIONCONTROLLER/CAnimationGroup::RemoveKeyframes", "AFXANIMATIONCONTROLLER/CAnimationGroup::RemoveTransitions", "AFXANIMATIONCONTROLLER/CAnimationGroup::Schedule", "AFXANIMATIONCONTROLLER/CAnimationGroup::SetAutodestroyTransitions", "AFXANIMATIONCONTROLLER/CAnimationGroup::AddKeyframes", "AFXANIMATIONCONTROLLER/CAnimationGroup::AddTransitions", "AFXANIMATIONCONTROLLER/CAnimationGroup::CreateTransitions", "AFXANIMATIONCONTROLLER/CAnimationGroup::m_bAutoclearTransitions", "AFXANIMATIONCONTROLLER/CAnimationGroup::m_bAutodestroyAnimationObjects", "AFXANIMATIONCONTROLLER/CAnimationGroup::m_bAutodestroyKeyframes", "AFXANIMATIONCONTROLLER/CAnimationGroup::m_lstAnimationObjects", "AFXANIMATIONCONTROLLER/CAnimationGroup::m_lstKeyFrames", "AFXANIMATIONCONTROLLER/CAnimationGroup::m_pStoryboard", "AFXANIMATIONCONTROLLER/CAnimationGroup::m_nGroupID", "AFXANIMATIONCONTROLLER/CAnimationGroup::m_pParentController"] helpviewer_keywords: ["CAnimationGroup [MFC], CAnimationGroup", "CAnimationGroup [MFC], Animate", "CAnimationGroup [MFC], ApplyTransitions", "CAnimationGroup [MFC], FindAnimationObject", "CAnimationGroup [MFC], GetGroupID", "CAnimationGroup [MFC], RemoveKeyframes", "CAnimationGroup [MFC], RemoveTransitions", "CAnimationGroup [MFC], Schedule", "CAnimationGroup [MFC], SetAutodestroyTransitions", "CAnimationGroup [MFC], AddKeyframes", "CAnimationGroup [MFC], AddTransitions", "CAnimationGroup [MFC], CreateTransitions", "CAnimationGroup [MFC], m_bAutoclearTransitions", "CAnimationGroup [MFC], m_bAutodestroyAnimationObjects", "CAnimationGroup [MFC], m_bAutodestroyKeyframes", "CAnimationGroup [MFC], m_lstAnimationObjects", "CAnimationGroup [MFC], m_lstKeyFrames", "CAnimationGroup [MFC], m_pStoryboard", "CAnimationGroup [MFC], m_nGroupID", "CAnimationGroup [MFC], m_pParentController"] -ms.assetid: 8bc18ceb-33a2-41d0-9731-71811adacab7 --- # CAnimationGroup Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements an animation group, which combines an animation storyboard, animation objects, and transitions to define an animation. ## Syntax diff --git a/docs/mfc/reference/canimationmanagereventhandler-class.md b/docs/mfc/reference/canimationmanagereventhandler-class.md index 098d5153445..0f734d57cb7 100644 --- a/docs/mfc/reference/canimationmanagereventhandler-class.md +++ b/docs/mfc/reference/canimationmanagereventhandler-class.md @@ -4,10 +4,12 @@ title: "CAnimationManagerEventHandler Class" ms.date: "11/04/2016" f1_keywords: ["CAnimationManagerEventHandler", "AFXANIMATIONCONTROLLER/CAnimationManagerEventHandler", "AFXANIMATIONCONTROLLER/CAnimationManagerEventHandler::CAnimationManagerEventHandler", "AFXANIMATIONCONTROLLER/CAnimationManagerEventHandler::CreateInstance", "AFXANIMATIONCONTROLLER/CAnimationManagerEventHandler::OnManagerStatusChanged", "AFXANIMATIONCONTROLLER/CAnimationManagerEventHandler::SetAnimationController"] helpviewer_keywords: ["CAnimationManagerEventHandler [MFC], CAnimationManagerEventHandler", "CAnimationManagerEventHandler [MFC], CreateInstance", "CAnimationManagerEventHandler [MFC], OnManagerStatusChanged", "CAnimationManagerEventHandler [MFC], SetAnimationController"] -ms.assetid: 6089ec07-e661-4805-b227-823b4652aade --- # CAnimationManagerEventHandler Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a callback, which is called by the Animation API when a status of an animation manager is changed. ## Syntax diff --git a/docs/mfc/reference/canimationpoint-class.md b/docs/mfc/reference/canimationpoint-class.md index 164e739941d..cf1d3ae8466 100644 --- a/docs/mfc/reference/canimationpoint-class.md +++ b/docs/mfc/reference/canimationpoint-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CAnimationPoint [MFC], CAnimationPoint", "CAnimationPoint --- # `CAnimationPoint` class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the functionality of a point whose coordinates can be animated. ## Syntax diff --git a/docs/mfc/reference/canimationrect-class.md b/docs/mfc/reference/canimationrect-class.md index 6d9e450cc35..b2a605299d6 100644 --- a/docs/mfc/reference/canimationrect-class.md +++ b/docs/mfc/reference/canimationrect-class.md @@ -4,10 +4,12 @@ title: "CAnimationRect Class" ms.date: "11/04/2016" f1_keywords: ["CAnimationRect", "AFXANIMATIONCONTROLLER/CAnimationRect", "AFXANIMATIONCONTROLLER/CAnimationRect::CAnimationRect", "AFXANIMATIONCONTROLLER/CAnimationRect::AddTransition", "AFXANIMATIONCONTROLLER/CAnimationRect::GetBottom", "AFXANIMATIONCONTROLLER/CAnimationRect::GetDefaultValue", "AFXANIMATIONCONTROLLER/CAnimationRect::GetLeft", "AFXANIMATIONCONTROLLER/CAnimationRect::GetRight", "AFXANIMATIONCONTROLLER/CAnimationRect::GetTop", "AFXANIMATIONCONTROLLER/CAnimationRect::GetValue", "AFXANIMATIONCONTROLLER/CAnimationRect::SetDefaultValue", "AFXANIMATIONCONTROLLER/CAnimationRect::GetAnimationVariableList", "AFXANIMATIONCONTROLLER/CAnimationRect::m_bFixedSize", "AFXANIMATIONCONTROLLER/CAnimationRect::m_bottomValue", "AFXANIMATIONCONTROLLER/CAnimationRect::m_leftValue", "AFXANIMATIONCONTROLLER/CAnimationRect::m_rightValue", "AFXANIMATIONCONTROLLER/CAnimationRect::m_szInitial", "AFXANIMATIONCONTROLLER/CAnimationRect::m_topValue"] helpviewer_keywords: ["CAnimationRect [MFC], CAnimationRect", "CAnimationRect [MFC], AddTransition", "CAnimationRect [MFC], GetBottom", "CAnimationRect [MFC], GetDefaultValue", "CAnimationRect [MFC], GetLeft", "CAnimationRect [MFC], GetRight", "CAnimationRect [MFC], GetTop", "CAnimationRect [MFC], GetValue", "CAnimationRect [MFC], SetDefaultValue", "CAnimationRect [MFC], GetAnimationVariableList", "CAnimationRect [MFC], m_bFixedSize", "CAnimationRect [MFC], m_bottomValue", "CAnimationRect [MFC], m_leftValue", "CAnimationRect [MFC], m_rightValue", "CAnimationRect [MFC], m_szInitial", "CAnimationRect [MFC], m_topValue"] -ms.assetid: 0294156d-241e-4a57-92b2-31234fe557d6 --- # CAnimationRect Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the functionality of a rectangle whose sides can be animated. ## Syntax diff --git a/docs/mfc/reference/canimationsize-class.md b/docs/mfc/reference/canimationsize-class.md index e918efbaef0..898c45342db 100644 --- a/docs/mfc/reference/canimationsize-class.md +++ b/docs/mfc/reference/canimationsize-class.md @@ -4,10 +4,12 @@ title: "CAnimationSize Class" ms.date: "11/04/2016" f1_keywords: ["CAnimationSize", "AFXANIMATIONCONTROLLER/CAnimationSize", "AFXANIMATIONCONTROLLER/CAnimationSize::CAnimationSize", "AFXANIMATIONCONTROLLER/CAnimationSize::AddTransition", "AFXANIMATIONCONTROLLER/CAnimationSize::GetCX", "AFXANIMATIONCONTROLLER/CAnimationSize::GetCY", "AFXANIMATIONCONTROLLER/CAnimationSize::GetDefaultValue", "AFXANIMATIONCONTROLLER/CAnimationSize::GetValue", "AFXANIMATIONCONTROLLER/CAnimationSize::SetDefaultValue", "AFXANIMATIONCONTROLLER/CAnimationSize::GetAnimationVariableList", "AFXANIMATIONCONTROLLER/CAnimationSize::m_cxValue", "AFXANIMATIONCONTROLLER/CAnimationSize::m_cyValue"] helpviewer_keywords: ["CAnimationSize [MFC], CAnimationSize", "CAnimationSize [MFC], AddTransition", "CAnimationSize [MFC], GetCX", "CAnimationSize [MFC], GetCY", "CAnimationSize [MFC], GetDefaultValue", "CAnimationSize [MFC], GetValue", "CAnimationSize [MFC], SetDefaultValue", "CAnimationSize [MFC], GetAnimationVariableList", "CAnimationSize [MFC], m_cxValue", "CAnimationSize [MFC], m_cyValue"] -ms.assetid: ea06d1b5-502c-44a3-82ca-8bd6ba6a9364 --- # CAnimationSize Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the functionality of a size object whose dimensions can be animated. ## Syntax diff --git a/docs/mfc/reference/canimationstoryboardeventhandler-class.md b/docs/mfc/reference/canimationstoryboardeventhandler-class.md index 24d9635f462..e7d70c17056 100644 --- a/docs/mfc/reference/canimationstoryboardeventhandler-class.md +++ b/docs/mfc/reference/canimationstoryboardeventhandler-class.md @@ -4,10 +4,12 @@ title: "CAnimationStoryboardEventHandler Class" ms.date: "11/04/2016" f1_keywords: ["CAnimationStoryboardEventHandler", "AFXANIMATIONCONTROLLER/CAnimationStoryboardEventHandler", "AFXANIMATIONCONTROLLER/CAnimationStoryboardEventHandler::CAnimationStoryboardEventHandler", "AFXANIMATIONCONTROLLER/CAnimationStoryboardEventHandler::CreateInstance", "AFXANIMATIONCONTROLLER/CAnimationStoryboardEventHandler::OnStoryboardStatusChanged", "AFXANIMATIONCONTROLLER/CAnimationStoryboardEventHandler::OnStoryboardUpdated", "AFXANIMATIONCONTROLLER/CAnimationStoryboardEventHandler::SetAnimationController"] helpviewer_keywords: ["CAnimationStoryboardEventHandler [MFC], CAnimationStoryboardEventHandler", "CAnimationStoryboardEventHandler [MFC], CreateInstance", "CAnimationStoryboardEventHandler [MFC], OnStoryboardStatusChanged", "CAnimationStoryboardEventHandler [MFC], OnStoryboardUpdated", "CAnimationStoryboardEventHandler [MFC], SetAnimationController"] -ms.assetid: 10a7e86b-c02d-4124-9a2e-61ecf8ac62fc --- # CAnimationStoryboardEventHandler Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a callback, which is called by the Animation API when the status of a storyboard is changed or a storyboard is updated. ## Syntax diff --git a/docs/mfc/reference/canimationtimereventhandler-class.md b/docs/mfc/reference/canimationtimereventhandler-class.md index ba43bc2b92c..c81fac2c402 100644 --- a/docs/mfc/reference/canimationtimereventhandler-class.md +++ b/docs/mfc/reference/canimationtimereventhandler-class.md @@ -4,10 +4,12 @@ title: "CAnimationTimerEventHandler Class" ms.date: "11/04/2016" f1_keywords: ["CAnimationTimerEventHandler", "AFXANIMATIONCONTROLLER/CAnimationTimerEventHandler", "AFXANIMATIONCONTROLLER/CAnimationTimerEventHandler::CreateInstance", "AFXANIMATIONCONTROLLER/CAnimationTimerEventHandler::OnPostUpdate", "AFXANIMATIONCONTROLLER/CAnimationTimerEventHandler::OnPreUpdate", "AFXANIMATIONCONTROLLER/CAnimationTimerEventHandler::OnRenderingTooSlow", "AFXANIMATIONCONTROLLER/CAnimationTimerEventHandler::SetAnimationController"] helpviewer_keywords: ["CAnimationTimerEventHandler [MFC], CreateInstance", "CAnimationTimerEventHandler [MFC], OnPostUpdate", "CAnimationTimerEventHandler [MFC], OnPreUpdate", "CAnimationTimerEventHandler [MFC], OnRenderingTooSlow", "CAnimationTimerEventHandler [MFC], SetAnimationController"] -ms.assetid: 188dea3b-4b5e-4f6b-8df9-09d993a21619 --- # CAnimationTimerEventHandler Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a callback, which is called by the Animation API when timing events occur. ## Syntax diff --git a/docs/mfc/reference/canimationvalue-class.md b/docs/mfc/reference/canimationvalue-class.md index 30fc884931c..e18d055b2e6 100644 --- a/docs/mfc/reference/canimationvalue-class.md +++ b/docs/mfc/reference/canimationvalue-class.md @@ -4,10 +4,12 @@ title: "CAnimationValue Class" ms.date: "11/04/2016" f1_keywords: ["CAnimationValue", "AFXANIMATIONCONTROLLER/CAnimationValue", "AFXANIMATIONCONTROLLER/CAnimationValue::CAnimationValue", "AFXANIMATIONCONTROLLER/CAnimationValue::AddTransition", "AFXANIMATIONCONTROLLER/CAnimationValue::GetValue", "AFXANIMATIONCONTROLLER/CAnimationValue::GetVariable", "AFXANIMATIONCONTROLLER/CAnimationValue::SetDefaultValue", "AFXANIMATIONCONTROLLER/CAnimationValue::GetAnimationVariableList", "AFXANIMATIONCONTROLLER/CAnimationValue::m_value"] helpviewer_keywords: ["CAnimationValue [MFC], CAnimationValue", "CAnimationValue [MFC], AddTransition", "CAnimationValue [MFC], GetValue", "CAnimationValue [MFC], GetVariable", "CAnimationValue [MFC], SetDefaultValue", "CAnimationValue [MFC], GetAnimationVariableList", "CAnimationValue [MFC], m_value"] -ms.assetid: 78c5ae19-ede5-4f20-bfbe-68b467b603c2 --- # CAnimationValue Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the functionality of animation object that has one value. ## Syntax diff --git a/docs/mfc/reference/canimationvariable-class.md b/docs/mfc/reference/canimationvariable-class.md index 2e6c644481f..cc9ff75a44b 100644 --- a/docs/mfc/reference/canimationvariable-class.md +++ b/docs/mfc/reference/canimationvariable-class.md @@ -4,10 +4,12 @@ title: "CAnimationVariable Class" ms.date: "03/27/2019" f1_keywords: ["CAnimationVariable", "AFXANIMATIONCONTROLLER/CAnimationVariable", "AFXANIMATIONCONTROLLER/CAnimationVariable::CAnimationVariable", "AFXANIMATIONCONTROLLER/CAnimationVariable::AddTransition", "AFXANIMATIONCONTROLLER/CAnimationVariable::ApplyTransitions", "AFXANIMATIONCONTROLLER/CAnimationVariable::ClearTransitions", "AFXANIMATIONCONTROLLER/CAnimationVariable::Create", "AFXANIMATIONCONTROLLER/CAnimationVariable::CreateTransitions", "AFXANIMATIONCONTROLLER/CAnimationVariable::EnableIntegerValueChangedEvent", "AFXANIMATIONCONTROLLER/CAnimationVariable::EnableValueChangedEvent", "AFXANIMATIONCONTROLLER/CAnimationVariable::GetDefaultValue", "AFXANIMATIONCONTROLLER/CAnimationVariable::GetParentAnimationObject", "AFXANIMATIONCONTROLLER/CAnimationVariable::GetValue", "AFXANIMATIONCONTROLLER/CAnimationVariable::GetVariable", "AFXANIMATIONCONTROLLER/CAnimationVariable::SetDefaultValue", "AFXANIMATIONCONTROLLER/CAnimationVariable::SetParentAnimationObject", "AFXANIMATIONCONTROLLER/CAnimationVariable::m_bAutodestroyTransitions", "AFXANIMATIONCONTROLLER/CAnimationVariable::m_dblDefaultValue", "AFXANIMATIONCONTROLLER/CAnimationVariable::m_lstTransitions", "AFXANIMATIONCONTROLLER/CAnimationVariable::m_pParentObject", "AFXANIMATIONCONTROLLER/CAnimationVariable::m_variable"] helpviewer_keywords: ["CAnimationVariable [MFC], CAnimationVariable", "CAnimationVariable [MFC], AddTransition", "CAnimationVariable [MFC], ApplyTransitions", "CAnimationVariable [MFC], ClearTransitions", "CAnimationVariable [MFC], Create", "CAnimationVariable [MFC], CreateTransitions", "CAnimationVariable [MFC], EnableIntegerValueChangedEvent", "CAnimationVariable [MFC], EnableValueChangedEvent", "CAnimationVariable [MFC], GetDefaultValue", "CAnimationVariable [MFC], GetParentAnimationObject", "CAnimationVariable [MFC], GetValue", "CAnimationVariable [MFC], GetVariable", "CAnimationVariable [MFC], SetDefaultValue", "CAnimationVariable [MFC], SetParentAnimationObject", "CAnimationVariable [MFC], m_bAutodestroyTransitions", "CAnimationVariable [MFC], m_dblDefaultValue", "CAnimationVariable [MFC], m_lstTransitions", "CAnimationVariable [MFC], m_pParentObject", "CAnimationVariable [MFC], m_variable"] -ms.assetid: 506e697e-31a8-4033-a27e-292f4d7b42d9 --- # CAnimationVariable Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents an animation variable. ## Syntax diff --git a/docs/mfc/reference/canimationvariablechangehandler-class.md b/docs/mfc/reference/canimationvariablechangehandler-class.md index 1ddcd351281..8b5b4aca7d5 100644 --- a/docs/mfc/reference/canimationvariablechangehandler-class.md +++ b/docs/mfc/reference/canimationvariablechangehandler-class.md @@ -4,10 +4,12 @@ title: "CAnimationVariableChangeHandler Class" ms.date: "11/04/2016" f1_keywords: ["CAnimationVariableChangeHandler", "AFXANIMATIONCONTROLLER/CAnimationVariableChangeHandler", "AFXANIMATIONCONTROLLER/CAnimationVariableChangeHandler::OnValueChanged", "AFXANIMATIONCONTROLLER/CAnimationVariableChangeHandler::SetAnimationController"] helpviewer_keywords: ["CAnimationVariableChangeHandler [MFC], OnValueChanged", "CAnimationVariableChangeHandler [MFC], SetAnimationController"] -ms.assetid: 2ea4996d-5c04-4dfc-be79-d42d55050795 --- # CAnimationVariableChangeHandler Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a callback, which is called by the Animation API when the value of an animation variable changes. ## Syntax diff --git a/docs/mfc/reference/canimationvariableintegerchangehandler-class.md b/docs/mfc/reference/canimationvariableintegerchangehandler-class.md index 4dfd846fcaa..bfda12cf2d4 100644 --- a/docs/mfc/reference/canimationvariableintegerchangehandler-class.md +++ b/docs/mfc/reference/canimationvariableintegerchangehandler-class.md @@ -4,10 +4,12 @@ title: "CAnimationVariableIntegerChangeHandler Class" ms.date: "11/04/2016" f1_keywords: ["CAnimationVariableIntegerChangeHandler", "AFXANIMATIONCONTROLLER/CAnimationVariableIntegerChangeHandler", "AFXANIMATIONCONTROLLER/CAnimationVariableIntegerChangeHandler::CAnimationVariableIntegerChangeHandler", "AFXANIMATIONCONTROLLER/CAnimationVariableIntegerChangeHandler::CreateInstance", "AFXANIMATIONCONTROLLER/CAnimationVariableIntegerChangeHandler::OnIntegerValueChanged", "AFXANIMATIONCONTROLLER/CAnimationVariableIntegerChangeHandler::SetAnimationController"] helpviewer_keywords: ["CAnimationVariableIntegerChangeHandler [MFC], CAnimationVariableIntegerChangeHandler", "CAnimationVariableIntegerChangeHandler [MFC], CreateInstance", "CAnimationVariableIntegerChangeHandler [MFC], OnIntegerValueChanged", "CAnimationVariableIntegerChangeHandler [MFC], SetAnimationController"] -ms.assetid: 6ac8e91b-e514-4ff6-babd-33f77c4b2b61 --- # CAnimationVariableIntegerChangeHandler Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a callback, which is called by the Animation API when the value of an animation variable changes. ## Syntax diff --git a/docs/mfc/reference/carchive-class.md b/docs/mfc/reference/carchive-class.md index 8d8f606693b..26b7fbc409d 100644 --- a/docs/mfc/reference/carchive-class.md +++ b/docs/mfc/reference/carchive-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CArchive [MFC], CArchive", "CArchive [MFC], Abort", "CArc --- # `CArchive` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Allows you to save a complex network of objects in a permanent binary form (usually disk storage) that persists after those objects are deleted. ## Syntax diff --git a/docs/mfc/reference/carchiveexception-class.md b/docs/mfc/reference/carchiveexception-class.md index dca7aacee89..f16ea647f26 100644 --- a/docs/mfc/reference/carchiveexception-class.md +++ b/docs/mfc/reference/carchiveexception-class.md @@ -4,10 +4,12 @@ title: "CArchiveException Class" ms.date: "11/04/2016" f1_keywords: ["CArchiveException", "AFX/CArchiveException", "AFX/CArchiveException::CArchiveException", "AFX/CArchiveException::m_cause", "AFX/CArchiveException::m_strFileName"] helpviewer_keywords: ["CArchiveException [MFC], CArchiveException", "CArchiveException [MFC], m_cause", "CArchiveException [MFC], m_strFileName"] -ms.assetid: da31a127-e86c-41d1-b0b6-bed0865b1b49 --- # CArchiveException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a serialization exception condition ## Syntax diff --git a/docs/mfc/reference/carray-class.md b/docs/mfc/reference/carray-class.md index 20596963732..0ebc44e38fc 100644 --- a/docs/mfc/reference/carray-class.md +++ b/docs/mfc/reference/carray-class.md @@ -4,10 +4,12 @@ title: "CArray Class" ms.date: "11/04/2016" f1_keywords: ["CArray", "AFXTEMPL/CArray", "AFXTEMPL/CArray::CArray", "AFXTEMPL/CArray::Add", "AFXTEMPL/CArray::Append", "AFXTEMPL/CArray::Copy", "AFXTEMPL/CArray::ElementAt", "AFXTEMPL/CArray::FreeExtra", "AFXTEMPL/CArray::GetAt", "AFXTEMPL/CArray::GetCount", "AFXTEMPL/CArray::GetData", "AFXTEMPL/CArray::GetSize", "AFXTEMPL/CArray::GetUpperBound", "AFXTEMPL/CArray::InsertAt", "AFXTEMPL/CArray::IsEmpty", "AFXTEMPL/CArray::RemoveAll", "AFXTEMPL/CArray::RemoveAt", "AFXTEMPL/CArray::SetAt", "AFXTEMPL/CArray::SetAtGrow", "AFXTEMPL/CArray::SetSize"] helpviewer_keywords: ["CArray [MFC], CArray", "CArray [MFC], Add", "CArray [MFC], Append", "CArray [MFC], Copy", "CArray [MFC], ElementAt", "CArray [MFC], FreeExtra", "CArray [MFC], GetAt", "CArray [MFC], GetCount", "CArray [MFC], GetData", "CArray [MFC], GetSize", "CArray [MFC], GetUpperBound", "CArray [MFC], InsertAt", "CArray [MFC], IsEmpty", "CArray [MFC], RemoveAll", "CArray [MFC], RemoveAt", "CArray [MFC], SetAt", "CArray [MFC], SetAtGrow", "CArray [MFC], SetSize"] -ms.assetid: fead8b00-4cfd-4625-ad0e-251df62ba92f --- # `CArray` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports arrays that are like C arrays, but can dynamically reduce and grow as necessary. ## Syntax diff --git a/docs/mfc/reference/casyncmonikerfile-class.md b/docs/mfc/reference/casyncmonikerfile-class.md index 609962a7759..e5ea9ddca36 100644 --- a/docs/mfc/reference/casyncmonikerfile-class.md +++ b/docs/mfc/reference/casyncmonikerfile-class.md @@ -4,10 +4,12 @@ title: "CAsyncMonikerFile Class" ms.date: "11/04/2016" f1_keywords: ["CAsyncMonikerFile", "AFXOLE/CAsyncMonikerFile", "AFXOLE/CAsyncMonikerFile::CAsyncMonikerFile", "AFXOLE/CAsyncMonikerFile::Close", "AFXOLE/CAsyncMonikerFile::GetBinding", "AFXOLE/CAsyncMonikerFile::GetFormatEtc", "AFXOLE/CAsyncMonikerFile::Open", "AFXOLE/CAsyncMonikerFile::CreateBindStatusCallback", "AFXOLE/CAsyncMonikerFile::GetBindInfo", "AFXOLE/CAsyncMonikerFile::GetPriority", "AFXOLE/CAsyncMonikerFile::OnDataAvailable", "AFXOLE/CAsyncMonikerFile::OnLowResource", "AFXOLE/CAsyncMonikerFile::OnProgress", "AFXOLE/CAsyncMonikerFile::OnStartBinding", "AFXOLE/CAsyncMonikerFile::OnStopBinding"] helpviewer_keywords: ["CAsyncMonikerFile [MFC], CAsyncMonikerFile", "CAsyncMonikerFile [MFC], Close", "CAsyncMonikerFile [MFC], GetBinding", "CAsyncMonikerFile [MFC], GetFormatEtc", "CAsyncMonikerFile [MFC], Open", "CAsyncMonikerFile [MFC], CreateBindStatusCallback", "CAsyncMonikerFile [MFC], GetBindInfo", "CAsyncMonikerFile [MFC], GetPriority", "CAsyncMonikerFile [MFC], OnDataAvailable", "CAsyncMonikerFile [MFC], OnLowResource", "CAsyncMonikerFile [MFC], OnProgress", "CAsyncMonikerFile [MFC], OnStartBinding", "CAsyncMonikerFile [MFC], OnStopBinding"] -ms.assetid: 17378b66-a49a-4b67-88e3-7756ad26a2fc --- # CAsyncMonikerFile Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides functionality for the use of asynchronous monikers in ActiveX controls (formerly OLE controls). ## Syntax diff --git a/docs/mfc/reference/casyncsocket-class.md b/docs/mfc/reference/casyncsocket-class.md index 9d1d045acdd..a88cc1ed46a 100644 --- a/docs/mfc/reference/casyncsocket-class.md +++ b/docs/mfc/reference/casyncsocket-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CAsyncSocket [MFC], CAsyncSocket", "CAsyncSocket [MFC], A --- # `CAsyncSocket` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a Windows Socket — an endpoint of network communication. ## Syntax diff --git a/docs/mfc/reference/cautohidedocksite-class.md b/docs/mfc/reference/cautohidedocksite-class.md index 9b588d7bbf0..87b68fc1d17 100644 --- a/docs/mfc/reference/cautohidedocksite-class.md +++ b/docs/mfc/reference/cautohidedocksite-class.md @@ -4,10 +4,12 @@ title: "CAutoHideDockSite Class" ms.date: "11/04/2016" f1_keywords: ["CAutoHideDockSite", "AFXAUTOHIDEDOCKSITE/CAutoHideDockSite", "AFXAUTOHIDEDOCKSITE/CAutoHideDockSite::CanAcceptPane", "AFXAUTOHIDEDOCKSITE/CAutoHideDockSite::DockPane", "AFXAUTOHIDEDOCKSITE/CAutoHideDockSite::GetAlignRect", "AFXAUTOHIDEDOCKSITE/CAutoHideDockSite::RepositionPanes", "AFXAUTOHIDEDOCKSITE/CAutoHideDockSite::SetOffsetLeft", "AFXAUTOHIDEDOCKSITE/CAutoHideDockSite::SetOffsetRight", "AFXAUTOHIDEDOCKSITE/CAutoHideDockSite::UnSetAutoHideMode", "AFXAUTOHIDEDOCKSITE/CAutoHideDockSite::m_nExtraSpace"] helpviewer_keywords: ["CAutoHideDockSite [MFC], CanAcceptPane", "CAutoHideDockSite [MFC], DockPane", "CAutoHideDockSite [MFC], GetAlignRect", "CAutoHideDockSite [MFC], RepositionPanes", "CAutoHideDockSite [MFC], SetOffsetLeft", "CAutoHideDockSite [MFC], SetOffsetRight", "CAutoHideDockSite [MFC], UnSetAutoHideMode", "CAutoHideDockSite [MFC], m_nExtraSpace"] -ms.assetid: 2a0f6bec-c369-4ab7-977d-564e7946ebad --- # CAutoHideDockSite Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CAutoHideDockSite` extends the [CDockSite Class](../../mfc/reference/cdocksite-class.md) to implement auto-hide dock panes. ## Syntax diff --git a/docs/mfc/reference/cbasekeyframe-class.md b/docs/mfc/reference/cbasekeyframe-class.md index 40785c05ad3..db616828987 100644 --- a/docs/mfc/reference/cbasekeyframe-class.md +++ b/docs/mfc/reference/cbasekeyframe-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CBaseKeyFrame [MFC], CBaseKeyFrame", "CBaseKeyFrame [MFC] --- # CBaseKeyFrame Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the basic functionality of a keyframe. ## Syntax diff --git a/docs/mfc/reference/cbasepane-class.md b/docs/mfc/reference/cbasepane-class.md index de3b9ea5943..0f46768977e 100644 --- a/docs/mfc/reference/cbasepane-class.md +++ b/docs/mfc/reference/cbasepane-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CBasePane [MFC], AccNotifyObjectFocusEvent", "CBasePane [ --- # CBasePane Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Base class for all panes in MFC. ## Syntax diff --git a/docs/mfc/reference/cbasetabbedpane-class.md b/docs/mfc/reference/cbasetabbedpane-class.md index 22e01b013fc..ce0f9df952f 100644 --- a/docs/mfc/reference/cbasetabbedpane-class.md +++ b/docs/mfc/reference/cbasetabbedpane-class.md @@ -4,10 +4,12 @@ title: "CBaseTabbedPane Class" ms.date: "11/04/2016" f1_keywords: ["CBaseTabbedPane", "AFXBASETABBEDPANE/CBaseTabbedPane", "AFXBASETABBEDPANE/CBaseTabbedPane::AddTab", "AFXBASETABBEDPANE/CBaseTabbedPane::AllowDestroyEmptyTabbedPane", "AFXBASETABBEDPANE/CBaseTabbedPane::ApplyRestoredTabInfo", "AFXBASETABBEDPANE/CBaseTabbedPane::CanFloat", "AFXBASETABBEDPANE/CBaseTabbedPane::CanSetCaptionTextToTabName", "AFXBASETABBEDPANE/CBaseTabbedPane::ConvertToTabbedDocument", "AFXBASETABBEDPANE/CBaseTabbedPane::DetachPane", "AFXBASETABBEDPANE/CBaseTabbedPane::EnableSetCaptionTextToTabName", "AFXBASETABBEDPANE/CBaseTabbedPane::FillDefaultTabsOrderArray", "AFXBASETABBEDPANE/CBaseTabbedPane::FindBarByTabNumber", "AFXBASETABBEDPANE/CBaseTabbedPane::FindPaneByID", "AFXBASETABBEDPANE/CBaseTabbedPane::FloatTab", "AFXBASETABBEDPANE/CBaseTabbedPane::GetDefaultTabsOrder", "AFXBASETABBEDPANE/CBaseTabbedPane::GetFirstVisibleTab", "AFXBASETABBEDPANE/CBaseTabbedPane::GetMinSize", "AFXBASETABBEDPANE/CBaseTabbedPane::GetPaneIcon", "AFXBASETABBEDPANE/CBaseTabbedPane::GetPaneList", "AFXBASETABBEDPANE/CBaseTabbedPane::GetTabArea", "AFXBASETABBEDPANE/CBaseTabbedPane::GetTabsNum", "AFXBASETABBEDPANE/CBaseTabbedPane::GetUnderlyingWindow", "AFXBASETABBEDPANE/CBaseTabbedPane::GetVisibleTabsNum", "AFXBASETABBEDPANE/CBaseTabbedPane::HasAutoHideMode", "AFXBASETABBEDPANE/CBaseTabbedPane::IsHideSingleTab", "AFXBASETABBEDPANE/CBaseTabbedPane::RecalcLayout", "AFXBASETABBEDPANE/CBaseTabbedPane::RemovePane", "AFXBASETABBEDPANE/CBaseTabbedPane::SetAutoDestroy", "AFXBASETABBEDPANE/CBaseTabbedPane::SetAutoHideMode", "AFXBASETABBEDPANE/CBaseTabbedPane::ShowTab"] helpviewer_keywords: ["CBaseTabbedPane [MFC], AddTab", "CBaseTabbedPane [MFC], AllowDestroyEmptyTabbedPane", "CBaseTabbedPane [MFC], ApplyRestoredTabInfo", "CBaseTabbedPane [MFC], CanFloat", "CBaseTabbedPane [MFC], CanSetCaptionTextToTabName", "CBaseTabbedPane [MFC], ConvertToTabbedDocument", "CBaseTabbedPane [MFC], DetachPane", "CBaseTabbedPane [MFC], EnableSetCaptionTextToTabName", "CBaseTabbedPane [MFC], FillDefaultTabsOrderArray", "CBaseTabbedPane [MFC], FindBarByTabNumber", "CBaseTabbedPane [MFC], FindPaneByID", "CBaseTabbedPane [MFC], FloatTab", "CBaseTabbedPane [MFC], GetDefaultTabsOrder", "CBaseTabbedPane [MFC], GetFirstVisibleTab", "CBaseTabbedPane [MFC], GetMinSize", "CBaseTabbedPane [MFC], GetPaneIcon", "CBaseTabbedPane [MFC], GetPaneList", "CBaseTabbedPane [MFC], GetTabArea", "CBaseTabbedPane [MFC], GetTabsNum", "CBaseTabbedPane [MFC], GetUnderlyingWindow", "CBaseTabbedPane [MFC], GetVisibleTabsNum", "CBaseTabbedPane [MFC], HasAutoHideMode", "CBaseTabbedPane [MFC], IsHideSingleTab", "CBaseTabbedPane [MFC], RecalcLayout", "CBaseTabbedPane [MFC], RemovePane", "CBaseTabbedPane [MFC], SetAutoDestroy", "CBaseTabbedPane [MFC], SetAutoHideMode", "CBaseTabbedPane [MFC], ShowTab"] -ms.assetid: f22c0080-5b29-4a0a-8f74-8f0a4cd2dbcf --- # CBaseTabbedPane Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Extends the functionality of the [CDockablePane Class](../../mfc/reference/cdockablepane-class.md) to support the creation of tabbed windows. ## Syntax diff --git a/docs/mfc/reference/cbasetransition-class.md b/docs/mfc/reference/cbasetransition-class.md index 83787986692..1fcad2c2626 100644 --- a/docs/mfc/reference/cbasetransition-class.md +++ b/docs/mfc/reference/cbasetransition-class.md @@ -4,10 +4,12 @@ title: "CBaseTransition Class" ms.date: "03/27/2019" f1_keywords: ["CBaseTransition", "AFXANIMATIONCONTROLLER/CBaseTransition", "AFXANIMATIONCONTROLLER/CBaseTransition::CBaseTransition", "AFXANIMATIONCONTROLLER/CBaseTransition::AddToStoryboard", "AFXANIMATIONCONTROLLER/CBaseTransition::AddToStoryboardAtKeyframes", "AFXANIMATIONCONTROLLER/CBaseTransition::Clear", "AFXANIMATIONCONTROLLER/CBaseTransition::Create", "AFXANIMATIONCONTROLLER/CBaseTransition::GetEndKeyframe", "AFXANIMATIONCONTROLLER/CBaseTransition::GetRelatedVariable", "AFXANIMATIONCONTROLLER/CBaseTransition::GetStartKeyframe", "AFXANIMATIONCONTROLLER/CBaseTransition::GetTransition", "AFXANIMATIONCONTROLLER/CBaseTransition::GetType", "AFXANIMATIONCONTROLLER/CBaseTransition::IsAdded", "AFXANIMATIONCONTROLLER/CBaseTransition::SetKeyframes", "AFXANIMATIONCONTROLLER/CBaseTransition::SetRelatedVariable", "AFXANIMATIONCONTROLLER/CBaseTransition::m_bAdded", "AFXANIMATIONCONTROLLER/CBaseTransition::m_pEndKeyframe", "AFXANIMATIONCONTROLLER/CBaseTransition::m_pRelatedVariable", "AFXANIMATIONCONTROLLER/CBaseTransition::m_pStartKeyframe", "AFXANIMATIONCONTROLLER/CBaseTransition::m_transition", "AFXANIMATIONCONTROLLER/CBaseTransition::m_type"] helpviewer_keywords: ["CBaseTransition [MFC], CBaseTransition", "CBaseTransition [MFC], AddToStoryboard", "CBaseTransition [MFC], AddToStoryboardAtKeyframes", "CBaseTransition [MFC], Clear", "CBaseTransition [MFC], Create", "CBaseTransition [MFC], GetEndKeyframe", "CBaseTransition [MFC], GetRelatedVariable", "CBaseTransition [MFC], GetStartKeyframe", "CBaseTransition [MFC], GetTransition", "CBaseTransition [MFC], GetType", "CBaseTransition [MFC], IsAdded", "CBaseTransition [MFC], SetKeyframes", "CBaseTransition [MFC], SetRelatedVariable", "CBaseTransition [MFC], m_bAdded", "CBaseTransition [MFC], m_pEndKeyframe", "CBaseTransition [MFC], m_pRelatedVariable", "CBaseTransition [MFC], m_pStartKeyframe", "CBaseTransition [MFC], m_transition", "CBaseTransition [MFC], m_type"] -ms.assetid: dfe84007-bbc5-43b7-b5b8-fae9145573bf --- # CBaseTransition Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a basic transition. ## Syntax diff --git a/docs/mfc/reference/cbitmap-class.md b/docs/mfc/reference/cbitmap-class.md index 41642f129b5..c914aa52a4b 100644 --- a/docs/mfc/reference/cbitmap-class.md +++ b/docs/mfc/reference/cbitmap-class.md @@ -4,10 +4,12 @@ title: "CBitmap Class" ms.date: "11/04/2016" f1_keywords: ["CBitmap", "AFXWIN/CBitmap", "AFXWIN/CBitmap::CBitmap", "AFXWIN/CBitmap::CreateBitmap", "AFXWIN/CBitmap::CreateBitmapIndirect", "AFXWIN/CBitmap::CreateCompatibleBitmap", "AFXWIN/CBitmap::CreateDiscardableBitmap", "AFXWIN/CBitmap::FromHandle", "AFXWIN/CBitmap::GetBitmap", "AFXWIN/CBitmap::GetBitmapBits", "AFXWIN/CBitmap::GetBitmapDimension", "AFXWIN/CBitmap::LoadBitmap", "AFXWIN/CBitmap::LoadMappedBitmap", "AFXWIN/CBitmap::LoadOEMBitmap", "AFXWIN/CBitmap::SetBitmapBits", "AFXWIN/CBitmap::SetBitmapDimension"] helpviewer_keywords: ["CBitmap [MFC], CBitmap", "CBitmap [MFC], CreateBitmap", "CBitmap [MFC], CreateBitmapIndirect", "CBitmap [MFC], CreateCompatibleBitmap", "CBitmap [MFC], CreateDiscardableBitmap", "CBitmap [MFC], FromHandle", "CBitmap [MFC], GetBitmap", "CBitmap [MFC], GetBitmapBits", "CBitmap [MFC], GetBitmapDimension", "CBitmap [MFC], LoadBitmap", "CBitmap [MFC], LoadMappedBitmap", "CBitmap [MFC], LoadOEMBitmap", "CBitmap [MFC], SetBitmapBits", "CBitmap [MFC], SetBitmapDimension"] -ms.assetid: 3980616a-c59d-495a-86e6-62bd3889c84c --- # `CBitmap` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a Windows graphics device interface (GDI) bitmap and provides member functions to manipulate the bitmap. ## Syntax diff --git a/docs/mfc/reference/cbitmapbutton-class.md b/docs/mfc/reference/cbitmapbutton-class.md index 40777e6f653..74b93c9d90c 100644 --- a/docs/mfc/reference/cbitmapbutton-class.md +++ b/docs/mfc/reference/cbitmapbutton-class.md @@ -4,10 +4,12 @@ title: "CBitmapButton Class" ms.date: "11/04/2016" f1_keywords: ["CBitmapButton", "AFXEXT/CBitmapButton", "AFXEXT/CBitmapButton::CBitmapButton", "AFXEXT/CBitmapButton::AutoLoad", "AFXEXT/CBitmapButton::LoadBitmaps", "AFXEXT/CBitmapButton::SizeToContent"] helpviewer_keywords: ["CBitmapButton [MFC], CBitmapButton", "CBitmapButton [MFC], AutoLoad", "CBitmapButton [MFC], LoadBitmaps", "CBitmapButton [MFC], SizeToContent"] -ms.assetid: 9ad6cb45-c3c4-4fb1-96d3-1fe3df7bbcfc --- # CBitmapButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Creates pushbutton controls labeled with bitmapped images instead of text. ## Syntax diff --git a/docs/mfc/reference/cbitmaprendertarget-class.md b/docs/mfc/reference/cbitmaprendertarget-class.md index 39e0ba6e5b0..c0469597461 100644 --- a/docs/mfc/reference/cbitmaprendertarget-class.md +++ b/docs/mfc/reference/cbitmaprendertarget-class.md @@ -4,10 +4,12 @@ title: "CBitmapRenderTarget Class" ms.date: "11/04/2016" f1_keywords: ["CBitmapRenderTarget", "AFXRENDERTARGET/CBitmapRenderTarget", "AFXRENDERTARGET/CBitmapRenderTarget::CBitmapRenderTarget", "AFXRENDERTARGET/CBitmapRenderTarget::Attach", "AFXRENDERTARGET/CBitmapRenderTarget::Detach", "AFXRENDERTARGET/CBitmapRenderTarget::GetBitmap", "AFXRENDERTARGET/CBitmapRenderTarget::GetBitmapRenderTarget", "AFXRENDERTARGET/CBitmapRenderTarget::m_pBitmapRenderTarget"] helpviewer_keywords: ["CBitmapRenderTarget [MFC], CBitmapRenderTarget", "CBitmapRenderTarget [MFC], Attach", "CBitmapRenderTarget [MFC], Detach", "CBitmapRenderTarget [MFC], GetBitmap", "CBitmapRenderTarget [MFC], GetBitmapRenderTarget", "CBitmapRenderTarget [MFC], m_pBitmapRenderTarget"] -ms.assetid: c89a4437-812e-4943-acb2-b429a04cc4d2 --- # CBitmapRenderTarget Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1BitmapRenderTarget. ## Syntax diff --git a/docs/mfc/reference/cbrush-class.md b/docs/mfc/reference/cbrush-class.md index e9173b9a1b9..274a3dac48a 100644 --- a/docs/mfc/reference/cbrush-class.md +++ b/docs/mfc/reference/cbrush-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CBrush [MFC], CBrush", "CBrush [MFC], CreateBrushIndirect --- # `CBrush` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a Windows graphics device interface (GDI) brush. ## Syntax diff --git a/docs/mfc/reference/cbutton-class.md b/docs/mfc/reference/cbutton-class.md index 3d19e7ff585..607dd0251aa 100644 --- a/docs/mfc/reference/cbutton-class.md +++ b/docs/mfc/reference/cbutton-class.md @@ -4,10 +4,12 @@ title: "CButton Class" ms.date: "11/04/2016" f1_keywords: ["CButton", "AFXWIN/CButton", "AFXWIN/CButton::CButton", "AFXWIN/CButton::Create", "AFXWIN/CButton::DrawItem", "AFXWIN/CButton::GetBitmap", "AFXWIN/CButton::GetButtonStyle", "AFXWIN/CButton::GetCheck", "AFXWIN/CButton::GetCursor", "AFXWIN/CButton::GetIcon", "AFXWIN/CButton::GetIdealSize", "AFXWIN/CButton::GetImageList", "AFXWIN/CButton::GetNote", "AFXWIN/CButton::GetNoteLength", "AFXWIN/CButton::GetSplitGlyph", "AFXWIN/CButton::GetSplitImageList", "AFXWIN/CButton::GetSplitInfo", "AFXWIN/CButton::GetSplitSize", "AFXWIN/CButton::GetSplitStyle", "AFXWIN/CButton::GetState", "AFXWIN/CButton::GetTextMargin", "AFXWIN/CButton::SetBitmap", "AFXWIN/CButton::SetButtonStyle", "AFXWIN/CButton::SetCheck", "AFXWIN/CButton::SetCursor", "AFXWIN/CButton::SetDropDownState", "AFXWIN/CButton::SetIcon", "AFXWIN/CButton::SetImageList", "AFXWIN/CButton::SetNote", "AFXWIN/CButton::SetSplitGlyph", "AFXWIN/CButton::SetSplitImageList", "AFXWIN/CButton::SetSplitInfo", "AFXWIN/CButton::SetSplitSize", "AFXWIN/CButton::SetSplitStyle", "AFXWIN/CButton::SetState", "AFXWIN/CButton::SetTextMargin"] helpviewer_keywords: ["CButton [MFC], CButton", "CButton [MFC], Create", "CButton [MFC], DrawItem", "CButton [MFC], GetBitmap", "CButton [MFC], GetButtonStyle", "CButton [MFC], GetCheck", "CButton [MFC], GetCursor", "CButton [MFC], GetIcon", "CButton [MFC], GetIdealSize", "CButton [MFC], GetImageList", "CButton [MFC], GetNote", "CButton [MFC], GetNoteLength", "CButton [MFC], GetSplitGlyph", "CButton [MFC], GetSplitImageList", "CButton [MFC], GetSplitInfo", "CButton [MFC], GetSplitSize", "CButton [MFC], GetSplitStyle", "CButton [MFC], GetState", "CButton [MFC], GetTextMargin", "CButton [MFC], SetBitmap", "CButton [MFC], SetButtonStyle", "CButton [MFC], SetCheck", "CButton [MFC], SetCursor", "CButton [MFC], SetDropDownState", "CButton [MFC], SetIcon", "CButton [MFC], SetImageList", "CButton [MFC], SetNote", "CButton [MFC], SetSplitGlyph", "CButton [MFC], SetSplitImageList", "CButton [MFC], SetSplitInfo", "CButton [MFC], SetSplitSize", "CButton [MFC], SetSplitStyle", "CButton [MFC], SetState", "CButton [MFC], SetTextMargin"] -ms.assetid: cdc76d5b-31da-43c5-bc43-fde4cb39de5b --- # CButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of Windows button controls. ## Syntax diff --git a/docs/mfc/reference/cbytearray-class.md b/docs/mfc/reference/cbytearray-class.md index 9010e7b881a..42df04444be 100644 --- a/docs/mfc/reference/cbytearray-class.md +++ b/docs/mfc/reference/cbytearray-class.md @@ -4,10 +4,12 @@ title: "CByteArray Class" ms.date: "11/04/2016" f1_keywords: ["CByteArray", "AFXCOLL/CByteArray", "AFXCOLL/CByteArray::CByteArray", "AFXCOLL/CByteArray::Add", "AFXCOLL/CByteArray::Append", "AFXCOLL/CByteArray::Copy", "AFXCOLL/CByteArray::ElementAt", "AFXCOLL/CByteArray::FreeExtra", "AFXCOLL/CByteArray::GetAt", "AFXCOLL/CByteArray::GetCount", "AFXCOLL/CByteArray::GetData", "AFXCOLL/CByteArray::GetSize", "AFXCOLL/CByteArray::GetUpperBound", "AFXCOLL/CByteArray::InsertAt", "AFXCOLL/CByteArray::IsEmpty", "AFXCOLL/CByteArray::RemoveAll", "AFXCOLL/CByteArray::RemoveAt", "AFXCOLL/CByteArray::SetAt", "AFXCOLL/CByteArray::SetAtGrow", "AFXCOLL/CByteArray::SetSize"] helpviewer_keywords: ["CByteArray [MFC], CByteArray", "CByteArray [MFC], Add", "CByteArray [MFC], Append", "CByteArray [MFC], Copy", "CByteArray [MFC], ElementAt", "CByteArray [MFC], FreeExtra", "CByteArray [MFC], GetAt", "CByteArray [MFC], GetCount", "CByteArray [MFC], GetData", "CByteArray [MFC], GetSize", "CByteArray [MFC], GetUpperBound", "CByteArray [MFC], InsertAt", "CByteArray [MFC], IsEmpty", "CByteArray [MFC], RemoveAll", "CByteArray [MFC], RemoveAt", "CByteArray [MFC], SetAt", "CByteArray [MFC], SetAtGrow", "CByteArray [MFC], SetSize"] -ms.assetid: 53d4a512-657c-4187-9609-e3f5339a78e0 --- # CByteArray Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports dynamic arrays of bytes. ## Syntax diff --git a/docs/mfc/reference/ccacheddatapathproperty-class.md b/docs/mfc/reference/ccacheddatapathproperty-class.md index bbbdeb2971a..e437ac08a70 100644 --- a/docs/mfc/reference/ccacheddatapathproperty-class.md +++ b/docs/mfc/reference/ccacheddatapathproperty-class.md @@ -4,10 +4,12 @@ title: "CCachedDataPathProperty Class" ms.date: "11/04/2016" f1_keywords: ["CCachedDataPathProperty", "AFXCTL/CCachedDataPathProperty", "AFXCTL/CCachedDataPathProperty::CCachedDataPathProperty", "AFXCTL/CCachedDataPathProperty::m_Cache"] helpviewer_keywords: ["CCachedDataPathProperty [MFC], CCachedDataPathProperty", "CCachedDataPathProperty [MFC], m_Cache"] -ms.assetid: 0d81356b-4fe5-43f6-aed2-2eb5a5485706 --- # CCachedDataPathProperty Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements an OLE control property transferred asynchronously and cached in a memory file. ## Syntax diff --git a/docs/mfc/reference/cchecklistbox-class.md b/docs/mfc/reference/cchecklistbox-class.md index 1ef8922947c..ab55aaf58ec 100644 --- a/docs/mfc/reference/cchecklistbox-class.md +++ b/docs/mfc/reference/cchecklistbox-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CCheckListBox [MFC], CCheckListBox", "CCheckListBox [MFC] --- # `CCheckListBox` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a Windows checklist box. ## Syntax diff --git a/docs/mfc/reference/cclientdc-class.md b/docs/mfc/reference/cclientdc-class.md index 02091a39e28..1321c52ab06 100644 --- a/docs/mfc/reference/cclientdc-class.md +++ b/docs/mfc/reference/cclientdc-class.md @@ -4,10 +4,12 @@ title: "CClientDC Class" ms.date: "11/04/2016" f1_keywords: ["CClientDC", "AFXWIN/CClientDC", "AFXWIN/CClientDC::CClientDC", "AFXWIN/CClientDC::m_hWnd"] helpviewer_keywords: ["CClientDC [MFC], CClientDC", "CClientDC [MFC], m_hWnd"] -ms.assetid: 8a871d6b-06f8-496e-9fa3-9a5780848369 --- # CClientDC Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Takes care of calling the Windows functions [GetDC](/windows/win32/api/winuser/nf-winuser-getdc) at construction time and [ReleaseDC](/windows/win32/api/winuser/nf-winuser-releasedc) at destruction time. ## Syntax diff --git a/docs/mfc/reference/ccmdtarget-class.md b/docs/mfc/reference/ccmdtarget-class.md index 6c3bdf1fc05..e089d2093e5 100644 --- a/docs/mfc/reference/ccmdtarget-class.md +++ b/docs/mfc/reference/ccmdtarget-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CCmdTarget [MFC], CCmdTarget", "CCmdTarget [MFC], BeginWa --- # `CCmdTarget` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class for the Microsoft Foundation Class Library message-map architecture. ## Syntax diff --git a/docs/mfc/reference/ccmdui-class.md b/docs/mfc/reference/ccmdui-class.md index f110e8be151..52a40e07db6 100644 --- a/docs/mfc/reference/ccmdui-class.md +++ b/docs/mfc/reference/ccmdui-class.md @@ -4,10 +4,12 @@ title: "CCmdUI Class" ms.date: "09/06/2019" f1_keywords: ["CCmdUI", "AFXWIN/CCmdUI", "AFXWIN/CCmdUI::ContinueRouting", "AFXWIN/CCmdUI::Enable", "AFXWIN/CCmdUI::SetCheck", "AFXWIN/CCmdUI::SetRadio", "AFXWIN/CCmdUI::SetText", "AFXWIN/CCmdUI::m_nID", "AFXWIN/CCmdUI::m_nIndex", "AFXWIN/CCmdUI::m_pMenu", "AFXWIN/CCmdUI::m_pOther", "AFXWIN/CCmdUI::m_pSubMenu"] helpviewer_keywords: ["CCmdUI [MFC], ContinueRouting", "CCmdUI [MFC], Enable", "CCmdUI [MFC], SetCheck", "CCmdUI [MFC], SetRadio", "CCmdUI [MFC], SetText", "CCmdUI [MFC], m_nID", "CCmdUI [MFC], m_nIndex", "CCmdUI [MFC], m_pMenu", "CCmdUI [MFC], m_pOther", "CCmdUI [MFC], m_pSubMenu"] -ms.assetid: 04eaaaf5-f510-48ab-b425-94665ba24766 --- # CCmdUI Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Is used only within an `ON_UPDATE_COMMAND_UI` handler in a `CCmdTarget`-derived class. ## Syntax diff --git a/docs/mfc/reference/ccolordialog-class.md b/docs/mfc/reference/ccolordialog-class.md index 3ef9b0282c5..d860dfcfc00 100644 --- a/docs/mfc/reference/ccolordialog-class.md +++ b/docs/mfc/reference/ccolordialog-class.md @@ -4,10 +4,12 @@ title: "CColorDialog Class" ms.date: "11/04/2016" f1_keywords: ["CColorDialog", "AFXDLGS/CColorDialog", "AFXDLGS/CColorDialog::CColorDialog", "AFXDLGS/CColorDialog::DoModal", "AFXDLGS/CColorDialog::GetColor", "AFXDLGS/CColorDialog::GetSavedCustomColors", "AFXDLGS/CColorDialog::SetCurrentColor", "AFXDLGS/CColorDialog::OnColorOK", "AFXDLGS/CColorDialog::m_cc"] helpviewer_keywords: ["CColorDialog [MFC], CColorDialog", "CColorDialog [MFC], DoModal", "CColorDialog [MFC], GetColor", "CColorDialog [MFC], GetSavedCustomColors", "CColorDialog [MFC], SetCurrentColor", "CColorDialog [MFC], OnColorOK", "CColorDialog [MFC], m_cc"] -ms.assetid: d013dc25-9290-4b5d-a97e-95ad7208e13b --- # CColorDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Allows you to incorporate a color-selection dialog box into your application. ## Syntax diff --git a/docs/mfc/reference/ccombobox-class.md b/docs/mfc/reference/ccombobox-class.md index ca740d929f8..fb99b69cc46 100644 --- a/docs/mfc/reference/ccombobox-class.md +++ b/docs/mfc/reference/ccombobox-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CComboBox [MFC], CComboBox", "CComboBox [MFC], AddString" --- # `CComboBox` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a Windows combo box. ## Syntax diff --git a/docs/mfc/reference/ccomboboxex-class.md b/docs/mfc/reference/ccomboboxex-class.md index 5038d39997d..51257fd7d41 100644 --- a/docs/mfc/reference/ccomboboxex-class.md +++ b/docs/mfc/reference/ccomboboxex-class.md @@ -4,10 +4,12 @@ title: "CComboBoxEx Class" ms.date: "11/04/2016" f1_keywords: ["CComboBoxEx", "AFXCMN/CComboBoxEx", "AFXCMN/CComboBoxEx::CComboBoxEx", "AFXCMN/CComboBoxEx::Create", "AFXCMN/CComboBoxEx::CreateEx", "AFXCMN/CComboBoxEx::DeleteItem", "AFXCMN/CComboBoxEx::GetComboBoxCtrl", "AFXCMN/CComboBoxEx::GetEditCtrl", "AFXCMN/CComboBoxEx::GetExtendedStyle", "AFXCMN/CComboBoxEx::GetImageList", "AFXCMN/CComboBoxEx::GetItem", "AFXCMN/CComboBoxEx::HasEditChanged", "AFXCMN/CComboBoxEx::InsertItem", "AFXCMN/CComboBoxEx::SetExtendedStyle", "AFXCMN/CComboBoxEx::SetImageList", "AFXCMN/CComboBoxEx::SetItem", "AFXCMN/CComboBoxEx::SetWindowTheme"] helpviewer_keywords: ["CComboBoxEx [MFC], CComboBoxEx", "CComboBoxEx [MFC], Create", "CComboBoxEx [MFC], CreateEx", "CComboBoxEx [MFC], DeleteItem", "CComboBoxEx [MFC], GetComboBoxCtrl", "CComboBoxEx [MFC], GetEditCtrl", "CComboBoxEx [MFC], GetExtendedStyle", "CComboBoxEx [MFC], GetImageList", "CComboBoxEx [MFC], GetItem", "CComboBoxEx [MFC], HasEditChanged", "CComboBoxEx [MFC], InsertItem", "CComboBoxEx [MFC], SetExtendedStyle", "CComboBoxEx [MFC], SetImageList", "CComboBoxEx [MFC], SetItem", "CComboBoxEx [MFC], SetWindowTheme"] -ms.assetid: 33ca960a-2409-478c-84a4-a2ee8ecfe8f7 --- # CComboBoxEx Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Extends the combo box control by providing support for image lists. ## Syntax diff --git a/docs/mfc/reference/ccommandlineinfo-class.md b/docs/mfc/reference/ccommandlineinfo-class.md index 0702885e23c..3f165999fdd 100644 --- a/docs/mfc/reference/ccommandlineinfo-class.md +++ b/docs/mfc/reference/ccommandlineinfo-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CCommandLineInfo [MFC], CCommandLineInfo", "CCommandLineI --- # `CCommandLineInfo` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Aids in parsing the command line at application startup. ## Syntax diff --git a/docs/mfc/reference/ccommondialog-class.md b/docs/mfc/reference/ccommondialog-class.md index bb92ea0e98a..80866aebe99 100644 --- a/docs/mfc/reference/ccommondialog-class.md +++ b/docs/mfc/reference/ccommondialog-class.md @@ -4,10 +4,12 @@ title: "CCommonDialog Class" ms.date: "11/04/2016" f1_keywords: ["CCommonDialog", "AFXDLGS/CCommonDialog", "AFXDLGS/CCommonDialog::CCommonDialog"] helpviewer_keywords: ["CCommonDialog [MFC], CCommonDialog"] -ms.assetid: 1f68d65f-a0fd-4778-be22-ebbe51a95f95 --- # CCommonDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class for classes that encapsulate functionality of the Windows common dialogs. ## Syntax diff --git a/docs/mfc/reference/cconnectionpoint-class.md b/docs/mfc/reference/cconnectionpoint-class.md index 97925d83f01..8ee400a356d 100644 --- a/docs/mfc/reference/cconnectionpoint-class.md +++ b/docs/mfc/reference/cconnectionpoint-class.md @@ -4,10 +4,12 @@ title: "CConnectionPoint Class" ms.date: "11/04/2016" f1_keywords: ["CConnectionPoint", "AFXDISP/CConnectionPoint", "AFXDISP/CConnectionPoint::CConnectionPoint", "AFXDISP/CConnectionPoint::GetConnections", "AFXDISP/CConnectionPoint::GetContainer", "AFXDISP/CConnectionPoint::GetIID", "AFXDISP/CConnectionPoint::GetMaxConnections", "AFXDISP/CConnectionPoint::GetNextConnection", "AFXDISP/CConnectionPoint::GetStartPosition", "AFXDISP/CConnectionPoint::OnAdvise", "AFXDISP/CConnectionPoint::QuerySinkInterface"] helpviewer_keywords: ["CConnectionPoint [MFC], CConnectionPoint", "CConnectionPoint [MFC], GetConnections", "CConnectionPoint [MFC], GetContainer", "CConnectionPoint [MFC], GetIID", "CConnectionPoint [MFC], GetMaxConnections", "CConnectionPoint [MFC], GetNextConnection", "CConnectionPoint [MFC], GetStartPosition", "CConnectionPoint [MFC], OnAdvise", "CConnectionPoint [MFC], QuerySinkInterface"] -ms.assetid: f0f23a1e-5e8c-41a9-aa6c-1a4793b28e8f --- # CConnectionPoint Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Defines a special type of interface used to communicate with other OLE objects, called a "connection point." ## Syntax diff --git a/docs/mfc/reference/cconstanttransition-class.md b/docs/mfc/reference/cconstanttransition-class.md index 16a55675bc6..717319d3441 100644 --- a/docs/mfc/reference/cconstanttransition-class.md +++ b/docs/mfc/reference/cconstanttransition-class.md @@ -4,10 +4,12 @@ title: "CConstantTransition Class" ms.date: "11/04/2016" f1_keywords: ["CConstantTransition", "AFXANIMATIONCONTROLLER/CConstantTransition", "AFXANIMATIONCONTROLLER/CConstantTransition::CConstantTransition", "AFXANIMATIONCONTROLLER/CConstantTransition::Create", "AFXANIMATIONCONTROLLER/CConstantTransition::m_duration"] helpviewer_keywords: ["CConstantTransition [MFC], CConstantTransition", "CConstantTransition [MFC], Create", "CConstantTransition [MFC], m_duration"] -ms.assetid: f6fa4780-a71b-4cd6-80aa-d4792ace36c2 --- # CConstantTransition Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a constant transition. ## Syntax diff --git a/docs/mfc/reference/ccontextmenumanager-class.md b/docs/mfc/reference/ccontextmenumanager-class.md index 5c6539ddf36..f2800b39bcb 100644 --- a/docs/mfc/reference/ccontextmenumanager-class.md +++ b/docs/mfc/reference/ccontextmenumanager-class.md @@ -4,10 +4,12 @@ title: "CContextMenuManager Class" ms.date: "11/04/2016" f1_keywords: ["CContextMenuManager", "AFXCONTEXTMENUMANAGER/CContextMenuManager", "AFXCONTEXTMENUMANAGER/CContextMenuManager::CContextMenuManager", "AFXCONTEXTMENUMANAGER/CContextMenuManager::AddMenu", "AFXCONTEXTMENUMANAGER/CContextMenuManager::GetMenuById", "AFXCONTEXTMENUMANAGER/CContextMenuManager::GetMenuByName", "AFXCONTEXTMENUMANAGER/CContextMenuManager::GetMenuNames", "AFXCONTEXTMENUMANAGER/CContextMenuManager::LoadState", "AFXCONTEXTMENUMANAGER/CContextMenuManager::ResetState", "AFXCONTEXTMENUMANAGER/CContextMenuManager::SaveState", "AFXCONTEXTMENUMANAGER/CContextMenuManager::SetDontCloseActiveMenu", "AFXCONTEXTMENUMANAGER/CContextMenuManager::ShowPopupMenu", "AFXCONTEXTMENUMANAGER/CContextMenuManager::TrackPopupMenu"] helpviewer_keywords: ["CContextMenuManager [MFC], CContextMenuManager", "CContextMenuManager [MFC], AddMenu", "CContextMenuManager [MFC], GetMenuById", "CContextMenuManager [MFC], GetMenuByName", "CContextMenuManager [MFC], GetMenuNames", "CContextMenuManager [MFC], LoadState", "CContextMenuManager [MFC], ResetState", "CContextMenuManager [MFC], SaveState", "CContextMenuManager [MFC], SetDontCloseActiveMenu", "CContextMenuManager [MFC], ShowPopupMenu", "CContextMenuManager [MFC], TrackPopupMenu"] -ms.assetid: 1de20640-243c-47e1-85de-1baa4153bc83 --- # CContextMenuManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CContextMenuManager` object manages shortcut menus, also known as context menus. ## Syntax diff --git a/docs/mfc/reference/ccontrolbar-class.md b/docs/mfc/reference/ccontrolbar-class.md index d8ab52bf13f..3216a4f4a83 100644 --- a/docs/mfc/reference/ccontrolbar-class.md +++ b/docs/mfc/reference/ccontrolbar-class.md @@ -4,10 +4,12 @@ title: "CControlBar Class" ms.date: "11/04/2016" f1_keywords: ["CControlBar", "AFXEXT/CControlBar", "AFXEXT/CControlBar::CControlBar", "AFXEXT/CControlBar::CalcDynamicLayout", "AFXEXT/CControlBar::CalcFixedLayout", "AFXEXT/CControlBar::CalcInsideRect", "AFXEXT/CControlBar::DoPaint", "AFXEXT/CControlBar::DrawBorders", "AFXEXT/CControlBar::DrawGripper", "AFXEXT/CControlBar::EnableDocking", "AFXEXT/CControlBar::GetBarStyle", "AFXEXT/CControlBar::GetBorders", "AFXEXT/CControlBar::GetCount", "AFXEXT/CControlBar::GetDockingFrame", "AFXEXT/CControlBar::IsFloating", "AFXEXT/CControlBar::OnUpdateCmdUI", "AFXEXT/CControlBar::SetBarStyle", "AFXEXT/CControlBar::SetBorders", "AFXEXT/CControlBar::SetInPlaceOwner", "AFXEXT/CControlBar::m_bAutoDelete", "AFXEXT/CControlBar::m_pInPlaceOwner"] helpviewer_keywords: ["CControlBar [MFC], CControlBar", "CControlBar [MFC], CalcDynamicLayout", "CControlBar [MFC], CalcFixedLayout", "CControlBar [MFC], CalcInsideRect", "CControlBar [MFC], DoPaint", "CControlBar [MFC], DrawBorders", "CControlBar [MFC], DrawGripper", "CControlBar [MFC], EnableDocking", "CControlBar [MFC], GetBarStyle", "CControlBar [MFC], GetBorders", "CControlBar [MFC], GetCount", "CControlBar [MFC], GetDockingFrame", "CControlBar [MFC], IsFloating", "CControlBar [MFC], OnUpdateCmdUI", "CControlBar [MFC], SetBarStyle", "CControlBar [MFC], SetBorders", "CControlBar [MFC], SetInPlaceOwner", "CControlBar [MFC], m_bAutoDelete", "CControlBar [MFC], m_pInPlaceOwner"] -ms.assetid: 4d668c55-9b42-4838-97ac-cf2b3000b82c --- # CControlBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class for the control-bar classes [CStatusBar](../../mfc/reference/cstatusbar-class.md), [CToolBar](../../mfc/reference/ctoolbar-class.md), [CDialogBar](../../mfc/reference/cdialogbar-class.md), [CReBar](../../mfc/reference/crebar-class.md), and [COleResizeBar](../../mfc/reference/coleresizebar-class.md). ## Syntax diff --git a/docs/mfc/reference/ccreatecontext-structure.md b/docs/mfc/reference/ccreatecontext-structure.md index 5e388a6ea2c..f51446f4efe 100644 --- a/docs/mfc/reference/ccreatecontext-structure.md +++ b/docs/mfc/reference/ccreatecontext-structure.md @@ -4,10 +4,12 @@ title: "CCreateContext Structure" ms.date: "11/04/2016" f1_keywords: ["CCreateContext"] helpviewer_keywords: ["CCreateContext structure [MFC]"] -ms.assetid: 337a0e44-d910-49a8-afc0-c7207666a9dc --- # CCreateContext Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The framework uses the `CCreateContext` structure when it creates the frame windows and views that are associated with a document. ## Syntax diff --git a/docs/mfc/reference/ccriticalsection-class.md b/docs/mfc/reference/ccriticalsection-class.md index 5f747387318..d8d4e783423 100644 --- a/docs/mfc/reference/ccriticalsection-class.md +++ b/docs/mfc/reference/ccriticalsection-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CCriticalSection [MFC], CCriticalSection", "CCriticalSect --- # `CCriticalSection` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a "critical section" — a synchronization object that allows one thread at a time to access a resource or section of code. ## Syntax diff --git a/docs/mfc/reference/cctrlview-class.md b/docs/mfc/reference/cctrlview-class.md index c2d7a5d4315..818994d888b 100644 --- a/docs/mfc/reference/cctrlview-class.md +++ b/docs/mfc/reference/cctrlview-class.md @@ -4,10 +4,12 @@ title: "CCtrlView Class" ms.date: "11/04/2016" f1_keywords: ["CCtrlView", "AFXWIN/CCtrlView", "AFXWIN/CCtrlView::CCtrlView", "AFXWIN/CCtrlView::OnDraw", "AFXWIN/CCtrlView::PreCreateWindow", "AFXWIN/CCtrlView::m_dwDefaultStyle", "AFXWIN/CCtrlView::m_strClass"] helpviewer_keywords: ["CCtrlView [MFC], CCtrlView", "CCtrlView [MFC], OnDraw", "CCtrlView [MFC], PreCreateWindow", "CCtrlView [MFC], m_dwDefaultStyle", "CCtrlView [MFC], m_strClass"] -ms.assetid: ff488596-1e71-451f-8fec-b0831a7b44e0 --- # CCtrlView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Adapts the document-view architecture to the common controls supported by Windows 98 and Windows NT versions 3.51 and later. ## Syntax diff --git a/docs/mfc/reference/ccubictransition-class.md b/docs/mfc/reference/ccubictransition-class.md index 17ba50a9a7c..093c1ed04d9 100644 --- a/docs/mfc/reference/ccubictransition-class.md +++ b/docs/mfc/reference/ccubictransition-class.md @@ -4,10 +4,12 @@ title: "CCubicTransition Class" ms.date: "11/04/2016" f1_keywords: ["CCubicTransition", "AFXANIMATIONCONTROLLER/CCubicTransition", "AFXANIMATIONCONTROLLER/CCubicTransition::CCubicTransition", "AFXANIMATIONCONTROLLER/CCubicTransition::Create", "AFXANIMATIONCONTROLLER/CCubicTransition::m_dblFinalValue", "AFXANIMATIONCONTROLLER/CCubicTransition::m_dblFinalVelocity", "AFXANIMATIONCONTROLLER/CCubicTransition::m_duration"] helpviewer_keywords: ["CCubicTransition [MFC], CCubicTransition", "CCubicTransition [MFC], Create", "CCubicTransition [MFC], m_dblFinalValue", "CCubicTransition [MFC], m_dblFinalVelocity", "CCubicTransition [MFC], m_duration"] -ms.assetid: 4fc30e9c-160c-45e1-bdbe-51adf8fee9c5 --- # CCubicTransition Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a cubic transition. ## Syntax diff --git a/docs/mfc/reference/ccustominterpolator-class.md b/docs/mfc/reference/ccustominterpolator-class.md index e1ab9c85536..270871b36a5 100644 --- a/docs/mfc/reference/ccustominterpolator-class.md +++ b/docs/mfc/reference/ccustominterpolator-class.md @@ -4,10 +4,12 @@ title: "CCustomInterpolator Class" ms.date: "11/04/2016" f1_keywords: ["CCustomInterpolator", "AFXANIMATIONCONTROLLER/CCustomInterpolator", "AFXANIMATIONCONTROLLER/CCustomInterpolator::CCustomInterpolator", "AFXANIMATIONCONTROLLER/CCustomInterpolator::GetDependencies", "AFXANIMATIONCONTROLLER/CCustomInterpolator::GetDuration", "AFXANIMATIONCONTROLLER/CCustomInterpolator::GetFinalValue", "AFXANIMATIONCONTROLLER/CCustomInterpolator::Init", "AFXANIMATIONCONTROLLER/CCustomInterpolator::InterpolateValue", "AFXANIMATIONCONTROLLER/CCustomInterpolator::InterpolateVelocity", "AFXANIMATIONCONTROLLER/CCustomInterpolator::SetDuration", "AFXANIMATIONCONTROLLER/CCustomInterpolator::SetInitialValueAndVelocity", "AFXANIMATIONCONTROLLER/CCustomInterpolator::m_currentValue", "AFXANIMATIONCONTROLLER/CCustomInterpolator::m_currentVelocity", "AFXANIMATIONCONTROLLER/CCustomInterpolator::m_duration", "AFXANIMATIONCONTROLLER/CCustomInterpolator::m_finalValue", "AFXANIMATIONCONTROLLER/CCustomInterpolator::m_initialValue", "AFXANIMATIONCONTROLLER/CCustomInterpolator::m_initialVelocity"] helpviewer_keywords: ["CCustomInterpolator [MFC], CCustomInterpolator", "CCustomInterpolator [MFC], GetDependencies", "CCustomInterpolator [MFC], GetDuration", "CCustomInterpolator [MFC], GetFinalValue", "CCustomInterpolator [MFC], Init", "CCustomInterpolator [MFC], InterpolateValue", "CCustomInterpolator [MFC], InterpolateVelocity", "CCustomInterpolator [MFC], SetDuration", "CCustomInterpolator [MFC], SetInitialValueAndVelocity", "CCustomInterpolator [MFC], m_currentValue", "CCustomInterpolator [MFC], m_currentVelocity", "CCustomInterpolator [MFC], m_duration", "CCustomInterpolator [MFC], m_finalValue", "CCustomInterpolator [MFC], m_initialValue", "CCustomInterpolator [MFC], m_initialVelocity"] -ms.assetid: 28d85595-989a-40a3-b003-e0e38437a94d --- # CCustomInterpolator Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a basic interpolator. ## Syntax diff --git a/docs/mfc/reference/ccustomtransition-class.md b/docs/mfc/reference/ccustomtransition-class.md index 36e2810e347..73ffb6d571d 100644 --- a/docs/mfc/reference/ccustomtransition-class.md +++ b/docs/mfc/reference/ccustomtransition-class.md @@ -4,10 +4,12 @@ title: "CCustomTransition Class" ms.date: "11/04/2016" f1_keywords: ["CCustomTransition", "AFXANIMATIONCONTROLLER/CCustomTransition", "AFXANIMATIONCONTROLLER/CCustomTransition::CCustomTransition", "AFXANIMATIONCONTROLLER/CCustomTransition::Create", "AFXANIMATIONCONTROLLER/CCustomTransition::SetInitialValue", "AFXANIMATIONCONTROLLER/CCustomTransition::SetInitialVelocity", "AFXANIMATIONCONTROLLER/CCustomTransition::m_bInitialValueSpecified", "AFXANIMATIONCONTROLLER/CCustomTransition::m_bInitialVelocitySpecified", "AFXANIMATIONCONTROLLER/CCustomTransition::m_initialValue", "AFXANIMATIONCONTROLLER/CCustomTransition::m_initialVelocity", "AFXANIMATIONCONTROLLER/CCustomTransition::m_pInterpolator"] helpviewer_keywords: ["CCustomTransition [MFC], CCustomTransition", "CCustomTransition [MFC], Create", "CCustomTransition [MFC], SetInitialValue", "CCustomTransition [MFC], SetInitialVelocity", "CCustomTransition [MFC], m_bInitialValueSpecified", "CCustomTransition [MFC], m_bInitialVelocitySpecified", "CCustomTransition [MFC], m_initialValue", "CCustomTransition [MFC], m_initialVelocity", "CCustomTransition [MFC], m_pInterpolator"] -ms.assetid: 5bd3f492-940f-4290-a38b-fa68eb8f8401 --- # CCustomTransition Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a custom transition. ## Syntax diff --git a/docs/mfc/reference/cd2dbitmap-class.md b/docs/mfc/reference/cd2dbitmap-class.md index 9527c8a6532..b763abcc8b7 100644 --- a/docs/mfc/reference/cd2dbitmap-class.md +++ b/docs/mfc/reference/cd2dbitmap-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CD2DBitmap [MFC], CD2DBitmap", "CD2DBitmap [MFC], CD2DBit --- # CD2DBitmap Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1Bitmap. ## Syntax diff --git a/docs/mfc/reference/cd2dbitmapbrush-class.md b/docs/mfc/reference/cd2dbitmapbrush-class.md index 7387755e260..cd4aa8f6312 100644 --- a/docs/mfc/reference/cd2dbitmapbrush-class.md +++ b/docs/mfc/reference/cd2dbitmapbrush-class.md @@ -4,10 +4,12 @@ title: "CD2DBitmapBrush Class" ms.date: "11/04/2016" f1_keywords: ["CD2DBitmapBrush", "AFXRENDERTARGET/CD2DBitmapBrush", "AFXRENDERTARGET/CD2DBitmapBrush::CD2DBitmapBrush", "AFXRENDERTARGET/CD2DBitmapBrush::Attach", "AFXRENDERTARGET/CD2DBitmapBrush::Create", "AFXRENDERTARGET/CD2DBitmapBrush::Destroy", "AFXRENDERTARGET/CD2DBitmapBrush::Detach", "AFXRENDERTARGET/CD2DBitmapBrush::Get", "AFXRENDERTARGET/CD2DBitmapBrush::GetBitmap", "AFXRENDERTARGET/CD2DBitmapBrush::GetExtendModeX", "AFXRENDERTARGET/CD2DBitmapBrush::GetExtendModeY", "AFXRENDERTARGET/CD2DBitmapBrush::GetInterpolationMode", "AFXRENDERTARGET/CD2DBitmapBrush::SetBitmap", "AFXRENDERTARGET/CD2DBitmapBrush::SetExtendModeX", "AFXRENDERTARGET/CD2DBitmapBrush::SetExtendModeY", "AFXRENDERTARGET/CD2DBitmapBrush::SetInterpolationMode", "AFXRENDERTARGET/CD2DBitmapBrush::CommonInit", "AFXRENDERTARGET/CD2DBitmapBrush::m_pBitmap", "AFXRENDERTARGET/CD2DBitmapBrush::m_pBitmapBrush", "AFXRENDERTARGET/CD2DBitmapBrush::m_pBitmapBrushProperties"] helpviewer_keywords: ["CD2DBitmapBrush [MFC], CD2DBitmapBrush", "CD2DBitmapBrush [MFC], Attach", "CD2DBitmapBrush [MFC], Create", "CD2DBitmapBrush [MFC], Destroy", "CD2DBitmapBrush [MFC], Detach", "CD2DBitmapBrush [MFC], Get", "CD2DBitmapBrush [MFC], GetBitmap", "CD2DBitmapBrush [MFC], GetExtendModeX", "CD2DBitmapBrush [MFC], GetExtendModeY", "CD2DBitmapBrush [MFC], GetInterpolationMode", "CD2DBitmapBrush [MFC], SetBitmap", "CD2DBitmapBrush [MFC], SetExtendModeX", "CD2DBitmapBrush [MFC], SetExtendModeY", "CD2DBitmapBrush [MFC], SetInterpolationMode", "CD2DBitmapBrush [MFC], CommonInit", "CD2DBitmapBrush [MFC], m_pBitmap", "CD2DBitmapBrush [MFC], m_pBitmapBrush", "CD2DBitmapBrush [MFC], m_pBitmapBrushProperties"] -ms.assetid: 46ebbe34-66e0-44c8-af1d-d129e851de5e --- # CD2DBitmapBrush Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1BitmapBrush. ## Syntax diff --git a/docs/mfc/reference/cd2dbrush-class.md b/docs/mfc/reference/cd2dbrush-class.md index 937159f7684..cc583fd9207 100644 --- a/docs/mfc/reference/cd2dbrush-class.md +++ b/docs/mfc/reference/cd2dbrush-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CD2DBrush [MFC], CD2DBrush", "CD2DBrush [MFC], Attach", " --- # `CD2DBrush` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for `ID2D1Brush`. ## Syntax diff --git a/docs/mfc/reference/cd2dbrushproperties-class.md b/docs/mfc/reference/cd2dbrushproperties-class.md index c28b4ec6722..527c0480618 100644 --- a/docs/mfc/reference/cd2dbrushproperties-class.md +++ b/docs/mfc/reference/cd2dbrushproperties-class.md @@ -4,10 +4,12 @@ title: "CD2DBrushProperties Class" ms.date: "11/04/2016" f1_keywords: ["CD2DBrushProperties", "AFXRENDERTARGET/CD2DBrushProperties", "AFXRENDERTARGET/CD2DBrushProperties::CD2DBrushProperties", "AFXRENDERTARGET/CD2DBrushProperties::CommonInit"] helpviewer_keywords: ["CD2DBrushProperties [MFC], CD2DBrushProperties", "CD2DBrushProperties [MFC], CommonInit"] -ms.assetid: c77d717f-0a16-4d74-b2ce-0ae1766ed6f9 --- # CD2DBrushProperties Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for `D2D1_BRUSH_PROPERTIES`. ## Syntax diff --git a/docs/mfc/reference/cd2dellipse-class.md b/docs/mfc/reference/cd2dellipse-class.md index dbe03207497..29caf8cb670 100644 --- a/docs/mfc/reference/cd2dellipse-class.md +++ b/docs/mfc/reference/cd2dellipse-class.md @@ -4,10 +4,12 @@ title: "CD2DEllipse Class" ms.date: "08/29/2019" f1_keywords: ["CD2DEllipse", "AFXRENDERTARGET/CD2DEllipse", "AFXRENDERTARGET/CD2DEllipse::CD2DEllipse"] helpviewer_keywords: ["CD2DEllipse [MFC], CD2DEllipse"] -ms.assetid: e9f02f54-acf2-427e-b349-db50cd9a77df --- # CD2DEllipse Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for `D2D1_ELLIPSE`. ## Syntax diff --git a/docs/mfc/reference/cd2dgeometry-class.md b/docs/mfc/reference/cd2dgeometry-class.md index e15757a9764..30b66e593e1 100644 --- a/docs/mfc/reference/cd2dgeometry-class.md +++ b/docs/mfc/reference/cd2dgeometry-class.md @@ -4,10 +4,12 @@ title: "CD2DGeometry Class" ms.date: "11/04/2016" f1_keywords: ["CD2DGeometry", "AFXRENDERTARGET/CD2DGeometry", "AFXRENDERTARGET/CD2DGeometry::CD2DGeometry", "AFXRENDERTARGET/CD2DGeometry::Attach", "AFXRENDERTARGET/CD2DGeometry::CombineWithGeometry", "AFXRENDERTARGET/CD2DGeometry::CompareWithGeometry", "AFXRENDERTARGET/CD2DGeometry::ComputeArea", "AFXRENDERTARGET/CD2DGeometry::ComputeLength", "AFXRENDERTARGET/CD2DGeometry::ComputePointAtLength", "AFXRENDERTARGET/CD2DGeometry::Destroy", "AFXRENDERTARGET/CD2DGeometry::Detach", "AFXRENDERTARGET/CD2DGeometry::FillContainsPoint", "AFXRENDERTARGET/CD2DGeometry::Get", "AFXRENDERTARGET/CD2DGeometry::GetBounds", "AFXRENDERTARGET/CD2DGeometry::GetWidenedBounds", "AFXRENDERTARGET/CD2DGeometry::IsValid", "AFXRENDERTARGET/CD2DGeometry::Outline", "AFXRENDERTARGET/CD2DGeometry::Simplify", "AFXRENDERTARGET/CD2DGeometry::StrokeContainsPoint", "AFXRENDERTARGET/CD2DGeometry::Tessellate", "AFXRENDERTARGET/CD2DGeometry::Widen", "AFXRENDERTARGET/CD2DGeometry::m_pGeometry"] helpviewer_keywords: ["CD2DGeometry [MFC], CD2DGeometry", "CD2DGeometry [MFC], Attach", "CD2DGeometry [MFC], CombineWithGeometry", "CD2DGeometry [MFC], CompareWithGeometry", "CD2DGeometry [MFC], ComputeArea", "CD2DGeometry [MFC], ComputeLength", "CD2DGeometry [MFC], ComputePointAtLength", "CD2DGeometry [MFC], Destroy", "CD2DGeometry [MFC], Detach", "CD2DGeometry [MFC], FillContainsPoint", "CD2DGeometry [MFC], Get", "CD2DGeometry [MFC], GetBounds", "CD2DGeometry [MFC], GetWidenedBounds", "CD2DGeometry [MFC], IsValid", "CD2DGeometry [MFC], Outline", "CD2DGeometry [MFC], Simplify", "CD2DGeometry [MFC], StrokeContainsPoint", "CD2DGeometry [MFC], Tessellate", "CD2DGeometry [MFC], Widen", "CD2DGeometry [MFC], m_pGeometry"] -ms.assetid: 3f95054b-fdb8-4e87-87f2-9fc3df7279ec --- # CD2DGeometry Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1Geometry. ## Syntax diff --git a/docs/mfc/reference/cd2dgeometrysink-class.md b/docs/mfc/reference/cd2dgeometrysink-class.md index ca50d6fef2a..f48b0a0569e 100644 --- a/docs/mfc/reference/cd2dgeometrysink-class.md +++ b/docs/mfc/reference/cd2dgeometrysink-class.md @@ -4,10 +4,12 @@ title: "CD2DGeometrySink Class" ms.date: "11/04/2016" f1_keywords: ["CD2DGeometrySink", "AFXRENDERTARGET/CD2DGeometrySink", "AFXRENDERTARGET/CD2DGeometrySink::CD2DGeometrySink", "AFXRENDERTARGET/CD2DGeometrySink::AddArc", "AFXRENDERTARGET/CD2DGeometrySink::AddBezier", "AFXRENDERTARGET/CD2DGeometrySink::AddBeziers", "AFXRENDERTARGET/CD2DGeometrySink::AddLine", "AFXRENDERTARGET/CD2DGeometrySink::AddLines", "AFXRENDERTARGET/CD2DGeometrySink::AddQuadraticBezier", "AFXRENDERTARGET/CD2DGeometrySink::AddQuadraticBeziers", "AFXRENDERTARGET/CD2DGeometrySink::BeginFigure", "AFXRENDERTARGET/CD2DGeometrySink::Close", "AFXRENDERTARGET/CD2DGeometrySink::EndFigure", "AFXRENDERTARGET/CD2DGeometrySink::Get", "AFXRENDERTARGET/CD2DGeometrySink::IsValid", "AFXRENDERTARGET/CD2DGeometrySink::SetFillMode", "AFXRENDERTARGET/CD2DGeometrySink::SetSegmentFlags", "AFXRENDERTARGET/CD2DGeometrySink::m_pSink"] helpviewer_keywords: ["CD2DGeometrySink [MFC], CD2DGeometrySink", "CD2DGeometrySink [MFC], AddArc", "CD2DGeometrySink [MFC], AddBezier", "CD2DGeometrySink [MFC], AddBeziers", "CD2DGeometrySink [MFC], AddLine", "CD2DGeometrySink [MFC], AddLines", "CD2DGeometrySink [MFC], AddQuadraticBezier", "CD2DGeometrySink [MFC], AddQuadraticBeziers", "CD2DGeometrySink [MFC], BeginFigure", "CD2DGeometrySink [MFC], Close", "CD2DGeometrySink [MFC], EndFigure", "CD2DGeometrySink [MFC], Get", "CD2DGeometrySink [MFC], IsValid", "CD2DGeometrySink [MFC], SetFillMode", "CD2DGeometrySink [MFC], SetSegmentFlags", "CD2DGeometrySink [MFC], m_pSink"] -ms.assetid: e5e07f41-0343-4ab1-9d6b-8c62ed33c04a --- # CD2DGeometrySink Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1GeometrySink. ## Syntax diff --git a/docs/mfc/reference/cd2dgradientbrush-class.md b/docs/mfc/reference/cd2dgradientbrush-class.md index f6611d222e0..b5c69b59e7e 100644 --- a/docs/mfc/reference/cd2dgradientbrush-class.md +++ b/docs/mfc/reference/cd2dgradientbrush-class.md @@ -4,10 +4,12 @@ title: "CD2DGradientBrush Class" ms.date: "03/27/2019" f1_keywords: ["CD2DGradientBrush", "AFXRENDERTARGET/CD2DGradientBrush", "AFXRENDERTARGET/CD2DGradientBrush::CD2DGradientBrush", "AFXRENDERTARGET/CD2DGradientBrush::Destroy", "AFXRENDERTARGET/CD2DGradientBrush::m_arGradientStops", "AFXRENDERTARGET/CD2DGradientBrush::m_colorInterpolationGamma", "AFXRENDERTARGET/CD2DGradientBrush::m_extendMode", "AFXRENDERTARGET/CD2DGradientBrush::m_pGradientStops"] helpviewer_keywords: ["CD2DGradientBrush [MFC], CD2DGradientBrush", "CD2DGradientBrush [MFC], Destroy", "CD2DGradientBrush [MFC], m_arGradientStops", "CD2DGradientBrush [MFC], m_colorInterpolationGamma", "CD2DGradientBrush [MFC], m_extendMode", "CD2DGradientBrush [MFC], m_pGradientStops"] -ms.assetid: 5bf133e6-16b7-4e3a-845d-0ce63fafe5ec --- # CD2DGradientBrush Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class of the CD2DLinearGradientBrush and the CD2DRadialGradientBrush classes. ## Syntax diff --git a/docs/mfc/reference/cd2dlayer-class.md b/docs/mfc/reference/cd2dlayer-class.md index 71d22b6df07..504d7151232 100644 --- a/docs/mfc/reference/cd2dlayer-class.md +++ b/docs/mfc/reference/cd2dlayer-class.md @@ -4,10 +4,12 @@ title: "CD2DLayer Class" ms.date: "11/04/2016" f1_keywords: ["CD2DLayer", "AFXRENDERTARGET/CD2DLayer", "AFXRENDERTARGET/CD2DLayer::CD2DLayer", "AFXRENDERTARGET/CD2DLayer::Attach", "AFXRENDERTARGET/CD2DLayer::Create", "AFXRENDERTARGET/CD2DLayer::Destroy", "AFXRENDERTARGET/CD2DLayer::Detach", "AFXRENDERTARGET/CD2DLayer::Get", "AFXRENDERTARGET/CD2DLayer::GetSize", "AFXRENDERTARGET/CD2DLayer::IsValid", "AFXRENDERTARGET/CD2DLayer::m_pLayer"] helpviewer_keywords: ["CD2DLayer [MFC], CD2DLayer", "CD2DLayer [MFC], Attach", "CD2DLayer [MFC], Create", "CD2DLayer [MFC], Destroy", "CD2DLayer [MFC], Detach", "CD2DLayer [MFC], Get", "CD2DLayer [MFC], GetSize", "CD2DLayer [MFC], IsValid", "CD2DLayer [MFC], m_pLayer"] -ms.assetid: 2f96378e-66bb-40d1-9661-6afe324de3c1 --- # CD2DLayer Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1Layer. ## Syntax diff --git a/docs/mfc/reference/cd2dlineargradientbrush-class.md b/docs/mfc/reference/cd2dlineargradientbrush-class.md index 70c1ca78877..dc008c90e2c 100644 --- a/docs/mfc/reference/cd2dlineargradientbrush-class.md +++ b/docs/mfc/reference/cd2dlineargradientbrush-class.md @@ -4,10 +4,12 @@ title: "CD2DLinearGradientBrush Class" ms.date: "11/04/2016" f1_keywords: ["CD2DLinearGradientBrush", "AFXRENDERTARGET/CD2DLinearGradientBrush", "AFXRENDERTARGET/CD2DLinearGradientBrush::CD2DLinearGradientBrush", "AFXRENDERTARGET/CD2DLinearGradientBrush::Attach", "AFXRENDERTARGET/CD2DLinearGradientBrush::Create", "AFXRENDERTARGET/CD2DLinearGradientBrush::Destroy", "AFXRENDERTARGET/CD2DLinearGradientBrush::Detach", "AFXRENDERTARGET/CD2DLinearGradientBrush::Get", "AFXRENDERTARGET/CD2DLinearGradientBrush::GetEndPoint", "AFXRENDERTARGET/CD2DLinearGradientBrush::GetStartPoint", "AFXRENDERTARGET/CD2DLinearGradientBrush::SetEndPoint", "AFXRENDERTARGET/CD2DLinearGradientBrush::SetStartPoint", "AFXRENDERTARGET/CD2DLinearGradientBrush::m_LinearGradientBrushProperties", "AFXRENDERTARGET/CD2DLinearGradientBrush::m_pLinearGradientBrush"] helpviewer_keywords: ["CD2DLinearGradientBrush [MFC], CD2DLinearGradientBrush", "CD2DLinearGradientBrush [MFC], Attach", "CD2DLinearGradientBrush [MFC], Create", "CD2DLinearGradientBrush [MFC], Destroy", "CD2DLinearGradientBrush [MFC], Detach", "CD2DLinearGradientBrush [MFC], Get", "CD2DLinearGradientBrush [MFC], GetEndPoint", "CD2DLinearGradientBrush [MFC], GetStartPoint", "CD2DLinearGradientBrush [MFC], SetEndPoint", "CD2DLinearGradientBrush [MFC], SetStartPoint", "CD2DLinearGradientBrush [MFC], m_LinearGradientBrushProperties", "CD2DLinearGradientBrush [MFC], m_pLinearGradientBrush"] -ms.assetid: d4be9ff9-0ea8-45e6-9b8d-f3bc5673cbac --- # CD2DLinearGradientBrush Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1LinearGradientBrush. ## Syntax diff --git a/docs/mfc/reference/cd2dmesh-class.md b/docs/mfc/reference/cd2dmesh-class.md index 1c00d6b8ab2..7b769ec7df4 100644 --- a/docs/mfc/reference/cd2dmesh-class.md +++ b/docs/mfc/reference/cd2dmesh-class.md @@ -4,10 +4,12 @@ title: "CD2DMesh Class" ms.date: "11/04/2016" f1_keywords: ["CD2DMesh", "AFXRENDERTARGET/CD2DMesh", "AFXRENDERTARGET/CD2DMesh::CD2DMesh", "AFXRENDERTARGET/CD2DMesh::Attach", "AFXRENDERTARGET/CD2DMesh::Create", "AFXRENDERTARGET/CD2DMesh::Destroy", "AFXRENDERTARGET/CD2DMesh::Detach", "AFXRENDERTARGET/CD2DMesh::Get", "AFXRENDERTARGET/CD2DMesh::IsValid", "AFXRENDERTARGET/CD2DMesh::Open", "AFXRENDERTARGET/CD2DMesh::m_pMesh"] helpviewer_keywords: ["CD2DMesh [MFC], CD2DMesh", "CD2DMesh [MFC], Attach", "CD2DMesh [MFC], Create", "CD2DMesh [MFC], Destroy", "CD2DMesh [MFC], Detach", "CD2DMesh [MFC], Get", "CD2DMesh [MFC], IsValid", "CD2DMesh [MFC], Open", "CD2DMesh [MFC], m_pMesh"] -ms.assetid: 11a2c78a-1367-40e8-a34f-44aa0509a4c9 --- # CD2DMesh Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1Mesh. ## Syntax diff --git a/docs/mfc/reference/cd2dpathgeometry-class.md b/docs/mfc/reference/cd2dpathgeometry-class.md index c8a92594575..5b7fd0c32a3 100644 --- a/docs/mfc/reference/cd2dpathgeometry-class.md +++ b/docs/mfc/reference/cd2dpathgeometry-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CD2DPathGeometry [MFC], CD2DPathGeometry", "CD2DPathGeome --- # CD2DPathGeometry Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1PathGeometry. ## Syntax diff --git a/docs/mfc/reference/cd2dpointf-class.md b/docs/mfc/reference/cd2dpointf-class.md index da1e32fae53..be72cbd1f06 100644 --- a/docs/mfc/reference/cd2dpointf-class.md +++ b/docs/mfc/reference/cd2dpointf-class.md @@ -4,10 +4,12 @@ title: "CD2DPointF Class" ms.date: "11/04/2016" f1_keywords: ["CD2DPointF", "AFXRENDERTARGET/CD2DPointF", "AFXRENDERTARGET/CD2DPointF::CD2DPointF"] helpviewer_keywords: ["CD2DPointF [MFC], CD2DPointF"] -ms.assetid: 30f72083-1c8a-4f50-adb2-72dbbe3522d4 --- # CD2DPointF Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for `D2D1_POINT_2F`. ## Syntax diff --git a/docs/mfc/reference/cd2dpointu-class.md b/docs/mfc/reference/cd2dpointu-class.md index a7496417187..40d1d16f15e 100644 --- a/docs/mfc/reference/cd2dpointu-class.md +++ b/docs/mfc/reference/cd2dpointu-class.md @@ -4,10 +4,12 @@ title: "CD2DPointU Class" ms.date: "08/29/2019" f1_keywords: ["CD2DPointU", "AFXRENDERTARGET/CD2DPointU", "AFXRENDERTARGET/CD2DPointU::CD2DPointU"] helpviewer_keywords: ["CD2DPointU [MFC], CD2DPointU"] -ms.assetid: 04733f96-b6de-4a89-82e3-caad1e8087a9 --- # CD2DPointU Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for `D2D1_POINT_2U`. ## Syntax diff --git a/docs/mfc/reference/cd2dradialgradientbrush-class.md b/docs/mfc/reference/cd2dradialgradientbrush-class.md index 6bedb70852f..3cd841c1f05 100644 --- a/docs/mfc/reference/cd2dradialgradientbrush-class.md +++ b/docs/mfc/reference/cd2dradialgradientbrush-class.md @@ -4,10 +4,12 @@ title: "CD2DRadialGradientBrush Class" ms.date: "11/04/2016" f1_keywords: ["CD2DRadialGradientBrush", "AFXRENDERTARGET/CD2DRadialGradientBrush", "AFXRENDERTARGET/CD2DRadialGradientBrush::CD2DRadialGradientBrush", "AFXRENDERTARGET/CD2DRadialGradientBrush::Attach", "AFXRENDERTARGET/CD2DRadialGradientBrush::Create", "AFXRENDERTARGET/CD2DRadialGradientBrush::Destroy", "AFXRENDERTARGET/CD2DRadialGradientBrush::Detach", "AFXRENDERTARGET/CD2DRadialGradientBrush::Get", "AFXRENDERTARGET/CD2DRadialGradientBrush::GetCenter", "AFXRENDERTARGET/CD2DRadialGradientBrush::GetGradientOriginOffset", "AFXRENDERTARGET/CD2DRadialGradientBrush::GetRadiusX", "AFXRENDERTARGET/CD2DRadialGradientBrush::GetRadiusY", "AFXRENDERTARGET/CD2DRadialGradientBrush::SetCenter", "AFXRENDERTARGET/CD2DRadialGradientBrush::SetGradientOriginOffset", "AFXRENDERTARGET/CD2DRadialGradientBrush::SetRadiusX", "AFXRENDERTARGET/CD2DRadialGradientBrush::SetRadiusY", "AFXRENDERTARGET/CD2DRadialGradientBrush::m_pRadialGradientBrush", "AFXRENDERTARGET/CD2DRadialGradientBrush::m_RadialGradientBrushProperties"] helpviewer_keywords: ["CD2DRadialGradientBrush [MFC], CD2DRadialGradientBrush", "CD2DRadialGradientBrush [MFC], Attach", "CD2DRadialGradientBrush [MFC], Create", "CD2DRadialGradientBrush [MFC], Destroy", "CD2DRadialGradientBrush [MFC], Detach", "CD2DRadialGradientBrush [MFC], Get", "CD2DRadialGradientBrush [MFC], GetCenter", "CD2DRadialGradientBrush [MFC], GetGradientOriginOffset", "CD2DRadialGradientBrush [MFC], GetRadiusX", "CD2DRadialGradientBrush [MFC], GetRadiusY", "CD2DRadialGradientBrush [MFC], SetCenter", "CD2DRadialGradientBrush [MFC], SetGradientOriginOffset", "CD2DRadialGradientBrush [MFC], SetRadiusX", "CD2DRadialGradientBrush [MFC], SetRadiusY", "CD2DRadialGradientBrush [MFC], m_pRadialGradientBrush", "CD2DRadialGradientBrush [MFC], m_RadialGradientBrushProperties"] -ms.assetid: 6c76d84a-d831-4ee2-96f1-82c1f5b0d6a9 --- # CD2DRadialGradientBrush Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1RadialGradientBrush. ## Syntax diff --git a/docs/mfc/reference/cd2drectf-class.md b/docs/mfc/reference/cd2drectf-class.md index 967b8fb9227..9f04d36e4ed 100644 --- a/docs/mfc/reference/cd2drectf-class.md +++ b/docs/mfc/reference/cd2drectf-class.md @@ -4,10 +4,12 @@ title: "CD2DRectF Class" ms.date: "11/04/2016" f1_keywords: ["CD2DRectF", "AFXRENDERTARGET/CD2DRectF", "AFXRENDERTARGET/CD2DRectF::CD2DRectF", "AFXRENDERTARGET/CD2DRectF::IsNull"] helpviewer_keywords: ["CD2DRectF [MFC], CD2DRectF", "CD2DRectF [MFC], IsNull"] -ms.assetid: 87c12d87-9d18-4a19-ba14-0f51d6b6835a --- # CD2DRectF Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for `D2D1_RECT_F`. ## Syntax diff --git a/docs/mfc/reference/cd2drectu-class.md b/docs/mfc/reference/cd2drectu-class.md index 2e49d1489ae..a88732c9fb7 100644 --- a/docs/mfc/reference/cd2drectu-class.md +++ b/docs/mfc/reference/cd2drectu-class.md @@ -4,10 +4,12 @@ title: "CD2DRectU Class" ms.date: "11/04/2016" f1_keywords: ["CD2DRectU", "AFXRENDERTARGET/CD2DRectU", "AFXRENDERTARGET/CD2DRectU::CD2DRectU", "AFXRENDERTARGET/CD2DRectU::IsNull"] helpviewer_keywords: ["CD2DRectU [MFC], CD2DRectU", "CD2DRectU [MFC], IsNull"] -ms.assetid: a62f17d1-011d-4867-8f51-fd7e7c00561d --- # CD2DRectU Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for `D2D1_RECT_U`. ## Syntax diff --git a/docs/mfc/reference/cd2dresource-class.md b/docs/mfc/reference/cd2dresource-class.md index fa6c42d756a..d4e355f07f3 100644 --- a/docs/mfc/reference/cd2dresource-class.md +++ b/docs/mfc/reference/cd2dresource-class.md @@ -4,10 +4,12 @@ title: "CD2DResource Class" ms.date: "03/27/2019" f1_keywords: ["CD2DResource", "AFXRENDERTARGET/CD2DResource", "AFXRENDERTARGET/CD2DResource::CD2DResource", "AFXRENDERTARGET/CD2DResource::Create", "AFXRENDERTARGET/CD2DResource::Destroy", "AFXRENDERTARGET/CD2DResource::IsValid", "AFXRENDERTARGET/CD2DResource::IsAutoDestroy", "AFXRENDERTARGET/CD2DResource::ReCreate", "AFXRENDERTARGET/CD2DResource::m_bIsAutoDestroy", "AFXRENDERTARGET/CD2DResource::m_pParentTarget"] helpviewer_keywords: ["CD2DResource [MFC], CD2DResource", "CD2DResource [MFC], Create", "CD2DResource [MFC], Destroy", "CD2DResource [MFC], IsValid", "CD2DResource [MFC], IsAutoDestroy", "CD2DResource [MFC], ReCreate", "CD2DResource [MFC], m_bIsAutoDestroy", "CD2DResource [MFC], m_pParentTarget"] -ms.assetid: 34e3ee18-aab6-4c39-9294-de869e1f7820 --- # CD2DResource Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An abstract class that provides an interface for creating and managing D2D resources such as brushes, layers, and texts. ## Syntax diff --git a/docs/mfc/reference/cd2droundedrect-class.md b/docs/mfc/reference/cd2droundedrect-class.md index fc3e784f5ef..e93423f089c 100644 --- a/docs/mfc/reference/cd2droundedrect-class.md +++ b/docs/mfc/reference/cd2droundedrect-class.md @@ -4,10 +4,12 @@ title: "CD2DRoundedRect Class" ms.date: "11/04/2016" f1_keywords: ["CD2DRoundedRect", "AFXRENDERTARGET/CD2DRoundedRect", "AFXRENDERTARGET/CD2DRoundedRect::CD2DRoundedRect"] helpviewer_keywords: ["CD2DRoundedRect [MFC], CD2DRoundedRect"] -ms.assetid: 06207fb5-e92b-41c0-bceb-b45d8f466531 --- # CD2DRoundedRect Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for `D2D1_ROUNDED_RECT`. ## Syntax diff --git a/docs/mfc/reference/cd2dsizef-class.md b/docs/mfc/reference/cd2dsizef-class.md index 5b1d39d894a..a4458cedd76 100644 --- a/docs/mfc/reference/cd2dsizef-class.md +++ b/docs/mfc/reference/cd2dsizef-class.md @@ -4,10 +4,12 @@ title: "CD2DSizeF Class" ms.date: "08/29/2019" f1_keywords: ["CD2DSizeF", "AFXRENDERTARGET/CD2DSizeF", "AFXRENDERTARGET/CD2DSizeF::CD2DSizeF", "AFXRENDERTARGET/CD2DSizeF::IsNull"] helpviewer_keywords: ["CD2DSizeF [MFC], CD2DSizeF", "CD2DSizeF [MFC], IsNull"] -ms.assetid: f486a1e1-997d-4286-8cb9-26369dc82055 --- # CD2DSizeF Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for D2D1_SIZE_F. ## Syntax diff --git a/docs/mfc/reference/cd2dsizeu-class.md b/docs/mfc/reference/cd2dsizeu-class.md index 464d7d1b622..819e251ae7b 100644 --- a/docs/mfc/reference/cd2dsizeu-class.md +++ b/docs/mfc/reference/cd2dsizeu-class.md @@ -4,10 +4,12 @@ title: "CD2DSizeU Class" ms.date: "08/29/2019" f1_keywords: ["CD2DSizeU", "AFXRENDERTARGET/CD2DSizeU", "AFXRENDERTARGET/CD2DSizeU::CD2DSizeU", "AFXRENDERTARGET/CD2DSizeU::IsNull"] helpviewer_keywords: ["CD2DSizeU [MFC], CD2DSizeU", "CD2DSizeU [MFC], IsNull"] -ms.assetid: 6e679ba8-2112-43c3-8275-70b660856f02 --- # CD2DSizeU Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for D2D1_SIZE_U. ## Syntax diff --git a/docs/mfc/reference/cd2dsolidcolorbrush-class.md b/docs/mfc/reference/cd2dsolidcolorbrush-class.md index 177c2fc3fef..c343346e6a8 100644 --- a/docs/mfc/reference/cd2dsolidcolorbrush-class.md +++ b/docs/mfc/reference/cd2dsolidcolorbrush-class.md @@ -4,10 +4,12 @@ title: "CD2DSolidColorBrush Class" ms.date: "03/27/2019" f1_keywords: ["CD2DSolidColorBrush", "AFXRENDERTARGET/CD2DSolidColorBrush", "AFXRENDERTARGET/CD2DSolidColorBrush::CD2DSolidColorBrush", "AFXRENDERTARGET/CD2DSolidColorBrush::Attach", "AFXRENDERTARGET/CD2DSolidColorBrush::Create", "AFXRENDERTARGET/CD2DSolidColorBrush::Destroy", "AFXRENDERTARGET/CD2DSolidColorBrush::Detach", "AFXRENDERTARGET/CD2DSolidColorBrush::Get", "AFXRENDERTARGET/CD2DSolidColorBrush::GetColor", "AFXRENDERTARGET/CD2DSolidColorBrush::SetColor", "AFXRENDERTARGET/CD2DSolidColorBrush::m_colorSolid", "AFXRENDERTARGET/CD2DSolidColorBrush::m_pSolidColorBrush"] helpviewer_keywords: ["CD2DSolidColorBrush [MFC], CD2DSolidColorBrush", "CD2DSolidColorBrush [MFC], Attach", "CD2DSolidColorBrush [MFC], Create", "CD2DSolidColorBrush [MFC], Destroy", "CD2DSolidColorBrush [MFC], Detach", "CD2DSolidColorBrush [MFC], Get", "CD2DSolidColorBrush [MFC], GetColor", "CD2DSolidColorBrush [MFC], SetColor", "CD2DSolidColorBrush [MFC], m_colorSolid", "CD2DSolidColorBrush [MFC], m_pSolidColorBrush"] -ms.assetid: d4506637-acce-4f74-8a9b-f0a45571a735 --- # CD2DSolidColorBrush Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1SolidColorBrush. ## Syntax diff --git a/docs/mfc/reference/cd2dtextformat-class.md b/docs/mfc/reference/cd2dtextformat-class.md index 258818a08a6..94bffc9c182 100644 --- a/docs/mfc/reference/cd2dtextformat-class.md +++ b/docs/mfc/reference/cd2dtextformat-class.md @@ -4,10 +4,12 @@ title: "CD2DTextFormat Class" ms.date: "03/27/2019" f1_keywords: ["CD2DTextFormat", "AFXRENDERTARGET/CD2DTextFormat", "AFXRENDERTARGET/CD2DTextFormat::CD2DTextFormat", "AFXRENDERTARGET/CD2DTextFormat::Create", "AFXRENDERTARGET/CD2DTextFormat::Destroy", "AFXRENDERTARGET/CD2DTextFormat::Get", "AFXRENDERTARGET/CD2DTextFormat::GetFontFamilyName", "AFXRENDERTARGET/CD2DTextFormat::GetLocaleName", "AFXRENDERTARGET/CD2DTextFormat::IsValid", "AFXRENDERTARGET/CD2DTextFormat::ReCreate", "AFXRENDERTARGET/CD2DTextFormat::m_pTextFormat"] helpviewer_keywords: ["CD2DTextFormat [MFC], CD2DTextFormat", "CD2DTextFormat [MFC], Create", "CD2DTextFormat [MFC], Destroy", "CD2DTextFormat [MFC], Get", "CD2DTextFormat [MFC], GetFontFamilyName", "CD2DTextFormat [MFC], GetLocaleName", "CD2DTextFormat [MFC], IsValid", "CD2DTextFormat [MFC], ReCreate", "CD2DTextFormat [MFC], m_pTextFormat"] -ms.assetid: db194cec-9dae-4644-ab84-7c43b7164117 --- # CD2DTextFormat Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for IDWriteTextFormat. ## Syntax diff --git a/docs/mfc/reference/cd2dtextlayout-class.md b/docs/mfc/reference/cd2dtextlayout-class.md index 02fe965fb31..574552a8d41 100644 --- a/docs/mfc/reference/cd2dtextlayout-class.md +++ b/docs/mfc/reference/cd2dtextlayout-class.md @@ -4,10 +4,12 @@ title: "CD2DTextLayout Class" ms.date: "03/27/2019" f1_keywords: ["CD2DTextLayout", "AFXRENDERTARGET/CD2DTextLayout", "AFXRENDERTARGET/CD2DTextLayout::CD2DTextLayout", "AFXRENDERTARGET/CD2DTextLayout::Create", "AFXRENDERTARGET/CD2DTextLayout::Destroy", "AFXRENDERTARGET/CD2DTextLayout::Get", "AFXRENDERTARGET/CD2DTextLayout::GetFontFamilyName", "AFXRENDERTARGET/CD2DTextLayout::GetLocaleName", "AFXRENDERTARGET/CD2DTextLayout::IsValid", "AFXRENDERTARGET/CD2DTextLayout::ReCreate", "AFXRENDERTARGET/CD2DTextLayout::SetFontFamilyName", "AFXRENDERTARGET/CD2DTextLayout::SetLocaleName", "AFXRENDERTARGET/CD2DTextLayout::m_pTextLayout"] helpviewer_keywords: ["CD2DTextLayout [MFC], CD2DTextLayout", "CD2DTextLayout [MFC], Create", "CD2DTextLayout [MFC], Destroy", "CD2DTextLayout [MFC], Get", "CD2DTextLayout [MFC], GetFontFamilyName", "CD2DTextLayout [MFC], GetLocaleName", "CD2DTextLayout [MFC], IsValid", "CD2DTextLayout [MFC], ReCreate", "CD2DTextLayout [MFC], SetFontFamilyName", "CD2DTextLayout [MFC], SetLocaleName", "CD2DTextLayout [MFC], m_pTextLayout"] -ms.assetid: 724bd13c-f2ef-4e55-a775-8cb04b7b7908 --- # CD2DTextLayout Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for IDWriteTextLayout. ## Syntax diff --git a/docs/mfc/reference/cdaodatabase-class.md b/docs/mfc/reference/cdaodatabase-class.md index f1b5b85af32..817e7f6ea26 100644 --- a/docs/mfc/reference/cdaodatabase-class.md +++ b/docs/mfc/reference/cdaodatabase-class.md @@ -8,6 +8,9 @@ ms.custom: sfi-ropc-nochange --- # CDaoDatabase Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a connection to an Access database using Data Access Objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaodatabaseinfo-structure.md b/docs/mfc/reference/cdaodatabaseinfo-structure.md index 24d774536be..e01c08c24f7 100644 --- a/docs/mfc/reference/cdaodatabaseinfo-structure.md +++ b/docs/mfc/reference/cdaodatabaseinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoDatabaseInfo structure [MFC]", "DAO (Data Access Obje --- # CDaoDatabaseInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoDatabaseInfo` structure contains information about a database object defined for data access objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaoerrorinfo-structure.md b/docs/mfc/reference/cdaoerrorinfo-structure.md index 0848f939efa..4e34fad326c 100644 --- a/docs/mfc/reference/cdaoerrorinfo-structure.md +++ b/docs/mfc/reference/cdaoerrorinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoErrorInfo structure [MFC]", "DAO (Data Access Objects --- # CDaoErrorInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoErrorInfo` structure contains information about an error object defined for data access objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaoexception-class.md b/docs/mfc/reference/cdaoexception-class.md index 7092121b13f..d0d03730f6b 100644 --- a/docs/mfc/reference/cdaoexception-class.md +++ b/docs/mfc/reference/cdaoexception-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoException [MFC], CDaoException", "CDaoException [MFC] --- # CDaoException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents an exception condition arising from the MFC database classes based on data access objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaofieldexchange-class.md b/docs/mfc/reference/cdaofieldexchange-class.md index 47e1f63124f..af11986eaa1 100644 --- a/docs/mfc/reference/cdaofieldexchange-class.md +++ b/docs/mfc/reference/cdaofieldexchange-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoFieldExchange [MFC], IsValidOperation", "CDaoFieldExc --- # CDaoFieldExchange Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports the DAO record field exchange (DFX) routines used by the DAO database classes. > [!NOTE] diff --git a/docs/mfc/reference/cdaofieldinfo-structure.md b/docs/mfc/reference/cdaofieldinfo-structure.md index 1935ec2f72b..6db2749e23d 100644 --- a/docs/mfc/reference/cdaofieldinfo-structure.md +++ b/docs/mfc/reference/cdaofieldinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["DAO (Data Access Objects), Fields collection", "CDaoField --- # CDaoFieldInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoFieldInfo` structure contains information about a field object defined for data access objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaoindexfieldinfo-structure.md b/docs/mfc/reference/cdaoindexfieldinfo-structure.md index c75e91b5865..b7b20cca2d7 100644 --- a/docs/mfc/reference/cdaoindexfieldinfo-structure.md +++ b/docs/mfc/reference/cdaoindexfieldinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoIndexFieldInfo structure [MFC]", "DAO (Data Access Ob --- # CDaoIndexFieldInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoIndexFieldInfo` structure contains information about an index field object defined for data access objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaoindexinfo-structure.md b/docs/mfc/reference/cdaoindexinfo-structure.md index e7558e5bae8..be9ddb6cda6 100644 --- a/docs/mfc/reference/cdaoindexinfo-structure.md +++ b/docs/mfc/reference/cdaoindexinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["DAO (Data Access Objects), Indexes collection", "CDaoInde --- # CDaoIndexInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoIndexInfo` structure contains information about an index object defined for data access objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaoparameterinfo-structure.md b/docs/mfc/reference/cdaoparameterinfo-structure.md index d2d54d4df78..4fcf70aef04 100644 --- a/docs/mfc/reference/cdaoparameterinfo-structure.md +++ b/docs/mfc/reference/cdaoparameterinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoParameterInfo structure [MFC]", "DAO (Data Access Obj --- # CDaoParameterInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoParameterInfo` structure contains information about a parameter object defined for data access objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaoquerydef-class.md b/docs/mfc/reference/cdaoquerydef-class.md index a8f573e6927..a9a1a58c780 100644 --- a/docs/mfc/reference/cdaoquerydef-class.md +++ b/docs/mfc/reference/cdaoquerydef-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoQueryDef [MFC], CDaoQueryDef", "CDaoQueryDef [MFC], A --- # `CDaoQueryDef` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a query definition, or "querydef," usually one saved in a database. > [!NOTE] diff --git a/docs/mfc/reference/cdaoquerydefinfo-structure.md b/docs/mfc/reference/cdaoquerydefinfo-structure.md index 78fed0c2d26..189ccc92e46 100644 --- a/docs/mfc/reference/cdaoquerydefinfo-structure.md +++ b/docs/mfc/reference/cdaoquerydefinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["DAO (Data Access Objects), QueryDefs collection", "CDaoQu --- # CDaoQueryDefInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoQueryDefInfo` structure contains information about a querydef object defined for data access objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaorecordset-class.md b/docs/mfc/reference/cdaorecordset-class.md index 4525538078a..5e2e7a99aaa 100644 --- a/docs/mfc/reference/cdaorecordset-class.md +++ b/docs/mfc/reference/cdaorecordset-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoRecordset [MFC], CDaoRecordset", "CDaoRecordset [MFC] --- # CDaoRecordset Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a set of records selected from a data source. > [!NOTE] diff --git a/docs/mfc/reference/cdaorecordview-class.md b/docs/mfc/reference/cdaorecordview-class.md index e2baaabc9ec..ac74d10bda4 100644 --- a/docs/mfc/reference/cdaorecordview-class.md +++ b/docs/mfc/reference/cdaorecordview-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoRecordView [MFC], CDaoRecordView", "CDaoRecordView [M --- # CDaoRecordView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A view that displays database records in controls. > [!NOTE] diff --git a/docs/mfc/reference/cdaorelationfieldinfo-structure.md b/docs/mfc/reference/cdaorelationfieldinfo-structure.md index af98cdba7ea..fca6e68a814 100644 --- a/docs/mfc/reference/cdaorelationfieldinfo-structure.md +++ b/docs/mfc/reference/cdaorelationfieldinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["DAO (Data Access Objects), Relations collection", "CDaoRe --- # CDaoRelationFieldInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoRelationFieldInfo` structure contains information about a field in a relation defined for data access objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaorelationinfo-structure.md b/docs/mfc/reference/cdaorelationinfo-structure.md index d93623b3d76..23b62170c85 100644 --- a/docs/mfc/reference/cdaorelationinfo-structure.md +++ b/docs/mfc/reference/cdaorelationinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["DAO (Data Access Objects), Relations collection", "CDaoRe --- # CDaoRelationInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoRelationInfo` structure contains information about a relation defined between fields of two tables in a [`CDaoDatabase`](../../mfc/reference/cdaodatabase-class.md) object. > [!NOTE] diff --git a/docs/mfc/reference/cdaotabledef-class.md b/docs/mfc/reference/cdaotabledef-class.md index 8e9f63fcc55..2c76e899c5f 100644 --- a/docs/mfc/reference/cdaotabledef-class.md +++ b/docs/mfc/reference/cdaotabledef-class.md @@ -8,6 +8,9 @@ ms.custom: sfi-ropc-nochange --- # CDaoTableDef Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents the stored definition of a base table or an attached table. > [!NOTE] diff --git a/docs/mfc/reference/cdaotabledefinfo-structure.md b/docs/mfc/reference/cdaotabledefinfo-structure.md index ca83c7daed9..d554bc069f5 100644 --- a/docs/mfc/reference/cdaotabledefinfo-structure.md +++ b/docs/mfc/reference/cdaotabledefinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoTableDefInfo structure [MFC]", "DAO (Data Access Obje --- # CDaoTableDefInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoTableDefInfo` structure contains information about a tabledef object defined for data access objects (DAO). > [!NOTE] diff --git a/docs/mfc/reference/cdaoworkspace-class.md b/docs/mfc/reference/cdaoworkspace-class.md index 0f1ddba2a65..b482e263b68 100644 --- a/docs/mfc/reference/cdaoworkspace-class.md +++ b/docs/mfc/reference/cdaoworkspace-class.md @@ -8,6 +8,9 @@ ms.custom: sfi-ropc-nochange --- # CDaoWorkspace Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages a named, password-protected database session from login to logoff, by a single user. > [!NOTE] diff --git a/docs/mfc/reference/cdaoworkspaceinfo-structure.md b/docs/mfc/reference/cdaoworkspaceinfo-structure.md index 906f4cc2f35..b35ed93deab 100644 --- a/docs/mfc/reference/cdaoworkspaceinfo-structure.md +++ b/docs/mfc/reference/cdaoworkspaceinfo-structure.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDaoWorkspaceInfo structure [MFC]", "DAO (Data Access Obj --- # CDaoWorkspaceInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDaoWorkspaceInfo` structure contains information about a workspace defined for data access objects (DAO) database access. > [!NOTE] diff --git a/docs/mfc/reference/cdatabase-class.md b/docs/mfc/reference/cdatabase-class.md index 7258c18594b..b6b22b72799 100644 --- a/docs/mfc/reference/cdatabase-class.md +++ b/docs/mfc/reference/cdatabase-class.md @@ -8,6 +8,9 @@ ms.custom: sfi-ropc-nochange --- # `CDatabase` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a connection to a data source, through which you can operate on the data source. ## Syntax diff --git a/docs/mfc/reference/cdataexchange-class.md b/docs/mfc/reference/cdataexchange-class.md index 36773b0d836..c8db1f00f28 100644 --- a/docs/mfc/reference/cdataexchange-class.md +++ b/docs/mfc/reference/cdataexchange-class.md @@ -4,10 +4,12 @@ title: "CDataExchange Class" ms.date: "11/04/2016" f1_keywords: ["CDataExchange", "AFXWIN/CDataExchange", "AFXWIN/CDataExchange::CDataExchange", "AFXWIN/CDataExchange::Fail", "AFXWIN/CDataExchange::PrepareCtrl", "AFXWIN/CDataExchange::PrepareEditCtrl", "AFXWIN/CDataExchange::PrepareOleCtrl", "AFXWIN/CDataExchange::m_bSaveAndValidate", "AFXWIN/CDataExchange::m_pDlgWnd"] helpviewer_keywords: ["CDataExchange [MFC], CDataExchange", "CDataExchange [MFC], Fail", "CDataExchange [MFC], PrepareCtrl", "CDataExchange [MFC], PrepareEditCtrl", "CDataExchange [MFC], PrepareOleCtrl", "CDataExchange [MFC], m_bSaveAndValidate", "CDataExchange [MFC], m_pDlgWnd"] -ms.assetid: 84ed6113-325d-493e-a75d-223f03a992b8 --- # CDataExchange Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports the dialog data exchange (DDX) and dialog data validation (DDV) routines used by the Microsoft Foundation classes. ## Syntax diff --git a/docs/mfc/reference/cdatapathproperty-class.md b/docs/mfc/reference/cdatapathproperty-class.md index 46de01c0c6b..d98aad1fe22 100644 --- a/docs/mfc/reference/cdatapathproperty-class.md +++ b/docs/mfc/reference/cdatapathproperty-class.md @@ -4,10 +4,12 @@ title: "CDataPathProperty Class" ms.date: "11/04/2016" f1_keywords: ["CDataPathProperty", "AFXCTL/CDataPathProperty", "AFXCTL/CDataPathProperty::CDataPathProperty", "AFXCTL/CDataPathProperty::GetControl", "AFXCTL/CDataPathProperty::GetPath", "AFXCTL/CDataPathProperty::Open", "AFXCTL/CDataPathProperty::ResetData", "AFXCTL/CDataPathProperty::SetControl", "AFXCTL/CDataPathProperty::SetPath"] helpviewer_keywords: ["CDataPathProperty [MFC], CDataPathProperty", "CDataPathProperty [MFC], GetControl", "CDataPathProperty [MFC], GetPath", "CDataPathProperty [MFC], Open", "CDataPathProperty [MFC], ResetData", "CDataPathProperty [MFC], SetControl", "CDataPathProperty [MFC], SetPath"] -ms.assetid: 1f96efdb-54e4-460b-862c-eba5d4103488 --- # CDataPathProperty Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements an OLE control property that can be loaded asynchronously. ## Syntax diff --git a/docs/mfc/reference/cdatarecoveryhandler-class.md b/docs/mfc/reference/cdatarecoveryhandler-class.md index e66f75c9646..8c5793cbe90 100644 --- a/docs/mfc/reference/cdatarecoveryhandler-class.md +++ b/docs/mfc/reference/cdatarecoveryhandler-class.md @@ -4,10 +4,12 @@ title: "CDataRecoveryHandler Class" ms.date: "03/27/2019" f1_keywords: ["CDataRecoveryHandler", "AFXDATARECOVERY/CDataRecoveryHandler", "AFXDATARECOVERY/CDataRecoveryHandler::CDataRecoveryHandler", "AFXDATARECOVERY/CDataRecoveryHandler::AutosaveAllDocumentInfo", "AFXDATARECOVERY/CDataRecoveryHandler::AutosaveDocumentInfo", "AFXDATARECOVERY/CDataRecoveryHandler::CreateDocumentInfo", "AFXDATARECOVERY/CDataRecoveryHandler::DeleteAllAutosavedFiles", "AFXDATARECOVERY/CDataRecoveryHandler::DeleteAutosavedFile", "AFXDATARECOVERY/CDataRecoveryHandler::GenerateAutosaveFileName", "AFXDATARECOVERY/CDataRecoveryHandler::GetAutosaveInterval", "AFXDATARECOVERY/CDataRecoveryHandler::GetAutosavePath", "AFXDATARECOVERY/CDataRecoveryHandler::GetDocumentListName", "AFXDATARECOVERY/CDataRecoveryHandler::GetNormalDocumentTitle", "AFXDATARECOVERY/CDataRecoveryHandler::GetRecoveredDocumentTitle", "AFXDATARECOVERY/CDataRecoveryHandler::GetRestartIdentifier", "AFXDATARECOVERY/CDataRecoveryHandler::GetSaveDocumentInfoOnIdle", "AFXDATARECOVERY/CDataRecoveryHandler::GetShutdownByRestartManager", "AFXDATARECOVERY/CDataRecoveryHandler::Initialize", "AFXDATARECOVERY/CDataRecoveryHandler::QueryRestoreAutosavedDocuments", "AFXDATARECOVERY/CDataRecoveryHandler::ReadOpenDocumentList", "AFXDATARECOVERY/CDataRecoveryHandler::RemoveDocumentInfo", "AFXDATARECOVERY/CDataRecoveryHandler::ReopenPreviousDocuments", "AFXDATARECOVERY/CDataRecoveryHandler::RestoreAutosavedDocuments", "AFXDATARECOVERY/CDataRecoveryHandler::SaveOpenDocumentList", "AFXDATARECOVERY/CDataRecoveryHandler::SetAutosaveInterval", "AFXDATARECOVERY/CDataRecoveryHandler::SetAutosavePath", "AFXDATARECOVERY/CDataRecoveryHandler::SetRestartIdentifier", "AFXDATARECOVERY/CDataRecoveryHandler::SetSaveDocumentInfoOnIdle", "AFXDATARECOVERY/CDataRecoveryHandler::SetShutdownByRestartManager", "AFXDATARECOVERY/CDataRecoveryHandler::UpdateDocumentInfo"] helpviewer_keywords: ["CDataRecoveryHandler [MFC], CDataRecoveryHandler", "CDataRecoveryHandler [MFC], AutosaveAllDocumentInfo", "CDataRecoveryHandler [MFC], AutosaveDocumentInfo", "CDataRecoveryHandler [MFC], CreateDocumentInfo", "CDataRecoveryHandler [MFC], DeleteAllAutosavedFiles", "CDataRecoveryHandler [MFC], DeleteAutosavedFile", "CDataRecoveryHandler [MFC], GenerateAutosaveFileName", "CDataRecoveryHandler [MFC], GetAutosaveInterval", "CDataRecoveryHandler [MFC], GetAutosavePath", "CDataRecoveryHandler [MFC], GetDocumentListName", "CDataRecoveryHandler [MFC], GetNormalDocumentTitle", "CDataRecoveryHandler [MFC], GetRecoveredDocumentTitle", "CDataRecoveryHandler [MFC], GetRestartIdentifier", "CDataRecoveryHandler [MFC], GetSaveDocumentInfoOnIdle", "CDataRecoveryHandler [MFC], GetShutdownByRestartManager", "CDataRecoveryHandler [MFC], Initialize", "CDataRecoveryHandler [MFC], QueryRestoreAutosavedDocuments", "CDataRecoveryHandler [MFC], ReadOpenDocumentList", "CDataRecoveryHandler [MFC], RemoveDocumentInfo", "CDataRecoveryHandler [MFC], ReopenPreviousDocuments", "CDataRecoveryHandler [MFC], RestoreAutosavedDocuments", "CDataRecoveryHandler [MFC], SaveOpenDocumentList", "CDataRecoveryHandler [MFC], SetAutosaveInterval", "CDataRecoveryHandler [MFC], SetAutosavePath", "CDataRecoveryHandler [MFC], SetRestartIdentifier", "CDataRecoveryHandler [MFC], SetSaveDocumentInfoOnIdle", "CDataRecoveryHandler [MFC], SetShutdownByRestartManager", "CDataRecoveryHandler [MFC], UpdateDocumentInfo"] -ms.assetid: 7794802c-e583-4eba-90b9-2fed1a161f9c --- # CDataRecoveryHandler Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDataRecoveryHandler` autosaves documents and restores them if an application unexpectedly exits. ## Syntax diff --git a/docs/mfc/reference/cdatetimectrl-class.md b/docs/mfc/reference/cdatetimectrl-class.md index 095b88b9642..92549d32217 100644 --- a/docs/mfc/reference/cdatetimectrl-class.md +++ b/docs/mfc/reference/cdatetimectrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDateTimeCtrl [MFC], CDateTimeCtrl", "CDateTimeCtrl [MFC] --- # `CDateTimeCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the functionality of a date and time picker control. ## Syntax diff --git a/docs/mfc/reference/cdbexception-class.md b/docs/mfc/reference/cdbexception-class.md index 741ced39720..0c142000f01 100644 --- a/docs/mfc/reference/cdbexception-class.md +++ b/docs/mfc/reference/cdbexception-class.md @@ -4,10 +4,12 @@ title: "CDBException Class" ms.date: "11/04/2016" f1_keywords: ["CDBException", "AFXDB/CDBException", "AFXDB/CDBException::m_nRetCode", "AFXDB/CDBException::m_strError", "AFXDB/CDBException::m_strStateNativeOrigin"] helpviewer_keywords: ["CDBException [MFC], m_nRetCode", "CDBException [MFC], m_strError", "CDBException [MFC], m_strStateNativeOrigin"] -ms.assetid: eb9e1119-89f5-49a7-b9d4-b91cee1ccc82 --- # CDBException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents an exception condition arising from the database classes. ## Syntax diff --git a/docs/mfc/reference/cdbvariant-class.md b/docs/mfc/reference/cdbvariant-class.md index f752d848dae..585531dc9ab 100644 --- a/docs/mfc/reference/cdbvariant-class.md +++ b/docs/mfc/reference/cdbvariant-class.md @@ -4,10 +4,12 @@ title: "CDBVariant Class" ms.date: "11/04/2016" f1_keywords: ["CDBVariant", "AFXDB/CDBVariant", "AFXDB/CDBVariant::CDBVariant", "AFXDB/CDBVariant::Clear", "AFXDB/CDBVariant::m_dwType", "AFXDB/CDBVariant::m_boolVal", "AFXDB/CDBVariant::m_chVal", "AFXDB/CDBVariant::m_dblVal", "AFXDB/CDBVariant::m_fltVal", "AFXDB/CDBVariant::m_iVal", "AFXDB/CDBVariant::m_lVal", "AFXDB/CDBVariant::m_pbinary", "AFXDB/CDBVariant::m_pdate", "AFXDB/CDBVariant::m_pstring", "AFXDB/CDBVariant::m_pstringA", "AFXDB/CDBVariant::m_pstringW"] helpviewer_keywords: ["CDBVariant [MFC], CDBVariant", "CDBVariant [MFC], Clear", "CDBVariant [MFC], m_dwType", "CDBVariant [MFC], m_boolVal", "CDBVariant [MFC], m_chVal", "CDBVariant [MFC], m_dblVal", "CDBVariant [MFC], m_fltVal", "CDBVariant [MFC], m_iVal", "CDBVariant [MFC], m_lVal", "CDBVariant [MFC], m_pbinary", "CDBVariant [MFC], m_pdate", "CDBVariant [MFC], m_pstring", "CDBVariant [MFC], m_pstringA", "CDBVariant [MFC], m_pstringW"] -ms.assetid: de23609c-c560-4b24-bd6b-9d8903fd5b49 --- # CDBVariant Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a variant data type for the MFC ODBC classes. ## Syntax diff --git a/docs/mfc/reference/cdc-class.md b/docs/mfc/reference/cdc-class.md index 910c96cad27..0ab4a2f4054 100644 --- a/docs/mfc/reference/cdc-class.md +++ b/docs/mfc/reference/cdc-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDC [MFC], CDC", "CDC [MFC], AbortDoc", "CDC [MFC], Abort --- # `CDC` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Defines a class of device-context objects. ## Syntax @@ -1643,7 +1646,7 @@ Specifies the last value returned by the [callback function](callback-functions- For each object of a given type, the callback function that you pass is called with the information for that object. The system calls the callback function until there are no more objects or the callback function returns 0. -New features of Microsoft Visual C++ let you use an ordinary function as the function passed to `EnumObjects`. The address passed to `EnumObjects` is a pointer to a function exported with **`EXPORT`** and with the Pascal calling convention. In protect-mode applications, you don't have to create this function with the Windows `MakeProcInstance` function or free the function after use with the `FreeProcInstance` Windows function. +New features of Visual Studio let you use an ordinary function as the function passed to `EnumObjects`. The address passed to `EnumObjects` is a pointer to a function exported with **`EXPORT`** and with the Pascal calling convention. In protect-mode applications, you don't have to create this function with the Windows `MakeProcInstance` function or free the function after use with the `FreeProcInstance` Windows function. You also don't have to export the function name in an **`EXPORTS`** statement in your application's module-definition file. You can instead use the **`EXPORT`** function modifier, as in @@ -5336,7 +5339,7 @@ Specifies the outcome of the `SetAbortProc` function. Some of the following valu If an application is to allow the print job to be canceled during spooling, it must set the abort function before the print job is started with the [`StartDoc`](#startdoc) member function. The Print Manager calls the abort function during spooling to allow the application to cancel the print job or to process out-of-disk-space conditions. If no abort function is set, the print job will fail if there isn't enough disk space for spooling. -The features of Microsoft Visual C++ simplify the creation of the callback function passed to `SetAbortProc`. The address passed to the `EnumObjects` member function is a pointer to a function exported with `__declspec(dllexport)` and with the **`__stdcall`** calling convention. +The features of Visual Studio simplify the creation of the callback function passed to `SetAbortProc`. The address passed to the `EnumObjects` member function is a pointer to a function exported with `__declspec(dllexport)` and with the **`__stdcall`** calling convention. You also don't have to export the function name in an **`EXPORTS`** statement in your application's module-definition file. You can instead use the **`EXPORT`** function modifier, as in diff --git a/docs/mfc/reference/cdcrendertarget-class.md b/docs/mfc/reference/cdcrendertarget-class.md index 6a191229ba9..43ae0089a83 100644 --- a/docs/mfc/reference/cdcrendertarget-class.md +++ b/docs/mfc/reference/cdcrendertarget-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDCRenderTarget [MFC], CDCRenderTarget", "CDCRenderTarget --- # `CDCRenderTarget` class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for [`ID2D1DCRenderTarget`](/windows/win32/api/d2d1/nn-d2d1-id2d1dcrendertarget). ## Syntax diff --git a/docs/mfc/reference/cdhtmldialog-class.md b/docs/mfc/reference/cdhtmldialog-class.md index 82562ba5ad2..afad32ba58d 100644 --- a/docs/mfc/reference/cdhtmldialog-class.md +++ b/docs/mfc/reference/cdhtmldialog-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDHtmlDialog [MFC], CDHtmlDialog", "CDHtmlDialog [MFC], C --- # `CDHtmlDialog` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Is used to create dialog boxes that use HTML rather than dialog resources to implement their user interface. ## Syntax diff --git a/docs/mfc/reference/cdialog-class.md b/docs/mfc/reference/cdialog-class.md index fa6866e8b86..dfd80214b40 100644 --- a/docs/mfc/reference/cdialog-class.md +++ b/docs/mfc/reference/cdialog-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDialog [MFC], CDialog", "CDialog [MFC], Create", "CDialo --- # CDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class used for displaying dialog boxes on the screen. ## Syntax diff --git a/docs/mfc/reference/cdialogbar-class.md b/docs/mfc/reference/cdialogbar-class.md index 8d8c5acd272..1bd4ddb3413 100644 --- a/docs/mfc/reference/cdialogbar-class.md +++ b/docs/mfc/reference/cdialogbar-class.md @@ -4,10 +4,12 @@ title: "CDialogBar Class" ms.date: "11/04/2016" f1_keywords: ["CDialogBar", "AFXEXT/CDialogBar", "AFXEXT/CDialogBar::CDialogBar", "AFXEXT/CDialogBar::Create"] helpviewer_keywords: ["CDialogBar [MFC], CDialogBar", "CDialogBar [MFC], Create"] -ms.assetid: da2f7a30-970c-44e3-87f0-6094bd002cab --- # CDialogBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a Windows modeless dialog box in a control bar. ## Syntax @@ -39,7 +41,7 @@ Creating and using a dialog bar is similar to creating and using a `CFormView` o For more information on `CDialogBar`, see the article [Dialog Bars](../../mfc/dialog-bars.md) and [Technical Note 31](../../mfc/tn031-control-bars.md), Control Bars. > [!NOTE] -> In the current release, a `CDialogBar` object cannot host Windows Forms controls. For more information about Windows Forms controls in Visual C++, see [Using a Windows Form User Control in MFC](../../dotnet/using-a-windows-form-user-control-in-mfc.md). +> In the current release, a `CDialogBar` object cannot host Windows Forms controls. For more information about Windows Forms controls in Visual Studio, see [Using a Windows Form User Control in MFC](../../dotnet/using-a-windows-form-user-control-in-mfc.md). ## Inheritance Hierarchy diff --git a/docs/mfc/reference/cdialogex-class.md b/docs/mfc/reference/cdialogex-class.md index f2b25ce85ee..06f3d5289ca 100644 --- a/docs/mfc/reference/cdialogex-class.md +++ b/docs/mfc/reference/cdialogex-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDialogEx [MFC], CDialogEx", "CDialogEx [MFC], SetBackgro --- # `CDialogEx` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDialogEx` class specifies the background color and background image of a dialog box. ## Syntax diff --git a/docs/mfc/reference/cdiscretetransition-class.md b/docs/mfc/reference/cdiscretetransition-class.md index 19fc03b66bb..252551cbaed 100644 --- a/docs/mfc/reference/cdiscretetransition-class.md +++ b/docs/mfc/reference/cdiscretetransition-class.md @@ -4,10 +4,12 @@ title: "CDiscreteTransition Class" ms.date: "11/04/2016" f1_keywords: ["CDiscreteTransition", "AFXANIMATIONCONTROLLER/CDiscreteTransition", "AFXANIMATIONCONTROLLER/CDiscreteTransition::CDiscreteTransition", "AFXANIMATIONCONTROLLER/CDiscreteTransition::Create", "AFXANIMATIONCONTROLLER/CDiscreteTransition::m_dblFinalValue", "AFXANIMATIONCONTROLLER/CDiscreteTransition::m_delay", "AFXANIMATIONCONTROLLER/CDiscreteTransition::m_hold"] helpviewer_keywords: ["CDiscreteTransition [MFC], CDiscreteTransition", "CDiscreteTransition [MFC], Create", "CDiscreteTransition [MFC], m_dblFinalValue", "CDiscreteTransition [MFC], m_delay", "CDiscreteTransition [MFC], m_hold"] -ms.assetid: b4d84fb3-ccaa-451c-a69b-6b50dcb9b9c8 --- # CDiscreteTransition Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a discrete transition. ## Syntax diff --git a/docs/mfc/reference/cdocitem-class.md b/docs/mfc/reference/cdocitem-class.md index 7c8ae289b39..b0bb4ca4108 100644 --- a/docs/mfc/reference/cdocitem-class.md +++ b/docs/mfc/reference/cdocitem-class.md @@ -4,10 +4,12 @@ title: "CDocItem Class" ms.date: "11/04/2016" f1_keywords: ["CDocItem", "AFXOLE/CDocItem", "AFXOLE/CDocItem::GetDocument", "AFXOLE/CDocItem::IsBlank"] helpviewer_keywords: ["CDocItem [MFC], GetDocument", "CDocItem [MFC], IsBlank"] -ms.assetid: 84fb8610-a4c8-4211-adc0-e70e8d002c11 --- # CDocItem Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class for document items, which are components of a document's data. ## Syntax diff --git a/docs/mfc/reference/cdockablepane-class.md b/docs/mfc/reference/cdockablepane-class.md index cd6f7131161..a52ecfb1a54 100644 --- a/docs/mfc/reference/cdockablepane-class.md +++ b/docs/mfc/reference/cdockablepane-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDockablePane [MFC], CDockablePane", "CDockablePane [MFC] --- # `CDockablePane` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a pane that can either be docked in a dock site or included in a tabbed pane. ## Syntax diff --git a/docs/mfc/reference/cdockablepaneadapter-class.md b/docs/mfc/reference/cdockablepaneadapter-class.md index 4c483e1e874..a9f0e5685b9 100644 --- a/docs/mfc/reference/cdockablepaneadapter-class.md +++ b/docs/mfc/reference/cdockablepaneadapter-class.md @@ -4,10 +4,12 @@ title: "CDockablePaneAdapter Class" ms.date: "11/04/2016" f1_keywords: ["CDockablePaneAdapter", "AFXDOCKABLEPANEADAPTER/CDockablePaneAdapter", "AFXDOCKABLEPANEADAPTER/CDockablePaneAdapter::GetWrappedWnd", "AFXDOCKABLEPANEADAPTER/CDockablePaneAdapter::LoadState", "AFXDOCKABLEPANEADAPTER/CDockablePaneAdapter::SaveState", "AFXDOCKABLEPANEADAPTER/CDockablePaneAdapter::SetWrappedWnd"] helpviewer_keywords: ["CDockablePaneAdapter [MFC], GetWrappedWnd", "CDockablePaneAdapter [MFC], LoadState", "CDockablePaneAdapter [MFC], SaveState", "CDockablePaneAdapter [MFC], SetWrappedWnd"] -ms.assetid: 6ed6cf82-f39c-4d0c-bf7c-8641495cf8f3 --- # CDockablePaneAdapter Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides docking support for `CWnd`-derived panes. ## Syntax diff --git a/docs/mfc/reference/cdockingmanager-class.md b/docs/mfc/reference/cdockingmanager-class.md index e3fe1e204bd..972e77d344e 100644 --- a/docs/mfc/reference/cdockingmanager-class.md +++ b/docs/mfc/reference/cdockingmanager-class.md @@ -4,10 +4,12 @@ title: "CDockingManager Class" ms.date: "11/04/2016" f1_keywords: ["CDockingManager", "AFXDOCKINGMANAGER/CDockingManager", "AFXDOCKINGMANAGER/CDockingManager::AddDockSite", "AFXDOCKINGMANAGER/CDockingManager::AddHiddenMDITabbedBar", "AFXDOCKINGMANAGER/CDockingManager::AddMiniFrame", "AFXDOCKINGMANAGER/CDockingManager::AddPane", "AFXDOCKINGMANAGER/CDockingManager::AdjustDockingLayout", "AFXDOCKINGMANAGER/CDockingManager::AdjustPaneFrames", "AFXDOCKINGMANAGER/CDockingManager::AdjustRectToClientArea", "AFXDOCKINGMANAGER/CDockingManager::AlignAutoHidePane", "AFXDOCKINGMANAGER/CDockingManager::AutoHidePane", "AFXDOCKINGMANAGER/CDockingManager::BringBarsToTop", "AFXDOCKINGMANAGER/CDockingManager::BuildPanesMenu", "AFXDOCKINGMANAGER/CDockingManager::CalcExpectedDockedRect", "AFXDOCKINGMANAGER/CDockingManager::Create", "AFXDOCKINGMANAGER/CDockingManager::DeterminePaneAndStatus", "AFXDOCKINGMANAGER/CDockingManager::DisableRestoreDockState", "AFXDOCKINGMANAGER/CDockingManager::DockPane", "AFXDOCKINGMANAGER/CDockingManager::DockPaneLeftOf", "AFXDOCKINGMANAGER/CDockingManager::EnableAutoHidePanes", "AFXDOCKINGMANAGER/CDockingManager::EnableDocking", "AFXDOCKINGMANAGER/CDockingManager::EnableDockSiteMenu", "AFXDOCKINGMANAGER/CDockingManager::EnablePaneContextMenu", "AFXDOCKINGMANAGER/CDockingManager::FindDockSite", "AFXDOCKINGMANAGER/CDockingManager::FindDockSiteByPane", "AFXDOCKINGMANAGER/CDockingManager::FindPaneByID", "AFXDOCKINGMANAGER/CDockingManager::FixupVirtualRects", "AFXDOCKINGMANAGER/CDockingManager::FrameFromPoint", "AFXDOCKINGMANAGER/CDockingManager::GetClientAreaBounds", "AFXDOCKINGMANAGER/CDockingManager::GetDockingMode", "AFXDOCKINGMANAGER/CDockingManager::GetDockSiteFrameWnd", "AFXDOCKINGMANAGER/CDockingManager::GetEnabledAutoHideAlignment", "AFXDOCKINGMANAGER/CDockingManager::GetMiniFrames", "AFXDOCKINGMANAGER/CDockingManager::GetOuterEdgeBounds", "AFXDOCKINGMANAGER/CDockingManager::GetPaneList", "AFXDOCKINGMANAGER/CDockingManager::GetSmartDockingManager", "AFXDOCKINGMANAGER/CDockingManager::GetSmartDockingManagerPermanent", "AFXDOCKINGMANAGER/CDockingManager::GetSmartDockingParams", "AFXDOCKINGMANAGER/CDockingManager::GetSmartDockingTheme", "AFXDOCKINGMANAGER/CDockingManager::HideAutoHidePanes", "AFXDOCKINGMANAGER/CDockingManager::InsertDockSite", "AFXDOCKINGMANAGER/CDockingManager::InsertPane", "AFXDOCKINGMANAGER/CDockingManager::IsDockSiteMenu", "AFXDOCKINGMANAGER/CDockingManager::IsInAdjustLayout", "AFXDOCKINGMANAGER/CDockingManager::IsOLEContainerMode", "AFXDOCKINGMANAGER/CDockingManager::IsPointNearDockSite", "AFXDOCKINGMANAGER/CDockingManager::IsPrintPreviewValid", "AFXDOCKINGMANAGER/CDockingManager::LoadState", "AFXDOCKINGMANAGER/CDockingManager::LockUpdate", "AFXDOCKINGMANAGER/CDockingManager::OnActivateFrame", "AFXDOCKINGMANAGER/CDockingManager::OnClosePopupMenu", "AFXDOCKINGMANAGER/CDockingManager::OnMoveMiniFrame", "AFXDOCKINGMANAGER/CDockingManager::OnPaneContextMenu", "AFXDOCKINGMANAGER/CDockingManager::PaneFromPoint", "AFXDOCKINGMANAGER/CDockingManager::ProcessPaneContextMenuCommand", "AFXDOCKINGMANAGER/CDockingManager::RecalcLayout", "AFXDOCKINGMANAGER/CDockingManager::ReleaseEmptyPaneContainers", "AFXDOCKINGMANAGER/CDockingManager::RemoveHiddenMDITabbedBar", "AFXDOCKINGMANAGER/CDockingManager::RemoveMiniFrame", "AFXDOCKINGMANAGER/CDockingManager::RemovePaneFromDockManager", "AFXDOCKINGMANAGER/CDockingManager::ReplacePane", "AFXDOCKINGMANAGER/CDockingManager::ResortMiniFramesForZOrder", "AFXDOCKINGMANAGER/CDockingManager::SaveState", "AFXDOCKINGMANAGER/CDockingManager::SendMessageToMiniFrames", "AFXDOCKINGMANAGER/CDockingManager::Serialize", "AFXDOCKINGMANAGER/CDockingManager::SetAutohideZOrder", "AFXDOCKINGMANAGER/CDockingManager::SetDockingMode", "AFXDOCKINGMANAGER/CDockingManager::SetDockState", "AFXDOCKINGMANAGER/CDockingManager::SetPrintPreviewMode", "AFXDOCKINGMANAGER/CDockingManager::SetSmartDockingParams", "AFXDOCKINGMANAGER/CDockingManager::ShowDelayShowMiniFrames", "AFXDOCKINGMANAGER/CDockingManager::ShowPanes", "AFXDOCKINGMANAGER/CDockingManager::StartSDocking", "AFXDOCKINGMANAGER/CDockingManager::StopSDocking", "AFXDOCKINGMANAGER/CDockingManager::m_bHideDockingBarsInContainerMode", "AFXDOCKINGMANAGER/CDockingManager::m_dockModeGlobal", "AFXDOCKINGMANAGER/CDockingManager::m_nDockSensitivity", "AFXDOCKINGMANAGER/CDockingManager::m_nTimeOutBeforeDockingBarDock", "AFXDOCKINGMANAGER/CDockingManager::m_nTimeOutBeforeToolBarDock"] helpviewer_keywords: ["CDockingManager [MFC], AddDockSite", "CDockingManager [MFC], AddHiddenMDITabbedBar", "CDockingManager [MFC], AddMiniFrame", "CDockingManager [MFC], AddPane", "CDockingManager [MFC], AdjustDockingLayout", "CDockingManager [MFC], AdjustPaneFrames", "CDockingManager [MFC], AdjustRectToClientArea", "CDockingManager [MFC], AlignAutoHidePane", "CDockingManager [MFC], AutoHidePane", "CDockingManager [MFC], BringBarsToTop", "CDockingManager [MFC], BuildPanesMenu", "CDockingManager [MFC], CalcExpectedDockedRect", "CDockingManager [MFC], Create", "CDockingManager [MFC], DeterminePaneAndStatus", "CDockingManager [MFC], DisableRestoreDockState", "CDockingManager [MFC], DockPane", "CDockingManager [MFC], DockPaneLeftOf", "CDockingManager [MFC], EnableAutoHidePanes", "CDockingManager [MFC], EnableDocking", "CDockingManager [MFC], EnableDockSiteMenu", "CDockingManager [MFC], EnablePaneContextMenu", "CDockingManager [MFC], FindDockSite", "CDockingManager [MFC], FindDockSiteByPane", "CDockingManager [MFC], FindPaneByID", "CDockingManager [MFC], FixupVirtualRects", "CDockingManager [MFC], FrameFromPoint", "CDockingManager [MFC], GetClientAreaBounds", "CDockingManager [MFC], GetDockingMode", "CDockingManager [MFC], GetDockSiteFrameWnd", "CDockingManager [MFC], GetEnabledAutoHideAlignment", "CDockingManager [MFC], GetMiniFrames", "CDockingManager [MFC], GetOuterEdgeBounds", "CDockingManager [MFC], GetPaneList", "CDockingManager [MFC], GetSmartDockingManager", "CDockingManager [MFC], GetSmartDockingManagerPermanent", "CDockingManager [MFC], GetSmartDockingParams", "CDockingManager [MFC], GetSmartDockingTheme", "CDockingManager [MFC], HideAutoHidePanes", "CDockingManager [MFC], InsertDockSite", "CDockingManager [MFC], InsertPane", "CDockingManager [MFC], IsDockSiteMenu", "CDockingManager [MFC], IsInAdjustLayout", "CDockingManager [MFC], IsOLEContainerMode", "CDockingManager [MFC], IsPointNearDockSite", "CDockingManager [MFC], IsPrintPreviewValid", "CDockingManager [MFC], LoadState", "CDockingManager [MFC], LockUpdate", "CDockingManager [MFC], OnActivateFrame", "CDockingManager [MFC], OnClosePopupMenu", "CDockingManager [MFC], OnMoveMiniFrame", "CDockingManager [MFC], OnPaneContextMenu", "CDockingManager [MFC], PaneFromPoint", "CDockingManager [MFC], ProcessPaneContextMenuCommand", "CDockingManager [MFC], RecalcLayout", "CDockingManager [MFC], ReleaseEmptyPaneContainers", "CDockingManager [MFC], RemoveHiddenMDITabbedBar", "CDockingManager [MFC], RemoveMiniFrame", "CDockingManager [MFC], RemovePaneFromDockManager", "CDockingManager [MFC], ReplacePane", "CDockingManager [MFC], ResortMiniFramesForZOrder", "CDockingManager [MFC], SaveState", "CDockingManager [MFC], SendMessageToMiniFrames", "CDockingManager [MFC], Serialize", "CDockingManager [MFC], SetAutohideZOrder", "CDockingManager [MFC], SetDockingMode", "CDockingManager [MFC], SetDockState", "CDockingManager [MFC], SetPrintPreviewMode", "CDockingManager [MFC], SetSmartDockingParams", "CDockingManager [MFC], ShowDelayShowMiniFrames", "CDockingManager [MFC], ShowPanes", "CDockingManager [MFC], StartSDocking", "CDockingManager [MFC], StopSDocking", "CDockingManager [MFC], m_bHideDockingBarsInContainerMode", "CDockingManager [MFC], m_dockModeGlobal", "CDockingManager [MFC], m_nDockSensitivity", "CDockingManager [MFC], m_nTimeOutBeforeDockingBarDock", "CDockingManager [MFC], m_nTimeOutBeforeToolBarDock"] -ms.assetid: 98e69c43-55d8-4f43-b861-4fda80ec1e32 --- # CDockingManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the core functionality that controls docking layout in a main frame window. ## Syntax diff --git a/docs/mfc/reference/cdockingpanesrow-class.md b/docs/mfc/reference/cdockingpanesrow-class.md index ed86e50a70f..be4e8f4a307 100644 --- a/docs/mfc/reference/cdockingpanesrow-class.md +++ b/docs/mfc/reference/cdockingpanesrow-class.md @@ -4,10 +4,12 @@ title: "CDockingPanesRow Class" ms.date: "10/18/2018" f1_keywords: ["CDockingPanesRow", "AFXDOCKINGPANESROW/CDockingPanesRow", "AFXDOCKINGPANESROW/CDockingPanesRow::AddPane", "AFXDOCKINGPANESROW/CDockingPanesRow::AddPaneFromRow", "AFXDOCKINGPANESROW/CDockingPanesRow::ArrangePanes", "AFXDOCKINGPANESROW/CDockingPanesRow::CalcFixedLayout", "AFXDOCKINGPANESROW/CDockingPanesRow::Create", "AFXDOCKINGPANESROW/CDockingPanesRow::ExpandStretchedPanes", "AFXDOCKINGPANESROW/CDockingPanesRow::ExpandStretchedPanesRect", "AFXDOCKINGPANESROW/CDockingPanesRow::FixupVirtualRects", "AFXDOCKINGPANESROW/CDockingPanesRow::GetAvailableLength", "AFXDOCKINGPANESROW/CDockingPanesRow::GetAvailableSpace", "AFXDOCKINGPANESROW/CDockingPanesRow::GetClientRect", "AFXDOCKINGPANESROW/CDockingPanesRow::GetDockSite", "AFXDOCKINGPANESROW/CDockingPanesRow::GetExtraSpace", "AFXDOCKINGPANESROW/CDockingPanesRow::GetGroupFromPane", "AFXDOCKINGPANESROW/CDockingPanesRow::GetID", "AFXDOCKINGPANESROW/CDockingPanesRow::GetMaxPaneSize", "AFXDOCKINGPANESROW/CDockingPanesRow::GetPaneCount", "AFXDOCKINGPANESROW/CDockingPanesRow::GetPaneList", "AFXDOCKINGPANESROW/CDockingPanesRow::GetRowAlignment", "AFXDOCKINGPANESROW/CDockingPanesRow::GetRowHeight", "AFXDOCKINGPANESROW/CDockingPanesRow::GetRowOffset", "AFXDOCKINGPANESROW/CDockingPanesRow::GetVisibleCount", "AFXDOCKINGPANESROW/CDockingPanesRow::GetWindowRect", "AFXDOCKINGPANESROW/CDockingPanesRow::HasPane", "AFXDOCKINGPANESROW/CDockingPanesRow::IsEmpty", "AFXDOCKINGPANESROW/CDockingPanesRow::IsExclusiveRow", "AFXDOCKINGPANESROW/CDockingPanesRow::IsHorizontal", "AFXDOCKINGPANESROW/CDockingPanesRow::IsVisible", "AFXDOCKINGPANESROW/CDockingPanesRow::Move", "AFXDOCKINGPANESROW/CDockingPanesRow::MovePane", "AFXDOCKINGPANESROW/CDockingPanesRow::OnResizePane", "AFXDOCKINGPANESROW/CDockingPanesRow::RedrawAll", "AFXDOCKINGPANESROW/CDockingPanesRow::RemovePane", "AFXDOCKINGPANESROW/CDockingPanesRow::ReplacePane", "AFXDOCKINGPANESROW/CDockingPanesRow::RepositionPanes", "AFXDOCKINGPANESROW/CDockingPanesRow::Resize", "AFXDOCKINGPANESROW/CDockingPanesRow::ResizeByPaneDivider", "AFXDOCKINGPANESROW/CDockingPanesRow::ScreenToClient", "AFXDOCKINGPANESROW/CDockingPanesRow::SetExtra", "AFXDOCKINGPANESROW/CDockingPanesRow::ShowDockSiteRow", "AFXDOCKINGPANESROW/CDockingPanesRow::ShowPane", "AFXDOCKINGPANESROW/CDockingPanesRow::UpdateVisibleState"] helpviewer_keywords: ["CDockingPanesRow [MFC], AddPane", "CDockingPanesRow [MFC], AddPaneFromRow", "CDockingPanesRow [MFC], ArrangePanes", "CDockingPanesRow [MFC], CalcFixedLayout", "CDockingPanesRow [MFC], Create", "CDockingPanesRow [MFC], ExpandStretchedPanes", "CDockingPanesRow [MFC], ExpandStretchedPanesRect", "CDockingPanesRow [MFC], FixupVirtualRects", "CDockingPanesRow [MFC], GetAvailableLength", "CDockingPanesRow [MFC], GetAvailableSpace", "CDockingPanesRow [MFC], GetClientRect", "CDockingPanesRow [MFC], GetDockSite", "CDockingPanesRow [MFC], GetExtraSpace", "CDockingPanesRow [MFC], GetGroupFromPane", "CDockingPanesRow [MFC], GetID", "CDockingPanesRow [MFC], GetMaxPaneSize", "CDockingPanesRow [MFC], GetPaneCount", "CDockingPanesRow [MFC], GetPaneList", "CDockingPanesRow [MFC], GetRowAlignment", "CDockingPanesRow [MFC], GetRowHeight", "CDockingPanesRow [MFC], GetRowOffset", "CDockingPanesRow [MFC], GetVisibleCount", "CDockingPanesRow [MFC], GetWindowRect", "CDockingPanesRow [MFC], HasPane", "CDockingPanesRow [MFC], IsEmpty", "CDockingPanesRow [MFC], IsExclusiveRow", "CDockingPanesRow [MFC], IsHorizontal", "CDockingPanesRow [MFC], IsVisible", "CDockingPanesRow [MFC], Move", "CDockingPanesRow [MFC], MovePane", "CDockingPanesRow [MFC], OnResizePane", "CDockingPanesRow [MFC], RedrawAll", "CDockingPanesRow [MFC], RemovePane", "CDockingPanesRow [MFC], ReplacePane", "CDockingPanesRow [MFC], RepositionPanes", "CDockingPanesRow [MFC], Resize", "CDockingPanesRow [MFC], ResizeByPaneDivider", "CDockingPanesRow [MFC], ScreenToClient", "CDockingPanesRow [MFC], SetExtra", "CDockingPanesRow [MFC], ShowDockSiteRow", "CDockingPanesRow [MFC], ShowPane", "CDockingPanesRow [MFC], UpdateVisibleState"] -ms.assetid: e7a17832-0ebb-4bce-b799-cec9b60f76fe --- # CDockingPanesRow Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages a list of panes that are located in the same horizontal or vertical row (column) of a dock site. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cdocksite-class.md b/docs/mfc/reference/cdocksite-class.md index b8b10362365..810d4522d7b 100644 --- a/docs/mfc/reference/cdocksite-class.md +++ b/docs/mfc/reference/cdocksite-class.md @@ -4,10 +4,12 @@ title: "CDockSite Class" ms.date: "10/18/2018" f1_keywords: ["CDockSite", "AFXDOCKSITE/CDockSite", "AFXDOCKSITE/CDockSite::AddRow", "AFXDOCKSITE/CDockSite::AdjustDockingLayout", "AFXDOCKSITE/CDockSite::AdjustLayout", "AFXDOCKSITE/CDockSite::AlignDockSite", "AFXDOCKSITE/CDockSite::CalcFixedLayout", "AFXDOCKSITE/CDockSite::CanAcceptPane", "AFXDOCKSITE/CDockSite::CreateEx", "AFXDOCKSITE/CDockSite::CreateRow", "AFXDOCKSITE/CDockSite::DockPane", "AFXDOCKSITE/CDockSite::DoesAllowDynInsertBefore", "AFXDOCKSITE/CDockSite::FindRowIndex", "AFXDOCKSITE/CDockSite::FixupVirtualRects", "AFXDOCKSITE/CDockSite::GetDockSiteID", "AFXDOCKSITE/CDockSite::GetDockSiteRowsList", "AFXDOCKSITE/CDockSite::IsAccessibilityCompatible", "AFXDOCKSITE/CDockSite::IsDragMode", "AFXDOCKSITE/CDockSite::IsLastRow", "AFXDOCKSITE/CDockSite::IsRectWithinDockSite", "AFXDOCKSITE/CDockSite::IsResizable", "AFXDOCKSITE/CDockSite::MovePane", "AFXDOCKSITE/CDockSite::OnInsertRow", "AFXDOCKSITE/CDockSite::OnRemoveRow", "AFXDOCKSITE/CDockSite::OnResizeRow", "AFXDOCKSITE/CDockSite::OnSetWindowPos", "AFXDOCKSITE/CDockSite::OnShowRow", "AFXDOCKSITE/CDockSite::OnSizeParent", "AFXDOCKSITE/CDockSite::PaneFromPoint", "AFXDOCKSITE/CDockSite::DockPaneLeftOf", "AFXDOCKSITE/CDockSite::FindPaneByID", "AFXDOCKSITE/CDockSite::GetPaneList", "AFXDOCKSITE/CDockSite::RectSideFromPoint", "AFXDOCKSITE/CDockSite::RemovePane", "AFXDOCKSITE/CDockSite::RemoveRow", "AFXDOCKSITE/CDockSite::ReplacePane", "AFXDOCKSITE/CDockSite::RepositionPanes", "AFXDOCKSITE/CDockSite::ResizeDockSite", "AFXDOCKSITE/CDockSite::ResizeRow", "AFXDOCKSITE/CDockSite::ShowPane", "AFXDOCKSITE/CDockSite::ShowRow", "AFXDOCKSITE/CDockSite::SwapRows"] helpviewer_keywords: ["CDockSite [MFC], AddRow", "CDockSite [MFC], AdjustDockingLayout", "CDockSite [MFC], AdjustLayout", "CDockSite [MFC], AlignDockSite", "CDockSite [MFC], CalcFixedLayout", "CDockSite [MFC], CanAcceptPane", "CDockSite [MFC], CreateEx", "CDockSite [MFC], CreateRow", "CDockSite [MFC], DockPane", "CDockSite [MFC], DoesAllowDynInsertBefore", "CDockSite [MFC], FindRowIndex", "CDockSite [MFC], FixupVirtualRects", "CDockSite [MFC], GetDockSiteID", "CDockSite [MFC], GetDockSiteRowsList", "CDockSite [MFC], IsAccessibilityCompatible", "CDockSite [MFC], IsDragMode", "CDockSite [MFC], IsLastRow", "CDockSite [MFC], IsRectWithinDockSite", "CDockSite [MFC], IsResizable", "CDockSite [MFC], MovePane", "CDockSite [MFC], OnInsertRow", "CDockSite [MFC], OnRemoveRow", "CDockSite [MFC], OnResizeRow", "CDockSite [MFC], OnSetWindowPos", "CDockSite [MFC], OnShowRow", "CDockSite [MFC], OnSizeParent", "CDockSite [MFC], PaneFromPoint", "CDockSite [MFC], DockPaneLeftOf", "CDockSite [MFC], FindPaneByID", "CDockSite [MFC], GetPaneList", "CDockSite [MFC], RectSideFromPoint", "CDockSite [MFC], RemovePane", "CDockSite [MFC], RemoveRow", "CDockSite [MFC], ReplacePane", "CDockSite [MFC], RepositionPanes", "CDockSite [MFC], ResizeDockSite", "CDockSite [MFC], ResizeRow", "CDockSite [MFC], ShowPane", "CDockSite [MFC], ShowRow", "CDockSite [MFC], SwapRows"] -ms.assetid: 0fcfff79-5f50-4281-b2de-a55653bbea40 --- # CDockSite Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. Provides functionality for arranging panes that are derived from the [CPane Class](../../mfc/reference/cpane-class.md) into sets of rows. diff --git a/docs/mfc/reference/cdockstate-class.md b/docs/mfc/reference/cdockstate-class.md index 573f914f69e..2cf9a40a24d 100644 --- a/docs/mfc/reference/cdockstate-class.md +++ b/docs/mfc/reference/cdockstate-class.md @@ -4,10 +4,12 @@ title: "CDockState Class" ms.date: "11/04/2016" f1_keywords: ["CDockState", "AFXADV/CDockState", "AFXADV/CDockState::Clear", "AFXADV/CDockState::GetVersion", "AFXADV/CDockState::LoadState", "AFXADV/CDockState::SaveState", "AFXADV/CDockState::m_arrBarInfo"] helpviewer_keywords: ["CDockState [MFC], Clear", "CDockState [MFC], GetVersion", "CDockState [MFC], LoadState", "CDockState [MFC], SaveState", "CDockState [MFC], m_arrBarInfo"] -ms.assetid: 09e7c10b-3abd-4cb2-ad36-42420fe6bc36 --- # CDockState Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A serialized `CObject` class that loads, unloads, or clears the state of one or more docking control bars in persistent memory (a file). ## Syntax diff --git a/docs/mfc/reference/cdocobjectserver-class.md b/docs/mfc/reference/cdocobjectserver-class.md index b99f2715ac6..706cee08863 100644 --- a/docs/mfc/reference/cdocobjectserver-class.md +++ b/docs/mfc/reference/cdocobjectserver-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDocObjectServer [MFC], CDocObjectServer", "CDocObjectSer --- # CDocObjectServer Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the additional OLE interfaces needed to make a normal `COleDocument` server into a full DocObject server: `IOleDocument`, `IOleDocumentView`, `IOleCommandTarget`, and `IPrint`. ## Syntax diff --git a/docs/mfc/reference/cdocobjectserveritem-class.md b/docs/mfc/reference/cdocobjectserveritem-class.md index 04f07c5cba0..373797418d1 100644 --- a/docs/mfc/reference/cdocobjectserveritem-class.md +++ b/docs/mfc/reference/cdocobjectserveritem-class.md @@ -4,10 +4,12 @@ title: "CDocObjectServerItem Class" ms.date: "03/27/2019" f1_keywords: ["CDocObjectServerItem", "AFXDOCOB/CDocObjectServerItem", "AFXDOCOB/CDocObjectServerItem::CDocObjectServerItem", "AFXDOCOB/CDocObjectServerItem::GetDocument", "AFXDOCOB/CDocObjectServerItem::OnDoVerb", "AFXDOCOB/CDocObjectServerItem::OnHide", "AFXDOCOB/CDocObjectServerItem::OnShow"] helpviewer_keywords: ["CDocObjectServerItem [MFC], CDocObjectServerItem", "CDocObjectServerItem [MFC], GetDocument", "CDocObjectServerItem [MFC], OnDoVerb", "CDocObjectServerItem [MFC], OnHide", "CDocObjectServerItem [MFC], OnShow"] -ms.assetid: 530f7156-50c8-4806-9328-602c9133f622 --- # CDocObjectServerItem Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements OLE server verbs specifically for DocObject servers. ## Syntax diff --git a/docs/mfc/reference/cdoctemplate-class.md b/docs/mfc/reference/cdoctemplate-class.md index f82442239b9..37cdf1a2d6d 100644 --- a/docs/mfc/reference/cdoctemplate-class.md +++ b/docs/mfc/reference/cdoctemplate-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CDocTemplate [MFC], CDocTemplate", "CDocTemplate [MFC], A --- # `CDocTemplate` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An abstract base class that defines the basic functionality for document templates. ## Syntax diff --git a/docs/mfc/reference/cdocument-class.md b/docs/mfc/reference/cdocument-class.md index 53f7c00e9c9..8fe635eee58 100644 --- a/docs/mfc/reference/cdocument-class.md +++ b/docs/mfc/reference/cdocument-class.md @@ -4,10 +4,12 @@ title: "CDocument Class" ms.date: "11/04/2016" f1_keywords: ["CDocument", "AFXWIN/CDocument", "AFXWIN/CDocument::CDocument", "AFXWIN/CDocument::AddView", "AFXWIN/CDocument::BeginReadChunks", "AFXWIN/CDocument::CanCloseFrame", "AFXWIN/CDocument::ClearChunkList", "AFXWIN/CDocument::ClearPathName", "AFXWIN/CDocument::DeleteContents", "AFXWIN/CDocument::FindChunk", "AFXWIN/CDocument::GetAdapter", "AFXWIN/CDocument::GetDocTemplate", "AFXWIN/CDocument::GetFile", "AFXWIN/CDocument::GetFirstViewPosition", "AFXWIN/CDocument::GetNextView", "AFXWIN/CDocument::GetPathName", "AFXWIN/CDocument::GetThumbnail", "AFXWIN/CDocument::GetTitle", "AFXWIN/CDocument::InitializeSearchContent", "AFXWIN/CDocument::IsModified", "AFXWIN/CDocument::IsSearchAndOrganizeHandler", "AFXWIN/CDocument::LoadDocumentFromStream", "AFXWIN/CDocument::OnBeforeRichPreviewFontChanged", "AFXWIN/CDocument::OnChangedViewList", "AFXWIN/CDocument::OnCloseDocument", "AFXWIN/CDocument::OnCreatePreviewFrame", "AFXWIN/CDocument::OnDocumentEvent", "AFXWIN/CDocument::OnDrawThumbnail", "AFXWIN/CDocument::OnLoadDocumentFromStream", "AFXWIN/CDocument::OnNewDocument", "AFXWIN/CDocument::OnOpenDocument", "AFXWIN/CDocument::OnPreviewHandlerQueryFocus", "AFXWIN/CDocument::OnPreviewHandlerTranslateAccelerator", "AFXWIN/CDocument::OnRichPreviewBackColorChanged", "AFXWIN/CDocument::OnRichPreviewFontChanged", "AFXWIN/CDocument::OnRichPreviewSiteChanged", "AFXWIN/CDocument::OnRichPreviewTextColorChanged", "AFXWIN/CDocument::OnSaveDocument", "AFXWIN/CDocument::OnUnloadHandler", "AFXWIN/CDocument::PreCloseFrame", "AFXWIN/CDocument::ReadNextChunkValue", "AFXWIN/CDocument::ReleaseFile", "AFXWIN/CDocument::RemoveChunk", "AFXWIN/CDocument::RemoveView", "AFXWIN/CDocument::ReportSaveLoadException", "AFXWIN/CDocument::SaveModified", "AFXWIN/CDocument::SetChunkValue", "AFXWIN/CDocument::SetModifiedFlag", "AFXWIN/CDocument::SetPathName", "AFXWIN/CDocument::SetTitle", "AFXWIN/CDocument::UpdateAllViews", "AFXWIN/CDocument::OnFileSendMail", "AFXWIN/CDocument::OnUpdateFileSendMail", "AFXWIN/CDocument::m_bGetThumbnailMode", "AFXWIN/CDocument::m_bPreviewHandlerMode", "AFXWIN/CDocument::m_bSearchMode", "AFXWIN/CDocument::m_clrRichPreviewBackColor", "AFXWIN/CDocument::m_clrRichPreviewTextColor", "AFXWIN/CDocument::m_lfRichPreviewFont"] helpviewer_keywords: ["CDocument [MFC], CDocument", "CDocument [MFC], AddView", "CDocument [MFC], BeginReadChunks", "CDocument [MFC], CanCloseFrame", "CDocument [MFC], ClearChunkList", "CDocument [MFC], ClearPathName", "CDocument [MFC], DeleteContents", "CDocument [MFC], FindChunk", "CDocument [MFC], GetAdapter", "CDocument [MFC], GetDocTemplate", "CDocument [MFC], GetFile", "CDocument [MFC], GetFirstViewPosition", "CDocument [MFC], GetNextView", "CDocument [MFC], GetPathName", "CDocument [MFC], GetThumbnail", "CDocument [MFC], GetTitle", "CDocument [MFC], InitializeSearchContent", "CDocument [MFC], IsModified", "CDocument [MFC], IsSearchAndOrganizeHandler", "CDocument [MFC], LoadDocumentFromStream", "CDocument [MFC], OnBeforeRichPreviewFontChanged", "CDocument [MFC], OnChangedViewList", "CDocument [MFC], OnCloseDocument", "CDocument [MFC], OnCreatePreviewFrame", "CDocument [MFC], OnDocumentEvent", "CDocument [MFC], OnDrawThumbnail", "CDocument [MFC], OnLoadDocumentFromStream", "CDocument [MFC], OnNewDocument", "CDocument [MFC], OnOpenDocument", "CDocument [MFC], OnPreviewHandlerQueryFocus", "CDocument [MFC], OnPreviewHandlerTranslateAccelerator", "CDocument [MFC], OnRichPreviewBackColorChanged", "CDocument [MFC], OnRichPreviewFontChanged", "CDocument [MFC], OnRichPreviewSiteChanged", "CDocument [MFC], OnRichPreviewTextColorChanged", "CDocument [MFC], OnSaveDocument", "CDocument [MFC], OnUnloadHandler", "CDocument [MFC], PreCloseFrame", "CDocument [MFC], ReadNextChunkValue", "CDocument [MFC], ReleaseFile", "CDocument [MFC], RemoveChunk", "CDocument [MFC], RemoveView", "CDocument [MFC], ReportSaveLoadException", "CDocument [MFC], SaveModified", "CDocument [MFC], SetChunkValue", "CDocument [MFC], SetModifiedFlag", "CDocument [MFC], SetPathName", "CDocument [MFC], SetTitle", "CDocument [MFC], UpdateAllViews", "CDocument [MFC], OnFileSendMail", "CDocument [MFC], OnUpdateFileSendMail", "CDocument [MFC], m_bGetThumbnailMode", "CDocument [MFC], m_bPreviewHandlerMode", "CDocument [MFC], m_bSearchMode", "CDocument [MFC], m_clrRichPreviewBackColor", "CDocument [MFC], m_clrRichPreviewTextColor", "CDocument [MFC], m_lfRichPreviewFont"] -ms.assetid: e5a2891d-e1e1-4599-8c7e-afa9b4945446 --- # `CDocument` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the basic functionality for user-defined document classes. ## Syntax diff --git a/docs/mfc/reference/cdraglistbox-class.md b/docs/mfc/reference/cdraglistbox-class.md index 3f606afec5c..0a6c49b750a 100644 --- a/docs/mfc/reference/cdraglistbox-class.md +++ b/docs/mfc/reference/cdraglistbox-class.md @@ -4,10 +4,12 @@ title: "CDragListBox Class" ms.date: "11/04/2016" f1_keywords: ["CDragListBox", "AFXCMN/CDragListBox", "AFXCMN/CDragListBox::CDragListBox", "AFXCMN/CDragListBox::BeginDrag", "AFXCMN/CDragListBox::CancelDrag", "AFXCMN/CDragListBox::Dragging", "AFXCMN/CDragListBox::DrawInsert", "AFXCMN/CDragListBox::Dropped", "AFXCMN/CDragListBox::ItemFromPt"] helpviewer_keywords: ["CDragListBox [MFC], CDragListBox", "CDragListBox [MFC], BeginDrag", "CDragListBox [MFC], CancelDrag", "CDragListBox [MFC], Dragging", "CDragListBox [MFC], DrawInsert", "CDragListBox [MFC], Dropped", "CDragListBox [MFC], ItemFromPt"] -ms.assetid: fee20b42-60ae-4aa9-83f9-5a3d9b96e33b --- # CDragListBox Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In addition to providing the functionality of a Windows list box, the `CDragListBox` class allows the user to move list box items, such as filenames, within the list box. ## Syntax diff --git a/docs/mfc/reference/cdrawingmanager-class.md b/docs/mfc/reference/cdrawingmanager-class.md index 0ac81cd52f4..0b13d57074e 100644 --- a/docs/mfc/reference/cdrawingmanager-class.md +++ b/docs/mfc/reference/cdrawingmanager-class.md @@ -4,10 +4,12 @@ title: "CDrawingManager Class" ms.date: "11/04/2016" f1_keywords: ["CDrawingManager", "AFXDRAWMANAGER/CDrawingManager", "AFXDRAWMANAGER/CDrawingManager::CDrawingManager", "AFXDRAWMANAGER/CDrawingManager::CreateBitmap_32", "AFXDRAWMANAGER/CDrawingManager::DrawAlpha", "AFXDRAWMANAGER/CDrawingManager::DrawRotated", "AFXDRAWMANAGER/CDrawingManager::DrawEllipse", "AFXDRAWMANAGER/CDrawingManager::DrawGradientRing", "AFXDRAWMANAGER/CDrawingManager::DrawRect", "AFXDRAWMANAGER/CDrawingManager::DrawShadow", "AFXDRAWMANAGER/CDrawingManager::Fill4ColorsGradient", "AFXDRAWMANAGER/CDrawingManager::FillGradient", "AFXDRAWMANAGER/CDrawingManager::FillGradient2", "AFXDRAWMANAGER/CDrawingManager::GrayRect", "AFXDRAWMANAGER/CDrawingManager::HighlightRect", "AFXDRAWMANAGER/CDrawingManager::HLStoRGB_ONE", "AFXDRAWMANAGER/CDrawingManager::HLStoRGB_TWO", "AFXDRAWMANAGER/CDrawingManager::HSVtoRGB", "AFXDRAWMANAGER/CDrawingManager::HuetoRGB", "AFXDRAWMANAGER/CDrawingManager::MirrorRect", "AFXDRAWMANAGER/CDrawingManager::PixelAlpha", "AFXDRAWMANAGER/CDrawingManager::PrepareShadowMask", "AFXDRAWMANAGER/CDrawingManager::RGBtoHSL", "AFXDRAWMANAGER/CDrawingManager::RGBtoHSV", "AFXDRAWMANAGER/CDrawingManager::SetAlphaPixel", "AFXDRAWMANAGER/CDrawingManager::SetPixel", "AFXDRAWMANAGER/CDrawingManager::SmartMixColors"] helpviewer_keywords: ["CDrawingManager [MFC], CDrawingManager", "CDrawingManager [MFC], CreateBitmap_32", "CDrawingManager [MFC], DrawAlpha", "CDrawingManager [MFC], DrawRotated", "CDrawingManager [MFC], DrawEllipse", "CDrawingManager [MFC], DrawGradientRing", "CDrawingManager [MFC], DrawRect", "CDrawingManager [MFC], DrawShadow", "CDrawingManager [MFC], Fill4ColorsGradient", "CDrawingManager [MFC], FillGradient", "CDrawingManager [MFC], FillGradient2", "CDrawingManager [MFC], GrayRect", "CDrawingManager [MFC], HighlightRect", "CDrawingManager [MFC], HLStoRGB_ONE", "CDrawingManager [MFC], HLStoRGB_TWO", "CDrawingManager [MFC], HSVtoRGB", "CDrawingManager [MFC], HuetoRGB", "CDrawingManager [MFC], MirrorRect", "CDrawingManager [MFC], PixelAlpha", "CDrawingManager [MFC], PrepareShadowMask", "CDrawingManager [MFC], RGBtoHSL", "CDrawingManager [MFC], RGBtoHSV", "CDrawingManager [MFC], SetAlphaPixel", "CDrawingManager [MFC], SetPixel", "CDrawingManager [MFC], SmartMixColors"] -ms.assetid: 9e4775ca-101b-4aa9-a85a-4d047c701215 --- # CDrawingManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CDrawingManager` class implements complex drawing algorithms. ## Syntax diff --git a/docs/mfc/reference/cdumpcontext-class.md b/docs/mfc/reference/cdumpcontext-class.md index 62761573c65..7ea003f58f8 100644 --- a/docs/mfc/reference/cdumpcontext-class.md +++ b/docs/mfc/reference/cdumpcontext-class.md @@ -4,10 +4,12 @@ title: "CDumpContext Class" ms.date: "11/04/2016" f1_keywords: ["CDumpContext", "AFX/CDumpContext", "AFX/CDumpContext::CDumpContext", "AFX/CDumpContext::DumpAsHex", "AFX/CDumpContext::Flush", "AFX/CDumpContext::GetDepth", "AFX/CDumpContext::HexDump", "AFX/CDumpContext::SetDepth"] helpviewer_keywords: ["CDumpContext [MFC], CDumpContext", "CDumpContext [MFC], DumpAsHex", "CDumpContext [MFC], Flush", "CDumpContext [MFC], GetDepth", "CDumpContext [MFC], HexDump", "CDumpContext [MFC], SetDepth"] -ms.assetid: 98c52b2d-14b5-48ed-b423-479a4d1c60fa --- # CDumpContext Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports stream-oriented diagnostic output in the form of human-readable text. ## Syntax diff --git a/docs/mfc/reference/cdwordarray-class.md b/docs/mfc/reference/cdwordarray-class.md index 6e9d5f38710..25eaea47f31 100644 --- a/docs/mfc/reference/cdwordarray-class.md +++ b/docs/mfc/reference/cdwordarray-class.md @@ -4,10 +4,12 @@ title: "CDWordArray Class" ms.date: "11/04/2016" f1_keywords: ["CDWordArray", "AFXCOLL/CDWordArray", "AFXCOLL/CDWordArray::CDWordArray", "AFXCOLL/CDWordArray::Add", "AFXCOLL/CDWordArray::Append", "AFXCOLL/CDWordArray::Copy", "AFXCOLL/CDWordArray::ElementAt", "AFXCOLL/CDWordArray::FreeExtra", "AFXCOLL/CDWordArray::GetAt", "AFXCOLL/CDWordArray::GetCount", "AFXCOLL/CDWordArray::GetData", "AFXCOLL/CDWordArray::GetSize", "AFXCOLL/CDWordArray::GetUpperBound", "AFXCOLL/CDWordArray::InsertAt", "AFXCOLL/CDWordArray::IsEmpty", "AFXCOLL/CDWordArray::RemoveAll", "AFXCOLL/CDWordArray::RemoveAt", "AFXCOLL/CDWordArray::SetAt", "AFXCOLL/CDWordArray::SetAtGrow", "AFXCOLL/CDWordArray::SetSize"] helpviewer_keywords: ["CDWordArray [MFC], CDWordArray", "CDWordArray [MFC], Add", "CDWordArray [MFC], Append", "CDWordArray [MFC], Copy", "CDWordArray [MFC], ElementAt", "CDWordArray [MFC], FreeExtra", "CDWordArray [MFC], GetAt", "CDWordArray [MFC], GetCount", "CDWordArray [MFC], GetData", "CDWordArray [MFC], GetSize", "CDWordArray [MFC], GetUpperBound", "CDWordArray [MFC], InsertAt", "CDWordArray [MFC], IsEmpty", "CDWordArray [MFC], RemoveAll", "CDWordArray [MFC], RemoveAt", "CDWordArray [MFC], SetAt", "CDWordArray [MFC], SetAtGrow", "CDWordArray [MFC], SetSize"] -ms.assetid: 581be11e-ced6-47d1-8679-e0b8e7d99494 --- # CDWordArray Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports arrays of 32-bit doublewords. ## Syntax diff --git a/docs/mfc/reference/cedit-class.md b/docs/mfc/reference/cedit-class.md index 3843aec8703..1bbce9a88f9 100644 --- a/docs/mfc/reference/cedit-class.md +++ b/docs/mfc/reference/cedit-class.md @@ -4,10 +4,12 @@ title: "CEdit Class" ms.date: "09/12/2018" f1_keywords: ["CEdit", "AFXWIN/CEdit", "AFXWIN/CEdit::CEdit", "AFXWIN/CEdit::CanUndo", "AFXWIN/CEdit::CharFromPos", "AFXWIN/CEdit::Clear", "AFXWIN/CEdit::Copy", "AFXWIN/CEdit::Create", "AFXWIN/CEdit::Cut", "AFXWIN/CEdit::EmptyUndoBuffer", "AFXWIN/CEdit::FmtLines", "AFXWIN/CEdit::GetCueBanner", "AFXWIN/CEdit::GetFirstVisibleLine", "AFXWIN/CEdit::GetHandle", "AFXWIN/CEdit::GetHighlight", "AFXWIN/CEdit::GetLimitText", "AFXWIN/CEdit::GetLine", "AFXWIN/CEdit::GetLineCount", "AFXWIN/CEdit::GetMargins", "AFXWIN/CEdit::GetModify", "AFXWIN/CEdit::GetPasswordChar", "AFXWIN/CEdit::GetRect", "AFXWIN/CEdit::GetSel", "AFXWIN/CEdit::HideBalloonTip", "AFXWIN/CEdit::LimitText", "AFXWIN/CEdit::LineFromChar", "AFXWIN/CEdit::LineIndex", "AFXWIN/CEdit::LineLength", "AFXWIN/CEdit::LineScroll", "AFXWIN/CEdit::Paste", "AFXWIN/CEdit::PosFromChar", "AFXWIN/CEdit::ReplaceSel", "AFXWIN/CEdit::SetCueBanner", "AFXWIN/CEdit::SetHandle", "AFXWIN/CEdit::SetHighlight", "AFXWIN/CEdit::SetLimitText", "AFXWIN/CEdit::SetMargins", "AFXWIN/CEdit::SetModify", "AFXWIN/CEdit::SetPasswordChar", "AFXWIN/CEdit::SetReadOnly", "AFXWIN/CEdit::SetRect", "AFXWIN/CEdit::SetRectNP", "AFXWIN/CEdit::SetSel", "AFXWIN/CEdit::SetTabStops", "AFXWIN/CEdit::ShowBalloonTip", "AFXWIN/CEdit::Undo"] helpviewer_keywords: ["CEdit [MFC], CEdit", "CEdit [MFC], CanUndo", "CEdit [MFC], CharFromPos", "CEdit [MFC], Clear", "CEdit [MFC], Copy", "CEdit [MFC], Create", "CEdit [MFC], Cut", "CEdit [MFC], EmptyUndoBuffer", "CEdit [MFC], FmtLines", "CEdit [MFC], GetCueBanner", "CEdit [MFC], GetFirstVisibleLine", "CEdit [MFC], GetHandle", "CEdit [MFC], GetHighlight", "CEdit [MFC], GetLimitText", "CEdit [MFC], GetLine", "CEdit [MFC], GetLineCount", "CEdit [MFC], GetMargins", "CEdit [MFC], GetModify", "CEdit [MFC], GetPasswordChar", "CEdit [MFC], GetRect", "CEdit [MFC], GetSel", "CEdit [MFC], HideBalloonTip", "CEdit [MFC], LimitText", "CEdit [MFC], LineFromChar", "CEdit [MFC], LineIndex", "CEdit [MFC], LineLength", "CEdit [MFC], LineScroll", "CEdit [MFC], Paste", "CEdit [MFC], PosFromChar", "CEdit [MFC], ReplaceSel", "CEdit [MFC], SetCueBanner", "CEdit [MFC], SetHandle", "CEdit [MFC], SetHighlight", "CEdit [MFC], SetLimitText", "CEdit [MFC], SetMargins", "CEdit [MFC], SetModify", "CEdit [MFC], SetPasswordChar", "CEdit [MFC], SetReadOnly", "CEdit [MFC], SetRect", "CEdit [MFC], SetRectNP", "CEdit [MFC], SetSel", "CEdit [MFC], SetTabStops", "CEdit [MFC], ShowBalloonTip", "CEdit [MFC], Undo"] -ms.assetid: b1533c30-7f10-4663-88d3-8b7f2c9f7024 --- # CEdit Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a Windows edit control. ## Syntax diff --git a/docs/mfc/reference/ceditview-class.md b/docs/mfc/reference/ceditview-class.md index 19e9d78e469..d2a418035b5 100644 --- a/docs/mfc/reference/ceditview-class.md +++ b/docs/mfc/reference/ceditview-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CEditView [MFC], CEditView", "CEditView [MFC], FindText", --- # CEditView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A type of view class that provides the functionality of a Windows edit control and can be used to implement simple text-editor functionality. ## Syntax diff --git a/docs/mfc/reference/cevent-class.md b/docs/mfc/reference/cevent-class.md index 2ed97e9f1d4..0389a61a321 100644 --- a/docs/mfc/reference/cevent-class.md +++ b/docs/mfc/reference/cevent-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CEvent [MFC], CEvent", "CEvent [MFC], PulseEvent", "CEven --- # `CEvent` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents an event, which is a synchronization object that enables one thread to notify another that an event has occurred. ## Syntax diff --git a/docs/mfc/reference/cexception-class.md b/docs/mfc/reference/cexception-class.md index 93f52aba8ac..8bc8d5f40da 100644 --- a/docs/mfc/reference/cexception-class.md +++ b/docs/mfc/reference/cexception-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CException [MFC], CException", "CException [MFC], Delete" --- # `CException` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class for all exceptions in the Microsoft Foundation Class Library. ## Syntax diff --git a/docs/mfc/reference/cfieldexchange-class.md b/docs/mfc/reference/cfieldexchange-class.md index 02902f9e1c8..f1a099f9bc7 100644 --- a/docs/mfc/reference/cfieldexchange-class.md +++ b/docs/mfc/reference/cfieldexchange-class.md @@ -4,10 +4,12 @@ title: "CFieldExchange Class" ms.date: "11/04/2016" f1_keywords: ["CFieldExchange", "AFXDB/CFieldExchange", "AFXDB/CFieldExchange::IsFieldType", "AFXDB/CFieldExchange::SetFieldType"] helpviewer_keywords: ["CFieldExchange [MFC], IsFieldType", "CFieldExchange [MFC], SetFieldType"] -ms.assetid: 24c5c0b3-06a6-430e-9b6f-005a2c65e29f --- # CFieldExchange Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports the record field exchange (RFX) and bulk record field exchange (Bulk RFX) routines used by the database classes. ## Syntax diff --git a/docs/mfc/reference/cfile-class.md b/docs/mfc/reference/cfile-class.md index 1621e327467..5c12dc2db75 100644 --- a/docs/mfc/reference/cfile-class.md +++ b/docs/mfc/reference/cfile-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CFile [MFC], CFile", "CFile [MFC], Abort", "CFile [MFC], --- # CFile Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class for Microsoft Foundation Class file classes. ## Syntax diff --git a/docs/mfc/reference/cfiledialog-class.md b/docs/mfc/reference/cfiledialog-class.md index 64c02078a88..3d84f293e8b 100644 --- a/docs/mfc/reference/cfiledialog-class.md +++ b/docs/mfc/reference/cfiledialog-class.md @@ -4,10 +4,12 @@ title: "CFileDialog Class" ms.date: "11/04/2016" f1_keywords: ["CFileDialog", "AFXDLGS/CFileDialog", "AFXDLGS/CFileDialog::CFileDialog", "AFXDLGS/CFileDialog::AddCheckButton", "AFXDLGS/CFileDialog::AddComboBox", "AFXDLGS/CFileDialog::AddControlItem", "AFXDLGS/CFileDialog::AddEditBox", "AFXDLGS/CFileDialog::AddMenu", "AFXDLGS/CFileDialog::AddPlace", "AFXDLGS/CFileDialog::AddPushButton", "AFXDLGS/CFileDialog::AddRadioButtonList", "AFXDLGS/CFileDialog::AddSeparator", "AFXDLGS/CFileDialog::AddText", "AFXDLGS/CFileDialog::ApplyOFNToShellDialog", "AFXDLGS/CFileDialog::DoModal", "AFXDLGS/CFileDialog::EnableOpenDropDown", "AFXDLGS/CFileDialog::EndVisualGroup", "AFXDLGS/CFileDialog::GetCheckButtonState", "AFXDLGS/CFileDialog::GetControlItemState", "AFXDLGS/CFileDialog::GetControlState", "AFXDLGS/CFileDialog::GetEditBoxText", "AFXDLGS/CFileDialog::GetFileExt", "AFXDLGS/CFileDialog::GetFileName", "AFXDLGS/CFileDialog::GetFileTitle", "AFXDLGS/CFileDialog::GetFolderPath", "AFXDLGS/CFileDialog::GetIFileDialogCustomize", "AFXDLGS/CFileDialog::GetIFileOpenDialog", "AFXDLGS/CFileDialog::GetIFileSaveDialog", "AFXDLGS/CFileDialog::GetNextPathName", "AFXDLGS/CFileDialog::GetOFN", "AFXDLGS/CFileDialog::GetPathName", "AFXDLGS/CFileDialog::GetReadOnlyPref", "AFXDLGS/CFileDialog::GetResult", "AFXDLGS/CFileDialog::GetResults", "AFXDLGS/CFileDialog::GetSelectedControlItem", "AFXDLGS/CFileDialog::GetStartPosition", "AFXDLGS/CFileDialog::HideControl", "AFXDLGS/CFileDialog::IsPickFoldersMode", "AFXDLGS/CFileDialog::MakeProminent", "AFXDLGS/CFileDialog::RemoveControlItem", "AFXDLGS/CFileDialog::SetCheckButtonState", "AFXDLGS/CFileDialog::SetControlItemState", "AFXDLGS/CFileDialog::SetControlItemText", "AFXDLGS/CFileDialog::SetControlLabel", "AFXDLGS/CFileDialog::SetControlState", "AFXDLGS/CFileDialog::SetControlText", "AFXDLGS/CFileDialog::SetDefExt", "AFXDLGS/CFileDialog::SetEditBoxText", "AFXDLGS/CFileDialog::SetProperties", "AFXDLGS/CFileDialog::SetSelectedControlItem", "AFXDLGS/CFileDialog::SetTemplate", "AFXDLGS/CFileDialog::StartVisualGroup", "AFXDLGS/CFileDialog::UpdateOFNFromShellDialog", "AFXDLGS/CFileDialog::OnButtonClicked", "AFXDLGS/CFileDialog::OnCheckButtonToggled", "AFXDLGS/CFileDialog::OnControlActivating", "AFXDLGS/CFileDialog::OnFileNameChange", "AFXDLGS/CFileDialog::OnFileNameOK", "AFXDLGS/CFileDialog::OnFolderChange", "AFXDLGS/CFileDialog::OnInitDone", "AFXDLGS/CFileDialog::OnItemSelected", "AFXDLGS/CFileDialog::OnLBSelChangedNotify", "AFXDLGS/CFileDialog::OnShareViolation", "AFXDLGS/CFileDialog::OnTypeChange", "AFXDLGS/CFileDialog::m_ofn"] helpviewer_keywords: ["CFileDialog [MFC], CFileDialog", "CFileDialog [MFC], AddCheckButton", "CFileDialog [MFC], AddComboBox", "CFileDialog [MFC], AddControlItem", "CFileDialog [MFC], AddEditBox", "CFileDialog [MFC], AddMenu", "CFileDialog [MFC], AddPlace", "CFileDialog [MFC], AddPushButton", "CFileDialog [MFC], AddRadioButtonList", "CFileDialog [MFC], AddSeparator", "CFileDialog [MFC], AddText", "CFileDialog [MFC], ApplyOFNToShellDialog", "CFileDialog [MFC], DoModal", "CFileDialog [MFC], EnableOpenDropDown", "CFileDialog [MFC], EndVisualGroup", "CFileDialog [MFC], GetCheckButtonState", "CFileDialog [MFC], GetControlItemState", "CFileDialog [MFC], GetControlState", "CFileDialog [MFC], GetEditBoxText", "CFileDialog [MFC], GetFileExt", "CFileDialog [MFC], GetFileName", "CFileDialog [MFC], GetFileTitle", "CFileDialog [MFC], GetFolderPath", "CFileDialog [MFC], GetIFileDialogCustomize", "CFileDialog [MFC], GetIFileOpenDialog", "CFileDialog [MFC], GetIFileSaveDialog", "CFileDialog [MFC], GetNextPathName", "CFileDialog [MFC], GetOFN", "CFileDialog [MFC], GetPathName", "CFileDialog [MFC], GetReadOnlyPref", "CFileDialog [MFC], GetResult", "CFileDialog [MFC], GetResults", "CFileDialog [MFC], GetSelectedControlItem", "CFileDialog [MFC], GetStartPosition", "CFileDialog [MFC], HideControl", "CFileDialog [MFC], IsPickFoldersMode", "CFileDialog [MFC], MakeProminent", "CFileDialog [MFC], RemoveControlItem", "CFileDialog [MFC], SetCheckButtonState", "CFileDialog [MFC], SetControlItemState", "CFileDialog [MFC], SetControlItemText", "CFileDialog [MFC], SetControlLabel", "CFileDialog [MFC], SetControlState", "CFileDialog [MFC], SetControlText", "CFileDialog [MFC], SetDefExt", "CFileDialog [MFC], SetEditBoxText", "CFileDialog [MFC], SetProperties", "CFileDialog [MFC], SetSelectedControlItem", "CFileDialog [MFC], SetTemplate", "CFileDialog [MFC], StartVisualGroup", "CFileDialog [MFC], UpdateOFNFromShellDialog", "CFileDialog [MFC], OnButtonClicked", "CFileDialog [MFC], OnCheckButtonToggled", "CFileDialog [MFC], OnControlActivating", "CFileDialog [MFC], OnFileNameChange", "CFileDialog [MFC], OnFileNameOK", "CFileDialog [MFC], OnFolderChange", "CFileDialog [MFC], OnInitDone", "CFileDialog [MFC], OnItemSelected", "CFileDialog [MFC], OnLBSelChangedNotify", "CFileDialog [MFC], OnShareViolation", "CFileDialog [MFC], OnTypeChange", "CFileDialog [MFC], m_ofn"] -ms.assetid: fda4fd3c-08b8-4ce0-8e9d-7bab23f8c6c0 --- # CFileDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the common dialog box that is used for file open or file save operations. ## Syntax diff --git a/docs/mfc/reference/cfileexception-class.md b/docs/mfc/reference/cfileexception-class.md index 4f5bd0c822c..a69119c7834 100644 --- a/docs/mfc/reference/cfileexception-class.md +++ b/docs/mfc/reference/cfileexception-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CFileException [MFC], CFileException", "CFileException [M --- # `CFileException` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a file-related exception condition. ## Syntax diff --git a/docs/mfc/reference/cfilefind-class.md b/docs/mfc/reference/cfilefind-class.md index aabf078c761..01edcb95523 100644 --- a/docs/mfc/reference/cfilefind-class.md +++ b/docs/mfc/reference/cfilefind-class.md @@ -4,10 +4,12 @@ title: "CFileFind Class" ms.date: "11/04/2016" f1_keywords: ["CFileFind", "AFX/CFileFind", "AFX/CFileFind::CFileFind", "AFX/CFileFind::Close", "AFX/CFileFind::FindFile", "AFX/CFileFind::FindNextFile", "AFX/CFileFind::GetCreationTime", "AFX/CFileFind::GetFileName", "AFX/CFileFind::GetFilePath", "AFX/CFileFind::GetFileTitle", "AFX/CFileFind::GetFileURL", "AFX/CFileFind::GetLastAccessTime", "AFX/CFileFind::GetLastWriteTime", "AFX/CFileFind::GetLength", "AFX/CFileFind::GetRoot", "AFX/CFileFind::IsArchived", "AFX/CFileFind::IsCompressed", "AFX/CFileFind::IsDirectory", "AFX/CFileFind::IsDots", "AFX/CFileFind::IsHidden", "AFX/CFileFind::IsNormal", "AFX/CFileFind::IsReadOnly", "AFX/CFileFind::IsSystem", "AFX/CFileFind::IsTemporary", "AFX/CFileFind::MatchesMask", "AFX/CFileFind::CloseContext", "AFX/CFileFind::m_pTM"] helpviewer_keywords: ["CFileFind [MFC], CFileFind", "CFileFind [MFC], Close", "CFileFind [MFC], FindFile", "CFileFind [MFC], FindNextFile", "CFileFind [MFC], GetCreationTime", "CFileFind [MFC], GetFileName", "CFileFind [MFC], GetFilePath", "CFileFind [MFC], GetFileTitle", "CFileFind [MFC], GetFileURL", "CFileFind [MFC], GetLastAccessTime", "CFileFind [MFC], GetLastWriteTime", "CFileFind [MFC], GetLength", "CFileFind [MFC], GetRoot", "CFileFind [MFC], IsArchived", "CFileFind [MFC], IsCompressed", "CFileFind [MFC], IsDirectory", "CFileFind [MFC], IsDots", "CFileFind [MFC], IsHidden", "CFileFind [MFC], IsNormal", "CFileFind [MFC], IsReadOnly", "CFileFind [MFC], IsSystem", "CFileFind [MFC], IsTemporary", "CFileFind [MFC], MatchesMask", "CFileFind [MFC], CloseContext", "CFileFind [MFC], m_pTM"] -ms.assetid: 9990068c-b023-4114-9580-a50182d15240 --- # `CFileFind` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Performs local file searches and is the base class for [`CGopherFileFind`](../../mfc/reference/cgopherfilefind-class.md) and [`CFtpFileFind`](../../mfc/reference/cftpfilefind-class.md), which perform Internet file searches. ## Syntax diff --git a/docs/mfc/reference/cfindreplacedialog-class.md b/docs/mfc/reference/cfindreplacedialog-class.md index e24c9f2471d..bb106ba948c 100644 --- a/docs/mfc/reference/cfindreplacedialog-class.md +++ b/docs/mfc/reference/cfindreplacedialog-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CFindReplaceDialog [MFC], CFindReplaceDialog", "CFindRepl --- # CFindReplaceDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Allows you to implement standard string Find/Replace dialog boxes in your application. ## Syntax diff --git a/docs/mfc/reference/cfolderpickerdialog-class.md b/docs/mfc/reference/cfolderpickerdialog-class.md index de4f2750fa3..3e416178867 100644 --- a/docs/mfc/reference/cfolderpickerdialog-class.md +++ b/docs/mfc/reference/cfolderpickerdialog-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CFolderPickerDialog [MFC], CFolderPickerDialog"] --- # `CFolderPickerDialog` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + `CFolderPickerDialog` class implements `CFileDialog` in the folder picker mode. ## Syntax diff --git a/docs/mfc/reference/cfont-class.md b/docs/mfc/reference/cfont-class.md index 6a91e72bb95..c16e20c74d1 100644 --- a/docs/mfc/reference/cfont-class.md +++ b/docs/mfc/reference/cfont-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CFont [MFC], CFont", "CFont [MFC], CreateFont", "CFont [M --- # `CFont` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a Windows graphics device interface (GDI) font and provides member functions for manipulating the font. ## Syntax diff --git a/docs/mfc/reference/cfontdialog-class.md b/docs/mfc/reference/cfontdialog-class.md index 175c1d1978c..277855afb50 100644 --- a/docs/mfc/reference/cfontdialog-class.md +++ b/docs/mfc/reference/cfontdialog-class.md @@ -4,10 +4,12 @@ title: "CFontDialog Class" ms.date: "11/04/2016" f1_keywords: ["CFontDialog", "AFXDLGS/CFontDialog", "AFXDLGS/CFontDialog::CFontDialog", "AFXDLGS/CFontDialog::DoModal", "AFXDLGS/CFontDialog::GetCharFormat", "AFXDLGS/CFontDialog::GetColor", "AFXDLGS/CFontDialog::GetCurrentFont", "AFXDLGS/CFontDialog::GetFaceName", "AFXDLGS/CFontDialog::GetSize", "AFXDLGS/CFontDialog::GetStyleName", "AFXDLGS/CFontDialog::GetWeight", "AFXDLGS/CFontDialog::IsBold", "AFXDLGS/CFontDialog::IsItalic", "AFXDLGS/CFontDialog::IsStrikeOut", "AFXDLGS/CFontDialog::IsUnderline", "AFXDLGS/CFontDialog::m_cf"] helpviewer_keywords: ["CFontDialog [MFC], CFontDialog", "CFontDialog [MFC], DoModal", "CFontDialog [MFC], GetCharFormat", "CFontDialog [MFC], GetColor", "CFontDialog [MFC], GetCurrentFont", "CFontDialog [MFC], GetFaceName", "CFontDialog [MFC], GetSize", "CFontDialog [MFC], GetStyleName", "CFontDialog [MFC], GetWeight", "CFontDialog [MFC], IsBold", "CFontDialog [MFC], IsItalic", "CFontDialog [MFC], IsStrikeOut", "CFontDialog [MFC], IsUnderline", "CFontDialog [MFC], m_cf"] -ms.assetid: 6228d500-ed0f-4156-81e5-ab0d57d1dcf4 --- # CFontDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Allows you to incorporate a font-selection dialog box into your application. ## Syntax diff --git a/docs/mfc/reference/cfontholder-class.md b/docs/mfc/reference/cfontholder-class.md index 793af5a5496..22a1b18a28f 100644 --- a/docs/mfc/reference/cfontholder-class.md +++ b/docs/mfc/reference/cfontholder-class.md @@ -4,10 +4,12 @@ title: "CFontHolder Class" ms.date: "11/04/2016" f1_keywords: ["CFontHolder", "AFXCTL/CFontHolder", "AFXCTL/CFontHolder::CFontHolder", "AFXCTL/CFontHolder::GetDisplayString", "AFXCTL/CFontHolder::GetFontDispatch", "AFXCTL/CFontHolder::GetFontHandle", "AFXCTL/CFontHolder::InitializeFont", "AFXCTL/CFontHolder::QueryTextMetrics", "AFXCTL/CFontHolder::ReleaseFont", "AFXCTL/CFontHolder::Select", "AFXCTL/CFontHolder::SetFont", "AFXCTL/CFontHolder::m_pFont"] helpviewer_keywords: ["CFontHolder [MFC], CFontHolder", "CFontHolder [MFC], GetDisplayString", "CFontHolder [MFC], GetFontDispatch", "CFontHolder [MFC], GetFontHandle", "CFontHolder [MFC], InitializeFont", "CFontHolder [MFC], QueryTextMetrics", "CFontHolder [MFC], ReleaseFont", "CFontHolder [MFC], Select", "CFontHolder [MFC], SetFont", "CFontHolder [MFC], m_pFont"] -ms.assetid: 728ab472-0c97-440d-889f-1324c6e1b6b8 --- # CFontHolder Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the stock Font property and encapsulates the functionality of a Windows font object and the `IFont` interface. ## Syntax diff --git a/docs/mfc/reference/cformview-class.md b/docs/mfc/reference/cformview-class.md index 2166ba0f16c..97aeaa9ffc6 100644 --- a/docs/mfc/reference/cformview-class.md +++ b/docs/mfc/reference/cformview-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CFormView [MFC], CFormView", "CFormView [MFC], IsInitDlgC --- # `CFormView` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class used for form views. ## Syntax @@ -35,7 +38,7 @@ A form view is essentially a view that contains controls. These controls are lai When you're [Creating a Forms-Based Application](../../mfc/reference/creating-a-forms-based-mfc-application.md), you can base its view class on `CFormView`, making it a forms-based application. -You can also insert new [Form Topics](../../mfc/form-views-mfc.md) into document-view-based applications. Even if your application didn't initially support forms, Visual C++ will add this support when you insert a new form. +You can also insert new [Form Topics](../../mfc/form-views-mfc.md) into document-view-based applications. Even if your application didn't initially support forms, Visual Studio will add this support when you insert a new form. The MFC Application Wizard and the Add Class command are the preferred methods for creating forms-based applications. If you need to create a forms-based application without using these methods, see [Creating a Forms-Based Application](../../mfc/reference/creating-a-forms-based-mfc-application.md). diff --git a/docs/mfc/reference/cframewnd-class.md b/docs/mfc/reference/cframewnd-class.md index 670db48714c..633733e9f7b 100644 --- a/docs/mfc/reference/cframewnd-class.md +++ b/docs/mfc/reference/cframewnd-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CFrameWnd [MFC], CFrameWnd", "CFrameWnd [MFC], ActivateFr --- # `CFrameWnd` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a Windows single document interface (SDI) overlapped or pop-up frame window, along with members for managing the window. ## Syntax diff --git a/docs/mfc/reference/cframewndex-class.md b/docs/mfc/reference/cframewndex-class.md index 6c54057b898..8447320700c 100644 --- a/docs/mfc/reference/cframewndex-class.md +++ b/docs/mfc/reference/cframewndex-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CFrameWndEx [MFC], ActiveItemRecalcLayout", "CFrameWndEx --- # `CFrameWndEx` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the functionality of a Windows single document interface (SDI) overlapped or popup frame window, and provides members for managing the window. It extends the [`CFrameWnd`](../../mfc/reference/cframewnd-class.md) class. ## Syntax diff --git a/docs/mfc/reference/cftpconnection-class.md b/docs/mfc/reference/cftpconnection-class.md index aae3de670a4..6f1606040cb 100644 --- a/docs/mfc/reference/cftpconnection-class.md +++ b/docs/mfc/reference/cftpconnection-class.md @@ -4,10 +4,12 @@ title: "CFtpConnection Class" ms.date: "08/29/2019" f1_keywords: ["CFtpConnection", "AFXINET/CFtpConnection", "AFXINET/CFtpConnection::CFtpConnection", "AFXINET/CFtpConnection::Command", "AFXINET/CFtpConnection::CreateDirectory", "AFXINET/CFtpConnection::GetCurrentDirectory", "AFXINET/CFtpConnection::GetCurrentDirectoryAsURL", "AFXINET/CFtpConnection::GetFile", "AFXINET/CFtpConnection::OpenFile", "AFXINET/CFtpConnection::PutFile", "AFXINET/CFtpConnection::Remove", "AFXINET/CFtpConnection::RemoveDirectory", "AFXINET/CFtpConnection::Rename", "AFXINET/CFtpConnection::SetCurrentDirectory"] helpviewer_keywords: ["CFtpConnection [MFC], CFtpConnection", "CFtpConnection [MFC], Command", "CFtpConnection [MFC], CreateDirectory", "CFtpConnection [MFC], GetCurrentDirectory", "CFtpConnection [MFC], GetCurrentDirectoryAsURL", "CFtpConnection [MFC], GetFile", "CFtpConnection [MFC], OpenFile", "CFtpConnection [MFC], PutFile", "CFtpConnection [MFC], Remove", "CFtpConnection [MFC], RemoveDirectory", "CFtpConnection [MFC], Rename", "CFtpConnection [MFC], SetCurrentDirectory"] -ms.assetid: 5e3a0501-8893-49cf-a3d5-0628d8d6b936 --- # CFtpConnection Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages your FTP connection to an Internet server and allows direct manipulation of directories and files on that server. ## Syntax diff --git a/docs/mfc/reference/cftpfilefind-class.md b/docs/mfc/reference/cftpfilefind-class.md index f43026aff12..33966e135c9 100644 --- a/docs/mfc/reference/cftpfilefind-class.md +++ b/docs/mfc/reference/cftpfilefind-class.md @@ -4,10 +4,12 @@ title: "CFtpFileFind Class" ms.date: "05/28/2020" f1_keywords: ["CFtpFileFind", "AFXINET/CFtpFileFind", "AFXINET/CFtpFileFind::CFtpFileFind", "AFXINET/CFtpFileFind::FindFile", "AFXINET/CFtpFileFind::FindNextFile", "AFXINET/CFtpFileFind::GetFileURL"] helpviewer_keywords: ["CFtpFileFind [MFC], CFtpFileFind", "CFtpFileFind [MFC], FindFile", "CFtpFileFind [MFC], FindNextFile", "CFtpFileFind [MFC], GetFileURL"] -ms.assetid: 9667cf01-657f-4b11-b9db-f11e5a7b4e4c --- # CFtpFileFind Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Aids in Internet file searches of FTP servers. ## Syntax diff --git a/docs/mfc/reference/cgdiobject-class.md b/docs/mfc/reference/cgdiobject-class.md index ff6dde45220..ab134f376d1 100644 --- a/docs/mfc/reference/cgdiobject-class.md +++ b/docs/mfc/reference/cgdiobject-class.md @@ -4,10 +4,12 @@ title: "CGdiObject Class" ms.date: "11/04/2016" f1_keywords: ["CGdiObject", "AFXWIN/CGdiObject", "AFXWIN/CGdiObject::CGdiObject", "AFXWIN/CGdiObject::Attach", "AFXWIN/CGdiObject::CreateStockObject", "AFXWIN/CGdiObject::DeleteObject", "AFXWIN/CGdiObject::DeleteTempMap", "AFXWIN/CGdiObject::Detach", "AFXWIN/CGdiObject::FromHandle", "AFXWIN/CGdiObject::GetObject", "AFXWIN/CGdiObject::GetObjectType", "AFXWIN/CGdiObject::GetSafeHandle", "AFXWIN/CGdiObject::UnrealizeObject", "AFXWIN/CGdiObject::m_hObject"] helpviewer_keywords: ["CGdiObject [MFC], CGdiObject", "CGdiObject [MFC], Attach", "CGdiObject [MFC], CreateStockObject", "CGdiObject [MFC], DeleteObject", "CGdiObject [MFC], DeleteTempMap", "CGdiObject [MFC], Detach", "CGdiObject [MFC], FromHandle", "CGdiObject [MFC], GetObject", "CGdiObject [MFC], GetObjectType", "CGdiObject [MFC], GetSafeHandle", "CGdiObject [MFC], UnrealizeObject", "CGdiObject [MFC], m_hObject"] -ms.assetid: 1cba3ba5-3d49-4e43-8293-209299f2f6f4 --- # CGdiObject Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides a base class for various kinds of Windows graphics device interface (GDI) objects such as bitmaps, regions, brushes, pens, palettes, and fonts. ## Syntax diff --git a/docs/mfc/reference/cglobalutils-class.md b/docs/mfc/reference/cglobalutils-class.md index 55f11e6089d..ddfb73146e3 100644 --- a/docs/mfc/reference/cglobalutils-class.md +++ b/docs/mfc/reference/cglobalutils-class.md @@ -4,10 +4,12 @@ title: "CGlobalUtils Class" ms.date: "10/18/2018" f1_keywords: ["CGlobalUtils", "AFXGLOBALUTILS/CGlobalUtils", "AFXGLOBALUTILS/CGlobalUtils::AdjustRectToWorkArea", "AFXGLOBALUTILS/CGlobalUtils::CalcExpectedDockedRect", "AFXGLOBALUTILS/CGlobalUtils::CanBeAttached", "AFXGLOBALUTILS/CGlobalUtils::CanPaneBeInFloatingMultiPaneFrameWnd", "AFXGLOBALUTILS/CGlobalUtils::CheckAlignment", "AFXGLOBALUTILS/CGlobalUtils::CyFromString", "AFXGLOBALUTILS/CGlobalUtils::DecimalFromString", "AFXGLOBALUTILS/CGlobalUtils::FlipRect", "AFXGLOBALUTILS/CGlobalUtils::ForceAdjustLayout", "AFXGLOBALUTILS/CGlobalUtils::GetDockingManager", "AFXGLOBALUTILS/CGlobalUtils::GetOppositeAlignment", "AFXGLOBALUTILS/CGlobalUtils::GetPaneAndAlignFromPoint", "AFXGLOBALUTILS/CGlobalUtils::GetWndIcon", "AFXGLOBALUTILS/CGlobalUtils::SetNewParent", "AFXGLOBALUTILS/CGlobalUtils::StringFromCy", "AFXGLOBALUTILS/CGlobalUtils::StringFromDecimal"] helpviewer_keywords: ["CGlobalUtils [MFC], AdjustRectToWorkArea", "CGlobalUtils [MFC], CalcExpectedDockedRect", "CGlobalUtils [MFC], CanBeAttached", "CGlobalUtils [MFC], CanPaneBeInFloatingMultiPaneFrameWnd", "CGlobalUtils [MFC], CheckAlignment", "CGlobalUtils [MFC], CyFromString", "CGlobalUtils [MFC], DecimalFromString", "CGlobalUtils [MFC], FlipRect", "CGlobalUtils [MFC], ForceAdjustLayout", "CGlobalUtils [MFC], GetDockingManager", "CGlobalUtils [MFC], GetOppositeAlignment", "CGlobalUtils [MFC], GetPaneAndAlignFromPoint", "CGlobalUtils [MFC], GetWndIcon", "CGlobalUtils [MFC], SetNewParent", "CGlobalUtils [MFC], StringFromCy", "CGlobalUtils [MFC], StringFromDecimal"] -ms.assetid: 2c5bd1a6-f80c-4e79-a476-b4ceebabfb2f --- # CGlobalUtils Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. ## Syntax diff --git a/docs/mfc/reference/cgopherconnection-class.md b/docs/mfc/reference/cgopherconnection-class.md index d05ead9a3a2..d6c587237d0 100644 --- a/docs/mfc/reference/cgopherconnection-class.md +++ b/docs/mfc/reference/cgopherconnection-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CGopherConnection [MFC], CGopherConnection", "CGopherConn --- # CGopherConnection Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages your connection to a gopher Internet server. > [!NOTE] diff --git a/docs/mfc/reference/cgopherfile-class.md b/docs/mfc/reference/cgopherfile-class.md index 8d384db4c31..23dd44f2693 100644 --- a/docs/mfc/reference/cgopherfile-class.md +++ b/docs/mfc/reference/cgopherfile-class.md @@ -4,10 +4,12 @@ title: "CGopherFile Class" ms.date: "11/04/2016" f1_keywords: ["CGopherFile", "AFXINET/CGopherFile", "AFXINET/CGopherFile::CGopherFile"] helpviewer_keywords: ["CGopherFile [MFC], CGopherFile"] -ms.assetid: 3ca9898f-8cdb-4495-bbde-46d40100feda --- # CGopherFile Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality to find and read files on a gopher server. > [!NOTE] diff --git a/docs/mfc/reference/cgopherfilefind-class.md b/docs/mfc/reference/cgopherfilefind-class.md index ef0ffada189..47ad8e86a51 100644 --- a/docs/mfc/reference/cgopherfilefind-class.md +++ b/docs/mfc/reference/cgopherfilefind-class.md @@ -4,10 +4,12 @@ title: "CGopherFileFind Class" ms.date: "11/04/2016" f1_keywords: ["CGopherFileFind", "AFXINET/CGopherFileFind", "AFXINET/CGopherFileFind::CGopherFileFind", "AFXINET/CGopherFileFind::FindFile", "AFXINET/CGopherFileFind::FindNextFile", "AFXINET/CGopherFileFind::GetCreationTime", "AFXINET/CGopherFileFind::GetLastAccessTime", "AFXINET/CGopherFileFind::GetLastWriteTime", "AFXINET/CGopherFileFind::GetLength", "AFXINET/CGopherFileFind::GetLocator", "AFXINET/CGopherFileFind::GetScreenName", "AFXINET/CGopherFileFind::IsDots"] helpviewer_keywords: ["CGopherFileFind [MFC], CGopherFileFind", "CGopherFileFind [MFC], FindFile", "CGopherFileFind [MFC], FindNextFile", "CGopherFileFind [MFC], GetCreationTime", "CGopherFileFind [MFC], GetLastAccessTime", "CGopherFileFind [MFC], GetLastWriteTime", "CGopherFileFind [MFC], GetLength", "CGopherFileFind [MFC], GetLocator", "CGopherFileFind [MFC], GetScreenName", "CGopherFileFind [MFC], IsDots"] -ms.assetid: 8465a979-6323-496d-ab4b-e81383fb999d --- # CGopherFileFind Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Aids in Internet file searches of gopher servers. > [!NOTE] diff --git a/docs/mfc/reference/cgopherlocator-class.md b/docs/mfc/reference/cgopherlocator-class.md index e7d981dba71..aa39d685fbd 100644 --- a/docs/mfc/reference/cgopherlocator-class.md +++ b/docs/mfc/reference/cgopherlocator-class.md @@ -4,10 +4,12 @@ title: "CGopherLocator Class" ms.date: "11/04/2016" f1_keywords: ["CGopherLocator", "AFXINET/CGopherLocator", "AFXINET/CGopherLocator::CGopherLocator", "AFXINET/CGopherLocator::GetLocatorType"] helpviewer_keywords: ["CGopherLocator [MFC], CGopherLocator", "CGopherLocator [MFC], GetLocatorType"] -ms.assetid: 6fcc015f-5ae6-4959-b936-858634c71019 --- # CGopherLocator Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Gets a gopher "locator" from a gopher server, determines the locator's type, and makes the locator available to [CGopherFileFind](../../mfc/reference/cgopherfilefind-class.md). > [!NOTE] diff --git a/docs/mfc/reference/cheaderctrl-class.md b/docs/mfc/reference/cheaderctrl-class.md index 3287d1ab18a..8ded47a365a 100644 --- a/docs/mfc/reference/cheaderctrl-class.md +++ b/docs/mfc/reference/cheaderctrl-class.md @@ -4,10 +4,12 @@ title: "CHeaderCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CHeaderCtrl", "AFXCMN/CHeaderCtrl", "AFXCMN/CHeaderCtrl::CHeaderCtrl", "AFXCMN/CHeaderCtrl::ClearAllFilters", "AFXCMN/CHeaderCtrl::ClearFilter", "AFXCMN/CHeaderCtrl::Create", "AFXCMN/CHeaderCtrl::CreateDragImage", "AFXCMN/CHeaderCtrl::CreateEx", "AFXCMN/CHeaderCtrl::DeleteItem", "AFXCMN/CHeaderCtrl::DrawItem", "AFXCMN/CHeaderCtrl::EditFilter", "AFXCMN/CHeaderCtrl::GetBitmapMargin", "AFXCMN/CHeaderCtrl::GetFocusedItem", "AFXCMN/CHeaderCtrl::GetImageList", "AFXCMN/CHeaderCtrl::GetItem", "AFXCMN/CHeaderCtrl::GetItemCount", "AFXCMN/CHeaderCtrl::GetItemDropDownRect", "AFXCMN/CHeaderCtrl::GetItemRect", "AFXCMN/CHeaderCtrl::GetOrderArray", "AFXCMN/CHeaderCtrl::GetOverflowRect", "AFXCMN/CHeaderCtrl::HitTest", "AFXCMN/CHeaderCtrl::InsertItem", "AFXCMN/CHeaderCtrl::Layout", "AFXCMN/CHeaderCtrl::OrderToIndex", "AFXCMN/CHeaderCtrl::SetBitmapMargin", "AFXCMN/CHeaderCtrl::SetFilterChangeTimeout", "AFXCMN/CHeaderCtrl::SetFocusedItem", "AFXCMN/CHeaderCtrl::SetHotDivider", "AFXCMN/CHeaderCtrl::SetImageList", "AFXCMN/CHeaderCtrl::SetItem", "AFXCMN/CHeaderCtrl::SetOrderArray"] helpviewer_keywords: ["CHeaderCtrl [MFC], CHeaderCtrl", "CHeaderCtrl [MFC], ClearAllFilters", "CHeaderCtrl [MFC], ClearFilter", "CHeaderCtrl [MFC], Create", "CHeaderCtrl [MFC], CreateDragImage", "CHeaderCtrl [MFC], CreateEx", "CHeaderCtrl [MFC], DeleteItem", "CHeaderCtrl [MFC], DrawItem", "CHeaderCtrl [MFC], EditFilter", "CHeaderCtrl [MFC], GetBitmapMargin", "CHeaderCtrl [MFC], GetFocusedItem", "CHeaderCtrl [MFC], GetImageList", "CHeaderCtrl [MFC], GetItem", "CHeaderCtrl [MFC], GetItemCount", "CHeaderCtrl [MFC], GetItemDropDownRect", "CHeaderCtrl [MFC], GetItemRect", "CHeaderCtrl [MFC], GetOrderArray", "CHeaderCtrl [MFC], GetOverflowRect", "CHeaderCtrl [MFC], HitTest", "CHeaderCtrl [MFC], InsertItem", "CHeaderCtrl [MFC], Layout", "CHeaderCtrl [MFC], OrderToIndex", "CHeaderCtrl [MFC], SetBitmapMargin", "CHeaderCtrl [MFC], SetFilterChangeTimeout", "CHeaderCtrl [MFC], SetFocusedItem", "CHeaderCtrl [MFC], SetHotDivider", "CHeaderCtrl [MFC], SetImageList", "CHeaderCtrl [MFC], SetItem", "CHeaderCtrl [MFC], SetOrderArray"] -ms.assetid: b847ac90-5fae-4a87-88e0-ca45f77b8b3b --- # CHeaderCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common header control. ## Syntax diff --git a/docs/mfc/reference/child-window-notification-message-handlers.md b/docs/mfc/reference/child-window-notification-message-handlers.md index 46654fcf608..318b2f6e6ae 100644 --- a/docs/mfc/reference/child-window-notification-message-handlers.md +++ b/docs/mfc/reference/child-window-notification-message-handlers.md @@ -4,10 +4,12 @@ title: "Child Window Notification Message Handlers" ms.date: "11/04/2016" f1_keywords: ["ChildWindow"] helpviewer_keywords: ["message handlers [MFC]", "message handling [MFC], child window message handlers", "notifications [MFC], child window messages", "windows [MFC], message handlers", "child windows [MFC], messages"] -ms.assetid: fddfdd08-8ecf-4f84-8b45-5a84616aaa8d --- # Child Window Notification Message Handlers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + There are five categories of child window notification messages: |Category|Description| diff --git a/docs/mfc/reference/chotkeyctrl-class.md b/docs/mfc/reference/chotkeyctrl-class.md index a442cd26c68..8b855d2303d 100644 --- a/docs/mfc/reference/chotkeyctrl-class.md +++ b/docs/mfc/reference/chotkeyctrl-class.md @@ -4,10 +4,12 @@ title: "CHotKeyCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CHotKeyCtrl", "AFXCMN/CHotKeyCtrl", "AFXCMN/CHotKeyCtrl::CHotKeyCtrl", "AFXCMN/CHotKeyCtrl::Create", "AFXCMN/CHotKeyCtrl::CreateEx", "AFXCMN/CHotKeyCtrl::GetHotKey", "AFXCMN/CHotKeyCtrl::GetHotKeyName", "AFXCMN/CHotKeyCtrl::GetKeyName", "AFXCMN/CHotKeyCtrl::SetHotKey", "AFXCMN/CHotKeyCtrl::SetRules"] helpviewer_keywords: ["CHotKeyCtrl [MFC], CHotKeyCtrl", "CHotKeyCtrl [MFC], Create", "CHotKeyCtrl [MFC], CreateEx", "CHotKeyCtrl [MFC], GetHotKey", "CHotKeyCtrl [MFC], GetHotKeyName", "CHotKeyCtrl [MFC], GetKeyName", "CHotKeyCtrl [MFC], SetHotKey", "CHotKeyCtrl [MFC], SetRules"] -ms.assetid: 896f9766-0718-4f58-aab2-20325e118ca6 --- # CHotKeyCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common hot key control. ## Syntax diff --git a/docs/mfc/reference/chtmleditctrl-class.md b/docs/mfc/reference/chtmleditctrl-class.md index 6a7e7c8c2a4..547bf0c9771 100644 --- a/docs/mfc/reference/chtmleditctrl-class.md +++ b/docs/mfc/reference/chtmleditctrl-class.md @@ -4,10 +4,12 @@ title: "CHtmlEditCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CHtmlEditCtrl", "AFXHTML/CHtmlEditCtrl", "AFXHTML/CHtmlEditCtrl::CHtmlEditCtrl", "AFXHTML/CHtmlEditCtrl::Create", "AFXHTML/CHtmlEditCtrl::GetDHtmlDocument", "AFXHTML/CHtmlEditCtrl::GetStartDocument"] helpviewer_keywords: ["CHtmlEditCtrl [MFC], CHtmlEditCtrl", "CHtmlEditCtrl [MFC], Create", "CHtmlEditCtrl [MFC], GetDHtmlDocument", "CHtmlEditCtrl [MFC], GetStartDocument"] -ms.assetid: 0fc4a238-b05f-4874-9edc-6a6701f064d9 --- # CHtmlEditCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the WebBrowser ActiveX control in an MFC window. ## Syntax diff --git a/docs/mfc/reference/chtmleditctrlbase-class.md b/docs/mfc/reference/chtmleditctrlbase-class.md index 084f3f0bed7..e092aa41d3f 100644 --- a/docs/mfc/reference/chtmleditctrlbase-class.md +++ b/docs/mfc/reference/chtmleditctrlbase-class.md @@ -4,10 +4,12 @@ title: "CHtmlEditCtrlBase Class" ms.date: "11/04/2016" f1_keywords: ["CHtmlEditCtrlBase", "AFXHTML/CHtmlEditCtrlBase", "AFXHTML/CHtmlEditCtrlBase::AddToGlyphTable", "AFXHTML/CHtmlEditCtrlBase::Bold", "AFXHTML/CHtmlEditCtrlBase::Button", "AFXHTML/CHtmlEditCtrlBase::CheckBox", "AFXHTML/CHtmlEditCtrlBase::ClearSelection", "AFXHTML/CHtmlEditCtrlBase::Copy", "AFXHTML/CHtmlEditCtrlBase::Cut", "AFXHTML/CHtmlEditCtrlBase::Delete", "AFXHTML/CHtmlEditCtrlBase::DropDownBox", "AFXHTML/CHtmlEditCtrlBase::EmptyGlyphTable", "AFXHTML/CHtmlEditCtrlBase::ExecCommand", "AFXHTML/CHtmlEditCtrlBase::Font", "AFXHTML/CHtmlEditCtrlBase::GetAbsolutePosition", "AFXHTML/CHtmlEditCtrlBase::GetBackColor", "AFXHTML/CHtmlEditCtrlBase::GetBlockFormat", "AFXHTML/CHtmlEditCtrlBase::GetBlockFormatNames", "AFXHTML/CHtmlEditCtrlBase::GetBookMark", "AFXHTML/CHtmlEditCtrlBase::GetDocument", "AFXHTML/CHtmlEditCtrlBase::GetDocumentHTML", "AFXHTML/CHtmlEditCtrlBase::GetDocumentTitle", "AFXHTML/CHtmlEditCtrlBase::GetEvent", "AFXHTML/CHtmlEditCtrlBase::GetEventSrcElement", "AFXHTML/CHtmlEditCtrlBase::GetFontFace", "AFXHTML/CHtmlEditCtrlBase::GetFontSize", "AFXHTML/CHtmlEditCtrlBase::GetForeColor", "AFXHTML/CHtmlEditCtrlBase::GetFrameZone", "AFXHTML/CHtmlEditCtrlBase::GetIsDirty", "AFXHTML/CHtmlEditCtrlBase::GetShowAlignedSiteTags", "AFXHTML/CHtmlEditCtrlBase::GetShowAllTags", "AFXHTML/CHtmlEditCtrlBase::GetShowAreaTags", "AFXHTML/CHtmlEditCtrlBase::GetShowBRTags", "AFXHTML/CHtmlEditCtrlBase::GetShowCommentTags", "AFXHTML/CHtmlEditCtrlBase::GetShowMiscTags", "AFXHTML/CHtmlEditCtrlBase::GetShowScriptTags", "AFXHTML/CHtmlEditCtrlBase::GetShowStyleTags", "AFXHTML/CHtmlEditCtrlBase::GetShowUnknownTags", "AFXHTML/CHtmlEditCtrlBase::HorizontalLine", "AFXHTML/CHtmlEditCtrlBase::HyperLink", "AFXHTML/CHtmlEditCtrlBase::IE50Paste", "AFXHTML/CHtmlEditCtrlBase::Iframe", "AFXHTML/CHtmlEditCtrlBase::Image", "AFXHTML/CHtmlEditCtrlBase::Indent", "AFXHTML/CHtmlEditCtrlBase::InsFieldSet", "AFXHTML/CHtmlEditCtrlBase::InsInputButton", "AFXHTML/CHtmlEditCtrlBase::InsInputHidden", "AFXHTML/CHtmlEditCtrlBase::InsInputImage", "AFXHTML/CHtmlEditCtrlBase::InsInputPassword", "AFXHTML/CHtmlEditCtrlBase::InsInputReset", "AFXHTML/CHtmlEditCtrlBase::InsInputSubmit", "AFXHTML/CHtmlEditCtrlBase::InsInputUpload", "AFXHTML/CHtmlEditCtrlBase::Is1DElement", "AFXHTML/CHtmlEditCtrlBase::Is2DElement", "AFXHTML/CHtmlEditCtrlBase::Italic", "AFXHTML/CHtmlEditCtrlBase::JustifyCenter", "AFXHTML/CHtmlEditCtrlBase::JustifyLeft", "AFXHTML/CHtmlEditCtrlBase::JustifyRight", "AFXHTML/CHtmlEditCtrlBase::ListBox", "AFXHTML/CHtmlEditCtrlBase::Marquee", "AFXHTML/CHtmlEditCtrlBase::NewDocument", "AFXHTML/CHtmlEditCtrlBase::OrderList", "AFXHTML/CHtmlEditCtrlBase::Outdent", "AFXHTML/CHtmlEditCtrlBase::Paragraph", "AFXHTML/CHtmlEditCtrlBase::Paste", "AFXHTML/CHtmlEditCtrlBase::PrintDocument", "AFXHTML/CHtmlEditCtrlBase::PrintPreview", "AFXHTML/CHtmlEditCtrlBase::QueryStatus", "AFXHTML/CHtmlEditCtrlBase::RadioButton", "AFXHTML/CHtmlEditCtrlBase::RefreshDocument", "AFXHTML/CHtmlEditCtrlBase::RemoveFormat", "AFXHTML/CHtmlEditCtrlBase::SaveAs", "AFXHTML/CHtmlEditCtrlBase::SelectAll", "AFXHTML/CHtmlEditCtrlBase::Set2DPosition", "AFXHTML/CHtmlEditCtrlBase::SetAbsolutePosition", "AFXHTML/CHtmlEditCtrlBase::SetAtomicSelection", "AFXHTML/CHtmlEditCtrlBase::SetAutoURLDetectMode", "AFXHTML/CHtmlEditCtrlBase::SetBackColor", "AFXHTML/CHtmlEditCtrlBase::SetBlockFormat", "AFXHTML/CHtmlEditCtrlBase::SetBookMark", "AFXHTML/CHtmlEditCtrlBase::SetCSSEditingLevel", "AFXHTML/CHtmlEditCtrlBase::SetDefaultComposeSettings", "AFXHTML/CHtmlEditCtrlBase::SetDesignMode", "AFXHTML/CHtmlEditCtrlBase::SetDisableEditFocusUI", "AFXHTML/CHtmlEditCtrlBase::SetDocumentHTML", "AFXHTML/CHtmlEditCtrlBase::SetFontFace", "AFXHTML/CHtmlEditCtrlBase::SetFontSize", "AFXHTML/CHtmlEditCtrlBase::SetForeColor", "AFXHTML/CHtmlEditCtrlBase::SetIE5PasteMode", "AFXHTML/CHtmlEditCtrlBase::SetLiveResize", "AFXHTML/CHtmlEditCtrlBase::SetMultiSelect", "AFXHTML/CHtmlEditCtrlBase::SetOverrideCursor", "AFXHTML/CHtmlEditCtrlBase::SetMode", "AFXHTML/CHtmlEditCtrlBase::SetRespectVisInDesign", "AFXHTML/CHtmlEditCtrlBase::SetShowAlignedSiteTags", "AFXHTML/CHtmlEditCtrlBase::SetShowAllTags", "AFXHTML/CHtmlEditCtrlBase::SetShowAreaTags", "AFXHTML/CHtmlEditCtrlBase::SetShowBRTags", "AFXHTML/CHtmlEditCtrlBase::SetShowCommentTags", "AFXHTML/CHtmlEditCtrlBase::SetShowMiscTags", "AFXHTML/CHtmlEditCtrlBase::SetShowScriptTags", "AFXHTML/CHtmlEditCtrlBase::SetShowStyleTags", "AFXHTML/CHtmlEditCtrlBase::SetShowUnknownTags", "AFXHTML/CHtmlEditCtrlBase::TextArea", "AFXHTML/CHtmlEditCtrlBase::TextBox", "AFXHTML/CHtmlEditCtrlBase::UnBookmark", "AFXHTML/CHtmlEditCtrlBase::Underline", "AFXHTML/CHtmlEditCtrlBase::Unlink", "AFXHTML/CHtmlEditCtrlBase::UnorderList"] helpviewer_keywords: ["CHtmlEditCtrlBase [MFC], AddToGlyphTable", "CHtmlEditCtrlBase [MFC], Bold", "CHtmlEditCtrlBase [MFC], Button", "CHtmlEditCtrlBase [MFC], CheckBox", "CHtmlEditCtrlBase [MFC], ClearSelection", "CHtmlEditCtrlBase [MFC], Copy", "CHtmlEditCtrlBase [MFC], Cut", "CHtmlEditCtrlBase [MFC], Delete", "CHtmlEditCtrlBase [MFC], DropDownBox", "CHtmlEditCtrlBase [MFC], EmptyGlyphTable", "CHtmlEditCtrlBase [MFC], ExecCommand", "CHtmlEditCtrlBase [MFC], Font", "CHtmlEditCtrlBase [MFC], GetAbsolutePosition", "CHtmlEditCtrlBase [MFC], GetBackColor", "CHtmlEditCtrlBase [MFC], GetBlockFormat", "CHtmlEditCtrlBase [MFC], GetBlockFormatNames", "CHtmlEditCtrlBase [MFC], GetBookMark", "CHtmlEditCtrlBase [MFC], GetDocument", "CHtmlEditCtrlBase [MFC], GetDocumentHTML", "CHtmlEditCtrlBase [MFC], GetDocumentTitle", "CHtmlEditCtrlBase [MFC], GetEvent", "CHtmlEditCtrlBase [MFC], GetEventSrcElement", "CHtmlEditCtrlBase [MFC], GetFontFace", "CHtmlEditCtrlBase [MFC], GetFontSize", "CHtmlEditCtrlBase [MFC], GetForeColor", "CHtmlEditCtrlBase [MFC], GetFrameZone", "CHtmlEditCtrlBase [MFC], GetIsDirty", "CHtmlEditCtrlBase [MFC], GetShowAlignedSiteTags", "CHtmlEditCtrlBase [MFC], GetShowAllTags", "CHtmlEditCtrlBase [MFC], GetShowAreaTags", "CHtmlEditCtrlBase [MFC], GetShowBRTags", "CHtmlEditCtrlBase [MFC], GetShowCommentTags", "CHtmlEditCtrlBase [MFC], GetShowMiscTags", "CHtmlEditCtrlBase [MFC], GetShowScriptTags", "CHtmlEditCtrlBase [MFC], GetShowStyleTags", "CHtmlEditCtrlBase [MFC], GetShowUnknownTags", "CHtmlEditCtrlBase [MFC], HorizontalLine", "CHtmlEditCtrlBase [MFC], HyperLink", "CHtmlEditCtrlBase [MFC], IE50Paste", "CHtmlEditCtrlBase [MFC], Iframe", "CHtmlEditCtrlBase [MFC], Image", "CHtmlEditCtrlBase [MFC], Indent", "CHtmlEditCtrlBase [MFC], InsFieldSet", "CHtmlEditCtrlBase [MFC], InsInputButton", "CHtmlEditCtrlBase [MFC], InsInputHidden", "CHtmlEditCtrlBase [MFC], InsInputImage", "CHtmlEditCtrlBase [MFC], InsInputPassword", "CHtmlEditCtrlBase [MFC], InsInputReset", "CHtmlEditCtrlBase [MFC], InsInputSubmit", "CHtmlEditCtrlBase [MFC], InsInputUpload", "CHtmlEditCtrlBase [MFC], Is1DElement", "CHtmlEditCtrlBase [MFC], Is2DElement", "CHtmlEditCtrlBase [MFC], Italic", "CHtmlEditCtrlBase [MFC], JustifyCenter", "CHtmlEditCtrlBase [MFC], JustifyLeft", "CHtmlEditCtrlBase [MFC], JustifyRight", "CHtmlEditCtrlBase [MFC], ListBox", "CHtmlEditCtrlBase [MFC], Marquee", "CHtmlEditCtrlBase [MFC], NewDocument", "CHtmlEditCtrlBase [MFC], OrderList", "CHtmlEditCtrlBase [MFC], Outdent", "CHtmlEditCtrlBase [MFC], Paragraph", "CHtmlEditCtrlBase [MFC], Paste", "CHtmlEditCtrlBase [MFC], PrintDocument", "CHtmlEditCtrlBase [MFC], PrintPreview", "CHtmlEditCtrlBase [MFC], QueryStatus", "CHtmlEditCtrlBase [MFC], RadioButton", "CHtmlEditCtrlBase [MFC], RefreshDocument", "CHtmlEditCtrlBase [MFC], RemoveFormat", "CHtmlEditCtrlBase [MFC], SaveAs", "CHtmlEditCtrlBase [MFC], SelectAll", "CHtmlEditCtrlBase [MFC], Set2DPosition", "CHtmlEditCtrlBase [MFC], SetAbsolutePosition", "CHtmlEditCtrlBase [MFC], SetAtomicSelection", "CHtmlEditCtrlBase [MFC], SetAutoURLDetectMode", "CHtmlEditCtrlBase [MFC], SetBackColor", "CHtmlEditCtrlBase [MFC], SetBlockFormat", "CHtmlEditCtrlBase [MFC], SetBookMark", "CHtmlEditCtrlBase [MFC], SetCSSEditingLevel", "CHtmlEditCtrlBase [MFC], SetDefaultComposeSettings", "CHtmlEditCtrlBase [MFC], SetDesignMode", "CHtmlEditCtrlBase [MFC], SetDisableEditFocusUI", "CHtmlEditCtrlBase [MFC], SetDocumentHTML", "CHtmlEditCtrlBase [MFC], SetFontFace", "CHtmlEditCtrlBase [MFC], SetFontSize", "CHtmlEditCtrlBase [MFC], SetForeColor", "CHtmlEditCtrlBase [MFC], SetIE5PasteMode", "CHtmlEditCtrlBase [MFC], SetLiveResize", "CHtmlEditCtrlBase [MFC], SetMultiSelect", "CHtmlEditCtrlBase [MFC], SetOverrideCursor", "CHtmlEditCtrlBase [MFC], SetOverwriteMode", "CHtmlEditCtrlBase [MFC], SetRespectVisInDesign", "CHtmlEditCtrlBase [MFC], SetShowAlignedSiteTags", "CHtmlEditCtrlBase [MFC], SetShowAllTags", "CHtmlEditCtrlBase [MFC], SetShowAreaTags", "CHtmlEditCtrlBase [MFC], SetShowBRTags", "CHtmlEditCtrlBase [MFC], SetShowCommentTags", "CHtmlEditCtrlBase [MFC], SetShowMiscTags", "CHtmlEditCtrlBase [MFC], SetShowScriptTags", "CHtmlEditCtrlBase [MFC], SetShowStyleTags", "CHtmlEditCtrlBase [MFC], SetShowUnknownTags", "CHtmlEditCtrlBase [MFC], TextArea", "CHtmlEditCtrlBase [MFC], TextBox", "CHtmlEditCtrlBase [MFC], UnBookmark", "CHtmlEditCtrlBase [MFC], Underline", "CHtmlEditCtrlBase [MFC], Unlink", "CHtmlEditCtrlBase [MFC], UnorderList"] -ms.assetid: e0cc74b4-8320-4570-b673-16c03d2ae266 --- # CHtmlEditCtrlBase Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents an HTML editing component. ## Syntax diff --git a/docs/mfc/reference/chtmleditdoc-class.md b/docs/mfc/reference/chtmleditdoc-class.md index 0e5251f0434..309a4e8901a 100644 --- a/docs/mfc/reference/chtmleditdoc-class.md +++ b/docs/mfc/reference/chtmleditdoc-class.md @@ -4,10 +4,12 @@ title: "CHtmlEditDoc Class" ms.date: "11/04/2016" f1_keywords: ["CHtmlEditDoc", "AFXHTML/CHtmlEditDoc", "AFXHTML/CHtmlEditDoc::CHtmlEditDoc", "AFXHTML/CHtmlEditDoc::GetView", "AFXHTML/CHtmlEditDoc::IsModified", "AFXHTML/CHtmlEditDoc::OpenURL"] helpviewer_keywords: ["CHtmlEditDoc [MFC], CHtmlEditDoc", "CHtmlEditDoc [MFC], GetView", "CHtmlEditDoc [MFC], IsModified", "CHtmlEditDoc [MFC], OpenURL"] -ms.assetid: b2cca61f-e5d6-4099-b0d1-46bf85f0bd64 --- # CHtmlEditDoc Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + With [CHtmlEditView](../../mfc/reference/chtmleditview-class.md), provides the functionality of the WebBrowser editing platform within the context of the MFC document-view architecture. ## Syntax diff --git a/docs/mfc/reference/chtmleditview-class.md b/docs/mfc/reference/chtmleditview-class.md index f636ef74ab1..0813a65f6bb 100644 --- a/docs/mfc/reference/chtmleditview-class.md +++ b/docs/mfc/reference/chtmleditview-class.md @@ -4,10 +4,12 @@ title: "CHtmlEditView Class" ms.date: "11/04/2016" f1_keywords: ["CHtmlEditView", "AFXHTML/CHtmlEditView", "AFXHTML/CHtmlEditView::CHtmlEditView", "AFXHTML/CHtmlEditView::Create", "AFXHTML/CHtmlEditView::GetDHtmlDocument", "AFXHTML/CHtmlEditView::GetStartDocument"] helpviewer_keywords: ["CHtmlEditView [MFC], CHtmlEditView", "CHtmlEditView [MFC], Create", "CHtmlEditView [MFC], GetDHtmlDocument", "CHtmlEditView [MFC], GetStartDocument"] -ms.assetid: 166c8ba8-3fb5-4dd7-a9ea-5bca662d00f6 --- # CHtmlEditView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the WebBrowser editing platform within the context of MFC's document/view architecture. ## Syntax diff --git a/docs/mfc/reference/chtmlview-class.md b/docs/mfc/reference/chtmlview-class.md index d19b1de124d..1a173311fc6 100644 --- a/docs/mfc/reference/chtmlview-class.md +++ b/docs/mfc/reference/chtmlview-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CHtmlView [MFC], Create", "CHtmlView [MFC], CreateControl --- # `CHtmlView` class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the WebBrowser control within the context of MFC's document/view architecture. ## Syntax diff --git a/docs/mfc/reference/chttpconnection-class.md b/docs/mfc/reference/chttpconnection-class.md index 04a22df5849..f8d4f1d7f87 100644 --- a/docs/mfc/reference/chttpconnection-class.md +++ b/docs/mfc/reference/chttpconnection-class.md @@ -4,10 +4,12 @@ title: "CHttpConnection Class" ms.date: "03/27/2019" f1_keywords: ["CHttpConnection", "AFXINET/CHttpConnection", "AFXINET/CHttpConnection::CHttpConnection", "AFXINET/CHttpConnection::OpenRequest"] helpviewer_keywords: ["CHttpConnection [MFC], CHttpConnection", "CHttpConnection [MFC], OpenRequest"] -ms.assetid: a402b662-c445-4988-800d-c8278551babe --- # CHttpConnection Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages your connection to an HTTP server. ## Syntax diff --git a/docs/mfc/reference/chttpfile-class.md b/docs/mfc/reference/chttpfile-class.md index 63ab4b55b7b..e6fac4c2b68 100644 --- a/docs/mfc/reference/chttpfile-class.md +++ b/docs/mfc/reference/chttpfile-class.md @@ -4,10 +4,12 @@ title: "CHttpFile Class" ms.date: "11/04/2016" f1_keywords: ["CHttpFile", "AFXINET/CHttpFile", "AFXINET/CHttpFile::CHttpFile", "AFXINET/CHttpFile::AddRequestHeaders", "AFXINET/CHttpFile::EndRequest", "AFXINET/CHttpFile::GetFileURL", "AFXINET/CHttpFile::GetObject", "AFXINET/CHttpFile::GetVerb", "AFXINET/CHttpFile::QueryInfo", "AFXINET/CHttpFile::QueryInfoStatusCode", "AFXINET/CHttpFile::SendRequest", "AFXINET/CHttpFile::SendRequestEx"] helpviewer_keywords: ["CHttpFile [MFC], CHttpFile", "CHttpFile [MFC], AddRequestHeaders", "CHttpFile [MFC], EndRequest", "CHttpFile [MFC], GetFileURL", "CHttpFile [MFC], GetObject", "CHttpFile [MFC], GetVerb", "CHttpFile [MFC], QueryInfo", "CHttpFile [MFC], QueryInfoStatusCode", "CHttpFile [MFC], SendRequest", "CHttpFile [MFC], SendRequestEx"] -ms.assetid: 399e7c68-bbce-4374-8c55-206e9c7baac6 --- # CHttpFile Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality to request and read files on an HTTP server. ## Syntax diff --git a/docs/mfc/reference/chwndrendertarget-class.md b/docs/mfc/reference/chwndrendertarget-class.md index 540b28ca338..a55070e729a 100644 --- a/docs/mfc/reference/chwndrendertarget-class.md +++ b/docs/mfc/reference/chwndrendertarget-class.md @@ -4,10 +4,12 @@ title: "CHwndRenderTarget Class" ms.date: "11/04/2016" f1_keywords: ["CHwndRenderTarget", "AFXRENDERTARGET/CHwndRenderTarget", "AFXRENDERTARGET/CHwndRenderTarget::CHwndRenderTarget", "AFXRENDERTARGET/CHwndRenderTarget::Attach", "AFXRENDERTARGET/CHwndRenderTarget::CheckWindowState", "AFXRENDERTARGET/CHwndRenderTarget::Create", "AFXRENDERTARGET/CHwndRenderTarget::Detach", "AFXRENDERTARGET/CHwndRenderTarget::GetHwnd", "AFXRENDERTARGET/CHwndRenderTarget::GetHwndRenderTarget", "AFXRENDERTARGET/CHwndRenderTarget::ReCreate", "AFXRENDERTARGET/CHwndRenderTarget::Resize", "AFXRENDERTARGET/CHwndRenderTarget::m_pHwndRenderTarget"] helpviewer_keywords: ["CHwndRenderTarget [MFC], CHwndRenderTarget", "CHwndRenderTarget [MFC], Attach", "CHwndRenderTarget [MFC], CheckWindowState", "CHwndRenderTarget [MFC], Create", "CHwndRenderTarget [MFC], Detach", "CHwndRenderTarget [MFC], GetHwnd", "CHwndRenderTarget [MFC], GetHwndRenderTarget", "CHwndRenderTarget [MFC], ReCreate", "CHwndRenderTarget [MFC], Resize", "CHwndRenderTarget [MFC], m_pHwndRenderTarget"] -ms.assetid: aa65b69f-7202-46ea-af81-ef325da0b840 --- # CHwndRenderTarget Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1HwndRenderTarget. ## Syntax diff --git a/docs/mfc/reference/cimagelist-class.md b/docs/mfc/reference/cimagelist-class.md index ca80bcc33ee..74324b18e4a 100644 --- a/docs/mfc/reference/cimagelist-class.md +++ b/docs/mfc/reference/cimagelist-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CImageList [MFC], CImageList", "CImageList [MFC], Add", " --- # `CImageList` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common image list control. ## Syntax diff --git a/docs/mfc/reference/cinstantaneoustransition-class.md b/docs/mfc/reference/cinstantaneoustransition-class.md index 3ae206b69ab..052761c2868 100644 --- a/docs/mfc/reference/cinstantaneoustransition-class.md +++ b/docs/mfc/reference/cinstantaneoustransition-class.md @@ -4,10 +4,12 @@ title: "CInstantaneousTransition Class" ms.date: "11/04/2016" f1_keywords: ["CInstantaneousTransition", "AFXANIMATIONCONTROLLER/CInstantaneousTransition", "AFXANIMATIONCONTROLLER/CInstantaneousTransition::CInstantaneousTransition", "AFXANIMATIONCONTROLLER/CInstantaneousTransition::Create", "AFXANIMATIONCONTROLLER/CInstantaneousTransition::m_dblFinalValue"] helpviewer_keywords: ["CInstantaneousTransition [MFC], CInstantaneousTransition", "CInstantaneousTransition [MFC], Create", "CInstantaneousTransition [MFC], m_dblFinalValue"] -ms.assetid: c3d5121f-2c6b-4221-9e57-10e082a31120 --- # CInstantaneousTransition Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates an instantaneous transition. ## Syntax diff --git a/docs/mfc/reference/cinternetconnection-class.md b/docs/mfc/reference/cinternetconnection-class.md index 0673cfd4de8..bc22af6454b 100644 --- a/docs/mfc/reference/cinternetconnection-class.md +++ b/docs/mfc/reference/cinternetconnection-class.md @@ -4,10 +4,12 @@ title: "CInternetConnection Class" ms.date: "11/04/2016" f1_keywords: ["CInternetConnection", "AFXINET/CInternetConnection", "AFXINET/CInternetConnection::CInternetConnection", "AFXINET/CInternetConnection::GetContext", "AFXINET/CInternetConnection::GetServerName", "AFXINET/CInternetConnection::GetSession"] helpviewer_keywords: ["CInternetConnection [MFC], CInternetConnection", "CInternetConnection [MFC], GetContext", "CInternetConnection [MFC], GetServerName", "CInternetConnection [MFC], GetSession"] -ms.assetid: 62a5d1c3-8471-4e36-a064-48831829b2a7 --- # CInternetConnection Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages your connection to an Internet server. ## Syntax diff --git a/docs/mfc/reference/cinternetexception-class.md b/docs/mfc/reference/cinternetexception-class.md index 0af84f73031..8b6ea3e8409 100644 --- a/docs/mfc/reference/cinternetexception-class.md +++ b/docs/mfc/reference/cinternetexception-class.md @@ -4,10 +4,12 @@ title: "CInternetException Class" ms.date: "11/04/2016" f1_keywords: ["CInternetException", "AFXINET/CInternetException", "AFXINET/CInternetException::CInternetException", "AFXINET/CInternetException::m_dwContext", "AFXINET/CInternetException::m_dwError"] helpviewer_keywords: ["CInternetException [MFC], CInternetException", "CInternetException [MFC], m_dwContext", "CInternetException [MFC], m_dwError"] -ms.assetid: 44fb3cbe-523e-4754-8843-a77909990b14 --- # CInternetException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents an exception condition related to an Internet operation. ## Syntax diff --git a/docs/mfc/reference/cinternetfile-class.md b/docs/mfc/reference/cinternetfile-class.md index 6e30d78c6bc..b8dc86a17a3 100644 --- a/docs/mfc/reference/cinternetfile-class.md +++ b/docs/mfc/reference/cinternetfile-class.md @@ -4,10 +4,12 @@ title: "CInternetFile Class" ms.date: "11/04/2016" f1_keywords: ["CInternetFile", "AFXINET/CInternetFile", "AFXINET/CInternetFile::CInternetFile", "AFXINET/CInternetFile::Abort", "AFXINET/CInternetFile::Close", "AFXINET/CInternetFile::Flush", "AFXINET/CInternetFile::GetLength", "AFXINET/CInternetFile::Read", "AFXINET/CInternetFile::ReadString", "AFXINET/CInternetFile::Seek", "AFXINET/CInternetFile::SetReadBufferSize", "AFXINET/CInternetFile::SetWriteBufferSize", "AFXINET/CInternetFile::Write", "AFXINET/CInternetFile::WriteString", "AFXINET/CInternetFile::m_hFile"] helpviewer_keywords: ["CInternetFile [MFC], CInternetFile", "CInternetFile [MFC], Abort", "CInternetFile [MFC], Close", "CInternetFile [MFC], Flush", "CInternetFile [MFC], GetLength", "CInternetFile [MFC], Read", "CInternetFile [MFC], ReadString", "CInternetFile [MFC], Seek", "CInternetFile [MFC], SetReadBufferSize", "CInternetFile [MFC], SetWriteBufferSize", "CInternetFile [MFC], Write", "CInternetFile [MFC], WriteString", "CInternetFile [MFC], m_hFile"] -ms.assetid: 96935681-ee71-4a8d-9783-5abc7b3e6f10 --- # CInternetFile Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Allows access to files on remote systems that use Internet protocols. ## Syntax diff --git a/docs/mfc/reference/cinternetsession-class.md b/docs/mfc/reference/cinternetsession-class.md index bc6087fc385..4ed84687949 100644 --- a/docs/mfc/reference/cinternetsession-class.md +++ b/docs/mfc/reference/cinternetsession-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CInternetSession [MFC], CInternetSession", "CInternetSess --- # `CInternetSession` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Creates and initializes a single or several simultaneous Internet sessions and, if necessary, describes your connection to a proxy server. ## Syntax diff --git a/docs/mfc/reference/cinterpolatorbase-class.md b/docs/mfc/reference/cinterpolatorbase-class.md index 3d8cced609b..93648302073 100644 --- a/docs/mfc/reference/cinterpolatorbase-class.md +++ b/docs/mfc/reference/cinterpolatorbase-class.md @@ -4,10 +4,12 @@ title: "CInterpolatorBase Class" ms.date: "11/04/2016" f1_keywords: ["CInterpolatorBase", "AFXANIMATIONCONTROLLER/CInterpolatorBase", "AFXANIMATIONCONTROLLER/CInterpolatorBase::CInterpolatorBase", "AFXANIMATIONCONTROLLER/CInterpolatorBase::CreateInstance", "AFXANIMATIONCONTROLLER/CInterpolatorBase::GetDependencies", "AFXANIMATIONCONTROLLER/CInterpolatorBase::GetDuration", "AFXANIMATIONCONTROLLER/CInterpolatorBase::GetFinalValue", "AFXANIMATIONCONTROLLER/CInterpolatorBase::InterpolateValue", "AFXANIMATIONCONTROLLER/CInterpolatorBase::InterpolateVelocity", "AFXANIMATIONCONTROLLER/CInterpolatorBase::SetCustomInterpolator", "AFXANIMATIONCONTROLLER/CInterpolatorBase::SetDuration", "AFXANIMATIONCONTROLLER/CInterpolatorBase::SetInitialValueAndVelocity"] helpviewer_keywords: ["CInterpolatorBase [MFC], CInterpolatorBase", "CInterpolatorBase [MFC], CreateInstance", "CInterpolatorBase [MFC], GetDependencies", "CInterpolatorBase [MFC], GetDuration", "CInterpolatorBase [MFC], GetFinalValue", "CInterpolatorBase [MFC], InterpolateValue", "CInterpolatorBase [MFC], InterpolateVelocity", "CInterpolatorBase [MFC], SetCustomInterpolator", "CInterpolatorBase [MFC], SetDuration", "CInterpolatorBase [MFC], SetInitialValueAndVelocity"] -ms.assetid: bbc3dce7-8398-47f9-b97e-e4fd2d737232 --- # CInterpolatorBase Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a callback, which is called by the Animation API when it has to calculate a new value of an animation variable. ## Syntax diff --git a/docs/mfc/reference/cinvalidargexception-class.md b/docs/mfc/reference/cinvalidargexception-class.md index 938e2630fbe..3efef73e2d8 100644 --- a/docs/mfc/reference/cinvalidargexception-class.md +++ b/docs/mfc/reference/cinvalidargexception-class.md @@ -4,10 +4,12 @@ title: "CInvalidArgException Class" ms.date: "11/04/2016" f1_keywords: ["CInvalidArgException", "AFX/CInvalidArgException", "AFX/CInvalidArgException::CInvalidArgException"] helpviewer_keywords: ["CInvalidArgException [MFC], CInvalidArgException"] -ms.assetid: e43d7c67-1157-47f8-817a-804083e8186e --- # CInvalidArgException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This class represents an invalid argument exception condition. ## Syntax diff --git a/docs/mfc/reference/cipaddressctrl-class.md b/docs/mfc/reference/cipaddressctrl-class.md index 859832b3e2e..6e0287d3989 100644 --- a/docs/mfc/reference/cipaddressctrl-class.md +++ b/docs/mfc/reference/cipaddressctrl-class.md @@ -4,10 +4,12 @@ title: "CIPAddressCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CIPAddressCtrl", "AFXCMN/CIPAddressCtrl", "AFXCMN/CIPAddressCtrl::CIPAddressCtrl", "AFXCMN/CIPAddressCtrl::ClearAddress", "AFXCMN/CIPAddressCtrl::Create", "AFXCMN/CIPAddressCtrl::CreateEx", "AFXCMN/CIPAddressCtrl::GetAddress", "AFXCMN/CIPAddressCtrl::IsBlank", "AFXCMN/CIPAddressCtrl::SetAddress", "AFXCMN/CIPAddressCtrl::SetFieldFocus", "AFXCMN/CIPAddressCtrl::SetFieldRange"] helpviewer_keywords: ["CIPAddressCtrl [MFC], CIPAddressCtrl", "CIPAddressCtrl [MFC], ClearAddress", "CIPAddressCtrl [MFC], Create", "CIPAddressCtrl [MFC], CreateEx", "CIPAddressCtrl [MFC], GetAddress", "CIPAddressCtrl [MFC], IsBlank", "CIPAddressCtrl [MFC], SetAddress", "CIPAddressCtrl [MFC], SetFieldFocus", "CIPAddressCtrl [MFC], SetFieldRange"] -ms.assetid: 9764d2f4-cb14-4ba8-b799-7f57a55a47c6 --- # CIPAddressCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common IP Address control. ## Syntax diff --git a/docs/mfc/reference/cjumplist-class.md b/docs/mfc/reference/cjumplist-class.md index e924d7a4a7c..140ef4a93e0 100644 --- a/docs/mfc/reference/cjumplist-class.md +++ b/docs/mfc/reference/cjumplist-class.md @@ -4,10 +4,12 @@ title: "CJumpList Class" ms.date: "03/27/2019" f1_keywords: ["CJumpList", "AFXADV/CJumpList", "AFXADV/CJumpList::CJumpList", "AFXADV/CJumpList::AbortList", "AFXADV/CJumpList::AddDestination", "AFXADV/CJumpList::AddKnownCategory", "AFXADV/CJumpList::AddTask", "AFXADV/CJumpList::AddTasks", "AFXADV/CJumpList::AddTaskSeparator", "AFXADV/CJumpList::ClearAll", "AFXADV/CJumpList::ClearAllDestinations", "AFXADV/CJumpList::CommitList", "AFXADV/CJumpList::GetDestinationList", "AFXADV/CJumpList::GetMaxSlots", "AFXADV/CJumpList::GetRemovedItems", "AFXADV/CJumpList::InitializeList", "AFXADV/CJumpList::SetAppID"] helpviewer_keywords: ["CJumpList [MFC], CJumpList", "CJumpList [MFC], AbortList", "CJumpList [MFC], AddDestination", "CJumpList [MFC], AddKnownCategory", "CJumpList [MFC], AddTask", "CJumpList [MFC], AddTasks", "CJumpList [MFC], AddTaskSeparator", "CJumpList [MFC], ClearAll", "CJumpList [MFC], ClearAllDestinations", "CJumpList [MFC], CommitList", "CJumpList [MFC], GetDestinationList", "CJumpList [MFC], GetMaxSlots", "CJumpList [MFC], GetRemovedItems", "CJumpList [MFC], InitializeList", "CJumpList [MFC], SetAppID"] -ms.assetid: d364d27e-f512-4b12-9872-c2a17c78ab1f --- # CJumpList Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A `CJumpList` is the list of shortcuts revealed when you right-click on an icon in the task bar. ## Syntax diff --git a/docs/mfc/reference/ckeyboardmanager-class.md b/docs/mfc/reference/ckeyboardmanager-class.md index 028992b0d67..19cfdf860e3 100644 --- a/docs/mfc/reference/ckeyboardmanager-class.md +++ b/docs/mfc/reference/ckeyboardmanager-class.md @@ -4,10 +4,12 @@ title: "CKeyboardManager Class" ms.date: "11/04/2016" f1_keywords: ["CKeyboardManager", "AFXKEYBOARDMANAGER/CKeyboardManager", "AFXKEYBOARDMANAGER/CKeyboardManager::CKeyboardManager", "AFXKEYBOARDMANAGER/CKeyboardManager::CleanUp", "AFXKEYBOARDMANAGER/CKeyboardManager::FindDefaultAccelerator", "AFXKEYBOARDMANAGER/CKeyboardManager::IsKeyHandled", "AFXKEYBOARDMANAGER/CKeyboardManager::IsKeyPrintable", "AFXKEYBOARDMANAGER/CKeyboardManager::IsShowAllAccelerators", "AFXKEYBOARDMANAGER/CKeyboardManager::LoadState", "AFXKEYBOARDMANAGER/CKeyboardManager::ResetAll", "AFXKEYBOARDMANAGER/CKeyboardManager::SaveState", "AFXKEYBOARDMANAGER/CKeyboardManager::ShowAllAccelerators", "AFXKEYBOARDMANAGER/CKeyboardManager::TranslateCharToUpper", "AFXKEYBOARDMANAGER/CKeyboardManager::UpdateAccelTable"] helpviewer_keywords: ["CKeyboardManager [MFC], CKeyboardManager", "CKeyboardManager [MFC], CleanUp", "CKeyboardManager [MFC], FindDefaultAccelerator", "CKeyboardManager [MFC], IsKeyHandled", "CKeyboardManager [MFC], IsKeyPrintable", "CKeyboardManager [MFC], IsShowAllAccelerators", "CKeyboardManager [MFC], LoadState", "CKeyboardManager [MFC], ResetAll", "CKeyboardManager [MFC], SaveState", "CKeyboardManager [MFC], ShowAllAccelerators", "CKeyboardManager [MFC], TranslateCharToUpper", "CKeyboardManager [MFC], UpdateAccelTable"] -ms.assetid: 4809ece6-89df-4479-8b53-9bf476ee107b --- # CKeyboardManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages shortcut key tables for the main frame window and child frame windows. ## Syntax diff --git a/docs/mfc/reference/ckeyframe-class.md b/docs/mfc/reference/ckeyframe-class.md index 295550b2edc..fab2e6461a0 100644 --- a/docs/mfc/reference/ckeyframe-class.md +++ b/docs/mfc/reference/ckeyframe-class.md @@ -4,10 +4,12 @@ title: "CKeyFrame Class" ms.date: "11/04/2016" f1_keywords: ["CKeyFrame", "AFXANIMATIONCONTROLLER/CKeyFrame", "AFXANIMATIONCONTROLLER/CKeyFrame::CKeyFrame", "AFXANIMATIONCONTROLLER/CKeyFrame::AddToStoryboard", "AFXANIMATIONCONTROLLER/CKeyFrame::AddToStoryboardAfterTransition", "AFXANIMATIONCONTROLLER/CKeyFrame::AddToStoryboardAtOffset", "AFXANIMATIONCONTROLLER/CKeyFrame::GetExistingKeyframe", "AFXANIMATIONCONTROLLER/CKeyFrame::GetOffset", "AFXANIMATIONCONTROLLER/CKeyFrame::GetTransition", "AFXANIMATIONCONTROLLER/CKeyFrame::m_offset", "AFXANIMATIONCONTROLLER/CKeyFrame::m_pExistingKeyFrame", "AFXANIMATIONCONTROLLER/CKeyFrame::m_pTransition"] helpviewer_keywords: ["CKeyFrame [MFC], CKeyFrame", "CKeyFrame [MFC], AddToStoryboard", "CKeyFrame [MFC], AddToStoryboardAfterTransition", "CKeyFrame [MFC], AddToStoryboardAtOffset", "CKeyFrame [MFC], GetExistingKeyframe", "CKeyFrame [MFC], GetOffset", "CKeyFrame [MFC], GetTransition", "CKeyFrame [MFC], m_offset", "CKeyFrame [MFC], m_pExistingKeyFrame", "CKeyFrame [MFC], m_pTransition"] -ms.assetid: d050a562-20f6-4c65-8ce5-ccb3aef1a20e --- # CKeyFrame Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents an animation keyframe. ## Syntax diff --git a/docs/mfc/reference/class-factories-and-licensing.md b/docs/mfc/reference/class-factories-and-licensing.md index fb570c46f96..eb2f2f98254 100644 --- a/docs/mfc/reference/class-factories-and-licensing.md +++ b/docs/mfc/reference/class-factories-and-licensing.md @@ -3,10 +3,12 @@ description: "Learn more about: Class Factories and Licensing" title: "Class Factories and Licensing" ms.date: "11/04/2016" helpviewer_keywords: ["class factories [MFC], and licensing"] -ms.assetid: 53c4856a-4062-46db-9f69-dd4339f746b3 --- # Class Factories and Licensing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To create an instance of your OLE control, a container application calls a member function of the control's class factory. Because your control is an actual OLE object, the class factory is responsible for creating instances of your control. Every OLE control class must have a class factory. Another important feature of OLE controls is their ability to enforce a license. ControlWizard allows you to incorporate licensing during the creation of your control project. For more information on control licensing, see the article [ActiveX Controls: Licensing An ActiveX Control](../../mfc/mfc-activex-controls-licensing-an-activex-control.md). diff --git a/docs/mfc/reference/classes-and-functions-generated-by-the-mfc-dll-wizard.md b/docs/mfc/reference/classes-and-functions-generated-by-the-mfc-dll-wizard.md index 8a8852ea8bd..c0db5403493 100644 --- a/docs/mfc/reference/classes-and-functions-generated-by-the-mfc-dll-wizard.md +++ b/docs/mfc/reference/classes-and-functions-generated-by-the-mfc-dll-wizard.md @@ -3,10 +3,12 @@ description: "Learn more about: Classes and Functions Generated by the MFC DLL W title: "Classes and Functions Generated by the MFC DLL Wizard" ms.date: "11/04/2016" helpviewer_keywords: ["functions [MFC]", "functions [MFC], DLLs", "MFC DLL Wizard", "DLLs [MFC], wizard classes and functions", "classes [MFC], generated by MFC DLL wizard", "code [MFC], generated by MFC DLL wizard"] -ms.assetid: e69e62fe-4953-42bf-a2fc-50bbf9bdaeaf --- # Classes and Functions Generated by the MFC DLL Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The code that the MFC DLL Wizard generates depends on the kind of DLL you are creating and the options you have selected. The MFC DLL Wizard generates the same code for both forms of regular MFC DLLs. |Kind of DLL|Option|Classes|Functions| diff --git a/docs/mfc/reference/clineartransition-class.md b/docs/mfc/reference/clineartransition-class.md index db00d95751a..4fc9741cd95 100644 --- a/docs/mfc/reference/clineartransition-class.md +++ b/docs/mfc/reference/clineartransition-class.md @@ -4,10 +4,12 @@ title: "CLinearTransition Class" ms.date: "11/04/2016" f1_keywords: ["CLinearTransition", "AFXANIMATIONCONTROLLER/CLinearTransition", "AFXANIMATIONCONTROLLER/CLinearTransition::CLinearTransition", "AFXANIMATIONCONTROLLER/CLinearTransition::Create", "AFXANIMATIONCONTROLLER/CLinearTransition::m_dblFinalValue", "AFXANIMATIONCONTROLLER/CLinearTransition::m_duration"] helpviewer_keywords: ["CLinearTransition [MFC], CLinearTransition", "CLinearTransition [MFC], Create", "CLinearTransition [MFC], m_dblFinalValue", "CLinearTransition [MFC], m_duration"] -ms.assetid: 7fcb2dba-beb8-4933-9f5d-3b7fb1585ef0 --- # CLinearTransition Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a linear transition. ## Syntax diff --git a/docs/mfc/reference/clineartransitionfromspeed-class.md b/docs/mfc/reference/clineartransitionfromspeed-class.md index 543e8eb4232..7054525da73 100644 --- a/docs/mfc/reference/clineartransitionfromspeed-class.md +++ b/docs/mfc/reference/clineartransitionfromspeed-class.md @@ -4,10 +4,12 @@ title: "CLinearTransitionFromSpeed Class" ms.date: "11/04/2016" f1_keywords: ["CLinearTransitionFromSpeed", "AFXANIMATIONCONTROLLER/CLinearTransitionFromSpeed", "AFXANIMATIONCONTROLLER/CLinearTransitionFromSpeed::CLinearTransitionFromSpeed", "AFXANIMATIONCONTROLLER/CLinearTransitionFromSpeed::Create", "AFXANIMATIONCONTROLLER/CLinearTransitionFromSpeed::m_dblFinalValue", "AFXANIMATIONCONTROLLER/CLinearTransitionFromSpeed::m_dblSpeed"] helpviewer_keywords: ["CLinearTransitionFromSpeed [MFC], CLinearTransitionFromSpeed", "CLinearTransitionFromSpeed [MFC], Create", "CLinearTransitionFromSpeed [MFC], m_dblFinalValue", "CLinearTransitionFromSpeed [MFC], m_dblSpeed"] -ms.assetid: 8f159a1c-8893-4017-951e-09e5758aba7d --- # CLinearTransitionFromSpeed Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a linear-speed transition. ## Syntax diff --git a/docs/mfc/reference/clinkctrl-class.md b/docs/mfc/reference/clinkctrl-class.md index 11601a0c130..0b0c0f80cc6 100644 --- a/docs/mfc/reference/clinkctrl-class.md +++ b/docs/mfc/reference/clinkctrl-class.md @@ -4,10 +4,12 @@ title: "CLinkCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CLinkCtrl", "AFXCMN/CLinkCtrl", "AFXCMN/CLinkCtrl::CLinkCtrl", "AFXCMN/CLinkCtrl::Create", "AFXCMN/CLinkCtrl::CreateEx", "AFXCMN/CLinkCtrl::GetIdealHeight", "AFXCMN/CLinkCtrl::GetIdealSize", "AFXCMN/CLinkCtrl::GetItem", "AFXCMN/CLinkCtrl::GetItemID", "AFXCMN/CLinkCtrl::GetItemState", "AFXCMN/CLinkCtrl::GetItemUrl", "AFXCMN/CLinkCtrl::HitTest", "AFXCMN/CLinkCtrl::SetItem", "AFXCMN/CLinkCtrl::SetItemID", "AFXCMN/CLinkCtrl::SetItemState", "AFXCMN/CLinkCtrl::SetItemUrl"] helpviewer_keywords: ["CLinkCtrl [MFC], CLinkCtrl", "CLinkCtrl [MFC], Create", "CLinkCtrl [MFC], CreateEx", "CLinkCtrl [MFC], GetIdealHeight", "CLinkCtrl [MFC], GetIdealSize", "CLinkCtrl [MFC], GetItem", "CLinkCtrl [MFC], GetItemID", "CLinkCtrl [MFC], GetItemState", "CLinkCtrl [MFC], GetItemUrl", "CLinkCtrl [MFC], HitTest", "CLinkCtrl [MFC], SetItem", "CLinkCtrl [MFC], SetItemID", "CLinkCtrl [MFC], SetItemState", "CLinkCtrl [MFC], SetItemUrl"] -ms.assetid: d1cd876a-ecca-42db-8ac4-9cd327df0cd4 --- # CLinkCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common SysLink control. ## Syntax diff --git a/docs/mfc/reference/clist-class.md b/docs/mfc/reference/clist-class.md index 083376f4fcf..536e937582b 100644 --- a/docs/mfc/reference/clist-class.md +++ b/docs/mfc/reference/clist-class.md @@ -4,10 +4,12 @@ title: "CList Class" ms.date: "11/04/2016" f1_keywords: ["CList", "AFXTEMPL/CList", "AFXTEMPL/CList::CList", "AFXTEMPL/CList::AddHead", "AFXTEMPL/CList::AddTail", "AFXTEMPL/CList::Find", "AFXTEMPL/CList::FindIndex", "AFXTEMPL/CList::GetAt", "AFXTEMPL/CList::GetCount", "AFXTEMPL/CList::GetHead", "AFXTEMPL/CList::GetHeadPosition", "AFXTEMPL/CList::GetNext", "AFXTEMPL/CList::GetPrev", "AFXTEMPL/CList::GetSize", "AFXTEMPL/CList::GetTail", "AFXTEMPL/CList::GetTailPosition", "AFXTEMPL/CList::InsertAfter", "AFXTEMPL/CList::InsertBefore", "AFXTEMPL/CList::IsEmpty", "AFXTEMPL/CList::RemoveAll", "AFXTEMPL/CList::RemoveAt", "AFXTEMPL/CList::RemoveHead", "AFXTEMPL/CList::RemoveTail", "AFXTEMPL/CList::SetAt"] helpviewer_keywords: ["CList [MFC], CList", "CList [MFC], AddHead", "CList [MFC], AddTail", "CList [MFC], Find", "CList [MFC], FindIndex", "CList [MFC], GetAt", "CList [MFC], GetCount", "CList [MFC], GetHead", "CList [MFC], GetHeadPosition", "CList [MFC], GetNext", "CList [MFC], GetPrev", "CList [MFC], GetSize", "CList [MFC], GetTail", "CList [MFC], GetTailPosition", "CList [MFC], InsertAfter", "CList [MFC], InsertBefore", "CList [MFC], IsEmpty", "CList [MFC], RemoveAll", "CList [MFC], RemoveAt", "CList [MFC], RemoveHead", "CList [MFC], RemoveTail", "CList [MFC], SetAt"] -ms.assetid: 6f6273c3-c8f6-47f5-ac2a-0a950379ae5d --- # `CList` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports ordered lists of nonunique objects accessible sequentially or by value. ## Syntax diff --git a/docs/mfc/reference/clistbox-class.md b/docs/mfc/reference/clistbox-class.md index 93f4efc5532..2c82cd368f2 100644 --- a/docs/mfc/reference/clistbox-class.md +++ b/docs/mfc/reference/clistbox-class.md @@ -4,10 +4,12 @@ description: "A description of the MFC CListBox class and its member functions." ms.date: "01/22/2020" f1_keywords: ["CListBox", "AFXWIN/CListBox", "AFXWIN/CListBox::CListBox", "AFXWIN/CListBox::AddString", "AFXWIN/CListBox::CharToItem", "AFXWIN/CListBox::CompareItem", "AFXWIN/CListBox::Create", "AFXWIN/CListBox::DeleteItem", "AFXWIN/CListBox::DeleteString", "AFXWIN/CListBox::Dir", "AFXWIN/CListBox::DrawItem", "AFXWIN/CListBox::FindString", "AFXWIN/CListBox::FindStringExact", "AFXWIN/CListBox::GetAnchorIndex", "AFXWIN/CListBox::GetCaretIndex", "AFXWIN/CListBox::GetCount", "AFXWIN/CListBox::GetCurSel", "AFXWIN/CListBox::GetHorizontalExtent", "AFXWIN/CListBox::GetItemData", "AFXWIN/CListBox::GetItemDataPtr", "AFXWIN/CListBox::GetItemHeight", "AFXWIN/CListBox::GetItemRect", "AFXWIN/CListBox::GetListBoxInfo", "AFXWIN/CListBox::GetLocale", "AFXWIN/CListBox::GetSel", "AFXWIN/CListBox::GetSelCount", "AFXWIN/CListBox::GetSelItems", "AFXWIN/CListBox::GetText", "AFXWIN/CListBox::GetTextLen", "AFXWIN/CListBox::GetTopIndex", "AFXWIN/CListBox::InitStorage", "AFXWIN/CListBox::InsertString", "AFXWIN/CListBox::ItemFromPoint", "AFXWIN/CListBox::MeasureItem", "AFXWIN/CListBox::ResetContent", "AFXWIN/CListBox::SelectString", "AFXWIN/CListBox::SelItemRange", "AFXWIN/CListBox::SetAnchorIndex", "AFXWIN/CListBox::SetCaretIndex", "AFXWIN/CListBox::SetColumnWidth", "AFXWIN/CListBox::SetCurSel", "AFXWIN/CListBox::SetHorizontalExtent", "AFXWIN/CListBox::SetItemData", "AFXWIN/CListBox::SetItemDataPtr", "AFXWIN/CListBox::SetItemHeight", "AFXWIN/CListBox::SetLocale", "AFXWIN/CListBox::SetSel", "AFXWIN/CListBox::SetTabStops", "AFXWIN/CListBox::SetTopIndex", "AFXWIN/CListBox::VKeyToItem"] helpviewer_keywords: ["CListBox [MFC], CListBox", "CListBox [MFC], AddString", "CListBox [MFC], CharToItem", "CListBox [MFC], CompareItem", "CListBox [MFC], Create", "CListBox [MFC], DeleteItem", "CListBox [MFC], DeleteString", "CListBox [MFC], Dir", "CListBox [MFC], DrawItem", "CListBox [MFC], FindString", "CListBox [MFC], FindStringExact", "CListBox [MFC], GetAnchorIndex", "CListBox [MFC], GetCaretIndex", "CListBox [MFC], GetCount", "CListBox [MFC], GetCurSel", "CListBox [MFC], GetHorizontalExtent", "CListBox [MFC], GetItemData", "CListBox [MFC], GetItemDataPtr", "CListBox [MFC], GetItemHeight", "CListBox [MFC], GetItemRect", "CListBox [MFC], GetListBoxInfo", "CListBox [MFC], GetLocale", "CListBox [MFC], GetSel", "CListBox [MFC], GetSelCount", "CListBox [MFC], GetSelItems", "CListBox [MFC], GetText", "CListBox [MFC], GetTextLen", "CListBox [MFC], GetTopIndex", "CListBox [MFC], InitStorage", "CListBox [MFC], InsertString", "CListBox [MFC], ItemFromPoint", "CListBox [MFC], MeasureItem", "CListBox [MFC], ResetContent", "CListBox [MFC], SelectString", "CListBox [MFC], SelItemRange", "CListBox [MFC], SetAnchorIndex", "CListBox [MFC], SetCaretIndex", "CListBox [MFC], SetColumnWidth", "CListBox [MFC], SetCurSel", "CListBox [MFC], SetHorizontalExtent", "CListBox [MFC], SetItemData", "CListBox [MFC], SetItemDataPtr", "CListBox [MFC], SetItemHeight", "CListBox [MFC], SetLocale", "CListBox [MFC], SetSel", "CListBox [MFC], SetTabStops", "CListBox [MFC], SetTopIndex", "CListBox [MFC], VKeyToItem"] -ms.assetid: 7ba3c699-c286-4cd9-9066-532c41ec05d1 --- # `CListBox` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a Windows list box. ## Syntax @@ -873,10 +875,10 @@ int InitStorage( ### Parameters *`nItems`*
-Specifies the number of items to add. +Specifies the number of items to for which to reserve space. *`nBytes`*
-Specifies the amount of memory, in bytes, to allocate for item strings. +Specifies the amount of additional memory, in bytes, to allocate for item strings. ### Return Value @@ -884,9 +886,11 @@ If successful, the maximum number of items that the list box can store before a ### Remarks -Call this function before adding a large number of items to a `CListBox`. +You can call this function before adding a large number of items to a `CListBox`. + +This function helps speed up the initialization of list boxes that have a large number of items (more than 100). It preallocates the specified amount of memory so that subsequent [`AddString`](#addstring), [`InsertString`](#insertstring), and [`Dir`](#dir) functions are more efficient. You can use estimates for the parameters. If you overestimate, the extra memory remains allocated; if you underestimate, the list box will allocate additional memory as necessary. -This function helps speed up the initialization of list boxes that have a large number of items (more than 100). It preallocates the specified amount of memory so that subsequent [`AddString`](#addstring), [`InsertString`](#insertstring), and [`Dir`](#dir) functions take the shortest possible time. You can use estimates for the parameters. If you overestimate, some extra memory is allocated; if you underestimate, the normal allocation is used for items that exceed the preallocated amount. +The memory required to store a string includes the null terminator. Therefore, if you plan to add 100 strings, each with a length of 10 characters, you would pass a *wParam* of 100 and an *lParam* of 100 × (10 + 1) × sizeof(TCHAR). Windows 95/98 only: The *`nItems`* parameter is limited to 16-bit values. This means list boxes cannot contain more than 32,767 items. Although the number of items is restricted, the total size of the items in a list box is limited only by available memory. diff --git a/docs/mfc/reference/clistctrl-class.md b/docs/mfc/reference/clistctrl-class.md index a9e92a75d11..489c3ee07dc 100644 --- a/docs/mfc/reference/clistctrl-class.md +++ b/docs/mfc/reference/clistctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CListCtrl [MFC], CListCtrl", "CListCtrl [MFC], Approximat --- # `CListCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the functionality of a "list view control," which displays a collection of items each consisting of an icon (from an image list) and a label. ## Syntax diff --git a/docs/mfc/reference/clistview-class.md b/docs/mfc/reference/clistview-class.md index 111656d0800..5536fc76f68 100644 --- a/docs/mfc/reference/clistview-class.md +++ b/docs/mfc/reference/clistview-class.md @@ -4,10 +4,12 @@ title: "CListView Class" ms.date: "11/04/2016" f1_keywords: ["CListView", "AFXCVIEW/CListView", "AFXCVIEW/CListView::CListView", "AFXCVIEW/CListView::GetListCtrl", "AFXCVIEW/CListView::RemoveImageList"] helpviewer_keywords: ["CListView [MFC], CListView", "CListView [MFC], GetListCtrl", "CListView [MFC], RemoveImageList"] -ms.assetid: 7626bdb2-a1b8-4eab-b631-6743710a8432 --- # CListView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Simplifies use of the list control and of [CListCtrl](../../mfc/reference/clistctrl-class.md), the class that encapsulates list-control functionality, with MFC's document-view architecture. ## Syntax diff --git a/docs/mfc/reference/clongbinary-class.md b/docs/mfc/reference/clongbinary-class.md index 7ba265343e8..268db8c9c57 100644 --- a/docs/mfc/reference/clongbinary-class.md +++ b/docs/mfc/reference/clongbinary-class.md @@ -4,10 +4,12 @@ title: "CLongBinary Class" ms.date: "11/04/2016" f1_keywords: ["CLongBinary", "AFXDB_/CLongBinary", "AFXDB_/CLongBinary::CLongBinary", "AFXDB_/CLongBinary::m_dwDataLength", "AFXDB_/CLongBinary::m_hData"] helpviewer_keywords: ["CLongBinary class [MFC]"] -ms.assetid: f4320059-aeb4-4ee5-bc2b-25f19d898ef5 --- # CLongBinary Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Simplifies working with very large binary data objects (often called BLOBs, or "binary large objects") in a database. ## Syntax diff --git a/docs/mfc/reference/cmap-class.md b/docs/mfc/reference/cmap-class.md index d985acc0408..ab87ec202a2 100644 --- a/docs/mfc/reference/cmap-class.md +++ b/docs/mfc/reference/cmap-class.md @@ -4,10 +4,12 @@ title: "CMap Class" ms.date: "11/04/2016" f1_keywords: ["CMap", "AFXTEMPL/CMap", "AFXTEMPL/CMap::CPair", "AFXTEMPL/CMap::CMap", "AFXTEMPL/CMap::GetCount", "AFXTEMPL/CMap::GetHashTableSize", "AFXTEMPL/CMap::GetNextAssoc", "AFXTEMPL/CMap::GetSize", "AFXTEMPL/CMap::GetStartPosition", "AFXTEMPL/CMap::InitHashTable", "AFXTEMPL/CMap::IsEmpty", "AFXTEMPL/CMap::Lookup", "AFXTEMPL/CMap::PGetFirstAssoc", "AFXTEMPL/CMap::PGetNextAssoc", "AFXTEMPL/CMap::PLookup", "AFXTEMPL/CMap::RemoveAll", "AFXTEMPL/CMap::RemoveKey", "AFXTEMPL/CMap::SetAt"] helpviewer_keywords: ["CMap [MFC], CPair", "CMap [MFC], CMap", "CMap [MFC], GetCount", "CMap [MFC], GetHashTableSize", "CMap [MFC], GetNextAssoc", "CMap [MFC], GetSize", "CMap [MFC], GetStartPosition", "CMap [MFC], InitHashTable", "CMap [MFC], IsEmpty", "CMap [MFC], Lookup", "CMap [MFC], PGetFirstAssoc", "CMap [MFC], PGetNextAssoc", "CMap [MFC], PLookup", "CMap [MFC], RemoveAll", "CMap [MFC], RemoveKey", "CMap [MFC], SetAt"] -ms.assetid: 640a45ab-0993-4def-97ec-42cc78eb10b9 --- # `CMap` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A dictionary collection class that maps unique keys to values. ## Syntax diff --git a/docs/mfc/reference/cmapptrtoptr-class.md b/docs/mfc/reference/cmapptrtoptr-class.md index 10277c43259..e30a3b31515 100644 --- a/docs/mfc/reference/cmapptrtoptr-class.md +++ b/docs/mfc/reference/cmapptrtoptr-class.md @@ -4,10 +4,12 @@ title: "CMapPtrToPtr Class" ms.date: "11/04/2016" f1_keywords: ["CMapPtrToPtr", "AFXCOLL/CMapPtrToPtr", "AFXCOLL/CMapPtrToPtr::CMapPtrToPtr", "AFXCOLL/CMapPtrToPtr::GetCount", "AFXCOLL/CMapPtrToPtr::GetHashTableSize", "AFXCOLL/CMapPtrToPtr::GetNextAssoc", "AFXCOLL/CMapPtrToPtr::GetSize", "AFXCOLL/CMapPtrToPtr::GetStartPosition", "AFXCOLL/CMapPtrToPtr::HashKey", "AFXCOLL/CMapPtrToPtr::InitHashTable", "AFXCOLL/CMapPtrToPtr::IsEmpty", "AFXCOLL/CMapPtrToPtr::Lookup", "AFXCOLL/CMapPtrToPtr::LookupKey", "AFXCOLL/CMapPtrToPtr::RemoveAll", "AFXCOLL/CMapPtrToPtr::RemoveKey", "AFXCOLL/CMapPtrToPtr::SetAt"] helpviewer_keywords: ["CMapPtrToPtr [MFC], CMapPtrToPtr", "CMapPtrToPtr [MFC], GetCount", "CMapPtrToPtr [MFC], GetHashTableSize", "CMapPtrToPtr [MFC], GetNextAssoc", "CMapPtrToPtr [MFC], GetSize", "CMapPtrToPtr [MFC], GetStartPosition", "CMapPtrToPtr [MFC], HashKey", "CMapPtrToPtr [MFC], InitHashTable", "CMapPtrToPtr [MFC], IsEmpty", "CMapPtrToPtr [MFC], Lookup", "CMapPtrToPtr [MFC], LookupKey", "CMapPtrToPtr [MFC], RemoveAll", "CMapPtrToPtr [MFC], RemoveKey", "CMapPtrToPtr [MFC], SetAt"] -ms.assetid: 23cbbaec-9d64-48f2-92ae-5e24fa64b926 --- # CMapPtrToPtr Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports maps of void pointers keyed by void pointers. ## Syntax diff --git a/docs/mfc/reference/cmapptrtoword-class.md b/docs/mfc/reference/cmapptrtoword-class.md index 1810b0d5fd7..6793004b32b 100644 --- a/docs/mfc/reference/cmapptrtoword-class.md +++ b/docs/mfc/reference/cmapptrtoword-class.md @@ -4,10 +4,12 @@ title: "CMapPtrToWord Class" ms.date: "11/04/2016" f1_keywords: ["CMapPtrToWord", "AFXCOLL/CMapPtrToWord", "AFXCOLL/CMapPtrToWord::CMapPtrToWord", "AFXCOLL/CMapPtrToWord::GetCount", "AFXCOLL/CMapPtrToWord::GetHashTableSize", "AFXCOLL/CMapPtrToWord::GetNextAssoc", "AFXCOLL/CMapPtrToWord::GetSize", "AFXCOLL/CMapPtrToWord::GetStartPosition", "AFXCOLL/CMapPtrToWord::HashKey", "AFXCOLL/CMapPtrToWord::InitHashTable", "AFXCOLL/CMapPtrToWord::IsEmpty", "AFXCOLL/CMapPtrToWord::Lookup", "AFXCOLL/CMapPtrToWord::LookupKey", "AFXCOLL/CMapPtrToWord::RemoveAll", "AFXCOLL/CMapPtrToWord::RemoveKey", "AFXCOLL/CMapPtrToWord::SetAt"] helpviewer_keywords: ["CMapPtrToWord [MFC], CMapPtrToWord", "CMapPtrToWord [MFC], GetCount", "CMapPtrToWord [MFC], GetHashTableSize", "CMapPtrToWord [MFC], GetNextAssoc", "CMapPtrToWord [MFC], GetSize", "CMapPtrToWord [MFC], GetStartPosition", "CMapPtrToWord [MFC], HashKey", "CMapPtrToWord [MFC], InitHashTable", "CMapPtrToWord [MFC], IsEmpty", "CMapPtrToWord [MFC], Lookup", "CMapPtrToWord [MFC], LookupKey", "CMapPtrToWord [MFC], RemoveAll", "CMapPtrToWord [MFC], RemoveKey", "CMapPtrToWord [MFC], SetAt"] -ms.assetid: 4631c6b6-d49f-49d9-adc0-1e0491e32d7b --- # CMapPtrToWord Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports maps of 16-bit words keyed by void pointers. ## Syntax diff --git a/docs/mfc/reference/cmapstringtoob-class.md b/docs/mfc/reference/cmapstringtoob-class.md index 7d7404e9956..a5de929c1c7 100644 --- a/docs/mfc/reference/cmapstringtoob-class.md +++ b/docs/mfc/reference/cmapstringtoob-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMapStringToOb [MFC], CMapStringToOb", "CMapStringToOb [M --- # `CMapStringToOb` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A dictionary collection class that maps unique `CString` objects to `CObject` pointers. ## Syntax diff --git a/docs/mfc/reference/cmapstringtoptr-class.md b/docs/mfc/reference/cmapstringtoptr-class.md index 4a4ac641f44..a89fe7b5c4f 100644 --- a/docs/mfc/reference/cmapstringtoptr-class.md +++ b/docs/mfc/reference/cmapstringtoptr-class.md @@ -4,10 +4,12 @@ title: "CMapStringToPtr Class" ms.date: "11/04/2016" f1_keywords: ["CMapStringToPtr", "AFXCOLL/CMapStringToPtr", "AFXCOLL/CMapStringToPtr::CMapStringToPtr", "AFXCOLL/CMapStringToPtr::GetCount", "AFXCOLL/CMapStringToPtr::GetHashTableSize", "AFXCOLL/CMapStringToPtr::GetNextAssoc", "AFXCOLL/CMapStringToPtr::GetSize", "AFXCOLL/CMapStringToPtr::GetStartPosition", "AFXCOLL/CMapStringToPtr::HashKey", "AFXCOLL/CMapStringToPtr::InitHashTable", "AFXCOLL/CMapStringToPtr::IsEmpty", "AFXCOLL/CMapStringToPtr::Lookup", "AFXCOLL/CMapStringToPtr::LookupKey", "AFXCOLL/CMapStringToPtr::RemoveAll", "AFXCOLL/CMapStringToPtr::RemoveKey", "AFXCOLL/CMapStringToPtr::SetAt"] helpviewer_keywords: ["CMapStringToPtr [MFC], CMapStringToPtr", "CMapStringToPtr [MFC], GetCount", "CMapStringToPtr [MFC], GetHashTableSize", "CMapStringToPtr [MFC], GetNextAssoc", "CMapStringToPtr [MFC], GetSize", "CMapStringToPtr [MFC], GetStartPosition", "CMapStringToPtr [MFC], HashKey", "CMapStringToPtr [MFC], InitHashTable", "CMapStringToPtr [MFC], IsEmpty", "CMapStringToPtr [MFC], Lookup", "CMapStringToPtr [MFC], LookupKey", "CMapStringToPtr [MFC], RemoveAll", "CMapStringToPtr [MFC], RemoveKey", "CMapStringToPtr [MFC], SetAt"] -ms.assetid: 1ac11143-eb0a-4511-a662-2df0d1d9005b --- # CMapStringToPtr Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports maps of void pointers keyed by `CString` objects. ## Syntax diff --git a/docs/mfc/reference/cmapstringtostring-class.md b/docs/mfc/reference/cmapstringtostring-class.md index 1899172a7ed..a7f970445e6 100644 --- a/docs/mfc/reference/cmapstringtostring-class.md +++ b/docs/mfc/reference/cmapstringtostring-class.md @@ -4,10 +4,12 @@ title: "CMapStringToString Class" ms.date: "11/04/2016" f1_keywords: ["CMapStringToString", "AFXCOLL/CMapStringToString", "AFXCOLL/CMapStringToString::CPair", "AFXCOLL/CMapStringToString::CMapStringToString", "AFXCOLL/CMapStringToString::GetCount", "AFXCOLL/CMapStringToString::GetHashTableSize", "AFXCOLL/CMapStringToString::GetNextAssoc", "AFXCOLL/CMapStringToString::GetSize", "AFXCOLL/CMapStringToString::GetStartPosition", "AFXCOLL/CMapStringToString::HashKey", "AFXCOLL/CMapStringToString::InitHashTable", "AFXCOLL/CMapStringToString::IsEmpty", "AFXCOLL/CMapStringToString::Lookup", "AFXCOLL/CMapStringToString::LookupKey", "AFXCOLL/CMapStringToString::PGetFirstAssoc", "AFXCOLL/CMapStringToString::PGetNextAssoc", "AFXCOLL/CMapStringToString::PLookup", "AFXCOLL/CMapStringToString::RemoveAll", "AFXCOLL/CMapStringToString::RemoveKey", "AFXCOLL/CMapStringToString::SetAt"] helpviewer_keywords: ["CMapStringToString [MFC], CPair", "CMapStringToString [MFC], CMapStringToString", "CMapStringToString [MFC], GetCount", "CMapStringToString [MFC], GetHashTableSize", "CMapStringToString [MFC], GetNextAssoc", "CMapStringToString [MFC], GetSize", "CMapStringToString [MFC], GetStartPosition", "CMapStringToString [MFC], HashKey", "CMapStringToString [MFC], InitHashTable", "CMapStringToString [MFC], IsEmpty", "CMapStringToString [MFC], Lookup", "CMapStringToString [MFC], LookupKey", "CMapStringToString [MFC], PGetFirstAssoc", "CMapStringToString [MFC], PGetNextAssoc", "CMapStringToString [MFC], PLookup", "CMapStringToString [MFC], RemoveAll", "CMapStringToString [MFC], RemoveKey", "CMapStringToString [MFC], SetAt"] -ms.assetid: b45794c2-fe6b-4edb-a8ca-faa03b57b4a8 --- # CMapStringToString Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports maps of `CString` objects keyed by `CString` objects. ## Syntax diff --git a/docs/mfc/reference/cmapwordtoob-class.md b/docs/mfc/reference/cmapwordtoob-class.md index 395f405e314..8b3c3c428d7 100644 --- a/docs/mfc/reference/cmapwordtoob-class.md +++ b/docs/mfc/reference/cmapwordtoob-class.md @@ -4,10 +4,12 @@ title: "CMapWordToOb Class" ms.date: "11/04/2016" f1_keywords: ["CMapWordToOb", "AFXCOLL/CMapWordToOb", "AFXCOLL/CMapWordToOb::CMapWordToOb", "AFXCOLL/CMapWordToOb::GetCount", "AFXCOLL/CMapWordToOb::GetHashTableSize", "AFXCOLL/CMapWordToOb::GetNextAssoc", "AFXCOLL/CMapWordToOb::GetSize", "AFXCOLL/CMapWordToOb::GetStartPosition", "AFXCOLL/CMapWordToOb::HashKey", "AFXCOLL/CMapWordToOb::InitHashTable", "AFXCOLL/CMapWordToOb::IsEmpty", "AFXCOLL/CMapWordToOb::Lookup", "AFXCOLL/CMapWordToOb::LookupKey", "AFXCOLL/CMapWordToOb::RemoveAll", "AFXCOLL/CMapWordToOb::RemoveKey", "AFXCOLL/CMapWordToOb::SetAt"] helpviewer_keywords: ["CMapWordToOb [MFC], CMapWordToOb", "CMapWordToOb [MFC], GetCount", "CMapWordToOb [MFC], GetHashTableSize", "CMapWordToOb [MFC], GetNextAssoc", "CMapWordToOb [MFC], GetSize", "CMapWordToOb [MFC], GetStartPosition", "CMapWordToOb [MFC], HashKey", "CMapWordToOb [MFC], InitHashTable", "CMapWordToOb [MFC], IsEmpty", "CMapWordToOb [MFC], Lookup", "CMapWordToOb [MFC], LookupKey", "CMapWordToOb [MFC], RemoveAll", "CMapWordToOb [MFC], RemoveKey", "CMapWordToOb [MFC], SetAt"] -ms.assetid: 9c9bcd76-456f-4cf9-b03c-dd28b49d5e4f --- # CMapWordToOb Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports maps of `CObject` pointers keyed by 16-bit words. ## Syntax diff --git a/docs/mfc/reference/cmapwordtoptr-class.md b/docs/mfc/reference/cmapwordtoptr-class.md index 474a9292c20..90d850b0f18 100644 --- a/docs/mfc/reference/cmapwordtoptr-class.md +++ b/docs/mfc/reference/cmapwordtoptr-class.md @@ -4,10 +4,12 @@ title: "CMapWordToPtr Class" ms.date: "11/04/2016" f1_keywords: ["CMapWordToPtr", "AFXCOLL/CMapWordToPtr", "AFXCOLL/CMapWordToPtr::CMapWordToPtr", "AFXCOLL/CMapWordToPtr::GetCount", "AFXCOLL/CMapWordToPtr::GetHashTableSize", "AFXCOLL/CMapWordToPtr::GetNextAssoc", "AFXCOLL/CMapWordToPtr::GetSize", "AFXCOLL/CMapWordToPtr::GetStartPosition", "AFXCOLL/CMapWordToPtr::HashKey", "AFXCOLL/CMapWordToPtr::InitHashTable", "AFXCOLL/CMapWordToPtr::IsEmpty", "AFXCOLL/CMapWordToPtr::Lookup", "AFXCOLL/CMapWordToPtr::LookupKey", "AFXCOLL/CMapWordToPtr::RemoveAll", "AFXCOLL/CMapWordToPtr::RemoveKey", "AFXCOLL/CMapWordToPtr::SetAt"] helpviewer_keywords: ["CMapWordToPtr [MFC], CMapWordToPtr", "CMapWordToPtr [MFC], GetCount", "CMapWordToPtr [MFC], GetHashTableSize", "CMapWordToPtr [MFC], GetNextAssoc", "CMapWordToPtr [MFC], GetSize", "CMapWordToPtr [MFC], GetStartPosition", "CMapWordToPtr [MFC], HashKey", "CMapWordToPtr [MFC], InitHashTable", "CMapWordToPtr [MFC], IsEmpty", "CMapWordToPtr [MFC], Lookup", "CMapWordToPtr [MFC], LookupKey", "CMapWordToPtr [MFC], RemoveAll", "CMapWordToPtr [MFC], RemoveKey", "CMapWordToPtr [MFC], SetAt"] -ms.assetid: b204d87f-6427-43e1-93e3-a4b1bb41099f --- # CMapWordToPtr Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports maps of void pointers keyed by 16-bit words. ## Syntax diff --git a/docs/mfc/reference/cmdichildwnd-class.md b/docs/mfc/reference/cmdichildwnd-class.md index a199284190a..acace68a0f5 100644 --- a/docs/mfc/reference/cmdichildwnd-class.md +++ b/docs/mfc/reference/cmdichildwnd-class.md @@ -4,10 +4,12 @@ title: "CMDIChildWnd Class" ms.date: "11/04/2016" f1_keywords: ["CMDIChildWnd", "AFXWIN/CMDIChildWnd", "AFXWIN/CMDIChildWnd::CMDIChildWnd", "AFXWIN/CMDIChildWnd::Create", "AFXWIN/CMDIChildWnd::GetMDIFrame", "AFXWIN/CMDIChildWnd::MDIActivate", "AFXWIN/CMDIChildWnd::MDIDestroy", "AFXWIN/CMDIChildWnd::MDIMaximize", "AFXWIN/CMDIChildWnd::MDIRestore", "AFXWIN/CMDIChildWnd::SetHandles"] helpviewer_keywords: ["CMDIChildWnd [MFC], CMDIChildWnd", "CMDIChildWnd [MFC], Create", "CMDIChildWnd [MFC], GetMDIFrame", "CMDIChildWnd [MFC], MDIActivate", "CMDIChildWnd [MFC], MDIDestroy", "CMDIChildWnd [MFC], MDIMaximize", "CMDIChildWnd [MFC], MDIRestore", "CMDIChildWnd [MFC], SetHandles"] -ms.assetid: 6d07f5d4-9a3e-4723-9fa5-e65bb669fdd5 --- # CMDIChildWnd Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a Windows multiple document interface (MDI) child window, along with members for managing the window. ## Syntax diff --git a/docs/mfc/reference/cmdichildwndex-class.md b/docs/mfc/reference/cmdichildwndex-class.md index b1f2e320dd5..a689a0849b7 100644 --- a/docs/mfc/reference/cmdichildwndex-class.md +++ b/docs/mfc/reference/cmdichildwndex-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMDIChildWndEx [MFC], ActivateTopLevelFrame", "CMDIChildW --- # CMDIChildWndEx Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMDIChildWndEx` class provides the functionality of a Windows multiple document interface (MDI) child window. It extends the functionality of [CMDIChildWnd Class](../../mfc/reference/cmdichildwnd-class.md). The framework requires this class when an MDI application uses certain MFC classes. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmdiframewnd-class.md b/docs/mfc/reference/cmdiframewnd-class.md index 8e5dc3025ae..f757ad62da0 100644 --- a/docs/mfc/reference/cmdiframewnd-class.md +++ b/docs/mfc/reference/cmdiframewnd-class.md @@ -4,10 +4,12 @@ title: "CMDIFrameWnd Class" ms.date: "11/04/2016" f1_keywords: ["CMDIFrameWnd", "AFXWIN/CMDIFrameWnd", "AFXWIN/CMDIFrameWnd::CMDIFrameWnd", "AFXWIN/CMDIFrameWnd::CreateClient", "AFXWIN/CMDIFrameWnd::CreateNewChild", "AFXWIN/CMDIFrameWnd::GetWindowMenuPopup", "AFXWIN/CMDIFrameWnd::MDIActivate", "AFXWIN/CMDIFrameWnd::MDICascade", "AFXWIN/CMDIFrameWnd::MDIGetActive", "AFXWIN/CMDIFrameWnd::MDIIconArrange", "AFXWIN/CMDIFrameWnd::MDIMaximize", "AFXWIN/CMDIFrameWnd::MDINext", "AFXWIN/CMDIFrameWnd::MDIPrev", "AFXWIN/CMDIFrameWnd::MDIRestore", "AFXWIN/CMDIFrameWnd::MDISetMenu", "AFXWIN/CMDIFrameWnd::MDITile"] helpviewer_keywords: ["CMDIFrameWnd [MFC], CMDIFrameWnd", "CMDIFrameWnd [MFC], CreateClient", "CMDIFrameWnd [MFC], CreateNewChild", "CMDIFrameWnd [MFC], GetWindowMenuPopup", "CMDIFrameWnd [MFC], MDIActivate", "CMDIFrameWnd [MFC], MDICascade", "CMDIFrameWnd [MFC], MDIGetActive", "CMDIFrameWnd [MFC], MDIIconArrange", "CMDIFrameWnd [MFC], MDIMaximize", "CMDIFrameWnd [MFC], MDINext", "CMDIFrameWnd [MFC], MDIPrev", "CMDIFrameWnd [MFC], MDIRestore", "CMDIFrameWnd [MFC], MDISetMenu", "CMDIFrameWnd [MFC], MDITile"] -ms.assetid: fa8736e6-511b-4c51-8b4d-eba78378aeb9 --- # CMDIFrameWnd Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a Windows multiple document interface (MDI) frame window, along with members for managing the window. ## Syntax diff --git a/docs/mfc/reference/cmdiframewndex-class.md b/docs/mfc/reference/cmdiframewndex-class.md index 4cebc0fd4de..47ee4e152ce 100644 --- a/docs/mfc/reference/cmdiframewndex-class.md +++ b/docs/mfc/reference/cmdiframewndex-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMDIFrameWndEx [MFC], ActiveItemRecalcLayout", "CMDIFrame --- # `CMDIFrameWndEx` class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Extends the functionality of [`CMDIFrameWnd`](../../mfc/reference/cframewnd-class.md), a Windows Multiple Document Interface (MDI) frame window. ## Syntax diff --git a/docs/mfc/reference/cmditabinfo-class.md b/docs/mfc/reference/cmditabinfo-class.md index f2c9ffc9a02..d2ef90ec29b 100644 --- a/docs/mfc/reference/cmditabinfo-class.md +++ b/docs/mfc/reference/cmditabinfo-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMDITabInfo [MFC], Serialize", "CMDITabInfo [MFC], m_bAut --- # CMDITabInfo Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMDITabInfo` class is used to pass parameters to [CMDIFrameWndEx::EnableMDITabbedGroups](../../mfc/reference/cmdiframewndex-class.md#enablemditabbedgroups) method. Set members of this class to control the behavior of MDI tabbed groups. ## Syntax diff --git a/docs/mfc/reference/cmemfile-class.md b/docs/mfc/reference/cmemfile-class.md index d6b8ff19954..4fdaeeddc42 100644 --- a/docs/mfc/reference/cmemfile-class.md +++ b/docs/mfc/reference/cmemfile-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMemFile [MFC], CMemFile", "CMemFile [MFC], Attach", "CMe --- # CMemFile Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [CFile](../../mfc/reference/cfile-class.md)-derived class that supports memory files. ## Syntax diff --git a/docs/mfc/reference/cmemoryexception-class.md b/docs/mfc/reference/cmemoryexception-class.md index d7afee5e522..42c37ca9bcc 100644 --- a/docs/mfc/reference/cmemoryexception-class.md +++ b/docs/mfc/reference/cmemoryexception-class.md @@ -4,10 +4,12 @@ title: "CMemoryException Class" ms.date: "11/04/2016" f1_keywords: ["CMemoryException", "AFX/CMemoryException", "AFX/CMemoryException::CMemoryException"] helpviewer_keywords: ["CMemoryException [MFC], CMemoryException"] -ms.assetid: 9af0ed57-d12a-45ca-82b5-c910a60f7edf --- # CMemoryException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents an out-of-memory exception condition. ## Syntax diff --git a/docs/mfc/reference/cmemorystate-structure.md b/docs/mfc/reference/cmemorystate-structure.md index a81816fc534..9f6a7f3f41f 100644 --- a/docs/mfc/reference/cmemorystate-structure.md +++ b/docs/mfc/reference/cmemorystate-structure.md @@ -4,10 +4,12 @@ title: "CMemoryState Structure" ms.date: "11/04/2016" f1_keywords: ["CMemoryState"] helpviewer_keywords: ["CMemoryState structure [MFC]", "memory leaks [MFC], detecting", "detecting memory leaks [MFC]"] -ms.assetid: 229d9de7-a6f3-4cc6-805b-5a9d9b1bfe1d --- # CMemoryState Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides a convenient way to detect memory leaks in your program. ## Syntax diff --git a/docs/mfc/reference/cmenu-class.md b/docs/mfc/reference/cmenu-class.md index 70d8e40d751..7cf5c9589a0 100644 --- a/docs/mfc/reference/cmenu-class.md +++ b/docs/mfc/reference/cmenu-class.md @@ -4,10 +4,12 @@ title: "CMenu Class" ms.date: "11/04/2016" f1_keywords: ["CMenu", "AFXWIN/CMenu", "AFXWIN/CMenu::CMenu", "AFXWIN/CMenu::AppendMenu", "AFXWIN/CMenu::Attach", "AFXWIN/CMenu::CheckMenuItem", "AFXWIN/CMenu::CheckMenuRadioItem", "AFXWIN/CMenu::CreateMenu", "AFXWIN/CMenu::CreatePopupMenu", "AFXWIN/CMenu::DeleteMenu", "AFXWIN/CMenu::DeleteTempMap", "AFXWIN/CMenu::DestroyMenu", "AFXWIN/CMenu::Detach", "AFXWIN/CMenu::DrawItem", "AFXWIN/CMenu::EnableMenuItem", "AFXWIN/CMenu::FromHandle", "AFXWIN/CMenu::GetDefaultItem", "AFXWIN/CMenu::GetMenuContextHelpId", "AFXWIN/CMenu::GetMenuInfo", "AFXWIN/CMenu::GetMenuItemCount", "AFXWIN/CMenu::GetMenuItemID", "AFXWIN/CMenu::GetMenuItemInfo", "AFXWIN/CMenu::GetMenuState", "AFXWIN/CMenu::GetMenuString", "AFXWIN/CMenu::GetSafeHmenu", "AFXWIN/CMenu::GetSubMenu", "AFXWIN/CMenu::InsertMenu", "AFXWIN/CMenu::InsertMenuItem", "AFXWIN/CMenu::LoadMenu", "AFXWIN/CMenu::LoadMenuIndirect", "AFXWIN/CMenu::MeasureItem", "AFXWIN/CMenu::ModifyMenu", "AFXWIN/CMenu::RemoveMenu", "AFXWIN/CMenu::SetDefaultItem", "AFXWIN/CMenu::SetMenuContextHelpId", "AFXWIN/CMenu::SetMenuInfo", "AFXWIN/CMenu::SetMenuItemBitmaps", "AFXWIN/CMenu::SetMenuItemInfo", "AFXWIN/CMenu::TrackPopupMenu", "AFXWIN/CMenu::TrackPopupMenuEx", "AFXWIN/CMenu::m_hMenu"] helpviewer_keywords: ["CMenu [MFC], CMenu", "CMenu [MFC], AppendMenu", "CMenu [MFC], Attach", "CMenu [MFC], CheckMenuItem", "CMenu [MFC], CheckMenuRadioItem", "CMenu [MFC], CreateMenu", "CMenu [MFC], CreatePopupMenu", "CMenu [MFC], DeleteMenu", "CMenu [MFC], DeleteTempMap", "CMenu [MFC], DestroyMenu", "CMenu [MFC], Detach", "CMenu [MFC], DrawItem", "CMenu [MFC], EnableMenuItem", "CMenu [MFC], FromHandle", "CMenu [MFC], GetDefaultItem", "CMenu [MFC], GetMenuContextHelpId", "CMenu [MFC], GetMenuInfo", "CMenu [MFC], GetMenuItemCount", "CMenu [MFC], GetMenuItemID", "CMenu [MFC], GetMenuItemInfo", "CMenu [MFC], GetMenuState", "CMenu [MFC], GetMenuString", "CMenu [MFC], GetSafeHmenu", "CMenu [MFC], GetSubMenu", "CMenu [MFC], InsertMenu", "CMenu [MFC], InsertMenuItem", "CMenu [MFC], LoadMenu", "CMenu [MFC], LoadMenuIndirect", "CMenu [MFC], MeasureItem", "CMenu [MFC], ModifyMenu", "CMenu [MFC], RemoveMenu", "CMenu [MFC], SetDefaultItem", "CMenu [MFC], SetMenuContextHelpId", "CMenu [MFC], SetMenuInfo", "CMenu [MFC], SetMenuItemBitmaps", "CMenu [MFC], SetMenuItemInfo", "CMenu [MFC], TrackPopupMenu", "CMenu [MFC], TrackPopupMenuEx", "CMenu [MFC], m_hMenu"] -ms.assetid: 40cacfdc-d45c-4ec7-bf28-991c72812499 --- # `CMenu` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An encapsulation of the Windows `HMENU`. ## Syntax diff --git a/docs/mfc/reference/cmenutearoffmanager-class.md b/docs/mfc/reference/cmenutearoffmanager-class.md index 3aeb8d41a0b..d4fea412a20 100644 --- a/docs/mfc/reference/cmenutearoffmanager-class.md +++ b/docs/mfc/reference/cmenutearoffmanager-class.md @@ -4,10 +4,12 @@ title: "CMenuTearOffManager Class" ms.date: "10/18/2018" f1_keywords: ["CMenuTearOffManager", "AFXMENUTEAROFFMANAGER/CMenuTearOffManager", "AFXMENUTEAROFFMANAGER/CMenuTearOffManager::CMenuTearOffManager", "AFXMENUTEAROFFMANAGER/CMenuTearOffManager::Build", "AFXMENUTEAROFFMANAGER/CMenuTearOffManager::GetRegPath", "AFXMENUTEAROFFMANAGER/CMenuTearOffManager::Initialize", "AFXMENUTEAROFFMANAGER/CMenuTearOffManager::IsDynamicID", "AFXMENUTEAROFFMANAGER/CMenuTearOffManager::Parse", "AFXMENUTEAROFFMANAGER/CMenuTearOffManager::Reset", "AFXMENUTEAROFFMANAGER/CMenuTearOffManager::SetInUse", "AFXMENUTEAROFFMANAGER/CMenuTearOffManager::SetupTearOffMenus"] helpviewer_keywords: ["CMenuTearOffManager [MFC], CMenuTearOffManager", "CMenuTearOffManager [MFC], Build", "CMenuTearOffManager [MFC], GetRegPath", "CMenuTearOffManager [MFC], Initialize", "CMenuTearOffManager [MFC], IsDynamicID", "CMenuTearOffManager [MFC], Parse", "CMenuTearOffManager [MFC], Reset", "CMenuTearOffManager [MFC], SetInUse", "CMenuTearOffManager [MFC], SetupTearOffMenus"] -ms.assetid: ab7ca272-ce42-4678-95f7-6ad75038f5a0 --- # CMenuTearOffManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages tear-off menus. A tear-off menu is a menu on the menu bar. The user can remove a tear-off menu from the menu bar, causing the tear-off menu to float. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmetafiledc-class.md b/docs/mfc/reference/cmetafiledc-class.md index 247113ce933..cbbca361521 100644 --- a/docs/mfc/reference/cmetafiledc-class.md +++ b/docs/mfc/reference/cmetafiledc-class.md @@ -4,10 +4,12 @@ title: "CMetaFileDC Class" ms.date: "11/04/2016" f1_keywords: ["CMetaFileDC", "AFXEXT/CMetaFileDC", "AFXEXT/CMetaFileDC::CMetaFileDC", "AFXEXT/CMetaFileDC::Close", "AFXEXT/CMetaFileDC::CloseEnhanced", "AFXEXT/CMetaFileDC::Create", "AFXEXT/CMetaFileDC::CreateEnhanced"] helpviewer_keywords: ["CMetaFileDC [MFC], CMetaFileDC", "CMetaFileDC [MFC], Close", "CMetaFileDC [MFC], CloseEnhanced", "CMetaFileDC [MFC], Create", "CMetaFileDC [MFC], CreateEnhanced"] -ms.assetid: ffce60fa-4181-4d46-9832-25e46fad4db4 --- # CMetaFileDC Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a Windows metafile, which contains a sequence of graphics device interface (GDI) commands that you can replay to create a desired image or text. ## Syntax diff --git a/docs/mfc/reference/cmfcacceleratorkey-class.md b/docs/mfc/reference/cmfcacceleratorkey-class.md index cea5e0154c5..ceef60ee03b 100644 --- a/docs/mfc/reference/cmfcacceleratorkey-class.md +++ b/docs/mfc/reference/cmfcacceleratorkey-class.md @@ -4,10 +4,12 @@ title: "CMFCAcceleratorKey Class" ms.date: "11/04/2016" f1_keywords: ["CMFCAcceleratorKey", "AFXACCELERATORKEY/CMFCAcceleratorKey", "AFXACCELERATORKEY/CMFCAcceleratorKey::CMFCAcceleratorKey", "AFXACCELERATORKEY/CMFCAcceleratorKey::Format", "AFXACCELERATORKEY/CMFCAcceleratorKey::SetAccelerator"] helpviewer_keywords: ["CMFCAcceleratorKey [MFC], CMFCAcceleratorKey", "CMFCAcceleratorKey [MFC], Format", "CMFCAcceleratorKey [MFC], SetAccelerator"] -ms.assetid: d140fbf7-23db-45ea-a63e-414a5ec7b3d5 --- # CMFCAcceleratorKey Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A helper class that implements virtual key mapping and formatting. ## Syntax diff --git a/docs/mfc/reference/cmfcacceleratorkeyassignctrl-class.md b/docs/mfc/reference/cmfcacceleratorkeyassignctrl-class.md index 24c02779510..dadb4244270 100644 --- a/docs/mfc/reference/cmfcacceleratorkeyassignctrl-class.md +++ b/docs/mfc/reference/cmfcacceleratorkeyassignctrl-class.md @@ -4,10 +4,12 @@ title: "CMFCAcceleratorKeyAssignCtrl Class" ms.date: "10/18/2018" f1_keywords: ["CMFCAcceleratorKeyAssignCtrl", "AFXACCELERATORKEYASSIGNCTRL/CMFCAcceleratorKeyAssignCtrl", "AFXACCELERATORKEYASSIGNCTRL/CMFCAcceleratorKeyAssignCtrl::CMFCAcceleratorKeyAssignCtrl", "AFXACCELERATORKEYASSIGNCTRL/CMFCAcceleratorKeyAssignCtrl::GetAccel", "AFXACCELERATORKEYASSIGNCTRL/CMFCAcceleratorKeyAssignCtrl::IsFocused", "AFXACCELERATORKEYASSIGNCTRL/CMFCAcceleratorKeyAssignCtrl::IsKeyDefined", "AFXACCELERATORKEYASSIGNCTRL/CMFCAcceleratorKeyAssignCtrl::PreTranslateMessage", "AFXACCELERATORKEYASSIGNCTRL/CMFCAcceleratorKeyAssignCtrl::ResetKey"] helpviewer_keywords: ["CMFCAcceleratorKeyAssignCtrl [MFC], CMFCAcceleratorKeyAssignCtrl", "CMFCAcceleratorKeyAssignCtrl [MFC], GetAccel", "CMFCAcceleratorKeyAssignCtrl [MFC], IsFocused", "CMFCAcceleratorKeyAssignCtrl [MFC], IsKeyDefined", "CMFCAcceleratorKeyAssignCtrl [MFC], PreTranslateMessage", "CMFCAcceleratorKeyAssignCtrl [MFC], ResetKey"] -ms.assetid: 89fb8e62-596e-4e71-8c9a-32740347aaab --- # CMFCAcceleratorKeyAssignCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCAcceleratorKeyAssignCtrl` class extends the [CEdit Class](../../mfc/reference/cedit-class.md) to support extra system buttons such as ALT, CONTROL, and SHIFT. ## Syntax diff --git a/docs/mfc/reference/cmfcautohidebar-class.md b/docs/mfc/reference/cmfcautohidebar-class.md index 120b1d8303a..20ad6d6369f 100644 --- a/docs/mfc/reference/cmfcautohidebar-class.md +++ b/docs/mfc/reference/cmfcautohidebar-class.md @@ -4,10 +4,12 @@ title: "CMFCAutoHideBar Class" ms.date: "10/18/2018" f1_keywords: ["CMFCAutoHideBar", "AFXAUTOHIDEBAR/CMFCAutoHideBar", "AFXAUTOHIDEBAR/CMFCAutoHideBar::CMFCAutoHideBar", "AFXAUTOHIDEBAR/CMFCAutoHideBar::AddAutoHideWindow", "AFXAUTOHIDEBAR/CMFCAutoHideBar::AllowShowOnPaneMenu", "AFXAUTOHIDEBAR/CMFCAutoHideBar::CalcFixedLayout", "AFXAUTOHIDEBAR/CMFCAutoHideBar::Create", "AFXAUTOHIDEBAR/CMFCAutoHideBar::GetFirstAHWindow", "AFXAUTOHIDEBAR/CMFCAutoHideBar::GetVisibleCount", "AFXAUTOHIDEBAR/CMFCAutoHideBar::OnShowControlBarMenu", "AFXAUTOHIDEBAR/CMFCAutoHideBar::RemoveAutoHideWindow", "AFXAUTOHIDEBAR/CMFCAutoHideBar::SetActiveInGroup", "AFXAUTOHIDEBAR/CMFCAutoHideBar::SetRecentVisibleState", "AFXAUTOHIDEBAR/CMFCAutoHideBar::ShowAutoHideWindow", "AFXAUTOHIDEBAR/CMFCAutoHideBar::StretchPane", "AFXAUTOHIDEBAR/CMFCAutoHideBar::UnSetAutoHideMode", "AFXAUTOHIDEBAR/CMFCAutoHideBar::UpdateVisibleState", "AFXAUTOHIDEBAR/CMFCAutoHideBar::m_nShowAHWndDelay"] helpviewer_keywords: ["CMFCAutoHideBar [MFC], CMFCAutoHideBar", "CMFCAutoHideBar [MFC], AddAutoHideWindow", "CMFCAutoHideBar [MFC], AllowShowOnPaneMenu", "CMFCAutoHideBar [MFC], CalcFixedLayout", "CMFCAutoHideBar [MFC], Create", "CMFCAutoHideBar [MFC], GetFirstAHWindow", "CMFCAutoHideBar [MFC], GetVisibleCount", "CMFCAutoHideBar [MFC], OnShowControlBarMenu", "CMFCAutoHideBar [MFC], RemoveAutoHideWindow", "CMFCAutoHideBar [MFC], SetActiveInGroup", "CMFCAutoHideBar [MFC], SetRecentVisibleState", "CMFCAutoHideBar [MFC], ShowAutoHideWindow", "CMFCAutoHideBar [MFC], StretchPane", "CMFCAutoHideBar [MFC], UnSetAutoHideMode", "CMFCAutoHideBar [MFC], UpdateVisibleState", "CMFCAutoHideBar [MFC], m_nShowAHWndDelay"] -ms.assetid: 54c8d84f-de64-4efd-8a47-3ea0ade40a70 --- # CMFCAutoHideBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCAutoHideBar` class is a special toolbar class that implements the auto-hide feature. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcautohidebutton-class.md b/docs/mfc/reference/cmfcautohidebutton-class.md index a1b6dfaa421..1b1561fd267 100644 --- a/docs/mfc/reference/cmfcautohidebutton-class.md +++ b/docs/mfc/reference/cmfcautohidebutton-class.md @@ -4,10 +4,12 @@ title: "CMFCAutoHideButton Class" ms.date: "10/18/2018" f1_keywords: ["CMFCAutoHideButton", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::BringToTop", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::Create", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::GetAlignment", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::GetAutoHideWindow", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::GetParentToolBar", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::GetRect", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::GetSize", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::GetTextSize", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::HighlightButton", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::IsActive", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::IsHighlighted", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::IsHorizontal", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::IsTop", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::IsVisible", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::Move", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::OnDraw", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::OnDrawBorder", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::OnFillBackground", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::ReplacePane", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::ShowAttachedWindow", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::ShowButton", "AFXAUTOHIDEBUTTON/CMFCAutoHideButton::UnSetAutoHideMode"] helpviewer_keywords: ["CMFCAutoHideButton [MFC], BringToTop", "CMFCAutoHideButton [MFC], Create", "CMFCAutoHideButton [MFC], GetAlignment", "CMFCAutoHideButton [MFC], GetAutoHideWindow", "CMFCAutoHideButton [MFC], GetParentToolBar", "CMFCAutoHideButton [MFC], GetRect", "CMFCAutoHideButton [MFC], GetSize", "CMFCAutoHideButton [MFC], GetTextSize", "CMFCAutoHideButton [MFC], HighlightButton", "CMFCAutoHideButton [MFC], IsActive", "CMFCAutoHideButton [MFC], IsHighlighted", "CMFCAutoHideButton [MFC], IsHorizontal", "CMFCAutoHideButton [MFC], IsTop", "CMFCAutoHideButton [MFC], IsVisible", "CMFCAutoHideButton [MFC], Move", "CMFCAutoHideButton [MFC], OnDraw", "CMFCAutoHideButton [MFC], OnDrawBorder", "CMFCAutoHideButton [MFC], OnFillBackground", "CMFCAutoHideButton [MFC], ReplacePane", "CMFCAutoHideButton [MFC], ShowAttachedWindow", "CMFCAutoHideButton [MFC], ShowButton", "CMFCAutoHideButton [MFC], UnSetAutoHideMode"] -ms.assetid: c80e6b8b-25ca-4d12-9d27-457731028ab0 --- # CMFCAutoHideButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A button that displays or hides a [CDockablePane Class](../../mfc/reference/cdockablepane-class.md) that is configured to hide. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcbasetabctrl-class.md b/docs/mfc/reference/cmfcbasetabctrl-class.md index d34822e52a4..519bcbeb027 100644 --- a/docs/mfc/reference/cmfcbasetabctrl-class.md +++ b/docs/mfc/reference/cmfcbasetabctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCBaseTabCtrl [MFC], AddIcon", "CMFCBaseTabCtrl [MFC], --- # CMFCBaseTabCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the base functionality for tabbed windows. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcbasetoolbar-class.md b/docs/mfc/reference/cmfcbasetoolbar-class.md index 39389c20bd7..d9a2eb12cae 100644 --- a/docs/mfc/reference/cmfcbasetoolbar-class.md +++ b/docs/mfc/reference/cmfcbasetoolbar-class.md @@ -4,10 +4,12 @@ title: "CMFCBaseToolBar Class" ms.date: "11/04/2016" f1_keywords: ["CMFCBaseToolBar", "AFXBASETOOLBAR/CMFCBaseToolBar", "AFXBASETOOLBAR/CMFCBaseToolBar::GetDockingMode", "AFXBASETOOLBAR/CMFCBaseToolBar::GetMinSize", "AFXBASETOOLBAR/CMFCBaseToolBar::OnAfterChangeParent"] helpviewer_keywords: ["CMFCBaseToolBar [MFC], GetDockingMode", "CMFCBaseToolBar [MFC], GetMinSize", "CMFCBaseToolBar [MFC], OnAfterChangeParent"] -ms.assetid: 5d79206d-55e4-46f8-b1b8-042e34d7f9da --- # CMFCBaseToolBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Base class for toolbars. ## Syntax diff --git a/docs/mfc/reference/cmfcbasevisualmanager-class.md b/docs/mfc/reference/cmfcbasevisualmanager-class.md index c6e2eacfb4a..e092d50743a 100644 --- a/docs/mfc/reference/cmfcbasevisualmanager-class.md +++ b/docs/mfc/reference/cmfcbasevisualmanager-class.md @@ -4,10 +4,12 @@ title: "CMFCBaseVisualManager Class" ms.date: "11/04/2016" f1_keywords: ["CMFCBaseVisualManager", "AFXVISUALMANAGER/CMFCBaseVisualManager", "AFXVISUALMANAGER/CMFCBaseVisualManager::CMFCBaseVisualManager", "AFXVISUALMANAGER/CMFCBaseVisualManager::DrawCheckBox", "AFXVISUALMANAGER/CMFCBaseVisualManager::DrawComboBorder", "AFXVISUALMANAGER/CMFCBaseVisualManager::DrawComboDropButton", "AFXVISUALMANAGER/CMFCBaseVisualManager::DrawPushButton", "AFXVISUALMANAGER/CMFCBaseVisualManager::DrawRadioButton", "AFXVISUALMANAGER/CMFCBaseVisualManager::DrawStatusBarProgress", "AFXVISUALMANAGER/CMFCBaseVisualManager::FillReBarPane", "AFXVISUALMANAGER/CMFCBaseVisualManager::GetStandardWindowsTheme", "AFXVISUALMANAGER/CMFCBaseVisualManager::CleanUpThemes", "AFXVISUALMANAGER/CMFCBaseVisualManager::UpdateSystemColors"] helpviewer_keywords: ["CMFCBaseVisualManager [MFC], CMFCBaseVisualManager", "CMFCBaseVisualManager [MFC], DrawCheckBox", "CMFCBaseVisualManager [MFC], DrawComboBorder", "CMFCBaseVisualManager [MFC], DrawComboDropButton", "CMFCBaseVisualManager [MFC], DrawPushButton", "CMFCBaseVisualManager [MFC], DrawRadioButton", "CMFCBaseVisualManager [MFC], DrawStatusBarProgress", "CMFCBaseVisualManager [MFC], FillReBarPane", "CMFCBaseVisualManager [MFC], GetStandardWindowsTheme", "CMFCBaseVisualManager [MFC], CleanUpThemes", "CMFCBaseVisualManager [MFC], UpdateSystemColors"] -ms.assetid: d56f3afc-cdea-4de1-825a-a08999c571e0 --- # CMFCBaseVisualManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A layer between derived visual managers and the Windows Theme API. `CMFCBaseVisualManager` loads UxTheme.dll, if available, and manages access to Windows Theme API methods. diff --git a/docs/mfc/reference/cmfcbutton-class.md b/docs/mfc/reference/cmfcbutton-class.md index a244e55d07e..def437d5ce1 100644 --- a/docs/mfc/reference/cmfcbutton-class.md +++ b/docs/mfc/reference/cmfcbutton-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCButton [MFC], CleanUp", "CMFCButton [MFC], EnableFull --- # `CMFCButton` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCButton` class adds functionality to the [`CButton`](../../mfc/reference/cbutton-class.md) class such as aligning button text, combining button text and an image, selecting a cursor, and specifying a tool tip. ## Syntax diff --git a/docs/mfc/reference/cmfccaptionbar-class.md b/docs/mfc/reference/cmfccaptionbar-class.md index b6faf964bb5..c42a67c0d28 100644 --- a/docs/mfc/reference/cmfccaptionbar-class.md +++ b/docs/mfc/reference/cmfccaptionbar-class.md @@ -4,10 +4,12 @@ title: "CMFCCaptionBar Class" ms.date: "11/04/2016" f1_keywords: ["CMFCCaptionBar", "AFXCAPTIONBAR/CMFCCaptionBar", "AFXCAPTIONBAR/CMFCCaptionBar::Create", "AFXCAPTIONBAR/CMFCCaptionBar::DoesAllowDynInsertBefore", "AFXCAPTIONBAR/CMFCCaptionBar::EnableButton", "AFXCAPTIONBAR/CMFCCaptionBar::GetAlignment", "AFXCAPTIONBAR/CMFCCaptionBar::GetBorderSize", "AFXCAPTIONBAR/CMFCCaptionBar::GetButtonRect", "AFXCAPTIONBAR/CMFCCaptionBar::GetMargin", "AFXCAPTIONBAR/CMFCCaptionBar::IsMessageBarMode", "AFXCAPTIONBAR/CMFCCaptionBar::RemoveBitmap", "AFXCAPTIONBAR/CMFCCaptionBar::RemoveButton", "AFXCAPTIONBAR/CMFCCaptionBar::RemoveIcon", "AFXCAPTIONBAR/CMFCCaptionBar::RemoveText", "AFXCAPTIONBAR/CMFCCaptionBar::SetBitmap", "AFXCAPTIONBAR/CMFCCaptionBar::SetBorderSize", "AFXCAPTIONBAR/CMFCCaptionBar::SetButton", "AFXCAPTIONBAR/CMFCCaptionBar::SetButtonPressed", "AFXCAPTIONBAR/CMFCCaptionBar::SetButtonToolTip", "AFXCAPTIONBAR/CMFCCaptionBar::SetFlatBorder", "AFXCAPTIONBAR/CMFCCaptionBar::SetIcon", "AFXCAPTIONBAR/CMFCCaptionBar::SetImageToolTip", "AFXCAPTIONBAR/CMFCCaptionBar::SetMargin", "AFXCAPTIONBAR/CMFCCaptionBar::SetText", "AFXCAPTIONBAR/CMFCCaptionBar::OnDrawBackground", "AFXCAPTIONBAR/CMFCCaptionBar::OnDrawBorder", "AFXCAPTIONBAR/CMFCCaptionBar::OnDrawButton", "AFXCAPTIONBAR/CMFCCaptionBar::OnDrawImage", "AFXCAPTIONBAR/CMFCCaptionBar::OnDrawText", "AFXCAPTIONBAR/CMFCCaptionBar::m_clrBarBackground", "AFXCAPTIONBAR/CMFCCaptionBar::m_clrBarBorder", "AFXCAPTIONBAR/CMFCCaptionBar::m_clrBarText"] helpviewer_keywords: ["CMFCCaptionBar [MFC], Create", "CMFCCaptionBar [MFC], DoesAllowDynInsertBefore", "CMFCCaptionBar [MFC], EnableButton", "CMFCCaptionBar [MFC], GetAlignment", "CMFCCaptionBar [MFC], GetBorderSize", "CMFCCaptionBar [MFC], GetButtonRect", "CMFCCaptionBar [MFC], GetMargin", "CMFCCaptionBar [MFC], IsMessageBarMode", "CMFCCaptionBar [MFC], RemoveBitmap", "CMFCCaptionBar [MFC], RemoveButton", "CMFCCaptionBar [MFC], RemoveIcon", "CMFCCaptionBar [MFC], RemoveText", "CMFCCaptionBar [MFC], SetBitmap", "CMFCCaptionBar [MFC], SetBorderSize", "CMFCCaptionBar [MFC], SetButton", "CMFCCaptionBar [MFC], SetButtonPressed", "CMFCCaptionBar [MFC], SetButtonToolTip", "CMFCCaptionBar [MFC], SetFlatBorder", "CMFCCaptionBar [MFC], SetIcon", "CMFCCaptionBar [MFC], SetImageToolTip", "CMFCCaptionBar [MFC], SetMargin", "CMFCCaptionBar [MFC], SetText", "CMFCCaptionBar [MFC], OnDrawBackground", "CMFCCaptionBar [MFC], OnDrawBorder", "CMFCCaptionBar [MFC], OnDrawButton", "CMFCCaptionBar [MFC], OnDrawImage", "CMFCCaptionBar [MFC], OnDrawText", "CMFCCaptionBar [MFC], m_clrBarBackground", "CMFCCaptionBar [MFC], m_clrBarBorder", "CMFCCaptionBar [MFC], m_clrBarText"] -ms.assetid: acb54d5f-14ff-4c96-aeb3-7717cf566d9a --- # CMFCCaptionBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A `CMFCCaptionBar` object is a control bar that can display three elements: a button, a text label, and a bitmap. It can only display one element of each type at a time. You can align each element to the left or right edges of the control or to the center. You can also apply a flat or 3D style to the top and bottom borders of the caption bar. ## Syntax diff --git a/docs/mfc/reference/cmfccaptionbutton-class.md b/docs/mfc/reference/cmfccaptionbutton-class.md index 645ae95d272..3c1b580936c 100644 --- a/docs/mfc/reference/cmfccaptionbutton-class.md +++ b/docs/mfc/reference/cmfccaptionbutton-class.md @@ -4,10 +4,12 @@ title: "CMFCCaptionButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCCaptionButton", "AFXCAPTIONBUTTON/CMFCCaptionButton", "AFXCAPTIONBUTTON/CMFCCaptionButton::CMFCCaptionButton", "AFXCAPTIONBUTTON/CMFCCaptionButton::GetHit", "AFXCAPTIONBUTTON/CMFCCaptionButton::GetIconID", "AFXCAPTIONBUTTON/CMFCCaptionButton::GetRect", "AFXCAPTIONBUTTON/CMFCCaptionButton::GetSize", "AFXCAPTIONBUTTON/CMFCCaptionButton::IsMiniFrameButton", "AFXCAPTIONBUTTON/CMFCCaptionButton::Move", "AFXCAPTIONBUTTON/CMFCCaptionButton::OnDraw", "AFXCAPTIONBUTTON/CMFCCaptionButton::SetMiniFrameButton"] helpviewer_keywords: ["CMFCCaptionButton [MFC], CMFCCaptionButton", "CMFCCaptionButton [MFC], GetHit", "CMFCCaptionButton [MFC], GetIconID", "CMFCCaptionButton [MFC], GetRect", "CMFCCaptionButton [MFC], GetSize", "CMFCCaptionButton [MFC], IsMiniFrameButton", "CMFCCaptionButton [MFC], Move", "CMFCCaptionButton [MFC], OnDraw", "CMFCCaptionButton [MFC], SetMiniFrameButton"] -ms.assetid: c5774b38-c0dd-414a-9ede-3b2f78f233ec --- # CMFCCaptionButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCCaptionButton` class implements a button that is displayed on the caption bar for a docking pane or a mini-frame window. Typically, the framework creates caption buttons automatically. ## Syntax diff --git a/docs/mfc/reference/cmfccmdusagecount-class.md b/docs/mfc/reference/cmfccmdusagecount-class.md index 72347cb1a62..db6d04fbc03 100644 --- a/docs/mfc/reference/cmfccmdusagecount-class.md +++ b/docs/mfc/reference/cmfccmdusagecount-class.md @@ -4,10 +4,12 @@ title: "CMFCCmdUsageCount Class" ms.date: "11/04/2016" f1_keywords: ["CMFCCmdUsageCount", "AFXCMDUSAGECOUNT/CMFCCmdUsageCount", "AFXCMDUSAGECOUNT/CMFCCmdUsageCount::AddCmd", "AFXCMDUSAGECOUNT/CMFCCmdUsageCount::GetCount", "AFXCMDUSAGECOUNT/CMFCCmdUsageCount::HasEnoughInformation", "AFXCMDUSAGECOUNT/CMFCCmdUsageCount::IsFreqeuntlyUsedCmd", "AFXCMDUSAGECOUNT/CMFCCmdUsageCount::Reset", "AFXCMDUSAGECOUNT/CMFCCmdUsageCount::Serialize", "AFXCMDUSAGECOUNT/CMFCCmdUsageCount::SetOptions"] helpviewer_keywords: ["CMFCCmdUsageCount [MFC], AddCmd", "CMFCCmdUsageCount [MFC], GetCount", "CMFCCmdUsageCount [MFC], HasEnoughInformation", "CMFCCmdUsageCount [MFC], IsFreqeuntlyUsedCmd", "CMFCCmdUsageCount [MFC], Reset", "CMFCCmdUsageCount [MFC], Serialize", "CMFCCmdUsageCount [MFC], SetOptions"] -ms.assetid: 9c33b783-37c0-43ea-9f31-3c75e246c841 --- # CMFCCmdUsageCount Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Tracks the usage count of Windows messages, such as when the user selects an item from a menu. ## Syntax diff --git a/docs/mfc/reference/cmfccolorbar-class.md b/docs/mfc/reference/cmfccolorbar-class.md index d24989d33b9..d423c2cacf5 100644 --- a/docs/mfc/reference/cmfccolorbar-class.md +++ b/docs/mfc/reference/cmfccolorbar-class.md @@ -4,10 +4,12 @@ title: "CMFCColorBar Class" ms.date: "11/04/2016" f1_keywords: ["CMFCColorBar", "AFXCOLORBAR/CMFCColorBar", "AFXCOLORBAR/CMFCColorBar::CMFCColorBar", "AFXCOLORBAR/CMFCColorBar::ContextToSize", "AFXCOLORBAR/CMFCColorBar::CreateControl", "AFXCOLORBAR/CMFCColorBar::Create", "AFXCOLORBAR/CMFCColorBar::EnableAutomaticButton", "AFXCOLORBAR/CMFCColorBar::EnableOtherButton", "AFXCOLORBAR/CMFCColorBar::GetColor", "AFXCOLORBAR/CMFCColorBar::GetCommandID", "AFXCOLORBAR/CMFCColorBar::GetHighlightedColor", "AFXCOLORBAR/CMFCColorBar::GetHorzMargin", "AFXCOLORBAR/CMFCColorBar::GetVertMargin", "AFXCOLORBAR/CMFCColorBar::IsTearOff", "AFXCOLORBAR/CMFCColorBar::SetColor", "AFXCOLORBAR/CMFCColorBar::SetColorName", "AFXCOLORBAR/CMFCColorBar::SetCommandID", "AFXCOLORBAR/CMFCColorBar::SetDocumentColors", "AFXCOLORBAR/CMFCColorBar::SetHorzMargin", "AFXCOLORBAR/CMFCColorBar::SetVertMargin", "AFXCOLORBAR/CMFCColorBar::AdjustLocations", "AFXCOLORBAR/CMFCColorBar::AllowChangeTextLabels", "AFXCOLORBAR/CMFCColorBar::AllowShowOnList", "AFXCOLORBAR/CMFCColorBar::CalcSize", "AFXCOLORBAR/CMFCColorBar::CreatePalette", "AFXCOLORBAR/CMFCColorBar::GetColorGridSize", "AFXCOLORBAR/CMFCColorBar::GetExtraHeight", "AFXCOLORBAR/CMFCColorBar::InitColors", "AFXCOLORBAR/CMFCColorBar::OnKey", "AFXCOLORBAR/CMFCColorBar::OnSendCommand", "AFXCOLORBAR/CMFCColorBar::OnUpdateCmdUI", "AFXCOLORBAR/CMFCColorBar::OpenColorDialog", "AFXCOLORBAR/CMFCColorBar::Rebuild", "AFXCOLORBAR/CMFCColorBar::SelectPalette", "AFXCOLORBAR/CMFCColorBar::SetPropList", "AFXCOLORBAR/CMFCColorBar::ShowCommandMessageString"] helpviewer_keywords: ["CMFCColorBar [MFC], CMFCColorBar", "CMFCColorBar [MFC], ContextToSize", "CMFCColorBar [MFC], CreateControl", "CMFCColorBar [MFC], Create", "CMFCColorBar [MFC], EnableAutomaticButton", "CMFCColorBar [MFC], EnableOtherButton", "CMFCColorBar [MFC], GetColor", "CMFCColorBar [MFC], GetCommandID", "CMFCColorBar [MFC], GetHighlightedColor", "CMFCColorBar [MFC], GetHorzMargin", "CMFCColorBar [MFC], GetVertMargin", "CMFCColorBar [MFC], IsTearOff", "CMFCColorBar [MFC], SetColor", "CMFCColorBar [MFC], SetColorName", "CMFCColorBar [MFC], SetCommandID", "CMFCColorBar [MFC], SetDocumentColors", "CMFCColorBar [MFC], SetHorzMargin", "CMFCColorBar [MFC], SetVertMargin", "CMFCColorBar [MFC], AdjustLocations", "CMFCColorBar [MFC], AllowChangeTextLabels", "CMFCColorBar [MFC], AllowShowOnList", "CMFCColorBar [MFC], CalcSize", "CMFCColorBar [MFC], CreatePalette", "CMFCColorBar [MFC], GetColorGridSize", "CMFCColorBar [MFC], GetExtraHeight", "CMFCColorBar [MFC], InitColors", "CMFCColorBar [MFC], OnKey", "CMFCColorBar [MFC], OnSendCommand", "CMFCColorBar [MFC], OnUpdateCmdUI", "CMFCColorBar [MFC], OpenColorDialog", "CMFCColorBar [MFC], Rebuild", "CMFCColorBar [MFC], SelectPalette", "CMFCColorBar [MFC], SetPropList", "CMFCColorBar [MFC], ShowCommandMessageString"] -ms.assetid: 4756ee40-25a5-4cee-af7f-acab7993d1c7 --- # CMFCColorBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCColorBar` class represents a docking control bar that can select colors in a document or application. ## Syntax diff --git a/docs/mfc/reference/cmfccolorbutton-class.md b/docs/mfc/reference/cmfccolorbutton-class.md index dca58ef49eb..1c99ada333c 100644 --- a/docs/mfc/reference/cmfccolorbutton-class.md +++ b/docs/mfc/reference/cmfccolorbutton-class.md @@ -4,10 +4,12 @@ title: "CMFCColorButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCColorButton", "AFXCOLORBUTTON/CMFCColorButton", "AFXCOLORBUTTON/CMFCColorButton::CMFCColorButton", "AFXCOLORBUTTON/CMFCColorButton::EnableAutomaticButton", "AFXCOLORBUTTON/CMFCColorButton::EnableOtherButton", "AFXCOLORBUTTON/CMFCColorButton::GetAutomaticColor", "AFXCOLORBUTTON/CMFCColorButton::GetColor", "AFXCOLORBUTTON/CMFCColorButton::SetColor", "AFXCOLORBUTTON/CMFCColorButton::SetColorName", "AFXCOLORBUTTON/CMFCColorButton::SetColumnsNumber", "AFXCOLORBUTTON/CMFCColorButton::SetDocumentColors", "AFXCOLORBUTTON/CMFCColorButton::SetPalette", "AFXCOLORBUTTON/CMFCColorButton::SizeToContent", "AFXCOLORBUTTON/CMFCColorButton::IsDrawXPTheme", "AFXCOLORBUTTON/CMFCColorButton::OnDraw", "AFXCOLORBUTTON/CMFCColorButton::OnDrawBorder", "AFXCOLORBUTTON/CMFCColorButton::OnDrawFocusRect", "AFXCOLORBUTTON/CMFCColorButton::OnShowColorPopup", "AFXCOLORBUTTON/CMFCColorButton::RebuildPalette", "AFXCOLORBUTTON/CMFCColorButton::UpdateColor", "AFXCOLORBUTTON/CMFCColorButton::m_bEnabledInCustomizeMode"] helpviewer_keywords: ["CMFCColorButton [MFC], CMFCColorButton", "CMFCColorButton [MFC], EnableAutomaticButton", "CMFCColorButton [MFC], EnableOtherButton", "CMFCColorButton [MFC], GetAutomaticColor", "CMFCColorButton [MFC], GetColor", "CMFCColorButton [MFC], SetColor", "CMFCColorButton [MFC], SetColorName", "CMFCColorButton [MFC], SetColumnsNumber", "CMFCColorButton [MFC], SetDocumentColors", "CMFCColorButton [MFC], SetPalette", "CMFCColorButton [MFC], SizeToContent", "CMFCColorButton [MFC], IsDrawXPTheme", "CMFCColorButton [MFC], OnDraw", "CMFCColorButton [MFC], OnDrawBorder", "CMFCColorButton [MFC], OnDrawFocusRect", "CMFCColorButton [MFC], OnShowColorPopup", "CMFCColorButton [MFC], RebuildPalette", "CMFCColorButton [MFC], UpdateColor", "CMFCColorButton [MFC], m_bEnabledInCustomizeMode"] -ms.assetid: 9fdf34ae-4cc5-4c5e-9d89-1c50e8a73699 --- # CMFCColorButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCColorButton` and [CMFCColorBar Class](../../mfc/reference/cmfccolorbar-class.md) classes are used together to implement a color picker control. ## Syntax diff --git a/docs/mfc/reference/cmfccolordialog-class.md b/docs/mfc/reference/cmfccolordialog-class.md index db781111fc2..2eac941f55d 100644 --- a/docs/mfc/reference/cmfccolordialog-class.md +++ b/docs/mfc/reference/cmfccolordialog-class.md @@ -4,10 +4,12 @@ title: "CMFCColorDialog Class" ms.date: "11/04/2016" f1_keywords: ["CMFCColorDialog", "AFXCOLORDIALOG/CMFCColorDialog", "AFXCOLORDIALOG/CMFCColorDialog::CMFCColorDialog", "AFXCOLORDIALOG/CMFCColorDialog::GetColor", "AFXCOLORDIALOG/CMFCColorDialog::GetPalette", "AFXCOLORDIALOG/CMFCColorDialog::RebuildPalette", "AFXCOLORDIALOG/CMFCColorDialog::SetCurrentColor", "AFXCOLORDIALOG/CMFCColorDialog::SetNewColor", "AFXCOLORDIALOG/CMFCColorDialog::SetPageOne", "AFXCOLORDIALOG/CMFCColorDialog::SetPageTwo"] helpviewer_keywords: ["CMFCColorDialog [MFC], CMFCColorDialog", "CMFCColorDialog [MFC], GetColor", "CMFCColorDialog [MFC], GetPalette", "CMFCColorDialog [MFC], RebuildPalette", "CMFCColorDialog [MFC], SetCurrentColor", "CMFCColorDialog [MFC], SetNewColor", "CMFCColorDialog [MFC], SetPageOne", "CMFCColorDialog [MFC], SetPageTwo"] -ms.assetid: 235bbbbc-a3b1-46e0-801b-fb55093ec579 --- # CMFCColorDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCColorDialog` class represents a color selection dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfccolormenubutton-class.md b/docs/mfc/reference/cmfccolormenubutton-class.md index e234a849f45..8298e45f61f 100644 --- a/docs/mfc/reference/cmfccolormenubutton-class.md +++ b/docs/mfc/reference/cmfccolormenubutton-class.md @@ -4,10 +4,12 @@ title: "CMFCColorMenuButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCColorMenuButton", "AFXCOLORMENUBUTTON/CMFCColorMenuButton", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::CMFCColorMenuButton", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::EnableAutomaticButton", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::EnableDocumentColors", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::EnableOtherButton", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::EnableTearOff", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::GetAutomaticColor", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::GetColor", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::GetColorByCmdID", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::OnChangeParentWnd", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::OpenColorDialog", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::SetColor", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::SetColorByCmdID", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::SetColorName", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::SetColumnsNumber", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::CopyFrom", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::CreatePopupMenu", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::IsEmptyMenuAllowed", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::OnDraw", "AFXCOLORMENUBUTTON/CMFCColorMenuButton::OnDrawOnCustomizeList"] helpviewer_keywords: ["CMFCColorMenuButton [MFC], CMFCColorMenuButton", "CMFCColorMenuButton [MFC], EnableAutomaticButton", "CMFCColorMenuButton [MFC], EnableDocumentColors", "CMFCColorMenuButton [MFC], EnableOtherButton", "CMFCColorMenuButton [MFC], EnableTearOff", "CMFCColorMenuButton [MFC], GetAutomaticColor", "CMFCColorMenuButton [MFC], GetColor", "CMFCColorMenuButton [MFC], GetColorByCmdID", "CMFCColorMenuButton [MFC], OnChangeParentWnd", "CMFCColorMenuButton [MFC], OpenColorDialog", "CMFCColorMenuButton [MFC], SetColor", "CMFCColorMenuButton [MFC], SetColorByCmdID", "CMFCColorMenuButton [MFC], SetColorName", "CMFCColorMenuButton [MFC], SetColumnsNumber", "CMFCColorMenuButton [MFC], CopyFrom", "CMFCColorMenuButton [MFC], CreatePopupMenu", "CMFCColorMenuButton [MFC], IsEmptyMenuAllowed", "CMFCColorMenuButton [MFC], OnDraw", "CMFCColorMenuButton [MFC], OnDrawOnCustomizeList"] -ms.assetid: 42685704-e994-4f7b-9553-62283c27b754 --- # CMFCColorMenuButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCColorMenuButton` class supports a menu command or a toolbar button that starts a color picker dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfccolorpickerctrl-class.md b/docs/mfc/reference/cmfccolorpickerctrl-class.md index dc47c78a255..4ccef18c4df 100644 --- a/docs/mfc/reference/cmfccolorpickerctrl-class.md +++ b/docs/mfc/reference/cmfccolorpickerctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCColorPickerCtrl [MFC], CMFCColorPickerCtrl", "CMFCCol --- # CMFCColorPickerCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCColorPickerCtrl` class provides functionality for a control that is used to select colors. ## Syntax diff --git a/docs/mfc/reference/cmfccolorpopupmenu-class.md b/docs/mfc/reference/cmfccolorpopupmenu-class.md index e67a537f494..0b6d3554b4c 100644 --- a/docs/mfc/reference/cmfccolorpopupmenu-class.md +++ b/docs/mfc/reference/cmfccolorpopupmenu-class.md @@ -4,10 +4,12 @@ title: "CMFCColorPopupMenu Class" ms.date: "11/04/2016" f1_keywords: ["CMFCColorPopupMenu", "AFXCOLORPOPUPMENU/CMFCColorPopupMenu", "AFXCOLORPOPUPMENU/CMFCColorPopupMenu::CMFCColorPopupMenu", "AFXCOLORPOPUPMENU/CMFCColorPopupMenu::CreateTearOffBar", "AFXCOLORPOPUPMENU/CMFCColorPopupMenu::GetMenuBar", "AFXCOLORPOPUPMENU/CMFCColorPopupMenu::SetPropList"] helpviewer_keywords: ["CMFCColorPopupMenu [MFC], CMFCColorPopupMenu", "CMFCColorPopupMenu [MFC], CreateTearOffBar", "CMFCColorPopupMenu [MFC], GetMenuBar", "CMFCColorPopupMenu [MFC], SetPropList"] -ms.assetid: 0bf9efe8-aed5-4ab7-b23b-eb284b4668be --- # CMFCColorPopupMenu Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a pop-up menu that users use to select colors in a document or application. ## Syntax diff --git a/docs/mfc/reference/cmfccustomcolorspropertypage-class.md b/docs/mfc/reference/cmfccustomcolorspropertypage-class.md index 215b8deb8d2..1c1005ea7a5 100644 --- a/docs/mfc/reference/cmfccustomcolorspropertypage-class.md +++ b/docs/mfc/reference/cmfccustomcolorspropertypage-class.md @@ -4,10 +4,12 @@ title: "CMFCCustomColorsPropertyPage Class" ms.date: "11/04/2016" f1_keywords: ["CMFCCustomColorsPropertyPage", "AFXCUSTOMCOLORSPROPERTYPAGE/CMFCCustomColorsPropertyPage", "AFXCUSTOMCOLORSPROPERTYPAGE/CMFCCustomColorsPropertyPage::Setup"] helpviewer_keywords: ["CMFCCustomColorsPropertyPage [MFC], Setup"] -ms.assetid: 46a45ba2-1fda-440d-8018-d4dcd44f5816 --- # CMFCCustomColorsPropertyPage Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a property page that can select custom colors in a color dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfcdesktopalertdialog-class.md b/docs/mfc/reference/cmfcdesktopalertdialog-class.md index 8807b8902f3..0e7912e917e 100644 --- a/docs/mfc/reference/cmfcdesktopalertdialog-class.md +++ b/docs/mfc/reference/cmfcdesktopalertdialog-class.md @@ -4,10 +4,12 @@ title: "CMFCDesktopAlertDialog Class" ms.date: "10/18/2018" f1_keywords: ["CMFCDesktopAlertDialog", "AFXDESKTOPALERTDIALOG/CMFCDesktopAlertDialog", "AFXDESKTOPALERTDIALOG/CMFCDesktopAlertDialog::CreateFromParams", "AFXDESKTOPALERTDIALOG/CMFCDesktopAlertDialog::GetDlgSize", "AFXDESKTOPALERTDIALOG/CMFCDesktopAlertDialog::HasFocus", "AFXDESKTOPALERTDIALOG/CMFCDesktopAlertDialog::PreTranslateMessage"] helpviewer_keywords: ["CMFCDesktopAlertDialog [MFC], CreateFromParams", "CMFCDesktopAlertDialog [MFC], GetDlgSize", "CMFCDesktopAlertDialog [MFC], HasFocus", "CMFCDesktopAlertDialog [MFC], PreTranslateMessage"] -ms.assetid: a53c60aa-9607-485b-b826-ec64962075f6 --- # CMFCDesktopAlertDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCDesktopAlertDialog` class is used together with the [CMFCDesktopAlertWnd Class](../../mfc/reference/cmfcdesktopalertwnd-class.md) to display a custom dialog in a popup window. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcdesktopalertwnd-class.md b/docs/mfc/reference/cmfcdesktopalertwnd-class.md index d473b05c588..5179e51c5f5 100644 --- a/docs/mfc/reference/cmfcdesktopalertwnd-class.md +++ b/docs/mfc/reference/cmfcdesktopalertwnd-class.md @@ -4,10 +4,12 @@ title: "CMFCDesktopAlertWnd Class" ms.date: "10/18/2018" f1_keywords: ["CMFCDesktopAlertWnd", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::Create", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::GetAnimationSpeed", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::GetAnimationType", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::GetAutoCloseTime", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::GetCaptionHeight", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::GetDialogSize", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::GetLastPos", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::GetTransparency", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::HasSmallCaption", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::OnBeforeShow", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::OnClickLinkButton", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::OnCommand", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::OnDraw", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::ProcessCommand", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::SetAnimationSpeed", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::SetAnimationType", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::SetAutoCloseTime", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::SetSmallCaption", "AFXDESKTOPALERTWND/CMFCDesktopAlertWnd::SetTransparency"] helpviewer_keywords: ["CMFCDesktopAlertWnd [MFC], Create", "CMFCDesktopAlertWnd [MFC], GetAnimationSpeed", "CMFCDesktopAlertWnd [MFC], GetAnimationType", "CMFCDesktopAlertWnd [MFC], GetAutoCloseTime", "CMFCDesktopAlertWnd [MFC], GetCaptionHeight", "CMFCDesktopAlertWnd [MFC], GetDialogSize", "CMFCDesktopAlertWnd [MFC], GetLastPos", "CMFCDesktopAlertWnd [MFC], GetTransparency", "CMFCDesktopAlertWnd [MFC], HasSmallCaption", "CMFCDesktopAlertWnd [MFC], OnBeforeShow", "CMFCDesktopAlertWnd [MFC], OnClickLinkButton", "CMFCDesktopAlertWnd [MFC], OnCommand", "CMFCDesktopAlertWnd [MFC], OnDraw", "CMFCDesktopAlertWnd [MFC], ProcessCommand", "CMFCDesktopAlertWnd [MFC], SetAnimationSpeed", "CMFCDesktopAlertWnd [MFC], SetAnimationType", "CMFCDesktopAlertWnd [MFC], SetAutoCloseTime", "CMFCDesktopAlertWnd [MFC], SetSmallCaption", "CMFCDesktopAlertWnd [MFC], SetTransparency"] -ms.assetid: 73a2dd7b-ea84-4ae2-9830-7cf6e8dd2425 --- # CMFCDesktopAlertWnd Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCDesktopAlertWnd` class implements the functionality of a modeless dialog box which appears on the screen to inform the user about an event. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcdesktopalertwndbutton-class.md b/docs/mfc/reference/cmfcdesktopalertwndbutton-class.md index 65e46a6c1ec..f216316ca09 100644 --- a/docs/mfc/reference/cmfcdesktopalertwndbutton-class.md +++ b/docs/mfc/reference/cmfcdesktopalertwndbutton-class.md @@ -4,10 +4,12 @@ title: "CMFCDesktopAlertWndButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCDesktopAlertWndButton", "AFXDESKTOPALERTWND/CMFCDesktopAlertWndButton", "AFXDESKTOPALERTWND/CMFCDesktopAlertWndButton::IsCaptionButton", "AFXDESKTOPALERTWND/CMFCDesktopAlertWndButton::IsCloseButton"] helpviewer_keywords: ["CMFCDesktopAlertWndButton [MFC], IsCaptionButton", "CMFCDesktopAlertWndButton [MFC], IsCloseButton"] -ms.assetid: df39a0c8-0c39-4ab0-8c64-78c5b2c4ecaf --- # CMFCDesktopAlertWndButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Allows buttons to be added to a desktop alert dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfcdesktopalertwndinfo-class.md b/docs/mfc/reference/cmfcdesktopalertwndinfo-class.md index fcf410dddb8..1591b9e0164 100644 --- a/docs/mfc/reference/cmfcdesktopalertwndinfo-class.md +++ b/docs/mfc/reference/cmfcdesktopalertwndinfo-class.md @@ -4,10 +4,12 @@ title: "CMFCDesktopAlertWndInfo Class" ms.date: "10/18/2018" f1_keywords: ["CMFCDesktopAlertWndInfo", "AFXDESKTOPALERTDIALOG/CMFCDesktopAlertWndInfo", "AFXDESKTOPALERTDIALOG/CMFCDesktopAlertWndInfo::m_hIcon", "AFXDESKTOPALERTDIALOG/CMFCDesktopAlertWndInfo::m_nURLCmdID", "AFXDESKTOPALERTDIALOG/CMFCDesktopAlertWndInfo::m_strText", "AFXDESKTOPALERTDIALOG/CMFCDesktopAlertWndInfo::m_strURL"] helpviewer_keywords: ["CMFCDesktopAlertWndInfo [MFC], m_hIcon", "CMFCDesktopAlertWndInfo [MFC], m_nURLCmdID", "CMFCDesktopAlertWndInfo [MFC], m_strText", "CMFCDesktopAlertWndInfo [MFC], m_strURL"] -ms.assetid: 5c9bb84e-6c96-4748-8e74-6951b6ae8e84 --- # CMFCDesktopAlertWndInfo Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCDesktopAlertWndInfo` class is used with the [CMFCDesktopAlertWnd Class](../../mfc/reference/cmfcdesktopalertwnd-class.md). It specifies the controls that are displayed if the desktop alert window pops up. ## Syntax diff --git a/docs/mfc/reference/cmfcdisablemenuanimation-class.md b/docs/mfc/reference/cmfcdisablemenuanimation-class.md index 5dc689897be..e4bd79b0ee9 100644 --- a/docs/mfc/reference/cmfcdisablemenuanimation-class.md +++ b/docs/mfc/reference/cmfcdisablemenuanimation-class.md @@ -4,10 +4,12 @@ title: "CMFCDisableMenuAnimation Class" ms.date: "11/04/2016" f1_keywords: ["CMFCDisableMenuAnimation", "AFXPOPUPMENU/CMFCDisableMenuAnimation", "AFXPOPUPMENU/CMFCDisableMenuAnimation::Restore"] helpviewer_keywords: ["CMFCDisableMenuAnimation [MFC], Restore"] -ms.assetid: c6eb07da-c382-43d6-8028-007f2320e50e --- # CMFCDisableMenuAnimation Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Disables pop-up menu animation. ## Syntax diff --git a/docs/mfc/reference/cmfcdragframeimpl-class.md b/docs/mfc/reference/cmfcdragframeimpl-class.md index 0305fe19091..6f1eca2b4cd 100644 --- a/docs/mfc/reference/cmfcdragframeimpl-class.md +++ b/docs/mfc/reference/cmfcdragframeimpl-class.md @@ -4,10 +4,12 @@ title: "CMFCDragFrameImpl Class" ms.date: "10/18/2018" f1_keywords: ["CMFCDragFrameImpl"] helpviewer_keywords: ["CMFCDragFrameImpl class [MFC]"] -ms.assetid: 500cd824-8188-43c2-8754-b7bb46b5648a --- # CMFCDragFrameImpl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCDragFrameImpl` class draws the drag rectangle that appears when the user drags a pane in the standard dock mode. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcdropdownframe-class.md b/docs/mfc/reference/cmfcdropdownframe-class.md index dc2193522d5..d82e9660902 100644 --- a/docs/mfc/reference/cmfcdropdownframe-class.md +++ b/docs/mfc/reference/cmfcdropdownframe-class.md @@ -4,10 +4,12 @@ title: "CMFCDropDownFrame Class" ms.date: "11/04/2016" f1_keywords: ["CMFCDropDownFrame", "AFXDROPDOWNTOOLBAR/CMFCDropDownFrame", "AFXDROPDOWNTOOLBAR/CMFCDropDownFrame::Create", "AFXDROPDOWNTOOLBAR/CMFCDropDownFrame::GetParentMenuBar", "AFXDROPDOWNTOOLBAR/CMFCDropDownFrame::GetParentPopupMenu", "AFXDROPDOWNTOOLBAR/CMFCDropDownFrame::RecalcLayout", "AFXDROPDOWNTOOLBAR/CMFCDropDownFrame::SetAutoDestroy"] helpviewer_keywords: ["CMFCDropDownFrame [MFC], Create", "CMFCDropDownFrame [MFC], GetParentMenuBar", "CMFCDropDownFrame [MFC], GetParentPopupMenu", "CMFCDropDownFrame [MFC], RecalcLayout", "CMFCDropDownFrame [MFC], SetAutoDestroy"] -ms.assetid: 09ff81a9-de00-43ec-9df9-b626f7728c4b --- # CMFCDropDownFrame Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides drop-down frame window functionality to drop-down toolbars and drop-down toolbar buttons. ## Syntax diff --git a/docs/mfc/reference/cmfcdropdowntoolbar-class.md b/docs/mfc/reference/cmfcdropdowntoolbar-class.md index 9fbdc25a7b8..ef021c74955 100644 --- a/docs/mfc/reference/cmfcdropdowntoolbar-class.md +++ b/docs/mfc/reference/cmfcdropdowntoolbar-class.md @@ -4,10 +4,12 @@ title: "CMFCDropDownToolBar Class" ms.date: "11/19/2018" f1_keywords: ["CMFCDropDownToolBar", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolBar", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolBar::AllowShowOnPaneMenu", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolBar::LoadBitmap", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolBar::LoadToolBar", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolBar::OnLButtonUp", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolBar::OnMouseMove", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolBar::OnSendCommand", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolBar::OnUpdateCmdUI"] helpviewer_keywords: ["CMFCDropDownToolBar [MFC], AllowShowOnPaneMenu", "CMFCDropDownToolBar [MFC], LoadBitmap", "CMFCDropDownToolBar [MFC], LoadToolBar", "CMFCDropDownToolBar [MFC], OnLButtonUp", "CMFCDropDownToolBar [MFC], OnMouseMove", "CMFCDropDownToolBar [MFC], OnSendCommand", "CMFCDropDownToolBar [MFC], OnUpdateCmdUI"] -ms.assetid: 78818ec5-83ce-42fa-a0d4-2d9d5ecc8770 --- # CMFCDropDownToolBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A toolbar that appears when the user presses and holds a top-level toolbar button. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcdropdowntoolbarbutton-class.md b/docs/mfc/reference/cmfcdropdowntoolbarbutton-class.md index dd68698320f..4b264833d8e 100644 --- a/docs/mfc/reference/cmfcdropdowntoolbarbutton-class.md +++ b/docs/mfc/reference/cmfcdropdowntoolbarbutton-class.md @@ -4,10 +4,12 @@ title: "CMFCDropDownToolbarButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCDropDownToolbarButton", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::CMFCDropDownToolbarButton", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::CopyFrom", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::DropDownToolbar", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::ExportToMenuButton", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::GetDropDownToolBar", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::IsDropDown", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::IsExtraSize", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::OnCalculateSize", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::OnChangeParentWnd", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::OnClick", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::OnClickUp", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::OnContextHelp", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::OnCustomizeMenu", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::OnDraw", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::OnDrawOnCustomizeList", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::Serialize", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::SetDefaultCommand", "AFXDROPDOWNTOOLBAR/CMFCDropDownToolbarButton::m_uiShowBarDelay"] helpviewer_keywords: ["CMFCDropDownToolbarButton [MFC], CMFCDropDownToolbarButton", "CMFCDropDownToolbarButton [MFC], CopyFrom", "CMFCDropDownToolbarButton [MFC], DropDownToolbar", "CMFCDropDownToolbarButton [MFC], ExportToMenuButton", "CMFCDropDownToolbarButton [MFC], GetDropDownToolBar", "CMFCDropDownToolbarButton [MFC], IsDropDown", "CMFCDropDownToolbarButton [MFC], IsExtraSize", "CMFCDropDownToolbarButton [MFC], OnCalculateSize", "CMFCDropDownToolbarButton [MFC], OnChangeParentWnd", "CMFCDropDownToolbarButton [MFC], OnClick", "CMFCDropDownToolbarButton [MFC], OnClickUp", "CMFCDropDownToolbarButton [MFC], OnContextHelp", "CMFCDropDownToolbarButton [MFC], OnCustomizeMenu", "CMFCDropDownToolbarButton [MFC], OnDraw", "CMFCDropDownToolbarButton [MFC], OnDrawOnCustomizeList", "CMFCDropDownToolbarButton [MFC], Serialize", "CMFCDropDownToolbarButton [MFC], SetDefaultCommand", "CMFCDropDownToolbarButton [MFC], m_uiShowBarDelay"] -ms.assetid: bc9d69e6-bd3e-4c15-9368-e80a504a0ba7 --- # CMFCDropDownToolbarButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A type of toolbar button that behaves like a regular button when it is clicked. However, it opens a drop-down toolbar ( [CMFCDropDownToolBar Class](../../mfc/reference/cmfcdropdowntoolbar-class.md) if the user presses and holds the toolbar button down. ## Syntax diff --git a/docs/mfc/reference/cmfcdynamiclayout-class.md b/docs/mfc/reference/cmfcdynamiclayout-class.md index c41f1893c72..09cb98df6b4 100644 --- a/docs/mfc/reference/cmfcdynamiclayout-class.md +++ b/docs/mfc/reference/cmfcdynamiclayout-class.md @@ -6,6 +6,9 @@ f1_keywords: ["CMFCDynamicLayout", "AFXLAYOUT/CMFCDynamicLayout", "AFXLAYOUT/CMF --- # CMFCDynamicLayout Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Specifies how controls in a window are moved and resized as the user resizes the window. ## Syntax diff --git a/docs/mfc/reference/cmfceditbrowsectrl-class.md b/docs/mfc/reference/cmfceditbrowsectrl-class.md index c24728b72e6..331e901377c 100644 --- a/docs/mfc/reference/cmfceditbrowsectrl-class.md +++ b/docs/mfc/reference/cmfceditbrowsectrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCEditBrowseCtrl [MFC], EnableBrowseButton", "CMFCEditB --- # CMFCEditBrowseCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCEditBrowseCtrl` class supports the edit browse control, which is an editable text box that optionally contains a browse button. When the user clicks the browse button, the control performs a custom action or displays a standard dialog box that contains a file browser or a folder browser. ## Syntax diff --git a/docs/mfc/reference/cmfcfilterchunkvalueimpl-class.md b/docs/mfc/reference/cmfcfilterchunkvalueimpl-class.md index 7bd629455bd..8b8400cd514 100644 --- a/docs/mfc/reference/cmfcfilterchunkvalueimpl-class.md +++ b/docs/mfc/reference/cmfcfilterchunkvalueimpl-class.md @@ -4,10 +4,12 @@ title: "CMFCFilterChunkValueImpl Class" ms.date: "11/04/2016" f1_keywords: ["CMFCFilterChunkValueImpl", "AFXWIN/CMFCFilterChunkValueImpl", "AFXWIN/CMFCFilterChunkValueImpl::CMFCFilterChunkValueImpl", "AFXWIN/CMFCFilterChunkValueImpl::Clear", "AFXWIN/CMFCFilterChunkValueImpl::CopyChunk", "AFXWIN/CMFCFilterChunkValueImpl::CopyFrom", "AFXWIN/CMFCFilterChunkValueImpl::GetChunkGUID", "AFXWIN/CMFCFilterChunkValueImpl::GetChunkPID", "AFXWIN/CMFCFilterChunkValueImpl::GetChunkType", "AFXWIN/CMFCFilterChunkValueImpl::GetString", "AFXWIN/CMFCFilterChunkValueImpl::GetValue", "AFXWIN/CMFCFilterChunkValueImpl::GetValueNoAlloc", "AFXWIN/CMFCFilterChunkValueImpl::IsValid", "AFXWIN/CMFCFilterChunkValueImpl::SetBoolValue", "AFXWIN/CMFCFilterChunkValueImpl::SetDwordValue", "AFXWIN/CMFCFilterChunkValueImpl::SetFileTimeValue", "AFXWIN/CMFCFilterChunkValueImpl::SetInt64Value", "AFXWIN/CMFCFilterChunkValueImpl::SetIntValue", "AFXWIN/CMFCFilterChunkValueImpl::SetLongValue", "AFXWIN/CMFCFilterChunkValueImpl::SetSystemTimeValue", "AFXWIN/CMFCFilterChunkValueImpl::SetTextValue", "AFXWIN/CMFCFilterChunkValueImpl::SetChunk"] helpviewer_keywords: ["CMFCFilterChunkValueImpl [MFC], CMFCFilterChunkValueImpl", "CMFCFilterChunkValueImpl [MFC], Clear", "CMFCFilterChunkValueImpl [MFC], CopyChunk", "CMFCFilterChunkValueImpl [MFC], CopyFrom", "CMFCFilterChunkValueImpl [MFC], GetChunkGUID", "CMFCFilterChunkValueImpl [MFC], GetChunkPID", "CMFCFilterChunkValueImpl [MFC], GetChunkType", "CMFCFilterChunkValueImpl [MFC], GetString", "CMFCFilterChunkValueImpl [MFC], GetValue", "CMFCFilterChunkValueImpl [MFC], GetValueNoAlloc", "CMFCFilterChunkValueImpl [MFC], IsValid", "CMFCFilterChunkValueImpl [MFC], SetBoolValue", "CMFCFilterChunkValueImpl [MFC], SetDwordValue", "CMFCFilterChunkValueImpl [MFC], SetFileTimeValue", "CMFCFilterChunkValueImpl [MFC], SetInt64Value", "CMFCFilterChunkValueImpl [MFC], SetIntValue", "CMFCFilterChunkValueImpl [MFC], SetLongValue", "CMFCFilterChunkValueImpl [MFC], SetSystemTimeValue", "CMFCFilterChunkValueImpl [MFC], SetTextValue", "CMFCFilterChunkValueImpl [MFC], SetChunk"] -ms.assetid: 3c833f23-5b88-4d08-9e09-ca6a8aec88bf --- # CMFCFilterChunkValueImpl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This is a class which simplifies both chunk and property value pair logic. ## Syntax diff --git a/docs/mfc/reference/cmfcfontcombobox-class.md b/docs/mfc/reference/cmfcfontcombobox-class.md index 23d4f981449..bebc44a37c0 100644 --- a/docs/mfc/reference/cmfcfontcombobox-class.md +++ b/docs/mfc/reference/cmfcfontcombobox-class.md @@ -4,10 +4,12 @@ title: "CMFCFontComboBox Class" ms.date: "11/04/2016" f1_keywords: ["CMFCFontComboBox", "AFXFONTCOMBOBOX/CMFCFontComboBox", "AFXFONTCOMBOBOX/CMFCFontComboBox::CMFCFontComboBox", "AFXFONTCOMBOBOX/CMFCFontComboBox::GetSelFont", "AFXFONTCOMBOBOX/CMFCFontComboBox::SelectFont", "AFXFONTCOMBOBOX/CMFCFontComboBox::Setup", "AFXFONTCOMBOBOX/CMFCFontComboBox::m_bDrawUsingFont"] helpviewer_keywords: ["CMFCFontComboBox [MFC], CMFCFontComboBox", "CMFCFontComboBox [MFC], GetSelFont", "CMFCFontComboBox [MFC], SelectFont", "CMFCFontComboBox [MFC], Setup", "CMFCFontComboBox [MFC], m_bDrawUsingFont"] -ms.assetid: 9a53fb0c-7b45-486d-8187-2a4c723d9fbb --- # CMFCFontComboBox Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCFontComboBox` class creates a combo box control that contains a list of fonts. ## Syntax diff --git a/docs/mfc/reference/cmfcfontinfo-class.md b/docs/mfc/reference/cmfcfontinfo-class.md index f44dd4e20b1..cf82482be39 100644 --- a/docs/mfc/reference/cmfcfontinfo-class.md +++ b/docs/mfc/reference/cmfcfontinfo-class.md @@ -4,10 +4,12 @@ title: "CMFCFontInfo Class" ms.date: "11/04/2016" f1_keywords: ["CMFCFontInfo", "AFXTOOLBARFONTCOMBOBOX/CMFCFontInfo", "AFXTOOLBARFONTCOMBOBOX/CMFCFontInfo::GetFullName", "AFXTOOLBARFONTCOMBOBOX/CMFCFontInfo::m_nCharSet", "AFXTOOLBARFONTCOMBOBOX/CMFCFontInfo::m_nPitchAndFamily", "AFXTOOLBARFONTCOMBOBOX/CMFCFontInfo::m_nType", "AFXTOOLBARFONTCOMBOBOX/CMFCFontInfo::m_strName", "AFXTOOLBARFONTCOMBOBOX/CMFCFontInfo::m_strScript"] helpviewer_keywords: ["CMFCFontInfo [MFC], GetFullName", "CMFCFontInfo [MFC], m_nCharSet", "CMFCFontInfo [MFC], m_nPitchAndFamily", "CMFCFontInfo [MFC], m_nType", "CMFCFontInfo [MFC], m_strName", "CMFCFontInfo [MFC], m_strScript"] -ms.assetid: f88329b2-d74e-4921-9441-a3bb6536a049 --- # CMFCFontInfo Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCFontInfo` class describes the name and other attributes of a font. ## Syntax diff --git a/docs/mfc/reference/cmfcheaderctrl-class.md b/docs/mfc/reference/cmfcheaderctrl-class.md index c736bcd0e22..fb24bc1b33b 100644 --- a/docs/mfc/reference/cmfcheaderctrl-class.md +++ b/docs/mfc/reference/cmfcheaderctrl-class.md @@ -4,10 +4,12 @@ title: "CMFCHeaderCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CMFCHeaderCtrl", "AFXHEADERCTRL/CMFCHeaderCtrl", "AFXHEADERCTRL/CMFCHeaderCtrl::CMFCHeaderCtrl", "AFXHEADERCTRL/CMFCHeaderCtrl::EnableMultipleSort", "AFXHEADERCTRL/CMFCHeaderCtrl::GetColumnState", "AFXHEADERCTRL/CMFCHeaderCtrl::GetSortColumn", "AFXHEADERCTRL/CMFCHeaderCtrl::IsAscending", "AFXHEADERCTRL/CMFCHeaderCtrl::IsDialogControl", "AFXHEADERCTRL/CMFCHeaderCtrl::IsMultipleSort", "AFXHEADERCTRL/CMFCHeaderCtrl::RemoveSortColumn", "AFXHEADERCTRL/CMFCHeaderCtrl::SetSortColumn", "AFXHEADERCTRL/CMFCHeaderCtrl::OnDrawItem", "AFXHEADERCTRL/CMFCHeaderCtrl::OnDrawSortArrow", "AFXHEADERCTRL/CMFCHeaderCtrl::OnFillBackground"] helpviewer_keywords: ["CMFCHeaderCtrl [MFC], CMFCHeaderCtrl", "CMFCHeaderCtrl [MFC], EnableMultipleSort", "CMFCHeaderCtrl [MFC], GetColumnState", "CMFCHeaderCtrl [MFC], GetSortColumn", "CMFCHeaderCtrl [MFC], IsAscending", "CMFCHeaderCtrl [MFC], IsDialogControl", "CMFCHeaderCtrl [MFC], IsMultipleSort", "CMFCHeaderCtrl [MFC], RemoveSortColumn", "CMFCHeaderCtrl [MFC], SetSortColumn", "CMFCHeaderCtrl [MFC], OnDrawItem", "CMFCHeaderCtrl [MFC], OnDrawSortArrow", "CMFCHeaderCtrl [MFC], OnFillBackground"] -ms.assetid: 2f5fbf7b-5c75-42db-9216-640b1628f777 --- # CMFCHeaderCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCHeaderCtrl` class supports sorting multiple columns in a header control. ## Syntax diff --git a/docs/mfc/reference/cmfcimageeditordialog-class.md b/docs/mfc/reference/cmfcimageeditordialog-class.md index fb12f266bfe..46b2338e662 100644 --- a/docs/mfc/reference/cmfcimageeditordialog-class.md +++ b/docs/mfc/reference/cmfcimageeditordialog-class.md @@ -4,10 +4,12 @@ title: "CMFCImageEditorDialog Class" ms.date: "11/19/2018" f1_keywords: ["CMFCImageEditorDialog", "AFXIMAGEEDITORDIALOG/CMFCImageEditorDialog", "AFXIMAGEEDITORDIALOG/CMFCImageEditorDialog::CMFCImageEditorDialog"] helpviewer_keywords: ["CMFCImageEditorDialog [MFC], CMFCImageEditorDialog"] -ms.assetid: 6a7d08f3-1ec2-4062-9b79-a0c2776b58d1 --- # CMFCImageEditorDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCImageEditorDialog` class supports an image editor dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfcimageeditorpalettebar-class.md b/docs/mfc/reference/cmfcimageeditorpalettebar-class.md index 3e967fd6efe..28e32d6f7e3 100644 --- a/docs/mfc/reference/cmfcimageeditorpalettebar-class.md +++ b/docs/mfc/reference/cmfcimageeditorpalettebar-class.md @@ -4,10 +4,12 @@ title: "CMFCImageEditorPaletteBar Class" ms.date: "11/04/2016" f1_keywords: ["CMFCImageEditorPaletteBar", "AFXIMAGEEDITORDIALOG/CMFCImageEditorPaletteBar", "AFXIMAGEEDITORDIALOG/CMFCImageEditorPaletteBar::GetRowHeight", "AFXIMAGEEDITORDIALOG/CMFCImageEditorPaletteBar::IsButtonExtraSizeAvailable"] helpviewer_keywords: ["CMFCImageEditorPaletteBar [MFC], GetRowHeight", "CMFCImageEditorPaletteBar [MFC], IsButtonExtraSizeAvailable"] -ms.assetid: 3fb7ba8e-f254-4d56-b913-9941b4ed8138 --- # CMFCImageEditorPaletteBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides palette bar functionality to an image editor dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfcimagepaintarea-class.md b/docs/mfc/reference/cmfcimagepaintarea-class.md index b9b12f31673..2c8bd7c1b13 100644 --- a/docs/mfc/reference/cmfcimagepaintarea-class.md +++ b/docs/mfc/reference/cmfcimagepaintarea-class.md @@ -4,10 +4,12 @@ title: "CMFCImagePaintArea Class" ms.date: "11/04/2016" f1_keywords: ["CMFCImagePaintArea", "AFXIMAGEPAINTAREA/CMFCImagePaintArea", "AFXIMAGEPAINTAREA/CMFCImagePaintArea::CMFCImagePaintArea", "AFXIMAGEPAINTAREA/CMFCImagePaintArea::GetMode", "AFXIMAGEPAINTAREA/CMFCImagePaintArea::SetBitmap", "AFXIMAGEPAINTAREA/CMFCImagePaintArea::SetColor", "AFXIMAGEPAINTAREA/CMFCImagePaintArea::SetMode"] helpviewer_keywords: ["CMFCImagePaintArea [MFC], CMFCImagePaintArea", "CMFCImagePaintArea [MFC], GetMode", "CMFCImagePaintArea [MFC], SetBitmap", "CMFCImagePaintArea [MFC], SetColor", "CMFCImagePaintArea [MFC], SetMode"] -ms.assetid: c59eec22-f15a-4e58-8c4d-4a18a41f4452 --- # CMFCImagePaintArea Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the picture area that you use to modify an image in an image editor dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfcimagepaintarea-image-edit-mode-enumeration.md b/docs/mfc/reference/cmfcimagepaintarea-image-edit-mode-enumeration.md index ea4942119f2..3ca70390145 100644 --- a/docs/mfc/reference/cmfcimagepaintarea-image-edit-mode-enumeration.md +++ b/docs/mfc/reference/cmfcimagepaintarea-image-edit-mode-enumeration.md @@ -4,10 +4,12 @@ title: "CMFCImagePaintArea::IMAGE_EDIT_MODE Enumeration" ms.date: "11/04/2016" f1_keywords: ["IMAGE_EDIT_MODE Enumeration"] helpviewer_keywords: ["IMAGE_EDIT_MODE Enumeration method [MFC]"] -ms.assetid: e51db66a-fa1c-4766-9dac-a25b595f871a --- # CMFCImagePaintArea::IMAGE_EDIT_MODE Enumeration +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Specifies a drawing mode that you use to modify an image in an image editor dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfckeymapdialog-class.md b/docs/mfc/reference/cmfckeymapdialog-class.md index 43c94443db1..80c2426815c 100644 --- a/docs/mfc/reference/cmfckeymapdialog-class.md +++ b/docs/mfc/reference/cmfckeymapdialog-class.md @@ -4,10 +4,12 @@ title: "CMFCKeyMapDialog Class" ms.date: "11/04/2016" f1_keywords: ["CMFCKeyMapDialog", "AFXKEYMAPDIALOG/CMFCKeyMapDialog", "AFXKEYMAPDIALOG/CMFCKeyMapDialog::CMFCKeyMapDialog", "AFXKEYMAPDIALOG/CMFCKeyMapDialog::DoModal", "AFXKEYMAPDIALOG/CMFCKeyMapDialog::FormatItem", "AFXKEYMAPDIALOG/CMFCKeyMapDialog::GetCommandKeys", "AFXKEYMAPDIALOG/CMFCKeyMapDialog::OnInsertItem", "AFXKEYMAPDIALOG/CMFCKeyMapDialog::OnPrintHeader", "AFXKEYMAPDIALOG/CMFCKeyMapDialog::OnPrintItem", "AFXKEYMAPDIALOG/CMFCKeyMapDialog::OnSetColumns", "AFXKEYMAPDIALOG/CMFCKeyMapDialog::PrintKeyMap", "AFXKEYMAPDIALOG/CMFCKeyMapDialog::SetColumnsWidth"] helpviewer_keywords: ["CMFCKeyMapDialog [MFC], CMFCKeyMapDialog", "CMFCKeyMapDialog [MFC], DoModal", "CMFCKeyMapDialog [MFC], FormatItem", "CMFCKeyMapDialog [MFC], GetCommandKeys", "CMFCKeyMapDialog [MFC], OnInsertItem", "CMFCKeyMapDialog [MFC], OnPrintHeader", "CMFCKeyMapDialog [MFC], OnPrintItem", "CMFCKeyMapDialog [MFC], OnSetColumns", "CMFCKeyMapDialog [MFC], PrintKeyMap", "CMFCKeyMapDialog [MFC], SetColumnsWidth"] -ms.assetid: 5feb4942-d636-462d-a162-0104dd320f4e --- # CMFCKeyMapDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCKeyMapDialog` class supports a control that maps commands to keys on the keyboard. ## Syntax diff --git a/docs/mfc/reference/cmfclinkctrl-class.md b/docs/mfc/reference/cmfclinkctrl-class.md index 9fee3460bae..0e008d64bfd 100644 --- a/docs/mfc/reference/cmfclinkctrl-class.md +++ b/docs/mfc/reference/cmfclinkctrl-class.md @@ -4,10 +4,12 @@ title: "CMFCLinkCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CMFCLinkCtrl", "AFXLINKCTRL/CMFCLinkCtrl", "AFXLINKCTRL/CMFCLinkCtrl::SetURL", "AFXLINKCTRL/CMFCLinkCtrl::SetURLPrefix", "AFXLINKCTRL/CMFCLinkCtrl::SizeToContent", "AFXLINKCTRL/CMFCLinkCtrl::OnDrawFocusRect"] helpviewer_keywords: ["CMFCLinkCtrl [MFC], SetURL", "CMFCLinkCtrl [MFC], SetURLPrefix", "CMFCLinkCtrl [MFC], SizeToContent", "CMFCLinkCtrl [MFC], OnDrawFocusRect"] -ms.assetid: 80f3874d-7cc8-410e-9ff1-62a225f5034b --- # CMFCLinkCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCLinkCtrl` class displays a button as a hyperlink and invokes the link's target when the button is clicked. ## Syntax diff --git a/docs/mfc/reference/cmfclistctrl-class.md b/docs/mfc/reference/cmfclistctrl-class.md index 2ac870b8469..9f7534a3fdf 100644 --- a/docs/mfc/reference/cmfclistctrl-class.md +++ b/docs/mfc/reference/cmfclistctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCListCtrl [MFC], EnableMarkSortedColumn", "CMFCListCtr --- # `CMFCListCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCListCtrl` class extends the functionality of [`CListCtrl` Class](../../mfc/reference/clistctrl-class.md) class by supporting the advanced header control functionality of the [`CMFCHeaderCtrl` Class](../../mfc/reference/cmfcheaderctrl-class.md). ## Syntax diff --git a/docs/mfc/reference/cmfcmaskededit-class.md b/docs/mfc/reference/cmfcmaskededit-class.md index 7b846c8641d..71ee2f137b4 100644 --- a/docs/mfc/reference/cmfcmaskededit-class.md +++ b/docs/mfc/reference/cmfcmaskededit-class.md @@ -4,10 +4,12 @@ title: "CMFCMaskedEdit Class" ms.date: "11/04/2016" f1_keywords: ["CMFCMaskedEdit", "AFXMASKEDEDIT/CMFCMaskedEdit", "AFXMASKEDEDIT/CMFCMaskedEdit::DisableMask", "AFXMASKEDEDIT/CMFCMaskedEdit::EnableGetMaskedCharsOnly", "AFXMASKEDEDIT/CMFCMaskedEdit::EnableMask", "AFXMASKEDEDIT/CMFCMaskedEdit::EnableSelectByGroup", "AFXMASKEDEDIT/CMFCMaskedEdit::EnableSetMaskedCharsOnly", "AFXMASKEDEDIT/CMFCMaskedEdit::GetWindowText", "AFXMASKEDEDIT/CMFCMaskedEdit::SetValidChars", "AFXMASKEDEDIT/CMFCMaskedEdit::SetWindowText", "AFXMASKEDEDIT/CMFCMaskedEdit::IsMaskedChar"] helpviewer_keywords: ["CMFCMaskedEdit [MFC], DisableMask", "CMFCMaskedEdit [MFC], EnableGetMaskedCharsOnly", "CMFCMaskedEdit [MFC], EnableMask", "CMFCMaskedEdit [MFC], EnableSelectByGroup", "CMFCMaskedEdit [MFC], EnableSetMaskedCharsOnly", "CMFCMaskedEdit [MFC], GetWindowText", "CMFCMaskedEdit [MFC], SetValidChars", "CMFCMaskedEdit [MFC], SetWindowText", "CMFCMaskedEdit [MFC], IsMaskedChar"] -ms.assetid: 13b1a645-2d5d-4c37-8599-16d5003f23a5 --- # CMFCMaskedEdit Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCMaskedEdit` class supports a masked edit control, which validates user input against a mask and displays the validated results according to a template. ## Syntax diff --git a/docs/mfc/reference/cmfcmenubar-class.md b/docs/mfc/reference/cmfcmenubar-class.md index 8b8174252b0..5dfec5efea7 100644 --- a/docs/mfc/reference/cmfcmenubar-class.md +++ b/docs/mfc/reference/cmfcmenubar-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCMenuBar [MFC], AdjustLocations", "CMFCMenuBar [MFC], --- # CMFCMenuBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A menu bar that implements docking. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcmenubutton-class.md b/docs/mfc/reference/cmfcmenubutton-class.md index 380fdad1eed..a7a14369f28 100644 --- a/docs/mfc/reference/cmfcmenubutton-class.md +++ b/docs/mfc/reference/cmfcmenubutton-class.md @@ -4,10 +4,12 @@ title: "CMFCMenuButton Class" ms.date: "07/15/2019" f1_keywords: ["CMFCMenuButton", "AFXMENUBUTTON/CMFCMenuButton", "AFXMENUBUTTON/CMFCMenuButton::CMFCMenuButton", "AFXMENUBUTTON/CMFCMenuButton::PreTranslateMessage", "AFXMENUBUTTON/CMFCMenuButton::SizeToContent", "AFXMENUBUTTON/CMFCMenuButton::m_bOSMenu", "AFXMENUBUTTON/CMFCMenuButton::m_bRightArrow", "AFXMENUBUTTON/CMFCMenuButton::m_bStayPressed", "AFXMENUBUTTON/CMFCMenuButton::m_hMenu", "AFXMENUBUTTON/CMFCMenuButton::m_nMenuResult", "AFXMENUBUTTON/CMFCMenuButton::m_bDefaultClick"] helpviewer_keywords: ["CMFCMenuButton [MFC], CMFCMenuButton", "CMFCMenuButton [MFC], PreTranslateMessage", "CMFCMenuButton [MFC], SizeToContent", "CMFCMenuButton [MFC], m_bOSMenu", "CMFCMenuButton [MFC], m_bRightArrow", "CMFCMenuButton [MFC], m_bStayPressed", "CMFCMenuButton [MFC], m_hMenu", "CMFCMenuButton [MFC], m_nMenuResult", "CMFCMenuButton [MFC], m_bDefaultClick"] -ms.assetid: 53d3d459-1e5a-47c5-8b7f-2e61f6af5187 --- # CMFCMenuButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A button that displays a pop-up menu and reports on the user's menu selections. ## Syntax diff --git a/docs/mfc/reference/cmfcoutlookbar-class.md b/docs/mfc/reference/cmfcoutlookbar-class.md index 86aa09e2f8d..e4b228d5fac 100644 --- a/docs/mfc/reference/cmfcoutlookbar-class.md +++ b/docs/mfc/reference/cmfcoutlookbar-class.md @@ -4,10 +4,12 @@ title: "CMFCOutlookBar Class" ms.date: "06/25/2018" f1_keywords: ["CMFCOutlookBar", "AFXOUTLOOKBAR/CMFCOutlookBar", "AFXOUTLOOKBAR/CMFCOutlookBar::AllowDestroyEmptyTabbedPane", "AFXOUTLOOKBAR/CMFCOutlookBar::CanAcceptPane", "AFXOUTLOOKBAR/CMFCOutlookBar::CanSetCaptionTextToTabName", "AFXOUTLOOKBAR/CMFCOutlookBar::Create", "AFXOUTLOOKBAR/CMFCOutlookBar::CreateCustomPage", "AFXOUTLOOKBAR/CMFCOutlookBar::DoesAllowDynInsertBefore", "AFXOUTLOOKBAR/CMFCOutlookBar::FloatTab", "AFXOUTLOOKBAR/CMFCOutlookBar::GetButtonsFont", "AFXOUTLOOKBAR/CMFCOutlookBar::GetTabArea", "AFXOUTLOOKBAR/CMFCOutlookBar::IsMode2003", "AFXOUTLOOKBAR/CMFCOutlookBar::OnAfterAnimation", "AFXOUTLOOKBAR/CMFCOutlookBar::OnBeforeAnimation", "AFXOUTLOOKBAR/CMFCOutlookBar::OnScroll", "AFXOUTLOOKBAR/CMFCOutlookBar::RemoveCustomPage", "AFXOUTLOOKBAR/CMFCOutlookBar::SetButtonsFont", "AFXOUTLOOKBAR/CMFCOutlookBar::SetMode2003"] helpviewer_keywords: ["CMFCOutlookBar [MFC], AllowDestroyEmptyTabbedPane", "CMFCOutlookBar [MFC], CanAcceptPane", "CMFCOutlookBar [MFC], CanSetCaptionTextToTabName", "CMFCOutlookBar [MFC], Create", "CMFCOutlookBar [MFC], CreateCustomPage", "CMFCOutlookBar [MFC], DoesAllowDynInsertBefore", "CMFCOutlookBar [MFC], FloatTab", "CMFCOutlookBar [MFC], GetButtonsFont", "CMFCOutlookBar [MFC], GetTabArea", "CMFCOutlookBar [MFC], IsMode2003", "CMFCOutlookBar [MFC], OnAfterAnimation", "CMFCOutlookBar [MFC], OnBeforeAnimation", "CMFCOutlookBar [MFC], OnScroll", "CMFCOutlookBar [MFC], RemoveCustomPage", "CMFCOutlookBar [MFC], SetButtonsFont", "CMFCOutlookBar [MFC], SetMode2003"] -ms.assetid: 2b335f71-ce99-4efd-b103-e65ba43ffc36 --- # CMFCOutlookBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A tabbed pane with the visual appearance of the **Navigation Pane** in Microsoft Outlook 2000 or Outlook 2003. The `CMFCOutlookBar` object contains a [CMFCOutlookBarTabCtrl Class](../../mfc/reference/cmfcoutlookbartabctrl-class.md) object and a series of tabs. The tabs can be either [CMFCOutlookBarPane Class](../../mfc/reference/cmfcoutlookbarpane-class.md) objects or `CWnd`-derived objects. To the user, the Outlook bar appears as a series of buttons and a display area. When the user clicks a button, the corresponding control or button pane is displayed. ## Syntax diff --git a/docs/mfc/reference/cmfcoutlookbarpane-class.md b/docs/mfc/reference/cmfcoutlookbarpane-class.md index 04527f6dd39..37a1f9e4ad7 100644 --- a/docs/mfc/reference/cmfcoutlookbarpane-class.md +++ b/docs/mfc/reference/cmfcoutlookbarpane-class.md @@ -4,10 +4,12 @@ title: "CMFCOutlookBarPane Class" ms.date: "11/04/2016" f1_keywords: ["CMFCOutlookBarPane", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::AddButton", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::CanBeAttached", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::ClearAll", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::Create", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::EnablePageScrollMode", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::GetRegularColor", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::IsBackgroundTexture", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::IsDrawShadedHighlight", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::RemoveButton", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::SetBackColor", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::SetBackImage", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::SetDefaultState", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::SetExtraSpace", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::SetTextColor", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::SetTransparentColor", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::EnableContextMenuItems", "AFXOUTLOOKBARPANE/CMFCOutlookBarPane::RemoveAllButtons"] helpviewer_keywords: ["CMFCOutlookBarPane [MFC], AddButton", "CMFCOutlookBarPane [MFC], CanBeAttached", "CMFCOutlookBarPane [MFC], ClearAll", "CMFCOutlookBarPane [MFC], Create", "CMFCOutlookBarPane [MFC], EnablePageScrollMode", "CMFCOutlookBarPane [MFC], GetRegularColor", "CMFCOutlookBarPane [MFC], IsBackgroundTexture", "CMFCOutlookBarPane [MFC], IsDrawShadedHighlight", "CMFCOutlookBarPane [MFC], RemoveButton", "CMFCOutlookBarPane [MFC], SetBackColor", "CMFCOutlookBarPane [MFC], SetBackImage", "CMFCOutlookBarPane [MFC], SetDefaultState", "CMFCOutlookBarPane [MFC], SetExtraSpace", "CMFCOutlookBarPane [MFC], SetTextColor", "CMFCOutlookBarPane [MFC], SetTransparentColor", "CMFCOutlookBarPane [MFC], EnableContextMenuItems", "CMFCOutlookBarPane [MFC], RemoveAllButtons"] -ms.assetid: 094e2ef3-a118-487e-a4cc-27626108fe08 --- # CMFCOutlookBarPane Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. A control derived from [CMFCToolBar Class](../../mfc/reference/cmfctoolbar-class.md) that can be inserted into an Outlook bar ( [CMFCOutlookBar Class](../../mfc/reference/cmfcoutlookbar-class.md)). The Outlook bar pane contains a column of large buttons. The user can scroll up and down the list of buttons if it is larger than the pane. When the user detaches an Outlook bar pane from the Outlook bar, it can float or dock in the main frame window. diff --git a/docs/mfc/reference/cmfcoutlookbartabctrl-class.md b/docs/mfc/reference/cmfcoutlookbartabctrl-class.md index 0ea3e6a49b0..7af29c03428 100644 --- a/docs/mfc/reference/cmfcoutlookbartabctrl-class.md +++ b/docs/mfc/reference/cmfcoutlookbartabctrl-class.md @@ -4,10 +4,12 @@ title: "CMFCOutlookBarTabCtrl Class" ms.date: "10/18/2018" f1_keywords: ["CMFCOutlookBarTabCtrl", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::AddControl", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::CanShowFewerPageButtons", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::CanShowMorePageButtons", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::Create", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::EnableAnimation", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::EnableInPlaceEdit", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::EnableScrollButtons", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::GetBorderSize", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::GetVisiblePageButtons", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::IsAnimation", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::IsMode2003", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::OnShowFewerPageButtons", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::OnShowMorePageButtons", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::OnShowOptions", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::SetActiveTab", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::SetBorderSize", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::SetPageButtonTextAlign", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::SetToolbarImageList", "AFXOUTLOOKBARTABCTRL/CMFCOutlookBarTabCtrl::SetVisiblePageButtons"] helpviewer_keywords: ["CMFCOutlookBarTabCtrl [MFC], AddControl", "CMFCOutlookBarTabCtrl [MFC], CanShowFewerPageButtons", "CMFCOutlookBarTabCtrl [MFC], CanShowMorePageButtons", "CMFCOutlookBarTabCtrl [MFC], Create", "CMFCOutlookBarTabCtrl [MFC], EnableAnimation", "CMFCOutlookBarTabCtrl [MFC], EnableInPlaceEdit", "CMFCOutlookBarTabCtrl [MFC], EnableScrollButtons", "CMFCOutlookBarTabCtrl [MFC], GetBorderSize", "CMFCOutlookBarTabCtrl [MFC], GetVisiblePageButtons", "CMFCOutlookBarTabCtrl [MFC], IsAnimation", "CMFCOutlookBarTabCtrl [MFC], IsMode2003", "CMFCOutlookBarTabCtrl [MFC], OnShowFewerPageButtons", "CMFCOutlookBarTabCtrl [MFC], OnShowMorePageButtons", "CMFCOutlookBarTabCtrl [MFC], OnShowOptions", "CMFCOutlookBarTabCtrl [MFC], SetActiveTab", "CMFCOutlookBarTabCtrl [MFC], SetBorderSize", "CMFCOutlookBarTabCtrl [MFC], SetPageButtonTextAlign", "CMFCOutlookBarTabCtrl [MFC], SetToolbarImageList", "CMFCOutlookBarTabCtrl [MFC], SetVisiblePageButtons"] -ms.assetid: b1f2b3f7-cc59-49a3-99d8-7ff9b37c044b --- # CMFCOutlookBarTabCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A tab control that has the visual appearance of the **Navigation Pane** in Microsoft Outlook. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcpopupmenu-class.md b/docs/mfc/reference/cmfcpopupmenu-class.md index ab702034109..a56effeb9f5 100644 --- a/docs/mfc/reference/cmfcpopupmenu-class.md +++ b/docs/mfc/reference/cmfcpopupmenu-class.md @@ -4,10 +4,12 @@ title: "CMFCPopupMenu Class" ms.date: "10/18/2018" f1_keywords: ["CMFCPopupMenu", "AFXPOPUPMENU/CMFCPopupMenu", "AFXPOPUPMENU/CMFCPopupMenu::CMFCPopupMenu", "AFXPOPUPMENU/CMFCPopupMenu::ActivatePopupMenu", "AFXPOPUPMENU/CMFCPopupMenu::AlwaysShowEmptyToolsEntry", "AFXPOPUPMENU/CMFCPopupMenu::AreAllCommandsShown", "AFXPOPUPMENU/CMFCPopupMenu::CheckArea", "AFXPOPUPMENU/CMFCPopupMenu::CloseMenu", "AFXPOPUPMENU/CMFCPopupMenu::Create", "AFXPOPUPMENU/CMFCPopupMenu::DefaultMouseClickOnClose", "AFXPOPUPMENU/CMFCPopupMenu::EnableMenuLogo", "AFXPOPUPMENU/CMFCPopupMenu::EnableMenuSound", "AFXPOPUPMENU/CMFCPopupMenu::EnableResize", "AFXPOPUPMENU/CMFCPopupMenu::EnableScrolling", "AFXPOPUPMENU/CMFCPopupMenu::EnableVertResize", "AFXPOPUPMENU/CMFCPopupMenu::FindSubItemByCommand", "AFXPOPUPMENU/CMFCPopupMenu::GetActiveMenu", "AFXPOPUPMENU/CMFCPopupMenu::GetAnimationSpeed", "AFXPOPUPMENU/CMFCPopupMenu::GetAnimationType", "AFXPOPUPMENU/CMFCPopupMenu::GetDropDirection", "AFXPOPUPMENU/CMFCPopupMenu::GetForceMenuFocus", "AFXPOPUPMENU/CMFCPopupMenu::GetForceShadow", "AFXPOPUPMENU/CMFCPopupMenu::GetHMenu", "AFXPOPUPMENU/CMFCPopupMenu::GetMenuBar", "AFXPOPUPMENU/CMFCPopupMenu::GetMenuItem", "AFXPOPUPMENU/CMFCPopupMenu::GetMenuItemCount", "AFXPOPUPMENU/CMFCPopupMenu::GetMessageWnd", "AFXPOPUPMENU/CMFCPopupMenu::GetParentArea", "AFXPOPUPMENU/CMFCPopupMenu::GetParentButton", "AFXPOPUPMENU/CMFCPopupMenu::GetParentPopupMenu", "AFXPOPUPMENU/CMFCPopupMenu::GetParentRibbonElement", "AFXPOPUPMENU/CMFCPopupMenu::GetParentToolBar", "AFXPOPUPMENU/CMFCPopupMenu::GetQuickCustomizeType", "AFXPOPUPMENU/CMFCPopupMenu::GetSelItem", "AFXPOPUPMENU/CMFCPopupMenu::HasBeenResized", "AFXPOPUPMENU/CMFCPopupMenu::HideRarelyUsedCommands", "AFXPOPUPMENU/CMFCPopupMenu::InCommand", "AFXPOPUPMENU/CMFCPopupMenu::InsertItem", "AFXPOPUPMENU/CMFCPopupMenu::InsertSeparator", "AFXPOPUPMENU/CMFCPopupMenu::IsAlwaysClose", "AFXPOPUPMENU/CMFCPopupMenu::IsAlwaysShowEmptyToolsEntry", "AFXPOPUPMENU/CMFCPopupMenu::IsCustomizePane", "AFXPOPUPMENU/CMFCPopupMenu::IsEscClose", "AFXPOPUPMENU/CMFCPopupMenu::IsIdle", "AFXPOPUPMENU/CMFCPopupMenu::IsMenuSound", "AFXPOPUPMENU/CMFCPopupMenu::IsQuickCustomize", "AFXPOPUPMENU/CMFCPopupMenu::IsResizeble", "AFXPOPUPMENU/CMFCPopupMenu::IsRightAlign", "AFXPOPUPMENU/CMFCPopupMenu::IsScrollable", "AFXPOPUPMENU/CMFCPopupMenu::IsSendMenuSelectMsg", "AFXPOPUPMENU/CMFCPopupMenu::IsShown", "AFXPOPUPMENU/CMFCPopupMenu::MoveTo", "AFXPOPUPMENU/CMFCPopupMenu::OnCmdMsg", "AFXPOPUPMENU/CMFCPopupMenu::PostCommand", "AFXPOPUPMENU/CMFCPopupMenu::PreTranslateMessage", "AFXPOPUPMENU/CMFCPopupMenu::RecalcLayout", "AFXPOPUPMENU/CMFCPopupMenu::RemoveAllItems", "AFXPOPUPMENU/CMFCPopupMenu::RemoveItem", "AFXPOPUPMENU/CMFCPopupMenu::SaveState", "AFXPOPUPMENU/CMFCPopupMenu::SetAnimationSpeed", "AFXPOPUPMENU/CMFCPopupMenu::SetAnimationType", "AFXPOPUPMENU/CMFCPopupMenu::SetAutoDestroy", "AFXPOPUPMENU/CMFCPopupMenu::SetDefaultItem", "AFXPOPUPMENU/CMFCPopupMenu::SetForceMenuFocus", "AFXPOPUPMENU/CMFCPopupMenu::SetForceShadow", "AFXPOPUPMENU/CMFCPopupMenu::SetMaxWidth", "AFXPOPUPMENU/CMFCPopupMenu::SetMessageWnd", "AFXPOPUPMENU/CMFCPopupMenu::SetParentRibbonElement", "AFXPOPUPMENU/CMFCPopupMenu::SetQuickCustomizeType", "AFXPOPUPMENU/CMFCPopupMenu::SetQuickMode", "AFXPOPUPMENU/CMFCPopupMenu::SetRightAlign", "AFXPOPUPMENU/CMFCPopupMenu::SetSendMenuSelectMsg", "AFXPOPUPMENU/CMFCPopupMenu::ShowAllCommands", "AFXPOPUPMENU/CMFCPopupMenu::TriggerResize", "AFXPOPUPMENU/CMFCPopupMenu::UpdateAllShadows", "AFXPOPUPMENU/CMFCPopupMenu::UpdateShadow", "AFXPOPUPMENU/CMFCPopupMenu::CreateTearOffBar", "AFXPOPUPMENU/CMFCPopupMenu::OnChangeHot", "AFXPOPUPMENU/CMFCPopupMenu::OnChooseItem"] helpviewer_keywords: ["CMFCPopupMenu [MFC], CMFCPopupMenu", "CMFCPopupMenu [MFC], ActivatePopupMenu", "CMFCPopupMenu [MFC], AlwaysShowEmptyToolsEntry", "CMFCPopupMenu [MFC], AreAllCommandsShown", "CMFCPopupMenu [MFC], CheckArea", "CMFCPopupMenu [MFC], CloseMenu", "CMFCPopupMenu [MFC], Create", "CMFCPopupMenu [MFC], DefaultMouseClickOnClose", "CMFCPopupMenu [MFC], EnableMenuLogo", "CMFCPopupMenu [MFC], EnableMenuSound", "CMFCPopupMenu [MFC], EnableResize", "CMFCPopupMenu [MFC], EnableScrolling", "CMFCPopupMenu [MFC], EnableVertResize", "CMFCPopupMenu [MFC], FindSubItemByCommand", "CMFCPopupMenu [MFC], GetActiveMenu", "CMFCPopupMenu [MFC], GetAnimationSpeed", "CMFCPopupMenu [MFC], GetAnimationType", "CMFCPopupMenu [MFC], GetDropDirection", "CMFCPopupMenu [MFC], GetForceMenuFocus", "CMFCPopupMenu [MFC], GetForceShadow", "CMFCPopupMenu [MFC], GetHMenu", "CMFCPopupMenu [MFC], GetMenuBar", "CMFCPopupMenu [MFC], GetMenuItem", "CMFCPopupMenu [MFC], GetMenuItemCount", "CMFCPopupMenu [MFC], GetMessageWnd", "CMFCPopupMenu [MFC], GetParentArea", "CMFCPopupMenu [MFC], GetParentButton", "CMFCPopupMenu [MFC], GetParentPopupMenu", "CMFCPopupMenu [MFC], GetParentRibbonElement", "CMFCPopupMenu [MFC], GetParentToolBar", "CMFCPopupMenu [MFC], GetQuickCustomizeType", "CMFCPopupMenu [MFC], GetSelItem", "CMFCPopupMenu [MFC], HasBeenResized", "CMFCPopupMenu [MFC], HideRarelyUsedCommands", "CMFCPopupMenu [MFC], InCommand", "CMFCPopupMenu [MFC], InsertItem", "CMFCPopupMenu [MFC], InsertSeparator", "CMFCPopupMenu [MFC], IsAlwaysClose", "CMFCPopupMenu [MFC], IsAlwaysShowEmptyToolsEntry", "CMFCPopupMenu [MFC], IsCustomizePane", "CMFCPopupMenu [MFC], IsEscClose", "CMFCPopupMenu [MFC], IsIdle", "CMFCPopupMenu [MFC], IsMenuSound", "CMFCPopupMenu [MFC], IsQuickCustomize", "CMFCPopupMenu [MFC], IsResizeble", "CMFCPopupMenu [MFC], IsRightAlign", "CMFCPopupMenu [MFC], IsScrollable", "CMFCPopupMenu [MFC], IsSendMenuSelectMsg", "CMFCPopupMenu [MFC], IsShown", "CMFCPopupMenu [MFC], MoveTo", "CMFCPopupMenu [MFC], OnCmdMsg", "CMFCPopupMenu [MFC], PostCommand", "CMFCPopupMenu [MFC], PreTranslateMessage", "CMFCPopupMenu [MFC], RecalcLayout", "CMFCPopupMenu [MFC], RemoveAllItems", "CMFCPopupMenu [MFC], RemoveItem", "CMFCPopupMenu [MFC], SaveState", "CMFCPopupMenu [MFC], SetAnimationSpeed", "CMFCPopupMenu [MFC], SetAnimationType", "CMFCPopupMenu [MFC], SetAutoDestroy", "CMFCPopupMenu [MFC], SetDefaultItem", "CMFCPopupMenu [MFC], SetForceMenuFocus", "CMFCPopupMenu [MFC], SetForceShadow", "CMFCPopupMenu [MFC], SetMaxWidth", "CMFCPopupMenu [MFC], SetMessageWnd", "CMFCPopupMenu [MFC], SetParentRibbonElement", "CMFCPopupMenu [MFC], SetQuickCustomizeType", "CMFCPopupMenu [MFC], SetQuickMode", "CMFCPopupMenu [MFC], SetRightAlign", "CMFCPopupMenu [MFC], SetSendMenuSelectMsg", "CMFCPopupMenu [MFC], ShowAllCommands", "CMFCPopupMenu [MFC], TriggerResize", "CMFCPopupMenu [MFC], UpdateAllShadows", "CMFCPopupMenu [MFC], UpdateShadow", "CMFCPopupMenu [MFC], CreateTearOffBar", "CMFCPopupMenu [MFC], OnChangeHot", "CMFCPopupMenu [MFC], OnChooseItem"] -ms.assetid: 9555dca1-8c9c-44c9-af72-0659ddad128e --- # CMFCPopupMenu Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements Windows pop-up menu functionality and extends it by adding features such as tear-off menus and tooltips. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcpopupmenubar-class.md b/docs/mfc/reference/cmfcpopupmenubar-class.md index c3b797becac..b80cec2199f 100644 --- a/docs/mfc/reference/cmfcpopupmenubar-class.md +++ b/docs/mfc/reference/cmfcpopupmenubar-class.md @@ -4,10 +4,12 @@ title: "CMFCPopupMenuBar Class" ms.date: "11/04/2016" f1_keywords: ["CMFCPopupMenuBar", "AFXPOPUPMENUBAR/CMFCPopupMenuBar", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::AdjustSizeImmediate", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::BuildOrigItems", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::CloseDelayedSubMenu", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::ExportToMenu", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::FindDestintationToolBar", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::GetCurrentMenuImageSize", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::GetDefaultMenuId", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::GetLastCommandIndex", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::GetOffset", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::ImportFromMenu", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::IsDropDownListMode", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::IsPaletteMode", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::IsRibbonPanel", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::IsRibbonPanelInRegularMode", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::LoadFromHash", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::RestoreDelayedSubMenu", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::SetButtonStyle", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::SetOffset", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::StartPopupMenuTimer", "AFXPOPUPMENUBAR/CMFCPopupMenuBar::m_bDisableSideBarInXPMode"] helpviewer_keywords: ["CMFCPopupMenuBar [MFC], AdjustSizeImmediate", "CMFCPopupMenuBar [MFC], BuildOrigItems", "CMFCPopupMenuBar [MFC], CloseDelayedSubMenu", "CMFCPopupMenuBar [MFC], ExportToMenu", "CMFCPopupMenuBar [MFC], FindDestintationToolBar", "CMFCPopupMenuBar [MFC], GetCurrentMenuImageSize", "CMFCPopupMenuBar [MFC], GetDefaultMenuId", "CMFCPopupMenuBar [MFC], GetLastCommandIndex", "CMFCPopupMenuBar [MFC], GetOffset", "CMFCPopupMenuBar [MFC], ImportFromMenu", "CMFCPopupMenuBar [MFC], IsDropDownListMode", "CMFCPopupMenuBar [MFC], IsPaletteMode", "CMFCPopupMenuBar [MFC], IsRibbonPanel", "CMFCPopupMenuBar [MFC], IsRibbonPanelInRegularMode", "CMFCPopupMenuBar [MFC], LoadFromHash", "CMFCPopupMenuBar [MFC], RestoreDelayedSubMenu", "CMFCPopupMenuBar [MFC], SetButtonStyle", "CMFCPopupMenuBar [MFC], SetOffset", "CMFCPopupMenuBar [MFC], StartPopupMenuTimer", "CMFCPopupMenuBar [MFC], m_bDisableSideBarInXPMode"] -ms.assetid: 4c93c459-7f70-4240-8c63-280bb811e374 --- # CMFCPopupMenuBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A menu bar embedded into a pop-up menu. ## Syntax diff --git a/docs/mfc/reference/cmfcpreviewctrlimpl-class.md b/docs/mfc/reference/cmfcpreviewctrlimpl-class.md index 0dc7d379523..00f4b24cce3 100644 --- a/docs/mfc/reference/cmfcpreviewctrlimpl-class.md +++ b/docs/mfc/reference/cmfcpreviewctrlimpl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCPreviewCtrlImpl [MFC], CMFCPreviewCtrlImpl", "CMFCPre --- # `CMFCPreviewCtrlImpl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This class implements a window that is placed on a host window provided by the Shell for Rich Preview. ## Syntax diff --git a/docs/mfc/reference/cmfcprintpreviewtoolbar-class.md b/docs/mfc/reference/cmfcprintpreviewtoolbar-class.md index d4afc3ce036..12c1fad00ce 100644 --- a/docs/mfc/reference/cmfcprintpreviewtoolbar-class.md +++ b/docs/mfc/reference/cmfcprintpreviewtoolbar-class.md @@ -3,10 +3,12 @@ description: "Learn more about: CMFCPrintPreviewToolBar Class" title: "CMFCPrintPreviewToolBar Class" ms.date: "11/04/2016" helpviewer_keywords: ["CMFCPrintPreviewToolBar class [MFC]", "CMFCPrintPreviewToolBar class [MFC], destructor"] -ms.assetid: 7b9f641b-d402-4339-8815-e5247237e7e5 --- # CMFCPrintPreviewToolBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The toolbar on the print preview. ## Syntax diff --git a/docs/mfc/reference/cmfcpropertygridcolorproperty-class.md b/docs/mfc/reference/cmfcpropertygridcolorproperty-class.md index 75794a5d3ce..2f8314b97fa 100644 --- a/docs/mfc/reference/cmfcpropertygridcolorproperty-class.md +++ b/docs/mfc/reference/cmfcpropertygridcolorproperty-class.md @@ -4,10 +4,12 @@ title: "CMFCPropertyGridColorProperty Class" ms.date: "11/04/2016" f1_keywords: ["CMFCPropertyGridColorProperty", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridColorProperty", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridColorProperty::CMFCPropertyGridColorProperty", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridColorProperty::EnableAutomaticButton", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridColorProperty::EnableOtherButton", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridColorProperty::GetColor", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridColorProperty::SetColor", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridColorProperty::SetColumnsNumber", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridColorProperty::SetOriginalValue"] helpviewer_keywords: ["CMFCPropertyGridColorProperty [MFC], CMFCPropertyGridColorProperty", "CMFCPropertyGridColorProperty [MFC], EnableAutomaticButton", "CMFCPropertyGridColorProperty [MFC], EnableOtherButton", "CMFCPropertyGridColorProperty [MFC], GetColor", "CMFCPropertyGridColorProperty [MFC], SetColor", "CMFCPropertyGridColorProperty [MFC], SetColumnsNumber", "CMFCPropertyGridColorProperty [MFC], SetOriginalValue"] -ms.assetid: af37be93-a91e-40a2-9a65-0f3412c6f0f8 --- # CMFCPropertyGridColorProperty Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCPropertyGridColorProperty` class supports a property list control item that opens a color selection dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfcpropertygridctrl-class.md b/docs/mfc/reference/cmfcpropertygridctrl-class.md index 08bc061cf36..bddf570d91a 100644 --- a/docs/mfc/reference/cmfcpropertygridctrl-class.md +++ b/docs/mfc/reference/cmfcpropertygridctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCPropertyGridCtrl [MFC], CMFCPropertyGridCtrl", "CMFCP --- # CMFCPropertyGridCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For more detail see the source code located in the **`mfc`** folder of your Visual Studio installation. For example, `%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc`. Supports an editable property grid control that can display properties in alphabetical or hierarchical order. diff --git a/docs/mfc/reference/cmfcpropertygridfileproperty-class.md b/docs/mfc/reference/cmfcpropertygridfileproperty-class.md index 7d7c329867d..00f5bffd1f0 100644 --- a/docs/mfc/reference/cmfcpropertygridfileproperty-class.md +++ b/docs/mfc/reference/cmfcpropertygridfileproperty-class.md @@ -4,10 +4,12 @@ title: "CMFCPropertyGridFileProperty Class" ms.date: "11/04/2016" f1_keywords: ["CMFCPropertyGridFileProperty", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridFileProperty", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridFileProperty::CMFCPropertyGridFileProperty"] helpviewer_keywords: ["CMFCPropertyGridFileProperty [MFC], CMFCPropertyGridFileProperty"] -ms.assetid: 2bb8b8b4-47fc-4798-bd5e-dc8ea0b4cd9d --- # CMFCPropertyGridFileProperty Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCPropertyGridFileProperty` class supports a property list control item that opens a file selection dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfcpropertygridfontproperty-class.md b/docs/mfc/reference/cmfcpropertygridfontproperty-class.md index 9dc77057151..84b77c97caa 100644 --- a/docs/mfc/reference/cmfcpropertygridfontproperty-class.md +++ b/docs/mfc/reference/cmfcpropertygridfontproperty-class.md @@ -4,10 +4,12 @@ title: "CMFCPropertyGridFontProperty Class" ms.date: "11/04/2016" f1_keywords: ["CMFCPropertyGridFontProperty", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridFontProperty", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridFontProperty::CMFCPropertyGridFontProperty", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridFontProperty::GetColor", "AFXPROPERTYGRIDCTRL/CMFCPropertyGridFontProperty::GetLogFont"] helpviewer_keywords: ["CMFCPropertyGridFontProperty [MFC], CMFCPropertyGridFontProperty", "CMFCPropertyGridFontProperty [MFC], GetColor", "CMFCPropertyGridFontProperty [MFC], GetLogFont"] -ms.assetid: 83693f33-bbd3-4fcb-a9ad-fa79fcf2ca24 --- # CMFCPropertyGridFontProperty Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCPropertyGridFileProperty` class supports a property list control item that opens a font selection dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfcpropertygridproperty-class.md b/docs/mfc/reference/cmfcpropertygridproperty-class.md index 8bf3752df36..e9a54f4ffc6 100644 --- a/docs/mfc/reference/cmfcpropertygridproperty-class.md +++ b/docs/mfc/reference/cmfcpropertygridproperty-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCPropertyGridProperty [MFC], CMFCPropertyGridProperty" --- # `CMFCPropertyGridProperty` class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A `CMFCPropertyGridProperty` object represents a list item in a property list control. For more detail, see the source code located in the **`mfc`** folder of your Visual Studio installation. For example, `%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc`. diff --git a/docs/mfc/reference/cmfcpropertygridtooltipctrl-class.md b/docs/mfc/reference/cmfcpropertygridtooltipctrl-class.md index 84ef4b26a9a..47484ecb7db 100644 --- a/docs/mfc/reference/cmfcpropertygridtooltipctrl-class.md +++ b/docs/mfc/reference/cmfcpropertygridtooltipctrl-class.md @@ -4,10 +4,12 @@ title: "CMFCPropertyGridToolTipCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CMFCPropertyGridToolTipCtrl", "AFXPROPERTYGRIDTOOLTIPCTRL/CMFCPropertyGridToolTipCtrl", "AFXPROPERTYGRIDTOOLTIPCTRL/CMFCPropertyGridToolTipCtrl::CMFCPropertyGridToolTipCtrl", "AFXPROPERTYGRIDTOOLTIPCTRL/CMFCPropertyGridToolTipCtrl::Create", "AFXPROPERTYGRIDTOOLTIPCTRL/CMFCPropertyGridToolTipCtrl::Deactivate", "AFXPROPERTYGRIDTOOLTIPCTRL/CMFCPropertyGridToolTipCtrl::GetLastRect", "AFXPROPERTYGRIDTOOLTIPCTRL/CMFCPropertyGridToolTipCtrl::Hide", "AFXPROPERTYGRIDTOOLTIPCTRL/CMFCPropertyGridToolTipCtrl::SetTextMargin", "AFXPROPERTYGRIDTOOLTIPCTRL/CMFCPropertyGridToolTipCtrl::Track"] helpviewer_keywords: ["CMFCPropertyGridToolTipCtrl [MFC], CMFCPropertyGridToolTipCtrl", "CMFCPropertyGridToolTipCtrl [MFC], Create", "CMFCPropertyGridToolTipCtrl [MFC], Deactivate", "CMFCPropertyGridToolTipCtrl [MFC], GetLastRect", "CMFCPropertyGridToolTipCtrl [MFC], Hide", "CMFCPropertyGridToolTipCtrl [MFC], SetTextMargin", "CMFCPropertyGridToolTipCtrl [MFC], Track"] -ms.assetid: 84b436e5-6695-4da0-9569-1a875e087711 --- # CMFCPropertyGridToolTipCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a tooltip control that the [CMFCPropertyGridCtrl Class](../../mfc/reference/cmfcpropertygridctrl-class.md) uses to display tooltips. ## Syntax diff --git a/docs/mfc/reference/cmfcpropertypage-class.md b/docs/mfc/reference/cmfcpropertypage-class.md index a8448d4c043..7ad58c0a49a 100644 --- a/docs/mfc/reference/cmfcpropertypage-class.md +++ b/docs/mfc/reference/cmfcpropertypage-class.md @@ -4,10 +4,12 @@ title: "CMFCPropertyPage Class" ms.date: "11/04/2016" f1_keywords: ["CMFCPropertyPage", "AFXPROPERTYPAGE/CMFCPropertyPage", "AFXPROPERTYPAGE/CMFCPropertyPage::CMFCPropertyPage"] helpviewer_keywords: ["CMFCPropertyPage [MFC], CMFCPropertyPage"] -ms.assetid: d279d7f2-2d81-418d-9f23-6147d6e8df09 --- # CMFCPropertyPage Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCPropertyPage` class supports the display of pop-up menus on a property page. ## Syntax diff --git a/docs/mfc/reference/cmfcpropertysheet-class.md b/docs/mfc/reference/cmfcpropertysheet-class.md index b7f34be9f44..3526eeb6a54 100644 --- a/docs/mfc/reference/cmfcpropertysheet-class.md +++ b/docs/mfc/reference/cmfcpropertysheet-class.md @@ -4,10 +4,12 @@ title: "CMFCPropertySheet Class" ms.date: "11/19/2018" f1_keywords: ["CMFCPropertySheet", "AFXPROPERTYSHEET/CMFCPropertySheet", "AFXPROPERTYSHEET/CMFCPropertySheet::CMFCPropertySheet", "AFXPROPERTYSHEET/CMFCPropertySheet::AddPage", "AFXPROPERTYSHEET/CMFCPropertySheet::AddPageToTree", "AFXPROPERTYSHEET/CMFCPropertySheet::AddTreeCategory", "AFXPROPERTYSHEET/CMFCPropertySheet::EnablePageHeader", "AFXPROPERTYSHEET/CMFCPropertySheet::GetHeaderHeight", "AFXPROPERTYSHEET/CMFCPropertySheet::GetLook", "AFXPROPERTYSHEET/CMFCPropertySheet::GetNavBarWidth", "AFXPROPERTYSHEET/CMFCPropertySheet::GetTab", "AFXPROPERTYSHEET/CMFCPropertySheet::InitNavigationControl", "AFXPROPERTYSHEET/CMFCPropertySheet::OnActivatePage", "AFXPROPERTYSHEET/CMFCPropertySheet::OnDrawPageHeader", "AFXPROPERTYSHEET/CMFCPropertySheet::OnRemoveTreePage", "AFXPROPERTYSHEET/CMFCPropertySheet::RemoveCategory", "AFXPROPERTYSHEET/CMFCPropertySheet::RemovePage", "AFXPROPERTYSHEET/CMFCPropertySheet::SetIconsList", "AFXPROPERTYSHEET/CMFCPropertySheet::SetLook"] helpviewer_keywords: ["CMFCPropertySheet [MFC], CMFCPropertySheet", "CMFCPropertySheet [MFC], AddPage", "CMFCPropertySheet [MFC], AddPageToTree", "CMFCPropertySheet [MFC], AddTreeCategory", "CMFCPropertySheet [MFC], EnablePageHeader", "CMFCPropertySheet [MFC], GetHeaderHeight", "CMFCPropertySheet [MFC], GetLook", "CMFCPropertySheet [MFC], GetNavBarWidth", "CMFCPropertySheet [MFC], GetTab", "CMFCPropertySheet [MFC], InitNavigationControl", "CMFCPropertySheet [MFC], OnActivatePage", "CMFCPropertySheet [MFC], OnDrawPageHeader", "CMFCPropertySheet [MFC], OnRemoveTreePage", "CMFCPropertySheet [MFC], RemoveCategory", "CMFCPropertySheet [MFC], RemovePage", "CMFCPropertySheet [MFC], SetIconsList", "CMFCPropertySheet [MFC], SetLook"] -ms.assetid: 01d93573-9698-440f-a6a4-5bebbee879dc --- # CMFCPropertySheet Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCPropertySheet` class supports a property sheet where each property page is denoted by a page tab, a toolbar button, a tree control node, or a list item. ## Syntax diff --git a/docs/mfc/reference/cmfcrebar-class.md b/docs/mfc/reference/cmfcrebar-class.md index 355e63c99e2..babf161b4c7 100644 --- a/docs/mfc/reference/cmfcrebar-class.md +++ b/docs/mfc/reference/cmfcrebar-class.md @@ -4,10 +4,12 @@ title: "CMFCReBar Class" ms.date: "11/04/2016" f1_keywords: ["CMFCReBar", "AFXREBAR/CMFCReBar", "AFXREBAR/CMFCReBar::AddBar", "AFXREBAR/CMFCReBar::CalcFixedLayout", "AFXREBAR/CMFCReBar::CanFloat", "AFXREBAR/CMFCReBar::Create", "AFXREBAR/CMFCReBar::EnableDocking", "AFXREBAR/CMFCReBar::GetReBarBandInfoSize", "AFXREBAR/CMFCReBar::GetReBarCtrl", "AFXREBAR/CMFCReBar::OnShowControlBarMenu", "AFXREBAR/CMFCReBar::OnToolHitTest", "AFXREBAR/CMFCReBar::OnUpdateCmdUI", "AFXREBAR/CMFCReBar::SetPaneAlignment"] helpviewer_keywords: ["CMFCReBar [MFC], AddBar", "CMFCReBar [MFC], CalcFixedLayout", "CMFCReBar [MFC], CanFloat", "CMFCReBar [MFC], Create", "CMFCReBar [MFC], EnableDocking", "CMFCReBar [MFC], GetReBarBandInfoSize", "CMFCReBar [MFC], GetReBarCtrl", "CMFCReBar [MFC], OnShowControlBarMenu", "CMFCReBar [MFC], OnToolHitTest", "CMFCReBar [MFC], OnUpdateCmdUI", "CMFCReBar [MFC], SetPaneAlignment"] -ms.assetid: 02a60e29-6224-49c1-9e74-e0a7d9f8d023 --- # CMFCReBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A `CMFCReBar` object is a control bar that provides layout, persistence, and state information for rebar controls. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcribbonapplicationbutton-class.md b/docs/mfc/reference/cmfcribbonapplicationbutton-class.md index 5309f14c60f..50d4c58b4ff 100644 --- a/docs/mfc/reference/cmfcribbonapplicationbutton-class.md +++ b/docs/mfc/reference/cmfcribbonapplicationbutton-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonApplicationButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonApplicationButton", "AFXRIBBONBAR/CMFCRibbonApplicationButton", "AFXRIBBONBAR/CMFCRibbonApplicationButton::CMFCRibbonApplicationButton", "AFXRIBBONBAR/CMFCRibbonApplicationButton::SetImage"] helpviewer_keywords: ["CMFCRibbonApplicationButton [MFC], CMFCRibbonApplicationButton", "CMFCRibbonApplicationButton [MFC], SetImage"] -ms.assetid: beb81757-fabd-4641-9130-876ba8505b78 --- # CMFCRibbonApplicationButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a special button located in the top-left corner of the application window. When clicked, the button opens a menu that usually contains common **File** commands like **Open**, **Save**, and **Exit**. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonbar-class.md b/docs/mfc/reference/cmfcribbonbar-class.md index b3ec1757ee4..0dc8d3faf6c 100644 --- a/docs/mfc/reference/cmfcribbonbar-class.md +++ b/docs/mfc/reference/cmfcribbonbar-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCRibbonBar [MFC], ActivateContextCategory", "CMFCRibbo --- # `CMFCRibbonBar` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonBar` class implements a ribbon bar similar to that used in Office 2007. For more detail, see the source code located in the `mfc` folder of your Visual Studio installation. For example, `%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc`. diff --git a/docs/mfc/reference/cmfcribbonbaseelement-class.md b/docs/mfc/reference/cmfcribbonbaseelement-class.md index 7f320909b9d..d67fb97cd16 100644 --- a/docs/mfc/reference/cmfcribbonbaseelement-class.md +++ b/docs/mfc/reference/cmfcribbonbaseelement-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCRibbonBaseElement [MFC], AddToKeyList", "CMFCRibbonBa --- # CMFCRibbonBaseElement Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonBaseElement` class is the base class for all elements that you can add to a [ribbon bar](../../mfc/reference/cmfcribbonbar-class.md). Examples of ribbon elements are ribbon buttons, ribbon check boxes, and ribbon combo boxes. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonbutton-class.md b/docs/mfc/reference/cmfcribbonbutton-class.md index 38845bda11c..fec84f00b6a 100644 --- a/docs/mfc/reference/cmfcribbonbutton-class.md +++ b/docs/mfc/reference/cmfcribbonbutton-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonButton", "AFXRIBBONBUTTON/CMFCRibbonButton", "AFXRIBBONBUTTON/CMFCRibbonButton::CMFCRibbonButton", "AFXRIBBONBUTTON/CMFCRibbonButton::AddSubItem", "AFXRIBBONBUTTON/CMFCRibbonButton::CanBeStretched", "AFXRIBBONBUTTON/CMFCRibbonButton::CleanUpSizes", "AFXRIBBONBUTTON/CMFCRibbonButton::ClosePopupMenu", "AFXRIBBONBUTTON/CMFCRibbonButton::DrawBottomText", "AFXRIBBONBUTTON/CMFCRibbonButton::DrawImage", "AFXRIBBONBUTTON/CMFCRibbonButton::DrawRibbonText", "AFXRIBBONBUTTON/CMFCRibbonButton::FindSubItemIndexByID", "AFXRIBBONBUTTON/CMFCRibbonButton::GetCommandRect", "AFXRIBBONBUTTON/CMFCRibbonButton::GetCompactSize", "AFXRIBBONBUTTON/CMFCRibbonButton::GetIcon", "AFXRIBBONBUTTON/CMFCRibbonButton::GetImageIndex", "AFXRIBBONBUTTON/CMFCRibbonButton::GetImageSize", "AFXRIBBONBUTTON/CMFCRibbonButton::GetIntermediateSize", "AFXRIBBONBUTTON/CMFCRibbonButton::GetMenu", "AFXRIBBONBUTTON/CMFCRibbonButton::GetMenuRect", "AFXRIBBONBUTTON/CMFCRibbonButton::GetRegularSize", "AFXRIBBONBUTTON/CMFCRibbonButton::GetSubItems", "AFXRIBBONBUTTON/CMFCRibbonButton::GetTextRowHeight", "AFXRIBBONBUTTON/CMFCRibbonButton::GetToolTipText", "AFXRIBBONBUTTON/CMFCRibbonButton::HasCompactMode", "AFXRIBBONBUTTON/CMFCRibbonButton::HasIntermediateMode", "AFXRIBBONBUTTON/CMFCRibbonButton::HasLargeMode", "AFXRIBBONBUTTON/CMFCRibbonButton::HasMenu", "AFXRIBBONBUTTON/CMFCRibbonButton::IsAlwaysDrawBorder", "AFXRIBBONBUTTON/CMFCRibbonButton::IsAlwaysLargeImage", "AFXRIBBONBUTTON/CMFCRibbonButton::IsApplicationButton", "AFXRIBBONBUTTON/CMFCRibbonButton::IsCommandAreaHighlighted", "AFXRIBBONBUTTON/CMFCRibbonButton::IsDefaultCommand", "AFXRIBBONBUTTON/CMFCRibbonButton::IsDefaultPanelButton", "AFXRIBBONBUTTON/CMFCRibbonButton::IsDrawTooltipImage", "AFXRIBBONBUTTON/CMFCRibbonButton::IsLargeImage", "AFXRIBBONBUTTON/CMFCRibbonButton::IsMenuAreaHighlighted", "AFXRIBBONBUTTON/CMFCRibbonButton::IsMenuOnBottom", "AFXRIBBONBUTTON/CMFCRibbonButton::IsPopupDefaultMenuLook", "AFXRIBBONBUTTON/CMFCRibbonButton::IsRightAlignMenu", "AFXRIBBONBUTTON/CMFCRibbonButton::IsSingleLineText", "AFXRIBBONBUTTON/CMFCRibbonButton::OnCalcTextSize", "AFXRIBBONBUTTON/CMFCRibbonButton::OnDrawBorder", "AFXRIBBONBUTTON/CMFCRibbonButton::OnDraw", "AFXRIBBONBUTTON/CMFCRibbonButton::OnFillBackground", "AFXRIBBONBUTTON/CMFCRibbonButton::RemoveAllSubItems", "AFXRIBBONBUTTON/CMFCRibbonButton::RemoveSubItem", "AFXRIBBONBUTTON/CMFCRibbonButton::SetACCData", "AFXRIBBONBUTTON/CMFCRibbonButton::SetAlwaysLargeImage", "AFXRIBBONBUTTON/CMFCRibbonButton::SetDefaultCommand", "AFXRIBBONBUTTON/CMFCRibbonButton::SetDescription", "AFXRIBBONBUTTON/CMFCRibbonButton::SetImageIndex", "AFXRIBBONBUTTON/CMFCRibbonButton::SetMenu", "AFXRIBBONBUTTON/CMFCRibbonButton::SetParentCategory", "AFXRIBBONBUTTON/CMFCRibbonButton::SetRightAlignMenu", "AFXRIBBONBUTTON/CMFCRibbonButton::SetText", "AFXRIBBONBUTTON/CMFCRibbonButton::OnClick"] helpviewer_keywords: ["CMFCRibbonButton [MFC], CMFCRibbonButton", "CMFCRibbonButton [MFC], AddSubItem", "CMFCRibbonButton [MFC], CanBeStretched", "CMFCRibbonButton [MFC], CleanUpSizes", "CMFCRibbonButton [MFC], ClosePopupMenu", "CMFCRibbonButton [MFC], DrawBottomText", "CMFCRibbonButton [MFC], DrawImage", "CMFCRibbonButton [MFC], DrawRibbonText", "CMFCRibbonButton [MFC], FindSubItemIndexByID", "CMFCRibbonButton [MFC], GetCommandRect", "CMFCRibbonButton [MFC], GetCompactSize", "CMFCRibbonButton [MFC], GetIcon", "CMFCRibbonButton [MFC], GetImageIndex", "CMFCRibbonButton [MFC], GetImageSize", "CMFCRibbonButton [MFC], GetIntermediateSize", "CMFCRibbonButton [MFC], GetMenu", "CMFCRibbonButton [MFC], GetMenuRect", "CMFCRibbonButton [MFC], GetRegularSize", "CMFCRibbonButton [MFC], GetSubItems", "CMFCRibbonButton [MFC], GetTextRowHeight", "CMFCRibbonButton [MFC], GetToolTipText", "CMFCRibbonButton [MFC], HasCompactMode", "CMFCRibbonButton [MFC], HasIntermediateMode", "CMFCRibbonButton [MFC], HasLargeMode", "CMFCRibbonButton [MFC], HasMenu", "CMFCRibbonButton [MFC], IsAlwaysDrawBorder", "CMFCRibbonButton [MFC], IsAlwaysLargeImage", "CMFCRibbonButton [MFC], IsApplicationButton", "CMFCRibbonButton [MFC], IsCommandAreaHighlighted", "CMFCRibbonButton [MFC], IsDefaultCommand", "CMFCRibbonButton [MFC], IsDefaultPanelButton", "CMFCRibbonButton [MFC], IsDrawTooltipImage", "CMFCRibbonButton [MFC], IsLargeImage", "CMFCRibbonButton [MFC], IsMenuAreaHighlighted", "CMFCRibbonButton [MFC], IsMenuOnBottom", "CMFCRibbonButton [MFC], IsPopupDefaultMenuLook", "CMFCRibbonButton [MFC], IsRightAlignMenu", "CMFCRibbonButton [MFC], IsSingleLineText", "CMFCRibbonButton [MFC], OnCalcTextSize", "CMFCRibbonButton [MFC], OnDrawBorder", "CMFCRibbonButton [MFC], OnDraw", "CMFCRibbonButton [MFC], OnFillBackground", "CMFCRibbonButton [MFC], RemoveAllSubItems", "CMFCRibbonButton [MFC], RemoveSubItem", "CMFCRibbonButton [MFC], SetACCData", "CMFCRibbonButton [MFC], SetAlwaysLargeImage", "CMFCRibbonButton [MFC], SetDefaultCommand", "CMFCRibbonButton [MFC], SetDescription", "CMFCRibbonButton [MFC], SetImageIndex", "CMFCRibbonButton [MFC], SetMenu", "CMFCRibbonButton [MFC], SetParentCategory", "CMFCRibbonButton [MFC], SetRightAlignMenu", "CMFCRibbonButton [MFC], SetText", "CMFCRibbonButton [MFC], OnClick"] -ms.assetid: 732e941c-9504-4b83-a691-d18075965d53 --- # CMFCRibbonButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonButton` class implements buttons that you can position on ribbon bar elements such as panels, Quick Access Toolbars, and pop-up menus. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcribbonbuttonsgroup-class.md b/docs/mfc/reference/cmfcribbonbuttonsgroup-class.md index 943d046aca0..969db73abad 100644 --- a/docs/mfc/reference/cmfcribbonbuttonsgroup-class.md +++ b/docs/mfc/reference/cmfcribbonbuttonsgroup-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonButtonsGroup Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonButtonsGroup", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::CMFCRibbonButtonsGroup", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::AddButton", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::AddButtons", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::GetButton", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::GetCount", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::GetImageSize", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::GetRegularSize", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::HasImages", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::OnDrawImage", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::RemoveAll", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::SetImages", "AFXRIBBONBUTTONSGROUP/CMFCRibbonButtonsGroup::SetParentCategory"] helpviewer_keywords: ["CMFCRibbonButtonsGroup [MFC], CMFCRibbonButtonsGroup", "CMFCRibbonButtonsGroup [MFC], AddButton", "CMFCRibbonButtonsGroup [MFC], AddButtons", "CMFCRibbonButtonsGroup [MFC], GetButton", "CMFCRibbonButtonsGroup [MFC], GetCount", "CMFCRibbonButtonsGroup [MFC], GetImageSize", "CMFCRibbonButtonsGroup [MFC], GetRegularSize", "CMFCRibbonButtonsGroup [MFC], HasImages", "CMFCRibbonButtonsGroup [MFC], OnDrawImage", "CMFCRibbonButtonsGroup [MFC], RemoveAll", "CMFCRibbonButtonsGroup [MFC], SetImages", "CMFCRibbonButtonsGroup [MFC], SetParentCategory"] -ms.assetid: b993d93e-fc1a-472f-a87f-1d7b7b499845 --- # CMFCRibbonButtonsGroup Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonButtonsGroup` class allows you to organize a set of ribbon buttons into a group. All buttons in the group are directly adjacent to each other horizontally and enclosed in a border. ## Syntax diff --git a/docs/mfc/reference/cmfcribboncategory-class.md b/docs/mfc/reference/cmfcribboncategory-class.md index c63b58d2c59..4cfdf0d8b3e 100644 --- a/docs/mfc/reference/cmfcribboncategory-class.md +++ b/docs/mfc/reference/cmfcribboncategory-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCRibbonCategory [MFC], CMFCRibbonCategory", "CMFCRibbo --- # CMFCRibbonCategory Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonCategory` class implements a ribbon tab that contains a group of [ribbon panels](../../mfc/reference/cmfcribbonpanel-class.md). ## Syntax diff --git a/docs/mfc/reference/cmfcribboncheckbox-class.md b/docs/mfc/reference/cmfcribboncheckbox-class.md index dd35d634409..33cb715bbba 100644 --- a/docs/mfc/reference/cmfcribboncheckbox-class.md +++ b/docs/mfc/reference/cmfcribboncheckbox-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCRibbonCheckBox [MFC], CMFCRibbonCheckBox", "CMFCRibbo --- # CMFCRibbonCheckBox Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonCheckBox` class implements a check box that you can add to a ribbon panel, Quick Access Toolbar, or popup menu. ## Syntax diff --git a/docs/mfc/reference/cmfcribboncolorbutton-class.md b/docs/mfc/reference/cmfcribboncolorbutton-class.md index 29ea27176bb..a450dd22d7e 100644 --- a/docs/mfc/reference/cmfcribboncolorbutton-class.md +++ b/docs/mfc/reference/cmfcribboncolorbutton-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonColorButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonColorButton", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::CMFCRibbonColorButton", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::AddColorsGroup", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::EnableAutomaticButton", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::EnableOtherButton", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::GetAutomaticColor", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::GetColor", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::GetColorBoxSize", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::GetColumns", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::GetHighlightedColor", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::RemoveAllColorGroups", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::SetColor", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::SetColorBoxSize", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::SetColorName", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::SetColumns", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::SetDocumentColors", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::SetPalette", "AFXRIBBONCOLORBUTTON/CMFCRibbonColorButton::UpdateColor"] helpviewer_keywords: ["CMFCRibbonColorButton [MFC], CMFCRibbonColorButton", "CMFCRibbonColorButton [MFC], AddColorsGroup", "CMFCRibbonColorButton [MFC], EnableAutomaticButton", "CMFCRibbonColorButton [MFC], EnableOtherButton", "CMFCRibbonColorButton [MFC], GetAutomaticColor", "CMFCRibbonColorButton [MFC], GetColor", "CMFCRibbonColorButton [MFC], GetColorBoxSize", "CMFCRibbonColorButton [MFC], GetColumns", "CMFCRibbonColorButton [MFC], GetHighlightedColor", "CMFCRibbonColorButton [MFC], RemoveAllColorGroups", "CMFCRibbonColorButton [MFC], SetColor", "CMFCRibbonColorButton [MFC], SetColorBoxSize", "CMFCRibbonColorButton [MFC], SetColorName", "CMFCRibbonColorButton [MFC], SetColumns", "CMFCRibbonColorButton [MFC], SetDocumentColors", "CMFCRibbonColorButton [MFC], SetPalette", "CMFCRibbonColorButton [MFC], UpdateColor"] -ms.assetid: 6b4b4ee3-8cc0-41b4-a4eb-93e8847008e1 --- # CMFCRibbonColorButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonColorButton` class implements a color button that you can add to a ribbon bar. The ribbon color button displays a drop-down menu that contains one or more color palettes. ## Syntax diff --git a/docs/mfc/reference/cmfcribboncombobox-class.md b/docs/mfc/reference/cmfcribboncombobox-class.md index 8c68550f07e..39b79bd3263 100644 --- a/docs/mfc/reference/cmfcribboncombobox-class.md +++ b/docs/mfc/reference/cmfcribboncombobox-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCRibbonComboBox [MFC], CMFCRibbonComboBox", "CMFCRibbo --- # CMFCRibbonComboBox Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonComboBox` class implements a combo box control that you can add to a ribbon bar, a ribbon panel, or a ribbon popup menu. ## Syntax diff --git a/docs/mfc/reference/cmfcribboncontextcaption-class.md b/docs/mfc/reference/cmfcribboncontextcaption-class.md index ce8c6bd89a9..a066c0981fd 100644 --- a/docs/mfc/reference/cmfcribboncontextcaption-class.md +++ b/docs/mfc/reference/cmfcribboncontextcaption-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonContextCaption Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonContextCaption", "AFXRIBBONBAR/CMFCRibbonContextCaption", "AFXRIBBONBAR/CMFCRibbonContextCaption::GetColor", "AFXRIBBONBAR/CMFCRibbonContextCaption::GetRightTabX"] helpviewer_keywords: ["CMFCRibbonContextCaption [MFC], GetColor", "CMFCRibbonContextCaption [MFC], GetRightTabX"] -ms.assetid: cce2c0a2-8370-4266-997e-f8d0eeb3d616 --- # CMFCRibbonContextCaption Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a colored caption that appears at the top of a ribbon category or a context category. ## Syntax diff --git a/docs/mfc/reference/cmfcribboncustomizedialog-class.md b/docs/mfc/reference/cmfcribboncustomizedialog-class.md index f465c917d41..dde0bf3da9d 100644 --- a/docs/mfc/reference/cmfcribboncustomizedialog-class.md +++ b/docs/mfc/reference/cmfcribboncustomizedialog-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonCustomizeDialog Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonCustomizeDialog", "AFXRIBBONCUSTOMIZEDIALOG/CMFCRibbonCustomizeDialog", "AFXRIBBONCUSTOMIZEDIALOG/CMFCRibbonCustomizeDialog::CMFCRibbonCustomizeDialog"] helpviewer_keywords: ["CMFCRibbonCustomizeDialog [MFC], CMFCRibbonCustomizeDialog"] -ms.assetid: ce67de7f-5eaa-4c75-9b94-f290f36df073 --- # CMFCRibbonCustomizeDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Displays the ribbon **Customize** page. ## Syntax diff --git a/docs/mfc/reference/cmfcribboncustomizepropertypage-class.md b/docs/mfc/reference/cmfcribboncustomizepropertypage-class.md index 1580c5a1aa3..47791413a83 100644 --- a/docs/mfc/reference/cmfcribboncustomizepropertypage-class.md +++ b/docs/mfc/reference/cmfcribboncustomizepropertypage-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonCustomizePropertyPage Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonCustomizePropertyPage", "AFXRIBBONCUSTOMIZEDIALOG/CMFCRibbonCustomizePropertyPage", "AFXRIBBONCUSTOMIZEDIALOG/CMFCRibbonCustomizePropertyPage::CMFCRibbonCustomizePropertyPage", "AFXRIBBONCUSTOMIZEDIALOG/CMFCRibbonCustomizePropertyPage::AddCustomCategory", "AFXRIBBONCUSTOMIZEDIALOG/CMFCRibbonCustomizePropertyPage::OnOK"] helpviewer_keywords: ["CMFCRibbonCustomizePropertyPage [MFC], CMFCRibbonCustomizePropertyPage", "CMFCRibbonCustomizePropertyPage [MFC], AddCustomCategory", "CMFCRibbonCustomizePropertyPage [MFC], OnOK"] -ms.assetid: ea32a99a-dfbe-401e-8975-aa191552532f --- # CMFCRibbonCustomizePropertyPage Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a custom page for the **Customize** dialog box in Ribbon-based applications. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonedit-class.md b/docs/mfc/reference/cmfcribbonedit-class.md index d27304b45d2..6e6bd2a3279 100644 --- a/docs/mfc/reference/cmfcribbonedit-class.md +++ b/docs/mfc/reference/cmfcribbonedit-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonEdit Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonEdit", "AFXRIBBONEDIT/CMFCRibbonEdit", "AFXRIBBONEDIT/CMFCRibbonEdit::CMFCRibbonEdit", "AFXRIBBONEDIT/CMFCRibbonEdit::CanBeStretched", "AFXRIBBONEDIT/CMFCRibbonEdit::CopyFrom", "AFXRIBBONEDIT/CMFCRibbonEdit::CreateEdit", "AFXRIBBONEDIT/CMFCRibbonEdit::DestroyCtrl", "AFXRIBBONEDIT/CMFCRibbonEdit::DropDownList", "AFXRIBBONEDIT/CMFCRibbonEdit::EnableSpinButtons", "AFXRIBBONEDIT/CMFCRibbonEdit::GetCompactSize", "AFXRIBBONEDIT/CMFCRibbonEdit::GetEditText", "AFXRIBBONEDIT/CMFCRibbonEdit::GetIntermediateSize", "AFXRIBBONEDIT/CMFCRibbonEdit::GetTextAlign", "AFXRIBBONEDIT/CMFCRibbonEdit::GetWidth", "AFXRIBBONEDIT/CMFCRibbonEdit::HasCompactMode", "AFXRIBBONEDIT/CMFCRibbonEdit::HasFocus", "AFXRIBBONEDIT/CMFCRibbonEdit::HasLargeMode", "AFXRIBBONEDIT/CMFCRibbonEdit::HasSpinButtons", "AFXRIBBONEDIT/CMFCRibbonEdit::IsHighlighted", "AFXRIBBONEDIT/CMFCRibbonEdit::OnAfterChangeRect", "AFXRIBBONEDIT/CMFCRibbonEdit::OnDraw", "AFXRIBBONEDIT/CMFCRibbonEdit::OnDrawLabelAndImage", "AFXRIBBONEDIT/CMFCRibbonEdit::OnDrawOnList", "AFXRIBBONEDIT/CMFCRibbonEdit::OnEnable", "AFXRIBBONEDIT/CMFCRibbonEdit::OnHighlight", "AFXRIBBONEDIT/CMFCRibbonEdit::OnKey", "AFXRIBBONEDIT/CMFCRibbonEdit::OnLButtonDown", "AFXRIBBONEDIT/CMFCRibbonEdit::OnLButtonUp", "AFXRIBBONEDIT/CMFCRibbonEdit::OnRTLChanged", "AFXRIBBONEDIT/CMFCRibbonEdit::OnShow", "AFXRIBBONEDIT/CMFCRibbonEdit::Redraw", "AFXRIBBONEDIT/CMFCRibbonEdit::SetACCData", "AFXRIBBONEDIT/CMFCRibbonEdit::SetEditText", "AFXRIBBONEDIT/CMFCRibbonEdit::SetTextAlign", "AFXRIBBONEDIT/CMFCRibbonEdit::SetWidth"] helpviewer_keywords: ["CMFCRibbonEdit [MFC], CMFCRibbonEdit", "CMFCRibbonEdit [MFC], CanBeStretched", "CMFCRibbonEdit [MFC], CMFCRibbonEdit", "CMFCRibbonEdit [MFC], CopyFrom", "CMFCRibbonEdit [MFC], CreateEdit", "CMFCRibbonEdit [MFC], DestroyCtrl", "CMFCRibbonEdit [MFC], DropDownList", "CMFCRibbonEdit [MFC], EnableSpinButtons", "CMFCRibbonEdit [MFC], GetCompactSize", "CMFCRibbonEdit [MFC], GetEditText", "CMFCRibbonEdit [MFC], GetIntermediateSize", "CMFCRibbonEdit [MFC], GetTextAlign", "CMFCRibbonEdit [MFC], GetWidth", "CMFCRibbonEdit [MFC], HasCompactMode", "CMFCRibbonEdit [MFC], HasFocus", "CMFCRibbonEdit [MFC], HasLargeMode", "CMFCRibbonEdit [MFC], HasSpinButtons", "CMFCRibbonEdit [MFC], IsHighlighted", "CMFCRibbonEdit [MFC], OnAfterChangeRect", "CMFCRibbonEdit [MFC], OnDraw", "CMFCRibbonEdit [MFC], OnDrawLabelAndImage", "CMFCRibbonEdit [MFC], OnDrawOnList", "CMFCRibbonEdit [MFC], OnEnable", "CMFCRibbonEdit [MFC], OnHighlight", "CMFCRibbonEdit [MFC], OnKey", "CMFCRibbonEdit [MFC], OnLButtonDown", "CMFCRibbonEdit [MFC], OnLButtonUp", "CMFCRibbonEdit [MFC], OnRTLChanged", "CMFCRibbonEdit [MFC], OnShow", "CMFCRibbonEdit [MFC], Redraw", "CMFCRibbonEdit [MFC], SetACCData", "CMFCRibbonEdit [MFC], SetEditText", "CMFCRibbonEdit [MFC], SetTextAlign", "CMFCRibbonEdit [MFC], SetWidth"] -ms.assetid: 9b85f1f2-446b-454e-9af9-104fdad8a897 --- # CMFCRibbonEdit Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements an edit control that is located on a ribbon bar. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonfontcombobox-class.md b/docs/mfc/reference/cmfcribbonfontcombobox-class.md index e37df6dfc0c..ac472185acb 100644 --- a/docs/mfc/reference/cmfcribbonfontcombobox-class.md +++ b/docs/mfc/reference/cmfcribbonfontcombobox-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCRibbonFontComboBox [MFC], CMFCRibbonFontComboBox", "C --- # CMFCRibbonFontComboBox Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a combo box that contains a list of fonts. You place the combo box on a ribbon panel. ## Syntax diff --git a/docs/mfc/reference/cmfcribbongallery-class.md b/docs/mfc/reference/cmfcribbongallery-class.md index 38ba418a4ea..097256031c0 100644 --- a/docs/mfc/reference/cmfcribbongallery-class.md +++ b/docs/mfc/reference/cmfcribbongallery-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonGallery Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonGallery", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::CMFCRibbonGallery", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::AddGroup", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::AddSubItem", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::Clear", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::EnableMenuResize", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::EnableMenuSideBar", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::GetCompactSize", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::GetDroppedDown", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::GetGroupName", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::GetGroupOffset", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::GetIconsInRow", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::GetItemToolTip", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::GetLastSelectedItem", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::GetPaletteID", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::GetRegularSize", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::GetSelectedItem", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::HasMenu", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::IsButtonMode", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::IsMenuResizeEnabled", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::IsMenuResizeVertical", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::IsMenuSideBar", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::OnAfterChangeRect", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::OnDraw", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::OnEnable", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::OnRTLChanged", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::RedrawIcons", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::RemoveItemToolTips", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::SelectItem", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::SetACCData", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::SetButtonMode", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::SetGroupName", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::SetIconsInRow", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::SetItemToolTip", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::SetPalette", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::SetPaletteID", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGallery::OnDrawPaletteIcon"] helpviewer_keywords: ["CMFCRibbonGallery [MFC], CMFCRibbonGallery", "CMFCRibbonGallery [MFC], AddGroup", "CMFCRibbonGallery [MFC], AddSubItem", "CMFCRibbonGallery [MFC], Clear", "CMFCRibbonGallery [MFC], EnableMenuResize", "CMFCRibbonGallery [MFC], EnableMenuSideBar", "CMFCRibbonGallery [MFC], GetCompactSize", "CMFCRibbonGallery [MFC], GetDroppedDown", "CMFCRibbonGallery [MFC], GetGroupName", "CMFCRibbonGallery [MFC], GetGroupOffset", "CMFCRibbonGallery [MFC], GetIconsInRow", "CMFCRibbonGallery [MFC], GetItemToolTip", "CMFCRibbonGallery [MFC], GetLastSelectedItem", "CMFCRibbonGallery [MFC], GetPaletteID", "CMFCRibbonGallery [MFC], GetRegularSize", "CMFCRibbonGallery [MFC], GetSelectedItem", "CMFCRibbonGallery [MFC], HasMenu", "CMFCRibbonGallery [MFC], IsButtonMode", "CMFCRibbonGallery [MFC], IsMenuResizeEnabled", "CMFCRibbonGallery [MFC], IsMenuResizeVertical", "CMFCRibbonGallery [MFC], IsMenuSideBar", "CMFCRibbonGallery [MFC], OnAfterChangeRect", "CMFCRibbonGallery [MFC], OnDraw", "CMFCRibbonGallery [MFC], OnEnable", "CMFCRibbonGallery [MFC], OnRTLChanged", "CMFCRibbonGallery [MFC], RedrawIcons", "CMFCRibbonGallery [MFC], RemoveItemToolTips", "CMFCRibbonGallery [MFC], SelectItem", "CMFCRibbonGallery [MFC], SetACCData", "CMFCRibbonGallery [MFC], SetButtonMode", "CMFCRibbonGallery [MFC], SetGroupName", "CMFCRibbonGallery [MFC], SetIconsInRow", "CMFCRibbonGallery [MFC], SetItemToolTip", "CMFCRibbonGallery [MFC], SetPalette", "CMFCRibbonGallery [MFC], SetPaletteID", "CMFCRibbonGallery [MFC], OnDrawPaletteIcon"] -ms.assetid: 9734c9c9-981c-4b3f-8c59-264fd41811b4 --- # CMFCRibbonGallery Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements Office 2007-style ribbon galleries. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcribbongallerymenubutton-class.md b/docs/mfc/reference/cmfcribbongallerymenubutton-class.md index 675fee0b139..34d3bb3d3a3 100644 --- a/docs/mfc/reference/cmfcribbongallerymenubutton-class.md +++ b/docs/mfc/reference/cmfcribbongallerymenubutton-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonGalleryMenuButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonGalleryMenuButton", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGalleryMenuButton", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGalleryMenuButton::CMFCRibbonGalleryMenuButton", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGalleryMenuButton::CopyFrom", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGalleryMenuButton::CreatePopupMenu", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGalleryMenuButton::GetPalette", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGalleryMenuButton::HasButton", "AFXRIBBONPALETTEGALLERY/CMFCRibbonGalleryMenuButton::IsEmptyMenuAllowed"] helpviewer_keywords: ["CMFCRibbonGalleryMenuButton [MFC], CMFCRibbonGalleryMenuButton", "CMFCRibbonGalleryMenuButton [MFC], CopyFrom", "CMFCRibbonGalleryMenuButton [MFC], CreatePopupMenu", "CMFCRibbonGalleryMenuButton [MFC], GetPalette", "CMFCRibbonGalleryMenuButton [MFC], HasButton", "CMFCRibbonGalleryMenuButton [MFC], IsEmptyMenuAllowed"] -ms.assetid: 4d459d9b-8b1a-4371-92f6-dc4ce6cc42c8 --- # CMFCRibbonGalleryMenuButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a ribbon menu button that contains ribbon galleries. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcribbonlabel-class.md b/docs/mfc/reference/cmfcribbonlabel-class.md index 9b505588b3d..da97ff30008 100644 --- a/docs/mfc/reference/cmfcribbonlabel-class.md +++ b/docs/mfc/reference/cmfcribbonlabel-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonLabel Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonLabel", "AFXRIBBONLABEL/CMFCRibbonLabel", "AFXRIBBONLABEL/CMFCRibbonLabel::CMFCRibbonLabel", "AFXRIBBONLABEL/CMFCRibbonLabel::SetACCData"] helpviewer_keywords: ["CMFCRibbonLabel [MFC], CMFCRibbonLabel", "CMFCRibbonLabel [MFC], SetACCData"] -ms.assetid: 0346c891-83bf-4f20-b8a1-c84cf2aadced --- # CMFCRibbonLabel Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a non-clickable text label for a ribbon. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonlinkctrl-class.md b/docs/mfc/reference/cmfcribbonlinkctrl-class.md index 1eaa093ba6f..6ac99272c06 100644 --- a/docs/mfc/reference/cmfcribbonlinkctrl-class.md +++ b/docs/mfc/reference/cmfcribbonlinkctrl-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonLinkCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonLinkCtrl", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::CMFCRibbonLinkCtrl", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::CopyFrom", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::GetCompactSize", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::GetLink", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::GetRegularSize", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::GetToolTipText", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::IsDrawTooltipImage", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::OnDraw", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::OnDrawMenuImage", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::OnMouseMove", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::OnSetIcon", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::OpenLink", "AFXRIBBONLINKCTRL/CMFCRibbonLinkCtrl::SetLink"] helpviewer_keywords: ["CMFCRibbonLinkCtrl [MFC], CMFCRibbonLinkCtrl", "CMFCRibbonLinkCtrl [MFC], CopyFrom", "CMFCRibbonLinkCtrl [MFC], GetCompactSize", "CMFCRibbonLinkCtrl [MFC], GetLink", "CMFCRibbonLinkCtrl [MFC], GetRegularSize", "CMFCRibbonLinkCtrl [MFC], GetToolTipText", "CMFCRibbonLinkCtrl [MFC], IsDrawTooltipImage", "CMFCRibbonLinkCtrl [MFC], OnDraw", "CMFCRibbonLinkCtrl [MFC], OnDrawMenuImage", "CMFCRibbonLinkCtrl [MFC], OnMouseMove", "CMFCRibbonLinkCtrl [MFC], OnSetIcon", "CMFCRibbonLinkCtrl [MFC], OpenLink", "CMFCRibbonLinkCtrl [MFC], SetLink"] -ms.assetid: 77ae1941-e0ab-4a9d-911e-1752d34c079b --- # CMFCRibbonLinkCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a hyperlink that is positioned on a ribbon. The hyperlink opens a Web page when you click it. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcribbonmainpanel-class.md b/docs/mfc/reference/cmfcribbonmainpanel-class.md index 622b1ecf24f..c97388bfaff 100644 --- a/docs/mfc/reference/cmfcribbonmainpanel-class.md +++ b/docs/mfc/reference/cmfcribbonmainpanel-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonMainPanel Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonMainPanel", "AFXRIBBONMAINPANEL/CMFCRibbonMainPanel", "AFXRIBBONMAINPANEL/CMFCRibbonMainPanel::Add", "AFXRIBBONMAINPANEL/CMFCRibbonMainPanel::AddRecentFilesList", "AFXRIBBONMAINPANEL/CMFCRibbonMainPanel::AddToBottom", "AFXRIBBONMAINPANEL/CMFCRibbonMainPanel::AddToRight", "AFXRIBBONMAINPANEL/CMFCRibbonMainPanel::GetCommandsFrame"] helpviewer_keywords: ["CMFCRibbonMainPanel [MFC], Add", "CMFCRibbonMainPanel [MFC], AddRecentFilesList", "CMFCRibbonMainPanel [MFC], AddToBottom", "CMFCRibbonMainPanel [MFC], AddToRight", "CMFCRibbonMainPanel [MFC], GetCommandsFrame"] -ms.assetid: 1af78798-5e75-4365-9c81-a54aa5679602 --- # CMFCRibbonMainPanel Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a ribbon panel that displays when you click the [CMFCRibbonApplicationButton](../../mfc/reference/cmfcribbonapplicationbutton-class.md). ## Syntax diff --git a/docs/mfc/reference/cmfcribbonminitoolbar-class.md b/docs/mfc/reference/cmfcribbonminitoolbar-class.md index 2cde2d313e5..07b6def8703 100644 --- a/docs/mfc/reference/cmfcribbonminitoolbar-class.md +++ b/docs/mfc/reference/cmfcribbonminitoolbar-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonMiniToolBar Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonMiniToolBar", "AFXRIBBONMINITOOLBAR/CMFCRibbonMiniToolBar", "AFXRIBBONMINITOOLBAR/CMFCRibbonMiniToolBar::IsContextMenuMode", "AFXRIBBONMINITOOLBAR/CMFCRibbonMiniToolBar::IsRibbonMiniToolBar", "AFXRIBBONMINITOOLBAR/CMFCRibbonMiniToolBar::SetCommands", "AFXRIBBONMINITOOLBAR/CMFCRibbonMiniToolBar::Show", "AFXRIBBONMINITOOLBAR/CMFCRibbonMiniToolBar::ShowWithContextMenu"] helpviewer_keywords: ["CMFCRibbonMiniToolBar [MFC], IsContextMenuMode", "CMFCRibbonMiniToolBar [MFC], IsRibbonMiniToolBar", "CMFCRibbonMiniToolBar [MFC], SetCommands", "CMFCRibbonMiniToolBar [MFC], Show", "CMFCRibbonMiniToolBar [MFC], ShowWithContextMenu"] -ms.assetid: 7017e963-aeaf-4fe9-b540-e15a7ed41e94 --- # CMFCRibbonMiniToolBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a contextual popup toolbar. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonpanel-class.md b/docs/mfc/reference/cmfcribbonpanel-class.md index 2a81fe3a7a0..bbacccf348a 100644 --- a/docs/mfc/reference/cmfcribbonpanel-class.md +++ b/docs/mfc/reference/cmfcribbonpanel-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonPanel Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonPanel", "AFXRIBBONPANEL/CMFCRibbonPanel", "AFXRIBBONPANEL/CMFCRibbonPanel::CMFCRibbonPanel", "AFXRIBBONPANEL/CMFCRibbonPanel::Add", "AFXRIBBONPANEL/CMFCRibbonPanel::AddSeparator", "AFXRIBBONPANEL/CMFCRibbonPanel::AddToolBar", "AFXRIBBONPANEL/CMFCRibbonPanel::FindByData", "AFXRIBBONPANEL/CMFCRibbonPanel::FindByID", "AFXRIBBONPANEL/CMFCRibbonPanel::GetCaptionHeight", "AFXRIBBONPANEL/CMFCRibbonPanel::GetCount", "AFXRIBBONPANEL/CMFCRibbonPanel::GetData", "AFXRIBBONPANEL/CMFCRibbonPanel::GetDefaultButton", "AFXRIBBONPANEL/CMFCRibbonPanel::GetDroppedDown", "AFXRIBBONPANEL/CMFCRibbonPanel::GetElement", "AFXRIBBONPANEL/CMFCRibbonPanel::GetElements", "AFXRIBBONPANEL/CMFCRibbonPanel::GetElementsByID", "AFXRIBBONPANEL/CMFCRibbonPanel::GetFocused", "AFXRIBBONPANEL/CMFCRibbonPanel::GetGalleryRect", "AFXRIBBONPANEL/CMFCRibbonPanel::GetHighlighted", "AFXRIBBONPANEL/CMFCRibbonPanel::GetIndex", "AFXRIBBONPANEL/CMFCRibbonPanel::GetItemIDsList", "AFXRIBBONPANEL/CMFCRibbonPanel::GetName", "AFXRIBBONPANEL/CMFCRibbonPanel::GetParentButton", "AFXRIBBONPANEL/CMFCRibbonPanel::GetParentCategory", "AFXRIBBONPANEL/CMFCRibbonPanel::GetParentMenuBar", "AFXRIBBONPANEL/CMFCRibbonPanel::GetPreferedMenuLocation", "AFXRIBBONPANEL/CMFCRibbonPanel::GetPressed", "AFXRIBBONPANEL/CMFCRibbonPanel::GetRect", "AFXRIBBONPANEL/CMFCRibbonPanel::GetVisibleElements", "AFXRIBBONPANEL/CMFCRibbonPanel::HasElement", "AFXRIBBONPANEL/CMFCRibbonPanel::HitTest", "AFXRIBBONPANEL/CMFCRibbonPanel::HitTestEx", "AFXRIBBONPANEL/CMFCRibbonPanel::Insert", "AFXRIBBONPANEL/CMFCRibbonPanel::InsertSeparator", "AFXRIBBONPANEL/CMFCRibbonPanel::IsCenterColumnVert", "AFXRIBBONPANEL/CMFCRibbonPanel::IsCollapsed", "AFXRIBBONPANEL/CMFCRibbonPanel::IsHighlighted", "AFXRIBBONPANEL/CMFCRibbonPanel::IsJustifyColumns", "AFXRIBBONPANEL/CMFCRibbonPanel::IsMainPanel", "AFXRIBBONPANEL/CMFCRibbonPanel::IsMenuMode", "AFXRIBBONPANEL/CMFCRibbonPanel::MakeGalleryItemVisible", "AFXRIBBONPANEL/CMFCRibbonPanel::OnKey", "AFXRIBBONPANEL/CMFCRibbonPanel::RecalcWidths", "AFXRIBBONPANEL/CMFCRibbonPanel::Remove", "AFXRIBBONPANEL/CMFCRibbonPanel::RemoveAll", "AFXRIBBONPANEL/CMFCRibbonPanel::Replace", "AFXRIBBONPANEL/CMFCRibbonPanel::ReplaceByID", "AFXRIBBONPANEL/CMFCRibbonPanel::SetCenterColumnVert", "AFXRIBBONPANEL/CMFCRibbonPanel::SetData", "AFXRIBBONPANEL/CMFCRibbonPanel::SetElementMenu", "AFXRIBBONPANEL/CMFCRibbonPanel::SetElementRTC", "AFXRIBBONPANEL/CMFCRibbonPanel::SetElementRTCByID", "AFXRIBBONPANEL/CMFCRibbonPanel::SetFocused", "AFXRIBBONPANEL/CMFCRibbonPanel::SetJustifyColumns", "AFXRIBBONPANEL/CMFCRibbonPanel::SetKeys", "AFXRIBBONPANEL/CMFCRibbonPanel::ShowPopup"] helpviewer_keywords: ["CMFCRibbonPanel [MFC], CMFCRibbonPanel", "CMFCRibbonPanel [MFC], Add", "CMFCRibbonPanel [MFC], AddSeparator", "CMFCRibbonPanel [MFC], AddToolBar", "CMFCRibbonPanel [MFC], FindByData", "CMFCRibbonPanel [MFC], FindByID", "CMFCRibbonPanel [MFC], GetCaptionHeight", "CMFCRibbonPanel [MFC], GetCount", "CMFCRibbonPanel [MFC], GetData", "CMFCRibbonPanel [MFC], GetDefaultButton", "CMFCRibbonPanel [MFC], GetDroppedDown", "CMFCRibbonPanel [MFC], GetElement", "CMFCRibbonPanel [MFC], GetElements", "CMFCRibbonPanel [MFC], GetElementsByID", "CMFCRibbonPanel [MFC], GetFocused", "CMFCRibbonPanel [MFC], GetGalleryRect", "CMFCRibbonPanel [MFC], GetHighlighted", "CMFCRibbonPanel [MFC], GetIndex", "CMFCRibbonPanel [MFC], GetItemIDsList", "CMFCRibbonPanel [MFC], GetName", "CMFCRibbonPanel [MFC], GetParentButton", "CMFCRibbonPanel [MFC], GetParentCategory", "CMFCRibbonPanel [MFC], GetParentMenuBar", "CMFCRibbonPanel [MFC], GetPreferedMenuLocation", "CMFCRibbonPanel [MFC], GetPressed", "CMFCRibbonPanel [MFC], GetRect", "CMFCRibbonPanel [MFC], GetVisibleElements", "CMFCRibbonPanel [MFC], HasElement", "CMFCRibbonPanel [MFC], HitTest", "CMFCRibbonPanel [MFC], HitTestEx", "CMFCRibbonPanel [MFC], Insert", "CMFCRibbonPanel [MFC], InsertSeparator", "CMFCRibbonPanel [MFC], IsCenterColumnVert", "CMFCRibbonPanel [MFC], IsCollapsed", "CMFCRibbonPanel [MFC], IsHighlighted", "CMFCRibbonPanel [MFC], IsJustifyColumns", "CMFCRibbonPanel [MFC], IsMainPanel", "CMFCRibbonPanel [MFC], IsMenuMode", "CMFCRibbonPanel [MFC], MakeGalleryItemVisible", "CMFCRibbonPanel [MFC], OnKey", "CMFCRibbonPanel [MFC], RecalcWidths", "CMFCRibbonPanel [MFC], Remove", "CMFCRibbonPanel [MFC], RemoveAll", "CMFCRibbonPanel [MFC], Replace", "CMFCRibbonPanel [MFC], ReplaceByID", "CMFCRibbonPanel [MFC], SetCenterColumnVert", "CMFCRibbonPanel [MFC], SetData", "CMFCRibbonPanel [MFC], SetElementMenu", "CMFCRibbonPanel [MFC], SetElementRTC", "CMFCRibbonPanel [MFC], SetElementRTCByID", "CMFCRibbonPanel [MFC], SetFocused", "CMFCRibbonPanel [MFC], SetJustifyColumns", "CMFCRibbonPanel [MFC], SetKeys", "CMFCRibbonPanel [MFC], ShowPopup"] -ms.assetid: 51d70749-1140-4386-b103-f14082049ba6 --- # CMFCRibbonPanel Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a panel that contains a set of ribbon elements. When the panel is drawn, it displays as many elements as possible, given the size of the panel. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcribbonprogressbar-class.md b/docs/mfc/reference/cmfcribbonprogressbar-class.md index 5155a822f97..67c5ff15ff7 100644 --- a/docs/mfc/reference/cmfcribbonprogressbar-class.md +++ b/docs/mfc/reference/cmfcribbonprogressbar-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonProgressBar Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonProgressBar", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar::CMFCRibbonProgressBar", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar::GetPos", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar::GetRangeMax", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar::GetRangeMin", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar::GetRegularSize", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar::IsInfiniteMode", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar::OnDraw", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar::SetInfiniteMode", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar::SetPos", "AFXRIBBONPROGRESSBAR/CMFCRibbonProgressBar::SetRange"] helpviewer_keywords: ["CMFCRibbonProgressBar [MFC], CMFCRibbonProgressBar", "CMFCRibbonProgressBar [MFC], GetPos", "CMFCRibbonProgressBar [MFC], GetRangeMax", "CMFCRibbonProgressBar [MFC], GetRangeMin", "CMFCRibbonProgressBar [MFC], GetRegularSize", "CMFCRibbonProgressBar [MFC], IsInfiniteMode", "CMFCRibbonProgressBar [MFC], OnDraw", "CMFCRibbonProgressBar [MFC], SetInfiniteMode", "CMFCRibbonProgressBar [MFC], SetPos", "CMFCRibbonProgressBar [MFC], SetRange"] -ms.assetid: de3d9f2e-ed59-480e-aa7d-08a33ab36c67 --- # CMFCRibbonProgressBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a control that visually indicates the progress of a lengthy operation. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonquickaccesstoolbardefaultstate-class.md b/docs/mfc/reference/cmfcribbonquickaccesstoolbardefaultstate-class.md index 7065867788b..0357f3a8f14 100644 --- a/docs/mfc/reference/cmfcribbonquickaccesstoolbardefaultstate-class.md +++ b/docs/mfc/reference/cmfcribbonquickaccesstoolbardefaultstate-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonQuickAccessToolBarDefaultState Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonQuickAccessToolBarDefaultState", "AFXRIBBONQUICKACCESSTOOLBAR/CMFCRibbonQuickAccessToolBarDefaultState", "AFXRIBBONQUICKACCESSTOOLBAR/CMFCRibbonQuickAccessToolBarDefaultState::CMFCRibbonQuickAccessToolBarDefaultState", "AFXRIBBONQUICKACCESSTOOLBAR/CMFCRibbonQuickAccessToolBarDefaultState::AddCommand", "AFXRIBBONQUICKACCESSTOOLBAR/CMFCRibbonQuickAccessToolBarDefaultState::CopyFrom", "AFXRIBBONQUICKACCESSTOOLBAR/CMFCRibbonQuickAccessToolBarDefaultState::RemoveAll"] helpviewer_keywords: ["CMFCRibbonQuickAccessToolBarDefaultState [MFC], CMFCRibbonQuickAccessToolBarDefaultState", "CMFCRibbonQuickAccessToolBarDefaultState [MFC], AddCommand", "CMFCRibbonQuickAccessToolBarDefaultState [MFC], CopyFrom", "CMFCRibbonQuickAccessToolBarDefaultState [MFC], RemoveAll"] -ms.assetid: eca99200-b87b-47ba-b2e8-2f3f2444b176 --- # `CMFCRibbonQuickAccessToolBarDefaultState` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A helper class that manages default state for the Quick Access Toolbar that is positioned on the ribbon bar ([`CMFCRibbonBar` Class](../../mfc/reference/cmfcribbonbar-class.md)). ## Syntax diff --git a/docs/mfc/reference/cmfcribbonseparator-class.md b/docs/mfc/reference/cmfcribbonseparator-class.md index 83e9ba528dc..e4839b50c9d 100644 --- a/docs/mfc/reference/cmfcribbonseparator-class.md +++ b/docs/mfc/reference/cmfcribbonseparator-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonSeparator Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonSeparator", "AFXBASERIBBONELEMENT/CMFCRibbonSeparator", "AFXBASERIBBONELEMENT/CMFCRibbonSeparator::CMFCRibbonSeparator", "AFXBASERIBBONELEMENT/CMFCRibbonSeparator::AddToListBox", "AFXBASERIBBONELEMENT/CMFCRibbonSeparator::CopyFrom", "AFXBASERIBBONELEMENT/CMFCRibbonSeparator::GetRegularSize", "AFXBASERIBBONELEMENT/CMFCRibbonSeparator::IsSeparator", "AFXBASERIBBONELEMENT/CMFCRibbonSeparator::IsTabStop", "AFXBASERIBBONELEMENT/CMFCRibbonSeparator::OnDraw", "AFXBASERIBBONELEMENT/CMFCRibbonSeparator::OnDrawOnList"] helpviewer_keywords: ["CMFCRibbonSeparator [MFC], CMFCRibbonSeparator", "CMFCRibbonSeparator [MFC], AddToListBox", "CMFCRibbonSeparator [MFC], CopyFrom", "CMFCRibbonSeparator [MFC], GetRegularSize", "CMFCRibbonSeparator [MFC], IsSeparator", "CMFCRibbonSeparator [MFC], IsTabStop", "CMFCRibbonSeparator [MFC], OnDraw", "CMFCRibbonSeparator [MFC], OnDrawOnList"] -ms.assetid: bedb1a53-cb07-4c3c-be12-698c5409e7cf --- # CMFCRibbonSeparator Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the ribbon separator. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonslider-class.md b/docs/mfc/reference/cmfcribbonslider-class.md index d0930642854..52069775539 100644 --- a/docs/mfc/reference/cmfcribbonslider-class.md +++ b/docs/mfc/reference/cmfcribbonslider-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonSlider Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonSlider", "AFXRIBBONSLIDER/CMFCRibbonSlider", "AFXRIBBONSLIDER/CMFCRibbonSlider::CMFCRibbonSlider", "AFXRIBBONSLIDER/CMFCRibbonSlider::GetPos", "AFXRIBBONSLIDER/CMFCRibbonSlider::GetRangeMax", "AFXRIBBONSLIDER/CMFCRibbonSlider::GetRangeMin", "AFXRIBBONSLIDER/CMFCRibbonSlider::GetRegularSize", "AFXRIBBONSLIDER/CMFCRibbonSlider::GetZoomIncrement", "AFXRIBBONSLIDER/CMFCRibbonSlider::HasZoomButtons", "AFXRIBBONSLIDER/CMFCRibbonSlider::OnDraw", "AFXRIBBONSLIDER/CMFCRibbonSlider::SetPos", "AFXRIBBONSLIDER/CMFCRibbonSlider::SetRange", "AFXRIBBONSLIDER/CMFCRibbonSlider::SetZoomButtons", "AFXRIBBONSLIDER/CMFCRibbonSlider::SetZoomIncrement"] helpviewer_keywords: ["CMFCRibbonSlider [MFC], CMFCRibbonSlider", "CMFCRibbonSlider [MFC], GetPos", "CMFCRibbonSlider [MFC], GetRangeMax", "CMFCRibbonSlider [MFC], GetRangeMin", "CMFCRibbonSlider [MFC], GetRegularSize", "CMFCRibbonSlider [MFC], GetZoomIncrement", "CMFCRibbonSlider [MFC], HasZoomButtons", "CMFCRibbonSlider [MFC], OnDraw", "CMFCRibbonSlider [MFC], SetPos", "CMFCRibbonSlider [MFC], SetRange", "CMFCRibbonSlider [MFC], SetZoomButtons", "CMFCRibbonSlider [MFC], SetZoomIncrement"] -ms.assetid: 9351ac34-f234-4e42-91e2-763f1989c8ff --- # CMFCRibbonSlider Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonSlider` class implements a slider control that you can add to a ribbon bar or ribbon status bar. The ribbon slider control resembles the zoom sliders that appear in Office 2007 applications. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonstatusbar-class.md b/docs/mfc/reference/cmfcribbonstatusbar-class.md index 1b142bb2694..0326624c77c 100644 --- a/docs/mfc/reference/cmfcribbonstatusbar-class.md +++ b/docs/mfc/reference/cmfcribbonstatusbar-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonStatusBar Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonStatusBar", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::AddDynamicElement", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::AddElement", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::AddExtendedElement", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::AddSeparator", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::Create", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::CreateEx", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::FindByID", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::FindElement", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::GetCount", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::GetElement", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::GetExCount", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::GetExElement", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::GetExtendedArea", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::GetSpace", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::IsBottomFrame", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::IsExtendedElement", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::IsInformationMode", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::RecalcLayout", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::RemoveAll", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::RemoveElement", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::SetInformation", "AFXRIBBONSTATUSBAR/CMFCRibbonStatusBar::OnDrawInformation"] helpviewer_keywords: ["CMFCRibbonStatusBar [MFC], AddDynamicElement", "CMFCRibbonStatusBar [MFC], AddElement", "CMFCRibbonStatusBar [MFC], AddExtendedElement", "CMFCRibbonStatusBar [MFC], AddSeparator", "CMFCRibbonStatusBar [MFC], Create", "CMFCRibbonStatusBar [MFC], CreateEx", "CMFCRibbonStatusBar [MFC], FindByID", "CMFCRibbonStatusBar [MFC], FindElement", "CMFCRibbonStatusBar [MFC], GetCount", "CMFCRibbonStatusBar [MFC], GetElement", "CMFCRibbonStatusBar [MFC], GetExCount", "CMFCRibbonStatusBar [MFC], GetExElement", "CMFCRibbonStatusBar [MFC], GetExtendedArea", "CMFCRibbonStatusBar [MFC], GetSpace", "CMFCRibbonStatusBar [MFC], IsBottomFrame", "CMFCRibbonStatusBar [MFC], IsExtendedElement", "CMFCRibbonStatusBar [MFC], IsInformationMode", "CMFCRibbonStatusBar [MFC], RecalcLayout", "CMFCRibbonStatusBar [MFC], RemoveAll", "CMFCRibbonStatusBar [MFC], RemoveElement", "CMFCRibbonStatusBar [MFC], SetInformation", "CMFCRibbonStatusBar [MFC], OnDrawInformation"] -ms.assetid: 921eb57f-3b40-49fa-a38c-3f2fb6dc2893 --- # CMFCRibbonStatusBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonStatusBar` class implements a status bar control that can display ribbon elements. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonstatusbarpane-class.md b/docs/mfc/reference/cmfcribbonstatusbarpane-class.md index 8893c2f2649..7c7da6cf122 100644 --- a/docs/mfc/reference/cmfcribbonstatusbarpane-class.md +++ b/docs/mfc/reference/cmfcribbonstatusbarpane-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonStatusBarPane Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonStatusBarPane", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::CMFCRibbonStatusBarPane", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::GetAlmostLargeText", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::GetTextAlign", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::IsAnimation", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::IsExtended", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::OnDrawBorder", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::OnFillBackground", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::SetAlmostLargeText", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::SetAnimationList", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::SetTextAlign", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::StartAnimation", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::StopAnimation", "AFXRIBBONSTATUSBARPANE/CMFCRibbonStatusBarPane::OnFinishAnimation"] helpviewer_keywords: ["CMFCRibbonStatusBarPane [MFC], CMFCRibbonStatusBarPane", "CMFCRibbonStatusBarPane [MFC], GetAlmostLargeText", "CMFCRibbonStatusBarPane [MFC], GetTextAlign", "CMFCRibbonStatusBarPane [MFC], IsAnimation", "CMFCRibbonStatusBarPane [MFC], IsExtended", "CMFCRibbonStatusBarPane [MFC], OnDrawBorder", "CMFCRibbonStatusBarPane [MFC], OnFillBackground", "CMFCRibbonStatusBarPane [MFC], SetAlmostLargeText", "CMFCRibbonStatusBarPane [MFC], SetAnimationList", "CMFCRibbonStatusBarPane [MFC], SetTextAlign", "CMFCRibbonStatusBarPane [MFC], StartAnimation", "CMFCRibbonStatusBarPane [MFC], StopAnimation", "CMFCRibbonStatusBarPane [MFC], OnFinishAnimation"] -ms.assetid: 5d034c3c-ecca-4267-b88c-0f55a2884dd0 --- # CMFCRibbonStatusBarPane Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonStatusBarPane` class implements a ribbon element that you can add to a ribbon status bar. ## Syntax diff --git a/docs/mfc/reference/cmfcribbonundobutton-class.md b/docs/mfc/reference/cmfcribbonundobutton-class.md index 2cc70cab6a8..19f612a1c0a 100644 --- a/docs/mfc/reference/cmfcribbonundobutton-class.md +++ b/docs/mfc/reference/cmfcribbonundobutton-class.md @@ -4,10 +4,12 @@ title: "CMFCRibbonUndoButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCRibbonUndoButton", "AFXRIBBONUNDOBUTTON/CMFCRibbonUndoButton", "AFXRIBBONUNDOBUTTON/CMFCRibbonUndoButton::CMFCRibbonUndoButton", "AFXRIBBONUNDOBUTTON/CMFCRibbonUndoButton::AddUndoAction", "AFXRIBBONUNDOBUTTON/CMFCRibbonUndoButton::CleanUpUndoList", "AFXRIBBONUNDOBUTTON/CMFCRibbonUndoButton::GetActionNumber", "AFXRIBBONUNDOBUTTON/CMFCRibbonUndoButton::HasMenu"] helpviewer_keywords: ["CMFCRibbonUndoButton [MFC], CMFCRibbonUndoButton", "CMFCRibbonUndoButton [MFC], AddUndoAction", "CMFCRibbonUndoButton [MFC], CleanUpUndoList", "CMFCRibbonUndoButton [MFC], GetActionNumber", "CMFCRibbonUndoButton [MFC], HasMenu"] -ms.assetid: 5c42adf7-871d-4239-901e-47ae7fb816fc --- # CMFCRibbonUndoButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCRibbonUndoButton` class implements a drop-down list button that contains the most recent user commands. Users can select one or more of the most recent commands from the drop-down list to either redo or undo them. ## Syntax diff --git a/docs/mfc/reference/cmfcshelllistctrl-class.md b/docs/mfc/reference/cmfcshelllistctrl-class.md index a912243d295..40bda8b608f 100644 --- a/docs/mfc/reference/cmfcshelllistctrl-class.md +++ b/docs/mfc/reference/cmfcshelllistctrl-class.md @@ -4,10 +4,12 @@ title: "CMFCShellListCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CMFCShellListCtrl", "AFXSHELLLISTCTRL/CMFCShellListCtrl", "AFXSHELLLISTCTRL/CMFCShellListCtrl::DisplayFolder", "AFXSHELLLISTCTRL/CMFCShellListCtrl::DisplayParentFolder", "AFXSHELLLISTCTRL/CMFCShellListCtrl::EnableShellContextMenu", "AFXSHELLLISTCTRL/CMFCShellListCtrl::GetCurrentFolder", "AFXSHELLLISTCTRL/CMFCShellListCtrl::GetCurrentFolderName", "AFXSHELLLISTCTRL/CMFCShellListCtrl::GetCurrentItemIdList", "AFXSHELLLISTCTRL/CMFCShellListCtrl::GetCurrentShellFolder", "AFXSHELLLISTCTRL/CMFCShellListCtrl::GetItemPath", "AFXSHELLLISTCTRL/CMFCShellListCtrl::GetItemTypes", "AFXSHELLLISTCTRL/CMFCShellListCtrl::IsDesktop", "AFXSHELLLISTCTRL/CMFCShellListCtrl::OnCompareItems", "AFXSHELLLISTCTRL/CMFCShellListCtrl::OnFormatFileDate", "AFXSHELLLISTCTRL/CMFCShellListCtrl::OnFormatFileSize", "AFXSHELLLISTCTRL/CMFCShellListCtrl::OnGetItemIcon", "AFXSHELLLISTCTRL/CMFCShellListCtrl::OnGetItemText", "AFXSHELLLISTCTRL/CMFCShellListCtrl::OnSetColumns", "AFXSHELLLISTCTRL/CMFCShellListCtrl::Refresh", "AFXSHELLLISTCTRL/CMFCShellListCtrl::SetItemTypes"] helpviewer_keywords: ["CMFCShellListCtrl [MFC], DisplayFolder", "CMFCShellListCtrl [MFC], DisplayParentFolder", "CMFCShellListCtrl [MFC], EnableShellContextMenu", "CMFCShellListCtrl [MFC], GetCurrentFolder", "CMFCShellListCtrl [MFC], GetCurrentFolderName", "CMFCShellListCtrl [MFC], GetCurrentItemIdList", "CMFCShellListCtrl [MFC], GetCurrentShellFolder", "CMFCShellListCtrl [MFC], GetItemPath", "CMFCShellListCtrl [MFC], GetItemTypes", "CMFCShellListCtrl [MFC], IsDesktop", "CMFCShellListCtrl [MFC], OnCompareItems", "CMFCShellListCtrl [MFC], OnFormatFileDate", "CMFCShellListCtrl [MFC], OnFormatFileSize", "CMFCShellListCtrl [MFC], OnGetItemIcon", "CMFCShellListCtrl [MFC], OnGetItemText", "CMFCShellListCtrl [MFC], OnSetColumns", "CMFCShellListCtrl [MFC], Refresh", "CMFCShellListCtrl [MFC], SetItemTypes"] -ms.assetid: ad472958-5586-4c50-aadf-1844c30bf6e7 --- # CMFCShellListCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCShellListCtrl` class provides Windows list control functionality and expands it by including the ability to display a list of shell items. ## Syntax diff --git a/docs/mfc/reference/cmfcshelltreectrl-class.md b/docs/mfc/reference/cmfcshelltreectrl-class.md index 7dfa16e3951..1389dd1c38b 100644 --- a/docs/mfc/reference/cmfcshelltreectrl-class.md +++ b/docs/mfc/reference/cmfcshelltreectrl-class.md @@ -4,10 +4,12 @@ title: "CMFCShellTreeCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CMFCShellTreeCtrl", "AFXSHELLTREECTRL/CMFCShellTreeCtrl", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::EnableShellContextMenu", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::GetFlags", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::GetItemPath", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::GetRelatedList", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::OnChildNotify", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::OnGetItemIcon", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::OnGetItemText", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::Refresh", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::SelectPath", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::SetFlags", "AFXSHELLTREECTRL/CMFCShellTreeCtrl::SetRelatedList"] helpviewer_keywords: ["CMFCShellTreeCtrl [MFC], EnableShellContextMenu", "CMFCShellTreeCtrl [MFC], GetFlags", "CMFCShellTreeCtrl [MFC], GetItemPath", "CMFCShellTreeCtrl [MFC], GetRelatedList", "CMFCShellTreeCtrl [MFC], OnChildNotify", "CMFCShellTreeCtrl [MFC], OnGetItemIcon", "CMFCShellTreeCtrl [MFC], OnGetItemText", "CMFCShellTreeCtrl [MFC], Refresh", "CMFCShellTreeCtrl [MFC], SelectPath", "CMFCShellTreeCtrl [MFC], SetFlags", "CMFCShellTreeCtrl [MFC], SetRelatedList"] -ms.assetid: 3d1da715-9554-4ed7-968c-055c48146267 --- # CMFCShellTreeCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCShellTreeCtrl` class extends [CTreeCtrl Class](../../mfc/reference/ctreectrl-class.md) functionality by displaying a hierarchy of Shell items. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcspinbuttonctrl-class.md b/docs/mfc/reference/cmfcspinbuttonctrl-class.md index 4c0be4a5be5..ba101a0b26f 100644 --- a/docs/mfc/reference/cmfcspinbuttonctrl-class.md +++ b/docs/mfc/reference/cmfcspinbuttonctrl-class.md @@ -4,10 +4,12 @@ title: "CMFCSpinButtonCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CMFCSpinButtonCtrl", "AFXSPINBUTTONCTRL/CMFCSpinButtonCtrl", "AFXSPINBUTTONCTRL/CMFCSpinButtonCtrl::OnDraw"] helpviewer_keywords: ["CMFCSpinButtonCtrl [MFC], OnDraw"] -ms.assetid: 8773f259-4d3f-4bca-a71c-09e0c71bc843 --- # CMFCSpinButtonCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCSpinButtonCtrl` class supports a visual manager that draws a spin button control. ## Syntax diff --git a/docs/mfc/reference/cmfcstandardcolorspropertypage-class.md b/docs/mfc/reference/cmfcstandardcolorspropertypage-class.md index bfa687e415c..74a8259dd78 100644 --- a/docs/mfc/reference/cmfcstandardcolorspropertypage-class.md +++ b/docs/mfc/reference/cmfcstandardcolorspropertypage-class.md @@ -3,10 +3,12 @@ description: "Learn more about: CMFCStandardColorsPropertyPage Class" title: "CMFCStandardColorsPropertyPage Class" ms.date: "11/04/2016" helpviewer_keywords: ["CMFCStandardColorsPropertyPage class [MFC]"] -ms.assetid: b84b7cfb-bb24-4c65-804a-5b642cb64400 --- # CMFCStandardColorsPropertyPage Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a property page that users use to select standard colors in a color dialog box. ## Syntax diff --git a/docs/mfc/reference/cmfcstatusbar-class.md b/docs/mfc/reference/cmfcstatusbar-class.md index 066130cf342..0f7754ee2fb 100644 --- a/docs/mfc/reference/cmfcstatusbar-class.md +++ b/docs/mfc/reference/cmfcstatusbar-class.md @@ -4,10 +4,12 @@ title: "CMFCStatusBar Class" ms.date: "11/19/2018" f1_keywords: ["CMFCStatusBar", "AFXSTATUSBAR/CMFCStatusBar", "AFXSTATUSBAR/CMFCStatusBar::CalcFixedLayout", "AFXSTATUSBAR/CMFCStatusBar::CommandToIndex", "AFXSTATUSBAR/CMFCStatusBar::Create", "AFXSTATUSBAR/CMFCStatusBar::CreateEx", "AFXSTATUSBAR/CMFCStatusBar::DoesAllowDynInsertBefore", "AFXSTATUSBAR/CMFCStatusBar::EnablePaneDoubleClick", "AFXSTATUSBAR/CMFCStatusBar::EnablePaneProgressBar", "AFXSTATUSBAR/CMFCStatusBar::GetCount", "AFXSTATUSBAR/CMFCStatusBar::GetDrawExtendedArea", "AFXSTATUSBAR/CMFCStatusBar::GetExtendedArea", "AFXSTATUSBAR/CMFCStatusBar::GetItemID", "AFXSTATUSBAR/CMFCStatusBar::GetItemRect", "AFXSTATUSBAR/CMFCStatusBar::GetPaneInfo", "AFXSTATUSBAR/CMFCStatusBar::GetPaneProgress", "AFXSTATUSBAR/CMFCStatusBar::GetPaneStyle", "AFXSTATUSBAR/CMFCStatusBar::GetPaneText", "AFXSTATUSBAR/CMFCStatusBar::GetPaneWidth", "AFXSTATUSBAR/CMFCStatusBar::GetTipText", "AFXSTATUSBAR/CMFCStatusBar::InvalidatePaneContent", "AFXSTATUSBAR/CMFCStatusBar::PreCreateWindow", "AFXSTATUSBAR/CMFCStatusBar::SetDrawExtendedArea", "AFXSTATUSBAR/CMFCStatusBar::SetIndicators", "AFXSTATUSBAR/CMFCStatusBar::SetPaneAnimation", "AFXSTATUSBAR/CMFCStatusBar::SetPaneBackgroundColor", "AFXSTATUSBAR/CMFCStatusBar::SetPaneIcon", "AFXSTATUSBAR/CMFCStatusBar::SetPaneInfo", "AFXSTATUSBAR/CMFCStatusBar::SetPaneProgress", "AFXSTATUSBAR/CMFCStatusBar::SetPaneStyle", "AFXSTATUSBAR/CMFCStatusBar::SetPaneText", "AFXSTATUSBAR/CMFCStatusBar::SetPaneTextColor", "AFXSTATUSBAR/CMFCStatusBar::SetPaneWidth", "AFXSTATUSBAR/CMFCStatusBar::SetTipText", "AFXSTATUSBAR/CMFCStatusBar::OnDrawPane"] helpviewer_keywords: ["CMFCStatusBar [MFC], CalcFixedLayout", "CMFCStatusBar [MFC], CommandToIndex", "CMFCStatusBar [MFC], Create", "CMFCStatusBar [MFC], CreateEx", "CMFCStatusBar [MFC], DoesAllowDynInsertBefore", "CMFCStatusBar [MFC], EnablePaneDoubleClick", "CMFCStatusBar [MFC], EnablePaneProgressBar", "CMFCStatusBar [MFC], GetCount", "CMFCStatusBar [MFC], GetDrawExtendedArea", "CMFCStatusBar [MFC], GetExtendedArea", "CMFCStatusBar [MFC], GetItemID", "CMFCStatusBar [MFC], GetItemRect", "CMFCStatusBar [MFC], GetPaneInfo", "CMFCStatusBar [MFC], GetPaneProgress", "CMFCStatusBar [MFC], GetPaneStyle", "CMFCStatusBar [MFC], GetPaneText", "CMFCStatusBar [MFC], GetPaneWidth", "CMFCStatusBar [MFC], GetTipText", "CMFCStatusBar [MFC], InvalidatePaneContent", "CMFCStatusBar [MFC], PreCreateWindow", "CMFCStatusBar [MFC], SetDrawExtendedArea", "CMFCStatusBar [MFC], SetIndicators", "CMFCStatusBar [MFC], SetPaneAnimation", "CMFCStatusBar [MFC], SetPaneBackgroundColor", "CMFCStatusBar [MFC], SetPaneIcon", "CMFCStatusBar [MFC], SetPaneInfo", "CMFCStatusBar [MFC], SetPaneProgress", "CMFCStatusBar [MFC], SetPaneStyle", "CMFCStatusBar [MFC], SetPaneText", "CMFCStatusBar [MFC], SetPaneTextColor", "CMFCStatusBar [MFC], SetPaneWidth", "CMFCStatusBar [MFC], SetTipText", "CMFCStatusBar [MFC], OnDrawPane"] -ms.assetid: f2960d1d-f4ed-41e8-bd99-0382b2f8d88e --- # CMFCStatusBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCStatusBar` class implements a status bar similar to the `CStatusBar` class. However, the `CMFCStatusBar` class has features not offered by the `CStatusBar` class, such as the ability to display images, animations, and progress bars; and the ability to respond to mouse double-clicks. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfctabctrl-class.md b/docs/mfc/reference/cmfctabctrl-class.md index d59039a3592..1cc67d8362b 100644 --- a/docs/mfc/reference/cmfctabctrl-class.md +++ b/docs/mfc/reference/cmfctabctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCTabCtrl [MFC], ActivateMDITab", "CMFCTabCtrl [MFC], A --- # `CMFCTabCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCTabCtrl` class provides functionality for a tab control. The tab control displays a dockable window with flat or three-dimensional tabs at its top or bottom. The tabs can display text and an image and can change color when active. ## Syntax diff --git a/docs/mfc/reference/cmfctabdroptarget-class.md b/docs/mfc/reference/cmfctabdroptarget-class.md index 5d89adc8afd..23d80ad1a80 100644 --- a/docs/mfc/reference/cmfctabdroptarget-class.md +++ b/docs/mfc/reference/cmfctabdroptarget-class.md @@ -4,10 +4,12 @@ title: "CMFCTabDropTarget Class" ms.date: "11/04/2016" f1_keywords: ["CMFCTabDropTarget", "AFXBASETABCTRL/CMFCTabDropTarget", "AFXBASETABCTRL/CMFCTabDropTarget::OnDragEnter", "AFXBASETABCTRL/CMFCTabDropTarget::OnDragLeave", "AFXBASETABCTRL/CMFCTabDropTarget::OnDragOver", "AFXBASETABCTRL/CMFCTabDropTarget::OnDropEx", "AFXBASETABCTRL/CMFCTabDropTarget::Register"] helpviewer_keywords: ["CMFCTabDropTarget [MFC], OnDragEnter", "CMFCTabDropTarget [MFC], OnDragLeave", "CMFCTabDropTarget [MFC], OnDragOver", "CMFCTabDropTarget [MFC], OnDropEx", "CMFCTabDropTarget [MFC], Register"] -ms.assetid: 9777b7b6-10da-4c4b-b1d1-7ea795b0f1cb --- # CMFCTabDropTarget Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the communication mechanism between a tab control and the OLE libraries. ## Syntax diff --git a/docs/mfc/reference/cmfctabtooltipinfo-structure.md b/docs/mfc/reference/cmfctabtooltipinfo-structure.md index af9d6c82a9c..b83387bc247 100644 --- a/docs/mfc/reference/cmfctabtooltipinfo-structure.md +++ b/docs/mfc/reference/cmfctabtooltipinfo-structure.md @@ -4,10 +4,12 @@ title: "CMFCTabToolTipInfo Structure" ms.date: "11/04/2016" f1_keywords: ["CMFCTabToolTipInfo"] helpviewer_keywords: ["CMFCTabToolTipInfo struct"] -ms.assetid: 9c3b3fb9-1497-4d59-932b-0da9348dd5e2 --- # CMFCTabToolTipInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This structure provides information about the MDI tab that the user is hovering over. ## Syntax diff --git a/docs/mfc/reference/cmfctaskspane-class.md b/docs/mfc/reference/cmfctaskspane-class.md index 3f766743078..c45aa476a0f 100644 --- a/docs/mfc/reference/cmfctaskspane-class.md +++ b/docs/mfc/reference/cmfctaskspane-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCTasksPane [MFC], CMFCTasksPane", "CMFCTasksPane [MFC] --- # CMFCTasksPane Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. The `CMFCTasksPane` class implements a list of clickable items (tasks). diff --git a/docs/mfc/reference/cmfctaskspanetask-class.md b/docs/mfc/reference/cmfctaskspanetask-class.md index 215e27bed25..f11dfddd682 100644 --- a/docs/mfc/reference/cmfctaskspanetask-class.md +++ b/docs/mfc/reference/cmfctaskspanetask-class.md @@ -4,10 +4,12 @@ title: "CMFCTasksPaneTask Class" ms.date: "11/19/2018" f1_keywords: ["CMFCTasksPaneTask", "AFXTASKSPANE/CMFCTasksPaneTask", "AFXTASKSPANE/CMFCTasksPaneTask::CMFCTasksPaneTask", "AFXTASKSPANE/CMFCTasksPaneTask::SetACCData", "AFXTASKSPANE/CMFCTasksPaneTask::m_bAutoDestroyWindow", "AFXTASKSPANE/CMFCTasksPaneTask::m_bIsBold", "AFXTASKSPANE/CMFCTasksPaneTask::m_dwUserData", "AFXTASKSPANE/CMFCTasksPaneTask::m_hwndTask", "AFXTASKSPANE/CMFCTasksPaneTask::m_nIcon", "AFXTASKSPANE/CMFCTasksPaneTask::m_nWindowHeight", "AFXTASKSPANE/CMFCTasksPaneTask::m_pGroup", "AFXTASKSPANE/CMFCTasksPaneTask::m_rect", "AFXTASKSPANE/CMFCTasksPaneTask::m_strName", "AFXTASKSPANE/CMFCTasksPaneTask::m_uiCommandID"] helpviewer_keywords: ["CMFCTasksPaneTask [MFC], CMFCTasksPaneTask", "CMFCTasksPaneTask [MFC], SetACCData", "CMFCTasksPaneTask [MFC], m_bAutoDestroyWindow", "CMFCTasksPaneTask [MFC], m_bIsBold", "CMFCTasksPaneTask [MFC], m_dwUserData", "CMFCTasksPaneTask [MFC], m_hwndTask", "CMFCTasksPaneTask [MFC], m_nIcon", "CMFCTasksPaneTask [MFC], m_nWindowHeight", "CMFCTasksPaneTask [MFC], m_pGroup", "CMFCTasksPaneTask [MFC], m_rect", "CMFCTasksPaneTask [MFC], m_strName", "CMFCTasksPaneTask [MFC], m_uiCommandID"] -ms.assetid: c5a7513b-cd8f-4e2e-b16f-650e1fe30954 --- # CMFCTasksPaneTask Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCTasksPaneTask` class is a helper class that represents tasks for the task pane control ( [CMFCTasksPane](../../mfc/reference/cmfctaskspane-class.md)). The task object represents an item in the task group ( [CMFCTasksPaneTaskGroup](../../mfc/reference/cmfctaskspanetaskgroup-class.md)). Each task can have a command that the framework executes when a user clicks on the task and an icon that appears to the left of the task name. ## Syntax diff --git a/docs/mfc/reference/cmfctaskspanetaskgroup-class.md b/docs/mfc/reference/cmfctaskspanetaskgroup-class.md index c7f575c20a3..4db39770b60 100644 --- a/docs/mfc/reference/cmfctaskspanetaskgroup-class.md +++ b/docs/mfc/reference/cmfctaskspanetaskgroup-class.md @@ -4,10 +4,12 @@ title: "CMFCTasksPaneTaskGroup Class" ms.date: "11/19/2018" f1_keywords: ["CMFCTasksPaneTaskGroup", "AFXTASKSPANE/CMFCTasksPaneTaskGroup", "AFXTASKSPANE/CMFCTasksPaneTaskGroup::CMFCTasksPaneTaskGroup", "AFXTASKSPANE/CMFCTasksPaneTaskGroup::SetACCData", "AFXTASKSPANE/CMFCTasksPaneTaskGroup::m_bIsBottom", "AFXTASKSPANE/CMFCTasksPaneTaskGroup::m_bIsCollapsed", "AFXTASKSPANE/CMFCTasksPaneTaskGroup::m_bIsSpecial", "AFXTASKSPANE/CMFCTasksPaneTaskGroup::m_lstTasks", "AFXTASKSPANE/CMFCTasksPaneTaskGroup::m_rect", "AFXTASKSPANE/CMFCTasksPaneTaskGroup::m_rectGroup", "AFXTASKSPANE/CMFCTasksPaneTaskGroup::m_strName"] helpviewer_keywords: ["CMFCTasksPaneTaskGroup [MFC], CMFCTasksPaneTaskGroup", "CMFCTasksPaneTaskGroup [MFC], SetACCData", "CMFCTasksPaneTaskGroup [MFC], m_bIsBottom", "CMFCTasksPaneTaskGroup [MFC], m_bIsCollapsed", "CMFCTasksPaneTaskGroup [MFC], m_bIsSpecial", "CMFCTasksPaneTaskGroup [MFC], m_lstTasks", "CMFCTasksPaneTaskGroup [MFC], m_rect", "CMFCTasksPaneTaskGroup [MFC], m_rectGroup", "CMFCTasksPaneTaskGroup [MFC], m_strName"] -ms.assetid: 2111640b-a46e-4b27-b033-29e88632b86a --- # CMFCTasksPaneTaskGroup Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCTasksPaneTaskGroup` class is a helper class used by the [CMFCTasksPane](../../mfc/reference/cmfctaskspane-class.md) control. Objects of type `CMFCTasksPaneTaskGroup` represent a *task group*. The task group is a list of items that the framework displays in a separate box that has a collapse button. The box can have an optional caption (group name). If a group is collapsed, the list of tasks is not visible. ## Syntax diff --git a/docs/mfc/reference/cmfctoolbar-class.md b/docs/mfc/reference/cmfctoolbar-class.md index 9e9384ef1d5..a921bc1033d 100644 --- a/docs/mfc/reference/cmfctoolbar-class.md +++ b/docs/mfc/reference/cmfctoolbar-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCToolBar [MFC], AddBasicCommand", "CMFCToolBar [MFC], --- # `CMFCToolBar` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCToolBar` class resembles [`CToolBar` Class](../../mfc/reference/ctoolbar-class.md), but provides additional support for user interface features. These include flat toolbars, toolbars with hot images, large icons, pager buttons, locked toolbars, rebar controls, text under images, background images, and tabbed toolbars. The `CMFCToolBar` class also contains built-in support for user customization of toolbars and menus, drag-and-drop between toolbars and menus, combo box buttons, edit box buttons, color pickers, and roll-up buttons. For more detail, see the source code located in your Visual Studio installation, for example, `%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc`. diff --git a/docs/mfc/reference/cmfctoolbarbutton-class.md b/docs/mfc/reference/cmfctoolbarbutton-class.md index dd3933b89bc..7c6d4005c6c 100644 --- a/docs/mfc/reference/cmfctoolbarbutton-class.md +++ b/docs/mfc/reference/cmfctoolbarbutton-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarButton", "AFXTOOLBARBUTTON/CMFCToolBarButton", "AFXTOOLBARBUTTON/CMFCToolBarButton::CMFCToolBarButton", "AFXTOOLBARBUTTON/CMFCToolBarButton::CanBeDropped", "AFXTOOLBARBUTTON/CMFCToolBarButton::CanBeStored", "AFXTOOLBARBUTTON/CMFCToolBarButton::CanBeStretched", "AFXTOOLBARBUTTON/CMFCToolBarButton::CompareWith", "AFXTOOLBARBUTTON/CMFCToolBarButton::CopyFrom", "AFXTOOLBARBUTTON/CMFCToolBarButton::CreateFromOleData", "AFXTOOLBARBUTTON/CMFCToolBarButton::EnableWindow", "AFXTOOLBARBUTTON/CMFCToolBarButton::ExportToMenuButton", "AFXTOOLBARBUTTON/CMFCToolBarButton::GetClipboardFormat", "AFXTOOLBARBUTTON/CMFCToolBarButton::GetHwnd", "AFXTOOLBARBUTTON/CMFCToolBarButton::GetImage", "AFXTOOLBARBUTTON/CMFCToolBarButton::GetInvalidateRect", "AFXTOOLBARBUTTON/CMFCToolBarButton::GetParentWnd", "AFXTOOLBARBUTTON/CMFCToolBarButton::GetProtectedCommands", "AFXTOOLBARBUTTON/CMFCToolBarButton::GetTextSize", "AFXTOOLBARBUTTON/CMFCToolBarButton::HasFocus", "AFXTOOLBARBUTTON/CMFCToolBarButton::HaveHotBorder", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsDrawImage", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsDrawText", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsDroppedDown", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsEditable", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsExtraSize", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsFirstInGroup", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsHidden", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsHorizontal", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsLastInGroup", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsLocked", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsOwnerOf", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsVisible", "AFXTOOLBARBUTTON/CMFCToolBarButton::IsWindowVisible", "AFXTOOLBARBUTTON/CMFCToolBarButton::NotifyCommand", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnAddToCustomizePage", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnBeforeDrag", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnBeforeDrop", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnCalculateSize", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnCancelMode", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnChangeParentWnd", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnClick", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnClickUp", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnContextHelp", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnCtlColor", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnCustomizeMenu", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnDblClk", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnDraw", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnDrawOnCustomizeList", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnGetCustomToolTipText", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnGlobalFontsChanged", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnMove", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnShow", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnSize", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnToolHitTest", "AFXTOOLBARBUTTON/CMFCToolBarButton::OnUpdateToolTip", "AFXTOOLBARBUTTON/CMFCToolBarButton::PrepareDrag", "AFXTOOLBARBUTTON/CMFCToolBarButton::Rect", "AFXTOOLBARBUTTON/CMFCToolBarButton::ResetImageToDefault", "AFXTOOLBARBUTTON/CMFCToolBarButton::SaveBarState", "AFXTOOLBARBUTTON/CMFCToolBarButton::Serialize", "AFXTOOLBARBUTTON/CMFCToolBarButton::SetACCData", "AFXTOOLBARBUTTON/CMFCToolBarButton::SetClipboardFormatName", "AFXTOOLBARBUTTON/CMFCToolBarButton::SetImage", "AFXTOOLBARBUTTON/CMFCToolBarButton::SetProtectedCommands", "AFXTOOLBARBUTTON/CMFCToolBarButton::SetRadio", "AFXTOOLBARBUTTON/CMFCToolBarButton::SetRect", "AFXTOOLBARBUTTON/CMFCToolBarButton::SetStyle", "AFXTOOLBARBUTTON/CMFCToolBarButton::SetVisible", "AFXTOOLBARBUTTON/CMFCToolBarButton::Show", "AFXTOOLBARBUTTON/CMFCToolBarButton::m_bImage", "AFXTOOLBARBUTTON/CMFCToolBarButton::m_bText", "AFXTOOLBARBUTTON/CMFCToolBarButton::m_bTextBelow", "AFXTOOLBARBUTTON/CMFCToolBarButton::m_bUserButton", "AFXTOOLBARBUTTON/CMFCToolBarButton::m_bWholeText", "AFXTOOLBARBUTTON/CMFCToolBarButton::m_bWrap", "AFXTOOLBARBUTTON/CMFCToolBarButton::m_bWrapText", "AFXTOOLBARBUTTON/CMFCToolBarButton::m_nID", "AFXTOOLBARBUTTON/CMFCToolBarButton::m_nStyle", "AFXTOOLBARBUTTON/CMFCToolBarButton::m_strText"] helpviewer_keywords: ["CMFCToolBarButton [MFC], CMFCToolBarButton", "CMFCToolBarButton [MFC], CanBeDropped", "CMFCToolBarButton [MFC], CanBeStored", "CMFCToolBarButton [MFC], CanBeStretched", "CMFCToolBarButton [MFC], CompareWith", "CMFCToolBarButton [MFC], CopyFrom", "CMFCToolBarButton [MFC], CreateFromOleData", "CMFCToolBarButton [MFC], EnableWindow", "CMFCToolBarButton [MFC], ExportToMenuButton", "CMFCToolBarButton [MFC], GetClipboardFormat", "CMFCToolBarButton [MFC], GetHwnd", "CMFCToolBarButton [MFC], GetImage", "CMFCToolBarButton [MFC], GetInvalidateRect", "CMFCToolBarButton [MFC], GetParentWnd", "CMFCToolBarButton [MFC], GetProtectedCommands", "CMFCToolBarButton [MFC], GetTextSize", "CMFCToolBarButton [MFC], HasFocus", "CMFCToolBarButton [MFC], HaveHotBorder", "CMFCToolBarButton [MFC], IsDrawImage", "CMFCToolBarButton [MFC], IsDrawText", "CMFCToolBarButton [MFC], IsDroppedDown", "CMFCToolBarButton [MFC], IsEditable", "CMFCToolBarButton [MFC], IsExtraSize", "CMFCToolBarButton [MFC], IsFirstInGroup", "CMFCToolBarButton [MFC], IsHidden", "CMFCToolBarButton [MFC], IsHorizontal", "CMFCToolBarButton [MFC], IsLastInGroup", "CMFCToolBarButton [MFC], IsLocked", "CMFCToolBarButton [MFC], IsOwnerOf", "CMFCToolBarButton [MFC], IsVisible", "CMFCToolBarButton [MFC], IsWindowVisible", "CMFCToolBarButton [MFC], NotifyCommand", "CMFCToolBarButton [MFC], OnAddToCustomizePage", "CMFCToolBarButton [MFC], OnBeforeDrag", "CMFCToolBarButton [MFC], OnBeforeDrop", "CMFCToolBarButton [MFC], OnCalculateSize", "CMFCToolBarButton [MFC], OnCancelMode", "CMFCToolBarButton [MFC], OnChangeParentWnd", "CMFCToolBarButton [MFC], OnClick", "CMFCToolBarButton [MFC], OnClickUp", "CMFCToolBarButton [MFC], OnContextHelp", "CMFCToolBarButton [MFC], OnCtlColor", "CMFCToolBarButton [MFC], OnCustomizeMenu", "CMFCToolBarButton [MFC], OnDblClk", "CMFCToolBarButton [MFC], OnDraw", "CMFCToolBarButton [MFC], OnDrawOnCustomizeList", "CMFCToolBarButton [MFC], OnGetCustomToolTipText", "CMFCToolBarButton [MFC], OnGlobalFontsChanged", "CMFCToolBarButton [MFC], OnMove", "CMFCToolBarButton [MFC], OnShow", "CMFCToolBarButton [MFC], OnSize", "CMFCToolBarButton [MFC], OnToolHitTest", "CMFCToolBarButton [MFC], OnUpdateToolTip", "CMFCToolBarButton [MFC], PrepareDrag", "CMFCToolBarButton [MFC], Rect", "CMFCToolBarButton [MFC], ResetImageToDefault", "CMFCToolBarButton [MFC], SaveBarState", "CMFCToolBarButton [MFC], Serialize", "CMFCToolBarButton [MFC], SetACCData", "CMFCToolBarButton [MFC], SetClipboardFormatName", "CMFCToolBarButton [MFC], SetImage", "CMFCToolBarButton [MFC], SetProtectedCommands", "CMFCToolBarButton [MFC], SetRadio", "CMFCToolBarButton [MFC], SetRect", "CMFCToolBarButton [MFC], SetStyle", "CMFCToolBarButton [MFC], SetVisible", "CMFCToolBarButton [MFC], Show", "CMFCToolBarButton [MFC], m_bImage", "CMFCToolBarButton [MFC], m_bText", "CMFCToolBarButton [MFC], m_bTextBelow", "CMFCToolBarButton [MFC], m_bUserButton", "CMFCToolBarButton [MFC], m_bWholeText", "CMFCToolBarButton [MFC], m_bWrap", "CMFCToolBarButton [MFC], m_bWrapText", "CMFCToolBarButton [MFC], m_nID", "CMFCToolBarButton [MFC], m_nStyle", "CMFCToolBarButton [MFC], m_strText"] -ms.assetid: 8a6ecffb-86b0-4f5c-8211-a9146b463efd --- # CMFCToolBarButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides button functionality to toolbars. ## Syntax diff --git a/docs/mfc/reference/cmfctoolbarcomboboxbutton-class.md b/docs/mfc/reference/cmfctoolbarcomboboxbutton-class.md index 33ad04efef8..90ef5256171 100644 --- a/docs/mfc/reference/cmfctoolbarcomboboxbutton-class.md +++ b/docs/mfc/reference/cmfctoolbarcomboboxbutton-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarComboBoxButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarComboBoxButton", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::CMFCToolBarComboBoxButton", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::AddItem", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::AddSortedItem", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::Compare", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::CreateEdit", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::DeleteItem", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::FindItem", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetByCmd", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetComboBox", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetCount", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetCountAll", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetCurSel", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetCurSelAll", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetEditCtrl", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetItem", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetItemAll", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetItemData", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetItemDataAll", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetItemDataPtrAll", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetText", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::GetTextAll", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::IsCenterVert", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::IsFlatMode", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::RemoveAllItems", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::SelectItem", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::SelectItemAll", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::SetCenterVert", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::SetDropDownHeight", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxButton::SetFlatMode"] helpviewer_keywords: ["CMFCToolBarComboBoxButton [MFC], CMFCToolBarComboBoxButton", "CMFCToolBarComboBoxButton [MFC], AddItem", "CMFCToolBarComboBoxButton [MFC], AddSortedItem", "CMFCToolBarComboBoxButton [MFC], Compare", "CMFCToolBarComboBoxButton [MFC], CreateEdit", "CMFCToolBarComboBoxButton [MFC], DeleteItem", "CMFCToolBarComboBoxButton [MFC], FindItem", "CMFCToolBarComboBoxButton [MFC], GetByCmd", "CMFCToolBarComboBoxButton [MFC], GetComboBox", "CMFCToolBarComboBoxButton [MFC], GetCount", "CMFCToolBarComboBoxButton [MFC], GetCountAll", "CMFCToolBarComboBoxButton [MFC], GetCurSel", "CMFCToolBarComboBoxButton [MFC], GetCurSelAll", "CMFCToolBarComboBoxButton [MFC], GetEditCtrl", "CMFCToolBarComboBoxButton [MFC], GetItem", "CMFCToolBarComboBoxButton [MFC], GetItemAll", "CMFCToolBarComboBoxButton [MFC], GetItemData", "CMFCToolBarComboBoxButton [MFC], GetItemDataAll", "CMFCToolBarComboBoxButton [MFC], GetItemDataPtrAll", "CMFCToolBarComboBoxButton [MFC], GetText", "CMFCToolBarComboBoxButton [MFC], GetTextAll", "CMFCToolBarComboBoxButton [MFC], IsCenterVert", "CMFCToolBarComboBoxButton [MFC], IsFlatMode", "CMFCToolBarComboBoxButton [MFC], RemoveAllItems", "CMFCToolBarComboBoxButton [MFC], SelectItem", "CMFCToolBarComboBoxButton [MFC], SelectItemAll", "CMFCToolBarComboBoxButton [MFC], SetCenterVert", "CMFCToolBarComboBoxButton [MFC], SetDropDownHeight", "CMFCToolBarComboBoxButton [MFC], SetFlatMode"] -ms.assetid: 32fa39f7-8e4e-4f0a-a31d-7b540d969a6c --- # CMFCToolBarComboBoxButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A toolbar button that contains a combo box control ( [CComboBox Class](../../mfc/reference/ccombobox-class.md)). ## Syntax diff --git a/docs/mfc/reference/cmfctoolbarcomboboxedit-class.md b/docs/mfc/reference/cmfctoolbarcomboboxedit-class.md index d3268930335..e967144ef94 100644 --- a/docs/mfc/reference/cmfctoolbarcomboboxedit-class.md +++ b/docs/mfc/reference/cmfctoolbarcomboboxedit-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarComboBoxEdit Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarComboBoxEdit", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxEdit", "AFXTOOLBARCOMBOBOXBUTTON/CMFCToolBarComboBoxEdit::CMFCToolBarComboBoxEdit"] helpviewer_keywords: ["CMFCToolBarComboBoxEdit [MFC], CMFCToolBarComboBoxEdit"] -ms.assetid: 4789c34a-ce58-48ba-a26f-38748b601352 --- # CMFCToolBarComboBoxEdit Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The framework uses the `CMFCToolBarComboBoxEdit` class to create a toolbar button that behaves like an editable combo box control. ## Syntax diff --git a/docs/mfc/reference/cmfctoolbardatetimectrl-class.md b/docs/mfc/reference/cmfctoolbardatetimectrl-class.md index 367cba596e9..8e6ff7c4dea 100644 --- a/docs/mfc/reference/cmfctoolbardatetimectrl-class.md +++ b/docs/mfc/reference/cmfctoolbardatetimectrl-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarDateTimeCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarDateTimeCtrl", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::CMFCToolBarDateTimeCtrl", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::CanBeStretched", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::CopyFrom", "AFXTOOLBARDATETIMECTRL/CMFCToolBarButton::ExportToMenuButton", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::GetByCmd", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::GetDateTimeCtrl", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::GetHwnd", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::GetTime", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::GetTimeAll", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::HaveHotBorder", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::NotifyCommand", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::OnAddToCustomizePage", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::OnChangeParentWnd", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::OnClick", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::OnCtlColor", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::OnGlobalFontsChanged", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::OnMove", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::OnShow", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::OnUpdateToolTip", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::SetTime", "AFXTOOLBARDATETIMECTRL/CMFCToolBarDateTimeCtrl::SetTimeAll"] helpviewer_keywords: ["CMFCToolBarDateTimeCtrl [MFC], CMFCToolBarDateTimeCtrl", "CMFCToolBarDateTimeCtrl [MFC], CanBeStretched", "CMFCToolBarDateTimeCtrl [MFC], CopyFrom", "CMFCToolBarButton [MFC], ExportToMenuButton", "CMFCToolBarDateTimeCtrl [MFC], GetByCmd", "CMFCToolBarDateTimeCtrl [MFC], GetDateTimeCtrl", "CMFCToolBarDateTimeCtrl [MFC], GetHwnd", "CMFCToolBarDateTimeCtrl [MFC], GetTime", "CMFCToolBarDateTimeCtrl [MFC], GetTimeAll", "CMFCToolBarDateTimeCtrl [MFC], HaveHotBorder", "CMFCToolBarDateTimeCtrl [MFC], NotifyCommand", "CMFCToolBarDateTimeCtrl [MFC], OnAddToCustomizePage", "CMFCToolBarDateTimeCtrl [MFC], OnChangeParentWnd", "CMFCToolBarDateTimeCtrl [MFC], OnClick", "CMFCToolBarDateTimeCtrl [MFC], OnCtlColor", "CMFCToolBarDateTimeCtrl [MFC], OnGlobalFontsChanged", "CMFCToolBarDateTimeCtrl [MFC], OnMove", "CMFCToolBarDateTimeCtrl [MFC], OnShow", "CMFCToolBarDateTimeCtrl [MFC], OnUpdateToolTip", "CMFCToolBarDateTimeCtrl [MFC], SetTime", "CMFCToolBarDateTimeCtrl [MFC], SetTimeAll"] -ms.assetid: a3853cb9-8ebc-444f-a1e4-9cf905e24c18 --- # CMFCToolBarDateTimeCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A toolbar button that contains a date and time picker control. ## Syntax diff --git a/docs/mfc/reference/cmfctoolbareditboxbutton-class.md b/docs/mfc/reference/cmfctoolbareditboxbutton-class.md index bd00650204d..3d2790f18f1 100644 --- a/docs/mfc/reference/cmfctoolbareditboxbutton-class.md +++ b/docs/mfc/reference/cmfctoolbareditboxbutton-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarEditBoxButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarEditBoxButton", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::CMFCToolBarEditBoxButton", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::CanBeStretched", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::CopyFrom", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::GetByCmd", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::GetContentsAll", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::GetContextMenuID", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::GetEditBorder", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::GetHwnd", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::GetInvalidateRect", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::HaveHotBorder", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::IsFlatMode", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::NotifyCommand", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::OnAddToCustomizePage", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::OnChangeParentWnd", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::OnClick", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::OnCtlColor", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::OnGlobalFontsChanged", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::OnMove", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::OnShow", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::OnSize", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::OnUpdateToolTip", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::SetContextMenuID", "AFXTOOLBAREDITBOXBUTTON/CMFCToolBarEditBoxButton::SetFlatMode"] helpviewer_keywords: ["CMFCToolBarEditBoxButton [MFC], CMFCToolBarEditBoxButton", "CMFCToolBarEditBoxButton [MFC], CanBeStretched", "CMFCToolBarEditBoxButton [MFC], CopyFrom", "CMFCToolBarEditBoxButton [MFC], GetByCmd", "CMFCToolBarEditBoxButton [MFC], GetContentsAll", "CMFCToolBarEditBoxButton [MFC], GetContextMenuID", "CMFCToolBarEditBoxButton [MFC], GetEditBorder", "CMFCToolBarEditBoxButton [MFC], GetHwnd", "CMFCToolBarEditBoxButton [MFC], GetInvalidateRect", "CMFCToolBarEditBoxButton [MFC], HaveHotBorder", "CMFCToolBarEditBoxButton [MFC], IsFlatMode", "CMFCToolBarEditBoxButton [MFC], NotifyCommand", "CMFCToolBarEditBoxButton [MFC], OnAddToCustomizePage", "CMFCToolBarEditBoxButton [MFC], OnChangeParentWnd", "CMFCToolBarEditBoxButton [MFC], OnClick", "CMFCToolBarEditBoxButton [MFC], OnCtlColor", "CMFCToolBarEditBoxButton [MFC], OnGlobalFontsChanged", "CMFCToolBarEditBoxButton [MFC], OnMove", "CMFCToolBarEditBoxButton [MFC], OnShow", "CMFCToolBarEditBoxButton [MFC], OnSize", "CMFCToolBarEditBoxButton [MFC], OnUpdateToolTip", "CMFCToolBarEditBoxButton [MFC], SetContextMenuID", "CMFCToolBarEditBoxButton [MFC], SetFlatMode"] -ms.assetid: b21d9b67-6bf7-4ca9-bd62-b237756e0ab3 --- # CMFCToolBarEditBoxButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A toolbar button that contains an edit control ( [CEdit Class](../../mfc/reference/cedit-class.md)). ## Syntax diff --git a/docs/mfc/reference/cmfctoolbarfontcombobox-class.md b/docs/mfc/reference/cmfctoolbarfontcombobox-class.md index 4c8e05d3ad6..965f04c370b 100644 --- a/docs/mfc/reference/cmfctoolbarfontcombobox-class.md +++ b/docs/mfc/reference/cmfctoolbarfontcombobox-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarFontComboBox Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarFontComboBox", "AFXTOOLBARFONTCOMBOBOX/CMFCToolBarFontComboBox", "AFXTOOLBARFONTCOMBOBOX/CMFCToolBarFontComboBox::CMFCToolBarFontComboBox", "AFXTOOLBARFONTCOMBOBOX/CMFCToolBarFontComboBox::GetFontDesc", "AFXTOOLBARFONTCOMBOBOX/CMFCToolBarFontComboBox::SetFont"] helpviewer_keywords: ["CMFCToolBarFontComboBox [MFC], CMFCToolBarFontComboBox", "CMFCToolBarFontComboBox [MFC], GetFontDesc", "CMFCToolBarFontComboBox [MFC], SetFont"] -ms.assetid: 25f8e08c-aadd-4cb5-9581-a99d49d444b1 --- # CMFCToolBarFontComboBox Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A toolbar button that contains a combo box control that enables the user to select a font from a list of system fonts. ## Syntax diff --git a/docs/mfc/reference/cmfctoolbarfontsizecombobox-class.md b/docs/mfc/reference/cmfctoolbarfontsizecombobox-class.md index 8bb1581813f..7314ab35ff8 100644 --- a/docs/mfc/reference/cmfctoolbarfontsizecombobox-class.md +++ b/docs/mfc/reference/cmfctoolbarfontsizecombobox-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarFontSizeComboBox Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarFontSizeComboBox", "AFXTOOLBARFONTCOMBOBOX/CMFCToolBarFontSizeComboBox", "AFXTOOLBARFONTCOMBOBOX/CMFCToolBarFontSizeComboBox::CMFCToolBarFontSizeComboBox", "AFXTOOLBARFONTCOMBOBOX/CMFCToolBarFontSizeComboBox::GetTwipSize", "AFXTOOLBARFONTCOMBOBOX/CMFCToolBarFontSizeComboBox::RebuildFontSizes", "AFXTOOLBARFONTCOMBOBOX/CMFCToolBarFontSizeComboBox::SetTwipSize"] helpviewer_keywords: ["CMFCToolBarFontSizeComboBox [MFC], CMFCToolBarFontSizeComboBox", "CMFCToolBarFontSizeComboBox [MFC], GetTwipSize", "CMFCToolBarFontSizeComboBox [MFC], RebuildFontSizes", "CMFCToolBarFontSizeComboBox [MFC], SetTwipSize"] -ms.assetid: 72e0c44c-6a0e-4194-a71f-ab64e3afb9b5 --- # CMFCToolBarFontSizeComboBox Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A toolbar button that contains a combo box control that enables the user to select a font size. ## Syntax diff --git a/docs/mfc/reference/cmfctoolbarimages-class.md b/docs/mfc/reference/cmfctoolbarimages-class.md index 3fe00a3e0af..6a04928ba74 100644 --- a/docs/mfc/reference/cmfctoolbarimages-class.md +++ b/docs/mfc/reference/cmfctoolbarimages-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarImages Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarImages", "AFXTOOLBARIMAGES/CMFCToolBarImages", "AFXTOOLBARIMAGES/CMFCToolBarImages::CMFCToolBarImages", "AFXTOOLBARIMAGES/CMFCToolBarImages::AdaptColors", "AFXTOOLBARIMAGES/CMFCToolBarImages::AddIcon", "AFXTOOLBARIMAGES/CMFCToolBarImages::AddImage", "AFXTOOLBARIMAGES/CMFCToolBarImages::CleanUp", "AFXTOOLBARIMAGES/CMFCToolBarImages::Clear", "AFXTOOLBARIMAGES/CMFCToolBarImages::ConvertTo32Bits", "AFXTOOLBARIMAGES/CMFCToolBarImages::CopyImageToClipboard", "AFXTOOLBARIMAGES/CMFCToolBarImages::CopyTo", "AFXTOOLBARIMAGES/CMFCToolBarImages::CreateFromImageList", "AFXTOOLBARIMAGES/CMFCToolBarImages::CreateRegionFromImage", "AFXTOOLBARIMAGES/CMFCToolBarImages::DeleteImage", "AFXTOOLBARIMAGES/CMFCToolBarImages::Draw", "AFXTOOLBARIMAGES/CMFCToolBarImages::DrawEx", "AFXTOOLBARIMAGES/CMFCToolBarImages::EnableRTL", "AFXTOOLBARIMAGES/CMFCToolBarImages::EndDrawImage", "AFXTOOLBARIMAGES/CMFCToolBarImages::ExtractIcon", "AFXTOOLBARIMAGES/CMFCToolBarImages::FillDitheredRect", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetAlwaysLight", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetBitsPerPixel", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetCount", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetDisabledImageAlpha", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetFadedImageAlpha", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetImageSize", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetImageWell", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetImageWellLight", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetLastImageRect", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetLightPercentage", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetMapTo3DColors", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetMask", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetResourceOffset", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetScale", "AFXTOOLBARIMAGES/CMFCToolBarImages::GetTransparentColor", "AFXTOOLBARIMAGES/CMFCToolBarImages::GrayImages", "AFXTOOLBARIMAGES/CMFCToolBarImages::Is32BitTransparencySupported", "AFXTOOLBARIMAGES/CMFCToolBarImages::IsPreMultiplyAutoCheck", "AFXTOOLBARIMAGES/CMFCToolBarImages::IsRTL", "AFXTOOLBARIMAGES/CMFCToolBarImages::IsReadOnly", "AFXTOOLBARIMAGES/CMFCToolBarImages::IsScaled", "AFXTOOLBARIMAGES/CMFCToolBarImages::IsUserImagesList", "AFXTOOLBARIMAGES/CMFCToolBarImages::IsValid", "AFXTOOLBARIMAGES/CMFCToolBarImages::Load", "AFXTOOLBARIMAGES/CMFCToolBarImages::LoadStr", "AFXTOOLBARIMAGES/CMFCToolBarImages::MapFromSysColor", "AFXTOOLBARIMAGES/CMFCToolBarImages::MapTo3dColors", "AFXTOOLBARIMAGES/CMFCToolBarImages::MapToSysColor", "AFXTOOLBARIMAGES/CMFCToolBarImages::MapToSysColorAlpha", "AFXTOOLBARIMAGES/CMFCToolBarImages::Mirror", "AFXTOOLBARIMAGES/CMFCToolBarImages::MirrorBitmap", "AFXTOOLBARIMAGES/CMFCToolBarImages::MirrorBitmapVert", "AFXTOOLBARIMAGES/CMFCToolBarImages::MirrorVert", "AFXTOOLBARIMAGES/CMFCToolBarImages::OnSysColorChange", "AFXTOOLBARIMAGES/CMFCToolBarImages::PrepareDrawImage", "AFXTOOLBARIMAGES/CMFCToolBarImages::Save", "AFXTOOLBARIMAGES/CMFCToolBarImages::SetAlwaysLight", "AFXTOOLBARIMAGES/CMFCToolBarImages::SetDisabledImageAlpha", "AFXTOOLBARIMAGES/CMFCToolBarImages::SetFadedImageAlpha", "AFXTOOLBARIMAGES/CMFCToolBarImages::SetImageSize", "AFXTOOLBARIMAGES/CMFCToolBarImages::SetLightPercentage", "AFXTOOLBARIMAGES/CMFCToolBarImages::SetMapTo3DColors", "AFXTOOLBARIMAGES/CMFCToolBarImages::SetPreMultiplyAutoCheck", "AFXTOOLBARIMAGES/CMFCToolBarImages::SetSingleImage", "AFXTOOLBARIMAGES/CMFCToolBarImages::SetTransparentColor", "AFXTOOLBARIMAGES/CMFCToolBarImages::SmoothResize", "AFXTOOLBARIMAGES/CMFCToolBarImages::UpdateImage", "AFXTOOLBARIMAGES/CMFCToolBarImages::PreMultiplyAlpha", "AFXTOOLBARIMAGES/CMFCToolBarImages::m_bDisableTrueColorAlpha"] helpviewer_keywords: ["CMFCToolBarImages [MFC], CMFCToolBarImages", "CMFCToolBarImages [MFC], AdaptColors", "CMFCToolBarImages [MFC], AddIcon", "CMFCToolBarImages [MFC], AddImage", "CMFCToolBarImages [MFC], CleanUp", "CMFCToolBarImages [MFC], Clear", "CMFCToolBarImages [MFC], ConvertTo32Bits", "CMFCToolBarImages [MFC], CopyImageToClipboard", "CMFCToolBarImages [MFC], CopyTo", "CMFCToolBarImages [MFC], CreateFromImageList", "CMFCToolBarImages [MFC], CreateRegionFromImage", "CMFCToolBarImages [MFC], DeleteImage", "CMFCToolBarImages [MFC], Draw", "CMFCToolBarImages [MFC], DrawEx", "CMFCToolBarImages [MFC], EnableRTL", "CMFCToolBarImages [MFC], EndDrawImage", "CMFCToolBarImages [MFC], ExtractIcon", "CMFCToolBarImages [MFC], FillDitheredRect", "CMFCToolBarImages [MFC], GetAlwaysLight", "CMFCToolBarImages [MFC], GetBitsPerPixel", "CMFCToolBarImages [MFC], GetCount", "CMFCToolBarImages [MFC], GetDisabledImageAlpha", "CMFCToolBarImages [MFC], GetFadedImageAlpha", "CMFCToolBarImages [MFC], GetImageSize", "CMFCToolBarImages [MFC], GetImageWell", "CMFCToolBarImages [MFC], GetImageWellLight", "CMFCToolBarImages [MFC], GetLastImageRect", "CMFCToolBarImages [MFC], GetLightPercentage", "CMFCToolBarImages [MFC], GetMapTo3DColors", "CMFCToolBarImages [MFC], GetMask", "CMFCToolBarImages [MFC], GetResourceOffset", "CMFCToolBarImages [MFC], GetScale", "CMFCToolBarImages [MFC], GetTransparentColor", "CMFCToolBarImages [MFC], GrayImages", "CMFCToolBarImages [MFC], Is32BitTransparencySupported", "CMFCToolBarImages [MFC], IsPreMultiplyAutoCheck", "CMFCToolBarImages [MFC], IsRTL", "CMFCToolBarImages [MFC], IsReadOnly", "CMFCToolBarImages [MFC], IsScaled", "CMFCToolBarImages [MFC], IsUserImagesList", "CMFCToolBarImages [MFC], IsValid", "CMFCToolBarImages [MFC], Load", "CMFCToolBarImages [MFC], LoadStr", "CMFCToolBarImages [MFC], MapFromSysColor", "CMFCToolBarImages [MFC], MapTo3dColors", "CMFCToolBarImages [MFC], MapToSysColor", "CMFCToolBarImages [MFC], MapToSysColorAlpha", "CMFCToolBarImages [MFC], Mirror", "CMFCToolBarImages [MFC], MirrorBitmap", "CMFCToolBarImages [MFC], MirrorBitmapVert", "CMFCToolBarImages [MFC], MirrorVert", "CMFCToolBarImages [MFC], OnSysColorChange", "CMFCToolBarImages [MFC], PrepareDrawImage", "CMFCToolBarImages [MFC], Save", "CMFCToolBarImages [MFC], SetAlwaysLight", "CMFCToolBarImages [MFC], SetDisabledImageAlpha", "CMFCToolBarImages [MFC], SetFadedImageAlpha", "CMFCToolBarImages [MFC], SetImageSize", "CMFCToolBarImages [MFC], SetLightPercentage", "CMFCToolBarImages [MFC], SetMapTo3DColors", "CMFCToolBarImages [MFC], SetPreMultiplyAutoCheck", "CMFCToolBarImages [MFC], SetSingleImage", "CMFCToolBarImages [MFC], SetTransparentColor", "CMFCToolBarImages [MFC], SmoothResize", "CMFCToolBarImages [MFC], UpdateImage", "CMFCToolBarImages [MFC], PreMultiplyAlpha", "CMFCToolBarImages [MFC], m_bDisableTrueColorAlpha"] -ms.assetid: d4e50518-9ffc-406f-9996-f79e5cd38155 --- # CMFCToolBarImages Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The images on a toolbar. The `CMFCToolBarImages` class manages toolbar images loaded from application resources or from files. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfctoolbarinfo-class.md b/docs/mfc/reference/cmfctoolbarinfo-class.md index efec0c3afac..43a753a5169 100644 --- a/docs/mfc/reference/cmfctoolbarinfo-class.md +++ b/docs/mfc/reference/cmfctoolbarinfo-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarInfo Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarInfo", "AFXTOOLBAR/CMFCToolBarInfo", "AFXTOOLBAR/CMFCToolBarInfo::m_uiColdResID", "AFXTOOLBAR/CMFCToolBarInfo::m_uiDisabledResID", "AFXTOOLBAR/CMFCToolBarInfo::m_uiHotResID", "AFXTOOLBAR/CMFCToolBarInfo::m_uiLargeColdResID", "AFXTOOLBAR/CMFCToolBarInfo::m_uiLargeDisabledResID", "AFXTOOLBAR/CMFCToolBarInfo::m_uiLargeHotResID", "AFXTOOLBAR/CMFCToolBarInfo::m_uiMenuDisabledResID", "AFXTOOLBAR/CMFCToolBarInfo::m_uiMenuResID"] helpviewer_keywords: ["CMFCToolBarInfo [MFC], m_uiColdResID", "CMFCToolBarInfo [MFC], m_uiDisabledResID", "CMFCToolBarInfo [MFC], m_uiHotResID", "CMFCToolBarInfo [MFC], m_uiLargeColdResID", "CMFCToolBarInfo [MFC], m_uiLargeDisabledResID", "CMFCToolBarInfo [MFC], m_uiLargeHotResID", "CMFCToolBarInfo [MFC], m_uiMenuDisabledResID", "CMFCToolBarInfo [MFC], m_uiMenuResID"] -ms.assetid: 6dc84482-eaaa-491f-aa5d-dd7a57886b46 --- # CMFCToolBarInfo Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Contains the resource IDs of toolbar images in various states. `CMFCToolBarInfo` is a helper class that is used as a parameter of the [CMFCToolBar::LoadToolBarEx](../../mfc/reference/cmfctoolbar-class.md#loadtoolbarex) method. ## Syntax diff --git a/docs/mfc/reference/cmfctoolbarmenubutton-class.md b/docs/mfc/reference/cmfctoolbarmenubutton-class.md index 62f67ca32f7..aa9fbb43a60 100644 --- a/docs/mfc/reference/cmfctoolbarmenubutton-class.md +++ b/docs/mfc/reference/cmfctoolbarmenubutton-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarMenuButton Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarMenuButton", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::CMFCToolBarMenuButton", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::CompareWith", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::CopyFrom", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::CreateFromMenu", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::CreateMenu", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::CreatePopupMenu", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::EnableQuickCustomize", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::GetCommands", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::GetImageRect", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::GetPaletteRows", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::GetPopupMenu", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::HasButton", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::HaveHotBorder", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::IsBorder", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::IsClickedOnMenu", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::IsDroppedDown", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::IsEmptyMenuAllowed", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::IsExclusive", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::IsMenuPaletteMode", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::IsQuickMode", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::IsTearOffMenu", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OnAfterCreatePopupMenu", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OnBeforeDrag", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OnCalculateSize", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OnCancelMode", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OnChangeParentWnd", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OnClick", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OnClickMenuItem", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OnContextHelp", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OnDraw", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OnDrawOnCustomizeList", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::OpenPopupMenu", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::ResetImageToDefault", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::SaveBarState", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::Serialize", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::SetACCData", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::SetMenuOnly", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::SetMenuPaletteMode", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::SetMessageWnd", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::SetRadio", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::SetTearOff", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::DrawDocumentIcon", "AFXTOOLBARMENUBUTTON/CMFCToolBarMenuButton::m_bAlwaysCallOwnerDraw"] helpviewer_keywords: ["CMFCToolBarMenuButton [MFC], CMFCToolBarMenuButton", "CMFCToolBarMenuButton [MFC], CompareWith", "CMFCToolBarMenuButton [MFC], CopyFrom", "CMFCToolBarMenuButton [MFC], CreateFromMenu", "CMFCToolBarMenuButton [MFC], CreateMenu", "CMFCToolBarMenuButton [MFC], CreatePopupMenu", "CMFCToolBarMenuButton [MFC], EnableQuickCustomize", "CMFCToolBarMenuButton [MFC], GetCommands", "CMFCToolBarMenuButton [MFC], GetImageRect", "CMFCToolBarMenuButton [MFC], GetPaletteRows", "CMFCToolBarMenuButton [MFC], GetPopupMenu", "CMFCToolBarMenuButton [MFC], HasButton", "CMFCToolBarMenuButton [MFC], HaveHotBorder", "CMFCToolBarMenuButton [MFC], IsBorder", "CMFCToolBarMenuButton [MFC], IsClickedOnMenu", "CMFCToolBarMenuButton [MFC], IsDroppedDown", "CMFCToolBarMenuButton [MFC], IsEmptyMenuAllowed", "CMFCToolBarMenuButton [MFC], IsExclusive", "CMFCToolBarMenuButton [MFC], IsMenuPaletteMode", "CMFCToolBarMenuButton [MFC], IsQuickMode", "CMFCToolBarMenuButton [MFC], IsTearOffMenu", "CMFCToolBarMenuButton [MFC], OnAfterCreatePopupMenu", "CMFCToolBarMenuButton [MFC], OnBeforeDrag", "CMFCToolBarMenuButton [MFC], OnCalculateSize", "CMFCToolBarMenuButton [MFC], OnCancelMode", "CMFCToolBarMenuButton [MFC], OnChangeParentWnd", "CMFCToolBarMenuButton [MFC], OnClick", "CMFCToolBarMenuButton [MFC], OnClickMenuItem", "CMFCToolBarMenuButton [MFC], OnContextHelp", "CMFCToolBarMenuButton [MFC], OnDraw", "CMFCToolBarMenuButton [MFC], OnDrawOnCustomizeList", "CMFCToolBarMenuButton [MFC], OpenPopupMenu", "CMFCToolBarMenuButton [MFC], ResetImageToDefault", "CMFCToolBarMenuButton [MFC], SaveBarState", "CMFCToolBarMenuButton [MFC], Serialize", "CMFCToolBarMenuButton [MFC], SetACCData", "CMFCToolBarMenuButton [MFC], SetMenuOnly", "CMFCToolBarMenuButton [MFC], SetMenuPaletteMode", "CMFCToolBarMenuButton [MFC], SetMessageWnd", "CMFCToolBarMenuButton [MFC], SetRadio", "CMFCToolBarMenuButton [MFC], SetTearOff", "CMFCToolBarMenuButton [MFC], DrawDocumentIcon", "CMFCToolBarMenuButton [MFC], m_bAlwaysCallOwnerDraw"] -ms.assetid: cfa50176-7e4b-4527-9904-86a1b48fc1bc --- # CMFCToolBarMenuButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A toolbar button that contains a pop-up menu. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfctoolbarscustomizedialog-class.md b/docs/mfc/reference/cmfctoolbarscustomizedialog-class.md index af756deef39..ab98d47944b 100644 --- a/docs/mfc/reference/cmfctoolbarscustomizedialog-class.md +++ b/docs/mfc/reference/cmfctoolbarscustomizedialog-class.md @@ -4,10 +4,12 @@ title: "CMFCToolBarsCustomizeDialog Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolBarsCustomizeDialog", "AFXTOOLBARSCUSTOMIZEDIALOG/CMFCToolBarsCustomizeDialog", "AFXTOOLBARSCUSTOMIZEDIALOG/CMFCToolBarsCustomizeDialog::CMFCToolBarsCustomizeDialog", "AFXTOOLBARSCUSTOMIZEDIALOG/CMFCToolBarsCustomizeDialog::FillAllCommandsList", "AFXTOOLBARSCUSTOMIZEDIALOG/CMFCToolBarsCustomizeDialog::FillCategoriesComboBox", "AFXTOOLBARSCUSTOMIZEDIALOG/CMFCToolBarsCustomizeDialog::FillCategoriesListBox", "AFXTOOLBARSCUSTOMIZEDIALOG/CMFCToolBarsCustomizeDialog::GetCommandName", "AFXTOOLBARSCUSTOMIZEDIALOG/CMFCToolBarsCustomizeDialog::GetCountInCategory", "AFXTOOLBARSCUSTOMIZEDIALOG/CMFCToolBarsCustomizeDialog::GetFlags", "AFXTOOLBARSCUSTOMIZEDIALOG/CMFCToolBarsCustomizeDialog::OnInitDialog", "AFXTOOLBARSCUSTOMIZEDIALOG/CMFCToolBarsCustomizeDialog::PostNcDestroy"] helpviewer_keywords: ["CMFCToolBarsCustomizeDialog [MFC], CMFCToolBarsCustomizeDialog", "CMFCToolBarsCustomizeDialog [MFC], FillAllCommandsList", "CMFCToolBarsCustomizeDialog [MFC], FillCategoriesComboBox", "CMFCToolBarsCustomizeDialog [MFC], FillCategoriesListBox", "CMFCToolBarsCustomizeDialog [MFC], GetCommandName", "CMFCToolBarsCustomizeDialog [MFC], GetCountInCategory", "CMFCToolBarsCustomizeDialog [MFC], GetFlags", "CMFCToolBarsCustomizeDialog [MFC], OnInitDialog", "CMFCToolBarsCustomizeDialog [MFC], PostNcDestroy"] -ms.assetid: 78e2cddd-4f13-4097-afc3-1ad646a113f1 --- # CMFCToolBarsCustomizeDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A modeless tab dialog box ( [CPropertySheet Class](../../mfc/reference/cpropertysheet-class.md)) that enables the user to customize the toolbars, menus, keyboard shortcuts, user-defined tools, and visual style in an application. Typically, the user accesses this dialog box by selecting **Customize** from the **Tools** menu. The **Customize** dialog box has six tabs: **Commands**, **Toolbars**, **Tools**, **Keyboard**, **Menu**, and **Options**. diff --git a/docs/mfc/reference/cmfctooltipctrl-class.md b/docs/mfc/reference/cmfctooltipctrl-class.md index 9f75f1de911..9cf0b9adff4 100644 --- a/docs/mfc/reference/cmfctooltipctrl-class.md +++ b/docs/mfc/reference/cmfctooltipctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCToolTipCtrl [MFC], GetIconSize", "CMFCToolTipCtrl [MF --- # CMFCToolTipCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An extended tooltip implementation based on the [CToolTipCtrl Class](../../mfc/reference/ctooltipctrl-class.md). A tooltip based on the `CMFCToolTipCtrl` class can display an icon, a label, and a description. You can customize its visual appearance by using a gradient fill, custom text and border colors, bold text, rounded corners, or a balloon style. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfctooltipinfo-class.md b/docs/mfc/reference/cmfctooltipinfo-class.md index cefde9ab39f..4f9385a7fd7 100644 --- a/docs/mfc/reference/cmfctooltipinfo-class.md +++ b/docs/mfc/reference/cmfctooltipinfo-class.md @@ -4,10 +4,12 @@ title: "CMFCToolTipInfo Class" ms.date: "11/04/2016" f1_keywords: ["CMFCToolTipInfo", "AFXTOOLTIPCTRL/CMFCToolTipInfo", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_bBalloonTooltip", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_bBoldLabel", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_bDrawDescription", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_bDrawIcon", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_bDrawSeparator", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_bRoundedCorners", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_bVislManagerTheme", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_clrBorder", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_clrFill", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_clrFillGradient", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_clrText", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_nGradientAngle", "AFXTOOLTIPCTRL/CMFCToolTipInfo::m_nMaxDescrWidth"] helpviewer_keywords: ["CMFCToolTipInfo [MFC], m_bBalloonTooltip", "CMFCToolTipInfo [MFC], m_bBoldLabel", "CMFCToolTipInfo [MFC], m_bDrawDescription", "CMFCToolTipInfo [MFC], m_bDrawIcon", "CMFCToolTipInfo [MFC], m_bDrawSeparator", "CMFCToolTipInfo [MFC], m_bRoundedCorners", "CMFCToolTipInfo [MFC], m_bVislManagerTheme", "CMFCToolTipInfo [MFC], m_clrBorder", "CMFCToolTipInfo [MFC], m_clrFill", "CMFCToolTipInfo [MFC], m_clrFillGradient", "CMFCToolTipInfo [MFC], m_clrText", "CMFCToolTipInfo [MFC], m_nGradientAngle", "CMFCToolTipInfo [MFC], m_nMaxDescrWidth"] -ms.assetid: f9d3d7f8-1f08-4342-a7b2-683860e5d2a5 --- # CMFCToolTipInfo Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Stores information about the visual appearance of tooltips. ## Syntax diff --git a/docs/mfc/reference/cmfcvisualmanager-class.md b/docs/mfc/reference/cmfcvisualmanager-class.md index fe9a063078a..fbcf36dd516 100644 --- a/docs/mfc/reference/cmfcvisualmanager-class.md +++ b/docs/mfc/reference/cmfcvisualmanager-class.md @@ -4,10 +4,12 @@ title: "CMFCVisualManager Class" ms.date: "11/04/2016" f1_keywords: ["CMFCVisualManager", "AFXVISUALMANAGER/CMFCVisualManager", "AFXVISUALMANAGER/CMFCVisualManager::AdjustFrames", "AFXVISUALMANAGER/CMFCVisualManager::AdjustToolbars", "AFXVISUALMANAGER/CMFCVisualManager::AlwaysHighlight3DTabs", "AFXVISUALMANAGER/CMFCVisualManager::DestroyInstance", "AFXVISUALMANAGER/CMFCVisualManager::DoDrawHeaderSortArrow", "AFXVISUALMANAGER/CMFCVisualManager::DrawComboDropButtonWinXP", "AFXVISUALMANAGER/CMFCVisualManager::DrawPushButtonWinXP", "AFXVISUALMANAGER/CMFCVisualManager::DrawTextOnGlass", "AFXVISUALMANAGER/CMFCVisualManager::GetAutoHideButtonTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetButtonExtraBorder", "AFXVISUALMANAGER/CMFCVisualManager::GetCaptionBarTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetDockingTabsBordersSize", "AFXVISUALMANAGER/CMFCVisualManager::GetHighlightedMenuItemTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetInstance", "AFXVISUALMANAGER/CMFCVisualManager::GetMDITabsBordersSize", "AFXVISUALMANAGER/CMFCVisualManager::GetMenuItemTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetMenuShadowDepth", "AFXVISUALMANAGER/CMFCVisualManager::GetNcBtnSize", "AFXVISUALMANAGER/CMFCVisualManager::GetPopupMenuBorderSize", "AFXVISUALMANAGER/CMFCVisualManager::GetPropertyGridGroupColor", "AFXVISUALMANAGER/CMFCVisualManager::GetPropertyGridGroupTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetRibbonHyperlinkTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetRibbonPopupBorderSize", "AFXVISUALMANAGER/CMFCVisualManager::GetRibbonQuickAccessToolBarTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetRibbonSliderColors", "AFXVISUALMANAGER/CMFCVisualManager::GetShowAllMenuItemsHeight", "AFXVISUALMANAGER/CMFCVisualManager::GetSmartDockingBaseGuideColors", "AFXVISUALMANAGER/CMFCVisualManager::GetSmartDockingHighlightToneColor", "AFXVISUALMANAGER/CMFCVisualManager::GetSmartDockingTheme", "AFXVISUALMANAGER/CMFCVisualManager::GetStatusBarPaneTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetTabFrameColors", "AFXVISUALMANAGER/CMFCVisualManager::GetTabTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetToolbarButtonTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetToolbarDisabledTextColor", "AFXVISUALMANAGER/CMFCVisualManager::GetToolbarHighlightColor", "AFXVISUALMANAGER/CMFCVisualManager::GetToolTipInfo", "AFXVISUALMANAGER/CMFCVisualManager::HasOverlappedAutoHideButtons", "AFXVISUALMANAGER/CMFCVisualManager::IsDockingTabHasBorder", "AFXVISUALMANAGER/CMFCVisualManager::IsEmbossDisabledImage", "AFXVISUALMANAGER/CMFCVisualManager::IsFadeInactiveImage", "AFXVISUALMANAGER/CMFCVisualManager::IsMenuFlatLook", "AFXVISUALMANAGER/CMFCVisualManager::IsOfficeXPStyleMenus", "AFXVISUALMANAGER/CMFCVisualManager::IsOwnerDrawCaption", "AFXVISUALMANAGER/CMFCVisualManager::IsShadowHighlightedImage", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawAutoHideButtonBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawBarGripper", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawBrowseButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawButtonBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawButtonSeparator", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawCaptionBarBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawCaptionBarButtonBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawCaptionBarInfoArea", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawCaptionButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawCheckBox", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawCheckBoxEx", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawComboBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawComboDropButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawControlBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawDefaultRibbonImage", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawEditBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawExpandingBox", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawFloatingToolbarBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawHeaderCtrlBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawHeaderCtrlSortArrow", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawMenuArrowOnCustomizeList", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawMenuBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawMenuCheck", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawMenuItemButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawMenuLabel", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawMenuResizeBar", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawMenuScrollButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawMenuShadow", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawMenuSystemButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawMiniFrameBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawOutlookBarSplitter", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawOutlookPageButtonBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawPaneBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawPaneCaption", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawPaneDivider", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawPopupWindowBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawPopupWindowButtonBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawPopupWindowCaption", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonApplicationButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonButtonBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonButtonsGroup", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonCaption", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonCaptionButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonCategory", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonCategoryCaption", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonCategoryScroll", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonCategoryTab", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonCheckBoxOnList", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonColorPaletteBox", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonDefaultPaneButtonContext", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonDefaultPaneButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonDefaultPaneButtonIndicator", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonGalleryBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonGalleryButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonKeyTip", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonLabel", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonMainPanelButtonBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonMainPanelFrame", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonMenuCheckFrame", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonPanel", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonPanelCaption", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonProgressBar", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonQuickAccessToolBarSeparator", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonRecentFilesFrame", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonSliderChannel", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonSliderThumb", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonSliderZoomButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonStatusBarPane", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawRibbonTabsFrame", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawScrollButtons", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawSeparator", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawShowAllMenuItems", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawSpinButtons", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawSplitterBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawSplitterBox", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawStatusBarPaneBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawStatusBarProgress", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawStatusBarSizeBox", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawTab", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawTabCloseButton", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawTabContent", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawTabsButtonBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawTask", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawTasksGroupAreaBorder", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawTasksGroupCaption", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawTasksGroupIcon", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawTearOffCaption", "AFXVISUALMANAGER/CMFCVisualManager::OnDrawToolBoxFrame", "AFXVISUALMANAGER/CMFCVisualManager::OnEraseMDIClientArea", "AFXVISUALMANAGER/CMFCVisualManager::OnErasePopupWindowButton", "AFXVISUALMANAGER/CMFCVisualManager::OnEraseTabsArea", "AFXVISUALMANAGER/CMFCVisualManager::OnEraseTabsButton", "AFXVISUALMANAGER/CMFCVisualManager::OnEraseTabsFrame", "AFXVISUALMANAGER/CMFCVisualManager::OnFillAutoHideButtonBackground", "AFXVISUALMANAGER/CMFCVisualManager::OnFillBarBackground", "AFXVISUALMANAGER/CMFCVisualManager::OnFillButtonInterior", "AFXVISUALMANAGER/CMFCVisualManager::OnFillCaptionBarButton", "AFXVISUALMANAGER/CMFCVisualManager::OnFillCommandsListBackground", "AFXVISUALMANAGER/CMFCVisualManager::OnFillHeaderCtrlBackground", "AFXVISUALMANAGER/CMFCVisualManager::OnFillMiniFrameCaption", "AFXVISUALMANAGER/CMFCVisualManager::OnFillOutlookBarCaption", "AFXVISUALMANAGER/CMFCVisualManager::OnFillOutlookPageButton", "AFXVISUALMANAGER/CMFCVisualManager::OnFillPopupWindowBackground", "AFXVISUALMANAGER/CMFCVisualManager::OnFillRibbonButton", "AFXVISUALMANAGER/CMFCVisualManager::OnFillRibbonEdit", "AFXVISUALMANAGER/CMFCVisualManager::OnFillRibbonMainPanelButton", "AFXVISUALMANAGER/CMFCVisualManager::OnFillRibbonMenuFrame", "AFXVISUALMANAGER/CMFCVisualManager::OnFillRibbonQuickAccessToolBarPopup", "AFXVISUALMANAGER/CMFCVisualManager::OnFillSplitterBackground", "AFXVISUALMANAGER/CMFCVisualManager::OnFillTab", "AFXVISUALMANAGER/CMFCVisualManager::OnFillTasksGroupInterior", "AFXVISUALMANAGER/CMFCVisualManager::OnFillTasksPaneBackground", "AFXVISUALMANAGER/CMFCVisualManager::OnHighlightMenuItem", "AFXVISUALMANAGER/CMFCVisualManager::OnHighlightRarelyUsedMenuItems", "AFXVISUALMANAGER/CMFCVisualManager::OnNcPaint", "AFXVISUALMANAGER/CMFCVisualManager::OnSetWindowRegion", "AFXVISUALMANAGER/CMFCVisualManager::OnUpdateSystemColors", "AFXVISUALMANAGER/CMFCVisualManager::RedrawAll", "AFXVISUALMANAGER/CMFCVisualManager::RibbonCategoryColorToRGB", "AFXVISUALMANAGER/CMFCVisualManager::SetDefaultManager", "AFXVISUALMANAGER/CMFCVisualManager::SetEmbossDisabledImage", "AFXVISUALMANAGER/CMFCVisualManager::SetFadeInactiveImage", "AFXVISUALMANAGER/CMFCVisualManager::SetMenuFlatLook", "AFXVISUALMANAGER/CMFCVisualManager::SetMenuShadowDepth", "AFXVISUALMANAGER/CMFCVisualManager::SetShadowHighlightedImage"] helpviewer_keywords: ["CMFCVisualManager [MFC], AdjustFrames", "CMFCVisualManager [MFC], AdjustToolbars", "CMFCVisualManager [MFC], AlwaysHighlight3DTabs", "CMFCVisualManager [MFC], DestroyInstance", "CMFCVisualManager [MFC], DoDrawHeaderSortArrow", "CMFCVisualManager [MFC], DrawComboDropButtonWinXP", "CMFCVisualManager [MFC], DrawPushButtonWinXP", "CMFCVisualManager [MFC], DrawTextOnGlass", "CMFCVisualManager [MFC], GetAutoHideButtonTextColor", "CMFCVisualManager [MFC], GetButtonExtraBorder", "CMFCVisualManager [MFC], GetCaptionBarTextColor", "CMFCVisualManager [MFC], GetDockingTabsBordersSize", "CMFCVisualManager [MFC], GetHighlightedMenuItemTextColor", "CMFCVisualManager [MFC], GetInstance", "CMFCVisualManager [MFC], GetMDITabsBordersSize", "CMFCVisualManager [MFC], GetMenuItemTextColor", "CMFCVisualManager [MFC], GetMenuShadowDepth", "CMFCVisualManager [MFC], GetNcBtnSize", "CMFCVisualManager [MFC], GetPopupMenuBorderSize", "CMFCVisualManager [MFC], GetPropertyGridGroupColor", "CMFCVisualManager [MFC], GetPropertyGridGroupTextColor", "CMFCVisualManager [MFC], GetRibbonHyperlinkTextColor", "CMFCVisualManager [MFC], GetRibbonPopupBorderSize", "CMFCVisualManager [MFC], GetRibbonQuickAccessToolBarTextColor", "CMFCVisualManager [MFC], GetRibbonSliderColors", "CMFCVisualManager [MFC], GetShowAllMenuItemsHeight", "CMFCVisualManager [MFC], GetSmartDockingBaseGuideColors", "CMFCVisualManager [MFC], GetSmartDockingHighlightToneColor", "CMFCVisualManager [MFC], GetSmartDockingTheme", "CMFCVisualManager [MFC], GetStatusBarPaneTextColor", "CMFCVisualManager [MFC], GetTabFrameColors", "CMFCVisualManager [MFC], GetTabTextColor", "CMFCVisualManager [MFC], GetToolbarButtonTextColor", "CMFCVisualManager [MFC], GetToolbarDisabledTextColor", "CMFCVisualManager [MFC], GetToolbarHighlightColor", "CMFCVisualManager [MFC], GetToolTipInfo", "CMFCVisualManager [MFC], HasOverlappedAutoHideButtons", "CMFCVisualManager [MFC], IsDockingTabHasBorder", "CMFCVisualManager [MFC], IsEmbossDisabledImage", "CMFCVisualManager [MFC], IsFadeInactiveImage", "CMFCVisualManager [MFC], IsMenuFlatLook", "CMFCVisualManager [MFC], IsOfficeXPStyleMenus", "CMFCVisualManager [MFC], IsOwnerDrawCaption", "CMFCVisualManager [MFC], IsShadowHighlightedImage", "CMFCVisualManager [MFC], OnDrawAutoHideButtonBorder", "CMFCVisualManager [MFC], OnDrawBarGripper", "CMFCVisualManager [MFC], OnDrawBrowseButton", "CMFCVisualManager [MFC], OnDrawButtonBorder", "CMFCVisualManager [MFC], OnDrawButtonSeparator", "CMFCVisualManager [MFC], OnDrawCaptionBarBorder", "CMFCVisualManager [MFC], OnDrawCaptionBarButtonBorder", "CMFCVisualManager [MFC], OnDrawCaptionBarInfoArea", "CMFCVisualManager [MFC], OnDrawCaptionButton", "CMFCVisualManager [MFC], OnDrawCheckBox", "CMFCVisualManager [MFC], OnDrawCheckBoxEx", "CMFCVisualManager [MFC], OnDrawComboBorder", "CMFCVisualManager [MFC], OnDrawComboDropButton", "CMFCVisualManager [MFC], OnDrawControlBorder", "CMFCVisualManager [MFC], OnDrawDefaultRibbonImage", "CMFCVisualManager [MFC], OnDrawEditBorder", "CMFCVisualManager [MFC], OnDrawExpandingBox", "CMFCVisualManager [MFC], OnDrawFloatingToolbarBorder", "CMFCVisualManager [MFC], OnDrawHeaderCtrlBorder", "CMFCVisualManager [MFC], OnDrawHeaderCtrlSortArrow", "CMFCVisualManager [MFC], OnDrawMenuArrowOnCustomizeList", "CMFCVisualManager [MFC], OnDrawMenuBorder", "CMFCVisualManager [MFC], OnDrawMenuCheck", "CMFCVisualManager [MFC], OnDrawMenuItemButton", "CMFCVisualManager [MFC], OnDrawMenuLabel", "CMFCVisualManager [MFC], OnDrawMenuResizeBar", "CMFCVisualManager [MFC], OnDrawMenuScrollButton", "CMFCVisualManager [MFC], OnDrawMenuShadow", "CMFCVisualManager [MFC], OnDrawMenuSystemButton", "CMFCVisualManager [MFC], OnDrawMiniFrameBorder", "CMFCVisualManager [MFC], OnDrawOutlookBarSplitter", "CMFCVisualManager [MFC], OnDrawOutlookPageButtonBorder", "CMFCVisualManager [MFC], OnDrawPaneBorder", "CMFCVisualManager [MFC], OnDrawPaneCaption", "CMFCVisualManager [MFC], OnDrawPaneDivider", "CMFCVisualManager [MFC], OnDrawPopupWindowBorder", "CMFCVisualManager [MFC], OnDrawPopupWindowButtonBorder", "CMFCVisualManager [MFC], OnDrawPopupWindowCaption", "CMFCVisualManager [MFC], OnDrawRibbonApplicationButton", "CMFCVisualManager [MFC], OnDrawRibbonButtonBorder", "CMFCVisualManager [MFC], OnDrawRibbonButtonsGroup", "CMFCVisualManager [MFC], OnDrawRibbonCaption", "CMFCVisualManager [MFC], OnDrawRibbonCaptionButton", "CMFCVisualManager [MFC], OnDrawRibbonCategory", "CMFCVisualManager [MFC], OnDrawRibbonCategoryCaption", "CMFCVisualManager [MFC], OnDrawRibbonCategoryScroll", "CMFCVisualManager [MFC], OnDrawRibbonCategoryTab", "CMFCVisualManager [MFC], OnDrawRibbonCheckBoxOnList", "CMFCVisualManager [MFC], OnDrawRibbonColorPaletteBox", "CMFCVisualManager [MFC], OnDrawRibbonDefaultPaneButtonContext", "CMFCVisualManager [MFC], OnDrawRibbonDefaultPaneButton", "CMFCVisualManager [MFC], OnDrawRibbonDefaultPaneButtonIndicator", "CMFCVisualManager [MFC], OnDrawRibbonGalleryBorder", "CMFCVisualManager [MFC], OnDrawRibbonGalleryButton", "CMFCVisualManager [MFC], OnDrawRibbonKeyTip", "CMFCVisualManager [MFC], OnDrawRibbonLabel", "CMFCVisualManager [MFC], OnDrawRibbonMainPanelButtonBorder", "CMFCVisualManager [MFC], OnDrawRibbonMainPanelFrame", "CMFCVisualManager [MFC], OnDrawRibbonMenuCheckFrame", "CMFCVisualManager [MFC], OnDrawRibbonPanel", "CMFCVisualManager [MFC], OnDrawRibbonPanelCaption", "CMFCVisualManager [MFC], OnDrawRibbonProgressBar", "CMFCVisualManager [MFC], OnDrawRibbonQuickAccessToolBarSeparator", "CMFCVisualManager [MFC], OnDrawRibbonRecentFilesFrame", "CMFCVisualManager [MFC], OnDrawRibbonSliderChannel", "CMFCVisualManager [MFC], OnDrawRibbonSliderThumb", "CMFCVisualManager [MFC], OnDrawRibbonSliderZoomButton", "CMFCVisualManager [MFC], OnDrawRibbonStatusBarPane", "CMFCVisualManager [MFC], OnDrawRibbonTabsFrame", "CMFCVisualManager [MFC], OnDrawScrollButtons", "CMFCVisualManager [MFC], OnDrawSeparator", "CMFCVisualManager [MFC], OnDrawShowAllMenuItems", "CMFCVisualManager [MFC], OnDrawSpinButtons", "CMFCVisualManager [MFC], OnDrawSplitterBorder", "CMFCVisualManager [MFC], OnDrawSplitterBox", "CMFCVisualManager [MFC], OnDrawStatusBarPaneBorder", "CMFCVisualManager [MFC], OnDrawStatusBarProgress", "CMFCVisualManager [MFC], OnDrawStatusBarSizeBox", "CMFCVisualManager [MFC], OnDrawTab", "CMFCVisualManager [MFC], OnDrawTabCloseButton", "CMFCVisualManager [MFC], OnDrawTabContent", "CMFCVisualManager [MFC], OnDrawTabsButtonBorder", "CMFCVisualManager [MFC], OnDrawTask", "CMFCVisualManager [MFC], OnDrawTasksGroupAreaBorder", "CMFCVisualManager [MFC], OnDrawTasksGroupCaption", "CMFCVisualManager [MFC], OnDrawTasksGroupIcon", "CMFCVisualManager [MFC], OnDrawTearOffCaption", "CMFCVisualManager [MFC], OnDrawToolBoxFrame", "CMFCVisualManager [MFC], OnEraseMDIClientArea", "CMFCVisualManager [MFC], OnErasePopupWindowButton", "CMFCVisualManager [MFC], OnEraseTabsArea", "CMFCVisualManager [MFC], OnEraseTabsButton", "CMFCVisualManager [MFC], OnEraseTabsFrame", "CMFCVisualManager [MFC], OnFillAutoHideButtonBackground", "CMFCVisualManager [MFC], OnFillBarBackground", "CMFCVisualManager [MFC], OnFillButtonInterior", "CMFCVisualManager [MFC], OnFillCaptionBarButton", "CMFCVisualManager [MFC], OnFillCommandsListBackground", "CMFCVisualManager [MFC], OnFillHeaderCtrlBackground", "CMFCVisualManager [MFC], OnFillMiniFrameCaption", "CMFCVisualManager [MFC], OnFillOutlookBarCaption", "CMFCVisualManager [MFC], OnFillOutlookPageButton", "CMFCVisualManager [MFC], OnFillPopupWindowBackground", "CMFCVisualManager [MFC], OnFillRibbonButton", "CMFCVisualManager [MFC], OnFillRibbonEdit", "CMFCVisualManager [MFC], OnFillRibbonMainPanelButton", "CMFCVisualManager [MFC], OnFillRibbonMenuFrame", "CMFCVisualManager [MFC], OnFillRibbonQuickAccessToolBarPopup", "CMFCVisualManager [MFC], OnFillSplitterBackground", "CMFCVisualManager [MFC], OnFillTab", "CMFCVisualManager [MFC], OnFillTasksGroupInterior", "CMFCVisualManager [MFC], OnFillTasksPaneBackground", "CMFCVisualManager [MFC], OnHighlightMenuItem", "CMFCVisualManager [MFC], OnHighlightRarelyUsedMenuItems", "CMFCVisualManager [MFC], OnNcPaint", "CMFCVisualManager [MFC], OnSetWindowRegion", "CMFCVisualManager [MFC], OnUpdateSystemColors", "CMFCVisualManager [MFC], RedrawAll", "CMFCVisualManager [MFC], RibbonCategoryColorToRGB", "CMFCVisualManager [MFC], SetDefaultManager", "CMFCVisualManager [MFC], SetEmbossDisabledImage", "CMFCVisualManager [MFC], SetFadeInactiveImage", "CMFCVisualManager [MFC], SetMenuFlatLook", "CMFCVisualManager [MFC], SetMenuShadowDepth", "CMFCVisualManager [MFC], SetShadowHighlightedImage"] -ms.assetid: beed80f7-36a2-4d64-9f09-e807cfefc3fe --- # CMFCVisualManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides support for changing the appearance of your application at a global level. The `CMFCVisualManager` class works together with a class that provides instructions to draw the GUI controls of your application using a consistent style. These other classes are referred to as visual managers and they inherit from `CMFCBaseVisualManager`. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcvisualmanageroffice2003-class.md b/docs/mfc/reference/cmfcvisualmanageroffice2003-class.md index b7e77059dcf..3ae383f3c4c 100644 --- a/docs/mfc/reference/cmfcvisualmanageroffice2003-class.md +++ b/docs/mfc/reference/cmfcvisualmanageroffice2003-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMFCVisualManagerOffice2003 Class [MFC]"] --- # CMFCVisualManagerOffice2003 Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + `CMFCVisualManagerOffice2003` gives an application a Microsoft Office 2003 appearance. ## Syntax diff --git a/docs/mfc/reference/cmfcvisualmanageroffice2007-class.md b/docs/mfc/reference/cmfcvisualmanageroffice2007-class.md index b0620fe6b8f..ee13a6682b2 100644 --- a/docs/mfc/reference/cmfcvisualmanageroffice2007-class.md +++ b/docs/mfc/reference/cmfcvisualmanageroffice2007-class.md @@ -4,10 +4,12 @@ title: "CMFCVisualManagerOffice2007 Class" ms.date: "11/04/2016" f1_keywords: ["CMFCVisualManagerOffice2007", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::AlwaysHighlight3DTabs", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::CleanStyle", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetCaptionBarTextColor", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetHighlightedMenuItemTextColor", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetMenuItemTextColor", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetNcBtnSize", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetRibbonBar", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetRibbonHyperlinkTextColor", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetRibbonPopupBorderSize", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetRibbonQuickAccessToolBarChevronOffset", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetRibbonQuickAccessToolBarRightMargin", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetRibbonQuickAccessToolBarTextColor", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetRibbonStatusBarTextColor", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetShowAllMenuItemsHeight", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetStatusBarPaneTextColor", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetTabFrameColors", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetTabHorzMargin", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetTabTextColor", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetToolbarButtonTextColor", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetToolbarDisabledTextColor", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::GetToolTipInfo", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::IsHighlightWholeMenuItem", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::IsLayeredRibbonKeyTip", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::IsOwnerDrawCaption", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::IsOwnerDrawMenuCheck", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::IsRibbonPresent", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawBarGripper", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawButtonBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawButtonSeparator", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawCaptionBarInfoArea", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawCheckBoxEx", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawComboBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawComboDropButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawDefaultRibbonImage", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawEditBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawFloatingToolbarBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawHeaderCtrlBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawMenuBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawMenuCheck", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawMenuItemButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawMenuLabel", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawMenuResizeBar", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawMenuScrollButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawMenuSystemButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawMiniFrameBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawOutlookBarSplitter", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawOutlookPageButtonBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawPaneCaption", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawPopupWindowCaption", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawPropertySheetListItem", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonApplicationButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonButtonBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonButtonsGroup", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonCaption", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonCaptionButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonCategory", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonCategoryCaption", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonCategoryScroll", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonCategoryTab", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonCheckBoxOnList", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonDefaultPaneButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonDefaultPaneButtonIndicator", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonGalleryBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonGalleryButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonKeyTip", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonMainPanelButtonBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonMainPanelFrame", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonMenuCheckFrame", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonPanel", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonPanelCaption", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonProgressBar", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonRecentFilesFrame", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonSliderChannel", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonSliderThumb", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonSliderZoomButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonStatusBarPane", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawRibbonTabsFrame", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawScrollButtons", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawSeparator", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawShowAllMenuItems", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawStatusBarPaneBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawStatusBarSizeBox", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawTab", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawTabsButtonBorder", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawTask", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawTasksGroupCaption", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnDrawTearOffCaption", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnEraseMDIClientArea", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnEraseTabsArea", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnEraseTabsButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnEraseTabsFrame", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillBarBackground", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillButtonInterior", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillCaptionBarButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillHighlightedArea", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillMiniFrameCaption", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillOutlookBarCaption", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillOutlookPageButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillPopupWindowBackground", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillRibbonButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillRibbonEdit", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillRibbonMainPanelButton", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillRibbonMenuFrame", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillRibbonQuickAccessToolBarPopup", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnFillTab", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnHighlightMenuItem", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnHighlightRarelyUsedMenuItems", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnNcActivate", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnNcPaint", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnSetWindowRegion", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::OnUpdateSystemColors", "AFXVISUALMANAGEROFFICE2007/CMFCVisualManagerOffice2007::SetResourceHandle"] helpviewer_keywords: ["CMFCVisualManagerOffice2007 [MFC], AlwaysHighlight3DTabs", "CMFCVisualManagerOffice2007 [MFC], CleanStyle", "CMFCVisualManagerOffice2007 [MFC], GetCaptionBarTextColor", "CMFCVisualManagerOffice2007 [MFC], GetHighlightedMenuItemTextColor", "CMFCVisualManagerOffice2007 [MFC], GetMenuItemTextColor", "CMFCVisualManagerOffice2007 [MFC], GetNcBtnSize", "CMFCVisualManagerOffice2007 [MFC], GetRibbonBar", "CMFCVisualManagerOffice2007 [MFC], GetRibbonHyperlinkTextColor", "CMFCVisualManagerOffice2007 [MFC], GetRibbonPopupBorderSize", "CMFCVisualManagerOffice2007 [MFC], GetRibbonQuickAccessToolBarChevronOffset", "CMFCVisualManagerOffice2007 [MFC], GetRibbonQuickAccessToolBarRightMargin", "CMFCVisualManagerOffice2007 [MFC], GetRibbonQuickAccessToolBarTextColor", "CMFCVisualManagerOffice2007 [MFC], GetRibbonStatusBarTextColor", "CMFCVisualManagerOffice2007 [MFC], GetShowAllMenuItemsHeight", "CMFCVisualManagerOffice2007 [MFC], GetStatusBarPaneTextColor", "CMFCVisualManagerOffice2007 [MFC], GetTabFrameColors", "CMFCVisualManagerOffice2007 [MFC], GetTabHorzMargin", "CMFCVisualManagerOffice2007 [MFC], GetTabTextColor", "CMFCVisualManagerOffice2007 [MFC], GetToolbarButtonTextColor", "CMFCVisualManagerOffice2007 [MFC], GetToolbarDisabledTextColor", "CMFCVisualManagerOffice2007 [MFC], GetToolTipInfo", "CMFCVisualManagerOffice2007 [MFC], IsHighlightWholeMenuItem", "CMFCVisualManagerOffice2007 [MFC], IsLayeredRibbonKeyTip", "CMFCVisualManagerOffice2007 [MFC], IsOwnerDrawCaption", "CMFCVisualManagerOffice2007 [MFC], IsOwnerDrawMenuCheck", "CMFCVisualManagerOffice2007 [MFC], IsRibbonPresent", "CMFCVisualManagerOffice2007 [MFC], OnDrawBarGripper", "CMFCVisualManagerOffice2007 [MFC], OnDrawButtonBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawButtonSeparator", "CMFCVisualManagerOffice2007 [MFC], OnDrawCaptionBarInfoArea", "CMFCVisualManagerOffice2007 [MFC], OnDrawCheckBoxEx", "CMFCVisualManagerOffice2007 [MFC], OnDrawComboBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawComboDropButton", "CMFCVisualManagerOffice2007 [MFC], OnDrawDefaultRibbonImage", "CMFCVisualManagerOffice2007 [MFC], OnDrawEditBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawFloatingToolbarBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawHeaderCtrlBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawMenuBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawMenuCheck", "CMFCVisualManagerOffice2007 [MFC], OnDrawMenuItemButton", "CMFCVisualManagerOffice2007 [MFC], OnDrawMenuLabel", "CMFCVisualManagerOffice2007 [MFC], OnDrawMenuResizeBar", "CMFCVisualManagerOffice2007 [MFC], OnDrawMenuScrollButton", "CMFCVisualManagerOffice2007 [MFC], OnDrawMenuSystemButton", "CMFCVisualManagerOffice2007 [MFC], OnDrawMiniFrameBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawOutlookBarSplitter", "CMFCVisualManagerOffice2007 [MFC], OnDrawOutlookPageButtonBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawPaneCaption", "CMFCVisualManagerOffice2007 [MFC], OnDrawPopupWindowCaption", "CMFCVisualManagerOffice2007 [MFC], OnDrawPropertySheetListItem", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonApplicationButton", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonButtonBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonButtonsGroup", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonCaption", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonCaptionButton", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonCategory", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonCategoryCaption", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonCategoryScroll", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonCategoryTab", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonCheckBoxOnList", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonDefaultPaneButton", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonDefaultPaneButtonIndicator", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonGalleryBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonGalleryButton", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonKeyTip", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonMainPanelButtonBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonMainPanelFrame", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonMenuCheckFrame", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonPanel", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonPanelCaption", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonProgressBar", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonRecentFilesFrame", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonSliderChannel", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonSliderThumb", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonSliderZoomButton", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonStatusBarPane", "CMFCVisualManagerOffice2007 [MFC], OnDrawRibbonTabsFrame", "CMFCVisualManagerOffice2007 [MFC], OnDrawScrollButtons", "CMFCVisualManagerOffice2007 [MFC], OnDrawSeparator", "CMFCVisualManagerOffice2007 [MFC], OnDrawShowAllMenuItems", "CMFCVisualManagerOffice2007 [MFC], OnDrawStatusBarPaneBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawStatusBarSizeBox", "CMFCVisualManagerOffice2007 [MFC], OnDrawTab", "CMFCVisualManagerOffice2007 [MFC], OnDrawTabsButtonBorder", "CMFCVisualManagerOffice2007 [MFC], OnDrawTask", "CMFCVisualManagerOffice2007 [MFC], OnDrawTasksGroupCaption", "CMFCVisualManagerOffice2007 [MFC], OnDrawTearOffCaption", "CMFCVisualManagerOffice2007 [MFC], OnEraseMDIClientArea", "CMFCVisualManagerOffice2007 [MFC], OnEraseTabsArea", "CMFCVisualManagerOffice2007 [MFC], OnEraseTabsButton", "CMFCVisualManagerOffice2007 [MFC], OnEraseTabsFrame", "CMFCVisualManagerOffice2007 [MFC], OnFillBarBackground", "CMFCVisualManagerOffice2007 [MFC], OnFillButtonInterior", "CMFCVisualManagerOffice2007 [MFC], OnFillCaptionBarButton", "CMFCVisualManagerOffice2007 [MFC], OnFillHighlightedArea", "CMFCVisualManagerOffice2007 [MFC], OnFillMiniFrameCaption", "CMFCVisualManagerOffice2007 [MFC], OnFillOutlookBarCaption", "CMFCVisualManagerOffice2007 [MFC], OnFillOutlookPageButton", "CMFCVisualManagerOffice2007 [MFC], OnFillPopupWindowBackground", "CMFCVisualManagerOffice2007 [MFC], OnFillRibbonButton", "CMFCVisualManagerOffice2007 [MFC], OnFillRibbonEdit", "CMFCVisualManagerOffice2007 [MFC], OnFillRibbonMainPanelButton", "CMFCVisualManagerOffice2007 [MFC], OnFillRibbonMenuFrame", "CMFCVisualManagerOffice2007 [MFC], OnFillRibbonQuickAccessToolBarPopup", "CMFCVisualManagerOffice2007 [MFC], OnFillTab", "CMFCVisualManagerOffice2007 [MFC], OnHighlightMenuItem", "CMFCVisualManagerOffice2007 [MFC], OnHighlightRarelyUsedMenuItems", "CMFCVisualManagerOffice2007 [MFC], OnNcActivate", "CMFCVisualManagerOffice2007 [MFC], OnNcPaint", "CMFCVisualManagerOffice2007 [MFC], OnSetWindowRegion", "CMFCVisualManagerOffice2007 [MFC], OnUpdateSystemColors", "CMFCVisualManagerOffice2007 [MFC], SetResourceHandle"] -ms.assetid: fb687c74-6d08-4c72-8acf-27f75dda6d6b --- # CMFCVisualManagerOffice2007 Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + `CMFCVisualManagerOffice2007` gives an application a Microsoft Office 2007 appearance. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcvisualmanagerofficexp-class.md b/docs/mfc/reference/cmfcvisualmanagerofficexp-class.md index ed358d6d4d4..4639abf5286 100644 --- a/docs/mfc/reference/cmfcvisualmanagerofficexp-class.md +++ b/docs/mfc/reference/cmfcvisualmanagerofficexp-class.md @@ -4,10 +4,12 @@ title: "CMFCVisualManagerOfficeXP Class" ms.date: "11/04/2016" f1_keywords: ["CMFCVisualManagerOfficeXP"] helpviewer_keywords: ["CMFCVisualManagerOfficeXP class [MFC]"] -ms.assetid: 46b6f854-37c2-4836-8f56-5cb6ff63c9af --- # CMFCVisualManagerOfficeXP Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCVisualManagerOfficeXP` gives an application a Microsoft Office XP appearance. ## Syntax diff --git a/docs/mfc/reference/cmfcvisualmanagervs2005-class.md b/docs/mfc/reference/cmfcvisualmanagervs2005-class.md index 4f612c6a6dc..0fd63adf20a 100644 --- a/docs/mfc/reference/cmfcvisualmanagervs2005-class.md +++ b/docs/mfc/reference/cmfcvisualmanagervs2005-class.md @@ -4,10 +4,12 @@ title: "CMFCVisualManagerVS2005 Class" ms.date: "11/04/2016" f1_keywords: ["CMFCVisualManagerVS2005", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::GetDockingTabsBordersSize", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::GetMDITabsBordersSize", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::GetPropertyGridGroupColor", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::GetTabFrameColors", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::HasOverlappedAutoHideButtons", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnDrawAutoHideButtonBorder", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnDrawCaptionButton", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnDrawPaneCaption", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnDrawSeparator", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnDrawTab", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnDrawToolBoxFrame", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnEraseTabsArea", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnFillAutoHideButtonBackground", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnFillHighlightedArea", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnFillMiniFrameCaption", "AFXVISUALMANAGERVS2005/CMFCVisualManagerVS2005::OnUpdateSystemColors"] helpviewer_keywords: ["CMFCVisualManagerVS2005 [MFC], GetDockingTabsBordersSize", "CMFCVisualManagerVS2005 [MFC], GetMDITabsBordersSize", "CMFCVisualManagerVS2005 [MFC], GetPropertyGridGroupColor", "CMFCVisualManagerVS2005 [MFC], GetTabFrameColors", "CMFCVisualManagerVS2005 [MFC], HasOverlappedAutoHideButtons", "CMFCVisualManagerVS2005 [MFC], OnDrawAutoHideButtonBorder", "CMFCVisualManagerVS2005 [MFC], OnDrawCaptionButton", "CMFCVisualManagerVS2005 [MFC], OnDrawPaneCaption", "CMFCVisualManagerVS2005 [MFC], OnDrawSeparator", "CMFCVisualManagerVS2005 [MFC], OnDrawTab", "CMFCVisualManagerVS2005 [MFC], OnDrawToolBoxFrame", "CMFCVisualManagerVS2005 [MFC], OnEraseTabsArea", "CMFCVisualManagerVS2005 [MFC], OnFillAutoHideButtonBackground", "CMFCVisualManagerVS2005 [MFC], OnFillHighlightedArea", "CMFCVisualManagerVS2005 [MFC], OnFillMiniFrameCaption", "CMFCVisualManagerVS2005 [MFC], OnUpdateSystemColors"] -ms.assetid: ea39b9ae-327e-4a51-bce7-dc84c78f005b --- # CMFCVisualManagerVS2005 Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + `CMFCVisualManagerVS2005` gives an application a Microsoft Visual Studio 2005 appearance. ## Syntax diff --git a/docs/mfc/reference/cmfcvisualmanagerwindows-class.md b/docs/mfc/reference/cmfcvisualmanagerwindows-class.md index 6579ed1aba2..0149e9a9721 100644 --- a/docs/mfc/reference/cmfcvisualmanagerwindows-class.md +++ b/docs/mfc/reference/cmfcvisualmanagerwindows-class.md @@ -4,10 +4,12 @@ title: "CMFCVisualManagerWindows Class" ms.date: "11/04/2016" f1_keywords: ["CMFCVisualManagerWindows", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::AlwaysHighlight3DTabs", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::DrawComboBorderWinXP", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::DrawComboDropButtonWinXP", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::DrawPushButtonWinXP", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::GetButtonExtraBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::GetCaptionButtonExtraBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::GetDockingPaneCaptionExtraHeight", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::GetHighlightedMenuItemTextColor", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::GetPopupMenuGap", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::GetToolbarButtonTextColor", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::IsDefaultWinXPPopupButton", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::IsHighlightWholeMenuItem", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::IsOfficeStyleMenus", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::IsOfficeXPStyleMenus", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::IsWindowsThemingSupported", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::IsWinXPThemeAvailable", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawBarGripper", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawBrowseButton", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawButtonBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawButtonSeparator", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawCaptionButton", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawCaptionButtonIcon", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawCheckBoxEx", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawComboBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawComboDropButton", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawControlBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawEditBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawExpandingBox", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawFloatingToolbarBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawHeaderCtrlBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawHeaderCtrlSortArrow", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawMenuBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawMenuSystemButton", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawMiniFrameBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawOutlookPageButtonBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawPaneBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawPaneCaption", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawPopupWindowButtonBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawScrollButtons", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawSeparator", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawSpinButtons", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawStatusBarPaneBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawStatusBarProgress", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawStatusBarSizeBox", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawTab", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawTabCloseButton", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawTabsButtonBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawTask", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawTasksGroupAreaBorder", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawTasksGroupCaption", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnDrawTearOffCaption", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnErasePopupWindowButton", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnEraseTabsArea", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnEraseTabsButton", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnEraseTabsFrame", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnFillBarBackground", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnFillButtonInterior", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnFillCommandsListBackground", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnFillMiniFrameCaption", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnFillOutlookPageButton", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnFillTasksGroupInterior", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnFillTasksPaneBackground", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnHighlightMenuItem", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnHighlightRarelyUsedMenuItems", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::OnUpdateSystemColors", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::SetOfficeStyleMenus", "AFXVISUALMANAGERWINDOWS/CMFCVisualManagerWindows::m_b3DTabsXPTheme"] helpviewer_keywords: ["CMFCVisualManagerWindows [MFC], AlwaysHighlight3DTabs", "CMFCVisualManagerWindows [MFC], DrawComboBorderWinXP", "CMFCVisualManagerWindows [MFC], DrawComboDropButtonWinXP", "CMFCVisualManagerWindows [MFC], DrawPushButtonWinXP", "CMFCVisualManagerWindows [MFC], GetButtonExtraBorder", "CMFCVisualManagerWindows [MFC], GetCaptionButtonExtraBorder", "CMFCVisualManagerWindows [MFC], GetDockingPaneCaptionExtraHeight", "CMFCVisualManagerWindows [MFC], GetHighlightedMenuItemTextColor", "CMFCVisualManagerWindows [MFC], GetPopupMenuGap", "CMFCVisualManagerWindows [MFC], GetToolbarButtonTextColor", "CMFCVisualManagerWindows [MFC], IsDefaultWinXPPopupButton", "CMFCVisualManagerWindows [MFC], IsHighlightWholeMenuItem", "CMFCVisualManagerWindows [MFC], IsOfficeStyleMenus", "CMFCVisualManagerWindows [MFC], IsOfficeXPStyleMenus", "CMFCVisualManagerWindows [MFC], IsWindowsThemingSupported", "CMFCVisualManagerWindows [MFC], IsWinXPThemeAvailable", "CMFCVisualManagerWindows [MFC], OnDrawBarGripper", "CMFCVisualManagerWindows [MFC], OnDrawBrowseButton", "CMFCVisualManagerWindows [MFC], OnDrawButtonBorder", "CMFCVisualManagerWindows [MFC], OnDrawButtonSeparator", "CMFCVisualManagerWindows [MFC], OnDrawCaptionButton", "CMFCVisualManagerWindows [MFC], OnDrawCaptionButtonIcon", "CMFCVisualManagerWindows [MFC], OnDrawCheckBoxEx", "CMFCVisualManagerWindows [MFC], OnDrawComboBorder", "CMFCVisualManagerWindows [MFC], OnDrawComboDropButton", "CMFCVisualManagerWindows [MFC], OnDrawControlBorder", "CMFCVisualManagerWindows [MFC], OnDrawEditBorder", "CMFCVisualManagerWindows [MFC], OnDrawExpandingBox", "CMFCVisualManagerWindows [MFC], OnDrawFloatingToolbarBorder", "CMFCVisualManagerWindows [MFC], OnDrawHeaderCtrlBorder", "CMFCVisualManagerWindows [MFC], OnDrawHeaderCtrlSortArrow", "CMFCVisualManagerWindows [MFC], OnDrawMenuBorder", "CMFCVisualManagerWindows [MFC], OnDrawMenuSystemButton", "CMFCVisualManagerWindows [MFC], OnDrawMiniFrameBorder", "CMFCVisualManagerWindows [MFC], OnDrawOutlookPageButtonBorder", "CMFCVisualManagerWindows [MFC], OnDrawPaneBorder", "CMFCVisualManagerWindows [MFC], OnDrawPaneCaption", "CMFCVisualManagerWindows [MFC], OnDrawPopupWindowButtonBorder", "CMFCVisualManagerWindows [MFC], OnDrawScrollButtons", "CMFCVisualManagerWindows [MFC], OnDrawSeparator", "CMFCVisualManagerWindows [MFC], OnDrawSpinButtons", "CMFCVisualManagerWindows [MFC], OnDrawStatusBarPaneBorder", "CMFCVisualManagerWindows [MFC], OnDrawStatusBarProgress", "CMFCVisualManagerWindows [MFC], OnDrawStatusBarSizeBox", "CMFCVisualManagerWindows [MFC], OnDrawTab", "CMFCVisualManagerWindows [MFC], OnDrawTabCloseButton", "CMFCVisualManagerWindows [MFC], OnDrawTabsButtonBorder", "CMFCVisualManagerWindows [MFC], OnDrawTask", "CMFCVisualManagerWindows [MFC], OnDrawTasksGroupAreaBorder", "CMFCVisualManagerWindows [MFC], OnDrawTasksGroupCaption", "CMFCVisualManagerWindows [MFC], OnDrawTearOffCaption", "CMFCVisualManagerWindows [MFC], OnErasePopupWindowButton", "CMFCVisualManagerWindows [MFC], OnEraseTabsArea", "CMFCVisualManagerWindows [MFC], OnEraseTabsButton", "CMFCVisualManagerWindows [MFC], OnEraseTabsFrame", "CMFCVisualManagerWindows [MFC], OnFillBarBackground", "CMFCVisualManagerWindows [MFC], OnFillButtonInterior", "CMFCVisualManagerWindows [MFC], OnFillCommandsListBackground", "CMFCVisualManagerWindows [MFC], OnFillMiniFrameCaption", "CMFCVisualManagerWindows [MFC], OnFillOutlookPageButton", "CMFCVisualManagerWindows [MFC], OnFillTasksGroupInterior", "CMFCVisualManagerWindows [MFC], OnFillTasksPaneBackground", "CMFCVisualManagerWindows [MFC], OnHighlightMenuItem", "CMFCVisualManagerWindows [MFC], OnHighlightRarelyUsedMenuItems", "CMFCVisualManagerWindows [MFC], OnUpdateSystemColors", "CMFCVisualManagerWindows [MFC], SetOfficeStyleMenus", "CMFCVisualManagerWindows [MFC], m_b3DTabsXPTheme"] -ms.assetid: 568b6e9e-8e67-4477-9a3d-2981cbd09861 --- # CMFCVisualManagerWindows Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + `CMFCVisualManagerWindows` mimics the appearance of Microsoft Windows XP or Microsoft Vista when the user selects a Windows XP or Vista theme. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmfcvisualmanagerwindows7-class.md b/docs/mfc/reference/cmfcvisualmanagerwindows7-class.md index d354cd2cc54..d2e9935e2e3 100644 --- a/docs/mfc/reference/cmfcvisualmanagerwindows7-class.md +++ b/docs/mfc/reference/cmfcvisualmanagerwindows7-class.md @@ -4,10 +4,12 @@ title: "CMFCVisualManagerWindows7 Class" ms.date: "03/27/2019" f1_keywords: ["CMFCVisualManagerWindows7", "AFXVISUALMANAGERWINDOWS7/CMFCVisualManagerWindows7", "AFXVISUALMANAGERWINDOWS7/CMFCVisualManagerWindows7::CMFCVisualManagerWindows7", "AFXVISUALMANAGERWINDOWS7/CMFCVisualManagerWindows7::GetRibbonEditBackgroundColor", "AFXVISUALMANAGERWINDOWS7/CMFCVisualManagerWindows7::OnFillMenuImageRect"] helpviewer_keywords: ["CMFCVisualManagerWindows7 Class [MFC]"] -ms.assetid: e8d87df1-0c09-4b58-8ade-4e911f796e42 --- # CMFCVisualManagerWindows7 Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCVisualManagerWindows7` gives an application the appearance of a Windows 7 application. ## Syntax diff --git a/docs/mfc/reference/cmfcwindowsmanagerdialog-class.md b/docs/mfc/reference/cmfcwindowsmanagerdialog-class.md index 3e82d4901f0..6e5f503419b 100644 --- a/docs/mfc/reference/cmfcwindowsmanagerdialog-class.md +++ b/docs/mfc/reference/cmfcwindowsmanagerdialog-class.md @@ -4,10 +4,12 @@ title: "CMFCWindowsManagerDialog Class" ms.date: "11/04/2016" f1_keywords: ["CMFCWindowsManagerDialog", "AFXWINDOWSMANAGERDIALOG/CMFCWindowsManagerDialog", "AFXWINDOWSMANAGERDIALOG/CMFCWindowsManagerDialog::CMFCWindowsManagerDialog"] helpviewer_keywords: ["CMFCWindowsManagerDialog [MFC], CMFCWindowsManagerDialog"] -ms.assetid: 35b4b0db-33c4-4b22-94d8-5e3396341340 --- # CMFCWindowsManagerDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMFCWindowsManagerDialog` object enables a user to manage MDI child windows in a MDI application. ## Syntax diff --git a/docs/mfc/reference/cminiframewnd-class.md b/docs/mfc/reference/cminiframewnd-class.md index c62e43effd8..ba3f3abbdb4 100644 --- a/docs/mfc/reference/cminiframewnd-class.md +++ b/docs/mfc/reference/cminiframewnd-class.md @@ -4,10 +4,12 @@ title: "CMiniFrameWnd Class" ms.date: "11/04/2016" f1_keywords: ["CMiniFrameWnd", "AFXWIN/CMiniFrameWnd", "AFXWIN/CMiniFrameWnd::CMiniFrameWnd", "AFXWIN/CMiniFrameWnd::Create", "AFXWIN/CMiniFrameWnd::CreateEx"] helpviewer_keywords: ["CMiniFrameWnd [MFC], CMiniFrameWnd", "CMiniFrameWnd [MFC], Create", "CMiniFrameWnd [MFC], CreateEx"] -ms.assetid: b8f534ed-0532-4d8e-9657-5595cf677749 --- # CMiniFrameWnd Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a half-height frame window typically seen around floating toolbars. ## Syntax diff --git a/docs/mfc/reference/cmonikerfile-class.md b/docs/mfc/reference/cmonikerfile-class.md index 56e7b9dac14..74ff22caf0c 100644 --- a/docs/mfc/reference/cmonikerfile-class.md +++ b/docs/mfc/reference/cmonikerfile-class.md @@ -4,10 +4,12 @@ title: "CMonikerFile Class" ms.date: "11/04/2016" f1_keywords: ["CMonikerFile", "AFXOLE/CMonikerFile", "AFXOLE/CMonikerFile::CMonikerFile", "AFXOLE/CMonikerFile::Close", "AFXOLE/CMonikerFile::Detach", "AFXOLE/CMonikerFile::GetMoniker", "AFXOLE/CMonikerFile::Open", "AFXOLE/CMonikerFile::CreateBindContext"] helpviewer_keywords: ["CMonikerFile [MFC], CMonikerFile", "CMonikerFile [MFC], Close", "CMonikerFile [MFC], Detach", "CMonikerFile [MFC], GetMoniker", "CMonikerFile [MFC], Open", "CMonikerFile [MFC], CreateBindContext"] -ms.assetid: 87be5966-f4f7-4235-bce2-1fa39e9417de --- # CMonikerFile Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a stream of data ( [IStream](/windows/win32/api/objidl/nn-objidl-istream)) named by an [IMoniker](/windows/win32/api/objidl/nn-objidl-imoniker). ## Syntax diff --git a/docs/mfc/reference/cmonthcalctrl-class.md b/docs/mfc/reference/cmonthcalctrl-class.md index e9ce4d517d5..033259412cf 100644 --- a/docs/mfc/reference/cmonthcalctrl-class.md +++ b/docs/mfc/reference/cmonthcalctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMonthCalCtrl [MFC], CMonthCalCtrl", "CMonthCalCtrl [MFC] --- # CMonthCalCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the functionality of a month calendar control. ## Syntax diff --git a/docs/mfc/reference/cmousemanager-class.md b/docs/mfc/reference/cmousemanager-class.md index 92e14a9af3f..1f133903fae 100644 --- a/docs/mfc/reference/cmousemanager-class.md +++ b/docs/mfc/reference/cmousemanager-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CMouseManager [MFC], AddView", "CMouseManager [MFC], GetV --- # CMouseManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Allows a user to associate different commands with a particular [CView](../../mfc/reference/cview-class.md) object when the user double-clicks inside that view. ## Syntax diff --git a/docs/mfc/reference/cmultidoctemplate-class.md b/docs/mfc/reference/cmultidoctemplate-class.md index c103e3e9a82..532ac98e884 100644 --- a/docs/mfc/reference/cmultidoctemplate-class.md +++ b/docs/mfc/reference/cmultidoctemplate-class.md @@ -4,10 +4,12 @@ title: "CMultiDocTemplate Class" ms.date: "11/04/2016" f1_keywords: ["CMultiDocTemplate", "AFXWIN/CMultiDocTemplate", "AFXWIN/CMultiDocTemplate::CMultiDocTemplate"] helpviewer_keywords: ["CMultiDocTemplate [MFC], CMultiDocTemplate"] -ms.assetid: 5b8aa328-e461-41d0-b388-00594535e119 --- # CMultiDocTemplate Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Defines a document template that implements the multiple document interface (MDI). ## Syntax diff --git a/docs/mfc/reference/cmultilock-class.md b/docs/mfc/reference/cmultilock-class.md index c59e02672be..f04a88f1b54 100644 --- a/docs/mfc/reference/cmultilock-class.md +++ b/docs/mfc/reference/cmultilock-class.md @@ -4,10 +4,12 @@ title: "CMultiLock Class" ms.date: "11/04/2016" f1_keywords: ["CMultiLock", "AFXMT/CMultiLock", "AFXMT/CMultiLock::CMultiLock", "AFXMT/CMultiLock::IsLocked", "AFXMT/CMultiLock::Lock", "AFXMT/CMultiLock::Unlock"] helpviewer_keywords: ["CMultiLock [MFC], CMultiLock", "CMultiLock [MFC], IsLocked", "CMultiLock [MFC], Lock", "CMultiLock [MFC], Unlock"] -ms.assetid: c5b7c78b-1f81-4387-b7dd-2c813c5b6b61 --- # CMultiLock Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents the access-control mechanism used in controlling access to resources in a multithreaded program. ## Syntax diff --git a/docs/mfc/reference/cmultipagedhtmldialog-class.md b/docs/mfc/reference/cmultipagedhtmldialog-class.md index b47ead03872..328f588d532 100644 --- a/docs/mfc/reference/cmultipagedhtmldialog-class.md +++ b/docs/mfc/reference/cmultipagedhtmldialog-class.md @@ -4,10 +4,12 @@ title: "CMultiPageDHtmlDialog Class" ms.date: "03/27/2019" f1_keywords: ["CMultiPageDHtmlDialog", "AFXDHTML/CMultiPageDHtmlDialog", "AFXDHTML/CMultiPageDHtmlDialog::CMultiPageDHtmlDialog"] helpviewer_keywords: ["CMultiPageDHtmlDialog [MFC], CMultiPageDHtmlDialog"] -ms.assetid: 971accc1-824d-4df4-b4c1-b1a20e0f7e4f --- # CMultiPageDHtmlDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A multipage dialog displays multiple HTML pages sequentially and handles the events from each page. ## Syntax diff --git a/docs/mfc/reference/cmultipaneframewnd-class.md b/docs/mfc/reference/cmultipaneframewnd-class.md index 67427e554bf..f19fe3809ba 100644 --- a/docs/mfc/reference/cmultipaneframewnd-class.md +++ b/docs/mfc/reference/cmultipaneframewnd-class.md @@ -4,10 +4,12 @@ title: "CMultiPaneFrameWnd Class" ms.date: "11/04/2016" f1_keywords: ["CMultiPaneFrameWnd", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::AddPane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::AddRecentPane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::AdjustLayout", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::AdjustPaneFrames", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::CalcExpectedDockedRect", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::CanBeAttached", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::CanBeDockedToPane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::CheckGripperVisibility", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::CloseMiniFrame", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::ConvertToTabbedDocument", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::DockFrame", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::DockPane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::DockRecentPaneToMainFrame", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::GetCaptionText", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::GetPaneContainerManager", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::GetFirstVisiblePane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::GetPane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::GetPaneCount", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::GetVisiblePaneCount", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::InsertPane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::LoadState", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::OnDockToRecentPos", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::OnKillRollUpTimer", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::OnPaneRecalcLayout", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::OnSetRollUpTimer", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::OnShowPane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::PaneFromPoint", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::RemoveNonValidPanes", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::RemovePane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::ReplacePane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::SaveState", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::Serialize", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::SetDockState", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::SetLastFocusedPane", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::SetPreDockState", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::StoreRecentDockSiteInfo", "AFXMULTIPANEFRAMEWND/CMultiPaneFrameWnd::StoreRecentTabRelatedInfo"] helpviewer_keywords: ["CMultiPaneFrameWnd [MFC], AddPane", "CMultiPaneFrameWnd [MFC], AddRecentPane", "CMultiPaneFrameWnd [MFC], AdjustLayout", "CMultiPaneFrameWnd [MFC], AdjustPaneFrames", "CMultiPaneFrameWnd [MFC], CalcExpectedDockedRect", "CMultiPaneFrameWnd [MFC], CanBeAttached", "CMultiPaneFrameWnd [MFC], CanBeDockedToPane", "CMultiPaneFrameWnd [MFC], CheckGripperVisibility", "CMultiPaneFrameWnd [MFC], CloseMiniFrame", "CMultiPaneFrameWnd [MFC], ConvertToTabbedDocument", "CMultiPaneFrameWnd [MFC], DockFrame", "CMultiPaneFrameWnd [MFC], DockPane", "CMultiPaneFrameWnd [MFC], DockRecentPaneToMainFrame", "CMultiPaneFrameWnd [MFC], GetCaptionText", "CMultiPaneFrameWnd [MFC], GetPaneContainerManager", "CMultiPaneFrameWnd [MFC], GetFirstVisiblePane", "CMultiPaneFrameWnd [MFC], GetPane", "CMultiPaneFrameWnd [MFC], GetPaneCount", "CMultiPaneFrameWnd [MFC], GetVisiblePaneCount", "CMultiPaneFrameWnd [MFC], InsertPane", "CMultiPaneFrameWnd [MFC], LoadState", "CMultiPaneFrameWnd [MFC], OnDockToRecentPos", "CMultiPaneFrameWnd [MFC], OnKillRollUpTimer", "CMultiPaneFrameWnd [MFC], OnPaneRecalcLayout", "CMultiPaneFrameWnd [MFC], OnSetRollUpTimer", "CMultiPaneFrameWnd [MFC], OnShowPane", "CMultiPaneFrameWnd [MFC], PaneFromPoint", "CMultiPaneFrameWnd [MFC], RemoveNonValidPanes", "CMultiPaneFrameWnd [MFC], RemovePane", "CMultiPaneFrameWnd [MFC], ReplacePane", "CMultiPaneFrameWnd [MFC], SaveState", "CMultiPaneFrameWnd [MFC], Serialize", "CMultiPaneFrameWnd [MFC], SetDockState", "CMultiPaneFrameWnd [MFC], SetLastFocusedPane", "CMultiPaneFrameWnd [MFC], SetPreDockState", "CMultiPaneFrameWnd [MFC], StoreRecentDockSiteInfo", "CMultiPaneFrameWnd [MFC], StoreRecentTabRelatedInfo"] -ms.assetid: 989a548e-0d70-46b7-a513-8cf740e1be3e --- # CMultiPaneFrameWnd Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CMultiPaneFrameWnd` class extends [CPaneFrameWnd Class](../../mfc/reference/cpaneframewnd-class.md). It can support multiple panes. Instead of a single embedded handle to a control bar, `CMultiPaneFrameWnd` contains a [CPaneContainerManager Class](../../mfc/reference/cpanecontainermanager-class.md) object that enables the user to dock one `CMultiPaneFrameWnd` to another and dynamically create multiple floating, tabbed windows. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cmutex-class.md b/docs/mfc/reference/cmutex-class.md index a7267ffb085..e7a025cf985 100644 --- a/docs/mfc/reference/cmutex-class.md +++ b/docs/mfc/reference/cmutex-class.md @@ -4,10 +4,12 @@ title: "CMutex Class" ms.date: "11/04/2016" f1_keywords: ["CMutex", "AFXMT/CMutex", "AFXMT/CMutex::CMutex"] helpviewer_keywords: ["CMutex [MFC], CMutex"] -ms.assetid: 6330c050-4f01-4195-a099-2029b92f8cf1 --- # CMutex Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a "mutex" — a synchronization object that allows one thread mutually exclusive access to a resource. ## Syntax diff --git a/docs/mfc/reference/cnetaddressctrl-class.md b/docs/mfc/reference/cnetaddressctrl-class.md index 961b95a3943..97655606205 100644 --- a/docs/mfc/reference/cnetaddressctrl-class.md +++ b/docs/mfc/reference/cnetaddressctrl-class.md @@ -4,10 +4,12 @@ title: "CNetAddressCtrl Class" ms.date: "11/19/2018" f1_keywords: ["CNetAddressCtrl", "AFXCMN/CNetAddressCtrl", "AFXCMN/CNetAddressCtrl::CNetAddressCtrl", "AFXCMN/CNetAddressCtrl::Create", "AFXCMN/CNetAddressCtrl::CreateEx", "AFXCMN/CNetAddressCtrl::DisplayErrorTip", "AFXCMN/CNetAddressCtrl::GetAddress", "AFXCMN/CNetAddressCtrl::GetAllowType", "AFXCMN/CNetAddressCtrl::SetAllowType"] helpviewer_keywords: ["CNetAddressCtrl [MFC], CNetAddressCtrl", "CNetAddressCtrl [MFC], Create", "CNetAddressCtrl [MFC], CreateEx", "CNetAddressCtrl [MFC], DisplayErrorTip", "CNetAddressCtrl [MFC], GetAddress", "CNetAddressCtrl [MFC], GetAllowType", "CNetAddressCtrl [MFC], SetAllowType"] -ms.assetid: cb4c6aca-3f49-4b52-b76c-65f57096155b --- # CNetAddressCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CNetAddressCtrl` class represents the network address control, which you can use to input and validate the format of IPv4, IPv6, and named DNS addresses. ## Syntax diff --git a/docs/mfc/reference/cnotsupportedexception-class.md b/docs/mfc/reference/cnotsupportedexception-class.md index 91c32de3a13..4cb7a08ce51 100644 --- a/docs/mfc/reference/cnotsupportedexception-class.md +++ b/docs/mfc/reference/cnotsupportedexception-class.md @@ -4,10 +4,12 @@ title: "CNotSupportedException Class" ms.date: "11/04/2016" f1_keywords: ["CNotSupportedException", "AFX/CNotSupportedException", "AFX/CNotSupportedException::CNotSupportedException"] helpviewer_keywords: ["CNotSupportedException [MFC], CNotSupportedException"] -ms.assetid: e517391b-eb94-4c39-ae32-87b45bf7d624 --- # CNotSupportedException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents an exception that is the result of a request for an unsupported feature. ## Syntax diff --git a/docs/mfc/reference/cobarray-class.md b/docs/mfc/reference/cobarray-class.md index 8dd735c1f0e..71356304785 100644 --- a/docs/mfc/reference/cobarray-class.md +++ b/docs/mfc/reference/cobarray-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CObArray [MFC], CObArray", "CObArray [MFC], Add", "CObArr --- # `CObArray` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports arrays of `CObject` pointers. ## Syntax diff --git a/docs/mfc/reference/cobject-class.md b/docs/mfc/reference/cobject-class.md index 1f712952c98..0eb328cc399 100644 --- a/docs/mfc/reference/cobject-class.md +++ b/docs/mfc/reference/cobject-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CObject [MFC], CObject", "CObject [MFC], AssertValid", "C --- # `CObject` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The principal base class for the Microsoft Foundation Class Library. ## Syntax diff --git a/docs/mfc/reference/coblist-class.md b/docs/mfc/reference/coblist-class.md index f62fd186b81..0e7810fc3d7 100644 --- a/docs/mfc/reference/coblist-class.md +++ b/docs/mfc/reference/coblist-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CObList [MFC], CObList", "CObList [MFC], AddHead", "CObLi --- # `CObList` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports ordered lists of nonunique `CObject` pointers accessible sequentially or by pointer value. ## Syntax diff --git a/docs/mfc/reference/coccmanager-class.md b/docs/mfc/reference/coccmanager-class.md index 8660c985c55..18a35b36a4a 100644 --- a/docs/mfc/reference/coccmanager-class.md +++ b/docs/mfc/reference/coccmanager-class.md @@ -4,10 +4,12 @@ title: "COccManager Class" ms.date: "11/04/2016" f1_keywords: ["COccManager", "AFXOCC/COccManager", "AFXOCC/COccManager::CreateContainer", "AFXOCC/COccManager::CreateDlgControls", "AFXOCC/COccManager::CreateSite", "AFXOCC/COccManager::GetDefBtnCode", "AFXOCC/COccManager::IsDialogMessage", "AFXOCC/COccManager::IsLabelControl", "AFXOCC/COccManager::IsMatchingMnemonic", "AFXOCC/COccManager::OnEvent", "AFXOCC/COccManager::PostCreateDialog", "AFXOCC/COccManager::PreCreateDialog", "AFXOCC/COccManager::SetDefaultButton", "AFXOCC/COccManager::SplitDialogTemplate"] helpviewer_keywords: ["COccManager [MFC], CreateContainer", "COccManager [MFC], CreateDlgControls", "COccManager [MFC], CreateSite", "COccManager [MFC], GetDefBtnCode", "COccManager [MFC], IsDialogMessage", "COccManager [MFC], IsLabelControl", "COccManager [MFC], IsMatchingMnemonic", "COccManager [MFC], OnEvent", "COccManager [MFC], PostCreateDialog", "COccManager [MFC], PreCreateDialog", "COccManager [MFC], SetDefaultButton", "COccManager [MFC], SplitDialogTemplate"] -ms.assetid: 7d47aeed-d1ab-48e3-b4cf-d429718e370a --- # COccManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages various custom control sites; implemented by `COleControlContainer` and `COleControlSite` objects. ## Syntax diff --git a/docs/mfc/reference/codbcfieldinfo-structure.md b/docs/mfc/reference/codbcfieldinfo-structure.md index 03a4573f045..ea89688707e 100644 --- a/docs/mfc/reference/codbcfieldinfo-structure.md +++ b/docs/mfc/reference/codbcfieldinfo-structure.md @@ -4,10 +4,12 @@ title: "CODBCFieldInfo Structure" ms.date: "11/04/2016" f1_keywords: ["CODBCFieldInfo"] helpviewer_keywords: ["ODBC [MFC], data source information", "CODBCFieldInfo structure [MFC]"] -ms.assetid: 92598b4f-facc-4108-b282-63a179ff79ab --- # CODBCFieldInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CODBCFieldInfo` structure contains information about the fields in an ODBC data source. ## Syntax diff --git a/docs/mfc/reference/colebusydialog-class.md b/docs/mfc/reference/colebusydialog-class.md index d9d615fe4e1..8a448182cce 100644 --- a/docs/mfc/reference/colebusydialog-class.md +++ b/docs/mfc/reference/colebusydialog-class.md @@ -4,10 +4,12 @@ title: "COleBusyDialog Class" ms.date: "11/04/2016" f1_keywords: ["COleBusyDialog", "AFXODLGS/COleBusyDialog", "AFXODLGS/COleBusyDialog::COleBusyDialog", "AFXODLGS/COleBusyDialog::DoModal", "AFXODLGS/COleBusyDialog::GetSelectionType", "AFXODLGS/COleBusyDialog::m_bz"] helpviewer_keywords: ["COleBusyDialog [MFC], COleBusyDialog", "COleBusyDialog [MFC], DoModal", "COleBusyDialog [MFC], GetSelectionType", "COleBusyDialog [MFC], m_bz"] -ms.assetid: c881a532-9672-4c41-b51b-5ce4a7246a6b --- # COleBusyDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used for the OLE Server Not Responding or Server Busy dialog boxes. ## Syntax diff --git a/docs/mfc/reference/colechangeicondialog-class.md b/docs/mfc/reference/colechangeicondialog-class.md index 4aa41b2f9b8..f3215747770 100644 --- a/docs/mfc/reference/colechangeicondialog-class.md +++ b/docs/mfc/reference/colechangeicondialog-class.md @@ -4,10 +4,12 @@ title: "COleChangeIconDialog Class" ms.date: "11/04/2016" f1_keywords: ["COleChangeIconDialog", "AFXODLGS/COleChangeIconDialog", "AFXODLGS/COleChangeIconDialog::COleChangeIconDialog", "AFXODLGS/COleChangeIconDialog::DoChangeIcon", "AFXODLGS/COleChangeIconDialog::DoModal", "AFXODLGS/COleChangeIconDialog::GetIconicMetafile", "AFXODLGS/COleChangeIconDialog::m_ci"] helpviewer_keywords: ["COleChangeIconDialog [MFC], COleChangeIconDialog", "COleChangeIconDialog [MFC], DoChangeIcon", "COleChangeIconDialog [MFC], DoModal", "COleChangeIconDialog [MFC], GetIconicMetafile", "COleChangeIconDialog [MFC], m_ci"] -ms.assetid: 8d6e131b-ddbb-4dff-a432-f239efda8e3d --- # COleChangeIconDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used for the OLE Change Icon dialog box. ## Syntax diff --git a/docs/mfc/reference/colechangesourcedialog-class.md b/docs/mfc/reference/colechangesourcedialog-class.md index dde0eeca7c4..9b66d040ee1 100644 --- a/docs/mfc/reference/colechangesourcedialog-class.md +++ b/docs/mfc/reference/colechangesourcedialog-class.md @@ -4,10 +4,12 @@ title: "COleChangeSourceDialog Class" ms.date: "11/04/2016" f1_keywords: ["COleChangeSourceDialog", "AFXODLGS/COleChangeSourceDialog", "AFXODLGS/COleChangeSourceDialog::COleChangeSourceDialog", "AFXODLGS/COleChangeSourceDialog::DoModal", "AFXODLGS/COleChangeSourceDialog::GetDisplayName", "AFXODLGS/COleChangeSourceDialog::GetFileName", "AFXODLGS/COleChangeSourceDialog::GetFromPrefix", "AFXODLGS/COleChangeSourceDialog::GetItemName", "AFXODLGS/COleChangeSourceDialog::GetToPrefix", "AFXODLGS/COleChangeSourceDialog::IsValidSource", "AFXODLGS/COleChangeSourceDialog::m_cs"] helpviewer_keywords: ["COleChangeSourceDialog [MFC], COleChangeSourceDialog", "COleChangeSourceDialog [MFC], DoModal", "COleChangeSourceDialog [MFC], GetDisplayName", "COleChangeSourceDialog [MFC], GetFileName", "COleChangeSourceDialog [MFC], GetFromPrefix", "COleChangeSourceDialog [MFC], GetItemName", "COleChangeSourceDialog [MFC], GetToPrefix", "COleChangeSourceDialog [MFC], IsValidSource", "COleChangeSourceDialog [MFC], m_cs"] -ms.assetid: d0e08be7-21ef-45e1-97af-fe27d99e3bac --- # COleChangeSourceDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used for the OLE Change Source dialog box. ## Syntax diff --git a/docs/mfc/reference/coleclientitem-class.md b/docs/mfc/reference/coleclientitem-class.md index 356cf6cdba4..6d13579bde0 100644 --- a/docs/mfc/reference/coleclientitem-class.md +++ b/docs/mfc/reference/coleclientitem-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["COleClientItem [MFC], COleClientItem", "COleClientItem [M --- # COleClientItem Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Defines the container interface to OLE items. ## Syntax diff --git a/docs/mfc/reference/colecmdui-class.md b/docs/mfc/reference/colecmdui-class.md index 93442684f98..04cb24cec92 100644 --- a/docs/mfc/reference/colecmdui-class.md +++ b/docs/mfc/reference/colecmdui-class.md @@ -4,10 +4,12 @@ title: "COleCmdUI Class" ms.date: 07/24/2020 f1_keywords: ["COleCmdUI", "AFXDOCOBJ/COleCmdUI", "AFXDOCOBJ/COleCmdUI::COleCmdUI", "AFXDOCOBJ/COleCmdUI::Enable", "AFXDOCOBJ/COleCmdUI::SetCheck", "AFXDOCOBJ/COleCmdUI::SetText"] helpviewer_keywords: ["COleCmdUI [MFC], COleCmdUI", "COleCmdUI [MFC], Enable", "COleCmdUI [MFC], SetCheck", "COleCmdUI [MFC], SetText"] -ms.assetid: a2d5ce08-6657-45d3-8673-2a9f32d50eec --- # COleCmdUI Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a method for MFC to update the state of user-interface objects related to the `IOleCommandTarget`-driven features of your application. ## Syntax diff --git a/docs/mfc/reference/colecontrol-class.md b/docs/mfc/reference/colecontrol-class.md index 4fd5fcaaa04..c30561fbf89 100644 --- a/docs/mfc/reference/colecontrol-class.md +++ b/docs/mfc/reference/colecontrol-class.md @@ -4,10 +4,12 @@ title: "COleControl Class" ms.date: "08/27/2018" f1_keywords: ["COleControl", "AFXCTL/COleControl", "AFXCTL/COleControl::COleControl", "AFXCTL/COleControl::AmbientAppearance", "AFXCTL/COleControl::AmbientBackColor", "AFXCTL/COleControl::AmbientDisplayName", "AFXCTL/COleControl::AmbientFont", "AFXCTL/COleControl::AmbientForeColor", "AFXCTL/COleControl::AmbientLocaleID", "AFXCTL/COleControl::AmbientScaleUnits", "AFXCTL/COleControl::AmbientShowGrabHandles", "AFXCTL/COleControl::AmbientShowHatching", "AFXCTL/COleControl::AmbientTextAlign", "AFXCTL/COleControl::AmbientUIDead", "AFXCTL/COleControl::AmbientUserMode", "AFXCTL/COleControl::BoundPropertyChanged", "AFXCTL/COleControl::BoundPropertyRequestEdit", "AFXCTL/COleControl::ClientToParent", "AFXCTL/COleControl::ClipCaretRect", "AFXCTL/COleControl::ControlInfoChanged", "AFXCTL/COleControl::DisplayError", "AFXCTL/COleControl::DoClick", "AFXCTL/COleControl::DoPropExchange", "AFXCTL/COleControl::DoSuperclassPaint", "AFXCTL/COleControl::EnableSimpleFrame", "AFXCTL/COleControl::ExchangeExtent", "AFXCTL/COleControl::ExchangeStockProps", "AFXCTL/COleControl::ExchangeVersion", "AFXCTL/COleControl::FireClick", "AFXCTL/COleControl::FireDblClick", "AFXCTL/COleControl::FireError", "AFXCTL/COleControl::FireEvent", "AFXCTL/COleControl::FireKeyDown", "AFXCTL/COleControl::FireKeyPress", "AFXCTL/COleControl::FireKeyUp", "AFXCTL/COleControl::FireMouseDown", "AFXCTL/COleControl::FireMouseMove", "AFXCTL/COleControl::FireMouseUp", "AFXCTL/COleControl::FireReadyStateChange", "AFXCTL/COleControl::GetActivationPolicy", "AFXCTL/COleControl::GetAmbientProperty", "AFXCTL/COleControl::GetAppearance", "AFXCTL/COleControl::GetBackColor", "AFXCTL/COleControl::GetBorderStyle", "AFXCTL/COleControl::GetCapture", "AFXCTL/COleControl::GetClassID", "AFXCTL/COleControl::GetClientOffset", "AFXCTL/COleControl::GetClientRect", "AFXCTL/COleControl::GetClientSite", "AFXCTL/COleControl::GetControlFlags", "AFXCTL/COleControl::GetControlSize", "AFXCTL/COleControl::GetDC", "AFXCTL/COleControl::GetEnabled", "AFXCTL/COleControl::GetExtendedControl", "AFXCTL/COleControl::GetFocus", "AFXCTL/COleControl::GetFont", "AFXCTL/COleControl::GetFontTextMetrics", "AFXCTL/COleControl::GetForeColor", "AFXCTL/COleControl::GetHwnd", "AFXCTL/COleControl::GetMessageString", "AFXCTL/COleControl::GetNotSupported", "AFXCTL/COleControl::GetReadyState", "AFXCTL/COleControl::GetRectInContainer", "AFXCTL/COleControl::GetStockTextMetrics", "AFXCTL/COleControl::GetText", "AFXCTL/COleControl::GetWindowlessDropTarget", "AFXCTL/COleControl::InitializeIIDs", "AFXCTL/COleControl::InternalGetFont", "AFXCTL/COleControl::InternalGetText", "AFXCTL/COleControl::InternalSetReadyState", "AFXCTL/COleControl::InvalidateControl", "AFXCTL/COleControl::InvalidateRgn", "AFXCTL/COleControl::IsConvertingVBX", "AFXCTL/COleControl::IsModified", "AFXCTL/COleControl::IsOptimizedDraw", "AFXCTL/COleControl::IsSubclassedControl", "AFXCTL/COleControl::Load", "AFXCTL/COleControl::LockInPlaceActive", "AFXCTL/COleControl::OnAmbientPropertyChange", "AFXCTL/COleControl::OnAppearanceChanged", "AFXCTL/COleControl::OnBackColorChanged", "AFXCTL/COleControl::OnBorderStyleChanged", "AFXCTL/COleControl::OnClick", "AFXCTL/COleControl::OnClose", "AFXCTL/COleControl::OnDoVerb", "AFXCTL/COleControl::OnDraw", "AFXCTL/COleControl::OnDrawMetafile", "AFXCTL/COleControl::OnEdit", "AFXCTL/COleControl::OnEnabledChanged", "AFXCTL/COleControl::OnEnumVerbs", "AFXCTL/COleControl::OnEventAdvise", "AFXCTL/COleControl::OnFontChanged", "AFXCTL/COleControl::OnForeColorChanged", "AFXCTL/COleControl::OnFreezeEvents", "AFXCTL/COleControl::OnGetColorSet", "AFXCTL/COleControl::OnGetControlInfo", "AFXCTL/COleControl::OnGetDisplayString", "AFXCTL/COleControl::OnGetInPlaceMenu", "AFXCTL/COleControl::OnGetNaturalExtent", "AFXCTL/COleControl::OnGetPredefinedStrings", "AFXCTL/COleControl::OnGetPredefinedValue", "AFXCTL/COleControl::OnGetViewExtent", "AFXCTL/COleControl::OnGetViewRect", "AFXCTL/COleControl::OnGetViewStatus", "AFXCTL/COleControl::OnHideToolBars", "AFXCTL/COleControl::OnInactiveMouseMove", "AFXCTL/COleControl::OnInactiveSetCursor", "AFXCTL/COleControl::OnKeyDownEvent", "AFXCTL/COleControl::OnKeyPressEvent", "AFXCTL/COleControl::OnKeyUpEvent", "AFXCTL/COleControl::OnMapPropertyToPage", "AFXCTL/COleControl::OnMnemonic", "AFXCTL/COleControl::OnProperties", "AFXCTL/COleControl::OnQueryHitPoint", "AFXCTL/COleControl::OnQueryHitRect", "AFXCTL/COleControl::OnRenderData", "AFXCTL/COleControl::OnRenderFileData", "AFXCTL/COleControl::OnRenderGlobalData", "AFXCTL/COleControl::OnResetState", "AFXCTL/COleControl::OnSetClientSite", "AFXCTL/COleControl::OnSetData", "AFXCTL/COleControl::OnSetExtent", "AFXCTL/COleControl::OnSetObjectRects", "AFXCTL/COleControl::OnShowToolBars", "AFXCTL/COleControl::OnTextChanged", "AFXCTL/COleControl::OnWindowlessMessage", "AFXCTL/COleControl::ParentToClient", "AFXCTL/COleControl::PostModalDialog", "AFXCTL/COleControl::PreModalDialog", "AFXCTL/COleControl::RecreateControlWindow", "AFXCTL/COleControl::Refresh", "AFXCTL/COleControl::ReleaseCapture", "AFXCTL/COleControl::ReleaseDC", "AFXCTL/COleControl::ReparentControlWindow", "AFXCTL/COleControl::ResetStockProps", "AFXCTL/COleControl::ResetVersion", "AFXCTL/COleControl::ScrollWindow", "AFXCTL/COleControl::SelectFontObject", "AFXCTL/COleControl::SelectStockFont", "AFXCTL/COleControl::SerializeExtent", "AFXCTL/COleControl::SerializeStockProps", "AFXCTL/COleControl::SerializeVersion", "AFXCTL/COleControl::SetAppearance", "AFXCTL/COleControl::SetBackColor", "AFXCTL/COleControl::SetBorderStyle", "AFXCTL/COleControl::SetCapture", "AFXCTL/COleControl::SetControlSize", "AFXCTL/COleControl::SetEnabled", "AFXCTL/COleControl::SetFocus", "AFXCTL/COleControl::SetFont", "AFXCTL/COleControl::SetForeColor", "AFXCTL/COleControl::SetInitialSize", "AFXCTL/COleControl::SetModifiedFlag", "AFXCTL/COleControl::SetNotPermitted", "AFXCTL/COleControl::SetNotSupported", "AFXCTL/COleControl::SetRectInContainer", "AFXCTL/COleControl::SetText", "AFXCTL/COleControl::ThrowError", "AFXCTL/COleControl::TransformCoords", "AFXCTL/COleControl::TranslateColor", "AFXCTL/COleControl::WillAmbientsBeValidDuringLoad", "AFXCTL/COleControl::WindowProc", "AFXCTL/COleControl::DrawContent", "AFXCTL/COleControl::DrawMetafile", "AFXCTL/COleControl::IsInvokeAllowed", "AFXCTL/COleControl::SetInitialDataFormats"] helpviewer_keywords: ["COleControl [MFC], COleControl", "COleControl [MFC], AmbientAppearance", "COleControl [MFC], AmbientBackColor", "COleControl [MFC], AmbientDisplayName", "COleControl [MFC], AmbientFont", "COleControl [MFC], AmbientForeColor", "COleControl [MFC], AmbientLocaleID", "COleControl [MFC], AmbientScaleUnits", "COleControl [MFC], AmbientShowGrabHandles", "COleControl [MFC], AmbientShowHatching", "COleControl [MFC], AmbientTextAlign", "COleControl [MFC], AmbientUIDead", "COleControl [MFC], AmbientUserMode", "COleControl [MFC], BoundPropertyChanged", "COleControl [MFC], BoundPropertyRequestEdit", "COleControl [MFC], ClientToParent", "COleControl [MFC], ClipCaretRect", "COleControl [MFC], ControlInfoChanged", "COleControl [MFC], DisplayError", "COleControl [MFC], DoClick", "COleControl [MFC], DoPropExchange", "COleControl [MFC], DoSuperclassPaint", "COleControl [MFC], EnableSimpleFrame", "COleControl [MFC], ExchangeExtent", "COleControl [MFC], ExchangeStockProps", "COleControl [MFC], ExchangeVersion", "COleControl [MFC], FireClick", "COleControl [MFC], FireDblClick", "COleControl [MFC], FireError", "COleControl [MFC], FireEvent", "COleControl [MFC], FireKeyDown", "COleControl [MFC], FireKeyPress", "COleControl [MFC], FireKeyUp", "COleControl [MFC], FireMouseDown", "COleControl [MFC], FireMouseMove", "COleControl [MFC], FireMouseUp", "COleControl [MFC], FireReadyStateChange", "COleControl [MFC], GetActivationPolicy", "COleControl [MFC], GetAmbientProperty", "COleControl [MFC], GetAppearance", "COleControl [MFC], GetBackColor", "COleControl [MFC], GetBorderStyle", "COleControl [MFC], GetCapture", "COleControl [MFC], GetClassID", "COleControl [MFC], GetClientOffset", "COleControl [MFC], GetClientRect", "COleControl [MFC], GetClientSite", "COleControl [MFC], GetControlFlags", "COleControl [MFC], GetControlSize", "COleControl [MFC], GetDC", "COleControl [MFC], GetEnabled", "COleControl [MFC], GetExtendedControl", "COleControl [MFC], GetFocus", "COleControl [MFC], GetFont", "COleControl [MFC], GetFontTextMetrics", "COleControl [MFC], GetForeColor", "COleControl [MFC], GetHwnd", "COleControl [MFC], GetMessageString", "COleControl [MFC], GetNotSupported", "COleControl [MFC], GetReadyState", "COleControl [MFC], GetRectInContainer", "COleControl [MFC], GetStockTextMetrics", "COleControl [MFC], GetText", "COleControl [MFC], GetWindowlessDropTarget", "COleControl [MFC], InitializeIIDs", "COleControl [MFC], InternalGetFont", "COleControl [MFC], InternalGetText", "COleControl [MFC], InternalSetReadyState", "COleControl [MFC], InvalidateControl", "COleControl [MFC], InvalidateRgn", "COleControl [MFC], IsConvertingVBX", "COleControl [MFC], IsModified", "COleControl [MFC], IsOptimizedDraw", "COleControl [MFC], IsSubclassedControl", "COleControl [MFC], Load", "COleControl [MFC], LockInPlaceActive", "COleControl [MFC], OnAmbientPropertyChange", "COleControl [MFC], OnAppearanceChanged", "COleControl [MFC], OnBackColorChanged", "COleControl [MFC], OnBorderStyleChanged", "COleControl [MFC], OnClick", "COleControl [MFC], OnClose", "COleControl [MFC], OnDoVerb", "COleControl [MFC], OnDraw", "COleControl [MFC], OnDrawMetafile", "COleControl [MFC], OnEdit", "COleControl [MFC], OnEnabledChanged", "COleControl [MFC], OnEnumVerbs", "COleControl [MFC], OnEventAdvise", "COleControl [MFC], OnFontChanged", "COleControl [MFC], OnForeColorChanged", "COleControl [MFC], OnFreezeEvents", "COleControl [MFC], OnGetColorSet", "COleControl [MFC], OnGetControlInfo", "COleControl [MFC], OnGetDisplayString", "COleControl [MFC], OnGetInPlaceMenu", "COleControl [MFC], OnGetNaturalExtent", "COleControl [MFC], OnGetPredefinedStrings", "COleControl [MFC], OnGetPredefinedValue", "COleControl [MFC], OnGetViewExtent", "COleControl [MFC], OnGetViewRect", "COleControl [MFC], OnGetViewStatus", "COleControl [MFC], OnHideToolBars", "COleControl [MFC], OnInactiveMouseMove", "COleControl [MFC], OnInactiveSetCursor", "COleControl [MFC], OnKeyDownEvent", "COleControl [MFC], OnKeyPressEvent", "COleControl [MFC], OnKeyUpEvent", "COleControl [MFC], OnMapPropertyToPage", "COleControl [MFC], OnMnemonic", "COleControl [MFC], OnProperties", "COleControl [MFC], OnQueryHitPoint", "COleControl [MFC], OnQueryHitRect", "COleControl [MFC], OnRenderData", "COleControl [MFC], OnRenderFileData", "COleControl [MFC], OnRenderGlobalData", "COleControl [MFC], OnResetState", "COleControl [MFC], OnSetClientSite", "COleControl [MFC], OnSetData", "COleControl [MFC], OnSetExtent", "COleControl [MFC], OnSetObjectRects", "COleControl [MFC], OnShowToolBars", "COleControl [MFC], OnTextChanged", "COleControl [MFC], OnWindowlessMessage", "COleControl [MFC], ParentToClient", "COleControl [MFC], PostModalDialog", "COleControl [MFC], PreModalDialog", "COleControl [MFC], RecreateControlWindow", "COleControl [MFC], Refresh", "COleControl [MFC], ReleaseCapture", "COleControl [MFC], ReleaseDC", "COleControl [MFC], ReparentControlWindow", "COleControl [MFC], ResetStockProps", "COleControl [MFC], ResetVersion", "COleControl [MFC], ScrollWindow", "COleControl [MFC], SelectFontObject", "COleControl [MFC], SelectStockFont", "COleControl [MFC], SerializeExtent", "COleControl [MFC], SerializeStockProps", "COleControl [MFC], SerializeVersion", "COleControl [MFC], SetAppearance", "COleControl [MFC], SetBackColor", "COleControl [MFC], SetBorderStyle", "COleControl [MFC], SetCapture", "COleControl [MFC], SetControlSize", "COleControl [MFC], SetEnabled", "COleControl [MFC], SetFocus", "COleControl [MFC], SetFont", "COleControl [MFC], SetForeColor", "COleControl [MFC], SetInitialSize", "COleControl [MFC], SetModifiedFlag", "COleControl [MFC], SetNotPermitted", "COleControl [MFC], SetNotSupported", "COleControl [MFC], SetRectInContainer", "COleControl [MFC], SetText", "COleControl [MFC], ThrowError", "COleControl [MFC], TransformCoords", "COleControl [MFC], TranslateColor", "COleControl [MFC], WillAmbientsBeValidDuringLoad", "COleControl [MFC], WindowProc", "COleControl [MFC], DrawContent", "COleControl [MFC], DrawMetafile", "COleControl [MFC], IsInvokeAllowed", "COleControl [MFC], SetInitialDataFormats"] -ms.assetid: 53e95299-38e8-447b-9c5f-a381d27f5123 --- # COleControl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A powerful base class for developing OLE controls. ## Syntax diff --git a/docs/mfc/reference/colecontrolcontainer-class.md b/docs/mfc/reference/colecontrolcontainer-class.md index 5187c2d745f..ff21a7c3de1 100644 --- a/docs/mfc/reference/colecontrolcontainer-class.md +++ b/docs/mfc/reference/colecontrolcontainer-class.md @@ -4,10 +4,12 @@ title: "COleControlContainer Class" ms.date: "11/04/2016" f1_keywords: ["COleControlContainer", "AFXOCC/COleControlContainer", "AFXOCC/COleControlContainer::COleControlContainer", "AFXOCC/COleControlContainer::AttachControlSite", "AFXOCC/COleControlContainer::BroadcastAmbientPropertyChange", "AFXOCC/COleControlContainer::CheckDlgButton", "AFXOCC/COleControlContainer::CheckRadioButton", "AFXOCC/COleControlContainer::CreateControl", "AFXOCC/COleControlContainer::CreateOleFont", "AFXOCC/COleControlContainer::FindItem", "AFXOCC/COleControlContainer::FreezeAllEvents", "AFXOCC/COleControlContainer::GetAmbientProp", "AFXOCC/COleControlContainer::GetDlgItem", "AFXOCC/COleControlContainer::GetDlgItemInt", "AFXOCC/COleControlContainer::GetDlgItemText", "AFXOCC/COleControlContainer::HandleSetFocus", "AFXOCC/COleControlContainer::HandleWindowlessMessage", "AFXOCC/COleControlContainer::IsDlgButtonChecked", "AFXOCC/COleControlContainer::OnPaint", "AFXOCC/COleControlContainer::OnUIActivate", "AFXOCC/COleControlContainer::OnUIDeactivate", "AFXOCC/COleControlContainer::ScrollChildren", "AFXOCC/COleControlContainer::SendDlgItemMessage", "AFXOCC/COleControlContainer::SetDlgItemInt", "AFXOCC/COleControlContainer::SetDlgItemText", "AFXOCC/COleControlContainer::m_crBack", "AFXOCC/COleControlContainer::m_crFore", "AFXOCC/COleControlContainer::m_listSitesOrWnds", "AFXOCC/COleControlContainer::m_nWindowlessControls", "AFXOCC/COleControlContainer::m_pOleFont", "AFXOCC/COleControlContainer::m_pSiteCapture", "AFXOCC/COleControlContainer::m_pSiteFocus", "AFXOCC/COleControlContainer::m_pSiteUIActive", "AFXOCC/COleControlContainer::m_pWnd", "AFXOCC/COleControlContainer::m_siteMap"] helpviewer_keywords: ["COleControlContainer [MFC], COleControlContainer", "COleControlContainer [MFC], AttachControlSite", "COleControlContainer [MFC], BroadcastAmbientPropertyChange", "COleControlContainer [MFC], CheckDlgButton", "COleControlContainer [MFC], CheckRadioButton", "COleControlContainer [MFC], CreateControl", "COleControlContainer [MFC], CreateOleFont", "COleControlContainer [MFC], FindItem", "COleControlContainer [MFC], FreezeAllEvents", "COleControlContainer [MFC], GetAmbientProp", "COleControlContainer [MFC], GetDlgItem", "COleControlContainer [MFC], GetDlgItemInt", "COleControlContainer [MFC], GetDlgItemText", "COleControlContainer [MFC], HandleSetFocus", "COleControlContainer [MFC], HandleWindowlessMessage", "COleControlContainer [MFC], IsDlgButtonChecked", "COleControlContainer [MFC], OnPaint", "COleControlContainer [MFC], OnUIActivate", "COleControlContainer [MFC], OnUIDeactivate", "COleControlContainer [MFC], ScrollChildren", "COleControlContainer [MFC], SendDlgItemMessage", "COleControlContainer [MFC], SetDlgItemInt", "COleControlContainer [MFC], SetDlgItemText", "COleControlContainer [MFC], m_crBack", "COleControlContainer [MFC], m_crFore", "COleControlContainer [MFC], m_listSitesOrWnds", "COleControlContainer [MFC], m_nWindowlessControls", "COleControlContainer [MFC], m_pOleFont", "COleControlContainer [MFC], m_pSiteCapture", "COleControlContainer [MFC], m_pSiteFocus", "COleControlContainer [MFC], m_pSiteUIActive", "COleControlContainer [MFC], m_pWnd", "COleControlContainer [MFC], m_siteMap"] -ms.assetid: f7ce9246-0fb7-4f07-a83a-6c2390d0fdf8 --- # COleControlContainer Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Acts as a control container for ActiveX controls. ## Syntax diff --git a/docs/mfc/reference/colecontrolmodule-class.md b/docs/mfc/reference/colecontrolmodule-class.md index 27758f5eae1..6a03e9ed1c9 100644 --- a/docs/mfc/reference/colecontrolmodule-class.md +++ b/docs/mfc/reference/colecontrolmodule-class.md @@ -4,10 +4,12 @@ title: "COleControlModule Class" ms.date: "11/04/2016" f1_keywords: ["OleControlModule"] helpviewer_keywords: ["OLE control modules [MFC]", "MFC ActiveX controls [MFC], OLE control modules", "COleControlModule class [MFC]", "control modules [MFC]"] -ms.assetid: 0721724d-d4af-4eda-ad34-5a2b27810dd4 --- # COleControlModule Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class from which you derive an OLE control module object. ## Syntax diff --git a/docs/mfc/reference/colecontrolsite-class.md b/docs/mfc/reference/colecontrolsite-class.md index 1e7c3602a6e..e5b30a331c1 100644 --- a/docs/mfc/reference/colecontrolsite-class.md +++ b/docs/mfc/reference/colecontrolsite-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["COleControlSite [MFC], COleControlSite", "COleControlSite --- # COleControlSite Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides support for custom client-side control interfaces. ## Syntax diff --git a/docs/mfc/reference/coleconvertdialog-class.md b/docs/mfc/reference/coleconvertdialog-class.md index eda026d9681..4d73297fdc0 100644 --- a/docs/mfc/reference/coleconvertdialog-class.md +++ b/docs/mfc/reference/coleconvertdialog-class.md @@ -4,10 +4,12 @@ title: "COleConvertDialog Class" ms.date: "11/04/2016" f1_keywords: ["COleConvertDialog", "AFXODLGS/COleConvertDialog", "AFXODLGS/COleConvertDialog::COleConvertDialog", "AFXODLGS/COleConvertDialog::DoConvert", "AFXODLGS/COleConvertDialog::DoModal", "AFXODLGS/COleConvertDialog::GetClassID", "AFXODLGS/COleConvertDialog::GetDrawAspect", "AFXODLGS/COleConvertDialog::GetIconicMetafile", "AFXODLGS/COleConvertDialog::GetSelectionType", "AFXODLGS/COleConvertDialog::m_cv"] helpviewer_keywords: ["COleConvertDialog [MFC], COleConvertDialog", "COleConvertDialog [MFC], DoConvert", "COleConvertDialog [MFC], DoModal", "COleConvertDialog [MFC], GetClassID", "COleConvertDialog [MFC], GetDrawAspect", "COleConvertDialog [MFC], GetIconicMetafile", "COleConvertDialog [MFC], GetSelectionType", "COleConvertDialog [MFC], m_cv"] -ms.assetid: a7c57714-31e8-4b78-834d-8ddd1b856a1c --- # COleConvertDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For more information, see the [OLEUICONVERT](/windows/win32/api/oledlg/ns-oledlg-oleuiconvertw) structure in the Windows SDK. ## Syntax diff --git a/docs/mfc/reference/colecurrency-class.md b/docs/mfc/reference/colecurrency-class.md index 76b27412456..b440966b509 100644 --- a/docs/mfc/reference/colecurrency-class.md +++ b/docs/mfc/reference/colecurrency-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["COleCurrency [MFC], COleCurrency", "COleCurrency [MFC], F --- # COleCurrency Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the `CURRENCY` data type of OLE automation. ## Syntax diff --git a/docs/mfc/reference/coledataobject-class.md b/docs/mfc/reference/coledataobject-class.md index 66f054c745a..db59686d70a 100644 --- a/docs/mfc/reference/coledataobject-class.md +++ b/docs/mfc/reference/coledataobject-class.md @@ -4,10 +4,12 @@ title: "COleDataObject Class" ms.date: "11/04/2016" f1_keywords: ["COleDataObject", "AFXOLE/COleDataObject", "AFXOLE/COleDataObject::COleDataObject", "AFXOLE/COleDataObject::Attach", "AFXOLE/COleDataObject::AttachClipboard", "AFXOLE/COleDataObject::BeginEnumFormats", "AFXOLE/COleDataObject::Detach", "AFXOLE/COleDataObject::GetData", "AFXOLE/COleDataObject::GetFileData", "AFXOLE/COleDataObject::GetGlobalData", "AFXOLE/COleDataObject::GetNextFormat", "AFXOLE/COleDataObject::IsDataAvailable", "AFXOLE/COleDataObject::Release"] helpviewer_keywords: ["COleDataObject [MFC], COleDataObject", "COleDataObject [MFC], Attach", "COleDataObject [MFC], AttachClipboard", "COleDataObject [MFC], BeginEnumFormats", "COleDataObject [MFC], Detach", "COleDataObject [MFC], GetData", "COleDataObject [MFC], GetFileData", "COleDataObject [MFC], GetGlobalData", "COleDataObject [MFC], GetNextFormat", "COleDataObject [MFC], IsDataAvailable", "COleDataObject [MFC], Release"] -ms.assetid: d1cc84be-2e1c-4bb3-a8a0-565eb08aaa34 --- # COleDataObject Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used in data transfers for retrieving data in various formats from the Clipboard, through drag and drop, or from an embedded OLE item. ## Syntax diff --git a/docs/mfc/reference/coledatasource-class.md b/docs/mfc/reference/coledatasource-class.md index 8d0101c0358..b107af62451 100644 --- a/docs/mfc/reference/coledatasource-class.md +++ b/docs/mfc/reference/coledatasource-class.md @@ -4,10 +4,12 @@ title: "COleDataSource Class" ms.date: "11/04/2016" f1_keywords: ["COleDataSource", "AFXOLE/COleDataSource", "AFXOLE/COleDataSource::COleDataSource", "AFXOLE/COleDataSource::CacheData", "AFXOLE/COleDataSource::CacheGlobalData", "AFXOLE/COleDataSource::DelayRenderData", "AFXOLE/COleDataSource::DelayRenderFileData", "AFXOLE/COleDataSource::DelaySetData", "AFXOLE/COleDataSource::DoDragDrop", "AFXOLE/COleDataSource::Empty", "AFXOLE/COleDataSource::FlushClipboard", "AFXOLE/COleDataSource::GetClipboardOwner", "AFXOLE/COleDataSource::OnRenderData", "AFXOLE/COleDataSource::OnRenderFileData", "AFXOLE/COleDataSource::OnRenderGlobalData", "AFXOLE/COleDataSource::OnSetData", "AFXOLE/COleDataSource::SetClipboard"] helpviewer_keywords: ["COleDataSource [MFC], COleDataSource", "COleDataSource [MFC], CacheData", "COleDataSource [MFC], CacheGlobalData", "COleDataSource [MFC], DelayRenderData", "COleDataSource [MFC], DelayRenderFileData", "COleDataSource [MFC], DelaySetData", "COleDataSource [MFC], DoDragDrop", "COleDataSource [MFC], Empty", "COleDataSource [MFC], FlushClipboard", "COleDataSource [MFC], GetClipboardOwner", "COleDataSource [MFC], OnRenderData", "COleDataSource [MFC], OnRenderFileData", "COleDataSource [MFC], OnRenderGlobalData", "COleDataSource [MFC], OnSetData", "COleDataSource [MFC], SetClipboard"] -ms.assetid: 02c8ee7d-8e10-4463-8613-bb2a0305ca69 --- # COleDataSource Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Acts as a cache into which an application places the data that it will offer during data transfer operations, such as Clipboard or drag-and-drop operations. ## Syntax diff --git a/docs/mfc/reference/coledbrecordview-class.md b/docs/mfc/reference/coledbrecordview-class.md index b8ab8c78076..dda014b94d5 100644 --- a/docs/mfc/reference/coledbrecordview-class.md +++ b/docs/mfc/reference/coledbrecordview-class.md @@ -4,10 +4,12 @@ title: "COleDBRecordView Class" ms.date: "11/04/2016" f1_keywords: ["COleDBRecordView", "AFXOLEDB/COleDBRecordView", "AFXOLEDB/COleDBRecordView::COleDBRecordView", "AFXOLEDB/COleDBRecordView::OnGetRowset", "AFXOLEDB/COleDBRecordView::OnMove"] helpviewer_keywords: ["COleDBRecordView [MFC], COleDBRecordView", "COleDBRecordView [MFC], OnGetRowset", "COleDBRecordView [MFC], OnMove"] -ms.assetid: 98612427-c4c9-4760-b7e1-85b17448add9 --- # COleDBRecordView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A view that displays database records in controls. ## Syntax diff --git a/docs/mfc/reference/coledialog-class.md b/docs/mfc/reference/coledialog-class.md index bc4e1f0d908..cc997aaebd4 100644 --- a/docs/mfc/reference/coledialog-class.md +++ b/docs/mfc/reference/coledialog-class.md @@ -4,10 +4,12 @@ title: "COleDialog Class" ms.date: "11/04/2016" f1_keywords: ["COleDialog", "AFXODLGS/COleDialog", "AFXODLGS/COleDialog::GetLastError"] helpviewer_keywords: ["COleDialog [MFC], GetLastError"] -ms.assetid: b1ed0aca-3914-4b00-af34-4a4fb491aec7 --- # COleDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides functionality common to dialog boxes for OLE. ## Syntax diff --git a/docs/mfc/reference/coledispatchdriver-class.md b/docs/mfc/reference/coledispatchdriver-class.md index 5984ecda38f..5a08820a954 100644 --- a/docs/mfc/reference/coledispatchdriver-class.md +++ b/docs/mfc/reference/coledispatchdriver-class.md @@ -4,10 +4,12 @@ title: "COleDispatchDriver Class" ms.date: "11/04/2016" f1_keywords: ["COleDispatchDriver", "AFXDISP/COleDispatchDriver", "AFXDISP/COleDispatchDriver::COleDispatchDriver", "AFXDISP/COleDispatchDriver::AttachDispatch", "AFXDISP/COleDispatchDriver::CreateDispatch", "AFXDISP/COleDispatchDriver::DetachDispatch", "AFXDISP/COleDispatchDriver::GetProperty", "AFXDISP/COleDispatchDriver::InvokeHelper", "AFXDISP/COleDispatchDriver::ReleaseDispatch", "AFXDISP/COleDispatchDriver::SetProperty", "AFXDISP/COleDispatchDriver::m_bAutoRelease", "AFXDISP/COleDispatchDriver::m_lpDispatch"] helpviewer_keywords: ["COleDispatchDriver [MFC], COleDispatchDriver", "COleDispatchDriver [MFC], AttachDispatch", "COleDispatchDriver [MFC], CreateDispatch", "COleDispatchDriver [MFC], DetachDispatch", "COleDispatchDriver [MFC], GetProperty", "COleDispatchDriver [MFC], InvokeHelper", "COleDispatchDriver [MFC], ReleaseDispatch", "COleDispatchDriver [MFC], SetProperty", "COleDispatchDriver [MFC], m_bAutoRelease", "COleDispatchDriver [MFC], m_lpDispatch"] -ms.assetid: 3ed98daf-cdc7-4374-8a0c-cf695a8d3657 --- # COleDispatchDriver Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the client side of OLE automation. ## Syntax diff --git a/docs/mfc/reference/coledispatchexception-class.md b/docs/mfc/reference/coledispatchexception-class.md index a37125f8492..c95af10037c 100644 --- a/docs/mfc/reference/coledispatchexception-class.md +++ b/docs/mfc/reference/coledispatchexception-class.md @@ -4,10 +4,12 @@ title: "COleDispatchException Class" ms.date: "11/04/2016" f1_keywords: ["COleDispatchException", "AFXDISP/COleDispatchException", "AFXDISP/COleDispatchException::m_dwHelpContext", "AFXDISP/COleDispatchException::m_strDescription", "AFXDISP/COleDispatchException::m_strHelpFile", "AFXDISP/COleDispatchException::m_strSource", "AFXDISP/COleDispatchException::m_wCode"] helpviewer_keywords: ["COleDispatchException [MFC], m_dwHelpContext", "COleDispatchException [MFC], m_strDescription", "COleDispatchException [MFC], m_strHelpFile", "COleDispatchException [MFC], m_strSource", "COleDispatchException [MFC], m_wCode"] -ms.assetid: 0e95c8be-e21a-490c-99ec-181c6a9a26d0 --- # COleDispatchException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Handles exceptions specific to the OLE `IDispatch` interface, which is a key part of OLE automation. ## Syntax diff --git a/docs/mfc/reference/coledocobjectitem-class.md b/docs/mfc/reference/coledocobjectitem-class.md index 91854ce6bb8..5bf120dd054 100644 --- a/docs/mfc/reference/coledocobjectitem-class.md +++ b/docs/mfc/reference/coledocobjectitem-class.md @@ -4,10 +4,12 @@ title: "COleDocObjectItem Class" ms.date: "11/04/2016" f1_keywords: ["COleDocObjectItem", "AFXOLE/COleDocObjectItem", "AFXOLE/COleDocObjectItem::COleDocObjectItem", "AFXOLE/COleDocObjectItem::DoDefaultPrinting", "AFXOLE/COleDocObjectItem::ExecCommand", "AFXOLE/COleDocObjectItem::GetActiveView", "AFXOLE/COleDocObjectItem::GetPageCount", "AFXOLE/COleDocObjectItem::OnPreparePrinting", "AFXOLE/COleDocObjectItem::OnPrint", "AFXOLE/COleDocObjectItem::QueryCommand", "AFXOLE/COleDocObjectItem::Release"] helpviewer_keywords: ["COleDocObjectItem [MFC], COleDocObjectItem", "COleDocObjectItem [MFC], DoDefaultPrinting", "COleDocObjectItem [MFC], ExecCommand", "COleDocObjectItem [MFC], GetActiveView", "COleDocObjectItem [MFC], GetPageCount", "COleDocObjectItem [MFC], OnPreparePrinting", "COleDocObjectItem [MFC], OnPrint", "COleDocObjectItem [MFC], QueryCommand", "COleDocObjectItem [MFC], Release"] -ms.assetid: d150d306-8fd3-4831-b06d-afbe71d8fc9b --- # COleDocObjectItem Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements Active document containment. ## Syntax diff --git a/docs/mfc/reference/coledocument-class.md b/docs/mfc/reference/coledocument-class.md index fe1959bf1aa..9c792ffd574 100644 --- a/docs/mfc/reference/coledocument-class.md +++ b/docs/mfc/reference/coledocument-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["COleDocument [MFC], COleDocument", "COleDocument [MFC], A --- # COleDocument Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class for OLE documents that support visual editing. ## Syntax diff --git a/docs/mfc/reference/coledropsource-class.md b/docs/mfc/reference/coledropsource-class.md index 1681ecaa0d2..e00dc920b0b 100644 --- a/docs/mfc/reference/coledropsource-class.md +++ b/docs/mfc/reference/coledropsource-class.md @@ -4,10 +4,12 @@ title: "COleDropSource Class" ms.date: "11/04/2016" f1_keywords: ["COleDropSource", "AFXOLE/COleDropSource", "AFXOLE/COleDropSource::COleDropSource", "AFXOLE/COleDropSource::GiveFeedback", "AFXOLE/COleDropSource::OnBeginDrag", "AFXOLE/COleDropSource::QueryContinueDrag"] helpviewer_keywords: ["COleDropSource [MFC], COleDropSource", "COleDropSource [MFC], GiveFeedback", "COleDropSource [MFC], OnBeginDrag", "COleDropSource [MFC], QueryContinueDrag"] -ms.assetid: d3eecc5f-a70b-4a01-b705-7d2c098ebe17 --- # COleDropSource Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Allows data to be dragged to a drop target. ## Syntax diff --git a/docs/mfc/reference/coledroptarget-class.md b/docs/mfc/reference/coledroptarget-class.md index 302ff8d19da..e9bd9141c53 100644 --- a/docs/mfc/reference/coledroptarget-class.md +++ b/docs/mfc/reference/coledroptarget-class.md @@ -4,10 +4,12 @@ title: "COleDropTarget Class" ms.date: "11/04/2016" f1_keywords: ["COleDropTarget", "AFXOLE/COleDropTarget", "AFXOLE/COleDropTarget::COleDropTarget", "AFXOLE/COleDropTarget::OnDragEnter", "AFXOLE/COleDropTarget::OnDragLeave", "AFXOLE/COleDropTarget::OnDragOver", "AFXOLE/COleDropTarget::OnDragScroll", "AFXOLE/COleDropTarget::OnDrop", "AFXOLE/COleDropTarget::OnDropEx", "AFXOLE/COleDropTarget::Register", "AFXOLE/COleDropTarget::Revoke"] helpviewer_keywords: ["COleDropTarget [MFC], COleDropTarget", "COleDropTarget [MFC], OnDragEnter", "COleDropTarget [MFC], OnDragLeave", "COleDropTarget [MFC], OnDragOver", "COleDropTarget [MFC], OnDragScroll", "COleDropTarget [MFC], OnDrop", "COleDropTarget [MFC], OnDropEx", "COleDropTarget [MFC], Register", "COleDropTarget [MFC], Revoke"] -ms.assetid: a58c9a48-6a93-4357-b078-4594df258311 --- # COleDropTarget Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the communication mechanism between a window and the OLE libraries. ## Syntax diff --git a/docs/mfc/reference/coleexception-class.md b/docs/mfc/reference/coleexception-class.md index c9c34fbd723..f78ec5f29fb 100644 --- a/docs/mfc/reference/coleexception-class.md +++ b/docs/mfc/reference/coleexception-class.md @@ -4,10 +4,12 @@ title: "COleException Class" ms.date: "11/04/2016" f1_keywords: ["COleException", "AFXDISP/COleException", "AFXDISP/COleException::Process", "AFXDISP/COleException::m_sc"] helpviewer_keywords: ["COleException [MFC], Process", "COleException [MFC], m_sc"] -ms.assetid: 2571e9fe-26cc-42f0-9ad9-8ad5b4311ec1 --- # COleException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents an exception condition related to an OLE operation. ## Syntax diff --git a/docs/mfc/reference/coleinsertdialog-class.md b/docs/mfc/reference/coleinsertdialog-class.md index 976c1cfaacb..229f2ae0ac3 100644 --- a/docs/mfc/reference/coleinsertdialog-class.md +++ b/docs/mfc/reference/coleinsertdialog-class.md @@ -4,10 +4,12 @@ title: "COleInsertDialog Class" ms.date: "11/04/2016" f1_keywords: ["COleInsertDialog", "AFXODLGS/COleInsertDialog", "AFXODLGS/COleInsertDialog::COleInsertDialog", "AFXODLGS/COleInsertDialog::CreateItem", "AFXODLGS/COleInsertDialog::DoModal", "AFXODLGS/COleInsertDialog::GetClassID", "AFXODLGS/COleInsertDialog::GetDrawAspect", "AFXODLGS/COleInsertDialog::GetIconicMetafile", "AFXODLGS/COleInsertDialog::GetPathName", "AFXODLGS/COleInsertDialog::GetSelectionType", "AFXODLGS/COleInsertDialog::m_io"] helpviewer_keywords: ["COleInsertDialog [MFC], COleInsertDialog", "COleInsertDialog [MFC], CreateItem", "COleInsertDialog [MFC], DoModal", "COleInsertDialog [MFC], GetClassID", "COleInsertDialog [MFC], GetDrawAspect", "COleInsertDialog [MFC], GetIconicMetafile", "COleInsertDialog [MFC], GetPathName", "COleInsertDialog [MFC], GetSelectionType", "COleInsertDialog [MFC], m_io"] -ms.assetid: a9ec610b-abde-431e-bd01-c40159a66dbb --- # COleInsertDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used for the OLE Insert Object dialog box. ## Syntax diff --git a/docs/mfc/reference/coleipframewnd-class.md b/docs/mfc/reference/coleipframewnd-class.md index 268e34a20cd..01d3333f30c 100644 --- a/docs/mfc/reference/coleipframewnd-class.md +++ b/docs/mfc/reference/coleipframewnd-class.md @@ -4,10 +4,12 @@ title: "COleIPFrameWnd Class" ms.date: "11/04/2016" f1_keywords: ["COleIPFrameWnd", "AFXOLE/COleIPFrameWnd", "AFXOLE/COleIPFrameWnd::COleIPFrameWnd", "AFXOLE/COleIPFrameWnd::OnCreateControlBars", "AFXOLE/COleIPFrameWnd::RepositionFrame"] helpviewer_keywords: ["COleIPFrameWnd [MFC], COleIPFrameWnd", "COleIPFrameWnd [MFC], OnCreateControlBars", "COleIPFrameWnd [MFC], RepositionFrame"] -ms.assetid: 24abb2cb-826c-4dda-a287-d8a8900a5763 --- # COleIPFrameWnd Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base for your application's in-place editing window. ## Syntax diff --git a/docs/mfc/reference/coleipframewndex-class.md b/docs/mfc/reference/coleipframewndex-class.md index 51faf2f1521..e309d938cf8 100644 --- a/docs/mfc/reference/coleipframewndex-class.md +++ b/docs/mfc/reference/coleipframewndex-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["COleIPFrameWndEx [MFC], AddDockSite", "COleIPFrameWndEx [ --- # COleIPFrameWndEx Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `COleIPFrameWndEx` class implements an OLE container that supports MFC. You must derive the in-place frame window class for your application from the `COleIPFrameWndEx` class, instead of deriving it from the [COleIPFrameWnd](../../mfc/reference/coleipframewnd-class.md) class. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/colelinkingdoc-class.md b/docs/mfc/reference/colelinkingdoc-class.md index a0e9bc58586..e81abbb02b1 100644 --- a/docs/mfc/reference/colelinkingdoc-class.md +++ b/docs/mfc/reference/colelinkingdoc-class.md @@ -4,10 +4,12 @@ title: "COleLinkingDoc Class" ms.date: "11/04/2016" f1_keywords: ["COleLinkingDoc", "AFXOLE/COleLinkingDoc", "AFXOLE/COleLinkingDoc::COleLinkingDoc", "AFXOLE/COleLinkingDoc::Register", "AFXOLE/COleLinkingDoc::Revoke", "AFXOLE/COleLinkingDoc::OnFindEmbeddedItem", "AFXOLE/COleLinkingDoc::OnGetLinkedItem"] helpviewer_keywords: ["COleLinkingDoc [MFC], COleLinkingDoc", "COleLinkingDoc [MFC], Register", "COleLinkingDoc [MFC], Revoke", "COleLinkingDoc [MFC], OnFindEmbeddedItem", "COleLinkingDoc [MFC], OnGetLinkedItem"] -ms.assetid: 9f547f35-2f95-427f-b9c0-85c31940198b --- # COleLinkingDoc Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class for OLE container documents that support linking to the embedded items they contain. ## Syntax diff --git a/docs/mfc/reference/colelinksdialog-class.md b/docs/mfc/reference/colelinksdialog-class.md index 9f58c147848..af1f098034d 100644 --- a/docs/mfc/reference/colelinksdialog-class.md +++ b/docs/mfc/reference/colelinksdialog-class.md @@ -4,10 +4,12 @@ title: "COleLinksDialog Class" ms.date: "11/04/2016" f1_keywords: ["COleLinksDialog", "AFXODLGS/COleLinksDialog", "AFXODLGS/COleLinksDialog::COleLinksDialog", "AFXODLGS/COleLinksDialog::DoModal", "AFXODLGS/COleLinksDialog::m_el"] helpviewer_keywords: ["COleLinksDialog [MFC], COleLinksDialog", "COleLinksDialog [MFC], DoModal", "COleLinksDialog [MFC], m_el"] -ms.assetid: fb2eb638-2809-46db-ac74-392a732affc7 --- # COleLinksDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used for the OLE Edit Links dialog box. ## Syntax diff --git a/docs/mfc/reference/colemessagefilter-class.md b/docs/mfc/reference/colemessagefilter-class.md index 4fe6409199c..51294d30e72 100644 --- a/docs/mfc/reference/colemessagefilter-class.md +++ b/docs/mfc/reference/colemessagefilter-class.md @@ -4,10 +4,12 @@ title: "COleMessageFilter Class" ms.date: "11/04/2016" f1_keywords: ["COleMessageFilter", "AFXOLE/COleMessageFilter", "AFXOLE/COleMessageFilter::COleMessageFilter", "AFXOLE/COleMessageFilter::BeginBusyState", "AFXOLE/COleMessageFilter::EnableBusyDialog", "AFXOLE/COleMessageFilter::EnableNotRespondingDialog", "AFXOLE/COleMessageFilter::EndBusyState", "AFXOLE/COleMessageFilter::OnMessagePending", "AFXOLE/COleMessageFilter::Register", "AFXOLE/COleMessageFilter::Revoke", "AFXOLE/COleMessageFilter::SetBusyReply", "AFXOLE/COleMessageFilter::SetMessagePendingDelay", "AFXOLE/COleMessageFilter::SetRetryReply"] helpviewer_keywords: ["COleMessageFilter [MFC], COleMessageFilter", "COleMessageFilter [MFC], BeginBusyState", "COleMessageFilter [MFC], EnableBusyDialog", "COleMessageFilter [MFC], EnableNotRespondingDialog", "COleMessageFilter [MFC], EndBusyState", "COleMessageFilter [MFC], OnMessagePending", "COleMessageFilter [MFC], Register", "COleMessageFilter [MFC], Revoke", "COleMessageFilter [MFC], SetBusyReply", "COleMessageFilter [MFC], SetMessagePendingDelay", "COleMessageFilter [MFC], SetRetryReply"] -ms.assetid: b1fd1639-fac4-4fd0-bf17-15172deba13c --- # COleMessageFilter Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages the concurrency required by the interaction of OLE applications. ## Syntax diff --git a/docs/mfc/reference/coleobjectfactory-class.md b/docs/mfc/reference/coleobjectfactory-class.md index e1b3a5411d5..08a19604d79 100644 --- a/docs/mfc/reference/coleobjectfactory-class.md +++ b/docs/mfc/reference/coleobjectfactory-class.md @@ -4,10 +4,12 @@ title: "COleObjectFactory Class" ms.date: "11/04/2016" f1_keywords: ["COleObjectFactory", "AFXDISP/COleObjectFactory", "AFXDISP/COleObjectFactory::COleObjectFactory", "AFXDISP/COleObjectFactory::GetClassID", "AFXDISP/COleObjectFactory::IsLicenseValid", "AFXDISP/COleObjectFactory::IsRegistered", "AFXDISP/COleObjectFactory::Register", "AFXDISP/COleObjectFactory::RegisterAll", "AFXDISP/COleObjectFactory::Revoke", "AFXDISP/COleObjectFactory::RevokeAll", "AFXDISP/COleObjectFactory::UnregisterAll", "AFXDISP/COleObjectFactory::UpdateRegistry", "AFXDISP/COleObjectFactory::UpdateRegistryAll", "AFXDISP/COleObjectFactory::GetLicenseKey", "AFXDISP/COleObjectFactory::OnCreateObject", "AFXDISP/COleObjectFactory::VerifyLicenseKey", "AFXDISP/COleObjectFactory::VerifyUserLicense"] helpviewer_keywords: ["COleObjectFactory [MFC], COleObjectFactory", "COleObjectFactory [MFC], GetClassID", "COleObjectFactory [MFC], IsLicenseValid", "COleObjectFactory [MFC], IsRegistered", "COleObjectFactory [MFC], Register", "COleObjectFactory [MFC], RegisterAll", "COleObjectFactory [MFC], Revoke", "COleObjectFactory [MFC], RevokeAll", "COleObjectFactory [MFC], UnregisterAll", "COleObjectFactory [MFC], UpdateRegistry", "COleObjectFactory [MFC], UpdateRegistryAll", "COleObjectFactory [MFC], GetLicenseKey", "COleObjectFactory [MFC], OnCreateObject", "COleObjectFactory [MFC], VerifyLicenseKey", "COleObjectFactory [MFC], VerifyUserLicense"] -ms.assetid: ab179c1e-4af2-44aa-a576-37c48149b427 --- # COleObjectFactory Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the OLE class factory, which creates OLE objects such as servers, automation objects, and documents. ## Syntax diff --git a/docs/mfc/reference/colepastespecialdialog-class.md b/docs/mfc/reference/colepastespecialdialog-class.md index cfc6e49021c..26e5fd4a445 100644 --- a/docs/mfc/reference/colepastespecialdialog-class.md +++ b/docs/mfc/reference/colepastespecialdialog-class.md @@ -4,10 +4,12 @@ title: "COlePasteSpecialDialog Class" ms.date: "11/04/2016" f1_keywords: ["COlePasteSpecialDialog", "AFXODLGS/COlePasteSpecialDialog", "AFXODLGS/COlePasteSpecialDialog::COlePasteSpecialDialog", "AFXODLGS/COlePasteSpecialDialog::AddFormat", "AFXODLGS/COlePasteSpecialDialog::AddLinkEntry", "AFXODLGS/COlePasteSpecialDialog::AddStandardFormats", "AFXODLGS/COlePasteSpecialDialog::CreateItem", "AFXODLGS/COlePasteSpecialDialog::DoModal", "AFXODLGS/COlePasteSpecialDialog::GetDrawAspect", "AFXODLGS/COlePasteSpecialDialog::GetIconicMetafile", "AFXODLGS/COlePasteSpecialDialog::GetPasteIndex", "AFXODLGS/COlePasteSpecialDialog::GetSelectionType", "AFXODLGS/COlePasteSpecialDialog::m_ps"] helpviewer_keywords: ["COlePasteSpecialDialog [MFC], COlePasteSpecialDialog", "COlePasteSpecialDialog [MFC], AddFormat", "COlePasteSpecialDialog [MFC], AddLinkEntry", "COlePasteSpecialDialog [MFC], AddStandardFormats", "COlePasteSpecialDialog [MFC], CreateItem", "COlePasteSpecialDialog [MFC], DoModal", "COlePasteSpecialDialog [MFC], GetDrawAspect", "COlePasteSpecialDialog [MFC], GetIconicMetafile", "COlePasteSpecialDialog [MFC], GetPasteIndex", "COlePasteSpecialDialog [MFC], GetSelectionType", "COlePasteSpecialDialog [MFC], m_ps"] -ms.assetid: 0e82ef9a-9bbe-457e-8240-42c86a0534f7 --- # COlePasteSpecialDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used for the OLE Paste Special dialog box. ## Syntax diff --git a/docs/mfc/reference/colepropertiesdialog-class.md b/docs/mfc/reference/colepropertiesdialog-class.md index 55ad58f8271..c35ab0d70ec 100644 --- a/docs/mfc/reference/colepropertiesdialog-class.md +++ b/docs/mfc/reference/colepropertiesdialog-class.md @@ -4,10 +4,12 @@ title: "COlePropertiesDialog Class" ms.date: "11/04/2016" f1_keywords: ["COlePropertiesDialog", "AFXODLGS/COlePropertiesDialog", "AFXODLGS/COlePropertiesDialog::COlePropertiesDialog", "AFXODLGS/COlePropertiesDialog::DoModal", "AFXODLGS/COlePropertiesDialog::OnApplyScale", "AFXODLGS/COlePropertiesDialog::m_gp", "AFXODLGS/COlePropertiesDialog::m_lp", "AFXODLGS/COlePropertiesDialog::m_op", "AFXODLGS/COlePropertiesDialog::m_psh", "AFXODLGS/COlePropertiesDialog::m_vp"] helpviewer_keywords: ["COlePropertiesDialog [MFC], COlePropertiesDialog", "COlePropertiesDialog [MFC], DoModal", "COlePropertiesDialog [MFC], OnApplyScale", "COlePropertiesDialog [MFC], m_gp", "COlePropertiesDialog [MFC], m_lp", "COlePropertiesDialog [MFC], m_op", "COlePropertiesDialog [MFC], m_psh", "COlePropertiesDialog [MFC], m_vp"] -ms.assetid: a54dbc89-1447-4329-bd01-00e98ec9e935 --- # COlePropertiesDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the Windows common OLE Object Properties dialog box. ## Syntax diff --git a/docs/mfc/reference/colepropertypage-class.md b/docs/mfc/reference/colepropertypage-class.md index bc1c760b238..e9d69c786df 100644 --- a/docs/mfc/reference/colepropertypage-class.md +++ b/docs/mfc/reference/colepropertypage-class.md @@ -4,10 +4,12 @@ title: "COlePropertyPage Class" ms.date: "11/04/2016" f1_keywords: ["COlePropertyPage", "AFXCTL/COlePropertyPage", "AFXCTL/COlePropertyPage::COlePropertyPage", "AFXCTL/COlePropertyPage::GetControlStatus", "AFXCTL/COlePropertyPage::GetObjectArray", "AFXCTL/COlePropertyPage::GetPageSite", "AFXCTL/COlePropertyPage::OVERWRITEApply", "AFXCTL/COlePropertyPage::IsModified", "AFXCTL/COlePropertyPage::OnEditProperty", "AFXCTL/COlePropertyPage::OnHelp", "AFXCTL/COlePropertyPage::OnInitDialog", "AFXCTL/COlePropertyPage::OnObjectsChanged", "AFXCTL/COlePropertyPage::OnSetPageSite", "AFXCTL/COlePropertyPage::SetControlStatus", "AFXCTL/COlePropertyPage::SetDialogResource", "AFXCTL/COlePropertyPage::SetHelpInfo", "AFXCTL/COlePropertyPage::SetModifiedFlag", "AFXCTL/COlePropertyPage::SetPageName"] helpviewer_keywords: ["COlePropertyPage [MFC], COlePropertyPage", "COlePropertyPage [MFC], GetControlStatus", "COlePropertyPage [MFC], GetObjectArray", "COlePropertyPage [MFC], GetPageSite", "COlePropertyPage [MFC], IgnoreApply", "COlePropertyPage [MFC], IsModified", "COlePropertyPage [MFC], OnEditProperty", "COlePropertyPage [MFC], OnHelp", "COlePropertyPage [MFC], OnInitDialog", "COlePropertyPage [MFC], OnObjectsChanged", "COlePropertyPage [MFC], OnSetPageSite", "COlePropertyPage [MFC], SetControlStatus", "COlePropertyPage [MFC], SetDialogResource", "COlePropertyPage [MFC], SetHelpInfo", "COlePropertyPage [MFC], SetModifiedFlag", "COlePropertyPage [MFC], SetPageName"] -ms.assetid: e9972872-8e6b-4550-905e-d36a274d64dc --- # COlePropertyPage Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used to display the properties of a custom control in a graphical interface, similar to a dialog box. ## Syntax diff --git a/docs/mfc/reference/coleresizebar-class.md b/docs/mfc/reference/coleresizebar-class.md index 1066e554e7a..5909bb78628 100644 --- a/docs/mfc/reference/coleresizebar-class.md +++ b/docs/mfc/reference/coleresizebar-class.md @@ -4,10 +4,12 @@ title: "COleResizeBar Class" ms.date: "11/04/2016" f1_keywords: ["COleResizeBar", "AFXOLE/COleResizeBar", "AFXOLE/COleResizeBar::COleResizeBar", "AFXOLE/COleResizeBar::Create"] helpviewer_keywords: ["COleResizeBar [MFC], COleResizeBar", "COleResizeBar [MFC], Create"] -ms.assetid: 56a708d9-28c5-4eb0-9404-77b688d91c63 --- # COleResizeBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A type of control bar that supports resizing of in-place OLE items. ## Syntax diff --git a/docs/mfc/reference/colesafearray-class.md b/docs/mfc/reference/colesafearray-class.md index f85c05baf87..322140c97cd 100644 --- a/docs/mfc/reference/colesafearray-class.md +++ b/docs/mfc/reference/colesafearray-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["COleSafeArray [MFC], COleSafeArray", "COleSafeArray [MFC] --- # COleSafeArray Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A class for working with arrays of arbitrary type and dimension. ## Syntax diff --git a/docs/mfc/reference/coleserverdoc-class.md b/docs/mfc/reference/coleserverdoc-class.md index b81a4ff6fdf..c9c350b8214 100644 --- a/docs/mfc/reference/coleserverdoc-class.md +++ b/docs/mfc/reference/coleserverdoc-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["COleServerDoc [MFC], COleServerDoc", "COleServerDoc [MFC] --- # COleServerDoc Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class for OLE server documents. ## Syntax diff --git a/docs/mfc/reference/coleserveritem-class.md b/docs/mfc/reference/coleserveritem-class.md index 44a7e5a498a..61718ed04e1 100644 --- a/docs/mfc/reference/coleserveritem-class.md +++ b/docs/mfc/reference/coleserveritem-class.md @@ -4,10 +4,12 @@ title: "COleServerItem Class" ms.date: "11/04/2016" f1_keywords: ["COleServerItem", "AFXOLE/COleServerItem", "AFXOLE/COleServerItem::COleServerItem", "AFXOLE/COleServerItem::AddOtherClipboardData", "AFXOLE/COleServerItem::CopyToClipboard", "AFXOLE/COleServerItem::DoDragDrop", "AFXOLE/COleServerItem::GetClipboardData", "AFXOLE/COleServerItem::GetDocument", "AFXOLE/COleServerItem::GetEmbedSourceData", "AFXOLE/COleServerItem::GetItemName", "AFXOLE/COleServerItem::GetLinkSourceData", "AFXOLE/COleServerItem::GetObjectDescriptorData", "AFXOLE/COleServerItem::IsConnected", "AFXOLE/COleServerItem::IsLinkedItem", "AFXOLE/COleServerItem::NotifyChanged", "AFXOLE/COleServerItem::OnDoVerb", "AFXOLE/COleServerItem::OnDraw", "AFXOLE/COleServerItem::OnDrawEx", "AFXOLE/COleServerItem::OnGetClipboardData", "AFXOLE/COleServerItem::OnGetExtent", "AFXOLE/COleServerItem::OnInitFromData", "AFXOLE/COleServerItem::OnQueryUpdateItems", "AFXOLE/COleServerItem::OnRenderData", "AFXOLE/COleServerItem::OnRenderFileData", "AFXOLE/COleServerItem::OnRenderGlobalData", "AFXOLE/COleServerItem::OnSetColorScheme", "AFXOLE/COleServerItem::OnSetData", "AFXOLE/COleServerItem::OnSetExtent", "AFXOLE/COleServerItem::OnUpdate", "AFXOLE/COleServerItem::OnUpdateItems", "AFXOLE/COleServerItem::SetItemName", "AFXOLE/COleServerItem::GetDataSource", "AFXOLE/COleServerItem::OnHide", "AFXOLE/COleServerItem::OnOpen", "AFXOLE/COleServerItem::OnShow", "AFXOLE/COleServerItem::m_sizeExtent"] helpviewer_keywords: ["COleServerItem [MFC], COleServerItem", "COleServerItem [MFC], AddOtherClipboardData", "COleServerItem [MFC], CopyToClipboard", "COleServerItem [MFC], DoDragDrop", "COleServerItem [MFC], GetClipboardData", "COleServerItem [MFC], GetDocument", "COleServerItem [MFC], GetEmbedSourceData", "COleServerItem [MFC], GetItemName", "COleServerItem [MFC], GetLinkSourceData", "COleServerItem [MFC], GetObjectDescriptorData", "COleServerItem [MFC], IsConnected", "COleServerItem [MFC], IsLinkedItem", "COleServerItem [MFC], NotifyChanged", "COleServerItem [MFC], OnDoVerb", "COleServerItem [MFC], OnDraw", "COleServerItem [MFC], OnDrawEx", "COleServerItem [MFC], OnGetClipboardData", "COleServerItem [MFC], OnGetExtent", "COleServerItem [MFC], OnInitFromData", "COleServerItem [MFC], OnQueryUpdateItems", "COleServerItem [MFC], OnRenderData", "COleServerItem [MFC], OnRenderFileData", "COleServerItem [MFC], OnRenderGlobalData", "COleServerItem [MFC], OnSetColorScheme", "COleServerItem [MFC], OnSetData", "COleServerItem [MFC], OnSetExtent", "COleServerItem [MFC], OnUpdate", "COleServerItem [MFC], OnUpdateItems", "COleServerItem [MFC], SetItemName", "COleServerItem [MFC], GetDataSource", "COleServerItem [MFC], OnHide", "COleServerItem [MFC], OnOpen", "COleServerItem [MFC], OnShow", "COleServerItem [MFC], m_sizeExtent"] -ms.assetid: 80256df6-3888-4256-944b-787d4b2e6b0d --- # COleServerItem Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the server interface to OLE items. ## Syntax diff --git a/docs/mfc/reference/colestreamfile-class.md b/docs/mfc/reference/colestreamfile-class.md index 964fe4e4dd8..62128112f58 100644 --- a/docs/mfc/reference/colestreamfile-class.md +++ b/docs/mfc/reference/colestreamfile-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["COleStreamFile [MFC], COleStreamFile", "COleStreamFile [M --- # COleStreamFile Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a stream of data (`IStream`) in a compound file as part of OLE Structured Storage. ## Syntax diff --git a/docs/mfc/reference/coletemplateserver-class.md b/docs/mfc/reference/coletemplateserver-class.md index 79a0b6e661b..2c2175eb464 100644 --- a/docs/mfc/reference/coletemplateserver-class.md +++ b/docs/mfc/reference/coletemplateserver-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["COleTemplateServer [MFC], COleTemplateServer", "COleTempl --- # COleTemplateServer Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used for OLE visual editing servers, automation servers, and link containers (applications that support links to embeddings). ## Syntax diff --git a/docs/mfc/reference/coleupdatedialog-class.md b/docs/mfc/reference/coleupdatedialog-class.md index 326d47c4ada..fecc99693b3 100644 --- a/docs/mfc/reference/coleupdatedialog-class.md +++ b/docs/mfc/reference/coleupdatedialog-class.md @@ -4,10 +4,12 @@ title: "COleUpdateDialog Class" ms.date: "11/04/2016" f1_keywords: ["COleUpdateDialog", "AFXODLGS/COleUpdateDialog", "AFXODLGS/COleUpdateDialog::COleUpdateDialog", "AFXODLGS/COleUpdateDialog::DoModal"] helpviewer_keywords: ["COleUpdateDialog [MFC], COleUpdateDialog", "COleUpdateDialog [MFC], DoModal"] -ms.assetid: 699ca980-52b1-4cf8-9ab1-ac6767ad5b0e --- # COleUpdateDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Used for a special case of the OLE Edit Links dialog box, which should be used when you need to update only existing linked or embedded objects in a document. ## Syntax diff --git a/docs/mfc/reference/colevariant-class.md b/docs/mfc/reference/colevariant-class.md index f3bc198514a..2bea4e14753 100644 --- a/docs/mfc/reference/colevariant-class.md +++ b/docs/mfc/reference/colevariant-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["COleVariant [MFC], COleVariant", "COleVariant [MFC], Atta --- # COleVariant Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the [VARIANT](/windows/win32/api/oaidl/ns-oaidl-variant) data type. ## Syntax diff --git a/docs/mfc/reference/collection-class-helpers.md b/docs/mfc/reference/collection-class-helpers.md index ca02e0d281f..b89b18ac671 100644 --- a/docs/mfc/reference/collection-class-helpers.md +++ b/docs/mfc/reference/collection-class-helpers.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["DestructElements function", "ConstructElements function", --- # Collection Class Helpers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The collection classes `CMap`, `CList`, and `CArray` use templated global helper functions for such purposes as comparing, copying, and serializing elements. As part of your implementation of classes based on `CMap`, `CList`, and `CArray`, you must override these functions as necessary with versions tailored to the type of data stored in your map, list, or array. For information on overriding helper functions such as `SerializeElements`, see the article [Collections: How to Make a Type-Safe Collection](../../mfc/how-to-make-a-type-safe-collection.md). Note that `ConstructElements` and `DestructElements` have been deprecated. The Microsoft Foundation Class Library provides the following global functions in afxtempl.h to help you customize your collection classes: diff --git a/docs/mfc/reference/combo-box-handlers.md b/docs/mfc/reference/combo-box-handlers.md index 46257dcaf02..f95c442ef4c 100644 --- a/docs/mfc/reference/combo-box-handlers.md +++ b/docs/mfc/reference/combo-box-handlers.md @@ -4,10 +4,12 @@ title: "Combo Box Handlers" ms.date: "11/04/2016" f1_keywords: ["ON_CBN_KILLFOCUS", "ON_CBN_ERRSPACE", "ON_CBN_EDITCHANGE", "ON_CBN_CLOSEUP", "ON_CBN_DBLCLK", "ON_CBN_EDITUPDATE", "ON_CBN_DROPDOWN", "ON_CBN_SELENDOK", "ON_CBN_SELCHANGE", "ON_CBN_SETFOCUS", "ON_CBN_SELENDCANCEL"] helpviewer_keywords: ["ON_CBN_CLOSEUP", "ON_CBN_SETFOCUS", "ON_CBN_DBLCLK", "ON_CBN_SELENDCANCEL", "ON_CBN_DROPDOWN", "ON_CBN_EDITUPDATE", "ON_CBN_KILLFOCUS", "combo boxes [MFC], handlers", "ON_CBN_EDITCHANGE", "ON_CBN_ERRSPACE", "ON_CBN_SELENDOK", "ON_CBN_SELCHANGE"] -ms.assetid: 7f092412-01b7-4242-95ec-41ba506b9d71 --- # Combo Box Handlers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries correspond to the function prototypes. |Map entry|Function prototype| diff --git a/docs/mfc/reference/compound-document-support-mfc-application-wizard.md b/docs/mfc/reference/compound-document-support-mfc-application-wizard.md index cf2cac48dfd..6ad2ec8f2f1 100644 --- a/docs/mfc/reference/compound-document-support-mfc-application-wizard.md +++ b/docs/mfc/reference/compound-document-support-mfc-application-wizard.md @@ -3,10 +3,12 @@ description: "Learn more about: Compound Document Support, MFC Application Wizar title: "Compound Document Support, MFC Application Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.exe.compdoc"] -ms.assetid: 42e1af83-12c4-438d-92eb-13835afdb148 --- # Compound Document Support, MFC Application Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In this page of the MFC Application Wizard, indicate to what level your application provides compound and active document support. Your application must support the document/view architecture to support compound documents and document templates. By default, the application contains no compound document support. If you accept this default, your application cannot support active documents or compound files. diff --git a/docs/mfc/reference/connection-maps.md b/docs/mfc/reference/connection-maps.md index 021a53eeade..db3d8ce0988 100644 --- a/docs/mfc/reference/connection-maps.md +++ b/docs/mfc/reference/connection-maps.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["connection maps"] # Connection maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + OLE controls are able to expose interfaces to other applications. These interfaces only allow access from a container into that control. If an OLE control wants to access external interfaces of other OLE objects, a connection point must be established. This connection point allows a control outgoing access to external dispatch maps, such as event maps or notification functions. The Microsoft Foundation Class Library offers a programming model that supports connection points. In this model, "connection maps" are used to designate interfaces or connection points for the OLE control. Connection maps contain one macro for each connection point. For more information on connection maps, see the [`CConnectionPoint`](../../mfc/reference/cconnectionpoint-class.md) class. diff --git a/docs/mfc/reference/control-names-mfc-activex-control-wizard.md b/docs/mfc/reference/control-names-mfc-activex-control-wizard.md index 9d6baedbd15..1ee01d5de06 100644 --- a/docs/mfc/reference/control-names-mfc-activex-control-wizard.md +++ b/docs/mfc/reference/control-names-mfc-activex-control-wizard.md @@ -4,10 +4,12 @@ title: "Control Names, MFC ActiveX Control Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.ctl.names"] helpviewer_keywords: ["MFC ActiveX Control Wizard, control names"] -ms.assetid: 9b8b81d2-36df-48ed-b58a-a771a0e269ee --- # Control Names, MFC ActiveX Control Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Specify the names for the control class and property page class, the type names, and type identifiers for your control. With the exception of **Short name**, all other fields can be edited independently. If you change the text for **Short name**, the change is reflected in the names of all other fields in this page. This naming behavior is designed to make all the names easily identifiable for you as you develop your control. - **Short name** diff --git a/docs/mfc/reference/control-settings-mfc-activex-control-wizard.md b/docs/mfc/reference/control-settings-mfc-activex-control-wizard.md index 6fe38cbe3b5..6c7a98c6210 100644 --- a/docs/mfc/reference/control-settings-mfc-activex-control-wizard.md +++ b/docs/mfc/reference/control-settings-mfc-activex-control-wizard.md @@ -4,10 +4,12 @@ title: "Control Settings, MFC ActiveX Control Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.ctl.settings"] helpviewer_keywords: ["MFC ActiveX Control Wizard, control settings"] -ms.assetid: 2ccaa4fc-0d52-413e-afa3-ecd474c3f6f0 --- # Control Settings, MFC ActiveX Control Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use this page of the wizard to specify how you want the control to behave. For example, you can base the control on standard Windows control types, optimize its behavior and appearance, or indicate that the control can act as a container for other controls. For more information about how to select options on this page to maximize the efficiency of the control, see [MFC ActiveX Controls: Optimization](../../mfc/mfc-activex-controls-optimization.md). diff --git a/docs/mfc/reference/cpagerctrl-class.md b/docs/mfc/reference/cpagerctrl-class.md index 78da74a2235..e04ec30cc21 100644 --- a/docs/mfc/reference/cpagerctrl-class.md +++ b/docs/mfc/reference/cpagerctrl-class.md @@ -4,10 +4,12 @@ title: "CPagerCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CPagerCtrl", "AFXCMN/CPagerCtrl", "AFXCMN/CPagerCtrl::CPagerCtrl", "AFXCMN/CPagerCtrl::Create", "AFXCMN/CPagerCtrl::CreateEx", "AFXCMN/CPagerCtrl::ForwardMouse", "AFXCMN/CPagerCtrl::GetBkColor", "AFXCMN/CPagerCtrl::GetBorder", "AFXCMN/CPagerCtrl::GetButtonSize", "AFXCMN/CPagerCtrl::GetButtonState", "AFXCMN/CPagerCtrl::GetDropTarget", "AFXCMN/CPagerCtrl::GetScrollPos", "AFXCMN/CPagerCtrl::IsButtonDepressed", "AFXCMN/CPagerCtrl::IsButtonGrayed", "AFXCMN/CPagerCtrl::IsButtonHot", "AFXCMN/CPagerCtrl::IsButtonInvisible", "AFXCMN/CPagerCtrl::IsButtonNormal", "AFXCMN/CPagerCtrl::RecalcSize", "AFXCMN/CPagerCtrl::SetBkColor", "AFXCMN/CPagerCtrl::SetBorder", "AFXCMN/CPagerCtrl::SetButtonSize", "AFXCMN/CPagerCtrl::SetChild", "AFXCMN/CPagerCtrl::SetScrollPos"] helpviewer_keywords: ["CPagerCtrl [MFC], CPagerCtrl", "CPagerCtrl [MFC], Create", "CPagerCtrl [MFC], CreateEx", "CPagerCtrl [MFC], ForwardMouse", "CPagerCtrl [MFC], GetBkColor", "CPagerCtrl [MFC], GetBorder", "CPagerCtrl [MFC], GetButtonSize", "CPagerCtrl [MFC], GetButtonState", "CPagerCtrl [MFC], GetDropTarget", "CPagerCtrl [MFC], GetScrollPos", "CPagerCtrl [MFC], IsButtonDepressed", "CPagerCtrl [MFC], IsButtonGrayed", "CPagerCtrl [MFC], IsButtonHot", "CPagerCtrl [MFC], IsButtonInvisible", "CPagerCtrl [MFC], IsButtonNormal", "CPagerCtrl [MFC], RecalcSize", "CPagerCtrl [MFC], SetBkColor", "CPagerCtrl [MFC], SetBorder", "CPagerCtrl [MFC], SetButtonSize", "CPagerCtrl [MFC], SetChild", "CPagerCtrl [MFC], SetScrollPos"] -ms.assetid: 65ac58dd-4f5e-4b7e-b15c-e0d435a7e884 --- # CPagerCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CPagerCtrl` class wraps the Windows pager control, which can scroll into view a contained window that does not fit the containing window. ## Syntax diff --git a/docs/mfc/reference/cpagesetupdialog-class.md b/docs/mfc/reference/cpagesetupdialog-class.md index bf629aa89cc..296f1412590 100644 --- a/docs/mfc/reference/cpagesetupdialog-class.md +++ b/docs/mfc/reference/cpagesetupdialog-class.md @@ -4,10 +4,12 @@ title: "CPageSetupDialog Class" ms.date: "11/04/2016" f1_keywords: ["CPageSetupDialog", "AFXDLGS/CPageSetupDialog", "AFXDLGS/CPageSetupDialog::CPageSetupDialog", "AFXDLGS/CPageSetupDialog::CreatePrinterDC", "AFXDLGS/CPageSetupDialog::DoModal", "AFXDLGS/CPageSetupDialog::GetDeviceName", "AFXDLGS/CPageSetupDialog::GetDevMode", "AFXDLGS/CPageSetupDialog::GetDriverName", "AFXDLGS/CPageSetupDialog::GetMargins", "AFXDLGS/CPageSetupDialog::GetPaperSize", "AFXDLGS/CPageSetupDialog::GetPortName", "AFXDLGS/CPageSetupDialog::OnDrawPage", "AFXDLGS/CPageSetupDialog::PreDrawPage", "AFXDLGS/CPageSetupDialog::m_psd"] helpviewer_keywords: ["CPageSetupDialog [MFC], CPageSetupDialog", "CPageSetupDialog [MFC], CreatePrinterDC", "CPageSetupDialog [MFC], DoModal", "CPageSetupDialog [MFC], GetDeviceName", "CPageSetupDialog [MFC], GetDevMode", "CPageSetupDialog [MFC], GetDriverName", "CPageSetupDialog [MFC], GetMargins", "CPageSetupDialog [MFC], GetPaperSize", "CPageSetupDialog [MFC], GetPortName", "CPageSetupDialog [MFC], OnDrawPage", "CPageSetupDialog [MFC], PreDrawPage", "CPageSetupDialog [MFC], m_psd"] -ms.assetid: 049c0ac8-f254-4854-9414-7a8271d1447a --- # CPageSetupDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the services provided by the Windows common OLE Page Setup dialog box with additional support for setting and modifying print margins. ## Syntax diff --git a/docs/mfc/reference/cpaintdc-class.md b/docs/mfc/reference/cpaintdc-class.md index dc01823c28e..9f5268f8d58 100644 --- a/docs/mfc/reference/cpaintdc-class.md +++ b/docs/mfc/reference/cpaintdc-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CPaintDC [MFC], CPaintDC", "CPaintDC [MFC], m_ps", "CPain --- # `CPaintDC` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A device-context class derived from [`CDC`](../../mfc/reference/cdc-class.md). ## Syntax diff --git a/docs/mfc/reference/cpalette-class.md b/docs/mfc/reference/cpalette-class.md index c07f7e48beb..7c40fbda689 100644 --- a/docs/mfc/reference/cpalette-class.md +++ b/docs/mfc/reference/cpalette-class.md @@ -4,10 +4,12 @@ title: "CPalette Class" ms.date: "11/04/2016" f1_keywords: ["CPalette", "AFXWIN/CPalette", "AFXWIN/CPalette::CPalette", "AFXWIN/CPalette::AnimatePalette", "AFXWIN/CPalette::CreateHalftonePalette", "AFXWIN/CPalette::CreatePalette", "AFXWIN/CPalette::FromHandle", "AFXWIN/CPalette::GetEntryCount", "AFXWIN/CPalette::GetNearestPaletteIndex", "AFXWIN/CPalette::GetPaletteEntries", "AFXWIN/CPalette::ResizePalette", "AFXWIN/CPalette::SetPaletteEntries"] helpviewer_keywords: ["CPalette [MFC], CPalette", "CPalette [MFC], AnimatePalette", "CPalette [MFC], CreateHalftonePalette", "CPalette [MFC], CreatePalette", "CPalette [MFC], FromHandle", "CPalette [MFC], GetEntryCount", "CPalette [MFC], GetNearestPaletteIndex", "CPalette [MFC], GetPaletteEntries", "CPalette [MFC], ResizePalette", "CPalette [MFC], SetPaletteEntries"] -ms.assetid: 8cd95498-53ed-4852-85e1-70e522541114 --- # CPalette Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a Windows color palette. ## Syntax diff --git a/docs/mfc/reference/cpane-class.md b/docs/mfc/reference/cpane-class.md index 72daa26442a..b80f5cbffa5 100644 --- a/docs/mfc/reference/cpane-class.md +++ b/docs/mfc/reference/cpane-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CPane [MFC], AdjustSizeImmediate", "CPane [MFC], AllocEle --- # CPane Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CPane` class is an enhancement of the [CControlBar Class](../../mfc/reference/ccontrolbar-class.md). If you are upgrading an existing MFC project, replace all occurrences of `CControlBar` with `CPane`. ## Syntax diff --git a/docs/mfc/reference/cpanecontainer-class.md b/docs/mfc/reference/cpanecontainer-class.md index 46fbe336ba1..3dfdcf4bdca 100644 --- a/docs/mfc/reference/cpanecontainer-class.md +++ b/docs/mfc/reference/cpanecontainer-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CPaneContainer [MFC], CPaneContainer", "CPaneContainer [M --- # CPaneContainer Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CPaneContainer` class is a basic component of the docking model implemented by MFC. An object of this class stores pointers to two docking panes or to two instances of `CPaneContainer`. It also stores a pointer to the divider that separates the panes (or the containers). By nesting containers inside containers, the framework can build a binary tree that represents complex docking layouts. The root of the binary tree is stored in a [CPaneContainerManager](../../mfc/reference/cpanecontainermanager-class.md) object. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cpanecontainermanager-class.md b/docs/mfc/reference/cpanecontainermanager-class.md index 0adabe6f729..65836da7866 100644 --- a/docs/mfc/reference/cpanecontainermanager-class.md +++ b/docs/mfc/reference/cpanecontainermanager-class.md @@ -4,10 +4,12 @@ title: "CPaneContainerManager Class" ms.date: "11/04/2016" f1_keywords: ["CPaneContainerManager", "AFXPANECONTAINERMANAGER/CPaneContainerManager", "AFXPANECONTAINERMANAGER/CPaneContainerManager::AddPane", "AFXPANECONTAINERMANAGER/CPaneContainerManager::AddPaneContainerManager", "AFXPANECONTAINERMANAGER/CPaneContainerManager::AddPaneContainerManagerToDockablePane", "AFXPANECONTAINERMANAGER/CPaneContainerManager::AddPanesToList", "AFXPANECONTAINERMANAGER/CPaneContainerManager::AddPaneToList", "AFXPANECONTAINERMANAGER/CPaneContainerManager::AddPaneToRecentPaneContainer", "AFXPANECONTAINERMANAGER/CPaneContainerManager::CalcRects", "AFXPANECONTAINERMANAGER/CPaneContainerManager::CanBeAttached", "AFXPANECONTAINERMANAGER/CPaneContainerManager::CheckAndRemoveNonValidPane", "AFXPANECONTAINERMANAGER/CPaneContainerManager::CheckForMiniFrameAndCaption", "AFXPANECONTAINERMANAGER/CPaneContainerManager::Create", "AFXPANECONTAINERMANAGER/CPaneContainerManager::DoesAllowDynInsertBefore", "AFXPANECONTAINERMANAGER/CPaneContainerManager::DoesContainFloatingPane", "AFXPANECONTAINERMANAGER/CPaneContainerManager::EnableGrippers", "AFXPANECONTAINERMANAGER/CPaneContainerManager::FindPaneContainer", "AFXPANECONTAINERMANAGER/CPaneContainerManager::FindTabbedPane", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetAvailableSpace", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetDefaultPaneDivider", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetDockSiteFrameWnd", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetFirstPane", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetFirstVisiblePane", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetMinMaxOffset", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetMinSize", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetNodeCount", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetPaneContainerRTC", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetPaneCount", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetTotalRefCount", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetVisiblePaneCount", "AFXPANECONTAINERMANAGER/CPaneContainerManager::GetWindowRect", "AFXPANECONTAINERMANAGER/CPaneContainerManager::HideAll", "AFXPANECONTAINERMANAGER/CPaneContainerManager::InsertPane", "AFXPANECONTAINERMANAGER/CPaneContainerManager::IsAutoHideMode", "AFXPANECONTAINERMANAGER/CPaneContainerManager::IsEmpty", "AFXPANECONTAINERMANAGER/CPaneContainerManager::IsRootPaneContainerVisible", "AFXPANECONTAINERMANAGER/CPaneContainerManager::NotifyPaneDivider", "AFXPANECONTAINERMANAGER/CPaneContainerManager::OnPaneDividerMove", "AFXPANECONTAINERMANAGER/CPaneContainerManager::OnShowPane", "AFXPANECONTAINERMANAGER/CPaneContainerManager::PaneFromPoint", "AFXPANECONTAINERMANAGER/CPaneContainerManager::ReleaseEmptyPaneContainers", "AFXPANECONTAINERMANAGER/CPaneContainerManager::RemoveAllPanesAndPaneDividers", "AFXPANECONTAINERMANAGER/CPaneContainerManager::RemoveNonValidPanes", "AFXPANECONTAINERMANAGER/CPaneContainerManager::RemovePaneDivider", "AFXPANECONTAINERMANAGER/CPaneContainerManager::RemovePaneFromPaneContainer", "AFXPANECONTAINERMANAGER/CPaneContainerManager::ReplacePane", "AFXPANECONTAINERMANAGER/CPaneContainerManager::ResizePaneContainers", "AFXPANECONTAINERMANAGER/CPaneContainerManager::Serialize", "AFXPANECONTAINERMANAGER/CPaneContainerManager::SetDefaultPaneDividerForPanes", "AFXPANECONTAINERMANAGER/CPaneContainerManager::SetPaneContainerRTC", "AFXPANECONTAINERMANAGER/CPaneContainerManager::SetResizeMode", "AFXPANECONTAINERMANAGER/CPaneContainerManager::StoreRecentDockSiteInfo"] helpviewer_keywords: ["CPaneContainerManager [MFC], AddPane", "CPaneContainerManager [MFC], AddPaneContainerManager", "CPaneContainerManager [MFC], AddPaneContainerManagerToDockablePane", "CPaneContainerManager [MFC], AddPanesToList", "CPaneContainerManager [MFC], AddPaneToList", "CPaneContainerManager [MFC], AddPaneToRecentPaneContainer", "CPaneContainerManager [MFC], CalcRects", "CPaneContainerManager [MFC], CanBeAttached", "CPaneContainerManager [MFC], CheckAndRemoveNonValidPane", "CPaneContainerManager [MFC], CheckForMiniFrameAndCaption", "CPaneContainerManager [MFC], Create", "CPaneContainerManager [MFC], DoesAllowDynInsertBefore", "CPaneContainerManager [MFC], DoesContainFloatingPane", "CPaneContainerManager [MFC], EnableGrippers", "CPaneContainerManager [MFC], FindPaneContainer", "CPaneContainerManager [MFC], FindTabbedPane", "CPaneContainerManager [MFC], GetAvailableSpace", "CPaneContainerManager [MFC], GetDefaultPaneDivider", "CPaneContainerManager [MFC], GetDockSiteFrameWnd", "CPaneContainerManager [MFC], GetFirstPane", "CPaneContainerManager [MFC], GetFirstVisiblePane", "CPaneContainerManager [MFC], GetMinMaxOffset", "CPaneContainerManager [MFC], GetMinSize", "CPaneContainerManager [MFC], GetNodeCount", "CPaneContainerManager [MFC], GetPaneContainerRTC", "CPaneContainerManager [MFC], GetPaneCount", "CPaneContainerManager [MFC], GetTotalRefCount", "CPaneContainerManager [MFC], GetVisiblePaneCount", "CPaneContainerManager [MFC], GetWindowRect", "CPaneContainerManager [MFC], HideAll", "CPaneContainerManager [MFC], InsertPane", "CPaneContainerManager [MFC], IsAutoHideMode", "CPaneContainerManager [MFC], IsEmpty", "CPaneContainerManager [MFC], IsRootPaneContainerVisible", "CPaneContainerManager [MFC], NotifyPaneDivider", "CPaneContainerManager [MFC], OnPaneDividerMove", "CPaneContainerManager [MFC], OnShowPane", "CPaneContainerManager [MFC], PaneFromPoint", "CPaneContainerManager [MFC], ReleaseEmptyPaneContainers", "CPaneContainerManager [MFC], RemoveAllPanesAndPaneDividers", "CPaneContainerManager [MFC], RemoveNonValidPanes", "CPaneContainerManager [MFC], RemovePaneDivider", "CPaneContainerManager [MFC], RemovePaneFromPaneContainer", "CPaneContainerManager [MFC], ReplacePane", "CPaneContainerManager [MFC], ResizePaneContainers", "CPaneContainerManager [MFC], Serialize", "CPaneContainerManager [MFC], SetDefaultPaneDividerForPanes", "CPaneContainerManager [MFC], SetPaneContainerRTC", "CPaneContainerManager [MFC], SetResizeMode", "CPaneContainerManager [MFC], StoreRecentDockSiteInfo"] -ms.assetid: 3d974c15-a62f-4648-bb5b-cc31ab7950af --- # CPaneContainerManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CPaneContainerManager` class manages the storage and display of the current docking layout. For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/cpanedialog-class.md b/docs/mfc/reference/cpanedialog-class.md index 71d8ba02273..43078a07946 100644 --- a/docs/mfc/reference/cpanedialog-class.md +++ b/docs/mfc/reference/cpanedialog-class.md @@ -4,10 +4,12 @@ title: "CPaneDialog Class" ms.date: "11/04/2016" f1_keywords: ["CPaneDialog", "AFXPANEDIALOG/CPaneDialog", "AFXPANEDIALOG/CPaneDialog::Create", "AFXPANEDIALOG/CPaneDialog::HandleInitDialog", "AFXPANEDIALOG/CPaneDialog::SetOccDialogInfo"] helpviewer_keywords: ["CPaneDialog [MFC], Create", "CPaneDialog [MFC], HandleInitDialog", "CPaneDialog [MFC], SetOccDialogInfo"] -ms.assetid: 48a6bb91-4b92-40f5-8907-b3270b146cf6 --- # CPaneDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CPaneDialog` class supports a modeless, dockable dialog box. ## Syntax diff --git a/docs/mfc/reference/cpanedivider-class.md b/docs/mfc/reference/cpanedivider-class.md index 23ca314fbe4..49f3d48bc3d 100644 --- a/docs/mfc/reference/cpanedivider-class.md +++ b/docs/mfc/reference/cpanedivider-class.md @@ -4,10 +4,12 @@ title: "CPaneDivider Class" ms.date: "11/04/2016" f1_keywords: ["CPaneDivider", "AFXPANEDIVIDER/CPaneDivider", "AFXPANEDIVIDER/CPaneDivider::CPaneDivider", "AFXPANEDIVIDER/CPaneDivider::AddPaneContainer", "AFXPANEDIVIDER/CPaneDivider::AddPane", "AFXPANEDIVIDER/CPaneDivider::AddRecentPane", "AFXPANEDIVIDER/CPaneDivider::CalcExpectedDockedRect", "AFXPANEDIVIDER/CPaneDivider::CalcFixedLayout", "AFXPANEDIVIDER/CPaneDivider::CheckVisibility", "AFXPANEDIVIDER/CPaneDivider::CreateEx", "AFXPANEDIVIDER/CPaneDivider::DoesAllowDynInsertBefore", "AFXPANEDIVIDER/CPaneDivider::DoesContainFloatingPane", "AFXPANEDIVIDER/CPaneDivider::FindPaneContainer", "AFXPANEDIVIDER/CPaneDivider::FindTabbedPane", "AFXPANEDIVIDER/CPaneDivider::GetDefaultWidth", "AFXPANEDIVIDER/CPaneDivider::GetFirstPane", "AFXPANEDIVIDER/CPaneDivider::GetPaneDividerStyle", "AFXPANEDIVIDER/CPaneDivider::GetRootContainerRect", "AFXPANEDIVIDER/CPaneDivider::GetWidth", "AFXPANEDIVIDER/CPaneDivider::Init", "AFXPANEDIVIDER/CPaneDivider::InsertPane", "AFXPANEDIVIDER/CPaneDivider::IsAutoHideMode", "AFXPANEDIVIDER/CPaneDivider::IsDefault", "AFXPANEDIVIDER/CPaneDivider::IsHorizontal", "AFXPANEDIVIDER/CPaneDivider::Move", "AFXPANEDIVIDER/CPaneDivider::NotifyAboutRelease", "AFXPANEDIVIDER/CPaneDivider::OnShowPane", "AFXPANEDIVIDER/CPaneDivider::ReleaseEmptyPaneContainers", "AFXPANEDIVIDER/CPaneDivider::RemovePane", "AFXPANEDIVIDER/CPaneDivider::ReplacePane", "AFXPANEDIVIDER/CPaneDivider::RepositionPanes", "AFXPANEDIVIDER/CPaneDivider::Serialize", "AFXPANEDIVIDER/CPaneDivider::SetAutoHideMode", "AFXPANEDIVIDER/CPaneDivider::SetPaneContainerManager", "AFXPANEDIVIDER/CPaneDivider::ShowWindow", "AFXPANEDIVIDER/CPaneDivider::StoreRecentDockSiteInfo", "AFXPANEDIVIDER/CPaneDivider::StoreRecentTabRelatedInfo", "AFXPANEDIVIDER/CPaneDivider::GetPanes", "AFXPANEDIVIDER/CPaneDivider::GetPaneDividers", "AFXPANEDIVIDER/CPaneDivider::m_nDefaultWidth", "AFXPANEDIVIDER/CPaneDivider::m_pSliderRTC"] helpviewer_keywords: ["CPaneDivider [MFC], CPaneDivider", "CPaneDivider [MFC], AddPaneContainer", "CPaneDivider [MFC], AddPane", "CPaneDivider [MFC], AddRecentPane", "CPaneDivider [MFC], CalcExpectedDockedRect", "CPaneDivider [MFC], CalcFixedLayout", "CPaneDivider [MFC], CheckVisibility", "CPaneDivider [MFC], CreateEx", "CPaneDivider [MFC], DoesAllowDynInsertBefore", "CPaneDivider [MFC], DoesContainFloatingPane", "CPaneDivider [MFC], FindPaneContainer", "CPaneDivider [MFC], FindTabbedPane", "CPaneDivider [MFC], GetDefaultWidth", "CPaneDivider [MFC], GetFirstPane", "CPaneDivider [MFC], GetPaneDividerStyle", "CPaneDivider [MFC], GetRootContainerRect", "CPaneDivider [MFC], GetWidth", "CPaneDivider [MFC], Init", "CPaneDivider [MFC], InsertPane", "CPaneDivider [MFC], IsAutoHideMode", "CPaneDivider [MFC], IsDefault", "CPaneDivider [MFC], IsHorizontal", "CPaneDivider [MFC], Move", "CPaneDivider [MFC], NotifyAboutRelease", "CPaneDivider [MFC], OnShowPane", "CPaneDivider [MFC], ReleaseEmptyPaneContainers", "CPaneDivider [MFC], RemovePane", "CPaneDivider [MFC], ReplacePane", "CPaneDivider [MFC], RepositionPanes", "CPaneDivider [MFC], Serialize", "CPaneDivider [MFC], SetAutoHideMode", "CPaneDivider [MFC], SetPaneContainerManager", "CPaneDivider [MFC], ShowWindow", "CPaneDivider [MFC], StoreRecentDockSiteInfo", "CPaneDivider [MFC], StoreRecentTabRelatedInfo", "CPaneDivider [MFC], GetPanes", "CPaneDivider [MFC], GetPaneDividers", "CPaneDivider [MFC], m_nDefaultWidth", "CPaneDivider [MFC], m_pSliderRTC"] -ms.assetid: 8e828a5d-232f-4127-b8e3-7fa45a7a476e --- # CPaneDivider Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. The `CPaneDivider` class divides two panes, divides two groups of panes, or separates a group of panes from the client area of the main frame window. diff --git a/docs/mfc/reference/cpaneframewnd-class.md b/docs/mfc/reference/cpaneframewnd-class.md index 3c281c3f41c..5c73ad4d607 100644 --- a/docs/mfc/reference/cpaneframewnd-class.md +++ b/docs/mfc/reference/cpaneframewnd-class.md @@ -4,10 +4,12 @@ title: "CPaneFrameWnd Class" ms.date: "11/04/2016" f1_keywords: ["CPaneFrameWnd", "AFXPANEFRAMEWND/CPaneFrameWnd", "AFXPANEFRAMEWND/CPaneFrameWnd::AddPane", "AFXPANEFRAMEWND/CPaneFrameWnd::AddRemovePaneFromGlobalList", "AFXPANEFRAMEWND/CPaneFrameWnd::AdjustLayout", "AFXPANEFRAMEWND/CPaneFrameWnd::AdjustPaneFrames", "AFXPANEFRAMEWND/CPaneFrameWnd::CalcBorderSize", "AFXPANEFRAMEWND/CPaneFrameWnd::CalcExpectedDockedRect", "AFXPANEFRAMEWND/CPaneFrameWnd::CanBeAttached", "AFXPANEFRAMEWND/CPaneFrameWnd::CanBeDockedToPane", "AFXPANEFRAMEWND/CPaneFrameWnd::CheckGripperVisibility", "AFXPANEFRAMEWND/CPaneFrameWnd::ConvertToTabbedDocument", "AFXPANEFRAMEWND/CPaneFrameWnd::Create", "AFXPANEFRAMEWND/CPaneFrameWnd::CreateEx", "AFXPANEFRAMEWND/CPaneFrameWnd::DockPane", "AFXPANEFRAMEWND/CPaneFrameWnd::FindFloatingPaneByID", "AFXPANEFRAMEWND/CPaneFrameWnd::FrameFromPoint", "AFXPANEFRAMEWND/CPaneFrameWnd::GetCaptionHeight", "AFXPANEFRAMEWND/CPaneFrameWnd::GetCaptionRect", "AFXPANEFRAMEWND/CPaneFrameWnd::GetCaptionText", "AFXPANEFRAMEWND/CPaneFrameWnd::GetDockingManager", "AFXPANEFRAMEWND/CPaneFrameWnd::GetDockingMode", "AFXPANEFRAMEWND/CPaneFrameWnd::GetFirstVisiblePane", "AFXPANEFRAMEWND/CPaneFrameWnd::GetHotPoint", "AFXPANEFRAMEWND/CPaneFrameWnd::GetPane", "AFXPANEFRAMEWND/CPaneFrameWnd::GetPaneCount", "AFXPANEFRAMEWND/CPaneFrameWnd::GetParent", "AFXPANEFRAMEWND/CPaneFrameWnd::GetPinState", "AFXPANEFRAMEWND/CPaneFrameWnd::GetRecentFloatingRect", "AFXPANEFRAMEWND/CPaneFrameWnd::GetVisiblePaneCount", "AFXPANEFRAMEWND/CPaneFrameWnd::HitTest", "AFXPANEFRAMEWND/CPaneFrameWnd::IsCaptured", "AFXPANEFRAMEWND/CPaneFrameWnd::IsDelayShow", "AFXPANEFRAMEWND/CPaneFrameWnd::IsRollDown", "AFXPANEFRAMEWND/CPaneFrameWnd::IsRollUp", "AFXPANEFRAMEWND/CPaneFrameWnd::KillDockingTimer", "AFXPANEFRAMEWND/CPaneFrameWnd::LoadState", "AFXPANEFRAMEWND/CPaneFrameWnd::OnBeforeDock", "AFXPANEFRAMEWND/CPaneFrameWnd::OnDockToRecentPos", "AFXPANEFRAMEWND/CPaneFrameWnd::OnKillRollUpTimer", "AFXPANEFRAMEWND/CPaneFrameWnd::OnMovePane", "AFXPANEFRAMEWND/CPaneFrameWnd::OnPaneRecalcLayout", "AFXPANEFRAMEWND/CPaneFrameWnd::OnSetRollUpTimer", "AFXPANEFRAMEWND/CPaneFrameWnd::OnShowPane", "AFXPANEFRAMEWND/CPaneFrameWnd::PaneFromPoint", "AFXPANEFRAMEWND/CPaneFrameWnd::Pin", "AFXPANEFRAMEWND/CPaneFrameWnd::RedrawAll", "AFXPANEFRAMEWND/CPaneFrameWnd::RemoveNonValidPanes", "AFXPANEFRAMEWND/CPaneFrameWnd::RemovePane", "AFXPANEFRAMEWND/CPaneFrameWnd::ReplacePane", "AFXPANEFRAMEWND/CPaneFrameWnd::SaveState", "AFXPANEFRAMEWND/CPaneFrameWnd::SetCaptionButtons", "AFXPANEFRAMEWND/CPaneFrameWnd::SetDelayShow", "AFXPANEFRAMEWND/CPaneFrameWnd::SetDockingManager", "AFXPANEFRAMEWND/CPaneFrameWnd::SetDockingTimer", "AFXPANEFRAMEWND/CPaneFrameWnd::SetDockState", "AFXPANEFRAMEWND/CPaneFrameWnd::SetHotPoint", "AFXPANEFRAMEWND/CPaneFrameWnd::SetPreDockState", "AFXPANEFRAMEWND/CPaneFrameWnd::SizeToContent", "AFXPANEFRAMEWND/CPaneFrameWnd::StartTearOff", "AFXPANEFRAMEWND/CPaneFrameWnd::StoreRecentDockSiteInfo", "AFXPANEFRAMEWND/CPaneFrameWnd::StoreRecentTabRelatedInfo", "AFXPANEFRAMEWND/CPaneFrameWnd::OnCheckRollState", "AFXPANEFRAMEWND/CPaneFrameWnd::OnDrawBorder", "AFXPANEFRAMEWND/CPaneFrameWnd::m_bUseSaveBits"] helpviewer_keywords: ["CPaneFrameWnd [MFC], AddPane", "CPaneFrameWnd [MFC], AddRemovePaneFromGlobalList", "CPaneFrameWnd [MFC], AdjustLayout", "CPaneFrameWnd [MFC], AdjustPaneFrames", "CPaneFrameWnd [MFC], CalcBorderSize", "CPaneFrameWnd [MFC], CalcExpectedDockedRect", "CPaneFrameWnd [MFC], CanBeAttached", "CPaneFrameWnd [MFC], CanBeDockedToPane", "CPaneFrameWnd [MFC], CheckGripperVisibility", "CPaneFrameWnd [MFC], ConvertToTabbedDocument", "CPaneFrameWnd [MFC], Create", "CPaneFrameWnd [MFC], CreateEx", "CPaneFrameWnd [MFC], DockPane", "CPaneFrameWnd [MFC], FindFloatingPaneByID", "CPaneFrameWnd [MFC], FrameFromPoint", "CPaneFrameWnd [MFC], GetCaptionHeight", "CPaneFrameWnd [MFC], GetCaptionRect", "CPaneFrameWnd [MFC], GetCaptionText", "CPaneFrameWnd [MFC], GetDockingManager", "CPaneFrameWnd [MFC], GetDockingMode", "CPaneFrameWnd [MFC], GetFirstVisiblePane", "CPaneFrameWnd [MFC], GetHotPoint", "CPaneFrameWnd [MFC], GetPane", "CPaneFrameWnd [MFC], GetPaneCount", "CPaneFrameWnd [MFC], GetParent", "CPaneFrameWnd [MFC], GetPinState", "CPaneFrameWnd [MFC], GetRecentFloatingRect", "CPaneFrameWnd [MFC], GetVisiblePaneCount", "CPaneFrameWnd [MFC], HitTest", "CPaneFrameWnd [MFC], IsCaptured", "CPaneFrameWnd [MFC], IsDelayShow", "CPaneFrameWnd [MFC], IsRollDown", "CPaneFrameWnd [MFC], IsRollUp", "CPaneFrameWnd [MFC], KillDockingTimer", "CPaneFrameWnd [MFC], LoadState", "CPaneFrameWnd [MFC], OnBeforeDock", "CPaneFrameWnd [MFC], OnDockToRecentPos", "CPaneFrameWnd [MFC], OnKillRollUpTimer", "CPaneFrameWnd [MFC], OnMovePane", "CPaneFrameWnd [MFC], OnPaneRecalcLayout", "CPaneFrameWnd [MFC], OnSetRollUpTimer", "CPaneFrameWnd [MFC], OnShowPane", "CPaneFrameWnd [MFC], PaneFromPoint", "CPaneFrameWnd [MFC], Pin", "CPaneFrameWnd [MFC], RedrawAll", "CPaneFrameWnd [MFC], RemoveNonValidPanes", "CPaneFrameWnd [MFC], RemovePane", "CPaneFrameWnd [MFC], ReplacePane", "CPaneFrameWnd [MFC], SaveState", "CPaneFrameWnd [MFC], SetCaptionButtons", "CPaneFrameWnd [MFC], SetDelayShow", "CPaneFrameWnd [MFC], SetDockingManager", "CPaneFrameWnd [MFC], SetDockingTimer", "CPaneFrameWnd [MFC], SetDockState", "CPaneFrameWnd [MFC], SetHotPoint", "CPaneFrameWnd [MFC], SetPreDockState", "CPaneFrameWnd [MFC], SizeToContent", "CPaneFrameWnd [MFC], StartTearOff", "CPaneFrameWnd [MFC], StoreRecentDockSiteInfo", "CPaneFrameWnd [MFC], StoreRecentTabRelatedInfo", "CPaneFrameWnd [MFC], OnCheckRollState", "CPaneFrameWnd [MFC], OnDrawBorder", "CPaneFrameWnd [MFC], m_bUseSaveBits"] -ms.assetid: ea3423a3-2763-482e-b763-817036ded10d --- # CPaneFrameWnd Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. Implements a mini-frame window that contains one pane. The pane fills the client area of the window. diff --git a/docs/mfc/reference/cparabolictransitionfromacceleration-class.md b/docs/mfc/reference/cparabolictransitionfromacceleration-class.md index ec6569ac474..669010b4e3d 100644 --- a/docs/mfc/reference/cparabolictransitionfromacceleration-class.md +++ b/docs/mfc/reference/cparabolictransitionfromacceleration-class.md @@ -4,10 +4,12 @@ title: "CParabolicTransitionFromAcceleration Class" ms.date: "11/04/2016" f1_keywords: ["CParabolicTransitionFromAcceleration", "AFXANIMATIONCONTROLLER/CParabolicTransitionFromAcceleration", "AFXANIMATIONCONTROLLER/CParabolicTransitionFromAcceleration::CParabolicTransitionFromAcceleration", "AFXANIMATIONCONTROLLER/CParabolicTransitionFromAcceleration::Create", "AFXANIMATIONCONTROLLER/CParabolicTransitionFromAcceleration::m_dblAcceleration", "AFXANIMATIONCONTROLLER/CParabolicTransitionFromAcceleration::m_dblFinalValue", "AFXANIMATIONCONTROLLER/CParabolicTransitionFromAcceleration::m_dblFinalVelocity"] helpviewer_keywords: ["CParabolicTransitionFromAcceleration [MFC], CParabolicTransitionFromAcceleration", "CParabolicTransitionFromAcceleration [MFC], Create", "CParabolicTransitionFromAcceleration [MFC], m_dblAcceleration", "CParabolicTransitionFromAcceleration [MFC], m_dblFinalValue", "CParabolicTransitionFromAcceleration [MFC], m_dblFinalVelocity"] -ms.assetid: 1e59b86f-358b-4da0-a4fd-8eaf5e85e00f --- # CParabolicTransitionFromAcceleration Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a parabolic-acceleration transition. ## Syntax diff --git a/docs/mfc/reference/cpen-class.md b/docs/mfc/reference/cpen-class.md index c891d6bff1f..3dfc6ed53ac 100644 --- a/docs/mfc/reference/cpen-class.md +++ b/docs/mfc/reference/cpen-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CPen [MFC], CPen", "CPen [MFC], CreatePen", "CPen [MFC], --- # `CPen` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a Windows graphics device interface (GDI) pen. ## Syntax diff --git a/docs/mfc/reference/cpictureholder-class.md b/docs/mfc/reference/cpictureholder-class.md index 27354c1940f..98e8a242e74 100644 --- a/docs/mfc/reference/cpictureholder-class.md +++ b/docs/mfc/reference/cpictureholder-class.md @@ -4,10 +4,12 @@ title: "CPictureHolder Class" ms.date: "11/04/2016" f1_keywords: ["CPictureHolder", "AFXCTL/CPictureHolder", "AFXCTL/CPictureHolder::CPictureHolder", "AFXCTL/CPictureHolder::CreateEmpty", "AFXCTL/CPictureHolder::CreateFromBitmap", "AFXCTL/CPictureHolder::CreateFromIcon", "AFXCTL/CPictureHolder::CreateFromMetafile", "AFXCTL/CPictureHolder::GetDisplayString", "AFXCTL/CPictureHolder::GetPictureDispatch", "AFXCTL/CPictureHolder::GetType", "AFXCTL/CPictureHolder::Render", "AFXCTL/CPictureHolder::SetPictureDispatch", "AFXCTL/CPictureHolder::m_pPict"] helpviewer_keywords: ["CPictureHolder [MFC], CPictureHolder", "CPictureHolder [MFC], CreateEmpty", "CPictureHolder [MFC], CreateFromBitmap", "CPictureHolder [MFC], CreateFromIcon", "CPictureHolder [MFC], CreateFromMetafile", "CPictureHolder [MFC], GetDisplayString", "CPictureHolder [MFC], GetPictureDispatch", "CPictureHolder [MFC], GetType", "CPictureHolder [MFC], Render", "CPictureHolder [MFC], SetPictureDispatch", "CPictureHolder [MFC], m_pPict"] -ms.assetid: a4f59775-704a-41dd-b5bd-2e531c95127a --- # CPictureHolder Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements a Picture property, which allows the user to display a picture in your control. ## Syntax diff --git a/docs/mfc/reference/cprintdialog-class.md b/docs/mfc/reference/cprintdialog-class.md index d4c03521ce6..093f0f5844a 100644 --- a/docs/mfc/reference/cprintdialog-class.md +++ b/docs/mfc/reference/cprintdialog-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CPrintDialog [MFC], CPrintDialog", "CPrintDialog [MFC], C --- # `CPrintDialog` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the services provided by the Windows common dialog box for printing. ## Syntax diff --git a/docs/mfc/reference/cprintdialogex-class.md b/docs/mfc/reference/cprintdialogex-class.md index 1a6cb91c882..dced4c2fffb 100644 --- a/docs/mfc/reference/cprintdialogex-class.md +++ b/docs/mfc/reference/cprintdialogex-class.md @@ -4,10 +4,12 @@ title: "CPrintDialogEx Class" ms.date: "11/04/2016" f1_keywords: ["CPrintDialogEx", "AFXDLGS/CPrintDialogEx", "AFXDLGS/CPrintDialogEx::CPrintDialogEx", "AFXDLGS/CPrintDialogEx::CreatePrinterDC", "AFXDLGS/CPrintDialogEx::DoModal", "AFXDLGS/CPrintDialogEx::GetCopies", "AFXDLGS/CPrintDialogEx::GetDefaults", "AFXDLGS/CPrintDialogEx::GetDeviceName", "AFXDLGS/CPrintDialogEx::GetDevMode", "AFXDLGS/CPrintDialogEx::GetDriverName", "AFXDLGS/CPrintDialogEx::GetPortName", "AFXDLGS/CPrintDialogEx::GetPrinterDC", "AFXDLGS/CPrintDialogEx::PrintAll", "AFXDLGS/CPrintDialogEx::PrintCollate", "AFXDLGS/CPrintDialogEx::PrintCurrentPage", "AFXDLGS/CPrintDialogEx::PrintRange", "AFXDLGS/CPrintDialogEx::PrintSelection", "AFXDLGS/CPrintDialogEx::m_pdex"] helpviewer_keywords: ["CPrintDialogEx [MFC], CPrintDialogEx", "CPrintDialogEx [MFC], CreatePrinterDC", "CPrintDialogEx [MFC], DoModal", "CPrintDialogEx [MFC], GetCopies", "CPrintDialogEx [MFC], GetDefaults", "CPrintDialogEx [MFC], GetDeviceName", "CPrintDialogEx [MFC], GetDevMode", "CPrintDialogEx [MFC], GetDriverName", "CPrintDialogEx [MFC], GetPortName", "CPrintDialogEx [MFC], GetPrinterDC", "CPrintDialogEx [MFC], PrintAll", "CPrintDialogEx [MFC], PrintCollate", "CPrintDialogEx [MFC], PrintCurrentPage", "CPrintDialogEx [MFC], PrintRange", "CPrintDialogEx [MFC], PrintSelection", "CPrintDialogEx [MFC], m_pdex"] -ms.assetid: 1d506703-ee1c-44cc-b4ce-4e778fec26b8 --- # CPrintDialogEx Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the services provided by the Windows Print property sheet. ## Syntax diff --git a/docs/mfc/reference/cprintinfo-structure.md b/docs/mfc/reference/cprintinfo-structure.md index 45508f935e3..988a7d8cb56 100644 --- a/docs/mfc/reference/cprintinfo-structure.md +++ b/docs/mfc/reference/cprintinfo-structure.md @@ -4,10 +4,12 @@ title: "CPrintInfo Structure" ms.date: "11/04/2016" f1_keywords: ["CPrintInfo"] helpviewer_keywords: ["CPrintInfo structure [MFC]"] -ms.assetid: 0b3de849-d050-4386-9a14-f4c1a25684f7 --- # CPrintInfo Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Stores information about a print or print-preview job. ## Syntax diff --git a/docs/mfc/reference/cprogressctrl-class.md b/docs/mfc/reference/cprogressctrl-class.md index d6eaee52925..7ae4d353fc7 100644 --- a/docs/mfc/reference/cprogressctrl-class.md +++ b/docs/mfc/reference/cprogressctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CProgressCtrl [MFC], CProgressCtrl", "CProgressCtrl [MFC] --- # `CProgressCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common progress bar control. ## Syntax diff --git a/docs/mfc/reference/cpropertypage-class.md b/docs/mfc/reference/cpropertypage-class.md index cfddd645dea..178080adc1f 100644 --- a/docs/mfc/reference/cpropertypage-class.md +++ b/docs/mfc/reference/cpropertypage-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CPropertyPage [MFC], CPropertyPage", "CPropertyPage [MFC] --- # `CPropertyPage` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents individual pages of a property sheet, otherwise known as a tab dialog box. ## Syntax diff --git a/docs/mfc/reference/cpropertysheet-class.md b/docs/mfc/reference/cpropertysheet-class.md index 000ec9eb63c..e383f0c4105 100644 --- a/docs/mfc/reference/cpropertysheet-class.md +++ b/docs/mfc/reference/cpropertysheet-class.md @@ -4,10 +4,12 @@ title: "CPropertySheet Class" ms.date: "11/04/2016" f1_keywords: ["CPropertySheet", "AFXDLGS/CPropertySheet", "AFXDLGS/CPropertySheet::CPropertySheet", "AFXDLGS/CPropertySheet::AddPage", "AFXDLGS/CPropertySheet::Construct", "AFXDLGS/CPropertySheet::Create", "AFXDLGS/CPropertySheet::DoModal", "AFXDLGS/CPropertySheet::EnableStackedTabs", "AFXDLGS/CPropertySheet::EndDialog", "AFXDLGS/CPropertySheet::GetActiveIndex", "AFXDLGS/CPropertySheet::GetActivePage", "AFXDLGS/CPropertySheet::GetPage", "AFXDLGS/CPropertySheet::GetPageCount", "AFXDLGS/CPropertySheet::GetPageIndex", "AFXDLGS/CPropertySheet::GetTabControl", "AFXDLGS/CPropertySheet::MapDialogRect", "AFXDLGS/CPropertySheet::OnInitDialog", "AFXDLGS/CPropertySheet::PressButton", "AFXDLGS/CPropertySheet::RemovePage", "AFXDLGS/CPropertySheet::SetActivePage", "AFXDLGS/CPropertySheet::SetFinishText", "AFXDLGS/CPropertySheet::SetTitle", "AFXDLGS/CPropertySheet::SetWizardButtons", "AFXDLGS/CPropertySheet::SetWizardMode", "AFXDLGS/CPropertySheet::m_psh"] helpviewer_keywords: ["CPropertySheet [MFC], CPropertySheet", "CPropertySheet [MFC], AddPage", "CPropertySheet [MFC], Construct", "CPropertySheet [MFC], Create", "CPropertySheet [MFC], DoModal", "CPropertySheet [MFC], EnableStackedTabs", "CPropertySheet [MFC], EndDialog", "CPropertySheet [MFC], GetActiveIndex", "CPropertySheet [MFC], GetActivePage", "CPropertySheet [MFC], GetPage", "CPropertySheet [MFC], GetPageCount", "CPropertySheet [MFC], GetPageIndex", "CPropertySheet [MFC], GetTabControl", "CPropertySheet [MFC], MapDialogRect", "CPropertySheet [MFC], OnInitDialog", "CPropertySheet [MFC], PressButton", "CPropertySheet [MFC], RemovePage", "CPropertySheet [MFC], SetActivePage", "CPropertySheet [MFC], SetFinishText", "CPropertySheet [MFC], SetTitle", "CPropertySheet [MFC], SetWizardButtons", "CPropertySheet [MFC], SetWizardMode", "CPropertySheet [MFC], m_psh"] -ms.assetid: 8461ccff-d14f-46e0-a746-42ad642ef94e --- # `CPropertySheet` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents property sheets, also known as tab dialog boxes. ## Syntax diff --git a/docs/mfc/reference/cpropexchange-class.md b/docs/mfc/reference/cpropexchange-class.md index 4292d4b07dd..6af0cb17262 100644 --- a/docs/mfc/reference/cpropexchange-class.md +++ b/docs/mfc/reference/cpropexchange-class.md @@ -4,10 +4,12 @@ title: "CPropExchange Class" ms.date: "11/04/2016" f1_keywords: ["CPropExchange", "AFXCTL/CPropExchange", "AFXCTL/CPropExchange::ExchangeBlobProp", "AFXCTL/CPropExchange::ExchangeFontProp", "AFXCTL/CPropExchange::ExchangePersistentProp", "AFXCTL/CPropExchange::ExchangeProp", "AFXCTL/CPropExchange::ExchangeVersion", "AFXCTL/CPropExchange::GetVersion", "AFXCTL/CPropExchange::IsAsynchronous", "AFXCTL/CPropExchange::IsLoading"] helpviewer_keywords: ["CPropExchange [MFC], ExchangeBlobProp", "CPropExchange [MFC], ExchangeFontProp", "CPropExchange [MFC], ExchangePersistentProp", "CPropExchange [MFC], ExchangeProp", "CPropExchange [MFC], ExchangeVersion", "CPropExchange [MFC], GetVersion", "CPropExchange [MFC], IsAsynchronous", "CPropExchange [MFC], IsLoading"] -ms.assetid: ed872180-e770-4942-892a-92139d501fab --- # CPropExchange Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports the implementation of persistence for your OLE controls. ## Syntax diff --git a/docs/mfc/reference/cptrarray-class.md b/docs/mfc/reference/cptrarray-class.md index 74865d07bc0..d96c8b72602 100644 --- a/docs/mfc/reference/cptrarray-class.md +++ b/docs/mfc/reference/cptrarray-class.md @@ -4,10 +4,12 @@ title: "CPtrArray Class" ms.date: "11/04/2016" f1_keywords: ["CPtrArray", "AFXCOLL/CPtrArray", "AFXCOLL/CPtrArray::CPtrArray", "AFXCOLL/CPtrArray::Add", "AFXCOLL/CPtrArray::Append", "AFXCOLL/CPtrArray::Copy", "AFXCOLL/CPtrArray::ElementAt", "AFXCOLL/CPtrArray::FreeExtra", "AFXCOLL/CPtrArray::GetAt", "AFXCOLL/CPtrArray::GetCount", "AFXCOLL/CPtrArray::GetData", "AFXCOLL/CPtrArray::GetSize", "AFXCOLL/CPtrArray::GetUpperBound", "AFXCOLL/CPtrArray::InsertAt", "AFXCOLL/CPtrArray::IsEmpty", "AFXCOLL/CPtrArray::RemoveAll", "AFXCOLL/CPtrArray::RemoveAt", "AFXCOLL/CPtrArray::SetAt", "AFXCOLL/CPtrArray::SetAtGrow", "AFXCOLL/CPtrArray::SetSize"] helpviewer_keywords: ["CPtrArray [MFC], CPtrArray", "CPtrArray [MFC], Add", "CPtrArray [MFC], Append", "CPtrArray [MFC], Copy", "CPtrArray [MFC], ElementAt", "CPtrArray [MFC], FreeExtra", "CPtrArray [MFC], GetAt", "CPtrArray [MFC], GetCount", "CPtrArray [MFC], GetData", "CPtrArray [MFC], GetSize", "CPtrArray [MFC], GetUpperBound", "CPtrArray [MFC], InsertAt", "CPtrArray [MFC], IsEmpty", "CPtrArray [MFC], RemoveAll", "CPtrArray [MFC], RemoveAt", "CPtrArray [MFC], SetAt", "CPtrArray [MFC], SetAtGrow", "CPtrArray [MFC], SetSize"] -ms.assetid: c23b87a3-bf84-49d6-a66b-61e999d0938a --- # CPtrArray Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports arrays of void pointers. ## Syntax diff --git a/docs/mfc/reference/cptrlist-class.md b/docs/mfc/reference/cptrlist-class.md index 452efb1d46e..46437ca882e 100644 --- a/docs/mfc/reference/cptrlist-class.md +++ b/docs/mfc/reference/cptrlist-class.md @@ -4,10 +4,12 @@ title: "CPtrList Class" ms.date: "11/04/2016" f1_keywords: ["CPtrList"] helpviewer_keywords: ["lists, generic", "CPtrList class [MFC]", "generic lists"] -ms.assetid: 4139a09c-4338-4f42-9eea-51336120b43c --- # CPtrList Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports lists of void pointers. ## Syntax diff --git a/docs/mfc/reference/creating-a-file-explorer-style-mfc-application.md b/docs/mfc/reference/creating-a-file-explorer-style-mfc-application.md index 896201ac5fc..14dba910556 100644 --- a/docs/mfc/reference/creating-a-file-explorer-style-mfc-application.md +++ b/docs/mfc/reference/creating-a-file-explorer-style-mfc-application.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["browsers [MFC], Explorer-style applications", "MFC applic --- # Creating a File Explorer-Style MFC Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Many Windows system applications use the user interface (UI) for File Explorer. When you start File Explorer, for example, you see an application with a vertical splitter bar dividing the client area. The left side of the client area provides navigation and browsing features, and the right side of the client area shows details pertinent to the selection in the left pane. When a user clicks an item in the left pane, the application repopulates the right pane. In an MDI application, you can use commands on the **View** menu to change the amount of detail shown in the right pane. (In an SDI or multiple top-level document application, you can change the detail using the toolbar buttons only.) The contents of the panes depend on the application. In a file-system browser, the left pane shows a hierarchical view of directories or machines, or machine groups, while the right pane displays folders, individual files, or machines, and details about them. The contents don't necessarily have to be files. They could be e-mail messages, error reports, or other items in a database. diff --git a/docs/mfc/reference/creating-a-forms-based-mfc-application.md b/docs/mfc/reference/creating-a-forms-based-mfc-application.md index 9ef2409ba6b..0c5b3bef019 100644 --- a/docs/mfc/reference/creating-a-forms-based-mfc-application.md +++ b/docs/mfc/reference/creating-a-forms-based-mfc-application.md @@ -4,10 +4,12 @@ title: "Creating a Forms-Based MFC Application" ms.date: "09/09/2019" f1_keywords: ["vc.appwiz.mfcforms.project"] helpviewer_keywords: ["applications [MFC], forms-based", "forms-based applications [MFC]"] -ms.assetid: 048d2f7d-b60d-4386-ad8e-71d49af9c05e --- # Creating a Forms-Based MFC Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A form is a dialog box with controls that let a user access and possibly change data. You may want to develop an application in which the user selects from a selection of forms. Commonly, a forms-based application lets the user access forms by click **New** from the **File** menu. A dialog-based application, which does not give users access to a **New** option in the **File** menu, is also considered a forms-based application. A single document interface (SDI), forms-based application allows only one instance of a particular form to run at a time. It is possible to run different forms at the same time from an SDI forms-based application by selecting a new form from the **New** option in the **File** menu. @@ -24,7 +26,7 @@ The base class for form-based applications is [`CFormView`](cformview-class.md). Even if you use a base class such as [`CView`](cview-class.md), you can later make your applications forms-based by [adding an MFC class](adding-an-mfc-class.md) derived from `CFormView`. -Once you finish with the wizard, your project opens, and if you selected `CFormView` (or a class that inherits from `CFormView`) as your base class or if you created a dialog-based application, Visual C++ opens the dialog editor. At this point, you are ready to design your first form. +Once you finish with the wizard, your project opens, and if you selected `CFormView` (or a class that inherits from `CFormView`) as your base class or if you created a dialog-based application, Visual Studio opens the dialog editor. At this point, you are ready to design your first form. ### To begin creating a forms-based MFC executable diff --git a/docs/mfc/reference/creating-a-web-browser-style-mfc-application.md b/docs/mfc/reference/creating-a-web-browser-style-mfc-application.md index 06aa373199c..b955619f604 100644 --- a/docs/mfc/reference/creating-a-web-browser-style-mfc-application.md +++ b/docs/mfc/reference/creating-a-web-browser-style-mfc-application.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["MFC, Web applications", "Web browsers, creating from MFC --- # Creating a Web Browser-Style MFC Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A Web browser-style application can access information from the Internet (such as HTML or active documents) or an intranet, as well as folders in the local file system and on a network. By deriving the application's view class from [`CHtmlView`](../../mfc/reference/chtmlview-class.md), effectively you make the application a Web browser by providing the view with the WebBrowser control. ## To create a Web browser application based on the MFC document/view architecture @@ -28,7 +31,7 @@ The WebBrowser control supports Web browsing through hyperlinks and Uniform Reso Because `CHtmlView` simply implements the Microsoft Web browser control, its support for printing isn't like other [`CView`](../../mfc/reference/cview-class.md)-derived classes. Rather, the WebBrowser control implements the printer user interface and printing. As a result, `CHtmlView` doesn't support print preview, and the framework doesn't provide for other printing support functions: for example, [`CView::OnPreparePrinting`](../../mfc/reference/cview-class.md#onprepareprinting), [`CView::OnBeginPrinting`](../../mfc/reference/cview-class.md#onbeginprinting), and [`CView::OnEndPrinting`](../../mfc/reference/cview-class.md#onendprinting), which are available in other MFC applications. -`CHtmlView` acts as a wrapper for the Web browser control, which gives your application a view onto a Web or an HTML page. The wizard creates an override to the [`OnInitialUpdate`](../../mfc/reference/cview-class.md#oninitialupdate) function in the view class, providing a navigational link to the Microsoft Visual C++ Web site: +`CHtmlView` acts as a wrapper for the Web browser control, which gives your application a view onto a Web or an HTML page. The wizard creates an override to the [`OnInitialUpdate`](../../mfc/reference/cview-class.md#oninitialupdate) function in the view class, providing a navigational link to the Visual Studio Web site: ```cpp void CWebView::OnInitialUpdate() diff --git a/docs/mfc/reference/creating-an-mfc-activex-control-container.md b/docs/mfc/reference/creating-an-mfc-activex-control-container.md index bf2998f393f..09e8ca13391 100644 --- a/docs/mfc/reference/creating-an-mfc-activex-control-container.md +++ b/docs/mfc/reference/creating-an-mfc-activex-control-container.md @@ -4,10 +4,12 @@ title: "Creating an MFC ActiveX Control Container" ms.date: "09/12/2018" f1_keywords: ["vc.appwiz.activex.container"] helpviewer_keywords: ["MFC ActiveX controls [MFC], containers", "ActiveX control containers [MFC], creating", "containers [MFC], creating", "OLE controls [MFC], containers"] -ms.assetid: ec70e137-7c14-4940-bd0e-fd4edcc63ea5 --- # Creating an MFC ActiveX Control Container +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An ActiveX control container is a parent program that supplies the environment for an ActiveX (formerly OLE) control to run. You can create an application capable of containing ActiveX controls with or without MFC, but it is much easier to do with MFC. >[!IMPORTANT] diff --git a/docs/mfc/reference/creating-an-mfc-activex-control.md b/docs/mfc/reference/creating-an-mfc-activex-control.md index af40e85640b..699fd44cc35 100644 --- a/docs/mfc/reference/creating-an-mfc-activex-control.md +++ b/docs/mfc/reference/creating-an-mfc-activex-control.md @@ -4,10 +4,12 @@ title: "Creating an MFC ActiveX Control" ms.date: "08/19/2019" f1_keywords: ["vc.appwiz.activex.project"] helpviewer_keywords: ["MFC ActiveX controls [MFC], creating", "ActiveX controls [MFC], creating"] -ms.assetid: 8bd5a93c-d04d-414e-bb28-163fdc1c0dd5 --- # Creating an MFC ActiveX Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + ActiveX control programs are modular programs designed to give a specific type of functionality to a parent application. For example, you can create a control such as a button for use in a dialog, or toolbar for use in a Web page. >[!IMPORTANT] diff --git a/docs/mfc/reference/creating-an-mfc-application.md b/docs/mfc/reference/creating-an-mfc-application.md index 5a981ca05ca..5a7719ffafc 100644 --- a/docs/mfc/reference/creating-an-mfc-application.md +++ b/docs/mfc/reference/creating-an-mfc-application.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["applications [MFC]", "MFC, creating applications", "MFC a --- # Creating an MFC Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An MFC application is an executable application for Windows that is based on the Microsoft Foundation Class (MFC) Library. MFC executables generally fall into five types: standard Windows applications, dialog boxes, forms-based applications, Explorer-style applications, and Web browser-style applications. For more information, see: - [Using the Classes to Write Windows Applications](../../mfc/using-the-classes-to-write-applications-for-windows.md) @@ -56,7 +59,7 @@ The dialog shows the application type, set to Console Application (.exe). Under ## To create an MFC forms or dialog-based application 1. From the Visual Studio main menu, choose **File** > **New** > **Project**. -1. Under the **Installed** templates, choose **Visual C++** > **MFC/ATL**. If you don't see these, use the Visual Studio Installer to add MFC/ATL functionality. You can access the installer from the Visual Studio menu via **Tools** > **Get Tools and Features...** In the installer, select **Individual components** and search for **mfc** and then select the appropriate library for your machine such as **Visual C++ MFC for x86 and x64 with Spectre Mitigations**. +1. Under the **Installed** templates, choose **Visual C++** > **MFC/ATL**. If you don't see these, use the Visual Studio Installer to add MFC/ATL functionality. You can access the installer from the Visual Studio menu via **Tools** > **Get Tools and Features...** In the installer, select **Individual components** and search for **mfc** and then select the appropriate library for your machine such as **C++ MFC for x86 and x64 with Spectre Mitigations**. 1. Choose **MFC App** from the center pane. 1. Modify the configuration values as needed, then press **OK**. diff --git a/docs/mfc/reference/creating-an-mfc-dll-project.md b/docs/mfc/reference/creating-an-mfc-dll-project.md index 783d8204a23..0db9eb054b6 100644 --- a/docs/mfc/reference/creating-an-mfc-dll-project.md +++ b/docs/mfc/reference/creating-an-mfc-dll-project.md @@ -4,10 +4,12 @@ title: "Creating an MFC DLL Project" ms.date: "08/19/2019" f1_keywords: ["vc.appwiz.mfcdll.project"] helpviewer_keywords: ["MFC DLLs [MFC], creating projects", "DLLs [MFC], MFC", "projects [MFC], creating", "DLLs [MFC], creating"] -ms.assetid: 05540b93-4781-4a90-aadf-55158313f5b2 --- # Creating an MFC DLL Project +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An MFC DLL is a binary file that acts as a shared library of functions that can be used simultaneously by multiple applications. The easiest way to create an MFC DLL project is to use the MFC DLL Wizard. > [!NOTE] diff --git a/docs/mfc/reference/crebar-class.md b/docs/mfc/reference/crebar-class.md index 52ee6e4ec94..16cc85e331b 100644 --- a/docs/mfc/reference/crebar-class.md +++ b/docs/mfc/reference/crebar-class.md @@ -4,10 +4,12 @@ title: "CReBar Class" ms.date: "11/19/2018" f1_keywords: ["CReBar", "AFXEXT/CReBar", "AFXEXT/CReBar::AddBar", "AFXEXT/CReBar::Create", "AFXEXT/CReBar::GetReBarCtrl"] helpviewer_keywords: ["CReBar [MFC], AddBar", "CReBar [MFC], Create", "CReBar [MFC], GetReBarCtrl"] -ms.assetid: c1ad2720-1d33-4106-8e4e-80aa84f93559 --- # CReBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A control bar that provides layout, persistence, and state information for rebar controls. ## Syntax diff --git a/docs/mfc/reference/crebarctrl-class.md b/docs/mfc/reference/crebarctrl-class.md index 7d66ed8b7f6..970ef6e7e42 100644 --- a/docs/mfc/reference/crebarctrl-class.md +++ b/docs/mfc/reference/crebarctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CReBarCtrl [MFC], CReBarCtrl", "CReBarCtrl [MFC], BeginDr --- # CReBarCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the functionality of a rebar control, which is a container for a child window. ## Syntax diff --git a/docs/mfc/reference/crecentdocksiteinfo-class.md b/docs/mfc/reference/crecentdocksiteinfo-class.md index 88bf440c502..2c9a20d7337 100644 --- a/docs/mfc/reference/crecentdocksiteinfo-class.md +++ b/docs/mfc/reference/crecentdocksiteinfo-class.md @@ -4,10 +4,12 @@ title: "CRecentDockSiteInfo Class" ms.date: "11/04/2016" f1_keywords: ["CRecentDockSiteInfo", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::CleanUp", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::GetRecentDefaultPaneDivider", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::GetRecentDockedPercent", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::GetRecentDockedRect", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::GetRecentListOfPanes", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::GetRecentPaneContainer", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::GetRecentTabContainer", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::Init", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::IsRecentLeftPane", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::SaveListOfRecentPanes", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::SetInfo", "AFXRECENTDOCKSITEINFO/CRecentDockSiteInfo::StoreDockInfo"] helpviewer_keywords: ["CRecentDockSiteInfo [MFC], CleanUp", "CRecentDockSiteInfo [MFC], GetRecentDefaultPaneDivider", "CRecentDockSiteInfo [MFC], GetRecentDockedPercent", "CRecentDockSiteInfo [MFC], GetRecentDockedRect", "CRecentDockSiteInfo [MFC], GetRecentListOfPanes", "CRecentDockSiteInfo [MFC], GetRecentPaneContainer", "CRecentDockSiteInfo [MFC], GetRecentTabContainer", "CRecentDockSiteInfo [MFC], Init", "CRecentDockSiteInfo [MFC], IsRecentLeftPane", "CRecentDockSiteInfo [MFC], SaveListOfRecentPanes", "CRecentDockSiteInfo [MFC], SetInfo", "CRecentDockSiteInfo [MFC], StoreDockInfo"] -ms.assetid: 2dd14f95-d5a2-4461-a7a5-2c6c36a3a165 --- # CRecentDockSiteInfo Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CRecentDockSiteInfo` class is a helper class that stores recent state information for the [CPane Class](../../mfc/reference/cpane-class.md). ## Syntax diff --git a/docs/mfc/reference/crecentfilelist-class.md b/docs/mfc/reference/crecentfilelist-class.md index d1254290dfa..01ada3f09c3 100644 --- a/docs/mfc/reference/crecentfilelist-class.md +++ b/docs/mfc/reference/crecentfilelist-class.md @@ -4,10 +4,12 @@ title: "CRecentFileList Class" ms.date: "11/04/2016" f1_keywords: ["CRecentFileList", "AFXADV/CRecentFileList", "AFXADV/CRecentFileList::CRecentFileList", "AFXADV/CRecentFileList::Add", "AFXADV/CRecentFileList::GetDisplayName", "AFXADV/CRecentFileList::GetSize", "AFXADV/CRecentFileList::ReadList", "AFXADV/CRecentFileList::Remove", "AFXADV/CRecentFileList::UpdateMenu", "AFXADV/CRecentFileList::WriteList"] helpviewer_keywords: ["CRecentFileList [MFC], CRecentFileList", "CRecentFileList [MFC], Add", "CRecentFileList [MFC], GetDisplayName", "CRecentFileList [MFC], GetSize", "CRecentFileList [MFC], ReadList", "CRecentFileList [MFC], Remove", "CRecentFileList [MFC], UpdateMenu", "CRecentFileList [MFC], WriteList"] -ms.assetid: a77f0524-7584-4582-849a-7e97b76d186e --- # CRecentFileList Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports control of the most recently used (MRU) file list. ## Syntax diff --git a/docs/mfc/reference/crecordset-class.md b/docs/mfc/reference/crecordset-class.md index 40295670721..4e04679a569 100644 --- a/docs/mfc/reference/crecordset-class.md +++ b/docs/mfc/reference/crecordset-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CRecordset [MFC], CRecordset", "CRecordset [MFC], AddNew" --- # `CRecordset` class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a set of records selected from a data source. ## Syntax @@ -1403,7 +1406,7 @@ Accept the default value, `AFX_DB_USE_DEFAULT_TYPE`, or use one of the following - `CRecordset::forwardOnly` A read-only recordset with only forward scrolling. - For `CRecordset`, the default value is `CRecordset::snapshot`. The default-value mechanism allows the Visual C++ wizards to interact with both ODBC `CRecordset` and DAO `CDaoRecordset`, which have different defaults. + For `CRecordset`, the default value is `CRecordset::snapshot`. The default-value mechanism allows the Visual Studio wizards to interact with both ODBC `CRecordset` and DAO `CDaoRecordset`, which have different defaults. For more information about these recordset types, see [Recordset (ODBC)](../../data/odbc/recordset-odbc.md). For related information, see "Using Block and Scrollable Cursors" in the Windows SDK. diff --git a/docs/mfc/reference/crecordview-class.md b/docs/mfc/reference/crecordview-class.md index f4e471911b4..6fd8701e014 100644 --- a/docs/mfc/reference/crecordview-class.md +++ b/docs/mfc/reference/crecordview-class.md @@ -4,10 +4,12 @@ title: "CRecordView Class" ms.date: "11/04/2016" f1_keywords: ["CRecordView", "AFXDB/CRecordView", "AFXDB/CRecordView::CRecordView", "AFXDB/CRecordView::IsOnFirstRecord", "AFXDB/CRecordView::IsOnLastRecord", "AFXDB/CRecordView::OnGetRecordset", "AFXDB/CRecordView::OnMove"] helpviewer_keywords: ["CRecordView [MFC], CRecordView", "CRecordView [MFC], IsOnFirstRecord", "CRecordView [MFC], IsOnLastRecord", "CRecordView [MFC], OnGetRecordset", "CRecordView [MFC], OnMove", "CRecordView [MFC], OnMove"] -ms.assetid: 9b4b0897-bd50-4d48-a0b4-f3323f5ccc55 --- # CRecordView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A view that displays database records in controls. ## Syntax diff --git a/docs/mfc/reference/crecttracker-class.md b/docs/mfc/reference/crecttracker-class.md index 19a028ee9c3..5fe0fff5ac8 100644 --- a/docs/mfc/reference/crecttracker-class.md +++ b/docs/mfc/reference/crecttracker-class.md @@ -4,10 +4,12 @@ title: "CRectTracker Class" ms.date: "11/19/2018" f1_keywords: ["CRectTracker", "AFXEXT/CRectTracker", "AFXEXT/CRectTracker::CRectTracker", "AFXEXT/CRectTracker::AdjustRect", "AFXEXT/CRectTracker::Draw", "AFXEXT/CRectTracker::DrawTrackerRect", "AFXEXT/CRectTracker::GetHandleMask", "AFXEXT/CRectTracker::GetTrueRect", "AFXEXT/CRectTracker::HitTest", "AFXEXT/CRectTracker::NormalizeHit", "AFXEXT/CRectTracker::OnChangedRect", "AFXEXT/CRectTracker::SetCursor", "AFXEXT/CRectTracker::Track", "AFXEXT/CRectTracker::TrackRubberBand", "AFXEXT/CRectTracker::m_nHandleSize", "AFXEXT/CRectTracker::m_nStyle", "AFXEXT/CRectTracker::m_rect", "AFXEXT/CRectTracker::m_sizeMin"] helpviewer_keywords: ["CRectTracker [MFC], CRectTracker", "CRectTracker [MFC], AdjustRect", "CRectTracker [MFC], Draw", "CRectTracker [MFC], DrawTrackerRect", "CRectTracker [MFC], GetHandleMask", "CRectTracker [MFC], GetTrueRect", "CRectTracker [MFC], HitTest", "CRectTracker [MFC], NormalizeHit", "CRectTracker [MFC], OnChangedRect", "CRectTracker [MFC], SetCursor", "CRectTracker [MFC], Track", "CRectTracker [MFC], TrackRubberBand", "CRectTracker [MFC], m_nHandleSize", "CRectTracker [MFC], m_nStyle", "CRectTracker [MFC], m_rect", "CRectTracker [MFC], m_sizeMin"] -ms.assetid: 99caa7f2-3c0d-4a42-bbee-e5d1d342d4ee --- # CRectTracker Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Allows an item to be displayed, moved, and resized in different fashions. ## Syntax diff --git a/docs/mfc/reference/crendertarget-class.md b/docs/mfc/reference/crendertarget-class.md index 3c031ef53a6..c03c1adaece 100644 --- a/docs/mfc/reference/crendertarget-class.md +++ b/docs/mfc/reference/crendertarget-class.md @@ -4,10 +4,12 @@ title: "CRenderTarget Class" ms.date: "03/27/2019" f1_keywords: ["CRenderTarget", "AFXRENDERTARGET/CRenderTarget", "AFXRENDERTARGET/CRenderTarget::CRenderTarget", "AFXRENDERTARGET/CRenderTarget::Attach", "AFXRENDERTARGET/CRenderTarget::BeginDraw", "AFXRENDERTARGET/CRenderTarget::Clear", "AFXRENDERTARGET/CRenderTarget::COLORREF_TO_D2DCOLOR", "AFXRENDERTARGET/CRenderTarget::CreateCompatibleRenderTarget", "AFXRENDERTARGET/CRenderTarget::Destroy", "AFXRENDERTARGET/CRenderTarget::Detach", "AFXRENDERTARGET/CRenderTarget::DrawBitmap", "AFXRENDERTARGET/CRenderTarget::DrawEllipse", "AFXRENDERTARGET/CRenderTarget::DrawGeometry", "AFXRENDERTARGET/CRenderTarget::DrawGlyphRun", "AFXRENDERTARGET/CRenderTarget::DrawLine", "AFXRENDERTARGET/CRenderTarget::DrawRectangle", "AFXRENDERTARGET/CRenderTarget::DrawRoundedRectangle", "AFXRENDERTARGET/CRenderTarget::DrawText", "AFXRENDERTARGET/CRenderTarget::DrawTextLayout", "AFXRENDERTARGET/CRenderTarget::EndDraw", "AFXRENDERTARGET/CRenderTarget::FillEllipse", "AFXRENDERTARGET/CRenderTarget::FillGeometry", "AFXRENDERTARGET/CRenderTarget::FillMesh", "AFXRENDERTARGET/CRenderTarget::FillOpacityMask", "AFXRENDERTARGET/CRenderTarget::FillRectangle", "AFXRENDERTARGET/CRenderTarget::FillRoundedRectangle", "AFXRENDERTARGET/CRenderTarget::Flush", "AFXRENDERTARGET/CRenderTarget::GetAntialiasMode", "AFXRENDERTARGET/CRenderTarget::GetDpi", "AFXRENDERTARGET/CRenderTarget::GetMaximumBitmapSize", "AFXRENDERTARGET/CRenderTarget::GetPixelFormat", "AFXRENDERTARGET/CRenderTarget::GetPixelSize", "AFXRENDERTARGET/CRenderTarget::GetRenderTarget", "AFXRENDERTARGET/CRenderTarget::GetSize", "AFXRENDERTARGET/CRenderTarget::GetTags", "AFXRENDERTARGET/CRenderTarget::GetTextAntialiasMode", "AFXRENDERTARGET/CRenderTarget::GetTextRenderingParams", "AFXRENDERTARGET/CRenderTarget::GetTransform", "AFXRENDERTARGET/CRenderTarget::IsSupported", "AFXRENDERTARGET/CRenderTarget::IsValid", "AFXRENDERTARGET/CRenderTarget::PopAxisAlignedClip", "AFXRENDERTARGET/CRenderTarget::PopLayer", "AFXRENDERTARGET/CRenderTarget::PushAxisAlignedClip", "AFXRENDERTARGET/CRenderTarget::PushLayer", "AFXRENDERTARGET/CRenderTarget::RestoreDrawingState", "AFXRENDERTARGET/CRenderTarget::SaveDrawingState", "AFXRENDERTARGET/CRenderTarget::SetAntialiasMode", "AFXRENDERTARGET/CRenderTarget::SetDpi", "AFXRENDERTARGET/CRenderTarget::SetTags", "AFXRENDERTARGET/CRenderTarget::SetTextAntialiasMode", "AFXRENDERTARGET/CRenderTarget::SetTextRenderingParams", "AFXRENDERTARGET/CRenderTarget::SetTransform", "AFXRENDERTARGET/CRenderTarget::VerifyResource", "AFXRENDERTARGET/CRenderTarget::m_lstResources", "AFXRENDERTARGET/CRenderTarget::m_pRenderTarget", "AFXRENDERTARGET/CRenderTarget::m_pTextFormatDefault"] helpviewer_keywords: ["CRenderTarget [MFC], CRenderTarget", "CRenderTarget [MFC], Attach", "CRenderTarget [MFC], BeginDraw", "CRenderTarget [MFC], Clear", "CRenderTarget [MFC], COLORREF_TO_D2DCOLOR", "CRenderTarget [MFC], CreateCompatibleRenderTarget", "CRenderTarget [MFC], Destroy", "CRenderTarget [MFC], Detach", "CRenderTarget [MFC], DrawBitmap", "CRenderTarget [MFC], DrawEllipse", "CRenderTarget [MFC], DrawGeometry", "CRenderTarget [MFC], DrawGlyphRun", "CRenderTarget [MFC], DrawLine", "CRenderTarget [MFC], DrawRectangle", "CRenderTarget [MFC], DrawRoundedRectangle", "CRenderTarget [MFC], DrawText", "CRenderTarget [MFC], DrawTextLayout", "CRenderTarget [MFC], EndDraw", "CRenderTarget [MFC], FillEllipse", "CRenderTarget [MFC], FillGeometry", "CRenderTarget [MFC], FillMesh", "CRenderTarget [MFC], FillOpacityMask", "CRenderTarget [MFC], FillRectangle", "CRenderTarget [MFC], FillRoundedRectangle", "CRenderTarget [MFC], Flush", "CRenderTarget [MFC], GetAntialiasMode", "CRenderTarget [MFC], GetDpi", "CRenderTarget [MFC], GetMaximumBitmapSize", "CRenderTarget [MFC], GetPixelFormat", "CRenderTarget [MFC], GetPixelSize", "CRenderTarget [MFC], GetRenderTarget", "CRenderTarget [MFC], GetSize", "CRenderTarget [MFC], GetTags", "CRenderTarget [MFC], GetTextAntialiasMode", "CRenderTarget [MFC], GetTextRenderingParams", "CRenderTarget [MFC], GetTransform", "CRenderTarget [MFC], IsSupported", "CRenderTarget [MFC], IsValid", "CRenderTarget [MFC], PopAxisAlignedClip", "CRenderTarget [MFC], PopLayer", "CRenderTarget [MFC], PushAxisAlignedClip", "CRenderTarget [MFC], PushLayer", "CRenderTarget [MFC], RestoreDrawingState", "CRenderTarget [MFC], SaveDrawingState", "CRenderTarget [MFC], SetAntialiasMode", "CRenderTarget [MFC], SetDpi", "CRenderTarget [MFC], SetTags", "CRenderTarget [MFC], SetTextAntialiasMode", "CRenderTarget [MFC], SetTextRenderingParams", "CRenderTarget [MFC], SetTransform", "CRenderTarget [MFC], VerifyResource", "CRenderTarget [MFC], m_lstResources", "CRenderTarget [MFC], m_pRenderTarget", "CRenderTarget [MFC], m_pTextFormatDefault"] -ms.assetid: 30d1607d-68d3-4d14-ac36-fdbd0ef903a1 --- # CRenderTarget Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for ID2D1RenderTarget. ## Syntax diff --git a/docs/mfc/reference/cresourceexception-class.md b/docs/mfc/reference/cresourceexception-class.md index 2fb51f30a9f..7092e28d4cf 100644 --- a/docs/mfc/reference/cresourceexception-class.md +++ b/docs/mfc/reference/cresourceexception-class.md @@ -4,10 +4,12 @@ title: "CResourceException Class" ms.date: "11/04/2016" f1_keywords: ["CResourceException", "AFXWIN/CResourceException", "AFXWIN/CResourceException::CResourceException"] helpviewer_keywords: ["CResourceException [MFC], CResourceException"] -ms.assetid: af6ae043-d124-4bfd-b35e-7bb0db67d289 --- # CResourceException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Generated when Windows cannot find or allocate a requested resource. ## Syntax diff --git a/docs/mfc/reference/creversaltransition-class.md b/docs/mfc/reference/creversaltransition-class.md index ce0eea97765..a5d5fd66648 100644 --- a/docs/mfc/reference/creversaltransition-class.md +++ b/docs/mfc/reference/creversaltransition-class.md @@ -4,10 +4,12 @@ title: "CReversalTransition Class" ms.date: "11/04/2016" f1_keywords: ["CReversalTransition", "AFXANIMATIONCONTROLLER/CReversalTransition", "AFXANIMATIONCONTROLLER/CReversalTransition::CReversalTransition", "AFXANIMATIONCONTROLLER/CReversalTransition::Create", "AFXANIMATIONCONTROLLER/CReversalTransition::m_duration"] helpviewer_keywords: ["CReversalTransition [MFC], CReversalTransition", "CReversalTransition [MFC], Create", "CReversalTransition [MFC], m_duration"] -ms.assetid: e89516be-2d07-4885-95a8-fc278f46e3ad --- # CReversalTransition Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a reversal transition. ## Syntax diff --git a/docs/mfc/reference/crgn-class.md b/docs/mfc/reference/crgn-class.md index 6568c4df1c5..3f188fbc505 100644 --- a/docs/mfc/reference/crgn-class.md +++ b/docs/mfc/reference/crgn-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CRgn [MFC], CRgn", "CRgn [MFC], CombineRgn", "CRgn [MFC], --- # CRgn Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a Windows graphics device interface (GDI) region. ## Syntax diff --git a/docs/mfc/reference/cricheditcntritem-class.md b/docs/mfc/reference/cricheditcntritem-class.md index 54de9aee098..98ad504bdb2 100644 --- a/docs/mfc/reference/cricheditcntritem-class.md +++ b/docs/mfc/reference/cricheditcntritem-class.md @@ -4,10 +4,12 @@ title: "CRichEditCntrItem Class" ms.date: "11/04/2016" f1_keywords: ["CRichEditCntrItem", "AFXRICH/CRichEditCntrItem", "AFXRICH/CRichEditCntrItem::CRichEditCntrItem", "AFXRICH/CRichEditCntrItem::SyncToRichEditObject"] helpviewer_keywords: ["CRichEditCntrItem [MFC], CRichEditCntrItem", "CRichEditCntrItem [MFC], SyncToRichEditObject"] -ms.assetid: 6c0b4efe-0fb8-4621-b5e1-fdcb8ec48c3b --- # CRichEditCntrItem Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + With [CRichEditView](../../mfc/reference/cricheditview-class.md) and [CRichEditDoc](../../mfc/reference/cricheditdoc-class.md), provides the functionality of the rich edit control within the context of MFC's document view architecture. ## Syntax diff --git a/docs/mfc/reference/cricheditctrl-class.md b/docs/mfc/reference/cricheditctrl-class.md index 146d92aecf4..9a34e6cb057 100644 --- a/docs/mfc/reference/cricheditctrl-class.md +++ b/docs/mfc/reference/cricheditctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CRichEditCtrl [MFC], CRichEditCtrl", "CRichEditCtrl [MFC] --- # `CRichEditCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the rich edit control. ## Syntax diff --git a/docs/mfc/reference/cricheditdoc-class.md b/docs/mfc/reference/cricheditdoc-class.md index 3897e50c9b2..5dfa99a29a0 100644 --- a/docs/mfc/reference/cricheditdoc-class.md +++ b/docs/mfc/reference/cricheditdoc-class.md @@ -4,10 +4,12 @@ title: "CRichEditDoc Class" ms.date: "11/04/2016" f1_keywords: ["CRichEditDoc", "AFXRICH/CRichEditDoc", "AFXRICH/CRichEditDoc::CreateClientItem", "AFXRICH/CRichEditDoc::GetStreamFormat", "AFXRICH/CRichEditDoc::GetView", "AFXRICH/CRichEditDoc::m_bRTF"] helpviewer_keywords: ["CRichEditDoc [MFC], CreateClientItem", "CRichEditDoc [MFC], GetStreamFormat", "CRichEditDoc [MFC], GetView", "CRichEditDoc [MFC], m_bRTF"] -ms.assetid: c936ec18-d516-49d4-b7fb-c9aa0229eddc --- # CRichEditDoc Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + With [CRichEditView](../../mfc/reference/cricheditview-class.md) and [CRichEditCntrItem](../../mfc/reference/cricheditcntritem-class.md), provides the functionality of the rich edit control within the context of MFC's document view architecture. ## Syntax diff --git a/docs/mfc/reference/cricheditview-class.md b/docs/mfc/reference/cricheditview-class.md index 7cab1642800..23d301f4091 100644 --- a/docs/mfc/reference/cricheditview-class.md +++ b/docs/mfc/reference/cricheditview-class.md @@ -4,10 +4,12 @@ title: "CRichEditView Class" ms.date: "11/04/2016" f1_keywords: ["CRichEditView", "AFXRICH/CRichEditView", "AFXRICH/CRichEditView::CRichEditView", "AFXRICH/CRichEditView::AdjustDialogPosition", "AFXRICH/CRichEditView::CanPaste", "AFXRICH/CRichEditView::DoPaste", "AFXRICH/CRichEditView::FindText", "AFXRICH/CRichEditView::FindTextSimple", "AFXRICH/CRichEditView::GetCharFormatSelection", "AFXRICH/CRichEditView::GetDocument", "AFXRICH/CRichEditView::GetInPlaceActiveItem", "AFXRICH/CRichEditView::GetMargins", "AFXRICH/CRichEditView::GetPageRect", "AFXRICH/CRichEditView::GetPaperSize", "AFXRICH/CRichEditView::GetParaFormatSelection", "AFXRICH/CRichEditView::GetPrintRect", "AFXRICH/CRichEditView::GetPrintWidth", "AFXRICH/CRichEditView::GetRichEditCtrl", "AFXRICH/CRichEditView::GetSelectedItem", "AFXRICH/CRichEditView::GetTextLength", "AFXRICH/CRichEditView::GetTextLengthEx", "AFXRICH/CRichEditView::InsertFileAsObject", "AFXRICH/CRichEditView::InsertItem", "AFXRICH/CRichEditView::IsRichEditFormat", "AFXRICH/CRichEditView::OnCharEffect", "AFXRICH/CRichEditView::OnParaAlign", "AFXRICH/CRichEditView::OnUpdateCharEffect", "AFXRICH/CRichEditView::OnUpdateParaAlign", "AFXRICH/CRichEditView::PrintInsideRect", "AFXRICH/CRichEditView::PrintPage", "AFXRICH/CRichEditView::SetCharFormat", "AFXRICH/CRichEditView::SetMargins", "AFXRICH/CRichEditView::SetPaperSize", "AFXRICH/CRichEditView::SetParaFormat", "AFXRICH/CRichEditView::TextNotFound", "AFXRICH/CRichEditView::GetClipboardData", "AFXRICH/CRichEditView::GetContextMenu", "AFXRICH/CRichEditView::IsSelected", "AFXRICH/CRichEditView::OnFindNext", "AFXRICH/CRichEditView::OnInitialUpdate", "AFXRICH/CRichEditView::OnPasteNativeObject", "AFXRICH/CRichEditView::OnPrinterChanged", "AFXRICH/CRichEditView::OnReplaceAll", "AFXRICH/CRichEditView::OnReplaceSel", "AFXRICH/CRichEditView::OnTextNotFound", "AFXRICH/CRichEditView::QueryAcceptData", "AFXRICH/CRichEditView::WrapChanged", "AFXRICH/CRichEditView::m_nBulletIndent", "AFXRICH/CRichEditView::m_nWordWrap"] helpviewer_keywords: ["CRichEditView [MFC], CRichEditView", "CRichEditView [MFC], AdjustDialogPosition", "CRichEditView [MFC], CanPaste", "CRichEditView [MFC], DoPaste", "CRichEditView [MFC], FindText", "CRichEditView [MFC], FindTextSimple", "CRichEditView [MFC], GetCharFormatSelection", "CRichEditView [MFC], GetDocument", "CRichEditView [MFC], GetInPlaceActiveItem", "CRichEditView [MFC], GetMargins", "CRichEditView [MFC], GetPageRect", "CRichEditView [MFC], GetPaperSize", "CRichEditView [MFC], GetParaFormatSelection", "CRichEditView [MFC], GetPrintRect", "CRichEditView [MFC], GetPrintWidth", "CRichEditView [MFC], GetRichEditCtrl", "CRichEditView [MFC], GetSelectedItem", "CRichEditView [MFC], GetTextLength", "CRichEditView [MFC], GetTextLengthEx", "CRichEditView [MFC], InsertFileAsObject", "CRichEditView [MFC], InsertItem", "CRichEditView [MFC], IsRichEditFormat", "CRichEditView [MFC], OnCharEffect", "CRichEditView [MFC], OnParaAlign", "CRichEditView [MFC], OnUpdateCharEffect", "CRichEditView [MFC], OnUpdateParaAlign", "CRichEditView [MFC], PrintInsideRect", "CRichEditView [MFC], PrintPage", "CRichEditView [MFC], SetCharFormat", "CRichEditView [MFC], SetMargins", "CRichEditView [MFC], SetPaperSize", "CRichEditView [MFC], SetParaFormat", "CRichEditView [MFC], TextNotFound", "CRichEditView [MFC], GetClipboardData", "CRichEditView [MFC], GetContextMenu", "CRichEditView [MFC], IsSelected", "CRichEditView [MFC], OnFindNext", "CRichEditView [MFC], OnInitialUpdate", "CRichEditView [MFC], OnPasteNativeObject", "CRichEditView [MFC], OnPrinterChanged", "CRichEditView [MFC], OnReplaceAll", "CRichEditView [MFC], OnReplaceSel", "CRichEditView [MFC], OnTextNotFound", "CRichEditView [MFC], QueryAcceptData", "CRichEditView [MFC], WrapChanged", "CRichEditView [MFC], m_nBulletIndent", "CRichEditView [MFC], m_nWordWrap"] -ms.assetid: bd576b10-4cc0-4050-8f76-e1a0548411e4 --- # CRichEditView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + With [CRichEditDoc](../../mfc/reference/cricheditdoc-class.md) and [CRichEditCntrItem](../../mfc/reference/cricheditcntritem-class.md), provides the functionality of the rich edit control within the context of MFC's document view architecture. ## Syntax diff --git a/docs/mfc/reference/cruntimeclass-structure.md b/docs/mfc/reference/cruntimeclass-structure.md index 6f396b5818b..c6772976abc 100644 --- a/docs/mfc/reference/cruntimeclass-structure.md +++ b/docs/mfc/reference/cruntimeclass-structure.md @@ -4,10 +4,12 @@ title: "CRuntimeClass Structure" ms.date: "11/04/2016" f1_keywords: ["CRuntimeClass"] helpviewer_keywords: ["CRuntimeClass structure [MFC]", "dynamic class information [MFC]", "runtime [MFC], class information", "run-time class [MFC], CRuntimeClass structure"] -ms.assetid: de62b6ef-90d4-420f-8c70-f58b36976a2b --- # CRuntimeClass Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Each class derived from `CObject` is associated with a `CRuntimeClass` structure that you can use to obtain information about an object or its base class at run time. ## Syntax diff --git a/docs/mfc/reference/cscrollbar-class.md b/docs/mfc/reference/cscrollbar-class.md index b5e379b5299..b489841cf9e 100644 --- a/docs/mfc/reference/cscrollbar-class.md +++ b/docs/mfc/reference/cscrollbar-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CScrollBar [MFC], CScrollBar", "CScrollBar [MFC], Create" --- # `CScrollBar` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a Windows scroll-bar control. ## Syntax diff --git a/docs/mfc/reference/cscrollview-class.md b/docs/mfc/reference/cscrollview-class.md index 17e1c7e1bd3..9103f4b0a7c 100644 --- a/docs/mfc/reference/cscrollview-class.md +++ b/docs/mfc/reference/cscrollview-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CScrollView [MFC], CScrollView", "CScrollView [MFC], Chec --- # `CScrollView` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A [`CView`](../../mfc/reference/cview-class.md) with scrolling capabilities. ## Syntax diff --git a/docs/mfc/reference/csemaphore-class.md b/docs/mfc/reference/csemaphore-class.md index a31a4590ab9..e2d61659cf4 100644 --- a/docs/mfc/reference/csemaphore-class.md +++ b/docs/mfc/reference/csemaphore-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CSemaphore [MFC], CSemaphore"] --- # CSemaphore Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An object of class `CSemaphore` represents a "semaphore". A semaphore is a synchronization object that controls access to shared resources and prevents race conditions. ## Syntax diff --git a/docs/mfc/reference/csettingsstore-class.md b/docs/mfc/reference/csettingsstore-class.md index d54d021a525..cb4f6c83294 100644 --- a/docs/mfc/reference/csettingsstore-class.md +++ b/docs/mfc/reference/csettingsstore-class.md @@ -4,10 +4,12 @@ title: "CSettingsStore Class" ms.date: "11/04/2016" f1_keywords: ["CSettingsStore", "AFXSETTINGSSTORE/CSettingsStore", "AFXSETTINGSSTORE/CSettingsStore::CSettingsStore", "AFXSETTINGSSTORE/CSettingsStore::Close", "AFXSETTINGSSTORE/CSettingsStore::CreateKey", "AFXSETTINGSSTORE/CSettingsStore::DeleteKey", "AFXSETTINGSSTORE/CSettingsStore::DeleteValue", "AFXSETTINGSSTORE/CSettingsStore::Open", "AFXSETTINGSSTORE/CSettingsStore::Read", "AFXSETTINGSSTORE/CSettingsStore::Write"] helpviewer_keywords: ["CSettingsStore [MFC], CSettingsStore", "CSettingsStore [MFC], Close", "CSettingsStore [MFC], CreateKey", "CSettingsStore [MFC], DeleteKey", "CSettingsStore [MFC], DeleteValue", "CSettingsStore [MFC], Open", "CSettingsStore [MFC], Read", "CSettingsStore [MFC], Write"] -ms.assetid: 0ea181de-a13e-4b29-b560-7c43838223ff --- # CSettingsStore Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Wraps Windows API functions, providing an object-oriented interface that you use to access the registry. ## Syntax diff --git a/docs/mfc/reference/csettingsstoresp-class.md b/docs/mfc/reference/csettingsstoresp-class.md index 460f1d63a96..aeede5a5af0 100644 --- a/docs/mfc/reference/csettingsstoresp-class.md +++ b/docs/mfc/reference/csettingsstoresp-class.md @@ -4,10 +4,12 @@ title: "CSettingsStoreSP Class" ms.date: "11/04/2016" f1_keywords: ["CSettingsStoreSP", "AFXSETTINGSSTORE/CSettingsStoreSP", "AFXSETTINGSSTORE/CSettingsStoreSP::CSettingsStoreSP", "AFXSETTINGSSTORE/CSettingsStoreSP::Create", "AFXSETTINGSSTORE/CSettingsStoreSP::SetRuntimeClass"] helpviewer_keywords: ["CSettingsStoreSP [MFC], CSettingsStoreSP", "CSettingsStoreSP [MFC], Create", "CSettingsStoreSP [MFC], SetRuntimeClass"] -ms.assetid: bcd37f40-cfd4-4d17-a5ce-3bfabe995dcc --- # CSettingsStoreSP Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CSettingsStoreSP` class is a helper class that you can use to create instances of the [CSettingsStore Class](../../mfc/reference/csettingsstore-class.md). ## Syntax diff --git a/docs/mfc/reference/csharedfile-class.md b/docs/mfc/reference/csharedfile-class.md index 9b41513705b..f337246813d 100644 --- a/docs/mfc/reference/csharedfile-class.md +++ b/docs/mfc/reference/csharedfile-class.md @@ -4,10 +4,12 @@ title: "CSharedFile Class" ms.date: "11/04/2016" f1_keywords: ["CSharedFile", "AFXADV/CSharedFile", "AFXADV/CSharedFile::CSharedFile", "AFXADV/CSharedFile::Detach", "AFXADV/CSharedFile::SetHandle"] helpviewer_keywords: ["CSharedFile [MFC], CSharedFile", "CSharedFile [MFC], Detach", "CSharedFile [MFC], SetHandle"] -ms.assetid: 5d000422-9ede-4318-a8c9-f7412b674f39 --- # CSharedFile Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [CMemFile](../../mfc/reference/cmemfile-class.md)-derived class that supports shared memory files. ## Syntax diff --git a/docs/mfc/reference/cshellmanager-class.md b/docs/mfc/reference/cshellmanager-class.md index 83bc1cbf6f1..3a4b20fb72a 100644 --- a/docs/mfc/reference/cshellmanager-class.md +++ b/docs/mfc/reference/cshellmanager-class.md @@ -4,10 +4,12 @@ title: "CShellManager Class" ms.date: "11/04/2016" f1_keywords: ["CShellManager", "AFXSHELLMANAGER/CShellManager", "AFXSHELLMANAGER/CShellManager::CShellManager", "AFXSHELLMANAGER/CShellManager::BrowseForFolder", "AFXSHELLMANAGER/CShellManager::ConcatenateItem", "AFXSHELLMANAGER/CShellManager::CopyItem", "AFXSHELLMANAGER/CShellManager::CreateItem", "AFXSHELLMANAGER/CShellManager::FreeItem", "AFXSHELLMANAGER/CShellManager::GetItemCount", "AFXSHELLMANAGER/CShellManager::GetItemSize", "AFXSHELLMANAGER/CShellManager::GetNextItem", "AFXSHELLMANAGER/CShellManager::GetParentItem", "AFXSHELLMANAGER/CShellManager::ItemFromPath"] helpviewer_keywords: ["CShellManager [MFC], CShellManager", "CShellManager [MFC], BrowseForFolder", "CShellManager [MFC], ConcatenateItem", "CShellManager [MFC], CopyItem", "CShellManager [MFC], CreateItem", "CShellManager [MFC], FreeItem", "CShellManager [MFC], GetItemCount", "CShellManager [MFC], GetItemSize", "CShellManager [MFC], GetNextItem", "CShellManager [MFC], GetParentItem", "CShellManager [MFC], ItemFromPath"] -ms.assetid: f15c4c1a-6fae-487d-9913-9b7369b33da0 --- # CShellManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements several methods that enable you to work with pointers to identifier lists (PIDLs). ## Syntax diff --git a/docs/mfc/reference/csimpleexception-class.md b/docs/mfc/reference/csimpleexception-class.md index 177145f514b..3e53ac0ac49 100644 --- a/docs/mfc/reference/csimpleexception-class.md +++ b/docs/mfc/reference/csimpleexception-class.md @@ -4,10 +4,12 @@ title: "CSimpleException Class" ms.date: "11/04/2016" f1_keywords: ["CSimpleException", "AFX/CSimpleException", "AFX/CSimpleException::CSimpleException", "AFX/CSimpleException::GetErrorMessage"] helpviewer_keywords: ["CSimpleException [MFC], CSimpleException", "CSimpleException [MFC], GetErrorMessage"] -ms.assetid: be0eb8ef-e5b9-47d6-b0fb-efaff2d1e666 --- # CSimpleException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This class is a base class for resource-critical MFC exceptions. ## Syntax diff --git a/docs/mfc/reference/csingledoctemplate-class.md b/docs/mfc/reference/csingledoctemplate-class.md index ef86c373897..91c62bd2ca8 100644 --- a/docs/mfc/reference/csingledoctemplate-class.md +++ b/docs/mfc/reference/csingledoctemplate-class.md @@ -4,10 +4,12 @@ title: "CSingleDocTemplate Class" ms.date: "11/04/2016" f1_keywords: ["CSingleDocTemplate", "AFXWIN/CSingleDocTemplate", "AFXWIN/CSingleDocTemplate::CSingleDocTemplate"] helpviewer_keywords: ["CSingleDocTemplate [MFC], CSingleDocTemplate"] -ms.assetid: 4f3a8212-81ee-48a0-ad22-e0ed7c36a391 --- # CSingleDocTemplate Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Defines a document template that implements the single document interface (SDI). ## Syntax diff --git a/docs/mfc/reference/csinglelock-class.md b/docs/mfc/reference/csinglelock-class.md index 25559869d57..514ffb67131 100644 --- a/docs/mfc/reference/csinglelock-class.md +++ b/docs/mfc/reference/csinglelock-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CSingleLock [MFC], CSingleLock", "CSingleLock [MFC], IsLo --- # `CSingleLock` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents the access-control mechanism used in controlling access to a resource in a multithreaded program. ## Syntax diff --git a/docs/mfc/reference/csinusoidaltransitionfromrange-class.md b/docs/mfc/reference/csinusoidaltransitionfromrange-class.md index 71e765f9e7a..0781edb9065 100644 --- a/docs/mfc/reference/csinusoidaltransitionfromrange-class.md +++ b/docs/mfc/reference/csinusoidaltransitionfromrange-class.md @@ -4,10 +4,12 @@ title: "CSinusoidalTransitionFromRange Class" ms.date: "11/04/2016" f1_keywords: ["CSinusoidalTransitionFromRange", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromRange", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromRange::CSinusoidalTransitionFromRange", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromRange::Create", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromRange::m_dblMaximumValue", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromRange::m_dblMinimumValue", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromRange::m_duration", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromRange::m_period", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromRange::m_slope"] helpviewer_keywords: ["CSinusoidalTransitionFromRange [MFC], CSinusoidalTransitionFromRange", "CSinusoidalTransitionFromRange [MFC], Create", "CSinusoidalTransitionFromRange [MFC], m_dblMaximumValue", "CSinusoidalTransitionFromRange [MFC], m_dblMinimumValue", "CSinusoidalTransitionFromRange [MFC], m_duration", "CSinusoidalTransitionFromRange [MFC], m_period", "CSinusoidalTransitionFromRange [MFC], m_slope"] -ms.assetid: 8b66a729-5f10-431a-b055-e3600d0065da --- # CSinusoidalTransitionFromRange Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a sinusoidal-range transition that has a given range of oscillation. ## Syntax diff --git a/docs/mfc/reference/csinusoidaltransitionfromvelocity-class.md b/docs/mfc/reference/csinusoidaltransitionfromvelocity-class.md index 5340dcf776b..035fcb9bc5f 100644 --- a/docs/mfc/reference/csinusoidaltransitionfromvelocity-class.md +++ b/docs/mfc/reference/csinusoidaltransitionfromvelocity-class.md @@ -4,10 +4,12 @@ title: "CSinusoidalTransitionFromVelocity Class" ms.date: "11/04/2016" f1_keywords: ["CSinusoidalTransitionFromVelocity", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromVelocity", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromVelocity::CSinusoidalTransitionFromVelocity", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromVelocity::Create", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromVelocity::m_duration", "AFXANIMATIONCONTROLLER/CSinusoidalTransitionFromVelocity::m_period"] helpviewer_keywords: ["CSinusoidalTransitionFromVelocity [MFC], CSinusoidalTransitionFromVelocity", "CSinusoidalTransitionFromVelocity [MFC], Create", "CSinusoidalTransitionFromVelocity [MFC], m_duration", "CSinusoidalTransitionFromVelocity [MFC], m_period"] -ms.assetid: cc885f17-b84b-45ee-8f1f-36a8bbb7adad --- # CSinusoidalTransitionFromVelocity Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a sinusoidal-velocity transition that has an amplitude that is determined by the initial velocity of the animation variable. ## Syntax diff --git a/docs/mfc/reference/csliderctrl-class.md b/docs/mfc/reference/csliderctrl-class.md index 28afb9140de..2618ebf579c 100644 --- a/docs/mfc/reference/csliderctrl-class.md +++ b/docs/mfc/reference/csliderctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CSliderCtrl [MFC], CSliderCtrl", "CSliderCtrl [MFC], Clea --- # `CSliderCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common slider control. ## Syntax diff --git a/docs/mfc/reference/csmartdockinginfo-class.md b/docs/mfc/reference/csmartdockinginfo-class.md index d7944553b9c..eb889a8c47a 100644 --- a/docs/mfc/reference/csmartdockinginfo-class.md +++ b/docs/mfc/reference/csmartdockinginfo-class.md @@ -4,10 +4,12 @@ title: "CSmartDockingInfo Class" ms.date: "11/19/2018" f1_keywords: ["CSmartDockingInfo", "AFXDOCKINGMANAGER/CSmartDockingInfo", "AFXDOCKINGMANAGER/CSmartDockingInfo::CopyTo", "AFXDOCKINGMANAGER/CSmartDockingInfo::m_bUseThemeColorInShading", "AFXDOCKINGMANAGER/CSmartDockingInfo::m_clrBaseBackground", "AFXDOCKINGMANAGER/CSmartDockingInfo::m_clrToneDest", "AFXDOCKINGMANAGER/CSmartDockingInfo::m_clrToneSrc", "AFXDOCKINGMANAGER/CSmartDockingInfo::m_clrTransparent", "AFXDOCKINGMANAGER/CSmartDockingInfo::m_nCentralGroupOffset", "AFXDOCKINGMANAGER/CSmartDockingInfo::m_sizeTotal", "AFXDOCKINGMANAGER/CSmartDockingInfo::m_uiMarkerBmpResID", "AFXDOCKINGMANAGER/CSmartDockingInfo::m_uiMarkerLightBmpResID"] helpviewer_keywords: ["CSmartDockingInfo [MFC], CopyTo", "CSmartDockingInfo [MFC], m_bUseThemeColorInShading", "CSmartDockingInfo [MFC], m_clrBaseBackground", "CSmartDockingInfo [MFC], m_clrToneDest", "CSmartDockingInfo [MFC], m_clrToneSrc", "CSmartDockingInfo [MFC], m_clrTransparent", "CSmartDockingInfo [MFC], m_nCentralGroupOffset", "CSmartDockingInfo [MFC], m_sizeTotal", "CSmartDockingInfo [MFC], m_uiMarkerBmpResID", "CSmartDockingInfo [MFC], m_uiMarkerLightBmpResID"] -ms.assetid: cab04f38-4bc1-4378-9337-c56fc87fbd68 --- # CSmartDockingInfo Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Defines the appearance of smart docking markers. ## Syntax diff --git a/docs/mfc/reference/csmoothstoptransition-class.md b/docs/mfc/reference/csmoothstoptransition-class.md index 039271bcb5e..9d7b0d6b78f 100644 --- a/docs/mfc/reference/csmoothstoptransition-class.md +++ b/docs/mfc/reference/csmoothstoptransition-class.md @@ -4,10 +4,12 @@ title: "CSmoothStopTransition Class" ms.date: "11/04/2016" f1_keywords: ["CSmoothStopTransition", "AFXANIMATIONCONTROLLER/CSmoothStopTransition", "AFXANIMATIONCONTROLLER/CSmoothStopTransition::CSmoothStopTransition", "AFXANIMATIONCONTROLLER/CSmoothStopTransition::Create", "AFXANIMATIONCONTROLLER/CSmoothStopTransition::m_dblFinalValue", "AFXANIMATIONCONTROLLER/CSmoothStopTransition::m_maximumDuration"] helpviewer_keywords: ["CSmoothStopTransition [MFC], CSmoothStopTransition", "CSmoothStopTransition [MFC], Create", "CSmoothStopTransition [MFC], m_dblFinalValue", "CSmoothStopTransition [MFC], m_maximumDuration"] -ms.assetid: e1a4b476-6f96-43dd-90db-870a64406b85 --- # CSmoothStopTransition Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates a smooth-stop transition. ## Syntax diff --git a/docs/mfc/reference/csocket-class.md b/docs/mfc/reference/csocket-class.md index b7cb5b69c98..d317b7cced5 100644 --- a/docs/mfc/reference/csocket-class.md +++ b/docs/mfc/reference/csocket-class.md @@ -4,10 +4,12 @@ title: "CSocket Class" ms.date: "11/04/2016" f1_keywords: ["CSocket", "AFXSOCK/CSocket", "AFXSOCK/CSocket::CSocket", "AFXSOCK/CSocket::Attach", "AFXSOCK/CSocket::CancelBlockingCall", "AFXSOCK/CSocket::Create", "AFXSOCK/CSocket::FromHandle", "AFXSOCK/CSocket::IsBlocking", "AFXSOCK/CSocket::OnMessagePending"] helpviewer_keywords: ["CSocket [MFC], CSocket", "CSocket [MFC], Attach", "CSocket [MFC], CancelBlockingCall", "CSocket [MFC], Create", "CSocket [MFC], FromHandle", "CSocket [MFC], IsBlocking", "CSocket [MFC], OnMessagePending"] -ms.assetid: 7f23c081-d24d-42e3-b511-8053ca53d729 --- # `CSocket` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Derives from `CAsyncSocket`, inherits its encapsulation of the Windows Sockets API, and represents a higher level of abstraction than that of a `CAsyncSocket` object. ## Syntax diff --git a/docs/mfc/reference/csocketfile-class.md b/docs/mfc/reference/csocketfile-class.md index 5a6596fbcf7..77c50de870a 100644 --- a/docs/mfc/reference/csocketfile-class.md +++ b/docs/mfc/reference/csocketfile-class.md @@ -4,10 +4,12 @@ title: "CSocketFile Class" ms.date: "11/04/2016" f1_keywords: ["CSocketFile", "AFXSOCK/CSocketFile", "AFXSOCK/CSocketFile::CSocketFile"] helpviewer_keywords: ["CSocketFile [MFC], CSocketFile"] -ms.assetid: 7924c098-5f72-40d6-989d-42800a47958f --- # CSocketFile Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A `CFile` object used for sending and receiving data across a network via Windows Sockets. ## Syntax diff --git a/docs/mfc/reference/cspinbuttonctrl-class.md b/docs/mfc/reference/cspinbuttonctrl-class.md index d5fc72a6e4e..35a334b4672 100644 --- a/docs/mfc/reference/cspinbuttonctrl-class.md +++ b/docs/mfc/reference/cspinbuttonctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CSpinButtonCtrl [MFC], CSpinButtonCtrl", "CSpinButtonCtrl --- # CSpinButtonCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common spin button control. ## Syntax diff --git a/docs/mfc/reference/csplitbutton-class.md b/docs/mfc/reference/csplitbutton-class.md index 1e57c08c497..e946d578adf 100644 --- a/docs/mfc/reference/csplitbutton-class.md +++ b/docs/mfc/reference/csplitbutton-class.md @@ -4,10 +4,12 @@ title: "CSplitButton Class" ms.date: "11/19/2018" f1_keywords: ["CSplitButton", "AFXCMN/CSplitButton", "AFXCMN/CSplitButton::CSplitButton", "AFXCMN/CSplitButton::Create", "AFXCMN/CSplitButton::SetDropDownMenu", "AFXCMN/CSplitButton::OnDropDown"] helpviewer_keywords: ["CSplitButton [MFC], CSplitButton", "CSplitButton [MFC], Create", "CSplitButton [MFC], SetDropDownMenu", "CSplitButton [MFC], OnDropDown"] -ms.assetid: 6844d0a9-6408-4e44-9b5f-57628ed8bad6 --- # CSplitButton Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CSplitButton` class represents a split button control. The split button control performs a default behavior when a user clicks the main part of the button, and displays a drop-down menu when a user clicks the drop-down arrow of the button. ## Syntax diff --git a/docs/mfc/reference/csplitterwnd-class.md b/docs/mfc/reference/csplitterwnd-class.md index da72f6e13bb..f84ab903751 100644 --- a/docs/mfc/reference/csplitterwnd-class.md +++ b/docs/mfc/reference/csplitterwnd-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CSplitterWnd [MFC], CSplitterWnd", "CSplitterWnd [MFC], A --- # `CSplitterWnd` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a splitter window, which is a window that contains multiple panes. ## Syntax diff --git a/docs/mfc/reference/csplitterwndex-class.md b/docs/mfc/reference/csplitterwndex-class.md index 58ba5c4a4b3..187fb96b481 100644 --- a/docs/mfc/reference/csplitterwndex-class.md +++ b/docs/mfc/reference/csplitterwndex-class.md @@ -4,10 +4,12 @@ title: "CSplitterWndEx Class" ms.date: "11/04/2016" f1_keywords: ["CSplitterWndEx", "AFXSPLITTERWNDEX/CSplitterWndEx", "AFXSPLITTERWNDEX/CSplitterWndEx::OnDrawSplitter"] helpviewer_keywords: ["CSplitterWndEx [MFC], OnDrawSplitter"] -ms.assetid: 33e5eef3-05e1-4a07-a968-bf9207ce8598 --- # CSplitterWndEx Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a customized splitter window. ## Syntax diff --git a/docs/mfc/reference/cstatic-class.md b/docs/mfc/reference/cstatic-class.md index bce8cd9cc13..00eb9afd387 100644 --- a/docs/mfc/reference/cstatic-class.md +++ b/docs/mfc/reference/cstatic-class.md @@ -4,10 +4,12 @@ title: "CStatic Class" ms.date: "11/04/2016" f1_keywords: ["CStatic", "AFXWIN/CStatic", "AFXWIN/CStatic::CStatic", "AFXWIN/CStatic::Create", "AFXWIN/CStatic::DrawItem", "AFXWIN/CStatic::GetBitmap", "AFXWIN/CStatic::GetCursor", "AFXWIN/CStatic::GetEnhMetaFile", "AFXWIN/CStatic::GetIcon", "AFXWIN/CStatic::SetBitmap", "AFXWIN/CStatic::SetCursor", "AFXWIN/CStatic::SetEnhMetaFile", "AFXWIN/CStatic::SetIcon"] helpviewer_keywords: ["CStatic [MFC], CStatic", "CStatic [MFC], Create", "CStatic [MFC], DrawItem", "CStatic [MFC], GetBitmap", "CStatic [MFC], GetCursor", "CStatic [MFC], GetEnhMetaFile", "CStatic [MFC], GetIcon", "CStatic [MFC], SetBitmap", "CStatic [MFC], SetCursor", "CStatic [MFC], SetEnhMetaFile", "CStatic [MFC], SetIcon"] -ms.assetid: e7c94cd9-5ebd-428a-aa30-b3e51f8efb95 --- # `CStatic` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of a Windows static control. ## Syntax diff --git a/docs/mfc/reference/cstatusbar-class.md b/docs/mfc/reference/cstatusbar-class.md index ccbf9e66028..c6c9f11a58f 100644 --- a/docs/mfc/reference/cstatusbar-class.md +++ b/docs/mfc/reference/cstatusbar-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CStatusBar [MFC], CStatusBar", "CStatusBar [MFC], Command --- # CStatusBar Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A control bar with a row of text output panes, or "indicators." ## Syntax diff --git a/docs/mfc/reference/cstatusbarctrl-class.md b/docs/mfc/reference/cstatusbarctrl-class.md index a8e884c9e38..aed31b1090e 100644 --- a/docs/mfc/reference/cstatusbarctrl-class.md +++ b/docs/mfc/reference/cstatusbarctrl-class.md @@ -4,10 +4,12 @@ title: "CStatusBarCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CStatusBarCtrl", "AFXCMN/CStatusBarCtrl", "AFXCMN/CStatusBarCtrl::CStatusBarCtrl", "AFXCMN/CStatusBarCtrl::Create", "AFXCMN/CStatusBarCtrl::CreateEx", "AFXCMN/CStatusBarCtrl::DrawItem", "AFXCMN/CStatusBarCtrl::GetBorders", "AFXCMN/CStatusBarCtrl::GetIcon", "AFXCMN/CStatusBarCtrl::GetParts", "AFXCMN/CStatusBarCtrl::GetRect", "AFXCMN/CStatusBarCtrl::GetText", "AFXCMN/CStatusBarCtrl::GetTextLength", "AFXCMN/CStatusBarCtrl::GetTipText", "AFXCMN/CStatusBarCtrl::IsSimple", "AFXCMN/CStatusBarCtrl::SetBkColor", "AFXCMN/CStatusBarCtrl::SetIcon", "AFXCMN/CStatusBarCtrl::SetMinHeight", "AFXCMN/CStatusBarCtrl::SetParts", "AFXCMN/CStatusBarCtrl::SetSimple", "AFXCMN/CStatusBarCtrl::SetText", "AFXCMN/CStatusBarCtrl::SetTipText"] helpviewer_keywords: ["CStatusBarCtrl [MFC], CStatusBarCtrl", "CStatusBarCtrl [MFC], Create", "CStatusBarCtrl [MFC], CreateEx", "CStatusBarCtrl [MFC], DrawItem", "CStatusBarCtrl [MFC], GetBorders", "CStatusBarCtrl [MFC], GetIcon", "CStatusBarCtrl [MFC], GetParts", "CStatusBarCtrl [MFC], GetRect", "CStatusBarCtrl [MFC], GetText", "CStatusBarCtrl [MFC], GetTextLength", "CStatusBarCtrl [MFC], GetTipText", "CStatusBarCtrl [MFC], IsSimple", "CStatusBarCtrl [MFC], SetBkColor", "CStatusBarCtrl [MFC], SetIcon", "CStatusBarCtrl [MFC], SetMinHeight", "CStatusBarCtrl [MFC], SetParts", "CStatusBarCtrl [MFC], SetSimple", "CStatusBarCtrl [MFC], SetText", "CStatusBarCtrl [MFC], SetTipText"] -ms.assetid: 8504ad38-7b91-4746-aede-ac98886eb47b --- # CStatusBarCtrl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common status bar control. ## Syntax diff --git a/docs/mfc/reference/cstdiofile-class.md b/docs/mfc/reference/cstdiofile-class.md index fd2ff46ab5a..5cc9c21d9d5 100644 --- a/docs/mfc/reference/cstdiofile-class.md +++ b/docs/mfc/reference/cstdiofile-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CStdioFile [MFC], CStdioFile", "CStdioFile [MFC], Open", --- # `CStdioFile` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a C run-time stream file as opened by the run-time function [`fopen`](../../c-runtime-library/reference/fopen-wfopen.md). ## Syntax diff --git a/docs/mfc/reference/cstring-formatting-and-message-box-display.md b/docs/mfc/reference/cstring-formatting-and-message-box-display.md index 51932cc807a..9a02bc6164b 100644 --- a/docs/mfc/reference/cstring-formatting-and-message-box-display.md +++ b/docs/mfc/reference/cstring-formatting-and-message-box-display.md @@ -3,10 +3,12 @@ description: "Learn more about: CString Formatting and Message-Box Display" title: "CString Formatting and Message-Box Display" ms.date: "11/04/2016" helpviewer_keywords: ["CString objects [MFC], formatting and message boxes"] -ms.assetid: d1068cf4-9cc5-4952-b9e7-d612c53cbc28 --- # `CString` Formatting and Message-Box Display +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A number of functions are provided to format and parse `CString` objects. You can use these functions whenever you have to manipulate `CString` objects, but they are particularly useful for formatting strings that will appear in message-box text. This group of functions also includes a global routine for displaying a message box. diff --git a/docs/mfc/reference/cstringarray-class.md b/docs/mfc/reference/cstringarray-class.md index f8d656bcbbf..89df9c7e97b 100644 --- a/docs/mfc/reference/cstringarray-class.md +++ b/docs/mfc/reference/cstringarray-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CStringArray [MFC], CStringArray", "CStringArray [MFC], A --- # `CStringArray` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports arrays of [`CString`](../../atl-mfc-shared/using-cstring.md) objects. ## Syntax diff --git a/docs/mfc/reference/cstringlist-class.md b/docs/mfc/reference/cstringlist-class.md index 06dfe5f2c01..323ca43963e 100644 --- a/docs/mfc/reference/cstringlist-class.md +++ b/docs/mfc/reference/cstringlist-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CStringList [MFC], CStringList", "CStringList [MFC], AddH --- # `CStringList` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports lists of `CString` objects. ## Syntax diff --git a/docs/mfc/reference/csyncobject-class.md b/docs/mfc/reference/csyncobject-class.md index 535d9aaaa81..3ba190fb667 100644 --- a/docs/mfc/reference/csyncobject-class.md +++ b/docs/mfc/reference/csyncobject-class.md @@ -4,10 +4,12 @@ title: "CSyncObject Class" ms.date: "11/04/2016" f1_keywords: ["CSyncObject", "AFXMT/CSyncObject", "AFXMT/CSyncObject::CSyncObject", "AFXMT/CSyncObject::Lock", "AFXMT/CSyncObject::Unlock", "AFXMT/CSyncObject::m_hObject"] helpviewer_keywords: ["CSyncObject [MFC], CSyncObject", "CSyncObject [MFC], Lock", "CSyncObject [MFC], Unlock", "CSyncObject [MFC], m_hObject"] -ms.assetid: c62ea6eb-a17b-4e01-aed4-321fc435a5f4 --- # CSyncObject Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A pure virtual class that provides functionality common to the synchronization objects in Win32. ## Syntax diff --git a/docs/mfc/reference/ctabbedpane-class.md b/docs/mfc/reference/ctabbedpane-class.md index f6b051754f6..939efc4a2c1 100644 --- a/docs/mfc/reference/ctabbedpane-class.md +++ b/docs/mfc/reference/ctabbedpane-class.md @@ -4,10 +4,12 @@ title: "CTabbedPane Class" ms.date: "11/04/2016" f1_keywords: ["CTabbedPane", "AFXTABBEDPANE/CTabbedPane", "AFXTABBEDPANE/CTabbedPane::DetachPane", "AFXTABBEDPANE/CTabbedPane::EnableTabAutoColor", "AFXTABBEDPANE/CTabbedPane::FloatTab", "AFXTABBEDPANE/CTabbedPane::GetTabArea", "AFXTABBEDPANE/CTabbedPane::GetTabWnd", "AFXTABBEDPANE/CTabbedPane::HasAutoHideMode", "AFXTABBEDPANE/CTabbedPane::IsTabLocationBottom", "AFXTABBEDPANE/CTabbedPane::ResetTabs", "AFXTABBEDPANE/CTabbedPane::SetTabAutoColors", "AFXTABBEDPANE/CTabbedPane::m_bTabsAlwaysTop", "AFXTABBEDPANE/CTabbedPane::m_pTabWndRTC"] helpviewer_keywords: ["CTabbedPane [MFC], DetachPane", "CTabbedPane [MFC], EnableTabAutoColor", "CTabbedPane [MFC], FloatTab", "CTabbedPane [MFC], GetTabArea", "CTabbedPane [MFC], GetTabWnd", "CTabbedPane [MFC], HasAutoHideMode", "CTabbedPane [MFC], IsTabLocationBottom", "CTabbedPane [MFC], ResetTabs", "CTabbedPane [MFC], SetTabAutoColors", "CTabbedPane [MFC], m_bTabsAlwaysTop", "CTabbedPane [MFC], m_pTabWndRTC"] -ms.assetid: f4dc5215-b789-4f2d-8c62-477aceda3578 --- # CTabbedPane Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements the functionality of a pane with detachable tabs. or more detail see the source code located in the **VC\\atlmfc\\src\\mfc** folder of your Visual Studio installation. diff --git a/docs/mfc/reference/ctabctrl-class.md b/docs/mfc/reference/ctabctrl-class.md index 1a2461f10b1..8e2ee485435 100644 --- a/docs/mfc/reference/ctabctrl-class.md +++ b/docs/mfc/reference/ctabctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CTabCtrl [MFC], CTabCtrl", "CTabCtrl [MFC], AdjustRect", --- # `CTabCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common tab control. ## Syntax diff --git a/docs/mfc/reference/ctabview-class.md b/docs/mfc/reference/ctabview-class.md index 82983a5e29a..2a38b3edd1b 100644 --- a/docs/mfc/reference/ctabview-class.md +++ b/docs/mfc/reference/ctabview-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CTabView [MFC], AddView", "CTabView [MFC], FindTab", "CTa --- # CTabView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CTabView` class simplifies the use of the tab control class ( [CMFCTabCtrl](../../mfc/reference/ctabview-class.md)) in applications that use MFC's document/view architecture. ## Syntax diff --git a/docs/mfc/reference/ctaskdialog-class.md b/docs/mfc/reference/ctaskdialog-class.md index 2f1d87a8197..c7d5d84e1a4 100644 --- a/docs/mfc/reference/ctaskdialog-class.md +++ b/docs/mfc/reference/ctaskdialog-class.md @@ -4,10 +4,12 @@ title: "CTaskDialog Class" ms.date: "11/19/2018" f1_keywords: ["CTaskDialog", "AFXTASKDIALOG/CTaskDialog", "AFXTASKDIALOG/CTaskDialog::CTaskDialog", "AFXTASKDIALOG/CTaskDialog::AddCommandControl", "AFXTASKDIALOG/CTaskDialog::AddRadioButton", "AFXTASKDIALOG/CTaskDialog::ClickCommandControl", "AFXTASKDIALOG/CTaskDialog::ClickRadioButton", "AFXTASKDIALOG/CTaskDialog::DoModal", "AFXTASKDIALOG/CTaskDialog::GetCommonButtonCount", "AFXTASKDIALOG/CTaskDialog::GetCommonButtonFlag", "AFXTASKDIALOG/CTaskDialog::GetCommonButtonId", "AFXTASKDIALOG/CTaskDialog::GetOptions", "AFXTASKDIALOG/CTaskDialog::GetSelectedCommandControlID", "AFXTASKDIALOG/CTaskDialog::GetSelectedRadioButtonID", "AFXTASKDIALOG/CTaskDialog::GetVerificationCheckboxState", "AFXTASKDIALOG/CTaskDialog::IsCommandControlEnabled", "AFXTASKDIALOG/CTaskDialog::IsRadioButtonEnabled", "AFXTASKDIALOG/CTaskDialog::IsSupported", "AFXTASKDIALOG/CTaskDialog::LoadCommandControls", "AFXTASKDIALOG/CTaskDialog::LoadRadioButtons", "AFXTASKDIALOG/CTaskDialog::NavigateTo", "AFXTASKDIALOG/CTaskDialog::OnCommandControlClick", "AFXTASKDIALOG/CTaskDialog::OnCreate", "AFXTASKDIALOG/CTaskDialog::OnDestroy", "AFXTASKDIALOG/CTaskDialog::OnExpandButtonClick", "AFXTASKDIALOG/CTaskDialog::OnHelp", "AFXTASKDIALOG/CTaskDialog::OnHyperlinkClick", "AFXTASKDIALOG/CTaskDialog::OnInit", "AFXTASKDIALOG/CTaskDialog::OnNavigatePage", "AFXTASKDIALOG/CTaskDialog::OnRadioButtonClick", "AFXTASKDIALOG/CTaskDialog::OnTimer", "AFXTASKDIALOG/CTaskDialog::OnVerificationCheckboxClick", "AFXTASKDIALOG/CTaskDialog::RemoveAllCommandControls", "AFXTASKDIALOG/CTaskDialog::RemoveAllRadioButtons", "AFXTASKDIALOG/CTaskDialog::SetCommandControlOptions", "AFXTASKDIALOG/CTaskDialog::SetCommonButtonOptions", "AFXTASKDIALOG/CTaskDialog::SetCommonButtons", "AFXTASKDIALOG/CTaskDialog::SetContent", "AFXTASKDIALOG/CTaskDialog::SetDefaultCommandControl", "AFXTASKDIALOG/CTaskDialog::SetDefaultRadioButton", "AFXTASKDIALOG/CTaskDialog::SetDialogWidth", "AFXTASKDIALOG/CTaskDialog::SetExpansionArea", "AFXTASKDIALOG/CTaskDialog::SetFooterIcon", "AFXTASKDIALOG/CTaskDialog::SetFooterText", "AFXTASKDIALOG/CTaskDialog::SetMainIcon", "AFXTASKDIALOG/CTaskDialog::SetMainInstruction", "AFXTASKDIALOG/CTaskDialog::SetOptions", "AFXTASKDIALOG/CTaskDialog::SetProgressBarMarquee", "AFXTASKDIALOG/CTaskDialog::SetProgressBarPosition", "AFXTASKDIALOG/CTaskDialog::SetProgressBarRange", "AFXTASKDIALOG/CTaskDialog::SetProgressBarState", "AFXTASKDIALOG/CTaskDialog::SetRadioButtonOptions", "AFXTASKDIALOG/CTaskDialog::SetVerificationCheckbox", "AFXTASKDIALOG/CTaskDialog::SetVerificationCheckboxText", "AFXTASKDIALOG/CTaskDialog::SetWindowTitle", "AFXTASKDIALOG/CTaskDialog::ShowDialog", "AFXTASKDIALOG/CTaskDialog::TaskDialogCallback"] helpviewer_keywords: ["CTaskDialog [MFC], CTaskDialog", "CTaskDialog [MFC], AddCommandControl", "CTaskDialog [MFC], AddRadioButton", "CTaskDialog [MFC], ClickCommandControl", "CTaskDialog [MFC], ClickRadioButton", "CTaskDialog [MFC], DoModal", "CTaskDialog [MFC], GetCommonButtonCount", "CTaskDialog [MFC], GetCommonButtonFlag", "CTaskDialog [MFC], GetCommonButtonId", "CTaskDialog [MFC], GetOptions", "CTaskDialog [MFC], GetSelectedCommandControlID", "CTaskDialog [MFC], GetSelectedRadioButtonID", "CTaskDialog [MFC], GetVerificationCheckboxState", "CTaskDialog [MFC], IsCommandControlEnabled", "CTaskDialog [MFC], IsRadioButtonEnabled", "CTaskDialog [MFC], IsSupported", "CTaskDialog [MFC], LoadCommandControls", "CTaskDialog [MFC], LoadRadioButtons", "CTaskDialog [MFC], NavigateTo", "CTaskDialog [MFC], OnCommandControlClick", "CTaskDialog [MFC], OnCreate", "CTaskDialog [MFC], OnDestroy", "CTaskDialog [MFC], OnExpandButtonClick", "CTaskDialog [MFC], OnHelp", "CTaskDialog [MFC], OnHyperlinkClick", "CTaskDialog [MFC], OnInit", "CTaskDialog [MFC], OnNavigatePage", "CTaskDialog [MFC], OnRadioButtonClick", "CTaskDialog [MFC], OnTimer", "CTaskDialog [MFC], OnVerificationCheckboxClick", "CTaskDialog [MFC], RemoveAllCommandControls", "CTaskDialog [MFC], RemoveAllRadioButtons", "CTaskDialog [MFC], SetCommandControlOptions", "CTaskDialog [MFC], SetCommonButtonOptions", "CTaskDialog [MFC], SetCommonButtons", "CTaskDialog [MFC], SetContent", "CTaskDialog [MFC], SetDefaultCommandControl", "CTaskDialog [MFC], SetDefaultRadioButton", "CTaskDialog [MFC], SetDialogWidth", "CTaskDialog [MFC], SetExpansionArea", "CTaskDialog [MFC], SetFooterIcon", "CTaskDialog [MFC], SetFooterText", "CTaskDialog [MFC], SetMainIcon", "CTaskDialog [MFC], SetMainInstruction", "CTaskDialog [MFC], SetOptions", "CTaskDialog [MFC], SetProgressBarMarquee", "CTaskDialog [MFC], SetProgressBarPosition", "CTaskDialog [MFC], SetProgressBarRange", "CTaskDialog [MFC], SetProgressBarState", "CTaskDialog [MFC], SetRadioButtonOptions", "CTaskDialog [MFC], SetVerificationCheckbox", "CTaskDialog [MFC], SetVerificationCheckboxText", "CTaskDialog [MFC], SetWindowTitle", "CTaskDialog [MFC], ShowDialog", "CTaskDialog [MFC], TaskDialogCallback"] -ms.assetid: 1991ec98-ae56-4483-958b-233809c8c559 --- # CTaskDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A pop-up dialog box that functions like a message box but can display additional information to the user. The `CTaskDialog` also includes functionality for gathering information from the user. ## Syntax diff --git a/docs/mfc/reference/ctoolbar-class.md b/docs/mfc/reference/ctoolbar-class.md index 983d20748bc..0374063757d 100644 --- a/docs/mfc/reference/ctoolbar-class.md +++ b/docs/mfc/reference/ctoolbar-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CToolBar [MFC], CToolBar", "CToolBar [MFC], CommandToInde --- # `CToolBar` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Control bars that have a row of bitmapped buttons and optional separators. ## Syntax @@ -52,7 +55,7 @@ The buttons can act like pushbuttons, check-box buttons, or radio buttons. `CToo [`CToolBar::GetToolBarCtrl`](#gettoolbarctrl), a member function new to MFC 4.0, allows you to take advantage of the Windows common control's support for toolbar customization and additional functionality. `CToolBar` member functions give you most of the functionality of the Windows common controls; however, when you call `GetToolBarCtrl`, you can give your toolbars even more of the characteristics of Windows 95/98 toolbars. When you call `GetToolBarCtrl`, it will return a reference to a `CToolBarCtrl` object. See [`CToolBarCtrl`](../../mfc/reference/ctoolbarctrl-class.md) for more information about designing toolbars using Windows common controls. For more general information about common controls, see [Common Controls](/windows/win32/Controls/common-controls-intro) in the Windows SDK. -Visual C++ provides you with two methods to create a toolbar. To create a toolbar resource using the Resource Editor, follow these steps: +Visual Studio provides you with two methods to create a toolbar. To create a toolbar resource using the Resource Editor, follow these steps: 1. Create a toolbar resource. diff --git a/docs/mfc/reference/ctoolbarctrl-class.md b/docs/mfc/reference/ctoolbarctrl-class.md index e213031818b..b4ff4996576 100644 --- a/docs/mfc/reference/ctoolbarctrl-class.md +++ b/docs/mfc/reference/ctoolbarctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CToolBarCtrl [MFC], CToolBarCtrl", "CToolBarCtrl [MFC], A --- # `CToolBarCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows toolbar common control. ## Syntax diff --git a/docs/mfc/reference/ctooltipctrl-class.md b/docs/mfc/reference/ctooltipctrl-class.md index ceaf49a6f03..258feb52633 100644 --- a/docs/mfc/reference/ctooltipctrl-class.md +++ b/docs/mfc/reference/ctooltipctrl-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CToolTipCtrl [MFC], CToolTipCtrl", "CToolTipCtrl [MFC], A --- # `CToolTipCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Encapsulates the functionality of a "tooltip control," a small pop-up window that displays a single line of text describing the purpose of a tool in an application. ## Syntax diff --git a/docs/mfc/reference/ctooltipmanager-class.md b/docs/mfc/reference/ctooltipmanager-class.md index 4a495081f92..a8ed2b9ada1 100644 --- a/docs/mfc/reference/ctooltipmanager-class.md +++ b/docs/mfc/reference/ctooltipmanager-class.md @@ -4,10 +4,12 @@ title: "CTooltipManager Class" ms.date: "11/04/2016" f1_keywords: ["CTooltipManager", "AFXTOOLTIPMANAGER/CTooltipManager", "AFXTOOLTIPMANAGER/CTooltipManager::CreateToolTip", "AFXTOOLTIPMANAGER/CTooltipManager::DeleteToolTip", "AFXTOOLTIPMANAGER/CTooltipManager::SetTooltipParams", "AFXTOOLTIPMANAGER/CTooltipManager::SetTooltipText", "AFXTOOLTIPMANAGER/CTooltipManager::UpdateTooltips"] helpviewer_keywords: ["CTooltipManager [MFC], CreateToolTip", "CTooltipManager [MFC], DeleteToolTip", "CTooltipManager [MFC], SetTooltipParams", "CTooltipManager [MFC], SetTooltipText", "CTooltipManager [MFC], UpdateTooltips"] -ms.assetid: c71779d7-8b6e-47ef-8500-d4552731fe86 --- # CTooltipManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Maintains runtime information about tooltips. The `CTooltipManager` class is instantiated one time per application. ## Syntax diff --git a/docs/mfc/reference/ctreectrl-class.md b/docs/mfc/reference/ctreectrl-class.md index 81ce2a29cb7..f3679f9e9bc 100644 --- a/docs/mfc/reference/ctreectrl-class.md +++ b/docs/mfc/reference/ctreectrl-class.md @@ -4,10 +4,12 @@ title: "CTreeCtrl Class" ms.date: "11/04/2016" f1_keywords: ["CTreeCtrl", "AFXCMN/CTreeCtrl", "AFXCMN/CTreeCtrl::CTreeCtrl", "AFXCMN/CTreeCtrl::Create", "AFXCMN/CTreeCtrl::CreateDragImage", "AFXCMN/CTreeCtrl::CreateEx", "AFXCMN/CTreeCtrl::DeleteAllItems", "AFXCMN/CTreeCtrl::DeleteItem", "AFXCMN/CTreeCtrl::EditLabel", "AFXCMN/CTreeCtrl::EndEditLabelNow", "AFXCMN/CTreeCtrl::EnsureVisible", "AFXCMN/CTreeCtrl::Expand", "AFXCMN/CTreeCtrl::GetBkColor", "AFXCMN/CTreeCtrl::GetCheck", "AFXCMN/CTreeCtrl::GetChildItem", "AFXCMN/CTreeCtrl::GetCount", "AFXCMN/CTreeCtrl::GetDropHilightItem", "AFXCMN/CTreeCtrl::GetEditControl", "AFXCMN/CTreeCtrl::GetExtendedStyle", "AFXCMN/CTreeCtrl::GetFirstVisibleItem", "AFXCMN/CTreeCtrl::GetImageList", "AFXCMN/CTreeCtrl::GetIndent", "AFXCMN/CTreeCtrl::GetInsertMarkColor", "AFXCMN/CTreeCtrl::GetItem", "AFXCMN/CTreeCtrl::GetItemData", "AFXCMN/CTreeCtrl::GetItemExpandedImageIndex", "AFXCMN/CTreeCtrl::GetItemHeight", "AFXCMN/CTreeCtrl::GetItemImage", "AFXCMN/CTreeCtrl::GetItemPartRect", "AFXCMN/CTreeCtrl::GetItemRect", "AFXCMN/CTreeCtrl::GetItemState", "AFXCMN/CTreeCtrl::GetItemStateEx", "AFXCMN/CTreeCtrl::GetItemText", "AFXCMN/CTreeCtrl::GetLastVisibleItem", "AFXCMN/CTreeCtrl::GetLineColor", "AFXCMN/CTreeCtrl::GetNextItem", "AFXCMN/CTreeCtrl::GetNextSiblingItem", "AFXCMN/CTreeCtrl::GetNextVisibleItem", "AFXCMN/CTreeCtrl::GetParentItem", "AFXCMN/CTreeCtrl::GetPrevSiblingItem", "AFXCMN/CTreeCtrl::GetPrevVisibleItem", "AFXCMN/CTreeCtrl::GetRootItem", "AFXCMN/CTreeCtrl::GetScrollTime", "AFXCMN/CTreeCtrl::GetSelectedCount", "AFXCMN/CTreeCtrl::GetSelectedItem", "AFXCMN/CTreeCtrl::GetTextColor", "AFXCMN/CTreeCtrl::GetToolTips", "AFXCMN/CTreeCtrl::GetVisibleCount", "AFXCMN/CTreeCtrl::HitTest", "AFXCMN/CTreeCtrl::InsertItem", "AFXCMN/CTreeCtrl::ItemHasChildren", "AFXCMN/CTreeCtrl::MapAccIdToItem", "AFXCMN/CTreeCtrl::MapItemToAccID", "AFXCMN/CTreeCtrl::Select", "AFXCMN/CTreeCtrl::SelectDropTarget", "AFXCMN/CTreeCtrl::SelectItem", "AFXCMN/CTreeCtrl::SelectSetFirstVisible", "AFXCMN/CTreeCtrl::SetAutoscrollInfo", "AFXCMN/CTreeCtrl::SetBkColor", "AFXCMN/CTreeCtrl::SetCheck", "AFXCMN/CTreeCtrl::SetExtendedStyle", "AFXCMN/CTreeCtrl::SetImageList", "AFXCMN/CTreeCtrl::SetIndent", "AFXCMN/CTreeCtrl::SetInsertMark", "AFXCMN/CTreeCtrl::SetInsertMarkColor", "AFXCMN/CTreeCtrl::SetItem", "AFXCMN/CTreeCtrl::SetItemData", "AFXCMN/CTreeCtrl::SetItemExpandedImageIndex", "AFXCMN/CTreeCtrl::SetItemHeight", "AFXCMN/CTreeCtrl::SetItemImage", "AFXCMN/CTreeCtrl::SetItemState", "AFXCMN/CTreeCtrl::SetItemStateEx", "AFXCMN/CTreeCtrl::SetItemText", "AFXCMN/CTreeCtrl::SetLineColor", "AFXCMN/CTreeCtrl::SetScrollTime", "AFXCMN/CTreeCtrl::SetTextColor", "AFXCMN/CTreeCtrl::SetToolTips", "AFXCMN/CTreeCtrl::ShowInfoTip", "AFXCMN/CTreeCtrl::SortChildren", "AFXCMN/CTreeCtrl::SortChildrenCB"] helpviewer_keywords: ["CTreeCtrl [MFC], CTreeCtrl", "CTreeCtrl [MFC], Create", "CTreeCtrl [MFC], CreateDragImage", "CTreeCtrl [MFC], CreateEx", "CTreeCtrl [MFC], DeleteAllItems", "CTreeCtrl [MFC], DeleteItem", "CTreeCtrl [MFC], EditLabel", "CTreeCtrl [MFC], EndEditLabelNow", "CTreeCtrl [MFC], EnsureVisible", "CTreeCtrl [MFC], Expand", "CTreeCtrl [MFC], GetBkColor", "CTreeCtrl [MFC], GetCheck", "CTreeCtrl [MFC], GetChildItem", "CTreeCtrl [MFC], GetCount", "CTreeCtrl [MFC], GetDropHilightItem", "CTreeCtrl [MFC], GetEditControl", "CTreeCtrl [MFC], GetExtendedStyle", "CTreeCtrl [MFC], GetFirstVisibleItem", "CTreeCtrl [MFC], GetImageList", "CTreeCtrl [MFC], GetIndent", "CTreeCtrl [MFC], GetInsertMarkColor", "CTreeCtrl [MFC], GetItem", "CTreeCtrl [MFC], GetItemData", "CTreeCtrl [MFC], GetItemExpandedImageIndex", "CTreeCtrl [MFC], GetItemHeight", "CTreeCtrl [MFC], GetItemImage", "CTreeCtrl [MFC], GetItemPartRect", "CTreeCtrl [MFC], GetItemRect", "CTreeCtrl [MFC], GetItemState", "CTreeCtrl [MFC], GetItemStateEx", "CTreeCtrl [MFC], GetItemText", "CTreeCtrl [MFC], GetLastVisibleItem", "CTreeCtrl [MFC], GetLineColor", "CTreeCtrl [MFC], GetNextItem", "CTreeCtrl [MFC], GetNextSiblingItem", "CTreeCtrl [MFC], GetNextVisibleItem", "CTreeCtrl [MFC], GetParentItem", "CTreeCtrl [MFC], GetPrevSiblingItem", "CTreeCtrl [MFC], GetPrevVisibleItem", "CTreeCtrl [MFC], GetRootItem", "CTreeCtrl [MFC], GetScrollTime", "CTreeCtrl [MFC], GetSelectedCount", "CTreeCtrl [MFC], GetSelectedItem", "CTreeCtrl [MFC], GetTextColor", "CTreeCtrl [MFC], GetToolTips", "CTreeCtrl [MFC], GetVisibleCount", "CTreeCtrl [MFC], HitTest", "CTreeCtrl [MFC], InsertItem", "CTreeCtrl [MFC], ItemHasChildren", "CTreeCtrl [MFC], MapAccIdToItem", "CTreeCtrl [MFC], MapItemToAccID", "CTreeCtrl [MFC], Select", "CTreeCtrl [MFC], SelectDropTarget", "CTreeCtrl [MFC], SelectItem", "CTreeCtrl [MFC], SelectSetFirstVisible", "CTreeCtrl [MFC], SetAutoscrollInfo", "CTreeCtrl [MFC], SetBkColor", "CTreeCtrl [MFC], SetCheck", "CTreeCtrl [MFC], SetExtendedStyle", "CTreeCtrl [MFC], SetImageList", "CTreeCtrl [MFC], SetIndent", "CTreeCtrl [MFC], SetInsertMark", "CTreeCtrl [MFC], SetInsertMarkColor", "CTreeCtrl [MFC], SetItem", "CTreeCtrl [MFC], SetItemData", "CTreeCtrl [MFC], SetItemExpandedImageIndex", "CTreeCtrl [MFC], SetItemHeight", "CTreeCtrl [MFC], SetItemImage", "CTreeCtrl [MFC], SetItemState", "CTreeCtrl [MFC], SetItemStateEx", "CTreeCtrl [MFC], SetItemText", "CTreeCtrl [MFC], SetLineColor", "CTreeCtrl [MFC], SetScrollTime", "CTreeCtrl [MFC], SetTextColor", "CTreeCtrl [MFC], SetToolTips", "CTreeCtrl [MFC], ShowInfoTip", "CTreeCtrl [MFC], SortChildren", "CTreeCtrl [MFC], SortChildrenCB"] -ms.assetid: 96e20031-6161-4143-8c12-8d1816c66d90 --- # `CTreeCtrl` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the functionality of the Windows common tree view control. ## Syntax diff --git a/docs/mfc/reference/ctreeview-class.md b/docs/mfc/reference/ctreeview-class.md index 7511efdd06c..4419e23af0a 100644 --- a/docs/mfc/reference/ctreeview-class.md +++ b/docs/mfc/reference/ctreeview-class.md @@ -4,10 +4,12 @@ title: "CTreeView Class" ms.date: "11/04/2016" f1_keywords: ["CTreeView", "AFXCVIEW/CTreeView", "AFXCVIEW/CTreeView::CTreeView", "AFXCVIEW/CTreeView::GetTreeCtrl"] helpviewer_keywords: ["CTreeView [MFC], CTreeView", "CTreeView [MFC], GetTreeCtrl"] -ms.assetid: 5df583a6-d69f-42ca-9d8d-57e04558afff --- # CTreeView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Simplifies use of the tree control and of [CTreeCtrl](../../mfc/reference/ctreectrl-class.md), the class that encapsulates tree-control functionality, with MFC's document-view architecture. ## Syntax diff --git a/docs/mfc/reference/ctypedptrarray-class.md b/docs/mfc/reference/ctypedptrarray-class.md index db37f7ca4af..0ece714e621 100644 --- a/docs/mfc/reference/ctypedptrarray-class.md +++ b/docs/mfc/reference/ctypedptrarray-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CTypedPtrArray [MFC], Add", "CTypedPtrArray [MFC], Append --- # CTypedPtrArray Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides a type-safe "wrapper" for objects of class `CPtrArray` or `CObArray`. ## Syntax diff --git a/docs/mfc/reference/ctypedptrlist-class.md b/docs/mfc/reference/ctypedptrlist-class.md index d06daa00f41..0ffa8e30f0f 100644 --- a/docs/mfc/reference/ctypedptrlist-class.md +++ b/docs/mfc/reference/ctypedptrlist-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CTypedPtrList [MFC], AddHead", "CTypedPtrList [MFC], AddT --- # CTypedPtrList Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides a type-safe "wrapper" for objects of class `CPtrList`. ## Syntax diff --git a/docs/mfc/reference/ctypedptrmap-class.md b/docs/mfc/reference/ctypedptrmap-class.md index 1e8ac54c643..7b430d55ba8 100644 --- a/docs/mfc/reference/ctypedptrmap-class.md +++ b/docs/mfc/reference/ctypedptrmap-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CTypedPtrMap [MFC], GetNextAssoc", "CTypedPtrMap [MFC], L --- # CTypedPtrMap Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides a type-safe "wrapper" for objects of the pointer-map classes `CMapPtrToPtr`, `CMapPtrToWord`, `CMapWordToPtr`, and `CMapStringToPtr`. ## Syntax diff --git a/docs/mfc/reference/cuintarray-class.md b/docs/mfc/reference/cuintarray-class.md index 6f73ded501d..fb9f1b1c845 100644 --- a/docs/mfc/reference/cuintarray-class.md +++ b/docs/mfc/reference/cuintarray-class.md @@ -4,10 +4,12 @@ title: "CUIntArray Class" ms.date: "11/04/2016" f1_keywords: ["CUIntArray", "AFXCOLL/CUIntArray", "AFXCOLL/CUIntArray::CUIntArray", "AFXCOLL/CUIntArray::Add", "AFXCOLL/CUIntArray::Append", "AFXCOLL/CUIntArray::Copy", "AFXCOLL/CUIntArray::ElementAt", "AFXCOLL/CUIntArray::FreeExtra", "AFXCOLL/CUIntArray::GetAt", "AFXCOLL/CUIntArray::GetCount", "AFXCOLL/CUIntArray::GetData", "AFXCOLL/CUIntArray::GetSize", "AFXCOLL/CUIntArray::GetUpperBound", "AFXCOLL/CUIntArray::InsertAt", "AFXCOLL/CUIntArray::IsEmpty", "AFXCOLL/CUIntArray::RemoveAll", "AFXCOLL/CUIntArray::RemoveAt", "AFXCOLL/CUIntArray::SetAt", "AFXCOLL/CUIntArray::SetAtGrow", "AFXCOLL/CUIntArray::SetSize"] helpviewer_keywords: ["CUIntArray [MFC], CUIntArray", "CUIntArray [MFC], Add", "CUIntArray [MFC], Append", "CUIntArray [MFC], Copy", "CUIntArray [MFC], ElementAt", "CUIntArray [MFC], FreeExtra", "CUIntArray [MFC], GetAt", "CUIntArray [MFC], GetCount", "CUIntArray [MFC], GetData", "CUIntArray [MFC], GetSize", "CUIntArray [MFC], GetUpperBound", "CUIntArray [MFC], InsertAt", "CUIntArray [MFC], IsEmpty", "CUIntArray [MFC], RemoveAll", "CUIntArray [MFC], RemoveAt", "CUIntArray [MFC], SetAt", "CUIntArray [MFC], SetAtGrow", "CUIntArray [MFC], SetSize"] -ms.assetid: d71f3d8f-ef9f-4e48-9b69-7782c0e2ddf7 --- # CUIntArray Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports arrays of unsigned integers. ## Syntax diff --git a/docs/mfc/reference/cuserexception-class.md b/docs/mfc/reference/cuserexception-class.md index b3dc67f0608..26387721c0a 100644 --- a/docs/mfc/reference/cuserexception-class.md +++ b/docs/mfc/reference/cuserexception-class.md @@ -4,10 +4,12 @@ title: "CUserException Class" ms.date: "11/04/2016" f1_keywords: ["CUserException"] helpviewer_keywords: ["operations [MFC], stopping", "exceptions [MFC], throwing", "CUserException class [MFC]", "errors [MFC], trapping", "operations [MFC]", "throwing exceptions [MFC], stopping user operations"] -ms.assetid: 2156ba6d-2cce-415a-9000-6f02c26fcd7d --- # CUserException Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Thrown to stop an end-user operation. ## Syntax diff --git a/docs/mfc/reference/cusertool-class.md b/docs/mfc/reference/cusertool-class.md index f664e322f8b..7701be54440 100644 --- a/docs/mfc/reference/cusertool-class.md +++ b/docs/mfc/reference/cusertool-class.md @@ -4,10 +4,12 @@ title: "CUserTool Class" ms.date: "11/04/2016" f1_keywords: ["CUserTool", "AFXUSERTOOL/CUserTool", "AFXUSERTOOL/CUserTool::CopyIconToClipboard", "AFXUSERTOOL/CUserTool::DrawToolIcon", "AFXUSERTOOL/CUserTool::GetCommand", "AFXUSERTOOL/CUserTool::GetCommandId", "AFXUSERTOOL/CUserTool::Invoke", "AFXUSERTOOL/CUserTool::Serialize", "AFXUSERTOOL/CUserTool::SetCommand", "AFXUSERTOOL/CUserTool::SetToolIcon", "AFXUSERTOOL/CUserTool::LoadDefaultIcon", "AFXUSERTOOL/CUserTool::m_strArguments", "AFXUSERTOOL/CUserTool::m_strInitialDirectory", "AFXUSERTOOL/CUserTool::m_strLabel"] helpviewer_keywords: ["CUserTool [MFC], CopyIconToClipboard", "CUserTool [MFC], DrawToolIcon", "CUserTool [MFC], GetCommand", "CUserTool [MFC], GetCommandId", "CUserTool [MFC], Invoke", "CUserTool [MFC], Serialize", "CUserTool [MFC], SetCommand", "CUserTool [MFC], SetToolIcon", "CUserTool [MFC], LoadDefaultIcon", "CUserTool [MFC], m_strArguments", "CUserTool [MFC], m_strInitialDirectory", "CUserTool [MFC], m_strLabel"] -ms.assetid: 7c287d3e-d012-488d-b4e1-aa0f83f294bb --- # CUserTool Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A user tool is a menu item that runs an external application. The **Tools** tab of the **Customize** dialog box ( [CMFCToolBarsCustomizeDialog Class](../../mfc/reference/cmfctoolbarscustomizedialog-class.md)) enables the user to add user tools, and to specify the name, command, arguments, and initial directory for each user tool. ## Syntax diff --git a/docs/mfc/reference/cusertoolsmanager-class.md b/docs/mfc/reference/cusertoolsmanager-class.md index a0b94f5dc84..eaa6e767e20 100644 --- a/docs/mfc/reference/cusertoolsmanager-class.md +++ b/docs/mfc/reference/cusertoolsmanager-class.md @@ -4,10 +4,12 @@ title: "CUserToolsManager Class" ms.date: "11/04/2016" f1_keywords: ["CUserToolsManager", "AFXUSERTOOLSMANAGER/CUserToolsManager", "AFXUSERTOOLSMANAGER/CUserToolsManager::CUserToolsManager", "AFXUSERTOOLSMANAGER/CUserToolsManager::CreateNewTool", "AFXUSERTOOLSMANAGER/CUserToolsManager::FindTool", "AFXUSERTOOLSMANAGER/CUserToolsManager::GetArgumentsMenuID", "AFXUSERTOOLSMANAGER/CUserToolsManager::GetDefExt", "AFXUSERTOOLSMANAGER/CUserToolsManager::GetFilter", "AFXUSERTOOLSMANAGER/CUserToolsManager::GetInitialDirMenuID", "AFXUSERTOOLSMANAGER/CUserToolsManager::GetMaxTools", "AFXUSERTOOLSMANAGER/CUserToolsManager::GetToolsEntryCmd", "AFXUSERTOOLSMANAGER/CUserToolsManager::GetUserTools", "AFXUSERTOOLSMANAGER/CUserToolsManager::InvokeTool", "AFXUSERTOOLSMANAGER/CUserToolsManager::IsUserToolCmd", "AFXUSERTOOLSMANAGER/CUserToolsManager::LoadState", "AFXUSERTOOLSMANAGER/CUserToolsManager::MoveToolDown", "AFXUSERTOOLSMANAGER/CUserToolsManager::MoveToolUp", "AFXUSERTOOLSMANAGER/CUserToolsManager::RemoveTool", "AFXUSERTOOLSMANAGER/CUserToolsManager::SaveState", "AFXUSERTOOLSMANAGER/CUserToolsManager::SetDefExt", "AFXUSERTOOLSMANAGER/CUserToolsManager::SetFilter"] helpviewer_keywords: ["CUserToolsManager [MFC], CUserToolsManager", "CUserToolsManager [MFC], CreateNewTool", "CUserToolsManager [MFC], FindTool", "CUserToolsManager [MFC], GetArgumentsMenuID", "CUserToolsManager [MFC], GetDefExt", "CUserToolsManager [MFC], GetFilter", "CUserToolsManager [MFC], GetInitialDirMenuID", "CUserToolsManager [MFC], GetMaxTools", "CUserToolsManager [MFC], GetToolsEntryCmd", "CUserToolsManager [MFC], GetUserTools", "CUserToolsManager [MFC], InvokeTool", "CUserToolsManager [MFC], IsUserToolCmd", "CUserToolsManager [MFC], LoadState", "CUserToolsManager [MFC], MoveToolDown", "CUserToolsManager [MFC], MoveToolUp", "CUserToolsManager [MFC], RemoveTool", "CUserToolsManager [MFC], SaveState", "CUserToolsManager [MFC], SetDefExt", "CUserToolsManager [MFC], SetFilter"] -ms.assetid: bdfa37ae-efca-4616-abb5-9d0dcd2d335b --- # CUserToolsManager Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Maintains the collection of [CUserTool Class](../../mfc/reference/cusertool-class.md) objects in an application. A user tool is a menu item that runs an external application. The `CUserToolsManager` object enables the user or developer to add new user tools to the application. It supports the execution of the commands associated with user tools, and it also saves information about user tools in the Windows registry. ## Syntax diff --git a/docs/mfc/reference/cview-class.md b/docs/mfc/reference/cview-class.md index 42e892ac90c..e9a3113ea03 100644 --- a/docs/mfc/reference/cview-class.md +++ b/docs/mfc/reference/cview-class.md @@ -4,10 +4,12 @@ title: "CView Class" ms.date: "11/04/2016" f1_keywords: ["CView", "AFXWIN/CView", "AFXWIN/CView::CView", "AFXWIN/CView::DoPreparePrinting", "AFXWIN/CView::GetDocument", "AFXWIN/CView::IsSelected", "AFXWIN/CView::OnDragEnter", "AFXWIN/CView::OnDragLeave", "AFXWIN/CView::OnDragOver", "AFXWIN/CView::OnDragScroll", "AFXWIN/CView::OnDrop", "AFXWIN/CView::OnDropEx", "AFXWIN/CView::OnInitialUpdate", "AFXWIN/CView::OnPrepareDC", "AFXWIN/CView::OnScroll", "AFXWIN/CView::OnScrollBy", "AFXWIN/CView::OnActivateFrame", "AFXWIN/CView::OnActivateView", "AFXWIN/CView::OnBeginPrinting", "AFXWIN/CView::OnDraw", "AFXWIN/CView::OnEndPrinting", "AFXWIN/CView::OnEndPrintPreview", "AFXWIN/CView::OnPreparePrinting", "AFXWIN/CView::OnPrint", "AFXWIN/CView::OnUpdate"] helpviewer_keywords: ["CView [MFC], CView", "CView [MFC], DoPreparePrinting", "CView [MFC], GetDocument", "CView [MFC], IsSelected", "CView [MFC], OnDragEnter", "CView [MFC], OnDragLeave", "CView [MFC], OnDragOver", "CView [MFC], OnDragScroll", "CView [MFC], OnDrop", "CView [MFC], OnDropEx", "CView [MFC], OnInitialUpdate", "CView [MFC], OnPrepareDC", "CView [MFC], OnScroll", "CView [MFC], OnScrollBy", "CView [MFC], OnActivateFrame", "CView [MFC], OnActivateView", "CView [MFC], OnBeginPrinting", "CView [MFC], OnDraw", "CView [MFC], OnEndPrinting", "CView [MFC], OnEndPrintPreview", "CView [MFC], OnPreparePrinting", "CView [MFC], OnPrint", "CView [MFC], OnUpdate"] -ms.assetid: 9cff3c56-7564-416b-b9a4-71a9254ed755 --- # `CView` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the basic functionality for user-defined view classes. ## Syntax diff --git a/docs/mfc/reference/cvslistbox-class.md b/docs/mfc/reference/cvslistbox-class.md index 45cbc0e8068..68cf0b67cc9 100644 --- a/docs/mfc/reference/cvslistbox-class.md +++ b/docs/mfc/reference/cvslistbox-class.md @@ -4,10 +4,12 @@ title: "CVSListBox Class" ms.date: "11/19/2018" f1_keywords: ["CVSListBox", "AFXVSLISTBOX/CVSListBox", "AFXVSLISTBOX/CVSListBox::CVSListBox", "AFXVSLISTBOX/CVSListBox::AddItem", "AFXVSLISTBOX/CVSListBox::EditItem", "AFXVSLISTBOX/CVSListBox::GetCount", "AFXVSLISTBOX/CVSListBox::GetItemData", "AFXVSLISTBOX/CVSListBox::GetItemText", "AFXVSLISTBOX/CVSListBox::GetSelItem", "AFXVSLISTBOX/CVSListBox::RemoveItem", "AFXVSLISTBOX/CVSListBox::SelectItem", "AFXVSLISTBOX/CVSListBox::SetItemData", "AFXVSLISTBOX/CVSListBox::GetListHwnd"] helpviewer_keywords: ["CVSListBox [MFC], CVSListBox", "CVSListBox [MFC], AddItem", "CVSListBox [MFC], EditItem", "CVSListBox [MFC], GetCount", "CVSListBox [MFC], GetItemData", "CVSListBox [MFC], GetItemText", "CVSListBox [MFC], GetSelItem", "CVSListBox [MFC], RemoveItem", "CVSListBox [MFC], SelectItem", "CVSListBox [MFC], SetItemData", "CVSListBox [MFC], GetListHwnd"] -ms.assetid: c79be7b4-46ed-4af8-a41e-68962782d8ef --- # CVSListBox Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `CVSListBox` class supports an editable list control. ## Syntax diff --git a/docs/mfc/reference/cwaitcursor-class.md b/docs/mfc/reference/cwaitcursor-class.md index 7a62508db91..36fd2f3f99d 100644 --- a/docs/mfc/reference/cwaitcursor-class.md +++ b/docs/mfc/reference/cwaitcursor-class.md @@ -4,10 +4,12 @@ title: "CWaitCursor Class" ms.date: "11/04/2016" f1_keywords: ["CWaitCursor", "AFXWIN/CWaitCursor", "AFXWIN/CWaitCursor::CWaitCursor", "AFXWIN/CWaitCursor::Restore"] helpviewer_keywords: ["CWaitCursor [MFC], CWaitCursor", "CWaitCursor [MFC], Restore"] -ms.assetid: 5dfae2ff-d7b6-4383-b0ad-91e0868c67b3 --- # CWaitCursor Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides a one-line way to show a wait cursor, which is usually displayed as an hourglass, while you're doing a lengthy operation. ## Syntax diff --git a/docs/mfc/reference/cwinapp-class.md b/docs/mfc/reference/cwinapp-class.md index 7f45102a51a..977fe4b8cc9 100644 --- a/docs/mfc/reference/cwinapp-class.md +++ b/docs/mfc/reference/cwinapp-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CWinApp [MFC], CWinApp", "CWinApp [MFC], AddDocTemplate", --- # CWinApp Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The base class from which you derive a Windows application object. ## Syntax diff --git a/docs/mfc/reference/cwinappex-class.md b/docs/mfc/reference/cwinappex-class.md index 85b09877183..6ddbfc30372 100644 --- a/docs/mfc/reference/cwinappex-class.md +++ b/docs/mfc/reference/cwinappex-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CWinAppEx [MFC], CWinAppEx", "CWinAppEx [MFC], CleanState --- # `CWinAppEx` class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + `CWinAppEx` handles the application state, saves the state to the registry, loads the state from the registry, initializes application managers, and provides links to those same application managers. For more detail, see the source code located in the `mfc` folder of your Visual Studio installation. For example, `%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc`. diff --git a/docs/mfc/reference/cwindowdc-class.md b/docs/mfc/reference/cwindowdc-class.md index e27c7be752e..c47bff917d7 100644 --- a/docs/mfc/reference/cwindowdc-class.md +++ b/docs/mfc/reference/cwindowdc-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CWindowDC [MFC], CWindowDC", "CWindowDC [MFC], m_hWnd"] --- # CWindowDC Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Derived from `CDC`. ## Syntax diff --git a/docs/mfc/reference/cwinformscontrol-class.md b/docs/mfc/reference/cwinformscontrol-class.md index 78663935bdc..1d3e5e58e4a 100644 --- a/docs/mfc/reference/cwinformscontrol-class.md +++ b/docs/mfc/reference/cwinformscontrol-class.md @@ -4,10 +4,12 @@ title: "CWinFormsControl Class" ms.date: "11/04/2016" f1_keywords: ["CWinFormsControl", "AFXWINFORMS/CWinFormsControl", "AFXWINFORMS/CWinFormsControl::CWinFormsControl", "AFXWINFORMS/CWinFormsControl::CreateManagedControl", "AFXWINFORMS/CWinFormsControl::GetControl", "AFXWINFORMS/CWinFormsControl::GetControlHandle"] helpviewer_keywords: ["CWinFormsControl [MFC], CWinFormsControl", "CWinFormsControl [MFC], CreateManagedControl", "CWinFormsControl [MFC], GetControl", "CWinFormsControl [MFC], GetControlHandle"] -ms.assetid: 6406dd7b-fb89-4a18-ac3a-c010d6b6289a --- # CWinFormsControl Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the basic functionality for hosting of a Windows Forms control. ## Syntax diff --git a/docs/mfc/reference/cwinformsdialog-class.md b/docs/mfc/reference/cwinformsdialog-class.md index 89e9ab38315..f24797163f1 100644 --- a/docs/mfc/reference/cwinformsdialog-class.md +++ b/docs/mfc/reference/cwinformsdialog-class.md @@ -4,10 +4,12 @@ title: "CWinFormsDialog Class" ms.date: "03/27/2019" f1_keywords: ["CWinFormsDialog", "AFXWINFORMS/CWinFormsDialog", "AFXWINFORMS/CWinFormsDialog::CWinFormsDialog", "AFXWINFORMS/CWinFormsDialog::GetControl", "AFXWINFORMS/CWinFormsDialog::GetControlHandle", "AFXWINFORMS/CWinFormsDialog::OnInitDialog"] helpviewer_keywords: ["CWinFormsDialog [MFC], CWinFormsDialog", "CWinFormsDialog [MFC], GetControl", "CWinFormsDialog [MFC], GetControlHandle", "CWinFormsDialog [MFC], OnInitDialog"] -ms.assetid: e3cec000-a578-448e-b06a-8af256312f61 --- # CWinFormsDialog Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A wrapper for an MFC dialog class that hosts a Windows Forms user control. ## Syntax diff --git a/docs/mfc/reference/cwinformsview-class.md b/docs/mfc/reference/cwinformsview-class.md index 624a55aadff..549c6236de3 100644 --- a/docs/mfc/reference/cwinformsview-class.md +++ b/docs/mfc/reference/cwinformsview-class.md @@ -4,10 +4,12 @@ title: "CWinFormsView Class" ms.date: "11/04/2016" f1_keywords: ["CWinFormsView", "AFXWINFORMS/CWinFormsView", "AFXWINFORMS/CWinFormsView::CWinFormsView", "AFXWINFORMS/CWinFormsView::GetControl"] helpviewer_keywords: ["CWinFormsView [MFC], CWinFormsView", "CWinFormsView [MFC], GetControl"] -ms.assetid: d597e397-6529-469b-88f5-7f65a6b9e895 --- # CWinFormsView Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides generic functionality for hosting of a Windows Forms control as an MFC view. ## Syntax diff --git a/docs/mfc/reference/cwinthread-class.md b/docs/mfc/reference/cwinthread-class.md index 02e9bfbfa88..4cc52e29c7b 100644 --- a/docs/mfc/reference/cwinthread-class.md +++ b/docs/mfc/reference/cwinthread-class.md @@ -4,10 +4,12 @@ title: "CWinThread Class" ms.date: "11/04/2016" f1_keywords: ["CWinThread", "AFXWIN/CWinThread", "AFXWIN/CWinThread::CWinThread", "AFXWIN/CWinThread::CreateThread", "AFXWIN/CWinThread::ExitInstance", "AFXWIN/CWinThread::GetMainWnd", "AFXWIN/CWinThread::GetThreadPriority", "AFXWIN/CWinThread::InitInstance", "AFXWIN/CWinThread::IsIdleMessage", "AFXWIN/CWinThread::OnIdle", "AFXWIN/CWinThread::PostThreadMessage", "AFXWIN/CWinThread::PreTranslateMessage", "AFXWIN/CWinThread::ProcessMessageFilter", "AFXWIN/CWinThread::ProcessWndProcException", "AFXWIN/CWinThread::PumpMessage", "AFXWIN/CWinThread::ResumeThread", "AFXWIN/CWinThread::Run", "AFXWIN/CWinThread::SetThreadPriority", "AFXWIN/CWinThread::SuspendThread", "AFXWIN/CWinThread::m_bAutoDelete", "AFXWIN/CWinThread::m_hThread", "AFXWIN/CWinThread::m_nThreadID", "AFXWIN/CWinThread::m_pActiveWnd", "AFXWIN/CWinThread::m_pMainWnd"] helpviewer_keywords: ["CWinThread [MFC], CWinThread", "CWinThread [MFC], CreateThread", "CWinThread [MFC], ExitInstance", "CWinThread [MFC], GetMainWnd", "CWinThread [MFC], GetThreadPriority", "CWinThread [MFC], InitInstance", "CWinThread [MFC], IsIdleMessage", "CWinThread [MFC], OnIdle", "CWinThread [MFC], PostThreadMessage", "CWinThread [MFC], PreTranslateMessage", "CWinThread [MFC], ProcessMessageFilter", "CWinThread [MFC], ProcessWndProcException", "CWinThread [MFC], PumpMessage", "CWinThread [MFC], ResumeThread", "CWinThread [MFC], Run", "CWinThread [MFC], SetThreadPriority", "CWinThread [MFC], SuspendThread", "CWinThread [MFC], m_bAutoDelete", "CWinThread [MFC], m_hThread", "CWinThread [MFC], m_nThreadID", "CWinThread [MFC], m_pActiveWnd", "CWinThread [MFC], m_pMainWnd"] -ms.assetid: 10cdc294-4057-4e76-ac7c-a8967a89af0b --- # `CWinThread` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Represents a thread of execution within an application. ## Syntax diff --git a/docs/mfc/reference/cwnd-class.md b/docs/mfc/reference/cwnd-class.md index 37b4d19b134..40d6e732502 100644 --- a/docs/mfc/reference/cwnd-class.md +++ b/docs/mfc/reference/cwnd-class.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["CWnd [MFC], CWnd", "CWnd [MFC], accDoDefaultAction", "CWn --- # `CWnd` Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides the base functionality of all window classes in the Microsoft Foundation Class Library. ## Syntax diff --git a/docs/mfc/reference/cwordarray-class.md b/docs/mfc/reference/cwordarray-class.md index 76e6c6e25ab..52941cdfd84 100644 --- a/docs/mfc/reference/cwordarray-class.md +++ b/docs/mfc/reference/cwordarray-class.md @@ -4,10 +4,12 @@ title: "CWordArray Class" ms.date: "09/07/2019" f1_keywords: ["CWordArray", "AFXCOLL/CWordArray", "AFXCOLL/CWordArray::CWordArray", "AFXCOLL/CWordArray::Add", "AFXCOLL/CWordArray::Append", "AFXCOLL/CWordArray::Copy", "AFXCOLL/CWordArray::ElementAt", "AFXCOLL/CWordArray::FreeExtra", "AFXCOLL/CWordArray::GetAt", "AFXCOLL/CWordArray::GetCount", "AFXCOLL/CWordArray::GetData", "AFXCOLL/CWordArray::GetSize", "AFXCOLL/CWordArray::GetUpperBound", "AFXCOLL/CWordArray::InsertAt", "AFXCOLL/CWordArray::IsEmpty", "AFXCOLL/CWordArray::RemoveAll", "AFXCOLL/CWordArray::RemoveAt", "AFXCOLL/CWordArray::SetAt", "AFXCOLL/CWordArray::SetAtGrow", "AFXCOLL/CWordArray::SetSize"] helpviewer_keywords: ["CWordArray [MFC], CWordArray", "CWordArray [MFC], Add", "CWordArray [MFC], Append", "CWordArray [MFC], Copy", "CWordArray [MFC], ElementAt", "CWordArray [MFC], FreeExtra", "CWordArray [MFC], GetAt", "CWordArray [MFC], GetCount", "CWordArray [MFC], GetData", "CWordArray [MFC], GetSize", "CWordArray [MFC], GetUpperBound", "CWordArray [MFC], InsertAt", "CWordArray [MFC], IsEmpty", "CWordArray [MFC], RemoveAll", "CWordArray [MFC], RemoveAt", "CWordArray [MFC], SetAt", "CWordArray [MFC], SetAtGrow", "CWordArray [MFC], SetSize"] -ms.assetid: 2ba2c194-2c6c-40ff-9db4-e9dbe57e1f57 --- # CWordArray Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Supports arrays of 16-bit words. ## Syntax diff --git a/docs/mfc/reference/dao-database-engine-initialization-and-termination.md b/docs/mfc/reference/dao-database-engine-initialization-and-termination.md index 67e0826e34d..937431e7009 100644 --- a/docs/mfc/reference/dao-database-engine-initialization-and-termination.md +++ b/docs/mfc/reference/dao-database-engine-initialization-and-termination.md @@ -3,10 +3,12 @@ description: "Learn more about: DAO Database Engine Initialization and Terminati title: "DAO Database Engine Initialization and Termination" ms.date: "09/17/2019" helpviewer_keywords: ["DAO (Data Access Objects), termination", "DAO (Data Access Objects), initialization"] -ms.assetid: a7edf31c-e7c2-4f3e-aada-63c3e48781da --- # DAO Database Engine Initialization and Termination +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + DAO is used with Access databases and is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. When using MFC DAO objects, the DAO database engine must first be initialized and then terminated before your application or DLL quits. Two functions, `AfxDaoInit` and `AfxDaoTerm`, perform these tasks. ### DAO Database Engine Initialization and Termination diff --git a/docs/mfc/reference/data-types-mfc.md b/docs/mfc/reference/data-types-mfc.md index 9893062dab9..d8c7488a1cb 100644 --- a/docs/mfc/reference/data-types-mfc.md +++ b/docs/mfc/reference/data-types-mfc.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["LPCRECT data type [MFC]", "WPARAM data type [MFC]", "data --- # Data Types (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic lists the data types most commonly used in the Microsoft Foundation Class (MFC) Library. Most of the data types are the same as those in the Platform Software Development Kit (SDK), while others are unique to MFC. For information about the data types used in both the Windows SDK and MFC, see [Windows Data Types](/windows/win32/WinProg/windows-data-types). diff --git a/docs/mfc/reference/database-macros-and-globals.md b/docs/mfc/reference/database-macros-and-globals.md index 0a51a55db66..b210e2a8037 100644 --- a/docs/mfc/reference/database-macros-and-globals.md +++ b/docs/mfc/reference/database-macros-and-globals.md @@ -4,10 +4,12 @@ title: "Database Macros and Globals" ms.date: "11/04/2016" f1_keywords: ["AFXDB/AFX_ODBC_CALL", "AFXDB/AFX_SQL_ASYNC", "AFXDB/AFX_SQL_SYNC", "AFXDB/AfxGetHENV"] helpviewer_keywords: ["global database functions [MFC]", "database macros [MFC]", "database globals [MFC]", "global functions [MFC], database functions", "macros [MFC], MFC database"] -ms.assetid: 5b9b9e61-1cf9-4345-9f29-3807dd466488 --- # Database Macros and Globals +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The macros and globals listed below apply to ODBC-based database applications. They are not used with DAO-based applications. Before MFC 4.2, the macros `AFX_SQL_ASYNC` and `AFX_SQL_SYNC` gave asynchronous operations an opportunity to yield time to other processes. Beginning with MFC 4.2, the implementation of these macros changed because the MFC ODBC classes used only synchronous operations. The macro `AFX_ODBC_CALL` was new to MFC 4.2. diff --git a/docs/mfc/reference/database-support-mfc-application-wizard.md b/docs/mfc/reference/database-support-mfc-application-wizard.md index 8430be65389..317ec1832c8 100644 --- a/docs/mfc/reference/database-support-mfc-application-wizard.md +++ b/docs/mfc/reference/database-support-mfc-application-wizard.md @@ -4,10 +4,12 @@ title: "Database Support, MFC Application Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.exe.database"] helpviewer_keywords: ["MFC Application Wizard, database support"] -ms.assetid: 9ddf4558-fd41-4ac7-8d9b-c93d9c68ab59 --- # Database Support, MFC Application Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This page provides options that allow you to specify the level of database support (plus a data source, if necessary) for your project. - **Database support** diff --git a/docs/mfc/reference/ddx-dhtml-helper-macros.md b/docs/mfc/reference/ddx-dhtml-helper-macros.md index cc1d4e7bebf..597dbbc19ab 100644 --- a/docs/mfc/reference/ddx-dhtml-helper-macros.md +++ b/docs/mfc/reference/ddx-dhtml-helper-macros.md @@ -4,10 +4,12 @@ title: "DDX_DHtml Helper Macros" ms.date: "11/04/2016" f1_keywords: ["AFXDHTML/DDX_DHtml_ElementValue", "AFXDHTML/DDX_DHtml_ElementInnerText", "AFXDHTML/DDX_DHtml_ElementInnerHtml", "AFXDHTML/DDX_DHtml_Anchor_Href", "AFXDHTML/DDX_DHtml_Anchor_Target", "AFXDHTML/DDX_DHtml_Img_Src", "AFXDHTML/DDX_DHtml_Frame_Src", "AFXDHTML/DDX_DHtml_IFrame_Src"] helpviewer_keywords: ["macros [MFC], exchanging data with HMTL pages", "DDX macros [MFC]", "HTML pages [MFC], helper macros", "DDX (dialog data exchange), DHtml helper macros", "macros [MFC], DDX_DHtml helpers"] -ms.assetid: c46302d2-ea43-4fea-bfc2-6f590d99f267 --- # DDX_DHtml Helper Macros +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The DDX_DHtml helper macros allow easy access to the commonly used properties of controls on an HTML page. ### Data Exchange Macros diff --git a/docs/mfc/reference/declaring-a-variable-based-on-your-new-control-class.md b/docs/mfc/reference/declaring-a-variable-based-on-your-new-control-class.md index d911fb2a338..9d0cd90dd1f 100644 --- a/docs/mfc/reference/declaring-a-variable-based-on-your-new-control-class.md +++ b/docs/mfc/reference/declaring-a-variable-based-on-your-new-control-class.md @@ -4,10 +4,12 @@ title: "Declaring a Variable Based on Your New Control Class" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.classes.control.variable"] helpviewer_keywords: ["variables [MFC], control classes", "control classes [MFC], variables", "classes [MFC], declaring variables based on"] -ms.assetid: 5722dc38-c0eb-40bd-93da-67a808140d03 --- # Declaring a Variable Based on Your New Control Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Once you have created an MFC control class, you can declare a variable based on it. To provide a context for the new variable, you must open the dialog editor and edit the dialog box in which you want to use your reusable control. Also, the dialog box must already have a class associated with it. For information on using the dialog editor, see [Dialog Editor](../../windows/dialog-editor.md). ### To declare a variable based on your reusable class diff --git a/docs/mfc/reference/defining-a-message-handler-for-a-reflected-message.md b/docs/mfc/reference/defining-a-message-handler-for-a-reflected-message.md index 7e3b2efc820..cc57d41b8b6 100644 --- a/docs/mfc/reference/defining-a-message-handler-for-a-reflected-message.md +++ b/docs/mfc/reference/defining-a-message-handler-for-a-reflected-message.md @@ -4,10 +4,12 @@ title: "Defining a Message Handler for a Reflected Message" ms.date: "09/07/2019" f1_keywords: ["vc.codewiz.defining.msg.msghandler"] helpviewer_keywords: ["messages [MFC], reflected", "message handling [MFC], reflected messages"] -ms.assetid: 5a403528-58c5-46e7-90d5-4a77f0ab9b9c --- # Defining a Message Handler for a Reflected Message +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Once you have created a new MFC control class, you can define message handlers for it. Reflected message handlers allow your control class to handle its own messages before the message is received by the parent. You can use the MFC [CWnd::SendMessage](../../mfc/reference/cwnd-class.md#sendmessage) function to send messages from your control to a parent window. With this functionality you could, for example, create a list box that will redraw itself rather than relying on the parent window to do so (owner drawn). For more information on reflected messages, see [Handling Reflected Messages](../../mfc/handling-reflected-messages.md). diff --git a/docs/mfc/reference/delegate-and-interface-maps.md b/docs/mfc/reference/delegate-and-interface-maps.md index 518e659915c..2aa03516318 100644 --- a/docs/mfc/reference/delegate-and-interface-maps.md +++ b/docs/mfc/reference/delegate-and-interface-maps.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["delegate map macros [MFC]", "event map macros [MFC]", "in --- # Delegate and interface map macros +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC supports these macros for delegate and interface maps: |Name|Description| diff --git a/docs/mfc/reference/details-of-atl-support-added-by-the-atl-wizard.md b/docs/mfc/reference/details-of-atl-support-added-by-the-atl-wizard.md index 75372cba8f4..938589b2b95 100644 --- a/docs/mfc/reference/details-of-atl-support-added-by-the-atl-wizard.md +++ b/docs/mfc/reference/details-of-atl-support-added-by-the-atl-wizard.md @@ -4,13 +4,16 @@ title: "Details of ATL Support Added by the ATL Wizard" ms.date: "08/20/2019" f1_keywords: ["vc.codewiz.atl.support"] helpviewer_keywords: ["MFC, ATL support", "ATL, MFC projects"] -ms.assetid: aa66bad0-008f-4886-94c1-2a0a0d04bce4 --- + # Details of ATL Support Added by the ATL Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library and Active Template Library (ATL) continue to be supported. However, we're no longer adding features or updating the documentation. + ::: moniker range=">=msvc-160" -When you [add ATL support to an existing MFC executable or DLL](../../mfc/reference/adding-atl-support-to-your-mfc-project.md), Visual Studio adds a header file called *framework.h* by default, which contains `#include` and `#define` preprocessor directives to enable the use of ATL in your project. No additional files or classes are added, as was done in previous versions of Visual Studio. +When you [add ATL support to an existing MFC executable or DLL](../../mfc/reference/adding-atl-support-to-your-mfc-project.md), Visual Studio adds a header file called `framework.h` by default, which contains `#include` and `#define` preprocessor directives to enable the use of ATL in your project. No additional files or classes are added, as was done in previous versions of Visual Studio. ::: moniker-end diff --git a/docs/mfc/reference/dhtml-editing-command-maps.md b/docs/mfc/reference/dhtml-editing-command-maps.md index 817b045cfc7..eb8672332d6 100644 --- a/docs/mfc/reference/dhtml-editing-command-maps.md +++ b/docs/mfc/reference/dhtml-editing-command-maps.md @@ -2,10 +2,12 @@ description: "Learn more about: DHTML Editing Command Maps" title: "DHTML Editing Command Maps" ms.date: "11/04/2016" -ms.assetid: c1b49876-039e-4a26-bb24-ea98ccf254a1 --- # DHTML Editing Command Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following macros can be used to map DHTML editing commands in [CHtmlEditView](../../mfc/reference/chtmleditview-class.md)-derived classes. For an example of their use, see [HTMLEdit Sample](../../overview/visual-cpp-samples.md). ### DHTML Editing Command Map Macros diff --git a/docs/mfc/reference/dhtml-event-maps.md b/docs/mfc/reference/dhtml-event-maps.md index b613eca890f..edc049eefaa 100644 --- a/docs/mfc/reference/dhtml-event-maps.md +++ b/docs/mfc/reference/dhtml-event-maps.md @@ -4,10 +4,12 @@ title: "DHTML Event Maps" ms.date: "11/04/2016" f1_keywords: ["vc.macros.shared"] helpviewer_keywords: ["event map macros [MFC]", "DHTML [MFC], event map macros", "macros [MFC], DHTML event map", "DHTML events [MFC], event map", "DHTML events [MFC]"] -ms.assetid: 9a2c8ae7-7216-4a5e-bc60-6b98695be0c6 --- # DHTML Event Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following macros can be used to handle DHTML events. ## DHTML Event Map Macros diff --git a/docs/mfc/reference/dhtmlurleventmapentry-structure.md b/docs/mfc/reference/dhtmlurleventmapentry-structure.md index 2664dadb6f2..d1b3181f822 100644 --- a/docs/mfc/reference/dhtmlurleventmapentry-structure.md +++ b/docs/mfc/reference/dhtmlurleventmapentry-structure.md @@ -4,10 +4,12 @@ title: "DHtmlUrlEventMapEntry Structure" ms.date: "11/04/2016" f1_keywords: ["DHtmlUrlEventMapEntry"] helpviewer_keywords: ["DHtmlUrlEventMapEntry structure [MFC]"] -ms.assetid: 43117c1f-1a51-406c-aa2f-fea647080049 --- # DHtmlUrlEventMapEntry Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The `DHtmlUrlEventMapEntry` structure provides multi-URL event map support. ## Syntax diff --git a/docs/mfc/reference/diagnostic-services.md b/docs/mfc/reference/diagnostic-services.md index 18c273ec9e0..afc822dd261 100644 --- a/docs/mfc/reference/diagnostic-services.md +++ b/docs/mfc/reference/diagnostic-services.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["diagnosi [MFC]s, diagnostic services", "diagnostic macros --- # Diagnostic Services +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class Library supplies many diagnostic services that make debugging your programs easier. These diagnostic services include macros and global functions that allow you to track your program's memory allocations, dump the contents of objects during run time, and print debugging messages during run time. The macros and global functions for diagnostic services are grouped into the following categories: - General diagnostic macros @@ -395,7 +398,7 @@ CDumpContext afxDump; `afxDump` is a predefined [CDumpContext](../../mfc/reference/cdumpcontext-class.md) object that allows you to send `CDumpContext` information to the debugger output window or to a debug terminal. Typically, you supply `afxDump` as a parameter to `CObject::Dump`. -Under Windows NT and all versions of Windows, `afxDump` output is sent to the Output-Debug window of Visual C++ when you debug your application. +Under Windows NT and all versions of Windows, `afxDump` output is sent to the Output-Debug window of Visual Studio when you debug your application. This variable is defined only in the Debug version of MFC. For more information on `afxDump`, see [Debugging MFC Applications](/visualstudio/debugger/mfc-debugging-techniques). diff --git a/docs/mfc/reference/dialog-data-exchange-functions-for-crecordview-and-cdaorecordview.md b/docs/mfc/reference/dialog-data-exchange-functions-for-crecordview-and-cdaorecordview.md index 06e79c9647e..c9544270702 100644 --- a/docs/mfc/reference/dialog-data-exchange-functions-for-crecordview-and-cdaorecordview.md +++ b/docs/mfc/reference/dialog-data-exchange-functions-for-crecordview-and-cdaorecordview.md @@ -4,10 +4,12 @@ title: "Dialog Data Exchange Functions for CRecordView and CDaoRecordView" ms.date: "09/17/2019" f1_keywords: ["AFXDAO/DDX_FieldCBIndex", "AFXDAO/DDX_FieldCBString", "AFXDAO/DDX_FieldCBStringExact", "AFXDAO/DDX_FieldCheck", "AFXDAO/DDX_FieldLBIndex", "AFXDAO/DDX_FieldLBString", "AFXDAO/DDX_FieldLBStringExact", "AFXDAO/DDX_FieldRadio", "AFXDAO/DDX_FieldScroll", "AFXDAO/DDX_FieldText"] helpviewer_keywords: ["DDX_Field functions [MFC]", "ODBC [MFC], dialog data exchange (DDX) support", "DDX (dialog data exchange) [MFC], database support", "DDX (dialog data exchange) [MFC], functions", "databases [MFC], dialog data exchange (DDX) support", "DAO [MFC], dialog data exchange (DDX) support"] -ms.assetid: 0d8cde38-3a2c-4100-9589-ac80a7b1ce91 --- # Dialog Data Exchange Functions for CRecordView and CDaoRecordView +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic lists the DDX_Field functions used to exchange data between a [CRecordset](../../mfc/reference/crecordset-class.md) and a [CRecordView](../../mfc/reference/crecordview-class.md) form or a [CDaoRecordset](../../mfc/reference/cdaorecordset-class.md) and a [CDaoRecordView](../../mfc/reference/cdaorecordview-class.md) form. DAO is used with Access databases and is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. > [!NOTE] diff --git a/docs/mfc/reference/dialog-data-exchange-functions-for-ole-controls.md b/docs/mfc/reference/dialog-data-exchange-functions-for-ole-controls.md index 7df654e2812..35eba789e94 100644 --- a/docs/mfc/reference/dialog-data-exchange-functions-for-ole-controls.md +++ b/docs/mfc/reference/dialog-data-exchange-functions-for-ole-controls.md @@ -4,10 +4,12 @@ title: "Dialog Data Exchange Functions for OLE Controls" ms.date: "11/04/2016" f1_keywords: ["AFXDISP/DDX_OCBool", "AFXDISP/DDX_OCBoolRO", "AFXDISP/DDX_OCColor", "AFXDISP/DDX_OCColorRO", "AFXDISP/DDX_OCFloat", "AFXDISP/DDX_OCFloatRO", "AFXDISP/DDX_OCInt", "AFXDISP/DDX_OCIntRO", "AFXDISP/DDX_OCShort", "AFXDISP/DDX_OCShortRO", "AFXDISP/DDX_OCText", "AFXDISP/DDX_OCTextRO"] helpviewer_keywords: ["OLE controls [MFC], DDX functions", "DDX (dialog data exchange), OLE support"] -ms.assetid: 7ef1f288-ff65-40d4-aad2-5497bc00bb27 --- # Dialog Data Exchange Functions for OLE Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic lists the DDX_OC functions used to exchange data between a property of an OLE control in a dialog box, form view, or control view object and a data member of the dialog box, form view, or control view object. ### DDX_OC Functions diff --git a/docs/mfc/reference/dispatch-maps.md b/docs/mfc/reference/dispatch-maps.md index 571218e9715..9d7c82dd749 100644 --- a/docs/mfc/reference/dispatch-maps.md +++ b/docs/mfc/reference/dispatch-maps.md @@ -3,10 +3,12 @@ description: "Learn more about: Dispatch Maps" title: "Dispatch Maps" ms.date: "06/20/2018" helpviewer_keywords: ["dispatch maps [MFC], macros", "dispatch maps [MFC]", "dispatch map macros [MFC]"] -ms.assetid: bef9d08b-ad35-4c3a-99d8-04150c7c04e2 --- # Dispatch Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + OLE Automation provides ways to call methods and to access properties across applications. The mechanism supplied by the Microsoft Foundation Class Library for dispatching these requests is the "dispatch map," which designates the internal and external names of object functions and properties, as well as the data types of the properties themselves and of function arguments. |Dispatch map macro|Description| diff --git a/docs/mfc/reference/document-template-strings-mfc-application-wizard.md b/docs/mfc/reference/document-template-strings-mfc-application-wizard.md index 29c42ee91a8..6cb67bac734 100644 --- a/docs/mfc/reference/document-template-strings-mfc-application-wizard.md +++ b/docs/mfc/reference/document-template-strings-mfc-application-wizard.md @@ -4,10 +4,12 @@ title: "Document Template Strings, MFC Application Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.exe.doctemp"] helpviewer_keywords: ["MFC Application Wizard, document template strings"] -ms.assetid: 8109f662-3182-4682-977a-2503321c678a --- # Document Template Strings, MFC Application Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In this page of the MFC Application Wizard, provide or refine the following options to help with document management and localization. Document template strings are available for applications that include **Document/view architecture support** in the [Application Type](../../mfc/reference/application-type-mfc-application-wizard.md). They are not available for dialog boxes. Because most document template strings are visible and used by the application's users, they are localized into the **Resource language** indicated in the **Application Type** page of the wizard. - **Nonlocalized strings** diff --git a/docs/mfc/reference/edit-control-handlers.md b/docs/mfc/reference/edit-control-handlers.md index 4fc2ee2591c..4b33390e216 100644 --- a/docs/mfc/reference/edit-control-handlers.md +++ b/docs/mfc/reference/edit-control-handlers.md @@ -4,10 +4,12 @@ title: "Edit Control Handlers" ms.date: "11/04/2016" f1_keywords: ["ON_EN_ERRSPACE", "ON_EN_UPDATE", "ON_EN_VSCROLL", "ON_EN_HSCROLL", "ON_EN_KILLFOCUS", "ON_EN_MAXTEXT", "ON_EN_SETFOCUS", "ON_EN_CHANGE"] helpviewer_keywords: ["ON_EN_ERRSPACE macro [MFC]", "ON_EN_SETFOCUS macro [MFC]", "ON_EN_UPDATE macro [MFC]", "ON_EN_MAXTEXT macro [MFC]", "ON_EN_CHANGE macro [MFC]", "ON_EN_HSCROLL macro [MFC]", "ON_EN_VSCROLL macro [MFC]", "ON_EN_KILLFOCUS macro [MFC]", "edit controls [MFC], edit control handlers"] -ms.assetid: 55b88b5e-12b5-4422-b03e-c8c2f27d095c --- # Edit Control Handlers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries correspond to the function prototype. |Map entry|Function prototype| diff --git a/docs/mfc/reference/editing-a-message-handler.md b/docs/mfc/reference/editing-a-message-handler.md index 17f1783f009..e54b6e9322e 100644 --- a/docs/mfc/reference/editing-a-message-handler.md +++ b/docs/mfc/reference/editing-a-message-handler.md @@ -4,10 +4,12 @@ title: "Editing a Message Handler" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.editing.msghandler"] helpviewer_keywords: ["message handlers [MFC]", "message handling [MFC], editing handlers"] -ms.assetid: 7babb496-1f14-43b1-a14d-2e54402a92e2 --- # Editing a Message Handler +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Once you have defined a message handler, you can go to the member function's definition to add or modify code. To jump to a member function definition from the [dialog editor](../../windows/dialog-editor.md), double-click a control for which a handler is already defined. This navigates you to the file in which the selected control's message handler is defined. diff --git a/docs/mfc/reference/event-maps.md b/docs/mfc/reference/event-maps.md index 2766a3a56a5..b6392f23e83 100644 --- a/docs/mfc/reference/event-maps.md +++ b/docs/mfc/reference/event-maps.md @@ -3,10 +3,12 @@ description: "Learn more about: Event Maps" title: "Event Maps" ms.date: "09/07/2019" helpviewer_keywords: ["event maps [MFC]"] -ms.assetid: 1ed53aee-bc53-43cd-834a-6fb935c0d29b --- # Event Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Whenever a control wishes to notify its container that some action (determined by the control developer) has happened (such as a keystroke, mouse click, or a change to the control's state) it calls an event-firing function. This function notifies the control container that some important action has occurred by firing the related event. The Microsoft Foundation Class Library offers a programming model optimized for firing events. In this model, "event maps" are used to designate which functions fire which events for a particular control. Event maps contain one macro for each event. For example, an event map that fires a stock Click event might look like this: diff --git a/docs/mfc/reference/event-sink-maps.md b/docs/mfc/reference/event-sink-maps.md index e1475a88c77..d4dad8707fc 100644 --- a/docs/mfc/reference/event-sink-maps.md +++ b/docs/mfc/reference/event-sink-maps.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["event sink maps [MFC]"] --- # Event Sink Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When an embedded OLE control fires an event, the control's container receives the event using a mechanism, called an "event sink map," supplied by MFC. This event sink map designates handler functions for each specific event, as well as parameters of those events. For more information on event sink maps, see the article [ActiveX Control Containers](../../mfc/activex-control-containers.md). ### Event Sink Maps diff --git a/docs/mfc/reference/exception-processing.md b/docs/mfc/reference/exception-processing.md index cd5e64b1d63..687a470c9c4 100644 --- a/docs/mfc/reference/exception-processing.md +++ b/docs/mfc/reference/exception-processing.md @@ -3,10 +3,12 @@ description: "Learn more about: Exception Processing" title: "Exception Processing" ms.date: "11/04/2016" helpviewer_keywords: ["macros [MFC], exception handling", "DAO (Data Access Objects), exceptions [MFC]", "OLE exceptions [MFC], MFC functions", "exceptions [MFC], processing", "exception macros [MFC]", "termination functions, MFC", "MFC, exceptions", "exceptions [MFC], MFC throwing functions"] -ms.assetid: 26d4457c-8350-48f5-916e-78f919787c30 --- # Exception Processing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When a program executes, a number of abnormal conditions and errors called "exceptions" can occur. These may include running out of memory, resource allocation errors, and failure to find files. The Microsoft Foundation Class Library uses an exception-handling scheme that is modeled closely after the one proposed by the ANSI standards committee for C++. An exception handler must be set up before calling a function that may encounter an abnormal situation. If the function encounters an abnormal condition, it throws an exception and control is passed to the exception handler. diff --git a/docs/mfc/reference/extension-dll-macros.md b/docs/mfc/reference/extension-dll-macros.md index a3682634f71..548496d62fa 100644 --- a/docs/mfc/reference/extension-dll-macros.md +++ b/docs/mfc/reference/extension-dll-macros.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["module macros in MFC"] --- # Macros and functions for managing DLLs +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + | Name | Description | |--|--| | [`AFX_EXT_CLASS`](#afx_ext_class)] | Exports classes. | diff --git a/docs/mfc/reference/generated-classes-mfc-application-wizard.md b/docs/mfc/reference/generated-classes-mfc-application-wizard.md index 7bdcfd54455..de59480ba26 100644 --- a/docs/mfc/reference/generated-classes-mfc-application-wizard.md +++ b/docs/mfc/reference/generated-classes-mfc-application-wizard.md @@ -4,10 +4,12 @@ title: "Generated Classes, MFC Application Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.exe.classes"] helpviewer_keywords: ["MFC Application Wizard, generated classes"] -ms.assetid: 5f33209c-7f01-4f72-8c1c-6f02f507ba9f --- # Generated Classes, MFC Application Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic lists the names of base classes and files that your project generates. By default, the names are based on the project name that you specified in the **New Project Dialog Box**. You can change most of these names, as described here: - **Generated classes** diff --git a/docs/mfc/reference/generic-control-handler.md b/docs/mfc/reference/generic-control-handler.md index 7006c0d77b3..37f27818fa9 100644 --- a/docs/mfc/reference/generic-control-handler.md +++ b/docs/mfc/reference/generic-control-handler.md @@ -3,10 +3,12 @@ description: "Learn more about: Generic Control Handler" title: "Generic Control Handler" ms.date: "11/04/2016" helpviewer_keywords: ["handlers [MFC], ON_CONTROL", "handlers [MFC]", "GenericControl Handler [MFC]", "ON_CONTROL macro [MFC]"] -ms.assetid: 1e25e583-5d5a-4363-8904-839991a8570d --- # Generic Control Handler +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entry corresponds to the function prototype. |Map entry|Function prototype| diff --git a/docs/mfc/reference/gray-and-dithered-bitmap-functions.md b/docs/mfc/reference/gray-and-dithered-bitmap-functions.md index d2d80261f07..4d33b4f498a 100644 --- a/docs/mfc/reference/gray-and-dithered-bitmap-functions.md +++ b/docs/mfc/reference/gray-and-dithered-bitmap-functions.md @@ -4,10 +4,12 @@ title: "Gray and Dithered Bitmap Functions" ms.date: "11/19/2018" f1_keywords: ["AFXWIN/AfxDrawGrayBitmap", "AFXWIN/AfxGetGrayBitmap", "AFXWIN/AfxDrawDitheredBitmap", "AFXWIN/AfxGetDitheredBitmap"] helpviewer_keywords: ["gray and dithered bitmap functions [MFC]"] -ms.assetid: cb139a77-b85e-4504-9d93-24156ad77a41 --- # Gray and Dithered Bitmap Functions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + **Gray Bitmap Functions** MFC provides two functions for giving a bitmap the appearance of a disabled control. diff --git a/docs/mfc/reference/handlers-for-wm-messages.md b/docs/mfc/reference/handlers-for-wm-messages.md index eb656fb8f76..a562529cbd9 100644 --- a/docs/mfc/reference/handlers-for-wm-messages.md +++ b/docs/mfc/reference/handlers-for-wm-messages.md @@ -3,10 +3,12 @@ description: "Learn more about: Handlers for WM_ Messages" title: "Handlers for WM_ Messages" ms.date: "11/04/2016" helpviewer_keywords: ["WM_ messages [MFC]"] -ms.assetid: cad81690-90bf-4f77-943f-a435e7563bdd --- # Handlers for WM_ Messages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following topics correspond to the map entries. |Topic|Map entries| diff --git a/docs/mfc/reference/how-to-use-the-message-map-cross-reference.md b/docs/mfc/reference/how-to-use-the-message-map-cross-reference.md index 8141dd49521..b93284c67e1 100644 --- a/docs/mfc/reference/how-to-use-the-message-map-cross-reference.md +++ b/docs/mfc/reference/how-to-use-the-message-map-cross-reference.md @@ -3,10 +3,12 @@ description: "Learn more about: How to: Use the Message-Map Cross-Reference" title: "How to: Use the Message-Map Cross-Reference" ms.date: "11/04/2016" helpviewer_keywords: ["windows [MFC], message maps"] -ms.assetid: 2e863d23-9e58-45ba-b5e4-a8ceefccd0c8 --- # How to: Use the Message-Map Cross-Reference +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In entries labeled \, write your own member function for a derived [CWnd](../../mfc/reference/cwnd-class.md) class. Give your function any name you like. Other functions, such as `OnActivate`, are member functions of class `CWnd`. If called, they pass the message to the `DefWindowProc` Windows function. To process Windows notification messages, override the corresponding `CWnd` function in your derived class. Your function should call the overridden function in your base class to let the base class and Windows respond to the message. In all cases, put the function prototype in the `CWnd`-derived class header, and code the message map entry as shown. diff --git a/docs/mfc/reference/hse-version-info-structure.md b/docs/mfc/reference/hse-version-info-structure.md index 3917f359172..30cb155cdac 100644 --- a/docs/mfc/reference/hse-version-info-structure.md +++ b/docs/mfc/reference/hse-version-info-structure.md @@ -4,10 +4,12 @@ title: "HSE_VERSION_INFO Structure" ms.date: "11/04/2016" f1_keywords: ["HSE_VERSION_INFO"] helpviewer_keywords: ["HSE_VERSION_INFO structure [MFC]"] -ms.assetid: 4837312d-68c8-4d05-9afa-1934d7d49b20 --- # HSE_VERSION_INFO Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This structure is pointed to by the *pVer* parameter in the `CHttpServer::GetExtensionVersion` member function. It provides the ISA version number and a text description of the ISA. ## Syntax diff --git a/docs/mfc/reference/icommandsource-interface.md b/docs/mfc/reference/icommandsource-interface.md index 80fd3391887..b5499c10a48 100644 --- a/docs/mfc/reference/icommandsource-interface.md +++ b/docs/mfc/reference/icommandsource-interface.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["ICommandSource interface [MFC]"] --- # ICommandSource Interface +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages commands sent from a command source object to a user control. ## Syntax diff --git a/docs/mfc/reference/icommandtarget-interface.md b/docs/mfc/reference/icommandtarget-interface.md index 95e3b7d45b8..5d5d07a167a 100644 --- a/docs/mfc/reference/icommandtarget-interface.md +++ b/docs/mfc/reference/icommandtarget-interface.md @@ -4,10 +4,12 @@ title: "ICommandTarget Interface" ms.date: "11/04/2016" f1_keywords: ["ICommandTarget", "AFXWINFORMS/ICommandTarget", "AFXWINFORMS/ICommandTarget::Initialize"] helpviewer_keywords: ["ICommandTarget interface [MFC]"] -ms.assetid: dd9927f6-3479-4e7c-8ef9-13206cf901f3 --- # ICommandTarget Interface +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Provides a user control with an interface to receive commands from a command source object. ## Syntax diff --git a/docs/mfc/reference/icommandui-interface.md b/docs/mfc/reference/icommandui-interface.md index 8e4e7726a6b..c2bc8e659ea 100644 --- a/docs/mfc/reference/icommandui-interface.md +++ b/docs/mfc/reference/icommandui-interface.md @@ -4,10 +4,12 @@ title: "ICommandUI Interface" ms.date: "09/07/2019" f1_keywords: ["ICommandUI", "AFXWINFORMS/ICommandUI", "AFXWINFORMS/icommandui__Check", "AFXWINFORMS/ICommandUI::ContinueRouting", "AFXWINFORMS/ICommandUI::Enabled", "AFXWINFORMS/ICommandUI::ID", "AFXWINFORMS/ICommandUI::Index", "AFXWINFORMS/ICommandUI::Radio", "AFXWINFORMS/ICommandUI::Text"] helpviewer_keywords: ["ICommandUI interface [MFC]"] -ms.assetid: 134afe8d-dcdf-47ca-857a-a166a6b665dd --- # ICommandUI Interface +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Manages user interface commands. ## Syntax diff --git a/docs/mfc/reference/internal-classes.md b/docs/mfc/reference/internal-classes.md index 09282b431ff..ceb3619df8e 100644 --- a/docs/mfc/reference/internal-classes.md +++ b/docs/mfc/reference/internal-classes.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["UpdateTabs method [MFC]", "Start method [MFC]", "IsLast m --- # Internal Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following classes are used internally in MFC. For completeness, this section describes these internal classes, but they aren't intended to be used directly in your code. ## In This Section diff --git a/docs/mfc/reference/internet-url-parsing-globals.md b/docs/mfc/reference/internet-url-parsing-globals.md index d87c5d1798e..053844d9984 100644 --- a/docs/mfc/reference/internet-url-parsing-globals.md +++ b/docs/mfc/reference/internet-url-parsing-globals.md @@ -3,10 +3,12 @@ description: "Learn more about: Internet URL Parsing Globals and Helpers" title: "Internet URL Parsing Globals and Helpers" ms.date: "04/03/2017" helpviewer_keywords: ["parsing, URLs", "URLs, parsing"] -ms.assetid: 46c6384f-e4a6-4dbd-9196-219c19040ec5 --- # Internet URL Parsing Globals and Helpers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When a client sends a query to the Internet server, you can use one of the URL parsing globals to extract information about the client. The helper functions provide other internet functionality. ## Internet URL Parsing Globals diff --git a/docs/mfc/reference/iview-interface.md b/docs/mfc/reference/iview-interface.md index 0cd40802b71..af902350ca1 100644 --- a/docs/mfc/reference/iview-interface.md +++ b/docs/mfc/reference/iview-interface.md @@ -4,10 +4,12 @@ title: "IView Interface" ms.date: "11/04/2016" f1_keywords: ["IView", "AFXWINFORMS/IView", "AFXWINFORMS/IView::OnActivateView", "AFXWINFORMS/IView::OnInitialUpdate", "AFXWINFORMS/IView::OnUpdate"] helpviewer_keywords: ["views [MFC]", "IView class [MFC]", "views [MFC], classes"] -ms.assetid: 9321f299-486e-4551-bee9-d2c4a7b91548 --- # IView Interface +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Implements several methods that [CWinFormsView](../../mfc/reference/cwinformsview-class.md) uses to send view notifications to a managed control. ## Syntax diff --git a/docs/mfc/reference/list-box-handlers.md b/docs/mfc/reference/list-box-handlers.md index 6563a51a716..f331b682812 100644 --- a/docs/mfc/reference/list-box-handlers.md +++ b/docs/mfc/reference/list-box-handlers.md @@ -4,10 +4,12 @@ title: "List Box Handlers" ms.date: "11/04/2016" f1_keywords: ["ON_LBN_DBLCLK", "ON_LBN_ERRSPACE", "ON_LBN_SETFOCUS", "ON_LBN_SELCHANGE", "ON_LBN_KILLFOCUS"] helpviewer_keywords: ["list boxes [MFC], list box handlers", "ON_LBN_KILLFOCUS", "ON_LBN_ERRSPACE", "ON_LBN_SELCHANGE", "ON_LBN_SETFOCUS", "ON_LBN_DBLCLK"] -ms.assetid: e4e54412-2167-436a-883b-5dcad01820b8 --- # List Box Handlers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries have the corresponding function prototype. |Map entry|Function prototype| diff --git a/docs/mfc/reference/mapping-messages-to-functions.md b/docs/mfc/reference/mapping-messages-to-functions.md index 6121a62bd33..5331cb8cc67 100644 --- a/docs/mfc/reference/mapping-messages-to-functions.md +++ b/docs/mfc/reference/mapping-messages-to-functions.md @@ -4,10 +4,12 @@ title: "Mapping Messages to Functions" ms.date: "09/06/2019" f1_keywords: ["vc.codewiz.mapping.msg.function"] helpviewer_keywords: ["Windows messages [MFC], adding message handlers", "message maps [MFC], mapping messages to functions"] -ms.assetid: a7727a62-f638-4b20-b7f5-131f47200d6a --- # Mapping Messages to Functions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [Class Wizard](mfc-class-wizard.md) enables you to bind message handlers (member functions of MFC user-interface classes) to the messages generated by your application's resources. They use [MFC message maps](../../mfc/messages-and-commands-in-the-framework.md) to create the binding. When you use Class View to create a new class derived from one of the framework classes, it automatically places a complete and functional class in the header (.h) and implementation (.cpp) files that you specify. diff --git a/docs/mfc/reference/message-map-macros-mfc.md b/docs/mfc/reference/message-map-macros-mfc.md index f2739a164d2..8b21fa4fa91 100644 --- a/docs/mfc/reference/message-map-macros-mfc.md +++ b/docs/mfc/reference/message-map-macros-mfc.md @@ -4,10 +4,12 @@ title: "Message Map Macros (MFC)" ms.date: "03/27/2019" f1_keywords: ["AFXWIN/DECLARE_MESSAGE_MAP", "AFXWIN/BEGIN_MESSAGE_MAP", "AFXWIN/BEGIN_TEMPLATE_MESSAGE_MAP", "AFXWIN/END_MESSAGE_MAP", "AFXWIN/ON_COMMAND", "AFXWIN/ON_COMMAND_EX", "AFXWIN/ON_CONTROL", "AFXWIN/ON_MESSAGE", "AFXWIN/ON_OLECMD", "AFXWIN/ON_REGISTERED_MESSAGE", "AFXWIN/ON_REGISTERED_THREAD_MESSAGE", "AFXWIN/ON_THREAD_MESSAGE", "AFXWIN/ON_UPDATE_COMMAND_UI", "AFXWIN/ON_COMMAND_RANGE", "AFXWIN/ON_UPDATE_COMMAND_UI_RANGE", "AFXWIN/ON_CONTROL_RANGE"] helpviewer_keywords: ["message map macros", "Windows messages [MFC], declaration", "demarcating Windows messages", "message maps [MFC], macros", "message maps [MFC], declaration and demarcation", "message mapping macros", "ranges, message map", "message map ranges"] -ms.assetid: 531b15ce-32b5-4ca0-a849-bb519616c731 --- # Message Map Macros (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To support message maps, MFC supplies the following macros: ### Message-Map Declaration and Demarcation Macros diff --git a/docs/mfc/reference/message-maps-mfc.md b/docs/mfc/reference/message-maps-mfc.md index fcce99b97e6..2de3e965971 100644 --- a/docs/mfc/reference/message-maps-mfc.md +++ b/docs/mfc/reference/message-maps-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Message Maps (MFC)" title: "Message Maps (MFC)" ms.date: "09/07/2019" helpviewer_keywords: ["message maps [MFC], MFC", "Windows messages [MFC], message maps", "messages [MFC], Windows", "MFC, messages"] -ms.assetid: 3f9855e4-9d7d-4b64-8f3f-a19ea3cf79ba --- # Message Maps (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This section of the reference lists all [message mapping macros](../../mfc/reference/message-map-macros-mfc.md) and all [`CWnd`](../../mfc/reference/cwnd-class.md) message-map entries along with the corresponding member function prototypes: |Category|Description| diff --git a/docs/mfc/reference/message-types-associated-with-user-interface-objects.md b/docs/mfc/reference/message-types-associated-with-user-interface-objects.md index 61472bf5ac0..b9183f9ee34 100644 --- a/docs/mfc/reference/message-types-associated-with-user-interface-objects.md +++ b/docs/mfc/reference/message-types-associated-with-user-interface-objects.md @@ -4,10 +4,12 @@ title: "Message Types Associated with User-Interface Objects" ms.date: "11/04/2016" f1_keywords: ["vc.codewiz.uiobject.msgs"] helpviewer_keywords: ["message types and user interface objects [MFC]"] -ms.assetid: 681ee1a7-f6e6-4ea0-9fc6-1fb53a35516e --- # Message Types Associated with User-Interface Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table shows the types of objects with which you work, and the types of messages associated with them. ### User Interface Objects and Associated Messages diff --git a/docs/mfc/reference/mfc-activex-control-wizard.md b/docs/mfc/reference/mfc-activex-control-wizard.md index e949d307fa7..b3eadd27b35 100644 --- a/docs/mfc/reference/mfc-activex-control-wizard.md +++ b/docs/mfc/reference/mfc-activex-control-wizard.md @@ -4,11 +4,13 @@ title: "MFC ActiveX Control Wizard" ms.date: "03/04/2022" f1_keywords: ["vc.appwiz.mfc.ctl.overview"] helpviewer_keywords: ["ActiveX controls [MFC], MFC", "MFC ActiveX controls [MFC], wizards", "OLE controls [MFC], creating", "MFC ActiveX Control Wizard", "OLE controls [MFC]"] -ms.assetid: f19d698c-bdc3-4c74-af97-3d6ccb441b75 ms.custom: devdivchpfy22 --- # MFC ActiveX Control Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An ActiveX control is a specific type of [automation server](../../mfc/automation-servers.md); it's a reusable component. The application hosting the ActiveX control is the [automation client](../../mfc/automation-clients.md) of that control. If your goal is to create such a reusable component, then use this wizard to create your control. For more information, see [MFC ActiveX Controls](../../mfc/mfc-activex-controls.md). >[!IMPORTANT] diff --git a/docs/mfc/reference/mfc-add-class-wizard.md b/docs/mfc/reference/mfc-add-class-wizard.md index ce799af37fc..fe1567f8266 100644 --- a/docs/mfc/reference/mfc-add-class-wizard.md +++ b/docs/mfc/reference/mfc-add-class-wizard.md @@ -4,10 +4,12 @@ title: "MFC Add Class Wizard" ms.date: "09/06/2019" f1_keywords: ["vc.codewiz.class.mfc.simple.overview"] helpviewer_keywords: ["MFC Add Class Wizard", "wizards [MFC]"] -ms.assetid: ad3b0989-d307-43b2-9417-3f9a78889024 --- # MFC Add Class Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use this code wizard to add a class to an existing MFC project, or to add a class to an ATL project that supports MFC. You can also add MFC classes to Win32 projects that have MFC support. The features you specified when you created your project determine the options available in this dialog box. To access the wizard, click on **Add Class** in [Class Wizard](mfc-class-wizard.md). ![Add MFC Class Wizard.](media/add-mfc-class-wizard.png "Add MFC Class Wizard") diff --git a/docs/mfc/reference/mfc-application-wizard.md b/docs/mfc/reference/mfc-application-wizard.md index 81d79ea6b6e..960a05d3ce5 100644 --- a/docs/mfc/reference/mfc-application-wizard.md +++ b/docs/mfc/reference/mfc-application-wizard.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["MFC Application Wizard", "executable files, creating"] --- # MFC Application Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The MFC Application Wizard generates an application that, when compiled, implements the basic features of a Windows executable (.exe) application. The MFC starter application includes C++ source (.cpp) files, resource (.rc) files, header (.h) files, and a project (.vcxproj) file. The code that is generated in these starter files is based on MFC. > [!NOTE] @@ -68,7 +71,7 @@ This wizard page describes the current application settings for the MFC applicat To change these default settings, select the appropriate tab title in the left column of the wizard and make the changes on the page that appears. -After you create an MFC application project, you can add objects or controls to your project using Visual C++ [code wizards](../../ide/adding-functionality-with-code-wizards-cpp.md). +After you create an MFC application project, you can add objects or controls to your project using Visual Studio [code wizards](../../ide/adding-functionality-with-code-wizards-cpp.md). ## See also diff --git a/docs/mfc/reference/mfc-class-wizard.md b/docs/mfc/reference/mfc-class-wizard.md index ea0eb4c71b2..3af17c09036 100644 --- a/docs/mfc/reference/mfc-class-wizard.md +++ b/docs/mfc/reference/mfc-class-wizard.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["MFC Class Wizard"] --- # MFC Class Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use the **Class Wizard** to create new MFC classes, or add messages and message handlers to existing classes in your project. There are three ways to open the **Class Wizard**: diff --git a/docs/mfc/reference/mfc-classes.md b/docs/mfc/reference/mfc-classes.md index 8389dcd7e55..99ecdc84b58 100644 --- a/docs/mfc/reference/mfc-classes.md +++ b/docs/mfc/reference/mfc-classes.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["MFC, classes", "classes [MFC], MFC"] --- # MFC Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The classes in the following list are included in the Microsoft Foundation Class (MFC) Library. > [!TIP] diff --git a/docs/mfc/reference/mfc-dll-wizard.md b/docs/mfc/reference/mfc-dll-wizard.md index 9f7433d1c1c..6d06403db33 100644 --- a/docs/mfc/reference/mfc-dll-wizard.md +++ b/docs/mfc/reference/mfc-dll-wizard.md @@ -4,10 +4,12 @@ title: "MFC DLL Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.dll.overview"] helpviewer_keywords: ["MFC DLLs [MFC], creating", "MFC DLL Wizard", "DLLs [MFC], MFC", "DLL wizard [MFC]", "MFC DLLs [MFC]", "DLLs [MFC], creating"] -ms.assetid: 4e936031-7e39-4f40-a295-42a09c5ff264 --- # MFC DLL Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you use the MFC DLL wizard to create an MFC DLL project, you get a working starter application with built-in functionality that, when compiled, will implement the basic features of a [DLL](../../build/dlls-in-visual-cpp.md). The MFC starter program includes C++ source (.cpp) files, resource (.rc) files, and a project (.vcxproj) file. The code generated in these starter files is based on MFC. For more detailed information, see the file details in Readme.txt that is generated for your project in Visual Studio, and [Classes and Functions Generated by the MFC DLL Wizard](../../mfc/reference/classes-and-functions-generated-by-the-mfc-dll-wizard.md) ## Overview @@ -16,7 +18,7 @@ This wizard page describes the current [application settings for the MFC DLL pro To change these defaults, click **Application Settings** in the left column of the wizard and make changes in that page of the MFC DLL Wizard. -After you create an MFC DLL project, you can add objects or controls to your project using Visual C++ [code wizards](../../ide/adding-functionality-with-code-wizards-cpp.md). +After you create an MFC DLL project, you can add objects or controls to your project using Visual Studio [code wizards](../../ide/adding-functionality-with-code-wizards-cpp.md). You can perform the following tasks and types of enhancements to a basic MFC DLL project: diff --git a/docs/mfc/reference/mfc-macros-and-globals.md b/docs/mfc/reference/mfc-macros-and-globals.md index 7055e4a7c74..10468fe5bbe 100644 --- a/docs/mfc/reference/mfc-macros-and-globals.md +++ b/docs/mfc/reference/mfc-macros-and-globals.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC Macros and Globals" title: "MFC Macros and Globals" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, global functions and variables", "MFC, macros", "global functions, MFC", "macros, MFC", "global functions [MFC]", "global variables, MFC", "Afx naming convention", "macros"] -ms.assetid: add4e33f-0e62-4d27-be14-896cb8675d22 --- # MFC Macros and Globals +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class Library can be divided into two major sections: (1) the MFC classes and (2) macros and globals. If a function or variable is not a member of a class, it is a global function or variable. The MFC library and the Active Template Library (ATL) share string conversion macros. For more information, see [String Conversion Macros](../../atl/reference/string-conversion-macros.md) in the ATL documentation. diff --git a/docs/mfc/reference/mfc-odbc-consumer-wizard.md b/docs/mfc/reference/mfc-odbc-consumer-wizard.md index 4b3754189d2..f63ea871767 100644 --- a/docs/mfc/reference/mfc-odbc-consumer-wizard.md +++ b/docs/mfc/reference/mfc-odbc-consumer-wizard.md @@ -3,10 +3,12 @@ description: "Learn more about: MFC ODBC Consumer Wizard" title: "MFC ODBC Consumer Wizard" ms.date: "08/29/2019" helpviewer_keywords: ["wizards [MFC]"] -ms.assetid: f64a890b-a252-4887-88a1-782a7cd4ff3d --- # MFC ODBC Consumer Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + ::: moniker range=">=msvc-160" This wizard is not available in Visual Studio 2019 and later. diff --git a/docs/mfc/reference/mfc-wizards-and-dialog-boxes.md b/docs/mfc/reference/mfc-wizards-and-dialog-boxes.md index 6a99fce2ecd..1ca91580e76 100644 --- a/docs/mfc/reference/mfc-wizards-and-dialog-boxes.md +++ b/docs/mfc/reference/mfc-wizards-and-dialog-boxes.md @@ -2,10 +2,12 @@ description: "Learn more about: MFC Wizards and Dialog Boxes" title: "MFC Wizards and Dialog Boxes" ms.date: "11/04/2016" -ms.assetid: 2fae0a2c-d147-4468-a547-f7b85df767a1 --- # MFC Wizards and Dialog Boxes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class (MFC) wizards generate boilerplate code for various kinds of components and objects. You can run the wizards by opening the shortcut menu for a project in **Solution Explorer** and choosing **Add**, **Class**. ## Related Articles diff --git a/docs/mfc/reference/ole-initialization.md b/docs/mfc/reference/ole-initialization.md index 9e2eb402775..739a71c9abf 100644 --- a/docs/mfc/reference/ole-initialization.md +++ b/docs/mfc/reference/ole-initialization.md @@ -4,10 +4,12 @@ title: "OLE Initialization" ms.date: "11/04/2016" f1_keywords: ["afxdisp/AfxOleInit", "afxdisp/AfxEnableControlContainer"] helpviewer_keywords: ["OLE initialization"] -ms.assetid: aa8a54a7-24c3-4344-b2c6-dbcf6084fa31 --- # OLE Initialization +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Before an application can use OLE system services, it must initialize the OLE system DLLs and verify that the DLLs are the correct version. The `AfxOleInit` function initializes the OLE system DLLs. ### OLE Initialization diff --git a/docs/mfc/reference/persistence-of-ole-controls.md b/docs/mfc/reference/persistence-of-ole-controls.md index f01c148c590..85a6f6459e5 100644 --- a/docs/mfc/reference/persistence-of-ole-controls.md +++ b/docs/mfc/reference/persistence-of-ole-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Persistence of OLE Controls" title: "Persistence of OLE Controls" ms.date: "11/04/2016" helpviewer_keywords: ["OLE controls [MFC], persistence", "persistence, OLE controls"] -ms.assetid: 64f8dc80-f110-41af-b3ea-14948f6bfdf7 --- # Persistence of OLE Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + One capability of OLE controls is property persistence (or serialization), which allows the OLE control to read or write property values to and from a file or stream. A container application can use serialization to store a control's property values even after the application has destroyed the control. The property values of the OLE control can then be read from the file or stream when a new instance of the control is created at a later time. ### Persistence of OLE Controls diff --git a/docs/mfc/reference/property-pages-mfc.md b/docs/mfc/reference/property-pages-mfc.md index 68a4e94fa5d..f46e45774dd 100644 --- a/docs/mfc/reference/property-pages-mfc.md +++ b/docs/mfc/reference/property-pages-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Property Pages (MFC)" title: "Property Pages (MFC)" ms.date: "11/04/2016" helpviewer_keywords: ["property page data transfer functions in MFC", "property pages [MFC], global MFC functions"] -ms.assetid: 734f88bc-c776-4136-9b0e-f45c761a45c1 --- # Property Pages (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Property pages display the current values of specific OLE control properties in a customizable, graphical interface for viewing and editing by supporting a data-mapping mechanism based on dialog data exchange (DDX). This data-mapping mechanism maps property page controls to the individual properties of the OLE control. The value of the control property reflects the status or content of the property page control. The mapping between property page controls and properties is specified by **DDP_** function calls in the property page's `DoDataExchange` member function. The following is a list of **DDP_** functions that exchange data entered using the property page of your control: diff --git a/docs/mfc/reference/record-field-exchange-functions.md b/docs/mfc/reference/record-field-exchange-functions.md index 477e1ec39a3..30388eac0ad 100644 --- a/docs/mfc/reference/record-field-exchange-functions.md +++ b/docs/mfc/reference/record-field-exchange-functions.md @@ -4,10 +4,12 @@ title: "Record Field Exchange Functions" ms.date: "09/17/2019" f1_keywords: ["AFXDB/RFX_Binary", "AFXDB/RFX_Bool", "AFXDB/RFX_Byte", "AFXDB/RFX_Date", "AFXDB/RFX_Double", "AFXDB/RFX_Int", "AFXDB/RFX_Long", "AFXDB/RFX_LongBinary", "AFXDB/RFX_Single", "AFXDB/RFX_Text", "AFXDB/RFX_Binary_Bulk", "AFXDB/RFX_Bool_Bulk", "AFXDB/RFX_Byte_Bulk", "AFXDB/RFX_Date_Bulk", "AFXDB/RFX_Double_Bulk", "AFXDB/RFX_Int_Bulk", "AFXDB/RFX_Long_Bulk", "AFXDB/RFX_Single_Bulk", "AFXDB/RFX_Text_Bulk", "AFXDB/DFX_Binary", "AFXDB/DFX_Bool", "AFXDB/DFX_Byte", "AFXDB/DFX_Currency", "AFXDB/DFX_DateTime", "AFXDB/DFX_Double", "AFXDB/DFX_Long", "AFXDB/DFX_LongBinary", "AFXDB/DFX_Short", "AFXDB/DFX_Single", "AFXDB/DFX_Text"] helpviewer_keywords: ["DAO (Data Access Objects), record field exchange (DFX)", "ODBC, bulk RFX data exchange functions [MFC]", "RFX (record field exchange), ODBC classes", "DFX (DAO record field exchange), data exchange functions [MFC]", "DFX functions [MFC]", "bulk RFX functions [MFC]", "DFX (DAO record field exchange)", "RFX (record field exchange), DAO classes", "ODBC, RFX", "RFX (record field exchange), data exchange functions [MFC]", "RFX (record field exchange)"] -ms.assetid: 6e4c5c1c-acb7-4c18-bf51-bf7959a696cd --- # Record Field Exchange Functions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic lists the Record Field Exchange (RFX, Bulk RFX, and DFX) functions used to automate the transfer of data between a recordset object and its data source and to perform other operations on the data. If you are using the ODBC-based classes and you have implemented bulk row fetching, you must manually override the `DoBulkFieldExchange` member function of `CRecordset` by calling the Bulk RFX functions for each data member corresponding to a data source column. diff --git a/docs/mfc/reference/registering-ole-controls.md b/docs/mfc/reference/registering-ole-controls.md index 8dd7892ccec..474f755e5d7 100644 --- a/docs/mfc/reference/registering-ole-controls.md +++ b/docs/mfc/reference/registering-ole-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Registering OLE Controls" title: "Registering OLE Controls" ms.date: "11/04/2016" helpviewer_keywords: ["registering OLE controls", "OLE controls [MFC], registering"] -ms.assetid: 73c45b7f-7dbc-43f5-bd17-dd77c6acec72 --- # Registering OLE Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + OLE controls, like other OLE server objects, can be accessed by other OLE-aware applications. This is achieved by registering the control's type library and class. The following functions allow you to add and remove the control's class, property pages, and type library in the Windows registration database: diff --git a/docs/mfc/reference/run-time-object-model-services.md b/docs/mfc/reference/run-time-object-model-services.md index b33e44f8ffd..b2554a26265 100644 --- a/docs/mfc/reference/run-time-object-model-services.md +++ b/docs/mfc/reference/run-time-object-model-services.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["run-time object model services macros"] --- # Run-Time Object Model Services +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The classes [`CObject`](../../mfc/reference/cobject-class.md) and [`CRuntimeClass`](../../mfc/reference/cruntimeclass-structure.md) encapsulate several object services, including access to run-time class information, serialization, and dynamic object creation. All classes derived from `CObject` inherit this functionality. Access to run-time class information enables you to determine information about an object's class at run time. The ability to determine the class of an object at run time is useful when you need extra type-checking of function arguments and when you must write special-purpose code based on the class of an object. Run-time class information isn't supported directly by the C++ language. diff --git a/docs/mfc/reference/standard-command-and-window-ids.md b/docs/mfc/reference/standard-command-and-window-ids.md index bd4e60b03d2..d856dbfd439 100644 --- a/docs/mfc/reference/standard-command-and-window-ids.md +++ b/docs/mfc/reference/standard-command-and-window-ids.md @@ -3,10 +3,12 @@ description: "Learn more about: Standard Command and Window IDs" title: "Standard Command and Window IDs" ms.date: "11/04/2016" helpviewer_keywords: ["standard command and Window IDs"] -ms.assetid: 0424805c-fff8-4531-8f0c-15cfb13aa612 --- # Standard Command and Window IDs +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class Library defines a number of standard command and window IDs in Afxres.h. These IDs are most commonly used within the resource editors and the [Class Wizard](mfc-class-wizard.md) to map messages to your handler functions. All standard commands have an **ID_** prefix. For example, when you use the menu editor, you normally bind the File Open menu item to the standard ID_FILE_OPEN command ID. For most standard commands, application code does not need to refer to the command ID, because the framework itself handles the commands through message maps in its primary framework classes (`CWinThread`, `CWinApp`, `CView`, `CDocument`, and so on). diff --git a/docs/mfc/reference/standard-dialog-data-exchange-routines.md b/docs/mfc/reference/standard-dialog-data-exchange-routines.md index 0af24a8c467..75d3a07d319 100644 --- a/docs/mfc/reference/standard-dialog-data-exchange-routines.md +++ b/docs/mfc/reference/standard-dialog-data-exchange-routines.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["standard dialog, data exchange routines"] --- # Standard Dialog Data Exchange Routines +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic lists the standard dialog data exchange (DDX) routines used for common MFC dialog controls. > [!NOTE] diff --git a/docs/mfc/reference/standard-dialog-data-validation-routines.md b/docs/mfc/reference/standard-dialog-data-validation-routines.md index 43e9cb3e105..80d776f309b 100644 --- a/docs/mfc/reference/standard-dialog-data-validation-routines.md +++ b/docs/mfc/reference/standard-dialog-data-validation-routines.md @@ -3,10 +3,12 @@ description: "Learn more about: Standard Dialog Data Validation Routines" title: "Standard Dialog Data Validation Routines" ms.date: "11/04/2016" helpviewer_keywords: ["standard dialog, data validation routines"] -ms.assetid: 44dbc222-a897-4949-925e-7660e8964ccd --- # Standard Dialog Data Validation Routines +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic lists the standard dialog data validation (DDV) routines used for common MFC dialog controls. > [!NOTE] diff --git a/docs/mfc/reference/structures-styles-callbacks-and-message-maps.md b/docs/mfc/reference/structures-styles-callbacks-and-message-maps.md index f7b7d59f652..759dcd5d559 100644 --- a/docs/mfc/reference/structures-styles-callbacks-and-message-maps.md +++ b/docs/mfc/reference/structures-styles-callbacks-and-message-maps.md @@ -3,10 +3,12 @@ description: "Learn more about: Structures, Styles, Callbacks, and Message Maps" title: "Structures, Styles, Callbacks, and Message Maps" ms.date: "11/04/2016" helpviewer_keywords: ["callback functions, MFC", "styles, MFC", "message classes [MFC], MFC", "structures, MFC"] -ms.assetid: 27566602-7d84-4089-880c-8e90fb04fa56 --- # Structures, Styles, Callbacks, and Message Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This section documents the structures, styles, and callback functions used by the Microsoft Foundation Class Library and the MFC message maps. ## In This Section diff --git a/docs/mfc/reference/structures-used-by-mfc.md b/docs/mfc/reference/structures-used-by-mfc.md index 4e4f0a60c98..f01d1b7ccbb 100644 --- a/docs/mfc/reference/structures-used-by-mfc.md +++ b/docs/mfc/reference/structures-used-by-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Structures Used by MFC" title: "Structures Used by MFC" ms.date: "12/03/2018" helpviewer_keywords: ["structures", "structures, MFC"] -ms.assetid: 2168fcc6-e800-4814-aabf-0bca86ff790d --- # Structures Used by MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table lists structures that are called from various member functions. For further information on individual structure usage, refer to the classes and member functions noted in the See Also list for each structure. :::row::: diff --git a/docs/mfc/reference/styles-used-by-mfc.md b/docs/mfc/reference/styles-used-by-mfc.md index 7dc94df5291..57a0bfaa6b2 100644 --- a/docs/mfc/reference/styles-used-by-mfc.md +++ b/docs/mfc/reference/styles-used-by-mfc.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["button objects (CButton), button styles", "button styles --- # Styles Used by MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use the following style flags to specify window or control appearance and behavior when you create the corresponding MFC object. In most cases, these styles are set in the *`dwStyle`* parameter of the class `Create` function. ## Button styles diff --git a/docs/mfc/reference/toolbar-control-styles.md b/docs/mfc/reference/toolbar-control-styles.md index 77597a53dab..f5b7a9d6002 100644 --- a/docs/mfc/reference/toolbar-control-styles.md +++ b/docs/mfc/reference/toolbar-control-styles.md @@ -3,10 +3,12 @@ description: "Learn more about: ToolBar Control Styles" title: "ToolBar Control Styles" ms.date: "11/04/2016" helpviewer_keywords: ["ToolBar control styles [MFC]"] -ms.assetid: 0f717eb9-fa32-4263-b852-809238863feb --- # ToolBar Control Styles +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + [CMFCToolBarButton Class](../../mfc/reference/cmfctoolbarbutton-class.md) has a set of style flags that determine the appearance and behavior of the button. You can set a combination of these flags by calling [CMFCToolBarButton::SetStyle](../../mfc/reference/cmfctoolbarbutton-class.md#setstyle). This topic lists the style flag values and their meanings. ## Property Values diff --git a/docs/mfc/reference/type-casting-of-mfc-class-objects.md b/docs/mfc/reference/type-casting-of-mfc-class-objects.md index ee081937069..233e7ad3cb8 100644 --- a/docs/mfc/reference/type-casting-of-mfc-class-objects.md +++ b/docs/mfc/reference/type-casting-of-mfc-class-objects.md @@ -3,10 +3,12 @@ description: "Learn more about: Type Casting of MFC Class Objects" title: "Type Casting of MFC Class Objects" ms.date: "11/04/2016" helpviewer_keywords: ["macros [MFC], type casting", "pointers [MFC], type casting", "type casts [MFC]", "casting types [MFC]", "macros [MFC], casting pointers"] -ms.assetid: e138465e-c35f-4e84-b788-bd200ccf2f0e --- # Type Casting of MFC Class Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Type casting macros provide a way to cast a given pointer to a pointer that points to an object of specific class, with or without checking that the cast is legal. The following table lists the MFC type casting macros. diff --git a/docs/mfc/reference/type-library-access.md b/docs/mfc/reference/type-library-access.md index 6ef3220a64b..b0b56f09b88 100644 --- a/docs/mfc/reference/type-library-access.md +++ b/docs/mfc/reference/type-library-access.md @@ -3,10 +3,12 @@ description: "Learn more about: Type Library Access" title: "Type Library Access" ms.date: "11/04/2016" helpviewer_keywords: ["type libraries [MFC], accessing"] -ms.assetid: a03fa7f0-86c2-4119-bf81-202916fb74b3 --- # Type Library Access +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Type libraries expose the interfaces of an OLE control to other OLE-aware applications. Each OLE control must have a type library if one or more interfaces are to be exposed. The following macros allow an OLE control to provide access to its own type library: diff --git a/docs/mfc/reference/uicheckstate-enumeration.md b/docs/mfc/reference/uicheckstate-enumeration.md index 71cd897d5a1..8224123d07a 100644 --- a/docs/mfc/reference/uicheckstate-enumeration.md +++ b/docs/mfc/reference/uicheckstate-enumeration.md @@ -4,10 +4,12 @@ title: "UICheckState Enumeration" ms.date: "04/03/2017" f1_keywords: ["afxwinforms/uicheckstate"] helpviewer_keywords: ["uicheckstate enumeration [MFC]"] -ms.assetid: 2ac0098c-20e7-410c-9685-5ead5cb02b63 --- # UICheckState Enumeration +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Describes the check state of a user interface item for the command. ### Syntax diff --git a/docs/mfc/reference/user-button-handlers.md b/docs/mfc/reference/user-button-handlers.md index 60722f09cc4..8d81f6329ef 100644 --- a/docs/mfc/reference/user-button-handlers.md +++ b/docs/mfc/reference/user-button-handlers.md @@ -4,10 +4,12 @@ title: "User Button Handlers" ms.date: "11/04/2016" f1_keywords: ["ON_BN_HILITE", "ON_BN_DOUBLECLICKED", "ON_BN_CLICKED", "ON_BN_PAINT", "ON_BN_DISABLE", "ON_BN_UNHILITE"] helpviewer_keywords: ["ON_BN_PAINT", "user buttons [MFC]", "ON_BN_DOUBLECLICKED [MFC]", "ON_BN_DISABLE [MFC]", "ON_BN_UNHILITE [MFC]", "ON_BN_HILITE [MFC]", "ON_BN_CLICKED [MFC]"] -ms.assetid: 410ea968-478f-4806-b7b8-5d7c8dc2bf42 --- # User Button Handlers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries correspond to the function prototypes. |Map entry|Function prototype| diff --git a/docs/mfc/reference/user-defined-handlers.md b/docs/mfc/reference/user-defined-handlers.md index e975f7b8127..f7774849951 100644 --- a/docs/mfc/reference/user-defined-handlers.md +++ b/docs/mfc/reference/user-defined-handlers.md @@ -3,10 +3,12 @@ description: "Learn more about: User-Defined Handlers" title: "User-Defined Handlers" ms.date: "11/04/2016" helpviewer_keywords: ["ON_REGISTERED_MESSAGE macro [MFC]", "ON_MESSAGE macro [MFC]", "user-defined handlers [MFC]"] -ms.assetid: 99478294-bef0-4ba7-a369-25a6abdcdb62 --- # User-Defined Handlers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries correspond to the function prototypes. |Map entry|Function prototype| diff --git a/docs/mfc/reference/user-interface-features-mfc-application-wizard.md b/docs/mfc/reference/user-interface-features-mfc-application-wizard.md index 68ccfa97e30..3dee4ab90ac 100644 --- a/docs/mfc/reference/user-interface-features-mfc-application-wizard.md +++ b/docs/mfc/reference/user-interface-features-mfc-application-wizard.md @@ -4,10 +4,12 @@ title: "User Interface Features, MFC Application Wizard" ms.date: "11/04/2016" f1_keywords: ["vc.appwiz.mfc.exe.ui"] helpviewer_keywords: ["MFC Application Wizard, user interface features"] -ms.assetid: 59e7b829-a665-42eb-be23-3f2a36eb2dad --- # User Interface Features, MFC Application Wizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic explains the options that you can use to specify the look of your application. The user interface features available for your project depend on the type of application you specified in the [Application Type, MFC Application Wizard](../../mfc/reference/application-type-mfc-application-wizard.md) page of the MFC Application Wizard. For example, if you create a single document interface application, you cannot add child frame styles. - **Main frame styles** diff --git a/docs/mfc/reference/variant-parameter-type-constants.md b/docs/mfc/reference/variant-parameter-type-constants.md index 0304c57c92c..2a6d1aadeee 100644 --- a/docs/mfc/reference/variant-parameter-type-constants.md +++ b/docs/mfc/reference/variant-parameter-type-constants.md @@ -4,10 +4,12 @@ title: "Variant Parameter Type Constants" ms.date: "11/04/2016" f1_keywords: ["VTS_YPOS_HIMETRIC", "VTS_PICTURE", "VTS_FONT", "VTS_XPOS_HIMETRIC", "VTS_XPOS_PIXELS", "VTS_XSIZE_HIMETRIC", "VTS_YPOS_PIXELS", "VTS_TRISTATE", "VTS_HANDLE", "VTS_YSIZE_HIMETRIC", "VTS_COLOR", "VTS_OPTEXCLUSIVE", "VTS_YSIZE_PIXELS", "VTS_XSIZE_PIXELS"] helpviewer_keywords: ["VTS_XPOS_HIMETRIC constant [MFC]", "VTS_FONT constant [MFC]", "VTS_XPOS_PIXELS constant [MFC]", "VTS_COLOR constant [MFC]", "Variants [MFC]", "VTS_YPOS_PIXELS constant [MFC]", "VTS_YSIZE_HIMETRIC constant [MFC]", "VTS_YPOS_HIMETRIC constant [MFC]", "Variants, parameter type constants", "Variant data constants [MFC]", "VTS_PICTURE constant [MFC]", "VTS_TRISTATE constant [MFC]", "VTS_XSIZE_HIMETRIC constant [MFC]", "VTS_HANDLE constant [MFC]", "VTS_XSIZE_PIXELS constant [MFC]", "VTS_OPTEXCLUSIVE constant [MFC]", "VTS_YSIZE_PIXELS constant [MFC]"] -ms.assetid: de99c7a9-7aae-4dc4-b723-40c6380543ab --- # Variant Parameter Type Constants +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic lists new constants that indicate variant parameter types designed for use with the OLE control classes of the Microsoft Foundation Class Library. The following is a list of class constants: diff --git a/docs/mfc/reference/wm-message-handlers-a-c.md b/docs/mfc/reference/wm-message-handlers-a-c.md index e6e35de0fcc..8301bf57d3d 100644 --- a/docs/mfc/reference/wm-message-handlers-a-c.md +++ b/docs/mfc/reference/wm-message-handlers-a-c.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["ON_WM_COMPACTING [MFC]", "ON_WM_COMPAREITEM [MFC]", "ON_W --- # `WM_` Message Handlers: A - C +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries on the left correspond to the function prototypes on the right: |Map entry|Function prototype| diff --git a/docs/mfc/reference/wm-message-handlers-d-e.md b/docs/mfc/reference/wm-message-handlers-d-e.md index 3e6cded86cc..0f1932a34bd 100644 --- a/docs/mfc/reference/wm-message-handlers-d-e.md +++ b/docs/mfc/reference/wm-message-handlers-d-e.md @@ -4,10 +4,12 @@ title: "WM_ Message Handlers: D - E" ms.date: "11/04/2016" f1_keywords: ["ON_WM_ERASEBKGND", "ON_WM_DEVICECHANGE", "ON_WM_ENTERIDLE", "ON_WM_DESTROYCLIPBOARD", "ON_WM_DESTROY", "ON_WM_DEADCHAR", "ON_WM_DELETEITEM", "ON_WM_DROPFILES", "ON_WM_DEVMODECHANGE", "ON_WM_ENDSESSION", "ON_WM_ENABLE", "ON_WM_DRAWITEM", "ON_WM_DRAWCLIPBOARD"] helpviewer_keywords: ["ON_WM_ENTERIDLE [MFC]", "ON_WM_DESTROYCLIPBOARD [MFC]", "ON_WM_DEADCHAR [MFC]", "ON_WM_DEVMODECHANGE [MFC]", "ON_WM_ERASEBKGND [MFC]", "ON_WM_DESTROY [MFC]", "ON_WM_DRAWCLIPBOARD [MFC]", "ON_WM_ENDSESSION [MFC]", "ON_WM_DRAWITEM [MFC]", "ON_WM_ENABLE [MFC]", "ON_WM_DROPFILES [MFC]", "ON_WM_DELETEITEM [MFC]", "ON_WM_DEVICECHANGE [MFC]", "WM_ messages [MFC]"] -ms.assetid: 56fb89c8-68a8-4adf-883e-a9f63bf677e9 --- # WM_ Message Handlers: D - E +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries on the left correspond to the function prototypes on the right: |Map entry|Function prototype| diff --git a/docs/mfc/reference/wm-message-handlers-f-k.md b/docs/mfc/reference/wm-message-handlers-f-k.md index e696a99370d..d5fdf788d64 100644 --- a/docs/mfc/reference/wm-message-handlers-f-k.md +++ b/docs/mfc/reference/wm-message-handlers-f-k.md @@ -4,10 +4,12 @@ title: "WM_ Message Handlers: F - K" ms.date: "11/27/2018" f1_keywords: ["ON_WM_FONTCHANGE", "ON_WM_ICONERASEBKGND", "ON_WM_KEYDOWN", "ON_WM_GETMINMAXINFO", "ON_WM_KEYUP", "ON_WM_HSCROLL", "ON_WM_KILLFOCUS", "ON_WM_HSCROLLCLIPBOARD", "ON_WM_GETDLGCODE", "ON_WM_HELPINFO", "ON_WM_INITMENUPOPUP", "ON_WM_INITMENU"] helpviewer_keywords: ["ON_WM_HELPINFO [MFC]", "ON_WM_KILLFOCUS [MFC]", "ON_WM_GETMINMAXINFO [MFC]", "ON_WM_KEYUP [MFC]", "ON_WM_HSCROLL [MFC]", "ON_WM_INITMENUPOPUP [MFC]", "ON_WM_FONTCHANGE [MFC]", "ON_WM_ICONERASEBKGND [MFC]", "ON_WM_GETDLGCODE [MFC]", "ON_WM_HSCROLLCLIPBOARD [MFC]", "ON_WM_INITMENU [MFC]", "WM_ messages [MFC]", "ON_WM_KEYDOWN [MFC]"] -ms.assetid: 0e7de191-1499-499f-859c-62742797808e --- # WM_ Message Handlers: F - K +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries on the left correspond to the function prototypes on the right: |Map entry|Function prototype| diff --git a/docs/mfc/reference/wm-message-handlers-l-m.md b/docs/mfc/reference/wm-message-handlers-l-m.md index 264bc859502..6b128ee4e41 100644 --- a/docs/mfc/reference/wm-message-handlers-l-m.md +++ b/docs/mfc/reference/wm-message-handlers-l-m.md @@ -4,10 +4,12 @@ title: "WM_ Message Handlers: L - M" ms.date: "11/04/2016" f1_keywords: ["ON_WM_MENUSELECT", "ON_WM_MBUTTONDBLCLK", "ON_WM_MOUSEACTIVATE", "ON_WM_MOUSEMOVE", "ON_WM_MOVING", "ON_WM_LBUTTONUP", "ON_WM_LBUTTONDBLCLK", "ON_WM_MEASUREITEM", "ON_WM_MDIACTIVATE", "ON_WM_MOVE", "ON_WM_LBUTTONDOWN", "ON_WM_MBUTTONDOWN", "ON_WM_MENUCHAR", "ON_WM_MBUTTONUP"] helpviewer_keywords: ["ON_WM_MENUSELECT [MFC]", "ON_WM_MBUTTONDBLCLK [MFC]", "ON_WM_MOVE [MFC]", "ON_WM_MOUSEACTIVATE [MFC]", "ON_WM_MBUTTONUP [MFC]", "ON_WM_MOUSEMOVE [MFC]", "ON_WM_MENUCHAR [MFC]", "ON_WM_MBUTTONDOWN [MFC]", "ON_WM_MEASUREITEM [MFC]", "ON_WM_MOVING [MFC]", "ON_WM_LBUTTONDOWN [MFC]", "ON_WM_MDIACTIVATE [MFC]", "ON_WM_LBUTTONDBLCLK [MFC]", "ON_WM_LBUTTONUP [MFC]", "WM_ messages"] -ms.assetid: 96ecaaf1-6d13-4e12-a454-535635967489 --- # WM_ Message Handlers: L - M +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries on the left correspond to the function prototypes on the right: |Map entry|Function prototype| diff --git a/docs/mfc/reference/wm-message-handlers-n-o.md b/docs/mfc/reference/wm-message-handlers-n-o.md index 51f2cc151fc..7d21b6da435 100644 --- a/docs/mfc/reference/wm-message-handlers-n-o.md +++ b/docs/mfc/reference/wm-message-handlers-n-o.md @@ -4,10 +4,12 @@ title: "WM_ Message Handlers: N - O" ms.date: "11/04/2016" f1_keywords: ["ON_WM_NCHITTEST", "ON_WM_NCLBUTTONDOWN", "ON_WM_NCCALCSIZE", "ON_WM_NCLBUTTONUP", "ON_WM_NCPAINT", "ON_WM_NCMBUTTONUP", "ON_WM_NCCREATE", "ON_WM_NCACTIVATE", "ON_WM_NCMOUSEMOVE", "ON_WM_NCRBUTTONDBLCLK", "ON_WM_NCLBUTTONDBLCLK", "ON_WM_NCDESTROY", "ON_WM_NCMBUTTONDBLCLK", "ON_WM_NCRBUTTONDOWN", "ON_WM_NCRBUTTONUP", "ON_WM_NCMBUTTONDOWN"] helpviewer_keywords: ["ON_WM_NCCALCSIZE [MFC]", "ON_WM_NCMBUTTONDOWN [MFC]", "ON_WM_NCRBUTTONDBLCLK [MFC]", "ON_WM_NCMBUTTONDBLCLK [MFC]", "ON_WM_NCLBUTTONDBLCLK [MFC]", "ON_WM_NCDESTROY [MFC]", "ON_WM_NCRBUTTONDOWN [MFC]", "ON_WM_NCLBUTTONDOWN [MFC]", "ON_WM_NCCREATE [MFC]", "ON_WM_NCRBUTTONUP [MFC]", "ON_WM_NCLBUTTONUP [MFC]", "ON_WM_NCPAINT [MFC]", "ON_WM_NCACTIVATE [MFC]", "ON_WM_NCHITTEST [MFC]", "ON_WM_NCMOUSEMOVE [MFC]", "ON_WM_NCMBUTTONUP [MFC]", "WM_ messages"] -ms.assetid: 4efd1cda-b642-4e8b-89e8-73255fa70d77 --- # WM_ Message Handlers: N - O +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries on the left correspond to the function prototypes on the right: |Map entry|Function prototype| diff --git a/docs/mfc/reference/wm-messages-p-r.md b/docs/mfc/reference/wm-messages-p-r.md index 257f831f491..11aef99dbbf 100644 --- a/docs/mfc/reference/wm-messages-p-r.md +++ b/docs/mfc/reference/wm-messages-p-r.md @@ -4,10 +4,12 @@ title: "WM_ Messages: P - R" ms.date: "11/04/2016" f1_keywords: ["ON_WM_RBUTTONUP", "ON_WM_PALETTECHANGED", "ON_WM_RBUTTONDBLCLK", "ON_WM_QUERYENDSESSION", "ON_WM_PARENTNOTIFY", "ON_WM_PALETTEISCHANGING", "ON_WM_QUERYOPEN", "ON_WM_PAINT", "ON_WM_QUERYNEWPALETTE", "ON_WM_RBUTTONDOWN", "ON_WM_RENDERALLFORMATS", "ON_WM_PAINTCLIPBOARD", "ON_WM_RENDERFORMAT", "ON_WM_QUERYDRAGICON"] helpviewer_keywords: ["ON_WM_RENDERFORMAT [MFC]", "ON_WM_QUERYOPEN [MFC]", "ON_WM_RBUTTONDOWN [MFC]", "ON_WM_PAINTCLIPBOARD [MFC]", "ON_WM_QUERYNEWPALETTE [MFC]", "ON_WM_RBUTTONUP [MFC]", "ON_WM_PARENTNOTIFY [MFC]", "ON_WM_RBUTTONDBLCLK [MFC]", "ON_WM_PALETTECHANGED [MFC]", "ON_WM_PALETTEISCHANGING [MFC]", "ON_WM_QUERYDRAGICON [MFC]", "ON_WM_PAINT [MFC]", "ON_WM_RENDERALLFORMATS [MFC]", "ON_WM_QUERYENDSESSION [MFC]", "WM_ messages"] -ms.assetid: f46962e5-8329-4f1f-9b4d-fdad2a5ce1f8 --- # WM_ Messages: P - R +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries correspond to the function prototypes: |Map entry|Function prototype| diff --git a/docs/mfc/reference/wm-messages-s.md b/docs/mfc/reference/wm-messages-s.md index 78fee76db60..70fb5ac333d 100644 --- a/docs/mfc/reference/wm-messages-s.md +++ b/docs/mfc/reference/wm-messages-s.md @@ -4,10 +4,12 @@ title: "WM_ Messages: S" ms.date: "11/04/2016" f1_keywords: ["ON_WM_SYSDEADCHAR", "ON_WM_SYSKEYDOWN", "ON_WM_STYLECHANGING", "ON_WM_STYLECHANGED", "ON_WM_SPOOLERSTATUS", "ON_WM_SYSCHAR", "ON_WM_SETFOCUS", "ON_WM_SIZE", "ON_WM_SIZING", "ON_WM_SETCURSOR", "ON_WM_SYSCOMMAND", "ON_WM_SETTINGCHANGE", "ON_WM_SHOWWINDOW", "ON_WM_SYSKEYUP", "ON_WM_SIZECLIPBOARD", "ON_WM_SYSCOLORCHANGE"] helpviewer_keywords: ["ON_WM_SIZE [MFC]", "ON_WM_SETFOCUS [MFC]", "ON_WM_SIZING [MFC]", "ON_WM_SYSCHAR [MFC]", "ON_WM_SETTINGCHANGE [MFC]", "ON_WM_SYSDEADCHAR [MFC]", "ON_WM_SHOWWINDOW [MFC]", "ON_WM_STYLECHANGING [MFC]", "ON_WM_SYSCOMMAND [MFC]", "ON_WM_STYLECHANGED [MFC]", "ON_WM_SPOOLERSTATUS [MFC]", "ON_WM_SYSCOLORCHANGE [MFC]", "ON_WM_SETCURSOR [MFC]", "ON_WM_SIZECLIPBOARD [MFC]", "ON_WM_SYSKEYUP [MFC]", "ON_WM_SYSKEYDOWN [MFC]", "WM_ messages"] -ms.assetid: 4b9aec79-a98f-4aa0-a3d9-110941b6dcbc --- # WM_ Messages: S +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries correspond to the function prototypes. |Map entry|Function prototype| diff --git a/docs/mfc/reference/wm-messages-t-z.md b/docs/mfc/reference/wm-messages-t-z.md index b60436e68dc..4c65130ce0f 100644 --- a/docs/mfc/reference/wm-messages-t-z.md +++ b/docs/mfc/reference/wm-messages-t-z.md @@ -4,10 +4,12 @@ title: "WM_ Messages: T - Z" ms.date: "11/04/2016" f1_keywords: ["ON_WM_TCARD", "ON_WM_WININICHANGE", "ON_WM_VSCROLLCLIPBOARD", "ON_WM_VSCROLL", "ON_WM_WINDOWPOSCHANGED", "ON_WM_TIMECHANGE", "ON_WM_TIMER", "ON_WM_VKEYTOITEM", "ON_WM_WINDOWPOSCHANGING"] helpviewer_keywords: ["ON_WM_VSCROLLCLIPBOARD [MFC]", "ON_WM_WININICHANGE [MFC]", "ON_WM_WINDOWPOSCHANGED [MFC]", "ON_WM_TCARD [MFC]", "ON_WM_TIMECHANGE [MFC]", "ON_WM_TIMER [MFC]", "WM_ messages [MFC]", "ON_WM_WINDOWPOSCHANGING [MFC]", "ON_WM_VKEYTOITEM [MFC]", "ON_WM_VSCROLL"] -ms.assetid: c528bb2e-ddb5-4da6-b652-432a387408b8 --- # WM_ Messages: T - Z +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following map entries correspond to the function prototypes: |Map entry|Function prototype| diff --git a/docs/mfc/reflected-window-message-ids.md b/docs/mfc/reflected-window-message-ids.md index 45071edf6dd..aec1d557a2b 100644 --- a/docs/mfc/reflected-window-message-ids.md +++ b/docs/mfc/reflected-window-message-ids.md @@ -4,10 +4,12 @@ title: "Reflected Window Message IDs" ms.date: "11/04/2016" f1_keywords: ["OCM_CTLCOLORBTN", "OCM_PARENTNOTIFY", "OCM_VKEYTOITEM", "OCM_CTLCOLORSTATIC", "OCM_HSCROLL", "OCM_CHARTOITEM", "OCM_DRAWITEM", "OCM_MEASUREITEM", "OCM_COMPAREITEM", "OCM_COMMAND", "OCM_NOTIFY", "OCM_CTLCOLORMSGBOX", "OCM_DELETEITEM", "OCM_CTLCOLORLISTBOX", "OCM_CTLCOLORDLG", "OCM_CTLCOLOREDIT", "OCM_CTLCOLORSCROLLBAR", "OCM_VSCROLL", "OCM_CTLCOLOR"] helpviewer_keywords: ["OCM_HSCROLL message [MFC]", "OCM_PARENTNOTIFY message [MFC]", "messages, reflected", "reflected messages, window message Ids", "OCM_CTLCOLORDLG message [MFC]", "OCM_COMMAND message [MFC]", "OCM_CTLCOLORMSGBOX message [MFC]", "OCM_COMPAREITEM message [MFC]", "OCM_DRAWITEM message [MFC]", "OCM_VSCROLL message [MFC]", "OCM_CTLCOLOREDIT message [MFC]", "OCM_VKEYTOITEM message [MFC]", "OCM_CHARTOITEM message [MFC]", "OCM_CTLCOLORBTN message [MFC]", "OCM_CTLCOLORSTATIC message [MFC]", "OCM_MEASUREITEM message [MFC]", "OCM_CTLCOLOR message [MFC]", "OCM_CTLCOLORSCROLLBAR message [MFC]", "OCM_ messages", "OCM_DELETEITEM message [MFC]", "OCM_CTLCOLORLISTBOX message [MFC]", "OCM_NOTIFY message [MFC]", "reflected messages"] -ms.assetid: 3417ff51-ff9f-458c-bff4-17c200f00d96 --- # Reflected Window Message IDs +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A quick way to create an ActiveX control, or other specialized control, is to subclass a window. For more information, see [MFC ActiveX Controls: Subclassing a Windows Control](../mfc/mfc-activex-controls-subclassing-a-windows-control.md). To prevent the control's container from receiving the window messages sent by a subclassed Windows control, [COleControl](../mfc/reference/colecontrol-class.md) creates a "reflector" window to intercept certain window messages and send them back to the control. The control, in its window procedure, can then process these reflected messages by taking actions appropriate for an ActiveX control. diff --git a/docs/mfc/registering-window-classes.md b/docs/mfc/registering-window-classes.md index 20bf96df284..be9840fb0a4 100644 --- a/docs/mfc/registering-window-classes.md +++ b/docs/mfc/registering-window-classes.md @@ -4,11 +4,13 @@ title: "Registering Window Classes" ms.date: "11/04/2016" f1_keywords: ["WndProc"] helpviewer_keywords: ["window classes [MFC], registering", "registry [MFC], registering classes", "AfxRegisterWndClass method [MFC]", "MFC, windows", "WinMain method [MFC], and registering window classes", "WndProc method [MFC]", "classes [MFC], registering window classes", "WinMain method [MFC]", "registering window classes [MFC]"] -ms.assetid: 30994bc4-a362-43da-bcc5-1bf67a3fc929 ms.topic: concept-article --- # Registering Window Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Window "classes" in traditional programming for Windows define the characteristics of a "class" (not a C++ class) from which any number of windows can be created. This kind of class is a template or model for creating windows. ## Window Class Registration in Traditional Programs for Windows diff --git a/docs/mfc/registration.md b/docs/mfc/registration.md index 93dd93f87f5..33ac6b7fa0b 100644 --- a/docs/mfc/registration.md +++ b/docs/mfc/registration.md @@ -3,10 +3,12 @@ description: "Learn more about: Registration" title: "Registration" ms.date: "11/04/2016" helpviewer_keywords: ["servers [MFC], initializing", "initializing servers [MFC]", "OLE, registration", "installing servers [MFC]", "registry [MFC], OLE item database", "registration databases [MFC]", "servers [MFC], installing", "OLE server applications [MFC], registering servers"] -ms.assetid: 991d5684-72c1-4f9e-a09a-9184ed12bbb9 --- # Registration +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When a user wants to insert an OLE item into an application, OLE presents a list of object types to choose from. OLE gets this list from the system registration database, which contains information provided by all server applications. When a server registers itself, the entries it puts into the system registration database (the Registry) describe each type of object it supplies, file extensions, and the path to itself, among other information. The framework and the OLE system dynamic-link libraries (DLL) use this registry to determine what types of OLE items are available on the system. The OLE system DLLs also use this registry to determine how to launch a server application when a linked or embedded object is activated. diff --git a/docs/mfc/relationship-between-a-cpp-window-object-and-an-hwnd.md b/docs/mfc/relationship-between-a-cpp-window-object-and-an-hwnd.md index 91522b05d2d..0ce79cf6314 100644 --- a/docs/mfc/relationship-between-a-cpp-window-object-and-an-hwnd.md +++ b/docs/mfc/relationship-between-a-cpp-window-object-and-an-hwnd.md @@ -4,10 +4,12 @@ title: "Relationship Between a C++ Window Object and an HWND" ms.date: "11/19/2018" f1_keywords: ["HWND"] helpviewer_keywords: ["Windows window [MFC]", "window objects [MFC], HWND and", "HWND [MFC]", "CWnd class [MFC], HWND", "HWND, window objects [MFC]"] -ms.assetid: f2e76340-6691-4ee6-9424-0345634a9469 --- # Relationship Between a C++ Window Object and an HWND +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The window *object* is an object of the C++ `CWnd` class (or a derived class) that your program creates directly. It comes and goes in response to your program's constructor and destructor calls. The Windows *window*, on the other hand, is an opaque handle to an internal Windows data structure that corresponds to a window and consumes system resources when present. A Windows window is identified by a "window handle" (`HWND`) and is created after the `CWnd` object is created by a call to the `Create` member function of class `CWnd`. The window may be destroyed either by a program call or by a user's action. The window handle is stored in the window object's *m_hWnd* member variable. The following figure shows the relationship between the C++ window object and the Windows window. Creating windows is discussed in [Creating Windows](../mfc/creating-windows.md). Destroying windows is discussed in [Destroying Window Objects](../mfc/destroying-window-objects.md). ![CWnd window object and resulting window.](../mfc/media/vc37fj1.gif "CWnd window object and resulting window")
diff --git a/docs/mfc/relationship-to-the-c-language-api.md b/docs/mfc/relationship-to-the-c-language-api.md index b055335b658..5fe382a89a6 100644 --- a/docs/mfc/relationship-to-the-c-language-api.md +++ b/docs/mfc/relationship-to-the-c-language-api.md @@ -3,13 +3,15 @@ description: "Learn more about: Relationship to the C-Language API" title: "Relationship to the C-Language API" ms.date: "11/04/2016" helpviewer_keywords: ["books [MFC], about MFC and Windows SDK", "books [MFC]", "MFC, Windows API", "Visual C, Windows API calls", "Windows API [MFC], and MFC"] -ms.assetid: 334e8efc-f3cc-4018-bc2e-02908b2a39fe --- # Relationship to the C-Language API +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The single characteristic that sets the Microsoft Foundation Class (MFC) Library apart from other class libraries for Windows is the very close mapping to the Windows API written in the C language. Further, you can generally mix calls to the class library freely with direct calls to the Windows API. This direct access does not, however, imply that the classes are a complete replacement for that API. Developers must still occasionally make direct calls to some Windows functions, such as [SetCursor](/windows/win32/api/winuser/nf-winuser-setcursor) and [GetSystemMetrics](/windows/win32/api/winuser/nf-winuser-getsystemmetrics), for example. A Windows function is wrapped by a class member function only when there is a clear advantage to doing so. -Because you sometimes need to make native Windows function calls, you should have access to the C-language Windows API documentation. This documentation is included with Microsoft Visual C++. +Because you sometimes need to make native Windows function calls, you should have access to the C-language Windows API documentation. This documentation is included with Visual Studio. > [!NOTE] > For an overview of how the MFC Library framework operates, see [Using the Classes to Write Applications for Windows](../mfc/using-the-classes-to-write-applications-for-windows.md). diff --git a/docs/mfc/relationships-among-mfc-objects.md b/docs/mfc/relationships-among-mfc-objects.md index 81cdad19204..a81651518ab 100644 --- a/docs/mfc/relationships-among-mfc-objects.md +++ b/docs/mfc/relationships-among-mfc-objects.md @@ -3,10 +3,12 @@ description: "Learn more about: Relationships Among MFC Objects" title: "Relationships Among MFC Objects" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, relationships between key objects", "objects [MFC], relationships", "relationships, MFC objects", "MFC object relationships"] -ms.assetid: 6e8f3b51-e80f-4d88-94c8-4c1e4ee163ad --- # Relationships Among MFC Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To help put the document/view creation process in perspective, consider a running program: a document, the frame window used to contain the view, and the view associated with the document. - A document keeps a list of the views of that document and a pointer to the document template that created the document. diff --git a/docs/mfc/responding-to-dynamic-data-exchange-dde.md b/docs/mfc/responding-to-dynamic-data-exchange-dde.md index cfcc4ddc454..c34e3e3c131 100644 --- a/docs/mfc/responding-to-dynamic-data-exchange-dde.md +++ b/docs/mfc/responding-to-dynamic-data-exchange-dde.md @@ -3,11 +3,13 @@ description: "Learn more about: Responding to Dynamic Data Exchange (DDE)" title: "Responding to Dynamic Data Exchange (DDE)" ms.date: "11/04/2016" helpviewer_keywords: ["registry [MFC], most recently used files", "frame windows [MFC], dynamic data exchange (DDE)", "DDE (Dynamic Data Exchange), frame windows", "registration [MFC], shell", "Shell [MFC], registering file types", "windows [MFC], and dynamic data exchange", "responding to dynamic data exchange (DDE)", "frame windows [MFC], shell registration"] -ms.assetid: 4db838d5-62cf-4123-915a-66e514155c0c ms.topic: concept-article --- # Responding to Dynamic Data Exchange (DDE) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The frame window can respond to dynamic data exchange (DDE) requests to open files from the File Manager (if the file extension is registered or associated with the application). See [Shell Registration](../mfc/special-cwinapp-services.md). ## See also diff --git a/docs/mfc/retrieving-data-from-the-dialog-object.md b/docs/mfc/retrieving-data-from-the-dialog-object.md index 0177ee9d4a8..cd3e39f36e0 100644 --- a/docs/mfc/retrieving-data-from-the-dialog-object.md +++ b/docs/mfc/retrieving-data-from-the-dialog-object.md @@ -3,11 +3,13 @@ description: "Learn more about: Retrieving Data from the Dialog Object" title: "Retrieving Data from the Dialog Object" ms.date: "11/04/2016" helpviewer_keywords: ["dialog boxes [MFC], retrieving user data", "dialog box data [MFC]", "data [MFC], retrieving", "GetDlgItemText method [MFC]", "SetDlgItemText method [MFC]", "SetWindowText method [MFC]", "dialog box data [MFC], retrieving", "retrieving data [MFC]", "user input [MFC], retrieving from MFC dialog boxes", "capturing user input [MFC]", "dialog box controls [MFC], initializing values", "DDX (dialog data exchange) [MFC]", "MFC dialog boxes [MFC], retrieving user input", "data retrieval [MFC], dialog boxes", "data [MFC], dialog boxes", "DDX (dialog data exchange) [MFC], about DDX", "DDX (dialog data exchange) [MFC], retrieving data from Dialog object", "GetWindowText method [MFC]"] -ms.assetid: bdca2b61-6b53-4c2e-b426-8712c7a38ec0 ms.topic: concept-article --- # Retrieving Data from the Dialog Object +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The framework provides an easy way to initialize the values of controls in a dialog box and to retrieve values from the controls. The more laborious manual approach is to call functions such as the `SetDlgItemText` and `GetDlgItemText` member functions of class `CWnd`, which apply to control windows. With these functions, you access each control individually to set or get its value, calling functions such as `SetWindowText` and `GetWindowText`. The framework's approach automates both initialization and retrieval. Dialog data exchange (DDX) lets you exchange data between the controls in the dialog box and member variables in the dialog object more easily. This exchange works both ways. To initialize the controls in the dialog box, you can set the values of data members in the dialog object, and the framework will transfer the values to the controls before the dialog box is displayed. Then you can at any time update the dialog data members with data entered by the user. At that point, you can use the data by referring to the data member variables. diff --git a/docs/mfc/ribbon-designer-mfc.md b/docs/mfc/ribbon-designer-mfc.md index d642ff01095..92a66a7e4ec 100644 --- a/docs/mfc/ribbon-designer-mfc.md +++ b/docs/mfc/ribbon-designer-mfc.md @@ -4,10 +4,12 @@ title: "Ribbon Designer (MFC)" ms.date: "11/19/2018" f1_keywords: ["vc.editors.ribbon.F1"] helpviewer_keywords: ["Ribbon Designer (MFC)", "MFC Ribbon Designer"] -ms.assetid: 0806dfd6-7d11-471a-99e1-4072852231f9 --- # Ribbon Designer (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Ribbon Designer lets you create and customize ribbons in MFC applications. A ribbon is a user interface (UI) element that organizes commands into logical groups. These groups appear on separate tabs in a strip across the top of the window. The ribbon replaces the menu bar and toolbars. A ribbon can significantly improve application usability. For more information, see [Ribbons](/windows/win32/uxguide/cmd-ribbons). The following illustration shows a ribbon. ![MFC Ribbon Resource Control.](../mfc/media/ribbon_no_callouts.png "MFC Ribbon Resource Control") diff --git a/docs/mfc/rich-edit-control-examples.md b/docs/mfc/rich-edit-control-examples.md index 8a37dc61eb9..f5b095f2dc4 100644 --- a/docs/mfc/rich-edit-control-examples.md +++ b/docs/mfc/rich-edit-control-examples.md @@ -2,10 +2,12 @@ description: "Learn more about: Rich Edit Control Examples" title: "Rich Edit Control Examples" ms.date: "02/06/2019" -ms.assetid: ac98bf45-ca74-459c-9b3e-df278a67a00f --- # Rich Edit Control Examples +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The MFC OLE sample [WORDPAD](https://github.com/Microsoft/VCSamples/tree/da802c2aa92a730b3da33c5957186f128709c398/VC2010Samples/MFC/Visual%20C%2B%2B%202008%20Feature%20Pack/WordPad) uses the `CRichEditView`, `CRichEditDoc`, and `CRichEditCntrItem` classes. By extension, it uses the [CRichEditCtrl](../mfc/reference/cricheditctrl-class.md). For a quick description of these three classes, see [Classes Related to Rich Edit Controls](../mfc/classes-related-to-rich-edit-controls.md). ## See also diff --git a/docs/mfc/role-of-the-view-in-printing.md b/docs/mfc/role-of-the-view-in-printing.md index d6d0724eeaa..5900d5ab150 100644 --- a/docs/mfc/role-of-the-view-in-printing.md +++ b/docs/mfc/role-of-the-view-in-printing.md @@ -3,10 +3,12 @@ description: "Learn more about: Role of the View in Printing" title: "Role of the View in Printing" ms.date: "11/04/2016" helpviewer_keywords: ["views [MFC], printing", "OnDraw method [MFC], and printing", "printing [MFC], OnDraw method [MFC]", "printing [MFC], views", "CView class [MFC], role in printing", "printing views [MFC]"] -ms.assetid: 8d4a3c8e-1fce-4edc-b608-94cb5f3e487e --- # Role of the View in Printing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Your view also plays two important roles in printing its associated document. The view: diff --git a/docs/mfc/root-class-cobject.md b/docs/mfc/root-class-cobject.md index 3f59550cd10..faaf0b9e8cb 100644 --- a/docs/mfc/root-class-cobject.md +++ b/docs/mfc/root-class-cobject.md @@ -3,10 +3,12 @@ description: "Learn more about: Root Class: CObject" title: "Root Class: CObject" ms.date: "11/04/2016" helpviewer_keywords: ["base classes [MFC], MFC objects", "classes [MFC], MFC base class [MFC]", "root class [MFC]", "MFC, base class"] -ms.assetid: 593706f3-e9e5-435f-815d-e7b5176b2a61 --- # Root Class: CObject +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Most of the classes in the Microsoft Foundation Class (MFC) Library are derived from a single base class at the root of the class hierarchy. `CObject` provides a number of useful capabilities to all classes derived from it, with very low overhead. For more information about `CObject` and its capabilities, see [Using CObject](../mfc/using-cobject.md). [CObject](../mfc/reference/cobject-class.md)
diff --git a/docs/mfc/rubber-banding-and-trackers.md b/docs/mfc/rubber-banding-and-trackers.md index 78313d57451..0e3385f5383 100644 --- a/docs/mfc/rubber-banding-and-trackers.md +++ b/docs/mfc/rubber-banding-and-trackers.md @@ -3,11 +3,13 @@ description: "Learn more about: Rubber-Banding and Trackers" title: "Rubber-Banding and Trackers" ms.date: "11/04/2016" helpviewer_keywords: ["trackers [MFC]", "CRectTracker class [MFC], implementing trackers", "OLE objects [MFC], selecting", "rubber banding [MFC]", "WM_LBUTTONDOWN [MFC]"] -ms.assetid: 0d0fa64c-6418-4baf-ab7f-2d16ca039230 ms.topic: concept-article --- # Rubber-Banding and Trackers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Another feature supplied with trackers is the "rubber-band" selection, which allows a user to select multiple OLE items by dragging a sizing rectangle around the items to be selected. When the user releases the left mouse button, items within the region selected by the user are selected and can be manipulated by the user. For instance, the user might drag the selection into another container application. Implementing this feature requires some additional code in your application's WM_LBUTTONDOWN handler function. diff --git a/docs/mfc/run-member-function.md b/docs/mfc/run-member-function.md index d9524c34a85..6c22de662c5 100644 --- a/docs/mfc/run-member-function.md +++ b/docs/mfc/run-member-function.md @@ -3,10 +3,12 @@ description: "Learn more about: Run Member Function" title: "Run Member Function" ms.date: "11/04/2016" helpviewer_keywords: ["WinMain method [MFC]"] -ms.assetid: 24ab7597-2354-495b-9a20-2c8ccc7385b3 --- # Run Member Function +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A framework application spends most of its time in the [Run](../mfc/reference/cwinapp-class.md#run) member function of class [CWinApp](../mfc/reference/cwinapp-class.md). After initialization, `WinMain` calls `Run` to process the message loop. `Run` cycles through a message loop, checking the message queue for available messages. If a message is available, `Run` dispatches it for action. If no messages are available, which is often true, `Run` calls `OnIdle` to do any idle-time processing that you or the framework may need done. If there are no messages and no idle processing to do, the application waits until something happens. When the application terminates, `Run` calls `ExitInstance`. The figure in [OnIdle Member Function](../mfc/onidle-member-function.md) shows the sequence of actions in the message loop. diff --git a/docs/mfc/scrolling-and-scaling-views.md b/docs/mfc/scrolling-and-scaling-views.md index ae3f1dd968d..ab7a05dacbb 100644 --- a/docs/mfc/scrolling-and-scaling-views.md +++ b/docs/mfc/scrolling-and-scaling-views.md @@ -3,11 +3,13 @@ description: "Learn more about: Scrolling and Scaling Views" title: "Scrolling and Scaling Views" ms.date: "11/04/2016" helpviewer_keywords: ["message handlers [MFC]", "scaling views [MFC]", "message handling [MFC], scroll bars in view class [MFC]", "scroll bars [MFC], messages", "scrolling views [MFC]"] -ms.assetid: f98a3421-c336-407e-97ee-dbb2ffd76fbd ms.topic: concept-article --- # Scrolling and Scaling Views +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC supports views that scroll and views that are automatically scaled to the size of the frame window that displays them. Class `CScrollView` supports both kinds of views. For more information about scrolling and scaling, see class [CScrollView](../mfc/reference/cscrollview-class.md) in the *MFC Reference*. For a scrolling example, see the [Scribble sample](../overview/visual-cpp-samples.md). diff --git a/docs/mfc/scrolling-arranging-sorting-and-finding-in-list-controls.md b/docs/mfc/scrolling-arranging-sorting-and-finding-in-list-controls.md index 118697bf2bf..d2f6e704ec7 100644 --- a/docs/mfc/scrolling-arranging-sorting-and-finding-in-list-controls.md +++ b/docs/mfc/scrolling-arranging-sorting-and-finding-in-list-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Scrolling, Arranging, Sorting, and Finding in Li title: "Scrolling, Arranging, Sorting, and Finding in List Controls" ms.date: "06/03/2019" helpviewer_keywords: ["image lists [MFC], sorting", "image lists [MFC], arranging", "image lists [MFC], scrolling", "CListCtrl class [MFC], finding items in", "image lists [MFC], finding items", "CListCtrl class [MFC], scrolling", "CListCtrl class [MFC], sorting", "CListCtrl class [MFC], arranging the list"] -ms.assetid: dcc51e4c-0ca8-4319-bec5-6994cc8ac9e5 --- # Scrolling, Arranging, Sorting, and Finding in List Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + List controls ([CListCtrl](../mfc/reference/clistctrl-class.md)) are scrollable by default. For more information, see [Scroll Position](/windows/win32/Controls/using-list-view-controls) in the Windows SDK and the [Scroll](../mfc/reference/clistctrl-class.md#scroll) member function. You can call `CListCtrl` member functions to arrange list items in the control, sort items, and find particular items. For more information, see [Using ListView Controls](/windows/win32/Controls/using-list-view-controls) in the Windows SDK and the [CListCtrl](../mfc/reference/clistctrl-class.md) members [Arrange](../mfc/reference/clistctrl-class.md#arrange), [SortItems](../mfc/reference/clistctrl-class.md#sortitems), and [FindItem](../mfc/reference/clistctrl-class.md#finditem). diff --git a/docs/mfc/sdi-and-mdi.md b/docs/mfc/sdi-and-mdi.md index 9eb07bb3531..0d8faf95203 100644 --- a/docs/mfc/sdi-and-mdi.md +++ b/docs/mfc/sdi-and-mdi.md @@ -3,10 +3,12 @@ description: "Learn more about: SDI and MDI" title: "SDI and MDI" ms.date: "11/04/2016" helpviewer_keywords: ["frame windows [MFC], SDI applications", "frame windows [MFC], MDI applications", "MFC, windows", "single document interface (SDI) [MFC], applications", "MDI [MFC], vs. SDI"] -ms.assetid: bb7239d9-4759-4f63-bfff-44a04b48c067 --- # SDI and MDI +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC makes it easy to work with both single-document interface (SDI) and multiple-document interface (MDI) applications. SDI applications allow only one open document frame window at a time. MDI applications allow multiple document frame windows to be open in the same instance of an application. An MDI application has a window within which multiple MDI child windows, which are frame windows themselves, can be opened, each containing a separate document. In some applications, the child windows can be of different types, such as chart windows and spreadsheet windows. In that case, the menu bar can change as MDI child windows of different types are activated. diff --git a/docs/mfc/security-implications-of-customization.md b/docs/mfc/security-implications-of-customization.md index e5a33963ddb..ba8a5191d15 100644 --- a/docs/mfc/security-implications-of-customization.md +++ b/docs/mfc/security-implications-of-customization.md @@ -3,10 +3,12 @@ description: "Learn more about: Security Implications of Customization" title: "Security Implications of Customization" ms.date: "11/04/2016" helpviewer_keywords: ["security, MFC Feature Pack", "MFC Feature Pack, security"] -ms.assetid: 9be96b12-be38-43bd-a133-5d671265f7a1 --- # Security Implications of Customization +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic discusses a potential security weakness in MFC. ## Potential Security Weakness diff --git a/docs/mfc/selecting-a-graphic-object-into-a-device-context.md b/docs/mfc/selecting-a-graphic-object-into-a-device-context.md index 722c6609e74..a1946b710d9 100644 --- a/docs/mfc/selecting-a-graphic-object-into-a-device-context.md +++ b/docs/mfc/selecting-a-graphic-object-into-a-device-context.md @@ -3,11 +3,13 @@ description: "Learn more about: Selecting a Graphic Object into a Device Context title: "Selecting a Graphic Object into a Device Context" ms.date: "11/04/2016" helpviewer_keywords: ["graphic objects [MFC], selecting into device context", "SelectObject method [MFC]", "GDI objects [MFC], device contexts", "lifetime, graphic objects [MFC]", "device contexts, selecting graphic objects into", "device contexts, graphic objects [MFC]"] -ms.assetid: cf54a330-63ef-421f-83eb-90ec7bd82eef ms.topic: concept-article --- # Selecting a Graphic Object into a Device Context +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This topic applies to using graphic objects in a window's device context. After you [create a drawing object](../mfc/one-stage-and-two-stage-construction-of-objects.md), you must select it into the device context in place of the default object stored there: [!code-cpp[NVC_MFCDocViewSDI#7](../mfc/codesnippet/cpp/selecting-a-graphic-object-into-a-device-context_1.cpp)] diff --git a/docs/mfc/sequence-of-operations-for-building-mfc-applications.md b/docs/mfc/sequence-of-operations-for-building-mfc-applications.md index 3c77d334150..a19042a0516 100644 --- a/docs/mfc/sequence-of-operations-for-building-mfc-applications.md +++ b/docs/mfc/sequence-of-operations-for-building-mfc-applications.md @@ -3,10 +3,12 @@ description: "Learn more about: Sequence of Operations for Building MFC Applicat title: "Sequence of Operations for Building MFC Applications" ms.date: "09/09/2019" helpviewer_keywords: ["applications [MFC], developing"] -ms.assetid: 6973c714-fe20-48c6-926b-de88356b3a3d --- # Sequence of Operations for Building MFC Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table explains the general sequence you might typically follow as you develop your MFC application. ### Sequence for Building an Application with the Framework @@ -14,8 +16,8 @@ The following table explains the general sequence you might typically follow as |Task|You do|The framework does| |----------|------------|------------------------| |Create a skeleton application.|Run the [MFC Application Wizard](../mfc/reference/mfc-application-wizard.md). Specify the options you want in the options pages. Options include making the application a COM component, container, or both; adding Automation; and making the application database-aware.|The MFC Application Wizard creates the files for a skeleton application, including source files for your application, document, view, and frame windows; a resource file; a project file; and others, all tailored to your specifications.| -|See what the framework and the MFC Application Wizard offer without adding a line of your own code.|Build the skeleton application and run it in Visual C++.|The running skeleton application derives many standard **File**, **Edit**, **View**, and **Help** menu commands from the framework. For MDI applications, you also get a fully functional Windows menu, and the framework manages creation, arrangement, and destruction of MDI child windows.| -|Construct your application's user interface.|Use the Visual C++ [resource editors](../windows/resource-editors.md) to visually edit the application's user interface:

- Create menus.
- Define accelerators.
- Create dialog boxes.
- Create and edit bitmaps, icons, and cursors.
- Edit the toolbar created for you by the MFC Application Wizard.
- Create and edit other resources.

You can also test the dialog boxes in the dialog editor.|The default resource file created by the MFC Application Wizard supplies many of the resources you need. Visual C++ lets you edit existing resources and add new resources easily and visually.| +|See what the framework and the MFC Application Wizard offer without adding a line of your own code.|Build the skeleton application and run it in Visual Studio.|The running skeleton application derives many standard **File**, **Edit**, **View**, and **Help** menu commands from the framework. For MDI applications, you also get a fully functional Windows menu, and the framework manages creation, arrangement, and destruction of MDI child windows.| +|Construct your application's user interface.|Use the Visual Studio [resource editors](../windows/resource-editors.md) to visually edit the application's user interface:

- Create menus.
- Define accelerators.
- Create dialog boxes.
- Create and edit bitmaps, icons, and cursors.
- Edit the toolbar created for you by the MFC Application Wizard.
- Create and edit other resources.

You can also test the dialog boxes in the dialog editor.|The default resource file created by the MFC Application Wizard supplies many of the resources you need. Visual Studio lets you edit existing resources and add new resources easily and visually.| |Map menus to handler functions.|Use the **Events** button in the [**Properties** window](/visualstudio/ide/reference/properties-window) in **Class View** (or the **Commands** tab in [Class Wizard](reference/mfc-class-wizard.md)) to connect menus and accelerators to handler functions in your code.|These tools insert message-map entries and empty function templates into the source files you specify and manages many manual coding tasks.| |Write your handler code.|Use Class View to jump directly to the code in the source code editor. Fill in the code for your handler functions. For more information on using Class View and about wizards that add code to a project, see [Adding Functionality with Code Wizards](../ide/adding-functionality-with-code-wizards-cpp.md).|Class View opens the editor, scrolls to the empty function template and positions the cursor for you.| |Map toolbar buttons to commands.|Map each button on your toolbar to a menu or accelerator command by assigning the button the appropriate command ID.|The framework controls the drawing, enabling, disabling, checking, and other visual aspects of the toolbar buttons.| @@ -33,7 +35,7 @@ The following table explains the general sequence you might typically follow as |Create database forms.|If you want a form-based data-access application, derive your view class from [CRecordView](../mfc/reference/crecordview-class.md) (for ODBC programming).|The view works like a form view, but its controls are connected to the fields of a [CRecordset](../mfc/reference/crecordset-class.md) object representing a database table. MFC moves data between the controls and the recordset for you.| |Create a simple text editor.|If you want your view to be a simple text editor, derive your view class or classes from [CEditView](../mfc/reference/ceditview-class.md) or [CRichEditView](../mfc/reference/cricheditview-class.md).|The view provides editing functions, Clipboard support, and file input/output. `CRichEditView` provides styled text.| |Add splitter windows.|If you want to support window splitting, add a [CSplitterWnd](../mfc/reference/csplitterwnd-class.md) object to your SDI frame window or MDI child window and hook it up in the window's [OnCreateClient](../mfc/reference/cframewnd-class.md#oncreateclient) member function.|The framework supplies splitter-box controls next to the scroll bars and manages splitting your view into multiple panes. If the user splits a window, the framework creates and attaches additional view objects to the document.| -|Build, test, and debug your application.|Use the facilities of Visual C++ to build, test, and debug your application.|Visual C++ lets you adjust compile, link, and other options. It also lets you browse your source code and class structure.| +|Build, test, and debug your application.|Use the facilities of Visual Studio to build, test, and debug your application.|Visual Studio lets you adjust compile, link, and other options. It also lets you browse your source code and class structure.| ## See also diff --git a/docs/mfc/sequence-of-operations-for-creating-activex-controls.md b/docs/mfc/sequence-of-operations-for-creating-activex-controls.md index 1b1dc9884d5..ac9ef6254a2 100644 --- a/docs/mfc/sequence-of-operations-for-creating-activex-controls.md +++ b/docs/mfc/sequence-of-operations-for-creating-activex-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Sequence of Operations for Creating ActiveX Cont title: "Sequence of Operations for Creating ActiveX Controls" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], creating", "ActiveX controls [MFC], creating", "sequence [MFC], for creating ActiveX controls", "OLE controls [MFC], MFC", "sequence [MFC]"] -ms.assetid: 7d868c53-a0af-4ef6-a89c-e1c03c583a53 --- # Sequence of Operations for Creating ActiveX Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table shows your role and the framework's role in creating ActiveX controls (formerly known as OLE controls). ### Creating ActiveX Controls @@ -16,7 +18,7 @@ The following table shows your role and the framework's role in creating ActiveX |Create an ActiveX control framework.|Run the MFC ActiveX Control Wizard to create your control. Specify the options you want in the options pages. Options include the type and name of the control in the project, licensing, subclassing, and an About Box method.|The MFC ActiveX Control Wizard creates the files for an ActiveX control with basic functionality, including source files for your application, control, and property page or pages; a resource file; a project file; and others, all tailored to your specifications.| |See what the control and the ActiveX Control Wizard offer without adding a line of your own code.|Build the ActiveX control and test it with Internet Explorer or the [TSTCON sample](../overview/visual-cpp-samples.md).|The running control has the ability to be resized and moved. It also has an **About Box** method (if chosen) that can be invoked.| |Implement the control's methods and properties.|Implement your control-specific methods and properties by adding member functions to provide an exposed interface to the control's data. Add member variables to hold data structures and use event handlers to fire events when you determine.|The framework has already defined a map to support the control's events, properties, and methods, leaving you to focus on how the properties and methods are implemented. The default property page is viewable and a default About Box method is supplied.| -|Construct the control's property page or pages.|Use the Visual C++ resource editors to visually edit the control's property page interface:

- Create additional property pages.
- Create and edit bitmaps, icons, and cursors.

You can also test the property page(s) in the dialog editor.|The default resource file created by the MFC Application Wizard supplies many of the resources you need. Visual C++ lets you edit existing resources and add new resources easily and visually.| +|Construct the control's property page or pages.|Use the Visual Studio resource editors to visually edit the control's property page interface:

- Create additional property pages.
- Create and edit bitmaps, icons, and cursors.

You can also test the property page(s) in the dialog editor.|The default resource file created by the MFC Application Wizard supplies many of the resources you need. Visual Studio lets you edit existing resources and add new resources easily and visually.| |Test the control's events, methods, and properties.|Rebuild the control and use Test Container to test that your handlers work correctly.|You can invoke the control's methods and manipulate its properties through the property page interface or through Test Container. In addition, use Test Container to track events fired from the control and notifications received by the control's container.| ## See also diff --git a/docs/mfc/sequence-of-operations-for-creating-database-applications.md b/docs/mfc/sequence-of-operations-for-creating-database-applications.md index 2f39ff70f31..ea35c960ae0 100644 --- a/docs/mfc/sequence-of-operations-for-creating-database-applications.md +++ b/docs/mfc/sequence-of-operations-for-creating-database-applications.md @@ -3,14 +3,16 @@ description: "Learn more about: Sequence of Operations for Creating Database App title: "Sequence of Operations for Creating Database Applications" ms.date: "11/04/2016" helpviewer_keywords: ["applications [MFC], database", "database applications [MFC]", "database applications [MFC], creating", "MFC, database applications"] -ms.assetid: 9371da59-8536-43cd-8314-706ad320e2ec --- # Sequence of Operations for Creating Database Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table shows your role and the framework's role in writing database applications. > [!NOTE] -> The Visual C++ environment and wizards do not support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use ODBC for new MFC projects. You should only use DAO in maintaining existing applications. +> The Visual Studio environment and wizards do not support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use ODBC for new MFC projects. You should only use DAO in maintaining existing applications. ### Creating Database Applications @@ -18,7 +20,7 @@ The following table shows your role and the framework's role in writing database |----------|------------|------------------------| |Decide whether to use the MFC ODBC or DAO classes.|Use ODBC for new MFC projects. Use DAO only to maintain existing applications. For general information, see the article [Data Access Programming](../data/data-access-programming-mfc-atl.md).|The framework supplies classes that support database access.| |Create your skeleton application with database options.|Run the MFC Application Wizard. Select options on the Database Support page. If you choose an option that creates a record view, also specify:

- Data source and table name or names
- Query name or names.|The MFC Application Wizard creates files and specifies the necessary includes. Depending on the options you specify, the files can include a recordset class.| -|Design your database form or forms.|Use the Visual C++ dialog editor to place controls on the dialog template resources for your record view classes.|The MFC Application Wizard creates an empty dialog template resource for you to fill in.| +|Design your database form or forms.|Use the Visual Studio dialog editor to place controls on the dialog template resources for your record view classes.|The MFC Application Wizard creates an empty dialog template resource for you to fill in.| |Create additional record view and recordset classes as needed.|Use Class View to create the classes and the dialog editor to design the views.|Class View creates additional files for your new classes.| |Create recordset objects as needed in your code. Use each recordset to manipulate records...|Your recordsets are based on the classes derived from [CRecordset](../mfc/reference/crecordset-class.md) with the wizards.|ODBC uses record field exchange (RFX) to exchange data between the database and your recordset's field data members. If you are using a record view, dialog data exchange (DDX) exchanges data between the recordset and the controls on the record view.| |...or create an explicit [CDatabase](../mfc/reference/cdatabase-class.md) in your code for each database you want to open.|Base your recordset objects on the database objects.|The database object provides an interface to the data source.| diff --git a/docs/mfc/sequence-of-operations-for-creating-ole-applications.md b/docs/mfc/sequence-of-operations-for-creating-ole-applications.md index 067edaef529..3ea89654f37 100644 --- a/docs/mfc/sequence-of-operations-for-creating-ole-applications.md +++ b/docs/mfc/sequence-of-operations-for-creating-ole-applications.md @@ -3,10 +3,12 @@ description: "Learn more about: Sequence of Operations for Creating OLE Applicat title: "Sequence of Operations for Creating OLE Applications" ms.date: "11/04/2016" helpviewer_keywords: ["OLE applications [MFC], creating", "OLE applications [MFC]", "applications [OLE], creating", "applications [OLE]"] -ms.assetid: 84b0f606-36c1-4253-9cea-44427f0074b9 --- # Sequence of Operations for Creating OLE Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table shows your role and the framework's role in creating OLE linking and embedding applications. These represent options available rather than a sequence of steps to perform. ### Creating OLE Applications diff --git a/docs/mfc/serialization-in-mfc.md b/docs/mfc/serialization-in-mfc.md index e864816e8ab..36fb257c7f9 100644 --- a/docs/mfc/serialization-in-mfc.md +++ b/docs/mfc/serialization-in-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Serialization in MFC" title: "Serialization in MFC" ms.date: "11/04/2016" helpviewer_keywords: ["collection classes [MFC], serialization", "bypassing serialization [MFC]", "MFC, serialization", "serialization [MFC], MFC", "serialization [MFC], bypassing"] -ms.assetid: fb596a18-4522-47e0-96e0-192732d24c12 --- # Serialization in MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the serialization mechanism provided in the Microsoft Foundation Class Library (MFC) to allow objects to persist between runs of your program. Serialization is the process of writing or reading an object to or from a persistent storage medium such as a disk file. Serialization is ideal for situations where it is desired to maintain the state of structured data (such as C++ classes or structures) during or after execution of a program. Using the serialization objects provided by MFC allows this to occur in a standard and consistent manner, relieving the user from the need to perform file operations by hand. diff --git a/docs/mfc/serialization-making-a-serializable-class.md b/docs/mfc/serialization-making-a-serializable-class.md index 1f99e1741f4..c5108c24f65 100644 --- a/docs/mfc/serialization-making-a-serializable-class.md +++ b/docs/mfc/serialization-making-a-serializable-class.md @@ -3,10 +3,12 @@ description: "Learn more about: Serialization: Making a Serializable Class" title: "Serialization: Making a Serializable Class" ms.date: "11/04/2016" helpviewer_keywords: ["serializable class [MFC]", "DECLARE_SERIAL macro [MFC]", "default constructor [MFC]", "VERSIONABLE_SCHEMA macro [MFC]", "classes [MFC], derived", "IMPLEMENT_SERIAL macro [MFC]", "no-arguments constructor [MFC]", "Serialize method, overriding", "defaults [MFC], constructor", "CObject class [MFC], deriving serializable classes", "constructors [MFC], defining with no arguments", "serialization [MFC], serializable classes", "no default constructor"] -ms.assetid: 59a14d32-1cc8-4275-9829-99639beee27c --- # Serialization: Making a Serializable Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Five main steps are required to make a class serializable. They are listed below and explained in the following sections: 1. [Deriving your class from CObject](#_core_deriving_your_class_from_cobject) (or from some class derived from `CObject`). diff --git a/docs/mfc/serialization-serialization-vs-database-input-output.md b/docs/mfc/serialization-serialization-vs-database-input-output.md index e1aca76ea6c..52e8a9d75a6 100644 --- a/docs/mfc/serialization-serialization-vs-database-input-output.md +++ b/docs/mfc/serialization-serialization-vs-database-input-output.md @@ -3,10 +3,12 @@ description: "Learn more about: Serialization: Serialization vs. Database Input/ title: "Serialization: Serialization vs. Database Input-Output" ms.date: "11/04/2016" helpviewer_keywords: ["database applications [MFC], file I/O vs. serialization", "serialization [MFC], vs. database I/O", "I/O [MFC], vs. serialization", "databases [MFC], input/output handling"] -ms.assetid: f1d23d77-4761-4a52-a7ea-54fc92d347ea --- # Serialization: Serialization vs. Database Input/Output +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains when to use document objects and serialization for file-based input/output (I/O) and when other I/O techniques are appropriate — because the application reads and writes data on a per-transaction basis, as in database applications. If you don't use serialization, you also won't need the File Open, Save, and Save As commands. Topics covered include: - [Recommendations for handling input/output](../mfc/recommendations-for-handling-input-output.md) diff --git a/docs/mfc/serialization-serializing-an-object.md b/docs/mfc/serialization-serializing-an-object.md index 232074c244b..cadb13d0f3f 100644 --- a/docs/mfc/serialization-serializing-an-object.md +++ b/docs/mfc/serialization-serializing-an-object.md @@ -3,10 +3,12 @@ description: "Learn more about: Serialization: Serializing an Object" title: "Serialization: Serializing an Object" ms.date: "11/04/2016" helpviewer_keywords: ["serializing objects [MFC]", "serialization [MFC], objects", "objects [MFC], serializing"] -ms.assetid: 1db772b1-ad55-4fcf-b133-126cca082510 --- # Serialization: Serializing an Object +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The article [Serialization: Making a Serializable Class](../mfc/serialization-making-a-serializable-class.md) shows how to make a class serializable. Once you have a serializable class, you can serialize objects of that class to and from a file via a [CArchive](../mfc/reference/carchive-class.md) object. This article explains: - [What a CArchive object is](../mfc/what-is-a-carchive-object.md). diff --git a/docs/mfc/serializing-data-to-and-from-files.md b/docs/mfc/serializing-data-to-and-from-files.md index 4131496be72..f261f8b8832 100644 --- a/docs/mfc/serializing-data-to-and-from-files.md +++ b/docs/mfc/serializing-data-to-and-from-files.md @@ -3,11 +3,13 @@ description: "Learn more about: Serializing Data to and from Files" title: "Serializing Data to and from Files" ms.date: "11/04/2016" helpviewer_keywords: ["documents [MFC], serialization", "documents [MFC], saving", "saving documents", "deserialization [MFC]", "serialization [MFC], role of document", "serialization [MFC], role of data", "data [MFC]", "data [MFC], serializing", "document data [MFC]"] -ms.assetid: b42a0c68-4bc4-4012-9938-5433a26d2c24 ms.topic: concept-article --- # Serializing Data to and from Files +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The basic idea of persistence is that an object should be able to write its current state, indicated by the values of its member variables, to persistent storage. Later, the object can be re-created by reading, or "deserializing," the object's state from persistent storage. A key point here is that the object itself is responsible for reading and writing its own state. Thus, for a class to be persistent, it must implement the basic serialization operations. The framework provides a default implementation for saving documents to disk files in response to the Save and Save As commands on the File menu and for loading documents from disk files in response to the Open command. With very little work, you can implement a document's ability to write and read its data to and from a file. The main thing you must do is override the [Serialize](../mfc/reference/cobject-class.md#serialize) member function in your document class. diff --git a/docs/mfc/servers-implementing-a-server.md b/docs/mfc/servers-implementing-a-server.md index c7b9e42a749..d7e904aaf38 100644 --- a/docs/mfc/servers-implementing-a-server.md +++ b/docs/mfc/servers-implementing-a-server.md @@ -3,10 +3,12 @@ description: "Learn more about: Servers: Implementing a Server" title: "Servers: Implementing a Server" ms.date: "11/04/2016" helpviewer_keywords: ["servers, implementing", "OLE server applications [MFC], implementing OLE servers"] -ms.assetid: 5bd57e8e-3b23-4f23-9597-496fac2d24b5 --- # Servers: Implementing a Server +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the code the MFC Application Wizard creates for a visual editing server application. If you are not using the application wizard, this article lists the areas where you must write code to implement a server application. If you are using the application wizard to create a new server application, it provides a significant amount of server-specific code for you. If you are adding visual editing server functionality to an existing application, you must duplicate the code that the application wizard would have provided before adding the rest of the necessary server code. diff --git a/docs/mfc/servers-implementing-in-place-frame-windows.md b/docs/mfc/servers-implementing-in-place-frame-windows.md index 3349e0c1357..8df12137b90 100644 --- a/docs/mfc/servers-implementing-in-place-frame-windows.md +++ b/docs/mfc/servers-implementing-in-place-frame-windows.md @@ -3,11 +3,13 @@ description: "Learn more about: Servers: Implementing In-Place Frame Windows" title: "Servers: Implementing In-Place Frame Windows" ms.date: "09/09/2019" helpviewer_keywords: ["frame windows [MFC], implementing", "OLE server applications [MFC], frame windows", "servers, in-place frame windows", "frame windows [MFC], in-place", "in-place frame windows"] -ms.assetid: 09bde4d8-15e2-4fba-8d14-9b954d926b92 --- # Servers: Implementing In-Place Frame Windows -This article explains what you must do to implement in-place frame windows in your visual editing server application if you do not use the application wizard to create your server application. In place of following the procedure outlined in this article, you could use an existing in-place frame-window class from either an application wizard-generated application or a sample provided with Visual C++. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +This article explains what you must do to implement in-place frame windows in your visual editing server application if you do not use the application wizard to create your server application. In place of following the procedure outlined in this article, you could use an existing in-place frame-window class from either an application wizard-generated application or a sample provided with Visual Studio. #### To declare an in-place frame-window class diff --git a/docs/mfc/servers-implementing-server-documents.md b/docs/mfc/servers-implementing-server-documents.md index 63a6bb9c0bb..05049ed51a8 100644 --- a/docs/mfc/servers-implementing-server-documents.md +++ b/docs/mfc/servers-implementing-server-documents.md @@ -3,10 +3,12 @@ description: "Learn more about: Servers: Implementing Server Documents" title: "Servers: Implementing Server Documents" ms.date: "11/04/2016" helpviewer_keywords: ["OLE server applications [MFC], managing server documents", "OLE server applications [MFC], implementing OLE servers", "servers, server documents", "server documents [MFC], implementing"] -ms.assetid: cca1451a-ad09-47ed-b56e-bccd78fc86d1 --- # Servers: Implementing Server Documents +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the steps you must take to successfully implement a server document if you did not specify the OLE Server option in the application wizard. #### To define a server document class diff --git a/docs/mfc/servers-server-items.md b/docs/mfc/servers-server-items.md index 86bcb8eb760..8ede0e366d0 100644 --- a/docs/mfc/servers-server-items.md +++ b/docs/mfc/servers-server-items.md @@ -3,10 +3,12 @@ description: "Learn more about: Servers: Server Items" title: "Servers: Server Items" ms.date: "11/04/2016" helpviewer_keywords: ["server items, implementing", "servers [MFC], server items", "architecture [MFC], server-item", "server items", "OLE server applications [MFC], server items"] -ms.assetid: 28ba81a1-726a-4728-a52d-68bc7efd5a3c --- # Servers: Server Items +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When a container launches a server so that a user can edit an embedded or linked OLE item, the server application creates a "server item." The server item, which is an object of a class derived from `COleServerItem`, provides an interface between the server document and the container application. The `COleServerItem` class defines several overridable member functions that are called by OLE, usually in response to requests from the container. Server items can represent part of the server document or the entire document. When an OLE item is embedded in the container document, the server item represents the entire server document. When the OLE item is linked, the server item can represent a part of the server document or the whole document, depending on whether the link is to a part or to the whole. diff --git a/docs/mfc/servers-user-interface-issues.md b/docs/mfc/servers-user-interface-issues.md index d0dd6bf54da..5c53ea2e53b 100644 --- a/docs/mfc/servers-user-interface-issues.md +++ b/docs/mfc/servers-user-interface-issues.md @@ -3,10 +3,12 @@ description: "Learn more about: Servers: User-Interface Issues" title: "Servers: User-Interface Issues" ms.date: "11/04/2016" helpviewer_keywords: ["OLE server applications [MFC], user interface", "servers, user-interface issues", "user interface issues"] -ms.assetid: 7ef55702-b439-43fa-8ced-c69b96239a89 --- # Servers: User-Interface Issues +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A server application has a number of features that must be added to the user interface to supply OLE items to container applications. For further information on the menus and additional resources that need to be added to a server application, see [Menus and Resources: Server Additions](../mfc/menus-and-resources-server-additions.md). ## See also diff --git a/docs/mfc/servers.md b/docs/mfc/servers.md index 79e33d42863..f4ad231f490 100644 --- a/docs/mfc/servers.md +++ b/docs/mfc/servers.md @@ -3,10 +3,12 @@ description: "Learn more about: Servers" title: "Servers" ms.date: "11/04/2016" helpviewer_keywords: ["OLE server applications [MFC]", "OLE server applications [MFC], activation", "full-server", "servers", "mini-server", "OLE server applications [MFC], server types", "server applications [MFC]"] -ms.assetid: e45172e8-eae3-400a-8139-0fa009a42fdc --- # Servers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A server application (or component application) creates OLE items (or components) for use by container applications. A visual editing server application also supports visual editing or in-place activation. Another form of OLE server is an [automation server](../mfc/automation-servers.md). Some server applications support only the creation of embedded items; others support the creation of both embedded and linked items. Some support linking only, although this is rare. All server applications must support activation by container applications when the user wants to edit an item. An application can be both a container and a server. In other words, it can both incorporate data into its documents, and create data that can be incorporated as items into other applications' documents. A miniserver is a special type of server application that can only be launched by a container. Microsoft Draw and Microsoft Graph are examples of miniservers. A miniserver does not store documents as files on disk. Instead, it reads its documents from and writes them to items in documents belonging to containers. As a result, a miniserver supports embedding only, not linking. diff --git a/docs/mfc/setting-a-hot-key.md b/docs/mfc/setting-a-hot-key.md index fbe03ecfbdd..902a72d9a00 100644 --- a/docs/mfc/setting-a-hot-key.md +++ b/docs/mfc/setting-a-hot-key.md @@ -3,11 +3,13 @@ description: "Learn more about: Setting a Hot Key" title: "Setting a Hot Key" ms.date: "11/04/2016" helpviewer_keywords: ["keyboard shortcuts [MFC], hot keys", "access keys [MFC], hot keys", "CHotKeyCtrl class [MFC], setting hot key"] -ms.assetid: 6f3bc141-e346-4dce-9ca7-3e6b2c453f3f ms.topic: concept-article --- # Setting a Hot Key +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Your application can use the information provided by a hot key ([CHotKeyCtrl](../mfc/reference/chotkeyctrl-class.md)) control in one of two ways: - Set up a global hot key for activating a nonchild window by sending a [WM_SETHOTKEY](/windows/win32/inputdev/wm-sethotkey) message to the window to be activated. diff --git a/docs/mfc/setting-the-day-state-of-a-month-calendar-control.md b/docs/mfc/setting-the-day-state-of-a-month-calendar-control.md index f563ff6a993..8e99333c363 100644 --- a/docs/mfc/setting-the-day-state-of-a-month-calendar-control.md +++ b/docs/mfc/setting-the-day-state-of-a-month-calendar-control.md @@ -4,11 +4,13 @@ title: "Setting the Day State of a Month Calendar Control" ms.date: "11/04/2016" f1_keywords: ["MCN_GETDAYSTATE"] helpviewer_keywords: ["CMonthCalCtrl class [MFC], setting day state info", "MCN_GETDAYSTATE notification [MFC]", "month calendar controls [MFC], day state info"] -ms.assetid: 435d1b11-ec0e-4121-9e25-aaa6af812a3c ms.topic: how-to --- # Setting the Day State of a Month Calendar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + One of the attributes of a month calendar control is the ability to store information, referred to as the day state of the control, for each day of the month. This information is used to emphasize certain dates for the month currently displayed. > [!NOTE] diff --git a/docs/mfc/setting-the-dialog-boxs-background-color.md b/docs/mfc/setting-the-dialog-boxs-background-color.md index f9636fc6710..5adc2f37f3c 100644 --- a/docs/mfc/setting-the-dialog-boxs-background-color.md +++ b/docs/mfc/setting-the-dialog-boxs-background-color.md @@ -7,6 +7,9 @@ ms.topic: concept-article --- # Setting the Dialog Box's Background Color +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can set the background color of your dialog boxes by handling `WM_CTLCOLOR` messages for the dialog box window. The color you set is used for only the specified dialog box. For example, the following code fragment sets the background color of the dialog box to dark grey. The `OnCtlColor` member function is called whenever the dialog box is redrawn: diff --git a/docs/mfc/setting-the-images-for-an-individual-item.md b/docs/mfc/setting-the-images-for-an-individual-item.md index d8b1d62da58..e871b56a334 100644 --- a/docs/mfc/setting-the-images-for-an-individual-item.md +++ b/docs/mfc/setting-the-images-for-an-individual-item.md @@ -3,11 +3,13 @@ description: "Learn more about: Setting the Images for an Individual Item" title: "Setting the Images for an Individual Item" ms.date: "11/04/2016" helpviewer_keywords: ["extended combo boxes [MFC], images", "images [MFC], combo box items"] -ms.assetid: bde83db8-23a7-4e35-837a-c86447d2c0af ms.topic: how-to --- # Setting the Images for an Individual Item +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The different types of images used by the extended combo box item are determined by the values in the *iImage*, *iSelectedImage*, and *iOverlay* members of the [COMBOBOXEXITEM](/windows/win32/api/commctrl/ns-commctrl-comboboxexitemw) structure. Each value is the index of an image in the associated image list of the control. By default, these members are set to 0, causing the control to display no image for the item. If you want to use images for a specific item, you can modify the structure accordingly, either when inserting the combo box item or by modifying an existing combo box item. ## Setting the Image for a New Item diff --git a/docs/mfc/setting-the-mode-of-a-cstatusbarctrl-object.md b/docs/mfc/setting-the-mode-of-a-cstatusbarctrl-object.md index 2b6710e45a3..cbf9cb32b0f 100644 --- a/docs/mfc/setting-the-mode-of-a-cstatusbarctrl-object.md +++ b/docs/mfc/setting-the-mode-of-a-cstatusbarctrl-object.md @@ -3,11 +3,13 @@ description: "Learn more about: Setting the Mode of a CStatusBarCtrl Object" title: "Setting the Mode of a CStatusBarCtrl Object" ms.date: "11/04/2016" helpviewer_keywords: ["simple mode and status bar controls", "IsSimple method, using", "SetSimple method [MFC]", "status bar controls [MFC], simple and nonsimple modes", "non-simple mode and status bar controls", "CStatusBarCtrl class [MFC], simple and nonsimple modes"] -ms.assetid: ca6076e5-1501-4e33-8d35-9308941e46c0 ms.topic: concept-article --- # Setting the Mode of a CStatusBarCtrl Object +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + There are two modes for a `CStatusBarCtrl` object: simple and nonsimple. In the majority of cases, your status bar control will have one or more parts, along with text and perhaps an icon or icons. This is called the nonsimple mode. For more information on this mode, see [Initializing the Parts of a CStatusBarCtrl Object](../mfc/initializing-the-parts-of-a-cstatusbarctrl-object.md). However, there are cases where you only need to display a single line of text. In this case, the simple mode is sufficient for your needs. To change the mode of the `CStatusBarCtrl` object to simple, make a call to the [SetSimple](../mfc/reference/cstatusbarctrl-class.md#setsimple) member function. Once the status bar control is in simple mode, set the text by calling the `SetText` member function, passing 255 as the value for the *nPane* parameter. diff --git a/docs/mfc/settings-for-the-cstatusbarctrl.md b/docs/mfc/settings-for-the-cstatusbarctrl.md index a8ec8d51a93..332b48a0464 100644 --- a/docs/mfc/settings-for-the-cstatusbarctrl.md +++ b/docs/mfc/settings-for-the-cstatusbarctrl.md @@ -3,10 +3,12 @@ description: "Learn more about: Settings for the CStatusBarCtrl" title: "Settings for the CStatusBarCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["status bar controls [MFC], settings", "CStatusBarCtrl class [MFC], settings"] -ms.assetid: adeba0c3-17f3-435c-b140-a57845e9ce49 --- # Settings for the CStatusBarCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The default position of a [CStatusBarCtrl](../mfc/reference/cstatusbarctrl-class.md) status window is along the bottom of the parent window, but you can specify the CCS_TOP style to have it appear at the top of the parent window's client area. You can specify the SBARS_SIZEGRIP style to include a sizing grip at the right end of the `CStatusBarCtrl` status window. A sizing grip is similar to a sizing border; it is a rectangular area that the user can click and drag to resize the parent window. diff --git a/docs/mfc/settings-for-the-progress-control.md b/docs/mfc/settings-for-the-progress-control.md index 982abdb535b..778150af132 100644 --- a/docs/mfc/settings-for-the-progress-control.md +++ b/docs/mfc/settings-for-the-progress-control.md @@ -3,10 +3,12 @@ description: "Learn more about: Settings for the Progress Control" title: "Settings for the Progress Control" ms.date: "11/04/2016" helpviewer_keywords: ["CProgressCtrl class [MFC], settings", "progress controls [MFC], settings"] -ms.assetid: f4616e91-74fa-4000-ba0d-d3ddc0ee075b --- # Settings for the Progress Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The basic settings for the progress control ([CProgressCtrl](../mfc/reference/cprogressctrl-class.md)) are the range and current position. The range represents the entire duration of the operation. The current position represents the progress that your application has made toward completing the operation. Any changes to the range or position cause the progress control to redraw itself. By default, the range is set to 0 - 100, and the initial position is set to 0. To retrieve the current range settings for the progress control, use the [GetRange](../mfc/reference/cprogressctrl-class.md#getrange) member function. To change the range, use the [SetRange](../mfc/reference/cprogressctrl-class.md#setrange) member function. diff --git a/docs/mfc/settings-for-the-tool-tip-control.md b/docs/mfc/settings-for-the-tool-tip-control.md index 05c07197ab0..adde2501854 100644 --- a/docs/mfc/settings-for-the-tool-tip-control.md +++ b/docs/mfc/settings-for-the-tool-tip-control.md @@ -3,10 +3,12 @@ description: "Learn more about: Settings for the Tool Tip Control" title: "Settings for the Tool Tip Control" ms.date: "11/04/2016" helpviewer_keywords: ["tool tips [MFC], activating", "CToolTipCtrl class [MFC], settings"] -ms.assetid: ff8c5c46-2047-403a-bd98-ffec3d21ee3a --- # Settings for the Tool Tip Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can set the tool tip control ([CToolTipCtrl](../mfc/reference/ctooltipctrl-class.md)) to be either active or inactive. When you set it to be active, the tool tip control appears when the cursor is on a tool. When you set it to be inactive, the tool tip control does not appear, even if the cursor is on a tool. Call [Activate](../mfc/reference/ctooltipctrl-class.md#activate) to activate or deactivate a tool tip control. You can set an active tool tip to display the tool tip when the cursor is on a tool, whether or not the tool tip control's owner window is active or inactive, by using the TTS_ALWAYSTIP style. If you do not use this style, the tool tip control appears when the tool's owner window is active, but not when it is inactive. diff --git a/docs/mfc/settings-for-the-toolbar-control.md b/docs/mfc/settings-for-the-toolbar-control.md index 5649440229c..91e4a115f28 100644 --- a/docs/mfc/settings-for-the-toolbar-control.md +++ b/docs/mfc/settings-for-the-toolbar-control.md @@ -3,10 +3,12 @@ description: "Learn more about: Settings for the Toolbar Control" title: "Settings for the Toolbar Control" ms.date: "11/04/2016" helpviewer_keywords: ["toolbar controls [MFC], about toolbar controls", "CToolBarCtrl class [MFC], settings"] -ms.assetid: 025ba920-b3ee-4d82-9367-e652cd7875b9 --- # Settings for the Toolbar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The buttons on a toolbar can display a bitmap, a string, or both. By default, the image size is set to the dimensions of 16 by 15 pixels. All buttons are the same width, by default 24 by 22 pixels. A toolbar's height is determined by the height of the buttons, and a toolbar's width is the same as the width of the parent window's client area, also by default. A toolbar can have built-in customization features, including a system-defined customization dialog box, that allow the user to insert, delete, or rearrange toolbar buttons. An application determines whether the customization features are available to the user and controls the extent to which the user can customize the toolbar. For more information about customizing the toolbar, see class [CToolBarCtrl](../mfc/reference/ctoolbarctrl-class.md) in the *MFC Reference*. diff --git a/docs/mfc/simple-data-type-classes.md b/docs/mfc/simple-data-type-classes.md index 4e332b84f9c..d5dbfc4d22f 100644 --- a/docs/mfc/simple-data-type-classes.md +++ b/docs/mfc/simple-data-type-classes.md @@ -4,10 +4,12 @@ title: "Simple Data Type Classes" ms.date: "11/04/2016" f1_keywords: ["vc.classes.data"] helpviewer_keywords: ["scalar classes [MFC]", "data classes [MFC]", "simple data type classes [MFC]"] -ms.assetid: 0d591d68-0a33-49e9-8a6d-90c90de5c16a --- # Simple Data Type Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following classes encapsulate drawing coordinates, character strings, and time and date information, allowing convenient use of C++ syntax. These objects are used widely as parameters to the member functions of Windows classes in the class library. Because `CPoint`, `CSize`, and `CRect` correspond to the **POINT**, **SIZE**, and **RECT** structures, respectively, in the Windows SDK, you can use objects of these C++ classes wherever you can use these C-language structures. The classes provide useful interfaces through their member functions. `CStringT` provides very flexible dynamic character strings. `CTime`, `COleDateTime`, `CTimeSpan`, and `COleTimeSpan` represent time and date values. For more information about these classes, see the article [Date and Time](../atl-mfc-shared/date-and-time.md). The classes that begin with "`COle`" are encapsulations of data types provided by OLE. These data types can be used in Windows programs regardless of whether other OLE features are used. diff --git a/docs/mfc/slider-control-member-functions.md b/docs/mfc/slider-control-member-functions.md index 10e1c674727..3bd37f94b77 100644 --- a/docs/mfc/slider-control-member-functions.md +++ b/docs/mfc/slider-control-member-functions.md @@ -3,13 +3,15 @@ description: "Learn more about: Slider Control Member Functions" title: "Slider Control Member Functions" ms.date: "11/04/2016" helpviewer_keywords: ["CSliderCtrl class [MFC], methods", "slider controls [MFC], member functions"] -ms.assetid: dbde49ee-7306-4d14-a6ce-d09aa198178f --- # Slider Control Member Functions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An application can call the slider control's member functions to retrieve information about the slider control ([CSliderCtrl](../mfc/reference/csliderctrl-class.md)) and to change its characteristics. -To retrieve the position of the slider (that is, the value the user has chosen), use the [GetPos](../mfc/reference/csliderctrl-class.md#getpos) member function. To set the position of the slider, use the [SetPos](../mfc/reference/csliderctrl-class.md#setpos) member function. At any time you can use the `VerifyPos` member function to make sure that the slider is between the minimum and maximum values. +To retrieve the position of the slider (that is, the value the user has chosen), use the [GetPos](../mfc/reference/csliderctrl-class.md#getpos) member function. To set the position of the slider, use the [SetPos](../mfc/reference/csliderctrl-class.md#setpos) member function. The range of a slider control is the set of contiguous values that the slider control can represent. Most applications use the [SetRange](../mfc/reference/csliderctrl-class.md#setrange) member function to set the range of a slider control when it is first created. Applications can dynamically alter the range after the slider control has been created by using the [SetRangeMax](../mfc/reference/csliderctrl-class.md#setrangemax) and [SetRangeMin](../mfc/reference/csliderctrl-class.md#setrangemin) member functions. An application that allows the range to be changed dynamically typically retrieves the final range settings when the user has finished working with the slider control. To retrieve these settings, use the [GetRange](../mfc/reference/csliderctrl-class.md#getrange), [GetRangeMax](../mfc/reference/csliderctrl-class.md#getrangemax), and [GetRangeMin](../mfc/reference/csliderctrl-class.md#getrangemin) member functions. diff --git a/docs/mfc/slider-control-styles.md b/docs/mfc/slider-control-styles.md index b84fb69f468..b779c005ee2 100644 --- a/docs/mfc/slider-control-styles.md +++ b/docs/mfc/slider-control-styles.md @@ -3,10 +3,12 @@ description: "Learn more about: Slider Control Styles" title: "Slider Control Styles" ms.date: "11/04/2016" helpviewer_keywords: ["slider controls [MFC], styles", "CSliderCtrl class [MFC], styles", "styles [MFC], CSliderCtrl", "styles [MFC], slider controls"] -ms.assetid: 64c491fc-5af1-4f97-ae30-854071b3dc02 --- # Slider Control Styles +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Slider controls ([CSliderCtrl](../mfc/reference/csliderctrl-class.md)) can have either a vertical or horizontal orientation. They can have tick marks on either side, both sides, or neither. They can also be used to specify a range of consecutive values. These properties are controlled by using slider control styles, which you specify when you create the slider control. The TBS_HORZ and TBS_VERT styles determine the orientation of the slider control. If you do not specify an orientation, the slider control is oriented horizontally. diff --git a/docs/mfc/slider-notification-messages.md b/docs/mfc/slider-notification-messages.md index 3e750d22cde..da9382e3626 100644 --- a/docs/mfc/slider-notification-messages.md +++ b/docs/mfc/slider-notification-messages.md @@ -3,10 +3,12 @@ description: "Learn more about: Slider Notification Messages" title: "Slider Notification Messages" ms.date: "11/04/2016" helpviewer_keywords: ["CSliderCtrl class [MFC], notifications", "slider controls [MFC], notification messages", "messages, notification", "notifications [MFC], CSliderCtrl"] -ms.assetid: b9121104-3889-4a10-92bf-f3723f1af9d0 --- # Slider Notification Messages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A slider control notifies its parent window of user actions by sending the parent WM_HSCROLL or WM_VSCROLL messages, depending on the orientation of the slider control. To handle these messages, add handlers for the WM_HSCROLL and WM_VSCROLL messages to the parent window. The [OnHScroll](../mfc/reference/cwnd-class.md#onhscroll) and [OnVScroll](../mfc/reference/cwnd-class.md#onvscroll) member functions will be passed a notification code, the position of the slider, and a pointer to the [CSliderCtrl](../mfc/reference/csliderctrl-class.md) object. Note that the pointer is of type `CScrollBar *` even though it points to a `CSliderCtrl` object. You may need to typecast this pointer if you need to manipulate the slider control. Rather than using the scroll bar notification codes, slider controls send a different set of notification codes. A slider control sends the TB_BOTTOM, TB_LINEDOWN, TB_LINEUP, and TB_TOP notification codes only when the user interacts with a slider control by using the keyboard. The TB_THUMBPOSITION and TB_THUMBTRACK notification messages are only sent when the user is using the mouse. The TB_ENDTRACK, TB_PAGEDOWN, and TB_PAGEUP notification codes are sent in both cases. diff --git a/docs/mfc/special-cwinapp-services.md b/docs/mfc/special-cwinapp-services.md index ee7285fee54..e0f956d3860 100644 --- a/docs/mfc/special-cwinapp-services.md +++ b/docs/mfc/special-cwinapp-services.md @@ -4,10 +4,12 @@ title: "Special CWinApp Services" ms.date: "11/04/2016" f1_keywords: ["LoadStdProfileSettings", "EnableShellOpen"] helpviewer_keywords: ["files [MFC], most recently used", "DragAcceptFiles method [MFC]", "MRU lists", "GDI+, initializing for MFC", "GDI+, suppressing background thread [MFC]", "CWinApp class [MFC], shell registration", "application objects [MFC], services", "CWinApp class [MFC], initializing GDI+", "MFC, shell registration", "CWinApp class [MFC], File Manager drag and drop", "LoadStdProfileSettings method [MFC]", "MFC, most-recently-used file list", "RegisterShellFileTypes method [MFC]", "drag and drop [MFC], files", "registering file types", "Shell, registering file types", "services, provided by CWinApp", "CWinApp class [MFC], recently used documents", "CWinApp class [MFC], services", "files [MFC], drag and drop", "EnableShellOpen method [MFC]", "registry [MFC], most recently used files", "MFC, file operations", "registration [MFC], shell"] -ms.assetid: 0480cd01-f629-4249-b221-93432d95b431 --- # Special CWinApp Services +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Besides running the message loop and giving you an opportunity to initialize the application and clean up after it, [CWinApp](../mfc/reference/cwinapp-class.md) provides several other services. ## Shell Registration diff --git a/docs/mfc/specifying-levels-of-functionality.md b/docs/mfc/specifying-levels-of-functionality.md index cfaa99c8a47..5c5b2617a16 100644 --- a/docs/mfc/specifying-levels-of-functionality.md +++ b/docs/mfc/specifying-levels-of-functionality.md @@ -3,11 +3,13 @@ description: "Learn more about: Specifying Levels of Functionality" title: "Specifying Levels of Functionality" ms.date: "11/06/2018" helpviewer_keywords: ["CObject class [MFC], adding functionality to derived classes", "runtime [MFC], class information", "serialization [MFC], Cobject", "dynamic creation support", "levels [MFC], functionality in CObject", "run-time class [MFC], information support", "levels [MFC]"] -ms.assetid: 562669ba-c858-4f66-b5f1-b3beeea4f486 ms.topic: how-to --- # Specifying Levels of Functionality +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes how to add the following levels of functionality to your [CObject](../mfc/reference/cobject-class.md)-derived class: - Run-time class information diff --git a/docs/mfc/spin-button-member-functions.md b/docs/mfc/spin-button-member-functions.md index 9c2b9529356..5346069e91c 100644 --- a/docs/mfc/spin-button-member-functions.md +++ b/docs/mfc/spin-button-member-functions.md @@ -3,10 +3,12 @@ description: "Learn more about: Spin Button Member Functions" title: "Spin Button Member Functions" ms.date: "11/04/2016" helpviewer_keywords: ["spin button control, methods", "CSpinButtonCtrl class [MFC], methods"] -ms.assetid: a08a26fd-b803-4cbe-a509-395fa357d057 --- # Spin Button Member Functions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + There are several member functions available for the spin control ([CSpinButtonCtrl](../mfc/reference/cspinbuttonctrl-class.md)). Use these functions to change the following attributes of the spin button. - **Acceleration** You can adjust the rate at which the position changes when the user holds down the arrow button. To work with acceleration, use the [SetAccel](../mfc/reference/cspinbuttonctrl-class.md#setaccel) and [GetAccel](../mfc/reference/cspinbuttonctrl-class.md#getaccel) member functions. diff --git a/docs/mfc/spin-button-styles.md b/docs/mfc/spin-button-styles.md index aaa73fe9d2f..4abc91b2123 100644 --- a/docs/mfc/spin-button-styles.md +++ b/docs/mfc/spin-button-styles.md @@ -3,10 +3,12 @@ description: "Learn more about: Spin Button Styles" title: "Spin Button Styles" ms.date: "09/09/2019" helpviewer_keywords: ["styles [MFC], CSpinButtonCtrl", "CSpinButtonCtrl class [MFC], styles", "styles [MFC], spin button control", "spin button control, styles"] -ms.assetid: fb4a7f6f-9182-47be-bccf-0728fdc5332f --- # Spin Button Styles +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Many of the settings for a spin button ([CSpinButtonCtrl](../mfc/reference/cspinbuttonctrl-class.md)) are controlled by styles. You can set the following styles using the [Class Wizard](reference/mfc-class-wizard.md). - **Orientation** Either Vertical or Horizontal. Controls the orientation of the arrow buttons. Associated with the UDS_HORZ style. diff --git a/docs/mfc/standard-commands.md b/docs/mfc/standard-commands.md index 116be5bb811..6c1c07c796f 100644 --- a/docs/mfc/standard-commands.md +++ b/docs/mfc/standard-commands.md @@ -3,10 +3,12 @@ description: "Learn more about: Standard Commands" title: "Standard Commands" ms.date: "11/04/2016" helpviewer_keywords: ["File menu", "identifiers [MFC], command IDs", "command IDs, standard commands", "OLE commands", "commands [MFC], standard", "standard command IDs", "Window menu commands", "standard commands", "View menu commands", "Edit menu standard commands", "Help [MFC], menus", "programmer-defined IDs [MFC]"] -ms.assetid: 88cf3ab4-79b3-4ac6-9365-8ac561036fbf --- # Standard commands +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The framework defines many standard command messages. The IDs for these commands typically take the form **`ID__`**, where `` is usually a menu name and `` is a menu item. For example, the command ID for the **New** command on the **File** menu is `ID_FILE_NEW`. Standard command IDs are shown in bold type in the documentation. Programmer-defined IDs are shown in a font that's different from the surrounding text. The following list shows some of the most important commands supported: diff --git a/docs/mfc/status-bar-implementation-in-mfc.md b/docs/mfc/status-bar-implementation-in-mfc.md index 6ddeb263c87..343121838b1 100644 --- a/docs/mfc/status-bar-implementation-in-mfc.md +++ b/docs/mfc/status-bar-implementation-in-mfc.md @@ -4,10 +4,12 @@ title: "Status Bar Implementation in MFC" ms.date: "11/19/2018" f1_keywords: ["COldStatusBar"] helpviewer_keywords: ["status bars [MFC], implementing in MFC", "CStatusBarCtrl class [MFC], and MFC status bars", "CStatusBar class [MFC], and CStatusBarCtrl class [MFC]", "CStatusBarCtrl class [MFC], and CStatusBar class [MFC]", "status bars [MFC], backward compatibility", "status bars [MFC], old with COldStatusBar class [MFC]", "COldStatusBar class [MFC]", "status bars [MFC], and CStatusBarCtrl class", "CStatusBar class [MFC], and MFC status bars", "status indicators", "status bars [MFC], Windows 95 implementation"] -ms.assetid: be5cd876-38e3-4d5c-b8cb-16d57a16a142 --- # Status Bar Implementation in MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A [CStatusBar](../mfc/reference/cstatusbar-class.md) object is a control bar with a row of text output panes. The output panes are commonly used as message lines and as status indicators. Examples include the menu help-message lines that briefly explain the selected menu command and the indicators that show the status of the SCROLL LOCK, NUM LOCK, and other keys. As of MFC version 4.0, status bars are implemented using class [CStatusBarCtrl](../mfc/reference/cstatusbarctrl-class.md), which encapsulates a status bar common control. For backward compatibility, MFC retains the older status bar implementation in class `COldStatusBar`. The documentation for earlier versions of MFC describes `COldStatusBar` under `CStatusBar`. diff --git a/docs/mfc/status-bars.md b/docs/mfc/status-bars.md index d780d9410ee..29ff0152e63 100644 --- a/docs/mfc/status-bars.md +++ b/docs/mfc/status-bars.md @@ -3,10 +3,12 @@ description: "Learn more about: Status Bars" title: "Status Bars" ms.date: "11/04/2016" helpviewer_keywords: ["status bars", "control bars [MFC], status bar"] -ms.assetid: fcbc5029-1aab-4e14-adf7-419038a4935e --- # Status Bars +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Status bars give your application a place to display messages and useful information to the user without interrupting the user's work. Typically displayed at the bottom of a window, status bars have "panes," which include "indicators" and a "message line." The indicators give the status of such things as SCROLL LOCK, whether macro recording is turned on, and so on. The message line on the status bar can display information about program status or about a toolbar button or menu item that the user is pointing to with the mouse. Create a status bar in your program by selecting the **Initial Status Bar** option in the MFC Application Wizard. diff --git a/docs/mfc/steps-in-a-typical-ftp-client-application-to-delete-a-file.md b/docs/mfc/steps-in-a-typical-ftp-client-application-to-delete-a-file.md index fe0603edff7..e6f3ca36d29 100644 --- a/docs/mfc/steps-in-a-typical-ftp-client-application-to-delete-a-file.md +++ b/docs/mfc/steps-in-a-typical-ftp-client-application-to-delete-a-file.md @@ -3,11 +3,13 @@ description: "Learn more about: Steps in a Typical FTP Client Application to Del title: "Steps in a Typical FTP Client Application to Delete a File" ms.date: "11/04/2016" helpviewer_keywords: ["Internet client applications [MFC], FTP delete", "WinInet classes [MFC], FTP", "FTP (File Transfer Protocol) [MFC], client applications", "Internet applications [MFC], FTP client applications"] -ms.assetid: 2c347a96-c0a4-4827-98fe-668406e552bc ms.topic: how-to --- # Steps in a Typical FTP Client Application to Delete a File +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table shows the steps you might perform in a typical FTP client application that deletes a file. |Your goal|Actions you take|Effects| diff --git a/docs/mfc/steps-in-a-typical-ftp-client-application.md b/docs/mfc/steps-in-a-typical-ftp-client-application.md index c1d16114ffe..b1b865a3ea1 100644 --- a/docs/mfc/steps-in-a-typical-ftp-client-application.md +++ b/docs/mfc/steps-in-a-typical-ftp-client-application.md @@ -3,11 +3,13 @@ description: "Learn more about: Steps in a Typical FTP Client Application" title: "Steps in a Typical FTP Client Application" ms.date: "11/04/2016" helpviewer_keywords: ["Internet client applications [MFC], FTP table", "FTP (File Transfer Protocol)", "WinInet classes [MFC], FTP", "FTP (File Transfer Protocol) [MFC], client applications", "Internet applications [MFC], FTP client applications"] -ms.assetid: 70bed7b5-6040-40d1-bc77-702e63a698f2 ms.topic: how-to --- # Steps in a Typical FTP Client Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A typical FTP client application creates a [CInternetSession](../mfc/reference/cinternetsession-class.md) and a [CFtpConnection](../mfc/reference/cftpconnection-class.md) object. Note that these MFC WinInet classes do not actually control the proxy type settings; IIS does. The following table shows the steps you might perform in a typical FTP client application. diff --git a/docs/mfc/steps-in-a-typical-gopher-client-application.md b/docs/mfc/steps-in-a-typical-gopher-client-application.md index 4468557ab4d..8e6d6c44703 100644 --- a/docs/mfc/steps-in-a-typical-gopher-client-application.md +++ b/docs/mfc/steps-in-a-typical-gopher-client-application.md @@ -3,11 +3,13 @@ description: "Learn more about: Steps in a Typical Gopher Client Application" title: "Steps in a Typical Gopher Client Application" ms.date: "11/04/2016" helpviewer_keywords: ["WinInet classes [MFC], gopher", "Internet applications [MFC], gopher client applications", "Gopher client applications [MFC]", "Internet client applications [MFC], gopher table"] -ms.assetid: 3e4e1869-5da0-453d-8ba9-b648c894bb90 ms.topic: how-to --- # Steps in a Typical Gopher Client Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table shows the steps you might perform in a typical gopher client application. |Your goal|Actions you take|Effects| diff --git a/docs/mfc/steps-in-a-typical-http-client-application.md b/docs/mfc/steps-in-a-typical-http-client-application.md index fa830ffcdb9..59dd59a7cb3 100644 --- a/docs/mfc/steps-in-a-typical-http-client-application.md +++ b/docs/mfc/steps-in-a-typical-http-client-application.md @@ -3,11 +3,13 @@ description: "Learn more about: Steps in a Typical HTTP Client Application" title: "Steps in a Typical HTTP Client Application" ms.date: "11/04/2016" helpviewer_keywords: ["HTTP client applications [MFC]", "client applications [MFC], HTTP", "Internet applications [MFC], HTTP client applications", "applications [MFC], HTTP client", "Internet client applications [MFC], HTTP table", "WinInet classes [MFC], HTTP"] -ms.assetid: f86552e8-8acd-4b23-bdc5-0c3a247ebd74 ms.topic: how-to --- # Steps in a Typical HTTP Client Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table shows the steps you might perform in a typical HTTP client application: |Your goal|Actions you take|Effects| diff --git a/docs/mfc/steps-in-a-typical-internet-client-application.md b/docs/mfc/steps-in-a-typical-internet-client-application.md index 24f95bcbc51..4f1851ddc27 100644 --- a/docs/mfc/steps-in-a-typical-internet-client-application.md +++ b/docs/mfc/steps-in-a-typical-internet-client-application.md @@ -3,11 +3,13 @@ description: "Learn more about: Steps in a Typical Internet Client Application" title: "Steps in a Typical Internet Client Application" ms.date: "11/04/2016" helpviewer_keywords: ["Internet client applications [MFC], general table", "WinInet classes [MFC], programming", "Internet applications [MFC], client applications"] -ms.assetid: 7aba135c-7c15-4e2f-8c34-bbaf792c89a6 ms.topic: how-to --- # Steps in a Typical Internet Client Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The following table shows the steps you might perform in a typical Internet client application. |Your goal|Actions you take|Effects| diff --git a/docs/mfc/storing-and-loading-cobjects-via-an-archive.md b/docs/mfc/storing-and-loading-cobjects-via-an-archive.md index f08ce386eab..145b8d1f840 100644 --- a/docs/mfc/storing-and-loading-cobjects-via-an-archive.md +++ b/docs/mfc/storing-and-loading-cobjects-via-an-archive.md @@ -3,11 +3,13 @@ description: "Learn more about: Storing and Loading CObjects via an Archive" title: "Storing and Loading CObjects via an Archive" ms.date: "11/04/2016" helpviewer_keywords: ["CObjects [MFC], loading through archives", "CArchive class [MFC], storing and loading objects", "Serialize method, vs. CArchive operators", "CObject class [MFC], CArchive objects", "CObjects [MFC]"] -ms.assetid: a829b6dd-bc31-47e0-8108-fbb946722db9 ms.topic: concept-article --- # Storing and Loading CObjects via an Archive +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Storing and loading `CObject`s via an archive requires extra consideration. In certain cases, you should call the `Serialize` function of the object, where the `CArchive` object is a parameter of the `Serialize` call, as opposed to using the **<\<** or **>>** operator of the `CArchive`. The important fact to keep in mind is that the `CArchive` **>>** operator constructs the `CObject` in memory based on `CRuntimeClass` information previously written to the file by the storing archive. Therefore, whether you use the `CArchive` **<\<** and **>>** operators, versus calling `Serialize`, depends on whether you *need* the loading archive to dynamically reconstruct the object based on previously stored `CRuntimeClass` information. Use the `Serialize` function in the following cases: diff --git a/docs/mfc/stream-operations-in-rich-edit-controls.md b/docs/mfc/stream-operations-in-rich-edit-controls.md index 81ae2c76cec..04f1e5d277c 100644 --- a/docs/mfc/stream-operations-in-rich-edit-controls.md +++ b/docs/mfc/stream-operations-in-rich-edit-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Stream Operations in Rich Edit Controls" title: "Stream Operations in Rich Edit Controls" ms.date: "11/04/2016" helpviewer_keywords: ["CRichEditCtrl class [MFC], stream operations", "CRichEditCtrl class [MFC], stream storage", "rich edit controls [MFC], stream operations", "storage, stream in CRichEditCtrl", "stream operations in CRichEditCtrl", "stream storage and CRichEditCtrl"] -ms.assetid: 110b4684-1e76-4ca6-9ef0-5bc8b2d93c78 --- # Stream Operations in Rich Edit Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can use streams to transfer data into or out of a rich edit control ([CRichEditCtrl](../mfc/reference/cricheditctrl-class.md)). A stream is defined by an [EDITSTREAM](/windows/win32/api/richedit/ns-richedit-editstream) structure, which specifies a buffer and an application-defined callback function. To read data into a rich edit control (that is, stream the data in), use the [StreamIn](../mfc/reference/cricheditctrl-class.md#streamin) member function. The control repeatedly calls the application-defined callback function, which transfers a portion of the data into the buffer each time. diff --git a/docs/mfc/styles-for-the-progress-control.md b/docs/mfc/styles-for-the-progress-control.md index 2fe586be746..9a43e2cb16d 100644 --- a/docs/mfc/styles-for-the-progress-control.md +++ b/docs/mfc/styles-for-the-progress-control.md @@ -3,10 +3,12 @@ description: "Learn more about: Styles for the Progress Control" title: "Styles for the Progress Control" ms.date: "11/19/2018" helpviewer_keywords: ["PBS_SMOOTH style", "progress controls [MFC], styles", "PBS_VERTICAL style", "CProgressCtrl class [MFC], styles"] -ms.assetid: 39eb8081-bc20-4552-91b9-e7cdd1b7d8ae --- # Styles for the Progress Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you initially create the progress control ([CProgressCtrl::Create](../mfc/reference/cprogressctrl-class.md#create)), use the *dwStyle* parameter to specify the desired window styles for your progress control. The following list details the applicable window styles. The control ignores any window style other than the ones listed here. You should always create the control as a child window, usually of a dialog box parent. |Window style|Effect| diff --git a/docs/mfc/support-for-activation-contexts-in-the-mfc-module-state.md b/docs/mfc/support-for-activation-contexts-in-the-mfc-module-state.md index 38bebdec767..b4a07738a52 100644 --- a/docs/mfc/support-for-activation-contexts-in-the-mfc-module-state.md +++ b/docs/mfc/support-for-activation-contexts-in-the-mfc-module-state.md @@ -3,10 +3,12 @@ description: "Learn more about: Support for Activation Contexts in the MFC Modul title: "Support for Activation Contexts in the MFC Module State" ms.date: "11/04/2016" helpviewer_keywords: ["activation contexts [MFC]", "activation contexts [MFC], MFC support"] -ms.assetid: 1e49eea9-3620-46dd-bc5f-d664749567c7 --- # Support for Activation Contexts in the MFC Module State +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC creates an activation context using a manifest resource provided by the user module. For more information on how activation contexts are created, see the following topics: - [Activation Contexts](/windows/win32/SbsCs/activation-contexts) diff --git a/docs/mfc/tab-controls-and-property-sheets.md b/docs/mfc/tab-controls-and-property-sheets.md index 594015025ce..adcb8c11d50 100644 --- a/docs/mfc/tab-controls-and-property-sheets.md +++ b/docs/mfc/tab-controls-and-property-sheets.md @@ -3,10 +3,12 @@ description: "Learn more about: Tab Controls and Property Sheets" title: "Tab Controls and Property Sheets" ms.date: "11/04/2016" helpviewer_keywords: ["property sheets, tab controls", "tab controls [MFC], and property sheets", "CTabCtrl class [MFC], and property sheets"] -ms.assetid: f3b87bea-9ad9-41e6-a7ff-a9285308267e --- # Tab Controls and Property Sheets +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Property sheets are multiple-page dialogs or "tab dialogs" that can display up to 24 dialog template resources to the user. For examples of property sheets, see the Windows Display Properties dialog box or the following MFC sample application: [CMNCTRL1: Demonstrates Common Control Classes, Part 1](../overview/visual-cpp-samples.md) diff --git a/docs/mfc/tabs-and-tab-control-attributes.md b/docs/mfc/tabs-and-tab-control-attributes.md index 61dcc0d87b4..02ea18ccdc2 100644 --- a/docs/mfc/tabs-and-tab-control-attributes.md +++ b/docs/mfc/tabs-and-tab-control-attributes.md @@ -3,10 +3,12 @@ description: "Learn more about: Tabs and Tab Control Attributes" title: "Tabs and Tab Control Attributes" ms.date: "11/04/2016" helpviewer_keywords: ["attributes [MFC], reference topics", "tab controls [MFC], attributes", "tabs [MFC]", "tabs [MFC], attributes", "CTabCtrl class [MFC], tab control attributes"] -ms.assetid: ecf190cb-f323-4751-bfdb-766dbe6bb553 --- # Tabs and Tab Control Attributes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You have considerable control over the appearance and behavior of tabs that make up a tab control ([CTabCtrl](../mfc/reference/ctabctrl-class.md)). Each tab can have a label, an icon, an item state, and an application-defined 32-bit value associated with it. For each tab, you can display the icon, the label, or both. In addition, each tab item can have three possible states: pressed, unpressed, or highlighted. This state can only be set by modifying an existing tab item. To modify an existing tab item, retrieve it with a call to [GetItem](../mfc/reference/ctabctrl-class.md#getitem), modify the `TCITEM` structure (specifically the *dwState* and *dwStateMask* data members), and then return the modified `TCITEM` structure with a call to [SetItem](../mfc/reference/ctabctrl-class.md#setitem). If you need to clear the item states of all the tab items in a `CTabCtrl` object, make a call to [DeselectAll](../mfc/reference/ctabctrl-class.md#deselectall). This function resets the state of all tab items or all items except the one currently selected. diff --git a/docs/mfc/technical-notes-by-category.md b/docs/mfc/technical-notes-by-category.md index 288094ac3af..7128376cfaa 100644 --- a/docs/mfc/technical-notes-by-category.md +++ b/docs/mfc/technical-notes-by-category.md @@ -2,10 +2,12 @@ description: "Learn more about: Technical Notes by Category" title: "Technical Notes by Category" ms.date: "11/04/2016" -ms.assetid: b9f1c953-233d-4d64-9e8e-ca69b79460b8 --- # Technical Notes by Category +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Technical notes are divided into the following categories. For a numerical listing of the technical notes, see [Technical Notes by Number](../mfc/technical-notes-by-number.md). ### MFC and Windows diff --git a/docs/mfc/technical-notes-by-number.md b/docs/mfc/technical-notes-by-number.md index d07d4b3b3bd..ce0f9032bba 100644 --- a/docs/mfc/technical-notes-by-number.md +++ b/docs/mfc/technical-notes-by-number.md @@ -3,10 +3,12 @@ description: "Learn more about: Technical Notes by Number" title: "Technical Notes by Number" ms.date: "11/04/2016" f1_keywords: ["vc.tables.mfc.technotes"] -ms.assetid: aaa449be-9167-4510-a490-af872c4f60a2 --- # Technical Notes by Number +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The technical notes below are listed numerically, with the most recently written technical note first. For a listing by category, see [Technical Notes by Category](../mfc/technical-notes-by-category.md). |Number|Title| diff --git a/docs/mfc/template-based-classes.md b/docs/mfc/template-based-classes.md index b60a54b82a6..c15c730b488 100644 --- a/docs/mfc/template-based-classes.md +++ b/docs/mfc/template-based-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Template-Based Classes" title: "Template-Based Classes" ms.date: "11/04/2016" helpviewer_keywords: ["type-safe collections", "CTypedPtrList class [MFC], template-based classes", "arrays [MFC], classes", "arrays [MFC], pointers", "typed pointers, collections of", "arrays [MFC], template-based", "CArray class [MFC], template-based classes", "simple template-based collections", "simple array collection classes [MFC]", "typed pointers", "collections, typed-pointer", "CList class [MFC], template-based classes", "collection classes [MFC], template-based", "CTypedPtrMap class [MFC], template-based classes", "pointers, collections of typed", "CTypedPtrArray class [MFC], template-based classes", "MFC collection classes [MFC], template-based", "template-based collection classes [MFC]", "simple list collection classes [MFC]"] -ms.assetid: c69fc95b-c8f6-4a99-abed-517c9898ef0c --- # Template-Based Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the type-safe template-based collection classes in MFC version 3.0 and later. Using these templates to create type-safe collections is more convenient and helps provide type safety more effectively than using the collection classes not based on templates. MFC predefines two categories of template-based collections: diff --git a/docs/mfc/template-classes-for-arrays-lists-and-maps.md b/docs/mfc/template-classes-for-arrays-lists-and-maps.md index adf320b1c3e..f76f823414c 100644 --- a/docs/mfc/template-classes-for-arrays-lists-and-maps.md +++ b/docs/mfc/template-classes-for-arrays-lists-and-maps.md @@ -4,10 +4,12 @@ title: "Template Classes for Arrays, Lists, and Maps" ms.date: "11/04/2016" f1_keywords: ["vc.classes.template"] helpviewer_keywords: ["arrays [MFC], classes", "template classes [MFC], for arrays/lists and maps", "list classes [MFC]", "map classes [MFC]", "template classes [MFC]"] -ms.assetid: a8331c4b-068a-48f8-a629-b8449601e121 --- # Template Classes for Arrays, Lists, and Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + These collection classes are templates whose parameters determine the types of the objects stored in the aggregates. The `CArray`, `CMap`, and `CList` classes use global helper functions that must usually be customized. For more information about these helper functions, see [Collection Class Helpers](../mfc/reference/collection-class-helpers.md). The typed pointer classes are wrappers for other classes in the class library. By using these wrappers, you enlist the compiler's type-checking to help you avoid errors. For more information on using these classes, see [Collections](../mfc/collections.md). These classes provide templates you can use to create arrays, lists, and maps using any type you like. diff --git a/docs/mfc/testing-internet-applications.md b/docs/mfc/testing-internet-applications.md index 40e53d914f6..cee0b483a39 100644 --- a/docs/mfc/testing-internet-applications.md +++ b/docs/mfc/testing-internet-applications.md @@ -3,11 +3,13 @@ description: "Learn more about: Testing Internet Applications" title: "Testing Internet Applications" ms.date: "11/04/2016" helpviewer_keywords: ["Web applications [MFC], testing", "debugging Web applications [MFC], testing applications", "testing [MFC], Internet applications", "debugging [MFC], Web applications", "Internet debugging and testing"] -ms.assetid: ac4c74e3-d4ad-4e19-8f6c-e270de067f01 ms.topic: concept-article --- # Testing Internet Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + There are some unique testing challenges on the Internet, especially for applications running on a Web server. Your initial testing will probably be done using a single-user client connecting to a test server. This will be useful for debugging your code. You will also want to test under real conditions: with multiple clients connected over high-speed connections as well as low-speed serial lines, including modem connections. It can be difficult to simulate real conditions, but it is certainly worth spending time designing possible scenarios and executing them. If possible, you will also want to use tools to do capacity and stress testing. Certain classes of bugs, such as timing bugs, are difficult to find and to reproduce. diff --git a/docs/mfc/testing-properties-and-events-with-test-container.md b/docs/mfc/testing-properties-and-events-with-test-container.md index d7258a77d5c..e6d18116671 100644 --- a/docs/mfc/testing-properties-and-events-with-test-container.md +++ b/docs/mfc/testing-properties-and-events-with-test-container.md @@ -7,6 +7,9 @@ ms.topic: how-to --- # Testing Properties and Events with Test Container +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Test Container application, shipped in Visual C++, is an ActiveX control container for testing and debugging ActiveX controls. Test Container allows the control developer to test the control's functionality by changing its properties, invoking its methods, and firing its events. Test Container can display logs of data-binding notifications and also provides facilities for testing an ActiveX control's persistence functionality: you can save properties to a stream or to substorage, reload them, and examine the stored stream data. This section describes how to use the basic features of Test Container. For additional information, select the **Help** menu while running Test Container. ### To access the ActiveX Control Test Container diff --git a/docs/mfc/the-ccmdui-class.md b/docs/mfc/the-ccmdui-class.md index 7b932b51d26..4769f532e4c 100644 --- a/docs/mfc/the-ccmdui-class.md +++ b/docs/mfc/the-ccmdui-class.md @@ -3,10 +3,12 @@ description: "Learn more about: The CCmdUI Class" title: "The CCmdUI Class" ms.date: "11/04/2016" helpviewer_keywords: ["updating user interface objects [MFC]", "user interface objects [MFC], updating", "CCmdUI class [MFC], menu updating", "update handlers [MFC]", "toolbars [MFC], updating"] -ms.assetid: 2f2bae62-8c29-45a4-bbce-490eb01907d5 --- # The CCmdUI Class +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When it routes an update command to its handler, the framework passes the handler a pointer to a `CCmdUI` object (or to an object of a `CCmdUI`-derived class). This object represents the menu item or toolbar button or other user-interface object that generated the command. The update handler calls member functions of the `CCmdUI` structure through the pointer to update the user-interface object. For example, here is an update handler for the Clear All menu item: [!code-cpp[NVC_MFCDocView#3](../mfc/codesnippet/cpp/the-ccmdui-class_1.cpp)] diff --git a/docs/mfc/thread-specific-hot-keys.md b/docs/mfc/thread-specific-hot-keys.md index cf9bd0c9221..bb3eddc5a5c 100644 --- a/docs/mfc/thread-specific-hot-keys.md +++ b/docs/mfc/thread-specific-hot-keys.md @@ -3,10 +3,12 @@ description: "Learn more about: Thread-Specific Hot Keys" title: "Thread-Specific Hot Keys" ms.date: "11/04/2016" helpviewer_keywords: ["CHotKeyCtrl class [MFC], thread-specific hot keys", "keyboard shortcuts [MFC], hot keys", "threading [MFC], hot keys in CHotKeyCtrl", "access keys [MFC], hot keys"] -ms.assetid: b6021274-1498-483f-bcbf-ba5723547cc8 --- # Thread-Specific Hot Keys +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An application sets a thread-specific hot key ([CHotKeyCtrl](../mfc/reference/chotkeyctrl-class.md)) by using the Windows `RegisterHotKey` function. When the user presses a thread-specific hot key, Windows posts a [WM_HOTKEY](/windows/win32/inputdev/wm-hotkey) message to the beginning of a particular thread's message queue. The WM_HOTKEY message contains the virtual key code, shift state, and user-defined ID of the specific hot key that was pressed. For a list of standard virtual key codes, see Winuser.h. For more information on this method, see [RegisterHotKey](/windows/win32/api/winuser/nf-winuser-registerhotkey). Note that the shift state flags used in the call to `RegisterHotKey` are not the same as those returned by the [GetHotKey](../mfc/reference/chotkeyctrl-class.md#gethotkey) member function; you'll have to translate these flags before calling `RegisterHotKey`. diff --git a/docs/mfc/tn001-window-class-registration.md b/docs/mfc/tn001-window-class-registration.md index 9a528229abf..df44ee16549 100644 --- a/docs/mfc/tn001-window-class-registration.md +++ b/docs/mfc/tn001-window-class-registration.md @@ -4,10 +4,12 @@ title: "TN001: Window Class Registration" ms.date: "11/04/2016" f1_keywords: ["vc.registration"] helpviewer_keywords: ["TN001", "WNDCLASS [MFC]", "AfxRegisterClass function"] -ms.assetid: 1abf678e-f220-4606-85e0-03df32f64c54 --- # TN001: Window Class Registration +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes the MFC routines that register the special [WNDCLASS](/windows/win32/api/winuser/ns-winuser-wndclassw)es needed by Microsoft Windows. Specific `WNDCLASS` attributes used by MFC and Windows are discussed. ## The Problem diff --git a/docs/mfc/tn002-persistent-object-data-format.md b/docs/mfc/tn002-persistent-object-data-format.md index 46c468bb74b..710322980dc 100644 --- a/docs/mfc/tn002-persistent-object-data-format.md +++ b/docs/mfc/tn002-persistent-object-data-format.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["VERSIONABLE_SCHEMA macro [MFC]", "persistent object data" --- # TN002: Persistent Object Data Format +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes the MFC routines that support persistent C++ objects and the format of the object data when it is stored in a file. This applies only to classes with the [DECLARE_SERIAL](../mfc/reference/run-time-object-model-services.md#declare_serial) and [IMPLEMENT_SERIAL](../mfc/reference/run-time-object-model-services.md#implement_serial) macros. ## The Problem diff --git a/docs/mfc/tn003-mapping-of-windows-handles-to-objects.md b/docs/mfc/tn003-mapping-of-windows-handles-to-objects.md index aae3e6e82cb..b7b4f207886 100644 --- a/docs/mfc/tn003-mapping-of-windows-handles-to-objects.md +++ b/docs/mfc/tn003-mapping-of-windows-handles-to-objects.md @@ -4,10 +4,12 @@ title: "TN003: Mapping of Windows Handles to Objects" ms.date: "11/04/2016" f1_keywords: ["vc.mapping"] helpviewer_keywords: ["TN003", "handle maps", "Windows handles to objects [MFC]", "mappings [MFC], Windows handles to objects"] -ms.assetid: fbea9f38-992c-4091-8dbc-f29e288617d6 --- # TN003: Mapping of Windows Handles to Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes the MFC routines that support mapping Windows object handles to C++ objects. ## The Problem diff --git a/docs/mfc/tn006-message-maps.md b/docs/mfc/tn006-message-maps.md index 91f8aec4a38..41ac839b2e1 100644 --- a/docs/mfc/tn006-message-maps.md +++ b/docs/mfc/tn006-message-maps.md @@ -4,10 +4,12 @@ title: "TN006: Message Maps" ms.date: "06/25/2018" f1_keywords: ["vc.messages.maps"] helpviewer_keywords: ["ON_UPDATE_COMMAND_UI macro [MFC]", "ON_NOTIFY_RANGE macro [MFC]", "ON_COMMAND macro [MFC]", "ON_CONTROL_RANGE macro [MFC]", "ON_REGISTERED_MESSAGE macro [MFC]", "ON_NOTIFY message [MFC]", "ON_COMMAND_RANGE_EX macro [MFC]", "ON_MESSAGE macro [MFC]", "Windows messages [MFC], message maps", "ON_COMMAND_RANGE macro [MFC]", "TN006", "ON_CONTROL macro [MFC]", "ON_COMMAND_EX macro [MFC]", "message maps [MFC], Windows messaging"] -ms.assetid: af4b6794-4b40-4f1e-ad41-603c3b7409bb --- # TN006: Message Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes the MFC message map facility. ## The Problem @@ -97,7 +99,7 @@ pWnd->SendMessage(WM_MYMESSAGE); The range of user-defined messages that use this approach must be in the range WM_USER to 0x7fff. > [!NOTE] -> ClassWizard does not support entering ON_MESSAGE handler routines from the ClassWizard user interface. You must manually enter them from the Visual C++ editor. ClassWizard will parse these entries and let you browse them just like any other message-map entries. +> ClassWizard does not support entering ON_MESSAGE handler routines from the ClassWizard user interface. You must manually enter them from the Visual Studio editor. ClassWizard will parse these entries and let you browse them just like any other message-map entries. ## Registered Windows Messages @@ -150,7 +152,7 @@ Advanced users can use the ON_COMMAND_EX macro, which is an extended form of com Examples of these forms: -- Inside Resource.h (usually generated by Visual C++) +- Inside Resource.h (usually generated by Visual Studio) ```cpp #define ID_MYCMD 100 diff --git a/docs/mfc/tn011-using-mfc-as-part-of-a-dll.md b/docs/mfc/tn011-using-mfc-as-part-of-a-dll.md index 6036c016123..bc0600b0c0b 100644 --- a/docs/mfc/tn011-using-mfc-as-part-of-a-dll.md +++ b/docs/mfc/tn011-using-mfc-as-part-of-a-dll.md @@ -3,10 +3,12 @@ description: "Learn more about: TN011: Using MFC as Part of a DLL" title: "TN011: Using MFC as Part of a DLL" ms.date: "11/04/2016" helpviewer_keywords: ["_USRDLL symbol", "USRDLLs, compiler switches", "TN011", "DLLs [MFC], linking", "MFC DLLs [MFC], linking regular MFC DLLs to MFC"] -ms.assetid: 76753e9c-59dc-40f6-b6a7-f6bb9a7c4190 --- # TN011: Using MFC as Part of a DLL +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes regular MFC DLLs, which allow you to use the MFC library as part of a Windows dynamic-link library (DLL). It assumes that you are familiar with Windows DLLs and how to build them. For information about MFC extension DLLs, with which you can create extensions to the MFC library, see [DLL Version of MFC](../mfc/tn033-dll-version-of-mfc.md). ## DLL Interfaces @@ -17,7 +19,7 @@ If both a DLL and an application want to use MFC, both have a choice to either u regular MFC DLLs have several advantages: -- The application that uses the DLL does not have to use MFC and does not have to be a Visual C++ application. +- The application that uses the DLL does not have to use MFC and does not have to be a Visual Studio application. - With regular MFC DLLs that statically link to MFC, the size of the DLL depends only on the MFC and C runtime routines that are used and linked. @@ -63,7 +65,7 @@ The `DllMain` function that MFC provides will call the [CWinApp::ExitInstance](. ## Linking Your DLL -With regular MFC DLLs that statically link to MFC, you must link your DLL with Nafxcwd.lib or Nafxcw.lib and with the version of the C runtimes named Libcmt.lib. These libraries are pre-built and may be installed by specifying them when you run Visual C++ setup. +With regular MFC DLLs that statically link to MFC, you must link your DLL with Nafxcwd.lib or Nafxcw.lib and with the version of the C runtimes named Libcmt.lib. These libraries are pre-built and may be installed by specifying them when you run Visual Studio setup. ## Sample Code diff --git a/docs/mfc/tn014-custom-controls.md b/docs/mfc/tn014-custom-controls.md index d6eb5e03e11..f1562fa20f3 100644 --- a/docs/mfc/tn014-custom-controls.md +++ b/docs/mfc/tn014-custom-controls.md @@ -7,6 +7,9 @@ helpviewer_keywords: ["TN014", "custom controls [MFC]"] --- # TN014: Custom Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes the MFC Support for custom and self-drawing controls. It also describes dynamic subclassing, and describes the relationship between [CWnd](../mfc/reference/cwnd-class.md) objects and `HWND`s. The MFC sample application CTRLTEST illustrates how to use many custom controls. See the source code for the MFC General sample [CTRLTEST](../overview/visual-cpp-samples.md) and online help. diff --git a/docs/mfc/tn016-using-cpp-multiple-inheritance-with-mfc.md b/docs/mfc/tn016-using-cpp-multiple-inheritance-with-mfc.md index cf44c6bf0ea..fec8f1aa64e 100644 --- a/docs/mfc/tn016-using-cpp-multiple-inheritance-with-mfc.md +++ b/docs/mfc/tn016-using-cpp-multiple-inheritance-with-mfc.md @@ -4,10 +4,12 @@ title: "TN016: Using C++ Multiple Inheritance with MFC" ms.date: "06/28/2018" f1_keywords: ["vc.inheritance"] helpviewer_keywords: ["TN016", "MI (Multiple Inheritance)", "multiple inheritance, MFC support for"] -ms.assetid: 4ee27ae1-1410-43a5-b111-b6af9b84535d --- # TN016: Using C++ Multiple Inheritance with MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes how to use multiple inheritance (MI) with the Microsoft Foundation Classes. The use of MI is not required with MFC. MI is not used in any MFC classes and is not required to write a class library. The following subtopics describe how MI affects the use of common MFC idioms as well as covering some of the restrictions of MI. Some of these restrictions are general C++ restrictions. Others are imposed by the MFC architecture. diff --git a/docs/mfc/tn017-destroying-window-objects.md b/docs/mfc/tn017-destroying-window-objects.md index f50a0b32b71..960374a2479 100644 --- a/docs/mfc/tn017-destroying-window-objects.md +++ b/docs/mfc/tn017-destroying-window-objects.md @@ -4,10 +4,12 @@ title: "TN017: Destroying window objects" ms.date: 06/03/2022 f1_keywords: ["vc.objects"] helpviewer_keywords: ["destroying windows", "TN017", "PostNcDestroy method [MFC]"] -ms.assetid: 5bf208a5-5683-439b-92a1-547c5ded26cd --- # TN017: Destroying window objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes the use of the [`CWnd::PostNcDestroy`](../mfc/reference/cwnd-class.md#postncdestroy) method. Use this method if you want to do customized allocation of `CWnd`-derived objects. This note also explains why you should use [`CWnd::DestroyWindow`](../mfc/reference/cwnd-class.md#destroywindow) to destroy a C++ Windows object instead of the **`delete`** operator. If you follow the guidelines in this article, you'll have few cleanup problems. These problems can result from issues such as forgetting to delete/free C++ memory, forgetting to free system resources like `HWND`s, or freeing objects too many times. diff --git a/docs/mfc/tn020-id-naming-and-numbering-conventions.md b/docs/mfc/tn020-id-naming-and-numbering-conventions.md index 753afb306c8..39b718d2625 100644 --- a/docs/mfc/tn020-id-naming-and-numbering-conventions.md +++ b/docs/mfc/tn020-id-naming-and-numbering-conventions.md @@ -4,21 +4,23 @@ title: "TN020: ID Naming and Numbering Conventions" ms.date: "11/04/2016" f1_keywords: ["vc.id"] helpviewer_keywords: ["TN020", "resource identifiers, naming and numbering", "resource identifiers"] -ms.assetid: aecbd2cf-68b3-47f6-ae21-b1f507917245 --- # TN020: ID Naming and Numbering Conventions +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes the ID naming and numbering conventions that MFC 2.0 uses for resources, commands, strings, controls, and child windows. The MFC ID naming and numbering conventions are intended to meet the following requirements: -- Provide a consistent ID-naming standard used across the MFC library and MFC applications that are supported by the Visual C++ resource editor. This makes it easier for the programmer to interpret the type and origin of a resource from its ID. +- Provide a consistent ID-naming standard used across the MFC library and MFC applications that are supported by the Visual Studio resource editor. This makes it easier for the programmer to interpret the type and origin of a resource from its ID. - Emphasize the strong 1-to-1 relationship between certain types of IDs. - Conform to already widely used standards for naming IDs in Windows. -- Partition the ID-numbering space. ID numbers can be assigned by the programmer, MFC, Windows, and Visual C++-edited resources. Appropriate partitioning will help avoid duplication of ID numbers. +- Partition the ID-numbering space. ID numbers can be assigned by the programmer, MFC, Windows, and Visual Studio-edited resources. Appropriate partitioning will help avoid duplication of ID numbers. ## The ID Prefix Naming Convention diff --git a/docs/mfc/tn021-command-and-message-routing.md b/docs/mfc/tn021-command-and-message-routing.md index 597613bdc7b..1ad354a62dd 100644 --- a/docs/mfc/tn021-command-and-message-routing.md +++ b/docs/mfc/tn021-command-and-message-routing.md @@ -4,16 +4,18 @@ title: "TN021: Command and Message Routing" ms.date: "06/28/2018" f1_keywords: ["vc.routing"] helpviewer_keywords: ["TN021", "command routing [MFC], technical note TN021", "Windows messages [MFC], routing"] -ms.assetid: b5952c8b-123e-406c-a36d-a6ac7c6df307 --- # TN021: Command and Message Routing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. This note describes the command routing and dispatch architecture as well as advanced topics in general window message routing. -Please refer to Visual C++ for general details on the architectures described here, especially the distinction between Windows messages, control notifications, and commands. This note assumes you are very familiar with the issues described in the printed documentation and only addresses very advanced topics. +Please refer to Visual Studio for general details on the architectures described here, especially the distinction between Windows messages, control notifications, and commands. This note assumes you are very familiar with the issues described in the printed documentation and only addresses very advanced topics. ## Command Routing and Dispatch MFC 1.0 Functionality Evolves to MFC 2.0 Architecture @@ -29,7 +31,7 @@ This functionality has been generalized and extended in MFC 2.0 to allow command ## Command IDs -See Visual C++ for an explanation of the command routing and binding process. [Technical Note 20](../mfc/tn020-id-naming-and-numbering-conventions.md) contains information on ID naming. +See Visual Studio for an explanation of the command routing and binding process. [Technical Note 20](../mfc/tn020-id-naming-and-numbering-conventions.md) contains information on ID naming. We use the generic prefix "ID_" for command IDs. Command IDs are >= 0x8000. The message line or status bar will show the command description string if there is a STRINGTABLE resource with the same IDs as the command ID. @@ -71,7 +73,7 @@ Maintaining the enabled/checked state of all a program's menu items all the time `CFrameWnd` also handles the WM_ENTERIDLE message to describe the current menu item selected on the status bar (also known as the message line). -An application's menu structure, edited by Visual C++, is used to represent the potential commands available at WM_INITMENUPOPUP time. ON_UPDATE_COMMAND_UI handlers can modify the state or text of a menu, or for advanced uses (like the File MRU list or the OLE Verbs pop-up menu), actually modify the menu structure before the menu is drawn. +An application's menu structure, edited by Visual Studio, is used to represent the potential commands available at WM_INITMENUPOPUP time. ON_UPDATE_COMMAND_UI handlers can modify the state or text of a menu, or for advanced uses (like the File MRU list or the OLE Verbs pop-up menu), actually modify the menu structure before the menu is drawn. The same sort of ON_UPDATE_COMMAND_UI processing is done for toolbars (and other control bars) when the application enters its idle loop. See the *Class Library Reference* and [Technical Note 31](../mfc/tn031-control-bars.md) for more information on control bars. diff --git a/docs/mfc/tn022-standard-commands-implementation.md b/docs/mfc/tn022-standard-commands-implementation.md index 87a928b8c48..a12033ebd64 100644 --- a/docs/mfc/tn022-standard-commands-implementation.md +++ b/docs/mfc/tn022-standard-commands-implementation.md @@ -4,16 +4,18 @@ title: "TN022: Standard Commands Implementation" ms.date: "11/04/2016" f1_keywords: ["vc.commands"] helpviewer_keywords: ["ID_PREV_PANE command [MFC]", "ID_APP_EXIT command [MFC]", "ID_NEXT_PANE command [MFC]", "ID_INDICATOR_REC command [MFC]", "ID_WINDOW_SPLIT command [MFC]", "ID_FILE_PRINT_PREVIEW command [MFC]", "ID_WINDOW_CASCADE command [MFC]", "ID_FILE_CLOSE command [MFC]", "ID_FILE_SAVE_COPY_AS command [MFC]", "ID_WINDOW_ARRANGE command [MFC]", "ID_EDIT_FIND command [MFC]", "ID_FILE_OPEN command [MFC]", "ID_FILE_PAGE_SETUP command [MFC]", "ID_OLE_VERB_FIRST command [MFC]", "ID_EDIT_UNDO command [MFC]", "ID_EDIT_CLEAR command [MFC]", "ID_INDICATOR_CAPS command [MFC]", "ID_HELP_INDEX command [MFC]", "commands [MFC], standard", "ID_FILE_PRINT_SETUP command [MFC]", "ID_DEFAULT_HELP command [MFC]", "ID_INDICATOR_SCRL command [MFC]", "ID_FILE_PRINT command [MFC]", "ID_INDICATOR_OVR command [MFC]", "ID_INDICATOR_KANA command [MFC]", "ID_EDIT_COPY command [MFC]", "ID_EDIT_REDO command [MFC]", "ID_EDIT_PASTE command [MFC]", "ID_OLE_INSERT_NEW command [MFC]", "ID_OLE_EDIT_LINKS command [MFC]", "ID_EDIT_PASTE_SPECIAL command [MFC]", "ID_INDICATOR_EXT command [MFC]", "ID_HELP_USING command [MFC]", "standard commands", "ID_VIEW_STATUS_BAR command [MFC]", "ID_FILE_SAVE_AS command [MFC]", "ID_EDIT_CLEAR_ALL command [MFC]", "ID_WINDOW_NEW command [MFC]", "ID_CONTEXT_HELP command [MFC]", "ID_EDIT_REPLACE command [MFC]", "ID_WINDOW_TILE_HORZ command [MFC]", "ID_APP_ABOUT command [MFC]", "TN022", "ID_VIEW_TOOLBAR command [MFC]", "ID_HELP command [MFC]", "ID_WINDOW_TILE_VERT command [MFC]", "ID_EDIT_CUT command [MFC]", "ID_FILE_UPDATE command [MFC]", "ID_EDIT_REPEAT command [MFC]", "ID_FILE_SAVE command [MFC]", "ID_EDIT_PASTE_LINK command [MFC]", "ID_EDIT_SELECT_ALL command [MFC]", "ID_FILE_NEW command [MFC]", "ID_INDICATOR_NUM command"] -ms.assetid: a7883b46-23f7-4870-ac3a-804aed9258b5 --- # TN022: Standard Commands Implementation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. This note describes the standard command implementations provided by MFC 2.0. Read [Technical Note 21](../mfc/tn021-command-and-message-routing.md) first because it describes the mechanisms used to implement many of the standard commands. -This description assumes knowledge of the MFC architectures, APIs, and common programming practice. Documented as well as undocumented "implementation only" APIs are described. This is not a place to start learning about the features of or how to program in MFC. Refer to Visual C++ for more general information and for details of documented APIs. +This description assumes knowledge of the MFC architectures, APIs, and common programming practice. Documented as well as undocumented "implementation only" APIs are described. This is not a place to start learning about the features of or how to program in MFC. Refer to Visual Studio for more general information and for details of documented APIs. ## The Problem diff --git a/docs/mfc/tn023-standard-mfc-resources.md b/docs/mfc/tn023-standard-mfc-resources.md index eebace2edac..913e6b22d01 100644 --- a/docs/mfc/tn023-standard-mfc-resources.md +++ b/docs/mfc/tn023-standard-mfc-resources.md @@ -3,10 +3,12 @@ description: "Learn more about: TN023: Standard MFC Resources" title: "TN023: Standard MFC Resources" ms.date: "11/04/2016" helpviewer_keywords: ["resources [MFC]", "TN023", "standard resources"] -ms.assetid: 60af8415-c576-4c2f-a711-ca5da0b9a1f2 --- # TN023: Standard MFC Resources +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes the standard resources provided with and needed by the MFC library. ## Standard Resources @@ -29,7 +31,7 @@ Clip-art resources are additional resources that the framework does not depend o - Prompts.rc: Contains menu-prompt string resources for each predefined command, such as "Create a new document" for ID_FILE_NEW. -- Commdlg.rc: A Visual C++ compatible .rc file that contains the standard COMMDLG dialog templates. +- Commdlg.rc: A Visual Studio compatible .rc file that contains the standard COMMDLG dialog templates. Standard framework resources are resources with AFX-defined IDs that the framework depends on for internal implementations. You will rarely need to change these AFX-defined resources. If you do, you should follow the procedure outlined later in this topic. @@ -47,7 +49,7 @@ The following framework resources are contained in the MFC\INCLUDE directory: #### To use a clip-art binary resource -1. Open your application's resource file in Visual C++. +1. Open your application's resource file in Visual Studio. 1. Open Common.rc. This file contains all the binary clip-art resources. This may take some time because the Common.rc file is compiled. @@ -76,7 +78,7 @@ In some rare cases you might want to customize the contents of the standard fram ##### To customize the contents of a standard resource file -1. Open the resource file in Visual C++. +1. Open the resource file in Visual Studio. 1. Using the Resource Set Includes command, remove the `#include` for the standard .rc file that you want to customize. For example, to customize the print-preview toolbar, remove the `#include "afxprint.rc"` line. diff --git a/docs/mfc/tn024-mfc-defined-messages-and-resources.md b/docs/mfc/tn024-mfc-defined-messages-and-resources.md index b510b909b79..6a18d57ef98 100644 --- a/docs/mfc/tn024-mfc-defined-messages-and-resources.md +++ b/docs/mfc/tn024-mfc-defined-messages-and-resources.md @@ -3,10 +3,12 @@ description: "Learn more about: TN024: MFC-Defined Messages and Resources" title: "TN024: MFC-Defined Messages and Resources" ms.date: "11/04/2016" helpviewer_keywords: ["resources [MFC]", "Windows messages [MFC], MFC-defined", "messages [MFC], MFC", "TN024"] -ms.assetid: c65353ce-8096-454b-ad22-1a7a1dd9a788 --- # TN024: MFC-Defined Messages and Resources +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. @@ -159,9 +161,9 @@ The default toolbar supplied by AppWizard is based on an RT_TOOLBAR custom resou ## RT_DLGINIT Resource Format -One MFC private resource format is used to store extra dialog initialization information. This includes the initial strings stored in a combo box. The format of this resource is not designed to be manually edited, but is handled by Visual C++. +One MFC private resource format is used to store extra dialog initialization information. This includes the initial strings stored in a combo box. The format of this resource is not designed to be manually edited, but is handled by Visual Studio. -Visual C++ and this RT_DLGINIT resource are not required to use the related features of MFC since there are API alternative to using the information in the resource. Using Visual C++ makes it much easier to write, maintain, and translate your application in the long run. +Visual Studio and this RT_DLGINIT resource are not required to use the related features of MFC since there are API alternative to using the information in the resource. Using Visual Studio makes it much easier to write, maintain, and translate your application in the long run. The basic structure of a RT_DLGINIT resource is as follows: @@ -186,7 +188,7 @@ A repeated section contains the control ID to send the message to, the Message # SendDlgItemMessage(, , 0, &); ``` -This is a very general format, allowing any Windows messages and data content. The Visual C++ resource editor and MFC only support a limited subset of Windows messages: CB_ADDSTRING for the initial list-choices for combo boxes (the data is a text string). +This is a very general format, allowing any Windows messages and data content. The Visual Studio resource editor and MFC only support a limited subset of Windows messages: CB_ADDSTRING for the initial list-choices for combo boxes (the data is a text string). ## See also diff --git a/docs/mfc/tn025-document-view-and-frame-creation.md b/docs/mfc/tn025-document-view-and-frame-creation.md index a914375e71e..425c5552a97 100644 --- a/docs/mfc/tn025-document-view-and-frame-creation.md +++ b/docs/mfc/tn025-document-view-and-frame-creation.md @@ -4,10 +4,12 @@ title: "TN025: Document, View, and Frame Creation" ms.date: "11/04/2016" f1_keywords: ["vc.creation"] helpviewer_keywords: ["documents [MFC], view and frame creation", "TN025"] -ms.assetid: 09254d72-6e1d-43db-80e9-693887dbeda2 --- # TN025: Document, View, and Frame Creation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn026-ddx-and-ddv-routines.md b/docs/mfc/tn026-ddx-and-ddv-routines.md index 8cfde655e61..0d6e4eb4176 100644 --- a/docs/mfc/tn026-ddx-and-ddv-routines.md +++ b/docs/mfc/tn026-ddx-and-ddv-routines.md @@ -4,10 +4,12 @@ title: "TN026: DDX and DDV Routines" ms.date: "06/28/2018" f1_keywords: ["DDX", "DDV"] helpviewer_keywords: ["DDX (dialog data exchange), procedures", "TN026", "DDV (dialog data validation), procedures"] -ms.assetid: c2eba87a-4b47-4083-b28b-e2fa77dfb4c4 --- # TN026: DDX and DDV Routines +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn028-context-sensitive-help-support.md b/docs/mfc/tn028-context-sensitive-help-support.md index 09992516214..b6ae1421563 100644 --- a/docs/mfc/tn028-context-sensitive-help-support.md +++ b/docs/mfc/tn028-context-sensitive-help-support.md @@ -4,11 +4,13 @@ title: "TN028: Context-Sensitive Help Support" ms.date: "11/04/2016" f1_keywords: ["vc.help"] helpviewer_keywords: ["context-sensitive Help [MFC], MFC applications", "TN028", "resource identifiers, context-sensitive Help"] -ms.assetid: 884f1c55-fa27-4d4c-984f-30907d477484 --- # TN028: Context-Sensitive Help Support -This note describes the rules for assigning Help contexts IDs and other help issues in MFC. Context-sensitive help support requires the help compiler that is available in Visual C++. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +This note describes the rules for assigning Help contexts IDs and other help issues in MFC. Context-sensitive help support requires the help compiler that is available in Visual Studio. > [!NOTE] > In addition to implementing context-sensitive help using WinHelp, MFC also supports using HTML Help. For more information on this support and programming with HTML Help, see [HTML Help: Context-Sensitive Help for Your Programs](../mfc/html-help-context-sensitive-help-for-your-programs.md). diff --git a/docs/mfc/tn029-splitter-windows.md b/docs/mfc/tn029-splitter-windows.md index 44ff393dd03..4a8d2d983dd 100644 --- a/docs/mfc/tn029-splitter-windows.md +++ b/docs/mfc/tn029-splitter-windows.md @@ -4,17 +4,19 @@ title: "TN029: Splitter Windows" ms.date: "11/04/2016" f1_keywords: ["vc.windows.splitter"] helpviewer_keywords: ["TN029", "splitter windows [MFC], about splitter windows"] -ms.assetid: 2c57ce99-2a3c-4eff-9cea-baccb13af075 --- # TN029: Splitter Windows +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes the MFC [CSplitterWnd Class](../mfc/reference/csplitterwnd-class.md), which provides window splits and manages the resizing of other pane windows. ## Splitter Styles A `CSplitterWnd` supports two different styles of splitting windows. -In "static splitters," the splitter window creates the panes when it is created. The order and number of panes never change. Splitter bars are used to resize the different panes. You can use this style to display a different view class in each pane. The Visual C++ graphics editor and the Windows File Manager are examples of programs that use this splitter style. This style of splitter window does not use splitter boxes. +In "static splitters," the splitter window creates the panes when it is created. The order and number of panes never change. Splitter bars are used to resize the different panes. You can use this style to display a different view class in each pane. The Visual Studio graphics editor and the Windows File Manager are examples of programs that use this splitter style. This style of splitter window does not use splitter boxes. In "dynamic splitters," additional panes are created and destroyed as the user splits and un-splits new views. This splitter starts out with a single view and provides splitter boxes for the user to initiate splitting. The splitter window dynamically creates a new view object when the view is split in one direction. This new view object represents the new pane. If the view is split in two directions by using the keyboard interface, the splitter window creates three new view objects for the three new panes. While the split is active, Windows displays the splitter box as a splitter bar between the panes. Windows destroys additional view objects when the user removes a split, but the original view remains until the splitter window itself is destroyed. Microsoft Excel and Microsoft Word are examples of applications that use the dynamic splitter style. diff --git a/docs/mfc/tn030-customizing-printing-and-print-preview.md b/docs/mfc/tn030-customizing-printing-and-print-preview.md index 851f9d6ad6d..859df12533e 100644 --- a/docs/mfc/tn030-customizing-printing-and-print-preview.md +++ b/docs/mfc/tn030-customizing-printing-and-print-preview.md @@ -4,10 +4,12 @@ title: "TN030: Customizing Printing and Print Preview" ms.date: "06/28/2018" f1_keywords: ["vc.print"] helpviewer_keywords: ["TN030", "customizing printing and print preview", "printing [MFC], views", "printing views [MFC]", "print preview [MFC], customizing"] -ms.assetid: 32744697-c91c-41b6-9a12-b8ec01e0d438 --- # TN030: Customizing Printing and Print Preview +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn031-control-bars.md b/docs/mfc/tn031-control-bars.md index cdd945cff4a..f186f5a4dc3 100644 --- a/docs/mfc/tn031-control-bars.md +++ b/docs/mfc/tn031-control-bars.md @@ -4,10 +4,12 @@ title: "TN031: Control Bars" ms.date: "11/04/2016" f1_keywords: ["vc.controls.bars"] helpviewer_keywords: ["control bars [MFC], styles", "CStatusBar class [MFC], Tech Note 31 usage", "CControlBar class [MFC], Tech Note 31 usage", "CControlBar class [MFC], deriving from", "control bars [MFC], classes [MFC]", "CDialogBar class [MFC], Tech Note 31 usage", "CToolBar class [MFC], Tech Note 31 usage", "TN031", "styles [MFC], control bars"] -ms.assetid: 8cb895c0-40ea-40ef-90ee-1dd29f34cfd1 --- # TN031: Control Bars +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn032-mfc-exception-mechanism.md b/docs/mfc/tn032-mfc-exception-mechanism.md index 37d0ecc454e..37358762f81 100644 --- a/docs/mfc/tn032-mfc-exception-mechanism.md +++ b/docs/mfc/tn032-mfc-exception-mechanism.md @@ -3,10 +3,12 @@ description: "Learn more about: TN032: MFC Exception Mechanism" title: "TN032: MFC Exception Mechanism" ms.date: "11/04/2016" helpviewer_keywords: ["TN032", "MFC, exceptions", "CException class [MFC], using"] -ms.assetid: 0271f0aa-82cb-47a2-b7ea-e88126fc7e43 --- # TN032: MFC Exception Mechanism +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Previous versions of Visual C++ did not support the standard C++ exception mechanism, and MFC provided macros **TRY/CATCH/THROW** that were used instead. This version of Visual C++ fully supports C++ exceptions. This note covered some of the advanced implementation details of the previous macros including how to automatically cleanup stack based objects. Because C++ exceptions support stack unwinding by default, this technical note is no longer necessary. Refer to [Exceptions: Using MFC Macros and C++ Exceptions](../mfc/exceptions-using-mfc-macros-and-cpp-exceptions.md) for more information on the differences between the MFC macros and the new C++ keywords. diff --git a/docs/mfc/tn033-dll-version-of-mfc.md b/docs/mfc/tn033-dll-version-of-mfc.md index 0e5df9d531b..3db6c4930e0 100644 --- a/docs/mfc/tn033-dll-version-of-mfc.md +++ b/docs/mfc/tn033-dll-version-of-mfc.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["MFC DLLs [MFC], writing MFC extension DLLS", "AFXDLL libr --- # TN033: DLL Version of MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note describes how you can use the *`MFCxx.DLL`* and *`MFCxxD.DLL`* (where *xx* is the MFC version number) shared dynamic link libraries with MFC applications and MFC extension DLLs. For more information about regular MFC DLLs, see [Using MFC as Part of a DLL](../mfc/tn011-using-mfc-as-part-of-a-dll.md). This technical note covers three aspects of DLLs. The last two are for the more advanced users: @@ -416,9 +419,9 @@ A full rebuild is required after these changes are made. ### Building the Samples -Most of the MFC sample programs can be built from Visual C++ or from a shared NMAKE-compatible MAKEFILE from the command line. +Most of the MFC sample programs can be built from Visual Studio or from a shared NMAKE-compatible MAKEFILE from the command line. -To convert any of these samples to use *`MFCxx.DLL`*, you can load the MAK file into the Visual C++ and set the Project options as described above. If you're using the NMAKE build, you can specify `AFXDLL=1` on the NMAKE command line and that will build the sample using the shared MFC libraries. +To convert any of these samples to use *`MFCxx.DLL`*, you can load the MAK file into the Visual Studio and set the Project options as described above. If you're using the NMAKE build, you can specify `AFXDLL=1` on the NMAKE command line and that will build the sample using the shared MFC libraries. The MFC Advanced Concepts sample [DLLHUSK](../overview/visual-cpp-samples.md) is built with the DLL version of MFC. This sample not only illustrates how to build an application linked with *`MFCxx.DLL`*, but it also illustrates other features of the MFC DLL packaging option such as MFC extension DLLs described later in this technical note. @@ -426,7 +429,7 @@ The MFC Advanced Concepts sample [DLLHUSK](../overview/visual-cpp-samples.md) is The release versions of the DLLs (*`MFCxx.DLL`* and *`MFCxxU.DLL`*) are freely redistributable. The debug versions of the DLLs are not freely redistributable and should be used only during the development of your application. -The debug DLLs are provided with debugging information. By using the Visual C++ debugger, you can trace execution of both your application and the DLL. The Release DLLs (*`MFCxx.DLL`* and *`MFCxxU.DLL`*) don't contain debugging information. +The debug DLLs are provided with debugging information. By using the Visual Studio debugger, you can trace execution of both your application and the DLL. The Release DLLs (*`MFCxx.DLL`* and *`MFCxxU.DLL`*) don't contain debugging information. If you customize or rebuild the DLLs, then you should call them something other than "MFCxx". The MFC SRC file *`MFCDLL.MAK`* describes build options and contains the logic for renaming the DLL. Renaming the files is necessary, since these DLLs are potentially shared by many MFC applications. Having your custom version of the MFC DLLs replace the ones installed on the system may break another MFC application using the shared MFC DLLs. diff --git a/docs/mfc/tn035-using-multiple-resource-files-and-header-files-with-visual-cpp.md b/docs/mfc/tn035-using-multiple-resource-files-and-header-files-with-visual-cpp.md index efb943db144..21c577de734 100644 --- a/docs/mfc/tn035-using-multiple-resource-files-and-header-files-with-visual-cpp.md +++ b/docs/mfc/tn035-using-multiple-resource-files-and-header-files-with-visual-cpp.md @@ -1,17 +1,19 @@ --- -description: "Learn more about: TN035: Using multiple resource files and header files with Visual C++" -title: "TN035: Using multiple resource files and header files with Visual C++" +description: "Learn more about: TN035: Using multiple resource files and header files with Visual Studio" +title: "TN035: Using multiple resource files and header files with Visual Studio" ms.date: "11/04/2016" f1_keywords: ["vc.resources"] helpviewer_keywords: ["resource files, multiple", "TN035"] -ms.assetid: 1f08ce5e-a912-44cc-ac56-7dd93ad73fb6 --- -# TN035: Using multiple resource files and header files with Visual C++ +# TN035: Using multiple resource files and header files with Visual Studio + +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. -This note describes how the Visual C++ resource editor supports multiple resource files and header files shared in a single project or shared across multiple projects and how you can take advantage of that support. This note answers these questions: +This note describes how the Visual Studio resource editor supports multiple resource files and header files shared in a single project or shared across multiple projects and how you can take advantage of that support. This note answers these questions: - When might you want to split a project into multiple resource files and/or header files, and how you do it @@ -25,7 +27,7 @@ You should be aware that if you add an additional resource file to your project, This note is structured to answer the above questions as follows: -- **Overview of how Visual C++ manages resource files and header files** provides an overview of how the Resource Set Includes command in Visual C++ lets you use multiple resource files and header files in the same project. +- **Overview of how Visual Studio manages resource files and header files** provides an overview of how the Resource Set Includes command in Visual Studio lets you use multiple resource files and header files in the same project. - **Analysis of AppWizard-created `.RC` and `.H` Files** looks at the multiple resource and header files that are used by an AppWizard-created application. These files serve as a good model for additional resource files and header files you might want to add to your project. @@ -35,17 +37,17 @@ This note is structured to answer the above questions as follows: - **Using multiple resource files in the same project** describes where you might want to break up your project into multiple `.RC` files, and provides details how to do so. -- **Enforcement of non-editable Visual C++ files** describes how you can make sure Visual C++ doesn't edit and unintentionally reformat a custom resource. +- **Enforcement of non-editable Visual Studio files** describes how you can make sure Visual Studio doesn't edit and unintentionally reformat a custom resource. -- **Managing symbols shared by multiple Visual C++-edited `.RC` files** describes how to share the same symbols across multiple `.RC` files and how to avoid assigning duplicate ID numeric values. +- **Managing symbols shared by multiple Visual Studio-edited `.RC` files** describes how to share the same symbols across multiple `.RC` files and how to avoid assigning duplicate ID numeric values. -- **Managing dependencies between `.RC`, `.CPP`, and `.H` files** describes how Visual C++ avoids unnecessary recompiling `.CPP` files that are dependent on resource symbol files. +- **Managing dependencies between `.RC`, `.CPP`, and `.H` files** describes how Visual Studio avoids unnecessary recompiling `.CPP` files that are dependent on resource symbol files. -- **How Visual C++ manages Set Includes information** provides technical details about how Visual C++ keeps track of multiple (nested) `.RC` files and multiple header files that are included by an `.RC` file. +- **How Visual Studio manages Set Includes information** provides technical details about how Visual Studio keeps track of multiple (nested) `.RC` files and multiple header files that are included by an `.RC` file. -## Overview of how Visual C++ manages resource files and header files +## Overview of how Visual Studio manages resource files and header files -Visual C++ manages a single `.RC` resource file and a corresponding `.H` header file as a tightly coupled pair of files. When you edit and save resources in an `.RC` file, you indirectly edit and save symbols in the corresponding `.H` file. Although you can open and edit multiple `.RC` files at a time (using Visual C++'s MDI user interface), for any given `.RC` file you indirectly edit exactly one corresponding header file. +Visual Studio manages a single `.RC` resource file and a corresponding `.H` header file as a tightly coupled pair of files. When you edit and save resources in an `.RC` file, you indirectly edit and save symbols in the corresponding `.H` file. Although you can open and edit multiple `.RC` files at a time (using Visual Studio's MDI user interface), for any given `.RC` file you indirectly edit exactly one corresponding header file. ### Resource View's Resource Includes dialog @@ -53,26 +55,26 @@ To access the **Resource Includes**, open the **Resource View** then right-click #### Symbol Header File -By default, Visual C++ always names the corresponding header file `RESOURCE.H`, regardless of the name of the resource file (for example, `MYAPP.RC`). The **Symbol Header File:** section in the **Resource Includes** dialog in Visual C++, lets you change the name of this header file. Enter a new file name in the section's edit box. +By default, Visual Studio always names the corresponding header file `RESOURCE.H`, regardless of the name of the resource file (for example, `MYAPP.RC`). The **Symbol Header File:** section in the **Resource Includes** dialog in Visual Studio, lets you change the name of this header file. Enter a new file name in the section's edit box. > [!NOTE] > resource files not located in the same directory as the `.RC` file must prepend a relative path with escaped-'\\' to be read properly. #### Read-Only Symbol Directives -Although Visual C++ only edits one header file for any given `.RC` file, Visual C++ supports references to symbols defined in additional read-only header files. The **Read-Only Symbol Directives:** section in the **Resource Includes** dialog lets you specify any number of additional read-only header files as Read-Only Symbol Directives. The "read-only" restriction means that when you add a new resource in the `.RC` file, you can use a symbol defined in the read-only header file. However, if you delete the resource, the symbol still remains defined in the read-only header file. You can't change the numeric value assigned to a read-only symbol. +Although Visual Studio only edits one header file for any given `.RC` file, Visual Studio supports references to symbols defined in additional read-only header files. The **Read-Only Symbol Directives:** section in the **Resource Includes** dialog lets you specify any number of additional read-only header files as Read-Only Symbol Directives. The "read-only" restriction means that when you add a new resource in the `.RC` file, you can use a symbol defined in the read-only header file. However, if you delete the resource, the symbol still remains defined in the read-only header file. You can't change the numeric value assigned to a read-only symbol. #### Compile-Time Directives -Visual C++ also supports nesting of resource files, where one `.RC` file is included within another by using a `#include` directive. When you edit a given `.RC` file using Visual C++, any resources in the included files aren't visible. But when you compile the `.RC` file, the included files are also compiled. The **Compile-Time Directives:** section in the **Resources Includes** dialog lets you specify any number of `.RC` files to include as Compile-Time Directives. +Visual Studio also supports nesting of resource files, where one `.RC` file is included within another by using a `#include` directive. When you edit a given `.RC` file using Visual Studio, any resources in the included files aren't visible. But when you compile the `.RC` file, the included files are also compiled. The **Compile-Time Directives:** section in the **Resources Includes** dialog lets you specify any number of `.RC` files to include as Compile-Time Directives. -Note what happens if you read into Visual C++ an `.RC` file that includes another `.RC` file that isn't* specified as a Compile-Time Directive. This situation might arise when you bring to Visual C++ an `.RC` file that you had been previously maintaining manually with a text editor. When Visual C++ reads the included `.RC` file, it merges the included resources into the parent `.RC` file. When you save the parent `.RC` file, the `#include` statement, in effect, will be replaced by the included resources. If you don't want this merge to happen, you should remove the `#include` statement from the parent `.RC` file *prior* to reading it into Visual C++; then using Visual C++, add back the same `#include` statement as a Compile-Time Directive. +Note what happens if you read into Visual Studio an `.RC` file that includes another `.RC` file that isn't* specified as a Compile-Time Directive. This situation might arise when you bring to Visual Studio an `.RC` file that you had been previously maintaining manually with a text editor. When Visual Studio reads the included `.RC` file, it merges the included resources into the parent `.RC` file. When you save the parent `.RC` file, the `#include` statement, in effect, will be replaced by the included resources. If you don't want this merge to happen, you should remove the `#include` statement from the parent `.RC` file *prior* to reading it into Visual Studio; then using Visual Studio, add back the same `#include` statement as a Compile-Time Directive. -Visual C++ saves in an `.RC` file the three kinds of above Set Includes information (Symbol Header File, Read-Only Symbol Directives, and Compile-Time Directives) in `#include` directives *and* in `TEXTINCLUDE` resources. The `TEXTINCLUDE` resources, an implementation detail that you don't normally need to deal with, are explained in [How Visual C++ manages set includes information](#_mfcnotes_tn035_set_includes). +Visual Studio saves in an `.RC` file the three kinds of above Set Includes information (Symbol Header File, Read-Only Symbol Directives, and Compile-Time Directives) in `#include` directives *and* in `TEXTINCLUDE` resources. The `TEXTINCLUDE` resources, an implementation detail that you don't normally need to deal with, are explained in [How Visual Studio manages set includes information](#_mfcnotes_tn035_set_includes). ## Analysis of AppWizard-created `.RC` and `.H` files -Examining the application code produced by AppWizard provides insight into how Visual C++ manages multiple resource files and header files. The code excerpts examined below are from a `MYAPP` application produced by AppWizard using the default options. +Examining the application code produced by AppWizard provides insight into how Visual Studio manages multiple resource files and header files. The code excerpts examined below are from a `MYAPP` application produced by AppWizard using the default options. An AppWizard-created application uses multiple resource files and multiple header files, as summarized in the diagram below: @@ -88,12 +90,12 @@ An AppWizard-created application uses multiple resource files and multiple heade AFXPRINT.RC ``` -You can view these multiple file relationships using the Visual C++ File/Set Includes command. +You can view these multiple file relationships using the Visual Studio File/Set Includes command. `MYAPP.RC`\ -The application resource file that you edit using Visual C++. +The application resource file that you edit using Visual Studio. -`RESOURCE.H` is the application-specific header file. It's always named `RESOURCE.H` by AppWizard, consistent with Visual C++'s default naming of the header file. The `#include` for this header file is the first statement in the resource file (`MYAPP.RC`): +`RESOURCE.H` is the application-specific header file. It's always named `RESOURCE.H` by AppWizard, consistent with Visual Studio's default naming of the header file. The `#include` for this header file is the first statement in the resource file (`MYAPP.RC`): ```rc //Microsoft Visual C++ generated resource script @@ -102,13 +104,13 @@ The application resource file that you edit using Visual C++. ``` `RES\MYAPP.RC2`\ -Contains resources that won't be edited by Visual C++ but will be included in the final compiled `.EXE` file. AppWizard creates no such resources by default, since Visual C++ can edit all of the standard resources, including the version resource (a new feature in this release). An empty file is generated by AppWizard in case you wish to add your own custom formatted resources to this file. +Contains resources that won't be edited by Visual Studio but will be included in the final compiled `.EXE` file. AppWizard creates no such resources by default, since Visual Studio can edit all of the standard resources, including the version resource (a new feature in this release). An empty file is generated by AppWizard in case you wish to add your own custom formatted resources to this file. -If you use custom formatted resources, you can add them to `RES\MYAPP.RC2` and edit them using the Visual C++ text editor. +If you use custom formatted resources, you can add them to `RES\MYAPP.RC2` and edit them using the Visual Studio text editor. -`AFXRES.RC` and `AFXPRINT.RC` contain standard resources required by certain features of the framework. Like `RES\MYAPP.RC2`, these two framework-provided resource files are included at the end of `MYAPP.RC`, and they're specified in the Compile-Time Directives of the Set Includes dialog box. Thus, you don't directly view or edit these framework resources while you edit `MYAPP.RC` in Visual C++, but they're compiled into the application's binary `.RES` file and final `.EXE` file. For more information on the standard framework resources, including procedures for modifying them, see [Technical Note 23](../mfc/tn023-standard-mfc-resources.md). +`AFXRES.RC` and `AFXPRINT.RC` contain standard resources required by certain features of the framework. Like `RES\MYAPP.RC2`, these two framework-provided resource files are included at the end of `MYAPP.RC`, and they're specified in the Compile-Time Directives of the Set Includes dialog box. Thus, you don't directly view or edit these framework resources while you edit `MYAPP.RC` in Visual Studio, but they're compiled into the application's binary `.RES` file and final `.EXE` file. For more information on the standard framework resources, including procedures for modifying them, see [Technical Note 23](../mfc/tn023-standard-mfc-resources.md). -`AFXRES.H` defines standard symbols, such as `ID_FILE_NEW`, used by the framework and specifically used in `AFXRES.RC`. `AFXRES.H` also uses `#include` to include `WINRES.H`, which contains a subset of `WINDOWS.H` that's needed by Visual C++ generated `.RC` files and `AFXRES.RC`. The symbols defined in `AFXRES.H` are available as you edit the application resource file (`MYAPP.RC`). For example, `ID_FILE_NEW` is used for the `File` `New` menu item in the `MYAPP.RC` file's menu resource. You can't change or delete these framework-defined symbols. +`AFXRES.H` defines standard symbols, such as `ID_FILE_NEW`, used by the framework and specifically used in `AFXRES.RC`. `AFXRES.H` also uses `#include` to include `WINRES.H`, which contains a subset of `WINDOWS.H` that's needed by Visual Studio generated `.RC` files and `AFXRES.RC`. The symbols defined in `AFXRES.H` are available as you edit the application resource file (`MYAPP.RC`). For example, `ID_FILE_NEW` is used for the `File` `New` menu item in the `MYAPP.RC` file's menu resource. You can't change or delete these framework-defined symbols. ## Including additional header files @@ -116,7 +118,7 @@ The AppWizard-created application includes only two header files: `RESOURCE.H` a The header file is provided by an external source, or you want to share the header file among multiple projects or multiple parts of the same project. -The header file has formatting and comments that you don't want Visual C++ to change or filter out when it saves the file. For example, maybe you want to preserve #define's that use symbolic arithmetic such as: +The header file has formatting and comments that you don't want Visual Studio to change or filter out when it saves the file. For example, maybe you want to preserve #define's that use symbolic arithmetic such as: ```h #define RED 0 @@ -170,22 +172,22 @@ The case where the second header file is shared by two `.RC` files in the same a ## Using multiple resource files in the same project -Visual C++ and the Resource Compiler support multiple `.RC` files in the same project through `#include` directives that include one `.RC` file within another. Multiple nesting is allowed. There are various reasons to split your project's resources into multiple `.RC` files: +Visual Studio and the Resource Compiler support multiple `.RC` files in the same project through `#include` directives that include one `.RC` file within another. Multiple nesting is allowed. There are various reasons to split your project's resources into multiple `.RC` files: - It's easier to manage a large number of resources among multiple project team members if you split the resources into multiple `.RC` files. If you use a source control management package for checking out files and checking in changes, splitting the resources into multiple `.RC` files will give you finer control over managing changes to resources. - If you want to use preprocessor directives, such as `#ifdef`, `#endif`, and `#define`, for portions of your resources, you must isolate them in read-only resources that will be compiled by the Resource Compiler. -- Component `.RC` files will load and save faster in Visual C++ than one composite `.RC` file. +- Component `.RC` files will load and save faster in Visual Studio than one composite `.RC` file. -- If you want to maintain a resource with a text editor in a human-readable form, you should keep it in a `.RC` file separate from the one Visual C++ edits. +- If you want to maintain a resource with a text editor in a human-readable form, you should keep it in a `.RC` file separate from the one Visual Studio edits. -- If you need to keep a user-defined resource in a binary or text form that is interpretable by another specialized data editor, then you should keep it in a separate `.RC` file so Visual C++ doesn't change the format to hexadecimal data. The `.WAV` (sound) file resources in the MFC Advanced Concepts sample [SPEAKN](../overview/visual-cpp-samples.md) are a good example. +- If you need to keep a user-defined resource in a binary or text form that is interpretable by another specialized data editor, then you should keep it in a separate `.RC` file so Visual Studio doesn't change the format to hexadecimal data. The `.WAV` (sound) file resources in the MFC Advanced Concepts sample [SPEAKN](../overview/visual-cpp-samples.md) are a good example. You can include `SECOND.RC` in the Compile-Time Directives in the Set Includes dialog box: ```h -#include "res\myapp.rc2" // non-Visual C++ edited resources +#include "res\myapp.rc2" // non-Visual Studio edited resources #include "second.rc" // THE SECOND .RC FILE #include "afxres.rc" // Standard components @@ -207,27 +209,27 @@ The result is illustrated in the following diagram: AFXPRINT.RC ``` -Using Compile-Time Directives, you can organize your Visual C++-editable and non-editable resources into multiple `.RC` files, where the main `MYAPP.RC` does nothing but `#include` the other `.RC` files. If you're using a Visual Studio C++ project `.MAK` file, then you should include the main `.RC` file in the project so that all the included resources are compiled with your application. +Using Compile-Time Directives, you can organize your Visual Studio-editable and non-editable resources into multiple `.RC` files, where the main `MYAPP.RC` does nothing but `#include` the other `.RC` files. If you're using a Visual Studio C++ project `.MAK` file, then you should include the main `.RC` file in the project so that all the included resources are compiled with your application. -## Enforcement of non-editable Visual C++ files +## Enforcement of non-editable Visual Studio files -The AppWizard-created `RES\MYAPP.RC2` file is an example of a file that contains resources that you don't want to accidentally read into Visual C++ and then write back out with loss of formatting information. To protect against this problem, place the following lines in the beginning of the `RES\MYAPP.RC2` file: +The AppWizard-created `RES\MYAPP.RC2` file is an example of a file that contains resources that you don't want to accidentally read into Visual Studio and then write back out with loss of formatting information. To protect against this problem, place the following lines in the beginning of the `RES\MYAPP.RC2` file: ```rc2 #ifdef APSTUDIO_INVOKED - #error this file is not editable by Visual C++ + #error this file is not editable by Visual Studio #endif //APSTUDIO_INVOKED ``` -When Visual C++ compiles the `.RC` file, it defines both `APSTUDIO_INVOKED` and `RC_INVOKED`. If the AppWizard-created file structure is corrupted and Visual C++ reads the #error line above, it reports a fatal error and aborts the reading of the `.RC` file. +When Visual Studio compiles the `.RC` file, it defines both `APSTUDIO_INVOKED` and `RC_INVOKED`. If the AppWizard-created file structure is corrupted and Visual Studio reads the #error line above, it reports a fatal error and aborts the reading of the `.RC` file. -## Managing symbols shared by multiple Visual C++-edited `.RC` files +## Managing symbols shared by multiple Visual Studio-edited `.RC` files -Two issues arise when you split up your resources into multiple `.RC` files that you want to edit separately in Visual C++: +Two issues arise when you split up your resources into multiple `.RC` files that you want to edit separately in Visual Studio: - You might want to share the same symbols across multiple `.RC` files. -- You need to help Visual C++ avoid assigning the same ID numeric values to distinct resources (symbols). +- You need to help Visual Studio avoid assigning the same ID numeric values to distinct resources (symbols). The following diagram illustrates an organization of `.RC` and `.H` files that deals with the first issue: @@ -243,11 +245,11 @@ MYSTRS.H / MYSHARED.H \ MYMENUS.H In this example, string resources are kept in one resource file, `MYSTRS.RC`, and menus are kept in another, `MYMENUS.RC`. Some symbols, such as for commands, may need to be shared between the two files. For example, a `ID_TOOLS_SPELL` may be the menu command ID for the Spell item in a Tools menu; and it may also be the string ID of the command prompt displayed by the framework in the application's main window status bar. -The `ID_TOOLS_SPELL` symbol is kept in the shared header file, `MYSHARED.H`. You maintain this shared header file manually with a text editor; Visual C++ doesn't directly edit it. In the two resource files `MYSTRS.RC` and `MYMENUS.RC`, you specify `#include "MYSHARED.H"` in the Read-Only Directives for `MYAPP.RC`, using the **Resource Includes** command, as described earlier. +The `ID_TOOLS_SPELL` symbol is kept in the shared header file, `MYSHARED.H`. You maintain this shared header file manually with a text editor; Visual Studio doesn't directly edit it. In the two resource files `MYSTRS.RC` and `MYMENUS.RC`, you specify `#include "MYSHARED.H"` in the Read-Only Directives for `MYAPP.RC`, using the **Resource Includes** command, as described earlier. It's most convenient to anticipate a symbol you'll share before you attempt to use it to identify any resource. Add the symbol to the shared header file and, if you haven't already included the shared header file in the Read-Only Directives for the `.RC` file, do so before using the symbol. If you didn't anticipate sharing the symbol in this way, then you'll have to manually (using a text editor) move the #define statement for the symbol from, say, `MYMENUS.H` to `MYSHARED.H` before using it in `MYSTRS.RC`. -When you manage symbols in multiple `.RC` files, you also must help Visual C++ avoid assigning the same ID numeric values to distinct resources (symbols). For any given `.RC` file, Visual C++ incrementally assigns IDs in each of four ID domains. Between editing sessions, Visual C++ keeps track of the last ID it assigned in each of the domains in the Symbol Header File for the `.RC` file. Here's what the `APS_NEXT` values are for an empty (new) `.RC` file: +When you manage symbols in multiple `.RC` files, you also must help Visual Studio avoid assigning the same ID numeric values to distinct resources (symbols). For any given `.RC` file, Visual Studio incrementally assigns IDs in each of four ID domains. Between editing sessions, Visual Studio keeps track of the last ID it assigned in each of the domains in the Symbol Header File for the `.RC` file. Here's what the `APS_NEXT` values are for an empty (new) `.RC` file: ```rc #define _APS_NEXT_RESOURCE_VALUE 101 @@ -264,9 +266,9 @@ When you manage symbols in multiple `.RC` files, you also must help Visual C++ a `_APS_NEXT_SYMED_VALUE` is the next symbol value that will be issued when you manually assign a symbol value using the New command in the Symbol Browser. -Visual C++ starts with slightly higher values that the lowest legal value when creating a new `.RC` file. AppWizard will also initialize these values to something more appropriate for MFC applications. For more information about ID value ranges, see [Technical Note 20](../mfc/tn020-id-naming-and-numbering-conventions.md). +Visual Studio starts with slightly higher values that the lowest legal value when creating a new `.RC` file. AppWizard will also initialize these values to something more appropriate for MFC applications. For more information about ID value ranges, see [Technical Note 20](../mfc/tn020-id-naming-and-numbering-conventions.md). -Now every time you create a new resource file, even in the same project, Visual C++ defines the same `_APS_NEXT_` values. It means that if you add, say, multiple dialogs in two different `.RC` files, it's highly likely that the same #define value will be assigned to different dialogs. For example, `IDD_MY_DLG1` in the first `.RC` file might be assigned the same number, 101, as `IDD_MY_DLG2` in a second `.RC` file. +Now every time you create a new resource file, even in the same project, Visual Studio defines the same `_APS_NEXT_` values. It means that if you add, say, multiple dialogs in two different `.RC` files, it's highly likely that the same #define value will be assigned to different dialogs. For example, `IDD_MY_DLG1` in the first `.RC` file might be assigned the same number, 101, as `IDD_MY_DLG2` in a second `.RC` file. To avoid this issue, you should reserve a separate numeric range for each of the four domains of IDs in the respective `.RC` files. Set the ranges by manually updating the `_APS_NEXT` values in each of the `.RC` files **before** you start adding resources. For example, if the first `.RC` file uses the default `_APS_NEXT` values, then you might want to assign the following `_APS_NEXT` values to the second `.RC` file: @@ -277,13 +279,13 @@ To avoid this issue, you should reserve a separate numeric range for each of the #define _APS_NEXT_SYMED_VALUE 2000 ``` -Of course, it's still possible that Visual C++ will assign so many IDs in the first `.RC` file that the numeric values start to overlap the ones reserved for the second `.RC` file. You should reserve sufficiently large ranges so that this collision doesn't happen. +Of course, it's still possible that Visual Studio will assign so many IDs in the first `.RC` file that the numeric values start to overlap the ones reserved for the second `.RC` file. You should reserve sufficiently large ranges so that this collision doesn't happen. ## Managing dependencies between `.RC`, `.CPP`, and `.H` files -When Visual C++ saves an `.RC` file, it also saves symbol changes to the corresponding `RESOURCE.H` file. Any of your `.CPP` files that refer to resources in the `.RC` file must use `#include` to include the `RESOURCE.H` file, usually from within your project's main header file. This inclusion leads to an undesirable side-effect because of the development environment's internal project management, which scans source files for header dependencies. Every time you add a new symbol in Visual C++, all the `.CPP` files that have `#include "RESOURCE.H"` directives would need to be recompiled. +When Visual Studio saves an `.RC` file, it also saves symbol changes to the corresponding `RESOURCE.H` file. Any of your `.CPP` files that refer to resources in the `.RC` file must use `#include` to include the `RESOURCE.H` file, usually from within your project's main header file. This inclusion leads to an undesirable side-effect because of the development environment's internal project management, which scans source files for header dependencies. Every time you add a new symbol in Visual Studio, all the `.CPP` files that have `#include "RESOURCE.H"` directives would need to be recompiled. -Visual C++, circumvents the dependency on `RESOURCE.H` by including the following comment as the first line of the `RESOURCE.H` file: +Visual Studio, circumvents the dependency on `RESOURCE.H` by including the following comment as the first line of the `RESOURCE.H` file: ```h //{{NO_DEPENDENCIES}} @@ -291,9 +293,9 @@ Visual C++, circumvents the dependency on `RESOURCE.H` by including the followin The development environment interprets this comment by ignoring the changes to `RESOURCE.H` so that dependent `.CPP` files won't need to be recompiled. -Visual C++ always adds the `//{{NO_DEPENDENCIES}}` comment line to a `.RC` file when it saves the file. In some cases, circumventing of the build dependency on `RESOURCE.H` may lead to run-time errors undetected at link time. For example, if you use the Symbol Browser to change the numeric value assigned to a symbol for a resource, the resource won't be correctly found and loaded at application run-time if the `.CPP` file referring to the resource isn't recompiled. In such cases, you should explicitly recompile any `.CPP` files that you know are affected by the symbol changes in `RESOURCE.H` or select **Rebuild All**. If you have the need to frequently change symbol values for a certain group of resources, you'll probably find it more convenient and safer to break out these symbols into a separate read-only header file, as described in the above section [Including Additional Header Files](#_mfcnotes_tn035_including). +Visual Studio always adds the `//{{NO_DEPENDENCIES}}` comment line to a `.RC` file when it saves the file. In some cases, circumventing of the build dependency on `RESOURCE.H` may lead to run-time errors undetected at link time. For example, if you use the Symbol Browser to change the numeric value assigned to a symbol for a resource, the resource won't be correctly found and loaded at application run-time if the `.CPP` file referring to the resource isn't recompiled. In such cases, you should explicitly recompile any `.CPP` files that you know are affected by the symbol changes in `RESOURCE.H` or select **Rebuild All**. If you have the need to frequently change symbol values for a certain group of resources, you'll probably find it more convenient and safer to break out these symbols into a separate read-only header file, as described in the above section [Including Additional Header Files](#_mfcnotes_tn035_including). -## How Visual C++ manages Set Includes information +## How Visual Studio manages Set Includes information As discussed above, the File menu Set Includes command lets you specify three types of information: @@ -303,11 +305,11 @@ As discussed above, the File menu Set Includes command lets you specify three ty - Compile-Time Directives -The following table describes how Visual C++ maintains this information in a `.RC` file. You don't need this information to use Visual C++, but it may enhance your understanding so that you can more confidently use the Set Includes feature. +The following table describes how Visual Studio maintains this information in a `.RC` file. You don't need this information to use Visual Studio, but it may enhance your understanding so that you can more confidently use the Set Includes feature. -Each of the above three types of Set Includes information is stored in the `.RC` file in two forms: (1) as `#include` or other directives interpretable by the Resource Compiler, and (2) as special `TEXTINCLUDE` resources interpretable only by Visual C++. +Each of the above three types of Set Includes information is stored in the `.RC` file in two forms: (1) as `#include` or other directives interpretable by the Resource Compiler, and (2) as special `TEXTINCLUDE` resources interpretable only by Visual Studio. -The purpose of the `TEXTINCLUDE` resource is to safely store Set Include information in a form that is readily presentable in Visual C++'s **Set Includes** dialog box. `TEXTINCLUDE` is a *resource type* defined by Visual C++. Visual C++ recognizes three specific `TEXTINCLUDE` resources that have the resource identification numbers 1, 2 and 3: +The purpose of the `TEXTINCLUDE` resource is to safely store Set Include information in a form that is readily presentable in Visual Studio's **Set Includes** dialog box. `TEXTINCLUDE` is a *resource type* defined by Visual Studio. Visual Studio recognizes three specific `TEXTINCLUDE` resources that have the resource identification numbers 1, 2 and 3: |`TEXTINCLUDE` resource ID|Type of Set Includes information| |-----------------------------|--------------------------------------| @@ -362,21 +364,21 @@ Compile-Time Directives are included at the end of `MYAPP.RC` in the following f // // From TEXTINCLUDE 3 // -#include "res\myapp.rc2" // non-Visual C++ edited resources +#include "res\myapp.rc2" // non-Visual Studio edited resources #include "afxres.rc" // Standard components #include "afxprint.rc" // printing/print preview resources #endif // not APSTUDIO_INVOKED ``` -The `#ifndef APSTUDIO_INVOKED` directive instructs Visual C++ to skip over Compile-Time Directives. +The `#ifndef APSTUDIO_INVOKED` directive instructs Visual Studio to skip over Compile-Time Directives. The corresponding `TEXTINCLUDE` resource is: ```rc 3 TEXTINCLUDE DISCARDABLE BEGIN -"#include ""res\myapp.rc2"" // non-Visual C++ edited resources\r\n" +"#include ""res\myapp.rc2"" // non-Visual Studio edited resources\r\n" "\r\n" "#include ""afxres.rc"" // Standard components\r\n" "#include ""afxprint.rc"" // printing/print preview resources\r\n" diff --git a/docs/mfc/tn036-using-cformview-with-appwizard-and-classwizard.md b/docs/mfc/tn036-using-cformview-with-appwizard-and-classwizard.md index 4d3569e13ae..9e8261d1fbe 100644 --- a/docs/mfc/tn036-using-cformview-with-appwizard-and-classwizard.md +++ b/docs/mfc/tn036-using-cformview-with-appwizard-and-classwizard.md @@ -3,10 +3,12 @@ description: "Learn more about: TN036: Using CFormView with AppWizard and ClassW title: "TN036: Using CFormView with AppWizard and ClassWizard" ms.date: "11/04/2016" helpviewer_keywords: ["TN036"] -ms.assetid: dd54053f-ae80-4d23-9180-c7d07ddf2290 --- # TN036: Using CFormView with AppWizard and ClassWizard +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This technical note described how to modify an AppWizard generated application so that it used a `CFormView` instead of the default `CView` as its main view class. This is supported directly with this version of Visual C++. ## See also diff --git a/docs/mfc/tn037-multithreaded-mfc-2-1-applications.md b/docs/mfc/tn037-multithreaded-mfc-2-1-applications.md index 8b1d54b02af..ac6bb8c4a7e 100644 --- a/docs/mfc/tn037-multithreaded-mfc-2-1-applications.md +++ b/docs/mfc/tn037-multithreaded-mfc-2-1-applications.md @@ -3,10 +3,12 @@ description: "Learn more about: TN037: Multithreaded MFC 2.1 Applications" title: "TN037: Multithreaded MFC 2.1 Applications" ms.date: "11/04/2016" helpviewer_keywords: ["TN037"] -ms.assetid: 05ee204c-700a-4c40-957c-dc2d0db1249d --- # TN037: Multithreaded MFC 2.1 Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This technical note originally described the limitations of multithreaded programs with MFC 2.1, originally provided with Visual C++ 1.0 for Windows NT. MFC 3.0 supports multithreading directly and is documented. See that reference for more information. ## See also diff --git a/docs/mfc/tn038-mfc-ole-iunknown-implementation.md b/docs/mfc/tn038-mfc-ole-iunknown-implementation.md index f9dd6560fb7..5389681a074 100644 --- a/docs/mfc/tn038-mfc-ole-iunknown-implementation.md +++ b/docs/mfc/tn038-mfc-ole-iunknown-implementation.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["aggregation macros [MFC]", "COM interfaces, base interfac --- # TN038: MFC/OLE IUnknown Implementation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn039-mfc-ole-automation-implementation.md b/docs/mfc/tn039-mfc-ole-automation-implementation.md index f0293d78dae..07218539d2f 100644 --- a/docs/mfc/tn039-mfc-ole-automation-implementation.md +++ b/docs/mfc/tn039-mfc-ole-automation-implementation.md @@ -3,10 +3,12 @@ description: "Learn more about: TN039: MFC/OLE Automation Implementation" title: "TN039: MFC-OLE Automation Implementation" ms.date: "06/28/2018" helpviewer_keywords: ["MFC, COM support", "IDispatch interface", "MFC, OLE DB and", "TN039", "Automation, MFC COM interface entry points"] -ms.assetid: 765fa3e9-dd54-4f08-9ad2-26e0546ff8b6 --- # TN039: MFC/OLE Automation Implementation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. @@ -85,7 +87,7 @@ The Z property is given a **DISPID** with a zero **HIWORD** since it is defined ## Advanced MFC Dispatch Map Features -There are a number of additional features that ClassWizard does not support with this release of Visual C++. ClassWizard supports `DISP_FUNCTION`, `DISP_PROPERTY`, and `DISP_PROPERTY_EX` which define a method, member variable property, and get/set member function property, respectively. These capabilities are usually all that is needed to create most automation servers. +There are a number of additional features that ClassWizard does not support with this release of Visual Studio. ClassWizard supports `DISP_FUNCTION`, `DISP_PROPERTY`, and `DISP_PROPERTY_EX` which define a method, member variable property, and get/set member function property, respectively. These capabilities are usually all that is needed to create most automation servers. The following additional macros can be used when the ClassWizard supported macros are not adequate: `DISP_PROPERTY_NOTIFY`, and `DISP_PROPERTY_PARAM`. diff --git a/docs/mfc/tn040-mfc-ole-in-place-resizing-and-zooming.md b/docs/mfc/tn040-mfc-ole-in-place-resizing-and-zooming.md index 4feead7b1e8..48d421019bc 100644 --- a/docs/mfc/tn040-mfc-ole-in-place-resizing-and-zooming.md +++ b/docs/mfc/tn040-mfc-ole-in-place-resizing-and-zooming.md @@ -3,10 +3,12 @@ description: "Learn more about: TN040: MFC/OLE In-Place Resizing and Zooming" title: "TN040: MFC-OLE In-Place Resizing and Zooming" ms.date: "11/04/2016" helpviewer_keywords: ["resizing in-place", "TN040", "zooming and in-place activation", "in-place activation, zooming and resizing"] -ms.assetid: 4d7859bd-0b2e-4254-be62-2735cecf02c6 --- # TN040: MFC/OLE In-Place Resizing and Zooming +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn041-mfc-ole1-migration-to-mfc-ole-2.md b/docs/mfc/tn041-mfc-ole1-migration-to-mfc-ole-2.md index 9838cef62ca..bb8cdf822ee 100644 --- a/docs/mfc/tn041-mfc-ole1-migration-to-mfc-ole-2.md +++ b/docs/mfc/tn041-mfc-ole1-migration-to-mfc-ole-2.md @@ -3,10 +3,12 @@ description: "Learn more about: TN041: MFC/OLE1 Migration to MFC/OLE 2" title: "TN041: MFC-OLE1 Migration to MFC-OLE 2" ms.date: "10/18/2018" helpviewer_keywords: ["OLE1 [MFC]", "migrating OLE1 to OLE2", "migration [MFC], OLE1 to OLE2", "OLE2 [MFC]", "porting OLE1 to OLE2", "converting OLE1 to OLE2", "upgrading Visual C++ applications [MFC], OLE1 to OLE2", "TN041"] -ms.assetid: 67f55552-4b04-4ddf-af0b-4d9eaf5da957 --- # TN041: MFC/OLE1 Migration to MFC/OLE 2 +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. @@ -276,7 +278,7 @@ At this point, OCLIENT is a functional OLE container application. It is possible One of the most interesting features of OLE is in-place activation (or "Visual Editing"). This feature allows the server application to take over portions of the container's user interface to provided a more seamless editing interface for the user. To implement in-place activation to OCLIENT, some special resources need to be added, as well as some additional code. These resources and the code are normally provided by AppWizard — in fact, much of the code here was borrowed directly from a fresh AppWizard application with "Container" support. -First of all, it is necessary to add a menu resource to be used when there is an item which is in-place active. You can create this extra menu resource in Visual C++ by copying the IDR_OCLITYPE resource and removing all but the File and Window pop-ups. Two separator bars are inserted between the File and Window pop-ups to indicate the separation of groups (it should look like: `File || Window`). For more information on what these separators mean and how the server and container menus are merged see [Menus and Resources: Menu Merging](../mfc/menus-and-resources-menu-merging.md). +First of all, it is necessary to add a menu resource to be used when there is an item which is in-place active. You can create this extra menu resource in Visual Studio by copying the IDR_OCLITYPE resource and removing all but the File and Window pop-ups. Two separator bars are inserted between the File and Window pop-ups to indicate the separation of groups (it should look like: `File || Window`). For more information on what these separators mean and how the server and container menus are merged see [Menus and Resources: Menu Merging](../mfc/menus-and-resources-menu-merging.md). Once you have these menus created, you need to let the framework know about them. This is done by calling `CDocTemplate::SetContainerInfo` for the document template before you add it to the document template list in your InitInstance. The new code to register the document template looks like this: @@ -292,7 +294,7 @@ pTemplate->SetContainerInfo(IDR_OLECLITYPE_INPLACE); AddDocTemplate(pTemplate); ``` -The IDR_OLECLITYPE_INPLACE resource is the special in-place resource created in Visual C++. +The IDR_OLECLITYPE_INPLACE resource is the special in-place resource created in Visual Studio. To enable in-place activation, there are some things that need to change in both the `CView` (CMainView) derived class as well as the `COleClientItem` derived class (CRectItem). All of these overrides are provided by AppWizard and most of the implementation will come directly from a default AppWizard application. @@ -338,7 +340,7 @@ BOOL CRectItem::OnChangeItemPosition(const CRect& rectPos) At this point, there is enough code to allow an item to be in-place activated and to deal with sizing and moving the item when it is active, but no code will allow the user to exit the editing session. Although some servers will provide this functionality themselves by handling the escape key, it is suggested that containers provide two ways to deactivate an item: (1) by clicking outside the item, and (2) by pressing the ESCAPE key. -For the ESCAPE key, add an accelerator with Visual C++ that maps the VK_ESCAPE key to a command, ID_CANCEL_EDIT is added to the resources. The handler for this command follows: +For the ESCAPE key, add an accelerator with Visual Studio that maps the VK_ESCAPE key to a command, ID_CANCEL_EDIT is added to the resources. The handler for this command follows: ```cpp // The following command handler provides the standard @@ -512,7 +514,7 @@ BOOL COLEServerApp::InitInstance() You will notice that the code above refers to a new resource ID, IDR_HIERSVRTYPE_SRVR_EMB. This is the menu resource to be used when a document that is embedded in another container is edited. In MFC/OLE1 the menu items specific to editing an embedded item were modified on the fly. Using an entirely different menu structure when editing an embedded item instead of editing a file-based document makes it much easier to provide different user interfaces for these two separate modes. As you'll see later, an entirely separate menu resource is used when editing an embedded object in-place. -To create this resource, load the resource script into Visual C++ and copy the existing IDR_HIERSVRTYPE menu resource. Rename the new resource to IDR_HIERSVRTYPE_SRVR_EMB (this is the same naming convention that AppWizard uses). Next change "File Save" to "File Update"; give it command ID ID_FILE_UPDATE. Also change "File Save As" to "File Save Copy As"; give it command ID ID_FILE_SAVE_COPY_AS. The framework provides the implementation of both of these commands. +To create this resource, load the resource script into Visual Studio and copy the existing IDR_HIERSVRTYPE menu resource. Rename the new resource to IDR_HIERSVRTYPE_SRVR_EMB (this is the same naming convention that AppWizard uses). Next change "File Save" to "File Update"; give it command ID ID_FILE_UPDATE. Also change "File Save As" to "File Save Copy As"; give it command ID ID_FILE_SAVE_COPY_AS. The framework provides the implementation of both of these commands. ```Output \hiersvr\svritem.h(60) : error C2433: 'OLESTATUS' : 'virtual' not permitted on data declarations @@ -629,9 +631,9 @@ To add "Visual Editing" (or in-place activation) to this server application, the - You need to tell the framework about these special resources and classes. -The menu resource is easy to create. Run Visual C++, copy the menu resource IDR_HIERSVRTYPE to a menu resource called IDR_HIERSVRTYPE_SRVR_IP. Modify the menu so that only the Edit and Help menu popups are left. Add two separators to the menu in between the Edit and Help menus (it should look like: `Edit || Help`). For more information on what these separators mean and how the server and container menus are merged, see [Menus and Resources: Menu Merging](../mfc/menus-and-resources-menu-merging.md). +The menu resource is easy to create. Run Visual Studio, copy the menu resource IDR_HIERSVRTYPE to a menu resource called IDR_HIERSVRTYPE_SRVR_IP. Modify the menu so that only the Edit and Help menu popups are left. Add two separators to the menu in between the Edit and Help menus (it should look like: `Edit || Help`). For more information on what these separators mean and how the server and container menus are merged, see [Menus and Resources: Menu Merging](../mfc/menus-and-resources-menu-merging.md). -The bitmap for the subset toolbar can be easily created by copying the one from a fresh AppWizard generated application with a "Server" option checked. This bitmap can then be imported into Visual C++. Be sure to give the bitmap an ID of IDR_HIERSVRTYPE_SRVR_IP. +The bitmap for the subset toolbar can be easily created by copying the one from a fresh AppWizard generated application with a "Server" option checked. This bitmap can then be imported into Visual Studio. Be sure to give the bitmap an ID of IDR_HIERSVRTYPE_SRVR_IP. The class derived from `COleIPFrameWnd` can be copied from an AppWizard generated application with server support as well. Copy both files, IPFRAME.CPP and IPFRAME.H and add them to the project. Make sure that the `LoadBitmap` call refers to IDR_HIERSVRTYPE_SRVR_IP, the bitmap created in the previous step. diff --git a/docs/mfc/tn042-odbc-driver-developer-recommendations.md b/docs/mfc/tn042-odbc-driver-developer-recommendations.md index 67507a46417..50e12f2ed4f 100644 --- a/docs/mfc/tn042-odbc-driver-developer-recommendations.md +++ b/docs/mfc/tn042-odbc-driver-developer-recommendations.md @@ -4,10 +4,12 @@ title: "TN042: ODBC Driver Developer Recommendations" ms.date: "11/04/2016" f1_keywords: ["vc.odbc"] helpviewer_keywords: ["ODBC drivers [MFC], writing", "databases [MFC], ODBC", "TN042"] -ms.assetid: ecc6b5d9-f480-4582-9e22-8309fe561dad --- # TN042: ODBC Driver Developer Recommendations +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn043-rfx-routines.md b/docs/mfc/tn043-rfx-routines.md index 9c22c0478d5..9ce9eb78ffb 100644 --- a/docs/mfc/tn043-rfx-routines.md +++ b/docs/mfc/tn043-rfx-routines.md @@ -4,10 +4,12 @@ title: "TN043: RFX Routines" ms.date: "06/28/2018" f1_keywords: ["RFX"] helpviewer_keywords: ["RFX (record field exchange), architecture", "TN043", "RFX (record field exchange)"] -ms.assetid: f552d0c1-2c83-4389-b472-42c9940aa713 --- # TN043: RFX Routines +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn044-mfc-support-for-dbcs.md b/docs/mfc/tn044-mfc-support-for-dbcs.md index d20373e0d56..a49ca84591f 100644 --- a/docs/mfc/tn044-mfc-support-for-dbcs.md +++ b/docs/mfc/tn044-mfc-support-for-dbcs.md @@ -3,10 +3,12 @@ description: "Learn more about: TN044: MFC Support for DBCS" title: "TN044: MFC Support for DBCS" ms.date: "11/04/2016" helpviewer_keywords: ["TN044"] -ms.assetid: 8160bb2a-012d-4c5a-b05c-91ee6d4ca4cb --- # TN044: MFC Support for DBCS +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This technical note described the support in MFC for "double-byte character sets" or DBCS. This information as well as information on MFC's support for UNICODE is now available in the *Class Library Reference*. ## See also diff --git a/docs/mfc/tn045-mfc-database-support-for-long-varchar-varbinary.md b/docs/mfc/tn045-mfc-database-support-for-long-varchar-varbinary.md index 871ed060118..ae8ac6acc8c 100644 --- a/docs/mfc/tn045-mfc-database-support-for-long-varchar-varbinary.md +++ b/docs/mfc/tn045-mfc-database-support-for-long-varchar-varbinary.md @@ -3,10 +3,12 @@ description: "Learn more about: TN045: MFC/Database Support for Long Varchar/Var title: "TN045: MFC-Database Support for Long Varchar-Varbinary" ms.date: "11/04/2016" helpviewer_keywords: ["TN045", "Varbinary data type", "Varchar data type"] -ms.assetid: cf572c35-5275-45b5-83df-5f0e36114f40 --- # TN045: MFC/Database Support for Long Varchar/Varbinary +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn046-commenting-conventions-for-the-mfc-classes.md b/docs/mfc/tn046-commenting-conventions-for-the-mfc-classes.md index 26c2dc119d1..bec24e62f25 100644 --- a/docs/mfc/tn046-commenting-conventions-for-the-mfc-classes.md +++ b/docs/mfc/tn046-commenting-conventions-for-the-mfc-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: TN046: Commenting Conventions for the MFC Classe title: "TN046: Commenting Conventions for the MFC Classes" ms.date: "11/04/2016" helpviewer_keywords: ["TN046"] -ms.assetid: 0d6ff3c9-4a5d-44df-b121-be4b0a649947 --- # TN046: Commenting Conventions for the MFC Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This technical note originally described the conventions used to comment the MFC classes. This information is now covered in [MFC: Using the MFC Source Files](../mfc/using-the-mfc-source-files.md). ## See also diff --git a/docs/mfc/tn047-relaxing-database-transaction-requirements.md b/docs/mfc/tn047-relaxing-database-transaction-requirements.md index 43e0e700c54..51f54a2b31b 100644 --- a/docs/mfc/tn047-relaxing-database-transaction-requirements.md +++ b/docs/mfc/tn047-relaxing-database-transaction-requirements.md @@ -4,10 +4,12 @@ title: "TN047: Relaxing Database Transaction Requirements" ms.date: "11/04/2016" f1_keywords: ["vc.data"] helpviewer_keywords: ["TN047"] -ms.assetid: f93c51cf-a8c0-43d0-aa47-7bcb8333d693 --- # TN047: Relaxing Database Transaction Requirements +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This tech note, which discussed the transaction requirements of the MFC ODBC database classes, is now obsolete. Before MFC 4.2, the database classes required that cursors be preserved on recordsets after a **CommitTrans** or **Rollback** operation. If the ODBC driver and DBMS did not support this level of cursor preservation, then the database classes did not enable transactions. Beginning with MFC 4.2, the database classes have relaxed the restriction of requiring cursor preservation. Transactions will be enabled if the driver supports them. However, you must now check the effect of a **CommitTrans** or **Rollback** operation on open recordsets. See the member functions [CDatabase::GetCursorCommitBehavior](../mfc/reference/cdatabase-class.md#getcursorcommitbehavior) and [CDatabase::GetCursorRollbackBehavior](../mfc/reference/cdatabase-class.md#getcursorrollbackbehavior) for more information. diff --git a/docs/mfc/tn048-writing-odbc-setup-and-administration-programs.md b/docs/mfc/tn048-writing-odbc-setup-and-administration-programs.md index 40acefd321e..af7fe25e2bf 100644 --- a/docs/mfc/tn048-writing-odbc-setup-and-administration-programs.md +++ b/docs/mfc/tn048-writing-odbc-setup-and-administration-programs.md @@ -3,11 +3,13 @@ description: "Learn more about: TN048: Writing ODBC Setup and Administration Pro title: "TN048: Writing ODBC Setup and Administration Programs for MFC Database Applications" ms.date: "11/04/2016" helpviewer_keywords: ["installing ODBC", "ODBC, installing", "setup, ODBC setup programs", "TN048", "ODBC, and MFC", "MFC, database applications"] -ms.assetid: d456cdd4-0513-4a51-80c0-9132b66115ce ms.topic: install-set-up-deploy --- # TN048: Writing ODBC Setup and Administration Programs for MFC Database Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn049-mfc-ole-mbcs-to-unicode-translation-layer-mfcans32.md b/docs/mfc/tn049-mfc-ole-mbcs-to-unicode-translation-layer-mfcans32.md index 85033aff5c3..b5125053a59 100644 --- a/docs/mfc/tn049-mfc-ole-mbcs-to-unicode-translation-layer-mfcans32.md +++ b/docs/mfc/tn049-mfc-ole-mbcs-to-unicode-translation-layer-mfcans32.md @@ -3,10 +3,12 @@ description: "Learn more about: TN049: MFC/OLE MBCS to Unicode Translation Layer title: "TN049: MFC-OLE MBCS to Unicode Translation Layer (MFCANS32)" ms.date: "11/04/2016" helpviewer_keywords: ["MFCANS32.DLL", "TN049"] -ms.assetid: c027e30d-8a51-4e28-b215-13fc49b40431 --- # TN049: MFC/OLE MBCS to Unicode Translation Layer (MFCANS32) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note originally described how MFCANS32.DLL provides ANSI interfaces in the primarily Unicode world of 32-bit OLE. This DLL is no longer used by MFC. ## See also diff --git a/docs/mfc/tn050-mfc-ole-common-dialogs-mfcuix32.md b/docs/mfc/tn050-mfc-ole-common-dialogs-mfcuix32.md index 622181cfa4f..e1aefa45288 100644 --- a/docs/mfc/tn050-mfc-ole-common-dialogs-mfcuix32.md +++ b/docs/mfc/tn050-mfc-ole-common-dialogs-mfcuix32.md @@ -3,10 +3,12 @@ description: "Learn more about: TN050: MFC/OLE Common Dialogs (MFCUIx32)" title: "TN050: MFC-OLE Common Dialogs (MFCUIx32)" ms.date: "11/04/2016" helpviewer_keywords: ["MFCUIx32", "TN050"] -ms.assetid: 397c92f7-e7c8-49fb-97bc-f5602ec744b8 --- # TN050: MFC/OLE Common Dialogs (MFCUIx32) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This note originally covered some issues and the future of the OLE common dialogs provided and used by MFC. The OLE common dialogs are now provided as a component built-in to the system (OLEDLG.DLL) and are fully documented in the product documentation. ## See also diff --git a/docs/mfc/tn051-using-ctl3d-now-and-in-the-future.md b/docs/mfc/tn051-using-ctl3d-now-and-in-the-future.md index 2507945e66f..7ce559319cf 100644 --- a/docs/mfc/tn051-using-ctl3d-now-and-in-the-future.md +++ b/docs/mfc/tn051-using-ctl3d-now-and-in-the-future.md @@ -3,10 +3,12 @@ description: "Learn more about: TN051: Using CTL3D Now and in the Future" title: "TN051: Using CTL3D Now and in the Future" ms.date: "11/04/2016" helpviewer_keywords: ["TN051", "CTL3D.DLL", "3D effect"] -ms.assetid: ab517a13-a137-4a60-8039-be92a632b76b --- # TN051: Using CTL3D Now and in the Future +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This technical note, which previously discussed CTL3D and MFC, is now obsolete. The 3D effect for controls is automatically implemented by MFC. ## See also diff --git a/docs/mfc/tn053-custom-dfx-routines-for-dao-database-classes.md b/docs/mfc/tn053-custom-dfx-routines-for-dao-database-classes.md index 5902135a9a4..68d83d09180 100644 --- a/docs/mfc/tn053-custom-dfx-routines-for-dao-database-classes.md +++ b/docs/mfc/tn053-custom-dfx-routines-for-dao-database-classes.md @@ -3,12 +3,14 @@ description: "Learn more about: TN053: Custom DFX Routines for DAO Database Clas title: "TN053: Custom DFX Routines for DAO Database Classes" ms.date: "09/17/2019" helpviewer_keywords: ["MFC, DAO and", "database classes [MFC], DAO", "DAO [MFC], MFC", "DFX (DAO record field exchange) [MFC], custom routines", "TN053", "DAO [MFC], classes", "DFX (DAO record field exchange) [MFC]", "custom DFX routines [MFC]"] -ms.assetid: fdcf3c51-4fa8-4517-9222-58aaa4f25cac --- # TN053: Custom DFX Routines for DAO Database Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] -> DAO is used with Access databases and is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. The Visual C++ environment and wizards do not support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use [OLE DB Templates](../data/oledb/ole-db-templates.md) or [ODBC and MFC](../data/odbc/odbc-and-mfc.md) for new projects. You should only use DAO in maintaining existing applications. +> DAO is used with Access databases and is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. The Visual Studio environment and wizards do not support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use [OLE DB Templates](../data/oledb/ole-db-templates.md) or [ODBC and MFC](../data/odbc/odbc-and-mfc.md) for new projects. You should only use DAO in maintaining existing applications. This technical note describes the DAO record field exchange (DFX) mechanism. To help understand what is happening in the DFX routines, the `DFX_Text` function will be explained in detail as an example. As an additional source of information to this technical note, you can examine the code for the other the individual DFX functions. You probably will not need a custom DFX routine as often as you might need a custom RFX routine (used with ODBC database classes). diff --git a/docs/mfc/tn054-calling-dao-directly-while-using-mfc-dao-classes.md b/docs/mfc/tn054-calling-dao-directly-while-using-mfc-dao-classes.md index c17812d54ab..c39376ef8a7 100644 --- a/docs/mfc/tn054-calling-dao-directly-while-using-mfc-dao-classes.md +++ b/docs/mfc/tn054-calling-dao-directly-while-using-mfc-dao-classes.md @@ -3,13 +3,15 @@ description: "Learn more about: TN054: Calling DAO Directly While Using MFC DAO title: "TN054: Calling DAO Directly While Using MFC DAO Classes" ms.date: "09/17/2019" helpviewer_keywords: ["MFC, DAO and", "passwords [MFC], calling DAO", "security [MFC], DAO", "DAO (Data Access Objects), calling directly", "DAO (Data Access Objects), security", "security [MFC]", "TN054", "DAO (Data Access Objects), and MFC"] -ms.assetid: f7de7d85-8d6c-4426-aa05-2e617c0da957 ms.custom: sfi-ropc-nochange --- # TN054: Calling DAO Directly While Using MFC DAO Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] -> DAO is used with Access databases and is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. The Visual C++ environment and wizards do not support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use [OLE DB Templates](../data/oledb/ole-db-templates.md) or [ODBC and MFC](../data/odbc/odbc-and-mfc.md) for new projects. You should only use DAO in maintaining existing applications. +> DAO is used with Access databases and is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. The Visual Studio environment and wizards do not support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use [OLE DB Templates](../data/oledb/ole-db-templates.md) or [ODBC and MFC](../data/odbc/odbc-and-mfc.md) for new projects. You should only use DAO in maintaining existing applications. When using the MFC DAO database classes, there may be situations where it is necessary to use DAO directly. Usually, this will not be the case, but MFC has provided some helper mechanisms to facilitate making direct DAO calls simple when combining the use of the MFC classes with direct DAO calls. Making direct DAO calls to the methods of an MFC-managed DAO object should require only a few lines of code. If you need to create and use DAO objects that are *not* managed by MFC, you will have to do a little more work by actually calling `Release` on the object. This technical note explains when you might want to call DAO directly, what the MFC helpers can do to help you, and how to use the DAO OLE interfaces. Finally, this note provides some sample functions showing how to call DAO directly for DAO security features. diff --git a/docs/mfc/tn055-migrating-mfc-odbc-database-class-applications-to-mfc-dao-classes.md b/docs/mfc/tn055-migrating-mfc-odbc-database-class-applications-to-mfc-dao-classes.md index 4f563326304..8b669381a6b 100644 --- a/docs/mfc/tn055-migrating-mfc-odbc-database-class-applications-to-mfc-dao-classes.md +++ b/docs/mfc/tn055-migrating-mfc-odbc-database-class-applications-to-mfc-dao-classes.md @@ -3,12 +3,14 @@ description: "Learn more about: TN055: Migrating MFC ODBC Database Class Applica title: "TN055: Migrating MFC ODBC Database Class Applications to MFC DAO Classes" ms.date: "09/17/2019" helpviewer_keywords: ["DAO [MFC], migration", "TN055", "migration [MFC], ODBC database applications", "ODBC classes [MFC], DAO classes", "migrating ODBC database applications [MFC]", "porting database applications to DAO", "ODBC [MFC], DAO", "porting ODBC database applications to DAO", "migrating database applications [MFC]"] -ms.assetid: 0f858bd1-e168-4e2e-bcd1-8debd82856e4 --- # TN055: Migrating MFC ODBC Database Class Applications to MFC DAO Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] -> DAO is used with Access databases and is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. The Visual C++ environment and wizards do not support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use [OLE DB Templates](../data/oledb/ole-db-templates.md) or [ODBC and MFC](../data/odbc/odbc-and-mfc.md) for new projects. You should only use DAO in maintaining existing applications. +> DAO is used with Access databases and is supported through Office 2013. DAO 3.6 is the final version, and it is considered obsolete. The Visual Studio environment and wizards do not support DAO (although the DAO classes are included and you can still use them). Microsoft recommends that you use [OLE DB Templates](../data/oledb/ole-db-templates.md) or [ODBC and MFC](../data/odbc/odbc-and-mfc.md) for new projects. You should only use DAO in maintaining existing applications. ## Overview diff --git a/docs/mfc/tn056-installation-of-localized-mfc-components.md b/docs/mfc/tn056-installation-of-localized-mfc-components.md index c3257be73fd..48848e726d2 100644 --- a/docs/mfc/tn056-installation-of-localized-mfc-components.md +++ b/docs/mfc/tn056-installation-of-localized-mfc-components.md @@ -3,10 +3,12 @@ description: "Learn more about: TN056: Installation of Localized MFC Components" title: "TN056: Installation of Localized MFC Components" ms.date: "11/04/2016" helpviewer_keywords: ["components [MFC]", "TN056", "resources [MFC], localization", "localization [MFC], MFC resources", "MFC70LOC.DLL", "MFC DLLs [MFC], localizing", "components [MFC], installing", "DLLs [MFC], localizing MFC", "CTL3D32.DLL", "localization [MFC], resources", "installing MFC components"] -ms.assetid: 0b582615-3bb1-4fc0-b569-d127d6deccd3 --- # TN056: Installation of Localized MFC Components +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This tech note, which discussed the installation of localized MFC components, is now obsolete. **See** [TechNote 57](../mfc/tn057-localization-of-mfc-components.md) for more information on localizing MFC applications. diff --git a/docs/mfc/tn057-localization-of-mfc-components.md b/docs/mfc/tn057-localization-of-mfc-components.md index bb920458129..fe12fc41a47 100644 --- a/docs/mfc/tn057-localization-of-mfc-components.md +++ b/docs/mfc/tn057-localization-of-mfc-components.md @@ -3,10 +3,12 @@ description: "Learn more about: TN057: Localization of MFC Components" title: "TN057: Localization of MFC Components" ms.date: "06/28/2018" helpviewer_keywords: ["components [MFC], localizing", "TN057", "resources [MFC], localization", "localization [MFC], MFC resources", "localization [MFC], MFC components", "MFC DLLs [MFC], localizing", "DLLs [MFC], localizing MFC", "localization [MFC], resources"] -ms.assetid: 5376d329-bd45-41bd-97f5-3d895a9a0af5 --- # TN057: Localization of MFC Components +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn058-mfc-module-state-implementation.md b/docs/mfc/tn058-mfc-module-state-implementation.md index 29a3777b22a..b2ca4bf12b7 100644 --- a/docs/mfc/tn058-mfc-module-state-implementation.md +++ b/docs/mfc/tn058-mfc-module-state-implementation.md @@ -3,10 +3,12 @@ description: "Learn more about: TN058: MFC Module State Implementation" title: "TN058: MFC Module State Implementation" ms.date: "06/28/2018" helpviewer_keywords: ["thread state [MFC]", "module states [MFC], managing state data", "TN058", "MFC, managing state data", "module states [MFC], switching", "DLLs [MFC], module states", "process state [MFC]"] -ms.assetid: 72f5b36f-b3da-4009-a144-24258dcd2b2f --- # TN058: MFC Module State Implementation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn059-using-mfc-mbcs-unicode-conversion-macros.md b/docs/mfc/tn059-using-mfc-mbcs-unicode-conversion-macros.md index ad8aba48e47..b4bae8e9fe9 100644 --- a/docs/mfc/tn059-using-mfc-mbcs-unicode-conversion-macros.md +++ b/docs/mfc/tn059-using-mfc-mbcs-unicode-conversion-macros.md @@ -3,10 +3,12 @@ description: "Learn more about: TN059: Using MFC MBCS/Unicode Conversion Macros" title: "TN059: Using MFC MBCS-Unicode Conversion Macros" ms.date: "11/04/2016" helpviewer_keywords: ["MFCANS32.DLL", "Unicode [MFC], conversion macros", "Unicode [MFC], OLE interfaces", "conversion macros [MFC]", "converting Unicode", "MBCS [MFC], conversion macros", "macros [MFC], MBCS conversion macros", "TN059"] -ms.assetid: a2aab748-94d0-4e2f-8447-3bd07112a705 --- # TN059: Using MFC MBCS/Unicode Conversion Macros +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn060-the-new-windows-common-controls.md b/docs/mfc/tn060-the-new-windows-common-controls.md index 587bb4c4336..2fc9ddc17bd 100644 --- a/docs/mfc/tn060-the-new-windows-common-controls.md +++ b/docs/mfc/tn060-the-new-windows-common-controls.md @@ -4,10 +4,12 @@ title: "TN060: The New Windows Common Controls" ms.date: "11/04/2016" f1_keywords: ["vc.controls.common"] helpviewer_keywords: ["TN060"] -ms.assetid: 1a8eea6c-283a-4043-a7dc-a036e37e508e --- # TN060: The New Windows Common Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Technical Note 60, describing the new Windows common controls and how to use them, has been incorporated into [Controls](../mfc/controls-mfc.md). ## See also diff --git a/docs/mfc/tn061-on-notify-and-wm-notify-messages.md b/docs/mfc/tn061-on-notify-and-wm-notify-messages.md index 41abe932b83..8575d247f07 100644 --- a/docs/mfc/tn061-on-notify-and-wm-notify-messages.md +++ b/docs/mfc/tn061-on-notify-and-wm-notify-messages.md @@ -3,11 +3,13 @@ description: "Learn more about: TN061: ON_NOTIFY and WM_NOTIFY Messages" title: "TN061: ON_NOTIFY and WM_NOTIFY Messages" ms.date: "06/28/2018" helpviewer_keywords: ["ON_NOTIFY_EX message [MFC]", "TN061", "ON_NOTIFY message [MFC]", "ON_NOTIFY_EX_RANGE message [MFC]", "ON_NOTIFY_RANGE message [MFC]", "notification messages", "WM_NOTIFY message"] -ms.assetid: 04a96dde-7049-41df-9954-ad7bb5587caf ms.topic: reference --- # TN061: ON_NOTIFY and WM_NOTIFY Messages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn062-message-reflection-for-windows-controls.md b/docs/mfc/tn062-message-reflection-for-windows-controls.md index 9f4d1c7ffe5..dda93b386df 100644 --- a/docs/mfc/tn062-message-reflection-for-windows-controls.md +++ b/docs/mfc/tn062-message-reflection-for-windows-controls.md @@ -4,10 +4,12 @@ title: "TN062: Message Reflection for Windows Controls" ms.date: "06/28/2018" f1_keywords: ["vc.controls.messages"] helpviewer_keywords: ["ON_WM_VKEYTOITEM_REFLECT macro [MFC]", "ON_WM_DRAWITEM_REFLECT macro [MFC]", "ON_WM_VSCROLL_REFLECT macro [MFC]", "ON_NOTIFY_REFLECT message [MFC]", "ON_CONTROL_REFLECT_EX macro [MFC]", "ON_UPDATE_COMMAND_UI_REFLECT macro [MFC]", "ON_NOTIFY_REFLECT_EX message [MFC]", "ON_WM_HSCROLL_REFLECT macro [MFC]", "message reflection [MFC]", "ON_WM_COMPAREITEM_REFLECT macro [MFC]", "ON_WM_MEASUREITEM_REFLECT macro [MFC]", "ON_NOTIFY message [MFC]", "WM_COMMAND [MFC]", "WM_CTLCOLOR message [MFC]", "TN062 [MFC]", "ON_WM_CHARTOITEM_REFLECT macro [MFC]", "ON_WM_CTLCOLOR_REFLECT macro [MFC]", "ON_WM_DELETEITEM_REFLECT macro [MFC]", "notification messages [MFC]", "ON_WM_PARENTNOTIFY_REFLECT macro [MFC]", "WM_NOTIFY message [MFC]", "ON_CONTROL_REFLECT macro"] -ms.assetid: 53efb0ba-fcda-4fa0-a3c7-14e0b78fb494 --- # TN062: Message Reflection for Windows Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. @@ -90,7 +92,7 @@ This simple example creates a reusable control called `CYellowEdit`. The control You must have an application in which to develop the reusable control. If you don't have an existing application to use, create a dialog-based application using AppWizard. -2. With your project loaded into Visual C++, use ClassWizard to create a new class called `CYellowEdit` based on `CEdit`. +2. With your project loaded into Visual Studio, use ClassWizard to create a new class called `CYellowEdit` based on `CEdit`. 3. Add three member variables to your `CYellowEdit` class. The first two will be *COLORREF* variables to hold the text color and the background color. The third will be a `CBrush` object that will hold the brush for painting the background. The `CBrush` object allows you to create the brush once, merely referencing it after that, and to destroy the brush automatically when the `CYellowEdit` control is destroyed. diff --git a/docs/mfc/tn063-debugging-internet-extension-dlls.md b/docs/mfc/tn063-debugging-internet-extension-dlls.md index 221dc62282f..cbc729feaf3 100644 --- a/docs/mfc/tn063-debugging-internet-extension-dlls.md +++ b/docs/mfc/tn063-debugging-internet-extension-dlls.md @@ -4,10 +4,12 @@ title: "TN063: Debugging Internet MFC extension DLLs" ms.date: "11/04/2016" f1_keywords: ["vs.debug.dlls"] helpviewer_keywords: ["IIS [MFC], debugging DLLs", "TN063 [MFC]", "DLLs [MFC], Internet extension"] -ms.assetid: 7012d592-9d2f-491a-b417-48e5c2a7680f --- # TN063: Debugging Internet MFC extension DLLs +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This information is obsolete and has been removed. ## See also diff --git a/docs/mfc/tn064-apartment-model-threading-in-activex-controls.md b/docs/mfc/tn064-apartment-model-threading-in-activex-controls.md index 0d71b56986e..126989be356 100644 --- a/docs/mfc/tn064-apartment-model-threading-in-activex-controls.md +++ b/docs/mfc/tn064-apartment-model-threading-in-activex-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: TN064: Apartment-Model Threading in ActiveX Cont title: "TN064: Apartment-Model Threading in ActiveX Controls" ms.date: "11/04/2016" helpviewer_keywords: ["OLE controls [MFC], container support", "containers [MFC], multithreaded", "TN064 [MFC]", "multithread container [MFC]", "apartment model threading [MFC]"] -ms.assetid: b2ab4c88-6954-48e2-9a74-01d4a60df073 --- # TN064: Apartment-Model Threading in ActiveX Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn065-dual-interface-support-for-ole-automation-servers.md b/docs/mfc/tn065-dual-interface-support-for-ole-automation-servers.md index 295169fce62..956ba9e677a 100644 --- a/docs/mfc/tn065-dual-interface-support-for-ole-automation-servers.md +++ b/docs/mfc/tn065-dual-interface-support-for-ole-automation-servers.md @@ -4,10 +4,12 @@ title: "TN065: Dual-Interface Support for OLE Automation Servers" ms.date: "06/28/2018" f1_keywords: ["vc.ole"] helpviewer_keywords: ["dual interfaces [MFC], OLE Automation", "TN065 [MFC]", "ACDUAL sample [MFC]", "Automation servers [MFC], dual-interface support"] -ms.assetid: b5c8ed09-2f7f-483c-80fc-2a47ad896063 --- # TN065: Dual-Interface Support for OLE Automation Servers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. @@ -31,7 +33,7 @@ Although OLE Automation allows you to implement an `IDispatch` interface, a VTBL A dual interface is really just a custom interface derived from `IDispatch`. The most straightforward way to implement dual-interface support in a `CCmdTarget`-based class is to first implement the normal dispatch interface on your class using MFC and ClassWizard, then add the custom interface later. For the most part, your custom interface implementation will simply delegate back to the MFC `IDispatch` implementation. -First, modify the ODL file for your server to define dual interfaces for your objects. To define a dual interface, you must use an interface statement, instead of the `DISPINTERFACE` statement that the Visual C++ wizards generate. Rather than removing the existing `DISPINTERFACE` statement, add a new interface statement. By retaining the `DISPINTERFACE` form, you can continue to use ClassWizard to add properties and methods to your object, but you must add the equivalent properties and methods to your interface statement. +First, modify the ODL file for your server to define dual interfaces for your objects. To define a dual interface, you must use an interface statement, instead of the `DISPINTERFACE` statement that the Visual Studio wizards generate. Rather than removing the existing `DISPINTERFACE` statement, add a new interface statement. By retaining the `DISPINTERFACE` form, you can continue to use ClassWizard to add properties and methods to your object, but you must add the equivalent properties and methods to your interface statement. An interface statement for a dual interface must have the *OLEAUTOMATION* and *DUAL* attributes, and the interface must be derived from `IDispatch`. You can use the [GUIDGEN](../overview/visual-cpp-samples.md) sample to create a **IID** for the dual interface: @@ -275,7 +277,7 @@ To add the **UUID** definitions from the MkTypLib-generated header file to your ## Specifying the Correct Object Class Name in the Type Library -The wizards shipped with Visual C++ incorrectly use the implementation class name to specify the coclass in the server's ODL file for OLE-creatable classes. While this will work, the implementation class name is probably not the class name you want users of your object to use. To specify the correct name, open the ODL file, locate each coclass statement, and replace the implementation class name with the correct external name. +The wizards shipped with Visual Studio incorrectly use the implementation class name to specify the coclass in the server's ODL file for OLE-creatable classes. While this will work, the implementation class name is probably not the class name you want users of your object to use. To specify the correct name, open the ODL file, locate each coclass statement, and replace the implementation class name with the correct external name. Note that when the coclass statement is changed, the variable names of **CLSID**s in the MkTypLib-generated header file will change accordingly. You will need to update your code to use the new variable names. diff --git a/docs/mfc/tn066-common-mfc-3-x-to-4-0-porting-issues.md b/docs/mfc/tn066-common-mfc-3-x-to-4-0-porting-issues.md index ecfa6eef124..6b374174140 100644 --- a/docs/mfc/tn066-common-mfc-3-x-to-4-0-porting-issues.md +++ b/docs/mfc/tn066-common-mfc-3-x-to-4-0-porting-issues.md @@ -3,10 +3,12 @@ description: "Learn more about: TN066: Common MFC 3.x to 4.0 Porting Issues" title: "TN066: Common MFC 3.x to 4.0 Porting Issues" ms.date: "11/04/2016" helpviewer_keywords: ["porting MFC, 3.x to 4.0", "TN066 [MFC]", "porting MFC"] -ms.assetid: 88308897-8da8-496d-bdef-d34ab77cdd79 --- # TN066: Common MFC 3.x to 4.0 Porting Issues +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This technical note described the most common problems that can occur when attempting to port an application written with MFC 3.x (the MFC included with Visual C++ 2.x) to MFC 4.0. ## See also diff --git a/docs/mfc/tn068-performing-transactions-with-the-microsoft-access-7-odbc-driver.md b/docs/mfc/tn068-performing-transactions-with-the-microsoft-access-7-odbc-driver.md index 41fbc200c66..64b92977edd 100644 --- a/docs/mfc/tn068-performing-transactions-with-the-microsoft-access-7-odbc-driver.md +++ b/docs/mfc/tn068-performing-transactions-with-the-microsoft-access-7-odbc-driver.md @@ -4,10 +4,12 @@ title: "TN068: Performing Transactions with the Microsoft Access 7 ODBC Driver" ms.date: "06/28/2018" f1_keywords: ["vc.data.odbc"] helpviewer_keywords: ["TN068 [MFC]", "transactions [MFC], calling BeginTrans", "transactions [MFC], Microsoft Access"] -ms.assetid: d3f8f5d9-b118-4194-be36-a1aefb630c45 --- # TN068: Performing Transactions with the Microsoft Access 7 ODBC Driver +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn070-mfc-window-class-names.md b/docs/mfc/tn070-mfc-window-class-names.md index f72a9dadf3f..f3d9fe97e47 100644 --- a/docs/mfc/tn070-mfc-window-class-names.md +++ b/docs/mfc/tn070-mfc-window-class-names.md @@ -3,10 +3,12 @@ description: "Learn more about: TN070: MFC Window Class Names" title: "TN070: MFC Window Class Names" ms.date: "11/04/2016" helpviewer_keywords: ["window class names [MFC]", "TN070 [MFC]"] -ms.assetid: 90617912-dd58-4a7c-9082-ced71736d7cd --- # TN070: MFC Window Class Names +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/tn071-mfc-iolecommandtarget-implementation.md b/docs/mfc/tn071-mfc-iolecommandtarget-implementation.md index 293dda09b60..33a2073e56b 100644 --- a/docs/mfc/tn071-mfc-iolecommandtarget-implementation.md +++ b/docs/mfc/tn071-mfc-iolecommandtarget-implementation.md @@ -3,10 +3,12 @@ description: "Learn more about: TN071: MFC IOleCommandTarget Implementation" title: "TN071: MFC IOleCommandTarget Implementation" ms.date: "06/28/2018" helpviewer_keywords: ["TN071 [MFC]", "IOleCommandTarget interface [MFC]"] -ms.assetid: 3eef571e-6357-444d-adbb-6f734a0c3161 --- # TN071: MFC IOleCommandTarget Implementation +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > The following technical note has not been updated since it was first included in the online documentation. As a result, some procedures and topics might be out of date or incorrect. For the latest information, it is recommended that you search for the topic of interest in the online documentation index. diff --git a/docs/mfc/toc.yml b/docs/mfc/toc.yml index 691f07b181b..fcc45274295 100644 --- a/docs/mfc/toc.yml +++ b/docs/mfc/toc.yml @@ -1493,7 +1493,7 @@ items: href: tn032-mfc-exception-mechanism.md - name: "TN033: DLL version of MFC" href: tn033-dll-version-of-mfc.md - - name: "TN035: Using multiple resource files and header files with Visual C++" + - name: "TN035: Using multiple resource files and header files with Visual Studio" href: tn035-using-multiple-resource-files-and-header-files-with-visual-cpp.md - name: "TN036: Using CFormView with AppWizard and ClassWizard" href: tn036-using-cformview-with-appwizard-and-classwizard.md diff --git a/docs/mfc/tool-tips-in-windows-not-derived-from-cframewnd.md b/docs/mfc/tool-tips-in-windows-not-derived-from-cframewnd.md index ae8986fef63..8d3d3ee6772 100644 --- a/docs/mfc/tool-tips-in-windows-not-derived-from-cframewnd.md +++ b/docs/mfc/tool-tips-in-windows-not-derived-from-cframewnd.md @@ -3,10 +3,12 @@ description: "Learn more about: Tool Tips in Windows Not Derived from CFrameWnd" title: "Tool Tips in Windows Not Derived from CFrameWnd" ms.date: "11/04/2016" helpviewer_keywords: ["enabling tool tips [MFC]", "TOOLTIPTEXT structure [MFC]", "Help [MFC], tool tips for controls", "TTN_NEEDTEXT message [MFC]", "controls [MFC], tool tips", "handler functions [MFC], tool tips"] -ms.assetid: cad5ef0f-02e3-4151-ad0d-3d42e6932b0e --- # Tool Tips in Windows Not Derived from CFrameWnd +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article family covers enabling tool tips for controls contained in a window that is not derived from [CFrameWnd](../mfc/reference/cframewnd-class.md). The article [Toolbars Tool Tips](../mfc/toolbar-tool-tips.md) provides information about tool tips for controls in a `CFrameWnd`. Topics covered in this article family include: diff --git a/docs/mfc/tool-tips.md b/docs/mfc/tool-tips.md index 33ac9aa93ef..84f1e235f9b 100644 --- a/docs/mfc/tool-tips.md +++ b/docs/mfc/tool-tips.md @@ -3,10 +3,12 @@ description: "Learn more about: Tool Tips" title: "Tool Tips" ms.date: "11/04/2016" helpviewer_keywords: ["CFrameWnd class [MFC], tool tips", "Help [MFC], tool tips for controls", "tool tips [MFC], CFrameWnd", "controls [MFC], tool tips", "buttons [MFC], tool tips"] -ms.assetid: 7f0bba86-7c55-4bf6-8455-687a4dcb2be8 --- # Tool Tips +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The procedures are distinct for adding tool tips to controls contained in windows derived from MFC class [CFrameWnd](../mfc/reference/cframewnd-class.md) and windows not derived from `CFrameWnd`. ## What do you want to know more about diff --git a/docs/mfc/toolbar-fundamentals.md b/docs/mfc/toolbar-fundamentals.md index 283156c66ef..92532ae95e8 100644 --- a/docs/mfc/toolbar-fundamentals.md +++ b/docs/mfc/toolbar-fundamentals.md @@ -4,10 +4,12 @@ title: "Toolbar Fundamentals" ms.date: "11/04/2016" f1_keywords: ["RT_TOOLBAR"] helpviewer_keywords: ["embedding toolbar in frame window class [MFC]", "application wizards [MFC], installing default application toolbars", "toolbars [MFC], creating", "resources [MFC], toolbar", "toolbar controls [MFC], toolbars created using Application Wizard", "toolbar controls [MFC], command ID", "RT_TOOLBAR resource [MFC]", "toolbars [MFC], adding default using Application Wizard", "LoadBitmap method [MFC], toolbars", "Toolbar editor [MFC], Application Wizard", "command IDs [MFC], toolbar buttons", "SetButtons method [MFC]", "CToolBar class [MFC], default toolbars in Application Wizard", "frame window classes [MFC], toolbar embedded in", "LoadToolBar method [MFC]"] -ms.assetid: cc00aaff-8a56-433b-b0c0-b857d76b4ffd --- # Toolbar Fundamentals +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the fundamental MFC implementation that lets you add a default toolbar to your application by selecting an option in the Application Wizard. Topics covered include: - [The Application Wizard toolbar option](#_core_the_appwizard_toolbar_option) @@ -47,7 +49,7 @@ The docking, floating, and tool tips calls are optional. You can remove those li ## Editing the Toolbar Resource -The default toolbar you get with the Application Wizard is based on an **RT_TOOLBAR** custom resource, introduced in MFC version 4.0. You can edit this resource with the [toolbar editor](../windows/toolbar-editor.md). The editor lets you easily add, delete, and rearrange buttons. It contains a graphical editor for the buttons that is very similar to the general graphics editor in Visual C++. If you edited toolbars in previous versions of Visual C++, you'll find the task much easier now. +The default toolbar you get with the Application Wizard is based on an **RT_TOOLBAR** custom resource, introduced in MFC version 4.0. You can edit this resource with the [toolbar editor](../windows/toolbar-editor.md). The editor lets you easily add, delete, and rearrange buttons. It contains a graphical editor for the buttons that is very similar to the general graphics editor in Visual Studio. If you edited toolbars in previous versions of Visual Studio, you'll find the task much easier now. To connect a toolbar button to a command, you give the button a command ID, such as `ID_MYCOMMAND`. Specify the command ID in the button's property page in the toolbar editor. Then create a handler function for the command (see [Mapping Messages to Functions](../mfc/reference/mapping-messages-to-functions.md) for more information). diff --git a/docs/mfc/toolbar-sample-list.md b/docs/mfc/toolbar-sample-list.md index f7ec47b1bec..a47fdf7ea6c 100644 --- a/docs/mfc/toolbar-sample-list.md +++ b/docs/mfc/toolbar-sample-list.md @@ -3,10 +3,12 @@ description: "Learn more about: Toolbar Sample List" title: "Toolbar Sample List" ms.date: "11/04/2016" helpviewer_keywords: ["sample applications [MFC], toolbars"] -ms.assetid: 61310e4e-3df7-47c2-8b10-7c6cb45c5d1b --- # Toolbar Sample List +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + See the following sample programs that illustrate using MFC's toolbars: - [SCRIBBLE](../overview/visual-cpp-samples.md) diff --git a/docs/mfc/toolbar-tool-tips.md b/docs/mfc/toolbar-tool-tips.md index d7914d8884d..b0ea2b0d9a7 100644 --- a/docs/mfc/toolbar-tool-tips.md +++ b/docs/mfc/toolbar-tool-tips.md @@ -3,10 +3,12 @@ description: "Learn more about: Toolbar Tool Tips" title: "Toolbar Tool Tips" ms.date: "11/04/2016" helpviewer_keywords: ["tool tips [MFC], activating", "CBRS_TOOLTIPS constant [MFC]", "tool tips [MFC], adding text", "updates [MFC]", "CBRS_FLYBY constant [MFC]", "tool tips [MFC]", "updating status bar messages", "updates, status bar messages", "status bars [MFC], tool tips", "flyby status bar updates"] -ms.assetid: d1696305-b604-4fad-9f09-638878371412 --- # Toolbar Tool Tips +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Tool tips are the tiny popup windows that present short descriptions of a toolbar button's purpose when you position the mouse over a button for a period of time. When you create an application with the Application Wizard that has a toolbar, tool tip support is provided for you. This article explains both the tool tip support created by the Application Wizard and how to add tool tip support to your application. This article covers: diff --git a/docs/mfc/toolbars.md b/docs/mfc/toolbars.md index 7ad24693784..cca3d41db3b 100644 --- a/docs/mfc/toolbars.md +++ b/docs/mfc/toolbars.md @@ -3,10 +3,12 @@ description: "Learn more about: Toolbars" title: "Toolbars" ms.date: "11/04/2016" helpviewer_keywords: ["toolbars [MFC]", "command bars [MFC], MFC toolbars"] -ms.assetid: c22ecc5b-a84c-4979-8d1a-8e3e71d5ce33 --- # Toolbars +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The toolbar family of articles describes MFC toolbars and how to create and use them. ## What do you want to know more about diff --git a/docs/mfc/tooltiptext-structure.md b/docs/mfc/tooltiptext-structure.md index 2fb1e28f541..ebb33d4f484 100644 --- a/docs/mfc/tooltiptext-structure.md +++ b/docs/mfc/tooltiptext-structure.md @@ -4,10 +4,12 @@ title: "TOOLTIPTEXT Structure" ms.date: "11/04/2016" f1_keywords: ["TOOLTIPTEXT"] helpviewer_keywords: ["TOOLTIPTEXT structure [MFC]", "tool tips [MFC], notifications"] -ms.assetid: 547591bf-80f5-400e-a2a7-0708cfffbb5d --- # TOOLTIPTEXT Structure +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In writing your [tool tip notification handler](../mfc/handling-ttn-needtext-notification-for-tool-tips.md), you need to use the **TOOLTIPTEXT** structure. The members of the **TOOLTIPTEXT** structure are: ```cpp diff --git a/docs/mfc/trackers-implementing-trackers-in-your-ole-application.md b/docs/mfc/trackers-implementing-trackers-in-your-ole-application.md index d5718ffda1d..208656401f8 100644 --- a/docs/mfc/trackers-implementing-trackers-in-your-ole-application.md +++ b/docs/mfc/trackers-implementing-trackers-in-your-ole-application.md @@ -3,10 +3,12 @@ description: "Learn more about: Trackers: Implementing Trackers in Your OLE Appl title: "Trackers: Implementing Trackers in Your OLE Application" ms.date: "11/04/2016" helpviewer_keywords: ["trackers [MFC]", "OLE applications [MFC], trackers", "applications [OLE], trackers", "tracking OLE items [MFC]", "OLE containers [MFC], trackers", "CRectTracker class [MFC], implementing trackers"] -ms.assetid: 5103a517-65bd-441a-8a53-02915ff3ef08 --- # Trackers: Implementing Trackers in Your OLE Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Trackers provide a graphical interface to enable users to interact with OLE client items. By using different tracker styles, OLE client items can be displayed with hatched borders, resize handles, or a variety of other visual effects. This article describes: - [How to Implement Tracking in Your Code](../mfc/how-to-implement-tracking-in-your-code.md). diff --git a/docs/mfc/trackers.md b/docs/mfc/trackers.md index 284e9585651..c3f2d1dec11 100644 --- a/docs/mfc/trackers.md +++ b/docs/mfc/trackers.md @@ -3,10 +3,12 @@ description: "Learn more about: Trackers" title: "Trackers" ms.date: "11/04/2016" helpviewer_keywords: ["trackers [MFC]", "OLE applications [MFC], trackers", "applications [OLE], trackers", "tracking OLE items [MFC]", "OLE containers [MFC], trackers", "CDC class [MFC], trackers", "CRectTracker class [MFC], implementing trackers", "OLE server applications [MFC], trackers"] -ms.assetid: dcd09399-6637-4621-80e5-d12670429787 --- # Trackers +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [CRectTracker](../mfc/reference/crecttracker-class.md) class provides a user interface between rectangular items in your application and your user by providing a variety of display styles. These styles include solid, hatched, or dashed borders; a hatched pattern that covers the item; and resize handles that can be located on the outside or inside of a border. Trackers are often used in conjunction with OLE items, that is, objects derived from `COleClientItem`. The tracker rectangles give visual cues on the current status of the item. The MFC OLE sample [OCLIENT](../overview/visual-cpp-samples.md) demonstrates a common interface using trackers and OLE client items from the viewpoint of a container application. For a demonstration of the different styles and abilities of a tracker object, see the MFC general sample [TRACKER](../overview/visual-cpp-samples.md). diff --git a/docs/mfc/tree-control-drag-and-drop-operations.md b/docs/mfc/tree-control-drag-and-drop-operations.md index 32bfd434cb4..bd72d567335 100644 --- a/docs/mfc/tree-control-drag-and-drop-operations.md +++ b/docs/mfc/tree-control-drag-and-drop-operations.md @@ -3,10 +3,12 @@ description: "Learn more about: Tree Control Drag-and-Drop Operations" title: "Tree Control Drag-and-Drop Operations" ms.date: "11/04/2016" helpviewer_keywords: ["CTreeCtrl class [MFC], drag and drop operations", "drag and drop [MFC], CTreeCtrl", "tree controls [MFC], drag and drop operations"] -ms.assetid: 3cf78b4c-4579-4fe1-9bc9-c5ab876e4af1 --- # Tree Control Drag-and-Drop Operations +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) sends a notification when the user starts to drag an item. The control sends a [TVN_BEGINDRAG](/windows/win32/Controls/tvn-begindrag) notification message when the user begins dragging an item with the left mouse button and a [TVN_BEGINRDRAG](/windows/win32/Controls/tvn-beginrdrag) notification message when the user begins dragging with the right button. You can prevent a tree control from sending these notifications by giving the tree control the TVS_DISABLEDRAGDROP style. You obtain an image to display during a drag operation by calling the [CreateDragImage](../mfc/reference/ctreectrl-class.md#createdragimage) member function. The tree control creates a dragging bitmap based on the label of the item being dragged. Then the tree control creates an image list, adds the bitmap to it, and returns a pointer to the [CImageList](../mfc/reference/cimagelist-class.md) object. diff --git a/docs/mfc/tree-control-image-lists.md b/docs/mfc/tree-control-image-lists.md index d8525bec05f..93787bb896f 100644 --- a/docs/mfc/tree-control-image-lists.md +++ b/docs/mfc/tree-control-image-lists.md @@ -3,10 +3,12 @@ description: "Learn more about: Tree Control Image Lists" title: "Tree Control Image Lists" ms.date: "11/04/2016" helpviewer_keywords: ["images [MFC], lists in tree controls", "tree controls [MFC], image lists", "CTreeCtrl class [MFC], image lists"] -ms.assetid: f560c4f2-20d2-4d28-ac33-4017e65fb0a6 --- # Tree Control Image Lists +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Each item in a tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) can have a pair of bitmapped images associated with it. The images appear on the left side of an item's label. One image is displayed when the item is selected, and the other is displayed when the item is not selected. For example, an item might display an open folder when it is selected and a closed folder when it is not selected. To use item images, you must create an image list by constructing a [CImageList](../mfc/reference/cimagelist-class.md) object and using the [CImageList::Create](../mfc/reference/cimagelist-class.md#create) function to create the associated image list. Then add the desired bitmaps to the list, and associate the list with the tree control by using the [SetImageList](../mfc/reference/ctreectrl-class.md#setimagelist) member function. By default, all items display the first image in the image list for both the selected and nonselected states. You can change the default behavior for a particular item by specifying the indexes of the selected and nonselected images when adding the item to the tree control using the [InsertItem](../mfc/reference/ctreectrl-class.md#insertitem) member function. You can change the indexes after adding an item by using the [SetItemImage](../mfc/reference/ctreectrl-class.md#setitemimage) member function. diff --git a/docs/mfc/tree-control-item-information.md b/docs/mfc/tree-control-item-information.md index acf7eb6b7d9..bc49370f2b1 100644 --- a/docs/mfc/tree-control-item-information.md +++ b/docs/mfc/tree-control-item-information.md @@ -3,10 +3,12 @@ description: "Learn more about: Tree Control Item Information" title: "Tree Control Item Information" ms.date: "11/04/2016" helpviewer_keywords: ["tree controls [MFC], item information", "CTreeCtrl class [MFC], item information"] -ms.assetid: 8dcab855-27de-49e9-95d8-f78ba963ea71 --- # Tree Control Item Information +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Tree controls ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) have a number of member functions that retrieve information about items in the control. The [GetItem](../mfc/reference/ctreectrl-class.md#getitem) member function retrieves some or all of the data associated with an item. This data could include the item's text, state, images, count of child items, and an application-defined 32-bit data value. There is also a [SetItem](../mfc/reference/ctreectrl-class.md#setitem) function that can set some or all of the data associated with an item. The [GetItemState](../mfc/reference/ctreectrl-class.md#getitemstate), [GetItemText](../mfc/reference/ctreectrl-class.md#getitemtext), [GetItemData](../mfc/reference/ctreectrl-class.md#getitemdata), and [GetItemImage](../mfc/reference/ctreectrl-class.md#getitemimage) member functions retrieve individual attributes of an item. Each of these functions has a corresponding Set function for setting the attributes of an item. diff --git a/docs/mfc/tree-control-item-labels.md b/docs/mfc/tree-control-item-labels.md index aea13c5e902..42490361966 100644 --- a/docs/mfc/tree-control-item-labels.md +++ b/docs/mfc/tree-control-item-labels.md @@ -3,10 +3,12 @@ description: "Learn more about: Tree Control Item Labels" title: "Tree Control Item Labels" ms.date: "11/04/2016" helpviewer_keywords: ["tree controls [MFC], item labels", "labels, CTreeCtrl items", "CTreeCtrl class [MFC], item labels", "item labels, tree controls", "item labels"] -ms.assetid: fe834107-1a25-4280-aced-774c11565805 --- # Tree Control Item Labels +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You typically specify the text of an item's label when adding the item to the tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)). The `InsertItem` member function can pass a [TVITEM](/windows/win32/api/commctrl/ns-commctrl-tvitemw) structure that defines the item's properties, including a string containing the text of the label. `InsertItem` has several overloads that can be called with various combinations of parameters. A tree control allocates memory for storing each item; the text of the item labels takes up a significant portion of this memory. If your application maintains a copy of the strings in the tree control, you can decrease the memory requirements of the control by specifying the **LPSTR_TEXTCALLBACK** value in the *pszText* member of `TV_ITEM` or the *lpszItem* parameter instead of passing actual strings to the tree control. Using **LPSTR_TEXTCALLBACK** causes the tree control to retrieve the text of an item's label from the application whenever the item needs to be redrawn. To retrieve the text, the tree control sends a [TVN_GETDISPINFO](/windows/win32/Controls/tvn-getdispinfo) notification message, which includes the address of a [NMTVDISPINFO](/windows/win32/api/commctrl/ns-commctrl-nmtvdispinfow) structure. You must respond by setting the appropriate members of the included structure. diff --git a/docs/mfc/tree-control-item-position.md b/docs/mfc/tree-control-item-position.md index f6a855c2018..11544293a93 100644 --- a/docs/mfc/tree-control-item-position.md +++ b/docs/mfc/tree-control-item-position.md @@ -3,10 +3,12 @@ description: "Learn more about: Tree Control Item Position" title: "Tree Control Item Position" ms.date: "11/04/2016" helpviewer_keywords: ["CTreeCtrl class [MFC], item position", "item position in tree controls", "tree controls [MFC], item position", "position, CTreeCtrl items"] -ms.assetid: cd264344-2cf9-4d90-9ea8-c6900b6f60e7 --- # Tree Control Item Position +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An item's initial position is set when the item is added to the tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) by using the `InsertItem` member function. The member function call specifies the handle of the parent item and the handle of the item after which the new item is to be inserted. The second handle must identify either a child item of the given parent or one of these values: `TVI_FIRST`, `TVI_LAST`, or `TVI_SORT`. When `TVI_FIRST` or `TVI_LAST` is specified, the tree control places the new item at the beginning or end of the given parent item's list of child items. When `TVI_SORT` is specified, the tree control inserts the new item into the list of child items in alphabetical order based on the text of the item labels. diff --git a/docs/mfc/tree-control-item-selection.md b/docs/mfc/tree-control-item-selection.md index e48ff060f2c..411f20dbc4f 100644 --- a/docs/mfc/tree-control-item-selection.md +++ b/docs/mfc/tree-control-item-selection.md @@ -3,10 +3,12 @@ description: "Learn more about: Tree Control Item Selection" title: "Tree Control Item Selection" ms.date: "11/04/2016" helpviewer_keywords: ["tree controls [MFC], item selection", "controls [MFC], selecting items in", "CTreeCtrl class [MFC], item selection", "item selection in tree controls"] -ms.assetid: 7bcb3b16-b9c8-4c06-9350-7bc3c1c5009b --- # Tree Control Item Selection +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When the selection changes from one item to another, a tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) sends [TVN_SELCHANGING](/windows/win32/Controls/tvn-selchanging) and [TVN_SELCHANGED](/windows/win32/Controls/tvn-selchanged) notification messages. Both notifications include a value that specifies whether the change is the result of a mouse click or a keystroke. The notifications also include information about the item that is gaining the selection and the item that is losing the selection. You can use this information to set item attributes that depend on the selection state of the item. Returning **TRUE** in response to `TVN_SELCHANGING` prevents the selection from changing; returning **FALSE** allows the change. An application can change the selection by calling the [SelectItem](../mfc/reference/ctreectrl-class.md#selectitem) member function. diff --git a/docs/mfc/tree-control-item-states-overview.md b/docs/mfc/tree-control-item-states-overview.md index ca07cec4fa6..856d9a7e72d 100644 --- a/docs/mfc/tree-control-item-states-overview.md +++ b/docs/mfc/tree-control-item-states-overview.md @@ -3,11 +3,13 @@ description: "Learn more about: Tree Control Item States Overview" title: "Tree Control Item States Overview" ms.date: "11/04/2016" helpviewer_keywords: ["states, CTreeCtrl items", "tree controls [MFC], item states overview", "CTreeCtrl class [MFC], item states"] -ms.assetid: 2db11ae0-0d87-499d-8c1f-5e0dbe9e94c8 ms.topic: concept-article --- # Tree Control Item States Overview +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Each item in a tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) has a current state. For example, an item can be selected, disabled, expanded, and so on. For the most part, the tree control automatically sets an item's state to reflect user actions, such as selection of an item. However, you can also set an item's state by using the [SetItemState](../mfc/reference/ctreectrl-class.md#setitemstate) member function and retrieve the current state of an item by using the [GetItemState](../mfc/reference/ctreectrl-class.md#getitemstate) member function. For a complete list of item states, see [Tree-View Control Constants](/windows/win32/Controls/tree-view-control-item-states) in the Windows SDK. An item's current state is specified by the *nState* parameter. A tree control might change an item's state to reflect a user action, such as selecting the item or setting the focus to the item. In addition, an application might change an item's state to disable or hide the item or to specify an overlay image or state image. diff --git a/docs/mfc/tree-control-label-editing.md b/docs/mfc/tree-control-label-editing.md index ec3bd79edfb..fbef5efff63 100644 --- a/docs/mfc/tree-control-label-editing.md +++ b/docs/mfc/tree-control-label-editing.md @@ -3,10 +3,12 @@ description: "Learn more about: Tree Control Label Editing" title: "Tree Control Label Editing" ms.date: "11/04/2016" helpviewer_keywords: ["editing tree control labels", "CTreeCtrl class [MFC], editing labels", "label editing in CTreeCtrl class [MFC]", "tree controls [MFC], label editing"] -ms.assetid: 6cde2ac3-43ee-468f-bac2-cf1a228ad32d --- # Tree Control Label Editing +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The user can directly edit the labels of items in a tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) that has the **TVS_EDITLABELS** style. The user begins editing by clicking the label of the item that has the focus. An application begins editing by using the [EditLabel](../mfc/reference/ctreectrl-class.md#editlabel) member function. The tree control sends the notification when editing begins and when it is canceled or completed. When editing is completed, you are responsible for updating the item's label, if appropriate. When label editing begins, a tree control sends a [TVN_BEGINLABELEDIT](/windows/win32/Controls/tvn-beginlabeledit) notification message. By processing this notification, you can allow editing of some labels and prevent editing of others. Returning 0 allows editing, and returning nonzero prevents it. diff --git a/docs/mfc/tree-control-notification-messages.md b/docs/mfc/tree-control-notification-messages.md index d17b69afe5d..15a91e6e4fb 100644 --- a/docs/mfc/tree-control-notification-messages.md +++ b/docs/mfc/tree-control-notification-messages.md @@ -3,10 +3,12 @@ description: "Learn more about: Tree Control Notification Messages" title: "Tree Control Notification Messages" ms.date: "11/04/2016" helpviewer_keywords: ["notifications [MFC], tree controls", "messages [MFC], notification", "CTreeCtrl class [MFC], notifications", "notifications [MFC], CTreeCtrl", "tree controls [MFC], notification messages"] -ms.assetid: ac7013b4-91dd-4668-bd75-439ca0680ef9 --- # Tree Control Notification Messages +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) sends the following notification messages as WM_NOTIFY messages: |Notification message|Description| diff --git a/docs/mfc/tree-control-parent-and-child-items.md b/docs/mfc/tree-control-parent-and-child-items.md index 27d07a900eb..ddc959d65e6 100644 --- a/docs/mfc/tree-control-parent-and-child-items.md +++ b/docs/mfc/tree-control-parent-and-child-items.md @@ -3,10 +3,12 @@ description: "Learn more about: Tree Control Parent and Child Items" title: "Tree Control Parent and Child Items" ms.date: "11/04/2016" helpviewer_keywords: ["parent items in CTreeCtrl [MFC]", "child items in tree control [MFC]", "CTreeCtrl class [MFC], parent and child items", "tree controls [MFC], parent and child items"] -ms.assetid: abcea1e4-fe9b-40d9-86dc-1db235f8f103 --- # Tree Control Parent and Child Items +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Any item in a tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) can have a list of subitems, which are called child items, associated with it. An item that has one or more child items is called a parent item. A child item is displayed below its parent item and is indented to indicate it is subordinate to the parent. An item that has no parent is at the top of the hierarchy and is called a root item. At any given time, the state of a parent item's list of child items can be either expanded or collapsed. When the state is expanded, the child items are displayed below the parent item. When it is collapsed, the child items are not displayed. The list automatically toggles between the expanded and collapsed states when the user double-clicks the parent item or, if the parent has the **TVS_HASBUTTONS** style, when the user clicks the button associated with the parent item. An application can expand or collapse the child items by using the [Expand](../mfc/reference/ctreectrl-class.md#expand) member function. diff --git a/docs/mfc/tree-control-styles.md b/docs/mfc/tree-control-styles.md index bde048b5f4f..b801000df1d 100644 --- a/docs/mfc/tree-control-styles.md +++ b/docs/mfc/tree-control-styles.md @@ -4,10 +4,12 @@ title: "Tree Control Styles" ms.date: "11/04/2016" f1_keywords: ["TVS_SINGLEEXPAND", "TVS_LINESATROOT", "TVS_HASBUTTONS", "TVS_NOTOOLTIPS", "TVS_HASLINES"] helpviewer_keywords: ["TVS_LINESATROOT [MFC]", "styles [MFC], CTreeCtrl", "styles [MFC], tree control", "TVS_HASLINES", "TVS_SINGLEEXPAND", "CTreeCtrl class [MFC], styles", "TVS_EDITLABELS [MFC]", "TVS_NOTOOLTIPS [MFC]", "TVS_HASBUTTONS [MFC]", "tree controls [MFC], styles"] -ms.assetid: f43faebd-a355-479e-888a-bf0673d5e1b4 --- # Tree Control Styles +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) styles govern aspects of a tree control's appearance. You set the initial styles when you create the tree control. You can retrieve and change the styles after creating the tree control by using the [GetWindowLong](/windows/win32/api/winuser/nf-winuser-getwindowlongw) and [SetWindowLong](/windows/win32/api/winuser/nf-winuser-setwindowlongw) Windows functions, specifying **GWL_STYLE** for the *nIndex* parameter. For a complete list of styles, see [Tree View Control Window Styles](/windows/win32/Controls/tree-view-control-window-styles) in the Windows SDK. The **TVS_HASLINES** style enhances the graphic representation of a tree control's hierarchy by drawing lines that link child items to their corresponding parent item. This style does not link items at the root of the hierarchy. To do so, you need to combine the **TVS_HASLINES** and **TVS_LINESATROOT** styles. diff --git a/docs/mfc/turning-off-the-activate-when-visible-option.md b/docs/mfc/turning-off-the-activate-when-visible-option.md index a72e1bf165f..530d54f0526 100644 --- a/docs/mfc/turning-off-the-activate-when-visible-option.md +++ b/docs/mfc/turning-off-the-activate-when-visible-option.md @@ -3,11 +3,13 @@ description: "Learn more about: Turning off the Activate When Visible Option" title: "Turning off the Activate When Visible Option" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], activate options", "Activate When Visible option [MFC]"] -ms.assetid: 8f7ddc5a-a7a6-4da8-bcb9-1b569f0ecb48 ms.topic: concept-article --- # Turning off the Activate When Visible Option +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A control has two basic states: active and inactive. Traditionally, these states were distinguished by whether the control had a window. An active control had a window; an inactive control did not. With the introduction of windowless activation, this distinction is no longer universal, but still applies to many controls. Compared with the rest of the initialization typically performed by an ActiveX control, the creation of a window is an extremely expensive operation. Ideally, a control would defer creating its window until absolutely necessary. diff --git a/docs/mfc/two-ways-to-create-a-carchive-object.md b/docs/mfc/two-ways-to-create-a-carchive-object.md index 9347fd20f75..b63004007b1 100644 --- a/docs/mfc/two-ways-to-create-a-carchive-object.md +++ b/docs/mfc/two-ways-to-create-a-carchive-object.md @@ -3,10 +3,12 @@ description: "Learn more about: Two Ways to Create a CArchive Object" title: "Two Ways to Create a CArchive Object" ms.date: "11/04/2016" helpviewer_keywords: ["CArchive class [MFC], closing CArchive objects", "CArchive objects [MFC], closing", "I/O [MFC], creating CArchive objects", "serialization [MFC], CArchive class", "CArchive objects [MFC]", "storage [MFC], CArchive class [MFC]", "data storage [MFC], CArchive class", "CArchive class [MFC], constructor"] -ms.assetid: aefa28ce-b55c-40dc-9e42-5f038030985d --- # Two Ways to Create a CArchive Object +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + There are two ways to create a `CArchive` object: - [Implicit creation of a CArchive object via the framework](#_core_implicit_creation_of_a_carchive_object_via_the_framework) diff --git a/docs/mfc/type-safe-access-to-controls-in-a-dialog-box.md b/docs/mfc/type-safe-access-to-controls-in-a-dialog-box.md index 0e628e5526b..1154f42ac06 100644 --- a/docs/mfc/type-safe-access-to-controls-in-a-dialog-box.md +++ b/docs/mfc/type-safe-access-to-controls-in-a-dialog-box.md @@ -3,10 +3,12 @@ description: "Learn more about: Type-Safe Access to Controls in a Dialog Box" title: "Type-Safe Access to Controls in a Dialog Box" ms.date: "11/04/2016" helpviewer_keywords: ["common controls [MFC], in dialog boxes", "Windows common controls [MFC], in dialog boxes", "safe access to dialog box controls", "dialog boxes [MFC], type-safe access to controls", "controls [MFC], accessing in dialog boxes", "type-safe access to dialog box controls", "MFC dialog boxes [MFC], type-safe access to controls"] -ms.assetid: 67021025-dd93-4d6a-8bed-a1348fe50685 --- # Type-Safe Access to Controls in a Dialog Box +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The controls in a dialog box can use the interfaces of MFC control classes such as `CListBox` and `CEdit`. You can create a control object and attach it to a dialog control. Then you can access the control through its class interface, calling member functions to operate on the control. The methods described here are designed to give you type-safe access to a control. This is especially useful for controls such as edit boxes and list boxes. There are two approaches to making a connection between a control in a dialog box and a C++ control member variable in a `CDialog`-derived class: diff --git a/docs/mfc/type-safe-access-to-controls-with-code-wizards.md b/docs/mfc/type-safe-access-to-controls-with-code-wizards.md index 0ac28da3350..56892af1285 100644 --- a/docs/mfc/type-safe-access-to-controls-with-code-wizards.md +++ b/docs/mfc/type-safe-access-to-controls-with-code-wizards.md @@ -3,10 +3,12 @@ description: "Learn more about: Type-Safe Access to Controls With Code Wizards" title: "Type-Safe Access to Controls With Code Wizards" ms.date: "11/04/2016" helpviewer_keywords: ["DDX (dialog data exchange), access to controls", "code wizards", "dialog boxes [MFC], access to controls", "dialog box controls [MFC], accessing"] -ms.assetid: b8874393-ee48-4124-8d78-e3648a7e29b9 --- # Type-Safe Access to Controls With Code Wizards +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If you are familiar with DDX features, you can use the Control property in the [Add Member Variable Wizard](../ide/adding-a-member-variable-visual-cpp.md#add-member-variable-wizard) to create type-safe access. This approach is easier than creating controls without code wizards. If you simply want access to a control's value, DDX provides it. If you want to do more than access a control's value, use the Add Member Variable Wizard to add a member variable of the appropriate class to your dialog class. Attach this member variable to the Control property. diff --git a/docs/mfc/type-safe-access-to-controls-without-code-wizards.md b/docs/mfc/type-safe-access-to-controls-without-code-wizards.md index 6783fcc6296..613307d7c10 100644 --- a/docs/mfc/type-safe-access-to-controls-without-code-wizards.md +++ b/docs/mfc/type-safe-access-to-controls-without-code-wizards.md @@ -3,10 +3,12 @@ description: "Learn more about: Type-Safe Access to Controls Without Code Wizard title: "Type-Safe Access to Controls Without Code Wizards" ms.date: "11/04/2016" helpviewer_keywords: ["dialog boxes [MFC], accessing controls", "dialog box controls [MFC], accessing"] -ms.assetid: 325b4927-d49b-42b4-8e0b-fc84f31fb059 --- # Type-Safe Access to Controls Without Code Wizards +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The first approach to creating type-safe access to controls uses an inline member function to cast the return type of class `CWnd`'s `GetDlgItem` member function to the appropriate C++ control type, as in this example: [!code-cpp[NVC_MFCControlLadenDialog#50](../mfc/codesnippet/cpp/type-safe-access-to-controls-without-code-wizards_1.cpp)] diff --git a/docs/mfc/types-of-image-lists.md b/docs/mfc/types-of-image-lists.md index 3ed02c1d59a..d93ce25d1c3 100644 --- a/docs/mfc/types-of-image-lists.md +++ b/docs/mfc/types-of-image-lists.md @@ -3,10 +3,12 @@ description: "Learn more about: Types of Image Lists" title: "Types of Image Lists" ms.date: "11/04/2016" helpviewer_keywords: ["lists [MFC], image", "image lists [MFC], types of", "CImageList class [MFC], types"] -ms.assetid: bee5e7c3-78f5-4037-a136-9c50d67cdee5 --- # Types of Image Lists +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + There are two types of image lists ([CImageList](../mfc/reference/cimagelist-class.md)): nonmasked and masked. A "nonmasked image list" consists of a color bitmap that contains one or more images. A "masked image list" consists of two bitmaps of equal size. The first is a color bitmap that contains the images, and the second is a monochrome bitmap that contains a series of masks — one for each image in the first bitmap. One of the overloads of the `Create` member function takes a flag to indicate whether or not the image list is masked. (The other overloads create masked image lists.) diff --git a/docs/mfc/updating-the-text-of-a-status-bar-pane.md b/docs/mfc/updating-the-text-of-a-status-bar-pane.md index 1954167790e..e77e2921ab3 100644 --- a/docs/mfc/updating-the-text-of-a-status-bar-pane.md +++ b/docs/mfc/updating-the-text-of-a-status-bar-pane.md @@ -3,11 +3,13 @@ description: "Learn more about: Updating the Text of a Status-Bar Pane" title: "Updating the Text of a Status-Bar Pane" ms.date: "11/04/2016" helpviewer_keywords: ["updating user interface objects [MFC]", "ON_UPDATE_COMMAND_UI macro [MFC]", "user interface objects [MFC], updating", "text, status bar", "CStatusBar class [MFC], updating", "SetText method [MFC]", "panes, status bar", "status bars [MFC], updating"] -ms.assetid: 4984a3f4-9905-4d8c-a927-dca19781053b ms.topic: how-to --- # Updating the Text of a Status-Bar Pane +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to change the text that appears in an MFC status bar pane. A status bar — a window object of class [CStatusBar](../mfc/reference/cstatusbar-class.md) — contains several "panes." Each pane is a rectangular area of the status bar that you can use to display information. For example, many applications display the status of the CAPS LOCK, NUM LOCK, and other keys in the rightmost panes. Applications also often display informative text in the leftmost pane (pane 0), sometimes called the "message pane." For example, the default MFC status bar uses the message pane to display a string explaining the currently selected menu item or toolbar button. The figure in [Status Bars](../mfc/status-bar-implementation-in-mfc.md) shows a status bar from an Application Wizard-created MFC application. By default, MFC does not enable a `CStatusBar` pane when it creates the pane. To activate a pane, you must use the ON_UPDATE_COMMAND_UI macro for each pane on the status bar and update the panes. Because panes do not send WM_COMMAND messages (they aren't like toolbar buttons), you must type the code manually. diff --git a/docs/mfc/upgrading-an-existing-activex-control.md b/docs/mfc/upgrading-an-existing-activex-control.md index 47524f29315..5af223c224e 100644 --- a/docs/mfc/upgrading-an-existing-activex-control.md +++ b/docs/mfc/upgrading-an-existing-activex-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Upgrading an Existing ActiveX Control" title: "Upgrading an Existing ActiveX Control" ms.date: 11/03/2021 helpviewer_keywords: ["ActiveX controls [MFC], Internet", "LPK files for Internet controls", "safe for scripting and initialization (controls)", "OLE controls [MFC], upgrading to ActiveX", "CAB files, for ActiveX controls", "Internet applications [MFC], ActiveX controls", "Internet applications [MFC], packaging code for download", "upgrading ActiveX controls", "licensing ActiveX controls"] -ms.assetid: 4d12ddfa-b491-4f9f-a0b7-b51458e05651 ms.topic: how-to --- # Upgrading an Existing ActiveX Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Existing ActiveX controls (formerly OLE controls) can be used on the Internet without modification. However, you may want to modify controls to improve their performance. > [!IMPORTANT] @@ -48,7 +50,7 @@ CODEBASE="http://example.contoso.com/mycontrol.ocx#version=4, 1086" ``` -This solution downloads only the control's .ocx file, and requires any supporting DLLs to already be installed on the client machine. This will work for Internet Explorer and MFC ActiveX controls built with Visual C++, because Internet Explorer ships with the supporting DLLs for Visual C++ controls. If another Internet browser that is ActiveX control-capable is used to view this control, this solution will not work. +This solution downloads only the control's .ocx file, and requires any supporting DLLs to already be installed on the client machine. This will work for Internet Explorer and MFC ActiveX controls built with Visual Studio, because Internet Explorer ships with the supporting DLLs for Visual Studio controls. If another Internet browser that is ActiveX control-capable is used to view this control, this solution will not work. ### Using the CODEBASE Tag with an INF File @@ -158,7 +160,7 @@ HKEY_CLASSES_ROOT\CLSID\{06889605-B8D0-101A-91F1-00608CEAD5B3}\Implemented Categ If you want to use a licensed control on a Web page, you must verify that the license agreement allows its use on the Internet and create a license package file (LPK) for it. -A licensed ActiveX control will not load properly in an HTML page if the computer running Internet Explorer is not licensed to use the control. For example, if a licensed control was built using Visual C++, the HTML page using the control will load properly on the computer where the control was built, but it will not load on a different computer unless licensing information is included. +A licensed ActiveX control will not load properly in an HTML page if the computer running Internet Explorer is not licensed to use the control. For example, if a licensed control was built using Visual Studio, the HTML page using the control will load properly on the computer where the control was built, but it will not load on a different computer unless licensing information is included. To use a licensed ActiveX control in Internet Explorer, you must check the vendor's license agreement to verify that the license for the control permits: diff --git a/docs/mfc/user-defined-tools.md b/docs/mfc/user-defined-tools.md index 9f477181081..e29719954c4 100644 --- a/docs/mfc/user-defined-tools.md +++ b/docs/mfc/user-defined-tools.md @@ -3,10 +3,12 @@ description: "Learn more about: User-defined Tools" title: "User-defined Tools" ms.date: "11/19/2018" helpviewer_keywords: ["user-defined tools (MFC Extensions)"] -ms.assetid: cb887421-78ce-4652-bc67-96a53984ccaa --- # User-defined Tools +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC supports user-defined tools. A user-defined tool is a special command that executes an external, user-specified program. You can use the customization process to manage user-defined tools. However, you cannot use this process if your application object is not derived from [CWinAppEx Class](../mfc/reference/cwinappex-class.md). For more information about customization, see [Customization for MFC](../mfc/customization-for-mfc.md). If you enabled user-defined tools support, the customization dialog box automatically includes the **Tools** tab. The following illustration shows the **Tools** page. diff --git a/docs/mfc/user-interface-elements-mfc.md b/docs/mfc/user-interface-elements-mfc.md index a4c20c415e1..fb716052e9a 100644 --- a/docs/mfc/user-interface-elements-mfc.md +++ b/docs/mfc/user-interface-elements-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: User Interface Elements (MFC)" title: "User Interface Elements (MFC)" ms.date: "11/04/2016" helpviewer_keywords: ["MFC, user interface", "user interfaces, creating", "user interfaces"] -ms.assetid: f5daf2c1-bc08-4b71-9b03-da2c0aab5764 --- # User Interface Elements (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + For information about how to create the user interface for your application by using the Microsoft Foundation Class (MFC) Library, see the following topics. ## In This Section diff --git a/docs/mfc/user-interface-objects-and-command-ids.md b/docs/mfc/user-interface-objects-and-command-ids.md index 25183aea048..ec45364b2e3 100644 --- a/docs/mfc/user-interface-objects-and-command-ids.md +++ b/docs/mfc/user-interface-objects-and-command-ids.md @@ -3,10 +3,12 @@ description: "Learn more about: User-Interface Objects and Command IDs" title: "User-Interface Objects and Command IDs" ms.date: "11/19/2018" helpviewer_keywords: ["keyboard shortcuts, associating with IDs", "MFC, command routing", "toolbar controls [MFC], command ID", "menu items, associating with IDs", "user interface objects [MFC], associating with IDs", "command IDs, user interface objects", "command routing [MFC], MFC", "command handling [MFC], user-interface objects"] -ms.assetid: 4ea19e9b-ed1e-452e-bd33-7f509107a45b --- # User-Interface Objects and Command IDs +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Menu items, toolbar buttons, and accelerator keys are "user-interface objects" capable of generating commands. Each such user-interface object has an ID. You associate a user-interface object with a command by assigning the same ID to the object and the command. As explained in [Messages](../mfc/messages.md), commands are implemented as special messages. The figure "Commands in the Framework" below shows how the framework manages commands. When a user-interface object generates a command, such as `ID_EDIT_CLEAR_ALL`, one of the objects in your application handles the command — in the figure below, the document object's `OnEditClearAll` function is called via the document's message map. ![Commands in the Framework.](../mfc/media/vc385p1.gif "Commands in the Framework")
diff --git a/docs/mfc/using-a-common-control-as-a-child-window.md b/docs/mfc/using-a-common-control-as-a-child-window.md index a6bb23d0b33..8e0cd9bb980 100644 --- a/docs/mfc/using-a-common-control-as-a-child-window.md +++ b/docs/mfc/using-a-common-control-as-a-child-window.md @@ -3,11 +3,13 @@ description: "Learn more about: Using a Common Control as a Child Window" title: "Using a Common Control as a Child Window" ms.date: "11/04/2016" helpviewer_keywords: ["controls [MFC], using as child windows", "windows [MFC], common controls as", "child windows [MFC], common controls as", "common controls [MFC], child windows", "Windows common controls [MFC], child windows"] -ms.assetid: 608f7d47-7854-4fce-bde9-856c51e76753 ms.topic: how-to --- # Using a Common Control as a Child Window +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Any of the Windows common controls can be used as a child window of any other window. The following procedure describes how to create a common control dynamically and then work with it. ### To use a common control as a child window diff --git a/docs/mfc/using-a-dialog-bar-with-a-rebar-control.md b/docs/mfc/using-a-dialog-bar-with-a-rebar-control.md index 896a649cbc1..d96d2431b8b 100644 --- a/docs/mfc/using-a-dialog-bar-with-a-rebar-control.md +++ b/docs/mfc/using-a-dialog-bar-with-a-rebar-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Using a Dialog Bar with a Rebar Control" title: "Using a Dialog Bar with a Rebar Control" ms.date: "11/04/2016" helpviewer_keywords: ["WS_EX_TRANSPARENT style", "rebar controls [MFC], dialog bars", "dialog bars [MFC], using with rebar bands"] -ms.assetid: e528cea0-6b81-4bdf-9643-7c03b6176590 ms.topic: how-to --- # Using a Dialog Bar with a Rebar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + As mentioned in [Rebar Controls and Bands](../mfc/rebar-controls-and-bands.md), each band can contain only one child window (or control). This might be a limitation if you want to have more than one child window per band. A convenient workaround is to create a dialog bar resource with multiple controls and then add a rebar band (containing the dialog bar) to the rebar control. Normally, if you wanted the dialog bar band to appear transparent, you would set the WS_EX_TRANSPARENT extended style for the dialog bar object. However, because WS_EX_TRANSPARENT has some issues with properly painting the background of a dialog bar, you will need to do a little extra work to achieve the desired effect. diff --git a/docs/mfc/using-a-dialog-template-in-memory.md b/docs/mfc/using-a-dialog-template-in-memory.md index 2ebc1096f2c..5be7e52e6a5 100644 --- a/docs/mfc/using-a-dialog-template-in-memory.md +++ b/docs/mfc/using-a-dialog-template-in-memory.md @@ -3,11 +3,13 @@ description: "Learn more about: Using a Dialog Template in Memory" title: "Using a Dialog Template in Memory" ms.date: "11/04/2016" helpviewer_keywords: ["templates [MFC], for dialog boxes", "dialog templates [MFC]", "dialog templates [MFC], in memory", "MFC dialog boxes [MFC], dialog templates"] -ms.assetid: edb443bb-e614-4f77-8a3b-74d93871e9bd ms.topic: concept-article --- # Using a Dialog Template in Memory +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Instead of using the methods given in the [Dialog Creation table](../mfc/creating-a-dialog-class-with-code-wizards.md), you can create either kind of dialog box indirectly from a dialog template in memory. For more information, see class [CDialog](../mfc/reference/cdialog-class.md) in the *MFC Reference*. ## See also diff --git a/docs/mfc/using-a-hot-key-control.md b/docs/mfc/using-a-hot-key-control.md index ca29fb0d076..2ecb69d51f2 100644 --- a/docs/mfc/using-a-hot-key-control.md +++ b/docs/mfc/using-a-hot-key-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Using a Hot Key Control" title: "Using a Hot Key Control" ms.date: "11/04/2016" helpviewer_keywords: ["CHotKeyCtrl class [MFC], using", "hot key controls"] -ms.assetid: cdd6524b-cc43-447f-b151-164273559685 ms.topic: concept-article --- # Using a Hot Key Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Typical usage of a hot key control follows the pattern below: - The control is created. If the control is specified in a dialog box template, creation is automatic when the dialog box is created. (You should have a [CHotKeyCtrl](../mfc/reference/chotkeyctrl-class.md) member in your dialog class that corresponds to the hot key control.) Alternatively, you can use the [Create](../mfc/reference/chotkeyctrl-class.md#create) member function to create the control as a child window of any window. diff --git a/docs/mfc/using-an-animation-control.md b/docs/mfc/using-an-animation-control.md index ceff13db018..39919ad405b 100644 --- a/docs/mfc/using-an-animation-control.md +++ b/docs/mfc/using-an-animation-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Using an Animation Control" title: "Using an Animation Control" ms.date: "11/04/2016" helpviewer_keywords: ["controls [MFC], animation", "CAnimateCtrl class [MFC], animation controls", "animation controls [MFC]"] -ms.assetid: a009a464-e12d-4112-bf52-04a09b28dd88 ms.topic: concept-article --- # Using an Animation Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Typical usage of an animation control follows the pattern below: - The control is created. If the control is specified in a dialog box template, creation is automatic when the dialog box is created. (You should have a [CAnimateCtrl](../mfc/reference/canimatectrl-class.md) member in your dialog class that corresponds to the animation control.) Alternatively, you can use the [Create](../mfc/reference/canimatectrl-class.md#create) member function to create the control as a child window of any window. diff --git a/docs/mfc/using-an-image-list-with-a-rebar-control.md b/docs/mfc/using-an-image-list-with-a-rebar-control.md index 4384b1557b7..9e60de4bb38 100644 --- a/docs/mfc/using-an-image-list-with-a-rebar-control.md +++ b/docs/mfc/using-an-image-list-with-a-rebar-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Using an Image List with a Rebar Control" title: "Using an Image List with a Rebar Control" ms.date: "11/04/2016" helpviewer_keywords: ["image lists [MFC], rebar controls", "rebar controls [MFC], image lists"] -ms.assetid: 1a5836ac-019a-46aa-8741-b35c3376b839 ms.topic: how-to --- # Using an Image List with a Rebar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Each rebar band can contain, among other things, an image from an associated image list. The following procedure details the necessary steps for displaying an image in a rebar band. ### To display images in a rebar band diff --git a/docs/mfc/using-an-image-list.md b/docs/mfc/using-an-image-list.md index 7016e9dd277..5eac2d45cf2 100644 --- a/docs/mfc/using-an-image-list.md +++ b/docs/mfc/using-an-image-list.md @@ -3,11 +3,13 @@ description: "Learn more about: Using an Image List" title: "Using an Image List" ms.date: "11/04/2016" helpviewer_keywords: ["lists [MFC], image", "CImageList class [MFC], using", "image lists [MFC]"] -ms.assetid: e0aed188-a1e6-400e-9f51-033d61c5541f ms.topic: concept-article --- # Using an Image List +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Typical usage of an image list follows the pattern below: - Construct a [CImageList](../mfc/reference/cimagelist-class.md) object and call one of the overloads of its [Create](../mfc/reference/cimagelist-class.md#create) function to create an image list and attach it to the `CImageList` object. diff --git a/docs/mfc/using-an-unclipped-device-context.md b/docs/mfc/using-an-unclipped-device-context.md index 35bd4e6fa10..6e2d218703e 100644 --- a/docs/mfc/using-an-unclipped-device-context.md +++ b/docs/mfc/using-an-unclipped-device-context.md @@ -3,11 +3,13 @@ description: "Learn more about: Using an Unclipped Device Context" title: "Using an Unclipped Device Context" ms.date: "11/04/2016" helpviewer_keywords: ["MFC ActiveX controls [MFC], unclipped device context"] -ms.assetid: 9c020063-73da-4803-bf7b-2e1fd950c9ed ms.topic: concept-article --- # Using an Unclipped Device Context +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + If you are absolutely certain that your control does not paint outside its client rectangle, you can realize a small but detectable speed gain by disabling the call to `IntersectClipRect` that is made by `COleControl`. To do this, remove the *clipPaintDC* flag from the set of flags returned by [COleControl::GetControlFlags](../mfc/reference/colecontrol-class.md#getcontrolflags). For example: [!code-cpp[NVC_MFC_AxOpt#5](../mfc/codesnippet/cpp/using-an-unclipped-device-context_1.cpp)] diff --git a/docs/mfc/using-callback-fields-in-a-date-and-time-picker-control.md b/docs/mfc/using-callback-fields-in-a-date-and-time-picker-control.md index 34e4486769c..bc01e6ebe10 100644 --- a/docs/mfc/using-callback-fields-in-a-date-and-time-picker-control.md +++ b/docs/mfc/using-callback-fields-in-a-date-and-time-picker-control.md @@ -4,11 +4,13 @@ title: "Using Callback Fields in a Date and Time Picker Control" ms.date: "11/04/2016" f1_keywords: ["DTN_FORMATQUERY", "DTN_FORMAT"] helpviewer_keywords: ["DateTimePicker control [MFC], callback fields", "callback fields in CDateTimeCtrl class [MFC]", "CDateTimeCtrl class [MFC], callback fields", "CDateTimeCtrl class [MFC], handling DTN_FORMAT and DTN_FORMATQ", "DTN_FORMATQUERY notification [MFC]", "DTN_FORMAT notification [MFC]", "DateTimePicker control [MFC]"] -ms.assetid: 404f4ba9-cba7-4718-9faa-bc6b274a723f ms.topic: concept-article --- # Using Callback Fields in a Date and Time Picker Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In addition to the standard format characters that define date and time picker fields, you can customize your output by specifying certain parts of a custom format string as callback fields. To declare a callback field, include one or more "X" characters (ASCII Code 88) anywhere in the body of the format string. For example, the following string "'Today is: 'yy'/'MM'/'dd' (Day 'X')'"causes the date and time picker control to display the current value as the year followed by the month, date, and finally the day of the year. > [!NOTE] diff --git a/docs/mfc/using-canimatectrl.md b/docs/mfc/using-canimatectrl.md index 76302558736..f22e7a7519b 100644 --- a/docs/mfc/using-canimatectrl.md +++ b/docs/mfc/using-canimatectrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CAnimateCtrl" title: "Using CAnimateCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["animation controls [MFC], CAnimateCtrl class", "controls [MFC], animation", "CAnimateCtrl class [MFC], about CAnimateCtrl class [MFC]"] -ms.assetid: 696c0805-bef0-4e2e-a9e7-b37b9215b7f0 ms.topic: concept-article --- # Using CAnimateCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An animation control, represented by the class [CAnimateCtrl](../mfc/reference/canimatectrl-class.md), is a window that displays a clip in Audio Video Interleaved (AVI) format — the standard Windows video/audio format. An AVI clip is a series of bitmap frames, like a movie. Since your thread continues executing while the AVI clip is displayed, one common use for an animation control is to indicate system activity during a lengthy operation. For example, the Windows Find dialog box displays a moving magnifying glass as the system searches for a file. diff --git a/docs/mfc/using-ccomboboxex.md b/docs/mfc/using-ccomboboxex.md index a9c9fca4d11..bed47613510 100644 --- a/docs/mfc/using-ccomboboxex.md +++ b/docs/mfc/using-ccomboboxex.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CComboBoxEx" title: "Using CComboBoxEx" ms.date: "11/04/2016" helpviewer_keywords: ["combo boxes [MFC], extended", "extended combo boxes [MFC], about extended combo boxes", "combo boxes [MFC], CComboBoxEx class", "CComboBox class [MFC], extended"] -ms.assetid: c23cbfe8-75d2-4f98-a753-c942416eda52 ms.topic: concept-article --- # Using CComboBoxEx +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The extended combo box control is an extension of the standard combo box control that provides native support for item images. These images can be used to indicate the status of individual items in the combo box, such as the currently selected and unselected items. To make item images easily accessible, the control provides image list support. Use this control to provide the functionality of a combo box without having to manually draw item graphics. diff --git a/docs/mfc/using-cdatetimectrl.md b/docs/mfc/using-cdatetimectrl.md index 2a67477916f..de67e342135 100644 --- a/docs/mfc/using-cdatetimectrl.md +++ b/docs/mfc/using-cdatetimectrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CDateTimeCtrl" title: "Using CDateTimeCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["DateTimePicker control [MFC], CDateTimeCtrl class"] -ms.assetid: cb2a8720-43f1-4c33-a3a4-def9a1622e00 ms.topic: concept-article --- # Using CDateTimeCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The date and time picker control ([CDateTimeCtrl](../mfc/reference/cdatetimectrl-class.md)) implements an intuitive and recognizable method of entering or selecting a specific date. The main interface of the control is similar in functionality to a combo box. However, if the user expands the control, a month calendar control appears (by default), allowing the user to specify a particular date. When a date is chosen, the month calendar control automatically disappears. > [!NOTE] diff --git a/docs/mfc/using-cheaderctrl.md b/docs/mfc/using-cheaderctrl.md index acc495d5aa1..f2b2ef3eb29 100644 --- a/docs/mfc/using-cheaderctrl.md +++ b/docs/mfc/using-cheaderctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CHeaderCtrl" title: "Using CHeaderCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["header controls [MFC], using", "CHeaderCtrl class [MFC]"] -ms.assetid: fb3e512b-9539-43c4-a7e7-3fafd6d0706e ms.topic: concept-article --- # Using CHeaderCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use a header control, represented by class [CHeaderCtrl](../mfc/reference/cheaderctrl-class.md), to display column headers for a columnar list. For example, a header control would be useful for implementing column controls in a spreadsheet. The header control is usually divided into parts, called "header items," each bearing a title for the associated column of text or numbers. Depending on the styles you set, you can provide a number of direct ways for users to manipulate the header items. diff --git a/docs/mfc/using-chotkeyctrl.md b/docs/mfc/using-chotkeyctrl.md index 2d7022a2830..f3f757de784 100644 --- a/docs/mfc/using-chotkeyctrl.md +++ b/docs/mfc/using-chotkeyctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CHotKeyCtrl" title: "Using CHotKeyCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["keys, hot and CHotKeyCtrl", "CHotKeyCtrl class [MFC], using", "hot key controls"] -ms.assetid: 9b207117-d848-4224-8888-c3d197bb0c95 ms.topic: concept-article --- # Using CHotKeyCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A hot key control, represented by class [CHotKeyCtrl](../mfc/reference/chotkeyctrl-class.md), is a window that displays a text representation of the key combination the user types into it, such as CTRL+SHIFT+Q. It also maintains an internal representation of this key in the form of a virtual key code and a set of flags that represent the shift state. The hot key control does not actually set the hot key — doing that is up to your program. (For a list of standard virtual key codes, see Winuser.h.) Use a hot key control to get a user's input for which hot key to associate with a window or thread. Hot key controls are often used in dialog boxes, such as you might display when asking the user to assign a hot key. It is your program's responsibility to retrieve the values describing the hot key from the hot key control and to call the appropriate functions to associate the hot key with a window or thread. diff --git a/docs/mfc/using-cimagelist.md b/docs/mfc/using-cimagelist.md index 64daaad06c3..e9042469157 100644 --- a/docs/mfc/using-cimagelist.md +++ b/docs/mfc/using-cimagelist.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CImageList" title: "Using CImageList" ms.date: "11/04/2016" helpviewer_keywords: ["image list control", "CImageList class [MFC], using"] -ms.assetid: 3d2a909e-d641-46b7-aada-81cab1a29b41 ms.topic: concept-article --- # Using CImageList +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An image list, represented by class [CImageList](../mfc/reference/cimagelist-class.md), is a collection of same-sized images, each of which can be referred to by its index. Image lists are used to efficiently manage large sets of icons or bitmaps. Image lists are not themselves controls since they are not windows; however, they are used with several different types of controls, including list controls ([CListCtrl](../mfc/reference/clistctrl-class.md)), tree controls ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)), and tab controls ([CTabCtrl](../mfc/reference/ctabctrl-class.md)). All images in an image list are contained in a single, wide bitmap in screen-device format. An image list may also include a monochrome bitmap that contains masks used to draw images transparently (icon style). `CImageList` provides member functions that enable you to draw images, create and destroy image lists, add and remove images, replace images, merge images, and drag images. diff --git a/docs/mfc/using-clistctrl.md b/docs/mfc/using-clistctrl.md index 9381c761991..afb3b2c7928 100644 --- a/docs/mfc/using-clistctrl.md +++ b/docs/mfc/using-clistctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CListCtrl" title: "Using CListCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["CListCtrl class [MFC], using"] -ms.assetid: 20d6a5d6-8f07-4ddf-975f-ea2dfebcc835 ms.topic: concept-article --- # Using CListCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Use a list control to display any arrangement of icons with labels, as in File Explorer, or columnar lists of text, with or without icons. For a description of the four possible "views" (not to be confused with MFC views) you can have in a list control — icon view, small icon view, list view, and report view — see Views in the [CListCtrl](../mfc/reference/clistctrl-class.md) class overview. In some views, users can drag icons to different positions or edit icon labels. For example, see the right-hand pane in File Explorer, which uses a list control in a nondialog window. You can experiment with the available views in Explorer's View menu. diff --git a/docs/mfc/using-cmonthcalctrl.md b/docs/mfc/using-cmonthcalctrl.md index 270c33595c5..b61d0562f7e 100644 --- a/docs/mfc/using-cmonthcalctrl.md +++ b/docs/mfc/using-cmonthcalctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CMonthCalCtrl" title: "Using CMonthCalCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["CMonthCalCtrl class [MFC], about CMonthCalCtrl class"] -ms.assetid: 2be0e8c2-ed03-4853-aea1-4461eba18611 ms.topic: concept-article --- # Using CMonthCalCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The month calendar control ([CMonthCalCtrl](../mfc/reference/cmonthcalctrl-class.md)) implements a calendar-like user interface. This provides the user with a very intuitive and recognizable method of entering or selecting a date. The control also provides the application with the means to obtain and set the date information in the control using existing data types. By default, the month calendar control displays the current day and month. However, the user is able to scroll to the previous and next months and select a specific month and/or year. > [!NOTE] diff --git a/docs/mfc/using-cobject.md b/docs/mfc/using-cobject.md index a528b36ec18..0b1071f2035 100644 --- a/docs/mfc/using-cobject.md +++ b/docs/mfc/using-cobject.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CObject" title: "Using CObject" ms.date: "11/04/2016" helpviewer_keywords: ["examples [MFC], CObject", "root base class for MFC", "derived classes [MFC], from CObject", "MFC, base class", "CObject class [MFC]"] -ms.assetid: d0cd19bb-2856-4b41-abbc-620fd64cb223 ms.topic: concept-article --- # Using CObject +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + [CObject](../mfc/reference/cobject-class.md) is the root base class for most of the Microsoft Foundation Class Library (MFC). The `CObject` class contains many useful features that you may want to incorporate into your own program objects, including serialization support, run-time class information, and object diagnostic output. If you derive your class from `CObject`, your class can exploit these `CObject` features. ## What do you want to do diff --git a/docs/mfc/using-common-controls-in-a-dialog-box.md b/docs/mfc/using-common-controls-in-a-dialog-box.md index d28c82e7536..e4d84c57642 100644 --- a/docs/mfc/using-common-controls-in-a-dialog-box.md +++ b/docs/mfc/using-common-controls-in-a-dialog-box.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Common Controls in a Dialog Box" title: "Using Common Controls in a Dialog Box" ms.date: "11/04/2016" helpviewer_keywords: ["common controls [MFC], in dialog boxes", "dialog box controls [MFC], common controls", "Windows common controls [MFC], in dialog boxes"] -ms.assetid: 17713caf-09f8-484a-bf54-5f48bf09cce9 ms.topic: how-to --- # Using Common Controls in a Dialog Box +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Windows common controls can be used in [dialog boxes](../mfc/dialog-boxes.md), form views, record views, and any other window based on a dialog template. The following procedure, with minor changes, will work for forms as well. ## Procedures diff --git a/docs/mfc/using-cprogressctrl.md b/docs/mfc/using-cprogressctrl.md index 07121a9f076..db9747fac63 100644 --- a/docs/mfc/using-cprogressctrl.md +++ b/docs/mfc/using-cprogressctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CProgressCtrl" title: "Using CProgressCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["progress controls [MFC]", "CProgressCtrl class [MFC], using", "progress controls [MFC], CProgressCtrl", "progress controls [MFC], using"] -ms.assetid: 61473270-196b-41ab-bf2b-467f46673539 ms.topic: concept-article --- # Using CProgressCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can use the progress control to indicate the progress of a lengthy operation. It is a rectangle that is gradually filled with the system highlight color as the operation progresses. The progress control is represented in MFC by class [CProgressCtrl](../mfc/reference/cprogressctrl-class.md). diff --git a/docs/mfc/using-crebarctrl.md b/docs/mfc/using-crebarctrl.md index ce1e299588f..4100cc50206 100644 --- a/docs/mfc/using-crebarctrl.md +++ b/docs/mfc/using-crebarctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CReBarCtrl" title: "Using CReBarCtrl" ms.date: "11/19/2018" helpviewer_keywords: ["child windows [MFC], rebar controls", "combo boxes [MFC], in rebar controls", "rebar controls"] -ms.assetid: 2c0aeec2-ffc3-44b8-97b5-0f56e116a338 ms.topic: concept-article --- # Using CReBarCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A rebar control acts as a container for child windows. These child windows, often other controls, are assigned to a rebar control band. A rebar control can contain one or more bands, with each band having any combination of a gripper bar, a bitmap, a text label, and a child window. However, bands cannot contain more than one child window. The following illustration shows a rebar control that has two bands. One contains a gripper bar, a text label ("Address"), and a combo box child window. The other band contains a gripper bar, a text label, and a flat toolbar (implemented with a child window). diff --git a/docs/mfc/using-cricheditctrl.md b/docs/mfc/using-cricheditctrl.md index 1d96ea63105..e53c1400f84 100644 --- a/docs/mfc/using-cricheditctrl.md +++ b/docs/mfc/using-cricheditctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CRichEditCtrl" title: "Using CRichEditCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["rich edit controls [MFC], using", "CRichEditCtrl class [MFC], using"] -ms.assetid: e400c6ed-563e-4d4c-ab3b-a3f0aa20273b ms.topic: concept-article --- # Using CRichEditCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A rich edit control is a window in which the user can enter and edit text. The text can be assigned character and paragraph formatting, and can include embedded OLE objects. The rich edit control is represented in MFC by the [CRichEditCtrl](../mfc/reference/cricheditctrl-class.md) class. ## What do you want to know more about diff --git a/docs/mfc/using-csliderctrl.md b/docs/mfc/using-csliderctrl.md index f4b91032146..0bcaefe6cb7 100644 --- a/docs/mfc/using-csliderctrl.md +++ b/docs/mfc/using-csliderctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CSliderCtrl" title: "Using CSliderCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["CSliderCtrl class [MFC], using", "slider controls [MFC], using"] -ms.assetid: 242c7bcd-126e-4b9b-8f76-8082ad06fe73 ms.topic: concept-article --- # Using CSliderCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [CSliderCtrl](../mfc/reference/csliderctrl-class.md) class represents a slider control, which is also called a trackbar. A "slider control" is a window that contains a slider and optional tick marks. When the user moves the slider, using either the mouse or the arrow keys, the slider control sends notification messages to indicate the change. Slider controls are useful when you want the user to select a discrete value or a set of consecutive values in a range. For example, you might use a slider control to allow the user to set the repeat rate of the keyboard by moving the slider to a given tick mark. diff --git a/docs/mfc/using-cspinbuttonctrl.md b/docs/mfc/using-cspinbuttonctrl.md index 9a28599d04b..a34cbab66da 100644 --- a/docs/mfc/using-cspinbuttonctrl.md +++ b/docs/mfc/using-cspinbuttonctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CSpinButtonCtrl" title: "Using CSpinButtonCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["up-down controls [MFC], spin button control", "up-down controls", "spin button control", "CSpinButtonCtrl class [MFC], using"] -ms.assetid: a91db36b-e11e-42ef-8e89-51915cc486d2 ms.topic: concept-article --- # Using CSpinButtonCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The *spin button* control (also known as an *up-down* control) provides a pair of arrows that a user can click to adjust a value. This value is known as the *current position*. The position stays within the range of the spin button. When the user clicks the up arrow, the position moves toward the maximum; and when the user clicks the down arrow, the position moves toward the minimum. The spin button control is represented in MFC by the [CSpinButtonCtrl](../mfc/reference/cspinbuttonctrl-class.md) class. diff --git a/docs/mfc/using-cstatusbarctrl-to-create-a-cstatusbarctrl-object.md b/docs/mfc/using-cstatusbarctrl-to-create-a-cstatusbarctrl-object.md index daf703d6076..e1a227e63c5 100644 --- a/docs/mfc/using-cstatusbarctrl-to-create-a-cstatusbarctrl-object.md +++ b/docs/mfc/using-cstatusbarctrl-to-create-a-cstatusbarctrl-object.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CStatusBarCtrl to Create a CStatusBarCtrl title: "Using CStatusBarCtrl to Create a CStatusBarCtrl Object" ms.date: "11/04/2016" helpviewer_keywords: ["status bar controls [MFC], creating", "CStatusBarCtrl class [MFC], creating"] -ms.assetid: 365c2b65-12de-49e6-9a2e-416c6ee10d60 ms.topic: how-to --- # Using CStatusBarCtrl to Create a CStatusBarCtrl Object +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Here is an example of a typical use of [CStatusBarCtrl](../mfc/reference/cstatusbarctrl-class.md): ### To use a status bar control with parts diff --git a/docs/mfc/using-cstatusbarctrl.md b/docs/mfc/using-cstatusbarctrl.md index 9cb57d6094d..3f547a0312b 100644 --- a/docs/mfc/using-cstatusbarctrl.md +++ b/docs/mfc/using-cstatusbarctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CStatusBarCtrl" title: "Using CStatusBarCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["CStatusBarCtrl class [MFC], using", "status bar controls [MFC], about status bar controls"] -ms.assetid: 08b39f83-580d-439a-b93e-7ef9e2a5702a ms.topic: concept-article --- # Using CStatusBarCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can use the status bar control ([CStatusBarCtrl](../mfc/reference/cstatusbarctrl-class.md)) to create a control window that reflects various kinds of status information about the application. The status window can be divided into parts that display more than one type of information. ## What do you want to know more about diff --git a/docs/mfc/using-ctabctrl.md b/docs/mfc/using-ctabctrl.md index 6d93b0163f0..ce3200242ed 100644 --- a/docs/mfc/using-ctabctrl.md +++ b/docs/mfc/using-ctabctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CTabCtrl" title: "Using CTabCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["CTabCtrl class [MFC], using", "tab controls [MFC], using"] -ms.assetid: 6bda6798-0085-4c09-a5ea-fe0e97af5c95 ms.topic: concept-article --- # Using CTabCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A "tab control" is analogous to the dividers in a notebook or the labeled folders in a file cabinet. Use the tab control, represented by class [CTabCtrl](../mfc/reference/ctabctrl-class.md), to show multiple pages of information or controls to a user, one at a time, in a format that suggests a peer or logical relationship between each page. For more information on tab controls, see [Tab Controls](/windows/win32/Controls/tab-controls) in the Windows SDK. diff --git a/docs/mfc/using-ctoolbarctrl.md b/docs/mfc/using-ctoolbarctrl.md index 51e7fb244bb..0322ea45f27 100644 --- a/docs/mfc/using-ctoolbarctrl.md +++ b/docs/mfc/using-ctoolbarctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CToolBarCtrl" title: "Using CToolBarCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["CToolBarCtrl class [MFC]", "toolbar controls [MFC], creating"] -ms.assetid: 13cf3753-135b-4a3e-a850-ed30177fcf9d ms.topic: concept-article --- # Using CToolBarCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can use the toolbar control ([CToolBarCtrl](../mfc/reference/ctoolbarctrl-class.md)) to create a control window containing buttons and optional spaces. Each button in the toolbar control window sends a command message to the parent window as the user chooses it. Typically, the buttons in a toolbar correspond to items in the application's menu, providing an additional and more direct way for the user to access an application's commands. ## What do you want to know more about diff --git a/docs/mfc/using-ctooltipctrl-to-create-and-manipulate-a-ctooltipctrl-object.md b/docs/mfc/using-ctooltipctrl-to-create-and-manipulate-a-ctooltipctrl-object.md index 8bb04ae8078..8dc58397f7d 100644 --- a/docs/mfc/using-ctooltipctrl-to-create-and-manipulate-a-ctooltipctrl-object.md +++ b/docs/mfc/using-ctooltipctrl-to-create-and-manipulate-a-ctooltipctrl-object.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CToolTipCtrl to Create and Manipulate a CT title: "Using CToolTipCtrl to Create and Manipulate a CToolTipCtrl Object" ms.date: "11/04/2016" helpviewer_keywords: ["tool tips [MFC], creating", "CToolTipCtrl class [MFC], using"] -ms.assetid: 0a34583f-f66d-46a1-a239-31b80ea395ad ms.topic: how-to --- # Using CToolTipCtrl to Create and Manipulate a CToolTipCtrl Object +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Here is an example of [CToolTipCtrl](../mfc/reference/ctooltipctrl-class.md) usage: ### To create and manipulate a CToolTipCtrl diff --git a/docs/mfc/using-ctooltipctrl.md b/docs/mfc/using-ctooltipctrl.md index 88c9dd0e09b..bacc499c4bd 100644 --- a/docs/mfc/using-ctooltipctrl.md +++ b/docs/mfc/using-ctooltipctrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CToolTipCtrl" title: "Using CToolTipCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["CToolTipCtrl class [MFC], creating tool tips", "CToolTipCtrl class"] -ms.assetid: 8fc58a04-4792-4223-a092-d349d11344da ms.topic: concept-article --- # Using CToolTipCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The [CToolTipCtrl](../mfc/reference/ctooltipctrl-class.md) class encapsulates the functionality of a tool tip control, a small pop-up window that displays a single line of text describing the purpose of a tool in an application. A tool tip is hidden most of the time, appearing only when the user puts the cursor on a tool and leaves it there for approximately one-half second. The tool tip appears near the cursor and disappears when the user clicks a mouse button or moves the cursor off of the tool. ## What do you want to know more about diff --git a/docs/mfc/using-ctreectrl.md b/docs/mfc/using-ctreectrl.md index 18651d78c16..8d379b429ba 100644 --- a/docs/mfc/using-ctreectrl.md +++ b/docs/mfc/using-ctreectrl.md @@ -3,11 +3,13 @@ description: "Learn more about: Using CTreeCtrl" title: "Using CTreeCtrl" ms.date: "11/04/2016" helpviewer_keywords: ["CTreeCtrl class [MFC], about CTreeCtrl", "tree controls [MFC], using"] -ms.assetid: 6a262f2c-3540-43e5-b03f-e4b6f9cb0325 ms.topic: concept-article --- # Using CTreeCtrl +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A tree control, represented by the class [CTreeCtrl](../mfc/reference/ctreectrl-class.md), is a window that displays a hierarchical list of items, such as the headings in a document, the entries in an index, or the files and directories on a disk. Each item consists of a label and an optional bitmapped image, and each item can have a list of subitems associated with it. By clicking an item, the user can expand and collapse the associated list of subitems. The directory tree in the left-hand pane of File Explorer is an example of a tree control. ## What do you want to know more about diff --git a/docs/mfc/using-custom-format-strings-in-a-date-and-time-picker-control.md b/docs/mfc/using-custom-format-strings-in-a-date-and-time-picker-control.md index 0137fffce30..1c22a9078aa 100644 --- a/docs/mfc/using-custom-format-strings-in-a-date-and-time-picker-control.md +++ b/docs/mfc/using-custom-format-strings-in-a-date-and-time-picker-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Custom Format Strings in a Date and Time P title: "Using Custom Format Strings in a Date and Time Picker Control" ms.date: "11/04/2016" helpviewer_keywords: ["CDateTimeCtrl class [MFC], display styles", "DateTimePicker control [MFC], display styles", "DateTimePicker control [MFC]"] -ms.assetid: 7d577f03-6ca0-4597-9093-50b78f304719 ms.topic: concept-article --- # Using Custom Format Strings in a Date and Time Picker Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + By default, date and time picker controls provide three format types (each format corresponding to a unique style) for displaying the current date or time: - **DTS_LONGDATEFORMAT** Displays the date in long format, producing output like "Wednesday, January 3, 2000". diff --git a/docs/mfc/using-documents.md b/docs/mfc/using-documents.md index 73f97283a24..f975b3b9f94 100644 --- a/docs/mfc/using-documents.md +++ b/docs/mfc/using-documents.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Documents" title: "Using Documents" ms.date: "11/04/2016" helpviewer_keywords: ["documents [MFC], C++ applications", "data [MFC], reading", "documents [MFC]", "files [MFC], writing to", "data [MFC], documents", "files [MFC]", "views [MFC], C++ applications", "document/view architecture [MFC], documents", "reading data [MFC], documents and views", "printing [MFC], documents", "writing to files [MFC]"] -ms.assetid: f390d6d8-d0e1-4497-9b6a-435f7ce0776c ms.topic: concept-article --- # Using Documents +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Working together, documents and views: - Contain, manage, and display your application-specific [data](../mfc/managing-data-with-document-data-variables.md). diff --git a/docs/mfc/using-drop-down-buttons-in-a-toolbar-control.md b/docs/mfc/using-drop-down-buttons-in-a-toolbar-control.md index 86403dd5c23..10ebb0f4aa4 100644 --- a/docs/mfc/using-drop-down-buttons-in-a-toolbar-control.md +++ b/docs/mfc/using-drop-down-buttons-in-a-toolbar-control.md @@ -4,11 +4,13 @@ title: "Using Drop-Down Buttons in a Toolbar Control" ms.date: "11/04/2016" f1_keywords: ["TBN_DROPDOWN", "TBSTYLE_EX_DRAWDDARROWS"] helpviewer_keywords: ["CToolBarCtrl class [MFC], drop-down buttons", "toolbars [MFC], drop-down buttons", "drop-down buttons in toolbars", "TBSTYLE_EX_DRAWDDARROWS", "TBN_DROPDOWN notification [MFC]"] -ms.assetid: b859f758-d2f6-40d9-9c26-0ff61993b9b2 ms.topic: how-to --- # Using Drop-Down Buttons in a Toolbar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In addition to standard push buttons, a toolbar can also have drop-down buttons. A drop-down button is usually indicated by the presence of an attached down arrow. > [!NOTE] diff --git a/docs/mfc/using-frame-windows.md b/docs/mfc/using-frame-windows.md index 39440816e66..dc593d3783f 100644 --- a/docs/mfc/using-frame-windows.md +++ b/docs/mfc/using-frame-windows.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Frame Windows" title: "Using Frame Windows" ms.date: "11/04/2016" helpviewer_keywords: ["windows [MFC], frame windows", "frame windows [MFC], using", "MFC, frame windows"] -ms.assetid: 4d773238-11f6-4ccf-8114-57310c5aaa2d ms.topic: concept-article --- # Using Frame Windows +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The MFC framework creates document frame windows — and their views and documents — as part of its implementation of the New and Open commands on the File menu. Because the framework does most of the frame-window work for you, you play only a small role in creating, using, and destroying those windows. You can, however, explicitly create your own frame windows and child windows for special purposes. ## What do you want to know more about diff --git a/docs/mfc/using-image-lists-in-a-toolbar-control.md b/docs/mfc/using-image-lists-in-a-toolbar-control.md index 5b280fa57e3..c8dd09a333f 100644 --- a/docs/mfc/using-image-lists-in-a-toolbar-control.md +++ b/docs/mfc/using-image-lists-in-a-toolbar-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Image Lists in a Toolbar Control" title: "Using Image Lists in a Toolbar Control" ms.date: "11/04/2016" helpviewer_keywords: ["toolbar controls [MFC], image", "image lists [MFC], toolbar controls", "CToolBarCtrl class [MFC], image lists"] -ms.assetid: ccbe8df4-4ed9-4b54-bb93-9a1dcb3b97eb ms.topic: concept-article --- # Using Image Lists in a Toolbar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + By default, the images used by the buttons in a toolbar control are stored as a single bitmap. However, you can also store button images in a set of image lists. The toolbar control object can use up to three separate image lists: - Enabled image list Contains images for toolbar buttons that are currently enabled. diff --git a/docs/mfc/using-image-lists-in-an-extended-combo-box-control.md b/docs/mfc/using-image-lists-in-an-extended-combo-box-control.md index 4060970825c..4c3c8a928e5 100644 --- a/docs/mfc/using-image-lists-in-an-extended-combo-box-control.md +++ b/docs/mfc/using-image-lists-in-an-extended-combo-box-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Image Lists in an Extended Combo Box Contr title: "Using Image Lists in an Extended Combo Box Control" ms.date: "11/04/2016" helpviewer_keywords: ["image lists [MFC], combo boxes", "extended combo boxes [MFC], images", "images [MFC], combo box items"] -ms.assetid: dfff25fe-af70-47a2-8032-3901d1e6842d ms.topic: how-to --- # Using Image Lists in an Extended Combo Box Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The main feature of extended combo box controls is the ability to associate images from an image list with individual items in a combo box control. Each item is able to display three different images: one for its selected state, one for its nonselected state, and a third for an overlay image. The following procedure associates an image list with an extended combo box control: diff --git a/docs/mfc/using-image-lists-with-header-controls.md b/docs/mfc/using-image-lists-with-header-controls.md index 830297f5a5f..76ea9410dc0 100644 --- a/docs/mfc/using-image-lists-with-header-controls.md +++ b/docs/mfc/using-image-lists-with-header-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Image Lists with Header Controls" title: "Using Image Lists with Header Controls" ms.date: "11/04/2016" helpviewer_keywords: ["header controls [MFC], image lists", "CHeaderCtrl class [MFC], image lists", "image lists [MFC], header controls"] -ms.assetid: d5e9b310-6278-406c-909c-eefa09549a47 ms.topic: how-to --- # Using Image Lists with Header Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Header items have the ability to display an image within a header item. This image, stored in an associated image list, is 16 x 16 pixels and has the same characteristics as the icon images used in a list view control. In order to implement this behavior successfully, you must first create and initialize the image list, associate the list with the header control, and then modify the attributes of the header item that will display the image. The following procedure illustrates the details, using a pointer to a header control (`m_pHdrCtrl`) and a pointer to an image list (`m_pHdrImages`). diff --git a/docs/mfc/using-property-sheets-in-your-application.md b/docs/mfc/using-property-sheets-in-your-application.md index e3dc0d6e6b8..dd89bad3850 100644 --- a/docs/mfc/using-property-sheets-in-your-application.md +++ b/docs/mfc/using-property-sheets-in-your-application.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Property Sheets in Your Application" title: "Using Property Sheets in Your Application" ms.date: "11/04/2016" helpviewer_keywords: ["dialog templates [MFC], property sheets", "dialog resources", "property pages [MFC], property sheets", "DoModal method property sheets", "AddPage method [MFC]", "property sheets, about property sheets", "Create method [MFC], property sheets", "CPropertyPage class [MFC], styles"] -ms.assetid: 240654d4-152b-4e3f-af7b-44234339206e ms.topic: how-to --- # Using Property Sheets in Your Application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To use a property sheet in your application, complete the following steps: 1. Create a dialog template resource for each property page. Keep in mind that the user may be switching from one page to another, so lay out each page as consistently as possible. diff --git a/docs/mfc/using-slider-controls.md b/docs/mfc/using-slider-controls.md index 2c970e4c5b0..52555ecbd5d 100644 --- a/docs/mfc/using-slider-controls.md +++ b/docs/mfc/using-slider-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Slider Controls" title: "Using Slider Controls" ms.date: "11/04/2016" helpviewer_keywords: ["CSliderCtrl class [MFC], using", "slider controls", "slider controls [MFC], using"] -ms.assetid: 2b1a8ac8-2b17-41e1-aa24-83c1fd737049 ms.topic: concept-article --- # Using Slider Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Typical usage of an slider control follows the pattern below: - The control is created. If the control is specified in a dialog box template, creation is automatic when the dialog box is created. (You should have a [CSliderCtrl](../mfc/reference/csliderctrl-class.md) member in your dialog class that corresponds to the slider control.) Alternatively, you can use the [Create](../mfc/reference/csliderctrl-class.md#create) member function to create the control as a child window of any window. diff --git a/docs/mfc/using-the-carchive-output-and-input-operators.md b/docs/mfc/using-the-carchive-output-and-input-operators.md index 533547cef5d..1f57ddc404c 100644 --- a/docs/mfc/using-the-carchive-output-and-input-operators.md +++ b/docs/mfc/using-the-carchive-output-and-input-operators.md @@ -3,11 +3,13 @@ description: "Learn more about: Using the CArchive << and >> Operators" title: "Using the CArchive << and >> Operators" ms.date: "11/04/2016" helpviewer_keywords: ["objects [MFC], loading from previously stored values", "CArchive class [MFC], storing and loading objects", "CArchive class [MFC], operators"] -ms.assetid: 56aef326-02dc-4992-8282-f0a4b78a064e ms.topic: how-to --- # Using the CArchive `<<` and `>>` Operators +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + `CArchive` provides <\< and >> operators for writing and reading simple data types as well as `CObject`s to and from a file. #### To store an object in a file via an archive diff --git a/docs/mfc/using-the-classes-to-write-applications-for-windows.md b/docs/mfc/using-the-classes-to-write-applications-for-windows.md index bba61db9ffc..27b9d14cf40 100644 --- a/docs/mfc/using-the-classes-to-write-applications-for-windows.md +++ b/docs/mfc/using-the-classes-to-write-applications-for-windows.md @@ -3,12 +3,14 @@ description: "Learn more about: Using the Classes to Write Applications for Wind title: "Using the Classes to Write Applications for Windows" ms.date: "11/04/2016" helpviewer_keywords: ["Windows applications [MFC], MFC application framework", "MFC, application development", "applications [OLE], MFC application framework", "MFC ActiveX controls [MFC], creating", "OLE applications [MFC], MFC application framework", "database applications [MFC], creating"] -ms.assetid: 73f63470-857d-43dd-9a54-b38b7be0f1b7 ms.topic: concept-article --- # Using the Classes to Write Applications for Windows -Taken together, the classes in the Microsoft Foundation Class (MFC) Library make up an "application framework," on which you build an application for the Windows operating system. At a very general level, the framework defines the skeleton of an application and supplies standard user-interface implementations that can be placed onto the skeleton. Your job as programmer is to fill in the rest of the skeleton, which are those things that are specific to your application. You can get a head start by using the MFC Application Wizard to create the files for a very thorough starter application. You use the Microsoft Visual C++ resource editors to design your user-interface elements visually, Class View commands to connect those elements to code, and the class library to implement your application-specific logic. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +Taken together, the classes in the Microsoft Foundation Class (MFC) Library make up an "application framework," on which you build an application for the Windows operating system. At a very general level, the framework defines the skeleton of an application and supplies standard user-interface implementations that can be placed onto the skeleton. Your job as programmer is to fill in the rest of the skeleton, which are those things that are specific to your application. You can get a head start by using the MFC Application Wizard to create the files for a very thorough starter application. You use the Visual Studio resource editors to design your user-interface elements visually, Class View commands to connect those elements to code, and the class library to implement your application-specific logic. Version 3.0 and later of the MFC framework supports programming for Win32 platforms, including Microsoft Windows 95 and later, and Windows NT versions 3.51 and later. MFC Win32 support includes multithreading. Use version 1.5*x* if you need to do 16-bit programming. diff --git a/docs/mfc/using-the-dialog-editor-to-add-controls.md b/docs/mfc/using-the-dialog-editor-to-add-controls.md index c5912c87f60..713ea777a5d 100644 --- a/docs/mfc/using-the-dialog-editor-to-add-controls.md +++ b/docs/mfc/using-the-dialog-editor-to-add-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Using the Dialog Editor to Add Controls" title: "Using the Dialog Editor to Add Controls" ms.date: "11/04/2016" helpviewer_keywords: ["Windows common controls [MFC], adding", "dialog box controls [MFC], adding to dialog boxes", "controls [MFC], adding to dialog boxes", "Dialog editor, creating controls", "common controls [MFC], adding"] -ms.assetid: d3f9f994-7e54-4656-a545-42c204557c36 ms.topic: concept-article --- # Using the Dialog Editor to Add Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you create your dialog-template resource with the [dialog editor](../windows/dialog-editor.md), you drag controls from a controls palette and drop them into the dialog box. This adds the specifications for that control type to the dialog-template resource. When you construct a dialog object and call its `Create` or `DoModal` member function, the framework creates a Windows control and places it in the dialog window on screen. You can instead [create controls by hand](../mfc/adding-controls-by-hand.md) if you want. This is more work. diff --git a/docs/mfc/using-the-mfc-source-files.md b/docs/mfc/using-the-mfc-source-files.md index 10c7f2d0fcc..ab89891084c 100644 --- a/docs/mfc/using-the-mfc-source-files.md +++ b/docs/mfc/using-the-mfc-source-files.md @@ -3,11 +3,13 @@ description: "Learn more about: Using the MFC source files" title: "Using the MFC source files" ms.date: "08/19/2019" helpviewer_keywords: ["public members", "source files", "MFC, source files", "MFC source files", "comments, MFC", "private member access", "protected member access", "source files, MFC"] -ms.assetid: 3230e8fb-3b69-4ddf-9538-365ac7ea5e72 ms.topic: concept-article --- # Using the MFC source files +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class (MFC) Library supplies full source code. Header files (.h) are in the *\atlmfc\include* directory. Implementation files (.cpp) are in the *\atlmfc\src\mfc* directory. This article explains the conventions that MFC uses to comment the various parts of each class, what these comments mean, and what you should expect to find in each section. The Visual Studio wizards use similar conventions for the classes that they create for you, and you'll probably find these conventions useful for your own code. diff --git a/docs/mfc/using-tooltips-in-a-cstatusbarctrl-object.md b/docs/mfc/using-tooltips-in-a-cstatusbarctrl-object.md index 2573a72f55c..acc70168491 100644 --- a/docs/mfc/using-tooltips-in-a-cstatusbarctrl-object.md +++ b/docs/mfc/using-tooltips-in-a-cstatusbarctrl-object.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Tooltips in a CStatusBarCtrl Object" title: "Using Tooltips in a CStatusBarCtrl Object" ms.date: "11/04/2016" helpviewer_keywords: ["tool tips [MFC], using in status bars", "status bars [MFC], tool tips", "CStatusBarCtrl class [MFC], tool tips"] -ms.assetid: a77597a7-43ef-4b8f-87bc-a8ea1dc63dc3 ms.topic: how-to --- # Using Tooltips in a CStatusBarCtrl Object +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To enable tooltips for a status bar control, create the `CStatusBarCtrl` object with the SBT_TOOLTIPS style. > [!NOTE] diff --git a/docs/mfc/using-tree-controls.md b/docs/mfc/using-tree-controls.md index 9130eb9f032..e444398c798 100644 --- a/docs/mfc/using-tree-controls.md +++ b/docs/mfc/using-tree-controls.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Tree Controls" title: "Using Tree Controls" ms.date: "11/04/2016" helpviewer_keywords: ["CTreeCtrl class [MFC], using", "tree controls [MFC], about tree controls"] -ms.assetid: 4e92941a-e477-4fb1-b1ce-4abeafbef1c1 ms.topic: concept-article --- # Using Tree Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Typical usage of a tree control ([CTreeCtrl](../mfc/reference/ctreectrl-class.md)) follows the pattern below: - The control is created. If the control is specified in a dialog box template or if you're using `CTreeView`, creation is automatic when the dialog box or view is created. If you want to create the tree control as a child window of some other window, use the [Create](../mfc/reference/ctreectrl-class.md#create) member function. diff --git a/docs/mfc/using-views.md b/docs/mfc/using-views.md index 2a3ce75afca..e83e30e8e11 100644 --- a/docs/mfc/using-views.md +++ b/docs/mfc/using-views.md @@ -3,11 +3,13 @@ description: "Learn more about: Using Views" title: "Using Views" ms.date: "11/04/2016" helpviewer_keywords: ["interacting with users and role of view class [MFC]", "drawing [MFC], data", "rendering data", "view classes [MFC], role in managing user interaction", "CView class [MFC], view architecture", "MFC, views", "views [MFC], using", "painting data", "user input [MFC], interpreting through view class [MFC]", "view classes [MFC], role in displaying application data"] -ms.assetid: dc3de6ad-5c64-4317-8f10-8bdcc38cdbd5 ms.topic: concept-article --- # Using Views +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The view's responsibilities are to display the document's data graphically to the user and to accept and interpret user input as operations on the document. Your tasks in writing your view class are to: - Write your view class's [OnDraw](../mfc/reference/cview-class.md#ondraw) member function, which renders the document's data. diff --git a/docs/mfc/using-your-old-toolbars.md b/docs/mfc/using-your-old-toolbars.md index d1fe0d061b2..8433410e874 100644 --- a/docs/mfc/using-your-old-toolbars.md +++ b/docs/mfc/using-your-old-toolbars.md @@ -4,12 +4,14 @@ title: "Using Your Old Toolbars" ms.date: "11/04/2016" f1_keywords: ["COldToolBar"] helpviewer_keywords: ["toolbars [MFC], backward compatibility", "COldToolBar class [MFC]"] -ms.assetid: 3543257c-8547-43f0-a66a-ee641dc1cf89 ms.topic: concept-article --- # Using Your Old Toolbars -If you have used previous versions of Visual C++ to create customized toolbars, the new implementation of class [CToolBar](../mfc/reference/ctoolbar-class.md) could cause you problems. So that you don't have to give up your old toolbars to use the new functionality, the old implementation is still supported. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +If you have used previous versions of Visual Studio to create customized toolbars, the new implementation of class [CToolBar](../mfc/reference/ctoolbar-class.md) could cause you problems. So that you don't have to give up your old toolbars to use the new functionality, the old implementation is still supported. The DOCKTOOL sample does not use the old-style toolbars, only the new-style toolbars. diff --git a/docs/mfc/view-classes-architecture.md b/docs/mfc/view-classes-architecture.md index b49cc3c4ec7..3e5e53eedb3 100644 --- a/docs/mfc/view-classes-architecture.md +++ b/docs/mfc/view-classes-architecture.md @@ -3,10 +3,12 @@ description: "Learn more about: View Classes (Architecture)" title: "View Classes (Architecture)" ms.date: "09/17/2019" helpviewer_keywords: ["form and record views [MFC]", "view classes [MFC]", "control views [MFC]", "view classes [MFC], architecture"] -ms.assetid: 8894579a-1436-441e-b985-83711061e495 --- # View Classes (Architecture) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + `CView` and its derived classes are child windows that represent the client area of a frame window. Views show data and accept input for a document. A view class is associated with a document class and a frame window class using a document-template object. diff --git a/docs/mfc/view-classes-windows.md b/docs/mfc/view-classes-windows.md index 763e0ca629a..ebd9220138c 100644 --- a/docs/mfc/view-classes-windows.md +++ b/docs/mfc/view-classes-windows.md @@ -4,10 +4,12 @@ title: "View Classes (Windows)" ms.date: "09/17/2019" f1_keywords: ["vc.classes.view"] helpviewer_keywords: ["form and record views [MFC]", "splitter window classes [MFC]", "view classes [MFC], Windows"] -ms.assetid: b11683fb-9f43-4de3-9499-2b55775f9870 --- # View Classes (Windows) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + `CView` and its derived classes are child windows that represent the client area of a frame window. Views show data and accept input for a document. A view class is associated with a document class and a frame window class using a document-template object. diff --git a/docs/mfc/virtual-list-controls.md b/docs/mfc/virtual-list-controls.md index f2e9003efd4..311cac31958 100644 --- a/docs/mfc/virtual-list-controls.md +++ b/docs/mfc/virtual-list-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Virtual List Controls" title: "Virtual List Controls" ms.date: "11/04/2016" helpviewer_keywords: ["cache, virtual list control item data", "list controls [MFC], virtual", "list controls [MFC], List view", "virtual list controls"] -ms.assetid: 319f841f-e426-423a-8276-d93f965b0b45 --- # Virtual List Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A virtual list control is a list view control that has the LVS_OWNERDATA style. This style enables the control to support an item count up to a **DWORD** (the default item count only extends to an **`int`**). However, the biggest advantage provided by this style is the ability to only have a subset of data items in memory at any one time. This allows the virtual list view control to lend itself for use with large databases of information, where specific methods of accessing data are already in place. > [!NOTE] diff --git a/docs/mfc/visualization-manager.md b/docs/mfc/visualization-manager.md index b02e2a7bb43..3325a8136a0 100644 --- a/docs/mfc/visualization-manager.md +++ b/docs/mfc/visualization-manager.md @@ -3,10 +3,12 @@ description: "Learn more about: Visualization Manager" title: "Visualization Manager" ms.date: "11/19/2018" helpviewer_keywords: ["Visualization Manager"] -ms.assetid: c9dd1365-27ac-42e5-8caa-1004525b4129 --- # Visualization Manager +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The visual manager is an object that controls the appearance of a whole application. It acts as a single class where you can put all the drawing code for your application. The MFC Library includes several visual managers. You can also create your own visual manager if you want to create a custom view for your application. The following images show the same application when different visual managers are enabled: ![MyApp as rendered by CMFCVisualManagerWindows.](../mfc/media/vmwindows.png "MyApp as rendered by CMFCVisualManagerWindows")
diff --git a/docs/mfc/walkthrough-adding-a-ctaskdialog-to-an-application.md b/docs/mfc/walkthrough-adding-a-ctaskdialog-to-an-application.md index 1174ea2988d..22a01a8430a 100644 --- a/docs/mfc/walkthrough-adding-a-ctaskdialog-to-an-application.md +++ b/docs/mfc/walkthrough-adding-a-ctaskdialog-to-an-application.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["CTaskDialog, adding", "walkthroughs [MFC], dialogs"] --- # Walkthrough: Adding a CTaskDialog to an application +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This walkthrough introduces the [`CTaskDialog` class](../mfc/reference/ctaskdialog-class.md) and shows how to add it to your application. The `CTaskDialog` is a task dialog box that replaces the Windows message box in Windows Vista or later. The `CTaskDialog` improves on the original message box and adds functionality. The Windows message box is still supported in Visual Studio. diff --git a/docs/mfc/walkthrough-adding-a-d2d-object-to-an-mfc-project.md b/docs/mfc/walkthrough-adding-a-d2d-object-to-an-mfc-project.md index a1bcbd4b77d..f947e363ef4 100644 --- a/docs/mfc/walkthrough-adding-a-d2d-object-to-an-mfc-project.md +++ b/docs/mfc/walkthrough-adding-a-d2d-object-to-an-mfc-project.md @@ -3,11 +3,13 @@ description: "Learn more about: Walkthrough: Adding a D2D Object to an MFC Proje title: "Walkthrough: Adding a D2D Object to an MFC Project" ms.date: "04/25/2019" helpviewer_keywords: ["MFC, D2D", "D2D [MFC]"] -ms.assetid: dda36c33-c231-4da6-a62f-72d69a12b6dd --- # Walkthrough: Adding a D2D Object to an MFC Project -This walkthrough teaches how to add a basic Direct2D (D2D) object to a Visual C++, Microsoft Foundation Class Library (MFC) project, and then build the project into an application that prints "Hello, World!" on a gradient background. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +This walkthrough teaches how to add a basic Direct2D (D2D) object to a Visual Studio, Microsoft Foundation Class Library (MFC) project, and then build the project into an application that prints "Hello, World!" on a gradient background. The walkthrough shows how to accomplish these tasks: @@ -25,7 +27,7 @@ The walkthrough shows how to accomplish these tasks: ## Prerequisites -To complete this walkthrough, you must have Visual Studio installed with the **Desktop development with C++** workload and the optional **Visual C++ MFC for x86 and x64** component. +To complete this walkthrough, you must have Visual Studio installed with the **Desktop development with C++** workload and the optional **C++ MFC for x64/x86** component. ## To create an MFC application diff --git a/docs/mfc/walkthrough-adding-animation-to-an-mfc-project.md b/docs/mfc/walkthrough-adding-animation-to-an-mfc-project.md index 2ab962abddd..8c7a5e4ed3c 100644 --- a/docs/mfc/walkthrough-adding-animation-to-an-mfc-project.md +++ b/docs/mfc/walkthrough-adding-animation-to-an-mfc-project.md @@ -3,11 +3,13 @@ description: "Learn more about: Walkthrough: Adding Animation to an MFC Project" title: "Walkthrough: Adding Animation to an MFC Project" ms.date: "04/25/2019" helpviewer_keywords: ["animation [MFC]", "MFC, animation"] -ms.assetid: 004f832c-9fd5-4f88-9ca9-ae65dececdc2 --- # Walkthrough: Adding Animation to an MFC Project -This walkthrough teaches how to add a basic animated object to a Visual C++, Microsoft Foundation Class Library (MFC) project. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +This walkthrough teaches how to add a basic animated object to a Visual Studio, Microsoft Foundation Class Library (MFC) project. The walkthrough shows how to accomplish these tasks: diff --git a/docs/mfc/walkthrough-creating-a-ribbon-application-by-using-mfc.md b/docs/mfc/walkthrough-creating-a-ribbon-application-by-using-mfc.md index 6421813b892..68f02ff75c1 100644 --- a/docs/mfc/walkthrough-creating-a-ribbon-application-by-using-mfc.md +++ b/docs/mfc/walkthrough-creating-a-ribbon-application-by-using-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Walkthrough: Creating a Ribbon Application By Us title: "Walkthrough: Creating a Ribbon Application By Using MFC" ms.date: "09/09/2019" helpviewer_keywords: ["ribbon application, creating (MFC)", "creating a ribbon application (MFC)"] -ms.assetid: e61393e2-1d6b-4594-a7ce-157d3d1b0d9f --- # Walkthrough: Creating a Ribbon Application By Using MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This walkthrough shows how to use the **MFC Application Wizard** to create an application that has a ribbon by default. You can then expand the ribbon by adding a **Custom** ribbon category that has a **Favorites** ribbon panel, and then adding some frequently used commands to the panel. ## Prerequisites diff --git a/docs/mfc/walkthrough-putting-controls-on-toolbars.md b/docs/mfc/walkthrough-putting-controls-on-toolbars.md index 2d3962ab8c2..9688e8d6d59 100644 --- a/docs/mfc/walkthrough-putting-controls-on-toolbars.md +++ b/docs/mfc/walkthrough-putting-controls-on-toolbars.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["Customize dialog box, adding controls", "toolbars [MFC], --- # Walkthrough: Putting Controls On Toolbars +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes how to add a toolbar button that contains a Windows control to a toolbar. In MFC, a toolbar button must be a [`CMFCToolBarButton` Class](reference/cmfctoolbarbutton-class.md)-derived class, for example [`CMFCToolBarComboBoxButton` Class](reference/cmfctoolbarcomboboxbutton-class.md), [`CMFCToolBarEditBoxButton` Class](reference/cmfctoolbareditboxbutton-class.md), [`CMFCDropDownToolbarButton` Class](reference/cmfcdropdowntoolbarbutton-class.md), or [`CMFCToolBarMenuButton` Class](reference/cmfctoolbarmenubutton-class.md). ## Adding Controls to Toolbars diff --git a/docs/mfc/walkthrough-updating-the-mfc-scribble-application-part-1.md b/docs/mfc/walkthrough-updating-the-mfc-scribble-application-part-1.md index 6a37a8bff6a..0df6ca00842 100644 --- a/docs/mfc/walkthrough-updating-the-mfc-scribble-application-part-1.md +++ b/docs/mfc/walkthrough-updating-the-mfc-scribble-application-part-1.md @@ -3,10 +3,12 @@ description: "Learn more about: Walkthrough: Updating the MFC Scribble Applicati title: "Walkthrough: Updating the MFC Scribble Application (Part 1)" ms.date: "09/09/2019" helpviewer_keywords: ["examples [MFC], update existing application", "ribbon UI, porting to", "Office Fluent UI, porting to", "samples [MFC], update existing application", "MFC Feature Pack, update existing application", "walkthroughs [MFC], update existing application"] -ms.assetid: aa6330d3-6cfc-4c79-8fcb-0282263025f7 --- # Walkthrough: Updating the MFC Scribble Application (Part 1) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This walkthrough demonstrates how to modify an existing MFC application to use the Ribbon user interface. Visual Studio supports both the Office 2007 Ribbon and the Windows 7 Scenic Ribbon. For more information about the Ribbon user interface, see [Ribbons](/windows/win32/uxguide/cmd-ribbons). This walkthrough modifies the classic Scribble 1.0 MFC sample that lets you use the mouse to create line drawings. This part of the walkthrough shows how to modify the Scribble sample so that it displays a ribbon bar. [Part 2](../mfc/walkthrough-updating-the-mfc-scribble-application-part-2.md) adds more buttons to the ribbon bar. diff --git a/docs/mfc/walkthrough-updating-the-mfc-scribble-application-part-2.md b/docs/mfc/walkthrough-updating-the-mfc-scribble-application-part-2.md index 19b88357d9d..81cb6c4023a 100644 --- a/docs/mfc/walkthrough-updating-the-mfc-scribble-application-part-2.md +++ b/docs/mfc/walkthrough-updating-the-mfc-scribble-application-part-2.md @@ -3,10 +3,12 @@ description: "Learn more about: Walkthrough: Updating the MFC Scribble Applicati title: "Walkthrough: Updating the MFC Scribble Application (Part 2)" ms.date: "04/25/2019" helpviewer_keywords: ["walkthroughs [MFC]"] -ms.assetid: 602df5c2-17d4-4cd9-8cf6-dff652c4cae5 --- # Walkthrough: Updating the MFC Scribble Application (Part 2) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + [Part 1](../mfc/walkthrough-updating-the-mfc-scribble-application-part-1.md) of this walkthrough showed how to add an Office Fluent Ribbon to the classic Scribble application. This part shows how to add ribbon panels and controls that users can use instead of menus and commands. ## Prerequisites diff --git a/docs/mfc/walkthrough-using-the-new-mfc-shell-controls.md b/docs/mfc/walkthrough-using-the-new-mfc-shell-controls.md index 35d503d1884..7b82b7990a9 100644 --- a/docs/mfc/walkthrough-using-the-new-mfc-shell-controls.md +++ b/docs/mfc/walkthrough-using-the-new-mfc-shell-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Walkthrough: Using the New MFC Shell Controls" title: "Walkthrough: Using the New MFC Shell Controls" ms.date: 10/27/2021 helpviewer_keywords: ["shell controls (MFC)"] -ms.assetid: f0015caa-199d-4aaf-9501-5a239fce9095 --- # Walkthrough: Using the New MFC Shell Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In this walkthrough, you'll create an application that resembles File Explorer. You'll create a window that has two panes. The left pane will hold a [CMFCShellTreeCtrl](../mfc/reference/cmfcshelltreectrl-class.md) object that displays your Desktop in a hierarchical view. The right pane will hold a [CMFCShellListCtrl](../mfc/reference/cmfcshelllistctrl-class.md) that shows the files in the folder that is selected in the left pane. ## Prerequisites diff --git a/docs/mfc/walkthroughs-mfc.md b/docs/mfc/walkthroughs-mfc.md index a286a742aec..d5c6bf20893 100644 --- a/docs/mfc/walkthroughs-mfc.md +++ b/docs/mfc/walkthroughs-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Walkthroughs (MFC)" title: "Walkthroughs (MFC)" ms.date: "09/20/2018" helpviewer_keywords: ["MFC Feature Pack, walkthroughs"] -ms.assetid: 20d5756f-ad58-46f4-8b6c-c7a1020b72eb --- # Walkthroughs (MFC) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This section contains articles that walk you through various tasks associated with new MFC library features. ## In This Section diff --git a/docs/mfc/what-does-it-cost-me-to-derive-a-class-from-cobject-q.md b/docs/mfc/what-does-it-cost-me-to-derive-a-class-from-cobject-q.md index 5aedcbf9840..6f32909aa5b 100644 --- a/docs/mfc/what-does-it-cost-me-to-derive-a-class-from-cobject-q.md +++ b/docs/mfc/what-does-it-cost-me-to-derive-a-class-from-cobject-q.md @@ -3,10 +3,12 @@ description: "Learn more about: What Does it Cost me to Derive a Class from CObj title: "What Does it Cost me to Derive a Class from CObject?" ms.date: "11/04/2016" helpviewer_keywords: ["CObject class [MFC], overhead of derived classes [MFC]"] -ms.assetid: 9b92c98b-b3dd-48a7-9d24-c3b8554edf90 --- # What Does it Cost me to Derive a Class from CObject? +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The overhead in deriving from class [CObject](../mfc/reference/cobject-class.md) is minimal. Your derived class inherits only four virtual functions and a single [CRuntimeClass](../mfc/reference/cruntimeclass-structure.md) object. ## See also diff --git a/docs/mfc/what-frame-windows-do.md b/docs/mfc/what-frame-windows-do.md index 4949a47ade0..bb4c94ccf7a 100644 --- a/docs/mfc/what-frame-windows-do.md +++ b/docs/mfc/what-frame-windows-do.md @@ -3,10 +3,12 @@ description: "Learn more about: What Frame Windows Do" title: "What Frame Windows Do" ms.date: "11/04/2016" helpviewer_keywords: ["frame windows [MFC], about frame windows", "frame windows [MFC], tasks", "MFC, frame windows"] -ms.assetid: 1148a952-6786-4622-b5a8-68a2d7eae584 --- # What Frame Windows Do +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Besides simply framing a view, frame windows are responsible for numerous tasks involved in coordinating the frame with its view and with the application. [CMDIFrameWnd](../mfc/reference/cmdiframewnd-class.md) and [CMDIChildWnd](../mfc/reference/cmdichildwnd-class.md) inherit from [CFrameWnd](../mfc/reference/cframewnd-class.md), so they have `CFrameWnd` capabilities as well as new capabilities that they add. Examples of child windows include views, controls such as buttons and list boxes, and control bars, including toolbars, status bars, and dialog bars. The frame window is responsible for managing the layout of its child windows. In the MFC framework, a frame window positions any control bars, views, and other child windows inside its client area. diff --git a/docs/mfc/what-is-a-carchive-object.md b/docs/mfc/what-is-a-carchive-object.md index 69b0bdb75a6..07598d35a70 100644 --- a/docs/mfc/what-is-a-carchive-object.md +++ b/docs/mfc/what-is-a-carchive-object.md @@ -3,12 +3,14 @@ description: "Learn more about: What Is a CArchive Object" title: "What Is a CArchive Object" ms.date: "11/04/2016" helpviewer_keywords: ["archive objects [MFC]", "archives [MFC], for serialization", "buffers, serializable objects", "CArchive class [MFC], about CArchive class [MFC]", "buffering, serializable objects"] -ms.assetid: 843f1825-288d-4d89-a1fa-70e1f92d9b8b ms.custom: intro-overview ms.topic: concept-article --- # What Is a CArchive Object +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A `CArchive` object provides a type-safe buffering mechanism for writing or reading serializable objects to or from a `CFile` object. Usually the `CFile` object represents a disk file; however, it can also be a memory file (`CSharedFile` object), perhaps representing the Clipboard. A given `CArchive` object either stores (writes, serializes) data or loads (reads, deserializes) data, but never both. The life of a `CArchive` object is limited to one pass through writing objects to a file or reading objects from a file. Thus, two successively created `CArchive` objects are required to serialize data to a file and then deserialize it back from the file. diff --git a/docs/mfc/when-to-initialize-cwnd-objects.md b/docs/mfc/when-to-initialize-cwnd-objects.md index 4097208b0f6..88b6408936f 100644 --- a/docs/mfc/when-to-initialize-cwnd-objects.md +++ b/docs/mfc/when-to-initialize-cwnd-objects.md @@ -3,10 +3,12 @@ description: "Learn more about: When to Initialize CWnd Objects" title: "When to Initialize CWnd Objects" ms.date: "11/04/2016" helpviewer_keywords: ["window objects [MFC], when to initialize CWnd", "initializing CWnd objects [MFC]", "initializing objects [MFC], CWnd", "CWnd objects [MFC], when HWND is attached", "HWND, when attached to CWnd object", "CWnd objects [MFC], when to initialize"] -ms.assetid: 4d31bcb1-73db-4f2f-b71c-89b087569a10 --- # When to Initialize CWnd Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You cannot create your own child windows or call any Windows API functions in the constructor of a `CWnd`-derived object. This is because the `HWND` for the `CWnd` object has not been created yet. Most Windows-specific initialization, such as adding child windows, must be done in an [OnCreate](../mfc/reference/cwnd-class.md#oncreate) message handler. ## What do you want to know more about diff --git a/docs/mfc/when-update-handlers-are-called.md b/docs/mfc/when-update-handlers-are-called.md index 63558a68e37..ad527d5e48d 100644 --- a/docs/mfc/when-update-handlers-are-called.md +++ b/docs/mfc/when-update-handlers-are-called.md @@ -3,10 +3,12 @@ description: "Learn more about: When Update Handlers Are Called" title: "When Update Handlers Are Called" ms.date: "11/04/2016" helpviewer_keywords: ["updating user interface objects [MFC]", "command routing [MFC], update commands", "toolbar buttons [MFC], enabling", "disabling toolbar buttons", "menus [MFC], initializing", "update handlers [MFC]", "disabling menu items", "toolbars [MFC], updating", "menus [MFC], updating as context changes", "toolbar controls [MFC], updated during OnIdle method [MFC]", "menu items, enabling", "command routing [MFC], update handlers", "update handlers, calling"] -ms.assetid: 7359f6b1-4669-477d-bd99-690affed08d9 --- # When Update Handlers Are Called +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Suppose the user clicks the mouse in the File menu, which generates a WM_INITMENUPOPUP message. The framework's update mechanism collectively updates all items on the File menu before the menu drops down so the user can see it. To do this, the framework routes update commands for all menu items in the pop-up menu along the standard command routing. Command targets on the routing have an opportunity to update any menu items by matching the update command with an appropriate message-map entry (of the form `ON_UPDATE_COMMAND_UI`) and calling an "update handler" function. Thus, for a menu with six menu items, six update commands are sent out. If an update handler exists for the command ID of the menu item, it is called to do the updating. If not, the framework checks for the existence of a handler for that command ID and enables or disables the menu item as appropriate. diff --git a/docs/mfc/where-to-find-message-maps.md b/docs/mfc/where-to-find-message-maps.md index 2d4a1403aa2..5db17291298 100644 --- a/docs/mfc/where-to-find-message-maps.md +++ b/docs/mfc/where-to-find-message-maps.md @@ -3,10 +3,12 @@ description: "Learn more about: Where to Find Message Maps" title: "Where to Find Message Maps" ms.date: "11/04/2016" helpviewer_keywords: ["macros, message map", "locating message maps", "message classes [MFC], finding", "message-map macros"] -ms.assetid: bf59fbc8-b222-42d3-b5d3-0a79aa3cb923 --- # Where to Find Message Maps +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + When you create a new skeleton application with the Application Wizard, the Application Wizard writes a message map for each command-target class it creates for you. This includes your derived application, document, view, and frame-window classes. Some of these message maps already have the entries supplied by the Application Wizard for certain messages and predefined commands, and some are just placeholders for handlers that you will add. A class's message map is located in the .CPP file for the class. Working with the basic message maps that the Application Wizard creates, you use the [Class Wizard](reference/mfc-class-wizard.md) to add entries for the messages and commands that each class will handle. A typical message map might look like the following after you add some entries: diff --git a/docs/mfc/win32-internet-classes.md b/docs/mfc/win32-internet-classes.md index 218920d5438..f30bb06f4b3 100644 --- a/docs/mfc/win32-internet-classes.md +++ b/docs/mfc/win32-internet-classes.md @@ -4,10 +4,12 @@ title: "Win32 Internet Classes" ms.date: "09/12/2018" f1_keywords: ["vc.classes.win32"] helpviewer_keywords: ["Internet classes [MFC]", "WinInet classes [MFC], classes", "Win32 [MFC], Internet classes", "Windows API [MFC], Internet classes"] -ms.assetid: b49601d5-3025-4068-9408-316b54ee4375 --- # Win32 Internet Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC wraps the Win32 Internet (WinInet) and ActiveX technology to make Internet programming easier. >[!IMPORTANT] diff --git a/docs/mfc/win32-internet-extensions-wininet.md b/docs/mfc/win32-internet-extensions-wininet.md index 801fcbb1aca..63a5cba7c3f 100644 --- a/docs/mfc/win32-internet-extensions-wininet.md +++ b/docs/mfc/win32-internet-extensions-wininet.md @@ -3,10 +3,12 @@ description: "Learn more about: Win32 Internet Extensions (WinInet)" title: "Win32 Internet Extensions (WinInet)" ms.date: "11/04/2016" helpviewer_keywords: ["Internet applications [MFC], Win32 Internet Extensions", "Internet client applications [MFC], about Internet client applications", "client applications [MFC], Win32 Internet", "WinInet classes [MFC], about WinInet classes"] -ms.assetid: f8c80f0b-ce14-4f0d-a3cf-4f7d8c5cca59 --- # Win32 Internet Extensions (WinInet) +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + An Internet client application is a program that accesses information from a network data source (server) using Internet protocols such as gopher, FTP, or HTTP. An Internet client application might access a server to retrieve data such as weather maps, stock prices, or newspaper headlines, for example. The Internet client can access the server through an external network (the Internet) or an internal network (sometimes called an intranet). MFC includes the Win32 Internet Extensions, or WinInet, for creating an Internet client application. MFC encapsulates these Internet extensions in a set of standard, easy-to-use classes. You can write a WinInet client application by calling the Win32 functions directly or by using the MFC WinInet classes. diff --git a/docs/mfc/window-destruction-sequence.md b/docs/mfc/window-destruction-sequence.md index 7cc74192df7..24af36131b3 100644 --- a/docs/mfc/window-destruction-sequence.md +++ b/docs/mfc/window-destruction-sequence.md @@ -3,10 +3,12 @@ description: "Learn more about: Window Destruction Sequence" title: "Window Destruction Sequence" ms.date: "11/04/2016" helpviewer_keywords: ["destruction, windows", "destroying windows", "sequence [MFC], window destruction", "CWnd objects [MFC], destruction sequence", "sequence [MFC]", "windows [MFC], destroying"] -ms.assetid: 2d819196-6240-415f-a308-db43745e616c --- # Window Destruction Sequence +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + In the MFC framework, when the user closes the frame window, the window's default [OnClose](../mfc/reference/cwnd-class.md#onclose) handler calls [DestroyWindow](../mfc/reference/cwnd-class.md#destroywindow). The last member function called when the Windows window is destroyed is [OnNcDestroy](../mfc/reference/cwnd-class.md#onncdestroy), which does some cleanup, calls the [Default](../mfc/reference/cwnd-class.md#default) member function to perform Windows cleanup, and lastly calls the virtual member function [PostNcDestroy](../mfc/reference/cwnd-class.md#postncdestroy). The [CFrameWnd](../mfc/reference/cframewnd-class.md) implementation of `PostNcDestroy` deletes the C++ window object. ## What do you want to know more about diff --git a/docs/mfc/window-dialog-and-control-classes.md b/docs/mfc/window-dialog-and-control-classes.md index 9beece06877..730a6baea47 100644 --- a/docs/mfc/window-dialog-and-control-classes.md +++ b/docs/mfc/window-dialog-and-control-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Window, Dialog, and Control Classes" title: "Window, Dialog, and Control Classes" ms.date: "11/04/2016" helpviewer_keywords: ["windows [MFC], dialog and control classes"] -ms.assetid: b3610da6-9644-49b7-adbf-0e04f0d6d2b5 --- # Window, Dialog, and Control Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Class `CWnd` and its derived classes encapsulate an `HWND`, a handle to a Windows window. `CWnd` can be used by itself or as a base for deriving new classes. The derived classes supplied by the class library represent various kinds of windows. [CWnd](../mfc/reference/cwnd-class.md)
diff --git a/docs/mfc/window-objects.md b/docs/mfc/window-objects.md index a4f2924d5be..fc1929cb147 100644 --- a/docs/mfc/window-objects.md +++ b/docs/mfc/window-objects.md @@ -3,10 +3,12 @@ description: "Learn more about: Window Objects" title: "Window Objects" ms.date: "11/04/2016" helpviewer_keywords: ["objects [MFC], window", "Windows window [MFC]", "MFC, windows", "frame windows [MFC], C++ window objects", "window objects [MFC]", "windows [MFC], C++ window objects", "window messages [MFC]", "HWND", "messages [MFC], Windows", "Visual C++, window objects [MFC]", "HWND, window objects [MFC]"] -ms.assetid: 28b33ce2-af05-4617-9d03-1cb9a02be687 --- # Window Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + MFC supplies class [CWnd](../mfc/reference/cwnd-class.md) to encapsulate the `HWND` handle of a window. The `CWnd` object is a C++ window object, distinct from the `HWND` that represents a Windows window but containing it. Use `CWnd` to derive your own child window classes, or use one of the many MFC classes derived from `CWnd`. Class `CWnd` is the base class for all windows, including frame windows, dialog boxes, child windows, controls, and control bars such as toolbars. A good understanding of [the relationship between a C++ window object and an HWND](../mfc/relationship-between-a-cpp-window-object-and-an-hwnd.md) is crucial for effective programming with MFC. MFC provides some default functionality and management of windows, but you can derive your own class from `CWnd` and use its member functions to customize the provided functionality. You can create child windows by constructing a `CWnd` object and calling its [Create](../mfc/reference/cwnd-class.md#create) member function, then customize the child windows using `CWnd` member functions. You can embed objects derived from [CView](../mfc/reference/cview-class.md), such as form views or tree views, in a frame window. And you can support multiple views of your documents via splitter panes, supplied by class [CSplitterWnd](../mfc/reference/csplitterwnd-class.md). diff --git a/docs/mfc/window-procedure-entry-points.md b/docs/mfc/window-procedure-entry-points.md index 2655dd259f0..a56476482dd 100644 --- a/docs/mfc/window-procedure-entry-points.md +++ b/docs/mfc/window-procedure-entry-points.md @@ -3,10 +3,12 @@ description: "Learn more about: Window Procedure Entry Points" title: "Window Procedure Entry Points" ms.date: "11/04/2016" helpviewer_keywords: ["state management, window procedures", "MFC, managing state data", "window procedure entry points", "entry points, window procedures"] -ms.assetid: a6b46a7f-6e42-45f2-9ae6-82e19fc57148 --- # Window Procedure Entry Points +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + To protect MFC window procedures, a module static links with a special window procedure implementation. The linkage occurs automatically when the module is linked with MFC. This window procedure uses the AFX_MANAGE_STATE macro to properly set the effective module state, then it calls `AfxWndProc`, which in turn delegates to the `WindowProc` member function of the appropriate `CWnd`-derived object. ## See also diff --git a/docs/mfc/windows-sockets-background.md b/docs/mfc/windows-sockets-background.md index 8bb853e4102..26d496907f5 100644 --- a/docs/mfc/windows-sockets-background.md +++ b/docs/mfc/windows-sockets-background.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Background" title: "Windows Sockets: Background" ms.date: "11/04/2016" helpviewer_keywords: ["record-oriented data [MFC]", "e-mail [MFC]", "Internet Protocol Suite", "mail [MFC]", "communications [MFC], domain", "Windows Sockets [MFC], stream sockets", "mail [MFC], programming for", "sockets [MFC], stream sockets", "datagram sockets [MFC]", "SOCKET handle", "data types [MFC], socket", "e-mail [MFC], programming for", "X Window servers", "sequenced data flow", "stream sockets [MFC]"] -ms.assetid: f60d4ed2-bf23-4a0e-98d2-fee77e8473dd --- # Windows Sockets: Background +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the nature and purpose of Windows Sockets. The article also: - [Defines the term "socket"](#_core_definition_of_a_socket). diff --git a/docs/mfc/windows-sockets-blocking.md b/docs/mfc/windows-sockets-blocking.md index f0e50a171df..2c2d61ed2d6 100644 --- a/docs/mfc/windows-sockets-blocking.md +++ b/docs/mfc/windows-sockets-blocking.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Blocking" title: "Windows Sockets: Blocking" ms.date: "11/04/2016" helpviewer_keywords: ["sockets [MFC], blocking mode", "Windows Sockets [MFC], Windows platforms", "Windows Sockets [MFC], blocking mode", "sockets [MFC], behavior on different Windows platforms", "blocking mode sockets"] -ms.assetid: 10aca9b1-bfba-41a8-9c55-ea8082181e63 --- # Windows Sockets: Blocking +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article and two companion articles explain several issues in Windows Sockets programming. This article covers blocking. The other issues are covered in the articles: [Windows Sockets: Byte Ordering](../mfc/windows-sockets-byte-ordering.md) and [Windows Sockets: Converting Strings](../mfc/windows-sockets-converting-strings.md). If you use or derive from class [CAsyncSocket](../mfc/reference/casyncsocket-class.md), you will need to manage these issues yourself. If you use or derive from class [CSocket](../mfc/reference/csocket-class.md), MFC manages them for you. diff --git a/docs/mfc/windows-sockets-byte-ordering.md b/docs/mfc/windows-sockets-byte-ordering.md index fde1d2eed8e..d8b3e1a50ae 100644 --- a/docs/mfc/windows-sockets-byte-ordering.md +++ b/docs/mfc/windows-sockets-byte-ordering.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Byte Ordering" title: "Windows Sockets: Byte Ordering" ms.date: "11/04/2016" helpviewer_keywords: ["byte order issues in sockets programming", "sockets [MFC], byte order issues", "Windows Sockets [MFC], byte order issues"] -ms.assetid: 8a787a65-f9f4-4002-a02f-ac25a5dace5d --- # Windows Sockets: Byte Ordering +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article and two companion articles explain several issues in Windows Sockets programming. This article covers byte ordering. The other issues are covered in the articles: [Windows Sockets: Blocking](../mfc/windows-sockets-blocking.md) and [Windows Sockets: Converting Strings](../mfc/windows-sockets-converting-strings.md). If you use or derive from class [CAsyncSocket](../mfc/reference/casyncsocket-class.md), you will need to manage these issues yourself. If you use or derive from class [CSocket](../mfc/reference/csocket-class.md), MFC manages them for you. diff --git a/docs/mfc/windows-sockets-classes.md b/docs/mfc/windows-sockets-classes.md index c80ea097acb..0c0b8f257ec 100644 --- a/docs/mfc/windows-sockets-classes.md +++ b/docs/mfc/windows-sockets-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets Classes" title: "Windows Sockets Classes" ms.date: "11/04/2016" helpviewer_keywords: ["sockets classes [MFC]", "Windows Sockets [MFC], classes"] -ms.assetid: 58b9ab8d-9e44-4db3-8265-e04e713d2e9a --- # Windows Sockets Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Windows Sockets provide a network protocol-independent way to communicate between two computers. These sockets can be synchronous (your program waits until the communication is done) or asynchronous (your program continues running while the communication is going on). [CAsyncSocket](../mfc/reference/casyncsocket-class.md)
diff --git a/docs/mfc/windows-sockets-converting-strings.md b/docs/mfc/windows-sockets-converting-strings.md index 6afd8d49102..d7a439eb926 100644 --- a/docs/mfc/windows-sockets-converting-strings.md +++ b/docs/mfc/windows-sockets-converting-strings.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Converting Strings" title: "Windows Sockets: Converting Strings" ms.date: "11/04/2016" helpviewer_keywords: ["Windows Sockets [MFC], multibyte character string conversion", "sockets [MFC], multibyte character string conversion issues", "string conversion, multibyte character strings"] -ms.assetid: 9df522b5-6b23-41e0-bb96-e4e623baf141 --- # Windows Sockets: Converting Strings +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article and two companion articles explain several issues in Windows Sockets programming. This article covers converting strings. The other issues are covered in [Windows Sockets: Blocking](../mfc/windows-sockets-blocking.md) and [Windows Sockets: Byte Ordering](../mfc/windows-sockets-byte-ordering.md). If you use or derive from class [CAsyncSocket](../mfc/reference/casyncsocket-class.md), you will need to manage these issues yourself. If you use or derive from class [CSocket](../mfc/reference/csocket-class.md), MFC manages them for you. diff --git a/docs/mfc/windows-sockets-datagram-sockets.md b/docs/mfc/windows-sockets-datagram-sockets.md index b751ab84485..6382445c37f 100644 --- a/docs/mfc/windows-sockets-datagram-sockets.md +++ b/docs/mfc/windows-sockets-datagram-sockets.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Datagram Sockets" title: "Windows Sockets: Datagram Sockets" ms.date: "11/04/2016" helpviewer_keywords: ["sockets [MFC], datagram", "Windows Sockets [MFC], bi-directional data flow", "datagram sockets [MFC]", "Windows Sockets [MFC], datagram", "sockets [MFC], bi-directional data flow"] -ms.assetid: bec16a1c-74c0-4ff9-8c18-c2d87897d264 --- # Windows Sockets: Datagram Sockets +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes datagram sockets, one of the two Windows Socket types available. (The other type is the [stream socket](../mfc/windows-sockets-stream-sockets.md).) Datagram sockets support a bidirectional data flow that is not guaranteed to be sequenced or unduplicated. Datagrams also are not guaranteed to be reliable; they can fail to arrive. Datagram data may arrive out of order and possibly duplicated, but record boundaries in the data are preserved, as long as the records are smaller than the receiver's internal size limit. You are responsible for managing sequencing and reliability. (Reliability tends to be good on local-area networks [LAN] but less so on wide-area networks [WAN], such as the Internet.) diff --git a/docs/mfc/windows-sockets-deriving-from-socket-classes.md b/docs/mfc/windows-sockets-deriving-from-socket-classes.md index 3915149c498..42d1d881cb8 100644 --- a/docs/mfc/windows-sockets-deriving-from-socket-classes.md +++ b/docs/mfc/windows-sockets-deriving-from-socket-classes.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Deriving from Socket Classes" title: "Windows Sockets: Deriving from Socket Classes" ms.date: "11/04/2016" helpviewer_keywords: ["derived classes [MFC], from socket classes", "Windows Sockets [MFC], deriving from socket classes", "sockets [MFC], deriving from socket classes"] -ms.assetid: 3a26e67a-e323-433b-9b05-eca018799801 --- # Windows Sockets: Deriving from Socket Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes some of the functionality you can gain by deriving your own class from one of the socket classes. You can derive your own socket classes from either [CAsyncSocket](../mfc/reference/casyncsocket-class.md) or [CSocket](../mfc/reference/csocket-class.md) to add your own functionality. In particular, these classes supply a number of virtual member functions that you can override. These functions include [OnReceive](../mfc/reference/casyncsocket-class.md#onreceive), [OnSend](../mfc/reference/casyncsocket-class.md#onsend), [OnAccept](../mfc/reference/casyncsocket-class.md#onaccept), [OnConnect](../mfc/reference/casyncsocket-class.md#onconnect), and [OnClose](../mfc/reference/casyncsocket-class.md#onclose). You can override the functions in your derived socket class to take advantage of the notifications they provide when network events occur. The framework calls these notification callback functions to notify you of important socket events, such as the receipt of data that you can begin reading. For more information about notification functions, see [Windows Sockets: Socket Notifications](../mfc/windows-sockets-socket-notifications.md). diff --git a/docs/mfc/windows-sockets-example-of-sockets-using-archives.md b/docs/mfc/windows-sockets-example-of-sockets-using-archives.md index 89e332528ba..92d56b0acb9 100644 --- a/docs/mfc/windows-sockets-example-of-sockets-using-archives.md +++ b/docs/mfc/windows-sockets-example-of-sockets-using-archives.md @@ -6,6 +6,9 @@ helpviewer_keywords: ["sockets [MFC], with archives", "examples [MFC], Windows S --- # Windows Sockets: Example of Sockets Using Archives +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article presents an example of using class [CSocket](../mfc/reference/csocket-class.md). The example employs `CArchive` objects to serialize data through a socket. Note that this is not document serialization to or from a file. The following example illustrates how you use the archive to send and receive data through `CSocket` objects. The example is designed so that two instances of the application (on the same machine or on different machines on the network) exchange data. One instance sends data, which the other instance receives and acknowledges. Either application can initiate an exchange, and either can act as server or as client to the other application. The following function is defined in the application's view class: diff --git a/docs/mfc/windows-sockets-how-sockets-with-archives-work.md b/docs/mfc/windows-sockets-how-sockets-with-archives-work.md index 6532e6b427a..d09962908a2 100644 --- a/docs/mfc/windows-sockets-how-sockets-with-archives-work.md +++ b/docs/mfc/windows-sockets-how-sockets-with-archives-work.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: How Sockets with Archives Work" title: "Windows Sockets: How Sockets with Archives Work" ms.date: "11/19/2018" helpviewer_keywords: ["Windows Sockets [MFC], synchronous", "sockets [MFC], synchronous operation", "sockets [MFC], with archives", "synchronous state socket", "Windows Sockets [MFC], with archives", "two-state socket object"] -ms.assetid: d8ae4039-391d-44f0-a19b-558817affcbb --- # Windows Sockets: How Sockets with Archives Work +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how a [CSocket](../mfc/reference/csocket-class.md) object, a [CSocketFile](../mfc/reference/csocketfile-class.md) object, and a [CArchive](../mfc/reference/carchive-class.md) object are combined to simplify sending and receiving data through a Windows Socket. The article [Windows Sockets: Example of Sockets Using Archives](../mfc/windows-sockets-example-of-sockets-using-archives.md) presents the `PacketSerialize` function. The archive object in the `PacketSerialize` example works much like an archive object passed to an MFC [Serialize](../mfc/reference/cobject-class.md#serialize) function. The essential difference is that for sockets, the archive is attached not to a standard [CFile](../mfc/reference/cfile-class.md) object (typically associated with a disk file) but to a `CSocketFile` object. Rather than connecting to a disk file, the `CSocketFile` object connects to a `CSocket` object. diff --git a/docs/mfc/windows-sockets-in-mfc.md b/docs/mfc/windows-sockets-in-mfc.md index c75929505b3..d63008126b5 100644 --- a/docs/mfc/windows-sockets-in-mfc.md +++ b/docs/mfc/windows-sockets-in-mfc.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets in MFC" title: "Windows Sockets in MFC" ms.date: "11/04/2016" helpviewer_keywords: ["WINSOCK.DLL", "sockets [MFC], programming models", "MFC, Windows Sockets", "Windows Sockets [MFC], MFC support", "Windows Sockets [MFC], programming models", "WSOCK32.DLL", "sockets [MFC], MFC"] -ms.assetid: 1f3c476a-9c68-49fe-9a25-d22971a334d0 --- # Windows Sockets in MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + > [!NOTE] > MFC supports Windows Sockets 1 but does not support [Windows Sockets 2](/windows/win32/WinSock/windows-sockets-start-page-2). Windows Sockets 2 first shipped with Windows 98 and is the version included with Windows 2000. @@ -30,7 +32,7 @@ Creating and using `CSocket` and `CAsyncSocket` objects is described in [Windows ## Windows Sockets DLLs -The Microsoft Windows operating systems supply the Windows Sockets dynamic-link libraries (DLL). Visual C++ supplies the appropriate header files and libraries and the Windows Sockets specification. +The Microsoft Windows operating systems supply the Windows Sockets dynamic-link libraries (DLL). Visual Studio supplies the appropriate header files and libraries and the Windows Sockets specification. For more information about Windows Sockets, see: diff --git a/docs/mfc/windows-sockets-ports-and-socket-addresses.md b/docs/mfc/windows-sockets-ports-and-socket-addresses.md index d4026d95f32..a8de0f7603f 100644 --- a/docs/mfc/windows-sockets-ports-and-socket-addresses.md +++ b/docs/mfc/windows-sockets-ports-and-socket-addresses.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Ports and Socket Addresses" title: "Windows Sockets: Ports and Socket Addresses" ms.date: "11/04/2016" helpviewer_keywords: ["ports [MFC], definition", "Windows Sockets [MFC], ports", "Windows Sockets [MFC], addresses", "ports [MFC]", "addresses [MFC], socket", "sockets [MFC], addresses", "sockets [MFC], ports"] -ms.assetid: e050261a-9285-4f31-a1c5-6c8033af5b4a --- # Windows Sockets: Ports and Socket Addresses +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the terms "port" and "address" as used with Windows Sockets. ## Port diff --git a/docs/mfc/windows-sockets-sequence-of-operations.md b/docs/mfc/windows-sockets-sequence-of-operations.md index cf5c241e016..82a4873c610 100644 --- a/docs/mfc/windows-sockets-sequence-of-operations.md +++ b/docs/mfc/windows-sockets-sequence-of-operations.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Sequence of Operations" title: "Windows Sockets: Sequence of Operations" ms.date: "11/04/2016" helpviewer_keywords: ["Windows Sockets [MFC], operations", "Windows Sockets [MFC], stream sockets", "sockets [MFC], stream sockets", "sockets [MFC], operations", "stream sockets [MFC]"] -ms.assetid: 43ce76f5-aad3-4247-b8a6-16cc7d012796 --- # Windows Sockets: Sequence of Operations +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article illustrates, side by side, the sequence of operations for a server socket and a client socket. Because the sockets use `CArchive` objects, they are necessarily [stream sockets](../mfc/windows-sockets-stream-sockets.md). ## Sequence of Operations for a Stream Socket Communication diff --git a/docs/mfc/windows-sockets-socket-notifications.md b/docs/mfc/windows-sockets-socket-notifications.md index b0119e77c9b..2716daf8e39 100644 --- a/docs/mfc/windows-sockets-socket-notifications.md +++ b/docs/mfc/windows-sockets-socket-notifications.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Socket Notifications" title: "Windows Sockets: Socket Notifications" ms.date: "11/04/2016" helpviewer_keywords: ["Windows Sockets [MFC], notifications", "notifications [MFC], socket", "sockets [MFC], notifications"] -ms.assetid: 87d5bf70-6e77-49a9-9a64-aaadee2ad018 --- # Windows Sockets: Socket Notifications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the notification functions in the socket classes. These member functions are callback functions that the framework calls to notify your socket object of important events. The notification functions are: - [OnReceive](../mfc/reference/casyncsocket-class.md#onreceive): Notifies this socket that there is data in the buffer for it to retrieve by calling [Receive](../mfc/reference/casyncsocket-class.md#receive). diff --git a/docs/mfc/windows-sockets-stream-sockets.md b/docs/mfc/windows-sockets-stream-sockets.md index e87a2ee37f2..30bff346e13 100644 --- a/docs/mfc/windows-sockets-stream-sockets.md +++ b/docs/mfc/windows-sockets-stream-sockets.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Stream Sockets" title: "Windows Sockets: Stream Sockets" ms.date: "11/04/2016" helpviewer_keywords: ["Windows Sockets [MFC], stream sockets", "sockets [MFC], stream sockets", "stream sockets [MFC]"] -ms.assetid: 31faaa34-a995-493f-a30b-b8115293d619 --- # Windows Sockets: Stream Sockets +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes stream sockets, one of the two Windows Socket types available. (The other type is the [datagram socket](../mfc/windows-sockets-datagram-sockets.md).) Stream sockets provide for a data flow without record boundaries: a stream of bytes that can be bidirectional (the application is full duplex: it can both transmit and receive through the socket). Streams can be relied upon to deliver sequenced, unduplicated data. ("Sequenced" means that packets are delivered in the order sent. "Unduplicated" means that you get a particular packet only once.) Receipt of stream messages is guaranteed, and streams are well suited to handling large amounts of data. diff --git a/docs/mfc/windows-sockets-using-class-casyncsocket.md b/docs/mfc/windows-sockets-using-class-casyncsocket.md index 992332b73a9..e4628d00c61 100644 --- a/docs/mfc/windows-sockets-using-class-casyncsocket.md +++ b/docs/mfc/windows-sockets-using-class-casyncsocket.md @@ -6,9 +6,12 @@ helpviewer_keywords: ["CAsyncSocket class [MFC], programming model", "Windows So --- # Windows Sockets: Using Class `CAsyncSocket` +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how to use class [`CAsyncSocket`](reference/casyncsocket-class.md). This class encapsulates the Windows Sockets API at a very low level. `CAsyncSocket` is for use by programmers who know network communications in detail but want the convenience of callbacks for notification of network events. Based on this assumption, this article provides only basic instruction. You should probably consider using `CAsyncSocket` if you want Windows Sockets' ease of dealing with multiple network protocols in an MFC application but don't want to sacrifice flexibility. You might also feel that you can get better efficiency by programming the communications more directly yourself than you could using the more general alternative model of class `CSocket`. -`CAsyncSocket` is documented in the *MFC Reference*. Visual C++ also supplies the Windows Sockets specification, located in the Windows SDK. The details are left to you. Visual C++ doesn't supply a sample application for `CAsyncSocket`. +`CAsyncSocket` is documented in the *MFC Reference*. Visual Studio also supplies the Windows Sockets specification, located in the Windows SDK. The details are left to you. Visual Studio doesn't supply a sample application for `CAsyncSocket`. If you aren't highly knowledgeable about network communications and want a simple solution, use class [`CSocket`](reference/csocket-class.md) with a `CArchive` object. See [Windows Sockets: Using Sockets with Archives](windows-sockets-using-sockets-with-archives.md) for more information. diff --git a/docs/mfc/windows-sockets-using-sockets-with-archives.md b/docs/mfc/windows-sockets-using-sockets-with-archives.md index cd35be2b053..139a4bfd6be 100644 --- a/docs/mfc/windows-sockets-using-sockets-with-archives.md +++ b/docs/mfc/windows-sockets-using-sockets-with-archives.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets: Using Sockets with Archives" title: "Windows Sockets: Using Sockets with Archives" ms.date: "11/04/2016" helpviewer_keywords: ["Windows Sockets [MFC], archives", "sockets [MFC], with archives", "archives [MFC], and Windows Sockets", "CSocket class [MFC], programming model"] -ms.assetid: 17e71a99-a09e-4e1a-9fda-13d62805c824 --- # Windows Sockets: Using Sockets with Archives +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article describes the [CSocket programming model](#_core_the_csocket_programming_model). Class [CSocket](../mfc/reference/csocket-class.md) supplies socket support at a higher level of abstraction than does class [CAsyncSocket](../mfc/reference/casyncsocket-class.md). `CSocket` uses a version of the MFC serialization protocol to pass data to and from a socket object through an MFC [CArchive](../mfc/reference/carchive-class.md) object. `CSocket` provides blocking (while managing background processing of Windows messages) and gives you access to `CArchive`, which manages many aspects of the communication that you would have to do yourself using either the raw API or class `CAsyncSocket`. > [!TIP] diff --git a/docs/mfc/windows-sockets.md b/docs/mfc/windows-sockets.md index 5459fe65933..04568103ca6 100644 --- a/docs/mfc/windows-sockets.md +++ b/docs/mfc/windows-sockets.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows Sockets" title: "Windows Sockets" ms.date: "11/04/2016" helpviewer_keywords: ["sockets [MFC], Windows sockets", "networks [MFC], Windows Sockets", "programming [MFC], network", "sockets [MFC]", "Windows Sockets [MFC]"] -ms.assetid: c077ec53-540d-4bfb-a1e0-bd6482ab9e19 --- # Windows Sockets +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This family of articles covers the MFC implementation of Windows Sockets. MFC supplies two classes to support programming network applications with the Windows Sockets API. Class [CAsyncSocket](../mfc/reference/casyncsocket-class.md) encapsulates the Windows Sockets API one for one, giving advanced network programmers the most power and flexibility. Class [CSocket](../mfc/reference/csocket-class.md) provides a simplified interface for serializing data to and from a [CArchive](../mfc/reference/carchive-class.md) object. ## In This Section diff --git a/docs/mfc/windows.md b/docs/mfc/windows.md index b8c0f5aee20..92c62e35331 100644 --- a/docs/mfc/windows.md +++ b/docs/mfc/windows.md @@ -3,10 +3,12 @@ description: "Learn more about: Windows" title: "Windows" ms.date: "11/04/2016" helpviewer_keywords: ["objects [MFC], window", "windows [MFC]", "MFC, windows", "window objects [MFC], MFC Framework"] -ms.assetid: dd92bf34-842e-40fe-8aea-3028b55314d5 --- # Windows +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This family of articles covers window objects in the MFC framework. All MFC windows derive from class [CWnd](../mfc/reference/cwnd-class.md), including frame windows, views, dialog boxes, and controls. The first group of articles describes [window objects](../mfc/window-objects.md) in general. Refer to this group for general information about C++ window objects, how they encapsulate an `HWND`, and how you use them when creating your own windows, such as child windows. diff --git a/docs/mfc/wininet-basics.md b/docs/mfc/wininet-basics.md index 8dc432382e0..57b100acb73 100644 --- a/docs/mfc/wininet-basics.md +++ b/docs/mfc/wininet-basics.md @@ -3,10 +3,12 @@ description: "Learn more about: WinInet Basics" title: "WinInet Basics" ms.date: "11/04/2016" helpviewer_keywords: ["OnStatusCallback method [MFC]", "WinInet classes [MFC], displaying progress", "WinInet classes [MFC], about WinInet classes"] -ms.assetid: 665de5ac-e80d-427d-8d91-2ae466885940 --- # WinInet Basics +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + You can use WinInet to add FTP support to download and upload files from within your application. You can override [OnStatusCallback](../mfc/reference/cinternetsession-class.md#onstatuscallback) and use the *dwContext* parameter to provide progress information to users as you search for and download files. This article contains the following topics: diff --git a/docs/mfc/wizards-and-the-resource-editors.md b/docs/mfc/wizards-and-the-resource-editors.md index daf62848239..d7b409d03e4 100644 --- a/docs/mfc/wizards-and-the-resource-editors.md +++ b/docs/mfc/wizards-and-the-resource-editors.md @@ -3,15 +3,17 @@ description: "Learn more about: Wizards and the Resource Editors" title: "Wizards and the Resource Editors" ms.date: "11/04/2016" helpviewer_keywords: ["application wizards [MFC], and MFC", "MFC, resource editors", "resource editors, MFC", "MFC Application Wizard", "editors [MFC], resource", "wizards [MFC]", "wizards [MFC], MFC programming", "MFC, wizards", "Class View tool, managing Windows messages"] -ms.assetid: f5dd4d13-9dc1-4a49-b6bf-5b3cb45fa8ba --- # Wizards and the Resource Editors -Visual C++ includes several wizards for use in MFC programming, along with many integrated resource editors. For ActiveX controls programming, the [ActiveX Control Wizard](../mfc/reference/mfc-activex-control-wizard.md) serves a purpose much like that of the MFC Application Wizard. While you can write MFC applications without most of these tools, the tools greatly simplify and speed your work. +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + +Visual Studio includes several wizards for use in MFC programming, along with many integrated resource editors. For ActiveX controls programming, the [ActiveX Control Wizard](../mfc/reference/mfc-activex-control-wizard.md) serves a purpose much like that of the MFC Application Wizard. While you can write MFC applications without most of these tools, the tools greatly simplify and speed your work. ## Use the MFC Application Wizard to Create an MFC Application -Use the [MFC Application Wizard](../mfc/reference/mfc-application-wizard.md) to create an MFC project in Visual C++, which can include OLE and database support. Files in the project contain your application, document, view, and frame-window classes; standard resources, including menus and an optional toolbar; other required Windows files; and optional .rtf files containing standard Windows Help topics that you can revise and augment to create your program's help file. +Use the [MFC Application Wizard](../mfc/reference/mfc-application-wizard.md) to create an MFC project in Visual Studio, which can include OLE and database support. Files in the project contain your application, document, view, and frame-window classes; standard resources, including menus and an optional toolbar; other required Windows files; and optional .rtf files containing standard Windows Help topics that you can revise and augment to create your program's help file. ## Use Class View to Manage Classes and Windows Messages @@ -30,11 +32,11 @@ The [Class Wizard](reference/mfc-class-wizard.md) will create empty message-hand ## Use the Resource Editors to Create and Edit Resources -Use the Visual C++ [resource editors](../windows/resource-editors.md) to create and edit menus, dialog boxes, custom controls, accelerator keys, bitmaps, icons, cursors, strings, and version resources. As of Visual C++ version 4.0, a toolbar editor makes creating toolbars much easier. +Use the Visual Studio [resource editors](../windows/resource-editors.md) to create and edit menus, dialog boxes, custom controls, accelerator keys, bitmaps, icons, cursors, strings, and version resources. As of Visual Studio version 4.0, a toolbar editor makes creating toolbars much easier. To help you even more, the Microsoft Foundation Class Library provides a file called COMMON.RES, which contains "clip art" resources that you can copy from COMMON.RES and paste into your own resource file. COMMON.RES includes toolbar buttons, common cursors, icons, and more. You can use, modify, and redistribute these resources in your application. For more information about COMMON.RES, see the [Clipart sample](../overview/visual-cpp-samples.md). -The MFC Application Wizard, the Visual C++ wizards, resource editors, and the MFC framework do a lot of work for you and make managing your code much easier. The bulk of your application-specific code is in your document and view classes. +The MFC Application Wizard, the Visual Studio wizards, resource editors, and the MFC framework do a lot of work for you and make managing your code much easier. The bulk of your application-specific code is in your document and view classes. ## See also diff --git a/docs/mfc/word-breaks-in-rich-edit-controls.md b/docs/mfc/word-breaks-in-rich-edit-controls.md index c4bd94e11bb..860a8188dac 100644 --- a/docs/mfc/word-breaks-in-rich-edit-controls.md +++ b/docs/mfc/word-breaks-in-rich-edit-controls.md @@ -3,10 +3,12 @@ description: "Learn more about: Word Breaks in Rich Edit Controls" title: "Word Breaks in Rich Edit Controls" ms.date: "11/04/2016" helpviewer_keywords: ["CRichEditCtrl class [MFC], word breaks in", "word breaks", "breaking words in CRichEditCtrl", "rich edit controls [MFC], word breaks in"] -ms.assetid: 641dcf9e-7b40-4dc0-85f7-575a8c142f73 --- # Word Breaks in Rich Edit Controls +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + A rich edit control ([CRichEditCtrl](../mfc/reference/cricheditctrl-class.md)) calls a function called a "word break procedure" to find breaks between words and to determine where it can break lines. The control uses this information when performing word-wrap operations and when processing the CTRL+LEFT and CTRL+RIGHT key combinations. An application can send messages to a rich edit control to replace the default word-break procedure, to retrieve word-break information, and to determine what line a given character falls on. ## See also diff --git a/docs/mfc/working-with-a-header-control.md b/docs/mfc/working-with-a-header-control.md index 1cd98c32b13..d08784122db 100644 --- a/docs/mfc/working-with-a-header-control.md +++ b/docs/mfc/working-with-a-header-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Working with a Header Control" title: "Working with a Header Control" ms.date: "11/04/2016" helpviewer_keywords: ["header controls [MFC], working with", "header controls"] -ms.assetid: af3afb5c-bf97-451b-8fee-3adcb8257210 ms.topic: concept-article --- # Working with a Header Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The easy way to use a header control ([CHeaderCtrl](../mfc/reference/cheaderctrl-class.md)) is in conjunction with a list control; see [Using CListCtrl](../mfc/using-clistctrl.md) later in this topic family. You can also use a header control by itself. MFC calls `InitCommonControls` for you. The key tasks are as follows: - [Creating the header control](../mfc/creating-the-header-control.md) diff --git a/docs/mfc/working-with-a-tab-control.md b/docs/mfc/working-with-a-tab-control.md index e730f954acd..6e7adf73b88 100644 --- a/docs/mfc/working-with-a-tab-control.md +++ b/docs/mfc/working-with-a-tab-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Working with a Tab Control" title: "Working with a Tab Control" ms.date: "11/04/2016" helpviewer_keywords: ["CTabCtrl class [MFC], using", "tab controls [MFC], working with", "tab controls [MFC], using"] -ms.assetid: 819488e3-4944-44b7-9483-195edb8e0aed ms.topic: concept-article --- # Working with a Tab Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The easiest way to use a tab control ([CTabCtrl](../mfc/reference/ctabctrl-class.md)) is by adding it to a dialog template resource with the dialog editor. You can also use a tab control by itself. MFC calls `InitCommonControls` for you. The key tasks are as follows: - [Creating the tab control](../mfc/creating-the-tab-control.md) diff --git a/docs/mfc/working-with-the-toolbar-control.md b/docs/mfc/working-with-the-toolbar-control.md index 486ff79f32e..ed5fe057c34 100644 --- a/docs/mfc/working-with-the-toolbar-control.md +++ b/docs/mfc/working-with-the-toolbar-control.md @@ -3,11 +3,13 @@ description: "Learn more about: Working with the Toolbar Control" title: "Working with the Toolbar Control" ms.date: "11/04/2016" helpviewer_keywords: ["GetToolBarCtrl method [MFC]", "toolbars [MFC], accessing common control", "CToolBarCtrl class [MFC], accessing toolbar", "toolbar controls [MFC], accessing"] -ms.assetid: b19409d5-3831-42c7-80ae-195c49dc9085 ms.topic: how-to --- # Working with the Toolbar Control +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains how you can access the [CToolBarCtrl](../mfc/reference/ctoolbarctrl-class.md) object underlying a [CToolBar](../mfc/reference/ctoolbar-class.md) for greater control over your toolbars. This is an advanced topic. ## Procedures diff --git a/docs/mfc/working-with-window-objects.md b/docs/mfc/working-with-window-objects.md index 55547aac560..2630a6af645 100644 --- a/docs/mfc/working-with-window-objects.md +++ b/docs/mfc/working-with-window-objects.md @@ -3,11 +3,13 @@ description: "Learn more about: Working with Window Objects" title: "Working with Window Objects" ms.date: "11/04/2016" helpviewer_keywords: ["child windows [MFC], working with", "window objects [MFC], working with"] -ms.assetid: f73aa254-90e3-46a9-8e9b-d78b7054a331 ms.topic: concept-article --- # Working with Window Objects +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + Working with windows calls for two kinds of activity: - Handling Windows messages diff --git a/docs/mfc/writing-an-internet-client-application-using-mfc-wininet-classes.md b/docs/mfc/writing-an-internet-client-application-using-mfc-wininet-classes.md index 89176ac68ec..339dc335a7b 100644 --- a/docs/mfc/writing-an-internet-client-application-using-mfc-wininet-classes.md +++ b/docs/mfc/writing-an-internet-client-application-using-mfc-wininet-classes.md @@ -3,11 +3,13 @@ description: "Learn more about: Writing an Internet Client Application Using MFC title: "Writing an Internet Client Application Using MFC WinInet Classes" ms.date: "11/04/2016" helpviewer_keywords: ["Internet client applications [MFC]", "WinInet classes [MFC], programming", "Internet client applications [MFC], writing", "Internet applications [MFC], WinInet", "Internet applications [MFC], client applications", "MFC, Internet applications"] -ms.assetid: a2c4a40c-a94e-4b3e-9dbf-f8a8dc8e5428 ms.topic: concept-article --- # Writing an Internet Client Application Using MFC WinInet Classes +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The basis of every Internet client application is the Internet session. MFC implements Internet sessions as objects of class [CInternetSession](../mfc/reference/cinternetsession-class.md). Using this class, you can create one Internet session or several simultaneous sessions. To communicate with a server, you need a [CInternetConnection](../mfc/reference/cinternetconnection-class.md) object as well as a `CInternetSession`. You can create a `CInternetConnection` by using [CInternetSession::GetFtpConnection](../mfc/reference/cinternetsession-class.md#getftpconnection), [CInternetSession::GetHttpConnection](../mfc/reference/cinternetsession-class.md#gethttpconnection), or [CInternetSession::GetGopherConnection](../mfc/reference/cinternetsession-class.md#getgopherconnection). Each of these calls is specific to the protocol type. These calls do not open a file on the server for reading or writing. If you intend to read or write data, you must open the file as a separate step. diff --git a/docs/mfc/writing-mfc-applications.md b/docs/mfc/writing-mfc-applications.md index abb166fc975..b42cbf62a52 100644 --- a/docs/mfc/writing-mfc-applications.md +++ b/docs/mfc/writing-mfc-applications.md @@ -3,11 +3,13 @@ description: "Learn more about: Writing MFC Applications" title: "Writing MFC Applications" ms.date: "09/12/2018" helpviewer_keywords: ["Internet applications [MFC], MFC", "MFC, Internet applications", "application wizards [MFC], Internet applications", "MFC, application development"] -ms.assetid: 6a8d8a03-abfa-4976-86c2-c5773a4b7179 ms.topic: concept-article --- # Writing MFC Applications +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + This article explains the initial steps you take to develop your application. First, you must decide what kind of application you are writing. Several of the choices were discussed in [Application Design Choices](../mfc/application-design-choices.md). Will your application be: - Running on the Internet or an intranet diff --git a/docs/overview/compiler-versions.md b/docs/overview/compiler-versions.md index b167daf2351..a51e9795b8e 100644 --- a/docs/overview/compiler-versions.md +++ b/docs/overview/compiler-versions.md @@ -1,14 +1,14 @@ --- -description: "Learn more about Microsoft Visual C++ compiler versioning." -title: "Microsoft Visual C++ compiler versioning (Visual C++)" -ms.date: 02/12/2025 +description: "Learn more about Microsoft C++ compiler versioning." +title: "Microsoft C++ (MSVC) compiler versioning" +ms.date: 05/12/2026 ms.service: "visual-cpp" ms.subservice: "tools" helpviewer_keywords: ["Visual C++, platforms supported", "platforms [C++]"] --- -# Microsoft Visual C++ compiler versioning +# Microsoft C++ (MSVC) compiler versioning -The Microsoft Visual C++ compiler version consists of four fields: +The Microsoft C++ (MSVC) compiler version consists of four fields: M - major version (two digits)\ N - minor version (two digits)\ @@ -33,9 +33,111 @@ The macros reflect these values like this: - `_MSC_BUILD` (the revision) is 0. >[!Note] ->Visual Studio 2019 16.8 and 16.9 share the same major and minor versions, and so have the same value for `_MSC_VER`. As do Visual Studio 2019 16.10 and 16.11. To distinguish them, use `_MSC_FULL_VER` as described in [Service releases starting with Visual Studio 2017](#service-releases-starting-with-visual-studio-2017). +>Visual Studio 2019 versions 16.8 and 16.9 share the same major and minor versions, and so have the same value for `_MSC_VER`. As do Visual Studio 2019 versions 16.10 and 16.11. To distinguish them, use `_MSC_FULL_VER` as described in [Service releases starting with Visual Studio 2017](#service-releases-starting-with-visual-studio-2017). -## A brief history of Visual C++ compiler versioning +## Visual Studio channels + +All MSVC Build Tools are available through the Visual Studio Installer. + +The [Visual Studio Stable Channel](https://visualstudio.microsoft.com) gets monthly updates and includes the latest supported MSVC Build Tools. The [Visual Studio Insiders Channel](https://visualstudio.microsoft.com/insiders) updates more often, so you can try upcoming MSVC changes sooner. For more information about the release cadence, see [Visual Studio 2026 release rhythm](/visualstudio/releases/2026/release-rhythm) and [Visual Studio Insiders release notes](/visualstudio/releases/2026/release-notes-insiders). + +Each Visual Studio update receives updates to all of the MSVC build toolsets: +- The **preview** toolset receives new features and fixes that the development team completed since the previous update. +- The **default** and **older in-support** toolsets receive only targeted bug fixes. + +Visual Studio Insiders users get early access to MSVC releases: +- On the Insiders Channel, preview toolsets update approximately weekly. +- On the Insiders Channel, new toolsets are available as release candidates about a month before they reach the Stable Channel, giving Insiders users time to validate the toolset and report issues. + +### Install specific MSVC toolsets + +- To install only the default MSVC toolset, install the `Desktop development with C++` workload. +- To install the preview toolset, run the Visual Studio Installer and select **MSVC Build Tools for <arch> (Preview)**. For more information, see [MSVC Build Tools Preview](https://aka.ms/msvc/preview). +- To install an older in-support 14.5x toolset, run the Visual Studio Installer, open the **Individual Components** tab, and select the specific 14.5x toolset. +- To restore a previously installed toolset after an upgrade—for example, when 14.50 is replaced by 14.51—add the older toolset back from the **Individual Components** tab. +- To install only the Build Tools without the full Visual Studio IDE, use the [Visual Studio Stable Build Tools SKU](https://aka.ms/vs/stable/vs_BuildTools.exe). +- Some out-of-support toolsets (labeled **(Out of support)**) may also be available in the Visual Studio Installer. These toolsets don't receive any updates and may be removed in the future. We strongly recommend moving to a supported version. + +## Version macros + +Recall that the version number consists of four fields: + +M - major version (two digits)\ +N - minor version (two digits)\ +B - build version (five digits)\ +R - revision version + +**[`_MSC_VER`](../preprocessor/predefined-macros.md)** distinguishes between major and minor releases. It has the form: MMNN. + +**[`_MSC_FULL_VER`](../preprocessor/predefined-macros.md)** represents the major, minor, and build version of the compiler. It has the form: MMNNBBBBB. Use it to distinguish between different versions of the compiler, including servicing releases. For more information about Visual Studio 2019 versions 16.8, 16.9, 16.10 and 16.11, see [Service releases starting with Visual Studio 2017](#service-releases-starting-with-visual-studio-2017). + +**[`_MSC_BUILD`](../preprocessor/predefined-macros.md)** represents the revision version of the compiler. It has the form: R. Use it to distinguish between compiler revisions. + +When the major version changed between Visual Studio 2013 and Visual Studio 2015, `_MSC_VER` reflected the change by going from 1800 to 1900. + +An example of a minor change is from Visual Studio 2022 version 17.1 to Visual Studio 2022 version 17.2. In that case, `_MSC_VER` changed from 1931 to 1932. + +The following table lists the Visual Studio version that corresponds to each MSVC compiler (`_MSC_VER`) and MSVC Build Tools release, together with support status. EOL means end of life. + +| Visual Studio version | `_MSC_VER` | MSVC Build Tools version | Support | More info | +|--|--|--|--|--| +| Visual Studio 6.0 | 1200 | 6.0 | EOL | [Visual Studio lifecycle policy](/visualstudio/releases/2026/servicing-vs#support-for-older-versions) | +| Visual Studio .NET 2002 (7.0) | 1300 | 7.0 | EOL | [Visual Studio lifecycle policy](/visualstudio/releases/2026/servicing-vs#support-for-older-versions) | +| Visual Studio .NET 2003 (7.1) | 1310 | 7.1 | EOL | [Visual Studio lifecycle policy](/visualstudio/releases/2026/servicing-vs#support-for-older-versions) | +| Visual Studio 2005 (8.0) | 1400 | 8.0 | EOL | [Visual Studio lifecycle policy](/visualstudio/releases/2026/servicing-vs#support-for-older-versions) | +| Visual Studio 2008 (9.0) | 1500 | 9.0 | EOL | [Visual Studio lifecycle policy](/visualstudio/releases/2026/servicing-vs#support-for-older-versions) | +| Visual Studio 2010 (10.0) | 1600 | 10.0 | EOL | [Visual Studio lifecycle policy](/visualstudio/releases/2026/servicing-vs#support-for-older-versions) | +| Visual Studio 2012 (11.0) | 1700 | 11.0 | EOL | [Visual Studio lifecycle policy](/visualstudio/releases/2026/servicing-vs#support-for-older-versions) | +| Visual Studio 2013 (12.0) | 1800 | 12.0 | EOL | [Visual Studio lifecycle policy](/visualstudio/releases/2026/servicing-vs#support-for-older-versions) | +| Visual Studio 2015 (14.0) | 1900 | 14.0 | EOL | [Visual Studio lifecycle policy](/visualstudio/releases/2026/servicing-vs#support-for-older-versions) | +| Visual Studio 2017 RTW (15.0) | 1910 | 14.10 | EOL | [Visual Studio 2017 lifecycle](/lifecycle/products/visual-studio-2017) | +| Visual Studio 2017 version 15.3 | 1911 | 14.11 | EOL | [Visual Studio 2017 lifecycle](/lifecycle/products/visual-studio-2017) | +| Visual Studio 2017 version 15.5 | 1912 | 14.12 | EOL | [Visual Studio 2017 lifecycle](/lifecycle/products/visual-studio-2017) | +| Visual Studio 2017 version 15.6 | 1913 | 14.13 | EOL | [Visual Studio 2017 lifecycle](/lifecycle/products/visual-studio-2017) | +| Visual Studio 2017 version 15.7 | 1914 | 14.14 | EOL | [Visual Studio 2017 lifecycle](/lifecycle/products/visual-studio-2017) | +| Visual Studio 2017 version 15.8 | 1915 | 14.15 | EOL | [Visual Studio 2017 lifecycle](/lifecycle/products/visual-studio-2017) | +| Visual Studio 2017 version 15.9 | 1916 | 14.16 | Apr 13, 2027 | [Visual Studio 2017 lifecycle](/lifecycle/products/visual-studio-2017) | +| Visual Studio 2019 RTW (16.0) | 1920 | 14.20 | EOL | [Visual Studio 2019 lifecycle](/lifecycle/products/visual-studio-2019) | +| Visual Studio 2019 version 16.1 | 1921 | 14.21 | EOL | [Visual Studio 2019 lifecycle](/lifecycle/products/visual-studio-2019) | +| Visual Studio 2019 version 16.2 | 1922 | 14.22 | EOL | [Visual Studio 2019 lifecycle](/lifecycle/products/visual-studio-2019) | +| Visual Studio 2019 version 16.3 | 1923 | 14.23 | EOL | [Visual Studio 2019 lifecycle](/lifecycle/products/visual-studio-2019) | +| Visual Studio 2019 version 16.4 | 1924 | 14.24 | EOL | [Visual Studio 2019 lifecycle](/lifecycle/products/visual-studio-2019) | +| Visual Studio 2019 version 16.5 | 1925 | 14.25 | EOL | [Visual Studio 2019 lifecycle](/lifecycle/products/visual-studio-2019) | +| Visual Studio 2019 version 16.6 | 1926 | 14.26 | EOL | [Visual Studio 2019 lifecycle](/lifecycle/products/visual-studio-2019) | +| Visual Studio 2019 version 16.7 | 1927 | 14.27 | EOL | [Visual Studio 2019 lifecycle](/lifecycle/products/visual-studio-2019) | +| Visual Studio 2019 version 16.8, 16.9 a | 1928 | 14.28 | EOL | [Visual Studio 2019 lifecycle](/lifecycle/products/visual-studio-2019) | +| Visual Studio 2019 version 16.10, 16.11 b | 1929 | 14.29 | Apr 10, 2029 | [Visual Studio 2019 lifecycle](/lifecycle/products/visual-studio-2019) | +| Visual Studio 2022 RTW 17.0 | 1930 | 14.30 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.1 | 1931 | 14.31 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.2 | 1932 | 14.32 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.3 | 1933 | 14.33 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.4 | 1934 | 14.34 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.5 | 1935 | 14.35 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.6 | 1936 | 14.36 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.7 | 1937 | 14.37 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.8 | 1938 | 14.38 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.9 | 1939 | 14.39 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.10 | 1940 | 14.40 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.11 | 1941 | 14.41 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.12 | 1942 | 14.42 | Jul 14, 2026 | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.13 | 1943 | 14.43 | EOL | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | +| Visual Studio 2022 version 17.14 | 1944 | 14.44 | Jan 13, 2032 | [Visual Studio 2022 lifecycle](/lifecycle/products/visual-studio-2022) | + +The following table lists MSVC Build Tools versions for Visual Studio 2026 and later. Starting with Visual Studio 2026, MSVC versioning is decoupled from Visual Studio versioning. EOL (end of life) dates are defined by the [MSVC lifecycle policy](https://aka.ms/msvc/lifecycle). + +| MSVC Build Tools version | `_MSC_VER` | Support | EOL date | More info | +|--|--|--|--|--| +| 14.50 | 1950 | Long-term | Nov 2028 | [What's New for C++ developers in Visual Studio 2026 version 18.0](https://devblogs.microsoft.com/cppblog/whats-new-for-cpp-developers-in-visual-studio-2026-version-18-0/) | +| 14.51 | 1951 | Standard | Feb 2027 | [MSVC lifecycle policy](https://aka.ms/msvc/lifecycle) | +| 14.52 | 1952 | Standard | Previewc | [MSVC lifecycle policy](https://aka.ms/msvc/lifecycle) | + +a Visual Studio 2019 versions 16.8 and 16.9 share the same major and minor versions (and so have the same value for `_MSC_VER`). To distinguish them, use `_MSC_FULL_VER`. The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 version 16.8 is 192829333. The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 version 16.9 is 192829910. + +b Visual Studio 2019 versions 16.10 and 16.11 share the same major and minor versions (and so have the same value for `_MSC_VER`). To distinguish them, use `_MSC_FULL_VER`. The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 version 16.10 is 192929917. The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 version 16.11 is 192930129. + +c MSVC Build Tools version 14.52 is in preview. The EOL date will be established upon general availability. + +## A brief history of Microsoft C++ compiler versioning ### Visual Studio 6.0 through Visual Studio 2015 (14.0) @@ -45,89 +147,45 @@ The macros reflect these values like this: >[!Note] > Visual Studio .NET 2003 was considered a minor release. -### Visual Studio 2017 and later +### Visual Studio 2017 to Visual Studio 2022 - For major releases, the minor version increases by 10. - For minor releases, the minor version increases by 1 starting with Visual Studio 2017 version 15.3. -### Service releases starting with Visual Studio 2017 +### Visual Studio 2026 and later -Servicing releases are distinguished by `_MSC_FULL_VER`. The build field (the BBBBB in the MMNNBBBBB version number) typically increases by 1. +The MSVC build tools that ship with Visual Studio 2026 and later start at version 14.50, and `_MSC_VER` starts at 1950. A new MSVC version—14.51/1951, 14.52/1952, and so on, ships every six months. Support follows the [MSVC lifecycle policy](https://aka.ms/msvc/lifecycle). -For example, two cases where `_MSC_FULL_VER` is useful is to distinguish Visual Studio 2019 16.8 from 16.9, and Visual Studio 2019 16.10 from 16.11. That's because those versions share the same major and minor versions, and so have the same value for `_MSC_VER`. +This versioning system differs from earlier Visual Studio releases because MSVC versioning is now separate from Visual Studio versioning. That means the compiler minor version can stay the same across multiple Visual Studio updates. -To distinguish these versions, use `_MSC_FULL_VER`.\ -The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 16.8 is 192829333.\ -The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 16.9 is 192829910. +At any given time, the Visual Studio Installer can offer several MSVC versions: -## Version macros +- A preview toolset with the newest changes +- The current default toolset +- Earlier toolsets that are still in support -Recall that the version number consists of four fields: +For example, as of May 2026: -M - major version (two digits)\ -N - minor version (two digits)\ -B - build version (five digits)\ -R - revision version +- **14.52** is the preview toolset and gets regular feature and fix updates. +- **14.51** is the default toolset released in May 2026, with 9 months of support. +- **14.50** is the toolset released in November 2025, with 3 years of support. -**[`_MSC_VER`](../preprocessor/predefined-macros.md)** distinguishes between major and minor releases. It has the form: MMNN. +By November 2026, we expect **14.53** to become the new preview toolset, **14.52** to become the default toolset, and **14.51** and **14.50** to remain in support under the [MSVC lifecycle policy](https://aka.ms/msvc/lifecycle). -**[`_MSC_FULL_VER`](../preprocessor/predefined-macros.md)** represents the major, minor, and build version of the compiler. It has the form: MMNNBBBBB. Use it to distinguish between different versions of the compiler, including servicing releases. For more information about Visual Studio 2019 16.8, 16.9, 16.10 and 16.11, see [Service releases starting with Visual Studio 2017](#service-releases-starting-with-visual-studio-2017). +Microsoft changed to this model for three reasons: +- It shortens the time between MSVC feature development and preview availability from months to a week or so. +- It keeps the MSVC release cadence aligned with Visual Studio and long-term servicing releases aligned with .NET Long Term Support (LTS) releases. +- It reduces the complexity of servicing older compilers. -**[`_MSC_BUILD`](../preprocessor/predefined-macros.md)** represents the build version of the compiler. It has the form: R. Use it to distinguish between servicing releases. +### Service releases starting with Visual Studio 2017 -When the major version changed between Visual Studio 2013 and Visual Studio 2015, `_MSC_VER` reflected the change by going from 1800 to 1900. +Use `_MSC_FULL_VER` to distinguish servicing releases. The build field (the BBBBB in the MMNNBBBBB version number) typically increases by 1. -An example of a minor change is from Visual Studio 2022 17.1 to Visual Studio 2022 17.2. In that case, `_MSC_VER` changed from 1931 to 1932. - -The following table lists the Visual Studio version corresponding to each Visual C++ compiler (`_MSC_VER`) and MSVC toolset release: - -| Visual Studio version | `_MSC_VER` | MSVC toolset version | -|--|--|--| -| Visual Studio 6.0 | 1200 | 6.0 | -| Visual Studio .NET 2002 (7.0) | 1300 | 7.0 | -| Visual Studio .NET 2003 (7.1) | 1310 | 7.1 | -| Visual Studio 2005 (8.0) | 1400 | 8.0 | -| Visual Studio 2008 (9.0) | 1500 | 9.0 | -| Visual Studio 2010 (10.0) | 1600 | 10.0 | -| Visual Studio 2012 (11.0) | 1700 | 11.0 | -| Visual Studio 2013 (12.0) | 1800 | 12.0 | -| Visual Studio 2015 (14.0) | 1900 | 14.0 | -| Visual Studio 2017 RTW (15.0) | 1910 | 14.10 | -| Visual Studio 2017 version 15.3 | 1911 | 14.11 | -| Visual Studio 2017 version 15.5 | 1912 | 14.12 | -| Visual Studio 2017 version 15.6 | 1913 | 14.13 | -| Visual Studio 2017 version 15.7 | 1914 | 14.14 | -| Visual Studio 2017 version 15.8 | 1915 | 14.15 | -| Visual Studio 2017 version 15.9 | 1916 | 14.16 | -| Visual Studio 2019 RTW 16.0 | 1920 | 14.20 | -| Visual Studio 2019 version 16.1 | 1921 | 14.21 | -| Visual Studio 2019 version 16.2 | 1922 | 14.22 | -| Visual Studio 2019 version 16.3 | 1923 | 14.23 | -| Visual Studio 2019 version 16.4 | 1924 | 14.24 | -| Visual Studio 2019 version 16.5 | 1925 | 14.25 | -| Visual Studio 2019 version 16.6 | 1926 | 14.26 | -| Visual Studio 2019 version 16.7 | 1927 | 14.27 | -| Visual Studio 2019 version 16.8, 16.9 a | 1928 | 14.28 | -| Visual Studio 2019 version 16.10, 16.11 b | 1929 | 14.29 | -| Visual Studio 2022 RTW 17.0 | 1930 | 14.30 | -| Visual Studio 2022 version 17.1 | 1931 | 14.31 | -| Visual Studio 2022 version 17.2 | 1932 | 14.32 | -| Visual Studio 2022 version 17.3 | 1933 | 14.33 | -| Visual Studio 2022 version 17.4 | 1934 | 14.34 | -| Visual Studio 2022 version 17.5 | 1935 | 14.35 | -| Visual Studio 2022 version 17.6 | 1936 | 14.36 | -| Visual Studio 2022 version 17.7 | 1937 | 14.37 | -| Visual Studio 2022 version 17.8 | 1938 | 14.38 | -| Visual Studio 2022 version 17.9 | 1939 | 14.39 | -| Visual Studio 2022 version 17.10 | 1940 | 14.40 | -| Visual Studio 2022 version 17.11 | 1941 | 14.41 | -| Visual Studio 2022 version 17.12 | 1942 | 14.42 | -| Visual Studio 2022 version 17.13 | 1943 | 14.43 | -| Visual Studio 2022 version 17.14 | 1944 | 14.44 | - -a Visual Studio 2019 16.8 and 16.9 share the same major and minor versions (and so have the same value for `_MSC_VER`). To distinguish them, use `_MSC_FULL_VER`. The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 16.8 is 192829333. The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 16.9 is 192829910. - -b Visual Studio 2019 16.10 and 16.11 share the same major and minor versions (and so have the same value for `_MSC_VER`). To distinguish them, use `_MSC_FULL_VER`. The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 16.10 is 192929917. The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 16.11 is 192930129. +For example, `_MSC_FULL_VER` is useful to distinguish Visual Studio 2019 version 16.8 from 16.9, and Visual Studio 2019 version 16.10 from 16.11. Those versions share the same major and minor versions, so they have the same value for `_MSC_VER`. + +To distinguish these versions, use `_MSC_FULL_VER`.\ +The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 version 16.8 is 192829333.\ +The minimum value of `_MSC_FULL_VER` for Visual Studio 2019 version 16.9 is 192829910. ## See also diff --git a/docs/overview/cpp-conformance-improvements-2017.md b/docs/overview/cpp-conformance-improvements-2017.md index 84382c2a25b..72c38c1e4ae 100644 --- a/docs/overview/cpp-conformance-improvements-2017.md +++ b/docs/overview/cpp-conformance-improvements-2017.md @@ -7,7 +7,7 @@ ms.subservice: "cpp-lang" --- # C++ Conformance improvements, behavior changes, and bug fixes in Visual Studio 2017 -Microsoft C/C++ in Visual Studio (MSVC) makes conformance improvements and bug fixes in every release. This article lists the improvements by major release, then by version. To jump directly to the changes for a specific version, use list below **In this article**. +Microsoft C/C++ in Visual Studio (MSVC) makes conformance improvements and bug fixes in every release. This article lists the improvements by major release, then by version. To jump directly to the changes for a specific version, use the list below **In this article**. This document lists the changes in Visual Studio 2017. For a guide to the changes in Visual Studio 2022, see [C++ conformance improvements in Visual Studio 2022](cpp-conformance-improvements.md). For a guide to the changes in Visual Studio 2019, see [C++ conformance improvements in Visual Studio 2019](cpp-conformance-improvements-2019.md). For a complete list of previous conformance improvements, see [Visual C++ What's New 2003 through 2015](../porting/visual-cpp-what-s-new-2003-through-2015.md). @@ -611,7 +611,7 @@ To fix the warning, put `extern "C"` first: extern "C" __declspec(noinline) HRESULT __stdcall ``` -This warning is off by default in Visual Studio 2017 version 15.3, and only impacts code compiled with **`/Wall`** **`/WX`**. Starting in Visual Studio 2017 version 15.5, it's enabled by default as a level 3 warning. +This warning is off by default in Visual Studio 2017 version 15.3, and only impacts code compiled with **`/Wall`** **`/WX`**. Starting in Visual Studio 2017 version 15.5, it's enabled by default as a level 3 warning. ### `decltype` and calls to deleted destructors @@ -805,7 +805,7 @@ In earlier versions of Visual Studio, the compiler always gave a **`constexpr`** ### Removing allocator support in `std::function` -[P0302R1](https://wg21.link/p0302r1) Prior to C++17, the class template `std::function` had several constructors that took an allocator argument. However, the use of allocators in this context was problematic, and the semantics were unclear. The problem contructors have been removed. +[P0302R1](https://wg21.link/p0302r1) Prior to C++17, the class template `std::function` had several constructors that took an allocator argument. However, the use of allocators in this context was problematic, and the semantics were unclear. The problematic constructors have been removed. ### Fixes for `not_fn()` @@ -1022,7 +1022,7 @@ To fix the error, remove the unused variable. ### Single-line comments -In Visual Studio 2017 version 15.5, warnings C4001 and C4179 are no longer emitted by the C compiler. Previously, they were only emitted under the **`/Za`** compiler switch. The warnings are no longer needed because single-line comments have been part of the C standard since C99. +In Visual Studio 2017 version 15.5, warnings C4001 and C4179 are no longer emitted by the C compiler. Previously, they were only emitted under the **`/Za`** compiler switch. The warnings are no longer needed because single-line comments have been part of the C standard since C99. ```cpp /* C only */ @@ -1051,7 +1051,7 @@ When the code doesn't need to be backwards compatible, avoid the warning by remo ### `__declspec` attributes with `extern "C"` linkage -In earlier versions of Visual Studio, the compiler ignored `__declspec(...)` attributes when `__declspec(...)` was applied before the `extern "C"` linkage specification. This behavior caused code to be generated that user didn't intend, with possible runtime implications. The [C4768](../error-messages/compiler-warnings/c4768.md) warning was added in Visual Studio version 15.3, but was off by default. In Visual Studio 2017 version 15.5, the warning is enabled by default. +In earlier versions of Visual Studio, the compiler ignored `__declspec(...)` attributes when `__declspec(...)` was applied before the `extern "C"` linkage specification. This behavior caused code to be generated that the user didn't intend, with possible runtime implications. The [C4768](../error-messages/compiler-warnings/c4768.md) warning was added in Visual Studio version 15.3, but was off by default. In Visual Studio 2017 version 15.5, the warning is enabled by default. ```cpp __declspec(noinline) extern "C" HRESULT __stdcall // C4768 @@ -1116,7 +1116,7 @@ error C2027: use of undefined type 'S' ### `std::is_convertible` target type -`std::is_convertible` requires the target type to be a valid return type. In earlier versions of Visual Studio, the compiler incorrectly allowed abstract types, which might lead to incorrect overload resolution and unintended runtime behavior. The following code now correctly raises C2338: +`std::is_convertible` requires the target type to be a valid return type. In earlier versions of Visual Studio, the compiler incorrectly allowed abstract types, which might lead to incorrect overload resolution and unintended runtime behavior. The following code now correctly raises C2338: ```cpp #include @@ -1193,7 +1193,7 @@ The warning was added in Visual Studio 2017 version 15.3, but was off by default ### Defaulted functions and `__declspec(nothrow)` -The compiler previously allowed defaulted functions to be declared with `__declspec(nothrow)` when the corresponding base/member functions permitted exceptions. This behavior is contrary to the C++ standard and can cause undefined behavior at runtime. The standard requires such functions to be defined as deleted if there's an exception specification mismatch. Under **`/std:c++17`**, the following code raises C2280: +The compiler previously allowed defaulted functions to be declared with `__declspec(nothrow)` when the corresponding base/member functions permitted exceptions. This behavior is contrary to the C++ standard and can cause undefined behavior at runtime. The standard requires such functions to be defined as deleted if there's an exception specification mismatch. Under **`/std:c++17`**, the following code raises C2280: ```cpp struct A { @@ -1441,7 +1441,7 @@ void sample(A<0> *p) ### C++20: Avoiding unnecessary decay (partial) -[P0777R1](https://wg21.link/p0777r1) Adds differentiation between the concept of "decay" and that of simply removing const or reference qualifiers. New type trait `remove_reference_t` replaces `decay_t` in some contexts. Support for `remove_cvref_t` is implemented in Visual Studio 2019. +[P0777R1](https://wg21.link/p0777r1) Adds differentiation between the concept of "decay" and that of simply removing const or reference qualifiers. New type trait `remove_reference_t` replaces `decay_t` in some contexts. Support for `remove_cvref_t` is implemented in Visual Studio 2019. ### C++17: Parallel algorithms @@ -1457,7 +1457,7 @@ void sample(A<0> *p) ### C++17: Mathematical special functions -[P0226R1](https://wg21.link/p0220r1) Adopts previous technical specifications for Mathematical Special Functions into the standard *``* header. +[P0226R1](https://wg21.link/p0226r1) Adopts previous technical specifications for Mathematical Special Functions into the standard *``* header. ### C++17: Deduction guides for the standard library @@ -1613,7 +1613,7 @@ In [`/permissive-`](../build/reference/permissive-standards-conformance.md) mode ```cpp template -using X = typename T; // C7511: 'T': 'typename' keyword must be +using X = typename T; // C7511: 'T': 'typename' keyword must be // followed by a qualified name ``` @@ -1632,7 +1632,7 @@ using X = __declspec(deprecated("msg")) T; // C2760: syntax error: // expected 'type specifier' ``` -To fix the error, change to code to the following (with the attribute placed before the '=' of the alias definition): +To fix the error, change the code to the following (with the attribute placed before the '=' of the alias definition): ```cpp template diff --git a/docs/overview/cpp-conformance-improvements-2019.md b/docs/overview/cpp-conformance-improvements-2019.md index e3b390b72fe..c69a47b06b0 100644 --- a/docs/overview/cpp-conformance-improvements-2019.md +++ b/docs/overview/cpp-conformance-improvements-2019.md @@ -7,7 +7,7 @@ ms.subservice: "cpp-lang" --- # C++ Conformance improvements, behavior changes, and bug fixes in Visual Studio 2019 -Microsoft C/C++ in Visual Studio (MSVC) makes conformance improvements and bug fixes in every release. This article lists the improvements by major release, then by version. To jump directly to the changes for a specific version, use the list below **In this article**. +Microsoft C++ (MSVC) Build Tools in Visual Studio makes conformance improvements and bug fixes in every release. This article lists the improvements by major release, then by version. To jump directly to the changes for a specific version, use the list below **In this article**. This document lists the changes in Visual Studio 2019. For a guide to the changes in Visual Studio 2022, see [C++ conformance improvements in Visual Studio 2022](cpp-conformance-improvements.md). For changes in Visual Studio 2017, see [C++ conformance improvements in Visual Studio 2017](cpp-conformance-improvements-2017.md). For a complete list of previous conformance improvements, see [Visual C++ What's New 2003 through 2015](../porting/visual-cpp-what-s-new-2003-through-2015.md). @@ -67,8 +67,8 @@ To avoid the errors, insert a space in the offending line before the final angle ### References to types with mismatched cv-qualifiers ->[!Note] -> This change only affects Visual Studio 2019 versions 16.0 through 16.8. It was reverted starting in Visual Studio 2019 version 16.9 +> [!NOTE] +> This change only affects Visual Studio 2019 versions 16.0 through 16.8. It was reverted starting in Visual Studio 2019 version 16.9. Previously, MSVC allowed direct binding of a reference from a type with mismatched cv-qualifiers below the top level. This binding could allow modification of supposedly const data referred to by the reference. @@ -455,7 +455,7 @@ The `std::bitset` constructor no longer reads the ones and zeroes in reverse ord ### `std::pair::operator=` regression -We fixed a regression in the `std::pair` assignment operator introduced when implementing [LWG 2729 "Missing SFINAE on `std::pair::operator=`";](https://cplusplus.github.io/LWG/issue2729). It now correctly accepts types convertible to `std::pair` again. +We fixed a regression in the `std::pair` assignment operator introduced when implementing [LWG 2729 "Missing SFINAE on `std::pair::operator=`"](https://cplusplus.github.io/LWG/issue2729). It now correctly accepts types convertible to `std::pair` again. ### Non-deduced contexts for `add_const_t` @@ -579,8 +579,8 @@ int main() // The conversion from 'E' to the fixed underlying type 'unsigned char' is better than the // conversion from 'E' to the promoted type 'unsigned int'. f(e); - - // Error C2666. This call is ambiguous, but previously called f(unsigned int, const B&). + + // Error C2666. This call is ambiguous, but previously called f(unsigned int, const B&). f(e, B{}); } ``` @@ -694,7 +694,7 @@ std::equal(std::begin(a), std::end(a), std::begin(b), std::end(b)); ### Effect of defining spaceship operator on `==` and `!=` -A definition of the spaceship operator (**`<=>`**) alone will no longer rewrite expressions involving **`==`** or **`!=`** unless the spaceship operator is marked as **`= default`** ([P1185R2](https://wg21.link/p1185r2)). The following example compiles in Visual Studio 2019 RTW and version 16.1, but produces C2678 in Visual Studio 2019 version 16.2: +A definition of the spaceship operator (**`<=>`**) alone will no longer rewrite expressions involving **`==`** or **`!=`** unless the spaceship operator is marked as **`= default`** ([P1185R2](https://wg21.link/p1185r2)). The following example compiles in Visual Studio 2019 RTW and version 16.1, but produces C2676 in Visual Studio 2019 version 16.2: ```cpp #include @@ -885,7 +885,7 @@ The non-standard headers \ and \ have been removed. Code Two-phase name lookup requires that non-dependent names used in template bodies must be visible to the template at definition time. Previously, such names may have been found when the template is instantiated. This change makes it easier to write portable and conforming code in MSVC under the [`/permissive-`](../build/reference/permissive-standards-conformance.md) flag. -In Visual Studio 2019 version 16.4 with the **`/permissive-`** flag set, the following example produces an error, because `N::f` isn't visible when the `f` template is defined: +In Visual Studio 2019 version 16.4 with the **`/permissive-`** flag set, the following example produces an error, because `N::f` isn't visible when the `f` template is defined: ```cpp template @@ -1424,7 +1424,7 @@ In Visual Studio 2019 version 16.6 and later, the behavior of **`typedef`** decl The same restrictions are applied recursively to each nested class. The restriction is meant to ensure the simplicity of structs that have **`typedef`** names for linkage purposes. They must be simple enough that no linkage calculations are necessary before the compiler gets to the **`typedef`** name for linkage. -This change affects all standards modes of the compiler. In default (**`/std:c++14`**) and **`/std:c++17`** modes, the compiler emits warning C5208 for non-conforming code. If **`/permissive-`** is specified, the compiler emits warning C5208 as an error under **`/std:c++14`** and emits error C7626 under **`/std:c++17`**. The compiler emits error C7626 for non-conforming code when **`/std:c++20`** or **`/std:c++latest`** is specified. +This change affects all standards modes of the compiler. In default (**`/std:c++14`**) and **`/std:c++17`** modes, the compiler emits warning C5208 for non-conforming code. If **`/permissive-`** is specified, the compiler emits warning C5208 as an error under **`/std:c++14`** and emits error C7626 under **`/std:c++17`**. The compiler emits error C7626 for non-conforming code when **`/std:c++20`** or **`/std:c++latest`** is specified. The following sample shows the constructs that are no longer allowed in unnamed structs. Depending on the standards mode specified, C5208 or C7626 errors or warnings are emitted: @@ -2101,7 +2101,7 @@ The update may change program behavior that relied on an introduced temporary: int func() { int i1 = 13; int i2 = 23; - + int* iptr = &i1; int const * const& iptrcref = iptr; @@ -2110,7 +2110,7 @@ int func() { { return 1; } - + // Now change what iptr points to. // Prior to CWG 2352 iptrcref should be bound to a temporary and still points to the value 13. @@ -2151,7 +2151,7 @@ class B { template B::~B() { /* ... */ } // Before: no diagnostic. -// Now diagnoses a definition mismatch. To fix, define the implementation by +// Now diagnoses a definition mismatch. To fix, define the implementation by // using the same noexcept-specifier. For example, // B::~B() noexcept { /* ... */ } ``` @@ -2254,7 +2254,7 @@ Earlier versions of the compiler would incorrectly convert the argument of `f` f This change can also correct the chosen overload in some other situations: ```cpp -struct Base +struct Base { operator char *(); }; diff --git a/docs/overview/how-to-report-a-problem-with-the-visual-cpp-toolset.md b/docs/overview/how-to-report-a-problem-with-the-visual-cpp-toolset.md index 5fff09d04d6..579d8db1796 100644 --- a/docs/overview/how-to-report-a-problem-with-the-visual-cpp-toolset.md +++ b/docs/overview/how-to-report-a-problem-with-the-visual-cpp-toolset.md @@ -1,13 +1,13 @@ --- -title: "How to report a problem with the Microsoft C++ toolset" +title: "How to report a problem with the Microsoft C++ Build Tools" description: How to create a good problem report and repro information for the Microsoft C++ toolset. ms.date: "09/24/2019" ms.service: "visual-cpp" -ms.subservice: "ide" +ms.subservice: "cpp-lang" author: "tylermsft" ms.author: "twhitney" --- -# How to report a problem with the Microsoft C++ toolset or documentation +# How to report a problem with the Microsoft C++ Build Tools or documentation If you find problems in the Microsoft C++ compiler (MSVC), the linker, or other tools and libraries, we want to know about them. When the issue is in our documentation, we want to know about that, too. @@ -311,6 +311,20 @@ After you generate the preprocessed files, it's a good idea to make sure the pro Finally, attach the preprocessed repro files (*filename*.i and *modulename*.i) along with the .ifc output to your report. +#### To generate a module trace file + +When issues involve C++ modules, provide a module trace file along with the preprocessed repro improves diagnostic quality to reduce turnaround time. A module trace file records detailed information about module operations during compilation. + +It's ideal if the example can be condensed to a single source code file, without reference to any user headers. + +Reducing the amount of code we have to consider as a possible contributor to the problem is enormously helpful to us. Using **/MP** or multi-source invocations can cause the trace to represent only the last compiled file or be incomplete. If you can't reduce the problem to a single source file, package your code into a .zip file or similar, or consider using an IDE project repro. For more information, see [Other repros](#other-repros). + +1. Open the **Developer Command Prompt** that matches the Visual Studio version and configuration architecture used to build your project. +1. Enter the command `cl /d1module:enableLogging`*trace.json* [*other-args*] *filename.cpp*. For *trace.json*, specify the desired output file name for the module trace. There can't be a space between `/d1module:enableLogging` and the output file name. For [*other-args*], include any additional compilation arguments. For *filename.cpp*, specify the source file that reproduces the problem. +1. If multiple translation units are involved in the problem, run separate single-file invocations to collect a trace for the specific file that reproduces the problem. You can collect traces for additional relevant files if needed. + +Finally, attach the generated *trace.json* file along with the preprocessed repro to your report. + ### Link repros A *link repro* is the linker-generated contents of a directory, specified either by the **link\_repro** environment variable, or as an argument to the [/LINKREPRO](../build/reference/linkrepro.md) linker option. It contains build artifacts that collectively demonstrate a problem that occurs at link time. Examples include a backend crash involving Link-Time Code Generation (LTCG), or a linker crash. These build artifacts are the ones needed as linker input so the problem can be reproduced. A link repro can be created easily by using this environment variable. It enables the linker's built-in repro generation capability. @@ -382,7 +396,7 @@ For issues with the C++ compiler, linker, and other tools and libraries, first s > Information in the initial Developer Community report will always be public. If this is a concern, see the next section about [Reports and privacy](#reports-and-privacy). > [!TIP] -> For other kinds of problems you might find in Visual Studio that are unrelated to the C++ toolset (For example, UI issues, broken IDE functionality, or general crashes), use the **Report a Problem** tool in the IDE. This is the best choice, due to its screenshot capabilities and its ability to record UI actions that lead to the problem you found. These kinds of errors can also be looked up on the Visual Studio [Developer Community](https://aka.ms/feedback/report?space=8) site. For more information, see [How to report a problem with Visual Studio](/visualstudio/ide/how-to-report-a-problem-with-visual-studio). +> For other kinds of problems you might find in Visual Studio that are unrelated to the Microsoft C++ Build Tools (For example, UI issues, broken IDE functionality, or general crashes), use the **Report a Problem** tool in the IDE. This is the best choice, due to its screenshot capabilities and its ability to record UI actions that lead to the problem you found. These kinds of errors can also be looked up on the Visual Studio [Developer Community](https://aka.ms/feedback/report?space=8) site. For more information, see [How to report a problem with Visual Studio](/visualstudio/ide/how-to-report-a-problem-with-visual-studio). ### Reports and privacy @@ -408,6 +422,6 @@ To maintain your privacy and keep your sensitive information out of public view, ## How to report a C++ documentation issue -We use GitHub issues to track problems reported in our documentation. You can now create GitHub issues directly from a content page, which enables you interact in a richer way with writers and product teams. If you see an issue with a document, a bad code sample, a confusing explanation, a critical omission, or even just a typo, you can easily let us know. Scroll to the bottom of the page and select **Sign in to give documentation feedback**. You need to create a GitHub account if you don't have one already. When you have a GitHub account, you can see all of our documentation issues and their status. You also get notifications when changes are made for the issue you reported. For more information, see our [Feedback System blog entry](/teamblog/a-new-feedback-system-is-coming-to-docs). +If you see an issue with a document, a bad code sample, a confusing explanation, a critical omission, or even just a typo, you can easily let us know by using the feedback buttons on the page. Since 2024, we no longer use GitHub issues to track problems reported. For more information, see [Announcing a new way to give feedback on Microsoft Learn](https://techcommunity.microsoft.com/blog/skills-hub-blog/announcing-a-new-way-to-give-feedback-on-microsoft-learn/4027635). -You create a documentation issue on GitHub when you use the documentation feedback button. The issue is automatically filled in with some information about the page you created the issue on. That's how we know where the problem is located, so don't edit this information. Just append the details about what's wrong, and if you like, a suggested fix. [Our C++ docs are open source](https://github.com/MicrosoftDocs/cpp-docs/), so if you'd like to submit a fix yourself, you can. For more information about how you can contribute to our documentation, see our [Contributing guide](https://github.com/MicrosoftDocs/cpp-docs/blob/main/CONTRIBUTING.md) on GitHub. +[Our C++ docs are open source](https://github.com/MicrosoftDocs/cpp-docs/), so if you'd like to submit a fix yourself, you can. For more information about how you can contribute to our documentation, see our [Contributing guide](https://github.com/MicrosoftDocs/cpp-docs/blob/main/CONTRIBUTING.md) on GitHub. diff --git a/docs/overview/media/clang-tidy-improvements.png b/docs/overview/media/clang-tidy-improvements.png new file mode 100644 index 00000000000..fe999aa5360 Binary files /dev/null and b/docs/overview/media/clang-tidy-improvements.png differ diff --git a/docs/overview/media/cpp-preprocess-menu-entry.png b/docs/overview/media/cpp-preprocess-menu-entry.png new file mode 100644 index 00000000000..59f45d3bc6a Binary files /dev/null and b/docs/overview/media/cpp-preprocess-menu-entry.png differ diff --git a/docs/overview/media/inline-post-return-value.png b/docs/overview/media/inline-post-return-value.png new file mode 100644 index 00000000000..cace675c49f Binary files /dev/null and b/docs/overview/media/inline-post-return-value.png differ diff --git a/docs/overview/msvc-conformance-improvements.md b/docs/overview/msvc-conformance-improvements.md new file mode 100644 index 00000000000..71c66d185d9 --- /dev/null +++ b/docs/overview/msvc-conformance-improvements.md @@ -0,0 +1,314 @@ +--- +title: "/C++ Conformance improvements, behavior changes, and bug fixes in Microsoft C++ (MSVC) Build Tools" +description: "Summary of conformance improvements in Microsoft C/C++ (MSVC)" +ms.date: 05/12/2026 +ms.service: "visual-cpp" +ms.subservice: "cpp-lang" +--- +# C/C++ Conformance improvements, behavior changes, and bug fixes in Microsoft C++ (MSVC) Build Tools + +We make conformance improvements and bug fixes in every release of Microsoft C++ (MSVC) Build Tools. Starting with Visual Studio 2026 version 18.0, we organize major improvements by MSVC Build Tools version number. Use the **In this article** links at the top of this article to jump directly to the changes for a specific version. + +For changes in earlier versions of Visual Studio: + +| Version | Conformance improvements link | +|---|---| +| 2022 | [C++ conformance improvements in Visual Studio 2022](cpp-conformance-improvements.md) | +| 2019 | [C++ conformance improvements in Visual Studio 2019](cpp-conformance-improvements-2019.md) | +| 2017 | [C++ conformance improvements in Visual Studio 2017](cpp-conformance-improvements-2017.md) | +| 2003-2015 | [Visual C++ What's New 2003 through 2015](../porting/visual-cpp-what-s-new-2003-through-2015.md) | + +## C++ conformance improvements, behavior changes, and bug fixes in MSVC Build Tools v14.51 + +MSVC Build Tools v14.51 continues the progress toward C++23 conformance with several key language feature implementations and numerous Core Working Group (CWG) issue resolutions. This release focuses on compile-time evaluation improvements, Unicode support enhancements, and refined `consteval` handling. + +This version shipped first with Visual Studio 2026 version 18.6 and includes version 19.51 of the MSVC compiler. + +Key highlights of this release include: +- Static `constexpr` variables in `constexpr` functions (P2647R1) +- Relaxed `constexpr` restrictions (P2448R2) +- Unicode support improvements (P2029R4, P2071R2, P2314R4) +- Improved `consteval` function handling with default-enabled experimental features +- New standard library headers `` and `` + +For more information about library features and other updates, see [C++23 Support in MSVC Build Tools 14.51](https://devblogs.microsoft.com/cppblog/c23-support-in-msvc-build-tools-14-51) and [STL Changelog](https://github.com/microsoft/STL/wiki/Changelog). + +### P2647R1: Static constexpr variables in constexpr functions + +[P2647R1](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p2647r1.html) allows static local variables to be declared `constexpr` within `constexpr` functions, reducing friction when marking existing functions as `constexpr`. + +```cpp +constexpr char xdigit(int n) +{ + static constexpr char digits[] = "0123456789abcdef"; + return digits[n]; +} +``` + +This feature improves both compile-time evaluation and run-time optimization. Previously, static local variables couldn't be marked `constexpr`, which made it difficult to declare lookup tables inside `constexpr` functions. Now the compiler can evaluate these functions at compile time when possible, while also generating optimized run-time code that accesses the static storage directly. + +### Other C++23 features + +Other C++23 features implemented in this release include Unicode support improvements, labels at the end of compound statements for C compatibility, Class Template Argument Deduction (CTAD) from inherited constructors, and meaningful exports for modules. For more information and related Core Working Group (CWG) issue resolutions, see the [C++23 Support in MSVC Build Tools 14.51](https://devblogs.microsoft.com/cppblog/c23-support-in-msvc-build-tools-14-51). + +### Standard Library + +MSVC Build Tools v14.51 adds new standard library features including: +- `` and `` headers +- Type traits for detecting references binding to temporaries ([P2255R2](https://wg21.link/p2255r2)) +- Explicit lifetime management ([P2590R2](https://wg21.link/p2590r2)), and `is_implicit_lifetime` ([P2674R1](https://wg21.link/P2674R1)). +- Major `` overhaul, SIMD-vectorized STL algorithms using NEON for ARM64/ARM64EC, and 18 Library Working Group (LWG) issue resolutions. +For the complete list, see the [STL Changelog](https://github.com/microsoft/STL/wiki/Changelog). + +## C++ conformance improvements, behavior changes, and bug fixes in MSVC Build Tools v14.50 + +MSVC Build Tools v14.50 introduces improvements to the MSVC compiler and standard library including better C++23 standards conformance, enhanced reliability, and improved correctness. This release also includes numerous bug fixes and updates that benefit large-scale C++ development. + +This version shipped first with Visual Studio 2026 version 18.0 and includes version 19.50 of the MSVC compiler. + +Key highlights of this release include: +- Advanced C++23 feature support including `auto(x)` decay-copy and `#warning` directive. +- Comprehensive `constexpr` improvements, particularly for virtual functions. +- Major stability improvements for C++ modules. +- Extensive reliability fixes reducing internal compiler errors. +- Enhanced C++/CLI support for managed code scenarios. +- The Microsoft C++ standard library (MSVC STL) no longer supports targeting Windows 7/Server 2008 R2, Windows 8/Server 2012, or Windows 8.1/Server 2012 R2. +- Windows 10/Server 2016 are the minimum supported operating systems. + +For more information about performance improvements, bug fixes, and conformance updates in the standard library, see [STL Changelog](https://github.com/microsoft/STL/wiki/Changelog), which is updated regularly. + +## C++23 features + +MSVC Build Tools v14.50 adds support for several C++23 features, bringing the compiler closer to full C++23 conformance. + +### P0849R8: auto(x) - decay-copy in the language + +[P0849R8](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2021/p0849r8.html) introduces the `auto(x)` syntax for decay-copy operations directly in the language, providing a more concise way to express decay-copy semantics. + +Before P0849R8, you needed to explicitly perform decay operations: + +```cpp +// Before P0849R8: +void pop_front_alike(auto& x) +{ + using T = std::decay_t; + std::erase(x, T(x.front())); +} +``` + +After P0849R8, you can use the simpler `auto(x)` syntax: + +```cpp +// After P0849R8: +void pop_front_alike(auto& x) +{ + std::erase(x, auto(x.front())); +} +``` + +This feature provides a standardized way to perform decay-copy operations, making code more readable and reducing the need for verbose template metaprogramming. + +### P2437R1: C++23 `#warning` directive + +[P2437R1](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p2437r1.pdf) implements the C++23 `#warning` preprocessor directive, providing a standard way to emit warnings during compilation. + +```cpp +// Valid before C++23. +#error bad configuration... + +// Valid after C++23. +#warning configuration deprecated... +``` + +The `#warning` directive allows you to emit diagnostic messages without stopping compilation, making it useful for deprecation notices and configuration warnings. For more information, see [#warning directive (C/C++)](/cpp/preprocessor/hash-warning-directive-c-cpp). + +### CWG Issue 2586: Explicit object parameter for assignment and comparison + +[CWG Issue 2586](https://cplusplus.github.io/CWG/issues/2586) allows explicit object parameters in assignment and comparison operators, enabling more flexible operator definitions. + +```cpp +struct S +{ + S& operator=(this S&, const S&) = default; // Valid after CWG2586. + auto operator<=>(this const S&, const S&) = default; // Valid after CWG2586. +}; +``` + +This change allows you to use the explicit object parameter syntax (deducing `this`) in assignment and comparison operators, providing more consistent syntax across different types of member functions. + +### P2266R1 : Simpler implicit move + +The introduction of [P2266R1](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2021/p2266r1.html) may cause code that was previously treated as an lvalue to be treated as an xvalue or a prvalue. For example: + +```cpp +#include + +template +T& f(T&& t) +{ + return t; +} + +struct S { }; + +void g() +{ + S s1{ }; + S& s2 = f(std::move(s1)); +} +``` + +In C++20, and earlier, this code compiled because even though the type of `t` is `S&&` the use of `t` in `return t` is treated as a glvalue and so it can bind to the return type.\ +With C++23, `t` is treated as an xvalue and so it can't bind to an lvalue reference.\ +One fix is to change to the return type of the function from `T&` to `T&&` but this may affect code that calls this function. An alternative is to use the feature test macro that is associated with this change. For example: + +```cpp +#include + +template +T& f(T&& t) +{ +#if defined(__cpp_implicit_move) + return static_cast&>(t); +#else + return t; +#endif +} +``` + +Adding the cast means that the value-category of the return expression is now an lvalue and so it can bind to the return type. + +### P2280R4: References to unknown values during constant evaluation + +[P2280R4](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p2280r4.html) allows references to unknown values during constant evaluation, relaxing restrictions on `constexpr` evaluation. + +```cpp +template +constexpr size_t array_size(T (&)[N]) +{ + return N; +} + +void check(int const (¶m)[3]) +{ + constexpr auto s2 = array_size(param); // Previously ill-formed, now accepted as a constant expression after P2280R4. +} +``` + +This improvement allows more code to be evaluated at compile time, particularly when dealing with function parameters in template contexts. + +## Conformance enhancements + +Improved adherence to C++ standards includes better handling of attributes, templates, and C++20/C++23 features. + +### Attribute support + +- Added support for [`[[maybe_unused]]` on labels](https://developercommunity.visualstudio.com/t/unreferenced-label-when-ref-hidden-by-if/102076). +- Fixed warning C4102 (unreferenced label) when the only reference was from a discarded `if constexpr` branch. + +### Template and specialization fixes + +- [Diagnosed ill-formed friend explicit specializations](https://developercommunity.visualstudio.com/t/Defining-explicit-function-template-spec/10933841) that were incorrectly accepted in C++20 or later. +- Added `/Zc:enumEncoding` switch to [correctly encode enum nontype template parameters](https://developercommunity.visualstudio.com/t/Overload-resolution-fails-for-enum-non-t/10398088). +- Fixed issues with [missing 'template' keyword diagnostics](https://developercommunity.visualstudio.com/t/No-diagnostic-for-missing-template-in-d/10501221) + +### C++20 and C++23 Features + +- Enhanced [multidimensional `operator[]` support](https://developercommunity.visualstudio.com/t/Multidimensional-operator-with-Wall-r/10876026) +- Improved [concept and constraint evaluation](https://developercommunity.visualstudio.com/t/VS-1714-if-constexpr-requires--does/10905731) + +### Smaller conformance updates + +MSVC Build Tools v14.50 includes numerous smaller conformance improvements that enhance C++ standard compliance: + +- [CWG2635](https://cplusplus.github.io/CWG/issues/2635): Constrained structured bindings support +- [CWG2465](https://cplusplus.github.io/CWG/issues/2465): Coroutine parameters passed to promise constructor improvements +- [CWG2496](https://cplusplus.github.io/CWG/issues/2496): Ref-qualifiers and virtual overriding corrections +- [CWG2506](https://cplusplus.github.io/CWG/issues/2506): Structured bindings and array cv-qualifiers fixes +- [CWG2507](https://cplusplus.github.io/CWG/issues/2507): Default arguments for `operator[]` support +- [CWG2585](https://cplusplus.github.io/CWG/issues/2585): Behavior alignment with standard requirements +- [CWG2521](https://cplusplus.github.io/CWG/issues/2521): Deprecation of 'operator string-literal identifier' +- [CWG2528](https://cplusplus.github.io/CWG/issues/2528): Relaxed conversion rules for the spaceship operator +- [P2360R0](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2021/p2360r0.html): Extended init-statement definition to allow alias-declarations +- [P2290R3](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p2290r3.pdf): C++23 hexadecimal/octal delimited escape sequence support in string literals +- [P2797R0](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2023/p2797r0.html): Resolution for CWG2692 regarding static and explicit object member functions with the same parameter-type-lists +- [P2266R3](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p2266r3.html): Simpler implicit move semantics + +## Bug fixes + +Bug fixes for C++ Modules, `constexpr`, and other fixes were made in MSVC Build Tools v14.50. + +For a detailed list of bug fixes, see [Compiler Improvements in v14.50](https://devblogs.microsoft.com/cppblog/c-language-updates-in-msvc-build-tools-v14-50/#compiler-improvements-in-v14.50). + +**Encoding of certain nontype template arguments corrected** + +Affects `/std:c++20` or later. + +Certain nontype pointer type template arguments involving subobjects could lead to linking issues or in some cases silent bad code generation where what should be distinct specializations collide. + +```cpp +struct A +{ + int x; +}; + +struct B +{ + int y; +}; + +template void f(); + +int main() +{ + static A a; + static B b; + constexpr auto px = &a.x; + constexpr auto py = &b.y; + f(); // incorrect encoding of argument 'px' + f(); // incorrect encoding of argument 'py', collided with 'px'. +} +``` + +With this fix, the two calls to `f` get distinct encodings, as required. + +## Migrating to MSVC Build Tools v14.50 + +When upgrading to MSVC Build Tools v14.50, consider the following potential breaking changes and migration guidance: + +### C++23 feature adoption +- Update code to take advantage of new `auto(x)` decay-copy syntax for cleaner template code +- Consider using `#warning` directives for deprecation notices instead of error-prone conditional compilation +- Review explicit object parameter usage in operators for improved consistency + +### `constexpr` improvements +- Existing `constexpr` code may now compile that previously failed, particularly with virtual functions +- Review constant evaluation code for potential new optimization opportunities +- Update CRTP patterns that may now work correctly with static constexpr members + +### Modules migration +- Projects using C++20 modules should see improved stability and compatibility +- Header units now work more reliably with large codebases like Unreal Engine 5 +- Consider migrating from traditional headers to modules for better compilation performance + +### Compiler diagnostics +- New warnings may appear for previously undiagnosed issues +- Review enum type usage if using `/Zc:enumTypes` +- Update code that relies on implicit conversions that may now be flagged + +### C code updates +- C23 features are available with `/std:clatest` +- `typeof` behavior changes may affect existing code +- Review preprocessor usage for new `__VA_OPT__` availability + +## Provide feedback + +For the latest updates and to provide feedback, visit the [Visual Studio Developer Community](https://developercommunity.visualstudio.com/) or contact the team at [visualcpp@microsoft.com](mailto:visualcpp@microsoft.com). Follow us on X [@visualc](https://x.com/visualc) or BlueSky [@msftcpp.bsky.social](https://bsky.app/profile/msftcpp.bsky.social). + +If you encounter problems with MSVC in Visual Studio 2026, please let us know via the [Report a Problem](how-to-report-a-problem-with-the-visual-cpp-toolset.md) option, either from the installer or the Visual Studio IDE itself. + +## See also + +[Microsoft C/C++ language conformance](visual-cpp-language-conformance.md)\ +[What's new for C++ in Visual Studio](what-s-new-for-visual-cpp-in-visual-studio.md)\ +[C++ conformance improvements in Visual Studio 2022](cpp-conformance-improvements.md) \ No newline at end of file diff --git a/docs/overview/overview-of-cpp-development.md b/docs/overview/overview-of-cpp-development.md index ca4cb394b97..ac46ec8f83c 100644 --- a/docs/overview/overview-of-cpp-development.md +++ b/docs/overview/overview-of-cpp-development.md @@ -1,6 +1,6 @@ --- title: "Overview of C++ development in Visual Studio" -description: "The Visual Studio IDE supports C++ development on Windows, Linux, Android and iOS with a code editor, debugger, test frameworks, static analyzers, and other programming tools." +description: "The Visual Studio IDE supports C++ development on Windows and Linux with a code editor, debugger, test frameworks, static analyzers, and other programming tools." ms.date: 12/02/2019 helpviewer_keywords: ["Visual C++, development tools"] author: "tylermsft" diff --git a/docs/overview/supported-platforms-visual-cpp.md b/docs/overview/supported-platforms-visual-cpp.md index 8c6f293023c..afcfd94885f 100644 --- a/docs/overview/supported-platforms-visual-cpp.md +++ b/docs/overview/supported-platforms-visual-cpp.md @@ -1,47 +1,56 @@ --- -description: "Learn more about: Supported Platforms (Visual C++)" -title: "Supported Platforms (Visual C++)" -ms.date: 11/09/2021 +description: "Learn more about: Supported Platforms (Microsoft C++)" +title: "Supported Platforms (Microsoft C++)" +ms.date: 10/22/2025 ms.service: "visual-cpp" ms.subservice: "tools" helpviewer_keywords: ["Visual C++, platforms supported", "platforms [C++]"] --- -# Supported platforms (Visual C++) +# Supported platforms (Microsoft C++) Apps built by using Visual Studio can be targeted to various platforms. +Support for targeting 32-bit ARM was permanently removed in VS 2026 18.0. + ## Visual Studio target OS and architecture support -| Operating System | x86 | x64 | ARM | ARM64a | -|--|--|--|--|--| -| Windows XP b | X | X | | | -| Windows Vista | X | X | | | -| Windows 7 | X | X | | | -| Windows 8 | X | X | X | | -| Windows 8.1 | X | X | X | | -| Windows 10 | X | X | X | X | -| Windows 11 | X | X | X | X | -| Windows Server 2003 b | X | X | | | -| Windows Server 2008 R2 | X | X | | | -| Windows Server 2012 R2 | X | X | | | -| Windows Server 2016 | X | X | | | -| Windows Server 2019 | X | X | | | -| Windows Server 2022 | X | X | | | -| Android c | X | X | X | X | -| iOS c | X | X | X | X | -| Linux d | X | X | X | X | +| Operating System | x86 | x64 | ARM64a | +|--|--|--|--| +| Windows XP b | X | X | | +| Windows Vistac | X | X | | +| Windows 7d | X | X | | +| Windows 8d | X | X | | +| Windows 8.1d | X | X | | +| Windows 10 | X | X | X | +| Windows 11 | X | X | X | +| Windows Server 2003 b | X | X | | +| Windows Server 2008d | X | X | | +| Windows Server 2008 R2d | X | X | | +| Windows Server 2012d | X | X | | +| Windows Server 2012 R2d | X | X | | +| Windows Server 2016 | X | X | | +| Windows Server 2019 | X | X | | +| Windows Server 2022 | X | X | | +| Windows Server 2025 | X | X | | +| Android e | X | X | X | +| iOS e | | | X | +| Linux f | X | X | X | a ARM64 support is available in Visual Studio 2017 and later. -b You can use the Windows XP platform toolsets included in Visual Studio 2017, Visual Studio 2015, Visual Studio 2013, and Visual Studio 2012 Update 1 to build Windows XP and Windows Server 2003 projects. For information on how to use these platform toolsets, see [Configuring Programs for Windows XP](../build/configuring-programs-for-windows-xp.md). For more information on changing the platform toolset, see [How to: Modify the Target Framework and Platform Toolset](../build/how-to-modify-the-target-framework-and-platform-toolset.md). +b Visual Studio no longer supports targeting Windows XP. Use the Windows XP platform toolsets included in Visual Studio 2017, Visual Studio 2015, Visual Studio 2013, and Visual Studio 2012 Update 1 to build Windows XP and Windows Server 2003 projects. + +c Visual Studio 2022 17.0 and later no longer support targeting Windows Vista or Windows Server 2008. + +d Visual Studio 2026 18.0 and later no longer support targeting Windows 7/8/8.1 or Windows Server 2008 R2/2012/2012 R2. Visual Studio 2026 and later target Windows 10 or later and Windows Server 2016 or later. -c You can install the **Mobile development with C++** workload in the installer for Visual Studio 2017 and later. In Visual Studio 2015 setup, choose the optional **Visual C++ for Cross Platform Mobile Development** component to target iOS or Android platforms. For instructions, see [Install Visual C++ for Cross-Platform Mobile Development](/visualstudio/cross-platform/install-visual-cpp-for-cross-platform-mobile-development). To build iOS code, you must have a Mac computer and meet other requirements. For a list of prerequisites and installation instructions, see [Install And Configure Tools to Build using iOS](/visualstudio/cross-platform/install-and-configure-tools-to-build-using-ios). You can build x86 or ARM code to match the target hardware. Use x86 configurations to build for some Android devices. Use ARM configurations to build for iOS devices and most Android devices. +e You can install the **Mobile development with C++** workload in the installer for Visual Studio 2017 and later. In Visual Studio 2015 setup, choose the optional **Visual C++ for Cross Platform Mobile Development** component to target iOS or Android platforms. For instructions, see [Install Visual C++ for Cross-Platform Mobile Development](/visualstudio/cross-platform/install-visual-cpp-for-cross-platform-mobile-development). To build iOS code, you must have a Mac computer and meet other requirements. For a list of prerequisites and installation instructions, see [Install And Configure Tools to Build using iOS](/visualstudio/cross-platform/install-and-configure-tools-to-build-using-ios). You can build x86 or ARM code to match the target hardware. Use x86 configurations to build for some Android devices. Use ARM configurations to build for iOS devices and most Android devices. **IMPORTANT**: Starting with Visual Studio 2026 (version 18.0), the **Mobile development with C++** workload for iOS and Android targeting in the Visual Studio installer and the **Embedded and IoT tools**--including RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import--are no longer supported and will be removed in a future update. However, the Android NDKs listed in the Mobile development with C++ workload continue to be supported. -d You can install the **Linux development with C++** workload in the installer for Visual Studio 2017 and later to target Linux platforms. For instructions, see [Download, install, and setup the Linux Workload](../linux/download-install-and-setup-the-linux-development-workload.md). This toolset compiles your executable on the target machine, so you can build for any supported architecture. +f You can install the **Linux development with C++** workload in the installer for Visual Studio 2017 and later to target Linux platforms. For instructions, see [Download, install, and setup the Linux Workload](../linux/download-install-and-setup-the-linux-development-workload.md). This toolset compiles your executable on the target machine, so you can build for any supported architecture. -For information about how to set the target platform configuration, see [How to: Configure Visual C++ projects to target 64-bit, x64 platforms](../build/how-to-configure-visual-cpp-projects-to-target-64-bit-platforms.md). +For information about how to set the target platform configuration, see [How to: Configure Microsoft C++ projects to target 64-bit, x64 platforms](../build/how-to-configure-visual-cpp-projects-to-target-64-bit-platforms.md). ## See also -[Visual C++ tools and features in Visual Studio editions](visual-cpp-tools-and-features-in-visual-studio-editions.md)\ +[Microsoft C++ tools and features in Visual Studio editions](visual-cpp-tools-and-features-in-visual-studio-editions.md)\ [Getting Started](/visualstudio/ide/getting-started-with-cpp-in-visual-studio) diff --git a/docs/overview/toc.yml b/docs/overview/toc.yml index 66d418921eb..39072bdc2eb 100644 --- a/docs/overview/toc.yml +++ b/docs/overview/toc.yml @@ -6,12 +6,16 @@ items: href: ../overview/visual-cpp-in-visual-studio.md - name: Overview of C++ development in Visual Studio href: ../overview/overview-of-cpp-development.md + - name: What's new for MSVC Build Tools + href: ../overview/what-s-new-for-msvc.md - name: What's new for C++ in Visual Studio 2022 href: ../overview/what-s-new-for-visual-cpp-in-visual-studio.md - name: What's new for C++ in Visual Studio 2019 href: ../overview/what-s-new-for-cpp-2019.md - name: What's new for C++ in Visual Studio 2017 href: ../overview/what-s-new-for-cpp-2017.md + - name: C/C++ conformance improvements in Microsoft C++ (MSVC) Build Tools + href: ../overview/msvc-conformance-improvements.md - name: C++ conformance improvements in Visual Studio 2022 href: ../overview/cpp-conformance-improvements.md - name: C++ conformance improvements in Visual Studio 2019 @@ -32,7 +36,7 @@ items: href: ../overview/visual-cpp-samples.md - name: Help and community href: ../overview/visual-cpp-help-and-community.md - - name: How to report a problem with the Visual C++ toolset + - name: How to report a problem with the Microsoft C++ Build Tools href: ../overview/how-to-report-a-problem-with-the-visual-cpp-toolset.md - name: Visual Studio C++ Tutorials expanded: false diff --git a/docs/overview/visual-cpp-in-visual-studio.md b/docs/overview/visual-cpp-in-visual-studio.md index 30012947cad..111b4036a69 100644 --- a/docs/overview/visual-cpp-in-visual-studio.md +++ b/docs/overview/visual-cpp-in-visual-studio.md @@ -44,9 +44,9 @@ helpviewer_keywords: ["Visual C++, home page"] :::moniker-end -Microsoft Visual C++ (MSVC) refers to the C++, C, and assembly language development tools and libraries available as part of Visual Studio on Windows. These tools and libraries let you create native Windows desktop and server applications, Universal Windows Platform (UWP) apps, or managed apps and libraries that use the .NET Framework. Create cross-platform libraries and apps that run on Windows, Linux, Android, and iOS. You can use MSVC to write anything from simple console apps to the most sophisticated and complex apps for Windows desktop. Write device drivers and operating system components or cross-platform games for mobile devices. Target anything from the smallest IoT devices to multi-server high performance computing in the Azure cloud. +Microsoft C++ (MSVC) refers to the C++, C, and assembly language development tools and libraries available as part of Visual Studio on Windows. These tools and libraries let you create native Windows desktop and server applications, Universal Windows Platform (UWP) apps, or managed apps and libraries that use the .NET Framework. Create cross-platform libraries and apps that run on Windows, Linux, Android, and iOS. You can use MSVC to write anything from simple console apps to the most sophisticated and complex apps for Windows desktop. Write device drivers and operating system components or cross-platform games for mobile devices. Target anything from the smallest IoT devices to multi-server high performance computing in the Azure cloud. -Visual Studio 2015, 2017, 2019, and 2022 can be installed side-by-side. You can use Visual Studio 2019 (compiler toolset v142) or Visual Studio 2017 (v141) to edit and build programs using the toolset from Visual Studio 2017 (v141) and Visual Studio 2015 (v140). +You can install Visual Studio 2015 and later side-by-side. For example, you can use Visual Studio 2019 (compiler toolset v142) or Visual Studio 2017 (v141) to edit and build programs using the toolset from Visual Studio 2017 (v141) and Visual Studio 2015 (v140). ## What's new for C++ in Visual Studio @@ -74,7 +74,7 @@ Learn about the breaking changes in previous versions. ## Install Visual Studio C++ and upgrade from earlier versions [Install C++ support in Visual Studio](../build/vscpp-step-0-installation.md)\ -Download Visual Studio and install the Microsoft C/C++ toolset. +Download Visual Studio and install the Microsoft C++ Build Tools. [Microsoft C++ porting and upgrading guide](../porting/visual-cpp-porting-and-upgrading-guide.md)\ Guidance for porting code and upgrading projects to Visual Studio 2015 or later. Take advantage of greater compiler conformance to the C++ standard, greatly improved compilation times, and security features such as Spectre mitigation. diff --git a/docs/overview/visual-cpp-language-conformance.md b/docs/overview/visual-cpp-language-conformance.md index b276614c6a6..698a03e2b9f 100644 --- a/docs/overview/visual-cpp-language-conformance.md +++ b/docs/overview/visual-cpp-language-conformance.md @@ -1,7 +1,7 @@ --- title: "Microsoft C/C++ language conformance" description: "Microsoft C and C++ conformance updates by Visual Studio version." -ms.date: 03/01/2023 +ms.date: 03/10/2026 ms.service: "visual-cpp" ms.subservice: "cpp-lang" --- @@ -9,7 +9,7 @@ ms.subservice: "cpp-lang" Standards conformance for the Microsoft C/C++ compiler in Visual Studio (MSVC) is a work in progress. Here's a summary of ISO Standard C and C++ language and library conformance by Visual Studio version. Each C++ compiler and standard library feature name has a link to the ISO Standard C++ proposal paper that describes the feature, when one is available at publication time. The **Supported** column lists the Visual Studio version in which support for the feature first appeared. -For details on conformance improvements, see [C++ conformance improvements in Visual Studio](cpp-conformance-improvements.md). For a list of other changes, see [What's New for Visual C++ in Visual Studio](what-s-new-for-visual-cpp-in-visual-studio.md). For conformance changes in earlier versions, see [Visual C++ change history](../porting/visual-cpp-change-history-2003-2015.md) and [Visual C++ What's New 2003 through 2015](../porting/visual-cpp-what-s-new-2003-through-2015.md). For current news from the C++ team, visit the [C++ team blog](https://devblogs.microsoft.com/cppblog/). +For details on conformance improvements, see [C++ conformance improvements in Visual Studio](cpp-conformance-improvements.md). For a list of other changes, see [What's New for Microsoft C++ in Visual Studio](what-s-new-for-visual-cpp-in-visual-studio.md). For conformance changes in earlier versions, see [Visual C++ change history](../porting/visual-cpp-change-history-2003-2015.md) and [Visual C++ What's New 2003 through 2015](../porting/visual-cpp-what-s-new-2003-through-2015.md). For current news from the C++ team, visit the [C++ team blog](https://devblogs.microsoft.com/cppblog/). > [!NOTE] > There are no binary breaking changes between Visual Studio 2015, 2017, 2019, and 2022. For more information, see [C++ binary compatibility between Visual Studio versions](../porting/binary-compat-2015-2017.md) @@ -21,6 +21,7 @@ For details on conformance improvements, see [C++ conformance improvements in Vi | **C++03/11 Core language features** | **Supported** | |  Everything else | VS 2015 [A](#note_A) | |  Two-phase name lookup | VS 2017 15.7 [B](#note_B) | +|  [`CWG 1213 Value category of arrays and subscripts`](https://cplusplus.github.io/CWG/issues/1213.html) | VS 2022 17.14 | |  [`N2634 Expression SFINAE`](https://wg21.link/N2634) | VS 2017 15.7 | |  [`N1653 C99 preprocessor`](https://wg21.link/N1653) | VS 2019 16.6 [C](#note_C) | | **C++03/11 Core language features (Defect reports)** | **Supported** | @@ -174,56 +175,61 @@ For details on conformance improvements, see [C++ conformance improvements in Vi |  [`P1073R3 Immediate functions`](https://wg21.link/P1073R3) | VS 2019 16.10 [20](#note_20) | |  [`P1143R2 constinit`](https://wg21.link/P1143R2) | VS 2019 16.10 [20](#note_20) | |  [`P1353R0 Missing feature-test macros`](https://wg21.link/P1353R0) | VS 2019 16.10 [20](#note_20) | -|  [`P0735R1 Interaction of memory_order_consume with release sequences`](https://wg21.link/P0735R1) | N/A | -|  [`P1236R1 Signed integers are two's complement`](https://wg21.link/P1236R1) | N/A | +|  [`P0735R1 Interaction of memory_order_consume with release sequences`](https://wg21.link/P0735R1) | VS 2022 v17.14 | +|  [`P1236R1 Signed integers are two's complement`](https://wg21.link/P1236R1) | VS 2022 v17.14 | | **C++23 Core language features** | **Supported** | -|  [`P0330R8 Literal Suffix for (signed) size_t`](https://wg21.link/p0330r8) | no | -|  [`P0847R7 Deducing this`](https://wg21.link/p0847r7) | no | -|  [`P0849R8 auto(x): decay-copy in the language`](https://wg21.link/p0849r8) | no | -|  [`P1102R2 Down with ()!`](https://wg21.link/p1102r2) | no | -|  [`P1169R4 static operator()`](https://wg21.link/p1169r4) | no | -|  [`P1401R5 Narrowing contextual conversions to bool`](https://wg21.link/p1401r5) | no | -|  [`P1467R9 Extended floating-point types and standard names`](https://wg21.link/p1467r9) | no | +|  [`P0330R8 Literal Suffix for (signed) size_t`](https://wg21.link/p0330r8) | VS 2022 17.13 [23](#note_23) | +|  [`P0847R7 Deducing this`](https://wg21.link/p0847r7) | VS 2022 17.13 [23](#note_23) | +|  [`P0849R8 auto(x): decay-copy in the language`](https://wg21.link/p0849r8) | MSVC Build Tools version 14.50 [24](#note_24) | +|  [`P1102R2 Down with ()!`](https://wg21.link/p1102r2) | VS 2022 17.14 [23](#note_23) | +|  [`P1169R4 static operator()`](https://wg21.link/p1169r4) | VS 2022 17.14 [23](#note_23) | +|  [`P1401R5 Narrowing contextual conversions to bool`](https://wg21.link/p1401r5) | VS 2022 17.14 [23](#note_23) | +|  [`P1467R9 Extended floating-point types and standard names`](https://wg21.link/p1467r9) | No [U](#note_U) | |  [`P1774R8 Portable assumptions`](https://wg21.link/p1774r8) | no | -|  [`P1787R6 Declarations and where to find them`](https://wg21.link/p1787r6) | no | +|  [`P1787R6 Declarations and where to find them`](https://wg21.link/p1787r6) | No change required | |  [`P1847R4 Make declaration order layout mandated`](https://wg21.link/p1847r4) | VS 2022 17.0 [23](#note_23) | -|  [`P1938R3 if consteval`](https://wg21.link/p1938r3) | no | -|  [`P1949R7 C++ Identifier Syntax using Unicode Standard Annex 31`](https://wg21.link/p1949r7) | no | +|  [`P1938R3 if consteval`](https://wg21.link/p1938r3) | VS 2022 17.14 [23](#note_23) | +|  [`P1949R7 C++ Identifier Syntax using Unicode Standard Annex 31`](https://wg21.link/p1949r7) | MSVC Build Tools version 14.50 [24](#note_24) | |  [`P2029R4 Proposed resolution for core issues 411, 1656, and 2333; numeric and universal character escapes in character and string literals`](https://wg21.link/p2029r4) | no | -|  [`P2036R3 Change scope of lambda trailing-return-type`](https://wg21.link/p2036r3) | no | +|  [`P2036R3 Change scope of lambda trailing-return-type`](https://wg21.link/p2036r3) | MSVC Build Tools version 14.50 [24](#note_24) | |  [`P2071R2 Named universal character escapes`](https://wg21.link/p2071r2) | no | -|  [`P2128R6 Multidimensional subscript operator`](https://wg21.link/p2128r6) | no | -|  [`P2156R1 Allow Duplicate Attributes`](https://wg21.link/p2156r1) | no | -|  [`P2173R1 Attributes on Lambda-Expressions`](https://wg21.link/p2173r1) | no | +|  [`P2128R6 Multidimensional subscript operator`](https://wg21.link/p2128r6) | VS 2022 17.12 [23](#note_23) | +|  [`P2156R1 Allow Duplicate Attributes`](https://wg21.link/p2156r1) | MSVC Build Tools version 14.50 [24](#note_24) | +|  [`P2173R1 Attributes on Lambda-Expressions`](https://wg21.link/p2173r1) | VS 2022 17.14 [23](#note_23) | |  [`P2186R2 Remove Garbage Collection Support`](https://wg21.link/p2186r2) | VS 2022 17.0 [23](#note_23) | -|  [`P2201R1 Mixed string literal concatenation`](https://wg21.link/p2201r1) | no | -|  [`P2223R2 Trimming whitespaces before line splicing`](https://wg21.link/p2223r2) | no | -|  [`P2242R3 Non-literal variables (and labels and gotos) in constexpr functions`](https://wg21.link/p2242r3) | no | +|  [`P2201R1 Mixed string literal concatenation`](https://wg21.link/p2201r1) | VS 2022 17.14 | +|  [`P2223R2 Trimming whitespaces before line splicing`](https://wg21.link/p2223r2) | MSVC Build Tools version 14.50 [24](#note_24) | +|  [`P2242R3 Non-literal variables (and labels and gotos) in constexpr functions`](https://wg21.link/p2242r3) | VS 2022 17.14 [23](#note_23) | |  [`P2246R1 Character encoding of diagnostic text`](https://wg21.link/p2246r1) | VS 2022 17.0 [23](#note_23) | -|  [`P2266R3 Simpler implicit move`](https://wg21.link/p2266r3) | no | -|  [`P2280R4 Using unknown pointers and references in constant expressions`](https://wg21.link/p2280r4) | no | -|  [`P2290R3 Delimited escape sequences`](https://wg21.link/p2290r3) | no | -|  [`P2295R6 Support for UTF-8 as a portable source file encoding`](https://wg21.link/p2295r6) | no | +|  [`P2266R3 Simpler implicit move`](https://wg21.link/p2266r3) | MSVC Build Tools version 14.50 [24](#note_24) | +|  [`P2280R4 Using unknown pointers and references in constant expressions`](https://wg21.link/p2280r4) | MSVC Build Tools version 14.50 [24](#note_24) | +|  [`P2290R3 Delimited escape sequences`](https://wg21.link/p2290r3) | MSVC Build Tools version 14.50 [24](#note_24) | +|  [`P2295R6 Support for UTF-8 as a portable source file encoding`](https://wg21.link/p2295r6) | [V](#note_V) | |  [`P2314R4 Character sets and encodings`](https://wg21.link/p2314r4) | no | |  [`P2316R2 Consistent character literal encoding`](https://wg21.link/p2316r2) | VS 2022 17.0 [23](#note_23) | |  [`P2324R2 Labels at the end of compound statements (C compatibility)`](https://wg21.link/p2324r2) | no | -|  [`P2327R1 De-deprecating volatile compound operations`](https://wg21.link/p2327r1) | no | -|  [`P2334R1 preprocessing directives elifdef and elifndef`](https://wg21.link/p2334r1) | no | -|  [`P2360R0 Extend init-statement to allow alias-declaration`](https://wg21.link/p2360r0) | no | +|  [`P2327R1 De-deprecating volatile compound operations`](https://wg21.link/p2327r1) | VS 2022 v17.14 | +|  [`P2334R1 preprocessing directives elifdef and elifndef`](https://wg21.link/p2334r1) | VS 2022 17.10 [23](#note_23) | +|  [`P2360R0 Extend init-statement to allow alias-declaration`](https://wg21.link/p2360r0) | MSVC Build Tools version 14.50 [24](#note_24) | |  [`P2362R3 Remove non-encodable wide character literals and multicharacter wide character literals`](https://wg21.link/p2362r3) | no | -|  [`P2437R1 Support for #warning`](https://wg21.link/p2437r1) | no | +|  [`P2437R1 Support for #warning`](https://wg21.link/p2437r1) | MSVC Build Tools version 14.50 [24](#note_24) | |  [`P2448R2 Relaxing some constexpr restrictions`](https://wg21.link/p2448r2) | no | -|  [`P2460R2 Relax requirements on wchar_t to match existing practices`](https://wg21.link/p2460r2) | no | -|  [`P2468R2 The Equality Operator You Are Looking For`](https://wg21.link/p2468r2) | no | -|  [`P2493R0 Missing feature test macros for C++20 core papers`](https://wg21.link/p2493r0) | no | +|  [`P2460R2 Relax requirements on wchar_t to match existing practices`](https://wg21.link/p2460r2) | VS 2022 v17.14 | +|  [`P2468R2 The Equality Operator You Are Looking For`](https://wg21.link/p2468r2) | VS 2022 17.6 [23](#note_23) | +|  [`P2493R0 Missing feature test macros for C++20 core papers`](https://wg21.link/p2493r0) | MSVC Build Tools version 14.50 [24](#note_24) | |  [`P2513R4 char8_t Compatibility and Portability Fix`](https://wg21.link/p2513r4) | VS 2022 17.4 [DR](#note_DR) | -|  [`P2579R0 Mitigation strategies for P2036 ”Changing scope for lambda trailing-return-type”`](https://wg21.link/p2579r0) | no | +|  [`P2579R0 Mitigation strategies for P2036 "Changing scope for lambda trailing-return-type"`](https://wg21.link/p2579r0) | MSVC Build Tools version 14.50 [24](#note_24) | |  [`P2582R1 Wording for class template argument deduction from inherited constructors`](https://wg21.link/p2582r1) | no | +|  [`P2589R1 static operator[]`](https://wg21.link/p2589r1) | VS 2022 17.14 [23](#note_23) | ## C++ Standard library features A more detailed listing of Standard Library features and bug fixes by product version is available on the [GitHub Microsoft STL wiki Changelog](https://github.com/microsoft/STL/wiki/Changelog) page. +For the latest information about ongoing conformance work, see: +- [STL C++23 Features](https://github.com/orgs/microsoft/projects/1142/views/2). +- [STL C++26 Features](https://github.com/orgs/microsoft/projects/1143/views/2). + | Feature | Supported | |--|--| | **C++14 Standard library features** | **Supported** | @@ -438,7 +444,7 @@ A more detailed listing of Standard Library features and bug fixes by product ve |  [`P1208R6 `](https://wg21.link/P1208R6) | VS 2019 16.10 [20](#note_20) | |  [`P1502R1 Standard Library Header Units`](https://wg21.link/P1502R1) | VS 2019 16.10 [20](#note_20) | |  [`P1614R2 Adding Spaceship <=> To The Library`](https://wg21.link/P1614R2) | VS 2019 16.10 [20](#note_20) | -|  [`P1285R0 Improving Completeness Requirements For Type Traits`](https://wg21.link/P1285R0) | N/A | +|  [`P1285R0 Improving Completeness Requirements For Type Traits`](https://wg21.link/P1285R0) | VS 2022 v17.14 | | **C++20 Standard library features (Defect reports)** | **Supported** | |  [`P2325R3 Views Should Not Be Required To Be Default Constructible`](https://wg21.link/P2325r3) | VS 2022 17.0 [20abi](#note_20abi) | |  [`P2328R1 join_view should join all views of ranges`](https://wg21.link/P2328R1) | VS 2022 17.0 [20abi](#note_20abi) | @@ -477,16 +483,20 @@ A more detailed listing of Standard Library features and bug fixes by product ve |  [`P2186R2 Removed garbage collection support`](https://wg21.link/P2186R2) | VS 2022 17.0 [23](#note_23), [Q](#note_Q) | |  [`P2251R1 Require span And basic_string_view To Be Trivially Copyable`](https://wg21.link/p2251r1) | VS 2022 17.1 [23](#note_23) | |  [`P2273R3 constexpr unique_ptr`](https://wg21.link/p2273r3) | VS 2022 17.3 [23](#note_23) | +|  [`P2280R4 Using unknown pointers and references in constant expressions`](https://wg21.link/p2280r4) | MSVC Build Tools version 14.5 [24](#note_24) | +|  [`P2290R3 Delimited escape sequences`](https://wg21.link/p2290r3) | MSVC Build Tools version 14.5 [24](#note_24) | |  [`P2291R3 constexpr Integral `](https://wg21.link/p2291r3) | VS 2022 17.4 [23](#note_23) | |  [`P2302R4 ranges::contains, ranges::contains_subrange`](https://wg21.link/p2302r4) | VS 2022 17.4 [23](#note_23) | |  [`P2321R2 std::zip`](https://wg21.link/p2321r2) | partial in VS 2022 17.5 [23](#note_23) | |  [`P2322R6 ranges::fold_left, ranges::fold_right, etc.`](https://wg21.link/p2322r6) | VS 2022 17.5 [23](#note_23) | +|  [`P2360R0 Extend init-statement to allow alias-declaration`](https://wg21.link/p2360r0) | MSVC Build Tools version 14.5 [24](#note_24) | |  [`P2387R3 Pipe Support For User-Defined Range Adaptors`](https://wg21.link/p2387r3) | VS 2022 17.4 [23](#note_23) | |  [`P2393R1 Cleaning Up Integer-Class Types`](https://wg21.link/p2393r1) | VS 2022 17.2 [23](#note_23) | |  [`P2401R0 Conditional noexcept For exchange()`](https://wg21.link/p2401r0) | VS 2022 17.1 [23](#note_23) | |  [`P2408R5 Ranges Iterators As Inputs To Non-Ranges Algorithms`](https://wg21.link/p2408r5) | VS 2022 17.4 [23](#note_23) | |  [`P2417R2 More constexpr bitset`](https://wg21.link/p2417r2) | VS 2022 17.4 [23](#note_23) | |  [`P2419R2 Clarify Handling Of Encodings In Localized Formatting Of chrono Types`](https://wg21.link/p2419r2) | VS 2022 17.4 [23](#note_23) | +|  [`P2437R1 Support for #warning`](https://wg21.link/p2437r1) | MSVC Build Tools version 14.50 [24](#note_24) | |  [`P2438R2 string::substr() &&`](https://wg21.link/p2438r2) | VS 2022 17.4 [23](#note_23) | |  [`P2440R1 ranges::iota, ranges::shift_left, ranges::shift_right`](https://wg21.link/p2440r1) | VS 2022 17.4 [23](#note_23) | |  [`P2441R2 views::join_with`](https://wg21.link/p2441r2) | VS 2022 17.4 [23](#note_23) | @@ -570,11 +580,12 @@ A group of papers listed together indicates a Standard feature along with one or **VS 2022 17.2** Supported in Visual Studio 2022 version 17.2.\ **VS 2022 17.3** Supported in Visual Studio 2022 version 17.3.\ **VS 2022 17.4** Supported in Visual Studio 2022 version 17.4.\ -**VS 2022 17.5** Supported in Visual Studio 2022 version 17.5. +**VS 2022 17.5** Supported in Visual Studio 2022 version 17.5.\ +**MSVC Build Tools version 14.50** Supported in Visual Studio 2026 18.0 (MSVC compiler version 19.50) and up. ### Notes - **A** In [`/std:c++14`](../build/reference/std-specify-language-standard-version.md) mode, dynamic exception specifications remain unimplemented, and `throw()` is still treated as a synonym for `__declspec(nothrow)`. In C++17, dynamic exception specifications were mostly removed by P0003R5, except for one vestige: `throw()` is deprecated and required to behave as a synonym for **`noexcept`**. In [`/std:c++17`](../build/reference/std-specify-language-standard-version.md) mode, MSVC now conforms to the Standard by giving `throw()` the same behavior as **`noexcept`**, that is, enforcement via termination. + **A** In [`/std:c++14`](../build/reference/std-specify-language-standard-version.md) mode, the compiler leaves dynamic exception specifications unimplemented, and treats `throw()` as a synonym for `__declspec(nothrow)`. In C++17, P0003R5 removed most dynamic exception specifications, except for one vestige: the standard deprecated `throw()` and requires it to behave as a synonym for **`noexcept`**. In [`/std:c++17`](../build/reference/std-specify-language-standard-version.md) mode, MSVC now conforms to the Standard by giving `throw()` the same behavior as **`noexcept`**, that is, enforcement via termination. The compiler option [`/Zc:noexceptTypes`](../build/reference/zc-noexcepttypes.md) requests the old behavior of `__declspec(nothrow)`. It's likely that `throw()` will be removed in a future version of C++. To help with migrating code in response to these changes in the Standard and the Microsoft implementation, new compiler warnings for exception specification issues are added under [`/std:c++17`](../build/reference/std-specify-language-standard-version.md) and [`/permissive-`](../build/reference/permissive-standards-conformance.md). @@ -588,7 +599,7 @@ The compiler option [`/Zc:noexceptTypes`](../build/reference/zc-noexcepttypes.md **F** Features removed when the [`/std:c++17`](../build/reference/std-specify-language-standard-version.md) or later compiler option is specified. To re-enable these features (to ease the transition to newer language modes), use these macros: `_HAS_AUTO_PTR_ETC`, `_HAS_FUNCTION_ALLOCATOR_SUPPORT`, `_HAS_OLD_IOSTREAMS_MEMBERS`, and `_HAS_UNEXPECTED`. - **G** C++17's parallel algorithms library is complete. Complete doesn't mean that every algorithm is parallelized in every case. The most important algorithms have been parallelized. Execution policy signatures are provided even where the implementation doesn't parallelize algorithms. The central internal header, ``, contains the following "Parallel Algorithms Notes": C++ allows an implementation to implement parallel algorithms as calls to the serial algorithms. This implementation parallelizes several common algorithm calls, but not all. + **G** C++17's parallel algorithms library is complete. Complete doesn't mean that every algorithm is parallelized in every case. The most important algorithms are parallelized. Execution policy signatures are provided even where the implementation doesn't parallelize algorithms. The central internal header, ``, contains the following "Parallel Algorithms Notes": C++ allows an implementation to implement parallel algorithms as calls to the serial algorithms. This implementation parallelizes several common algorithm calls, but not all. The following algorithms are parallelized: @@ -602,7 +613,7 @@ These algorithms aren't presently parallelized: - `generate`, `generate_n` - Effective parallelism of these algorithms might be infeasible: - `partial_sort`, `partial_sort_copy` -- These algorithms haven't been evaluated yet. The library might implement parallelism in a future release: +- These algorithms aren't evaluated yet. The library might implement parallelism in a future release: - `copy_if`, `includes`, `inplace_merge`, `lexicographical_compare`, `max_element`, `merge`, `min_element`, `minmax_element`, `nth_element`, `partition_copy`, `remove_copy`, `remove_copy_if`, `replace_copy`, `replace_copy_if`, `set_symmetric_difference`, `set_union`, `stable_partition`, `unique`, `unique_copy` **H** This is a wholly new implementation, incompatible with the previous `std::experimental` version, made necessary by symlink support, bug fixes, and changes in standard-required behavior. Currently, `` provides both the new `std::filesystem` and the previous `std::experimental::filesystem`. The `` header provides only the old experimental implementation. Expect removal of the experimental implementation in the next ABI-breaking release of the libraries. @@ -613,7 +624,7 @@ These algorithms aren't presently parallelized: **K** MSVC doesn't support the `_Complex` keyword or native complex types. The Universal CRT `` uses implementation-specific macros to achieve the same effect. For more information, see [C complex math support](../c-runtime-library/complex-math-support.md). - **L** The Universal CRT doesn't implement the `strftime` `E` and `O` alternative conversion modifiers. These modifiers are ignored (for example, `%Oe` behaves the same as `%e`). The modifiers aren't supported by the underlying locale APIs. + **L** The Universal CRT doesn't implement the `strftime` `E` and `O` alternative conversion modifiers. These modifiers are ignored (for example, `%Oe` behaves the same as `%e`). The underlying locale APIs don’t support the modifiers. **M** The Universal CRT doesn't implement C11 `aligned_alloc`, but does provide [`_aligned_malloc`](../c-runtime-library/reference/aligned-malloc.md) and [`_aligned_free`](../c-runtime-library/reference/aligned-free.md). Because the Windows operating system doesn't support aligned allocations, this function is unlikely to be implemented. @@ -631,6 +642,10 @@ These algorithms aren't presently parallelized: **T** `` is currently supported when compiled as C++ (`/std:c++latest`). It isn't yet supported when compiled as C (`/std:c11` and `/std:c17`) + **U** Extended floating-point types are an optional C++23 feature. This feature won't be implemented until C++23 standardization is finalized. + + **V** Use the compiler options `/source-charset:utf-8` and `/we4828` to treat source files as UTF-8 encoded. + **14** These C++17 and C++20 features are always enabled, even when [`/std:c++14`](../build/reference/std-specify-language-standard-version.md) (the default) is specified. The reason is either because the feature was implemented before the introduction of the **`/std`** options, or because conditional implementation was undesirably complex. **17** These features are enabled by the [`/std:c++17`](../build/reference/std-specify-language-standard-version.md) or later compiler option. @@ -641,6 +656,8 @@ These algorithms aren't presently parallelized: **23** In Visual Studio 2022 version 17.0 and up, these features are enabled by the [`/std:c++latest`](../build/reference/std-specify-language-standard-version.md) compiler option. + **24** In MSVC Build Tools version 14.50 and up (first shipped with Visual Studio 2026 version 18.0), these features are enabled by the [`/std:c++latest`](../build/reference/std-specify-language-standard-version.md) compiler option. + **C11** Compiler support for C11 and C17 requires Visual Studio 2019 version 16.8 or higher. Except as noted, C11 and C17 library support requires Windows SDK build 10.0.20211.0 or higher. For more information on how to install support for C11 and C17, see [Install C11 and C17 support in Visual Studio](./install-c17-support.md). **DR** These features are enabled in all C++ [`/std`](../build/reference/std-specify-language-standard-version.md) compiler option modes. The C++ Standard committee adopted this change as a retroactive Defect Report to C++11 and all later versions. @@ -652,7 +669,7 @@ These algorithms aren't presently parallelized: [C++ Language Reference](../cpp/cpp-language-reference.md)\ [C++ Standard Library](../standard-library/cpp-standard-library-reference.md)\ [C++ conformance improvements in Visual Studio](cpp-conformance-improvements.md)\ -[What's New for Visual C++ in Visual Studio](what-s-new-for-visual-cpp-in-visual-studio.md)\ +[What's New for Microsoft C++ in Visual Studio](what-s-new-for-visual-cpp-in-visual-studio.md)\ [Visual C++ change history 2003 through 2015](../porting/visual-cpp-change-history-2003-2015.md)\ [Visual C++ What's New 2003 through 2015](../porting/visual-cpp-what-s-new-2003-through-2015.md)\ [C++ team blog](https://devblogs.microsoft.com/cppblog/) diff --git a/docs/overview/visual-cpp-tools-and-features-in-visual-studio-editions.md b/docs/overview/visual-cpp-tools-and-features-in-visual-studio-editions.md index 8f68bdd1c4a..05aadb31dd0 100644 --- a/docs/overview/visual-cpp-tools-and-features-in-visual-studio-editions.md +++ b/docs/overview/visual-cpp-tools-and-features-in-visual-studio-editions.md @@ -3,7 +3,6 @@ description: "Learn more about: C++ Tools and Features in Visual Studio Editions title: "C++ Tools and Features in Visual Studio Editions" ms.date: 10/27/2021 helpviewer_keywords: ["tools and platforms [C++]"] -ms.assetid: 3d88607b-9cc4-490a-8d4c-31ee7610a26f --- # C++ Tools and Features in Visual Studio Editions @@ -15,7 +14,7 @@ The following C++ features are available in Visual Studio. Unless stated otherwi ::: moniker range="<=msvc-150" -The following tables show Visual C++ features that are available in Visual Studio 2017. An X in a cell indicates that the feature is available; an empty cell indicates that the feature is not available. Notes in parentheses indicate that a feature is available, but restricted. +The following tables show C++ features that are available in Visual Studio 2017. An X in a cell indicates that the feature is available; an empty cell indicates that the feature is not available. Notes in parentheses indicate that a feature is available, but restricted. ::: moniker-end @@ -29,6 +28,9 @@ The following tables show Visual C++ features that are available in Visual Studi - Android - iOS +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + ::: moniker-end ::: moniker range="<=msvc-150" @@ -257,6 +259,9 @@ Optional Components: ### Mobile development with C++ +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + Included: - C++ core features diff --git a/docs/overview/what-s-new-for-cpp-2019.md b/docs/overview/what-s-new-for-cpp-2019.md index e79f0e6d590..341347e69cd 100644 --- a/docs/overview/what-s-new-for-cpp-2019.md +++ b/docs/overview/what-s-new-for-cpp-2019.md @@ -134,7 +134,7 @@ For a summary of new features and bug fixes in Visual Studio version 16.8, see [ - Support for ARM64 projects using clang-cl. -- [Intel AMX intrinsics](https://software.intel.com/content/www/us/en/develop/documentation/cpp-compiler-developer-guide-and-reference/top/compiler-reference/intrinsics/intrinsics-for-intel-advanced-matrix-extensions-intel-amx-instructions.html) support. +- [Intel AMX intrinsics](https://www.intel.com/content/www/us/en/developer/articles/code-sample/advanced-matrix-extensions-intrinsics-functions.html) support. ## What's new for C++ in Visual Studio version 16.7 diff --git a/docs/overview/what-s-new-for-msvc.md b/docs/overview/what-s-new-for-msvc.md new file mode 100644 index 00000000000..31aabe88305 --- /dev/null +++ b/docs/overview/what-s-new-for-msvc.md @@ -0,0 +1,173 @@ +--- +title: "What's new for MSVC Build Tools" +description: "The new features and fixes in the Microsoft C/C++ compiler and tools (MSVC)." +ms.date: 05/15/2026 +ms.service: "visual-cpp" +ms.subservice: "cpp-lang" +ms.custom: intro-whats-new +--- + +# What's new for MSVC Build Tools + +Version 14.51 brings many updates and fixes to the Microsoft C++ compiler and other build tools. + +- For more information about what's new in all of Visual Studio, see [Visual Studio 2026 release notes](/visualstudio/releases/2026/release-notes). + +## What's new for MSVC Build Tools version 14.51 + +* Introduced in Visual Studio 2026 version 18.6 released May 2026. + +Visual Studio 2026 version 18.6 ships with the v145 platform toolset for MSBuild C++ projects and Microsoft C++ (MSVC) Build Tools version 14.51. To access all the new language features, build with `/std:c++latest`. Or, if you want to be restricted to features up to C++23, use `/std:c++23preview`. + +MSVC Build Tools version 14.51 preserves binary compatibility with code built with MSVC tools shipped in Visual Studio 2015 or later. For more information about binary compatibility, see [C++ binary compatibility between Visual Studio versions](/cpp/porting/binary-compat-2015-2017). + +| For detailed information about | See | +|---|---| +| What's new for C++ developers | [MSVC Build Tools version 14.51 Release Candidate Now Available](https://devblogs.microsoft.com/cppblog/msvc-build-tools-version-14-51-release-candidate-now-available/) | +| Standard Library (STL) improvements | [STL Changelog MSVC Build Tools 14.51](https://github.com/microsoft/STL/wiki/Changelog#msvc-build-tools-1451) | +| C++ language conformance improvements | [C/C++ Conformance improvements, behavior changes, and bug fixes in Microsoft C++ (MSVC) Build Tools](msvc-conformance-improvements.md) | + +Here's a quick highlight of some of the new features in MSVC Build Tools version 14.51: + +### C++ language enhancements + +- More C++23 and C++20 features and conformance issue fixes. For full C++23 details, see [C++23 Support in MSVC Build Tools 14.51](https://devblogs.microsoft.com/cppblog/c23-support-in-msvc-build-tools-14-51). +- Multiple fixes to `consteval` function handling, including support for constexpr `new`/`delete` in modules. The `/experimental:constevalVfuncVtable` behavior is now enabled by default. +- Added support for C language features: `_Atomic` qualifier and `__typeof__` for function types. +- Fixed incorrect diagnostics for C99 flexible array members. +- MSVC now generates IFC files according to [version 0.44](https://github.com/microsoft/ifc-spec/releases/tag/0.44) of the [IFC specification](https://github.com/microsoft/ifc-spec). +- Improved parser error recovery. + +## C language enhancements + +Added `_Atomic` qualifier support and added `__typeof__` support for function types. +Fixed [C4319](/cpp/error-messages/compiler-warnings/compiler-warning-level-1-c4319) not being emitted when compiling C code. + +### Standard Library enhancements + +- Added new C++23 headers: `` ([P0429R9](https://wg21.link/P0429R9)) and `` ([P1222R4](https://wg21.link/P1222R4)). +- **Massive `` overhaul:** Fixed long-standing correctness and performance problems. The implementation includes significant performance improvements. +- **ARM64 NEON vectorization:** First release shipping NEON-vectorized STL algorithms for ARM64/ARM64EC. Previously, only x64/x86 received SIMD optimizations with SSE4.2 and AVX2. Vectorized implementations are now available for algorithms including `swap_ranges()`, `rotate()`, `reverse()`, `min_element()`, `max_element()`, `find()`, `count()`, and more. +- Implemented 18 Library Working Group (LWG) issue resolutions, including fixes for duration conversion overflow, `construct_at` array support, and `optional` const overloads. +- Optimized integer-to-string conversions by printing digits in pairs. The Standard Template Library is now optimized for speed instead of size. +- Added type traits to detect references binding to temporaries ([P2255R2](https://wg21.link/P2255R2)). +- Added explicit lifetime management support ([P2590R2](https://wg21.link/P2590R2)). +- Enhanced debugger visualizations, including a `c_str()` intrinsic function for `basic_string` that enables conditional breakpoints. + +### Build enhancements + +- **Arm SVE support:** First Arm Scalable Vector Extension (SVE) support in MSVC, including frontend type support, intrinsic lowering, callee-saved register unwinding, and DIA SDK support. +- **Sample-based PGO:** Preview support for sample-based profile guided optimizations. For more information, see [Use Sample Profile Guided Optimization (SPGO) to improve C++ performance](../build/sample-profile-guided-optimization.md). +- The C++ backend optimizer improves code generation, including better inlining, loop optimizations, and pattern matching. +- **Experimental support for x64 Unwind Version 3 MASM directives**. For more information, see [Unwind Version 3 directives (experimental)](../assembler/masm/directives-reference.md#x64-unwind-version-3-experimental) +- **Intel APX preview:** Preview support for Intel Advanced Performance Extensions. For more information, see [/feature (x64)](../build/reference/feature-x64.md), [`[[msvc::enable(feature:APX)]]`](../cpp/attributes.md#msvcenablefeatureapx), and [`[[msvc::disable(feature:APX)]]`](../cpp/attributes.md#msvcdisablefeatureapx). +- Enabled debug info pruning to reduce PDB sizes. + +### Deprecations + +- The following experimental coroutine headers are now deprecated: ``, ``, and ``. Transition to standard C++20 coroutines using the `` header. + +### Removed features + +The following long-deprecated non-Standard features have been removed: + +- **TR1** including the `std::tr1` namespace, old `array::assign()`, and old `` engines and distributions. Deprecated since VS 2017 15.5 (December 2017). +- **`_ALLOW_RTCc_IN_STL`** macro removed. The Standard Template Library doesn't support the `/RTCc` compiler option, but `/RTCs` and `/RTCu`/`/RTC1` remain supported. +- **`` and ``**. Deprecated since VS 2015 (July 2015). +- **``**. Deprecated since VS 2019 16.3 (September 2019). +- **`stdext::checked_array_iterator` and `stdext::unchecked_array_iterator`**. Deprecated since VS 2022 17.8 (November 2023) for C++17 and later. +- **`basic_istream::ipfx()`/`isfx()` and `basic_ostream::opfx()`/`osfx()`**. Deprecated since VS 2022 17.9 (February 2024) for C++17 and later. +- **`locale::empty()`**. Deprecated since VS 2022 17.14 (May 2025). + +## What's new for MSVC Build Tools version 14.50 + +* Introduced in Visual Studio 2026 version 18.0 released November 2025. + +Visual Studio 2026 version 18.0 ships with the v145 platform toolset for MSBuild C++ projects and Microsoft C++ (MSVC) Build Tools version 14.50, which offers the best conformance, build performance, and runtime performance story yet. To access all the new language features, build with `/std:c++latest`. Or, if you want to be restricted to features up to C++23, use `/std:c++23preview`. + +MSVC Build Tools version 14.50 preserves binary compatibility with code built with MSVC tools shipped in Visual Studio 2015 or later. For more information about binary compatibility, see [C++ binary compatibility between Visual Studio versions](/cpp/porting/binary-compat-2015-2017). + +| For detailed information about | See | +|---|---| +| What's new for C++ developers | [What’s New for C++ Developers in Visual Studio 2026 version 18.0](https://devblogs.microsoft.com/cppblog/whats-new-for-cpp-developers-in-visual-studio-2026-version-18-0) | +| C++ Standard Library (STL) improvements | [STL Changelog MSVC Build Tools 14.50](https://github.com/microsoft/STL/wiki/Changelog#msvc-build-tools-1450) | +| C++ language updates | [C++ Language Updates in MSVC Build Tools v14.50](https://devblogs.microsoft.com/cppblog/c-language-updates-in-msvc-build-tools-v14-50/) | +| C++ language conformance improvements | [C/C++ Conformance improvements, behavior changes, and bug fixes in Microsoft C++ (MSVC) Build Tools](msvc-conformance-improvements.md) | + +Here's a quick highlight of some of the new features in MSVC Build Tools version 14.50 and Visual Studio 2026 version 18.0: + +### C++ language enhancements + +- C++20 is the default for new Console App, Windows Desktop Application, Dynamic-Link Library, and Static Library C++ projects. +- C++23 preprocessing directive `#warning` allows you to generate a diagnostic message without stopping translation as `#error` does. For more information, see [`#warning` directive](/cpp/preprocessor/hash-warning-directive-c-cpp). +- Easily set debugger command-line arguments for any C++ project using the toolbar for `.vcxproj`, CMake, and Unreal Engine projects. This feature is no longer tied to the Game Development with C++ workload, and is available to all C++ developers without installing any other workloads or components. For more information, see [Pass command-line arguments](/visualstudio/debugger/getting-started-with-the-debugger-cpp?view=visualstudio&preserve-view=true). + +### Standard Library enhancements + +- Enhanced `` reliability and speed. [LWG-2503](https://cplusplus.github.io/LWG/issue2503) added a multiline option to `syntax_option_type`. This is a `regex` behavioral change. By default, `_REGEX_LEGACY_MULTILINE_MODE` is 0, which requests Standard behavior. Set `_REGEX_LEGACY_MULTILINE_MODE` to 1 to request legacy behavior. For more information, see [STL Changelog](https://github.com/microsoft/STL/wiki/Changelog#msvc-build-tools-1450). +- Added and improved vectorized implementations of many types and functions. + +### GitHub Copilot enhancements + +- Copilot Chat allows you to use natural language to get answers to questions (Ask mode) or even implement changes for you automatically (Agent Mode). +- Copilot Chat is smarter with improved context for everyday tasks. Expect better results when searching your codebase and referencing specific lines in your code. +- A **Copilot Actions** option was added to the right-click context menu in the Visual Studio editor. Use it to quickly bring a specific file or lines of code you select to the attention of Copilot Chat. You can then ask Copilot to explain what the code does, make optimizations, generate comments, generate unit tests, and more. +- Better AI code completions for C++. GitHub Copilot uses context from relevant files to improve inline autocomplete for C++. GitHub Copilot includes other relevant files as context, which reduces hallucinations while offering more relevant and accurate suggestions. +- For more information, see [New GitHub Copilot capabilities for C++ developers: Upgrade MSVC, improve build performance, and refactor C++ code](https://devblogs.microsoft.com/cppblog/new-github-copilot-capabilities-for-c-developers-upgrade-msvc-improve-build-performance-and-refactor-c-code/). + +### Build enhancements + +- Visual Studio 2026 now includes CMake 4.1.1 by default. CMake also includes a Visual Studio 2026 generator and supports modern SLNX projects, so you can build Visual Studio C++ projects directly from CMake. +- Includes the latest version of the IncrediBuild engine and an updated extension that works with Visual Studio 2026 version 18.0. +- Compiler backend runtime performance improvements. Compared to Visual Studio version 17.14, there's up to a 6% improvement on Unreal Engine's City Sample RenderThread and up to +3% improvements on Unreal Engine's City Sample GameThread benchmark. For more information, see [Why you should upgrade your C++ build tools](https://devblogs.microsoft.com/cppblog/upgrading-c-projects-to-visual-studio-2026/#why-you-should-upgrade-your-c++-build-tools). +- The Visual Studio setup assistant can help you retarget your projects to build with the latest MSVC Build Tools. For more information, see [Retarget your projects with the setup assistant](https://devblogs.microsoft.com/cppblog/upgrading-c-projects-to-visual-studio-2026/#retarget-your-projects-with-the-setup-assistant). + +### Code analysis enhancements + +- Clang-Tidy code analysis improvements provide enhanced configuration options for faster builds and custom workflows: + - Code analysis has new configuration options. You can now allocate more processors to run code analysis as part of your build, speeding up your development workflow. + - You can add custom arguments to the command line used to invoke `clang-tidy`, giving you complete control over your analysis setup. + - Access the new options from **Project Properties** > **Code Analysis** > **Clang-Tidy**: + +![Screenshot of Project Properties dialog showing clang-tidy configuration options including processor allocation and custom command line arguments](./media/clang-tidy-improvements.png) +- AddressSanitizer support for ARM64 Builds (Preview): For some time, the MSVC Build Tools supported building projects that target x64 and x86 with [AddressSanitizer](/cpp/sanitizers/asan), which allows you to identify hard-to-find memory safety issues with zero false positives at runtime and increase memory safety. Now you can use AddressSanitizer to target ARM64. This feature is in preview. + +### Productivity enhancements + +- Generate preprocessed output for a C++ file. In Visual Studio, right-click a C++ file to instantly generate its preprocessed output, making it easy to debug macros and includes, and see errors immediately: ![Screenshot showing the right-click context menu for a C++ file with the Preprocess option highlighted.](./media/cpp-preprocess-menu-entry.png) +- The Visual Studio debugger now shows the return values of functions inline. This provides real-time visibility into function behavior without stepping into code or setting up watches, making it faster to catch logic issues or unexpected results: ![Screenshot showing inline post-return values displayed in the debugger next to function call."](./media/inline-post-return-value.png) + +### Other changes + +- In the Visual Studio installer, the *C++ Linux* workload is renamed *Linux, Mac, and embedded development with C++*. + +### Deprecations + +- The minimum supported target operating systems for the MSVC Build Tools version 14.50 are Windows 10 or Windows Server 2016. +- MSVC Build Tools version 14.50 no longer targets: + + - Windows 7 / Windows Server 2008 R2 + - Windows 8 / Windows Server 2012 + - Windows 8.1 / Windows Server 2012 R2 + + These changes allow for better performance, enhanced security, and alignment with the most recent Windows platform capabilities. + +The MSVC compiler switch [`/await`](/cpp/build/reference/await-enable-coroutine-support) is deprecated and will be removed in a future release. This switch enabled an early draft implementation of C++ coroutines using the `` header. Developers should transition to standard C++ coroutines by using the `` header available in C++20 and later. For C++14/17 projects, use `/await:strict` (which isn't being deprecated) to access the standard `` header without enabling other C++20 features. + +The Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. This impacts tooling support for iOS and Android development, including new projects, building, and debugging. + +### Removed features + +- C++AMP +- ARM32 toolchain: if you still need to build for ARM32, use an older version of the MSVC Build Tools. For more information, see [Side-by-side Minor Version MSVC Toolsets in Visual Studio 2019](https://devblogs.microsoft.com/cppblog/side-by-side-minor-version-msvc-toolsets-in-visual-studio-2019/). +- `/DEBUG:FASTLINK` linker switch. Use [`/DEBUG:FULL`](/cpp/build/reference/debug-generate-debug-info) for improved debugging support. + +## Feedback and suggestions + +We'd love to hear from you! You can [Report a Problem or Suggest a Feature](/visualstudio/ide/how-to-report-a-problem-with-visual-studio) by using the Send Feedback icon in the upper right-hand corner of either the installer or the Visual Studio IDE, or from **Help** > **Send Feedback**. You can track your issues by using [Visual Studio Developer Community](https://developercommunity.visualstudio.com/), where you add comments or find solutions. You can also get free installation help through our [Live Chat support](https://visualstudio.microsoft.com/vs/support/#talktous). + +## Blogs + +Stay up to date on all new releases by taking advantage of the insights and recommendations available in at [Microsoft Developer Blogs](https://devblogs.microsoft.com/). The blogs include deep dive posts on a broad range of features. + +The [C++ Team Blog](https://devblogs.microsoft.com/cppblog) and the [Visual Studio Blog](https://devblogs.microsoft.com/visualstudio) are of particular interest. diff --git a/docs/overview/what-s-new-for-visual-cpp-in-visual-studio.md b/docs/overview/what-s-new-for-visual-cpp-in-visual-studio.md index 4f546d1d8c0..491f55e9093 100644 --- a/docs/overview/what-s-new-for-visual-cpp-in-visual-studio.md +++ b/docs/overview/what-s-new-for-visual-cpp-in-visual-studio.md @@ -1,14 +1,18 @@ --- title: "What's new for C++ in Visual Studio" description: "The new features and fixes in the Microsoft C/C++ compiler and tools in Visual Studio." -ms.date: 05/13/2025 +ms.date: 11/04/2025 ms.service: "visual-cpp" ms.subservice: "ide" ms.custom: intro-whats-new ai-usage: ai-assisted --- -# What's new for C++ in Visual Studio 2022 +# What's new for C++ in Visual Studio + +Microsoft C++ Build Tools (MSVC Build Tools) versioning is no longer synchronized with Visual Studio versioning starting with Visual Studio 2026 version 18.0 and Microsoft C++ Build Tools version 14.50. For the latest updates to MSVC going forward, see [What's new for MSVC](what-s-new-for-msvc.md). + +## What's new for C++ in Visual Studio 2022 Visual Studio 2022 brings many updates and fixes to the Microsoft C++ compiler and tools. The Visual Studio IDE also offers significant improvements in performance and productivity, and now runs natively as a 64-bit application. diff --git a/docs/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md b/docs/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md deleted file mode 100644 index d4b2d50056a..00000000000 --- a/docs/parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -description: "Learn more about: C++ AMP (C++ Accelerated Massive Parallelism)" -title: "C++ AMP (C++ Accelerated Massive Parallelism)" -ms.date: "11/04/2016" -helpviewer_keywords: ["C++ AMP (see C++ Accelerated Massive Parallelism)", "C++ Accelerated Massive Parallelism, getting started"] ---- -# C++ AMP (C++ Accelerated Massive Parallelism) - -C++ AMP (C++ Accelerated Massive Parallelism) accelerates the execution of your C++ code by taking advantage of the data-parallel hardware that's commonly present as a graphics processing unit (GPU) on a discrete graphics card. The C++ AMP programming model includes support for multidimensional arrays, indexing, memory transfer, and tiling. It also includes a mathematical function library. You can use C++ AMP language extensions to control how data is moved from the CPU to the GPU and back. - -> [!NOTE] -> C++ AMP headers are deprecated starting with Visual Studio 2022 version 17.0. -> Including any AMP headers will generate build errors. Define `_SILENCE_AMP_DEPRECATION_WARNINGS` before including any AMP headers to silence the warnings. - -## Related Topics - -|Title|Description| -|-----------|-----------------| -|[C++ AMP Overview](../../parallel/amp/cpp-amp-overview.md)|Describes the key features of C++ AMP and the mathematical library.| -|[Using Lambdas, Function Objects, and Restricted Functions](../../parallel/amp/using-lambdas-function-objects-and-restricted-functions.md)|Describes how to use lambda expressions, function objects, and restricted functions in calls to the [parallel_for_each](reference/concurrency-namespace-functions-amp.md#parallel_for_each) method.| -|[Using Tiles](../../parallel/amp/using-tiles.md)|Describes how to use tiles to accelerate your C++ AMP code.| -|[Using accelerator and accelerator_view Objects](../../parallel/amp/using-accelerator-and-accelerator-view-objects.md)|Describes how to use accelerators to customize execution of your code on the GPU.| -|[Using C++ AMP in UWP Apps](../../parallel/amp/using-cpp-amp-in-windows-store-apps.md)|Describes how to use C++ AMP in Universal Windows Platform (UWP) apps that use Windows Runtime types.| -|[Graphics (C++ AMP)](../../parallel/amp/graphics-cpp-amp.md)|Describes how to use the C++ AMP graphics library.| -|[Walkthrough: Matrix Multiplication](../../parallel/amp/walkthrough-matrix-multiplication.md)|Demonstrates matrix multiplication using C++ AMP code and tiling.| -|[Walkthrough: Debugging a C++ AMP Application](../../parallel/amp/walkthrough-debugging-a-cpp-amp-application.md)|Explains how to create and debug an application that uses parallel reduction to sum up a large array of integers.| - -## Reference - -[Reference (C++ AMP)](../../parallel/amp/reference/reference-cpp-amp.md)
-[tile_static Keyword](../../cpp/tile-static-keyword.md)
-[restrict (C++ AMP)](../../cpp/restrict-cpp-amp.md) - -## Other Resources - -[Parallel Programming in Native Code Blog](/archive/blogs/nativeconcurrency/)
-[C++ AMP sample projects for download](/archive/blogs/nativeconcurrency/c-amp-sample-projects-for-download)
-[Analyzing C++ AMP Code with the Concurrency Visualizer](/archive/blogs/nativeconcurrency/analyzing-c-amp-code-with-the-concurrency-visualizer) diff --git a/docs/parallel/amp/cpp-amp-overview.md b/docs/parallel/amp/cpp-amp-overview.md deleted file mode 100644 index 71492d2b0f3..00000000000 --- a/docs/parallel/amp/cpp-amp-overview.md +++ /dev/null @@ -1,505 +0,0 @@ ---- -title: "C++ AMP Overview" -description: "Learn more about: C++ AMP Overview" -ms.date: 11/19/2018 -ms.topic: concept-article -helpviewer_keywords: ["C++ Accelerated Massive Parallelism, requirements", "C++ Accelerated Massive Parallelism, architecture", "C++ AMP", "C++ Accelerated Massive Parallelism, overview", "C++ Accelerated Massive Parallelism"] ---- -# C++ AMP Overview - -> [!NOTE] -> C++ AMP headers are deprecated starting with Visual Studio 2022 version 17.0. -> Including any AMP headers will generate build errors. Define `_SILENCE_AMP_DEPRECATION_WARNINGS` before including any AMP headers to silence the warnings. - -C++ Accelerated Massive Parallelism (C++ AMP) accelerates execution of C++ code by taking advantage of data-parallel hardware such as a graphics processing unit (GPU) on a discrete graphics card. By using C++ AMP, you can code multi-dimensional data algorithms so that execution can be accelerated by using parallelism on heterogeneous hardware. The C++ AMP programming model includes multidimensional arrays, indexing, memory transfer, tiling, and a mathematical function library. You can use C++ AMP language extensions to control how data is moved from the CPU to the GPU and back, so that you can improve performance. - -## System Requirements - -- Windows 7 or later - -- Windows Server 2008 R2 through Visual Studio 2019. - -- DirectX 11 Feature Level 11.0 or later hardware - -- For debugging on the software emulator, Windows 8 or Windows Server 2012 is required. For debugging on the hardware, you must install the drivers for your graphics card. For more information, see [Debugging GPU Code](/visualstudio/debugger/debugging-gpu-code). - -- Note: AMP is currently not supported on ARM64. - -## Introduction - -The following two examples illustrate the primary components of C++ AMP. Assume that you want to add the corresponding elements of two one-dimensional arrays. For example, you might want to add `{1, 2, 3, 4, 5}` and `{6, 7, 8, 9, 10}` to obtain `{7, 9, 11, 13, 15}`. Without using C++ AMP, you might write the following code to add the numbers and display the results. - -```cpp -#include - -void StandardMethod() { - - int aCPP[] = {1, 2, 3, 4, 5}; - int bCPP[] = {6, 7, 8, 9, 10}; - int sumCPP[5]; - - for (int idx = 0; idx < 5; idx++) - { - sumCPP[idx] = aCPP[idx] + bCPP[idx]; - } - - for (int idx = 0; idx < 5; idx++) - { - std::cout << sumCPP[idx] << "\n"; - } -} -``` - -The important parts of the code are as follows: - -- Data: The data consists of three arrays. All have the same rank (one) and length (five). - -- Iteration: The first **`for`** loop provides a mechanism for iterating through the elements in the arrays. The code that you want to execute to compute the sums is contained in the first **`for`** block. - -- Index: The `idx` variable accesses the individual elements of the arrays. - -Using C++ AMP, you might write the following code instead. - -```cpp -#include -#include -using namespace concurrency; - -const int size = 5; - -void CppAmpMethod() { - int aCPP[] = {1, 2, 3, 4, 5}; - int bCPP[] = {6, 7, 8, 9, 10}; - int sumCPP[size]; - - // Create C++ AMP objects. - array_view a(size, aCPP); - array_view b(size, bCPP); - array_view sum(size, sumCPP); - sum.discard_data(); - - parallel_for_each( - // Define the compute domain, which is the set of threads that are created. - sum.extent, - // Define the code to run on each thread on the accelerator. - [=](index<1> idx) restrict(amp) { - sum[idx] = a[idx] + b[idx]; - } - ); - - // Print the results. The expected output is "7, 9, 11, 13, 15". - for (int i = 0; i < size; i++) { - std::cout << sum[i] << "\n"; - } -} -``` - -The same basic elements are present, but C++ AMP constructs are used: - -- Data: You use C++ arrays to construct three C++ AMP [array_view](../../parallel/amp/reference/array-view-class.md) objects. You supply four values to construct an `array_view` object: the data values, the rank, the element type, and the length of the `array_view` object in each dimension. The rank and type are passed as type parameters. The data and length are passed as constructor parameters. In this example, the C++ array that is passed to the constructor is one-dimensional. The rank and length are used to construct the rectangular shape of the data in the `array_view` object, and the data values are used to fill the array. The runtime library also includes the [array Class](../../parallel/amp/reference/array-class.md), which has an interface that resembles the `array_view` class and is discussed later in this article. - -- Iteration: The [parallel_for_each Function (C++ AMP)](reference/concurrency-namespace-functions-amp.md#parallel_for_each) provides a mechanism for iterating through the data elements, or *compute domain*. In this example, the compute domain is specified by `sum.extent`. The code that you want to execute is contained in a lambda expression, or *kernel function*. The `restrict(amp)` indicates that only the subset of the C++ language that C++ AMP can accelerate is used. - -- Index: The [index Class](../../parallel/amp/reference/index-class.md) variable, `idx`, is declared with a rank of one to match the rank of the `array_view` object. By using the index, you can access the individual elements of the `array_view` objects. - -## Shaping and Indexing Data: index and extent - -You must define the data values and declare the shape of the data before you can run the kernel code. All data is defined to be an array (rectangular), and you can define the array to have any rank (number of dimensions). The data can be any size in any of the dimensions. - -### index Class - -The [index Class](../../parallel/amp/reference/index-class.md) specifies a location in the `array` or `array_view` object by encapsulating the offset from the origin in each dimension into one object. When you access a location in the array, you pass an `index` object to the indexing operator, `[]`, instead of a list of integer indexes. You can access the elements in each dimension by using the [array::operator() Operator](reference/array-class.md#operator_call) or the [array_view::operator() Operator](reference/array-view-class.md#operator_call). - -The following example creates a one-dimensional index that specifies the third element in a one-dimensional `array_view` object. The index is used to print the third element in the `array_view` object. The output is 3. - -```cpp -int aCPP[] = {1, 2, 3, 4, 5}; -array_view a(5, aCPP); - -index<1> idx(2); - -std::cout << a[idx] << "\n"; -// Output: 3 -``` - -The following example creates a two-dimensional index that specifies the element where the row = 1 and the column = 2 in a two-dimensional `array_view` object. The first parameter in the `index` constructor is the row component, and the second parameter is the column component. The output is 6. - -```cpp -int aCPP[] = {1, 2, 3, 4, 5, 6}; -array_view a(2, 3, aCPP); - -index<2> idx(1, 2); - -std::cout < a(2, 3, 4, aCPP); - -// Specifies the element at 3, 1, 0. -index<3> idx(0, 1, 3); - -std::cout << a[idx] << "\n"; -// Output: 8 -``` - -### extent Class - -The [extent Class](../../parallel/amp/reference/extent-class.md) specifies the length of the data in each dimension of the `array` or `array_view` object. You can create an extent and use it to create an `array` or `array_view` object. You can also retrieve the extent of an existing `array` or `array_view` object. The following example prints the length of the extent in each dimension of an `array_view` object. - -```cpp -int aCPP[] = { - 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, - 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12}; -// There are 3 rows and 4 columns, and the depth is two. -array_view a(2, 3, 4, aCPP); - -std::cout << "The number of columns is " << a.extent[2] << "\n"; -std::cout << "The number of rows is " << a.extent[1] << "\n"; -std::cout << "The depth is " << a.extent[0] << "\n"; -std::cout << "Length in most significant dimension is " << a.extent[0] << "\n"; -``` - -The following example creates an `array_view` object that has the same dimensions as the object in the previous example, but this example uses an `extent` object instead of using explicit parameters in the `array_view` constructor. - -```cpp -int aCPP[] = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24}; -extent<3> e(2, 3, 4); - -array_view a(e, aCPP); - -std::cout << "The number of columns is " << a.extent[2] << "\n"; -std::cout << "The number of rows is " << a.extent[1] << "\n"; -std::cout << "The depth is " << a.extent[0] << "\n"; -``` - -## Moving Data to the Accelerator: array and array_view - -Two data containers used to move data to the accelerator are defined in the runtime library. They are the [array Class](../../parallel/amp/reference/array-class.md) and the [array_view Class](../../parallel/amp/reference/array-view-class.md). The `array` class is a container class that creates a deep copy of the data when the object is constructed. The `array_view` class is a wrapper class that copies the data when the kernel function accesses the data. When the data is needed on the source device the data is copied back. - -### array Class - -When an `array` object is constructed, a deep copy of the data is created on the accelerator if you use a constructor that includes a pointer to the data set. The kernel function modifies the copy on the accelerator. When the execution of the kernel function is finished, you must copy the data back to the source data structure. The following example multiplies each element in a vector by 10. After the kernel function is finished, the `vector conversion operator` is used to copy the data back into the vector object. - -```cpp -std::vector data(5); - -for (int count = 0; count <5; count++) -{ - data[count] = count; -} - -array a(5, data.begin(), data.end()); - -parallel_for_each( - a.extent, - [=, &a](index<1> idx) restrict(amp) { - a[idx] = a[idx]* 10; - }); - -data = a; -for (int i = 0; i < 5; i++) -{ - std::cout << data[i] << "\n"; -} -``` - -### array_view Class - -The `array_view` has nearly the same members as the `array` class, but the underlying behavior is not the same. Data passed to the `array_view` constructor is not replicated on the GPU as it is with an `array` constructor. Instead, the data is copied to the accelerator when the kernel function is executed. Therefore, if you create two `array_view` objects that use the same data, both `array_view` objects refer to the same memory space. When you do this, you have to synchronize any multithreaded access. The main advantage of using the `array_view` class is that data is moved only if it is necessary. - -### Comparison of array and array_view - -The following table summarizes the similarities and differences between the `array` and `array_view` classes. - -|Description|array class|array_view class| -|-----------------|-----------------|-----------------------| -|When rank is determined|At compile time.|At compile time.| -|When extent is determined|At run time.|At run time.| -|Shape|Rectangular.|Rectangular.| -|Data storage|Is a data container.|Is a data wrapper.| -|Copy|Explicit and deep copy at definition.|Implicit copy when it is accessed by the kernel function.| -|Data retrieval|By copying the array data back to an object on the CPU thread.|By direct access of the `array_view` object or by calling the [array_view::synchronize Method](reference/array-view-class.md#synchronize) to continue accessing the data on the original container.| - -### Shared memory with array and array_view - -Shared memory is memory that can be accessed by both the CPU and the accelerator. The use of shared memory eliminates or significantly reduces the overhead of copying data between the CPU and the accelerator. Although the memory is shared, it cannot be accessed concurrently by both the CPU and the accelerator, and doing so causes undefined behavior. - -`array` objects can be used to specify fine-grained control over the use of shared memory if the associated accelerator supports it. Whether an accelerator supports shared memory is determined by the accelerator's [supports_cpu_shared_memory](reference/accelerator-class.md#supports_cpu_shared_memory) property, which returns **`true`** when shared memory is supported. If shared memory is supported, the default [access_type Enumeration](reference/concurrency-namespace-enums-amp.md#access_type) for memory allocations on the accelerator is determined by the `default_cpu_access_type` property. By default, `array` and `array_view` objects take on the same `access_type` as the primary associated `accelerator`. - -By setting the [array::cpu_access_type Data Member](reference/array-class.md#cpu_access_type) property of an `array` explicitly, you can exercise fine-grained control over how shared memory is used, so that you can optimize the app for the hardware's performance characteristics, based on the memory access patterns of its computation kernels. An `array_view` reflects the same `cpu_access_type` as the `array` that it's associated with; or, if the array_view is constructed without a data source, its `access_type` reflects the environment that first causes it to allocate storage. That is, if it's first accessed by the host (CPU), then it behaves as if it were created over a CPU data source and shares the `access_type` of the `accelerator_view` associated by capture; however, if it's first accessed by an `accelerator_view`, then it behaves as if it were created over an `array` created on that `accelerator_view` and shares the `array`'s `access_type`. - -The following code example shows how to determine whether the default accelerator supports shared memory, and then creates several arrays that have different cpu_access_type configurations. - -```cpp -#include -#include - -using namespace Concurrency; - -int main() -{ - accelerator acc = accelerator(accelerator::default_accelerator); - - // Early out if the default accelerator doesn't support shared memory. - if (!acc.supports_cpu_shared_memory) - { - std::cout << "The default accelerator does not support shared memory" << std::endl; - return 1; - } - - // Override the default CPU access type. - acc.default_cpu_access_type = access_type_read_write - - // Create an accelerator_view from the default accelerator. The - // accelerator_view inherits its default_cpu_access_type from acc. - accelerator_view acc_v = acc.default_view; - - // Create an extent object to size the arrays. - extent<1> ex(10); - - // Input array that can be written on the CPU. - array arr_w(ex, acc_v, access_type_write); - - // Output array that can be read on the CPU. - array arr_r(ex, acc_v, access_type_read); - - // Read-write array that can be both written to and read from on the CPU. - array arr_rw(ex, acc_v, access_type_read_write); -} -``` - -## Executing Code over Data: parallel_for_each - -The [parallel_for_each](reference/concurrency-namespace-functions-amp.md#parallel_for_each) function defines the code that you want to run on the accelerator against the data in the `array` or `array_view` object. Consider the following code from the introduction of this topic. - -```cpp -#include -#include -using namespace concurrency; - -void AddArrays() { - int aCPP[] = {1, 2, 3, 4, 5}; - int bCPP[] = {6, 7, 8, 9, 10}; - int sumCPP[5] = {0, 0, 0, 0, 0}; - - array_view a(5, aCPP); - array_view b(5, bCPP); - array_view sum(5, sumCPP); - - parallel_for_each( - sum.extent, - [=](index<1> idx) restrict(amp) - { - sum[idx] = a[idx] + b[idx]; - } - ); - - for (int i = 0; i < 5; i++) { - std::cout << sum[i] << "\n"; - } -} -``` - -The `parallel_for_each` method takes two arguments, a compute domain and a lambda expression. - -The *compute domain* is an `extent` object or a `tiled_extent` object that defines the set of threads to create for parallel execution. One thread is generated for each element in the compute domain. In this case, the `extent` object is one-dimensional and has five elements. Therefore, five threads are started. - -The *lambda expression* defines the code to run on each thread. The capture clause, `[=]`, specifies that the body of the lambda expression accesses all captured variables by value, which in this case are `a`, `b`, and `sum`. In this example, the parameter list creates a one-dimensional `index` variable named `idx`. The value of the `idx[0]` is 0 in the first thread and increases by one in each subsequent thread. The `restrict(amp)` indicates that only the subset of the C++ language that C++ AMP can accelerate is used. The limitations on functions that have the restrict modifier are described in [restrict (C++ AMP)](../../cpp/restrict-cpp-amp.md). For more information, see, [Lambda Expression Syntax](../../cpp/lambda-expression-syntax.md). - -The lambda expression can include the code to execute or it can call a separate kernel function. The kernel function must include the `restrict(amp)` modifier. The following example is equivalent to the previous example, but it calls a separate kernel function. - -```cpp -#include -#include -using namespace concurrency; - -void AddElements( - index<1> idx, - array_view sum, - array_view a, - array_view b) restrict(amp) { - sum[idx] = a[idx] + b[idx]; -} - -void AddArraysWithFunction() { - - int aCPP[] = {1, 2, 3, 4, 5}; - int bCPP[] = {6, 7, 8, 9, 10}; - int sumCPP[5] = {0, 0, 0, 0, 0}; - - array_view a(5, aCPP); - array_view b(5, bCPP); - array_view sum(5, sumCPP); - - parallel_for_each( - sum.extent, - [=](index<1> idx) restrict(amp) { - AddElements(idx, sum, a, b); - } - ); - - for (int i = 0; i < 5; i++) { - std::cout << sum[i] << "\n"; - } -} -``` - -## Accelerating Code: Tiles and Barriers - -You can gain additional acceleration by using tiling. Tiling divides the threads into equal rectangular subsets or *tiles*. You determine the appropriate tile size based on your data set and the algorithm that you are coding. For each thread, you have access to the *global* location of a data element relative to the whole `array` or `array_view` and access to the *local* location relative to the tile. Using the local index value simplifies your code because you don't have to write the code to translate index values from global to local. To use tiling, call the [extent::tile Method](reference/extent-class.md#tile) on the compute domain in the `parallel_for_each` method, and use a [tiled_index](../../parallel/amp/reference/tiled-index-class.md) object in the lambda expression. - -In typical applications, the elements in a tile are related in some way, and the code has to access and keep track of values across the tile. Use the [tile_static Keyword](../../cpp/tile-static-keyword.md) keyword and the [tile_barrier::wait Method](reference/tile-barrier-class.md#wait) to accomplish this. A variable that has the **tile_static** keyword has a scope across an entire tile, and an instance of the variable is created for each tile. You must handle synchronization of tile-thread access to the variable. The [tile_barrier::wait Method](reference/tile-barrier-class.md#wait) stops execution of the current thread until all the threads in the tile have reached the call to `tile_barrier::wait`. So you can accumulate values across the tile by using **tile_static** variables. Then you can finish any computations that require access to all the values. - -The following diagram represents a two-dimensional array of sampling data that is arranged in tiles. - -![Index values in a tiled extent.](../../parallel/amp/media/camptiledgridexample.png "Index values in a tiled extent") - -The following code example uses the sampling data from the previous diagram. The code replaces each value in the tile by the average of the values in the tile. - -```cpp -// Sample data: -int sampledata[] = { - 2, 2, 9, 7, 1, 4, - 4, 4, 8, 8, 3, 4, - 1, 5, 1, 2, 5, 2, - 6, 8, 3, 2, 7, 2}; - -// The tiles: -// 2 2 9 7 1 4 -// 4 4 8 8 3 4 -// -// 1 5 1 2 5 2 -// 6 8 3 2 7 2 - -// Averages: -int averagedata[] = { - 0, 0, 0, 0, 0, 0, - 0, 0, 0, 0, 0, 0, - 0, 0, 0, 0, 0, 0, - 0, 0, 0, 0, 0, 0, -}; - -array_view sample(4, 6, sampledata); - -array_view average(4, 6, averagedata); - -parallel_for_each( - // Create threads for sample.extent and divide the extent into 2 x 2 tiles. - sample.extent.tile<2,2>(), - [=](tiled_index<2,2> idx) restrict(amp) { - // Create a 2 x 2 array to hold the values in this tile. - tile_static int nums[2][2]; - - // Copy the values for the tile into the 2 x 2 array. - nums[idx.local[1]][idx.local[0]] = sample[idx.global]; - - // When all the threads have executed and the 2 x 2 array is complete, find the average. - idx.barrier.wait(); - int sum = nums[0][0] + nums[0][1] + nums[1][0] + nums[1][1]; - - // Copy the average into the array_view. - average[idx.global] = sum / 4; - }); - -for (int i = 0; i <4; i++) { - for (int j = 0; j <6; j++) { - std::cout << average(i,j) << " "; - } - std::cout << "\n"; -} - -// Output: -// 3 3 8 8 3 3 -// 3 3 8 8 3 3 -// 5 5 2 2 4 4 -// 5 5 2 2 4 4 -``` - -## Math Libraries - -C++ AMP includes two math libraries. The double-precision library in the [Concurrency::precise_math Namespace](../../parallel/amp/reference/concurrency-precise-math-namespace.md) provides support for double-precision functions. It also provides support for single-precision functions, although double-precision support on the hardware is still required. It conforms to the [C99 Specification (ISO/IEC 9899)](https://go.microsoft.com/fwlink/p/?linkid=225887). The accelerator must support full double precision. You can determine whether it does by checking the value of the [accelerator::supports_double_precision Data Member](reference/accelerator-class.md#supports_double_precision). The fast math library, in the [Concurrency::fast_math Namespace](../../parallel/amp/reference/concurrency-fast-math-namespace.md), contains another set of math functions. These functions, which support only **`float`** operands, execute more quickly but aren't as precise as those in the double-precision math library. The functions are contained in the \ header file and all are declared with `restrict(amp)`. The functions in the \ header file are imported into both the `fast_math` and `precise_math` namespaces. The **`restrict`** keyword is used to distinguish the \ version and the C++ AMP version. The following code calculates the base-10 logarithm, using the fast method, of each value that is in the compute domain. - -```cpp -#include -#include -#include -using namespace concurrency; - -void MathExample() { - - double numbers[] = { 1.0, 10.0, 60.0, 100.0, 600.0, 1000.0 }; - array_view logs(6, numbers); - - parallel_for_each( - logs.extent, - [=] (index<1> idx) restrict(amp) { - logs[idx] = concurrency::fast_math::log10(numbers[idx]); - } - ); - - for (int i = 0; i < 6; i++) { - std::cout << logs[i] << "\n"; - } -} -``` - -## Graphics Library - -C++ AMP includes a graphics library that is designed for accelerated graphics programming. This library is used only on devices that support native graphics functionality. The methods are in the [Concurrency::graphics Namespace](../../parallel/amp/reference/concurrency-graphics-namespace.md) and are contained in the \ header file. The key components of the graphics library are: - -- [texture Class](../../parallel/amp/reference/texture-class.md): You can use the texture class to create textures from memory or from a file. Textures resemble arrays because they contain data, and they resemble containers in the C++ Standard Library with respect to assignment and copy construction. For more information, see [C++ Standard Library Containers](../../standard-library/stl-containers.md). The template parameters for the `texture` class are the element type and the rank. The rank can be 1, 2, or 3. The element type can be one of the short vector types that are described later in this article. - -- [writeonly_texture_view Class](../../parallel/amp/reference/writeonly-texture-view-class.md): Provides write-only access to any texture. - -- Short Vector Library: Defines a set of short vector types of length 2, 3, and 4 that are based on **`int`**, `uint`, **`float`**, **`double`**, [norm](../../parallel/amp/reference/norm-class.md), or [unorm](../../parallel/amp/reference/unorm-class.md). - -## Universal Windows Platform (UWP) Apps - -Like other C++ libraries, you can use C++ AMP in your UWP apps. These articles describe how to include C++ AMP code in apps that is created by using C++, C#, Visual Basic, or JavaScript: - -- [Using C++ AMP in UWP Apps](../../parallel/amp/using-cpp-amp-in-windows-store-apps.md) - -- [Walkthrough: Creating a basic Windows Runtime component in C++ and calling it from JavaScript](/previous-versions/windows/apps/hh755833(v=vs.140)) - -- [Bing Maps Trip Optimizer, a Window Store app in JavaScript and C++](/previous-versions/windows/apps/hh699893(v=vs.140)) - -- [How to use C++ AMP from C# using the Windows Runtime](https://devblogs.microsoft.com/pfxteam/how-to-use-c-amp-from-c-using-winrt/) - -- [How to use C++ AMP from C#](https://devblogs.microsoft.com/pfxteam/how-to-use-c-amp-from-c/) - -- [Calling Native Functions from Managed Code](../../dotnet/calling-native-functions-from-managed-code.md) - -## C++ AMP and Concurrency Visualizer - -The Concurrency Visualizer includes support for analyzing performance of C++ AMP code. These articles describe these features: - -- [GPU Activity Graph](/visualstudio/profiling/gpu-activity-graph) - -- [GPU Activity (Paging)](/visualstudio/profiling/gpu-activity-paging) - -- [GPU Activity (This Process)](/visualstudio/profiling/gpu-activity-this-process) - -- [GPU Activity (Other Processes)](/visualstudio/profiling/gpu-activity-other-processes) - -- [Channels (Threads View)](/visualstudio/profiling/channels-threads-view) - -- [Analyzing C++ AMP Code with the Concurrency Visualizer](/archive/blogs/nativeconcurrency/analyzing-c-amp-code-with-the-concurrency-visualizer) - -## Performance Recommendations - -Modulus and division of unsigned integers have significantly better performance than modulus and division of signed integers. We recommend that you use unsigned integers when possible. - -## See also - -[C++ AMP (C++ Accelerated Massive Parallelism)](../../parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md)
-[Lambda Expression Syntax](../../cpp/lambda-expression-syntax.md)
-[Reference (C++ AMP)](../../parallel/amp/reference/reference-cpp-amp.md)
-[Parallel Programming in Native Code Blog](/archive/blogs/nativeconcurrency/) diff --git a/docs/parallel/amp/graphics-cpp-amp.md b/docs/parallel/amp/graphics-cpp-amp.md deleted file mode 100644 index 5368ba8b88e..00000000000 --- a/docs/parallel/amp/graphics-cpp-amp.md +++ /dev/null @@ -1,428 +0,0 @@ ---- -title: "Graphics (C++ AMP)" -description: "Learn more about: Graphics (C++ AMP)" -ms.date: 11/04/2016 ---- -# Graphics (C++ AMP) - -C++ AMP contains several APIs in the [`Concurrency::graphics`](../../parallel/amp/reference/concurrency-graphics-namespace.md) namespace that you can use to access the texture support on GPUs. Some common scenarios are: - -- You can use the [`texture`](../../parallel/amp/reference/texture-class.md) class as a data container for computation and exploit the *spatial locality* of the texture cache and layouts of GPU hardware. Spatial locality is the property of data elements being physically close to each other. - -- The runtime provides efficient interoperability with non-compute shaders. Pixel, vertex, tessellation, and hull shaders frequently consume or produce textures that you can use in your C++ AMP computations. - -- The graphics APIs in C++ AMP provide alternative ways to access sub-word packed buffers. Textures that have formats that represent *texels* (texture elements) that are composed of 8-bit or 16-bit scalars allow access to such packed data storage. - -> [!NOTE] -> C++ AMP headers are deprecated starting with Visual Studio 2022 version 17.0. -> Including any AMP headers will generate build errors. Define `_SILENCE_AMP_DEPRECATION_WARNINGS` before including any AMP headers to silence the warnings. - -## The norm and unorm Types - -The `norm` and `unorm` types are scalar types that limit the range of **`float`** values; this is known as *clamping*. These types can be explicitly constructed from other scalar types. In casting, the value is first cast to **`float`** and then clamped to the respective region that's allowed by `norm [-1.0, 1.0]` or `unorm [0.0, 1.0]`. Casting from +/- infinity returns +/-1. Casting from NaN is undefined. A `norm` can be implicitly constructed from a `unorm` and there is no loss of data. The implicit conversion operator to **`float`** is defined on these types. Binary operators are defined between these types and other built-in scalar types such as **`float`** and **`int`**: `+`, `-`, `*`, `/`, `==`, `!=`, `>`, `<`, `>=`, `<=`. The compound assignment operators are also supported: `+=`, `-=`, `*=`, `/=`. The unary negation operator (`-`) is defined for `norm` types. - -## Short Vector Library - -The Short Vector Library provides some of the functionality of the [Vector Type](/windows/win32/direct3dhlsl/dx-graphics-hlsl-vector) that's defined in HLSL and is typically used to define texels. A short vector is a data structure that holds one to four values of the same type. The supported types are **`double`**, **`float`**, **`int`**, `norm`, `uint`, and `unorm`. The type names are shown in the following table. For each type, there is also a corresponding **`typedef`** that doesn't have an underscore in the name. The types that have the underscores are in the [Concurrency::graphics Namespace](../../parallel/amp/reference/concurrency-graphics-namespace.md). The types that don't have the underscores are in the [Concurrency::graphics::direct3d Namespace](../../parallel/amp/reference/concurrency-graphics-direct3d-namespace.md) so that they are clearly separated from the similarly-named fundamental types such as **`__int8`** and **`__int16`**. - -|Type|Length 2|Length 3|Length 4| -|-|--------------|--------------|--------------| -|double|double_2

double2|double_3

double3|double_4

double4| -|float|float_2

float2|float_3

float3|float_4

float4| -|int|int_2

int2|int_3

int3|int_4

int4| -|norm|norm_2

norm2|norm_3

norm3|norm_4

norm4| -|uint|uint_2

uint2|uint_3

uint3|uint_4

uint4| -|unorm|unorm_2

unorm2|unorm_3

unorm3|unorm_4

unorm4| - -### Operators - -If an operator is defined between two short vectors, then it is also defined between a short vector and a scalar. Also, one of these must be true: - -- The scalar's type must be the same as the short vector's element type. - -- The scalar's type can be implicitly converted to the vector's element type by using only one user-defined conversion. - -The operation is carried component-wise between each component of the short vector and the scalar. Here are the valid operators: - -|Operator type|Valid types| -|-------------------|-----------------| -|Binary operators|Valid on all types: `+`, `-`, `*`, `/`,

Valid on integer types: `%`, `^`, `|`, `&`, `<<`, `>>`

The two vectors must have the same size, and the result is a vector of the same size.| -|Relational operators|Valid on all types: `==` and `!=`| -|Compound assignment operator|Valid on all types: `+=`, `-=`, `*=`, `/=`

Valid on integer types: `%=`, `^=`, `|=`, `&=`, `<<=`, `>>=`| -|Increment and decrement operators|Valid on all types: `++`, `--`

Both prefix and postfix are valid.| -|Bitwise NOT operator (`~`)|Valid on integer types.| -|Unary `-` operator|Valid on all types except `unorm` and `uint`.| - -### Swizzling Expressions - -The Short Vector Library supports the `vector_type.identifier` accessor construct to access the components of a short vector. The `identifier`, which is known as a *swizzling expression*, specifies the components of the vector. The expression can be an l-value or an r-value. Individual characters in the identifier may be: x, y, z, and w; or r, g, b, and a. "x" and "r" mean the zero-th component, "y" and "g" mean the first component, and so on. (Notice that "x" and "r" cannot be used in the same identifier.) Therefore, "rgba" and "xyzw" return the same result. Single-component accessors such as "x" and "y" are scalar value types. Multi-component accessors are short vector types. For example, if you construct an `int_4` vector that's named `fourInts` and has the values 2, 4, 6, and 8, then `fourInts.y` returns the integer 4 and `fourInts.rg` returns an `int_2` object that has the values 2 and 4. - -## Texture Classes - -Many GPUs have hardware and caches that are optimized to fetch pixels and texels and to render images and textures. The [`texture`](../../parallel/amp/reference/texture-class.md) class, which is a container class for texel objects, exposes the texture functionality of these GPUs. A texel can be: - -- An **`int`**, `uint`, **`float`**, **`double`**, `norm`, or `unorm` scalar. - -- A short vector that has two or four components. The only exception is `double_4`, which is not allowed. - -The `texture` object can have a rank of 1, 2, or 3. The `texture` object can be captured only by reference in the lambda of a call to `parallel_for_each`. The texture is stored on the GPU as Direct3D texture objects. For more information about textures and texels in Direct3D, see [Introduction to Textures in Direct3D 11](/windows/win32/direct3d11/overviews-direct3d-11-resources-textures-intro). - -The texel type you use might be one of the many texture formats that are used in graphics programming. For example, an RGBA format could use 32 bits, with 8 bits each for the R, G, B, and A scalar elements. The texture hardware of a graphics card can access the individual elements based on the format. For example, if you are using the RGBA format, the texture hardware can extract each 8-bit element into a 32-bit form. In C++ AMP, you can set the bits per scalar element of your texel so that you can automatically access the individual scalar elements in the code without using bit-shifting. - -### Instantiating Texture Objects - -You can declare a texture object without initialization. The following code example declares several texture objects. - -```cpp -#include -#include -using namespace concurrency; -using namespace concurrency::graphics; - -void declareTextures() { - // Create a 16-texel texture of int. - texture intTexture1(16); - texture intTexture2(extent<1>(16)); - - // Create a 16 x 32 texture of float_2. - texture floatTexture1(16, 32); - texture floatTexture2(extent<2>(16, 32)); - - // Create a 2 x 4 x 8 texture of uint_4. - texture uintTexture1(2, 4, 8); - texture uintTexture2(extent<3>(2, 4, 8)); -} -``` - -You can also use a constructor to declare and initialize a `texture` object. The following code example instantiates a `texture` object from a vector of `float_4` objects. The bits per scalar element is set to the default. You cannot use this constructor with `norm`, `unorm`, or the short vectors of `norm` and `unorm`, because they do not have a default bits per scalar element. - -```cpp -#include -#include -#include -using namespace concurrency; -using namespace concurrency::graphics; - -void initializeTexture() { - std::vector texels; - for (int i = 0; i < 768 * 1024; i++) { - int_4 i4(i, i, i, i); - texels.push_back(i4); - } - - texture aTexture(768, 1024, texels.begin(), texels.end()); -} -``` - -You can also declare and initialize a `texture` object by using a constructor overload that takes a pointer to the source data, the size of source data in bytes, and the bits per scalar element. - -```cpp -void createTextureWithBPC() { // Create the source data. - float source[1024* 2]; - for (int i = 0; i <1024* 2; i++) { - source[i] = (float)i; - } - // Initialize the texture by using the size of source in bytes // and bits per scalar element. - texture floatTexture(1024, source, (unsigned int)sizeof(source), 32U); -} -``` - -The textures in these examples are created on the default view of the default accelerator. You can use other overloads of the constructor if you want to specify an `accelerator_view` object. You cannot create a texture object on a CPU accelerator. - -There are limits on the size of each dimension of the `texture` object, as shown in the following table. A run-time error is generated if you exceed the limits. - -|Texture|Size limitation per dimension| -|-------------|---------------------| -|texture\|16384| -|texture\|16384| -|texture\|2048| - -### Reading from Texture Objects - -You can read from a `texture` object by using [texture::operator\[\]](reference/texture-class.md#operator_at), [texture::operator() Operator](reference/texture-class.md#operator_call), or [texture::get Method](reference/texture-class.md#get). The two operators return a value, not a reference. Therefore, you cannot write to a `texture` object by using `texture::operator[]`. - -```cpp -void readTexture() { - std::vector src; - for (int i = 0; i <16 *32; i++) { - int_2 i2(i, i); - - src.push_back(i2); - } - - std::vector dst(16* 32); - - array_view arr(16, 32, dst); - - arr.discard_data(); - - const texture tex9(16, 32, src.begin(), src.end()); - - parallel_for_each(tex9.extent, [=, &tex9] (index<2> idx) restrict(amp) { // Use the subscript operator. - arr[idx].x += tex9[idx].x; // Use the function () operator. - arr[idx].x += tex9(idx).x; // Use the get method. - arr[idx].y += tex9.get(idx).y; // Use the function () operator. - arr[idx].y += tex9(idx[0], idx[1]).y; - }); - - arr.synchronize(); -} -``` - -The following code example demonstrates how to store texture channels in a short vector, and then access the individual scalar elements as properties of the short vector. - -```cpp -void UseBitsPerScalarElement() { // Create the image data. // Each unsigned int (32-bit) represents four 8-bit scalar elements(r,g,b,a values). - const int image_height = 16; - const int image_width = 16; - std::vector image(image_height* image_width); - - extent<2> image_extent(image_height, image_width); - - // By using uint_4 and 8 bits per channel, each 8-bit channel in the data source is // stored in one 32-bit component of a uint_4. - texture image_texture(image_extent, image.data(), image_extent.size()* 4U, 8U); - - // Use can access the RGBA values of the source data by using swizzling expressions of the uint_4. - parallel_for_each(image_extent, - [&image_texture](index<2> idx) restrict(amp) - { // 4 bytes are automatically extracted when reading. - uint_4 color = image_texture[idx]; - unsigned int r = color.r; - unsigned int g = color.g; - unsigned int b = color.b; - unsigned int a = color.a; - }); -} -``` - -The following table lists the valid bits per channel for each sort vector type. - -|Texture data type|Valid bits per scalar element| -|-----------------------|-----------------------------------| -|int, int_2, int_4

uint, uint_2, uint_4|8, 16, 32| -|int_3, uint_3|32| -|float, float_2, float_4|16, 32| -|float_3|32| -|double, double_2|64| -|norm, norm_2, norm_4

unorm, unorm_2, unorm, 4|8, 16| - -### Writing to Texture Objects - -Use the [texture::set](reference/texture-class.md#set) method to write to `texture` objects. A texture object can be readonly or read/write. For a texture object to be readable and writeable, the following conditions must be true: - -- T has only one scalar component. (Short vectors are not allowed.) - -- T is not **`double`**, `norm`, or `unorm`. - -- The `texture::bits_per_scalar_element` property is 32. - -If all three are not true, then the `texture` object is readonly. The first two conditions are checked during compilation. A compilation error is generated if you have code that tries to write to a `readonly` texture object. The condition for `texture::bits_per_scalar_element` is detected at run time, and the runtime generates the [unsupported_feature](../../parallel/amp/reference/unsupported-feature-class.md) exception if you try to write to a readonly `texture` object. - -The following code example writes values to a texture object. - -```cpp -void writeTexture() { - texture tex1(16); - - parallel_for_each(tex1.extent, [&tex1] (index<1> idx) restrict(amp) { - tex1.set(idx, 0); - }); -} -``` - -### Copying Texture Objects - -You can copy between texture objects by using the [copy](reference/concurrency-namespace-functions-amp.md#copy) function or the [copy_async](reference/concurrency-namespace-functions-amp.md#copy_async) function, as shown in the following code example. - -```cpp -void copyHostArrayToTexture() { // Copy from source array to texture object by using the copy function. - float floatSource[1024* 2]; - for (int i = 0; i <1024* 2; i++) { - floatSource[i] = (float)i; - } - texture floatTexture(1024); - - copy(floatSource, (unsigned int)sizeof(floatSource), floatTexture); - - // Copy from source array to texture object by using the copy function. - char charSource[16* 16]; - for (int i = 0; i <16* 16; i++) { - charSource[i] = (char)i; - } - texture charTexture(16, 16, 8U); - - copy(charSource, (unsigned int)sizeof(charSource), charTexture); - // Copy from texture object to source array by using the copy function. - copy(charTexture, charSource, (unsigned int)sizeof(charSource)); -} -``` - -You can also copy from one texture to another by using the [texture::copy_to](reference/texture-class.md#copy_to) method. The two textures can be on different accelerator_views. When you copy to a `writeonly_texture_view` object, the data is copied to the underlying `texture` object. The bits per scalar element and the extent must be the same on the source and destination `texture` objects. If those requirements are not met, the runtime throws an exception. - -## Texture View Classes - -C++ AMP introduces the [texture_view Class](../../parallel/amp/reference/texture-view-class.md) in Visual Studio 2013. Texture views support the same texel types and ranks as the [texture Class](../../parallel/amp/reference/texture-class.md), but unlike textures, they provide access to additional hardware features such as texture sampling and mipmaps. Texture views support read-only, write-only, and read-write access to the underlying texture data. - -- Read-only access is provided by the `texture_view` template specialization, which supports elements that have 1, 2, or 4 components, texture sampling, and dynamic access to a range of mipmap levels that are determined when the view is instantiated. - -- Write-only access is provided by the non-specialized template class `texture_view`, which supports elements that have either 2 or 4 components and can access one mipmap level that's determined when the view is instantiated. It does not support sampling. - -- Read-write access is provided by the non-specialized template class `texture_view`, which, like textures, supports elements that have only one component; the view can access one mipmap level that's determined when it is instantiated. It does not support sampling. - -Texture views are analogous to array views, but do not provide the automatic data management and movement functionality that the [array_view Class](../../parallel/amp/reference/array-view-class.md) provides over the [array class](../../parallel/amp/reference/array-class.md). A `texture_view` can only be accessed on the accelerator view where the underlying texture data resides. - -### writeonly_texture_view Deprecated - -For Visual Studio 2013, C++ AMP introduces better support for hardware texture features such as sampling and mipmaps, which could not be supported by the [writeonly_texture_view Class](../../parallel/amp/reference/writeonly-texture-view-class.md). The newly introduced `texture_view` class supports a superset of the functionality in `writeonly_texture_view`; as a result, `writeonly_texture_view` is deprecated. - -We recommend—at least for new code—that you use `texture_view` to access functionality that was formerly provided by `writeonly_texture_view`. Compare the following two code examples that write to a texture object that has two components (int_2). Notice that in both cases, the view, `wo_tv4`, must be captured by value in the lambda expression. Here is the example that uses the new `texture_view` class: - -```cpp -void write2ComponentTexture() { - texture tex4(16); - - texture_view wo_tv4(tex4); - - parallel_for_each(extent<1>(16), [=] (index<1> idx) restrict(amp) { - wo_tv4.set(idx, int_2(1, 1)); - }); -} -``` - -And here is the deprecated `writeonly_texture_view` class: - -```cpp -void write2ComponentTexture() { - texture tex4(16); - - writeonly_texture_view wo_tv4(tex4); - - parallel_for_each(extent<1>(16), [=] (index<1> idx) restrict(amp) { - wo_tv4.set(idx, int_2(1, 1)); - }); -} -``` - -As you can see, the two code examples are nearly identical when all you are doing is writing to the primary mipmap level. If you used `writeonly_texture_view` in existing code and you're not planning to enhance that code, you don't have to change it. However, if you're thinking about bringing that code forward, we suggest that you rewrite it to use `texture_view` because the enhancements in it support new hardware texture features. Read on for more information about these new capabilities. - -For more information about the deprecation of `writeonly_texture_view`, see [Overview of the Texture View Design in C++ AMP](/archive/blogs/nativeconcurrency/overview-of-the-texture-view-design-in-c-amp) on the Parallel Programming in Native Code blog. - -### Instantiating Texture View Objects - -Declaring a `texture_view` is similar to declaring an `array_view` that's associated with an **array**. The following code example declares several `texture` objects and `texture_view` objects that are associated with them. - -```cpp -#include -#include -using namespace concurrency; -using namespace concurrency::graphics; - -void declareTextureViews() -{ - // Create a 16-texel texture of int, with associated texture_views. - texture intTexture(16); - texture_view intTextureViewRO(intTexture); // read-only - texture_view intTextureViewRW(intTexture); // read-write - - // Create a 16 x 32 texture of float_2, with associated texture_views. - texture floatTexture(16, 32); - texture_view floatTextureViewRO(floatTexture); // read-only - texture_view floatTextureViewRO(floatTexture); // write-only - - // Create a 2 x 4 x 8 texture of uint_4, with associated texture_views. - texture uintTexture(2, 4, 8); - texture_view uintTextureViewRO(uintTexture); // read-only - texture_view uintTextureViewWO(uintTexture); // write-only -} -``` - -Notice how a texture view whose element type is non-const and has one component is read-write, but a texture view whose element type is non-const but has more than one componenent are write-only. Texture views of const element types are always read-only, but if the element type is non-const, then the number of components in the element determines whether it is read-write (1 component) or write-only (multiple components). - -The element type of a `texture_view`—its const-ness and also the number of components it has—also plays a role in determining whether the view supports texture sampling, and how mipmap levels can be accessed: - -|Type|Components|Read|Write|Sampling|Mipmap access| -|----------|----------------|----------|-----------|--------------|-------------------| -|texture_view\|1, 2, 4|Yes|No (1)|Yes|Yes, indexable. Range is determined at instantiation.| -|Texture_view\|1

2, 4|Yes

No (2)|Yes

Yes|No (1)

No (1)|Yes, one level. Level is determined at instantiation.

Yes, one level. Level is determined at instantiation.| - -From this table, you can see that read-only texture views fully support the new capabilities in exchange for not being able to write to the view. Writable texture views are limited in that they can only access one mipmap level. Read-write texture views are even more specialized than writable ones, because they add the requirement that the element type of the texture view has only one component. Notice that sampling is not supported for writable texture views because it's a read-oriented operation. - -### Reading from Texture View Objects - -Reading unsampled texture data through a texture view is just like reading it from the texture itself, except that textures are captured by reference, whereas texture views are captured by value. The following two code examples demonstrate; first, by using `texture` only: - -```cpp -void write2ComponentTexture() { - texture text_data(16); - - parallel_for_each(extent<1>(16), [&] (index<1> idx) restrict(amp) { - tex_data.set(idx, int_2(1, 1)); - }); -} -``` - -And here is the same example, except it now uses the `texture_view` class: - -```cpp -void write2ComponentTexture() { - texture tex_data(16); - - texture_view tex_view(tex_data); - - parallel_for_each(extent<1>(16), [=] (index<1> idx) restrict(amp) { - tex_view.set(idx, int_2(1, 1)); - }); -} -``` - -Texture views whose elements are based on floating-point types—for example, float, float_2, or float_4—can also be read by using texture sampling to take advantage of hardware support for various filtering modes and addressing modes. C++ AMP supports the two filtering modes that are most common in compute scenarios—point-filtering (nearest-neighbor) and linear-filtering (weighted average)—and four addressing modes—wrapped, mirrored, clamped, and border. For more information about addressing modes, see [address_mode Enumeration](reference/concurrency-graphics-namespace-enums.md#address_mode). - -In addition to modes that C++ AMP supports directly, you can access other filtering modes and addressing modes of the underlying platform by using the interop APIs to adopt a texture sampler that was created by using the platform APIs directly. For example, Direct3D supports other filtering modes such as anisotropic filtering, and can apply a different addressing mode to each dimension of a texture. You could create a texture sampler whose coordinates are wrapped vertically, mirrored horizontally, and sampled with anisotropic filtering by using the Direct3D APIs, and then leverage the sampler in your C++ AMP code by using the `make_sampler` interop API. For more information, see [Texture Sampling in C++ AMP](/archive/blogs/nativeconcurrency/texture-sampling-in-c-amp) on the Parallel Programming in Native Code blog. - -Texture views also support the reading of mipmaps. Read-only texture views (those that have a const element type) offer the most flexibility because a range of mip-levels that is determined at instantiation can be dynamically sampled, and because elements that have 1, 2, or 4 components are supported. Read-write texture views that have elements that have one component also support mipmaps, but only of a level that's determined at instantiation. For more information, see [Texture with Mipmaps](/archive/blogs/nativeconcurrency/texture-with-mipmaps) on the Parallel Programming in Native Code blog. - -### Writing to Texture View Objects - -Use the [texture_view::get Method](reference/texture-view-class.md#get) to write to the underlying `texture` through the `texture_view` object. A texture view can be read-only, read-write, or write-only. For a texture view to be writable it must have an element type that is non-const; for a texture view to be readable and writable, its element type must also have only one component. Otherwise, the texture view is read-only. You can only access one mipmap level of a texture at a time through a texture view, and the level is specified when the view is instantiated. - -This example shows how to write to the second-most detailed mipmap level of a texture that has 4 mipmap levels. The most detailed mipmap level is level 0. - -```cpp -// Create a texture that has 4 mipmap levels : 16x16, 8x8, 4x4, 2x2 -texture tex(extent<2>(16, 16), 16U, 4); - -// Create a writable texture view to the second mipmap level :4x4 -texture_view w_view(tex, 1); - -parallel_for_each(w_view.extent, [=](index<2> idx) restrict(amp) -{ - w_view.set(idx, 123); -}); -``` - -## Interoperability - -The C++ AMP runtime supports interoperability between `texture` and the [ID3D11Texture1D interface](/windows/win32/api/d3d11/nn-d3d11-id3d11texture1d), between `texture` and the [ID3D11Texture2D interface](/windows/win32/api/d3d11/nn-d3d11-id3d11texture2d), and between `texture` and the [ID3D11Texture3D interface](/windows/win32/api/d3d11/nn-d3d11-id3d11texture3d). The [get_texture](reference/concurrency-graphics-direct3d-namespace-functions.md#get_texture) method takes a `texture` object and returns an `IUnknown` interface. The [make_texture](reference/concurrency-graphics-direct3d-namespace-functions.md#make_texture) method takes an `IUnknown` interface and an `accelerator_view` object and returns a `texture` object. - -## See also - -[double_2 Class](../../parallel/amp/reference/double-2-class.md)
-[double_3 Class](../../parallel/amp/reference/double-3-class.md)
-[double_4 Class](../../parallel/amp/reference/double-4-class.md)
-[float_2 Class](../../parallel/amp/reference/float-2-class.md)
-[float_3 Class](../../parallel/amp/reference/float-3-class.md)
-[float_4 Class](../../parallel/amp/reference/float-4-class.md)
-[int_2 Class](../../parallel/amp/reference/int-2-class.md)
-[int_3 Class](../../parallel/amp/reference/int-3-class.md)
-[int_4 Class](../../parallel/amp/reference/int-4-class.md)
-[norm_2 Class](../../parallel/amp/reference/norm-2-class.md)
-[norm_3 Class](../../parallel/amp/reference/norm-3-class.md)
-[norm_4 Class](../../parallel/amp/reference/norm-4-class.md)
-[short_vector Structure](../../parallel/amp/reference/short-vector-structure.md)
-[short_vector_traits Structure](../../parallel/amp/reference/short-vector-traits-structure.md)
-[uint_2 Class](../../parallel/amp/reference/uint-2-class.md)
-[uint_3 Class](../../parallel/amp/reference/uint-3-class.md)
-[uint_4 Class](../../parallel/amp/reference/uint-4-class.md)
-[unorm_2 Class](../../parallel/amp/reference/unorm-2-class.md)
-[unorm_3 Class](../../parallel/amp/reference/unorm-3-class.md)
-[unorm_4 Class](../../parallel/amp/reference/unorm-4-class.md) diff --git a/docs/parallel/amp/media/campc.PNG b/docs/parallel/amp/media/campc.PNG deleted file mode 100644 index adbcadddb1a..00000000000 Binary files a/docs/parallel/amp/media/campc.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campcpubreakpoints.png b/docs/parallel/amp/media/campcpubreakpoints.png deleted file mode 100644 index 44d1da5977a..00000000000 Binary files a/docs/parallel/amp/media/campcpubreakpoints.png and /dev/null differ diff --git a/docs/parallel/amp/media/campd.png b/docs/parallel/amp/media/campd.png deleted file mode 100644 index 2ea0f0cd8a9..00000000000 Binary files a/docs/parallel/amp/media/campd.png and /dev/null differ diff --git a/docs/parallel/amp/media/campe.png b/docs/parallel/amp/media/campe.png deleted file mode 100644 index 681bd4cc9ee..00000000000 Binary files a/docs/parallel/amp/media/campe.png and /dev/null differ diff --git a/docs/parallel/amp/media/campf.PNG b/docs/parallel/amp/media/campf.PNG deleted file mode 100644 index 627b78deb1d..00000000000 Binary files a/docs/parallel/amp/media/campf.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campg.PNG b/docs/parallel/amp/media/campg.PNG deleted file mode 100644 index 181d786a7b7..00000000000 Binary files a/docs/parallel/amp/media/campg.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campgpubreakpoints.png b/docs/parallel/amp/media/campgpubreakpoints.png deleted file mode 100644 index c3195246a9d..00000000000 Binary files a/docs/parallel/amp/media/campgpubreakpoints.png and /dev/null differ diff --git a/docs/parallel/amp/media/camph.png b/docs/parallel/amp/media/camph.png deleted file mode 100644 index 2688ccc2267..00000000000 Binary files a/docs/parallel/amp/media/camph.png and /dev/null differ diff --git a/docs/parallel/amp/media/campk.PNG b/docs/parallel/amp/media/campk.PNG deleted file mode 100644 index c4d12b983fd..00000000000 Binary files a/docs/parallel/amp/media/campk.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campl.PNG b/docs/parallel/amp/media/campl.PNG deleted file mode 100644 index aa55a8b92d1..00000000000 Binary files a/docs/parallel/amp/media/campl.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campmatrixanontiled.PNG b/docs/parallel/amp/media/campmatrixanontiled.PNG deleted file mode 100644 index 9d614e60639..00000000000 Binary files a/docs/parallel/amp/media/campmatrixanontiled.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campmatrixapartitioned.PNG b/docs/parallel/amp/media/campmatrixapartitioned.PNG deleted file mode 100644 index c7ea08435eb..00000000000 Binary files a/docs/parallel/amp/media/campmatrixapartitioned.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campmatrixatiled.PNG b/docs/parallel/amp/media/campmatrixatiled.PNG deleted file mode 100644 index 7e0e1fc8896..00000000000 Binary files a/docs/parallel/amp/media/campmatrixatiled.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campmatrixbnontiled.PNG b/docs/parallel/amp/media/campmatrixbnontiled.PNG deleted file mode 100644 index 2c7633e1787..00000000000 Binary files a/docs/parallel/amp/media/campmatrixbnontiled.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campmatrixbpartitioned.PNG b/docs/parallel/amp/media/campmatrixbpartitioned.PNG deleted file mode 100644 index 9e345d153e2..00000000000 Binary files a/docs/parallel/amp/media/campmatrixbpartitioned.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campmatrixbtiled.PNG b/docs/parallel/amp/media/campmatrixbtiled.PNG deleted file mode 100644 index a9a12d72da1..00000000000 Binary files a/docs/parallel/amp/media/campmatrixbtiled.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campmatrixproductnontiled.PNG b/docs/parallel/amp/media/campmatrixproductnontiled.PNG deleted file mode 100644 index 8632cfec780..00000000000 Binary files a/docs/parallel/amp/media/campmatrixproductnontiled.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campmatrixproductpartitioned.PNG b/docs/parallel/amp/media/campmatrixproductpartitioned.PNG deleted file mode 100644 index 82b5f65cba4..00000000000 Binary files a/docs/parallel/amp/media/campmatrixproductpartitioned.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/campmatrixproducttiled.PNG b/docs/parallel/amp/media/campmatrixproducttiled.PNG deleted file mode 100644 index 4339e6523f4..00000000000 Binary files a/docs/parallel/amp/media/campmatrixproducttiled.PNG and /dev/null differ diff --git a/docs/parallel/amp/media/camptiledgridexample.png b/docs/parallel/amp/media/camptiledgridexample.png deleted file mode 100644 index 8a82b2c08f9..00000000000 Binary files a/docs/parallel/amp/media/camptiledgridexample.png and /dev/null differ diff --git a/docs/parallel/amp/media/usingtilesmatrix.PNG b/docs/parallel/amp/media/usingtilesmatrix.PNG deleted file mode 100644 index 0175a433a18..00000000000 Binary files a/docs/parallel/amp/media/usingtilesmatrix.PNG and /dev/null differ diff --git a/docs/parallel/amp/reference/accelerator-class.md b/docs/parallel/amp/reference/accelerator-class.md deleted file mode 100644 index e5f08b9b8a2..00000000000 --- a/docs/parallel/amp/reference/accelerator-class.md +++ /dev/null @@ -1,524 +0,0 @@ ---- -title: "accelerator Class" -description: "Learn more about: accelerator Class" -ms.date: 11/04/2016 -f1_keywords: ["AMPRT/accelerator", "AMPRT/Concurrency::accelerator::accelerator", "AMPRT/Concurrency::accelerator::create_view", "AMPRT/Concurrency::accelerator::get_all", "AMPRT/Concurrency::accelerator::get_auto_selection_view", "AMPRT/Concurrency::accelerator::get_dedicated_memory", "AMPRT/Concurrency::accelerator::get_default_cpu_access_type", "AMPRT/Concurrency::accelerator::get_default_view", "AMPRT/Concurrency::accelerator::get_description", "AMPRT/Concurrency::accelerator::get_device_path", "AMPRT/Concurrency::accelerator::get_has_display", "AMPRT/Concurrency::accelerator::get_is_debug", "AMPRT/Concurrency::accelerator::get_is_emulated", "AMPRT/Concurrency::accelerator::get_supports_cpu_shared_memory", "AMPRT/Concurrency::accelerator::get_supports_double_precision", "AMPRT/Concurrency::accelerator::get_supports_limited_double_precision", "AMPRT/Concurrency::accelerator::get_version", "AMPRT/Concurrency::accelerator::set_default", "AMPRT/Concurrency::accelerator::set_default_cpu_access_type", "AMPRT/Concurrency::accelerator::cpu_accelerator", "AMPRT/Concurrency::accelerator::dedicated_memory", "AMPRT/Concurrency::accelerator::default_accelerator", "AMPRT/Concurrency::accelerator::default_cpu_access_type", "AMPRT/Concurrency::accelerator::default_view", "AMPRT/Concurrency::accelerator::description", "AMPRT/Concurrency::accelerator::device_path", "AMPRT/Concurrency::accelerator::direct3d_ref", "AMPRT/Concurrency::accelerator::direct3d_warp", "AMPRT/Concurrency::accelerator::has_display", "AMPRT/Concurrency::accelerator::is_debug", "AMPRT/Concurrency::accelerator::is_emulated", "AMPRT/Concurrency::accelerator::supports_cpu_shared_memory", "AMPRT/Concurrency::accelerator::supports_double_precision", "AMPRT/Concurrency::accelerator::supports_limited_double_precision", "AMPRT/Concurrency::accelerator::version"] -helpviewer_keywords: ["accelerator class"] ---- -# accelerator Class - -An accelerator is a hardware capability that is optimized for data-parallel computing. An accelerator may be a device attached to a PCIe bus (such as a GPU), or it might be an extended instruction set on the main CPU. - -## Syntax - -```cpp -class accelerator; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[accelerator Constructor](#ctor)|Initializes a new instance of the `accelerator` class.| -|[~accelerator Destructor](#ctor)|Destroys the `accelerator` object.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[create_view](#create_view)|Creates and returns an `accelerator_view` object on this accelerator.| -|[get_all](#get_all)|Returns a vector of `accelerator` objects that represent all the available accelerators.| -|[get_auto_selection_view](#get_auto_selection_view)|Returns the auto-selection `accelerator_view`.| -|[get_dedicated_memory](#get_dedicated_memory)|Returns the dedicated memory for the `accelerator`, in kilobytes.| -|[get_default_cpu_access_type](#get_default_cpu_access_type)|Returns the default [access_type](concurrency-namespace-enums-amp.md#access_type) for buffers created on this accelerator.| -|[get_default_view](#get_default_view)|Returns the default `accelerator_view` object that is associated with the `accelerator`.| -|[get_description](#get_description)|Returns a short description of the `accelerator` device.| -|[get_device_path](#get_device_path)|Returns the path of the device.| -|[get_has_display](#get_has_display)|Determines whether the `accelerator` is attached to a display.| -|[get_is_debug](#get_is_debug)|Determines whether the `accelerator` has the DEBUG layer enabled for extensive error reporting.| -|[get_is_emulated](#get_is_emulated)|Determines whether the `accelerator` is emulated.| -|[get_supports_cpu_shared_memory](#get_supports_cpu_shared_memory)|Determines whether the `accelerator` supports shared memory| -|[get_supports_double_precision](#get_supports_double_precision)|Determines whether the `accelerator` is attached to a display.| -|[get_supports_limited_double_precision](#get_supports_limited_double_precision)|Determines whether the `accelerator` has limited support for double-precision math.| -|[get_version](#get_version)|Returns the version of the `accelerator`.| -|[set_default](#set_default)|Returns the path of the default accelerator.| -|[set_default_cpu_access_type](#set_default_cpu_access_type)|Sets the default CPU [access_type](concurrency-namespace-enums-amp.md#access_type) for arrays and implicit memory allocations made on this `accelerator`.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator!=](#operator_neq)|Compares this `accelerator` object with another and returns **`false`** if they are the same; otherwise, returns **`true`**.| -|[operator=](#operator_eq)|Copies the contents of the specified `accelerator` object to this one.| -|[operator==](#operator_eq_eq)|Compares this `accelerator` object with another and returns **`true`** if they are the same; otherwise, returns **`false`**.| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|[cpu_accelerator](#cpu_accelerator)|Gets a string constant for the CPU `accelerator`.| -|[dedicated_memory](#dedicated_memory)|Gets the dedicated memory for the `accelerator`, in kilobytes.| -|[default_accelerator](#default_accelerator)|Gets a string constant for the default `accelerator`.| -|[default_cpu_access_type](#default_cpu_access_type)|Gets or sets the default CPU [access_type](concurrency-namespace-enums-amp.md#access_type) for arrays and implicit memory allocations made on this `accelerator`.| -|[default_view](#default_view)|Gets the default `accelerator_view` object that is associated with the `accelerator`.| -|[description](#description)|Gets a short description of the `accelerator` device.| -|[device_path](#device_path)|Gets the path of the device.| -|[direct3d_ref](#direct3d_ref)|Gets a string constant for a Direct3D reference `accelerator`.| -|[direct3d_warp](#direct3d_warp)|Gets the string constant for an `accelerator` object that you can use for executing C++ AMP code on multi-core CPUs that use Streaming SIMD Extensions (SSE).| -|[has_display](#has_display)|Gets a Boolean value that indicates whether the `accelerator` is attached to a display.| -|[is_debug](#is_debug)|Indicates whether the `accelerator` has the DEBUG layer enabled for extensive error reporting.| -|[is_emulated](#is_emulated)|Indicates whether the `accelerator` is emulated.| -|[supports_cpu_shared_memory](#supports_cpu_shared_memory)|Indicates whether the `accelerator` supports shared memory.| -|[supports_double_precision](#supports_double_precision)|Indicates whether the accelerator supports double-precision math.| -|[supports_limited_double_precision](#supports_limited_double_precision)|Indicates whether the accelerator has limited support for double-precision math.| -|[version](#version)|Gets the version of the `accelerator`.| - -## Inheritance Hierarchy - -`accelerator` - -## Remarks - -An accelerator is a hardware capability that is optimized for data-parallel computing. An accelerator is often a discrete GPU, but it can also be a virtual host-side entity such as a DirectX REF device, a WARP (a CPU-side device that is accelerated by means of SSE instructions), or the CPU itself. - -You can construct an `accelerator` object by enumerating the available devices, or by getting the default device, the reference device, or the WARP device. - -## Requirements - -**Header:** amprt.h - -**Namespace:** Concurrency - -## ~accelerator - -Destroys the `accelerator` object. - -```cpp -~accelerator(); -``` - -### Return Value - -## accelerator - -Initializes a new instance of the [accelerator class](accelerator-class.md). - -```cpp -accelerator(); - -explicit accelerator(const std::wstring& _Device_path); - -accelerator(const accelerator& _Other); -``` - -### Parameters - -*_Device_path*
-The path of the physical device. - -*_Other*
-The accelerator to copy. - -## cpu_accelerator - -Gets a string constant for the CPU accelerator. - -```cpp -static const wchar_t cpu_accelerator[]; -``` - -## create_view - -Creates and returns an `accelerator_view` object on this accelerator, using the specified queuing mode. When the queuing mode is not specified, the new `accelerator_view` uses the [queuing_mode::immediate](concurrency-namespace-enums-amp.md#queuing_mode) queuing mode. - -```cpp -accelerator_view create_view(queuing_mode qmode = queuing_mode_automatic); -``` - -### Parameters - -*qmode*
-The queuing mode. - -### Return Value - -A new `accelerator_view` object on this accelerator, using the specified queuing mode. - -## dedicated_memory - -Gets the dedicated memory for the `accelerator`, in kilobytes. - -```cpp -__declspec(property(get= get_dedicated_memory)) size_t dedicated_memory; -``` - -## default_accelerator - -Gets a string constant for the default `accelerator`. - -```cpp -static const wchar_t default_accelerator[]; -``` - -## default_cpu_access_type - -The default cpu [access_type](concurrency-namespace-enums-amp.md#access_type) for arrays and implicit memory allocations made on this `accelerator`. - -```cpp -__declspec(property(get= get_default_cpu_access_type)) access_type default_cpu_access_type; -``` - -## default_view - -Gets the default accelerator view that is associated with the `accelerator`. - -```cpp -__declspec(property(get= get_default_view)) accelerator_view default_view; -``` - -## description - -Gets a short description of the `accelerator` device. - -```cpp -__declspec(property(get= get_description)) std::wstring description; -``` - -## device_path - -Gets the path of the accelerator. The path is unique on the system. - -```cpp -__declspec(property(get= get_device_path)) std::wstring device_path; -``` - -## direct3d_ref - -Gets a string constant for a Direct3D reference accelerator. - -```cpp -static const wchar_t direct3d_ref[]; -``` - -## direct3d_warp - -Gets the string constant for an `accelerator` object that you can use for executing your C++ AMP code on multi-core CPUs using Streaming SIMD Extensions (SSE). - -```cpp -static const wchar_t direct3d_warp[]; -``` - -## get_all - -Returns a vector of `accelerator` objects that represent all the available accelerators. - -```cpp -static inline std::vector get_all(); -``` - -### Return Value - -The vector of available accelerators - -## get_auto_selection_view - -Returns the auto selection accelerator_view, which when specified as the parallel_for_each target results in the target accelerator_view for executing the parallel_for_each kernel to be automatically selected by the runtime. For all other purposes, the accelerator_view returned by this method is the same as the default accelerator_view of the default accelerator - -```cpp -static accelerator_view __cdecl get_auto_selection_view(); -``` - -### Return Value - -The auto selection accelerator_view. - -## get_dedicated_memory - -Returns the dedicated memory for the `accelerator`, in kilobytes. - -```cpp -size_t get_dedicated_memory() const; -``` - -### Return Value - -The dedicated memory for the `accelerator`, in kilobytes. - -## get_default_cpu_access_type - -Gets the default cpu access_type for buffers created on this accelerator - -```cpp -access_type get_default_cpu_access_type() const; -``` - -### Return Value - -The default cpu access_type for buffers created on this accelerator. - -## get_default_view - -Returns the default `accelerator_view` object that is associated with the `accelerator`. - -```cpp -accelerator_view get_default_view() const; -``` - -### Return Value - -The default `accelerator_view` object that is associated with the `accelerator`. - -## get_description - -Returns a short description of the `accelerator` device. - -```cpp -std::wstring get_description() const; -``` - -### Return Value - -A short description of the `accelerator` device. - -## get_device_path - -Returns the path of the accelerator. The path is unique on the system. - -```cpp -std::wstring get_device_path() const; -``` - -### Return Value - -The system-wide unique device instance path. - -## get_has_display - -Returns a Boolean value that indicates whether the `accelerator` can output to a display. - -```cpp -bool get_has_display() const; -``` - -### Return Value - -**`true`** if the `accelerator` can output to a display; otherwise, **`false`**. - -## get_is_debug - -Determines whether the `accelerator` has the DEBUG layer enabled for extensive error reporting. - -```cpp -bool get_is_debug() const; -``` - -### Return Value - -**`true`** if the `accelerator` has the DEBUG layer enabled for extensive error reporting. Otherwise, **`false`**. - -## get_is_emulated - -Determines whether the `accelerator` is emulated. - -```cpp -bool get_is_emulated() const; -``` - -### Return Value - -**`true`** if the `accelerator` is emulated. Otherwise, **`false`**. - -## get_supports_cpu_shared_memory - -Returns a boolean value indicating whether the accelerator supports memory accessible both by the accelerator and the CPU. - -```cpp -bool get_supports_cpu_shared_memory() const; -``` - -### Return Value - -**`true`** if the accelerator supports CPU shared memory; otherwise, **`false`**. - -## get_supports_double_precision - -Returns a Boolean value that indicates whether the accelerator supports double precision math, including fused multiply add (FMA), division, reciprocal, and casting between **`int`** and **`double`** - -```cpp -bool get_supports_double_precision() const; -``` - -### Return Value - -**`true`** if the accelerator supports double precision math; otherwise, **`false`**. - -## get_supports_limited_double_precision - -Returns a Boolean value that indicates whether the accelerator has limited support for double precision math. If the accelerator has only limited support, then fused multiply add (FMA), division, reciprocal, and casting between **`int`** and **`double`** are not supported. - -```cpp -bool get_supports_limited_double_precision() const; -``` - -### Return Value - -**`true`** if the accelerator has limited support for double precision math; otherwise, **`false`**. - -## get_version - -Returns the version of the `accelerator`. - -```cpp -unsigned int get_version() const; -``` - -### Return Value - -The version of the `accelerator`. - -## has_display - -Gets a Boolean value that indicates whether the `accelerator` can output to a display. - -```cpp -__declspec(property(get= get_has_display)) bool has_display; -``` - -## is_debug - -Gets a Boolean value that indicates whether the `accelerator` has the DEBUG layer enabled for extensive error reporting. - -```cpp -__declspec(property(get= get_is_debug)) bool is_debug; -``` - -## is_emulated - -Gets a Boolean value that indicates whether the `accelerator` is emulated. - -```cpp -__declspec(property(get= get_is_emulated)) bool is_emulated; -``` - -## operator!= - -Compares this `accelerator` object with another and returns **`false`** if they are the same; otherwise, returns **`true`**. - -```cpp -bool operator!= (const accelerator& _Other) const; -``` - -### Parameters - -*_Other*
-The `accelerator` object to compare with this one. - -### Return Value - -**`false`** if the two `accelerator` objects are the same; otherwise, **`true`**. - -## operator= - -Copies the contents of the specified `accelerator` object to this one. - -```cpp -accelerator& operator= (const accelerator& _Other); -``` - -### Parameters - -*_Other*
-The `accelerator` object to copy from. - -### Return Value - -A reference to this `accelerator` object. - -## operator== - -Compares this `accelerator` object with another and returns **`true`** if they are the same; otherwise, returns **`false`**. - -```cpp -bool operator== (const accelerator& _Other) const; -``` - -### Parameters - -*_Other*
-The `accelerator` object to compare with this one. - -### Return Value - -**`true`** if the other `accelerator` object is same as this `accelerator` object; otherwise, **`false`**. - -## set_default - -Sets the default accelerator to be used for any operation that implicitly uses the default accelerator. This method only succeeds if the runtime selected default accelerator has not already been used in an operation that implicitly uses the default accelerator - -```cpp -static inline bool set_default(std::wstring _Path); -``` - -### Parameters - -*_Path*
-The path to the accelerator. - -### Return Value - -**`true`** if the call succeeds at setting the default accelerator. Otherwise, **`false`**. - -## set_default_cpu_access_type - -Set the default cpu access_type for arrays created on this accelerator or for implicit memory allocations as part of array_views accessed on this accelerator. This method only succeeds if the default_cpu_access_type for the accelerator has not already been overridden by a previous call to this method and the runtime selected default_cpu_access_type for this accelerator has not yet been used for allocating an array or for an implicit memory allocation backing an array_view accessed on this accelerator. - -```cpp -bool set_default_cpu_access_type(access_type _Default_cpu_access_type); -``` - -### Parameters - -*_Default_cpu_access_type*
-The default cpu access_type to be used for array/array_view memory allocations on this accelerator. - -### Return Value - -A boolean value indicating if the default cpu access_type for the accelerator was successfully set. - -## supports_cpu_shared_memory - -Gets a Boolean value indicating whether the `accelerator` supports shared memory. - -```cpp -__declspec(property(get= get_supports_cpu_shared_memory)) bool supports_cpu_shared_memory; -``` - -## supports_double_precision - -Gets a Boolean value that indicates whether the accelerator supports double precision math. - -```cpp -__declspec(property(get= get_supports_double_precision)) bool supports_double_precision; -``` - -## supports_limited_double_precision - -Gets a Boolean value that indicates whether the accelerator has limited support for double precision math. If the accelerator has only limited support, then fused multiply add (FMA), division, reciprocal, and casting between **`int`** and **`double`** are not supported. - -```cpp -__declspec(property(get= get_supports_limited_double_precision)) bool supports_limited_double_precision; -``` - -## version - -Gets the version of the `accelerator`. - -```cpp -__declspec(property(get= get_version)) unsigned int version; -``` - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/accelerator-view-class.md b/docs/parallel/amp/reference/accelerator-view-class.md deleted file mode 100644 index 53208aae6bf..00000000000 --- a/docs/parallel/amp/reference/accelerator-view-class.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -description: "Learn more about: accelerator_view Class" -title: "accelerator_view Class" -ms.date: "03/27/2019" -f1_keywords: ["accelerator_view", "AMPRT/accelerator_view", "AMPRT/Concurrency::accelerator_view::accelerator_view", "AMPRT/Concurrency::accelerator_view::create_marker", "AMPRT/Concurrency::accelerator_view::flush", "AMPRT/Concurrency::accelerator_view::get_accelerator", "AMPRT/Concurrency::accelerator_view::get_is_auto_selection", "AMPRT/Concurrency::accelerator_view::get_is_debug", "AMPRT/Concurrency::accelerator_view::get_queuing_mode", "AMPRT/Concurrency::accelerator_view::get_version", "AMPRT/Concurrency::accelerator_view::wait", "AMPRT/Concurrency::accelerator_view::accelerator", "AMPRT/Concurrency::accelerator_view::is_auto_selection", "AMPRT/Concurrency::accelerator_view::is_debug", "AMPRT/Concurrency::accelerator_view::queuing_mode", "AMPRT/Concurrency::accelerator_view::version"] -helpviewer_keywords: ["accelerator_view class"] -ms.assetid: 9f298c21-bf62-46e0-88b8-01c5c78ef144 ---- -# accelerator_view Class - -Represents a virtual device abstraction on a C++ AMP data-parallel accelerator. - -## Syntax - -```cpp -class accelerator_view; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[accelerator_view Constructor](#ctor)|Initializes a new instance of the `accelerator_view` class.| -|[~accelerator_view Destructor](#dtor)|Destroys the `accelerator_view` object.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[create_marker](#create_marker)|Returns a future to track the completion of all commands submitted so far to this `accelerator_view` object.| -|[flush](#flush)|Submits all pending commands queued to the `accelerator_view` object to the accelerator for execution.| -|[get_accelerator](#get_accelerator)|Returns the `accelerator` object for the `accelerator_view` object.| -|[get_is_auto_selection](#get_is_auto_selection)|Returns a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the `accelerator_view` object is passed to a [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each).| -|[get_is_debug](#get_is_debug)|Returns a Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.| -|[get_queuing_mode](#get_queuing_mode)|Returns the queuing mode for the `accelerator_view` object.| -|[get_version](#get_version)|Returns the version of the `accelerator_view`.| -|[wait](#wait)|Waits for all commands submitted to the `accelerator_view` object to finish.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator!=](#operator_neq)|Compares this `accelerator_view` object with another and returns **`false`** if they are the same; otherwise, returns **`true`**.| -|[operator=](#operator_eq)|Copies the contents of the specified `accelerator_view` object into this one.| -|[operator==](#operator_eq_eq)|Compares this `accelerator_view` object with another and returns **`true`** if they are the same; otherwise, returns **`false`**.| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|[accelerator](#accelerator)|Gets the `accelerator` object for the `accelerator_view` object.| -|[is_auto_selection](#is_auto_selection)|Gets a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the `accelerator_view` object is passed to a [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each).| -|[is_debug](#is_debug)|Gets a Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.| -|[queuing_mode](#queuing_mode)|Gets the queuing mode for the `accelerator_view` object.| -|[version](#version)|Gets the version of the accelerator.| - -## Inheritance Hierarchy - -`accelerator_view` - -### Remarks - -An `accelerator_view` object represents a logical, isolated view of an accelerator. A single physical compute device can have many logical, isolated `accelerator_view` objects. Each accelerator has a default `accelerator_view` object. Additional `accelerator_view` objects can be created. - -Physical devices can be shared among many client threads. Client threads can cooperatively use the same `accelerator_view` object of an accelerator, or each client can communicate with a compute device via an independent `accelerator_view` object for isolation from other client threads. - -An `accelerator_view` object can have one of two [queuing_mode Enumeration](concurrency-namespace-enums-amp.md#queuing_mode) states. If the queuing mode is `immediate`, commands like `copy` and `parallel_for_each` are sent to the corresponding accelerator device as soon as they return to the caller. If the queuing mode is `deferred`, such commands are queued up on a command queue that corresponds to the `accelerator_view` object. Commands are not actually sent to the device until `flush()` is called. - -## Requirements - -**Header:** amprt.h - -**Namespace:** Concurrency - -## accelerator - -Gets the accelerator object for the accelerator_view object. - -### Syntax - -```cpp -__declspec(property(get= get_accelerator)) Concurrency::accelerator accelerator; -``` - -## accelerator_view - -Initializes a new instance of the accelerator_view class by copying an existing `accelerator_view` object. - -### Syntax - -```cpp -accelerator_view( const accelerator_view & other ); -``` - -### Parameters - -*other*
-The `accelerator_view` object to copy. - -## create_marker - -Returns a future to track the completion of all commands submitted so far to this `accelerator_view` object. - -### Syntax - -```cpp -concurrency::completion_future create_marker(); -``` - -### Return Value - -A future to track the completion of all commands submitted so far to this `accelerator_view` object. - -## flush - -Submits all pending commands queued to the accelerator_view object to the accelerator for execution. - -### Syntax - -```cpp -void flush(); -``` - -### Return Value - -Returns **`void`**. - -## get_accelerator - -Returns the accelerator object for the accelerator_view object. - -### Syntax - -```cpp -accelerator get_accelerator() const; -``` - -### Return Value - -The accelerator object for the accelerator_view object. - -## get_is_auto_selection - -Returns a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the accelerator_view is passed to a [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each). - -### Syntax - -```cpp -bool get_is_auto_selection() const; -``` - -### Return Value - -**`true`** if the runtime will automatically select an appropriate accelerator; otherwise, **`false`**. - -## get_is_debug - -Returns a Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting. - -### Syntax - -```cpp -bool get_is_debug() const; -``` - -### Return Value - -A Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting. - -## get_queuing_mode - -Returns the queuing mode for the accelerator_view object. - -### Syntax - -```cpp -queuing_mode get_queuing_mode() const; -``` - -### Return Value - -The queuing mode for the `accelerator_view` object. - -## get_version - -Returns the version of the accelerator_view. - -### Syntax - -```cpp -unsigned int get_version() const; -``` - -### Return Value - -The version of the `accelerator_view`. - -## is_auto_selection - -Gets a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the accelerator_view is passed to a [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each). - -### Syntax - -```cpp -__declspec(property(get= get_is_auto_selection)) bool is_auto_selection; -``` - -## is_debug - -Gets a Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting. - -### Syntax - -```cpp -__declspec(property(get= get_is_debug)) bool is_debug; -``` - -## operator!= - -Compares this accelerator_view object with another and returns **`false`** if they are the same; otherwise, returns **`true`**. - -### Syntax - -```cpp -bool operator!= ( const accelerator_view & other ) const; -``` - -### Parameters - -*other*
-The `accelerator_view` object to compare with this one. - -### Return Value - -**`false`** if the two objects are the same; otherwise, **`true`**. - -## operator= - -Copies the contents of the specified accelerator_view object into this one. - -### Syntax - -```cpp -accelerator_view & operator= ( const accelerator_view & other ); -``` - -### Parameters - -*other*
-The `accelerator_view` object to copy from. - -### Return Value - -A reference to the modified `accelerator_view` object. - -## operator== - -Compares this accelerator_view object with another and returns **`true`** if they are the same; otherwise, returns **`false`**. - -### Syntax - -```cpp -bool operator== ( const accelerator_view & other ) const; -``` - -### Parameters - -*other*
-The `accelerator_view` object to compare with this one. - -### Return Value - -**`true`** if the two objects are the same; otherwise, **`false`**. - -## queuing_mode - -Gets the queuing mode for the accelerator_view object. - -### Syntax - -```cpp -__declspec(property(get= get_queuing_mode)) Concurrency::queuing_mode queuing_mode; -``` - -## version - -Gets the version of the accelerator_view. - -### Syntax - -```cpp -__declspec(property(get= get_version)) unsigned int version; -``` - -## wait - -Waits for all commands submitted to the accelerator_view object to finish. - -### Syntax - -```cpp -void wait(); -``` - -### Return Value - -Returns **`void`**. - -### Remarks - -If the [queuing_mode](concurrency-namespace-enums-amp.md#queuing_mode) is `immediate`, this method returns immediately without blocking. - -## ~accelerator_view - -Destroys the accelerator_view object. - -### Syntax - -```cpp -~accelerator_view(); -``` - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/accelerator-view-removed-class.md b/docs/parallel/amp/reference/accelerator-view-removed-class.md deleted file mode 100644 index f5487950ff2..00000000000 --- a/docs/parallel/amp/reference/accelerator-view-removed-class.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -description: "Learn more about: accelerator_view_removed Class" -title: "accelerator_view_removed Class" -ms.date: "03/27/2019" -f1_keywords: ["accelerator_view_removed", "AMPRT/accelerator_view_removed", "AMPRT/Concurrency::accelerator_view_removed::accelerator_view_removed", "AMPRT/Concurrency::accelerator_view_removed::get_view_removed_reason"] -helpviewer_keywords: ["AMPRT/Concurrency::accelerator_view_removed::accelerator_view_removed Class"] -ms.assetid: 262446de-311c-454e-a5ed-e2aaced0d88a ---- -# accelerator_view_removed Class - -The exception that is thrown when an underlying DirectX call fails due to the Windows timeout detection and recovery mechanism. - -## Syntax - -```cpp -class accelerator_view_removed : public runtime_exception; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[accelerator_view_removed Constructor](#ctor)|Initializes a new instance of the `accelerator_view_removed` class.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[get_view_removed_reason](#get_view_removed_reason)|Returns an HRESULT error code indicating the cause of the `accelerator_view` object's removal.| - -## Inheritance Hierarchy - -`exception` - -`runtime_exception` - -`out_of_memory` - -## Requirements - -**Header:** amprt.h - -**Namespace:** Concurrency - -## accelerator_view_removed - -Initializes a new instance of the [accelerator_view_removed](accelerator-view-removed-class.md) class. - -### Syntax - -```cpp -explicit accelerator_view_removed( - const char * message, - HRESULT view_removed_reason ) throw(); - -explicit accelerator_view_removed( - HRESULT view_removed_reason ) throw(); -``` - -### Parameters - -*message*
-A description of the error. - -*view_removed_reason*
-An HRESULT error code indicating the cause of removal of the `accelerator_view` object. - -### Return Value - -A new instance of the `accelerator_view_removed` class. - -## get_view_removed_reason - -Returns an HRESULT error code indicating the cause of the `accelerator_view` object's removal. - -### Syntax - -```cpp -HRESULT get_view_removed_reason() const throw(); -``` - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/adopt-d3d-access-lock-t-structure.md b/docs/parallel/amp/reference/adopt-d3d-access-lock-t-structure.md deleted file mode 100644 index 9c6baf74c4d..00000000000 --- a/docs/parallel/amp/reference/adopt-d3d-access-lock-t-structure.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -description: "Learn more about: adopt_d3d_access_lock_t Structure" -title: "adopt_d3d_access_lock_t Structure" -ms.date: "11/04/2016" -f1_keywords: ["amprt/concurrency::direct3d::adopt_d3d_access_lock_t"] -ms.assetid: ef10bb06-88d6-420b-bb81-35895b2e02e6 ---- -# adopt_d3d_access_lock_t Structure - -Tag type to indicate the D3D access lock should be adopted rather than acquired. - -## Syntax - -```cpp -struct adopt_d3d_access_lock_t; -``` - -## Members - -## Inheritance Hierarchy - -`adopt_d3d_access_lock_t` - -## Requirements - -**Header:** amprt.h - -**Namespace:** concurrency::direct3d - -## See also - -[Concurrency::direct3d Namespace](concurrency-direct3d-namespace.md) diff --git a/docs/parallel/amp/reference/array-class.md b/docs/parallel/amp/reference/array-class.md deleted file mode 100644 index 5fd455d1f15..00000000000 --- a/docs/parallel/amp/reference/array-class.md +++ /dev/null @@ -1,816 +0,0 @@ ---- -title: "array Class" -description: "Learn more about: array Class" -ms.date: 11/04/2016 -f1_keywords: ["array", "AMP/array", "AMP/Concurrency::array::array", "AMP/Concurrency::array::copy_to", "AMP/Concurrency::array::data", "AMP/Concurrency::array::get_accelerator_view", "AMP/Concurrency::array::get_associated_accelerator_view", "AMP/Concurrency::array::get_cpu_access_type", "AMP/Concurrency::array::get_extent", "AMP/Concurrency::array::reinterpret_as", "AMP/Concurrency::array::section", "AMP/Concurrency::array::view_as", "AMP/Concurrency::array::rank", "AMP/Concurrency::array::accelerator_view", "AMP/Concurrency::array::associated_accelerator_view", "AMP/Concurrency::array::cpu_access_type", "AMP/Concurrency::array::extent"] -helpviewer_keywords: ["array class"] ---- -# array Class - -Represents a data container used to move data to an accelerator. - -## Syntax - -```cpp -template -friend class array; -``` - -### Parameters - -*value_type*
-The element type of the data. - -*_Rank*
-The rank of the array. - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[array Constructor](#ctor)|Initializes a new instance of the `array` class.| -|[~array Destructor](#dtor)|Destroys the `array` object.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[copy_to](#copy_to)|Copies the contents of the array to another array.| -|[data](#data)|Returns a pointer to the raw data of the array.| -|[get_accelerator_view](#get_accelerator_view)|Returns the [accelerator_view](accelerator-view-class.md) object that represents the location where the array is allocated. This property can be accessed only on the CPU.| -|[get_associated_accelerator_view](#get_associated_accelerator_view)|Gets the second [accelerator_view](accelerator-view-class.md) object that is passed as a parameter when a staging constructor is called to instantiate the `array` object.| -|[get_cpu_access_type](#get_cpu_access_type)|Returns the [access_type](concurrency-namespace-enums-amp.md#access_type) of the array. This method can be accessed only on the CPU.| -|[get_extent](#get_extent)|Returns the [extent](extent-class.md) object of the array.| -|[reinterpret_as](#reinterpret_as)|Returns a one-dimensional array that contains all the elements in the `array` object.| -|[section](#section)|Returns a subsection of the `array` object that is at the specified origin and, optionally, that has the specified extent.| -|[view_as](#view_as)|Returns an [array_view](array-view-class.md) object that is constructed from the `array` object.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[`operator std::vector`](#operator_vec)|Uses `copy(*this, vector)` to implicitly convert the array to a [std::vector](../../../standard-library/vector-class.md) object.| -|[operator()](#operator_call)|Returns the element value that is specified by the parameters.| -|[operator\[\]](#operator_at)|Returns the element that is at the specified index.| -|[operator=](#operator_eq)|Copies the contents of the specified `array` object into this one.| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[rank Constant](#rank)|Stores the rank of the array.| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|[accelerator_view](#accelerator_view)|Gets the [accelerator_view](accelerator-view-class.md) object that represents the location where the array is allocated. This property can be accessed only on the CPU.| -|[associated_accelerator_view](#associated_accelerator_view)|Gets the second [accelerator_view](accelerator-view-class.md) object that is passed as a parameter when a staging constructor is called to instantiate the `array` object.| -|[cpu_access_type](#cpu_access_type)|Gets the [access_type](concurrency-namespace-enums-amp.md#access_type) that represents how the CPU can access the storage of the array.| -|[extent](#extent)|Gets the extent that defines the shape of the array.| - -## Remarks - -The type `array` represents a dense and regular (not jagged) *N*-dimensional array that is located in a specific location, such as an accelerator or the CPU. The data type of the elements in the array is `T`, which must be of a type that is compatible with the target accelerator. Although the rank, `N`, (of the array is determined statically and is part of the type, the extent of the array is determined by the runtime and is expressed by using class `extent`. - -An array can have any number of dimensions, although some functionality is specialized for `array` objects with rank one, two, and three. If you omit the dimension argument, the default is 1. - -Array data is laid out contiguously in memory. Elements that differ by one in the least significant dimension are adjacent in memory. - -Arrays are logically considered to be value types, because when an array is copied to another array, a deep copy is performed. Two arrays never point to the same data. - -The `array` type is used in several scenarios: - -- As a data container that can be used in computations on an accelerator. - -- As a data container to hold memory on the host CPU (that can be used to copy to and from other arrays). - -- As a staging object to act as a fast intermediary in host-to-device copies. - -## Inheritance Hierarchy - -`array` - -## Requirements - -**Header:** amp.h - -**Namespace:** Concurrency - -## ~array - -Destroys the `array` object. - -```cpp -~array() restrict(cpu); -``` - -## accelerator_view - -Gets the [accelerator_view](accelerator-view-class.md) object that represents the location where the array is allocated. This property can be accessed only on the CPU. - -```cpp -__declspec(property(get= get_accelerator_view)) Concurrency::accelerator_view accelerator_view; -``` - -## array - -Initializes a new instance of the [array class](array-class.md). There is no default constructor for `array`. All constructors are run on the CPU only. They cannot be executed on a Direct3D target. - -```cpp -explicit array( - const Concurrency::extent<_Rank>& _Extent) restrict(cpu); - -explicit array( - int _E0) restrict(cpu); - -explicit array( - int _E0, - int _E1) restrict(cpu); - -explicit array( - int _E0, - int _E1, - int _E2) restrict(cpu); - -array( - const Concurrency::extent<_Rank>& _Extent, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -array( - int _E0, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -array( - int _E0, - int _E1, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -array( - int _E0, - int _E1, - int _E2, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -array( - const Concurrency::extent<_Rank>& _Extent, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -array( - int _E0, - accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -array( - int _E0, - int _E1, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -array( - int _E0, - int _E1, - int _E2, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -template -array( - const Concurrency::extent<_Rank>& _Extent, - _InputIterator _Src_first, - _InputIterator _Src_last) restrict(cpu); - -template -array( - const Concurrency::extent<_Rank>& _Extent, - _InputIterator _Src_first) restrict(cpu); - -template -array( - int _E0, - _InputIterator _Src_first, - _InputIterator _Src_last) restrict(cpu); - -template -array( - int _E0, - _InputIterator _Src_first) restrict(cpu); - -template -array( - int _E0, - int _E1, - _InputIterator _Src_first, - _InputIterator _Src_last) restrict(cpu); - -template -array( - int _E0, - int _E1, - _InputIterator _Src_first) restrict(cpu); - -template -array( - int _E0, - int _E1, - int _E2, - _InputIterator _Src_first, - _InputIterator _Src_last) restrict(cpu); - -template -array( - int _E0, - int _E1, - int _E2, - _InputIterator _Src_first) restrict(cpu); - -template -array( - const Concurrency::extent<_Rank>& _Extent, - _InputIterator _Src_first, - _InputIterator _Src_last, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -template -array( - const Concurrency::extent<_Rank>& _Extent, - _InputIterator _Src_first, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -template -array( - int _E0, - _InputIterator _Src_first, - _InputIterator _Src_last, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -template -array( - int _E0, - _InputIterator _Src_first, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -template -array( - int _E0, - int _E1, - _InputIterator _Src_first, - _InputIterator _Src_last, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -template -array( - int _E0, - int _E1, - _InputIterator _Src_first, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -template -array( - int _E0, - int _E1, - int _E2, - _InputIterator _Src_first, - _InputIterator _Src_last, - Concurrency::accelerator_view _Av, - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -template -array( - int _E0, - int _E1, - int _E2, - _InputIterator _Src_first, - Concurrency::accelerator_view _Av - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -template -array( - const Concurrency::extent<_Rank>& _Extent, - _InputIterator _Src_first, - _InputIterator _Src_last, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -template -array( - const Concurrency::extent<_Rank>& _Extent, - _InputIterator _Src_first, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -template -array( - int _E0, - _InputIterator _Src_first, - _InputIterator _Src_last, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -template -array( - int _E0, _InputIterator _Src_first, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -template -array( - int _E0, - int _E1, _InputIterator _Src_first, _InputIterator _Src_last, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -template -array( - int _E0, - int _E1, _InputIterator _Src_first, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -template -array( - int _E0, - int _E1, - int _E2, _InputIterator _Src_first, _InputIterator _Src_last, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -template -array( - int _E0, - int _E1, - int _E2, _InputIterator _Src_first, - Concurrency::accelerator_view _Av, - Concurrency::accelerator_view _Associated_Av) restrict(cpu); - -explicit array( - const array_view& _Src) restrict(cpu); - -array( - const array_view& _Src, - accelerator_view _Av, - access_type _Cpu_access_type = access_type_auto) restrict(cpu); - -array( - const array_view& _Src, - accelerator_view _Av, - accelerator_view _Associated_Av) restrict(cpu); - -array(const array& _Other) restrict(cpu); - -array(array&& _Other) restrict(cpu); -``` - -### Parameters - -*_Associated_Av*
-An accelerator_view which specifies the preferred target location of the array. - -*_Av*
-An [accelerator_view](accelerator-view-class.md) object that specifies the location of the array. - -*_Cpu_access_type*
-The desired [access_type](concurrency-namespace-enums-amp.md#access_type) for the array on the CPU. This parameter has a default value of `access_type_auto` leaving the CPU `access_type` determination to the runtime. The actual CPU `access_type` for the array can be queried using the `get_cpu_access_type` method. - -*_Extent*
-The extent in each dimension of the array. - -*_E0*
-The most significant component of the extent of this section. - -*_E1*
-The next-to-most-significant component of the extent of this section. - -*_E2*
-The least significant component of the extent of this section. - -*_InputIterator*
-The type of the input iterator. - -*_Src*
-To object to copy. - -*_Src_first*
-A beginning iterator into the source container. - -*_Src_last*
-An ending iterator into the source container. - -*_Other*
-Other data source. - -*_Rank*
-The rank of the section. - -*value_type*
-The data type of the elements that are copied. - -## associated_accelerator_view - -Gets the second [accelerator_view](accelerator-view-class.md) object that is passed as a parameter when a staging constructor is called to instantiate the `array` object. - -```cpp -__declspec(property(get= get_associated_accelerator_view)) Concurrency::accelerator_view associated_accelerator_view; -``` - -## copy_to - -Copies the contents of the `array` to another `array`. - -```cpp -void copy_to( - array& _Dest) const ; - -void copy_to( - array_view& _Dest) const ; -``` - -### Parameters - -*_Dest*
-The [array_view](array-view-class.md) object to copy to. - -## cpu_access_type - -Gets the CPU access_type allowed for this array. - -```cpp -__declspec(property(get= get_cpu_access_type)) access_type cpu_access_type; -``` - -## data - -Returns a pointer to the raw data of the `array`. - -```cpp -value_type* data() restrict(amp, cpu); - -const value_type* data() const restrict(amp, cpu); -``` - -### Return Value - -A pointer to the raw data of the array. - -## extent - -Gets the [extent](extent-class.md) object that defines the shape of the `array`. - -```cpp -__declspec(property(get= get_extent)) Concurrency::extent<_Rank> extent; -``` - -## get_accelerator_view - -Returns the [accelerator_view](accelerator-view-class.md) object that represents the location where the `array` object is allocated. This property can be accessed only on the CPU. - -```cpp -Concurrency::accelerator_view get_accelerator_view() const; -``` - -### Return Value - -The `accelerator_view` object that represents the location where the `array` object is allocated. - -## get_associated_accelerator_view - -Gets the second [accelerator_view](accelerator-view-class.md) object that is passed as a parameter when a staging constructor is called to instantiate the `array` object. - -```cpp -Concurrency::accelerator_view get_associated_accelerator_view() const ; -``` - -### Return Value - -The second [accelerator_view](accelerator-view-class.md) object passed to the staging constructor. - -## get_cpu_access_type - -Returns the CPU access_type that's allowed for this array. - -```cpp -access_type get_cpu_access_type() const restrict(cpu); -``` - -### Return Value - -## get_extent - -Returns the [extent](extent-class.md) object of the `array`. - -```cpp -Concurrency::extent<_Rank> get_extent() const restrict(amp,cpu); -``` - -### Return Value - -The `extent` object of the `array`. - -## `operator std::vector` - -Uses `copy(*this, vector)` to implicitly convert the array to a std::vector object. - -```cpp -operator std::vector() const restrict(cpu); -``` - -### Parameters - -*value_type*
-The data type of the elements of the vector. - -### Return Value - -An object of type `vector` that contains a copy of the data that is contained in the array. - -## operator() - -Returns the element value that is specified by the parameters. - -```cpp -value_type& operator() (const index<_Rank>& _Index) restrict(amp,cpu); - -const value_type& operator() (const index<_Rank>& _Index) cons t restrict(amp,cpu); - -value_type& operator() (int _I0, int _I1) restrict(amp,cpu); - -const value_type& operator() (int _I0, int _I1) const restrict(amp,cpu) ; - -value_type& operator() (int _I0, int _I1, int _I2) restrict(amp,cpu); - -const value_type& operator() (int _I0, int _I1, int _I2) const restrict(amp,cpu); - -typename details::_Projection_result_type::_Result_type operator()(int _I) restrict(amp,cpu); - -typename details::_Projection_result_type::_Const_result_type operator()(int _I) const restrict(amp,cpu); -``` - -### Parameters - -*_Index*
-The location of the element. - -*_I0*
-The most significant component of the origin of this section. - -*_I1*
-The next-to-most-significant component of the origin of this section. - -*_I2*
-The least significant component of the origin of this section. - -*_I*
-The location of the element. - -### Return Value - -The element value specified by the parameters. - -## operator[] - -Returns the element that is at the specified index. - -```cpp -value_type& operator[](const index<_Rank>& _Index) restrict(amp,cpu); - -const value_type& operator[] - (const index<_Rank>& _Index) const restrict(amp,cpu); - -typename details::_Projection_result_type::_Result_type operator[](int _i) restrict(amp,cpu); - -typename details::_Projection_result_type::_Const_result_type operator[](int _i) const restrict(amp,cpu); -``` - -### Parameters - -*_Index*
-The index. - -*_I*
-The index. - -### Return Value - -The element that is at the specified index. - -## operator= - -Copies the contents of the specified `array` object. - -```cpp -array& operator= (const array& _Other) restrict(cpu); - -array& operator= (array&& _Other) restrict(cpu); - -array& operator= ( - const array_view& _Src) restrict(cpu); -``` - -### Parameters - -*_Other*
-The `array` object to copy from. - -*_Src*
-The `array` object to copy from. - -### Return Value - -A reference to this `array` object. - -## rank - -Stores the rank of the `array`. - -```cpp -static const int rank = _Rank; -``` - -## reinterpret_as - -Reinterprets the array through a one-dimensional array_view, which optionally may have a different value type than the source array. - -### Syntax - -```cpp -template -array_view<_Value_type2,1> reinterpret_as() restrict(amp,cpu); - -template -array_view reinterpret_as() const restrict(amp,cpu); -``` - -### Parameters - -*_Value_type2*
-The data type of the returned data. - -### Return Value - -An array_view or const array_view object that is based on the array, with the element type reinterpreted from T to ElementType and the rank reduced from N to 1. - -### Remarks - -Sometimes it is convenient to view a multi-dimensional array as if it is a linear, one-dimensional array, possibly with a different value type than the source array. You can use this method to achieve this. -**Caution** Reinterpreting an array object by using a different value type is a potentially unsafe operation. We recommend that you use this functionality carefully. - -The following code provides an example. - -```cpp -struct RGB { float r; float g; float b; }; - -array a = ...; -array_view v = a.reinterpret_as(); - -assert(v.extent == 3*a.extent); -``` - -## section - -Returns a subsection of the `array` object that is at the specified origin and, optionally, that has the specified extent. - -```cpp -array_view section( - const Concurrency::index<_Rank>& _Section_origin, - const Concurrency::extent<_Rank>& _Section_extent) restrict(amp,cpu); - -array_view section( - const Concurrency::index<_Rank>& _Section_origin, - const Concurrency::extent<_Rank>& _Section_extent) const restrict(amp,cpu); - -array_view section( - const Concurrency::extent<_Rank>& _Ext) restrict(amp,cpu); - -array_view section( - const Concurrency::extent<_Rank>& _Ext) const restrict(amp,cpu); - -array_view section( - const index<_Rank>& _Idx) restrict(amp,cpu); - -array_view section( - const index<_Rank>& _Idx) const restrict(amp,cpu); - -array_view section( - int _I0, - int _E0) restrict(amp,cpu); - -array_view section( - int _I0, - int _E0) const restrict(amp,cpu); - -array_view section( - int _I0, - int _I1, - int _E0, - int _E1) restrict(amp,cpu); - -array_view section( - int _I0, - int _I1, - int _E0, - int _E1) const restrict(amp,cpu); - -array_view section( - int _I0, - int _I1, - int _I2, - int _E0, - int _E1, - int _E2) restrict(amp,cpu); - -array_view section( - int _I0, - int _I1, - int _I2, - int _E0, - int _E1, - int _E2) const restrict(amp,cpu); -``` - -### Parameters - -*_E0*
-The most significant component of the extent of this section. - -*_E1*
-The next-to-most-significant component of the extent of this section. - -*_E2*
-The least significant component of the extent of this section. - -*_Ext*
-The [extent](extent-class.md) object that specifies the extent of the section. The origin is 0. - -*_Idx*
-The [index](index-class.md) object that specifies the location of the origin. The subsection is the rest of the extent. - -*_I0*
-The most significant component of the origin of this section. - -*_I1*
-The next-to-most-significant component of the origin of this section. - -*_I2*
-The least significant component of the origin of this section. - -*_Rank*
-The rank of the section. - -*_Section_extent*
-The [extent](extent-class.md) object that specifies the extent of the section. - -*_Section_origin*
-The [index](index-class.md) object that specifies the location of the origin. - -*value_type*
-The data type of the elements that are copied. - -### Return Value - -Returns a subsection of the `array` object that is at the specified origin and, optionally, that has the specified extent. When only the `index` object is specified, the subsection contains all elements in the associated grid that have indexes that are larger than the indexes of the elements in the `index` object. - -## view_as - -Reinterprets this array as an [array_view](array-view-class.md) of a different rank. - -```cpp -template -array_view view_as( - const Concurrency::extent<_New_rank>& _View_extent) restrict(amp,cpu); - -template -array_view view_as( - const Concurrency::extent<_New_rank>& _View_extent) const restrict(amp,cpu); -``` - -### Parameters - -*_New_rank*
-The rank of the `extent` object passed as a parameter. - -*_View_extent*
-The extent that is used to construct the new [array_view](array-view-class.md) object. - -*value_type*
-The data type of the elements in both the original `array` object and the returned `array_view` object. - -### Return Value - -The [array_view](array-view-class.md) object that is constructed. - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/array-view-class.md b/docs/parallel/amp/reference/array-view-class.md deleted file mode 100644 index 26700c4f97b..00000000000 --- a/docs/parallel/amp/reference/array-view-class.md +++ /dev/null @@ -1,773 +0,0 @@ ---- -description: "Learn more about: array_view Class" -title: "array_view Class" -ms.date: "11/04/2016" -f1_keywords: ["array_view", "AMP/array_view", "AMP/Concurrency::array_view::array_view", "AMP/Concurrency::array_view::copy_to", "AMP/Concurrency::array_view::data", "AMP/Concurrency::array_view::discard_data", "AMP/Concurrency::array_view::get_extent", "AMP/Concurrency::array_view::get_ref", "AMP/Concurrency::array_view::get_source_accelerator_view", "AMP/Concurrency::array_view::refresh", "AMP/Concurrency::array_view::reinterpret_as", "AMP/Concurrency::array_view::section", "AMP/Concurrency::array_view::synchronize", "AMP/Concurrency::array_view::synchronize_async", "AMP/Concurrency::array_view::synchronize_to", "AMP/Concurrency::array_view::synchronize_to_async", "AMP/Concurrency::array_view::view_as", "AMP/Concurrency::array_view::rank", "AMP/Concurrency::array_view::extent", "AMP/Concurrency::array_view::source_accelerator_view", "AMP/Concurrency::array_view::value_type"] -helpviewer_keywords: ["array_view class"] -ms.assetid: 7e7ec9bc-05a2-4372-b05d-752b50006c5a ---- -# array_view Class - -Represents an N-dimensional view over the data held in another container. - -## Syntax - -```cpp -template < - typename value_type, - int _Rank = 1 -> -class array_view : public _Array_view_base<_Rank, sizeof(value_type)/sizeof(int)>; - -template < - typename value_type, - int _Rank -> -class array_view : public _Array_view_base<_Rank, sizeof(value_type)/sizeof(int)>; -``` - -### Parameters - -*value_type*
-The data type of the elements in the `array_view` object. - -*_Rank*
-The rank of the `array_view` object. - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[array_view Constructor](#ctor)|Initializes a new instance of the `array_view` class. There is no default constructor for `array`. All constructors are restricted to run on the CPU only and cannot be executed on a Direct3D target.| -|[~array_view Destructor](#ctor)|Destroys the `array_view` object.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[copy_to](#copy_to)|Copies the contents of the `array_view` object to the specified destination by calling `copy(*this, dest)`.| -|[data](#data)|Returns a pointer to the raw data of the `array_view`.| -|[discard_data](#discard_data)|Discards the current data underlying this view.| -|[get_extent](#get_extent)|Returns the extent object of the array_view object.| -|[get_ref](#get_ref)|Returns a reference to the indexed element.| -|[get_source_accelerator_view](#get_source_accelerator_view)|Returns the [accelerator_view](accelerator-view-class.md) where the data source of the `array_view` is located.| -|[refresh](#refresh)|Notifies the `array_view` object that its bound memory has been modified outside the `array_view` interface. A call to this method renders all cached information stale.| -|[reinterpret_as](#reinterpret_as)|Returns a one-dimensional array that contains all the elements in the `array_view` object.| -|[section](#section)|Returns a subsection of the `array_view` object that's at the specified origin and, optionally, that has the specified extent.| -|[synchronize](#synchronize)|Synchronizes any modifications made to the `array_view` object back to its source data.| -|[synchronize_async](#synchronize_async)|Asynchronously synchronizes any modifications made to the `array_view` object back to its source data.| -|[synchronize_to](#synchronize_to)|Synchronizes any modifications made to the `array_view` object to the specified [accelerator_view](accelerator-view-class.md).| -|[synchronize_to_async](#synchronize_to_async)|Asynchronously synchronizes any modifications made to the `array_view` object to the specified [accelerator_view](accelerator-view-class.md).| -|[view_as](#view_as)|Produces an `array_view` object of a different rank using this `array_view` object's data.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator()](#operator_call)|Returns the value of the element that is specified by the parameter or parameters.| -|[operator\[\]](#operator_at)|Returns the element that is specified by the parameters.| -|[operator=](#operator_eq)|Copies the contents of the specified `array_view` object into this one.| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[rank Constant](#rank)|Stores the rank of the `array_view` object.| - -### Data Members - -|Name|Description| -|----------|-----------------| -|[extent](#extent)|Gets the `extent` object that defines the shape of the `array_view` object.| -|[source_accelerator_view](#source_accelerator_view)|Gets the [accelerator_view](accelerator-view-class.md) where the data source of the `array_view` is located| -|[value_type](#value_type)|The value type of the `array_view` and the bound array.| - -## Remarks - -The `array_view` class represents a view into the data that is contained in an [array](array-class.md) object or a subsection of an `array` object. - -You can access the `array_view` object where the source data is located (locally) or on a different accelerator or a coherence domain (remotely). When you access the object remotely, views are copied and cached as necessary. Except for the effects of automatic caching, `array_view` objects have a performance profile similar to that of `array` objects. There is a small performance penalty when you access the data through views. - -There are three remote usage scenarios: - -- A view to a system memory pointer is passed by means of a [parallel_for_each](../../../parallel/concrt/reference/concurrency-namespace-functions.md#parallel_for_each) call to an accelerator and accessed on the accelerator. - -- A view to an array located on an accelerator is passed by means of a `parallel_for_each` call to another accelerator and is accessed there. - -- A view to an array located on an accelerator is accessed on the CPU. - -In any one of these scenarios, the referenced views are copied by the runtime to the remote location and, if modified by the calls to the `array_view` object, are copied back to the local location. The runtime might optimize the process of copying changes back, might copy only changed elements, or might copy unchanged portions also. Overlapping `array_view` objects on one data source are not guaranteed to maintain referential integrity in a remote location. - -You must synchronize any multithreaded access to the same data source. - -The runtime makes the following guarantees regarding the caching of data in `array_view` objects: - -- All well-synchronized accesses to an `array` object and an `array_view` object on it in program order obey a serial happens-before relationship. - -- All well-synchronized accesses to overlapping `array_view` objects on the same accelerator on a single `array` object are aliased through the `array` object. They induce a total occurs-before relationship which obeys program order. There is no caching. If the `array_view` objects are executing on different accelerators, the order of access is undefined, creating a race condition. - -When you create an `array_view` object using a pointer in system memory, you must change the view `array_view` object only through the `array_view` pointer. Alternatively, you must call `refresh()` on one of the `array_view` objects that are attached to the system pointer, if the underlying native memory is changed directly, instead of through the `array_view` object. - -Either action notifies the `array_view` object that the underlying native memory is changed and that any copies that are located on an accelerator are outdated. If you follow these guidelines, the pointer-based views are identical to those provided to views of data-parallel arrays. - -## Inheritance Hierarchy - -`_Array_view_shape` - -`_Array_view_base` - -`array_view` - -## Requirements - -**Header:** amp.h - -**Namespace:** Concurrency - -## ~array_view - -Destroys the `array_view` object. - -```cpp -~array_view()restrict(amp,cpu); -``` - -## array_view - -Initializes a new instance of the `array_view` class. - -```cpp -array_view( - array& _Src)restrict(amp,cpu); - -array_view( - const array_view& _Other)restrict(amp,cpu); - -explicit array_view( - const Concurrency::extent<_Rank>& _Extent) restrict(cpu); - -template < - typename _Container -> -array_view( - const Concurrency::extent<_Rank>& _Extent, - _Container& _Src) restrict(cpu); - -array_view( - const Concurrency::extent<_Rank>& _Extent, - value_type* _Src)restrict(amp,cpu); - -explicit array_view( - int _E0) restrict(cpu); - -template < - typename _Container -> -explicit array_view( - _Container& _Src, - typename std::enable_if::type::value, void **>::type = 0) restrict(cpu); - -template < - typename _Container -> -explicit array_view( - int _E0, - _Container& _Src) restrict(cpu); - -explicit array_view( - int _E0, - int _E1) __CPU_ONLY; - -template < - typename _Container -> -explicit array_view( - int _E0, - int _E1, - _Container& _Src) restrict(cpu); - -explicit array_view( - int _E0, - int _E1, - int _E2) __CPU_ONLY; - -template < - typename _Container -> -explicit array_view( - int _E0, - int _E1, - int _E2, - _Container& _Src); - -explicit array_view( - int _E0, - _In_ value_type* _Src)restrict(amp,cpu); - -template < - typename _Arr_type, - int _Size -> -explicit array_view( - _In_ _Arr_type (& _Src) [_Size]) restrict(amp,cpu); - -explicit array_view( - int _E0, - int _E1, - _In_ value_type* _Src)restrict(amp,cpu); - -explicit array_view( - int _E0, - int _E1, - int _E2, - _In_ value_type* _Src)restrict(amp,cpu); - -array_view( - const array& _Src)restrict(amp,cpu); - -array_view( - const array_view& _Src)restrict(amp,cpu); - -array_view( - const array_view& _Src)restrict(amp,cpu); - -template < - typename _Container -> -array_view( - const Concurrency::extent<_Rank>& _Extent, - const _Container& _Src) restrict(cpu); - -template < - typename _Container -> -explicit array_view( - const _Container& _Src, - typename std::enable_if::type::value, void **>::type = 0) restrict(cpu); - -array_view( - const Concurrency::extent<_Rank>& _Extent, - const value_type* _Src)restrict(amp,cpu); - -template < - typename _Arr_type, - int _Size -> -explicit array_view( - const _In_ _Arr_type (& _Src) [_Size]) restrict(amp,cpu); - -template < - typename _Container -> -array_view( - int _E0, - const _Container& _Src); - -template < - typename _Container -> -array_view( - int _E0, - int _E1, - const _Container& _Src); - -template < - typename _Container -> -array_view( - int _E0, - int _E1, - int _E2, - const _Container& _Src); - -array_view( - int _E0, - const value_type* _Src)restrict(amp,cpu); - -array_view( - int _E0, - int _E1, - const value_type* _Src) restrict(amp,cpu); - -array_view( - int _E0, - int _E1, - int _E2, - const value_type* _Src) restrict(amp,cpu); -``` - -### Parameters - -*_Arr_type*
-The element type of a C-style array from which data is supplied. - -*_Container*
-A template argument that must specify a linear container that supports `data()` and `size()` members. - -*_E0*
-The most significant component of the extent of this section. - -*_E1*
-The next-to-most-significant component of the extent of this section. - -*_E2*
-The least significant component of the extent of this section. - -*_Extent*
-The extent in each dimension of this `array_view`. - -*_Other*
-An object of type `array_view` from which to initialize the new `array_view`. - -*_Size*
-The size of a C-style array from which data is supplied. - -*_Src*
-A pointer to the source data that will be copied into the new array. - -## copy_to - -Copies the contents of the `array_view` object to the specified destination object by calling `copy(*this, dest)`. - -```cpp -void copy_to( - array& _Dest) const; - -void copy_to( - array_view& _Dest) const; -``` - -### Parameters - -*_Dest*
-The object to copy to. - -## data - -Returns a pointer to the raw data of the `array_view`. - -```cpp -value_type* data() const restrict(amp, - cpu); - -const value_type* data() const restrict(amp, - cpu); -``` - -### Return Value - -A pointer to the raw data of the `array_view`. - -## discard_data - -Discards the current data underlying this view. This is an optimization hint to the runtime used to avoid copying the current contents of the view to a target `accelerator_view` that it is accessed on, and its use is recommended if the existing content is not needed. This method is a no-op when used in a restrict(amp) context - -```cpp -void discard_data() const restrict(cpu); -``` - -## extent - -Gets the `extent` object that defines the shape of the `array_view` object. - -```cpp -__declspec(property(get= get_extent)) Concurrency::extent<_Rank> extent; -``` - -## get_extent - -Returns the [extent](extent-class.md) object of the `array_view` object. - -```cpp -Concurrency::extent<_Rank> get_extent() const restrict(cpu, amp); -``` - -### Return Value - -The `extent` object of the `array_view` object - -## get_ref - -Get a reference to the element indexed by _Index. Unlike the other indexing operators for accessing the array_view on the CPU, this method does not implicitly synchronize this array_view's contents to the CPU. After accessing the array_view on a remote location or performing a copy operation involving this array_view users are responsible to explicitly synchronize the array_view to the CPU before calling this method. Failure to do so results in undefined behavior. - -```cpp -value_type& get_ref( - const index<_Rank>& _Index) const restrict(amp, cpu); -``` - -### Parameters - -*_Index*
-The index. - -### Return Value - -Reference to the element indexed by _Index - -## get_source_accelerator_view - -Returns the accelerator_view where the data source of the array_view is located. If the array_view does not have a data source, this API throws a runtime_exception - -```cpp -accelerator_view get_source_accelerator_view() const; -``` - -### Return Value - -## operator() - -Returns the value of the element that is specified by the parameter or parameters. - -```cpp -value_type& operator() ( - const index<_Rank>& _Index) const restrict(amp,cpu); - -typename details::_Projection_result_type::_Result_type operator() ( - int _I) const restrict(amp,cpu); - -value_type& operator() ( - int _I0, - int _I1) const restrict(amp,cpu); - -value_type& operator() ( - int _I0, - int _I1, - int _I2) const restrict(amp,cpu); - -typename details::_Projection_result_type::_Const_result_type operator() ( - int _I) const restrict(amp,cpu); -``` - -### Parameters - -*_Index*
-The location of the element. - -*_I0*
-The index in the first dimension. - -*_I1*
-The index in the second dimension. - -*_I2*
-The index in the third dimension. - -*_I*
-The location of the element. - -### Return Value - -The value of the element that is specified by the parameter or parameters. - -## operator[] - -Returns the element that is specified by the parameters. - -```cpp -typename details::_Projection_result_type::_Const_result_type operator[] ( - int _I) const restrict(amp,cpu); - -value_type& operator[] ( - const index<_Rank>& _Index) const restrict(amp,cpu); -``` - -### Parameters - -*_Index*
-The index. - -*_I*
-The index. - -### Return Value - -The value of the element at the index, or an `array_view` projected on the most-significant dimension. - -## operator= - -Copies the contents of the specified `array_view` object to this one. - -```cpp -array_view& operator= ( - const array_view& _Other) restrict(amp,cpu); - -array_view& operator= ( - const array_view& _Other) restrict(amp,cpu); -``` - -### Parameters - -*_Other*
-The `array_view` object to copy from. - -### Return Value - -A reference to this `array_view` object. - -## rank - -Stores the rank of the `array_view` object. - -```cpp -static const int rank = _Rank; -``` - -## refresh - -Notifies the `array_view` object that its bound memory has been modified outside the `array_view` interface. A call to this method renders all cached information stale. - -```cpp -void refresh() const restrict(cpu); -``` - -## reinterpret_as - -Reinterprets the array_view through a one-dimensional array_view, which as an option can have a different value type than the source array_view. - -### Syntax - -```cpp -template < - typename _Value_type2 -> -array_view< _Value_type2, _Rank> reinterpret_as() const restrict(amp,cpu); - -template < - typename _Value_type2 -> -array_view reinterpret_as() const restrict(amp,cpu); -``` - -### Parameters - -*_Value_type2*
-The data type of the new `array_view` object. - -### Return Value - -An `array_view` object or a const `array_view` object that is based on this `array_view`, with the element type converted from `T` to `_Value_type2`, and the rank reduced from *N* to 1. - -### Remarks - -Sometimes it is convenient to view a multi-dimensional array as a linear, one-dimensional array, which may have a different value type than the source array. You can achieve this on an `array_view` by using this method. - -**Warning** Reinterpreting an array_view object by using a different value type is a potentially unsafe operation. This functionality should be used with care. - -Here's an example: - -```cpp -struct RGB { float r; float g; float b; }; - -array a = ...; -array_view v = a.reinterpret_as(); - -assert(v.extent == 3*a.extent); -``` - -## section - -Returns a subsection of the `array_view` object that's at the specified origin and, optionally, that has the specified extent. - -```cpp -array_view section( - const Concurrency::index<_Rank>& _Section_origin, - const Concurrency::extent<_Rank>& _Section_extent) const restrict(amp,cpu); - -array_view section( - const Concurrency::index<_Rank>& _Idx) const restrict(amp,cpu); - -array_view section( - const Concurrency::extent<_Rank>& _Ext) const restrict(amp,cpu); - -array_view section( - int _I0, - int _E0) const restrict(amp,cpu); - -array_view section( - int _I0, - int _I1, - int _E0, - int _E1) const restrict(amp,cpu); - -array_view section( - int _I0, - int _I1, - int _I2, - int _E0, - int _E1, - int _E2) const restrict(amp,cpu); -``` - -### Parameters - -*_E0*
-The most significant component of the extent of this section. - -*_E1*
-The next-to-most-significant component of the extent of this section. - -*_E2*
-The least significant component of the extent of this section. - -*_Ext*
-The [extent](extent-class.md) object that specifies the extent of the section. The origin is 0. - -*_Idx*
-The [index](index-class.md) object that specifies the location of the origin. The subsection is the rest of the extent. - -*_I0*
-The most significant component of the origin of this section. - -*_I1*
-The next-to-most-significant component of the origin of this section. - -*_I2*
-The least significant component of the origin of this section. - -*_Rank*
-The rank of the section. - -*_Section_extent*
-The [extent](extent-class.md) object that specifies the extent of the section. - -*_Section_origin*
-The [index](index-class.md) object that specifies the location of the origin. - -### Return Value - -A subsection of the `array_view` object that's at the specified origin and, optionally, that has the specified extent. When only the `index` object is specified, the subsection contains all elements in the associated extent that have indexes that are larger than the indexes of the elements in the `index` object. - -## source_accelerator_view - -Gets the source accelerator_view that this array_view is associated with. - -```cpp -__declspec(property(get= get_source_accelerator_view)) accelerator_view source_accelerator_view; -``` - -## synchronize - -Synchronizes any modifications made to the `array_view` object back to its source data. - -```cpp -void synchronize(access_type _Access_type = access_type_read) const restrict(cpu); - -void synchronize() const restrict(cpu); -``` - -### Parameters - -*_Access_type*
-The intended [access_type](concurrency-namespace-enums-amp.md#access_type) on the target [accelerator_view](accelerator-view-class.md). This parameter has a default value of `access_type_read`. - -## synchronize_async - -Asynchronously synchronizes any modifications made to the `array_view` object back to its source data. - -```cpp -concurrency::completion_future synchronize_async(access_type _Access_type = access_type_read) const restrict(cpu); - -concurrency::completion_future synchronize_async() const restrict(cpu); -``` - -### Parameters - -*_Access_type*
-The intended [access_type](concurrency-namespace-enums-amp.md#access_type) on the target [accelerator_view](accelerator-view-class.md). This parameter has a default value of `access_type_read`. - -### Return Value - -A future upon which to wait for the operation to complete. - -## synchronize_to - -Synchronizes any modifications made to this array_view to the specified accelerator_view. - -```cpp -void synchronize_to( - const accelerator_view& _Accl_view, - access_type _Access_type = access_type_read) const restrict(cpu); - -void synchronize_to( - const accelerator_view& _Accl_view) const restrict(cpu); -``` - -### Parameters - -*_Accl_view*
-The target accelerator_view to synchronize to. - -*_Access_type*
-The desired access_type on the target accelerator_view. This parameter has a default value of access_type_read. - -## synchronize_to_async - -Asynchronously synchronizes any modifications made to this array_view to the specified accelerator_view. - -```cpp -concurrency::completion_future synchronize_to_async( - const accelerator_view& _Accl_view, - access_type _Access_type = access_type_read) const restrict(cpu); - -concurrency::completion_future synchronize_to_async( - const accelerator_view& _Accl_view) const restrict(cpu); -``` - -### Parameters - -*_Accl_view*
-The target accelerator_view to synchronize to. - -*_Access_type*
-The desired access_type on the target accelerator_view. This parameter has a default value of access_type_read. - -### Return Value - -A future upon which to wait for the operation to complete. - -## value_type - -The value type of the array_view and the bound array. - -```cpp -typedef typenamevalue_type value_type; -``` - -## view_as - -Reinterprets this `array_view` as an `array_view` of a different rank. - -```cpp -template < - int _New_rank -> -array_view view_as( - const Concurrency::extent<_New_rank>& _View_extent) const restrict(amp,cpu); - -template < - int _New_rank -> -array_view view_as( - const Concurrency::extent<_New_rank> _View_extent) const restrict(amp,cpu); -``` - -### Parameters - -*_New_rank*
-The rank of the new `array_view` object. - -*_View_extent*
-The reshaping `extent`. - -*value_type*
-The data type of the elements in both the original [array](array-class.md) object and the returned `array_view` object. - -### Return Value - -The `array_view` object that is constructed. - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/completion-future-class.md b/docs/parallel/amp/reference/completion-future-class.md deleted file mode 100644 index 7441757f113..00000000000 --- a/docs/parallel/amp/reference/completion-future-class.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -description: "Learn more about: completion_future Class" -title: "completion_future Class" -ms.date: "11/04/2016" -f1_keywords: ["completion_future", "AMPRT/completion_future", "AMPRT/Concurrency::completion_future::completion_future", "AMPRT/Concurrency::completion_future::get", "AMPRT/Concurrency::completion_future::then", "AMPRT/Concurrency::completion_future::to_task", "AMPRT/Concurrency::completion_future::valid", "AMPRT/Concurrency::completion_future::wait", "AMPRT/Concurrency::completion_future::wait_for", "AMPRT/Concurrency::completion_future::wait_until"] -ms.assetid: 1303c62e-546d-4b02-a578-251ed3fc0b6b ---- -# completion_future Class - -Represents a future corresponding to a C++ AMP asynchronous operation. - -## Syntax - -```cpp -class completion_future; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[completion_future Constructor](#ctor)|Initializes a new instance of the `completion_future` class.| -|[~completion_future Destructor](#dtor)|Destroys the `completion_future` object.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[get](#get)|Waits until the associated asynchronous operation completes.| -|[then](#then)|Chains a callback function object to the `completion_future` object to be executed when the associated asynchronous operation finishes execution.| -|[to_task](#to_task)|Returns a `task` object corresponding to the associated asynchronous operation.| -|[valid](#valid)|Gets a Boolean value that indicates whether the object is associated with an asynchronous operation.| -|[wait](#wait)|Blocks until the associated asynchronous operation completes.| -|[wait_for](#wait_for)|Blocks until the associated asynchronous operation completes or the time specified by `_Rel_time` has elapsed.| -|[wait_until](#wait_until)|Blocks until the associated asynchronous operation completes or until the current time exceeds the value specified by `_Abs_time`.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator std::shared_future\](#operator_shared_future)|Implicitly converts the `completion_future` object to an `std::shared_future` object.| -|[operator=](#operator_eq)|Copies the contents of the specified `completion_future` object into this one.| - -## Inheritance Hierarchy - -`completion_future` - -## Requirements - -**Header:** amprt.h - -**Namespace:** concurrency - -## completion_future - -Initializes a new instance of the `completion_future` class. - -### Syntax - -```cpp -completion_future(); - -completion_future( - const completion_future& _Other ); - -completion_future( - completion_future&& _Other ); -``` - -### Parameters - -*_Other*
-The `completion_future` object to copy or move. - -### Overloads List - -|Name|Description| -|----------|-----------------| -|`completion_future();`|Initializes a new instance of the `completion_future` Class| -|`completion_future(const completion_future& _Other);`|Initializes a new instance of the `completion_future` class by copying a constructor.| -|`completion_future(completion_future&& _Other);`|Initializes a new instance of the `completion_future` class by moving a constructor.| - -## get - -Waits until the associated asynchronous operation completes. Throws the stored exception if one was encountered during the asynchronous operation. - -### Syntax - -```cpp -void get() const; -``` - -## operator std::shared_future\ - -Implicitly converts the `completion_future` object to an `std::shared_future` object. - -### Syntax - -```cpp -operator std::shared_future() const; -``` - -### Return Value - -An `std::shared_future` object. - -## operator= - -Copies the contents of the specified `completion_future` object into this one. - -### Syntax - -```cpp -completion_future& operator= (const completion_future& _Other ); -completion_future& operator= (completion_future&& _Other ); -``` - -### Parameters - -*_Other*
-The object to copy from. - -### Return Value - -A reference to this `completion_future` object. - -## Overloads List - -|Name|Description| -|----------|-----------------| -|`completion_future& operator=(const completion_future& _Other);`|Copies the contents of the specified `completion_future` object into this one, using a deep copy.| -|`completion_future& operator=(completion_future&& _Other);`|Copies the contents of the specified `completion_future` object into this one, using a move assignment.| - -## then - -Chains a callback function object to the `completion_future` object to be executed when the associated asynchronous operation finishes execution. - -### Syntax - -```cpp -template -void then(const _Functor & _Func ) const; -``` - -### Parameters - -*_Functor*
-The callback functor. - -*_Func*
-The callback function object. - -## to_task - -Returns a `task` object corresponding to the associated asynchronous operation. - -### Syntax - -```cpp -concurrency::task to_task() const; -``` - -### Return Value - -A `task` object corresponding to the associated asynchronous operation. - -## valid - -Gets a Boolean value that indicates whether the object is associated with an asynchronous operation. - -### Syntax - -```cpp -bool valid() const; -``` - -### Return Value - -**`true`** if the object is associated with an asynchronous operation; otherwise, **`false`**. - -## wait - -Blocks until the associated asynchronous operation completes. - -### Syntax - -```cpp -void wait() const; -``` - -## wait_for - -Blocks until the associated asynchronous operation completes or the time that's specified by `_Rel_time` has elapsed. - -### Syntax - -```cpp -template < - class _Rep, - class _Period -> -std::future_status::future_status wait_for( - const std::chrono::duration< _Rep, _Period>& _Rel_time ) const; -``` - -### Parameters - -*_Rep*
-An arithmetic type that represents the number of ticks. - -*_Period*
-A std::ratio that represents the number of seconds that elapse per tick. - -*_Rel_time*
-The maximum amount of time to wait for the operation to complete. - -### Return Value - -Returns: - -- `std::future_status::deferred` if the associated asynchronous operation is not running. - -- `std::future_status::ready` if the associated asynchronous operation is finished. - -- `std::future_status::timeout` if the specified time period has elapsed. - -## wait_until - -Blocks until the associated asynchronous operation completes or until the current time exceeds the value specified by `_Abs_time`. - -### Syntax - -```cpp -template < - class _Clock, - class _Duration -> -std::future_status::future_status wait_until( - const std::chrono::time_point< _Clock, _Duration>& _Abs_time ) const; -``` - -### Parameters - -*_Clock*
-The clock on which this time point is measured. - -*_Duration*
-The time interval since the start of `_Clock`'s epoch, after which the function will time out. - -*_Abs_time*
-The point in time after which the function will time out. - -### Return Value - -Returns: - -1. `std::future_status::deferred` if the associated asynchronous operation is not running. - -1. `std::future_status::ready` if the associated asynchronous operation is finished. - -1. `std::future_status::timeout` if the time period specified has elapsed. - -## ~completion_future - -Destroys the `completion_future` object. - -### Syntax - -```cpp -~completion_future(); -``` - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp.md b/docs/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp.md deleted file mode 100644 index d0a6ddd7c47..00000000000 --- a/docs/parallel/amp/reference/concurrency-direct3d-namespace-functions-amp.md +++ /dev/null @@ -1,618 +0,0 @@ ---- -title: "Concurrency::direct3d namespace functions (AMP)" -description: "Learn more about: Concurrency::direct3d namespace functions (AMP)" -ms.date: "08/31/2018" -f1_keywords: ["amp/Concurrency::direct3d::abs", "amp/Concurrency::direct3d::countbits", "amp/Concurrency::direct3d::create_accelerator_view", "amp/Concurrency::direct3d::d3d_access_lock", "amp/Concurrency::direct3d::d3d_access_unlock", "amp/Concurrency::direct3d::firstbithigh", "amp/Concurrency::direct3d::get_buffer", "amp/Concurrency::direct3d::get_device", "amp/Concurrency::direct3d::imax", "amp/Concurrency::direct3d::is_timeout_disabled", "amp/Concurrency::direct3d::mad", "amp/Concurrency::direct3d::noise", "amp/Concurrency::direct3d::radians", "amp/Concurrency::direct3d::reversebits", "amp/Concurrency::direct3d::saturate", "amp/Concurrency::direct3d::smoothstep", "amp/Concurrency::direct3d::step", "amp/Concurrency::direct3d::umin"] ---- -# Concurrency::direct3d namespace functions (AMP) - -:::row::: - :::column span=""::: - [abs](#abs)\ - [clamp](#clamp)\ - [countbits](#countbits)\ - [create_accelerator_view](#create_accelerator_view)\ - [d3d_access_lock](#d3d_access_lock)\ - [d3d_access_try_lock](#d3d_access_try_lock)\ - [d3d_access_unlock](#d3d_access_unlock) - :::column-end::: - :::column span=""::: - [firstbithigh](#firstbithigh)\ - [firstbitlow](#firstbitlow)\ - [get_buffer](#get_buffer)\ - [get_device](#get_device)\ - [imax](#imax)\ - [imin](#imin)\ - [is_timeout_disabled](#is_timeout_disabled) - :::column-end::: - :::column span=""::: - [mad](#mad)\ - [make_array](#make_array)\ - [noise](#noise)\ - [radians](#radians)\ - [rcp](#rcp)\ - [reversebits](#reversebits) - :::column-end::: - :::column span=""::: - [saturate](#saturate)\ - [sign](#sign)\ - [smoothstep](#smoothstep)\ - [step](#step)\ - [umax](#umax)\ - [umin](#umin) - :::column-end::: -:::row-end::: - -## Requirements - -**Header:** amp.h - -**Namespace:** Concurrency - -## abs - -Returns the absolute value of the argument. - -```cpp -inline int abs(int _X) restrict(amp); -``` - -### Parameters - -*_X*\ -Integer value - -### Return Value - -Returns the absolute value of the argument. - -## clamp - -Computes the value of the first specified argument clamped to a range defined by the second and third specified arguments. - -```cpp -inline float clamp( - float _X, - float _Min, - float _Max) restrict(amp); - -inline int clamp( - int _X, - int _Min, - int _Max) restrict(amp); -``` - -### Parameters - -*_X*\ -The value to be clamped. - -*_Min*\ -The lower bound of the clamping range. - -*_Max*\ -The upper bound of the clamping range. - -### Return Value - -The clamped value of `_X`. - -## countbits - -Counts the number of set bits in `_X`. - -```cpp -inline unsigned int countbits(unsigned int _X) restrict(amp); -``` - -### Parameters - -*_X*\ -Unsigned integer value - -### Return Value - -Returns the number of set bits in `_X`. - -## create_accelerator_view - -Creates an [accelerator_view](accelerator-view-class.md) object from a pointer to a Direct3D device interface. - -## Syntax - -```cpp -accelerator_view create_accelerator_view( - IUnknown * _D3D_device, - queuing_mode _Qmode = queuing_mode_automatic); - -accelerator_view create_accelerator_view( - accelerator& _Accelerator, - bool _Disable_timeout, - queuing_mode _Qmode = queuing_mode_automatic); -``` - -### Parameters - -*_Accelerator*\ -The accelerator on which the new accelerator_view is to be created. - -*_D3D_device*\ -The pointer to the Direct3D device interface. - -*_Disable_timeout*\ -A Boolean parameter that specifies whether timeout should be disabled for the newly created accelerator_view. This corresponds to the D3D11_CREATE_DEVICE_DISABLE_GPU_TIMEOUT flag for Direct3D device creation and is used to indicate if the operating system should allow workloads that take more than 2 seconds to execute without resetting the device per the Windows timeout detection and recovery mechanism. Use of this flag is recommended if you need to perform time consuming tasks on the accelerator_view. - -*_Qmode*\ -The [queuing_mode](concurrency-namespace-enums-amp.md#queuing_mode) to be used for the newly created accelerator_view. This parameter has a default value of `queuing_mode_automatic`. - -## Return Value - -The `accelerator_view` object created from the passed Direct3D device interface. - -## Remarks - -This function creates a new `accelerator_view` object from an existing pointer to a Direct3D device interface. If the function call succeeds, the reference count of the parameter is incremented by means of an `AddRef` call to the interface. You can safely release the object when it is no longer required in your DirectX code. If the method call fails, a [runtime_exception](runtime-exception-class.md) is thrown. - -The `accelerator_view` object that you create by using this function is thread safe. You must synchronize concurrent use of the `accelerator_view` object. Unsynchronized concurrent usage of the `accelerator_view` object and the raw ID3D11Device interface causes undefined behavior. - -The C++ AMP runtime provides detailed error information in debug mode by using the D3D Debug layer if you use the `D3D11_CREATE_DEVICE_DEBUG` flag. - -## d3d_access_lock - -Acquire a lock on an accelerator_view for the purpose of safely performing D3D operations on resources shared with the accelerator_view. The accelerator_view and all C++ AMP resources associated with this accelerator_view internally take this lock when performing operations and will block while another thread holds the D3D access lock. This lock is non-recursive: It is undefined behavior to call this function from a thread that already holds the lock. It is undefined behavior to perform operations on the accelerator_view or any data container associated with the accelerator_view from the thread that holds the D3D access lock. See also scoped_d3d_access_lock, a RAII-style class for a scope-based D3D access lock. - -```cpp -void __cdecl d3d_access_lock(accelerator_view& _Av); -``` - -### Parameters - -*_Av*\ -The accelerator_view to lock. - -## d3d_access_try_lock - -Attempt to acquire the D3D access lock on an accelerator_view without blocking. - -```cpp -bool __cdecl d3d_access_try_lock(accelerator_view& _Av); -``` - -### Parameters - -*_Av*\ -The accelerator_view to lock. - -### Return Value - -true if the lock was acquired, or false if it is currently held by another thread. - -## d3d_access_unlock - -Release the D3D access lock on the given accelerator_view. If the calling thread does not hold the lock on the accelerator_view the results are undefined. - -```cpp -void __cdecl d3d_access_unlock(accelerator_view& _Av); -``` - -### Parameters - -*_Av*\ -The accelerator_view for which the lock is to be released. - -## firstbithigh - -Gets the location of the first set bit in `_X`, beginning with the highest-order bit and moving towards the lowest-order bit. - -```cpp -inline int firstbithigh(int _X) restrict(amp); -``` - -### Parameters - -*_X*\ -Integer value - -### Return Value - -The location of the first set bit. - -## firstbitlow - -Gets the location of the first set bit in `_X`, beginning with the lowest-order bit and working toward the highest-order bit. - -```cpp -inline int firstbitlow(int _X) restrict(amp); -``` - -### Parameters - -*_X*\ -Integer value - -### Return Value - -Returns The location of the first set bit. - -## get_buffer - -Get the Direct3D buffer interface underlying the specified array. - -```cpp -template< - typename value_type, - int _Rank -> -IUnknown *get_buffer( - const array& _Array); -``` - -### Parameters - -*value_type*\ -The type of elements in the array. - -*_Rank*\ -The rank of the array. - -*_Array*\ -An array on a Direct3D accelerator_view for which the underlying Direct3D buffer interface is returned. - -### Return Value - -The IUnknown interface pointer corresponding to the Direct3D buffer underlying the array. - -## get_device - -Get the D3D device interface underlying a accelerator_view. - -```cpp -IUnknown* get_device(const accelerator_view Av); -``` - -### Parameters - -*Av*\ -The D3D accelerator_view for which the underlying D3D device interface is returned. - -### Return value - -The `IUnknown` interface pointer of the D3D device underlying the accelerator_view. - -## imax - -Determine the maximum numeric value of the arguments. - -```cpp -inline int imax( - int _X, - int _Y) restrict(amp); -``` - -### Parameters - -*_X*\ -Integer value - -*_Y*\ -Integer value - -### Return Value - -Return the maximum numeric value of the arguments. - -## imin - -Determine the minimum numeric value of the arguments. - -```cpp -inline int imin( - int _X, - int _Y) restrict(amp); -``` - -### Parameters - -*_X*\ -Integer value - -*_Y*\ -Integer value - -### Return Value - -Return the minimum numeric value of the arguments. - -## is_timeout_disabled - -Returns a boolean flag indicating if timeout is disabled for the specified accelerator_view. This corresponds to the D3D11_CREATE_DEVICE_DISABLE_GPU_TIMEOUT flag for Direct3D device creation. - -```cpp -bool __cdecl is_timeout_disabled(const accelerator_view& _Accelerator_view); -``` - -### Parameters - -*_Accelerator_view*\ -The accelerator_view for which the timeout disabled setting is to be queried. - -### Return Value - -A boolean flag indicating if timeout is disabled for the specified accelerator_view. - -## mad - -Computes the product of the first and second specified argument, then adds the third specified argument. - -```cpp -inline float mad( - float _X, - float _Y, - float _Z) restrict(amp); - -inline double mad( - double _X, - double _Y, - double _Z) restrict(amp); - -inline int mad( - int _X, - int _Y, - int _Z) restrict(amp); - -inline unsigned int mad( - unsigned int _X, - unsigned int _Y, - unsigned int _Z) restrict(amp); -``` - -### Parameters - -*_X*\ -The first specified argument. - -*_Y*\ -The second specified argument. - -*_Z*\ -The third specified argument. - -### Return Value - -The result of `_X` \* `_Y` + `_Z`. - -## make_array - -Create an array from a Direct3D buffer interface pointer. - -```cpp -template< - typename value_type, - int _Rank -> -array make_array( - const extent<_Rank>& _Extent, - const Concurrency::accelerator_view& _Rv, - IUnknown* _D3D_buffer); -``` - -### Parameters - -*value_type*\ -The element type of the array to be created. - -*_Rank*\ -The rank of the array to be created. - -*_Extent*\ -An extent that describes the shape of the array aggregate. - -*_Rv*\ -A D3D accelerator view on which the array is to be created. - -*_D3D_buffer*\ -IUnknown interface pointer of the D3D buffer to create the array from. - -### Return Value - -An array created using the provided Direct3D buffer. - -## noise - -Generates a random value using the Perlin noise algorithm. - -```cpp -inline float noise(float _X) restrict(amp); -``` - -### Parameters - -*_X*\ -Floating-point value from which to generate Perlin noise. - -### Return Value - -Returns the Perlin noise value within a range between -1 and 1. - -## radians - -Converts `_X` from degrees to radians. - -```cpp -inline float radians(float _X) restrict(amp); -``` - -### Parameters - -*_X*\ -Floating-point value - -### Return Value - -Returns `_X` converted from degrees to radians. - -## rcp - -Computes the reciprocal of the specified argument by using a fast approximation. - -```cpp -inline float rcp(float _X) restrict(amp); - -inline double rcp(double _X) restrict(amp); -``` - -### Parameters - -*_X*\ -The value for which to compute the reciprocal. - -### Return Value - -The reciprocal of the specified argument. - -## reversebits - -Reverses the order of the bits in `_X`. - -```cpp -inline unsigned int reversebits(unsigned int _X) restrict(amp); -``` - -### Parameters - -*_X*\ -Unsigned integer value - -### Return Value - -Returns the value with the bit order reversed in `_X`. - -## saturate - -Clamps `_X` within the range of 0 to 1. - -```cpp -inline float saturate(float _X) restrict(amp); -``` - -### Parameters - -*_X*\ -Floating-point value - -### Return Value - -Returns `_X` clamped within the range of 0 to 1. - -## sign - -Determines the sign of the specified argument. - -```cpp -inline int sign(int _X) restrict(amp); -``` - -### Parameters - -*_X*\ -Integer value - -### Return Value - -The sign of the argument. - -## smoothstep - -Returns a smooth Hermite interpolation between 0 and 1, if `_X` is in the range [_Min, _Max]. - -```cpp -inline float smoothstep( - float _Min, - float _Max, - float _X) restrict(amp); -``` - -### Parameters - -*_Min*\ -Floating-point value - -*_Max*\ -Floating-point value - -*_X*\ -Floating-point value - -### Return Value - -Returns 0 if `_X` is less than _Min; 1 if `_X` is greater than _Max; otherwise, a value between 0 and 1 if `_X` is in the range [_Min, _Max]. - -## step - -Compares two values, returning 0 or 1 based on which value is greater. - -```cpp -inline float step( - float _Y, - float _X) restrict(amp); -``` - -### Parameters - -*_Y*\ -Floating-point value - -*_X*\ -Floating-point value - -### Return Value - -Returns 1 if the `_X` is greater than or equal to `_Y`; otherwise, 0. - -## umax - -Determine the maximum numeric value of the arguments. - -```cpp -inline unsigned int umax( - unsigned int _X, - unsigned int _Y) restrict(amp); -``` - -### Parameters - -*_X*\ -Integer value - -*_Y*\ -Integer value - -### Return Value - -Return the maximum numeric value of the arguments. - -## umin - -Determine the minimum numeric value of the arguments. - -```cpp -inline unsigned int umin( - unsigned int _X, - unsigned int _Y) restrict(amp); -``` - -### Parameters - -*_X*\ -Integer value - -*_Y*\ -Integer value - -### Return Value - -Return the minimum numeric value of the arguments. - -## See also - -[Concurrency::direct3d Namespace](concurrency-direct3d-namespace.md) diff --git a/docs/parallel/amp/reference/concurrency-direct3d-namespace.md b/docs/parallel/amp/reference/concurrency-direct3d-namespace.md deleted file mode 100644 index 3c371c751ec..00000000000 --- a/docs/parallel/amp/reference/concurrency-direct3d-namespace.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -description: "Learn more about: Concurrency::direct3d Namespace" -title: "Concurrency::direct3d Namespace" -ms.date: "11/04/2016" -f1_keywords: ["amp/Concurrency::direct3d", "amprt/Concurrency::direct3d", "amp_short_vectors/Concurrency::direct3d", "amp_graphics/Concurrency::direct3d", "amp_math/Concurrency::direct3d"] -helpviewer_keywords: ["direct3d namespace"] -ms.assetid: 9566a2f1-4d5f-43e4-a3ac-676643d38420 ---- -# Concurrency::direct3d Namespace - -The `direct3d` namespace provides functions that support D3D interoperability. It lets you use D3D resources for compute in AMP code. It also allows use of resources created in AMP in D3D code, without creating redundant intermediate copies. You can incrementally accelerate the compute intensive sections of your DirectX applications by using C++ AMP, and use the D3D API on data produced from AMP computations. - -## Syntax - -```cpp -namespace direct3d; -``` - -## Members - -### Classes - -|Name|Description| -|----------|-----------------| -|[scoped_d3d_access_lock Class](scoped-d3d-access-lock-class.md)|An RAII wrapper for a D3D access lock on an `accelerator_view` object.| - -### Structures - -|Name|Description| -|----------|-----------------| -|[adopt_d3d_access_lock_t Structure](adopt-d3d-access-lock-t-structure.md)|Tag type to indicate the D3D access lock should be adopted rather than acquired.| - -### Functions - -|Name|Description| -|----------|-----------------| -|[abs](concurrency-direct3d-namespace-functions-amp.md#abs)|Returns the absolute value of the argument| -|[clamp](concurrency-direct3d-namespace-functions-amp.md#clamp)|Overloaded. Clamps _X to the specified _Min and _Max range| -|[countbits](concurrency-direct3d-namespace-functions-amp.md#countbits)|Counts the number of set bits in _X| -|[create_accelerator_view](concurrency-direct3d-namespace-functions-amp.md#create_accelerator_view)|Creates an [accelerator_view Class](accelerator-view-class.md) from a pointer to a Direct3D device interface| -|[d3d_access_lock](concurrency-direct3d-namespace-functions-amp.md#d3d_access_lock)|Acquires a lock on an accelerator_view to safely perform D3D operations on resources shared with the accelerator_view| -|[d3d_access_try_lock](concurrency-direct3d-namespace-functions-amp.md#d3d_access_try_lock)|Attempt to acquire the D3D access lock on an accelerator_view without blocking.| -|[d3d_access_unlock](concurrency-direct3d-namespace-functions-amp.md#d3d_access_unlock)|Release the D3D access lock on the given accelerator_view.| -|[firstbithigh](concurrency-direct3d-namespace-functions-amp.md#firstbithigh)|Gets the location of the first set bit in _X, starting from the highest order bit and working downward| -|[firstbitlow](concurrency-direct3d-namespace-functions-amp.md#firstbitlow)|Gets the location of the first set bit in _X, starting from the lowest order bit and working upward| -|[get_buffer](concurrency-direct3d-namespace-functions-amp.md#get_buffer)|Get the D3D buffer interface underlying an array.| -|[imax](concurrency-direct3d-namespace-functions-amp.md#imax)|Compares two values, returning the value that's greater.| -|[imin](concurrency-direct3d-namespace-functions-amp.md#imin)|Compares two values, returning the value that's smaller.| -|[is_timeout_disabled](concurrency-direct3d-namespace-functions-amp.md#is_timeout_disabled)|Returns a boolean flag indicating if timeout is disabled for the specified accelerator_view.| -|[mad](concurrency-direct3d-namespace-functions-amp.md#mad)|Overloaded. Performs an arithmetic multiply/add operation on three arguments: _X \* _Y + _Z| -|[make_array](concurrency-direct3d-namespace-functions-amp.md#make_array)|Create an array from a D3D buffer interface pointer.| -|[noise](concurrency-direct3d-namespace-functions-amp.md#noise)|Generates a random value by using the Perlin noise algorithm| -|[radians](concurrency-direct3d-namespace-functions-amp.md#radians)|Converts _X from degrees to radians| -|[rcp](concurrency-direct3d-namespace-functions-amp.md#rcp)|Calculates a fast, approximate reciprocal of the argument| -|[reversebits](concurrency-direct3d-namespace-functions-amp.md#reversebits)|Reverses the order of the bits in _X| -|[saturate](concurrency-direct3d-namespace-functions-amp.md#saturate)|Clamps _X within the range of 0 to 1| -|[sign](concurrency-direct3d-namespace-functions-amp.md#sign)|Overloaded. Returns the sign of the argument| -|[smoothstep](concurrency-direct3d-namespace-functions-amp.md#smoothstep)|Returns a smooth Hermite interpolation between 0 and 1, if _X is in the range [_Min, _Max].| -|[step](concurrency-direct3d-namespace-functions-amp.md#step)|Compares two values, returning 0 or 1 based on which value is greater| -|[umax](concurrency-direct3d-namespace-functions-amp.md#umax)|Compares two unsigned values, returning the value that's greater.| -|[umin](concurrency-direct3d-namespace-functions-amp.md#umin)|Compares two unsigned values, returning the value that's smaller.| - -## Requirements - -**Header:** amp.h - -**Namespace:** Concurrency - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/concurrency-fast-math-namespace-functions.md b/docs/parallel/amp/reference/concurrency-fast-math-namespace-functions.md deleted file mode 100644 index dea78f5cd4d..00000000000 --- a/docs/parallel/amp/reference/concurrency-fast-math-namespace-functions.md +++ /dev/null @@ -1,1286 +0,0 @@ ---- -description: "Learn more about: Concurrency::fast_math namespace functions" -title: "Concurrency::fast_math namespace functions" -ms.date: "11/04/2016" -f1_keywords: ["amp_math/Concurrency::fast_math::acos", "amp_math/Concurrency::fast_math::asin", "amp_math/Concurrency::fast_math::asinf", "amp_math/Concurrency::fast_math::atan2", "amp_math/Concurrency::fast_math::atan2f", "amp_math/Concurrency::fast_math::ceil", "amp_math/Concurrency::fast_math::ceilf", "amp_math/Concurrency::fast_math::cosf", "amp_math/Concurrency::fast_math::cosh", "amp_math/Concurrency::fast_math::exp", "amp_math/Concurrency::fast_math::exp2", "amp_math/Concurrency::fast_math::expf", "amp_math/Concurrency::fast_math::fabs", "amp_math/Concurrency::fast_math::floor", "amp_math/Concurrency::fast_math::floorf", "amp_math/Concurrency::fast_math::fmaxf", "amp_math/Concurrency::fast_math::fmin", "amp_math/Concurrency::fast_math::fmod", "amp_math/Concurrency::fast_math::fmodf", "amp_math/Concurrency::fast_math::frexpf", "amp_math/Concurrency::fast_math::isfinite", "amp_math/Concurrency::fast_math::isnan", "amp_math/Concurrency::fast_math::ldexp", "amp_math/Concurrency::fast_math::log", "amp_math/Concurrency::fast_math::log10", "amp_math/Concurrency::fast_math::log2", "amp_math/Concurrency::fast_math::log2f", "amp_math/Concurrency::fast_math::modf", "amp_math/Concurrency::fast_math::modff", "amp_math/Concurrency::fast_math::powf", "amp_math/Concurrency::fast_math::round", "amp_math/Concurrency::fast_math::rsqrt", "amp_math/Concurrency::fast_math::rsqrtf", "amp_math/Concurrency::fast_math::signbitf", "amp_math/Concurrency::fast_math::sin", "amp_math/Concurrency::fast_math::sincosf", "amp_math/Concurrency::fast_math::sinf", "amp_math/Concurrency::fast_math::sinhf", "amp_math/Concurrency::fast_math::sqrt", "amp_math/Concurrency::fast_math::tan", "amp_math/Concurrency::fast_math::tanf", "amp_math/Concurrency::fast_math::tanhf", "amp_math/Concurrency::fast_math::trunc"] -ms.assetid: f5763d62-795b-4de6-a7a5-c7115f158708 ---- -# Concurrency::fast_math namespace functions - -:::row::: - :::column span=""::: - [`acos`](#acos)\ - [`acosf`](#acosf)\ - [`asin`](#asin)\ - [`asinf`](#asinf)\ - [`atan`](#atan)\ - [`atan2`](#atan2)\ - [`atan2f`](#atan2f)\ - [`atanf`](#atanf)\ - [`ceil`](#ceil)\ - [`ceilf`](#ceilf)\ - [`cos`](#cos)\ - [`cosf`](#cosf)\ - [`cosh`](#cosh)\ - [`coshf`](#coshf)\ - [`exp`](#exp)\ - [`exp2`](#exp2)\ - [`exp2f`](#exp2f) - :::column-end::: - :::column span=""::: - [`expf`](#expf)\ - [`fabs`](#fabs)\ - [`fabsf`](#fabsf)\ - [`floor`](#floor)\ - [`floorf`](#floorf)\ - [`fmax`](#fmax)\ - [`fmaxf`](#fmaxf)\ - [`fmin`](#fmin)\ - [`fminf`](#fminf)\ - [`fmod`](#fmod)\ - [`fmodf`](#fmodf)\ - [`frexp`](#frexp)\ - [`frexpf`](#frexpf)\ - [`isfinite`](#isfinite)\ - [`isinf`](#isinf)\ - [`isnan`](#isnan) - :::column-end::: - :::column span=""::: - [`ldexp`](#ldexp)\ - [`ldexpf`](#ldexpf)\ - [`log`](#log)\ - [`log10`](#log10)\ - [`log10f`](#log10f)\ - [`log2`](#log2)\ - [`log2f`](#log2f)\ - [`logf`](#logf)\ - [`modf`](#modf)\ - [`modff`](#modff)\ - [`pow`](#pow)\ - [`powf`](#powf)\ - [`round`](#round)\ - [`roundf`](#roundf)\ - [`rsqrt`](#rsqrt)\ - [`rsqrtf`](#rsqrtf) - :::column-end::: - :::column span=""::: - [`signbit`](#signbit)\ - [`signbitf`](#signbitf)\ - [`sin`](#sin)\ - [`sincos`](#sincos)\ - [`sincosf`](#sincosf)\ - [`sinf`](#sinf)\ - [`sinh`](#sinh)\ - [`sinhf`](#sinhf)\ - [`sqrt`](#sqrt)\ - [`sqrtf`](#sqrtf)\ - [`tan`](#tan)\ - [`tanf`](#tanf)\ - [`tanh`](#tanh)\ - [`tanhf`](#tanhf)\ - [`trunc`](#trunc)\ - [`truncf`](#truncf) - :::column-end::: -:::row-end::: - -## acos - -Calculates the arccosine of the argument - -```cpp -inline float acos(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arccosine value of the argument - -## acosf - -Calculates the arccosine of the argument - -```cpp -inline float acosf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arccosine value of the argument - -## asin - -Calculates the arcsine of the argument - -```cpp -inline float asin(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arcsine value of the argument - -## asinf - -Calculates the arcsine of the argument - -```cpp -inline float asinf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arcsine value of the argument - -## atan - -Calculates the arctangent of the argument - -```cpp -inline float atan(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arctangent value of the argument - -## atan2 - -Calculates the arctangent of _Y/_X - -```cpp -inline float atan2( - float _Y, - float _X) restrict(amp); -``` - -### Parameters - -*_Y*
-Floating-point value - -*_X*
-Floating-point value - -### Return Value - -Returns the arctangent value of _Y/_X - -## atan2f - -Calculates the arctangent of _Y/_X - -```cpp -inline float atan2f( - float _Y, - float _X) restrict(amp); -``` - -### Parameters - -*_Y*
-Floating-point value - -*_X*
-Floating-point value - -### Return Value - -Returns the arctangent value of _Y/_X - -## atanf - -Calculates the arctangent of the argument - -```cpp -inline float atanf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arctangent value of the argument - -## ceil - -Calculates the ceiling of the argument - -```cpp -inline float ceil(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the ceiling of the argument - -## ceilf - -Calculates the ceiling of the argument - -```cpp -inline float ceilf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the ceiling of the argument - -## cosf - -Calculates the cosine of the argument - -```cpp -inline float cosf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the cosine value of the argument - -## coshf - -Calculates the hyperbolic cosine value of the argument - -```cpp -inline float coshf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic cosine value of the argument - -## cos - -Calculates the cosine of the argument - -```cpp -inline float cos(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the cosine value of the argument - -## cosh - -Calculates the hyperbolic cosine value of the argument - -```cpp -inline float cosh(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic cosine value of the argument - -## exp - -Calculates the base-e exponential of the argument - -```cpp -inline float exp(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-e exponential of the argument - -## exp2 - -Calculates the base-2 exponential of the argument - -```cpp -inline float exp2(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-2 exponential of the argument - -## exp2f - -Calculates the base-2 exponential of the argument - -```cpp -inline float exp2f(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-2 exponential of the argument - -## expf - -Calculates the base-e exponential of the argument - -```cpp -inline float expf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-e exponential of the argument - -## fabs - -Returns the absolute value of the argument - -```cpp -inline float fabs(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Integer value - -### Return Value - -Returns the absolute value of the argument - -## fabsf - -Returns the absolute value of the argument - -```cpp -inline float fabsf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the absolute value of the argument - -## floor - -Calculates the floor of the argument - -```cpp -inline float floor(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the floor of the argument - -## floorf - -Calculates the floor of the argument - -```cpp -inline float floorf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the floor of the argument - -## fmax - -Determine the maximum numeric value of the arguments - -```cpp -inline float max( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Integer value - -*_Y*
-Integer value - -### Return Value - -Return the maximum numeric value of the arguments - -## fmaxf - -Determine the maximum numeric value of the arguments - -```cpp -inline float fmaxf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Return the maximum numeric value of the arguments - -## fmin - -Determine the minimum numeric value of the arguments - -```cpp -inline float min( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Integer value - -*_Y*
-Integer value - -### Return Value - -Return the minimum numeric value of the arguments - -## fminf - -Determine the minimum numeric value of the arguments - -```cpp -inline float fminf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Return the minimum numeric value of the arguments - -## fmod - -Calculates the floating-point remainder of _X/_Y - -```cpp -inline float fmod( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns the floating-point remainder of _X/_Y - -## fmodf - -Calculates the floating-point remainder of _X/_Y. - -```cpp -inline float fmodf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns the floating-point remainder of _X/_Y - -## frexp - -Gets the mantissa and exponent of _X - -```cpp -inline float frexp( - float _X, - _Out_ int* _Exp) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Exp*
-Returns the integer exponent of _X in floating-point value - -### Return Value - -Returns the mantissa _X - -## frexpf - -Gets the mantissa and exponent of _X - -```cpp -inline float frexpf( - float _X, - _Out_ int* _Exp) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Exp*
-Returns the integer exponent of _X in floating-point value - -### Return Value - -Returns the mantissa _X - -## isfinite - -Determines whether the argument has a finite value - -```cpp -inline int isfinite(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the argument has a finite value - -## isinf - -Determines whether the argument is an infinity - -```cpp -inline int isinf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the argument has an infinite value - -## isnan - -Determines whether the argument is a NaN - -```cpp -inline int isnan(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the argument has a NaN value - -## ldexp - -Computes a real number from the mantissa and exponent - -```cpp -inline float ldexp( - float _X, - int _Exp) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value, mentissa - -*_Exp*
-Integer exponent - -### Return Value - -Returns _X \* 2^_Exp - -## ldexpf - -Computes a real number from the mantissa and exponent - -```cpp -inline float ldexpf( - float _X, - int _Exp) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value, mentissa - -*_Exp*
-Integer exponent - -### Return Value - -Returns _X \* 2^_Exp - -## log - -Calculates the base-e logarithm of the argument - -```cpp -inline float log(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-e logarithm of the argument - -## log10 - -Calculates the base-10 logarithm of the argument - -```cpp -inline float log10(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-10 logarithm of the argument - -## log10f - -Calculates the base-10 logarithm of the argument - -```cpp -inline float log10f(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-10 logarithm of the argument - -## log2 - -Calculates the base-2 logarithm of the argument - -```cpp -inline float log2(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-2 logarithm of the argument - -## log2f - -Calculates the base-2 logarithm of the argument - -```cpp -inline float log2f(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-10 logarithm of the argument - -## logf - -Calculates the base-e logarithm of the argument - -```cpp -inline float logf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-e logarithm of the argument - -## modf - -Splits _X into fractional and integer parts. - -```cpp -inline float modf( - float _X, - float* _Ip) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Ip*
-Receives integer part of the value - -### Return Value - -Returns the signed fractional portion of _X - -## modff - -Splits _X into fractional and integer parts. - -```cpp -inline float modff( - float _X, - float* _Ip) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Ip*
-Receives integer part of the value - -### Return Value - -Returns the signed fractional portion of _X - -## pow - -Calculates _X raised to the power of _Y - -```cpp -inline float pow( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value, base - -*_Y*
-Floating-point value, exponent - -### Return Value - -Returns the value of _X raised to the power of _Y - -## powf - -Calculates _X raised to the power of _Y - -```cpp -inline float powf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value, base - -*_Y*
-Floating-point value, exponent - -### Return Value - -## round - -Rounds _X to the nearest integer - -```cpp -inline float round(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the nearest integer of _X - -## roundf - -Rounds _X to the nearest integer - -```cpp -inline float roundf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the nearest integer of _X - -## rsqrt - -Returns the reciprocal of the square root of the argument - -```cpp -inline float rsqrt(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the reciprocal of the square root of the argument - -## rsqrtf - -Returns the reciprocal of the square root of the argument - -```cpp -inline float rsqrtf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the reciprocal of the square root of the argument - -## signbit - -Determines whether the sign of _X is negative - -```cpp -inline int signbit(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the sign of _X is negative - -## signbitf - -Determines whether the sign of _X is negative - -```cpp -inline int signbitf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the sign of _X is negative - -## sin - -Calculates the sine value of the argument - -```cpp -inline float sin(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the sine value of the argument - -## sinf - -Calculates the sine value of the argument - -```cpp -inline float sinf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the sine value of the argument - -## sincos - -Calculates sine and cosine value of _X - -```cpp -inline void sincos( - float _X, - float* _S, - float* _C) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_S*
-Returns the sine value of _X - -*_C*
-Returns the cosine value of _X - -## sincosf - -Calculates sine and cosine value of _X - -```cpp -inline void sincosf( - float _X, - float* _S, - float* _C) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_S*
-Returns the sine value of _X - -*_C*
-Returns the cosine value of _X - -## sinh - -Calculates the hyperbolic sine value of the argument - -```cpp -inline float sinh(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic sine value of the argument - -## sinhf - -Calculates the hyperbolic sine value of the argument - -```cpp -inline float sinhf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic sine value of the argument - -## sqrt - -Calculates the squre root of the argument - -```cpp -inline float sqrt(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the squre root of the argument - -## sqrtf - -Calculates the squre root of the argument - -```cpp -inline float sqrtf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the squre root of the argument - -## tan - -Calculates the tangent value of the argument - -```cpp -inline float tan(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the tangent value of the argument - -## tanf - -Calculates the tangent value of the argument - -```cpp -inline float tanf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the tangent value of the argument - -## tanh - -Calculates the hyperbolic tangent value of the argument - -```cpp -inline float tanh(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic tangent value of the argument - -## tanhf - -Calculates the hyperbolic tangent value of the argument - -```cpp -inline float tanhf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic tangent value of the argument - -## trunc - -Truncates the argument to the integer component - -```cpp -inline float trunc(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the integer component of the argument - -## truncf - -Truncates the argument to the integer component - -```cpp -inline float truncf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the integer component of the argument - -## Requirements - -**Header:** amp_math.h -**Namespace:** Concurrency::fast_math - -## See also - -[Concurrency::fast_math Namespace](concurrency-fast-math-namespace.md) diff --git a/docs/parallel/amp/reference/concurrency-fast-math-namespace.md b/docs/parallel/amp/reference/concurrency-fast-math-namespace.md deleted file mode 100644 index 38e9403d86e..00000000000 --- a/docs/parallel/amp/reference/concurrency-fast-math-namespace.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -description: "Learn more about: Concurrency::fast_math Namespace" -title: "Concurrency::fast_math Namespace" -ms.date: "11/04/2016" -f1_keywords: ["amp_math/Concurrency::fast_math"] -ms.assetid: 54fed939-9902-49db-9f29-e98fd9821508 ---- -# Concurrency::fast_math Namespace - -Functions in the `fast_math` namespace have lower accuracy, support only single-precision (**`float`**), and call the DirectX intrinsics. There are two versions of each function, for example `cos` and `cosf`. Both versions take and return a **`float`**, but each calls the same DirectX intrinsic. - -## Syntax - -```cpp -namespace fast_math; -``` - -## Members - -### Functions - -|Name|Description| -|----------|-----------------| -|[cos](concurrency-fast-math-namespace-functions.md#cos)|Calculates the arccosine of the argument| -|[cosf](concurrency-fast-math-namespace-functions.md#cosf)|Calculates the arccosine of the argument| -|[asin](concurrency-fast-math-namespace-functions.md#asin)|Calculates the arcsine of the argument| -|[asinf](concurrency-fast-math-namespace-functions.md#asinf)|Calculates the arcsine of the argument| -|[atan](concurrency-fast-math-namespace-functions.md#atan)|Calculates the arctangent of the argument| -|[atan2](concurrency-fast-math-namespace-functions.md#atan2)|Calculates the arctangent of _Y/_X| -|[atan2f](concurrency-fast-math-namespace-functions.md#atan2f)|Calculates the arctangent of _Y/_X| -|[atanf](concurrency-fast-math-namespace-functions.md#atanf)|Calculates the arctangent of the argument| -|[ceil](concurrency-fast-math-namespace-functions.md#ceil)|Calculates the ceiling of the argument| -|[ceilf](concurrency-fast-math-namespace-functions.md#ceilf)|Calculates the ceiling of the argument| -|[cos](concurrency-fast-math-namespace-functions.md#cos)|Calculates the cosine of the argument| -|[cosf](concurrency-fast-math-namespace-functions.md#cosf)|Calculates the cosine of the argument| -|[cosh](concurrency-fast-math-namespace-functions.md#cosh)|Calculates the hyperbolic cosine value of the argument| -|[coshf](concurrency-fast-math-namespace-functions.md#coshf)|Calculates the hyperbolic cosine value of the argument| -|[exp](concurrency-fast-math-namespace-functions.md#exp)|Calculates the base-e exponential of the argument| -|[exp2](concurrency-fast-math-namespace-functions.md#exp2)|Calculates the base-2 exponential of the argument| -|[exp2f](concurrency-fast-math-namespace-functions.md#exp2f)|Calculates the base-2 exponential of the argument| -|[expf](concurrency-fast-math-namespace-functions.md#expf)|Calculates the base-e exponential of the argument| -|[fabs](concurrency-fast-math-namespace-functions.md#fabs)|Returns the absolute value of the argument| -|[fabsf](concurrency-fast-math-namespace-functions.md#fabsf)|Returns the absolute value of the argument| -|[floor](concurrency-fast-math-namespace-functions.md#floor)|Calculates the floor of the argument| -|[floorf](concurrency-fast-math-namespace-functions.md#floorf)|Calculates the floor of the argument| -|[fmax](concurrency-fast-math-namespace-functions.md#fmax)|Determine the maximum numeric value of the arguments| -|[fmaxf](concurrency-fast-math-namespace-functions.md#fmaxf)|Determine the maximum numeric value of the arguments| -|[fmin](concurrency-fast-math-namespace-functions.md#fmin)|Determine the minimum numeric value of the arguments| -|[fminf](concurrency-fast-math-namespace-functions.md#fminf)|Determine the minimum numeric value of the arguments| -|[fmod](concurrency-fast-math-namespace-functions.md#fmod)|Calculates the floating-point remainder of _X/_Y| -|[fmodf](concurrency-fast-math-namespace-functions.md#fmodf)|Calculates the floating-point remainder of _X/_Y| -|[frexp](concurrency-fast-math-namespace-functions.md#frexp)|Gets the mantissa and exponent of _X| -|[frexpf](concurrency-fast-math-namespace-functions.md#frexpf)|Gets the mantissa and exponent of _X| -|[isfinite](concurrency-fast-math-namespace-functions.md#isfinite)|Determines whether the argument has a finite value| -|[isinf](concurrency-fast-math-namespace-functions.md#isinf)|Determines whether the argument is an infinity| -|[isnan](concurrency-fast-math-namespace-functions.md#isnan)|Determines whether the argument is a NaN| -|[ldexp](concurrency-fast-math-namespace-functions.md#ldexp)|Computes a real number from the mantissa and exponent| -|[ldexpf](concurrency-fast-math-namespace-functions.md#ldexpf)|Computes a real number from the mantissa and exponent| -|[log](concurrency-fast-math-namespace-functions.md#log)|Calculates the base-e logarithm of the argument| -|[log10](concurrency-fast-math-namespace-functions.md#log10)|Calculates the base-10 logarithm of the argument| -|[log10f](concurrency-fast-math-namespace-functions.md#log10f)|Calculates the base-10 logarithm of the argument| -|[log2](concurrency-fast-math-namespace-functions.md#log2)|Calculates the base-2 logarithm of the argument| -|[log2f](concurrency-fast-math-namespace-functions.md#log2f)|Calculates the base-2 logarithm of the argument| -|[logf](concurrency-fast-math-namespace-functions.md#logf)|Calculates the base-e logarithm of the argument| -|[modf](concurrency-fast-math-namespace-functions.md#modf)|Splits _X into fractional and integer parts.| -|[modff](concurrency-fast-math-namespace-functions.md#modff)|Splits _X into fractional and integer parts.| -|[pow](concurrency-fast-math-namespace-functions.md#pow)|Calculates _X raised to the power of _Y| -|[powf](concurrency-fast-math-namespace-functions.md#powf)|Calculates _X raised to the power of _Y| -|[round](concurrency-fast-math-namespace-functions.md#round)|Rounds _X to the nearest integer| -|[roundf](concurrency-fast-math-namespace-functions.md#roundf)|Rounds _X to the nearest integer| -|[rsqrt](concurrency-fast-math-namespace-functions.md#rsqrt)|Returns the reciprocal of the square root of the argument| -|[rsqrtf](concurrency-fast-math-namespace-functions.md#rsqrtf)|Returns the reciprocal of the square root of the argument| -|[signbit](concurrency-fast-math-namespace-functions.md#signbit)|Returns the sign of the argument| -|[signbitf](concurrency-fast-math-namespace-functions.md#signbitf)|Returns the sign of the argument| -|[sin](concurrency-fast-math-namespace-functions.md#sin)|Calculates the sine value of the argument| -|[sincos](concurrency-fast-math-namespace-functions.md#sincos)|Calculates sine and cosine value of _X| -|[sincosf](concurrency-fast-math-namespace-functions.md#sincosf)|Calculates sine and cosine value of _X| -|[sinf](concurrency-fast-math-namespace-functions.md#sinf)|Calculates the sine value of the argument| -|[sinh](concurrency-fast-math-namespace-functions.md#sinh)|Calculates the hyperbolic sine value of the argument| -|[sinhf](concurrency-fast-math-namespace-functions.md#sinhf)|Calculates the hyperbolic sine value of the argument| -|[sqrt](concurrency-fast-math-namespace-functions.md#sqrt)|Calculates the square root of the argument| -|[sqrtf](concurrency-fast-math-namespace-functions.md#sqrtf)|Calculates the square root of the argument| -|[tan](concurrency-fast-math-namespace-functions.md#tan)|Calculates the tangent value of the argument| -|[tanf](concurrency-fast-math-namespace-functions.md#tanf)|Calculates the tangent value of the argument| -|[tanh](concurrency-fast-math-namespace-functions.md#tanh)|Calculates the hyperbolic tangent value of the argument| -|[tanhf](concurrency-fast-math-namespace-functions.md#tanhf)|Calculates the hyperbolic tangent value of the argument| -|[trunc](concurrency-fast-math-namespace-functions.md#trunc)|Truncates the argument to the integer component| -|[truncf](concurrency-fast-math-namespace-functions.md#truncf)|Truncates the argument to the integer component| - -## Requirements - -**Header:** amp_math.h - -**Namespace:** Concurrency::fast_math - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions.md b/docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions.md deleted file mode 100644 index 946f6478c8f..00000000000 --- a/docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -description: "Learn more about: Concurrency::graphics::direct3d namespace functions" -title: "Concurrency::graphics::direct3d namespace functions" -ms.date: "11/04/2016" -f1_keywords: ["amp_graphics/Concurrency::graphics::direct3d::get_sampler", "amp_graphics/Concurrency::graphics::direct3d::make_sampler", "amp_graphics/Concurrency::graphics::direct3d::make_texture"] -ms.assetid: 11ee1d42-333e-4ae9-95ac-4cf68c06d13d ---- -# Concurrency::graphics::direct3d namespace functions - -:::row::: - :::column span=""::: - [`get_sampler`](#get_sampler)\ - [`get_texture`](#get_texture) - :::column-end::: - :::column span=""::: - [`make_sampler`](#make_sampler) - :::column-end::: - :::column span=""::: - [`make_texture`](#make_texture) - :::column-end::: - :::column span=""::: - [`msad4`](#msad4) - :::column-end::: -:::row-end::: - -## get_sampler - -Get the D3D sampler state interface on the given accelerator view that represents the specified sampler object. - -```cpp -IUnknown* get_sampler( - const Concurrency::accelerator_view& _Av, - const sampler& _Sampler) restrict(amp); -``` - -### Parameters - -*_Av*
-A D3D accelerator view on which the D3D sampler state is to be created. - -*_Sampler*
-A sampler object for which the underlying D3D sampler state interface is created. - -### Return Value - -The IUnknown interface pointer corresponding to the D3D sampler state that represents the given sampler. - -## get_texture - -Gets the Direct3D texture interface underlying the specified [texture](texture-class.md) object. - -```cpp -template< - typename value_type, - int _Rank -> -_Ret_ IUnknown *get_texture( - const texture& _Texture) restrict(cpu); - -template< - typename value_type, - int _Rank -> -_Ret_ IUnknown *get_texture( - const writeonly_texture_view& _Texture) restrict(cpu); - -template< - typename value_type, - int _Rank -> -_Ret_ IUnknown *get_texture( - const texture_view& _Texture) restrict(cpu); -``` - -### Parameters - -*value_type*
-The element type of the texture. - -*_Rank*
-The rank of the texture. - -*_Texture*
-A texture or texture view associated with the accelerator_view for which the underlying Direct3D texture interface is returned. - -### Return Value - -The IUnknown interface pointer corresponding to the Direct3D texture underlying the texture. - -## make_sampler - -Create a sampler from a D3D sampler state interface pointer. - -```cpp -sampler make_sampler(_In_ IUnknown* _D3D_sampler) restrict(amp); -``` - -### Parameters - -*_D3D_sampler*
-IUnknown interface pointer of the D3D sampler state to create the sampler from. - -### Return Value - -A sampler represents the provided D3D sampler state. - -## make_texture - -Creates a [texture](texture-class.md) object by using the specified parameters. - -```cpp -template< - typename value_type, - int _Rank -> -texture make_texture( - const Concurrency::accelerator_view& _Av, - _In_ IUnknown* _D3D_texture, - DXGI_FORMAT _View_format = DXGI_FORMAT_UNKNOWN) restrict(cpu); -``` - -### Parameters - -*value_type*
-The type of the elements in the texture. - -*_Rank*
-The rank of the texture. - -*_Av*
-A D3D accelerator view on which the texture is to be created. - -*_D3D_texture*
-IUnknown interface pointer of the D3D texture to create the texture from. - -*_View_format*
-The DXGI format to use for views created from this texture. Pass DXGI_FORMAT_UNKNOWN (the default) to derive the format from the underlying format of _D3D_texture and the value_type of this template. The provided format must be compatible with the underlying format of _D3D_texture. - -### Return Value - -A texture using the provided D3D texture. - -## msad4 - -Compares a 4-byte reference value and an 8-byte source value and accumulates a vector of 4 sums. Each sum corresponds to the masked sum of absolute differences of different byte alignments between the reference value and the source value. - -```cpp -inline uint4 msad4( - uint _Reference, - uint2 _Source, - uint4 _Accum) restrict(amp); -``` - -### Parameters - -*_Reference*
-The reference array of 4 bytes in one uint value - -*_Source*
-The source array of 8 bytes in a vector of two uint values. - -*_Accum*
-A vector of 4 values to be added to the masked sum of absolute differences of the different byte alignments between the reference value and the source value. - -### Return Value - -Returns a vector of 4 sums. Each sum corresponds to the masked sum of absolute differences of different byte alignments between the reference value and the source value. - -## Requirements - -**Header:** amp_graphics.h - -**Namespace:** Concurrency::graphics::direct3d - -## See also - -[Concurrency::graphics::direct3d Namespace](concurrency-graphics-direct3d-namespace.md) diff --git a/docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace.md b/docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace.md deleted file mode 100644 index 05afb7f5aed..00000000000 --- a/docs/parallel/amp/reference/concurrency-graphics-direct3d-namespace.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "Concurrency::graphics::direct3d Namespace" -description: "Learn more about: Concurrency::graphics::direct3d Namespace" -ms.date: 11/04/2016 -f1_keywords: ["amp_graphics/Concurrency::graphics::direct3d", "amp_short_vectors/Concurrency::graphics::direct3d"] ---- -# Concurrency::graphics::direct3d Namespace - -Provides the [get_texture](concurrency-graphics-direct3d-namespace-functions.md#get_texture) and [make_texture](concurrency-graphics-direct3d-namespace-functions.md#make_texture) methods. - -## Syntax - -```cpp -namespace direct3d; -``` - -## Members - -### Functions - -|Name|Description| -|----------|-----------------| -|[get_sampler](concurrency-graphics-direct3d-namespace-functions.md#get_sampler)|Get the Direct3D sampler state interface on the given accelerator view that represents the specified sampler object.| -|[get_texture](concurrency-graphics-direct3d-namespace-functions.md#get_texture)|Gets the Direct3D texture interface underlying the specified [texture](texture-class.md) object.| -|[make_sampler](concurrency-graphics-direct3d-namespace-functions.md#make_sampler)|Create a sampler from a Direct3D sampler state interface pointer.| -|[make_texture](concurrency-graphics-direct3d-namespace-functions.md#make_texture)|Creates a [texture](texture-class.md) object by using the specified parameters.| -|[msad4](concurrency-graphics-direct3d-namespace-functions.md#msad4)|Compares a 4-byte reference value and an 8-byte source value and accumulates a vector of 4 sums.| - -## Requirements - -**Header:** amp_graphics.h - -**Namespace:** Concurrency::graphics - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/concurrency-graphics-namespace-enums.md b/docs/parallel/amp/reference/concurrency-graphics-namespace-enums.md deleted file mode 100644 index 212776f47b4..00000000000 --- a/docs/parallel/amp/reference/concurrency-graphics-namespace-enums.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -description: "Learn more about: Concurrency::graphics namespace enums" -title: "Concurrency::graphics namespace enums" -ms.date: "11/04/2016" -f1_keywords: ["amp_graphics/concurrency::graphics::address_mode", "amp_graphics/concurrency::graphics::filter_mode"] -ms.assetid: 1d2e1859-a3d7-4d3d-8e03-1a877a86b3e0 ---- -# Concurrency::graphics namespace enums - -|Name|Description| -|-|-| -|[_mode Enumeration](#address_mode)|[filter_mode Enumeration](#filter_mode)| - -## address_mode Enumeration - -Enumeration type use to denote address modes supported for texture sampling. - -```cpp -enum address_mode; -``` - -## filter_mode Enumeration - -Enumeration type use to denote filter modes supported for texture sampling. - -```cpp -enum filter_mode; -``` - -## Requirements - -**Header:** amp_graphics.h -**Namespace:** Concurrency::graphics - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md b/docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md deleted file mode 100644 index e9e8eef1890..00000000000 --- a/docs/parallel/amp/reference/concurrency-graphics-namespace-functions.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -title: "Concurrency::graphics namespace functions" -description: "Learn more about: Concurrency::graphics namespace functions" -ms.date: 11/04/2016 -f1_keywords: ["amp_graphics/Concurrency::fast_math::copy_async", "amp_graphics/Concurrency::fast_math::copy"] ---- -# Concurrency::graphics namespace functions - -The following functions are available in the `Concurrency::graphics` namespace: - -## copy Function (Concurrency::graphics Namespace) - -Copies a source texture into a destination buffer, or copies a source buffer into a destination buffer. The general form of this function is `copy(src, dest)`. - -```cpp -template < - typename _Src_type, - typename = typename std::enable_if::is_texture, void>::type> -> -void copy ( - const _Src_type& _Src, - _Out_ void* _Dst, - unsigned int _Dst_byte_size); - -template < - typename _Src_type, - typename = typename std::enable_if::is_texture, void>::type -> -void copy( - const _Src_type& _Src, - const index<_Src_type::rank>& _Src_offset, - const extent<_Src_type::rank>& _Copy_extent, - _Out_ void* _Dst, - unsigned int _Dst_byte_size); - -template < - typename _Dst_type, - typename = typename std::enable_if::is_texture, void>::type -> -void copy( - const void* _Src, - unsigned int _Src_byte_size, _Dst_type& _Dst); - -template < - typename _Dst_type, - typename = typename std::enable_if::is_texture, void>::type -> -void copy( - const void* _Src, - unsigned int _Src_byte_size, - _Dst_type& _Dst, - const index<_Dst_type::rank>& _Dst_offset, - const extent<_Dst_type::rank>& _Copy_extent); - -template < - typename InputIterator, - typename _Dst_type, - typename = typename std::enable_if::is_texture, void>::type -> -void copy(InputIterator first, InputIterator last, _Dst_type& _Dst); - -template < - typename InputIterator, - typename _Dst_type, - typename = typename std::enable_if::is_texture, void>::type ->void copy(InputIterator first, InputIterator last, _Dst_type& _Dst, - const index<_Dst_type::rank>& _Dst_offset, - const extent<_Dst_type::rank>& _Copy_extent); - -template < - typename _Src_type, - typename OutputIterator, - typename = typename std::enable_if::is_texture&& !details::texture_traits::is_texture, void>::type -> -void copy( - const _Src_type& _Src, OutputIterator _Dst); - -template < - typename _Src_type, - typename OutputIterator, - typename = typename std::enable_if::is_texture&& !details::texture_traits::is_texture, void>::type -> -void copy ( - const _Src_type& _Src, - const index<_Src_type::rank>& _Src_offset, - const extent<_Src_type::rank>& _Copy_extent, OutputIterator _Dst); - -template < - typename _Src_type, - typename _Dst_type, - typename = typename std::enable_if::is_texture&& details::texture_traits<_Dst_type>::is_texture, void>::type -> -void copy ( - const _Src_type& _Src, _Dst_type& _Dst); - -template < - typename _Src_type, - typename _Dst_type, - typename = typename std::enable_if::is_texture&& details::texture_traits<_Dst_type>::is_texture, - void>::type -> -void copy ( - const _Src_type& _Src, - const index<_Src_type::rank>& _Src_offset, _Dst_type& _Dst, - const index<_Dst_type::rank>& _Dst_offset, - const extent<_Src_type::rank>& _Copy_extent); -``` - -### Parameters - -*_Copy_extent*
-The extent of the texture section to be copied. - -*_Dst*
-The object to copy to. - -*_Dst_byte_size*
-The number of bytes in the destination. - -*_Dst_type*
-The type of the destination object. - -*_Dst_offset*
-The offset into the destination at which to begin copying. - -*InputIterator*
-The type of the input iterator. - -*OutputIterator*
-The type of the output iterator. - -*_Src*
-To object to copy. - -*_Src_byte_size*
-The number of bytes in the source. - -*_Src_type*
-The type of the source object. - -*_Src_offset*
-The offset into the source from which to begin copying. - -*first*
-A beginning iterator into the source container. - -*last*
-An ending iterator into the source container. - -## copy_async Function (Concurrency::graphics Namespace) - -Asynchronously copies a source texture into a destination buffer, or copies a source buffer into a destination buffer, and then returns a [completion_future](completion-future-class.md) object that can be waited on. Data can't be copied when code is running on an accelerator. The general form of this function is `copy(src, dest)`. - -```cpp -template< - typename _Src_type, - typename = typename std::enable_if::is_texture, void>::type -> -concurrency::completion_future copy_async( - const _Src_type& _Src, - _Out_ void* _Dst, - unsigned int _Dst_byte_size); - -template< - typename _Src_type, - typename = typename std::enable_if::is_texture, void>::type -> -concurrency::completion_future copy_async( - const _Src_type& _Src, - const index<_Src_type::rank>& _Src_offset, - const extent<_Src_type::rank>& _Copy_extent, - _Out_ void* _Dst, - unsigned int _Dst_byte_size); - -template < - typename _Dst_type, - typename = typename std::enable_if::is_texture, void>::type -> -concurrency::completion_future copy_async( - const void* _Src, - unsigned int _Src_byte_size, _Dst_type& _Dst); - -template < - typename _Dst_type, - typename = typename std::enable_if::is_texture, void>::type -> -concurrency::completion_future copy_async( - const void* _Src, - unsigned int _Src_byte_size, _Dst_type& _Dst, - const index<_Dst_type::rank>& _Dst_offset, - const extent<_Dst_type::rank>& _Copy_extent); - -template < - typename InputIterator, - typename _Dst_type, - typename = typename std::enable_if::is_texture, void>::type -> -concurrency::completion_future copy_async(InputIterator first, InputIterator last, _Dst_type& _Dst); - -template < - typename InputIterator, - typename _Dst_type, - typename = typename std::enable_if::is_texture, void>::type -> -concurrency::completion_future copy_async(InputIterator first, InputIterator last, _Dst_type& _Dst, - const index<_Dst_type::rank>& _Dst_offset, - const extent<_Dst_type::rank>& _Copy_extent); - -template < - typename _Src_type, - typename OutputIterator, - typename = typename std::enable_if::is_texture&& !details::texture_traits::is_texture, void>::type -> -concurrency::completion_future copy_async(_Src_type& _Src, OutputIterator _Dst); - -template < - typename _Src_type, - typename OutputIterator, - typename = typename std::enable_if::is_texture&& !details::texture_traits::is_texture, void>::type -> -concurrency::completion_future copy_async(_Src_type& _Src, - const index<_Src_type::rank>& _Src_offset, - const extent<_Src_type::rank>& _Copy_extent, - OutputIterator _Dst); - -template < - typename _Src_type, - typename _Dst_type, - typename = typename std::enable_if::is_texture&& details::texture_traits<_Dst_type>::is_texture, void>::type -> -concurrency::completion_future copy_async(_Src_type& _Src, _Dst_type& _Dst); - -template < - typename _Src_type, - typename _Dst_type, - typename = typename std::enable_if::is_texture&& details::texture_traits<_Dst_type>::is_texture, void>::type -> -concurrency::completion_future copy_async(_Src_type& _Src, - const index<_Src_type::rank>& _Src_offset, _Dst_type &_Dst, - const index<_Dst_type::rank>& _Dst_offset, - const extent<_Src_type::rank>& _Copy_extent); -``` - -### Parameters - -*_Copy_extent*
-The extent of the texture section to be copied. - -*_Dst*
-The object to copy to. - -*_Dst_byte_size*
-The number of bytes in the destination. - -*_Dst_type*
-The type of the destination object. - -*_Dst_offset*
-The offset into the destination at which to begin copying. - -*InputIterator*
-The type of the input iterator. - -*OutputIterator*
-The type of the output iterator. - -*_Src*
-To object to copy. - -*_Src_byte_size*
-The number of bytes in the source. - -*_Src_type*
-The type of the source object. - -*_Src_offset*
-The offset into the source from which to begin copying. - -*first*
-A beginning iterator into the source container. - -*last*
-An ending iterator into the source container. - -## Requirements - -**Header:** amp_graphics.h - -**Namespace:** Concurrency::graphics - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/concurrency-graphics-namespace.md b/docs/parallel/amp/reference/concurrency-graphics-namespace.md deleted file mode 100644 index cf1517f385d..00000000000 --- a/docs/parallel/amp/reference/concurrency-graphics-namespace.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -description: "Learn more about: Concurrency::graphics Namespace" -title: "Concurrency::graphics Namespace" -ms.date: "11/04/2016" -f1_keywords: ["AMP_GRAPHICS/Concurrency"] -ms.assetid: 4529d3b1-d7da-4ffb-82bf-080915e0f23e ---- -# Concurrency::graphics Namespace - -The graphics namespace provides types and functions that are designed for graphics programming. - -## Syntax - -```cpp -namespace graphics; -``` - -## Members - -### Namespaces - -|Name|Description| -|----------|-----------------| -|[Concurrency::graphics::direct3d Namespace](concurrency-graphics-direct3d-namespace.md)|Provides functions for Direct3D interop.| - -### Typedefs - -|Name|Description| -|----------|-----------------| -|`uint`|The element type for [uint_2 Class](uint-2-class.md), [uint_3 Class](uint-3-class.md), and [uint_4 Class](uint-4-class.md). Defined as `typedef unsigned int uint;`.| - -### Enumerations - -|Name|Description| -|----------|-----------------| -|[address_mode Enumeration](concurrency-graphics-namespace-enums.md#address_mode).|Specifies address modes supported for texture sampling.| -|[filter_mode Enumeration](concurrency-graphics-namespace-enums.md#filter_mode)|Specifies filter modes supported for texture sampling.| - -### Classes - -|Name|Description| -|----------|-----------------| -|[texture Class](texture-class.md)|A texture is a data aggregate on an accelerator_view in the extent domain. It is a collection of variables, one for each element in an extent domain. Each variable holds a value corresponding to C++ primitive type (unsigned int, int, float, double), or scalar type norm, or unorm (defined in concurrency::graphics), or eligible short vector types defined in concurrency::graphics.| -|[writeonly_texture_view Class](writeonly-texture-view-class.md)|A writeonly_texture_view provides writeonly access to a texture.| -|[double_2 Class](double-2-class.md)|Represents a short vector of 2 **`double`** values.| -|[double_3 Class](double-3-class.md)|Represents a short vector of 3 **`double`** values.| -|[double_4 Class](double-4-class.md)|Represents a short vector of 4 **`double`** values.| -|[float_2 Class](float-2-class.md)|Represents a short vector of 2 **`float`** values.| -|[float_3 Class](float-3-class.md)|Represents a short vector of 3 **`float`** values.| -|[float_4 Class](float-4-class.md)|Represents a short vector of 4 **`float`** values.| -|[int_2 Class](int-2-class.md)|Represents a short vector of 2 **`int`** values.| -|[int_3 Class](int-3-class.md)|Represents a short vector of 3 **`int`** values.| -|[int_4 Class](int-4-class.md)|Represents a short vector of 4 **`int`** values.| -|[norm_2 Class](norm-2-class.md)|Represents a short vector of 2 `norm` values.| -|[norm_3 Class](norm-3-class.md)|Represents a short vector of 3 `norm` values.| -|[norm_4 Class](norm-4-class.md)|Represents a short vector of 4 `norm` values.| -|[uint_2 Class](uint-2-class.md)|Represents a short vector of 2 `uint` values.| -|[uint_3 Class](uint-3-class.md)|Represents a short vector of 3 `uint` values.| -|[uint_4 Class](uint-4-class.md)|Represents a short vector of 4 `uint` values.| -|[unorm_2 Class](unorm-2-class.md)|Represents a short vector of 2 `unorm` values.| -|[unorm_3 Class](unorm-3-class.md)|Represents a short vector of 3 `unorm` values.| -|[unorm_4 Class](unorm-4-class.md)|Represents a short vector of 4 `unorm` values.| -|[sampler Class](sampler-class.md)|Represents the sampler configuration used for texture sampling.| -|[short_vector Structure](short-vector-structure.md)|Provides a basic implementation of a short vector of values.| -|[short_vector_traits Structure](short-vector-traits-structure.md)|Provides for retrieval of the length and type of a short vector.| -|[texture_view Class](texture-view-class.md)|Provides read access and write access to a texture.| - -### Functions - -|Name|Description| -|----------|-----------------| -|[copy](concurrency-graphics-namespace-functions.md#copy)|Overloaded. Copies the contents of the source texture into the destination host buffer.| -|[copy_async](concurrency-graphics-namespace-functions.md#copy_async)|Overloaded. Asynchronously copies the contents of the source texture into the destination host buffer.| - -## Requirements - -**Header:** amp_graphics.h - -**Namespace:** Concurrency - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/concurrency-namespace-constants-amp.md b/docs/parallel/amp/reference/concurrency-namespace-constants-amp.md deleted file mode 100644 index a03bea4d1af..00000000000 --- a/docs/parallel/amp/reference/concurrency-namespace-constants-amp.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Concurrency namespace constants (AMP)" -description: "Learn more about: Concurrency namespace constants (AMP)" -ms.date: 11/04/2016 -f1_keywords: ["amp/Concurrency::HLSL_MAX_NUM_BUFFERS", "amp/Concurrency::MODULENAME_MAX_LENGTH"] ---- -# Concurrency namespace constants (AMP) - -The following constants are defined in the `Concurrency` namespace (AMP): - -## `HLSL_MAX_NUM_BUFFERS` Constant - -The maximum number of buffers allowed by DirectX. - -```cpp -static const UINT HLSL_MAX_NUM_BUFFERS = 64 + 128; -``` - -## `MODULENAME_MAX_LENGTH` constant - -Stores the maximum length of the module name. This value must be the same at compile time and runtime. - -```cpp -static const UINT MODULENAME_MAX_LENGTH = 1024; -``` - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/concurrency-namespace-cpp-amp.md b/docs/parallel/amp/reference/concurrency-namespace-cpp-amp.md deleted file mode 100644 index df6d09b52f2..00000000000 --- a/docs/parallel/amp/reference/concurrency-namespace-cpp-amp.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -description: "Learn more about: Concurrency Namespace (C++ AMP)" -title: "Concurrency Namespace (C++ AMP)" -ms.date: "11/04/2016" -f1_keywords: ["AMP/Concurrency"] -helpviewer_keywords: ["Concurrency namespace"] -ms.assetid: b5aab265-3bac-42c5-8ead-f92ce05ef267 ---- -# Concurrency Namespace (C++ AMP) - -Provides classes and functions that accelerate the execution of C++ code on data-parallel hardware. For more information, see [C++ AMP Overview](../cpp-amp-overview.md) - -## Syntax - -```cpp -namespace Concurrency; -``` - -## Members - -### Namespaces - -|Name|Description| -|----------|-----------------| -|[Concurrency::direct3d Namespace](concurrency-direct3d-namespace.md)|Provides functions that support D3D interoperability. Enables seamless use of D3D resources for compute in AMP code and the use of resources created in AMP in D3D code, without creating redundant intermediate copies. You can use C++ AMP to incrementally accelerate the compute-intensive sections of your DirectX applications and use the D3D API on data produced from AMP computations.| -|[Concurrency::fast_math Namespace](concurrency-fast-math-namespace.md)|Functions in the `fast_math` namespace are not C99-conformant. Only single-precision versions of each function are provided. These functions use the DirectX intrinsic functions, which are faster than the corresponding functions in the `precise_math` namespace and do not require extended double-precision support on the accelerator, but they are less accurate. There are two versions of each function for source-level compatibility with C99 code; both versions take and return single-precision values.| -|[Concurrency::graphics Namespace](concurrency-graphics-namespace.md)|Provides types and functions that are designed for graphics programming.| -|[Concurrency::precise_math Namespace](concurrency-precise-math-namespace.md)|Functions in the `precise_math` namespace are C99 conformant. Both single-precision and double-precision versions of each function are included. These functions—this includes the single-precision functions—require extended double-precision support on the accelerator.| - -### Classes - -|Name|Description| -|----------|-----------------| -|[accelerator Class](accelerator-class.md)|Represents an abstraction of a physical DP-optimized compute node.| -|[accelerator_view Class](accelerator-view-class.md)|Represents a virtual device abstraction on a C++ AMP data-parallel accelerator.| -|[accelerator_view_removed Class](accelerator-view-removed-class.md)|The exception that is thrown when an underlying DirectX call fails due to the Windows timeout-detection-and-recovery mechanism.| -|[array Class](array-class.md)|A data aggregate on an `accelerator_view` in the grid domain. It is a collection of variables, one for each element in a grid domain. Each variable holds a value that corresponds to some C++ type.| -|[array_view Class](array-view-class.md)|Represents a view into the data in an array\.| -|[completion_future Class](completion-future-class.md)|Represents a future that corresponds to a C++ AMP asynchronous operation.| -|[extent Class](extent-class.md)|Represents a vector of N integer values that specify the bounds of an N-dimensional space that has an origin of 0. The values in the coordinate vector are ordered from most significant to least significant. For example, in Cartesian 3-dimensional space, the extent vector (7,5,3) represents a space in which the z coordinate ranges from 0 to 7, the y coordinate ranges from 0 to 5, and the x coordinate ranges from 0 to 3.| -|[index Class](index-class.md)|Defines an N-dimensional index point.| -|[invalid_compute_domain Class](invalid-compute-domain-class.md)|The exception that's thrown when the runtime can't start a kernel by using the compute domain specified at the `parallel_for_each` call site.| -|[out_of_memory Class](out-of-memory-class.md)|The exception that is thrown when a method fails because of a lack of system or device memory.| -|[runtime_exception Class](runtime-exception-class.md)|The base type for exceptions in the C++ AMP library.| -|[tile_barrier Class](tile-barrier-class.md)|A capability class that is only creatable by the system and is passed to a tiled `parallel_for_each` lambda as part of the `tiled_index` parameter. It provides one method, `wait()`, whose purpose is to synchronize execution of threads that are running in the thread group (tile).| -|[tiled_extent Class](tiled-extent-class.md)|A `tiled_extent` object is an `extent` object of one to three dimensions that subdivides the extent space into one-dimensional, two-dimensional, or three-dimensional tiles.| -|[tiled_index Class](tiled-index-class.md)|Provides an index into a `tiled_grid` object. This class has properties to access element relative to the local tile origin and relative to the global origin.| -|[uninitialized_object Class](uninitialized-object-class.md)|The exception that is thrown when an uninitialized object is used.| -|[unsupported_feature Class](unsupported-feature-class.md)|The exception that is thrown when an unsupported feature is used.| - -### Enumerations - -|Name|Description| -|----------|-----------------| -|[access_type Enumeration](concurrency-namespace-enums-amp.md#access_type)|Specifies the data access type.| -|[queuing_mode Enumeration](concurrency-namespace-enums-amp.md#queuing_mode)|Specifies the queuing modes that are supported on the accelerator.| - -### Operators - -|Operator|Description| -|--------------|-----------------| -|[operator== Operator (C++ AMP)](concurrency-namespace-operators-amp.md#operator_eq_eq)|Determines whether the specified data structures are equal.| -|[operator!= Operator (C++ AMP)](concurrency-namespace-operators-amp.md#operator_neq)|Determines whether the specified data structures are unequal.| -|[operator+ Operator (C++ AMP)](concurrency-namespace-operators-amp.md#operator_add)|Computes the component-wise sum of the specified arguments.| -|[operator- Operator (C++ AMP)](concurrency-namespace-operators-amp.md#operator-)|Computes the component-wise difference between the specified arguments.| -|[operator* Operator (C++ AMP)](concurrency-namespace-operators-amp.md#operator_star)|Computes the component-wise product of the specified arguments.| -|[operator/ Operator (C++ AMP)](concurrency-namespace-operators-amp.md#operator_div)|Computes the component-wise quotient of the specified arguments.| -|[operator% Operator (C++ AMP)](concurrency-namespace-operators-amp.md#operator_mod)|Computes the modulus of the first specified argument by the second specified argument.| - -### Functions - -|Name|Description| -|----------|-----------------| -|[all_memory_fence](concurrency-namespace-functions-amp.md#all_memory_fence)|Blocks execution of all threads in a tile until all memory accesses have been completed.| -|[amp_uninitialize](concurrency-namespace-functions-amp.md#amp_uninitialize)|Uninitializes the C++ AMP runtime.| -|[atomic_compare_exchange](concurrency-namespace-functions-amp.md#atomic_compare_exchange)|Overloaded. If the value stored at the specified location compares equal to the first specified value, then the second specified value is stored in the same location as an atomic operation.| -|[atomic_exchange](concurrency-namespace-functions-amp.md#atomic_exchange)|Overloaded. Sets the value stored at the specified location to the specified value as an atomic operation.| -|[atomic_fetch_add](concurrency-namespace-functions-amp.md#atomic_fetch_add)|Overloaded. Sets the value stored at the specified location to the sum of that value and a specified value as an atomic operation.| -|[atomic_fetch_and](concurrency-namespace-functions-amp.md#atomic_fetch_and)|Overloaded. Sets the value stored at the specified location to the bitwise `and` of that value and a specified value as an atomic operation.| -|[atomic_fetch_dec](concurrency-namespace-functions-amp.md#atomic_fetch_dec)|Overloaded. Decrements the value stored at the specified location and stores the result in the same location as an atomic operation.| -|[atomic_fetch_inc](concurrency-namespace-functions-amp.md#atomic_fetch_inc)|Overloaded. Increments the value stored at the specified location and stores the result in the same location as an atomic operation.| -|[atomic_fetch_max](concurrency-namespace-functions-amp.md#atomic_fetch_max)|Overloaded. Sets the value stored at the specified location to the larger of that value and a specified value as an atomic operation.| -|[atomic_fetch_min](concurrency-namespace-functions-amp.md#atomic_fetch_min)|Overloaded. Sets the value stored at the specified location to the smaller of that value and a specified value as an atomic operation.| -|[atomic_fetch_or](concurrency-namespace-functions-amp.md#atomic_fetch_or)|Overloaded. Sets the value stored at the specified location to the bitwise `or` of that value and a specified value as an atomic operation.| -|[atomic_fetch_sub](concurrency-namespace-functions-amp.md#atomic_fetch_sub)|Overloaded. Sets the value stored at the specified location to the difference of that value and a specified value as an atomic operation.| -|[atomic_fetch_xor](concurrency-namespace-functions-amp.md#atomic_fetch_xor)|Overloaded. Sets the value stored at the specified location to the bitwise `xor` of that value and a specified value as an atomic operation.| -|[copy](concurrency-namespace-functions-amp.md#copy)|Copies a C++ AMP object. All synchronous data transfer requirements are met. Data can't be copied when code is running code on an accelerator. The general form of this function is `copy(src, dest)`.| -|[copy_async](concurrency-namespace-functions-amp.md#copy_async)|Copies a C++ AMP object and returns [completion_future](completion-future-class.md) that can be waited on. Data can't be copied when code is running on an accelerator. The general form of this function is `copy(src, dest)`.| -|[direct3d_abort](concurrency-namespace-functions-amp.md#direct3d_abort)|Aborts the execution of a function that has the `restrict(amp)` restriction clause.| -|[direct3d_errorf](concurrency-namespace-functions-amp.md#direct3d_errorf)|Prints a formatted string to the Visual Studio **Output** window and raises a [runtime_exception](runtime-exception-class.md) exception that has the same formatting string.| -|[direct3d_printf](concurrency-namespace-functions-amp.md#direct3d_printf)|Prints a formatted string to the Visual Studio **Output** window. It is called from a function that has the `restrict(amp)` restriction clause.| -|[global_memory_fence](concurrency-namespace-functions-amp.md#global_memory_fence)|Blocks execution of all threads in a tile until all global memory accesses have been completed.| -|[parallel_for_each Function (C++ AMP)](concurrency-namespace-functions-amp.md#parallel_for_each)|Runs a function across the compute domain.| -|[tile_static_memory_fence](concurrency-namespace-functions-amp.md#tile_static_memory_fence)|Blocks execution of all threads in a tile until `tile_static` memory accesses have been completed.| - -## Constants - -|Name|Description| -|----------|-----------------| -|[HLSL_MAX_NUM_BUFFERS Constant](concurrency-namespace-constants-amp.md#hlsl_max_num_buffers)|The maximum number of buffers allowed by DirectX.| -|[MODULENAME_MAX_LENGTH Constant](concurrency-namespace-constants-amp.md#modulename_max_length)|Stores the maximum length of the module name. This value must be the same on the compiler and the runtime.| - -## Requirements - -**Header:** amp.h - -## See also - -[Reference (C++ AMP)](reference-cpp-amp.md) diff --git a/docs/parallel/amp/reference/concurrency-namespace-enums-amp.md b/docs/parallel/amp/reference/concurrency-namespace-enums-amp.md deleted file mode 100644 index feef3abec33..00000000000 --- a/docs/parallel/amp/reference/concurrency-namespace-enums-amp.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Concurrency namespace enums (AMP)" -description: "Learn more about: Concurrency namespace enums (AMP)" -ms.date: 11/04/2016 -f1_keywords: ["amp/Concurrency::access_type", "amp/Concurrency::queuing_mode"] ---- -# `Concurrency` namespace enums (AMP) - -The following enumerations are available in the `Concurrency` namespace: - -## `access_type` enumeration - -```cpp -enum access_type; -``` - -### Values - -|Name|Description| -|----------|-----------------| -|`access_type_auto`|Automatically choose the best `access_type` for the accelerator.| -|`access_type_none`|Dedicated. The allocation is only accessible on the accelerator and not on the CPU.| -|`access_type_read`|Shared. The allocation is accessible on the accelerator and is readable on the CPU.| -|`access_type_read_write`|Shared. The allocation is accessible on the accelerator and is writable on the CPU.| -|`access_type_write`|Shared. The allocation is accessible on the accelerator and is both readable and writable on the CPU.| - -## `queuing_mode` enumeration - -Specifies the queuing modes that are supported on the accelerator. - -```cpp -enum queuing_mode; -``` - -### Values - -|Name|Description| -|----------|-----------------| -|`queuing_mode_immediate`|A queuing mode that specifies that any commands, for example, [parallel_for_each Function (C++ AMP)](concurrency-namespace-functions-amp.md#parallel_for_each), are sent to the corresponding accelerator device as soon as they return to the caller.| -|`queuing_mode_automatic`|A queuing mode that specifies that commands be queued up on a command queue that corresponds to the [accelerator_view](accelerator-view-class.md) object. Commands are sent to the device when [accelerator_view::flush](accelerator-view-class.md#flush) is called.| - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/concurrency-namespace-functions-amp.md b/docs/parallel/amp/reference/concurrency-namespace-functions-amp.md deleted file mode 100644 index 5020d2c580b..00000000000 --- a/docs/parallel/amp/reference/concurrency-namespace-functions-amp.md +++ /dev/null @@ -1,686 +0,0 @@ ---- -description: "Learn more about: Concurrency namespace functions (AMP)" -title: "Concurrency namespace functions (AMP)" -ms.date: "11/04/2016" -f1_keywords: ["amp/Concurrency::all_memory_fence", "amp/Concurrency::atomic_compare_exchange", "amp/Concurrency::atomic_fetch_dec", "amp/Concurrency::atomic_fetch_max", "amp/Concurrency::atomic_fetch_min", "amp/Concurrency::copy", "amp/Concurrency::direct3d_abort", "amp/Concurrency::direct3d_printf", "amp/Concurrency::global_memory_fence", "amp/Concurrency::tile_static_memory_fence"] -ms.assetid: 2bef0985-cb90-4ece-90b9-66529aec73c9 ---- -# Concurrency namespace functions (AMP) - -:::row::: - :::column span=""::: - [`all_memory_fence`](#all_memory_fence)\ - [`amp_uninitialize`](#amp_uninitialize)\ - [`atomic_compare_exchange`](#atomic_compare_exchange)\ - [`atomic_exchange`](#atomic_exchange)\ - [`atomic_fetch_add`](#atomic_fetch_add)\ - [`atomic_fetch_and`](#atomic_fetch_and) - :::column-end::: - :::column span=""::: - [`atomic_fetch_dec`](#atomic_fetch_dec)\ - [`atomic_fetch_inc`](#atomic_fetch_inc)\ - [`atomic_fetch_max`](#atomic_fetch_max)\ - [`atomic_fetch_min`](#atomic_fetch_min)\ - [`atomic_fetch_or`](#atomic_fetch_or) - :::column-end::: - :::column span=""::: - [`atomic_fetch_sub`](#atomic_fetch_sub)\ - [`atomic_fetch_xor`](#atomic_fetch_xor)\ - [`copy`](#copy)\ - [`copy_async`](#copy_async)\ - [`direct3d_abort`](#direct3d_abort) - :::column-end::: - :::column span=""::: - [`direct3d_errorf`](#direct3d_errorf)\ - [`direct3d_printf`](#direct3d_printf)\ - [`global_memory_fence`](#global_memory_fence)\ - [`parallel_for_each`](#parallel_for_each)\ - [`tile_static_memory_fence`](#tile_static_memory_fence) - :::column-end::: -:::row-end::: - -## all_memory_fence - -Blocks execution of all threads in a tile until all memory accesses have been completed. This ensures that all memory accesses are visible to other threads in the thread tile, and are executed in program order. - -```cpp -inline void all_memory_fence(const tile_barrier& _Barrier) restrict(amp); -``` - -### Parameters - -*_Barrier*
-A `tile_barrier` object. - -## amp_uninitialize - -Uninitializes the C++ AMP runtime. It is legal to call this function multiple times during an applications lifetime. Calling any C++ AMP API after calling this function will reinitialize the C++ AMP runtime. Note that it is illegal to use C++ AMP objects across calls to this function and doing so will result in undefined behavior. Also, concurrently calling this function and any other AMP APIs is illegal and would result in undefined behavior. - -```cpp -void __cdecl amp_uninitialize(); -``` - -## atomic_compare_exchange - -Atomically compares the value stored at a memory location specified in the first argument for equality with the value of the second specified argument, and if the values are the same, the value at the memory location is changed to that of the third specified argument. - -```cpp -inline bool atomic_compare_exchange( - _Inout_ int* _Dest, - _Inout_ int* _Expected_value, - int value - ) restrict(amp) - -inline bool atomic_compare_exchange( - _Inout_ unsigned int* _Dest, - _Inout_ unsigned int* _Expected_value, - unsigned int value - ) restrict(amp) -``` - -### Parameters - -*_Dest*
-The location from which one of the values to be compared is read, and to which the new value, if any, is to be stored. - -*_Expected_value*
-The location from which the second value to be compared is read. - -*value*
-The value to be stored to the memory location specified in by `_Dest` if `_Dest` is equal to `_Expected_value`. - -### Return Value - -**`true`** if the operation is successful; otherwise, **`false`**. - -## atomic_exchange Function (C++ AMP) - -Sets the value of destination location as an atomic operation. - -```cpp -inline int atomic_exchange( - _Inout_ int* _Dest, - int value - ) restrict(amp) - -inline unsigned int atomic_exchange( - _Inout_ unsigned int* _Dest, - unsigned int value - ) restrict(amp) - -inline float atomic_exchange( - _Inout_ float* _Dest, - float value - ) restrict(amp) -``` - -### Parameters - -*_Dest*
-Pointer to the destination location. - -*value*
-The new value. - -### Return Value - -The original value of the destination location. - -## atomic_fetch_add Function (C++ AMP) - -Atomically add a value to the value of a memory location. - -```cpp -inline int atomic_fetch_add( - _Inout_ int* _Dest, - int value - ) restrict(amp) - -inline unsigned int atomic_fetch_add( - _Inout_ unsigned int* _Dest, - unsigned int value - ) restrict(amp) -``` - -### Parameters - -*_Dest*
-Pointer to the memory location. - -*value*
-The value to be added. - -### Return Value - -The original value of the memory location. - -## atomic_fetch_and Function (C++ AMP) - -Atomically performs a bitwise AND operation of a value and the value of a memory location. - -```cpp -inline int atomic_fetch_and( - _Inout_ int* _Dest, - int value - ) restrict(amp) - -inline unsigned int atomic_fetch_and( - _Inout_ unsigned int* _Dest, - unsigned int value - ) restrict(amp) -``` - -### Parameters - -*_Dest*
-Pointer to the memory location. - -*value*
-The value to use in the bitwise AND calculation. - -### Return Value - -The original value of the memory location. - -## atomic_fetch_dec - -Atomically decrements the value stored at the specified memory location. - -```cpp -inline int atomic_fetch_dec(_Inout_ int* _Dest - ) restrict(amp) - -inline unsigned int atomic_fetch_dec(_Inout_ unsigned int* _Dest) restrict(amp); -``` - -### Parameters - -*_Dest*
-The location in memory of the value to be decremented. - -### Return Value - -The original value stored at the memory location. - -## atomic_fetch_inc - -Atomically increments the value stored at the specified memory location. - -```cpp -inline int atomic_fetch_inc(_Inout_ int* _Dest) restrict(amp); - -inline unsigned int atomic_fetch_inc(_Inout_ unsigned int* _Dest) restrict(amp); -``` - -### Parameters - -*_Dest*
-The location in memory of the value to be incremented. - -### Return Value - -The original value stored at the memory location. - -## atomic_fetch_max - -Atomically computes the maximum value between the value stored at the memory location specified in the first argument and the value specified in the second argument, and stores it at the same memory location. - -```cpp -inline int atomic_fetch_max( - _Inout_ int* _Dest, - int value - ) restrict(amp) - -inline unsigned int atomic_fetch_max( - _Inout_ unsigned int* _Dest, - unsigned int value - ) restrict(amp) -``` - -### Parameters - -*_Dest*
-The location from which one of the values to be compared is read, and to which the maximum of the two values is to be stored. - -*value*
-The value to be compared to the value at the specified location. - -### Return Value - -The original value stored at the specified location location. - -## atomic_fetch_min - -Atomically computes the minimum value between the value stored at the memory location specified in the first argument and the value specified in the second argument, and stores it at the same memory location. - -```cpp -inline int atomic_fetch_min( - _Inout_ int* _Dest, - int value - ) restrict(amp) - -inline unsigned int atomic_fetch_min( - _Inout_ unsigned int* _Dest, - unsigned int value - ) restrict(amp) -``` - -### Parameters - -*_Dest*
-The location from which one of the values to be compared is read, and to which the minimum of the two values is to be stored. - -*value*
-The value to be compared to the value at the specified location. - -### Return Value - -The original value stored at the specified location location. - -## atomic_fetch_or Function (C++ AMP) - -Atomically performs a bitwise OR operation with a value and the value of a memory location. - -```cpp -inline int atomic_fetch_or( - _Inout_ int* _Dest, - int value - ) restrict(amp) - -inline unsigned int atomic_fetch_or( - _Inout_ unsigned int* _Dest, - unsigned int value - ) restrict(amp) -``` - -### Parameters - -*_Dest*
-Pointer to the memory location. - -*value*
-The value to use in the bitwise OR calculation. - -### Return Value - -The original value of the memory location. - -## atomic_fetch_sub Function (C++ AMP) - -Atomically subtracts a value from a memory location. - -```cpp -inline int atomic_fetch_sub( - _Inout_ int* _Dest, - int value - ) restrict(amp) - -inline unsigned int atomic_fetch_sub( - _Inout_ unsigned int* _Dest, - unsigned int value - ) restrict(amp) -``` - -### Parameters - -*_Dest*
-Pointer to the destination location. - -*value*
-The value to be subtracted. - -### Return Value - -The original value of the memory location. - -## atomic_fetch_xor Function (C++ AMP) - -Atomically performs an bitwise XOR operation of a value and a memory location. - -```cpp -inline int atomic_fetch_xor( - _Inout_ int* _Dest, - int value - ) restrict(amp) - -inline unsigned int atomic_fetch_xor( - _Inout_ unsigned int* _Dest, - unsigned int value - ) restrict(amp) -``` - -### Parameters - -*_Dest*
-Pointer to the memory location. - -*value*
-The value to use in the XOR calculation. - -### Return Value - -The original value of the memory location. - -## copy - -Copies a C++ AMP object. All synchronous data transfer requirements are met. You can't copy data when running code on an accelerator. The general form of this function is `copy(src, dest)`. - -```cpp -template -void copy( - const array& _Src, - array& _Dest); - -template -void copy( - InputIterator _SrcFirst, - InputIterator _SrcLast, - array& _Dest); - -template -void copy( - InputIterator _SrcFirst, - array& _Dest); - -template -void copy( - const array& _Src, - OutputIterator _DestIter); - -template -void copy( - const array& _Src, - array_view& _Dest); - -template -void copy( - const array_view& _Src, - array& _Dest); - -template -void copy( - const array_view& _Src, - array& _Dest); - -template -void copy( - const array_view& _Src, - array_view& _Dest); - -template -void copy( - const array_view& _Src, - array_view& _Dest); - -template -void copy( - InputIterator _SrcFirst, - InputIterator _SrcLast, - array_view& _Dest); - -template -void copy( - InputIterator _SrcFirst, - array_view& _Dest); - -template -void copy( - const array_view& _Src, - OutputIterator _DestIter); -``` - -### Parameters - -*_Dest*
-The object to copy to. - -*_DestIter*
-An output iterator to the beginning position at destination. - -*InputIterator*
-The type of the input iterator. - -*OutputIterator*
-The type of the output iterator. - -*_Rank*
-The rank of the object to copy from or the object to copy to. - -*_Src*
-To object to copy. - -*_SrcFirst*
-A beginning iterator into the source container. - -*_SrcLast*
-An ending iterator into the source container. - -*value_type*
-The data type of the elements that are copied. - -## copy_async - -Copies a C++ AMP object and returns a [completion_future](completion-future-class.md) object that can be waited on. You can't copy data when running code on an accelerator. The general form of this function is `copy(src, dest)`. - -```cpp -template -concurrency::completion_future copy_async( - const array& _Src, - array& _Dest); - -template -concurrency::completion_future copy_async(InputIterator _SrcFirst, InputIterator _SrcLast, - array& _Dest); - -template -concurrency::completion_future copy_async(InputIterator _SrcFirst, - array& _Dest); - -template -concurrency::completion_future copy_async( - const array& _Src, OutputIterator _DestIter); - -template -concurrency::completion_future copy_async( - const array& _Src, - array_view& _Dest); - -template -concurrency::completion_future copy_async( - const array_view& _Src, - array& _Dest); - -template -concurrency::completion_future copy_async( - const array_view& _Src, - array& _Dest); - -template -concurrency::completion_future copy_async( - const array_view& _Src, - array_view& _Dest); - -template -concurrency::completion_future copy_async( - const array_view& _Src, - array_view& _Dest); - -template -concurrency::completion_future copy_async(InputIterator _SrcFirst, InputIterator _SrcLast, - array_view& _Dest); - -template -concurrency::completion_future copy_async(InputIterator _SrcFirst, - array_view& _Dest); - -template -concurrency::completion_future copy_async( - const array_view& _Src, OutputIterator _DestIter); -``` - -### Parameters - -*_Dest*
-The object to copy to. - -*_DestIter*
-An output iterator to the beginning position at destination. - -*InputIterator*
-The type of the input iterator. - -*OutputIterator*
-The type of the output iterator. - -*_Rank*
-The rank of the object to copy from or the object to copy to. - -*_Src*
-To object to copy. - -*_SrcFirst*
-A beginning iterator into the source container. - -*_SrcLast*
-An ending iterator into the source container. - -*value_type*
-The data type of the elements that are copied. - -### Return Value - -A `future` that can be waited on. - -## direct3d_abort - -Aborts the execution of a function with the `restrict(amp)` restriction clause. When the AMP runtime detects the call, it raises a [runtime_exception](runtime-exception-class.md) exception with the error message "Reference Rasterizer: Shader abort instruction hit". - -```cpp -void direct3d_abort() restrict(amp); -``` - -## direct3d_errorf - -Prints a formatted string to the Visual Studio output window. It is called from a function with the `restrict(amp)` restriction clause. When the AMP runtime detects the call, it raises a [runtime_exception](runtime-exception-class.md) exception with the same formatting string. - -```cpp -void direct3d_errorf( - const char *, -...) restrict(amp); -``` - -## direct3d_printf - -Prints a formatted string to the Visual Studio output window. It is called from a function with the `restrict(amp)` restriction clause. - -```cpp -void direct3d_printf( - const char *, -...) restrict(amp); -``` - -## global_memory_fence - -Blocks execution of all threads in a tile until all global memory accesses have been completed. This ensures that global memory accesses are visible to other threads in the thread tile, and are executed in program order. - -```cpp -inline void global_memory_fence(const tile_barrier& _Barrier) restrict(amp); -``` - -### Parameters - -*_Barrier*
-A tile_barrier object - -## parallel_for_each Function (C++ AMP) - -Runs a function across the compute domain. For more information, see [C++ AMP Overview](../../../parallel/amp/cpp-amp-overview.md). - -```cpp -template -void parallel_for_each( - const extent<_Rank>& _Compute_domain, - const _Kernel_type& _Kernel); - -template -void parallel_for_each( - const tiled_extent<_Dim0, _Dim1, _Dim2>& _Compute_domain, - const _Kernel_type& _Kernel); - -template -void parallel_for_each( - const tiled_extent<_Dim0, _Dim1>& _Compute_domain, - const _Kernel_type& _Kernel); - -template -void parallel_for_each( - const tiled_extent<_Dim0>& _Compute_domain, - const _Kernel_type& _Kernel); - -template -void parallel_for_each( - const accelerator_view& _Accl_view, - const extent<_Rank>& _Compute_domain, - const _Kernel_type& _Kernel); - -template -void parallel_for_each( - const accelerator_view& _Accl_view, - const tiled_extent<_Dim0, _Dim1, _Dim2>& _Compute_domain, - const _Kernel_type& _Kernel); - -template -void parallel_for_each( - const accelerator_view& _Accl_view, - const tiled_extent<_Dim0, _Dim1>& _Compute_domain, - const _Kernel_type& _Kernel); - -template -void parallel_for_each( - const accelerator_view& _Accl_view, - const tiled_extent<_Dim0>& _Compute_domain, - const _Kernel_type& _Kernel); -``` - -### Parameters - -*_Accl_view*
-The `accelerator_view` object to run the parallel computation on. - -*_Compute_domain*
-An `extent` object that contains the data for the computation. - -*_Dim0*
-The dimension of the `tiled_extent` object. - -*_Dim1*
-The dimension of the `tiled_extent` object. - -*_Dim2*
-The dimension of the `tiled_extent` object. - -*_Kernel*
-A lambda or function object that takes an argument of type "index\<_Rank>" and performs the parallel computation. - -*_Kernel_type*
-A lambda or functor. - -*_Rank*
-The rank of the extent. - -## tile_static_memory_fence - -Blocks execution of all threads in a tile until all outstanding `tile_static` memory accesses have been completed. This ensures that `tile_static` memory accesses are visible to other threads in the thread tile, and that accesses are executed in program order. - -```cpp -inline void tile_static_memory_fence(const tile_barrier& _Barrier) restrict(amp); -``` - -### Parameters - -*_Barrier*
-A tile_barrier object. - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/concurrency-namespace-operators-amp.md b/docs/parallel/amp/reference/concurrency-namespace-operators-amp.md deleted file mode 100644 index 3275296c1f8..00000000000 --- a/docs/parallel/amp/reference/concurrency-namespace-operators-amp.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -description: "Learn more about: Concurrency namespace operators (AMP)" -title: "Concurrency namespace operators (AMP)" -ms.date: "11/04/2016" -ms.assetid: 77f1ae17-1eb2-480d-8fe5-66d4c24bb91e ---- -# Concurrency namespace operators (AMP) - -:::row::: - :::column span=""::: - [`operator==`](#operator_eq_eq)\ - [`operator!=`](#operator_neq) - :::column-end::: - :::column span=""::: - [`operator+`](#operator_add)\ - [`operator-`](#operator-) - :::column-end::: - :::column span=""::: - [`operator*`](#operator_star)\ - [`operator/`](#operator_div) - :::column-end::: - :::column span=""::: - [`operator%`](#operator_mod) - :::column-end::: -:::row-end::: - -## operator== - -Determines whether the specified arguments are equal. - -```cpp -template < - int _Rank, - template class _Tuple_type -> -bool operator== ( - const _Tuple_type<_Rank>& _Lhs, - const _Tuple_type<_Rank>& _Rhs) restrict(amp); -``` - -### Parameters - -*_Rank*
-The rank of the tuple arguments. - -*_Lhs*
-One of the tuples to compare. - -*_Rhs*
-One of the tuples to compare. - -### Return Value - -**`true`** if the tuples are equal; otherwise, **`false`**. - -## operator!= - -Determines whether the specified arguments are not equal. - -```cpp -template < - int _Rank, - template class _Tuple_type -> -bool operator!= ( - const _Tuple_type<_Rank>& _Lhs, - const _Tuple_type<_Rank>& _Rhs) restrict(amp); -``` - -### Parameters - -*_Rank*
-The rank of the tuple arguments. - -*_Lhs*
-One of the tuples to compare. - -*_Rhs*
-One of the tuples to compare. - -### Return Value - -**`true`** if the tuples are not equal; otherwise, **`false`**. - -## operator+ - -Computes the component-wise sum of the specified arguments. - -```cpp -template < - int _Rank, - template class _Tuple_type -> -class _Tuple_type> _Tuple_type<_Rank> operator+( - const _Tuple_type<_Rank>& _Lhs, - const _Tuple_type<_Rank>& _Rhs) restrict(amp,cpu); - -template < - int _Rank, - template class _Tuple_type -> -class _Tuple_type> _Tuple_type<_Rank> operator+( - const _Tuple_type<_Rank>& _Lhs, - typename _Tuple_type<_Rank>::value_type _Rhs) restrict(amp,cpu); - -template < - int _Rank, - template class _Tuple_type -> -class _Tuple_type> _Tuple_type<_Rank> operator+( - typename _Tuple_type<_Rank>::value_type _Lhs, - const _Tuple_type<_Rank>& _Rhs) restrict(amp,cpu); -``` - -### Parameters - -*_Rank*
-The rank of the tuple arguments. - -*_Lhs*
-One of the arguments to add. - -*_Rhs*
-One of the arguments to add. - -### Return Value - -The component-wise sum of the specified arguments. - -## operator- - -Computes the component-wise difference between the specified arguments. - -```cpp -template < - int _Rank, - template class _Tuple_type -> -_Tuple_type<_Rank> operator-( - const _Tuple_type<_Rank>& _Lhs, - const _Tuple_type<_Rank>& _Rhs) restrict(amp,cpu); - -template < - int _Rank, - template class _Tuple_type -> -_Tuple_type<_Rank> operator-( - const _Tuple_type<_Rank>& _Lhs, - typename _Tuple_type<_Rank>::value_type _Rhs) restrict(amp,cpu); - -template < - int _Rank, - template class _Tuple_type -> -_Tuple_type<_Rank> operator-( - typename _Tuple_type<_Rank>::value_type _Lhs, - const _Tuple_type<_Rank>& _Rhs) restrict(amp,cpu); -``` - -### Parameters - -*_Rank*
-The rank of the tuple arguments. - -*_Lhs*
-The argument to be subtracted from. - -*_Rhs*
-The argument to subtract. - -### Return Value - -The component-wise difference between the specified arguments. - -## operator* - -Computes the component-wise product of the specified arguments. - -```cpp -template < - int _Rank, - template class _Tuple_type -> -_Tuple_type<_Rank> operator*( - const _Tuple_type<_Rank>& _Lhs, - typename _Tuple_type<_Rank>::value_type _Rhs) restrict(amp,cpu); - -template < - int _Rank, - template class _Tuple_type -> -_Tuple_type<_Rank> operator*( - typename _Tuple_type<_Rank>::value_type _Lhs, - const _Tuple_type<_Rank>& _Rhs) restrict(amp, cpu); -``` - -### Parameters - -*_Rank*
-The rank of the tuple arguments. - -*_Lhs*
-One of the tuples to multiply. - -*_Rhs*
-One of the tuples to multiply. - -### Return Value - -The component-wise product of the specified arguments. - -## operator/ - -Computes the component-wise quotient of the specified arguments. - -```cpp -template < - int _Rank, - template class _Tuple_type -> -_Tuple_type<_Rank> operator/( - const _Tuple_type<_Rank>& _Lhs, - typename _Tuple_type<_Rank>::value_type _Rhs) restrict(amp,cpu); - -template < - int _Rank, - template class _Tuple_type -> -_Tuple_type<_Rank> operator/( - typename _Tuple_type<_Rank>::value_type _Lhs, - const _Tuple_type<_Rank>& _Rhs) restrict(amp,cpu); -``` - -### Parameters - -*_Rank*
-The rank of the tuple arguments. - -*_Lhs*
-The tuple to be divided. - -*_Rhs*
-The tuple to divide by. - -### Return Value - -The component-wise quotient of the specified arguments. - -## operator% - -Computes the modulus of the first specified argument by the second specified argument. - -```cpp -template < - int _Rank, - template class _Tuple_type -> -_Tuple_type<_Rank> operator%( - const _Tuple_type<_Rank>& _Lhs, - typename _Tuple_type<_Rank>::value_type _Rhs) restrict(amp,cpu); - -template < - int _Rank, - template class _Tuple_type -> -_Tuple_type<_Rank> operator%( - typename _Tuple_type<_Rank>::value_type _Lhs, - const _Tuple_type<_Rank>& _Rhs) restrict(amp,cpu); -``` - -### Parameters - -*_Rank*
-The rank of the tuple arguments. - -*_Lhs*
-The tuple from which the modulo is calculated. - -*_Rhs*
-The tuple to modulo by. - -### Return Value - -The result of the first specified argument modulus the second specified argument. - -## See also - -[Concurrency Namespace](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/concurrency-precise-math-namespace-functions.md b/docs/parallel/amp/reference/concurrency-precise-math-namespace-functions.md deleted file mode 100644 index fba9b56557b..00000000000 --- a/docs/parallel/amp/reference/concurrency-precise-math-namespace-functions.md +++ /dev/null @@ -1,2762 +0,0 @@ ---- -title: "Concurrency::precise_math namespace functions" -description: "Learn more about: Concurrency::precise_math namespace functions" -ms.date: 11/04/2016 -f1_keywords: ["amp_math/Concurrency::precise_math::acos", "amp_math/Concurrency::precise_math::acosh", "amp_math/Concurrency::precise_math::acoshf", "amp_math/Concurrency::precise_math::asinf", "amp_math/Concurrency::precise_math::asinh", "amp_math/Concurrency::precise_math::atan", "amp_math/Concurrency::precise_math::atan2", "amp_math/Concurrency::precise_math::atanf", "amp_math/Concurrency::precise_math::atanh", "amp_math/Concurrency::precise_math::cbrt", "amp_math/Concurrency::precise_math::cbrtf", "amp_math/Concurrency::precise_math::ceilf", "amp_math/Concurrency::precise_math::copysign", "amp_math/Concurrency::precise_math::cos", "amp_math/Concurrency::precise_math::cosf", "amp_math/Concurrency::precise_math::coshf", "amp_math/Concurrency::precise_math::cospi", "amp_math/Concurrency::precise_math::erf", "amp_math/Concurrency::precise_math::erfc", "amp_math/Concurrency::precise_math::erfcinv", "amp_math/Concurrency::precise_math::erfcinvf", "amp_math/Concurrency::precise_math::erfinv", "amp_math/Concurrency::precise_math::erfinvf", "amp_math/Concurrency::precise_math::exp10", "amp_math/Concurrency::precise_math::exp10f", "amp_math/Concurrency::precise_math::exp2f", "amp_math/Concurrency::precise_math::expf", "amp_math/Concurrency::precise_math::expm1f", "amp_math/Concurrency::precise_math::fabs", "amp_math/Concurrency::precise_math::floor", "amp_math/Concurrency::precise_math::fdim", "amp_math/Concurrency::precise_math::floorf", "amp_math/Concurrency::precise_math::fmaf", "amp_math/Concurrency::precise_math::fmaxf", "amp_math/Concurrency::precise_math::fmin", "amp_math/Concurrency::precise_math::fmod", "amp_math/Concurrency::precise_math::fmodf", "amp_math/Concurrency::precise_math::frexp", "amp_math/Concurrency::precise_math::frexpf", "amp_math/Concurrency::precise_math::hypotf", "amp_math/Concurrency::precise_math::ilogb", "amp_math/Concurrency::precise_math::isfinite", "amp_math/Concurrency::precise_math::isinf", "amp_math/Concurrency::precise_math::isnormal", "amp_math/Concurrency::precise_math::ldexp", "amp_math/Concurrency::precise_math::lgamma", "amp_math/Concurrency::precise_math::lgammaf", "amp_math/Concurrency::precise_math::log10", "amp_math/Concurrency::precise_math::log10f", "amp_math/Concurrency::precise_math::log1pf", "amp_math/Concurrency::precise_math::log2", "amp_math/Concurrency::precise_math::logb", "amp_math/Concurrency::precise_math::logbf", "amp_math/Concurrency::precise_math::modf", "amp_math/Concurrency::precise_math::modff", "amp_math/Concurrency::precise_math::nanf", "amp_math/Concurrency::precise_math::nearbyint", "amp_math/Concurrency::precise_math::nextafter", "amp_math/Concurrency::precise_math::nextafterf", "amp_math/Concurrency::precise_math::phif", "amp_math/Concurrency::precise_math::pow", "amp_math/Concurrency::precise_math::probit", "amp_math/Concurrency::precise_math::probitf", "amp_math/Concurrency::precise_math::rcbrtf", "amp_math/Concurrency::precise_math::remainder", "amp_math/Concurrency::precise_math::remquo", "amp_math/Concurrency::precise_math::remquof", "amp_math/Concurrency::precise_math::roundf", "amp_math/Concurrency::precise_math::rsqrt", "amp_math/Concurrency::precise_math::scalb", "amp_math/Concurrency::precise_math::scalbf", "amp_math/Concurrency::precise_math::scalbnf", "amp_math/Concurrency::precise_math::signbit", "amp_math/Concurrency::precise_math::sin", "amp_math/Concurrency::precise_math::sincos", "amp_math/Concurrency::precise_math::sinf", "amp_math/Concurrency::precise_math::sinh", "amp_math/Concurrency::precise_math::sinpi", "amp_math/Concurrency::precise_math::sinpif", "amp_math/Concurrency::precise_math::sqrtf", "amp_math/Concurrency::precise_math::tan", "amp_math/Concurrency::precise_math::tanh", "amp_math/Concurrency::precise_math::tanhf", "amp_math/Concurrency::precise_math::tanpif", "amp_math/Concurrency::precise_math::tgamma", "amp_math/Concurrency::precise_math::trunc", "amp_math/Concurrency::precise_math::truncf"] ---- -# Concurrency::precise_math namespace functions - -:::row::: - :::column span=""::: - [`acos`](#acos)\ - [`acosf`](#acosf)\ - [`acosh`](#acosh)\ - [`acoshf`](#acoshf)\ - [`asin`](#asin)\ - [`asinf`](#asinf)\ - [`asinh`](#asinh)\ - [`asinhf`](#asinhf)\ - [`atan`](#atan)\ - [`atan2`](#atan2)\ - [`atan2f`](#atan2f)\ - [`atanf`](#atanf)\ - [`atanh`](#atanh)\ - [`atanhf`](#atanhf)\ - [`cbrt`](#cbrt)\ - [`cbrtf`](#cbrtf)\ - [`ceil`](#ceil)\ - [`ceilf`](#ceilf)\ - [`copysign`](#copysign)\ - [`copysignf`](#copysignf)\ - [`cos`](#cos)\ - [`cosf`](#cosf)\ - [`cosh`](#cosh)\ - [`coshf`](#coshf)\ - [`cospi`](#cospi)\ - [`cospif`](#cospif)\ - [`erf`](#erf)\ - [`erfc`](#erfc)\ - [`erfcf`](#erfcf)\ - [`erfcinv`](#erfcinv)\ - [`erfcinvf`](#erfcinvf)\ - [`erff`](#erff)\ - [`erfinv`](#erfinv) - :::column-end::: - :::column span=""::: - [`erfinvf`](#erfinvf)\ - [`exp`](#exp)\ - [`exp10`](#exp10)\ - [`exp10f`](#exp10f)\ - [`exp2`](#exp2)\ - [`exp2f`](#exp2f)\ - [`expf`](#expf)\ - [`expm1`](#expm1)\ - [`expm1f`](#expm1f)\ - [`fabs`](#fabs)\ - [`fabsf`](#fabsf)\ - [`floor`](#floor)\ - [`fdim`](#fdim)\ - [`fdimf`](#fdimf)|\ - [`floorf`](#floorf)\ - [`fma`](#fma)\ - [`fmaf`](#fmaf)\ - [`fmax`](#fmax)\ - [`fmaxf`](#fmaxf)\ - [`fmin`](#fmin)\ - [`fminf`](#fminf)\ - [`fmod`](#fmod)\ - [`fmodf`](#fmodf)\ - [`fpclassify`](#fpclassify)\ - [`frexp`](#frexp)\ - [`frexpf`](#frexpf)\ - [`hypot`](#hypot)\ - [`hypotf`](#hypotf)\ - [`ilogb`](#ilogb)\ - [`ilogbf`](#ilogbf)\ - [`isfinite`](#isfinite)\ - [`isinf`](#isinf)\ - [`isnan`](#isnan) - :::column-end::: - :::column span=""::: - [`isnormal`](#isnormal)\ - [`ldexp`](#ldexp)\ - [`ldexpf`](#ldexpf)\ - [`lgamma`](#lgamma)\ - [`lgammaf`](#lgammaf)\ - [`log`](#log)\ - [`log10`](#log10)\ - [`log10f`](#log10f)\ - [`log1p`](#log1p)\ - [`log1pf`](#log1pf)\ - [`log2`](#log2)\ - [`log2f`](#log2f)\ - [`logb`](#logb)\ - [`logbf`](#logbf)\ - [`logf`](#logf)\ - [`modf`](#modf)\ - [`modff`](#modff)\ - [`nan`](#nan)\ - [`nanf`](#nanf)\ - [`nearbyint`](#nearbyint)\ - [`nearbyintf`](#nearbyintf)\ - [`nextafter`](#nextafter)\ - [`nextafterf`](#nextafterf)\ - [`phi`](#phi)\ - [`phif`](#phif)\ - [`pow`](#pow)\ - [`powf`](#powf)\ - [`probit`](#probit)\ - [`probitf`](#probitf)\ - [`rcbrt`](#rcbrt)\ - [`rcbrtf`](#rcbrtf)\ - [`remainder`](#remainder)\ - [`remainderf`](#remainderf) - :::column-end::: - :::column span=""::: - [`remquo`](#remquo)\ - [`remquof`](#remquof)\ - [`round`](#round)\ - [`roundf`](#roundf)\ - [`rsqrt`](#rsqrt)\ - [`rsqrtf`](#rsqrtf)\ - [`scalb`](#scalb)\ - [`scalbf`](#scalbf)\ - [`scalbn`](#scalbn)\ - [`scalbnf`](#scalbnf)\ - [`signbit`](#signbit)\ - [`signbitf`](#signbitf)\ - [`sin`](#sin)\ - [`sincos`](#sincos)\ - [`sincosf`](#sincosf)\ - [`sinf`](#sinf)\ - [`sinh`](#sinh)\ - [`sinhf`](#sinhf)\ - [`sinpi`](#sinpi)\ - [`sinpif`](#sinpif)\ - [`sqrt`](#sqrt)\ - [`sqrtf`](#sqrtf)\ - [`tan`](#tan)\ - [`tanf`](#tanf)\ - [`tanh`](#tanh)\ - [`tanhf`](#tanhf)\ - [`tanpi`](#tanpi)\ - [`tanpif`](#tanpif)\ - [`tgamma`](#tgamma)\ - [`tgammaf`](#tgammaf)\ - [`trunc`](#trunc)\ - [`truncf`](#truncf) - :::column-end::: -:::row-end::: - -## acos - -Calculates the arccosine of the argument - -```cpp -inline float acos(float _X) restrict(amp); - -inline double acos(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arccosine value of the argument - -## acosf - -Calculates the arccosine of the argument - -```cpp -inline float acosf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arccosine value of the argument - -## acosh - -Calculates the inverse hyperbolic cosine of the argument - -```cpp -inline float acosh(float _X) restrict(amp); - -inline double acosh(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse hyperbolic cosine value of the argument - -## acoshf - -Calculates the inverse hyperbolic cosine of the argument - -```cpp -inline float acoshf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse hyperbolic cosine value of the argument - -## asin - -Calculates the arcsine of the argument - -```cpp -inline float asin(float _X) restrict(amp); - -inline double asin(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arcsine value of the argument - -## asinf - -Calculates the arcsine of the argument - -```cpp -inline float asinf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arcsine value of the argument - -## asinh - -Calculates the inverse hyperbolic sine of the argument - -```cpp -inline float asinh(float _X) restrict(amp); - -inline double asinh(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse hyperbolic sine value of the argument - -## asinhf - -Calculates the inverse hyperbolic sine of the argument - -```cpp -inline float asinhf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse hyperbolic sine value of the argument - -## atan - -Calculates the arctangent of the argument - -```cpp -inline float atan(float _X) restrict(amp); - -inline double atan(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arctangent value of the argument - -## atan2 - -Calculates the arctangent of _Y/_X - -```cpp -inline float atan2( - float _Y, - float _X) restrict(amp); - -inline double atan2( - double _Y, - double _X) restrict(amp); -``` - -### Parameters - -*_Y*
-Floating-point value - -*_X*
-Floating-point value - -### Return Value - -Returns the arctangent value of _Y/_X - -## atan2f - -Calculates the arctangent of _Y/_X - -```cpp -inline float atan2f( - float _Y, - float _X) restrict(amp); -``` - -### Parameters - -*_Y*
-Floating-point value - -*_X*
-Floating-point value - -### Return Value - -Returns the arctangent value of _Y/_X - -## atanf - -Calculates the arctangent of the argument - -```cpp -inline float atanf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the arctangent value of the argument - -## atanh - -Calculates the inverse hyperbolic tangent of the argument - -```cpp -inline float atanh(float _X) restrict(amp); - -inline double atanh(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse hyperbolic tangent value of the argument - -## atanhf - -Calculates the inverse hyperbolic tangent of the argument - -```cpp -inline float atanhf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse hyperbolic tangent value of the argument - -## cbrt - -Computes the real cube root of the argument - -```cpp -inline float cbrt(float _X) restrict(amp); - -inline double cbrt(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the real cube root of the argument - -## cbrtf - -Computes the real cube root of the argument - -```cpp -inline float cbrtf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the real cube root of the argument - -## ceil - -Calculates the ceiling of the argument - -```cpp -inline float ceil(float _X) restrict(amp); - -inline double ceil(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the ceiling of the argument - -## ceilf - -Calculates the ceiling of the argument - -```cpp -inline float ceilf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the ceiling of the argument - -## copysign - -Produces a value with the magnitude of _X and the sign of _Y - -```cpp -inline float copysign( - float _X, - float _Y) restrict(amp); - -inline double copysign( - double _X, - double _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns a value with the magnitude of _X and the sign of _Y - -## copysignf - -Produces a value with the magnitude of _X and the sign of _Y - -```cpp -inline float copysignf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns a value with the magnitude of _X and the sign of _Y - -## cos - -Calculates the cosine of the argument - -```cpp -inline float cos(float _X) restrict(amp); - -inline double cos(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the cosine value of the argument - -## cosf - -Calculates the cosine of the argument - -```cpp -inline float cosf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the cosine value of the argument - -## cosh - -Calculates the hyperbolic cosine value of the argument - -```cpp -inline float cosh(float _X) restrict(amp); - -inline double cosh(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic cosine value of the argument - -## coshf - -Calculates the hyperbolic cosine value of the argument - -```cpp -inline float coshf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic cosine value of the argument - -## cospi - -Calculates the cosine value of pi \* _X - -```cpp -inline float cospi(float _X) restrict(amp); - -inline double cospi(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the cosine value of pi \* _X - -## cospif - -Calculates the cosine value of pi \* _X - -```cpp -inline float cospif(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the cosine value of pi \* _X - -## erf - -Computes the error function of _X - -```cpp -inline float erf(float _X) restrict(amp); - -inline double erf(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the error function of _X - -## erfc - -Computes the complementary error function of _X - -```cpp -inline float erfc(float _X) restrict(amp); - -inline double erfc(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the complementary error function of _X - -## erfcf - -Computes the complementary error function of _X - -```cpp -inline float erfcf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the complementary error function of _X - -## erfcinv - -Computes the inverse complementary error function of _X - -```cpp -inline float erfcinv(float _X) restrict(amp); - -inline double erfcinv(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse complementary error function of _X - -## erfcinvf - -Computes the inverse complementary error function of _X - -```cpp -inline float erfcinvf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse complementary error function of _X - -## erff - -Computes the error function of _X - -```cpp -inline float erff(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the error function of _X - -## erfinv - -Computes the inverse error function of _X - -```cpp -inline float erfinv(float _X) restrict(amp); - -inline double erfinv(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse error function of _X - -## erfinvf - -Computes the inverse error function of _X - -```cpp -inline float erfinvf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse error function of _X - -## exp10 - -Calculates the base-10 exponential of the argument - -```cpp -inline float exp10(float _X) restrict(amp); - -inline double exp10(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-10 exponential of the argument - -## exp10f - -Calculates the base-10 exponential of the argument - -```cpp -inline float exp10f(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-10 exponential of the argument - -## expm1 - -Calculates the base-e exponential of the argument, minus 1 - -```cpp -inline float expm1(float exponent) restrict(amp); - -inline double expm1(double exponent) restrict(amp); -``` - -### Parameters - -*exponent*
-The exponential term *n* of the mathematical expression `e`n, where `e` is the base of the natural logarithm. - -### Return Value - -Returns the base-e exponential of the argument, minus 1 - -## expm1f - -Calculates the base-e exponential of the argument, minus 1 - -```cpp -inline float expm1f(float exponent) restrict(amp); -``` - -### Parameters - -*exponent*
-The exponential term *n* of the mathematical expression `e`n, where `e` is the base of the natural logarithm. - -### Return Value - -Returns the base-e exponential of the argument, minus 1 - -## exp - -Calculates the base-e exponential of the argument - -```cpp -inline float exp(float _X) restrict(amp); - -inline double exp(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-e exponential of the argument - -## expf - -Calculates the base-e exponential of the argument - -```cpp -inline float expf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-e exponential of the argument - -## exp2 - -Calculates the base-2 exponential of the argument - -```cpp -inline float exp2(float _X) restrict(amp); - -inline double exp2(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-2 exponential of the argument - -## exp2f - -Calculates the base-2 exponential of the argument - -```cpp -inline float exp2f(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-2 exponential of the argument - -## fabs - -Returns the absolute value of the argument - -```cpp -inline float fabs(float _X) restrict(amp); - -inline double fabs(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the absolute value of the argument - -## fabsf - -Returns the absolute value of the argument - -```cpp -inline float fabsf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the absolute value of the argument - -## fdim - -Computes the positive difference between the arguments. - -```cpp -inline float fdim( - float _X, - float _Y -) restrict(amp); -inline double fdim( - double _X, - double _Y -) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -The difference between _X and _Y if _X is greater than _Y; otherwise, +0. - -## fdimf - -Computes the positive difference between the arguments. - -```cpp -inline float fdimf( - float _X, - float _Y -) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -The difference between _X and _Y if _X is greater than _Y; otherwise, +0. - -## floor - -Calculates the floor of the argument - -```cpp -inline float floor(float _X) restrict(amp); - -inline double floor(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the floor of the argument - -## floorf - -Calculates the floor of the argument - -```cpp -inline float floorf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the floor of the argument - -## fma - -Computes the product of the first and second specified arguments, then adds the third specified argument to the result; the entire computation is performed as a single operation. - -```cpp -inline float fma( - float _X, - float _Y, - float _Z -) restrict(amp); - -inline double fma( - double _X, - double _Y, - double _Z -) restrict(amp); -``` - -### Parameters - -*_X*
-The first floating-point argument. - -*_Y*
-The second floating-point argument. - -*_Z*
-The third floating-point argument. - -### Return Value - -The result of the expression (_X \* _Y) + _Z. The entire computation is performed as a single operation; that is, the sub-expressions are calculated to infinite precision, and only the final result is rounded. - -## fmaf - -Computes the product of the first and second specified arguments, then adds the third specified argument to the result; the entire computation is performed as a single operation. - -```cpp -inline float fmaf( - float _X, - float _Y, - float _Z -) restrict(amp); -``` - -### Parameters - -*_X*
-The first floating-point argument. - -*_Y*
-The second floating-point argument. - -*_Z*
-The third floating-point argument. - -### Return Value - -The result of the expression (_X \* _Y) + _Z. The entire computation is performed as a single operation; that is, the sub-expressions are calculated to infinite precision, and only the final result is rounded. - -## fmax - -Determine the maximum numeric value of the arguments - -```cpp -inline float fmax( - float _X, - float _Y) restrict(amp); - -inline double fmax( - double _X, - double _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Return the maximum numeric value of the arguments - -## fmaxf - -Determine the maximum numeric value of the arguments - -```cpp -inline float fmaxf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Return the maximum numeric value of the arguments - -## fmin - -Determine the minimum numeric value of the arguments - -```cpp -inline float fmin( - float _X, - float _Y) restrict(amp); - -inline double fmin( - double _X, - double _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Return the minimum numeric value of the arguments - -## fminf - -Determine the minimum numeric value of the arguments - -```cpp -inline float fminf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Return the minimum numeric value of the arguments - -## fmod Function (C++ AMP) - -Computes the remainder of the first specified argument divided by the second specified argument. - -```cpp -inline float fmod( - float _X, - float _Y) restrict(amp); - -inline double fmod( - double _X, - double _Y) restrict(amp); -``` - -### Parameters - -*_X*
-The first floating-point argument. - -*_Y*
-The second floating-point argument. - -### Return Value - -The remainder of `_X` divided by `_Y`; that is, the value of `_X` - `_Y`*n*, where *n* is a whole integer such that the magnitude of `_X` - `_Y`*n* is less than the magnitude of `_Y`. - -## fmodf - -Computes the remainder of the first specified argument divided by the second specified argument. - -```cpp -inline float fmodf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-The first floating-point argument. - -*_Y*
-The second floating-point argument. - -### Return Value - -The remainder of `_X` divided by `_Y`; that is, the value of `_X` - `_Y`*n*, where *n* is a whole integer such that the magnitude of `_X` - `_Y`*n* is less than the magnitude of `_Y`. - -## fpclassify - -Classifies the argument value as NaN, infinite, normal, subnormal, zero - -```cpp -inline int fpclassify(float _X) restrict(amp); - -inline int fpclassify(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the value of the number classification macro appropriate to the value of the argument. - -## frexp - -Gets the mantissa and exponent of _X - -```cpp -inline float frexp( - float _X, - _Out_ int* _Exp) restrict(amp); - -inline double frexp( - double _X, - _Out_ int* _Exp) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Exp*
-Returns the integer exponent of _X in floating-point value - -### Return Value - -Returns the mantissa _X - -## frexpf - -Gets the mantissa and exponent of _X - -```cpp -inline float frexpf( - float _X, - _Out_ int* _Exp) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Exp*
-Returns the integer exponent of _X in floating-point value - -### Return Value - -Returns the mantissa _X - -## hypot - -Computes the square root of the sum of the squares of _X and _Y - -```cpp -inline float hypot( - float _X, - float _Y) restrict(amp); - -inline double hypot( - double _X, - double _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns the square root of the sum of the squares of _X and _Y - -## hypotf - -Computes the square root of the sum of the squares of _X and _Y - -```cpp -inline float hypotf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns the square root of the sum of the squares of _X and _Y - -## ilogb - -Extract the exponent of _X as a signed int value - -```cpp -inline int ilogb(float _X) restrict(amp); - -inline int ilogb(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the exponent of _X as a signed int value - -## ilogbf - -Extract the exponent of _X as a signed int value - -```cpp -inline int ilogbf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the exponent of _X as a signed int value - -## isfinite - -Determines whether the argument has a finite value - -```cpp -inline int isfinite(float _X) restrict(amp); - -inline int isfinite(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the argument has a finite value - -## isinf - -Determines whether the argument is an infinity - -```cpp -inline int isinf(float _X) restrict(amp); - -inline int isinf(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the argument has an infinite value - -## isnan - -Determines whether the argument is a NaN - -```cpp -inline int isnan(float _X) restrict(amp); - -inline int isnan(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the argument has a NaN value - -## isnormal - -Determines whether the argument is a normal - -```cpp -inline int isnormal(float _X) restrict(amp); - -inline int isnormal(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the argument has a normal value - -## ldexp - -Computes a real number from the specified mantissa and exponent. - -```cpp -inline float ldexp( - float _X, - int _Exp) restrict(amp); - -inline double ldexp( - double _X, - double _Exp) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value, mantissa - -*_Exp*
-Integer value, exponent - -### Return Value - -Returns _X \* 2^_Exp - -## ldexpf - -Computes a real number from the specified mantissa and exponent. - -```cpp -inline float ldexpf( - float _X, - int _Exp) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value, mantissa - -*_Exp*
-Integer value, exponent - -### Return Value - -Returns _X \* 2^_Exp - -## lgamma - -Computes the natural logarithm of the absolute value of gamma of the argument - -```cpp -inline float lgamma( - float _X, - _Out_ int* _Sign) restrict(amp); - -inline double lgamma( - double _X, - _Out_ int* _Sign) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Sign*
-Returns the sign - -### Return Value - -Returns the natural logarithm of the absolute value of gamma of the argument - -## lgammaf - -Computes the natural logarithm of the absolute value of gamma of the argument - -```cpp -inline float lgammaf( - float _X, - _Out_ int* _Sign) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Sign*
-Returns the sign - -### Return Value - -Returns the natural logarithm of the absolute value of gamma of the argument - -## log - -Calculates the base-e logarithm of the argument - -```cpp -inline float log(float _X) restrict(amp); - -inline double log(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-e logarithm of the argument - -## log10 - -Calculates the base-10 logarithm of the argument - -```cpp -inline float log10(float _X) restrict(amp); - -inline double log10(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-10 logarithm of the argument - -## log10f - -Calculates the base-10 logarithm of the argument - -```cpp -inline float log10f(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-10 logarithm of the argument - -## log1p - -Calculates the base-e logarithm of 1 plus the argument - -```cpp -inline float log1p(float _X) restrict(amp); - -inline double log1p(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-e logarithm of 1 plus the argument - -## log1pf - -Calculates the base-e logarithm of 1 plus the argument - -```cpp -inline float log1pf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-e logarithm of 1 plus the argument - -## log2 - -Calculates the base-2 logarithm of the argument - -```cpp -inline float log2(float _X) restrict(amp); - -inline double log2(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-10 logarithm of the argument - -## log2f - -Calculates the base-2 logarithm of the argument - -```cpp -inline float log2f(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-10 logarithm of the argument - -## logb - -Extracts the exponent of _X, as a signed integer value in floating-point format - -```cpp -inline float logb(float _X) restrict(amp); - -inline double logb(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the signed exponent of _X - -## logbf - -Extracts the exponent of _X, as a signed integer value in floating-point format - -```cpp -inline float logbf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the signed exponent of _X - -## logf - -Calculates the base-e logarithm of the argument - -```cpp -inline float logf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the base-e logarithm of the argument - -## modf - -Splits the specified argument into fractional and integer parts. - -```cpp -inline float modf( - float _X, - _Out_ float* _Iptr) restrict(amp); - -inline double modf( - double _X, - _Out_ double* _Iptr) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Iptr*
-[out] The integer portion of `_X`, as a floating-point value. - -### Return Value - -The signed fractional portion of `_X`. - -## modff - -Splits the specified argument into fractional and integer parts. - -```cpp -inline float modff( - float _X, - _Out_ float* _Iptr) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Iptr*
-The integer portion of `_X`, as a floating-point value. - -### Return Value - -Returns the signed fractional portion of `_X`. - -## nan - -Returns a quiet NaN - -```cpp -inline double nan(int _X) restrict(amp); -``` - -### Parameters - -*_X*
-Integer value - -### Return Value - -Returns a quiet NaN, if available, with the content indicated in _X - -## nanf - -Returns a quiet NaN - -```cpp -inline float nanf(int _X) restrict(amp); -``` - -### Parameters - -*_X*
-Integer value - -### Return Value - -Returns a quiet NaN, if available, with the content indicated in _X - -## nearbyint - -Rounds the argument to an integer value in floating-point format, using the current rounding direction. - -```cpp -inline float nearbyint(float _X) restrict(amp); - -inline double nearbyint(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the rounded integer value. - -## nearbyintf - -Rounds the argument to an integer value in floating-point format, using the current rounding direction. - -```cpp -inline float nearbyintf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the rounded integer value. - -## nextafter - -Determine the next representable value, in the type of the function, after _X in the direction of _Y - -```cpp -inline float nextafter( - float _X, - float _Y) restrict(amp); - -inline double nextafter( - double _X, - double _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns the next representable value, in the type of the function, after _X in the direction of _Y - -## nextafterf - -Determine the next representable value, in the type of the function, after _X in the direction of _Y - -```cpp -inline float nextafterf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns the next representable value, in the type of the function, after _X in the direction of _Y - -## phi - -Returns the cumulative distribution function of the argument - -```cpp -inline float phi(float _X) restrict(amp); - -inline double phi(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the cumulative distribution function of the argument - -## phif - -Returns the cumulative distribution function of the argument - -```cpp -inline float phif(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the cumulative distribution function of the argument - -## pow - -Calculates _X raised to the power of _Y - -```cpp -inline float pow( - float _X, - float _Y) restrict(amp); - -inline double pow( - double _X, - double _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value, base - -*_Y*
-Floating-point value, exponent - -### Return Value - -## powf - -Calculates _X raised to the power of _Y - -```cpp -inline float powf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value, base - -*_Y*
-Floating-point value, exponent - -### Return Value - -## probit - -Returns the inverse cumulative distribution function of the argument - -```cpp -inline float probit(float _X) restrict(amp); - -inline double probit(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse cumulative distribution function of the argument - -## probitf - -Returns the inverse cumulative distribution function of the argument - -```cpp -inline float probitf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the inverse cumulative distribution function of the argument - -## rcbrt - -Returns the reciprocal of the cube root of the argument - -```cpp -inline float rcbrt(float _X) restrict(amp); - -inline double rcbrt(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the reciprocal of the cube root of the argument - -## rcbrtf - -Returns the reciprocal of the cube root of the argument - -```cpp -inline float rcbrtf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the reciprocal of the cube root of the argument - -## remainder - -Computes the remainder: _X REM _Y - -```cpp -inline float remainder( - float _X, - float _Y) restrict(amp); - -inline double remainder( - double _X, - double _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns _X REM _Y - -## remainderf - -Computes the remainder: _X REM _Y - -```cpp -inline float remainderf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns _X REM _Y - -## remquo - -Computes the remainder of the first specified argument divided by the second specified argument. Also computes the quotient of the significand of the first specified argument divided by the significand of the second specified argument, and returns the quotient using the location specified in the third argument. - -```cpp -inline float remquo( - float _X, - float _Y, - _Out_ int* _Quo) restrict(amp); - -inline double remquo( - double _X, - double _Y, - _Out_ int* _Quo) restrict(amp); -``` - -### Parameters - -*_X*
-The first floating-point argument. - -*_Y*
-The second floating-point argument. - -*_Quo*
-[out] The address of an integer that's used to return the quotient of the fractional bits of `_X` divided by the fractional bits of `_Y`. - -### Return Value - -Returns the remainder of `_X` divided by `_Y`. - -## remquof - -Computes the remainder of the first specified argument divided by the second specified argument. Also computes the quotient of the significand of the first specified argument divided by the significand of the second specified argument, and returns the quotient using the location specified in the third argument. - -```cpp -inline float remquof( - float _X, - float _Y, - _Out_ int* _Quo) restrict(amp); -``` - -### Parameters - -*_X*
-The first floating-point argument. - -*_Y*
-The second floating-point argument. - -*_Quo*
-[out] The address of an integer that's used to return the quotient of the fractional bits of `_X` divided by the fractional bits of `_Y`. - -### Return Value - -Returns the remainder of `_X` divided by `_Y`. - -## round - -Rounds _X to the nearest integer - -```cpp -inline float round(float _X) restrict(amp); - -inline double round(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the nearest integer of _X - -## roundf - -Rounds _X to the nearest integer - -```cpp -inline float roundf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the nearest integer of _X - -## rsqrt - -Returns the reciprocal of the square root of the argument - -```cpp -inline float rsqrt(float _X) restrict(amp); - -inline double rsqrt(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the reciprocal of the square root of the argument - -## rsqrtf - -Returns the reciprocal of the square root of the argument - -```cpp -inline float rsqrtf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the reciprocal of the square root of the argument - -## scalb - -Multiplies _X by FLT_RADIX to the power _Y - -```cpp -inline float scalb( - float _X, - float _Y) restrict(amp); - -inline double scalb( - double _X, - double _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns _X \* (FLT_RADIX ^ _Y) - -## scalbf - -Multiplies _X by FLT_RADIX to the power _Y - -```cpp -inline float scalbf( - float _X, - float _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Floating-point value - -### Return Value - -Returns _X \* (FLT_RADIX ^ _Y) - -## scalbn - -Multiplies _X by FLT_RADIX to the power _Y - -```cpp -inline float scalbn( - float _X, - int _Y) restrict(amp); - -inline double scalbn( - double _X, - int _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Integer value - -### Return Value - -Returns _X \* (FLT_RADIX ^ _Y) - -## scalbnf - -Multiplies _X by FLT_RADIX to the power _Y - -```cpp -inline float scalbnf( - float _X, - int _Y) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_Y*
-Integer value - -### Return Value - -Returns _X \* (FLT_RADIX ^ _Y) - -## signbit - -Determines whether the sign of _X is negative - -```cpp -inline int signbit(float _X) restrict(amp); - -inline int signbit(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the sign of _X is negative - -## signbitf - -Determines whether the sign of _X is negative - -```cpp -inline int signbitf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns a nonzero value if and only if the sign of _X is negative - -## sin - -Calculates the sine value of the argument - -```cpp -inline float sin(float _X) restrict(amp); - -inline double sin(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the sine value of the argument - -## sinf - -Calculates the sine value of the argument - -```cpp -inline float sinf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the sine value of the argument - -## sincos - -Calculates sine and cosine value of _X - -```cpp -inline void sincos( - float _X, - _Out_ float* _S, - _Out_ float* _C) restrict(amp); - -inline void sincos( - double _X, - _Out_ double* _S, - _Out_ double* _C) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_S*
-Returns the sine value of _X - -*_C*
-Returns the cosine value of _X - -## sincosf - -Calculates sine and cosine value of _X - -```cpp -inline void sincosf( - float _X, - _Out_ float* _S, - _Out_ float* _C) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -*_S*
-Returns the sine value of _X - -*_C*
-Returns the cosine value of _X - -## sinh - -Calculates the hyperbolic sine value of the argument - -```cpp -inline float sinh(float _X) restrict(amp); - -inline double sinh(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic sine value of the argument - -## sinhf - -Calculates the hyperbolic sine value of the argument - -```cpp -inline float sinhf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic sine value of the argument - -## sinpi - -Calculates the sine value of pi \* _X - -```cpp -inline float sinpi(float _X) restrict(amp); - -inline double sinpi(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the sine value of pi \* _X - -## sinpif - -Calculates the sine value of pi \* _X - -```cpp -inline float sinpif(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the sine value of pi \* _X - -## sqrt - -Calculates the squre root of the argument - -```cpp -inline float sqrt(float _X) restrict(amp); - -inline double sqrt(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the squre root of the argument - -## sqrtf - -Calculates the squre root of the argument - -```cpp -inline float sqrtf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the squre root of the argument - -## tan - -Calculates the tangent value of the argument - -```cpp -inline float tan(float _X) restrict(amp); - -inline double tan(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the tangent value of the argument - -## tanf - -Calculates the tangent value of the argument - -```cpp -inline float tanf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the tangent value of the argument - -## tanh - -Calculates the hyperbolic tangent value of the argument - -```cpp -inline float tanh(float _X) restrict(amp); - -inline double tanh(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic tangent value of the argument - -## tanhf - -Calculates the hyperbolic tangent value of the argument - -```cpp -inline float tanhf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the hyperbolic tangent value of the argument - -## tanpi - -Calculates the tangent value of pi \* _X - -```cpp -inline float tanpi(float _X) restrict(amp); - -inline double tanpi(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the tangent value of pi \* _X - -## tanpif - -Calculates the tangent value of pi \* _X - -```cpp -inline float tanpif(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the tangent value of pi \* _X - -## tgamma - -Computes the gamma function of _X - -```cpp -inline float tgamma(float _X) restrict(amp); - -inline double tgamma(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the result of gamma function of _X - -## tgammaf - -Computes the gamma function of _X - -```cpp -inline float tgammaf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the result of gamma function of _X - -## trunc - -Truncates the argument to the integer component - -```cpp -inline float trunc(float _X) restrict(amp); - -inline double trunc(double _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the integer component of the argument - -## truncf - -Truncates the argument to the integer component - -```cpp -inline float truncf(float _X) restrict(amp); -``` - -### Parameters - -*_X*
-Floating-point value - -### Return Value - -Returns the integer component of the argument - -## See also - -[Concurrency::precise_math Namespace](concurrency-precise-math-namespace.md) diff --git a/docs/parallel/amp/reference/concurrency-precise-math-namespace.md b/docs/parallel/amp/reference/concurrency-precise-math-namespace.md deleted file mode 100644 index ade1b8c16cc..00000000000 --- a/docs/parallel/amp/reference/concurrency-precise-math-namespace.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -description: "Learn more about: Concurrency::precise_math Namespace" -title: "Concurrency::precise_math Namespace" -ms.date: "11/04/2016" -f1_keywords: ["AMP_MATH/Concurrency::acos", "AMP_MATH/Concurrency::acosf", "AMP_MATH/Concurrency::acosh", "AMP_MATH/Concurrency::acoshf", "AMP_MATH/Concurrency::asin", "AMP_MATH/Concurrency::asinf", "AMP_MATH/Concurrency::asinh", "AMP_MATH/Concurrency::asinhf", "AMP_MATH/Concurrency::atan", "AMP_MATH/Concurrency::atan2", "AMP_MATH/Concurrency::atan2f", "AMP_MATH/Concurrency::atanf", "AMP_MATH/Concurrency::atanh", "AMP_MATH/Concurrency::atanhf", "AMP_MATH/Concurrency::cbrt", "AMP_MATH/Concurrency::cbrtf", "AMP_MATH/Concurrency::ceil", "AMP_MATH/Concurrency::ceilf", "AMP_MATH/Concurrency::copysign", "AMP_MATH/Concurrency::copysignf", "AMP_MATH/Concurrency::cos", "AMP_MATH/Concurrency::cosf", "AMP_MATH/Concurrency::cosh", "AMP_MATH/Concurrency::coshf", "AMP_MATH/Concurrency::cospi", "AMP_MATH/Concurrency::cospif", "AMP_MATH/Concurrency::erf", "AMP_MATH/Concurrency::erfc", "AMP_MATH/Concurrency::erfcf", "AMP_MATH/Concurrency::erfcinv", "AMP_MATH/Concurrency::erfcinvf", "AMP_MATH/Concurrency::erff", "AMP_MATH/Concurrency::erfinv", "AMP_MATH/Concurrency::erfinvf", "AMP_MATH/Concurrency::exp", "AMP_MATH/Concurrency::exp10", "AMP_MATH/Concurrency::exp10f", "AMP_MATH/Concurrency::exp2", "AMP_MATH/Concurrency::exp2f", "AMP_MATH/Concurrency::expf", "AMP_MATH/Concurrency::expm1", "AMP_MATH/Concurrency::expm1f", "AMP_MATH/Concurrency::fabs", "AMP_MATH/Concurrency::fabsf", "AMP_MATH/Concurrency::fdim", "AMP_MATH/Concurrency::fdimf", "AMP_MATH/Concurrency::floor", "AMP_MATH/Concurrency::floorf", "AMP_MATH/Concurrency::fma", "AMP_MATH/Concurrency::fmaf", "AMP_MATH/Concurrency::fmax", "AMP_MATH/Concurrency::fmaxf", "AMP_MATH/Concurrency::fmin", "AMP_MATH/Concurrency::fminf", "AMP_MATH/Concurrency::fmodf", "AMP_MATH/Concurrency::fpclassify", "AMP_MATH/Concurrency::frexp", "AMP_MATH/Concurrency::frexpf", "AMP_MATH/Concurrency::hypot", "AMP_MATH/Concurrency::hypotf", "AMP_MATH/Concurrency::ilogb", "AMP_MATH/Concurrency::ilogbf", "AMP_MATH/Concurrency::isfinite", "AMP_MATH/Concurrency::isinf", "AMP_MATH/Concurrency::isnan", "AMP_MATH/Concurrency::isnormal", "AMP_MATH/Concurrency::ldexp", "AMP_MATH/Concurrency::ldexpf", "AMP_MATH/Concurrency::lgamma", "AMP_MATH/Concurrency::lgammaf", "AMP_MATH/Concurrency::log", "AMP_MATH/Concurrency::log10", "AMP_MATH/Concurrency::log10f", "AMP_MATH/Concurrency::log1p", "AMP_MATH/Concurrency::log1pf", "AMP_MATH/Concurrency::log2", "AMP_MATH/Concurrency::log2f", "AMP_MATH/Concurrency::logb", "AMP_MATH/Concurrency::logbf", "AMP_MATH/Concurrency::logf", "AMP_MATH/Concurrency::modf", "AMP_MATH/Concurrency::modff", "AMP_MATH/Concurrency::nan", "AMP_MATH/Concurrency::nanf", "AMP_MATH/Concurrency::nearbyint", "AMP_MATH/Concurrency::nearbyintf", "AMP_MATH/Concurrency::nextafter", "AMP_MATH/Concurrency::nextafterf", "AMP_MATH/Concurrency::phi", "AMP_MATH/Concurrency::phif", "AMP_MATH/Concurrency::pow", "AMP_MATH/Concurrency::powf", "AMP_MATH/Concurrency::probit", "AMP_MATH/Concurrency::probitf", "AMP_MATH/Concurrency::rcbrt", "AMP_MATH/Concurrency::rcbrtf", "AMP_MATH/Concurrency::remainder", "AMP_MATH/Concurrency::remainderf", "AMP_MATH/Concurrency::remquo", "AMP_MATH/Concurrency::remquof", "AMP_MATH/Concurrency::round", "AMP_MATH/Concurrency::roundf", "AMP_MATH/Concurrency::rsqrt", "AMP_MATH/Concurrency::rsqrtf", "AMP_MATH/Concurrency::scalb", "AMP_MATH/Concurrency::scalbf", "AMP_MATH/Concurrency::scalbn", "AMP_MATH/Concurrency::scalbnf", "AMP_MATH/Concurrency::signbit", "AMP_MATH/Concurrency::signbitf", "AMP_MATH/Concurrency::sin", "AMP_MATH/Concurrency::sincos", "AMP_MATH/Concurrency::sincosf", "AMP_MATH/Concurrency::sinf", "AMP_MATH/Concurrency::sinh", "AMP_MATH/Concurrency::sinhf", "AMP_MATH/Concurrency::sinpi", "AMP_MATH/Concurrency::sinpif", "AMP_MATH/Concurrency::sqrt", "AMP_MATH/Concurrency::sqrtf", "AMP_MATH/Concurrency::tan", "AMP_MATH/Concurrency::tanf", "AMP_MATH/Concurrency::tanh", "AMP_MATH/Concurrency::tanhf", "AMP_MATH/Concurrency::tanpi", "AMP_MATH/Concurrency::tanpif", "AMP_MATH/Concurrency::tgamma", "AMP_MATH/Concurrency::tgammaf", "AMP_MATH/Concurrency::trunc", "AMP_MATH/Concurrency::truncf"] -ms.assetid: ba653308-dc28-4384-b2fd-6cd718a72f91 ---- -# Concurrency::precise_math Namespace - -Functions in the `precise_math` namespace are C99 conformant. Both single precision and double precision versions of each function are included. For example, `acos` is the double-precision version and `acosf` is the single-precision version. These functions, including the single-precision functions, require extended double-precision support on the accelerator. You can use the [accelerator::supports_double_precision](accelerator-class.md#supports_double_precision) to determine if you can run these functions on a specific accelerator. - -## Syntax - -```cpp -namespace precise_math; -``` - -### Parameters - -## Members - -### Functions - -|Name|Description| -|----------|-----------------| -|[acos](concurrency-precise-math-namespace-functions.md#acos)|Overloaded. Calculates the arccosine of the argument| -|[acosf](concurrency-precise-math-namespace-functions.md#acosf)|Calculates the arccosine of the argument| -|[acosh](concurrency-precise-math-namespace-functions.md#acosh)|Overloaded. Calculates the inverse hyperbolic cosine of the argument| -|[acoshf](concurrency-precise-math-namespace-functions.md#acoshf)|Calculates the inverse hyperbolic cosine of the argument| -|[asin](concurrency-precise-math-namespace-functions.md#asin)|Overloaded. Calculates the arcsine of the argument| -|[asinf](concurrency-precise-math-namespace-functions.md#asinf)|Calculates the arcsine of the argument| -|[asinh](concurrency-precise-math-namespace-functions.md#asinh)|Overloaded. Calculates the inverse hyperbolic sine of the argument| -|[asinhf](concurrency-precise-math-namespace-functions.md#asinhf)|Calculates the inverse hyperbolic sine of the argument| -|[atan](concurrency-precise-math-namespace-functions.md#atan)|Overloaded. Calculates the arctangent of the argument| -|[atan2](concurrency-precise-math-namespace-functions.md#atan2)|Overloaded. Calculates the arctangent of _Y/_X| -|[atan2f](concurrency-precise-math-namespace-functions.md#atan2f)|Calculates the arctangent of _Y/_X| -|[atanf](concurrency-precise-math-namespace-functions.md#atanf)|Calculates the arctangent of the argument| -|[atanh](concurrency-precise-math-namespace-functions.md#atanh)|Overloaded. Calculates the inverse hyperbolic tangent of the argument| -|[atanhf](concurrency-precise-math-namespace-functions.md#atanhf)|Calculates the inverse hyperbolic tangent of the argument| -|[cbrt](concurrency-precise-math-namespace-functions.md#cbrt)|Overloaded. Computes the real cube root of the argument| -|[cbrtf](concurrency-precise-math-namespace-functions.md#cbrtf)|Computes the real cube root of the argument| -|[ceil](concurrency-precise-math-namespace-functions.md#ceil)|Overloaded. Calculates the ceiling of the argument| -|[ceilf](concurrency-precise-math-namespace-functions.md#ceilf)|Calculates the ceiling of the argument| -|[copysign](concurrency-precise-math-namespace-functions.md#copysign)|Overloaded. Produces a value with the magnitude of _X and the sign of _Y| -|[copysignf](concurrency-precise-math-namespace-functions.md#copysignf)|Produces a value with the magnitude of _X and the sign of _Y| -|[cos](concurrency-precise-math-namespace-functions.md#cos)|Overloaded. Calculates the cosine of the argument| -|[cosf](concurrency-precise-math-namespace-functions.md#cosf)|Calculates the cosine of the argument| -|[cosh](concurrency-precise-math-namespace-functions.md#cosh)|Overloaded. Calculates the hyperbolic cosine value of the argument| -|[coshf](concurrency-precise-math-namespace-functions.md#coshf)|Calculates the hyperbolic cosine value of the argument| -|[cospi](concurrency-precise-math-namespace-functions.md#cospi)|Overloaded. Calculates the cosine value of pi \* _X| -|[cospif](concurrency-precise-math-namespace-functions.md#cospif)|Calculates the cosine value of pi \* _X| -|[erf](concurrency-precise-math-namespace-functions.md#erf)|Overloaded. Computes the error function of _X| -|[erfc](concurrency-precise-math-namespace-functions.md#erfc)|Overloaded. Computes the complementary error function of _X| -|[erfcf](concurrency-precise-math-namespace-functions.md#erfcf)|Computes the complementary error function of _X| -|[erfcinv](concurrency-precise-math-namespace-functions.md#erfcinv)|Overloaded. Computes the inverse complementary error function of _X| -|[erfcinvf](concurrency-precise-math-namespace-functions.md#erfcinvf)|Computes the inverse complementary error function of _X| -|[erff](concurrency-precise-math-namespace-functions.md#erff)|Computes the error function of _X| -|[erfinv](concurrency-precise-math-namespace-functions.md#erfinv)|Overloaded. Computes the inverse error function of _X| -|[erfinvf](concurrency-precise-math-namespace-functions.md#erfinvf)|Computes the inverse error function of _X| -|[exp](concurrency-precise-math-namespace-functions.md#exp)|Overloaded. Calculates the base-e exponential of the argument| -|[exp10](concurrency-precise-math-namespace-functions.md#exp10)|Overloaded. Calculates the base-10 exponential of the argument| -|[exp10f](concurrency-precise-math-namespace-functions.md#exp10f)|Calculates the base-10 exponential of the argument| -|[exp2](concurrency-precise-math-namespace-functions.md#exp2)|Overloaded. Calculates the base-2 exponential of the argument| -|[exp2f](concurrency-precise-math-namespace-functions.md#exp2f)|Calculates the base-2 exponential of the argument| -|[expf](concurrency-precise-math-namespace-functions.md#expf)|Calculates the base-e exponential of the argument| -|[expm1](concurrency-precise-math-namespace-functions.md#expm1)|Overloaded. Calculates the base-e exponential of the argument, minus 1| -|[expm1f](concurrency-precise-math-namespace-functions.md#expm1f)|Calculates the base-e exponential of the argument, minus 1| -|[fabs](concurrency-precise-math-namespace-functions.md#fabs)|Overloaded. Returns the absolute value of the argument| -|[fabsf](concurrency-precise-math-namespace-functions.md#fabsf)|Returns the absolute value of the argument| -|[fdim](concurrency-precise-math-namespace-functions.md#fdim)|Overloaded. Determines the positive difference between the arguments| -|[fdimf](concurrency-precise-math-namespace-functions.md#fdimf)|Determines the positive difference between the arguments| -|[floor](concurrency-precise-math-namespace-functions.md#floor)|Overloaded. Calculates the floor of the argument| -|[floorf](concurrency-precise-math-namespace-functions.md#floorf)|Calculates the floor of the argument| -|[fma](concurrency-precise-math-namespace-functions.md#fma)|Overloaded. Compute (_X \* _Y) + _Z, rounded as one ternary operation| -|[fmaf](concurrency-precise-math-namespace-functions.md#fmaf)|Compute (_X \* _Y) + _Z, rounded as one ternary operation| -|[fmax](concurrency-precise-math-namespace-functions.md#fmax)|Overloaded. Determine the maximum numeric value of the arguments| -|[fmaxf](concurrency-precise-math-namespace-functions.md#fmaxf)|Determine the maximum numeric value of the arguments| -|[fmin](concurrency-precise-math-namespace-functions.md#fmin)|Overloaded. Determine the minimum numeric value of the arguments| -|[fminf](concurrency-precise-math-namespace-functions.md#fminf)|Determine the minimum numeric value of the arguments| -|[fmod Function (C++ AMP)](concurrency-precise-math-namespace-functions.md#fmod)|Overloaded. Calculates the floating-point remainder of _X/_Y| -|[fmodf](concurrency-precise-math-namespace-functions.md#fmodf)|Calculates the floating-point remainder of _X/_Y| -|[fpclassify](concurrency-precise-math-namespace-functions.md#fpclassify)|Overloaded. Classifies the argument value as NaN, infinite, normal, subnormal, zero| -|[frexp](concurrency-precise-math-namespace-functions.md#frexp)|Overloaded. Gets the mantissa and exponent of _X| -|[frexpf](concurrency-precise-math-namespace-functions.md#frexpf)|Gets the mantissa and exponent of _X| -|[hypot](concurrency-precise-math-namespace-functions.md#hypot)|Overloaded. Computes the square root of the sum of the squares of _X and _Y| -|[hypotf](concurrency-precise-math-namespace-functions.md#hypotf)|Computes the square root of the sum of the squares of _X and _Y| -|[ilogb](concurrency-precise-math-namespace-functions.md#ilogb)|Overloaded. Extract the exponent of _X as a signed int value| -|[ilogbf](concurrency-precise-math-namespace-functions.md#ilogbf)|Extract the exponent of _X as a signed int value| -|[isfinite](concurrency-precise-math-namespace-functions.md#isfinite)|Overloaded. Determines whether the argument has a finite value| -|[isinf](concurrency-precise-math-namespace-functions.md#isinf)|Overloaded. Determines whether the argument is an infinity| -|[isnan](concurrency-precise-math-namespace-functions.md#isnan)|Overloaded. Determines whether the argument is a NaN| -|[isnormal](concurrency-precise-math-namespace-functions.md#isnormal)|Overloaded. Determines whether the argument is a normal| -|[ldexp](concurrency-precise-math-namespace-functions.md#ldexp)|Overloaded. Computes a real number from the mantissa and exponent| -|[ldexpf](concurrency-precise-math-namespace-functions.md#ldexpf)|Computes a real number from the mantissa and exponent| -|[lgamma](concurrency-precise-math-namespace-functions.md#lgamma)|Overloaded. Computes the natural logarithm of the absolute value of gamma of the argument| -|[lgammaf](concurrency-precise-math-namespace-functions.md#lgammaf)|Computes the natural logarithm of the absolute value of gamma of the argument| -|[log](concurrency-precise-math-namespace-functions.md#log)|Overloaded. Calculates the base-e logarithm of the argument| -|[log10](concurrency-precise-math-namespace-functions.md#log10)|Overloaded. Calculates the base-10 logarithm of the argument| -|[log10f](concurrency-precise-math-namespace-functions.md#log10f)|Calculates the base-10 logarithm of the argument| -|[log1p](concurrency-precise-math-namespace-functions.md#log1p)|Overloaded. Calculates the base-e logarithm of 1 plus the argument| -|[log1pf](concurrency-precise-math-namespace-functions.md#log1pf)|Calculates the base-e logarithm of 1 plus the argument| -|[log2](concurrency-precise-math-namespace-functions.md#log2)|Overloaded. Calculates the base-2 logarithm of the argument| -|[log2f](concurrency-precise-math-namespace-functions.md#log2f)|Calculates the base-2 logarithm of the argument| -|[logb](concurrency-precise-math-namespace-functions.md#logb)|Overloaded. Extracts the exponent of _X, as a signed integer value in floating-point format| -|[logbf](concurrency-precise-math-namespace-functions.md#logbf)|Extracts the exponent of _X, as a signed integer value in floating-point format| -|[logf](concurrency-precise-math-namespace-functions.md#logf)|Calculates the base-e logarithm of the argument| -|[modf](concurrency-precise-math-namespace-functions.md#modf)|Overloaded. Splits _X into fractional and integer parts.| -|[modff](concurrency-precise-math-namespace-functions.md#modff)|Splits _X into fractional and integer parts.| -|[nan](concurrency-precise-math-namespace-functions.md#nan)|Returns a quiet NaN| -|[nanf](concurrency-precise-math-namespace-functions.md#nanf)|Returns a quiet NaN| -|[nearbyint](concurrency-precise-math-namespace-functions.md#nearbyint)|Overloaded. Rounds the argument to an integer value in floating-point format, using the current rounding direction.| -|[nearbyintf](concurrency-precise-math-namespace-functions.md#nearbyintf)|Rounds the argument to an integer value in floating-point format, using the current rounding direction.| -|[nextafter](concurrency-precise-math-namespace-functions.md#nextafter)|Overloaded. Determine the next representable value, in the type of the function, after _X in the direction of _Y| -|[nextafterf](concurrency-precise-math-namespace-functions.md#nextafterf)|Determine the next representable value, in the type of the function, after _X in the direction of _Y| -|[phi](concurrency-precise-math-namespace-functions.md#phi)|Overloaded. Returns the cumulative distribution function of the argument| -|[phif](concurrency-precise-math-namespace-functions.md#phif)|Returns the cumulative distribution function of the argument| -|[pow](concurrency-precise-math-namespace-functions.md#pow)|Overloaded. Calculates _X raised to the power of _Y| -|[powf](concurrency-precise-math-namespace-functions.md#powf)|Calculates _X raised to the power of _Y| -|[probit](concurrency-precise-math-namespace-functions.md#probit)|Overloaded. Returns the inverse cumulative distribution function of the argument| -|[probitf](concurrency-precise-math-namespace-functions.md#probitf)|Returns the inverse cumulative distribution function of the argument| -|[rcbrt](concurrency-precise-math-namespace-functions.md#rcbrt)|Overloaded. Returns the reciprocal of the cube root of the argument| -|[rcbrtf](concurrency-precise-math-namespace-functions.md#rcbrtf)|Returns the reciprocal of the cube root of the argument| -|[remainder](concurrency-precise-math-namespace-functions.md#remainder)|Overloaded. Computes the remainder: _X REM _Y| -|[remainderf](concurrency-precise-math-namespace-functions.md#remainderf)|Computes the remainder: _X REM _Y| -|[remquo](concurrency-precise-math-namespace-functions.md#remquo)|Overloaded. Computes the same remainder as _X REM _Y. Also calculates the lower 23 bits of the integral quotient _X/_Y, and gives that value the same sign as _X/_Y. It stores this signed value in the integer pointed to by _Quo.| -|[remquof](concurrency-precise-math-namespace-functions.md#remquof)|Computes the same remainder as _X REM _Y. Also calculates the lower 23 bits of the integral quotient _X/_Y, and gives that value the same sign as _X/_Y. It stores this signed value in the integer pointed to by _Quo.| -|[round](concurrency-precise-math-namespace-functions.md#round)|Overloaded. Rounds _X to the nearest integer| -|[roundf](concurrency-precise-math-namespace-functions.md#roundf)|Rounds _X to the nearest integer| -|[rsqrt](concurrency-precise-math-namespace-functions.md#rsqrt)|Overloaded. Returns the reciprocal of the square root of the argument| -|[rsqrtf](concurrency-precise-math-namespace-functions.md#rsqrtf)|Returns the reciprocal of the square root of the argument| -|[scalb](concurrency-precise-math-namespace-functions.md#scalb)|Overloaded. Multiplies _X by FLT_RADIX to the power _Y| -|[scalbf](concurrency-precise-math-namespace-functions.md#scalbf)|Multiplies _X by FLT_RADIX to the power _Y| -|[scalbn](concurrency-precise-math-namespace-functions.md#scalbn)|Overloaded. Multiplies _X by FLT_RADIX to the power _Y| -|[scalbnf](concurrency-precise-math-namespace-functions.md#scalbnf)|Multiplies _X by FLT_RADIX to the power _Y| -|[signbit](concurrency-precise-math-namespace-functions.md#signbit)|Overloaded. Determines whether the sign of _X is negative| -|[signbitf](concurrency-precise-math-namespace-functions.md#signbitf)|Determines whether the sign of _X is negative| -|[sin](concurrency-precise-math-namespace-functions.md#sin)|Overloaded. Calculates the sine value of the argument| -|[sincos](concurrency-precise-math-namespace-functions.md#sincos)|Overloaded. Calculates sine and cosine value of _X| -|[sincosf](concurrency-precise-math-namespace-functions.md#sincosf)|Calculates sine and cosine value of _X| -|[sinf](concurrency-precise-math-namespace-functions.md#sinf)|Calculates the sine value of the argument| -|[sinh](concurrency-precise-math-namespace-functions.md#sinh)|Overloaded. Calculates the hyperbolic sine value of the argument| -|[sinhf](concurrency-precise-math-namespace-functions.md#sinhf)|Calculates the hyperbolic sine value of the argument| -|[sinpi](concurrency-precise-math-namespace-functions.md#sinpi)|Overloaded. Calculates the sine value of pi \* _X| -|[sinpif](concurrency-precise-math-namespace-functions.md#sinpif)|Calculates the sine value of pi \* _X| -|[sqrt](concurrency-precise-math-namespace-functions.md#sqrt)|Overloaded. Calculates the squre root of the argument| -|[sqrtf](concurrency-precise-math-namespace-functions.md#sqrtf)|Calculates the squre root of the argument| -|[tan](concurrency-precise-math-namespace-functions.md#tan)|Overloaded. Calculates the tangent value of the argument| -|[tanf](concurrency-precise-math-namespace-functions.md#tanf)|Calculates the tangent value of the argument| -|[tanh](concurrency-precise-math-namespace-functions.md#tanh)|Overloaded. Calculates the hyperbolic tangent value of the argument| -|[tanhf](concurrency-precise-math-namespace-functions.md#tanhf)|Calculates the hyperbolic tangent value of the argument| -|[tanpi](concurrency-precise-math-namespace-functions.md#tanpi)|Overloaded. Calculates the tangent value of pi \* _X| -|[tanpif](concurrency-precise-math-namespace-functions.md#tanpif)|Calculates the tangent value of pi \* _X| -|[tgamma](concurrency-precise-math-namespace-functions.md#tgamma)|Overloaded. Computes the gamma function of _X| -|[tgammaf](concurrency-precise-math-namespace-functions.md#tgammaf)|Computes the gamma function of _X| -|[trunc](concurrency-precise-math-namespace-functions.md#trunc)|Overloaded. Truncates the argument to the integer component| -|[truncf](concurrency-precise-math-namespace-functions.md#truncf)|Truncates the argument to the integer component| - -## Requirements - -**Header:** amp_math.h - -**Namespace:** Concurrency - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/double-2-class.md b/docs/parallel/amp/reference/double-2-class.md deleted file mode 100644 index 59d983be77d..00000000000 --- a/docs/parallel/amp/reference/double-2-class.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -description: "Learn more about: double_2 Class" -title: "double_2 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::double_2::set_x", "amp_short_vectors/Concurrency::graphics::double_2::operator+=", "amp_short_vectors/Concurrency::graphics::double_2::operator=", "amp_short_vectors/Concurrency::graphics::double_2::operator/=", "amp_short_vectors/Concurrency::graphics::double_2::operator*=", "amp_short_vectors/Concurrency::graphics::double_2::yx", "amp_short_vectors/Concurrency::graphics::double_2::y", "amp_short_vectors/Concurrency::graphics::double_2::xy", "amp_short_vectors/Concurrency::graphics::double_2::set_xy", "amp_short_vectors/Concurrency::graphics::double_2::get_yx", "amp_short_vectors/Concurrency::graphics::double_2::set_yx", "amp_short_vectors/Concurrency::graphics::double_2::get_xy", "amp_short_vectors/Concurrency::graphics::double_2::operator++", "amp_short_vectors/Concurrency::graphics::double_2::get_x", "amp_short_vectors/Concurrency::graphics::double_2::operator-=", "amp_short_vectors/Concurrency::graphics::double_2::rg", "amp_short_vectors/Concurrency::graphics::double_2::gr", "amp_short_vectors/Concurrency::graphics::double_2::get_y", "amp_short_vectors/Concurrency::graphics::double_2::x", "amp_short_vectors/Concurrency::graphics::double_2::r", "amp_short_vectors/Concurrency::graphics::double_2::operator--", "amp_short_vectors/Concurrency::graphics::double_2", "amp_short_vectors/Concurrency::graphics::double_2::operator-", "amp_short_vectors/Concurrency::graphics::double_2::g", "amp_short_vectors/Concurrency::graphics::double_2::set_y"] -ms.assetid: c19c2d21-3cbf-4ce5-b460-3b8253688f82 ---- -# double_2 Class - -Represent a short vector of 2 double's. - -## Syntax - -```cpp -class double_2; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[double_2 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|double_2::get_x|| -|double_2::get_xy|| -|double_2::get_y|| -|double_2::get_yx|| -|double_2::ref_g|| -|double_2::ref_r|| -|double_2::ref_x|| -|double_2::ref_y|| -|double_2::set_x|| -|double_2::set_xy|| -|double_2::set_y|| -|double_2::set_yx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|double_2::operator-|| -|double_2::operator--|| -|double_2::operator*=|| -|double_2::operator/=|| -|double_2::operator++|| -|double_2::operator+=|| -|double_2::operator=|| -|double_2::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|double_2::size Constant|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|double_2::g|| -|double_2::gr|| -|double_2::r|| -|double_2::rg|| -|double_2::x|| -|double_2::xy|| -|double_2::y|| -|double_2::yx|| - -## Inheritance Hierarchy - -`double_2` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## double_2 - -Default constructor, initializes all elements with 0. - -```cpp -double_2() restrict(amp, - cpu); - -double_2( - double _V0, - double _V1) restrict(amp, - cpu); - -double_2( - double _V) restrict(amp, - cpu); - -double_2( - const double_2& _Other) restrict(amp, - cpu); - -explicit inline double_2( - const uint_2& _Other) restrict(amp, - cpu); - -explicit inline double_2( - const int_2& _Other) restrict(amp, - cpu); - -explicit inline double_2( - const float_2& _Other) restrict(amp, - cpu); - -explicit inline double_2( - const unorm_2& _Other) restrict(amp, - cpu); - -explicit inline double_2( - const norm_2& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 2; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/double-3-class.md b/docs/parallel/amp/reference/double-3-class.md deleted file mode 100644 index 67dd97384bb..00000000000 --- a/docs/parallel/amp/reference/double-3-class.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -description: "Learn more about: double_3 Class" -title: "double_3 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::double_3::get_xzy", "amp_short_vectors/Concurrency::graphics::double_3", "amp_short_vectors/Concurrency::graphics::double_3::set_yz", "amp_short_vectors/Concurrency::graphics::double_3::bgr", "amp_short_vectors/Concurrency::graphics::double_3::get_zyx", "amp_short_vectors/Concurrency::graphics::double_3::r", "amp_short_vectors/Concurrency::graphics::double_3::g", "amp_short_vectors/Concurrency::graphics::double_3::gr", "amp_short_vectors/Concurrency::graphics::double_3::yz", "amp_short_vectors/Concurrency::graphics::double_3::gbr", "amp_short_vectors/Concurrency::graphics::double_3::xyz", "amp_short_vectors/Concurrency::graphics::double_3::grb", "amp_short_vectors/Concurrency::graphics::double_3::get_z", "amp_short_vectors/Concurrency::graphics::double_3::get_xyz", "amp_short_vectors/Concurrency::graphics::double_3::set_yxz", "amp_short_vectors/Concurrency::graphics::double_3::z", "amp_short_vectors/Concurrency::graphics::double_3::zx", "amp_short_vectors/Concurrency::graphics::double_3::operator+=", "amp_short_vectors/Concurrency::graphics::double_3::rg", "amp_short_vectors/Concurrency::graphics::double_3::get_x", "amp_short_vectors/Concurrency::graphics::double_3::x", "amp_short_vectors/Concurrency::graphics::double_3::set_y", "amp_short_vectors/Concurrency::graphics::double_3::set_yx", "amp_short_vectors/Concurrency::graphics::double_3::operator-=", "amp_short_vectors/Concurrency::graphics::double_3::operator/=", "amp_short_vectors/Concurrency::graphics::double_3::get_y", "amp_short_vectors/Concurrency::graphics::double_3::zy", "amp_short_vectors/Concurrency::graphics::double_3::xy", "amp_short_vectors/Concurrency::graphics::double_3::operator-", "amp_short_vectors/Concurrency::graphics::double_3::bg", "amp_short_vectors/Concurrency::graphics::double_3::get_xz", "amp_short_vectors/Concurrency::graphics::double_3::zxy", "amp_short_vectors/Concurrency::graphics::double_3::set_xzy", "amp_short_vectors/Concurrency::graphics::double_3::set_zx", "amp_short_vectors/Concurrency::graphics::double_3::xzy", "amp_short_vectors/Concurrency::graphics::double_3::get_yzx", "amp_short_vectors/Concurrency::graphics::double_3::br", "amp_short_vectors/Concurrency::graphics::double_3::set_zxy", "amp_short_vectors/Concurrency::graphics::double_3::zyx", "amp_short_vectors/Concurrency::graphics::double_3::get_zx", "amp_short_vectors/Concurrency::graphics::double_3::operator--", "amp_short_vectors/Concurrency::graphics::double_3::b", "amp_short_vectors/Concurrency::graphics::double_3::set_xy", "amp_short_vectors/Concurrency::graphics::double_3::set_x", "amp_short_vectors/Concurrency::graphics::double_3::rb", "amp_short_vectors/Concurrency::graphics::double_3::y", "amp_short_vectors/Concurrency::graphics::double_3::set_xyz", "amp_short_vectors/Concurrency::graphics::double_3::get_xy", "amp_short_vectors/Concurrency::graphics::double_3::operator++", "amp_short_vectors/Concurrency::graphics::double_3::set_z", "amp_short_vectors/Concurrency::graphics::double_3::yx", "amp_short_vectors/Concurrency::graphics::double_3::operator*=", "amp_short_vectors/Concurrency::graphics::double_3::set_zy", "amp_short_vectors/Concurrency::graphics::double_3::rgb", "amp_short_vectors/Concurrency::graphics::double_3::set_zyx", "amp_short_vectors/Concurrency::graphics::double_3::gb", "amp_short_vectors/Concurrency::graphics::double_3::get_zy", "amp_short_vectors/Concurrency::graphics::double_3::get_yz", "amp_short_vectors/Concurrency::graphics::double_3::operator=", "amp_short_vectors/Concurrency::graphics::double_3::yxz", "amp_short_vectors/Concurrency::graphics::double_3::xz", "amp_short_vectors/Concurrency::graphics::double_3::get_zxy", "amp_short_vectors/Concurrency::graphics::double_3::set_yzx", "amp_short_vectors/Concurrency::graphics::double_3::yzx", "amp_short_vectors/Concurrency::graphics::double_3::brg", "amp_short_vectors/Concurrency::graphics::double_3::set_xz", "amp_short_vectors/Concurrency::graphics::double_3::get_yx", "amp_short_vectors/Concurrency::graphics::double_3::rbg", "amp_short_vectors/Concurrency::graphics::double_3::get_yxz"] -ms.assetid: baeb3ff0-2862-4c81-857e-b1a4c085be25 ---- -# double_3 Class - -Represents a short vector of three doubles. - -## Syntax - -```cpp -class double_3; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|value_type|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[double_3 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|double_3::get_x|| -|double_3::get_xy|| -|double_3::get_xyz|| -|double_3::get_xz|| -|double_3::get_xzy|| -|double_3::get_y|| -|double_3::get_yx|| -|double_3::get_yxz|| -|double_3::get_yz|| -|double_3::get_yzx|| -|double_3::get_z|| -|double_3::get_zx|| -|double_3::get_zxy|| -|double_3::get_zy|| -|double_3::get_zyx|| -|double_3::ref_b|| -|double_3::ref_g|| -|double_3::ref_r|| -|double_3::ref_x|| -|double_3::ref_y|| -|double_3::ref_z|| -|double_3::set_x|| -|double_3::set_xy|| -|double_3::set_xyz|| -|double_3::set_xz|| -|double_3::set_xzy|| -|double_3::set_y|| -|double_3::set_yx|| -|double_3::set_yxz|| -|double_3::set_yz|| -|double_3::set_yzx|| -|double_3::set_z|| -|double_3::set_zx|| -|double_3::set_zxy|| -|double_3::set_zy|| -|double_3::set_zyx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|double_3::operator-|| -|double_3::operator--|| -|double_3::operator*=|| -|double_3::operator/=|| -|double_3::operator++|| -|double_3::operator+=|| -|double_3::operator=|| -|double_3::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#double_3__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|double_3::b|| -|double_3::bg|| -|double_3::bgr|| -|double_3::br|| -|double_3::brg|| -|double_3::g|| -|double_3::gb|| -|double_3::gbr|| -|double_3::gr|| -|double_3::grb|| -|double_3::r|| -|double_3::rb|| -|double_3::rbg|| -|double_3::rg|| -|double_3::rgb|| -|double_3::x|| -|double_3::xy|| -|double_3::xyz|| -|double_3::xz|| -|double_3::xzy|| -|double_3::y|| -|double_3::yx|| -|double_3::yxz|| -|double_3::yz|| -|double_3::yzx|| -|double_3::z|| -|double_3::zx|| -|double_3::zxy|| -|double_3::zy|| -|double_3::zyx|| - -## Inheritance Hierarchy - -`double_3` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## double_3 - -Default constructor, initializes all elements with 0. - -```cpp -double_3() restrict(amp, - cpu); - -double_3( - double _V0, - double _V1, - double _V2) restrict(amp, - cpu); - -double_3( - double _V) restrict(amp, - cpu); - -double_3( - const double_3& _Other) restrict(amp, - cpu); - -explicit inline double_3( - const uint_3& _Other) restrict(amp, - cpu); - -explicit inline double_3( - const int_3& _Other) restrict(amp, - cpu); - -explicit inline double_3( - const float_3& _Other) restrict(amp, - cpu); - -explicit inline double_3( - const unorm_3& _Other) restrict(amp, - cpu); - -explicit inline double_3( - const norm_3& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 3; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/double-4-class.md b/docs/parallel/amp/reference/double-4-class.md deleted file mode 100644 index ef7b6325492..00000000000 --- a/docs/parallel/amp/reference/double-4-class.md +++ /dev/null @@ -1,407 +0,0 @@ ---- -description: "Learn more about: double_4 Class" -title: "double_4 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::double_4::get_xw", "amp_short_vectors/Concurrency::graphics::double_4::wxz", "amp_short_vectors/Concurrency::graphics::double_4::rag", "amp_short_vectors/Concurrency::graphics::double_4::wzx", "amp_short_vectors/Concurrency::graphics::double_4::get_yzxw", "amp_short_vectors/Concurrency::graphics::double_4::zxw", "amp_short_vectors/Concurrency::graphics::double_4::set_zwx", "amp_short_vectors/Concurrency::graphics::double_4::get_yxwz", "amp_short_vectors/Concurrency::graphics::double_4::get_wy", "amp_short_vectors/Concurrency::graphics::double_4::set_yx", "amp_short_vectors/Concurrency::graphics::double_4::rbag", "amp_short_vectors/Concurrency::graphics::double_4::ab", "amp_short_vectors/Concurrency::graphics::double_4::ywx", "amp_short_vectors/Concurrency::graphics::double_4::set_xwzy", "amp_short_vectors/Concurrency::graphics::double_4::set_wxyz", "amp_short_vectors/Concurrency::graphics::double_4::xw", "amp_short_vectors/Concurrency::graphics::double_4::set_wxz", "amp_short_vectors/Concurrency::graphics::double_4::ga", "amp_short_vectors/Concurrency::graphics::double_4::yxz", "amp_short_vectors/Concurrency::graphics::double_4::wyx", "amp_short_vectors/Concurrency::graphics::double_4::get_yz", "amp_short_vectors/Concurrency::graphics::double_4::rgba", "amp_short_vectors/Concurrency::graphics::double_4::yzwx", "amp_short_vectors/Concurrency::graphics::double_4::rgb", "amp_short_vectors/Concurrency::graphics::double_4::ywz", "amp_short_vectors/Concurrency::graphics::double_4::set_yw", "amp_short_vectors/Concurrency::graphics::double_4::get_yw", "amp_short_vectors/Concurrency::graphics::double_4::get_xy", "amp_short_vectors/Concurrency::graphics::double_4::set_zwxy", "amp_short_vectors/Concurrency::graphics::double_4::arb", "amp_short_vectors/Concurrency::graphics::double_4::abgr", "amp_short_vectors/Concurrency::graphics::double_4::xwyz", "amp_short_vectors/Concurrency::graphics::double_4::get_wxy", "amp_short_vectors/Concurrency::graphics::double_4::wzyx", "amp_short_vectors/Concurrency::graphics::double_4::zwx", "amp_short_vectors/Concurrency::graphics::double_4::wyz", "amp_short_vectors/Concurrency::graphics::double_4::xwz", "amp_short_vectors/Concurrency::graphics::double_4::set_wy", "amp_short_vectors/Concurrency::graphics::double_4::g", "amp_short_vectors/Concurrency::graphics::double_4::set_zxwy", "amp_short_vectors/Concurrency::graphics::double_4::abg", "amp_short_vectors/Concurrency::graphics::double_4::xzyw", "amp_short_vectors/Concurrency::graphics::double_4::operator++", "amp_short_vectors/Concurrency::graphics::double_4::get_yzx", "amp_short_vectors/Concurrency::graphics::double_4::set_wzx", "amp_short_vectors/Concurrency::graphics::double_4::arg", "amp_short_vectors/Concurrency::graphics::double_4::rab", "amp_short_vectors/Concurrency::graphics::double_4::set_zwyx", "amp_short_vectors/Concurrency::graphics::double_4::ba", "amp_short_vectors/Concurrency::graphics::double_4::w", "amp_short_vectors/Concurrency::graphics::double_4::set_yxwz", "amp_short_vectors/Concurrency::graphics::double_4::ywxz", "amp_short_vectors/Concurrency::graphics::double_4::bar", "amp_short_vectors/Concurrency::graphics::double_4::set_xz", "amp_short_vectors/Concurrency::graphics::double_4::yxzw", "amp_short_vectors/Concurrency::graphics::double_4::get_xzyw", "amp_short_vectors/Concurrency::graphics::double_4::get_wxzy", "amp_short_vectors/Concurrency::graphics::double_4::garb", "amp_short_vectors/Concurrency::graphics::double_4::zwyx", "amp_short_vectors/Concurrency::graphics::double_4::set_yxz", "amp_short_vectors/Concurrency::graphics::double_4::get_xzw", "amp_short_vectors/Concurrency::graphics::double_4::wzy", "amp_short_vectors/Concurrency::graphics::double_4::get_xz", "amp_short_vectors/Concurrency::graphics::double_4::barg", "amp_short_vectors/Concurrency::graphics::double_4::get_zwyx", "amp_short_vectors/Concurrency::graphics::double_4::operator-=", "amp_short_vectors/Concurrency::graphics::double_4::set_yzwx", "amp_short_vectors/Concurrency::graphics::double_4::get_wxz", "amp_short_vectors/Concurrency::graphics::double_4::gabr", "amp_short_vectors/Concurrency::graphics::double_4::set_wxzy", "amp_short_vectors/Concurrency::graphics::double_4::operator/=", "amp_short_vectors/Concurrency::graphics::double_4::zxy", "amp_short_vectors/Concurrency::graphics::double_4::set_zx", "amp_short_vectors/Concurrency::graphics::double_4::get_ywzx", "amp_short_vectors/Concurrency::graphics::double_4::grab", "amp_short_vectors/Concurrency::graphics::double_4::set_ywzx", "amp_short_vectors/Concurrency::graphics::double_4::get_zy", "amp_short_vectors/Concurrency::graphics::double_4::wxzy", "amp_short_vectors/Concurrency::graphics::double_4::yzx", "amp_short_vectors/Concurrency::graphics::double_4::brag", "amp_short_vectors/Concurrency::graphics::double_4::get_wyz", "amp_short_vectors/Concurrency::graphics::double_4::set_yxw", "amp_short_vectors/Concurrency::graphics::double_4::set_xzw", "amp_short_vectors/Concurrency::graphics::double_4::get_zx", "amp_short_vectors/Concurrency::graphics::double_4::get_zxyw", "amp_short_vectors/Concurrency::graphics::double_4::get_zyxw", "amp_short_vectors/Concurrency::graphics::double_4::set_xzwy", "amp_short_vectors/Concurrency::graphics::double_4::get_xyzw", "amp_short_vectors/Concurrency::graphics::double_4::get_xywz", "amp_short_vectors/Concurrency::graphics::double_4::operator-", "amp_short_vectors/Concurrency::graphics::double_4::bga", "amp_short_vectors/Concurrency::graphics::double_4::bgra", "amp_short_vectors/Concurrency::graphics::double_4::set_yzxw", "amp_short_vectors/Concurrency::graphics::double_4::abr", "amp_short_vectors/Concurrency::graphics::double_4::brga", "amp_short_vectors/Concurrency::graphics::double_4::rga", "amp_short_vectors/Concurrency::graphics::double_4::yxw", "amp_short_vectors/Concurrency::graphics::double_4::abrg", "amp_short_vectors/Concurrency::graphics::double_4::gbr", "amp_short_vectors/Concurrency::graphics::double_4::set_wzyx", "amp_short_vectors/Concurrency::graphics::double_4::set_zyxw", "amp_short_vectors/Concurrency::graphics::double_4::xz", "amp_short_vectors/Concurrency::graphics::double_4::get_zxy", "amp_short_vectors/Concurrency::graphics::double_4::set_zw", "amp_short_vectors/Concurrency::graphics::double_4::wy", "amp_short_vectors/Concurrency::graphics::double_4::zx", "amp_short_vectors/Concurrency::graphics::double_4::set_xy", "amp_short_vectors/Concurrency::graphics::double_4::rabg", "amp_short_vectors/Concurrency::graphics::double_4::set_zwy", "amp_short_vectors/Concurrency::graphics::double_4::xzwy", "amp_short_vectors/Concurrency::graphics::double_4::bgar", "amp_short_vectors/Concurrency::graphics::double_4::operator+=", "amp_short_vectors/Concurrency::graphics::double_4::get_xwz", "amp_short_vectors/Concurrency::graphics::double_4::operator*=", "amp_short_vectors/Concurrency::graphics::double_4::get_yxw", "amp_short_vectors/Concurrency::graphics::double_4::y", "amp_short_vectors/Concurrency::graphics::double_4::set_zy", "amp_short_vectors/Concurrency::graphics::double_4::wzxy", "amp_short_vectors/Concurrency::graphics::double_4::get_xwy", "amp_short_vectors/Concurrency::graphics::double_4::xzy", "amp_short_vectors/Concurrency::graphics::double_4::set_zywx", "amp_short_vectors/Concurrency::graphics::double_4::yxwz", "amp_short_vectors/Concurrency::graphics::double_4::ragb", "amp_short_vectors/Concurrency::graphics::double_4::get_zyx", "amp_short_vectors/Concurrency::graphics::double_4::agb", "amp_short_vectors/Concurrency::graphics::double_4::gar", "amp_short_vectors/Concurrency::graphics::double_4::get_wyxz", "amp_short_vectors/Concurrency::graphics::double_4::a", "amp_short_vectors/Concurrency::graphics::double_4::set_wyx", "amp_short_vectors/Concurrency::graphics::double_4::rg", "amp_short_vectors/Concurrency::graphics::double_4::set_xzyw", "amp_short_vectors/Concurrency::graphics::double_4::get_ywx", "amp_short_vectors/Concurrency::graphics::double_4::yx", "amp_short_vectors/Concurrency::graphics::double_4::get_wyzx", "amp_short_vectors/Concurrency::graphics::double_4::set_w", "amp_short_vectors/Concurrency::graphics::double_4::set_zyx", "amp_short_vectors/Concurrency::graphics::double_4::set_wyz", "amp_short_vectors/Concurrency::graphics::double_4::set_wzxy", "amp_short_vectors/Concurrency::graphics::double_4::wyzx", "amp_short_vectors/Concurrency::graphics::double_4::gbar", "amp_short_vectors/Concurrency::graphics::double_4::operator=", "amp_short_vectors/Concurrency::graphics::double_4::x", "amp_short_vectors/Concurrency::graphics::double_4::get_y", "amp_short_vectors/Concurrency::graphics::double_4::set_wx", "amp_short_vectors/Concurrency::graphics::double_4::get_zyw", "amp_short_vectors/Concurrency::graphics::double_4::set_xywz", "amp_short_vectors/Concurrency::graphics::double_4::zyxw", "amp_short_vectors/Concurrency::graphics::double_4::get_zywx", "amp_short_vectors/Concurrency::graphics::double_4::yzw", "amp_short_vectors/Concurrency::graphics::double_4::xyw", "amp_short_vectors/Concurrency::graphics::double_4::bra", "amp_short_vectors/Concurrency::graphics::double_4::agr", "amp_short_vectors/Concurrency::graphics::double_4::zw", "amp_short_vectors/Concurrency::graphics::double_4::get_xwyz", "amp_short_vectors/Concurrency::graphics::double_4::gbra", "amp_short_vectors/Concurrency::graphics::double_4::get_wz", "amp_short_vectors/Concurrency::graphics::double_4::brg", "amp_short_vectors/Concurrency::graphics::double_4::xyz", "amp_short_vectors/Concurrency::graphics::double_4::set_y", "amp_short_vectors/Concurrency::graphics::double_4::set_wyxz", "amp_short_vectors/Concurrency::graphics::double_4::set_z", "amp_short_vectors/Concurrency::graphics::double_4::zwxy", "amp_short_vectors/Concurrency::graphics::double_4::get_ywxz", "amp_short_vectors/Concurrency::graphics::double_4::set_xwy", "amp_short_vectors/Concurrency::graphics::double_4::xyzw", "amp_short_vectors/Concurrency::graphics::double_4::get_x", "amp_short_vectors/Concurrency::graphics::double_4::get_zw", "amp_short_vectors/Concurrency::graphics::double_4::rbga", "amp_short_vectors/Concurrency::graphics::double_4::gr", "amp_short_vectors/Concurrency::graphics::double_4::set_xyzw", "amp_short_vectors/Concurrency::graphics::double_4::get_xzwy", "amp_short_vectors/Concurrency::graphics::double_4::gb", "amp_short_vectors/Concurrency::graphics::double_4::zxyw", "amp_short_vectors/Concurrency::graphics::double_4::set_zxw", "amp_short_vectors/Concurrency::graphics::double_4::gab", "amp_short_vectors/Concurrency::graphics::double_4::xwy", "amp_short_vectors/Concurrency::graphics::double_4::wxyz", "amp_short_vectors/Concurrency::graphics::double_4::wx", "amp_short_vectors/Concurrency::graphics::double_4::gra", "amp_short_vectors/Concurrency::graphics::double_4::xwzy", "amp_short_vectors/Concurrency::graphics::double_4::wxy", "amp_short_vectors/Concurrency::graphics::double_4::set_ywz", "amp_short_vectors/Concurrency::graphics::double_4::set_xw", "amp_short_vectors/Concurrency::graphics::double_4::set_yxzw", "amp_short_vectors/Concurrency::graphics::double_4::set_zyw", "amp_short_vectors/Concurrency::graphics::double_4::get_zwy", "amp_short_vectors/Concurrency::graphics::double_4::agrb", "amp_short_vectors/Concurrency::graphics::double_4::get_yxzw", "amp_short_vectors/Concurrency::graphics::double_4::grb", "amp_short_vectors/Concurrency::graphics::double_4::get_yx", "amp_short_vectors/Concurrency::graphics::double_4::gba", "amp_short_vectors/Concurrency::graphics::double_4::set_ywxz", "amp_short_vectors/Concurrency::graphics::double_4::ywzx", "amp_short_vectors/Concurrency::graphics::double_4::yzxw", "amp_short_vectors/Concurrency::graphics::double_4::zyx", "amp_short_vectors/Concurrency::graphics::double_4::get_yxz", "amp_short_vectors/Concurrency::graphics::double_4::set_yzw", "amp_short_vectors/Concurrency::graphics::double_4::xzw", "amp_short_vectors/Concurrency::graphics::double_4::wz", "amp_short_vectors/Concurrency::graphics::double_4::yw", "amp_short_vectors/Concurrency::graphics::double_4::set_zxyw", "amp_short_vectors/Concurrency::graphics::double_4::get_yzw", "amp_short_vectors/Concurrency::graphics::double_4::get_xyw", "amp_short_vectors/Concurrency::graphics::double_4::get_wzx", "amp_short_vectors/Concurrency::graphics::double_4::argb", "amp_short_vectors/Concurrency::graphics::double_4::set_ywx", "amp_short_vectors/Concurrency::graphics::double_4::get_zwx", "amp_short_vectors/Concurrency::graphics::double_4::set_xyw", "amp_short_vectors/Concurrency::graphics::double_4::r", "amp_short_vectors/Concurrency::graphics::double_4::set_yzx", "amp_short_vectors/Concurrency::graphics::double_4::agbr", "amp_short_vectors/Concurrency::graphics::double_4::set_wzy", "amp_short_vectors/Concurrency::graphics::double_4::xywz", "amp_short_vectors/Concurrency::graphics::double_4::set_wyzx", "amp_short_vectors/Concurrency::graphics::double_4::grba", "amp_short_vectors/Concurrency::graphics::double_4::bg", "amp_short_vectors/Concurrency::graphics::double_4::get_zwxy", "amp_short_vectors/Concurrency::graphics::double_4::get_wyx", "amp_short_vectors/Concurrency::graphics::double_4::get_zxwy", "amp_short_vectors/Concurrency::graphics::double_4::set_zxy", "amp_short_vectors/Concurrency::graphics::double_4::get_w", "amp_short_vectors/Concurrency::graphics::double_4", "amp_short_vectors/Concurrency::graphics::double_4::set_x", "amp_short_vectors/Concurrency::graphics::double_4::bgr", "amp_short_vectors/Concurrency::graphics::double_4::xy", "amp_short_vectors/Concurrency::graphics::double_4::yz", "amp_short_vectors/Concurrency::graphics::double_4::get_wzxy", "amp_short_vectors/Concurrency::graphics::double_4::rbg", "amp_short_vectors/Concurrency::graphics::double_4::get_xzy", "amp_short_vectors/Concurrency::graphics::double_4::operator--", "amp_short_vectors/Concurrency::graphics::double_4::z", "amp_short_vectors/Concurrency::graphics::double_4::b", "amp_short_vectors/Concurrency::graphics::double_4::set_wz", "amp_short_vectors/Concurrency::graphics::double_4::arbg", "amp_short_vectors/Concurrency::graphics::double_4::rba", "amp_short_vectors/Concurrency::graphics::double_4::get_zxw", "amp_short_vectors/Concurrency::graphics::double_4::get_wxyz", "amp_short_vectors/Concurrency::graphics::double_4::ag", "amp_short_vectors/Concurrency::graphics::double_4::zxwy", "amp_short_vectors/Concurrency::graphics::double_4::get_ywz", "amp_short_vectors/Concurrency::graphics::double_4::get_xyz", "amp_short_vectors/Concurrency::graphics::double_4::get_wzy", "amp_short_vectors/Concurrency::graphics::double_4::zy", "amp_short_vectors/Concurrency::graphics::double_4::set_xyz", "amp_short_vectors/Concurrency::graphics::double_4::set_wxy", "amp_short_vectors/Concurrency::graphics::double_4::get_wx", "amp_short_vectors/Concurrency::graphics::double_4::rb", "amp_short_vectors/Concurrency::graphics::double_4::get_wzyx", "amp_short_vectors/Concurrency::graphics::double_4::get_yzwx", "amp_short_vectors/Concurrency::graphics::double_4::rgab", "amp_short_vectors/Concurrency::graphics::double_4::set_xwz", "amp_short_vectors/Concurrency::graphics::double_4::get_z", "amp_short_vectors/Concurrency::graphics::double_4::br", "amp_short_vectors/Concurrency::graphics::double_4::bagr", "amp_short_vectors/Concurrency::graphics::double_4::zywx", "amp_short_vectors/Concurrency::graphics::double_4::set_xzy", "amp_short_vectors/Concurrency::graphics::double_4::set_yz", "amp_short_vectors/Concurrency::graphics::double_4::zyw", "amp_short_vectors/Concurrency::graphics::double_4::ar", "amp_short_vectors/Concurrency::graphics::double_4::wyxz", "amp_short_vectors/Concurrency::graphics::double_4::get_xwzy", "amp_short_vectors/Concurrency::graphics::double_4::ra", "amp_short_vectors/Concurrency::graphics::double_4::set_xwyz", "amp_short_vectors/Concurrency::graphics::double_4::bag", "amp_short_vectors/Concurrency::graphics::double_4::zwy"] -ms.assetid: a81c1595-24c6-4b3f-9574-d5942275e5e8 ---- -# double_4 Class - -Represents a short vector of four doubles. - -## Syntax - -```cpp -class double_4; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[double_4 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|double_4::get_w|| -|double_4::get_wx|| -|double_4::get_wxy|| -|double_4::get_wxyz|| -|double_4::get_wxz|| -|double_4::get_wxzy|| -|double_4::get_wy|| -|double_4::get_wyx|| -|double_4::get_wyxz|| -|double_4::get_wyz|| -|double_4::get_wyzx|| -|double_4::get_wz|| -|double_4::get_wzx|| -|double_4::get_wzxy|| -|double_4::get_wzy|| -|double_4::get_wzyx|| -|double_4::get_x|| -|double_4::get_xw|| -|double_4::get_xwy|| -|double_4::get_xwyz|| -|double_4::get_xwz|| -|double_4::get_xwzy|| -|double_4::get_xy|| -|double_4::get_xyw|| -|double_4::get_xywz|| -|double_4::get_xyz|| -|double_4::get_xyzw|| -|double_4::get_xz|| -|double_4::get_xzw|| -|double_4::get_xzwy|| -|double_4::get_xzy|| -|double_4::get_xzyw|| -|double_4::get_y|| -|double_4::get_yw|| -|double_4::get_ywx|| -|double_4::get_ywxz|| -|double_4::get_ywz|| -|double_4::get_ywzx|| -|double_4::get_yx|| -|double_4::get_yxw|| -|double_4::get_yxwz|| -|double_4::get_yxz|| -|double_4::get_yxzw|| -|double_4::get_yz|| -|double_4::get_yzw|| -|double_4::get_yzwx|| -|double_4::get_yzx|| -|double_4::get_yzxw|| -|double_4::get_z|| -|double_4::get_zw|| -|double_4::get_zwx|| -|double_4::get_zwxy|| -|double_4::get_zwy|| -|double_4::get_zwyx|| -|double_4::get_zx|| -|double_4::get_zxw|| -|double_4::get_zxwy|| -|double_4::get_zxy|| -|double_4::get_zxyw|| -|double_4::get_zy|| -|double_4::get_zyw|| -|double_4::get_zywx|| -|double_4::get_zyx|| -|double_4::get_zyxw|| -|double_4::ref_a|| -|double_4::ref_b|| -|double_4::ref_g|| -|double_4::ref_r|| -|double_4::ref_w|| -|double_4::ref_x|| -|double_4::ref_y|| -|double_4::ref_z|| -|double_4::set_w|| -|double_4::set_wx|| -|double_4::set_wxy|| -|double_4::set_wxyz|| -|double_4::set_wxz|| -|double_4::set_wxzy|| -|double_4::set_wy|| -|double_4::set_wyx|| -|double_4::set_wyxz|| -|double_4::set_wyz|| -|double_4::set_wyzx|| -|double_4::set_wz|| -|double_4::set_wzx|| -|double_4::set_wzxy|| -|double_4::set_wzy|| -|double_4::set_wzyx|| -|double_4::set_x|| -|double_4::set_xw|| -|double_4::set_xwy|| -|double_4::set_xwyz|| -|double_4::set_xwz|| -|double_4::set_xwzy|| -|double_4::set_xy|| -|double_4::set_xyw|| -|double_4::set_xywz|| -|double_4::set_xyz|| -|double_4::set_xyzw|| -|double_4::set_xz|| -|double_4::set_xzw|| -|double_4::set_xzwy|| -|double_4::set_xzy|| -|double_4::set_xzyw|| -|double_4::set_y|| -|double_4::set_yw|| -|double_4::set_ywx|| -|double_4::set_ywxz|| -|double_4::set_ywz|| -|double_4::set_ywzx|| -|double_4::set_yx|| -|double_4::set_yxw|| -|double_4::set_yxwz|| -|double_4::set_yxz|| -|double_4::set_yxzw|| -|double_4::set_yz|| -|double_4::set_yzw|| -|double_4::set_yzwx|| -|double_4::set_yzx|| -|double_4::set_yzxw|| -|double_4::set_z|| -|double_4::set_zw|| -|double_4::set_zwx|| -|double_4::set_zwxy|| -|double_4::set_zwy|| -|double_4::set_zwyx|| -|double_4::set_zx|| -|double_4::set_zxw|| -|double_4::set_zxwy|| -|double_4::set_zxy|| -|double_4::set_zxyw|| -|double_4::set_zy|| -|double_4::set_zyw|| -|double_4::set_zywx|| -|double_4::set_zyx|| -|double_4::set_zyxw|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|double_4::operator-|| -|double_4::operator--|| -|double_4::operator*=|| -|double_4::operator/=|| -|double_4::operator++|| -|double_4::operator+=|| -|double_4::operator=|| -|double_4::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#double_4__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|double_4::a|| -|double_4::ab|| -|double_4::abg|| -|double_4::abgr|| -|double_4::abr|| -|double_4::abrg|| -|double_4::ag|| -|double_4::agb|| -|double_4::agbr|| -|double_4::agr|| -|double_4::agrb|| -|double_4::ar|| -|double_4::arb|| -|double_4::arbg|| -|double_4::arg|| -|double_4::argb|| -|double_4::b|| -|double_4::ba|| -|double_4::bag|| -|double_4::bagr|| -|double_4::bar|| -|double_4::barg|| -|double_4::bg|| -|double_4::bga|| -|double_4::bgar|| -|double_4::bgr|| -|double_4::bgra|| -|double_4::br|| -|double_4::bra|| -|double_4::brag|| -|double_4::brg|| -|double_4::brga|| -|double_4::g|| -|double_4::ga|| -|double_4::gab|| -|double_4::gabr|| -|double_4::gar|| -|double_4::garb|| -|double_4::gb|| -|double_4::gba|| -|double_4::gbar|| -|double_4::gbr|| -|double_4::gbra|| -|double_4::gr|| -|double_4::gra|| -|double_4::grab|| -|double_4::grb|| -|double_4::grba|| -|double_4::r|| -|double_4::ra|| -|double_4::rab|| -|double_4::rabg|| -|double_4::rag|| -|double_4::ragb|| -|double_4::rb|| -|double_4::rba|| -|double_4::rbag|| -|double_4::rbg|| -|double_4::rbga|| -|double_4::rg|| -|double_4::rga|| -|double_4::rgab|| -|double_4::rgb|| -|double_4::rgba|| -|double_4::w|| -|double_4::wx|| -|double_4::wxy|| -|double_4::wxyz|| -|double_4::wxz|| -|double_4::wxzy|| -|double_4::wy|| -|double_4::wyx|| -|double_4::wyxz|| -|double_4::wyz|| -|double_4::wyzx|| -|double_4::wz|| -|double_4::wzx|| -|double_4::wzxy|| -|double_4::wzy|| -|double_4::wzyx|| -|double_4::x|| -|double_4::xw|| -|double_4::xwy|| -|double_4::xwyz|| -|double_4::xwz|| -|double_4::xwzy|| -|double_4::xy|| -|double_4::xyw|| -|double_4::xywz|| -|double_4::xyz|| -|double_4::xyzw|| -|double_4::xz|| -|double_4::xzw|| -|double_4::xzwy|| -|double_4::xzy|| -|double_4::xzyw|| -|double_4::y|| -|double_4::yw|| -|double_4::ywx|| -|double_4::ywxz|| -|double_4::ywz|| -|double_4::ywzx|| -|double_4::yx|| -|double_4::yxw|| -|double_4::yxwz|| -|double_4::yxz|| -|double_4::yxzw|| -|double_4::yz|| -|double_4::yzw|| -|double_4::yzwx|| -|double_4::yzx|| -|double_4::yzxw|| -|double_4::z|| -|double_4::zw|| -|double_4::zwx|| -|double_4::zwxy|| -|double_4::zwy|| -|double_4::zwyx|| -|double_4::zx|| -|double_4::zxw|| -|double_4::zxwy|| -|double_4::zxy|| -|double_4::zxyw|| -|double_4::zy|| -|double_4::zyw|| -|double_4::zywx|| -|double_4::zyx|| -|double_4::zyxw|| - -## Inheritance Hierarchy - -`double_4` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## double_4 - -Default constructor, initializes all elements with 0. - -```cpp -double_4() restrict(amp, - cpu); - -double_4( - double _V0, - double _V1, - double _V2, - double _V3) restrict(amp, - cpu); - -double_4( - double _V) restrict(amp, - cpu); - -double_4( - const double_4& _Other) restrict(amp, - cpu); - -explicit inline double_4( - const uint_4& _Other) restrict(amp, - cpu); - -explicit inline double_4( - const int_4& _Other) restrict(amp, - cpu); - -explicit inline double_4( - const float_4& _Other) restrict(amp, - cpu); - -explicit inline double_4( - const unorm_4& _Other) restrict(amp, - cpu); - -explicit inline double_4( - const norm_4& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V3*
-The value to initialize element 3. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 4; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/extent-class.md b/docs/parallel/amp/reference/extent-class.md deleted file mode 100644 index f547bd38c0f..00000000000 --- a/docs/parallel/amp/reference/extent-class.md +++ /dev/null @@ -1,386 +0,0 @@ ---- -title: "extent Class (C++ AMP)" -description: "Learn more about: extent Class (C++ AMP)" -ms.date: 03/27/2019 -f1_keywords: ["extent", "AMP/extent", "AMP/Concurrency::extent::extent", "AMP/Concurrency::extent::contains", "AMP/Concurrency::extent::size", "AMP/Concurrency::extent::tile", "AMP/Concurrency::extent::rank Constant"] -helpviewer_keywords: ["extent structure"] ---- -# extent Class (C++ AMP) - -Represents a vector of *N* integer values that specify the bounds of an *N*-dimensional space that has an origin of 0. The values in the vector are ordered from most significant to least significant. - -## Syntax - -```cpp -template -class extent; -``` - -### Parameters - -*_Rank*
-The rank of the `extent` object. - -## Requirements - -**Header:** amp.h - -**Namespace:** Concurrency - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[extent Constructor](#ctor)|Initializes a new instance of the `extent` class.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[contains](#contains)|Verifies that the specified `extent` object has the specified rank.| -|[size](#size)|Returns the total linear size of the extent (in units of elements).| -|[tile](#tile)|Produces a `tiled_extent` object with the tile extents given by specified dimensions.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator-](#operator_min)|Returns a new `extent` object that's created by subtracting the `index` elements from the corresponding `extent` elements.| -|[operator--](#operator_min_min)|Decrements each element of the `extent` object.| -|[operator%=](#operator_mod_eq)|Calculates the modulus (remainder) of each element in the `extent` object when that element is divided by a number.| -|[operator*=](#operator_star_eq)|Multiplies each element of the `extent` object by a number.| -|[operator/=](#operator_min_eq)|Divides each element of the `extent` object by a number.| -|[extent::operator\[\]](#operator_at)|Returns the element that's at the specified index.| -|[operator+](#operator_add)|Returns a new `extent` object that's created by adding the corresponding `index` and `extent` elements.| -|[operator++](#operator_add_add)|Increments each element of the `extent` object.| -|[operator+=](#operator_add_eq)|Adds the specified number to each element of the `extent` object.| -|[operator=](#operator_eq)|Copies the contents of another `extent` object into this one.| -|[operator-=](#operator_min_eq)|Subtracts the specified number from each element of the `extent` object.| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[rank Constant](#rank_constant)|Gets the rank of the `extent` object.| - -## Inheritance Hierarchy - -`extent` - -## contains - -Indicates whether the specified [index](index-class.md) value is contained within the `extent` object. - -### Syntax - -```cpp -bool contains(const index& _Index) const restrict(amp,cpu); -``` - -### Parameters - -*_Index*
-The `index` value to test. - -### Return Value - -**`true`** if the specified *index* value is contained in the `extent` object; otherwise, **`false`**. - -## extent - -Initializes a new instance of the `extent` class. - -### Syntax - -```cpp -extent() restrict(amp,cpu); -extent(const extent<_Rank>& _Other) restrict(amp,cpu); -explicit extent(int _I) restrict(amp,cpu); -extent(int _I0, int _I1) restrict(amp,cpu); -extent(int _I0, int _I1, int _I2) restrict(amp,cpu); -explicit extent(const int _Array[_Rank])restrict(amp,cpu); -``` - -### Parameters - -*_Array*
-An array of `_Rank` integers that is used to create the new `extent` object. - -*_I*
-The length of the extent. - -*_I0*
-The length of the most significant dimension. - -*_I1*
-The length of the next-to-most-significant dimension. - -*_I2*
-The length of the least significant dimension. - -*_Other*
-An `extent` object on which the new `extent` object is based. - -## Remarks - -The default constructor initializes an `extent` object that has a rank of three. - -If an array is used to construct an `extent` object, the length of the array must match the rank of the `extent` object. - -## operator%= - -Calculates the modulus (remainder) of each element in the `extent` when that element is divided by a number. - -### Syntax - -```cpp -extent<_Rank>& operator%=(int _Rhs) restrict(cpu, direct3d); -``` - -### Parameters - -*_Rhs*
-The number to find the modulus of. - -### Return Value - -The `extent` object. - -## operator*= - -Multiplies each element in the `extent` object by the specified number. - -### Syntax - -```cpp -extent<_Rank>& operator*=(int _Rhs) restrict(amp,cpu); -``` - -### Parameters - -*_Rhs*
-The number to multiply. - -### Return Value - -The `extent` object. - -## operator+ - -Returns a new `extent` object created by adding the corresponding `index` and `extent` elements. - -### Syntax - -```cpp -extent<_Rank> operator+(const index<_Rank>& _Rhs) restrict(amp,cpu); -``` - -### Parameters - -*_Rhs*
-The `index` object that contains the elements to add. - -### Return Value - -The new `extent` object. - -## operator++ - -Increments each element of the `extent` object. - -### Syntax - -```cpp -extent<_Rank>& operator++() restrict(amp,cpu); -extent<_Rank> operator++(int)restrict(amp,cpu); -``` - -### Return Value - -For the prefix operator, the `extent` object (**`*this`**). For the suffix operator, a new `extent` object. - -## operator+= - -Adds the specified number to each element of the `extent` object. - -### Syntax - -```cpp -extent<_Rank>& operator+=(const extent<_Rank>& _Rhs) restrict(amp,cpu); -extent<_Rank>& operator+=(const index<_Rank>& _Rhs) restrict(amp,cpu); -extent<_Rank>& operator+=(int _Rhs) restrict(amp,cpu); -``` - -### Parameters - -*_Rhs*
-The number, index, or extent to add. - -### Return Value - -The resulting `extent` object. - -## operator- - -Creates a new `extent` object by subtracting each element in the specified `index` object from the corresponding element in this `extent` object. - -### Syntax - -```cpp -extent<_Rank> operator-(const index<_Rank>& _Rhs) restrict(amp,cpu); -``` - -### Parameters - -*_Rhs*
-The `index` object that contains the elements to subtract. - -### Return Value - -The new `extent` object. - -## operator-- - -Decrements each element in the `extent` object. - -### Syntax - -```cpp -extent<_Rank>& operator--() restrict(amp,cpu); -extent<_Rank> operator--(int)restrict(amp,cpu); -``` - -### Return Value - -For the prefix operator, the `extent` object (**`*this`**). For the suffix operator, a new `extent` object. - -## operator/= - -Divides each element in the `extent` object by the specified number. - -### Syntax - -```cpp -extent<_Rank>& operator/=(int _Rhs) restrict(amp,cpu); -``` - -### Parameters - -*_Rhs*
-The number to divide by. - -### Return Value - -The `extent` object. - -## operator-= - -Subtracts the specified number from each element of the `extent` object. - -### Syntax - -```cpp -extent<_Rank>& operator-=(const extent<_Rank>& _Rhs) restrict(amp,cpu); -extent<_Rank>& operator-=(const index<_Rank>& _Rhs) restrict(amp,cpu); -extent<_Rank>& operator-=(int _Rhs) restrict(amp,cpu); -``` - -### Parameters - -*_Rhs*
-The number to subtract. - -### Return Value - -The resulting `extent` object. - -## operator= - -Copies the contents of another `extent` object into this one. - -### Syntax - -```cpp -extent<_Rank>& operator=(const extent<_Rank>& _Other) restrict(amp,cpu); -``` - -### Parameters - -*_Other*
-The `extent` object to copy from. - -### Return Value - -A reference to this `extent` object. - -## extent::operator \[\] - -Returns the element that's at the specified index. - -### Syntax - -```cpp -int operator[](unsigned int _Index) const restrict(amp,cpu); -int& operator[](unsigned int _Index) restrict(amp,cpu); -``` - -### Parameters - -*_Index*
-An integer from 0 through the rank minus 1. - -### Return Value - -The element that's at the specified index. - -## rank - -Stores the rank of the `extent` object. - -### Syntax - -```cpp -static const int rank = _Rank; -``` - -## size - -Returns the total linear size of the `extent` object (in units of elements). - -### Syntax - -```cpp -unsigned int size() const restrict(amp,cpu); -``` - -## tile - -Produces a tiled_extent object with the specified tile dimensions. - -```cpp -template -tiled_extent<_Dim0> tile() const ; - -template -tiled_extent<_Dim0, _Dim1> tile() const ; - -template -tiled_extent<_Dim0, _Dim1, _Dim2> tile() const ; -``` - -### Parameters - -*_Dim0*
-The most significant component of the tiled extent. - -*_Dim1*
-The next-to-most-significant component of the tiled extent. - -*_Dim2*
-The least significant component of the tiled extent. - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/float-2-class.md b/docs/parallel/amp/reference/float-2-class.md deleted file mode 100644 index 4f6befc7b98..00000000000 --- a/docs/parallel/amp/reference/float-2-class.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -description: "Learn more about: float_2 Class" -title: "float_2 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::float_2::yx", "amp_short_vectors/Concurrency::graphics::float_2::operator-=", "amp_short_vectors/Concurrency::graphics::float_2::operator++", "amp_short_vectors/Concurrency::graphics::float_2::operator-", "amp_short_vectors/Concurrency::graphics::float_2::r", "amp_short_vectors/Concurrency::graphics::float_2::get_yx", "amp_short_vectors/Concurrency::graphics::float_2::get_xy", "amp_short_vectors/Concurrency::graphics::float_2::operator/=", "amp_short_vectors/Concurrency::graphics::float_2::set_yx", "amp_short_vectors/Concurrency::graphics::float_2::x", "amp_short_vectors/Concurrency::graphics::float_2::get_y", "amp_short_vectors/Concurrency::graphics::float_2::operator+=", "amp_short_vectors/Concurrency::graphics::float_2::gr", "amp_short_vectors/Concurrency::graphics::float_2::operator=", "amp_short_vectors/Concurrency::graphics::float_2::set_x", "amp_short_vectors/Concurrency::graphics::float_2::operator--", "amp_short_vectors/Concurrency::graphics::float_2::get_x", "amp_short_vectors/Concurrency::graphics::float_2::operator*=", "amp_short_vectors/Concurrency::graphics::float_2::rg", "amp_short_vectors/Concurrency::graphics::float_2::set_xy", "amp_short_vectors/Concurrency::graphics::float_2::xy", "amp_short_vectors/Concurrency::graphics::float_2", "amp_short_vectors/Concurrency::graphics::float_2::set_y", "amp_short_vectors/Concurrency::graphics::float_2::y", "amp_short_vectors/Concurrency::graphics::float_2::g"] -ms.assetid: b3ebd48e-f8c8-4f00-a640-357f702f0cae ---- -# float_2 Class - -Represents a short vector of two floats. - -## Syntax - -```cpp -class float_2; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[float_2 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|float_2::get_x|| -|float_2::get_xy|| -|float_2::get_y|| -|float_2::get_yx|| -|float_2::ref_g|| -|float_2::ref_r|| -|float_2::ref_x|| -|float_2::ref_y|| -|float_2::set_x|| -|float_2::set_xy|| -|float_2::set_y|| -|float_2::set_yx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|float_2::operator-|| -|float_2::operator--|| -|float_2::operator*=|| -|float_2::operator/=|| -|float_2::operator++|| -|float_2::operator+=|| -|float_2::operator=|| -|float_2::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#float_2__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|float_2::g|| -|float_2::gr|| -|float_2::r|| -|float_2::rg|| -|float_2::x|| -|float_2::xy|| -|float_2::y|| -|float_2::yx|| - -## Inheritance Hierarchy - -`float_2` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## float_2 - -Default constructor, initializes all elements with 0. - -```cpp -float_2() restrict(amp, - cpu); - -float_2( - float _V0, - float _V1) restrict(amp, - cpu); - -float_2( - float _V) restrict(amp, - cpu); - -float_2( - const float_2& _Other) restrict(amp, - cpu); - -explicit inline float_2( - const uint_2& _Other) restrict(amp, - cpu); - -explicit inline float_2( - const int_2& _Other) restrict(amp, - cpu); - -explicit inline float_2( - const unorm_2& _Other) restrict(amp, - cpu); - -explicit inline float_2( - const norm_2& _Other) restrict(amp, - cpu); - -explicit inline float_2( - const double_2& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 2; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/float-3-class.md b/docs/parallel/amp/reference/float-3-class.md deleted file mode 100644 index 0a4ac77c7da..00000000000 --- a/docs/parallel/amp/reference/float-3-class.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -description: "Learn more about: float_3 Class" -title: "float_3 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::float_3::get_zyx", "amp_short_vectors/Concurrency::graphics::float_3::set_y", "amp_short_vectors/Concurrency::graphics::float_3::b", "amp_short_vectors/Concurrency::graphics::float_3::operator-=", "amp_short_vectors/Concurrency::graphics::float_3::get_y", "amp_short_vectors/Concurrency::graphics::float_3::set_zy", "amp_short_vectors/Concurrency::graphics::float_3::get_yzx", "amp_short_vectors/Concurrency::graphics::float_3::xz", "amp_short_vectors/Concurrency::graphics::float_3::xyz", "amp_short_vectors/Concurrency::graphics::float_3::operator+=", "amp_short_vectors/Concurrency::graphics::float_3::brg", "amp_short_vectors/Concurrency::graphics::float_3::get_x", "amp_short_vectors/Concurrency::graphics::float_3::get_zx", "amp_short_vectors/Concurrency::graphics::float_3::y", "amp_short_vectors/Concurrency::graphics::float_3::rbg", "amp_short_vectors/Concurrency::graphics::float_3::operator-", "amp_short_vectors/Concurrency::graphics::float_3::get_yz", "amp_short_vectors/Concurrency::graphics::float_3::set_xz", "amp_short_vectors/Concurrency::graphics::float_3::operator/=", "amp_short_vectors/Concurrency::graphics::float_3::zxy", "amp_short_vectors/Concurrency::graphics::float_3::yx", "amp_short_vectors/Concurrency::graphics::float_3::g", "amp_short_vectors/Concurrency::graphics::float_3::r", "amp_short_vectors/Concurrency::graphics::float_3::zy", "amp_short_vectors/Concurrency::graphics::float_3::set_zxy", "amp_short_vectors/Concurrency::graphics::float_3::set_zyx", "amp_short_vectors/Concurrency::graphics::float_3::get_yx", "amp_short_vectors/Concurrency::graphics::float_3", "amp_short_vectors/Concurrency::graphics::float_3::get_xz", "amp_short_vectors/Concurrency::graphics::float_3::get_yxz", "amp_short_vectors/Concurrency::graphics::float_3::set_xy", "amp_short_vectors/Concurrency::graphics::float_3::get_xzy", "amp_short_vectors/Concurrency::graphics::float_3::bgr", "amp_short_vectors/Concurrency::graphics::float_3::zx", "amp_short_vectors/Concurrency::graphics::float_3::gr", "amp_short_vectors/Concurrency::graphics::float_3::set_z", "amp_short_vectors/Concurrency::graphics::float_3::get_zy", "amp_short_vectors/Concurrency::graphics::float_3::gb", "amp_short_vectors/Concurrency::graphics::float_3::set_xzy", "amp_short_vectors/Concurrency::graphics::float_3::set_zx", "amp_short_vectors/Concurrency::graphics::float_3::set_yzx", "amp_short_vectors/Concurrency::graphics::float_3::operator=", "amp_short_vectors/Concurrency::graphics::float_3::x", "amp_short_vectors/Concurrency::graphics::float_3::grb", "amp_short_vectors/Concurrency::graphics::float_3::zyx", "amp_short_vectors/Concurrency::graphics::float_3::set_yxz", "amp_short_vectors/Concurrency::graphics::float_3::get_zxy", "amp_short_vectors/Concurrency::graphics::float_3::set_yz", "amp_short_vectors/Concurrency::graphics::float_3::operator--", "amp_short_vectors/Concurrency::graphics::float_3::set_xyz", "amp_short_vectors/Concurrency::graphics::float_3::operator++", "amp_short_vectors/Concurrency::graphics::float_3::z", "amp_short_vectors/Concurrency::graphics::float_3::xy", "amp_short_vectors/Concurrency::graphics::float_3::rgb", "amp_short_vectors/Concurrency::graphics::float_3::rg", "amp_short_vectors/Concurrency::graphics::float_3::yzx", "amp_short_vectors/Concurrency::graphics::float_3::set_yx", "amp_short_vectors/Concurrency::graphics::float_3::xzy", "amp_short_vectors/Concurrency::graphics::float_3::rb", "amp_short_vectors/Concurrency::graphics::float_3::get_z", "amp_short_vectors/Concurrency::graphics::float_3::br", "amp_short_vectors/Concurrency::graphics::float_3::bg", "amp_short_vectors/Concurrency::graphics::float_3::get_xyz", "amp_short_vectors/Concurrency::graphics::float_3::set_x", "amp_short_vectors/Concurrency::graphics::float_3::yxz", "amp_short_vectors/Concurrency::graphics::float_3::yz", "amp_short_vectors/Concurrency::graphics::float_3::gbr", "amp_short_vectors/Concurrency::graphics::float_3::operator*=", "amp_short_vectors/Concurrency::graphics::float_3::get_xy"] -helpviewer_keywords: ["amp_short_vectors/Concurrency::graphics::float_3"] -ms.assetid: 209df7a5-08d7-48b4-8ba5-77603642cdd8 ---- -# float_3 Class - -Represents a short vector of three floats. - -## Syntax - -```cpp -class float_3; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[float_3 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|float_3::get_x|| -|float_3::get_xy|| -|float_3::get_xyz|| -|float_3::get_xz|| -|float_3::get_xzy|| -|float_3::get_y|| -|float_3::get_yx|| -|float_3::get_yxz|| -|float_3::get_yz|| -|float_3::get_yzx|| -|float_3::get_z|| -|float_3::get_zx|| -|float_3::get_zxy|| -|float_3::get_zy|| -|float_3::get_zyx|| -|float_3::ref_b|| -|float_3::ref_g|| -|float_3::ref_r|| -|float_3::ref_x|| -|float_3::ref_y|| -|float_3::ref_z|| -|float_3::set_x|| -|float_3::set_xy|| -|float_3::set_xyz|| -|float_3::set_xz|| -|float_3::set_xzy|| -|float_3::set_y|| -|float_3::set_yx|| -|float_3::set_yxz|| -|float_3::set_yz|| -|float_3::set_yzx|| -|float_3::set_z|| -|float_3::set_zx|| -|float_3::set_zxy|| -|float_3::set_zy|| -|float_3::set_zyx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|float_3::operator-|| -|float_3::operator--|| -|float_3::operator*=|| -|float_3::operator/=|| -|float_3::operator++|| -|float_3::operator+=|| -|float_3::operator=|| -|float_3::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#float_3__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|float_3::b|| -|float_3::bg|| -|float_3::bgr|| -|float_3::br|| -|float_3::brg|| -|float_3::g|| -|float_3::gb|| -|float_3::gbr|| -|float_3::gr|| -|float_3::grb|| -|float_3::r|| -|float_3::rb|| -|float_3::rbg|| -|float_3::rg|| -|float_3::rgb|| -|float_3::x|| -|float_3::xy|| -|float_3::xyz|| -|float_3::xz|| -|float_3::xzy|| -|float_3::y|| -|float_3::yx|| -|float_3::yxz|| -|float_3::yz|| -|float_3::yzx|| -|float_3::z|| -|float_3::zx|| -|float_3::zxy|| -|float_3::zy|| -|float_3::zyx|| - -## Inheritance Hierarchy - -`float_3` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## float_3 - -Default constructor, initializes all elements with 0. - -```cpp -float_3() restrict(amp, - cpu); - -float_3( - float _V0, - float _V1, - float _V2) restrict(amp, - cpu); - -float_3( - float _V) restrict(amp, - cpu); - -float_3( - const float_3& _Other) restrict(amp, - cpu); - -explicit inline float_3( - const uint_3& _Other) restrict(amp, - cpu); - -explicit inline float_3( - const int_3& _Other) restrict(amp, - cpu); - -explicit inline float_3( - const unorm_3& _Other) restrict(amp, - cpu); - -explicit inline float_3( - const norm_3& _Other) restrict(amp, - cpu); - -explicit inline float_3( - const double_3& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 3; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/float-4-class.md b/docs/parallel/amp/reference/float-4-class.md deleted file mode 100644 index 386b6fa124a..00000000000 --- a/docs/parallel/amp/reference/float-4-class.md +++ /dev/null @@ -1,407 +0,0 @@ ---- -description: "Learn more about: float_4 Class" -title: "float_4 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::float_4::get_wyxz", "amp_short_vectors/Concurrency::graphics::float_4::zxw", "amp_short_vectors/Concurrency::graphics::float_4::bgra", "amp_short_vectors/Concurrency::graphics::float_4::get_xz", "amp_short_vectors/Concurrency::graphics::float_4::get_yxw", "amp_short_vectors/Concurrency::graphics::float_4::r", "amp_short_vectors/Concurrency::graphics::float_4::set_wzx", "amp_short_vectors/Concurrency::graphics::float_4::brga", "amp_short_vectors/Concurrency::graphics::float_4::get_xyw", "amp_short_vectors/Concurrency::graphics::float_4::gr", "amp_short_vectors/Concurrency::graphics::float_4::operator/=", "amp_short_vectors/Concurrency::graphics::float_4::agrb", "amp_short_vectors/Concurrency::graphics::float_4::set_wxz", "amp_short_vectors/Concurrency::graphics::float_4::get_wzy", "amp_short_vectors/Concurrency::graphics::float_4::rag", "amp_short_vectors/Concurrency::graphics::float_4::yzx", "amp_short_vectors/Concurrency::graphics::float_4::gbr", "amp_short_vectors/Concurrency::graphics::float_4::set_zxwy", "amp_short_vectors/Concurrency::graphics::float_4::wx", "amp_short_vectors/Concurrency::graphics::float_4::zwx", "amp_short_vectors/Concurrency::graphics::float_4::zwyx", "amp_short_vectors/Concurrency::graphics::float_4::wxy", "amp_short_vectors/Concurrency::graphics::float_4::set_wyx", "amp_short_vectors/Concurrency::graphics::float_4::set_zyx", "amp_short_vectors/Concurrency::graphics::float_4::set_yz", "amp_short_vectors/Concurrency::graphics::float_4::rbag", "amp_short_vectors/Concurrency::graphics::float_4::rb", "amp_short_vectors/Concurrency::graphics::float_4::get_zxyw", "amp_short_vectors/Concurrency::graphics::float_4::xz", "amp_short_vectors/Concurrency::graphics::float_4::get_zy", "amp_short_vectors/Concurrency::graphics::float_4::abrg", "amp_short_vectors/Concurrency::graphics::float_4::bg", "amp_short_vectors/Concurrency::graphics::float_4::xwy", "amp_short_vectors/Concurrency::graphics::float_4::get_xwz", "amp_short_vectors/Concurrency::graphics::float_4::ragb", "amp_short_vectors/Concurrency::graphics::float_4::wzx", "amp_short_vectors/Concurrency::graphics::float_4::rgba", "amp_short_vectors/Concurrency::graphics::float_4::set_zyw", "amp_short_vectors/Concurrency::graphics::float_4::get_zw", "amp_short_vectors/Concurrency::graphics::float_4::zywx", "amp_short_vectors/Concurrency::graphics::float_4::set_zwxy", "amp_short_vectors/Concurrency::graphics::float_4::set_wyzx", "amp_short_vectors/Concurrency::graphics::float_4::zyxw", "amp_short_vectors/Concurrency::graphics::float_4::yw", "amp_short_vectors/Concurrency::graphics::float_4::set_xw", "amp_short_vectors/Concurrency::graphics::float_4::gar", "amp_short_vectors/Concurrency::graphics::float_4::get_yzx", "amp_short_vectors/Concurrency::graphics::float_4::get_w", "amp_short_vectors/Concurrency::graphics::float_4::wzy", "amp_short_vectors/Concurrency::graphics::float_4::ywx", "amp_short_vectors/Concurrency::graphics::float_4::get_zx", "amp_short_vectors/Concurrency::graphics::float_4::operator=", "amp_short_vectors/Concurrency::graphics::float_4::set_wx", "amp_short_vectors/Concurrency::graphics::float_4::get_zyx", "amp_short_vectors/Concurrency::graphics::float_4::ra", "amp_short_vectors/Concurrency::graphics::float_4::zy", "amp_short_vectors/Concurrency::graphics::float_4::grab", "amp_short_vectors/Concurrency::graphics::float_4::get_xwy", "amp_short_vectors/Concurrency::graphics::float_4::get_yw", "amp_short_vectors/Concurrency::graphics::float_4::set_xyz", "amp_short_vectors/Concurrency::graphics::float_4::get_zywx", "amp_short_vectors/Concurrency::graphics::float_4::w", "amp_short_vectors/Concurrency::graphics::float_4::get_ywxz", "amp_short_vectors/Concurrency::graphics::float_4::xy", "amp_short_vectors/Concurrency::graphics::float_4::yzwx", "amp_short_vectors/Concurrency::graphics::float_4::rabg", "amp_short_vectors/Concurrency::graphics::float_4::get_ywx", "amp_short_vectors/Concurrency::graphics::float_4::get_zwyx", "amp_short_vectors/Concurrency::graphics::float_4::rbg", "amp_short_vectors/Concurrency::graphics::float_4::get_yxzw", "amp_short_vectors/Concurrency::graphics::float_4::a", "amp_short_vectors/Concurrency::graphics::float_4::ba", "amp_short_vectors/Concurrency::graphics::float_4::operator+=", "amp_short_vectors/Concurrency::graphics::float_4::brag", "amp_short_vectors/Concurrency::graphics::float_4::yxz", "amp_short_vectors/Concurrency::graphics::float_4::get_yzxw", "amp_short_vectors/Concurrency::graphics::float_4::set_xyw", "amp_short_vectors/Concurrency::graphics::float_4::set_yxwz", "amp_short_vectors/Concurrency::graphics::float_4::ab", "amp_short_vectors/Concurrency::graphics::float_4", "amp_short_vectors/Concurrency::graphics::float_4::set_wz", "amp_short_vectors/Concurrency::graphics::float_4::gabr", "amp_short_vectors/Concurrency::graphics::float_4::operator-", "amp_short_vectors/Concurrency::graphics::float_4::set_zwyx", "amp_short_vectors/Concurrency::graphics::float_4::set_zxy", "amp_short_vectors/Concurrency::graphics::float_4::set_x", "amp_short_vectors/Concurrency::graphics::float_4::get_wzxy", "amp_short_vectors/Concurrency::graphics::float_4::gbar", "amp_short_vectors/Concurrency::graphics::float_4::gb", "amp_short_vectors/Concurrency::graphics::float_4::zxwy", "amp_short_vectors/Concurrency::graphics::float_4::yxzw", "amp_short_vectors/Concurrency::graphics::float_4::get_wxz", "amp_short_vectors/Concurrency::graphics::float_4::zyx", "amp_short_vectors/Concurrency::graphics::float_4::xzyw", "amp_short_vectors/Concurrency::graphics::float_4::operator*=", "amp_short_vectors/Concurrency::graphics::float_4::yxwz", "amp_short_vectors/Concurrency::graphics::float_4::xywz", "amp_short_vectors/Concurrency::graphics::float_4::arb", "amp_short_vectors/Concurrency::graphics::float_4::get_yzw", "amp_short_vectors/Concurrency::graphics::float_4::wyxz", "amp_short_vectors/Concurrency::graphics::float_4::get_yzwx", "amp_short_vectors/Concurrency::graphics::float_4::wy", "amp_short_vectors/Concurrency::graphics::float_4::zwxy", "amp_short_vectors/Concurrency::graphics::float_4::set_wyz", "amp_short_vectors/Concurrency::graphics::float_4::set_wyxz", "amp_short_vectors/Concurrency::graphics::float_4::gab", "amp_short_vectors/Concurrency::graphics::float_4::get_xyzw", "amp_short_vectors/Concurrency::graphics::float_4::get_wyz", "amp_short_vectors/Concurrency::graphics::float_4::rbga", "amp_short_vectors/Concurrency::graphics::float_4::bagr", "amp_short_vectors/Concurrency::graphics::float_4::xyz", "amp_short_vectors/Concurrency::graphics::float_4::set_wzxy", "amp_short_vectors/Concurrency::graphics::float_4::agb", "amp_short_vectors/Concurrency::graphics::float_4::brg", "amp_short_vectors/Concurrency::graphics::float_4::zxyw", "amp_short_vectors/Concurrency::graphics::float_4::arg", "amp_short_vectors/Concurrency::graphics::float_4::g", "amp_short_vectors/Concurrency::graphics::float_4::get_zxy", "amp_short_vectors/Concurrency::graphics::float_4::set_yzxw", "amp_short_vectors/Concurrency::graphics::float_4::set_yzx", "amp_short_vectors/Concurrency::graphics::float_4::gba", "amp_short_vectors/Concurrency::graphics::float_4::ywzx", "amp_short_vectors/Concurrency::graphics::float_4::get_wx", "amp_short_vectors/Concurrency::graphics::float_4::set_z", "amp_short_vectors/Concurrency::graphics::float_4::set_xwyz", "amp_short_vectors/Concurrency::graphics::float_4::grba", "amp_short_vectors/Concurrency::graphics::float_4::yxw", "amp_short_vectors/Concurrency::graphics::float_4::set_zw", "amp_short_vectors/Concurrency::graphics::float_4::get_yx", "amp_short_vectors/Concurrency::graphics::float_4::get_zwxy", "amp_short_vectors/Concurrency::graphics::float_4::get_wz", "amp_short_vectors/Concurrency::graphics::float_4::garb", "amp_short_vectors/Concurrency::graphics::float_4::set_yxw", "amp_short_vectors/Concurrency::graphics::float_4::rba", "amp_short_vectors/Concurrency::graphics::float_4::xzwy", "amp_short_vectors/Concurrency::graphics::float_4::get_zxwy", "amp_short_vectors/Concurrency::graphics::float_4::zw", "amp_short_vectors/Concurrency::graphics::float_4::abgr", "amp_short_vectors/Concurrency::graphics::float_4::set_wxzy", "amp_short_vectors/Concurrency::graphics::float_4::wz", "amp_short_vectors/Concurrency::graphics::float_4::agbr", "amp_short_vectors/Concurrency::graphics::float_4::ar", "amp_short_vectors/Concurrency::graphics::float_4::bra", "amp_short_vectors/Concurrency::graphics::float_4::zxy", "amp_short_vectors/Concurrency::graphics::float_4::set_wy", "amp_short_vectors/Concurrency::graphics::float_4::argb", "amp_short_vectors/Concurrency::graphics::float_4::abr", "amp_short_vectors/Concurrency::graphics::float_4::get_wyzx", "amp_short_vectors/Concurrency::graphics::float_4::set_xywz", "amp_short_vectors/Concurrency::graphics::float_4::get_xwzy", "amp_short_vectors/Concurrency::graphics::float_4::b", "amp_short_vectors/Concurrency::graphics::float_4::ywz", "amp_short_vectors/Concurrency::graphics::float_4::wxz", "amp_short_vectors/Concurrency::graphics::float_4::rga", "amp_short_vectors/Concurrency::graphics::float_4::set_zx", "amp_short_vectors/Concurrency::graphics::float_4::ga", "amp_short_vectors/Concurrency::graphics::float_4::get_y", "amp_short_vectors/Concurrency::graphics::float_4::agr", "amp_short_vectors/Concurrency::graphics::float_4::wzxy", "amp_short_vectors/Concurrency::graphics::float_4::set_xzy", "amp_short_vectors/Concurrency::graphics::float_4::arbg", "amp_short_vectors/Concurrency::graphics::float_4::gbra", "amp_short_vectors/Concurrency::graphics::float_4::set_xy", "amp_short_vectors/Concurrency::graphics::float_4::yx", "amp_short_vectors/Concurrency::graphics::float_4::set_yxz", "amp_short_vectors/Concurrency::graphics::float_4::wxzy", "amp_short_vectors/Concurrency::graphics::float_4::bgr", "amp_short_vectors/Concurrency::graphics::float_4::get_wxyz", "amp_short_vectors/Concurrency::graphics::float_4::xyw", "amp_short_vectors/Concurrency::graphics::float_4::set_ywx", "amp_short_vectors/Concurrency::graphics::float_4::get_wzyx", "amp_short_vectors/Concurrency::graphics::float_4::wyx", "amp_short_vectors/Concurrency::graphics::float_4::get_xzyw", "amp_short_vectors/Concurrency::graphics::float_4::get_zwy", "amp_short_vectors/Concurrency::graphics::float_4::get_wzx", "amp_short_vectors/Concurrency::graphics::float_4::barg", "amp_short_vectors/Concurrency::graphics::float_4::get_ywzx", "amp_short_vectors/Concurrency::graphics::float_4::set_wxyz", "amp_short_vectors/Concurrency::graphics::float_4::get_wxy", "amp_short_vectors/Concurrency::graphics::float_4::set_zyxw", "amp_short_vectors/Concurrency::graphics::float_4::set_zywx", "amp_short_vectors/Concurrency::graphics::float_4::operator-=", "amp_short_vectors/Concurrency::graphics::float_4::set_y", "amp_short_vectors/Concurrency::graphics::float_4::wyzx", "amp_short_vectors/Concurrency::graphics::float_4::bgar", "amp_short_vectors/Concurrency::graphics::float_4::set_yx", "amp_short_vectors/Concurrency::graphics::float_4::set_xzyw", "amp_short_vectors/Concurrency::graphics::float_4::set_yxzw", "amp_short_vectors/Concurrency::graphics::float_4::xyzw", "amp_short_vectors/Concurrency::graphics::float_4::abg", "amp_short_vectors/Concurrency::graphics::float_4::x", "amp_short_vectors/Concurrency::graphics::float_4::gra", "amp_short_vectors/Concurrency::graphics::float_4::get_zyw", "amp_short_vectors/Concurrency::graphics::float_4::set_xz", "amp_short_vectors/Concurrency::graphics::float_4::get_xw", "amp_short_vectors/Concurrency::graphics::float_4::bag", "amp_short_vectors/Concurrency::graphics::float_4::xwz", "amp_short_vectors/Concurrency::graphics::float_4::get_xwyz", "amp_short_vectors/Concurrency::graphics::float_4::get_zxw", "amp_short_vectors/Concurrency::graphics::float_4::set_xwzy", "amp_short_vectors/Concurrency::graphics::float_4::get_wxzy", "amp_short_vectors/Concurrency::graphics::float_4::get_xzwy", "amp_short_vectors/Concurrency::graphics::float_4::get_xzw", "amp_short_vectors/Concurrency::graphics::float_4::get_xzy", "amp_short_vectors/Concurrency::graphics::float_4::set_yzw", "amp_short_vectors/Concurrency::graphics::float_4::zwy", "amp_short_vectors/Concurrency::graphics::float_4::operator--", "amp_short_vectors/Concurrency::graphics::float_4::set_xzw", "amp_short_vectors/Concurrency::graphics::float_4::get_wy", "amp_short_vectors/Concurrency::graphics::float_4::xzy", "amp_short_vectors/Concurrency::graphics::float_4::set_zy", "amp_short_vectors/Concurrency::graphics::float_4::set_xwz", "amp_short_vectors/Concurrency::graphics::float_4::set_zwx", "amp_short_vectors/Concurrency::graphics::float_4::bar", "amp_short_vectors/Concurrency::graphics::float_4::set_wzy", "amp_short_vectors/Concurrency::graphics::float_4::set_zxyw", "amp_short_vectors/Concurrency::graphics::float_4::set_wzyx", "amp_short_vectors/Concurrency::graphics::float_4::set_w", "amp_short_vectors/Concurrency::graphics::float_4::get_yxz", "amp_short_vectors/Concurrency::graphics::float_4::get_ywz", "amp_short_vectors/Concurrency::graphics::float_4::set_ywzx", "amp_short_vectors/Concurrency::graphics::float_4::get_zwx", "amp_short_vectors/Concurrency::graphics::float_4::set_zwy", "amp_short_vectors/Concurrency::graphics::float_4::set_yzwx", "amp_short_vectors/Concurrency::graphics::float_4::wyz", "amp_short_vectors/Concurrency::graphics::float_4::yzxw", "amp_short_vectors/Concurrency::graphics::float_4::yz", "amp_short_vectors/Concurrency::graphics::float_4::xw", "amp_short_vectors/Concurrency::graphics::float_4::bga", "amp_short_vectors/Concurrency::graphics::float_4::ywxz", "amp_short_vectors/Concurrency::graphics::float_4::set_wxy", "amp_short_vectors/Concurrency::graphics::float_4::get_wyx", "amp_short_vectors/Concurrency::graphics::float_4::yzw", "amp_short_vectors/Concurrency::graphics::float_4::grb", "amp_short_vectors/Concurrency::graphics::float_4::operator++", "amp_short_vectors/Concurrency::graphics::float_4::xwyz", "amp_short_vectors/Concurrency::graphics::float_4::br", "amp_short_vectors/Concurrency::graphics::float_4::set_zxw", "amp_short_vectors/Concurrency::graphics::float_4::rgab", "amp_short_vectors/Concurrency::graphics::float_4::get_xy", "amp_short_vectors/Concurrency::graphics::float_4::xzw", "amp_short_vectors/Concurrency::graphics::float_4::zyw", "amp_short_vectors/Concurrency::graphics::float_4::set_ywz", "amp_short_vectors/Concurrency::graphics::float_4::zx", "amp_short_vectors/Concurrency::graphics::float_4::wxyz", "amp_short_vectors/Concurrency::graphics::float_4::set_xzwy", "amp_short_vectors/Concurrency::graphics::float_4::rab", "amp_short_vectors/Concurrency::graphics::float_4::ag", "amp_short_vectors/Concurrency::graphics::float_4::set_xwy", "amp_short_vectors/Concurrency::graphics::float_4::get_xywz", "amp_short_vectors/Concurrency::graphics::float_4::get_xyz", "amp_short_vectors/Concurrency::graphics::float_4::y", "amp_short_vectors/Concurrency::graphics::float_4::rg", "amp_short_vectors/Concurrency::graphics::float_4::wzyx", "amp_short_vectors/Concurrency::graphics::float_4::z", "amp_short_vectors/Concurrency::graphics::float_4::set_ywxz", "amp_short_vectors/Concurrency::graphics::float_4::get_yxwz", "amp_short_vectors/Concurrency::graphics::float_4::rgb", "amp_short_vectors/Concurrency::graphics::float_4::get_zyxw", "amp_short_vectors/Concurrency::graphics::float_4::get_yz", "amp_short_vectors/Concurrency::graphics::float_4::set_yw", "amp_short_vectors/Concurrency::graphics::float_4::xwzy", "amp_short_vectors/Concurrency::graphics::float_4::get_x", "amp_short_vectors/Concurrency::graphics::float_4::get_z", "amp_short_vectors/Concurrency::graphics::float_4::set_xyzw"] -ms.assetid: 10f92170-e58c-4afc-8198-fc5778d56038 ---- -# float_4 Class - -Represents a short vector of four floats. - -## Syntax - -```cpp -class float_4; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[float_4 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|float_4::get_w|| -|float_4::get_wx|| -|float_4::get_wxy|| -|float_4::get_wxyz|| -|float_4::get_wxz|| -|float_4::get_wxzy|| -|float_4::get_wy|| -|float_4::get_wyx|| -|float_4::get_wyxz|| -|float_4::get_wyz|| -|float_4::get_wyzx|| -|float_4::get_wz|| -|float_4::get_wzx|| -|float_4::get_wzxy|| -|float_4::get_wzy|| -|float_4::get_wzyx|| -|float_4::get_x|| -|float_4::get_xw|| -|float_4::get_xwy|| -|float_4::get_xwyz|| -|float_4::get_xwz|| -|float_4::get_xwzy|| -|float_4::get_xy|| -|float_4::get_xyw|| -|float_4::get_xywz|| -|float_4::get_xyz|| -|float_4::get_xyzw|| -|float_4::get_xz|| -|float_4::get_xzw|| -|float_4::get_xzwy|| -|float_4::get_xzy|| -|float_4::get_xzyw|| -|float_4::get_y|| -|float_4::get_yw|| -|float_4::get_ywx|| -|float_4::get_ywxz|| -|float_4::get_ywz|| -|float_4::get_ywzx|| -|float_4::get_yx|| -|float_4::get_yxw|| -|float_4::get_yxwz|| -|float_4::get_yxz|| -|float_4::get_yxzw|| -|float_4::get_yz|| -|float_4::get_yzw|| -|float_4::get_yzwx|| -|float_4::get_yzx|| -|float_4::get_yzxw|| -|float_4::get_z|| -|float_4::get_zw|| -|float_4::get_zwx|| -|float_4::get_zwxy|| -|float_4::get_zwy|| -|float_4::get_zwyx|| -|float_4::get_zx|| -|float_4::get_zxw|| -|float_4::get_zxwy|| -|float_4::get_zxy|| -|float_4::get_zxyw|| -|float_4::get_zy|| -|float_4::get_zyw|| -|float_4::get_zywx|| -|float_4::get_zyx|| -|float_4::get_zyxw|| -|float_4::ref_a|| -|float_4::ref_b|| -|float_4::ref_g|| -|float_4::ref_r|| -|float_4::ref_w|| -|float_4::ref_x|| -|float_4::ref_y|| -|float_4::ref_z|| -|float_4::set_w|| -|float_4::set_wx|| -|float_4::set_wxy|| -|float_4::set_wxyz|| -|float_4::set_wxz|| -|float_4::set_wxzy|| -|float_4::set_wy|| -|float_4::set_wyx|| -|float_4::set_wyxz|| -|float_4::set_wyz|| -|float_4::set_wyzx|| -|float_4::set_wz|| -|float_4::set_wzx|| -|float_4::set_wzxy|| -|float_4::set_wzy|| -|float_4::set_wzyx|| -|float_4::set_x|| -|float_4::set_xw|| -|float_4::set_xwy|| -|float_4::set_xwyz|| -|float_4::set_xwz|| -|float_4::set_xwzy|| -|float_4::set_xy|| -|float_4::set_xyw|| -|float_4::set_xywz|| -|float_4::set_xyz|| -|float_4::set_xyzw|| -|float_4::set_xz|| -|float_4::set_xzw|| -|float_4::set_xzwy|| -|float_4::set_xzy|| -|float_4::set_xzyw|| -|float_4::set_y|| -|float_4::set_yw|| -|float_4::set_ywx|| -|float_4::set_ywxz|| -|float_4::set_ywz|| -|float_4::set_ywzx|| -|float_4::set_yx|| -|float_4::set_yxw|| -|float_4::set_yxwz|| -|float_4::set_yxz|| -|float_4::set_yxzw|| -|float_4::set_yz|| -|float_4::set_yzw|| -|float_4::set_yzwx|| -|float_4::set_yzx|| -|float_4::set_yzxw|| -|float_4::set_z|| -|float_4::set_zw|| -|float_4::set_zwx|| -|float_4::set_zwxy|| -|float_4::set_zwy|| -|float_4::set_zwyx|| -|float_4::set_zx|| -|float_4::set_zxw|| -|float_4::set_zxwy|| -|float_4::set_zxy|| -|float_4::set_zxyw|| -|float_4::set_zy|| -|float_4::set_zyw|| -|float_4::set_zywx|| -|float_4::set_zyx|| -|float_4::set_zyxw|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|float_4::operator-|| -|float_4::operator--|| -|float_4::operator*=|| -|float_4::operator/=|| -|float_4::operator++|| -|float_4::operator+=|| -|float_4::operator=|| -|float_4::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#float_4__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|float_4::a|| -|float_4::ab|| -|float_4::abg|| -|float_4::abgr|| -|float_4::abr|| -|float_4::abrg|| -|float_4::ag|| -|float_4::agb|| -|float_4::agbr|| -|float_4::agr|| -|float_4::agrb|| -|float_4::ar|| -|float_4::arb|| -|float_4::arbg|| -|float_4::arg|| -|float_4::argb|| -|float_4::b|| -|float_4::ba|| -|float_4::bag|| -|float_4::bagr|| -|float_4::bar|| -|float_4::barg|| -|float_4::bg|| -|float_4::bga|| -|float_4::bgar|| -|float_4::bgr|| -|float_4::bgra|| -|float_4::br|| -|float_4::bra|| -|float_4::brag|| -|float_4::brg|| -|float_4::brga|| -|float_4::g|| -|float_4::ga|| -|float_4::gab|| -|float_4::gabr|| -|float_4::gar|| -|float_4::garb|| -|float_4::gb|| -|float_4::gba|| -|float_4::gbar|| -|float_4::gbr|| -|float_4::gbra|| -|float_4::gr|| -|float_4::gra|| -|float_4::grab|| -|float_4::grb|| -|float_4::grba|| -|float_4::r|| -|float_4::ra|| -|float_4::rab|| -|float_4::rabg|| -|float_4::rag|| -|float_4::ragb|| -|float_4::rb|| -|float_4::rba|| -|float_4::rbag|| -|float_4::rbg|| -|float_4::rbga|| -|float_4::rg|| -|float_4::rga|| -|float_4::rgab|| -|float_4::rgb|| -|float_4::rgba|| -|float_4::w|| -|float_4::wx|| -|float_4::wxy|| -|float_4::wxyz|| -|float_4::wxz|| -|float_4::wxzy|| -|float_4::wy|| -|float_4::wyx|| -|float_4::wyxz|| -|float_4::wyz|| -|float_4::wyzx|| -|float_4::wz|| -|float_4::wzx|| -|float_4::wzxy|| -|float_4::wzy|| -|float_4::wzyx|| -|float_4::x|| -|float_4::xw|| -|float_4::xwy|| -|float_4::xwyz|| -|float_4::xwz|| -|float_4::xwzy|| -|float_4::xy|| -|float_4::xyw|| -|float_4::xywz|| -|float_4::xyz|| -|float_4::xyzw|| -|float_4::xz|| -|float_4::xzw|| -|float_4::xzwy|| -|float_4::xzy|| -|float_4::xzyw|| -|float_4::y|| -|float_4::yw|| -|float_4::ywx|| -|float_4::ywxz|| -|float_4::ywz|| -|float_4::ywzx|| -|float_4::yx|| -|float_4::yxw|| -|float_4::yxwz|| -|float_4::yxz|| -|float_4::yxzw|| -|float_4::yz|| -|float_4::yzw|| -|float_4::yzwx|| -|float_4::yzx|| -|float_4::yzxw|| -|float_4::z|| -|float_4::zw|| -|float_4::zwx|| -|float_4::zwxy|| -|float_4::zwy|| -|float_4::zwyx|| -|float_4::zx|| -|float_4::zxw|| -|float_4::zxwy|| -|float_4::zxy|| -|float_4::zxyw|| -|float_4::zy|| -|float_4::zyw|| -|float_4::zywx|| -|float_4::zyx|| -|float_4::zyxw|| - -## Inheritance Hierarchy - -`float_4` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## float_4 - -Default constructor, initializes all elements with 0. - -```cpp -float_4() restrict(amp, - cpu); - -float_4( - float _V0, - float _V1, - float _V2, - float _V3) restrict(amp, - cpu); - -float_4( - float _V) restrict(amp, - cpu); - -float_4( - const float_4& _Other) restrict(amp, - cpu); - -explicit inline float_4( - const uint_4& _Other) restrict(amp, - cpu); - -explicit inline float_4( - const int_4& _Other) restrict(amp, - cpu); - -explicit inline float_4( - const unorm_4& _Other) restrict(amp, - cpu); - -explicit inline float_4( - const norm_4& _Other) restrict(amp, - cpu); - -explicit inline float_4( - const double_4& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V3*
-The value to initialize element 3. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 4; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/index-class.md b/docs/parallel/amp/reference/index-class.md deleted file mode 100644 index 7e4fe7573d1..00000000000 --- a/docs/parallel/amp/reference/index-class.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -description: "Learn more about: index Class" -title: "index Class" -ms.date: 06/21/2022 -f1_keywords: ["AMP/index", "AMP/Concurrency::index::index", "AMP/Concurrency::index::rank"] -helpviewer_keywords: ["index structure"] -ms.assetid: cbe79b08-0ba7-474c-9828-f1a71da39eb3 -ms.custom: devdivchpfy22 ---- - -# index Class - -Defines an *N*-dimensional index vector. - -## Syntax - -```cpp -template -class index; -``` - -### Parameters - -*_Rank*
-The rank, or number of dimensions. - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[index Constructor](#index_ctor)|Initializes a new instance of the `index` class.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator--](#operator--)|Decrements each element of the `index` object.| -|[operator%=](#operator_mod_eq)|Calculates the modulus (remainder) of each element in the `index` object when that element is divided by a number.| -|[operator*=](#operator_star_eq)|Multiplies each element of the `index` object by a number.| -|[operator/=](#operator_div_eq)|Divides each element of the `index` object by a number.| -|[index::operator\[\]](#operator_at)|Returns the element that's at the specified index.| -|[operator++](#operator_add_add)|Increments each element of the `index` object.| -|[operator+=](#operator_add_eq)|Adds the specified number to each element of the `index` object.| -|[operator=](#operator_eq)|Copies the contents of the specified `index` object into this one.| -|[operator-=](#operator_-_eq)|Subtracts the specified number from each element of the `index` object.| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[rank Constant](#rank)|Stores the rank of the `index` object.| - -## Inheritance Hierarchy - -`index` - -## Remarks - -The `index` structure represents a coordinate vector of *N* integers that specifies a unique position in an *N*-dimensional space. The values in the vector are ordered from most significant to least significant. You can retrieve the values of the components using [operator=](#operator_eq). - -## Requirements - -**Header:** amp.h - -**Namespace:** Concurrency - -## index Constructor - -Initializes a new instance of the index class. - -```cpp -index() restrict(amp,cpu); - -index( - const index<_Rank>& _Other -) restrict(amp,cpu); - -explicit index( - int _I -) restrict(amp,cpu); - -index( - int _I0, - int _I1 -) restrict(amp,cpu); - -index( - int _I0, - int _I1, - int _I2 -) restrict(amp,cpu); - -explicit index( - const int _Array[_Rank] -) restrict(amp,cpu); -``` - -### Parameters - -*_Array*
-A one-dimensional array with the rank values. - -*_I*
-The index location in a one-dimensional index. - -*_I0*
-The length of the most significant dimension. - -*_I1*
-The length of the next-to-most-significant dimension. - -*_I2*
-The length of the least significant dimension. - -*_Other*
-An index object on which the new index object is based. - -## operator-- - -Decrements each element of the index object. - -```cpp -index<_Rank>& operator--() restrict(amp,cpu); - -index operator--( - int -) restrict(amp,cpu); -``` - -### Return values - -For the prefix operator, the index object (`*this`). For the suffix operator, a new index object. - -## operator%= - -Calculates the modulus (remainder) of each element in the index object when that element is divided by the specified number. - -```cpp -index<_Rank>& operator%=( - int _Rhs -) restrict(cpu, amp); -``` - -### Parameters - -*_Rhs*
-The number to divide by to find the modulus. - -## Return Value - -The index object. - -## operator*= - -Multiplies each element in the index object by the specified number. - -```cpp -index<_Rank>& operator*=( - int _Rhs -) restrict(amp,cpu); -``` - -### Parameters - -*_Rhs*
-The number to multiply. - -## operator/= - -Divides each element in the index object by the specified number. - -```cpp -index<_Rank>& operator/=( - int _Rhs -) restrict(amp,cpu); -``` - -### Parameters - -*_Rhs*
-The number to divide by. - -## operator\[\] - -Returns the component of the index at the specified location. - -```cpp -int operator[] ( - unsigned _Index -) const restrict(amp,cpu); - -int& operator[] ( - unsigned _Index -) restrict(amp,cpu); -``` - -### Parameters - -*_Index*
-An integer from 0 through the rank minus 1. - -### Return Value - -The element that's at the specified index. - -### Remarks - -This following example displays the component values of the index. - -```cpp -// Prints 1 2 3. -concurrency::index<3> idx(1, 2, 3); -std::cout << idx[0] << "\n"; -std::cout << idx[1] << "\n"; -std::cout << idx[2] << "\n"; -``` - -## operator++ - -Increments each element of the index object. - -```cpp -index<_Rank>& operator++() restrict(amp,cpu); - -index<_Rank> operator++( - int -) restrict(amp,cpu); -``` - -### Return Value - -For the prefix operator, the index object (`*this`). For the suffix operator, a new index object. - -## operator+= - -Adds the specified number to each element of the index object. - -```cpp -index<_Rank>& operator+=( - const index<_Rank>& _Rhs -) restrict(amp,cpu); - -index<_Rank>& operator+=( - int _Rhs -) restrict(amp,cpu); -``` - -### Parameters - -*_Rhs*
-The number to add. - -### Return Value - -The index object. - -## operator= - -Copies the contents of the specified index object into this one. - -```cpp -index<_Rank>& operator=( - const index<_Rank>& _Other -) restrict(amp,cpu); -``` - -### Parameters - -*_Other*
-The index object to copy from. - -### Return Value - -A reference to this index object. - -## operator-= - -Subtracts the specified number from each element of the index object. - -```cpp -index<_Rank>& operator-=( - const index<_Rank>& _Rhs -) restrict(amp,cpu); - -index<_Rank>& operator-=( - int _Rhs -) restrict(amp,cpu); -``` - -### Parameters - -*_Rhs*
-The number to subtract. - -### Return Value - -The index object. - -## Rank - -Gets the rank of the index object. - -```cpp -static const int rank = _Rank; -``` - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/int-2-class.md b/docs/parallel/amp/reference/int-2-class.md deleted file mode 100644 index 6b5e99b2225..00000000000 --- a/docs/parallel/amp/reference/int-2-class.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -description: "Learn more about: int_2 Class" -title: "int_2 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::int_2::y", "amp_short_vectors/Concurrency::graphics::int_2::set_x", "amp_short_vectors/Concurrency::graphics::int_2::set_y", "amp_short_vectors/Concurrency::graphics::int_2::get_yx", "amp_short_vectors/Concurrency::graphics::int_2::operator++", "amp_short_vectors/Concurrency::graphics::int_2::x", "amp_short_vectors/Concurrency::graphics::int_2::set_yx", "amp_short_vectors/Concurrency::graphics::int_2::operator/=", "amp_short_vectors/Concurrency::graphics::int_2::get_y", "amp_short_vectors/Concurrency::graphics::int_2::gr", "amp_short_vectors/Concurrency::graphics::int_2::operator*=", "amp_short_vectors/Concurrency::graphics::int_2::r", "amp_short_vectors/Concurrency::graphics::int_2::get_xy", "amp_short_vectors/Concurrency::graphics::int_2::operator=", "amp_short_vectors/Concurrency::graphics::int_2::g", "amp_short_vectors/Concurrency::graphics::int_2::rg", "amp_short_vectors/Concurrency::graphics::int_2::xy", "amp_short_vectors/Concurrency::graphics::int_2::operator-=", "amp_short_vectors/Concurrency::graphics::int_2::get_x", "amp_short_vectors/Concurrency::graphics::int_2::yx", "amp_short_vectors/Concurrency::graphics::int_2", "amp_short_vectors/Concurrency::graphics::int_2::operator-", "amp_short_vectors/Concurrency::graphics::int_2::set_xy", "amp_short_vectors/Concurrency::graphics::int_2::operator+=", "amp_short_vectors/Concurrency::graphics::int_2::operator--"] -ms.assetid: 258b02e9-f1ee-46c2-8edd-dc9f69184846 ---- -# int_2 Class - -Represents a short vector of two integers. - -## Syntax - -```cpp -class int_2; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[int_2 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|int_2::get_x|| -|int_2::get_xy|| -|int_2::get_y|| -|int_2::get_yx|| -|int_2::ref_g|| -|int_2::ref_r|| -|int_2::ref_x|| -|int_2::ref_y|| -|int_2::set_x|| -|int_2::set_xy|| -|int_2::set_y|| -|int_2::set_yx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|int_2::operator-|| -|int_2::operator--|| -|int_2::operator%=|| -|int_2::operator&=|| -|int_2::operator*=|| -|int_2::operator/=|| -|int_2::operator^=|| -|int_2::operator\|=|| -|int_2::operator~|| -|int_2::operator++|| -|int_2::operator+=|| -|int_2::operator<\<=|| -|int_2::operator=|| -|int_2::operator-=|| -|int_2::operator>>=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#int_2__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|int_2::g|| -|int_2::gr|| -|int_2::r|| -|int_2::rg|| -|int_2::x|| -|int_2::xy|| -|int_2::y|| -|int_2::yx|| - -## Inheritance Hierarchy - -`int_2` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## int_2 - -Default constructor, initializes all elements with 0. - -```cpp -int_2() restrict(amp, - cpu); - -int_2( - int _V0, - int _V1) restrict(amp, - cpu); - -int_2( - int _V) restrict(amp, - cpu); - -int_2( - const int_2& _Other) restrict(amp, - cpu); - -explicit inline int_2( - const uint_2& _Other) restrict(amp, - cpu); - -explicit inline int_2( - const float_2& _Other) restrict(amp, - cpu); - -explicit inline int_2( - const unorm_2& _Other) restrict(amp, - cpu); - -explicit inline int_2( - const norm_2& _Other) restrict(amp, - cpu); - -explicit inline int_2( - const double_2& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 2; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/int-3-class.md b/docs/parallel/amp/reference/int-3-class.md deleted file mode 100644 index 460a6983ff9..00000000000 --- a/docs/parallel/amp/reference/int-3-class.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -description: "Learn more about: int_3 Class" -title: "int_3 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::int_3::get_x", "amp_short_vectors/Concurrency::graphics::int_3::operator-=", "amp_short_vectors/Concurrency::graphics::int_3::get_y", "amp_short_vectors/Concurrency::graphics::int_3::operator=", "amp_short_vectors/Concurrency::graphics::int_3::operator++", "amp_short_vectors/Concurrency::graphics::int_3::zyx", "amp_short_vectors/Concurrency::graphics::int_3::get_z", "amp_short_vectors/Concurrency::graphics::int_3::operator*=", "amp_short_vectors/Concurrency::graphics::int_3::grb", "amp_short_vectors/Concurrency::graphics::int_3::get_xz", "amp_short_vectors/Concurrency::graphics::int_3::br", "amp_short_vectors/Concurrency::graphics::int_3::operator--", "amp_short_vectors/Concurrency::graphics::int_3", "amp_short_vectors/Concurrency::graphics::int_3::set_yx", "amp_short_vectors/Concurrency::graphics::int_3::x", "amp_short_vectors/Concurrency::graphics::int_3::yxz", "amp_short_vectors/Concurrency::graphics::int_3::set_y", "amp_short_vectors/Concurrency::graphics::int_3::zy", "amp_short_vectors/Concurrency::graphics::int_3::z", "amp_short_vectors/Concurrency::graphics::int_3::get_zx", "amp_short_vectors/Concurrency::graphics::int_3::rb", "amp_short_vectors/Concurrency::graphics::int_3::yzx", "amp_short_vectors/Concurrency::graphics::int_3::gb", "amp_short_vectors/Concurrency::graphics::int_3::set_zxy", "amp_short_vectors/Concurrency::graphics::int_3::xy", "amp_short_vectors/Concurrency::graphics::int_3::set_zx", "amp_short_vectors/Concurrency::graphics::int_3::g", "amp_short_vectors/Concurrency::graphics::int_3::operator/=", "amp_short_vectors/Concurrency::graphics::int_3::get_zy", "amp_short_vectors/Concurrency::graphics::int_3::yx", "amp_short_vectors/Concurrency::graphics::int_3::xzy", "amp_short_vectors/Concurrency::graphics::int_3::set_x", "amp_short_vectors/Concurrency::graphics::int_3::set_xz", "amp_short_vectors/Concurrency::graphics::int_3::get_yzx", "amp_short_vectors/Concurrency::graphics::int_3::b", "amp_short_vectors/Concurrency::graphics::int_3::gbr", "amp_short_vectors/Concurrency::graphics::int_3::operator+=", "amp_short_vectors/Concurrency::graphics::int_3::gr", "amp_short_vectors/Concurrency::graphics::int_3::brg", "amp_short_vectors/Concurrency::graphics::int_3::bg", "amp_short_vectors/Concurrency::graphics::int_3::zx", "amp_short_vectors/Concurrency::graphics::int_3::get_xyz", "amp_short_vectors/Concurrency::graphics::int_3::set_zyx", "amp_short_vectors/Concurrency::graphics::int_3::set_yzx", "amp_short_vectors/Concurrency::graphics::int_3::y", "amp_short_vectors/Concurrency::graphics::int_3::set_z", "amp_short_vectors/Concurrency::graphics::int_3::r", "amp_short_vectors/Concurrency::graphics::int_3::set_xzy", "amp_short_vectors/Concurrency::graphics::int_3::rg", "amp_short_vectors/Concurrency::graphics::int_3::xyz", "amp_short_vectors/Concurrency::graphics::int_3::get_yz", "amp_short_vectors/Concurrency::graphics::int_3::operator-", "amp_short_vectors/Concurrency::graphics::int_3::set_xy", "amp_short_vectors/Concurrency::graphics::int_3::zxy", "amp_short_vectors/Concurrency::graphics::int_3::yz", "amp_short_vectors/Concurrency::graphics::int_3::set_zy", "amp_short_vectors/Concurrency::graphics::int_3::bgr", "amp_short_vectors/Concurrency::graphics::int_3::get_xzy", "amp_short_vectors/Concurrency::graphics::int_3::get_yx", "amp_short_vectors/Concurrency::graphics::int_3::rbg", "amp_short_vectors/Concurrency::graphics::int_3::get_zxy", "amp_short_vectors/Concurrency::graphics::int_3::set_yxz", "amp_short_vectors/Concurrency::graphics::int_3::rgb", "amp_short_vectors/Concurrency::graphics::int_3::get_xy", "amp_short_vectors/Concurrency::graphics::int_3::set_xyz", "amp_short_vectors/Concurrency::graphics::int_3::get_yxz", "amp_short_vectors/Concurrency::graphics::int_3::get_zyx", "amp_short_vectors/Concurrency::graphics::int_3::xz", "amp_short_vectors/Concurrency::graphics::int_3::set_yz"] -ms.assetid: d4af182f-30f1-455c-b16d-aa99cd314038 ---- -# int_3 Class - -Represents a short vector of three integers. - -## Syntax - -```cpp -class int_3; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[int_3 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|int_3::get_x|| -|int_3::get_xy|| -|int_3::get_xyz|| -|int_3::get_xz|| -|int_3::get_xzy|| -|int_3::get_y|| -|int_3::get_yx|| -|int_3::get_yxz|| -|int_3::get_yz|| -|int_3::get_yzx|| -|int_3::get_z|| -|int_3::get_zx|| -|int_3::get_zxy|| -|int_3::get_zy|| -|int_3::get_zyx|| -|int_3::ref_b|| -|int_3::ref_g|| -|int_3::ref_r|| -|int_3::ref_x|| -|int_3::ref_y|| -|int_3::ref_z|| -|int_3::set_x|| -|int_3::set_xy|| -|int_3::set_xyz|| -|int_3::set_xz|| -|int_3::set_xzy|| -|int_3::set_y|| -|int_3::set_yx|| -|int_3::set_yxz|| -|int_3::set_yz|| -|int_3::set_yzx|| -|int_3::set_z|| -|int_3::set_zx|| -|int_3::set_zxy|| -|int_3::set_zy|| -|int_3::set_zyx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|int_3::operator-|| -|int_3::operator--|| -|int_3::operator%=|| -|int_3::operator&=|| -|int_3::operator*=|| -|int_3::operator/=|| -|int_3::operator^=|| -|int_3::operator\|=|| -|int_3::operator~|| -|int_3::operator++|| -|int_3::operator+=|| -|int_3::operator<\<=|| -|int_3::operator=|| -|int_3::operator-=|| -|int_3::operator>>=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|int_3::b|| -|int_3::bg|| -|int_3::bgr|| -|int_3::br|| -|int_3::brg|| -|int_3::g|| -|int_3::gb|| -|int_3::gbr|| -|int_3::gr|| -|int_3::grb|| -|int_3::r|| -|int_3::rb|| -|int_3::rbg|| -|int_3::rg|| -|int_3::rgb|| -|int_3::x|| -|int_3::xy|| -|int_3::xyz|| -|int_3::xz|| -|int_3::xzy|| -|int_3::y|| -|int_3::yx|| -|int_3::yxz|| -|int_3::yz|| -|int_3::yzx|| -|int_3::z|| -|int_3::zx|| -|int_3::zxy|| -|int_3::zy|| -|int_3::zyx|| - -## Inheritance Hierarchy - -`int_3` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## int_3 - -Default constructor, initializes all elements with 0. - -### Syntax - -```cpp -int_3() restrict(amp,cpu); -int_3( - int _V0, - int _V1, - int _V2 -) restrict(amp,cpu); -int_3( - int _V -) restrict(amp,cpu); -int_3( - const int_3& _Other -) restrict(amp,cpu); -explicit inline int_3( - const uint_3& _Other -) restrict(amp,cpu); -explicit inline int_3( - const float_3& _Other -) restrict(amp,cpu); -explicit inline int_3( - const unorm_3& _Other -) restrict(amp,cpu); -explicit inline int_3( - const norm_3& _Other -) restrict(amp,cpu); -explicit inline int_3( - const double_3& _Other -) restrict(amp,cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -### Syntax - -```cpp -static const int size = 3; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/int-4-class.md b/docs/parallel/amp/reference/int-4-class.md deleted file mode 100644 index ad9e159065f..00000000000 --- a/docs/parallel/amp/reference/int-4-class.md +++ /dev/null @@ -1,414 +0,0 @@ ---- -description: "Learn more about: int_4 Class" -title: "int_4 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::int_4::get_ywxz", "amp_short_vectors/Concurrency::graphics::int_4::xzyw", "amp_short_vectors/Concurrency::graphics::int_4::get_x", "amp_short_vectors/Concurrency::graphics::int_4::agr", "amp_short_vectors/Concurrency::graphics::int_4::set_ywxz", "amp_short_vectors/Concurrency::graphics::int_4::set_yzxw", "amp_short_vectors/Concurrency::graphics::int_4::get_zyw", "amp_short_vectors/Concurrency::graphics::int_4::set_zwyx", "amp_short_vectors/Concurrency::graphics::int_4::abgr", "amp_short_vectors/Concurrency::graphics::int_4::get_wzxy", "amp_short_vectors/Concurrency::graphics::int_4::get_wyxz", "amp_short_vectors/Concurrency::graphics::int_4::zyxw", "amp_short_vectors/Concurrency::graphics::int_4::rgb", "amp_short_vectors/Concurrency::graphics::int_4::wyxz", "amp_short_vectors/Concurrency::graphics::int_4::get_xwz", "amp_short_vectors/Concurrency::graphics::int_4::set_wyz", "amp_short_vectors/Concurrency::graphics::int_4::set_xz", "amp_short_vectors/Concurrency::graphics::int_4::gabr", "amp_short_vectors/Concurrency::graphics::int_4::gbr", "amp_short_vectors/Concurrency::graphics::int_4::set_wx", "amp_short_vectors/Concurrency::graphics::int_4::yxw", "amp_short_vectors/Concurrency::graphics::int_4::get_ywx", "amp_short_vectors/Concurrency::graphics::int_4::set_wxzy", "amp_short_vectors/Concurrency::graphics::int_4::get_yzx", "amp_short_vectors/Concurrency::graphics::int_4::yz", "amp_short_vectors/Concurrency::graphics::int_4::rg", "amp_short_vectors/Concurrency::graphics::int_4::rba", "amp_short_vectors/Concurrency::graphics::int_4::operator/=", "amp_short_vectors/Concurrency::graphics::int_4::get_wxy", "amp_short_vectors/Concurrency::graphics::int_4::set_yx", "amp_short_vectors/Concurrency::graphics::int_4::get_ywz", "amp_short_vectors/Concurrency::graphics::int_4::abg", "amp_short_vectors/Concurrency::graphics::int_4::get_y", "amp_short_vectors/Concurrency::graphics::int_4::ra", "amp_short_vectors/Concurrency::graphics::int_4::wxzy", "amp_short_vectors/Concurrency::graphics::int_4::rabg", "amp_short_vectors/Concurrency::graphics::int_4::ag", "amp_short_vectors/Concurrency::graphics::int_4::xwyz", "amp_short_vectors/Concurrency::graphics::int_4::zxy", "amp_short_vectors/Concurrency::graphics::int_4::x", "amp_short_vectors/Concurrency::graphics::int_4::bag", "amp_short_vectors/Concurrency::graphics::int_4::grb", "amp_short_vectors/Concurrency::graphics::int_4::xwz", "amp_short_vectors/Concurrency::graphics::int_4::get_wzx", "amp_short_vectors/Concurrency::graphics::int_4::operator*=", "amp_short_vectors/Concurrency::graphics::int_4::r", "amp_short_vectors/Concurrency::graphics::int_4::get_xzwy", "amp_short_vectors/Concurrency::graphics::int_4::bgra", "amp_short_vectors/Concurrency::graphics::int_4::xyzw", "amp_short_vectors/Concurrency::graphics::int_4::ab", "amp_short_vectors/Concurrency::graphics::int_4::set_xwyz", "amp_short_vectors/Concurrency::graphics::int_4::brg", "amp_short_vectors/Concurrency::graphics::int_4::garb", "amp_short_vectors/Concurrency::graphics::int_4::set_xzw", "amp_short_vectors/Concurrency::graphics::int_4::set_ywz", "amp_short_vectors/Concurrency::graphics::int_4::xywz", "amp_short_vectors/Concurrency::graphics::int_4::get_w", "amp_short_vectors/Concurrency::graphics::int_4::wzy", "amp_short_vectors/Concurrency::graphics::int_4::zwy", "amp_short_vectors/Concurrency::graphics::int_4::arb", "amp_short_vectors/Concurrency::graphics::int_4::agbr", "amp_short_vectors/Concurrency::graphics::int_4::get_yw", "amp_short_vectors/Concurrency::graphics::int_4::gra", "amp_short_vectors/Concurrency::graphics::int_4::get_yx", "amp_short_vectors/Concurrency::graphics::int_4::get_zyx", "amp_short_vectors/Concurrency::graphics::int_4::rag", "amp_short_vectors/Concurrency::graphics::int_4::b", "amp_short_vectors/Concurrency::graphics::int_4::rbag", "amp_short_vectors/Concurrency::graphics::int_4::set_zyw", "amp_short_vectors/Concurrency::graphics::int_4::grab", "amp_short_vectors/Concurrency::graphics::int_4::xzy", "amp_short_vectors/Concurrency::graphics::int_4::get_xwzy", "amp_short_vectors/Concurrency::graphics::int_4::wxy", "amp_short_vectors/Concurrency::graphics::int_4::abr", "amp_short_vectors/Concurrency::graphics::int_4::yw", "amp_short_vectors/Concurrency::graphics::int_4::set_zxyw", "amp_short_vectors/Concurrency::graphics::int_4::get_xyzw", "amp_short_vectors/Concurrency::graphics::int_4::set_wxz", "amp_short_vectors/Concurrency::graphics::int_4::get_yxwz", "amp_short_vectors/Concurrency::graphics::int_4::bar", "amp_short_vectors/Concurrency::graphics::int_4::zwxy", "amp_short_vectors/Concurrency::graphics::int_4::operator+=", "amp_short_vectors/Concurrency::graphics::int_4::get_zwy", "amp_short_vectors/Concurrency::graphics::int_4::get_xwyz", "amp_short_vectors/Concurrency::graphics::int_4::zxwy", "amp_short_vectors/Concurrency::graphics::int_4::barg", "amp_short_vectors/Concurrency::graphics::int_4::set_yxwz", "amp_short_vectors/Concurrency::graphics::int_4::operator=", "amp_short_vectors/Concurrency::graphics::int_4::get_xz", "amp_short_vectors/Concurrency::graphics::int_4::wz", "amp_short_vectors/Concurrency::graphics::int_4::w", "amp_short_vectors/Concurrency::graphics::int_4::set_zwy", "amp_short_vectors/Concurrency::graphics::int_4::yzx", "amp_short_vectors/Concurrency::graphics::int_4::set_xwzy", "amp_short_vectors/Concurrency::graphics::int_4::set_wzxy", "amp_short_vectors/Concurrency::graphics::int_4::get_yxz", "amp_short_vectors/Concurrency::graphics::int_4::set_ywx", "amp_short_vectors/Concurrency::graphics::int_4::get_zyxw", "amp_short_vectors/Concurrency::graphics::int_4::ragb", "amp_short_vectors/Concurrency::graphics::int_4::xzwy", "amp_short_vectors/Concurrency::graphics::int_4::get_wx", "amp_short_vectors/Concurrency::graphics::int_4::arbg", "amp_short_vectors/Concurrency::graphics::int_4::set_zxw", "amp_short_vectors/Concurrency::graphics::int_4::get_wyx", "amp_short_vectors/Concurrency::graphics::int_4::gab", "amp_short_vectors/Concurrency::graphics::int_4::agrb", "amp_short_vectors/Concurrency::graphics::int_4::bagr", "amp_short_vectors/Concurrency::graphics::int_4::get_wzyx", "amp_short_vectors/Concurrency::graphics::int_4::operator-=", "amp_short_vectors/Concurrency::graphics::int_4::get_wxz", "amp_short_vectors/Concurrency::graphics::int_4::get_xzw", "amp_short_vectors/Concurrency::graphics::int_4::gar", "amp_short_vectors/Concurrency::graphics::int_4::zw", "amp_short_vectors/Concurrency::graphics::int_4::yxzw", "amp_short_vectors/Concurrency::graphics::int_4::get_yxw", "amp_short_vectors/Concurrency::graphics::int_4::get_yxzw", "amp_short_vectors/Concurrency::graphics::int_4::operator++", "amp_short_vectors/Concurrency::graphics::int_4::xzw", "amp_short_vectors/Concurrency::graphics::int_4::arg", "amp_short_vectors/Concurrency::graphics::int_4::get_zwyx", "amp_short_vectors/Concurrency::graphics::int_4::g", "amp_short_vectors/Concurrency::graphics::int_4::set_zywx", "amp_short_vectors/Concurrency::graphics::int_4::z", "amp_short_vectors/Concurrency::graphics::int_4::get_z", "amp_short_vectors/Concurrency::graphics::int_4::get_zwxy", "amp_short_vectors/Concurrency::graphics::int_4::set_zyx", "amp_short_vectors/Concurrency::graphics::int_4", "amp_short_vectors/Concurrency::graphics::int_4::set_wy", "amp_short_vectors/Concurrency::graphics::int_4::bgr", "amp_short_vectors/Concurrency::graphics::int_4::xwy", "amp_short_vectors/Concurrency::graphics::int_4::xz", "amp_short_vectors/Concurrency::graphics::int_4::get_zwx", "amp_short_vectors/Concurrency::graphics::int_4::set_z", "amp_short_vectors/Concurrency::graphics::int_4::ywz", "amp_short_vectors/Concurrency::graphics::int_4::set_yz", "amp_short_vectors/Concurrency::graphics::int_4::wyx", "amp_short_vectors/Concurrency::graphics::int_4::get_yzwx", "amp_short_vectors/Concurrency::graphics::int_4::grba", "amp_short_vectors/Concurrency::graphics::int_4::bra", "amp_short_vectors/Concurrency::graphics::int_4::set_zxy", "amp_short_vectors/Concurrency::graphics::int_4::set_xzyw", "amp_short_vectors/Concurrency::graphics::int_4::get_zx", "amp_short_vectors/Concurrency::graphics::int_4::xyz", "amp_short_vectors/Concurrency::graphics::int_4::operator--", "amp_short_vectors/Concurrency::graphics::int_4::y", "amp_short_vectors/Concurrency::graphics::int_4::yzwx", "amp_short_vectors/Concurrency::graphics::int_4::agb", "amp_short_vectors/Concurrency::graphics::int_4::set_wyxz", "amp_short_vectors/Concurrency::graphics::int_4::set_xyzw", "amp_short_vectors/Concurrency::graphics::int_4::wzyx", "amp_short_vectors/Concurrency::graphics::int_4::rgab", "amp_short_vectors/Concurrency::graphics::int_4::set_wzy", "amp_short_vectors/Concurrency::graphics::int_4::set_wxyz", "amp_short_vectors/Concurrency::graphics::int_4::set_wyzx", "amp_short_vectors/Concurrency::graphics::int_4::wyzx", "amp_short_vectors/Concurrency::graphics::int_4::set_ywzx", "amp_short_vectors/Concurrency::graphics::int_4::zyw", "amp_short_vectors/Concurrency::graphics::int_4::get_xyw", "amp_short_vectors/Concurrency::graphics::int_4::ywxz", "amp_short_vectors/Concurrency::graphics::int_4::brag", "amp_short_vectors/Concurrency::graphics::int_4::get_yzw", "amp_short_vectors/Concurrency::graphics::int_4::get_xzy", "amp_short_vectors/Concurrency::graphics::int_4::get_xw", "amp_short_vectors/Concurrency::graphics::int_4::xw", "amp_short_vectors/Concurrency::graphics::int_4::gbra", "amp_short_vectors/Concurrency::graphics::int_4::set_wxy", "amp_short_vectors/Concurrency::graphics::int_4::get_xyz", "amp_short_vectors/Concurrency::graphics::int_4::get_zxyw", "amp_short_vectors/Concurrency::graphics::int_4::zwx", "amp_short_vectors/Concurrency::graphics::int_4::get_xzyw", "amp_short_vectors/Concurrency::graphics::int_4::set_xzwy", "amp_short_vectors/Concurrency::graphics::int_4::set_yxw", "amp_short_vectors/Concurrency::graphics::int_4::get_xy", "amp_short_vectors/Concurrency::graphics::int_4::get_wz", "amp_short_vectors/Concurrency::graphics::int_4::set_yw", "amp_short_vectors/Concurrency::graphics::int_4::rbga", "amp_short_vectors/Concurrency::graphics::int_4::ywzx", "amp_short_vectors/Concurrency::graphics::int_4::get_wxyz", "amp_short_vectors/Concurrency::graphics::int_4::ba", "amp_short_vectors/Concurrency::graphics::int_4::gba", "amp_short_vectors/Concurrency::graphics::int_4::set_zw", "amp_short_vectors/Concurrency::graphics::int_4::set_x", "amp_short_vectors/Concurrency::graphics::int_4::set_xwy", "amp_short_vectors/Concurrency::graphics::int_4::get_zxy", "amp_short_vectors/Concurrency::graphics::int_4::set_xwz", "amp_short_vectors/Concurrency::graphics::int_4::wyz", "amp_short_vectors/Concurrency::graphics::int_4::set_y", "amp_short_vectors/Concurrency::graphics::int_4::get_wyzx", "amp_short_vectors/Concurrency::graphics::int_4::set_zyxw", "amp_short_vectors/Concurrency::graphics::int_4::rgba", "amp_short_vectors/Concurrency::graphics::int_4::gr", "amp_short_vectors/Concurrency::graphics::int_4::set_yzx", "amp_short_vectors/Concurrency::graphics::int_4::set_xyz", "amp_short_vectors/Concurrency::graphics::int_4::get_xwy", "amp_short_vectors/Concurrency::graphics::int_4::get_wxzy", "amp_short_vectors/Concurrency::graphics::int_4::set_xzy", "amp_short_vectors/Concurrency::graphics::int_4::set_xy", "amp_short_vectors/Concurrency::graphics::int_4::rbg", "amp_short_vectors/Concurrency::graphics::int_4::br", "amp_short_vectors/Concurrency::graphics::int_4::get_yzxw", "amp_short_vectors/Concurrency::graphics::int_4::rab", "amp_short_vectors/Concurrency::graphics::int_4::set_xw", "amp_short_vectors/Concurrency::graphics::int_4::ga", "amp_short_vectors/Concurrency::graphics::int_4::wxyz", "amp_short_vectors/Concurrency::graphics::int_4::set_wzyx", "amp_short_vectors/Concurrency::graphics::int_4::zywx", "amp_short_vectors/Concurrency::graphics::int_4::xyw", "amp_short_vectors/Concurrency::graphics::int_4::bgar", "amp_short_vectors/Concurrency::graphics::int_4::xy", "amp_short_vectors/Concurrency::graphics::int_4::zxw", "amp_short_vectors/Concurrency::graphics::int_4::get_xywz", "amp_short_vectors/Concurrency::graphics::int_4::wy", "amp_short_vectors/Concurrency::graphics::int_4::zyx", "amp_short_vectors/Concurrency::graphics::int_4::get_zw", "amp_short_vectors/Concurrency::graphics::int_4::bga", "amp_short_vectors/Concurrency::graphics::int_4::set_zx", "amp_short_vectors/Concurrency::graphics::int_4::get_zywx", "amp_short_vectors/Concurrency::graphics::int_4::yzw", "amp_short_vectors/Concurrency::graphics::int_4::set_yzw", "amp_short_vectors/Concurrency::graphics::int_4::rb", "amp_short_vectors/Concurrency::graphics::int_4::set_w", "amp_short_vectors/Concurrency::graphics::int_4::get_wy", "amp_short_vectors/Concurrency::graphics::int_4::yzxw", "amp_short_vectors/Concurrency::graphics::int_4::wzx", "amp_short_vectors/Concurrency::graphics::int_4::zxyw", "amp_short_vectors/Concurrency::graphics::int_4::set_zwxy", "amp_short_vectors/Concurrency::graphics::int_4::get_wzy", "amp_short_vectors/Concurrency::graphics::int_4::zwyx", "amp_short_vectors/Concurrency::graphics::int_4::set_xywz", "amp_short_vectors/Concurrency::graphics::int_4::set_zxwy", "amp_short_vectors/Concurrency::graphics::int_4::set_zy", "amp_short_vectors/Concurrency::graphics::int_4::yx", "amp_short_vectors/Concurrency::graphics::int_4::set_yxzw", "amp_short_vectors/Concurrency::graphics::int_4::ar", "amp_short_vectors/Concurrency::graphics::int_4::yxwz", "amp_short_vectors/Concurrency::graphics::int_4::get_zxwy", "amp_short_vectors/Concurrency::graphics::int_4::rga", "amp_short_vectors/Concurrency::graphics::int_4::zy", "amp_short_vectors/Concurrency::graphics::int_4::operator-", "amp_short_vectors/Concurrency::graphics::int_4::xwzy", "amp_short_vectors/Concurrency::graphics::int_4::wxz", "amp_short_vectors/Concurrency::graphics::int_4::set_wzx", "amp_short_vectors/Concurrency::graphics::int_4::gb", "amp_short_vectors/Concurrency::graphics::int_4::get_yz", "amp_short_vectors/Concurrency::graphics::int_4::set_yzwx", "amp_short_vectors/Concurrency::graphics::int_4::get_wyz", "amp_short_vectors/Concurrency::graphics::int_4::set_wyx", "amp_short_vectors/Concurrency::graphics::int_4::get_zy", "amp_short_vectors/Concurrency::graphics::int_4::zx", "amp_short_vectors/Concurrency::graphics::int_4::set_xyw", "amp_short_vectors/Concurrency::graphics::int_4::wx", "amp_short_vectors/Concurrency::graphics::int_4::get_zxw", "amp_short_vectors/Concurrency::graphics::int_4::brga", "amp_short_vectors/Concurrency::graphics::int_4::set_zwx", "amp_short_vectors/Concurrency::graphics::int_4::a", "amp_short_vectors/Concurrency::graphics::int_4::ywx", "amp_short_vectors/Concurrency::graphics::int_4::wzxy", "amp_short_vectors/Concurrency::graphics::int_4::argb", "amp_short_vectors/Concurrency::graphics::int_4::set_wz", "amp_short_vectors/Concurrency::graphics::int_4::gbar", "amp_short_vectors/Concurrency::graphics::int_4::set_yxz", "amp_short_vectors/Concurrency::graphics::int_4::get_ywzx", "amp_short_vectors/Concurrency::graphics::int_4::abrg", "amp_short_vectors/Concurrency::graphics::int_4::bg", "amp_short_vectors/Concurrency::graphics::int_4::yxz"] -ms.assetid: 01768c28-23a8-4965-8267-96834864f4eb ---- -# int_4 Class - -Represents a short vector of four integers. - -## Syntax - -```cpp -class int_4; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[int_4 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|int_4::get_w|| -|int_4::get_wx|| -|int_4::get_wxy|| -|int_4::get_wxyz|| -|int_4::get_wxz|| -|int_4::get_wxzy|| -|int_4::get_wy|| -|int_4::get_wyx|| -|int_4::get_wyxz|| -|int_4::get_wyz|| -|int_4::get_wyzx|| -|int_4::get_wz|| -|int_4::get_wzx|| -|int_4::get_wzxy|| -|int_4::get_wzy|| -|int_4::get_wzyx|| -|int_4::get_x|| -|int_4::get_xw|| -|int_4::get_xwy|| -|int_4::get_xwyz|| -|int_4::get_xwz|| -|int_4::get_xwzy|| -|int_4::get_xy|| -|int_4::get_xyw|| -|int_4::get_xywz|| -|int_4::get_xyz|| -|int_4::get_xyzw|| -|int_4::get_xz|| -|int_4::get_xzw|| -|int_4::get_xzwy|| -|int_4::get_xzy|| -|int_4::get_xzyw|| -|int_4::get_y|| -|int_4::get_yw|| -|int_4::get_ywx|| -|int_4::get_ywxz|| -|int_4::get_ywz|| -|int_4::get_ywzx|| -|int_4::get_yx|| -|int_4::get_yxw|| -|int_4::get_yxwz|| -|int_4::get_yxz|| -|int_4::get_yxzw|| -|int_4::get_yz|| -|int_4::get_yzw|| -|int_4::get_yzwx|| -|int_4::get_yzx|| -|int_4::get_yzxw|| -|int_4::get_z|| -|int_4::get_zw|| -|int_4::get_zwx|| -|int_4::get_zwxy|| -|int_4::get_zwy|| -|int_4::get_zwyx|| -|int_4::get_zx|| -|int_4::get_zxw|| -|int_4::get_zxwy|| -|int_4::get_zxy|| -|int_4::get_zxyw|| -|int_4::get_zy|| -|int_4::get_zyw|| -|int_4::get_zywx|| -|int_4::get_zyx|| -|int_4::get_zyxw|| -|int_4::ref_a|| -|int_4::ref_b|| -|int_4::ref_g|| -|int_4::ref_r|| -|int_4::ref_w|| -|int_4::ref_x|| -|int_4::ref_y|| -|int_4::ref_z|| -|int_4::set_w|| -|int_4::set_wx|| -|int_4::set_wxy|| -|int_4::set_wxyz|| -|int_4::set_wxz|| -|int_4::set_wxzy|| -|int_4::set_wy|| -|int_4::set_wyx|| -|int_4::set_wyxz|| -|int_4::set_wyz|| -|int_4::set_wyzx|| -|int_4::set_wz|| -|int_4::set_wzx|| -|int_4::set_wzxy|| -|int_4::set_wzy|| -|int_4::set_wzyx|| -|int_4::set_x|| -|int_4::set_xw|| -|int_4::set_xwy|| -|int_4::set_xwyz|| -|int_4::set_xwz|| -|int_4::set_xwzy|| -|int_4::set_xy|| -|int_4::set_xyw|| -|int_4::set_xywz|| -|int_4::set_xyz|| -|int_4::set_xyzw|| -|int_4::set_xz|| -|int_4::set_xzw|| -|int_4::set_xzwy|| -|int_4::set_xzy|| -|int_4::set_xzyw|| -|int_4::set_y|| -|int_4::set_yw|| -|int_4::set_ywx|| -|int_4::set_ywxz|| -|int_4::set_ywz|| -|int_4::set_ywzx|| -|int_4::set_yx|| -|int_4::set_yxw|| -|int_4::set_yxwz|| -|int_4::set_yxz|| -|int_4::set_yxzw|| -|int_4::set_yz|| -|int_4::set_yzw|| -|int_4::set_yzwx|| -|int_4::set_yzx|| -|int_4::set_yzxw|| -|int_4::set_z|| -|int_4::set_zw|| -|int_4::set_zwx|| -|int_4::set_zwxy|| -|int_4::set_zwy|| -|int_4::set_zwyx|| -|int_4::set_zx|| -|int_4::set_zxw|| -|int_4::set_zxwy|| -|int_4::set_zxy|| -|int_4::set_zxyw|| -|int_4::set_zy|| -|int_4::set_zyw|| -|int_4::set_zywx|| -|int_4::set_zyx|| -|int_4::set_zyxw|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|int_4::operator-|| -|int_4::operator--|| -|int_4::operator%=|| -|int_4::operator&=|| -|int_4::operator*=|| -|int_4::operator/=|| -|int_4::operator^=|| -|int_4::operator\|=|| -|int_4::operator~|| -|int_4::operator++|| -|int_4::operator+=|| -|int_4::operator<\<=|| -|int_4::operator=|| -|int_4::operator-=|| -|int_4::operator>>=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#int_4__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|int_4::a|| -|int_4::ab|| -|int_4::abg|| -|int_4::abgr|| -|int_4::abr|| -|int_4::abrg|| -|int_4::ag|| -|int_4::agb|| -|int_4::agbr|| -|int_4::agr|| -|int_4::agrb|| -|int_4::ar|| -|int_4::arb|| -|int_4::arbg|| -|int_4::arg|| -|int_4::argb|| -|int_4::b|| -|int_4::ba|| -|int_4::bag|| -|int_4::bagr|| -|int_4::bar|| -|int_4::barg|| -|int_4::bg|| -|int_4::bga|| -|int_4::bgar|| -|int_4::bgr|| -|int_4::bgra|| -|int_4::br|| -|int_4::bra|| -|int_4::brag|| -|int_4::brg|| -|int_4::brga|| -|int_4::g|| -|int_4::ga|| -|int_4::gab|| -|int_4::gabr|| -|int_4::gar|| -|int_4::garb|| -|int_4::gb|| -|int_4::gba|| -|int_4::gbar|| -|int_4::gbr|| -|int_4::gbra|| -|int_4::gr|| -|int_4::gra|| -|int_4::grab|| -|int_4::grb|| -|int_4::grba|| -|int_4::r|| -|int_4::ra|| -|int_4::rab|| -|int_4::rabg|| -|int_4::rag|| -|int_4::ragb|| -|int_4::rb|| -|int_4::rba|| -|int_4::rbag|| -|int_4::rbg|| -|int_4::rbga|| -|int_4::rg|| -|int_4::rga|| -|int_4::rgab|| -|int_4::rgb|| -|int_4::rgba|| -|int_4::w|| -|int_4::wx|| -|int_4::wxy|| -|int_4::wxyz|| -|int_4::wxz|| -|int_4::wxzy|| -|int_4::wy|| -|int_4::wyx|| -|int_4::wyxz|| -|int_4::wyz|| -|int_4::wyzx|| -|int_4::wz|| -|int_4::wzx|| -|int_4::wzxy|| -|int_4::wzy|| -|int_4::wzyx|| -|int_4::x|| -|int_4::xw|| -|int_4::xwy|| -|int_4::xwyz|| -|int_4::xwz|| -|int_4::xwzy|| -|int_4::xy|| -|int_4::xyw|| -|int_4::xywz|| -|int_4::xyz|| -|int_4::xyzw|| -|int_4::xz|| -|int_4::xzw|| -|int_4::xzwy|| -|int_4::xzy|| -|int_4::xzyw|| -|int_4::y|| -|int_4::yw|| -|int_4::ywx|| -|int_4::ywxz|| -|int_4::ywz|| -|int_4::ywzx|| -|int_4::yx|| -|int_4::yxw|| -|int_4::yxwz|| -|int_4::yxz|| -|int_4::yxzw|| -|int_4::yz|| -|int_4::yzw|| -|int_4::yzwx|| -|int_4::yzx|| -|int_4::yzxw|| -|int_4::z|| -|int_4::zw|| -|int_4::zwx|| -|int_4::zwxy|| -|int_4::zwy|| -|int_4::zwyx|| -|int_4::zx|| -|int_4::zxw|| -|int_4::zxwy|| -|int_4::zxy|| -|int_4::zxyw|| -|int_4::zy|| -|int_4::zyw|| -|int_4::zywx|| -|int_4::zyx|| -|int_4::zyxw|| - -## Inheritance Hierarchy - -`int_4` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## int_4 - -Default constructor, initializes all elements with 0. - -```cpp -int_4() restrict(amp, - cpu); - -int_4( - int _V0, - int _V1, - int _V2, - int _V3) restrict(amp, - cpu); - -int_4( - int _V) restrict(amp, - cpu); - -int_4( - const int_4& _Other) restrict(amp, - cpu); - -explicit inline int_4( - const uint_4& _Other) restrict(amp, - cpu); - -explicit inline int_4( - const float_4& _Other) restrict(amp, - cpu); - -explicit inline int_4( - const unorm_4& _Other) restrict(amp, - cpu); - -explicit inline int_4( - const norm_4& _Other) restrict(amp, - cpu); - -explicit inline int_4( - const double_4& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V3*
-The value to initialize element 3. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 4; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/invalid-compute-domain-class.md b/docs/parallel/amp/reference/invalid-compute-domain-class.md deleted file mode 100644 index 333ee60fc80..00000000000 --- a/docs/parallel/amp/reference/invalid-compute-domain-class.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: "Learn more about: invalid_compute_domain Class" -title: "invalid_compute_domain Class" -ms.date: "11/04/2016" -f1_keywords: ["invalid_compute_domain", "AMPRT/invalid_compute_domain", "AMPRT/Concurrency::invalid_compute_domain::invalid_compute_domain"] -helpviewer_keywords: ["invalid_compute_domain class"] -ms.assetid: ac7a7166-8bdb-4db1-8caf-ea129ab5117e ---- -# invalid_compute_domain Class - -The exception that's thrown when the runtime can't start a kernel by using the compute domain specified at the [parallel_for_each](concurrency-namespace-functions-amp.md#parallel_for_each) call site. - -## Syntax - -```cpp -class invalid_compute_domain : public runtime_exception; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[invalid_compute_domain Constructor](#ctor)|Initializes a new instance of the `invalid_compute_domain` class.| - -## Inheritance Hierarchy - -`exception` - -`runtime_exception` - -`invalid_compute_domain` - -## Requirements - -**Header:** amprt.h - -**Namespace:** Concurrency - -## invalid_compute_domain - -Initializes a new instance of the class. - -### Syntax - -```cpp -explicit invalid_compute_domain( - const char * _Message ) throw(); - -invalid_compute_domain() throw(); -``` - -### Parameters - -*_Message*
-A description of the error. - -### Return Value - -An instance of the `invalid_compute_domain` class - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/norm-2-class.md b/docs/parallel/amp/reference/norm-2-class.md deleted file mode 100644 index 4a244b33204..00000000000 --- a/docs/parallel/amp/reference/norm-2-class.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -description: "Learn more about: norm_2 Class" -title: "norm_2 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::norm_2::set_x", "amp_short_vectors/Concurrency::graphics::norm_2::set_xy", "amp_short_vectors/Concurrency::graphics::norm_2::g", "amp_short_vectors/Concurrency::graphics::norm_2::get_yx", "amp_short_vectors/Concurrency::graphics::norm_2::set_yx", "amp_short_vectors/Concurrency::graphics::norm_2::operator-=", "amp_short_vectors/Concurrency::graphics::norm_2::operator/=", "amp_short_vectors/Concurrency::graphics::norm_2::operator*=", "amp_short_vectors/Concurrency::graphics::norm_2::yx", "amp_short_vectors/Concurrency::graphics::norm_2::y", "amp_short_vectors/Concurrency::graphics::norm_2::xy", "amp_short_vectors/Concurrency::graphics::norm_2::operator++", "amp_short_vectors/Concurrency::graphics::norm_2::operator-", "amp_short_vectors/Concurrency::graphics::norm_2::rg", "amp_short_vectors/Concurrency::graphics::norm_2::operator=", "amp_short_vectors/Concurrency::graphics::norm_2::get_y", "amp_short_vectors/Concurrency::graphics::norm_2::r", "amp_short_vectors/Concurrency::graphics::norm_2::get_x", "amp_short_vectors/Concurrency::graphics::norm_2::get_xy", "amp_short_vectors/Concurrency::graphics::norm_2::gr", "amp_short_vectors/Concurrency::graphics::norm_2::set_y", "amp_short_vectors/Concurrency::graphics::norm_2::x", "amp_short_vectors/Concurrency::graphics::norm_2::operator+=", "amp_short_vectors/Concurrency::graphics::norm_2", "amp_short_vectors/Concurrency::graphics::norm_2::operator--"] -ms.assetid: 80703f9b-61f4-414a-93fd-bc774f7d3393 ---- -# norm_2 Class - -Represents a short vector of two normal numbers. - -## Syntax - -```cpp -class norm_2; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[norm_2 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|norm_2::get_x|| -|norm_2::get_xy|| -|norm_2::get_y|| -|norm_2::get_yx|| -|norm_2::ref_g|| -|norm_2::ref_r|| -|norm_2::ref_x|| -|norm_2::ref_y|| -|norm_2::set_x|| -|norm_2::set_xy|| -|norm_2::set_y|| -|norm_2::set_yx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|norm_2::operator-|| -|norm_2::operator--|| -|norm_2::operator*=|| -|norm_2::operator/=|| -|norm_2::operator++|| -|norm_2::operator+=|| -|norm_2::operator=|| -|norm_2::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#norm_2__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|norm_2::g|| -|norm_2::gr|| -|norm_2::r|| -|norm_2::rg|| -|norm_2::x|| -|norm_2::xy|| -|norm_2::y|| -|norm_2::yx|| - -## Inheritance Hierarchy - -`norm_2` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## norm_2 - -Default constructor, initializes all elements with 0. - -```cpp -norm_2() restrict(amp, - cpu); - -norm_2( - norm _V0, - norm _V1) restrict(amp, - cpu); - -norm_2( - float _V0, - float _V1) restrict(amp, - cpu); - -norm_2( - unorm _V0, - unorm _V1) restrict(amp, - cpu); - -norm_2( - norm _V) restrict(amp, - cpu); - -explicit norm_2( - float _V) restrict(amp, - cpu); - -norm_2( - const norm_2& _Other) restrict(amp, - cpu); - -explicit inline norm_2( - const uint_2& _Other) restrict(amp, - cpu); - -explicit inline norm_2( - const int_2& _Other) restrict(amp, - cpu); - -explicit inline norm_2( - const float_2& _Other) restrict(amp, - cpu); - -explicit inline norm_2( - const unorm_2& _Other) restrict(amp, - cpu); - -explicit inline norm_2( - const double_2& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 2; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/norm-3-class.md b/docs/parallel/amp/reference/norm-3-class.md deleted file mode 100644 index a0e3841d4dd..00000000000 --- a/docs/parallel/amp/reference/norm-3-class.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -title: "norm_3 Class" -description: "Learn more about: norm_3 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::norm_3::get_z", "amp_short_vectors/Concurrency::graphics::norm_3::operator=", "amp_short_vectors/Concurrency::graphics::norm_3::r", "amp_short_vectors/Concurrency::graphics::norm_3::set_zyx", "amp_short_vectors/Concurrency::graphics::norm_3::xyz", "amp_short_vectors/Concurrency::graphics::norm_3::operator/=", "amp_short_vectors/Concurrency::graphics::norm_3::yz", "amp_short_vectors/Concurrency::graphics::norm_3::get_xyz", "amp_short_vectors/Concurrency::graphics::norm_3::br", "amp_short_vectors/Concurrency::graphics::norm_3::xy", "amp_short_vectors/Concurrency::graphics::norm_3::get_yzx", "amp_short_vectors/Concurrency::graphics::norm_3::set_xyz", "amp_short_vectors/Concurrency::graphics::norm_3::gr", "amp_short_vectors/Concurrency::graphics::norm_3::g", "amp_short_vectors/Concurrency::graphics::norm_3::set_yxz", "amp_short_vectors/Concurrency::graphics::norm_3::get_zyx", "amp_short_vectors/Concurrency::graphics::norm_3::get_y", "amp_short_vectors/Concurrency::graphics::norm_3::zx", "amp_short_vectors/Concurrency::graphics::norm_3::yzx", "amp_short_vectors/Concurrency::graphics::norm_3::gb", "amp_short_vectors/Concurrency::graphics::norm_3::xzy", "amp_short_vectors/Concurrency::graphics::norm_3::xz", "amp_short_vectors/Concurrency::graphics::norm_3::rb", "amp_short_vectors/Concurrency::graphics::norm_3::rgb", "amp_short_vectors/Concurrency::graphics::norm_3::b", "amp_short_vectors/Concurrency::graphics::norm_3::z", "amp_short_vectors/Concurrency::graphics::norm_3::operator*=", "amp_short_vectors/Concurrency::graphics::norm_3::operator+=", "amp_short_vectors/Concurrency::graphics::norm_3::get_zy", "amp_short_vectors/Concurrency::graphics::norm_3::get_xz", "amp_short_vectors/Concurrency::graphics::norm_3::gbr", "amp_short_vectors/Concurrency::graphics::norm_3::get_yz", "amp_short_vectors/Concurrency::graphics::norm_3::get_zx", "amp_short_vectors/Concurrency::graphics::norm_3::get_xzy", "amp_short_vectors/Concurrency::graphics::norm_3::set_xz", "amp_short_vectors/Concurrency::graphics::norm_3::set_xzy", "amp_short_vectors/Concurrency::graphics::norm_3::set_zy", "amp_short_vectors/Concurrency::graphics::norm_3::get_xy", "amp_short_vectors/Concurrency::graphics::norm_3::y", "amp_short_vectors/Concurrency::graphics::norm_3::yx", "amp_short_vectors/Concurrency::graphics::norm_3::rbg", "amp_short_vectors/Concurrency::graphics::norm_3::zxy", "amp_short_vectors/Concurrency::graphics::norm_3", "amp_short_vectors/Concurrency::graphics::norm_3::set_yz", "amp_short_vectors/Concurrency::graphics::norm_3::brg", "amp_short_vectors/Concurrency::graphics::norm_3::operator--", "amp_short_vectors/Concurrency::graphics::norm_3::yxz", "amp_short_vectors/Concurrency::graphics::norm_3::x", "amp_short_vectors/Concurrency::graphics::norm_3::set_x", "amp_short_vectors/Concurrency::graphics::norm_3::get_x", "amp_short_vectors/Concurrency::graphics::norm_3::get_yxz", "amp_short_vectors/Concurrency::graphics::norm_3::grb", "amp_short_vectors/Concurrency::graphics::norm_3::get_yx", "amp_short_vectors/Concurrency::graphics::norm_3::zy", "amp_short_vectors/Concurrency::graphics::norm_3::rg", "amp_short_vectors/Concurrency::graphics::norm_3::set_yzx", "amp_short_vectors/Concurrency::graphics::norm_3::operator-=", "amp_short_vectors/Concurrency::graphics::norm_3::bg", "amp_short_vectors/Concurrency::graphics::norm_3::operator++", "amp_short_vectors/Concurrency::graphics::norm_3::set_y", "amp_short_vectors/Concurrency::graphics::norm_3::zyx", "amp_short_vectors/Concurrency::graphics::norm_3::set_z", "amp_short_vectors/Concurrency::graphics::norm_3::operator-", "amp_short_vectors/Concurrency::graphics::norm_3::get_zxy", "amp_short_vectors/Concurrency::graphics::norm_3::set_xy", "amp_short_vectors/Concurrency::graphics::norm_3::set_zxy", "amp_short_vectors/Concurrency::graphics::norm_3::set_yx", "amp_short_vectors/Concurrency::graphics::norm_3::set_zx", "amp_short_vectors/Concurrency::graphics::norm_3::bgr"] ---- -# norm_3 Class - -Represents a short vector of three normal numbers. - -## Syntax - -```cpp -class norm_3; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[norm_3 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|norm_3::get_x|| -|norm_3::get_xy|| -|norm_3::get_xyz|| -|norm_3::get_xz|| -|norm_3::get_xzy|| -|norm_3::get_y|| -|norm_3::get_yx|| -|norm_3::get_yxz|| -|norm_3::get_yz|| -|norm_3::get_yzx|| -|norm_3::get_z|| -|norm_3::get_zx|| -|norm_3::get_zxy|| -|norm_3::get_zy|| -|norm_3::get_zyx|| -|norm_3::ref_b|| -|norm_3::ref_g|| -|norm_3::ref_r|| -|norm_3::ref_x|| -|norm_3::ref_y|| -|norm_3::ref_z|| -|norm_3::set_x|| -|norm_3::set_xy|| -|norm_3::set_xyz|| -|norm_3::set_xz|| -|norm_3::set_xzy|| -|norm_3::set_y|| -|norm_3::set_yx|| -|norm_3::set_yxz|| -|norm_3::set_yz|| -|norm_3::set_yzx|| -|norm_3::set_z|| -|norm_3::set_zx|| -|norm_3::set_zxy|| -|norm_3::set_zy|| -|norm_3::set_zyx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|norm_3::operator-|| -|norm_3::operator--|| -|norm_3::operator*=|| -|norm_3::operator/=|| -|norm_3::operator++|| -|norm_3::operator+=|| -|norm_3::operator=|| -|norm_3::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|norm_3::b|| -|norm_3::bg|| -|norm_3::bgr|| -|norm_3::br|| -|norm_3::brg|| -|norm_3::g|| -|norm_3::gb|| -|norm_3::gbr|| -|norm_3::gr|| -|norm_3::grb|| -|norm_3::r|| -|norm_3::rb|| -|norm_3::rbg|| -|norm_3::rg|| -|norm_3::rgb|| -|norm_3::x|| -|norm_3::xy|| -|norm_3::xyz|| -|norm_3::xz|| -|norm_3::xzy|| -|norm_3::y|| -|norm_3::yx|| -|norm_3::yxz|| -|norm_3::yz|| -|norm_3::yzx|| -|norm_3::z|| -|norm_3::zx|| -|norm_3::zxy|| -|norm_3::zy|| -|norm_3::zyx|| - -## Inheritance Hierarchy - -`norm_3` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## norm_3 Constructor - -Default constructor, initializes all elements with 0. - -### Syntax - -```cpp -norm_3() restrict(amp,cpu); -norm_3( - norm _V0, - norm _V1, - norm _V2 -) restrict(amp,cpu); -norm_3( - float _V0, - float _V1, - float _V2 -) restrict(amp,cpu); -norm_3( - unorm _V0, - unorm _V1, - unorm _V2 -) restrict(amp,cpu); -norm_3( - norm _V -) restrict(amp,cpu); -explicit norm_3( - float _V -) restrict(amp,cpu); -norm_3( - const norm_3& _Other -) restrict(amp,cpu); -explicit inline norm_3( - const uint_3& _Other -) restrict(amp,cpu); -explicit inline norm_3( - const int_3& _Other -) restrict(amp,cpu); -explicit inline norm_3( - const float_3& _Other -) restrict(amp,cpu); -explicit inline norm_3( - const unorm_3& _Other -) restrict(amp,cpu); -explicit inline norm_3( - const double_3& _Other -) restrict(amp,cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size Constant - -### Syntax - -```cpp -static const int size = 3; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/norm-4-class.md b/docs/parallel/amp/reference/norm-4-class.md deleted file mode 100644 index 0b0262d23a5..00000000000 --- a/docs/parallel/amp/reference/norm-4-class.md +++ /dev/null @@ -1,425 +0,0 @@ ---- -description: "Learn more about: norm_4 Class" -title: "norm_4 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::norm_4::grab", "amp_short_vectors/Concurrency::graphics::norm_4::agrb", "amp_short_vectors/Concurrency::graphics::norm_4::bg", "amp_short_vectors/Concurrency::graphics::norm_4::get_wx", "amp_short_vectors/Concurrency::graphics::norm_4::rabg", "amp_short_vectors/Concurrency::graphics::norm_4::get_wxz", "amp_short_vectors/Concurrency::graphics::norm_4::get_zxyw", "amp_short_vectors/Concurrency::graphics::norm_4::get_ywxz", "amp_short_vectors/Concurrency::graphics::norm_4::zwyx", "amp_short_vectors/Concurrency::graphics::norm_4::set_yxzw", "amp_short_vectors/Concurrency::graphics::norm_4::rag", "amp_short_vectors/Concurrency::graphics::norm_4::operator--", "amp_short_vectors/Concurrency::graphics::norm_4::agbr", "amp_short_vectors/Concurrency::graphics::norm_4::set_zyw", "amp_short_vectors/Concurrency::graphics::norm_4::y", "amp_short_vectors/Concurrency::graphics::norm_4::get_xzy", "amp_short_vectors/Concurrency::graphics::norm_4::get_wxy", "amp_short_vectors/Concurrency::graphics::norm_4::get_ywzx", "amp_short_vectors/Concurrency::graphics::norm_4::grba", "amp_short_vectors/Concurrency::graphics::norm_4::get_xwz", "amp_short_vectors/Concurrency::graphics::norm_4::xzy", "amp_short_vectors/Concurrency::graphics::norm_4::get_xywz", "amp_short_vectors/Concurrency::graphics::norm_4::get_ywx", "amp_short_vectors/Concurrency::graphics::norm_4::abgr", "amp_short_vectors/Concurrency::graphics::norm_4::get_xyzw", "amp_short_vectors/Concurrency::graphics::norm_4::ywx", "amp_short_vectors/Concurrency::graphics::norm_4::argb", "amp_short_vectors/Concurrency::graphics::norm_4::set_ywx", "amp_short_vectors/Concurrency::graphics::norm_4::set_yzx", "amp_short_vectors/Concurrency::graphics::norm_4::b", "amp_short_vectors/Concurrency::graphics::norm_4::arb", "amp_short_vectors/Concurrency::graphics::norm_4::rab", "amp_short_vectors/Concurrency::graphics::norm_4::gb", "amp_short_vectors/Concurrency::graphics::norm_4::yzxw", "amp_short_vectors/Concurrency::graphics::norm_4::bagr", "amp_short_vectors/Concurrency::graphics::norm_4::wyzx", "amp_short_vectors/Concurrency::graphics::norm_4::gba", "amp_short_vectors/Concurrency::graphics::norm_4::wz", "amp_short_vectors/Concurrency::graphics::norm_4::get_yz", "amp_short_vectors/Concurrency::graphics::norm_4::rgab", "amp_short_vectors/Concurrency::graphics::norm_4::get_wxzy", "amp_short_vectors/Concurrency::graphics::norm_4::set_wzyx", "amp_short_vectors/Concurrency::graphics::norm_4::set_yzxw", "amp_short_vectors/Concurrency::graphics::norm_4::xzw", "amp_short_vectors/Concurrency::graphics::norm_4::zwxy", "amp_short_vectors/Concurrency::graphics::norm_4::yzw", "amp_short_vectors/Concurrency::graphics::norm_4::set_zxw", "amp_short_vectors/Concurrency::graphics::norm_4::ywxz", "amp_short_vectors/Concurrency::graphics::norm_4::yxz", "amp_short_vectors/Concurrency::graphics::norm_4::rbg", "amp_short_vectors/Concurrency::graphics::norm_4::get_wyz", "amp_short_vectors/Concurrency::graphics::norm_4::get_zwyx", "amp_short_vectors/Concurrency::graphics::norm_4::set_zxwy", "amp_short_vectors/Concurrency::graphics::norm_4::set_xzwy", "amp_short_vectors/Concurrency::graphics::norm_4::set_zxyw", "amp_short_vectors/Concurrency::graphics::norm_4::get_wzyx", "amp_short_vectors/Concurrency::graphics::norm_4::barg", "amp_short_vectors/Concurrency::graphics::norm_4::set_zywx", "amp_short_vectors/Concurrency::graphics::norm_4::set_wx", "amp_short_vectors/Concurrency::graphics::norm_4::bar", "amp_short_vectors/Concurrency::graphics::norm_4::a", "amp_short_vectors/Concurrency::graphics::norm_4::set_xyz", "amp_short_vectors/Concurrency::graphics::norm_4::gab", "amp_short_vectors/Concurrency::graphics::norm_4::gbra", "amp_short_vectors/Concurrency::graphics::norm_4::agr", "amp_short_vectors/Concurrency::graphics::norm_4::xzyw", "amp_short_vectors/Concurrency::graphics::norm_4::rg", "amp_short_vectors/Concurrency::graphics::norm_4::get_wzxy", "amp_short_vectors/Concurrency::graphics::norm_4::operator=", "amp_short_vectors/Concurrency::graphics::norm_4::wxzy", "amp_short_vectors/Concurrency::graphics::norm_4::get_x", "amp_short_vectors/Concurrency::graphics::norm_4::bra", "amp_short_vectors/Concurrency::graphics::norm_4::get_xwzy", "amp_short_vectors/Concurrency::graphics::norm_4::yzwx", "amp_short_vectors/Concurrency::graphics::norm_4::wzyx", "amp_short_vectors/Concurrency::graphics::norm_4::gbar", "amp_short_vectors/Concurrency::graphics::norm_4::set_wyzx", "amp_short_vectors/Concurrency::graphics::norm_4::set_yxz", "amp_short_vectors/Concurrency::graphics::norm_4::wzxy", "amp_short_vectors/Concurrency::graphics::norm_4::garb", "amp_short_vectors/Concurrency::graphics::norm_4::bgar", "amp_short_vectors/Concurrency::graphics::norm_4::set_zx", "amp_short_vectors/Concurrency::graphics::norm_4::bgr", "amp_short_vectors/Concurrency::graphics::norm_4::ga", "amp_short_vectors/Concurrency::graphics::norm_4::set_wzy", "amp_short_vectors/Concurrency::graphics::norm_4::zxw", "amp_short_vectors/Concurrency::graphics::norm_4::get_xwyz", "amp_short_vectors/Concurrency::graphics::norm_4::yzx", "amp_short_vectors/Concurrency::graphics::norm_4::get_wy", "amp_short_vectors/Concurrency::graphics::norm_4::get_xwy", "amp_short_vectors/Concurrency::graphics::norm_4::set_xw", "amp_short_vectors/Concurrency::graphics::norm_4::yz", "amp_short_vectors/Concurrency::graphics::norm_4::w", "amp_short_vectors/Concurrency::graphics::norm_4::wxyz", "amp_short_vectors/Concurrency::graphics::norm_4::set_w", "amp_short_vectors/Concurrency::graphics::norm_4::gar", "amp_short_vectors/Concurrency::graphics::norm_4::get_yzx", "amp_short_vectors/Concurrency::graphics::norm_4::set_zwx", "amp_short_vectors/Concurrency::graphics::norm_4::set_wxzy", "amp_short_vectors/Concurrency::graphics::norm_4::xyz", "amp_short_vectors/Concurrency::graphics::norm_4::set_wz", "amp_short_vectors/Concurrency::graphics::norm_4::get_xz", "amp_short_vectors/Concurrency::graphics::norm_4::set_zwxy", "amp_short_vectors/Concurrency::graphics::norm_4::get_w", "amp_short_vectors/Concurrency::graphics::norm_4::set_yzw", "amp_short_vectors/Concurrency::graphics::norm_4::set_yx", "amp_short_vectors/Concurrency::graphics::norm_4::rga", "amp_short_vectors/Concurrency::graphics::norm_4::xwy", "amp_short_vectors/Concurrency::graphics::norm_4::wzy", "amp_short_vectors/Concurrency::graphics::norm_4::wzx", "amp_short_vectors/Concurrency::graphics::norm_4::xz", "amp_short_vectors/Concurrency::graphics::norm_4::brga", "amp_short_vectors/Concurrency::graphics::norm_4::brag", "amp_short_vectors/Concurrency::graphics::norm_4::set_wyz", "amp_short_vectors/Concurrency::graphics::norm_4::ra", "amp_short_vectors/Concurrency::graphics::norm_4::get_xzwy", "amp_short_vectors/Concurrency::graphics::norm_4::zyx", "amp_short_vectors/Concurrency::graphics::norm_4::yw", "amp_short_vectors/Concurrency::graphics::norm_4::set_yzwx", "amp_short_vectors/Concurrency::graphics::norm_4::get_yxz", "amp_short_vectors/Concurrency::graphics::norm_4::xwzy", "amp_short_vectors/Concurrency::graphics::norm_4::get_zyw", "amp_short_vectors/Concurrency::graphics::norm_4::gbr", "amp_short_vectors/Concurrency::graphics::norm_4::zxyw", "amp_short_vectors/Concurrency::graphics::norm_4::wyx", "amp_short_vectors/Concurrency::graphics::norm_4::get_zyxw", "amp_short_vectors/Concurrency::graphics::norm_4::get_zwy", "amp_short_vectors/Concurrency::graphics::norm_4::set_zxy", "amp_short_vectors/Concurrency::graphics::norm_4::ywz", "amp_short_vectors/Concurrency::graphics::norm_4::xy", "amp_short_vectors/Concurrency::graphics::norm_4", "amp_short_vectors/Concurrency::graphics::norm_4::set_wxyz", "amp_short_vectors/Concurrency::graphics::norm_4::r", "amp_short_vectors/Concurrency::graphics::norm_4::get_zwx", "amp_short_vectors/Concurrency::graphics::norm_4::get_xw", "amp_short_vectors/Concurrency::graphics::norm_4::xyw", "amp_short_vectors/Concurrency::graphics::norm_4::wxy", "amp_short_vectors/Concurrency::graphics::norm_4::set_wxz", "amp_short_vectors/Concurrency::graphics::norm_4::agb", "amp_short_vectors/Concurrency::graphics::norm_4::bga", "amp_short_vectors/Concurrency::graphics::norm_4::gr", "amp_short_vectors/Concurrency::graphics::norm_4::arg", "amp_short_vectors/Concurrency::graphics::norm_4::rgba", "amp_short_vectors/Concurrency::graphics::norm_4::arbg", "amp_short_vectors/Concurrency::graphics::norm_4::yx", "amp_short_vectors/Concurrency::graphics::norm_4::set_yz", "amp_short_vectors/Concurrency::graphics::norm_4::set_yxwz", "amp_short_vectors/Concurrency::graphics::norm_4::get_wyzx", "amp_short_vectors/Concurrency::graphics::norm_4::get_yzw", "amp_short_vectors/Concurrency::graphics::norm_4::set_yw", "amp_short_vectors/Concurrency::graphics::norm_4::brg", "amp_short_vectors/Concurrency::graphics::norm_4::zxy", "amp_short_vectors/Concurrency::graphics::norm_4::operator-", "amp_short_vectors/Concurrency::graphics::norm_4::yxzw", "amp_short_vectors/Concurrency::graphics::norm_4::rbga", "amp_short_vectors/Concurrency::graphics::norm_4::set_zyxw", "amp_short_vectors/Concurrency::graphics::norm_4::zwy", "amp_short_vectors/Concurrency::graphics::norm_4::abr", "amp_short_vectors/Concurrency::graphics::norm_4::get_zwxy", "amp_short_vectors/Concurrency::graphics::norm_4::br", "amp_short_vectors/Concurrency::graphics::norm_4::set_xzy", "amp_short_vectors/Concurrency::graphics::norm_4::get_zx", "amp_short_vectors/Concurrency::graphics::norm_4::rgb", "amp_short_vectors/Concurrency::graphics::norm_4::get_zy", "amp_short_vectors/Concurrency::graphics::norm_4::zw", "amp_short_vectors/Concurrency::graphics::norm_4::set_ywzx", "amp_short_vectors/Concurrency::graphics::norm_4::set_xy", "amp_short_vectors/Concurrency::graphics::norm_4::get_xzw", "amp_short_vectors/Concurrency::graphics::norm_4::rba", "amp_short_vectors/Concurrency::graphics::norm_4::get_wyx", "amp_short_vectors/Concurrency::graphics::norm_4::operator+=", "amp_short_vectors/Concurrency::graphics::norm_4::set_xwz", "amp_short_vectors/Concurrency::graphics::norm_4::set_zwy", "amp_short_vectors/Concurrency::graphics::norm_4::abg", "amp_short_vectors/Concurrency::graphics::norm_4::xywz", "amp_short_vectors/Concurrency::graphics::norm_4::ar", "amp_short_vectors/Concurrency::graphics::norm_4::set_y", "amp_short_vectors/Concurrency::graphics::norm_4::get_xzyw", "amp_short_vectors/Concurrency::graphics::norm_4::set_yxw", "amp_short_vectors/Concurrency::graphics::norm_4::set_ywxz", "amp_short_vectors/Concurrency::graphics::norm_4::yxw", "amp_short_vectors/Concurrency::graphics::norm_4::get_z", "amp_short_vectors/Concurrency::graphics::norm_4::get_zxy", "amp_short_vectors/Concurrency::graphics::norm_4::ag", "amp_short_vectors/Concurrency::graphics::norm_4::operator/=", "amp_short_vectors/Concurrency::graphics::norm_4::gra", "amp_short_vectors/Concurrency::graphics::norm_4::ragb", "amp_short_vectors/Concurrency::graphics::norm_4::get_yxwz", "amp_short_vectors/Concurrency::graphics::norm_4::get_wyxz", "amp_short_vectors/Concurrency::graphics::norm_4::xyzw", "amp_short_vectors/Concurrency::graphics::norm_4::zyw", "amp_short_vectors/Concurrency::graphics::norm_4::set_wzxy", "amp_short_vectors/Concurrency::graphics::norm_4::set_x", "amp_short_vectors/Concurrency::graphics::norm_4::set_xwyz", "amp_short_vectors/Concurrency::graphics::norm_4::wyz", "amp_short_vectors/Concurrency::graphics::norm_4::zwx", "amp_short_vectors/Concurrency::graphics::norm_4::set_zw", "amp_short_vectors/Concurrency::graphics::norm_4::zy", "amp_short_vectors/Concurrency::graphics::norm_4::set_zwyx", "amp_short_vectors/Concurrency::graphics::norm_4::set_xwzy", "amp_short_vectors/Concurrency::graphics::norm_4::get_yzxw", "amp_short_vectors/Concurrency::graphics::norm_4::get_yzwx", "amp_short_vectors/Concurrency::graphics::norm_4::z", "amp_short_vectors/Concurrency::graphics::norm_4::g", "amp_short_vectors/Concurrency::graphics::norm_4::get_xyz", "amp_short_vectors/Concurrency::graphics::norm_4::xwyz", "amp_short_vectors/Concurrency::graphics::norm_4::get_wxyz", "amp_short_vectors/Concurrency::graphics::norm_4::zywx", "amp_short_vectors/Concurrency::graphics::norm_4::operator++", "amp_short_vectors/Concurrency::graphics::norm_4::operator-=", "amp_short_vectors/Concurrency::graphics::norm_4::set_wyx", "amp_short_vectors/Concurrency::graphics::norm_4::wxz", "amp_short_vectors/Concurrency::graphics::norm_4::set_xyw", "amp_short_vectors/Concurrency::graphics::norm_4::set_ywz", "amp_short_vectors/Concurrency::graphics::norm_4::operator*=", "amp_short_vectors/Concurrency::graphics::norm_4::wx", "amp_short_vectors/Concurrency::graphics::norm_4::x", "amp_short_vectors/Concurrency::graphics::norm_4::get_y", "amp_short_vectors/Concurrency::graphics::norm_4::set_xzyw", "amp_short_vectors/Concurrency::graphics::norm_4::bag", "amp_short_vectors/Concurrency::graphics::norm_4::get_zw", "amp_short_vectors/Concurrency::graphics::norm_4::abrg", "amp_short_vectors/Concurrency::graphics::norm_4::get_xy", "amp_short_vectors/Concurrency::graphics::norm_4::set_wyxz", "amp_short_vectors/Concurrency::graphics::norm_4::ywzx", "amp_short_vectors/Concurrency::graphics::norm_4::set_xwy", "amp_short_vectors/Concurrency::graphics::norm_4::set_wxy", "amp_short_vectors/Concurrency::graphics::norm_4::set_xyzw", "amp_short_vectors/Concurrency::graphics::norm_4::wyxz", "amp_short_vectors/Concurrency::graphics::norm_4::ba", "amp_short_vectors/Concurrency::graphics::norm_4::xwz", "amp_short_vectors/Concurrency::graphics::norm_4::zxwy", "amp_short_vectors/Concurrency::graphics::norm_4::gabr", "amp_short_vectors/Concurrency::graphics::norm_4::set_wzx", "amp_short_vectors/Concurrency::graphics::norm_4::get_xyw", "amp_short_vectors/Concurrency::graphics::norm_4::grb", "amp_short_vectors/Concurrency::graphics::norm_4::get_zxw", "amp_short_vectors/Concurrency::graphics::norm_4::get_yw", "amp_short_vectors/Concurrency::graphics::norm_4::set_xzw", "amp_short_vectors/Concurrency::graphics::norm_4::set_wy", "amp_short_vectors/Concurrency::graphics::norm_4::get_yxw", "amp_short_vectors/Concurrency::graphics::norm_4::get_ywz", "amp_short_vectors/Concurrency::graphics::norm_4::get_wz", "amp_short_vectors/Concurrency::graphics::norm_4::yxwz", "amp_short_vectors/Concurrency::graphics::norm_4::get_zxwy", "amp_short_vectors/Concurrency::graphics::norm_4::set_zy", "amp_short_vectors/Concurrency::graphics::norm_4::xzwy", "amp_short_vectors/Concurrency::graphics::norm_4::bgra", "amp_short_vectors/Concurrency::graphics::norm_4::set_xz", "amp_short_vectors/Concurrency::graphics::norm_4::rbag", "amp_short_vectors/Concurrency::graphics::norm_4::zx", "amp_short_vectors/Concurrency::graphics::norm_4::get_zyx", "amp_short_vectors/Concurrency::graphics::norm_4::zyxw", "amp_short_vectors/Concurrency::graphics::norm_4::set_z", "amp_short_vectors/Concurrency::graphics::norm_4::xw", "amp_short_vectors/Concurrency::graphics::norm_4::set_xywz", "amp_short_vectors/Concurrency::graphics::norm_4::get_yxzw", "amp_short_vectors/Concurrency::graphics::norm_4::get_yx", "amp_short_vectors/Concurrency::graphics::norm_4::get_wzx", "amp_short_vectors/Concurrency::graphics::norm_4::ab", "amp_short_vectors/Concurrency::graphics::norm_4::rb", "amp_short_vectors/Concurrency::graphics::norm_4::get_zywx", "amp_short_vectors/Concurrency::graphics::norm_4::get_wzy", "amp_short_vectors/Concurrency::graphics::norm_4::set_zyx", "amp_short_vectors/Concurrency::graphics::norm_4::wy"] -ms.assetid: d628b2bf-2cdb-4dbb-95c6-cd778f5e991f ---- -# norm_4 Class - -Represents a short vector of four normal numbers. - -## Syntax - -```cpp -class norm_4; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[norm_4 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|norm_4::get_w|| -|norm_4::get_wx|| -|norm_4::get_wxy|| -|norm_4::get_wxyz|| -|norm_4::get_wxz|| -|norm_4::get_wxzy|| -|norm_4::get_wy|| -|norm_4::get_wyx|| -|norm_4::get_wyxz|| -|norm_4::get_wyz|| -|norm_4::get_wyzx|| -|norm_4::get_wz|| -|norm_4::get_wzx|| -|norm_4::get_wzxy|| -|norm_4::get_wzy|| -|norm_4::get_wzyx|| -|norm_4::get_x|| -|norm_4::get_xw|| -|norm_4::get_xwy|| -|norm_4::get_xwyz|| -|norm_4::get_xwz|| -|norm_4::get_xwzy|| -|norm_4::get_xy|| -|norm_4::get_xyw|| -|norm_4::get_xywz|| -|norm_4::get_xyz|| -|norm_4::get_xyzw|| -|norm_4::get_xz|| -|norm_4::get_xzw|| -|norm_4::get_xzwy|| -|norm_4::get_xzy|| -|norm_4::get_xzyw|| -|norm_4::get_y|| -|norm_4::get_yw|| -|norm_4::get_ywx|| -|norm_4::get_ywxz|| -|norm_4::get_ywz|| -|norm_4::get_ywzx|| -|norm_4::get_yx|| -|norm_4::get_yxw|| -|norm_4::get_yxwz|| -|norm_4::get_yxz|| -|norm_4::get_yxzw|| -|norm_4::get_yz|| -|norm_4::get_yzw|| -|norm_4::get_yzwx|| -|norm_4::get_yzx|| -|norm_4::get_yzxw|| -|norm_4::get_z|| -|norm_4::get_zw|| -|norm_4::get_zwx|| -|norm_4::get_zwxy|| -|norm_4::get_zwy|| -|norm_4::get_zwyx|| -|norm_4::get_zx|| -|norm_4::get_zxw|| -|norm_4::get_zxwy|| -|norm_4::get_zxy|| -|norm_4::get_zxyw|| -|norm_4::get_zy|| -|norm_4::get_zyw|| -|norm_4::get_zywx|| -|norm_4::get_zyx|| -|norm_4::get_zyxw|| -|norm_4::ref_a|| -|norm_4::ref_b|| -|norm_4::ref_g|| -|norm_4::ref_r|| -|norm_4::ref_w|| -|norm_4::ref_x|| -|norm_4::ref_y|| -|norm_4::ref_z|| -|norm_4::set_w|| -|norm_4::set_wx|| -|norm_4::set_wxy|| -|norm_4::set_wxyz|| -|norm_4::set_wxz|| -|norm_4::set_wxzy|| -|norm_4::set_wy|| -|norm_4::set_wyx|| -|norm_4::set_wyxz|| -|norm_4::set_wyz|| -|norm_4::set_wyzx|| -|norm_4::set_wz|| -|norm_4::set_wzx|| -|norm_4::set_wzxy|| -|norm_4::set_wzy|| -|norm_4::set_wzyx|| -|norm_4::set_x|| -|norm_4::set_xw|| -|norm_4::set_xwy|| -|norm_4::set_xwyz|| -|norm_4::set_xwz|| -|norm_4::set_xwzy|| -|norm_4::set_xy|| -|norm_4::set_xyw|| -|norm_4::set_xywz|| -|norm_4::set_xyz|| -|norm_4::set_xyzw|| -|norm_4::set_xz|| -|norm_4::set_xzw|| -|norm_4::set_xzwy|| -|norm_4::set_xzy|| -|norm_4::set_xzyw|| -|norm_4::set_y|| -|norm_4::set_yw|| -|norm_4::set_ywx|| -|norm_4::set_ywxz|| -|norm_4::set_ywz|| -|norm_4::set_ywzx|| -|norm_4::set_yx|| -|norm_4::set_yxw|| -|norm_4::set_yxwz|| -|norm_4::set_yxz|| -|norm_4::set_yxzw|| -|norm_4::set_yz|| -|norm_4::set_yzw|| -|norm_4::set_yzwx|| -|norm_4::set_yzx|| -|norm_4::set_yzxw|| -|norm_4::set_z|| -|norm_4::set_zw|| -|norm_4::set_zwx|| -|norm_4::set_zwxy|| -|norm_4::set_zwy|| -|norm_4::set_zwyx|| -|norm_4::set_zx|| -|norm_4::set_zxw|| -|norm_4::set_zxwy|| -|norm_4::set_zxy|| -|norm_4::set_zxyw|| -|norm_4::set_zy|| -|norm_4::set_zyw|| -|norm_4::set_zywx|| -|norm_4::set_zyx|| -|norm_4::set_zyxw|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|norm_4::operator-|| -|norm_4::operator--|| -|norm_4::operator*=|| -|norm_4::operator/=|| -|norm_4::operator++|| -|norm_4::operator+=|| -|norm_4::operator=|| -|norm_4::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#norm_4__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|norm_4::a|| -|norm_4::ab|| -|norm_4::abg|| -|norm_4::abgr|| -|norm_4::abr|| -|norm_4::abrg|| -|norm_4::ag|| -|norm_4::agb|| -|norm_4::agbr|| -|norm_4::agr|| -|norm_4::agrb|| -|norm_4::ar|| -|norm_4::arb|| -|norm_4::arbg|| -|norm_4::arg|| -|norm_4::argb|| -|norm_4::b|| -|norm_4::ba|| -|norm_4::bag|| -|norm_4::bagr|| -|norm_4::bar|| -|norm_4::barg|| -|norm_4::bg|| -|norm_4::bga|| -|norm_4::bgar|| -|norm_4::bgr|| -|norm_4::bgra|| -|norm_4::br|| -|norm_4::bra|| -|norm_4::brag|| -|norm_4::brg|| -|norm_4::brga|| -|norm_4::g|| -|norm_4::ga|| -|norm_4::gab|| -|norm_4::gabr|| -|norm_4::gar|| -|norm_4::garb|| -|norm_4::gb|| -|norm_4::gba|| -|norm_4::gbar|| -|norm_4::gbr|| -|norm_4::gbra|| -|norm_4::gr|| -|norm_4::gra|| -|norm_4::grab|| -|norm_4::grb|| -|norm_4::grba|| -|norm_4::r|| -|norm_4::ra|| -|norm_4::rab|| -|norm_4::rabg|| -|norm_4::rag|| -|norm_4::ragb|| -|norm_4::rb|| -|norm_4::rba|| -|norm_4::rbag|| -|norm_4::rbg|| -|norm_4::rbga|| -|norm_4::rg|| -|norm_4::rga|| -|norm_4::rgab|| -|norm_4::rgb|| -|norm_4::rgba|| -|norm_4::w|| -|norm_4::wx|| -|norm_4::wxy|| -|norm_4::wxyz|| -|norm_4::wxz|| -|norm_4::wxzy|| -|norm_4::wy|| -|norm_4::wyx|| -|norm_4::wyxz|| -|norm_4::wyz|| -|norm_4::wyzx|| -|norm_4::wz|| -|norm_4::wzx|| -|norm_4::wzxy|| -|norm_4::wzy|| -|norm_4::wzyx|| -|norm_4::x|| -|norm_4::xw|| -|norm_4::xwy|| -|norm_4::xwyz|| -|norm_4::xwz|| -|norm_4::xwzy|| -|norm_4::xy|| -|norm_4::xyw|| -|norm_4::xywz|| -|norm_4::xyz|| -|norm_4::xyzw|| -|norm_4::xz|| -|norm_4::xzw|| -|norm_4::xzwy|| -|norm_4::xzy|| -|norm_4::xzyw|| -|norm_4::y|| -|norm_4::yw|| -|norm_4::ywx|| -|norm_4::ywxz|| -|norm_4::ywz|| -|norm_4::ywzx|| -|norm_4::yx|| -|norm_4::yxw|| -|norm_4::yxwz|| -|norm_4::yxz|| -|norm_4::yxzw|| -|norm_4::yz|| -|norm_4::yzw|| -|norm_4::yzwx|| -|norm_4::yzx|| -|norm_4::yzxw|| -|norm_4::z|| -|norm_4::zw|| -|norm_4::zwx|| -|norm_4::zwxy|| -|norm_4::zwy|| -|norm_4::zwyx|| -|norm_4::zx|| -|norm_4::zxw|| -|norm_4::zxwy|| -|norm_4::zxy|| -|norm_4::zxyw|| -|norm_4::zy|| -|norm_4::zyw|| -|norm_4::zywx|| -|norm_4::zyx|| -|norm_4::zyxw|| - -## Inheritance Hierarchy - -`norm_4` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## norm_4 - -Default constructor, initializes all elements with 0. - -```cpp -norm_4() restrict(amp, - cpu); - -norm_4( - norm _V0, - norm _V1, - norm _V2, - norm _V3) restrict(amp, - cpu); - -norm_4( - float _V0, - float _V1, - float _V2, - float _V3) restrict(amp, - cpu); - -norm_4( - unorm _V0, - unorm _V1, - unorm _V2, - unorm _V3) restrict(amp, - cpu); - -norm_4( - norm _V) restrict(amp, - cpu); - -explicit norm_4( - float _V) restrict(amp, - cpu); - -norm_4( - const norm_4& _Other) restrict(amp, - cpu); - -explicit inline norm_4( - const uint_4& _Other) restrict(amp, - cpu); - -explicit inline norm_4( - const int_4& _Other) restrict(amp, - cpu); - -explicit inline norm_4( - const float_4& _Other) restrict(amp, - cpu); - -explicit inline norm_4( - const unorm_4& _Other) restrict(amp, - cpu); - -explicit inline norm_4( - const double_4& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V3*
-The value to initialize element 3. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 4; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/norm-class.md b/docs/parallel/amp/reference/norm-class.md deleted file mode 100644 index 56952e2cf8f..00000000000 --- a/docs/parallel/amp/reference/norm-class.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -description: "Learn more about: norm Class" -title: "norm Class" -ms.date: "11/04/2016" -f1_keywords: ["AMP_SHORT_VECTORS/norm", "AMP_SHORT_VECTORS/Concurrency::graphics::norm Constructor"] -ms.assetid: 73002f3d-c25e-4119-bcd3-4c46c9b6abf1 ---- -# norm Class - -Represent a norm number. Each element is a floating point number in the range of [-1.0f, 1.0f]. - -## Syntax - -```cpp -class norm; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[norm Constructor](#ctor)|Overloaded. Default constructor. Initialize to 0.0f.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|norm::operator-|| -|norm::operator--|| -|norm::operator float|Conversion operator. Convert the norm number to a floating point value.| -|norm::operator*=|| -|norm::operator/=|| -|norm::operator++|| -|norm::operator+=|| -|norm::operator=|| -|norm::operator-=|| - -## Inheritance Hierarchy - -`norm` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## norm - -Default constructor. Initialize to 0.0f. - -```cpp -norm( - void) restrict(amp, - cpu); - -explicit norm( - float _V) restrict(amp, - cpu); - -explicit norm( - unsigned int _V) restrict(amp, - cpu); - -explicit norm( - int _V) restrict(amp, - cpu); - -explicit norm( - double _V) restrict(amp, - cpu); - -norm( - const norm& _Other) restrict(amp, - cpu); - -norm( - const unorm& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V*
-The value used to initialize. - -*_Other*
-The object used to initialize. - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/out-of-memory-class.md b/docs/parallel/amp/reference/out-of-memory-class.md deleted file mode 100644 index c59ef294a0a..00000000000 --- a/docs/parallel/amp/reference/out-of-memory-class.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: "Learn more about: out_of_memory Class" -title: "out_of_memory Class" -ms.date: "11/04/2016" -f1_keywords: ["out_of_memory", "AMPRT/out_of_memory", "AMPRT/Concurrency::out_of_memory::out_of_memory"] -helpviewer_keywords: ["out_of_memory class"] -ms.assetid: 3aa7e682-8f13-4ae6-9188-31fb423956e4 ---- -# out_of_memory Class - -The exception that is thrown when a method fails because of a lack of system or device memory. - -## Syntax - -```cpp -class out_of_memory : public runtime_exception; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[out_of_memory Constructor](#ctor)|Initializes a new instance of the `out_of_memory` class.| - -## Inheritance Hierarchy - -`exception` - -`runtime_exception` - -`out_of_memory` - -## Requirements - -**Header:** amprt.h - -**Namespace:** Concurrency - -## out_of_memory - -Initializes a new instance of the class. - -### Syntax - -```cpp -explicit out_of_memory( - const char * _Message ) throw(); - -out_of_memory () throw(); -``` - -### Parameters - -*_Message*
-A description of the error. - -### Return Value - -A new instance of the `out_of_memory` class. - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/reference-cpp-amp.md b/docs/parallel/amp/reference/reference-cpp-amp.md deleted file mode 100644 index 21e44bd2a83..00000000000 --- a/docs/parallel/amp/reference/reference-cpp-amp.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: "Learn more about: Reference (C++ AMP)" -title: "Reference (C++ AMP)" -ms.date: "11/04/2016" -f1_keywords: ["amp/Concurrency::Reference (C++ AMP)"] -helpviewer_keywords: ["C++ Accelerated Massive Parallelism, reference"] -ms.assetid: 372a8aed-8a53-48c9-996f-9c3cf09c9fa8 ---- -# Reference (C++ AMP) - -This section contains reference information for the C++ Accelerated Massive Parallelism (C++ AMP) runtime. - -> [!NOTE] -> The C++ language standard reserves the use of identifiers that begin with an underscore (`_`) character for implementations such as libraries. Do not use names beginning with an underscore in your code. The behavior of code elements whose names follow this convention are not guaranteed and are subject to change in future releases. For these reasons, such code elements are omitted from this documentation. - -## In This Section - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md)
-Provides classes and functions that enable the acceleration of C++ code on data parallel hardware. - -[Concurrency::direct3d Namespace](concurrency-direct3d-namespace.md)
-Provides functions that support D3D interoperability. Enables seamless use of D3D resources for compute in AMP code and the use of resources created in AMP in D3D code, without creating redundant intermediate copies. You can use C++ AMP to incrementally accelerate the compute-intensive sections of your DirectX applications and use the D3D API on data produced from AMP computations. - -[Concurrency::fast_math Namespace](concurrency-fast-math-namespace.md)
-Functions in the `fast_math` namespace are not C99-conformant. Only single-precision versions of each function are provided. These functions use the DirectX intrinsic functions, which are faster than the corresponding functions in the `precise_math` namespace and do not require extended double-precision support on the accelerator, but they are less accurate. There are two versions of each function for source-level compatibility with C99 code; both versions take and return single-precision values. - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md)
-Provides types and functions that are designed for graphics programming. - -[Concurrency::precise_math Namespace](concurrency-precise-math-namespace.md)
-Functions in the `precise_math` namespace are C99 conformant. Both single-precision and double-precision versions of each function are included. These functions—this includes the single-precision functions—require extended double-precision support on the accelerator. - -## Related Sections - -[C++ AMP (C++ Accelerated Massive Parallelism)](../../../parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md)
-C++ AMP accelerates the execution of your C++ code by taking advantage of the data-parallel hardware that's commonly present as a graphics processing unit (GPU) on a discrete graphics card. diff --git a/docs/parallel/amp/reference/runtime-exception-class.md b/docs/parallel/amp/reference/runtime-exception-class.md deleted file mode 100644 index ae03941949e..00000000000 --- a/docs/parallel/amp/reference/runtime-exception-class.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "runtime_exception Class" -description: "Learn more about: runtime_exception Class" -ms.date: 03/27/2019 -f1_keywords: ["runtime_exception", "AMPRT/runtime_exception", "AMPRT/Concurrency::runtime_exception", "AMPRT/Concurrency::runtime_exception::get_error_code"] -helpviewer_keywords: ["runtime_exception class"] ---- -# runtime_exception Class - -The base type for exceptions in the C++ Accelerated Massive Parallelism (AMP) library. - -### Syntax - -```cpp -class runtime_exception : public std::exception; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[runtime_exception Constructor](#ctor)|Initializes a new instance of the `runtime_exception` class.| -|[~runtime_exception Destructor](#dtor)|Destroys the `runtime_exception` object.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[get_error_code](#get_error_code)|Returns the error code that caused the exception.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator=](#operator_eq)|Copies the contents of the specified `runtime_exception` object into this one.| - -## Inheritance Hierarchy - -`exception` - -`runtime_exception` - -## Requirements - -**Header:** amprt.h - -**Namespace:** Concurrency - -## runtime_exception Constructor - -Initializes a new instance of the class. - -### Syntax - -```cpp -runtime_exception( - const char * _Message, - HRESULT _Hresult ) throw(); - -explicit runtime_exception( - HRESULT _Hresult ) throw(); - -runtime_exception( - const runtime_exception & _Other ) throw(); -``` - -### Parameters - -*_Message*
-A description of the error that caused the exception. - -*_Hresult*
-The HRESULT of error that caused the exception. - -*_Other*
-The `runtime_exception` object to copy. - -### Return Value - -The `runtime_exception` object. - -## ~runtime_exception Destructor - -Destroys the object. - -### Syntax - -```cpp -virtual ~runtime_exception() throw(); -``` - -## get_error_code - -Returns the error code that caused the exception. - -### Syntax - -```cpp -HRESULT get_error_code() const throw(); -``` - -### Return Value - -The HRESULT of error that caused the exception. - -## operator= - -Copies the contents of the specified `runtime_exception` object into this one. - -### Syntax - -```cpp -runtime_exception & operator= ( const runtime_exception & _Other ) throw(); -``` - -### Parameters - -*_Other*
-The `runtime_exception` object to copy. - -### Return Value - -A reference to this `runtime_exception` object. - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/sampler-class.md b/docs/parallel/amp/reference/sampler-class.md deleted file mode 100644 index 5542115588c..00000000000 --- a/docs/parallel/amp/reference/sampler-class.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -description: "Learn more about: sampler Class" -title: "sampler Class" -ms.date: "06/28/2018" -f1_keywords: ["sampler", "AMP_GRAPHICS/sampler", "AMP_GRAPHICS/concurrency::sampler::graphics::sampler", "AMP_GRAPHICS/concurrency::sampler::graphics::get_address_mode", "AMP_GRAPHICS/concurrency::sampler::graphics::get_border_color", "AMP_GRAPHICS/concurrency::sampler::graphics::get_filter_mode", "AMP_GRAPHICS/concurrency::sampler::graphics::address_mode", "AMP_GRAPHICS/concurrency::sampler::graphics::border_color", "AMP_GRAPHICS/concurrency::sampler::graphics::filter_mode"] -ms.assetid: 9a6a9807-497d-402d-b092-8c4d86275b80 ---- -# sampler Class - -The sampler class aggregates sampling configuration information to be used for texture sampling. - -## Syntax - -```cpp -class sampler; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[sampler Constructor](#ctor)|Overloaded. Constructs a sampler instance.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[get_address_mode](#get_address_mode)|Returns the `address_mode` that's associated with the sampler object.| -|[get_border_color](#get_border_color)|Returns the border color that's associated with the sampler object.| -|[get_filter_mode](#get_filter_mode)|Returns the `filter_mode` that's associated with the sampler object.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator=](#operator_eq)|Overloaded. Assignment operator.| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|[address_mode](#address_mode)|Gets the address mode of the `sampler` object.| -|[border_color](#border_color)|Gets the border color of the `sampler` object.| -|[filter_mode](#filter_mode)|Gets the filter mode of the `sampler` object.| - -## Inheritance Hierarchy - -`sampler` - -## Requirements - -**Header:** amp_graphics.h - -**Namespace:** concurrency::graphics - -## sampler - -Constructs an instance of the [sampler Class](sampler-class.md). - -```cpp -sampler() restrict(cpu); // [1] default constructor - -sampler( // [2] constructor - filter_mode _Filter_mode) restrict(cpu); - -sampler( // [3] constructor - address_mode _Address_mode, - float_4 _Border_color = float_4(0.0f, - 0.0f, - 0.0f, - 0.0f)) restrict(cpu); - -sampler( // [4] constructor - filter_mode _Filter_mode, - address_mode _Address_mode, - float_4 _Border_color = float_4(0.0f, - 0.0f, - 0.0f, - 0.0f)) restrict(cpu); - -sampler( // [5] copy constructor - const sampler& _Other) restrict(amp, - cpu); - -sampler( // [6] move constructor - sampler&& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_Filter_mode*
-The filter mode to be used in sampling. - -*_Address_mode*
-The addressing mode to be used in sampling for all dimensions. - -*_Border_color*
-The border color to be used if the address mode is address_border. The default value is `float_4(0.0f, 0.0f, 0.0f, 0.0f)`. - -*_Other*
-[5] Copy Constructor -The `sampler` object to copy into the new `sampler` instance. - -[6] Move Constructor -The `sampler` object to move into the new `sampler` instance. - -## address_mode - -Gets the address mode of the `sampler` object. - -```cpp -__declspec(property(get= get_address_mode)) Concurrency::graphics::address_mode address_mode; -``` - -## border_color - -Gets the border color of the `sampler` object. - -```cpp -__declspec(property(get= get_border_color)) Concurrency::graphics::float_4 border_color; -``` - -## filter_mode - -Gets the filter mode of the `sampler` object. - -```cpp -__declspec(property(get= get_filter_mode)) Concurrency::graphics::filter_mode filter_mode; -``` - -## get_address_mode - -Returns the filter mode that's configured for this `sampler`. - -```cpp -Concurrency::graphics::address_mode get_address_mode() const __GPU; -``` - -### Return Value - -The address mode that's configured for the sampler. - -## get_border_color - -Returns the border color that's configured for this `sampler`. - -```cpp -Concurrency::graphics::float_4 get_border_color() const restrict(amp, cpu); -``` - -### Return Value - -A float_4 that contains the border color. - -## get_filter_mode - -Returns the filter mode that's configured for this `sampler`. - -```cpp -Concurrency::graphics::filter_mode get_filter_mode() const restrict(amp, cpu); -``` - -### Return Value - -The filter mode that's configured for the sampler. - -## operator= - -Assigns the value of another sampler object to an existing sampler. - -```cpp -sampler& operator= ( // [1] copy assignment operator - const sampler& _Other) restrict(amp, cpu); - -sampler& operator= ( // [2] move assignment operator - sampler&& _Other) restrict(amp, cpu); -``` - -### Parameters - -*_Other*
-[1] Copy Assignment Operator -The `sampler` object to copy into this `sampler`. - -[2] Move Assignment Operator -The `sampler` object to move into this `sampler`. - -### Return Value - -A reference to this sampler instance. - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/scoped-d3d-access-lock-class.md b/docs/parallel/amp/reference/scoped-d3d-access-lock-class.md deleted file mode 100644 index 8a6888a479a..00000000000 --- a/docs/parallel/amp/reference/scoped-d3d-access-lock-class.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -description: "Learn more about: scoped_d3d_access_lock Class" -title: "scoped_d3d_access_lock Class" -ms.date: "11/04/2016" -f1_keywords: ["scoped_d3d_access_lock", "AMPRT/scoped_d3d_access_lock", "AMPRT/concurrency::direct3d::scoped_d3d_access_lock::scoped_d3d_access_lock"] -ms.assetid: 0ad333e6-9839-4736-a722-16d95d70c4b1 ---- -# scoped_d3d_access_lock Class - -RAII wrapper for a D3D access lock on an accelerator_view object. - -## Syntax - -```cpp -class scoped_d3d_access_lock; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[scoped_d3d_access_lock Constructor](#ctor)|Overloaded. Constructs a `scoped_d3d_access_lock` object. The lock is released when this object goes out of scope.| -|[~scoped_d3d_access_lock Destructor](#dtor)|Releases the D3D access lock on the associated `accelerator_view` object.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator=](#operator_eq)|Takes ownership of a lock from another `scoped_d3d_access_lock`.| - -## Inheritance Hierarchy - -`scoped_d3d_access_lock` - -## Requirements - -**Header:** amprt.h - -**Namespace:** concurrency::direct3d - -## scoped_d3d_access_lock - -Constructs a `scoped_d3d_access_lock` object. The lock is released when this object goes out of scope. - -```cpp -explicit scoped_d3d_access_lock(// [1] constructor - accelerator_view& _Av); - -explicit scoped_d3d_access_lock(// [2] constructor - accelerator_view& _Av, - adopt_d3d_access_lock_t _T); - -scoped_d3d_access_lock(// [3] move constructor - scoped_d3d_access_lock&& _Other); -``` - -### Parameters - -*_Av*
-The `accelerator_view` for the lock to adopt. - -*_T*
-The `adopt_d3d_access_lock_t` object. - -*_Other*
-The `scoped_d3d_access_lock` object from which to move an existing lock. - -## Construction - -[1] Constructor -Acquires a D3D access lock on the given [accelerator_view](accelerator-view-class.md) object. Construction blocks until the lock is acquired. - -[2] Constructor -Adopt a D3D access lock from the given [accelerator_view](accelerator-view-class.md) object. - -[3] Move Constructor -Takes an existing D3D access lock from another `scoped_d3d_access_lock` object. Construction does not block. - -## ~scoped_d3d_access_lock - -Releases the D3D access lock on the associated `accelerator_view` object. - -```cpp -~scoped_d3d_access_lock(); -``` - -## operator= - -Takes ownership of a D3D access lock from another `scoped_d3d_access_lock` object, releasing the previous lock. - -```cpp -scoped_d3d_access_lock& operator= (scoped_d3d_access_lock&& _Other); -``` - -### Parameters - -*_Other*
-The accelerator_view from which to move the D3D access lock. - -### Return Value - -A reference to this `scoped_accelerator_view_lock`. - -## See also - -[Concurrency::direct3d Namespace](concurrency-direct3d-namespace.md) diff --git a/docs/parallel/amp/reference/short-vector-structure.md b/docs/parallel/amp/reference/short-vector-structure.md deleted file mode 100644 index f35a36cbd38..00000000000 --- a/docs/parallel/amp/reference/short-vector-structure.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -description: "Learn more about: short_vector Structure" -title: "short_vector Structure" -ms.date: "11/04/2016" -f1_keywords: ["short_vector", "AMP_SHORT_VECTORS/short_vector", "AMP_SHORT_VECTORS/Concurrency::graphics::short_vector::short_vector Constructor"] -ms.assetid: e4f50b8f-1150-437d-b58c-79c5fb883708 ---- -# short_vector Structure - -short_vector provides metaprogramming definitions which are useful for programming short vectors generically. - -## Syntax - -```cpp -template< - typename _Scalar_type, - int _Size -> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -template<> -struct short_vector; -``` - -### Parameters - -*_Scalar_type*
- -*_Size*
- -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[short_vector::short_vector Constructor](#ctor)|| - -## Inheritance Hierarchy - -`short_vector` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## short_vector::short_vector Constructor - -```cpp -short_vector(); -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/short-vector-traits-structure.md b/docs/parallel/amp/reference/short-vector-traits-structure.md deleted file mode 100644 index 671761e5cdf..00000000000 --- a/docs/parallel/amp/reference/short-vector-traits-structure.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -description: "Learn more about: short_vector_traits Structure" -title: "short_vector_traits Structure" -ms.date: "11/04/2016" -f1_keywords: ["short_vector_traits", "AMP_SHORT_VECTORS/short_vector_traits", "AMP_SHORT_VECTORS/Concurrency::graphics::short_vector_traits::short_vector_traits", "AMP_SHORT_VECTORS/Concurrency::graphics::short_vector_traits::size Constant"] -ms.assetid: cd9492da-9e02-4a6e-9d50-b61252cdb460 ---- -# short_vector_traits Structure - -short_vector_traits allows retrieval of the underlying vector length and scalar type of a short vector type or a scalar type - -## Syntax - -```cpp -template< - typename T -> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -template<> -struct short_vector_traits; -``` - -### Parameters - -`T` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[short_vector_traits::short_vector_traits Constructor](#ctor)|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[short_vector_traits::size Constant](#size)|| - -## Inheritance Hierarchy - -`short_vector_traits` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## short_vector_traits::short_vector_traits Constructor - -```cpp -short_vector_traits(); -``` - -## short_vector_traits::size Constant - -```cpp -static int const size = 1; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/texture-class.md b/docs/parallel/amp/reference/texture-class.md deleted file mode 100644 index 67d5044baea..00000000000 --- a/docs/parallel/amp/reference/texture-class.md +++ /dev/null @@ -1,579 +0,0 @@ ---- -title: "texture Class" -description: "Learn more about: texture Class" -ms.date: 11/04/2016 -f1_keywords: ["texture", "AMP_GRAPHICS/texture", "AMP_GRAPHICS/concurrency::graphics::texture::texture", "AMP_GRAPHICS/concurrency::graphics::texture::copy_to", "AMP_GRAPHICS/concurrency::graphics::texture::data", "AMP_GRAPHICS/concurrency::graphics::texture::get", "AMP_GRAPHICS/concurrency::graphics::texture::get_associated_accelerator_view", "AMP_GRAPHICS/concurrency::graphics::texture::get_depth_pitch", "AMP_GRAPHICS/concurrency::graphics::texture::get_row_pitch", "AMP_GRAPHICS/concurrency::graphics::texture::set", "AMP_GRAPHICS/concurrency::graphics::texture::rank", "AMP_GRAPHICS/concurrency::graphics::texture::associated_accelerator_view", "AMP_GRAPHICS/concurrency::graphics::texture::depth_pitch", "AMP_GRAPHICS/concurrency::graphics::texture::row_pitch"] ---- -# texture Class - -A texture is a data aggregate on an `accelerator_view` in the extent domain. It is a collection of variables, one for each element in an extent domain. Each variable holds a value corresponding to C++ primitive type ( **`unsigned int`**, **`int`**, **`float`**, **`double`**), a scalar type (`norm`, or `unorm`), or a short vector type. - -## Syntax - -```cpp -template -class texture; -``` - -### Parameters - -*value_type*
-The type of the elements in the texture. - -*_Rank*
-The rank of the texture. - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`scalar_type`|Scalar types.| -|`value_type`|Value types.| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[texture Constructor](#ctor)|Initializes a new instance of the `texture` class.| -|[~texture Destructor](#ctor)|Destroys the `texture` object.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[copy_to](#copy_to)|Copies the `texture` object to the destination, by doing a deep copy.| -|[data](#data)|Returns a CPU pointer to the raw data of this texture.| -|[get](#get)|Returns the value of the element at the specified index.| -|[get_associated_accelerator_view](#get_associated_accelerator_view)|Returns the [accelerator_view](accelerator-view-class.md) that is the preferred target for this texture to be copied to.| -|[get_depth_pitch](#get_depth_pitch)|Returns the number of bytes between each depth slice in a 3D staging texture on the CPU.| -|[get_row_pitch](#get_row_pitch)|Returns the number of bytes between each row in a 2D or 3D staging texture on the CPU.| -|[set](#set)|Sets the value of the element at the specified index.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator()](#operator_call)|Returns the element value that is specified by the parameters.| -|[operator\[\]](#operator_at)|Returns the element that is at the specified index.| -|[operator=](#operator_eq)|Copies the specified [texture](texture-class.md) object to this one.| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[rank Constant](#rank)|Gets the rank of the `texture` object.| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|[associated_accelerator_view](#associated_accelerator_view)|Gets the [accelerator_view](accelerator-view-class.md) that is the preferred target for this texture to be copied to.| -|[depth_pitch](#depth_pitch)|Gets the number of bytes between each depth slice in a 3D staging texture on the CPU.| -|[row_pitch](#row_pitch)|Gets the number of bytes between each row in a 2D or 3D staging texture on the CPU.| - -## Inheritance Hierarchy - -`_Texture_base` - -`texture` - -## Requirements - -**Header:** amp_graphics.h - -**Namespace:** Concurrency::graphics - -## ~texture - -Destroys the `texture` object. - -```cpp -~texture() restrict(cpu); -``` - -## associated_accelerator_view - -Gets the [accelerator_view](accelerator-view-class.md) that is the preferred target for this texture to be copied to. - -```cpp -__declspec(property(get= get_associated_accelerator_view)) Concurrency::accelerator_view associated_accelerator_view; -``` - -## copy_to - -Copies the `texture` object to the destination, by doing a deep copy. - -```cpp -void copy_to(texture& _Dest) const; -void copy_to(writeonly_texture_view& _Dest) const; -``` - -### Parameters - -*_Dest*
-The object to copy to. - -*_Rank*
-The rank of the texture. - -*value_type*
-The type of the elements in the texture. - -## data - -Returns a CPU pointer to the raw data of this texture. - -```cpp -void* data() restrict(cpu); - -const void* data() const restrict(cpu); -``` - -### Return Value - -A pointer to the raw data of the texture. - -## depth_pitch - -Gets the number of bytes between each depth slice in a 3D staging texture on the CPU. - -```cpp -__declspec(property(get= get_depth_pitch)) unsigned int depth_pitch; -``` - -## get - -Returns the value of the element at the specified index. - -```cpp -const value_type get(const index<_Rank>& _Index) const restrict(amp); -``` - -### Parameters - -*_Index*
-The index of the element. - -### Return Value - -The value of the element at the specified index. - -## get_associated_accelerator_view - -Returns the accelerator_view that is the preferred target for this texture to be copied to. - -```cpp -Concurrency::accelerator_view get_associated_accelerator_view() const restrict(cpu); -``` - -### Return Value - -The [accelerator_view](accelerator-view-class.md) that is the preferred target for this texture to be copied to. - -## get_depth_pitch - -Returns the number of bytes between each depth slice in a 3D staging texture on the CPU. - -```cpp -unsigned int get_depth_pitch() const restrict(cpu); -``` - -### Return Value - -The number of bytes between each depth slice in a 3D staging texture on the CPU. - -## get_row_pitch - -Returns the number of bytes between each row in a 2-dimensional staging texture, or between each row of a depth slice in 3-dimensional staging texture. - -```cpp -unsigned int get_row_pitch() const restrict(cpu); -``` - -### Return Value - -The number of bytes between each row in a 2-dimensional staging texture, or between each row of a depth slice in 3-dimensional staging texture. - -## operator() - -Returns the element value that is specified by the parameters. - -```cpp -const value_type operator() ( - const index<_Rank>& _Index) const restrict(amp); - -const value_type operator() ( - int _I0) const restrict(amp); - -const value_type operator() ( - int _I0, - int _I1) const restrict(amp); - -const value_type operator() ( - int _I0, - int _I1, - int _I2) const restrict(amp); -``` - -### Parameters - -*_Index*
-The index. - -*_I0*
-The most-significant component of the index. - -*_I1*
-The next-to-most-significant component of the index. - -*_I2*
-The least-significant component of the index. - -*_Rank*
-The rank of the index. - -### Return Value - -The element value that is specified by the parameters. - -## operator[] - -Returns the element that is at the specified index. - -```cpp -const value_type operator[] (const index<_Rank>& _Index) const restrict(amp); - -const value_type operator[] (int _I0) const restrict(amp); -``` - -### Parameters - -*_Index*
-The index. - -*_I0*
-The index. - -### Return Value - -The element that is at the specified index. - -## operator= - -Copies the specified [texture](texture-class.md) object to this one. - -```cpp -texture& operator= ( - const texture& _Other); - -texture& operator= ( - texture&& _Other); -``` - -### Parameters - -*_Other*
-The `texture` object to copy from. - -### Return Value - -A reference to this `texture` object. - -## rank - -Gets the rank of the `texture` object. - -```cpp -static const int rank = _Rank; -``` - -## row_pitch - -Gets the number of bytes between each row in a 2D or 3D staging texture on the CPU. - -```cpp -__declspec(property(get= get_row_pitch)) unsigned int row_pitch; -``` - -## set - -Sets the value of the element at the specified index. - -```cpp -void set( - const index<_Rank>& _Index, - const value_type& value) restrict(amp); -``` - -### Parameters - -*_Index*
-The index of the element. - -*_Rank*
-The rank of the index. - -*value*
-The new value of the element. - -## texture - -Initializes a new instance of the `texture` class. - -```cpp -texture(const Concurrency::extent<_Rank>& _Ext) restrict(cpu); - -texture(int _E0) restrict(cpu); - -texture(int _E0, int _E1) restrict(cpu); - -texture(int _E0, int _E1, int _E2) restrict(cpu); - -texture( - const Concurrency::extent<_Rank>& _Ext, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -texture( - int _E0, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -texture( - int _E0, - int _E1, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -texture( - int _E0, - int _E1, - int _E2, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -template -texture( - const Concurrency::extent<_Rank>& _Ext, - _Input_iterator _Src_first, - _Input_iterator _Src_last) restrict(cpu); - -template -texture( - int _E0, _Input_iterator _Src_first, _Input_iterator _Src_last) restrict(cpu); - -template -texture( - int _E0, - int _E1, - _Input_iterator _Src_first, - _Input_iterator _Src_last) restrict(cpu); - -template -texture( - int _E0, - int _E1, - int _E2, - _Input_iterator _Src_first, - _Input_iterator _Src_last) restrict(cpu); - -template -texture( - const Concurrency::extent<_Rank>& _Ext, - _Input_iterator _Src_first, - _Input_iterator _Src_last, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -template -texture( - int _E0, - _Input_iterator _Src_first, - _Input_iterator _Src_last, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -template -texture( - int _E0, - int _E1, - _Input_iterator _Src_first, - _Input_iterator _Src_last, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -template -texture( - int _E0, - int _E1, - int _E2, - _Input_iterator _Src_first, - _Input_iterator _Src_last, - const Concurrency::accelerator_view& _Av) restrict(cpu)) ; - -texture( - int _E0, - unsigned int _Bits_per_scalar_element) restrict(cpu); - -texture( - int _E0, - int _E1, - unsigned int _Bits_per_scalar_element) restrict(cpu); - -texture( - int _E0, - int _E1, - int _E2, - unsigned int _Bits_per_scalar_element) restrict(cpu); - -texture( - const Concurrency::extent<_Rank>& _Ext, - unsigned int _Bits_per_scalar_element, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -texture( - int _E0, - unsigned int _Bits_per_scalar_element, - const Concurrency::accelerator_view& _Av) ; - -texture( - int _E0, - int _E1, - unsigned int _Bits_per_scalar_element, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -texture( - int _E0, - int _E1, - int _E2, - unsigned int _Bits_per_scalar_element, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -texture( - const Concurrency::extent<_Rank>& _Ext, - _In_ void* _Source, - unsigned int _Src_byte_size, - unsigned int _Bits_per_scalar_element) restrict(cpu); - -texture( - int _E0, - _In_ void* _Source, - unsigned int _Src_byte_size, - unsigned int _Bits_per_scalar_element) restrict(cpu); - -texture( - int _E0, - int _E1, - _In_ void* _Source, - unsigned int _Src_byte_size, - unsigned int _Bits_per_scalar_element) restrict(cpu); - -texture( - int _E0, - int _E1, - int _E2, - _In_ void* _Source, - unsigned int _Src_byte_size, - unsigned int _Bits_per_scalar_element) restrict(cpu); - -texture( - const Concurrency::extent<_Rank>& _Ext, - _In_ void* _Source, - unsigned int _Src_byte_size, - unsigned int _Bits_per_scalar_element, - const Concurrency::accelerator_view& _Av) ; - -texture( - int _E0, - _In_ void* _Source, - unsigned int _Src_byte_size, - unsigned int _Bits_per_scalar_element, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -texture( - int _E0, - int _E1, - _In_ void* _Source, - unsigned int _Src_byte_size, - unsigned int _Bits_per_scalar_element, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -texture( - int _E0, - int _E1, - int _E2, - _In_ void* _Source, - unsigned int _Src_byte_size, - unsigned int _Bits_per_scalar_element, - const Concurrency::accelerator_view& _Av) restrict(cpu); - -texture( - const texture& _Src, - const Concurrency::accelerator_view& _Acc_view); - -texture( - texture&& _Other); - -texture( - const Concurrency::extent<_Rank>& _Ext, - unsigned int _Bits_per_scalar_element, - const Concurrency::accelerator_view& _Av); - -texture( - const texture& _Src); -``` - -### Parameters - -*_Acc_view*
-The [accelerator_view](accelerator-view-class.md) that specifies the location of the texture. - -*_Av*
-The [accelerator_view](accelerator-view-class.md) that specifies the location of the texture. - -*_Associated_av*
-An accelerator_view that specifies the preferred target for copies to or from this texture. - -*_Bits_per_scalar_element*
-The number of bits per each scalar element in the underlying scalar type of the texture. In general, supported value are 8, 16, 32, and 64. If 0 is specified, the number of bits is the same as the underlying scalar_type. 64 is only valid for double-based textures. - -*_Ext*
-The extent in each dimension of the texture. - -*_E0*
-The most significant component of the texture. - -*_E1*
-The next-to-most-significant component of the texture. - -*_E2*
-The least significant component of the extent of the texture. - -*_Input_iterator*
-The type of the input iterator. - -*_Mipmap_levels*
-The number of mipmap levels in the underlying texture. If 0 is specified, the texture will have the full range of mipmap levels down to the smallest possible size for the specified extent. - -*_Rank*
-The rank of the extent. - -*_Source*
-A pointer to a host buffer. - -*_Src*
-To texture to copy. - -*_Src_byte_size*
-The number of bytes in the source buffer. - -*_Src_first*
-A beginning iterator into the source container. - -*_Src_last*
-An ending iterator into the source container. - -*_Other*
-Other data source. - -*_Rank*
-The rank of the section. - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/texture-view-class.md b/docs/parallel/amp/reference/texture-view-class.md deleted file mode 100644 index 2ab64c9f966..00000000000 --- a/docs/parallel/amp/reference/texture-view-class.md +++ /dev/null @@ -1,479 +0,0 @@ ---- -description: "Learn more about: texture_view Class" -title: "texture_view Class" -ms.date: "11/04/2016" -f1_keywords: ["texture_view", "AMP_GRAPHICS/texture_view", "AMP_GRAPHICS/Concurrency::graphics::texture_view::texture_view", "AMP_GRAPHICS/Concurrency::graphics::texture_view::gather_alpha", "AMP_GRAPHICS/Concurrency::graphics::texture_view::gather_blue", "AMP_GRAPHICS/Concurrency::graphics::texture_view::gather_green", "AMP_GRAPHICS/Concurrency::graphics::texture_view::gather_red", "AMP_GRAPHICS/Concurrency::graphics::texture_view::get", "AMP_GRAPHICS/Concurrency::graphics::texture_view::sample", "AMP_GRAPHICS/Concurrency::graphics::texture_view::set", "AMP_GRAPHICS/Concurrency::graphics::texture_view::value_type"] -ms.assetid: 6ec2e289-1626-4727-9592-07981cf1d27d ---- -# texture_view Class - -Provides read access and write access to a texture. `texture_view` can only be used to read textures whose value type is **`int`**, **`unsigned int`**, or **`float`** that have default 32-bit bpse. To read other texture formats, use `texture_view`. - -## Syntax - -```cpp -template -class texture_view; - -template -class texture_view - : public details::_Texture_base; - -template -class texture_view - : public details::_Texture_base; -``` - -### Parameters - -*value_type*
-The type of the elements in the texture aggregate. - -*_Rank*
-The rank of the `texture_view`. - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|The type of the elements in the texture aggregates.| -|`coordinates_type`|The type of the coordinate used to specify a texel in the `texture_view`—that is, a `short_vector` that has the same rank as the associated texture that has a value type of **`float`**.| -|`gather_return_type`|The return type used for gather operations—that is, a rank 4 `short_vector` that holds the four homogeneous color components gathered from the four texel values sampled.| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[texture_view Constructor](#ctor)|Overloaded. Constructs a `texture_view` instance.| -|[~texture_view Destructor](#ctor)|Destroys the `texture_view` instance.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[gather_alpha](#gather_alpha)|Overloaded. Samples the texture at the specified coordinates by using the specified sampling configuration and returns the alpha (w) components of the four sampled texels.| -|[gather_blue](#gather_blue)|Overloaded. Samples the texture at the specified coordinates by using the specified sampling configuration and returns the blue (z) components of the four sampled texels.| -|[gather_green](#gather_green)|Overloaded. Samples the texture at the specified coordinates by using the specified sampling configuration and returns the green (y) components of the four sampled texels.| -|[gather_red](#gather_red)|Overloaded. Samples the texture at the specified coordinates by using the specified sampling configuration and returns the red (x) components of the four sampled texels.| -|[get](#get)|Overloaded. Gets the element value by index.| -|[sample](#sample)|Overloaded. Samples the texture at the specified coordinates and level of detail by using the specified sampling configuration.| -|[set](#set)|Sets the value of an element by index.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator()](#operator_call)|Overloaded. Gets the element value by index.| -|[operator\[\]](#operator_at)|Overloaded. Gets the element value by index.| -|[operator=](#operator_eq)|Overloaded. Assignment operator.| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|[value_type](#value_type)|The value type of the elements of the `texture_view`.| - -## Inheritance Hierarchy - -`_Texture_base` - -`texture_view` - -## Requirements - -**Header:** amp_graphics.h - -**Namespace:** concurrency::graphics - -## ~texture_view - -Destroys the `texture_view` instance. - -```cpp -~texture_view() restrict(amp, cpu); -``` - -## texture_view - -Constructs a `texture_view` instance. - -```cpp -texture_view(// [1] constructor - texture& _Src) restrict(amp); - -texture_view(// [2] constructor - texture& _Src, - unsigned int _Mipmap_level = 0) restrict(cpu); - -texture_view(// [3] constructor - const texture& _Src) restrict(amp); - -texture_view(// [4] constructor - const texture& _Src, - unsigned int _Most_detailed_mip, - unsigned int _Mip_levels) restrict(cpu); - -texture_view(// [5] copy constructor - const texture_view& _Other) restrict(amp, cpu); - -texture_view(// [6] copy constructor - const texture_view& _Other) restrict(amp, cpu); - -texture_view(// [7] copy constructor - const texture_view& _Other, - unsigned int _Most_detailed_mip, - unsigned int _Mip_levels) restrict(cpu); -``` - -### Parameters - -*_Src*
-[1, 2] Constructor -The `texture` on which the writable `texture_view` is created. - -[3, 4] Constructor -The `texture` on which the non-writable `texture_view` is created. - -*_Other*
-[5] Copy Constructor -The source writable `texture_view`. - -[6, 7] Copy Constructor -The source non-writable `texture_view`. - -*_Mipmap_level*
-The specific mipmap level on the source `texture` that this writeable `texture_view` binds to. The default value is 0, which represents the top level (most detailed) mip level. - -*_Most_detailed_mip*
-Top level (most detailed) mip level for the view, relative to the specified `texture_view` object. - -*_Mip_levels*
-The number of mipmap levels accessible through the `texture_view`. - -## gather_red - -Samples the texture at the specified coordinates by using the specified sampling configuration and returns the red (x) components of the four sampled texels. - -```cpp -const gather_return_type gather_red( - const sampler& _Sampler, - const coordinates_type& _Coord) const restrict(amp); - -template< - address_mode _Address_mode = address_clamp -> -const gather_return_type gather_red( - const coordinates_type& _Coord) const restrict(amp); -``` - -### Parameters - -*_Address_mode*
-The address mode to use to sample the `texture_view`. The address mode is the same for all dimensions. - -*_Sampler*
-The sampler configuration to use to sample the `texture_view`. - -*_Coord*
-The coordinates to take the sample from. Fractional coordinate values are used to interpolate between sample texels. - -### Return Value - -A rank 4 short vector containing the red (x) component of the 4 sampled texel values. - -## gather_green - -Samples the texture at the specified coordinates by using the specified sampling configuration and returns the green (y) components of the four sampled texels. - -```cpp -const gather_return_type gather_green( - const sampler& _Sampler, - const coordinates_type& _Coord) const restrict(amp); - -template< - address_mode _Address_mode = address_clamp -> -const gather_return_type gather_green( - const coordinates_type& _Coord) const restrict(amp); -``` - -### Parameters - -*_Address_mode*
-The address mode to use to sample the `texture_view`. The address mode is the same for all dimensions. - -*_Sampler*
-The sampler configuration to use to sample the `texture_view`. - -*_Coord*
-The coordinates to take the sample from. Fractional coordinate values are used to interpolate between sample texels. - -### Return Value - -A rank 4 short vector containing the green (y) component of the 4 sampled texel values. - -## gather_blue - -Samples the texture at the specified coordinates by using the specified sampling configuration and returns the blue (z) components of the four sampled texels. - -```cpp -const gather_return_type gather_blue( - const sampler& _Sampler, - const coordinates_type& _Coord) const restrict(amp); - -template< - address_mode _Address_mode = address_clamp -> -const gather_return_type gather_blue( - const coordinates_type& _Coord) const restrict(amp); -``` - -### Parameters - -*_Address_mode*
-The address mode to use to sample the `texture_view`. The address mode is the same for all dimensions. - -*_Sampler*
-The sampler configuration to use to sample the `texture_view`. - -*_Coord*
-The coordinates to take the sample from. Fractional coordinate values are used to interpolate between sample texels. - -### Return Value - -A rank 4 short vector containing the red (x) component of the 4 sampled texel values. - -## gather_alpha - -Samples the texture at the specified coordinates by using the specified sampling configuration and returns the alpha (w) components of the four sampled texels. - -```cpp -const gather_return_type gather_alpha( - const sampler& _Sampler, - const coordinates_type& _Coord) const restrict(amp); - -template< - address_mode _Address_mode = address_clamp -> -const gather_return_type gather_alpha( - const coordinates_type& _Coord) const restrict(amp); -``` - -### Parameters - -*_Address_mode*
-The address mode to use to sample the `texture_view`. The address mode is the same for all dimensions. - -*_Sampler*
-The sampler configuration to use to sample the `texture_view`. - -*_Coord*
-The coordinates to take the sample from. Fractional coordinate values are used to interpolate between sample texels. - -### Return Value - -A rank 4 short vector containing the alpha (w) component of the 4 sampled texel values. - -## get - -Gets the value of the element at the specified index. - -```cpp -const value_type get( - const index<_Rank>& _Index) const restrict(amp); - -value_type get( - const index<_Rank>& _Index, - unsigned int _Mip_level = 0) const restrict(amp); -``` - -### Parameters - -*_Index*
-The index of the element to get, possibly multi-dimensional. - -*_Mip_level*
-The mipmap level from which we should get the value. The default value 0 represents the most detailed mipmap level. - -### Return Value - -The value of the element. - -## operator= - -Assigns a view of the same texture as the specified `texture_view` to this `texture_view` instance. - -```cpp -texture_view& operator= (// [1] copy constructor - const texture_view& _Other) restrict(amp, cpu); - -texture_view& operator= (// [2] copy constructor - const texture_view& _Other) restrict(cpu); - -texture_view& operator= (// [3] copy constructor - const texture_view& _Other) restrict(amp, cpu); -``` - -### Parameters - -*_Other*
-[1, 2] Copy Constructor -A writable `texture_view` object. - -[3] Copy Constructor -A non-writable `texture_view` object. - -### Return Value - -A reference to this `texture_view` instance. - -## operator[] - -Returns the element value by index. - -```cpp -const value_type operator[] (const index<_Rank>& _Index) const restrict(amp); - -const value_type operator[] (int _I0) const restrict(amp); - -value_type operator[] (const index<_Rank>& _Index) const restrict(amp); - -value_type operator[] (int _I0) const restrict(amp); -``` - -### Parameters - -*_Index*
-The index, possibly multi-dimensional. - -*_I0*
-The one-dimensional index. - -### Return Value - -The element value indexed by `_Index`. - -## operator() - -Returns the element value by index. - -```cpp -const value_type operator() ( - const index<_Rank>& _Index) const restrict(amp); - -const value_type operator() ( - int _I0) const restrict(amp); - -const value_type operator() ( - int _I0, int _I1) const restrict(amp); - -const value_type operator() ( - int _I0, - int _I1, - int _I2) const restrict(amp); - -value_type operator() ( - const index<_Rank>& _Index) const restrict(amp); - -value_type operator() ( - int _I0) const restrict(amp); - -value_type operator() ( - int _I0, - int _I1) const restrict(amp); - -value_type operator() ( - int _I0, - int _I1, - int _I2) const restrict(amp); -``` - -### Parameters - -*_Index*
-The index, possibly multi-dimensional. - -*_I0*
-The most-significant component of the index. - -*_I1*
-The next-to-most-significant component of the index. - -*_I2*
-The least-significant component of the index. - -### Return Value - -The element value indexed by `_Index`. - -## sample - -Samples the texture at the specified coordinates and level of detail by using the specified sampling configuration. - -```cpp -value_type sample( - const sampler& _Sampler, - const coordinates_type& _Coord, - float _Level_of_detail = 0.0f) const restrict(amp); - -template< - filter_mode _Filter_mode = filter_linear, - address_mode _Address_mode = address_clamp -> -value_type sample( - const coordinates_type& _Coord, - float _Level_of_detail = 0.0f) const restrict(amp); -``` - -### Parameters - -*_Filter_mode*
-The filter mode to use to sample the texture_view. The filter mode is the same for the minimization, maximization, and mipmap filters. - -*_Address_mode*
-The address mode to use to sample the texture_view. The address mode is the same for all dimensions. - -*_Sampler*
-The sampler configuration to use to sample the texture_view. - -*_Coord*
-The coordinates to take the sample from. Fractional coordinate values are used to interpolate between texel values. - -*_Level_of_detail*
-The value specifies the mipmap level to sample from. Fractional values are used to interpolate between two mipmap levels. The default level of detail is 0, which represents the most detailed mip level. - -### Return Value - -The interpolated sample value. - -## set - -Sets the value of the element at the specified index to the specified value. - -```cpp -void set( - const index<_Rank>& _Index, - const value_type& value) const restrict(amp); -``` - -### Parameters - -*_Index*
-The index of the element to set, possibly multi-dimensional. - -*value*
-The value to set the element to. - -## value_type - -The value type of the elements of the texture_view. - -```cpp -typedef typename const value_type value_type; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/tile-barrier-class.md b/docs/parallel/amp/reference/tile-barrier-class.md deleted file mode 100644 index d9c181b68bd..00000000000 --- a/docs/parallel/amp/reference/tile-barrier-class.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "tile_barrier Class" -description: "Learn more about: tile_barrier Class" -ms.date: "03/27/2019" -f1_keywords: ["tile_barrier", "AMP/tile_barrier", "AMP/Concurrency::tile_barrier::tile_barrier::tile_barrier", "AMP/Concurrency::tile_barrier::tile_barrier::wait", "AMP/Concurrency::tile_barrier::tile_barrier::wait_with_all_memory_fence", "AMP/Concurrency::tile_barrier::tile_barrier::wait_with_global_memory_fence", "AMP/Concurrency::tile_barrier::tile_barrier::wait_with_tile_static_memory_fence"] -helpviewer_keywords: ["tile_barrier class"] ---- -# tile_barrier Class - -Synchronizes the execution of threads that are running in the thread group (the tile) by using `wait` methods. Only the runtime can instantiate this class. - -## Syntax - -```cpp -class tile_barrier; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[tile_barrier Constructor](#ctor)|Initializes a new instance of the `tile_barrier` class.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[wait](#wait)|Instructs all threads in the thread group (tile) to stop executing until all threads in the tile have finished waiting.| -|[wait_with_all_memory_fence](#wait_with_all_memory_fence)|Blocks execution of all threads in a tile until all memory accesses have been completed and all threads in the tile have reached this call.| -|[wait_with_global_memory_fence](#wait_with_global_memory_fence)|Blocks execution of all threads in a tile until all global memory accesses have been completed and all threads in the tile have reached this call.| -|[wait_with_tile_static_memory_fence](#wait_with_tile_static_memory_fence)|Blocks execution of all threads in a tile until all `tile_static` memory accesses have been completed and all threads in the tile have reached this call.| - -## Inheritance Hierarchy - -`tile_barrier` - -## Requirements - -**Header:** amp.h - -**Namespace:** Concurrency - -## tile_barrier Constructor - -Initializes a new instance of the class by copying an existing one. - -### Syntax - -```cpp -tile_barrier( - const tile_barrier& _Other ) restrict(amp,cpu); -``` - -### Parameters - -*_Other*
-The `tile_barrier` object to copy. - -## wait - -Instructs all threads in the thread group (tile) to stop execution until all threads in the tile have finished waiting. - -### Syntax - -```cpp -void wait() const restrict(amp); -``` - -## wait_with_all_memory_fence - -Blocks execution of all threads in a tile until all threads in a tile have reached this call. This ensures that all memory accesses are visible to other threads in the thread tile, and have been executed in program order. - -### Syntax - -```cpp -void wait_with_all_memory_fence() const restrict(amp); -``` - -## wait_with_global_memory_fence - -Blocks execution of all threads in a tile until all threads in a tile have reached this call. This ensures that all global memory accesses are visible to other threads in the thread tile, and have been executed in program order. - -### Syntax - -```cpp -void wait_with_global_memory_fence() const restrict(amp); -``` - -## wait_with_tile_static_memory_fence - -Blocks execution of all threads in a tile until all threads in a tile have reached this call. This ensures that `tile_static` memory accesses are visible to other threads in the thread tile, and have been executed in program order. - -### Syntax - -```cpp -void wait_with_tile_static_memory_fence() const restrict(amp); -``` - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/tiled-extent-class.md b/docs/parallel/amp/reference/tiled-extent-class.md deleted file mode 100644 index ba3df5b31f3..00000000000 --- a/docs/parallel/amp/reference/tiled-extent-class.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -description: "Learn more about: tiled_extent Class" -title: "tiled_extent Class" -ms.date: "11/04/2016" -f1_keywords: ["tiled_extent", "AMP/tiled_extent", "AMP/Concurrency::tiled_extent::tiled_extent", "AMP/Concurrency::tiled_extent::get_tile_extent", "AMP/Concurrency::tiled_extent::pad", "AMP/Concurrency::tiled_extent::truncate", "AMP/Concurrency::tiled_extent::tile_dim0", "AMP/Concurrency::tiled_extent::tile_dim1", "AMP/Concurrency::tiled_extent::tile_dim2", "AMP/Concurrency::tiled_extent::tile_extent"] -ms.assetid: 671ecaf8-c7b0-4ac8-bbdc-e30bd92da7c0 ---- -# tiled_extent Class - -A `tiled_extent` object is an `extent` object of one to three dimensions that subdivides the extent space into one-, two-, or three-dimensional tiles. - -## Syntax - -```cpp -template < - int _Dim0, - int _Dim1, - int _Dim2 -> -class tiled_extent : public Concurrency::extent<3>; - -template < - int _Dim0, - int _Dim1 -> -class tiled_extent<_Dim0, _Dim1, 0> : public Concurrency::extent<2>; - -template < - int _Dim0 -> -class tiled_extent<_Dim0, 0, 0> : public Concurrency::extent<1>; -``` - -### Parameters - -*_Dim0*
-The length of the most significant dimension. - -*_Dim1*
-The length of the next-to-most significant dimension. - -*_Dim2*
-The length of the least significant dimension. - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[tiled_extent Constructor](#ctor)|Initializes a new instance of the `tiled_extent` class.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[get_tile_extent](#get_tile_extent)|Returns an `extent` object that captures the values of the `tiled_extent` template arguments `_Dim0`, `_Dim1`, and `_Dim2`.| -|[pad](#pad)|Returns a new `tiled_extent` object with extents adjusted up to be evenly divisible by the tile dimensions.| -|[truncate](#truncate)|Returns a new `tiled_extent` object with extents adjusted down to be evenly divisible by the tile dimensions.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator=](#operator_eq)|Copies the contents of the specified `tiled_index` object into this one.| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[tile_dim0 Constant](#tile_dim0)|Stores the length of the most significant dimension.| -|[tile_dim1 Constant](#tile_dim1)|Stores the length of the next-to-most significant dimension.| -|[tile_dim2 Constant](#tile_dim2)|Stores the length of the least significant dimension.| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|[tile_extent](#tile_extent)|Gets an `extent` object that captures the values of the `tiled_extent` template arguments `_Dim0`, `_Dim1`, and `_Dim2`.| - -## Inheritance Hierarchy - -`extent` - -`tiled_extent` - -## Requirements - -**Header:** amp.h - -**Namespace:** Concurrency - -## tiled_extent Constructor - -Initializes a new instance of the `tiled_extent` class. - -### Syntax - -```cpp -tiled_extent(); - -tiled_extent( - const Concurrency::extent& _Other ); - -tiled_extent( - const tiled_extent& _Other ); -``` - -### Parameters - -*_Other*
-The `extent` or `tiled_extent` object to copy. - -## get_tile_extent - -Returns an `extent` object that captures the values of the `tiled_extent` template arguments `_Dim0`, `_Dim1`, and `_Dim2`. - -### Syntax - -```cpp -Concurrency::extent get_tile_extent() const restrict(amp,cpu); -``` - -### Return Value - -An `extent` object that captures the dimensions of this `tiled_extent` instance. - -## pad - -Returns a new `tiled_extent` object with extents adjusted up to be evenly divisible by the tile dimensions. - -### Syntax - -```cpp -tiled_extent pad() const; -``` - -### Return Value - -The new `tiled_extent` object, by value. - -## truncate - -Returns a new `tiled_extent` object with extents adjusted down to be evenly divisible by the tile dimensions. - -### Syntax - -```cpp -tiled_extent truncate() const; -``` - -### Return Value - -Returns a new `tiled_extent` object with extents adjusted down to be evenly divisible by the tile dimensions. - -## operator= - -Copies the contents of the specified `tiled_index` object into this one. - -### Syntax - -```cpp -tiled_extent& operator= ( - const tiled_extent& _Other ) restrict (amp, cpu); -``` - -### Parameters - -*_Other*
-The `tiled_index` object to copy from. - -### Return Value - -A reference to this `tiled_index` instance. - -## tile_dim0 - -Stores the length of the most significant dimension. - -### Syntax - -```cpp -static const int tile_dim0 = _Dim0; -``` - -## tile_dim1 - -Stores the length of the next-to-most significant dimension. - -### Syntax - -```cpp -static const int tile_dim1 = _Dim1; -``` - -## tile_dim2 - -Stores the length of the least significant dimension. - -### Syntax - -```cpp -static const int tile_dim2 = _Dim2; -``` - -## tile_extent - -Gets an `extent` object that captures the values of the `tiled_extent` template arguments `_Dim0`, `_Dim1`, and `_Dim2`. - -### Syntax - -```cpp -__declspec(property(get= get_tile_extent)) Concurrency::extent tile_extent; -``` - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/tiled-index-class.md b/docs/parallel/amp/reference/tiled-index-class.md deleted file mode 100644 index 0ce0b17509e..00000000000 --- a/docs/parallel/amp/reference/tiled-index-class.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -description: "Learn more about: tiled_index Class" -title: "tiled_index Class" -ms.date: "03/27/2019" -f1_keywords: ["tiled_index", "AMP/tiled_index", "AMP/Concurrency::tiled_index::tiled_index", "AMP/Concurrency::tiled_index::get_tile_extent", "AMP/Concurrency::tiled_index::barrier", "AMP/Concurrency::tiled_index::global", "AMP/Concurrency::tiled_index::local", "AMP/Concurrency::tiled_index::rank", "AMP/Concurrency::tiled_index::tile", "AMP/Concurrency::tiled_index::tile_dim0", "AMP/Concurrency::tiled_index::tile_dim1", "AMP/Concurrency::tiled_index::tile_dim2", "AMP/Concurrency::tiled_index::tile_origin", "AMP/Concurrency::tiled_index::tile_extent"] -helpviewer_keywords: ["tiled_index class"] -ms.assetid: 0ce2ae26-f1bb-4436-b473-a9e1b619bb38 ---- -# tiled_index Class - -Provides an index into a [tiled_extent](tiled-extent-class.md) object. This class has properties to access elements relative to the local tile origin and relative to the global origin. For more information about tiled spaces, see [Using Tiles](../../../parallel/amp/using-tiles.md). - -## Syntax - -```cpp -template < - int _Dim0, - int _Dim1 = 0, - int _Dim2 = 0 -> -class tiled_index : public _Tiled_index_base<3>; - -template < - int _Dim0, - int _Dim1 -> -class tiled_index<_Dim0, _Dim1, 0> : public _Tiled_index_base<2>; - -template < - int _Dim0 -> -class tiled_index<_Dim0, 0, 0> : public _Tiled_index_base<1>; -``` - -### Parameters - -*_Dim0*
-The length of the most significant dimension. - -*_Dim1*
-The length of the next-to-most significant dimension. - -*_Dim2*
-The length of the least significant dimension. - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[tiled_index Constructor](#ctor)|Initializes a new instance of the `tile_index` class.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[get_tile_extent](#tiled_index__get_tile_extent)|Returns an [extent](extent-class.md) object that has the values of the `tiled_index` template arguments `_Dim0`, `_Dim1`, and `_Dim2`.| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[barrier Constant](#tiled_index__barrier)|Stores a [tile_barrier](tile-barrier-class.md) object that represents a barrier in the current tile of threads.| -|[global Constant](#tiled_index__global)|Stores an [index](index-class.md) object of rank 1, 2, or 3 that represents the global index in a grid object.| -|[local Constant](#tiled_index__local)|Stores an `index` object of rank 1, 2, or 3 that represents the relative index in the current tile of a [tiled_extent](tiled-extent-class.md) object.| -|[rank Constant](#tiled_index__rank)|Stores the rank of the `tiled_index` object.| -|[tile Constant](#tiled_index__tile)|Stores an `index` object of rank 1, 2, or 3 that represents the coordinates of the current tile of a `tiled_extent` object.| -|[tile_dim0 Constant](#tiled_index__tile_dim0)|Stores the length of the most significant dimension.| -|[tile_dim1 Constant](#tiled_index__tile_dim1)|Stores the length of the next-to-most significant dimension.| -|[tile_dim2 Constant](#tiled_index__tile_dim2)|Stores the length of the least significant dimension.| -|[tile_origin Constant](#tiled_index__tile_origin)|Stores an `index` object of rank 1, 2, or 3 that represents the global coordinates of the origin of the current tile in a `tiled_extent` object.| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|[tile_extent](#tile_extent)|Gets an [extent](extent-class.md) object that has the values of the `tiled_index` template arguments `tiled_index` template arguments `_Dim0`, `_Dim1`, and `_Dim2`.| - -## Inheritance Hierarchy - -`_Tiled_index_base` - -`tiled_index` - -## Requirements - -**Header:** amp.h - -**Namespace:** Concurrency - -## tiled_index Constructor - -Initializes a new instance of the `tiled_index` class. - -### Syntax - -```cpp -tiled_index( - const index& _Global, - const index& _Local, - const index& _Tile, - const index& _Tile_origin, - const tile_barrier& _Barrier ) restrict(amp,cpu); - -tiled_index( - const tiled_index& _Other ) restrict(amp,cpu); -``` - -### Parameters - -*_Global*
-The global [index](index-class.md) of the constructed `tiled_index`. - -*_Local*
-The local [index](index-class.md) of the constructed `tiled_index` - -*_Tile*
-The tile [index](index-class.md) of the constructed `tiled_index` - -*_Tile_origin*
-The tile origin [index](index-class.md) of the constructed `tiled_index` - -*_Barrier*
-The [tile_barrier](tile-barrier-class.md) object of the constructed `tiled_index`. - -*_Other*
-The `tile_index` object to be copied to the constructed `tiled_index`. - -### Overloads - -|Name|Description| -|-|-| -|`tiled_index(const index& _Global, const index& _Local, const index& _Tile, const index& _Tile_origin, const tile_barrier& _Barrier restrict(amp,cpu);`|Initializes a new instance of the `tile_index` class from the index of the tile in global coordinates and the relative position in the tile in local coordinates. The `_Global` and `_Tile_origin` parameters are computed.| -|`tiled_index( const tiled_index& _Other) restrict(amp,cpu);`|Initializes a new instance of the `tile_index` class by copying the specified `tiled_index` object.| - -## get_tile_extent - -Returns an [extent](extent-class.md) object that has the values of the `tiled_index` template arguments `_Dim0`, `_Dim1`, and `_Dim2`. - -### Syntax - -```cpp -extent get_tile_extent()restrict(amp,cpu); -``` - -### Return Value - -An `extent` object that has the values of the `tiled_index` template arguments `_Dim0`, `_Dim1`, and `_Dim2`. - -## barrier - -Stores a [tile_barrier](tile-barrier-class.md) object that represents a barrier in the current tile of threads. - -### Syntax - -```cpp -const tile_barrier barrier; -``` - -## global - -Stores an [index](index-class.md) object of rank 1, 2, or 3 that represents the global index of an object. - -### Syntax - -```cpp -const index global; -``` - -## local - -Stores an [index](index-class.md) object of rank 1, 2, or 3 that represents the relative index in the current tile of a [tiled_extent](tiled-extent-class.md) object. - -### Syntax - -```cpp -const index local; -``` - -## rank - -Stores the rank of the `tiled_index` object. - -### Syntax - -```cpp -static const int rank = _Rank; -``` - -## tile - -Stores an [index](index-class.md) object of rank 1, 2, or 3 that represents the coordinates of the current tile of a [tiled_extent](tiled-extent-class.md) object. - -### Syntax - -```cpp -const index tile; -``` - -## tile_dim0 - -Stores the length of the most significant dimension. - -### Syntax - -```cpp -static const int tile_dim0 = _Dim0; -``` - -## tile_dim1 - -Stores the length of the next-to-most significant dimension. - -### Syntax - -```cpp -static const int tile_dim1 = _Dim1; -``` - -## tile_dim2 - -Stores the length of the least significant dimension. - -### Syntax - -```cpp -static const int tile_dim2 = _Dim2; -``` - -## tile_origin - -Stores an [index](index-class.md) object of rank 1, 2, or 3 that represents the global coordinates of the origin of the current tile within a [tiled_extent](tiled-extent-class.md) object. - -### Syntax - -```cpp -const index tile_origin -``` - -## tile_extent - -Gets an [extent](extent-class.md) object that has the values of the `tiled_index` template arguments `tiled_index` template arguments `_Dim0`, `_Dim1`, and `_Dim2`. - -### Syntax - -```cpp -__declspec(property(get= get_tile_extent)) extent tile_extent; -``` - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/uint-2-class.md b/docs/parallel/amp/reference/uint-2-class.md deleted file mode 100644 index b94c30a56f3..00000000000 --- a/docs/parallel/amp/reference/uint-2-class.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -description: "Learn more about: uint_2 Class" -title: "uint_2 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::uint_2::set_xy", "amp_short_vectors/Concurrency::graphics::uint_2::y", "amp_short_vectors/Concurrency::graphics::uint_2::gr", "amp_short_vectors/Concurrency::graphics::uint_2::operator-", "amp_short_vectors/Concurrency::graphics::uint_2::get_x", "amp_short_vectors/Concurrency::graphics::uint_2::operator-=", "amp_short_vectors/Concurrency::graphics::uint_2::r", "amp_short_vectors/Concurrency::graphics::uint_2::yx", "amp_short_vectors/Concurrency::graphics::uint_2::operator--", "amp_short_vectors/Concurrency::graphics::uint_2::set_yx", "amp_short_vectors/Concurrency::graphics::uint_2::operator=", "amp_short_vectors/Concurrency::graphics::uint_2::set_x", "amp_short_vectors/Concurrency::graphics::uint_2::operator+=", "amp_short_vectors/Concurrency::graphics::uint_2::get_y", "amp_short_vectors/Concurrency::graphics::uint_2::xy", "amp_short_vectors/Concurrency::graphics::uint_2::x", "amp_short_vectors/Concurrency::graphics::uint_2::get_xy", "amp_short_vectors/Concurrency::graphics::uint_2::set_y", "amp_short_vectors/Concurrency::graphics::uint_2", "amp_short_vectors/Concurrency::graphics::uint_2::operator*=", "amp_short_vectors/Concurrency::graphics::uint_2::get_yx", "amp_short_vectors/Concurrency::graphics::uint_2::operator/=", "amp_short_vectors/Concurrency::graphics::uint_2::g", "amp_short_vectors/Concurrency::graphics::uint_2::operator++", "amp_short_vectors/Concurrency::graphics::uint_2::rg"] -ms.assetid: 9fcc9129-72b1-4da7-9012-4d3be15f1c52 ---- -# uint_2 Class - -Represents a short vector of two unsigned integers. - -## Syntax - -```cpp -class uint_2; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[uint_2 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|uint_2::get_x|| -|uint_2::get_xy|| -|uint_2::get_y|| -|uint_2::get_yx|| -|uint_2::ref_g_Method|| -|uint_2::ref_r_Method|| -|uint_2::ref_x_Method|| -|uint_2::ref_y_Method|| -|uint_2::set_x|| -|uint_2::set_xy|| -|uint_2::set_y|| -|uint_2::set_yx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|uint_2::operator--|| -|uint_2::operator%=|| -|uint_2::operator&=|| -|uint_2::operator*=|| -|uint_2::operator/=|| -|uint_2::operator^=|| -|uint_2::operator\|=|| -|uint_2::operator~|| -|uint_2::operator++|| -|uint_2::operator+=|| -|uint_2::operator<\<=|| -|uint_2::operator=|| -|uint_2::operator-=|| -|uint_2::operator>>=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#uint_2__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|uint_2::g|| -|uint_2::gr|| -|uint_2::r|| -|uint_2::rg|| -|uint_2::x|| -|uint_2::xy|| -|uint_2::y|| -|uint_2::yx|| - -## Inheritance Hierarchy - -`uint_2` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## uint_2 - -Default constructor, initializes all elements with 0. - -```cpp -uint_2() restrict(amp, - cpu); - -uint_2( - unsigned int _V0, - unsigned int _V1) restrict(amp, - cpu); - -uint_2( - unsigned int _V) restrict(amp, - cpu); - -uint_2( - const uint_2& _Other) restrict(amp, - cpu); - -explicit inline uint_2( - const int_2& _Other) restrict(amp, - cpu); - -explicit inline uint_2( - const float_2& _Other) restrict(amp, - cpu); - -explicit inline uint_2( - const unorm_2& _Other) restrict(amp, - cpu); - -explicit inline uint_2( - const norm_2& _Other) restrict(amp, - cpu); - -explicit inline uint_2( - const double_2& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 2; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/uint-3-class.md b/docs/parallel/amp/reference/uint-3-class.md deleted file mode 100644 index f6eba197139..00000000000 --- a/docs/parallel/amp/reference/uint-3-class.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -description: "Learn more about: uint_3 Class" -title: "uint_3 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::uint_3::get_xz", "amp_short_vectors/Concurrency::graphics::uint_3::set_yzx", "amp_short_vectors/Concurrency::graphics::uint_3::get_y", "amp_short_vectors/Concurrency::graphics::uint_3::get_yzx", "amp_short_vectors/Concurrency::graphics::uint_3::get_yz", "amp_short_vectors/Concurrency::graphics::uint_3::yzx", "amp_short_vectors/Concurrency::graphics::uint_3::get_z", "amp_short_vectors/Concurrency::graphics::uint_3::z", "amp_short_vectors/Concurrency::graphics::uint_3::xy", "amp_short_vectors/Concurrency::graphics::uint_3::gr", "amp_short_vectors/Concurrency::graphics::uint_3::operator=", "amp_short_vectors/Concurrency::graphics::uint_3::x", "amp_short_vectors/Concurrency::graphics::uint_3::gbr", "amp_short_vectors/Concurrency::graphics::uint_3::set_xy", "amp_short_vectors/Concurrency::graphics::uint_3::g", "amp_short_vectors/Concurrency::graphics::uint_3::set_yz", "amp_short_vectors/Concurrency::graphics::uint_3::br", "amp_short_vectors/Concurrency::graphics::uint_3::get_xyz", "amp_short_vectors/Concurrency::graphics::uint_3::b", "amp_short_vectors/Concurrency::graphics::uint_3::get_yxz", "amp_short_vectors/Concurrency::graphics::uint_3::set_zyx", "amp_short_vectors/Concurrency::graphics::uint_3::get_x", "amp_short_vectors/Concurrency::graphics::uint_3::rgb", "amp_short_vectors/Concurrency::graphics::uint_3::set_zy", "amp_short_vectors/Concurrency::graphics::uint_3::brg", "amp_short_vectors/Concurrency::graphics::uint_3::set_xyz", "amp_short_vectors/Concurrency::graphics::uint_3::xyz", "amp_short_vectors/Concurrency::graphics::uint_3::set_zxy", "amp_short_vectors/Concurrency::graphics::uint_3", "amp_short_vectors/Concurrency::graphics::uint_3::get_xy", "amp_short_vectors/Concurrency::graphics::uint_3::set_yx", "amp_short_vectors/Concurrency::graphics::uint_3::get_zyx", "amp_short_vectors/Concurrency::graphics::uint_3::get_zxy", "amp_short_vectors/Concurrency::graphics::uint_3::set_y", "amp_short_vectors/Concurrency::graphics::uint_3::yx", "amp_short_vectors/Concurrency::graphics::uint_3::grb", "amp_short_vectors/Concurrency::graphics::uint_3::operator+=", "amp_short_vectors/Concurrency::graphics::uint_3::set_x", "amp_short_vectors/Concurrency::graphics::uint_3::operator/=", "amp_short_vectors/Concurrency::graphics::uint_3::rbg", "amp_short_vectors/Concurrency::graphics::uint_3::set_zx", "amp_short_vectors/Concurrency::graphics::uint_3::set_z", "amp_short_vectors/Concurrency::graphics::uint_3::get_zx", "amp_short_vectors/Concurrency::graphics::uint_3::bgr", "amp_short_vectors/Concurrency::graphics::uint_3::get_xzy", "amp_short_vectors/Concurrency::graphics::uint_3::get_yx", "amp_short_vectors/Concurrency::graphics::uint_3::bg", "amp_short_vectors/Concurrency::graphics::uint_3::r", "amp_short_vectors/Concurrency::graphics::uint_3::xzy", "amp_short_vectors/Concurrency::graphics::uint_3::zyx", "amp_short_vectors/Concurrency::graphics::uint_3::set_xz", "amp_short_vectors/Concurrency::graphics::uint_3::rg", "amp_short_vectors/Concurrency::graphics::uint_3::zxy", "amp_short_vectors/Concurrency::graphics::uint_3::zy", "amp_short_vectors/Concurrency::graphics::uint_3::yz", "amp_short_vectors/Concurrency::graphics::uint_3::zx", "amp_short_vectors/Concurrency::graphics::uint_3::gb", "amp_short_vectors/Concurrency::graphics::uint_3::operator--", "amp_short_vectors/Concurrency::graphics::uint_3::set_yxz", "amp_short_vectors/Concurrency::graphics::uint_3::get_zy", "amp_short_vectors/Concurrency::graphics::uint_3::operator++", "amp_short_vectors/Concurrency::graphics::uint_3::operator-", "amp_short_vectors/Concurrency::graphics::uint_3::y", "amp_short_vectors/Concurrency::graphics::uint_3::xz", "amp_short_vectors/Concurrency::graphics::uint_3::rb", "amp_short_vectors/Concurrency::graphics::uint_3::operator*=", "amp_short_vectors/Concurrency::graphics::uint_3::yxz", "amp_short_vectors/Concurrency::graphics::uint_3::set_xzy", "amp_short_vectors/Concurrency::graphics::uint_3::operator-="] -ms.assetid: 5e22c277-9d4f-4a3a-b38c-a83d5fcab33c ---- -# uint_3 Class - -Represents a short vector of three unsigned integers. - -## Syntax - -```cpp -class uint_3; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[uint_3 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|uint_3::get_x|| -|uint_3::get_xy|| -|uint_3::get_xyz|| -|uint_3::get_xz|| -|uint_3::get_xzy|| -|uint_3::get_y|| -|uint_3::get_yx|| -|uint_3::get_yxz|| -|uint_3::get_yz|| -|uint_3::get_yzx|| -|uint_3::get_z|| -|uint_3::get_zx|| -|uint_3::get_zxy|| -|uint_3::get_zy|| -|uint_3::get_zyx|| -|uint_t::ref_b|| -|uint_t::ref_g|| -|uint_t::ref_r|| -|uint_t::ref_x|| -|uint_t::ref_y|| -|uint_t::ref_z|| -|uint_3::set_x|| -|uint_3::set_xy|| -|uint_3::set_xyz|| -|uint_3::set_xz|| -|uint_3::set_xzy|| -|uint_3::set_y|| -|uint_3::set_yx|| -|uint_3::set_yxz|| -|uint_3::set_yz|| -|uint_3::set_yzx|| -|uint_3::set_z|| -|uint_3::set_zx|| -|uint_3::set_zxy|| -|uint_3::set_zy|| -|uint_3::set_zyx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|uint_3::operator--|| -|uint_3::operator%=|| -|uint_3::operator&=|| -|uint_3::operator*=|| -|uint_3::operator/=|| -|uint_3::operator^=|| -|uint_3::operator\|=|| -|uint_3::operator~|| -|uint_3::operator++|| -|uint_3::operator+=|| -|uint_3::operator<\<=|| -|uint_3::operator=|| -|uint_3::operator-=|| -|uint_3::operator>>=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#uint_3__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|uint_3::b|| -|uint_3::bg|| -|uint_3::bgr|| -|uint_3::br|| -|uint_3::brg|| -|uint_3::g|| -|uint_3::gb|| -|uint_3::gbr|| -|uint_3::gr|| -|uint_3::grb|| -|uint_3::r|| -|uint_3::rb|| -|uint_3::rbg|| -|uint_3::rg|| -|uint_3::rgb|| -|uint_3::x|| -|uint_3::xy|| -|uint_3::xyz|| -|uint_3::xz|| -|uint_3::xzy|| -|uint_3::y|| -|uint_3::yx|| -|uint_3::yxz|| -|uint_3::yz|| -|uint_3::yzx|| -|uint_3::z|| -|uint_3::zx|| -|uint_3::zxy|| -|uint_3::zy|| -|uint_3::zyx|| - -## Inheritance Hierarchy - -`uint_3` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## uint_3 - -Default constructor, initializes all elements with 0. - -```cpp -uint_3() restrict(amp, - cpu); - -uint_3( - unsigned int _V0, - unsigned int _V1, - unsigned int _V2) restrict(amp, - cpu); - -uint_3( - unsigned int _V) restrict(amp, - cpu); - -uint_3( - const uint_3& _Other) restrict(amp, - cpu); - -explicit inline uint_3( - const int_3& _Other) restrict(amp, - cpu); - -explicit inline uint_3( - const float_3& _Other) restrict(amp, - cpu); - -explicit inline uint_3( - const unorm_3& _Other) restrict(amp, - cpu); - -explicit inline uint_3( - const norm_3& _Other) restrict(amp, - cpu); - -explicit inline uint_3( - const double_3& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 3; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/uint-4-class.md b/docs/parallel/amp/reference/uint-4-class.md deleted file mode 100644 index 52c3c56b77a..00000000000 --- a/docs/parallel/amp/reference/uint-4-class.md +++ /dev/null @@ -1,402 +0,0 @@ ---- -description: "Learn more about: uint_4 Class" -title: "uint_4 Class" -ms.date: "03/27/2019" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::uint_4::ywx", "amp_short_vectors/Concurrency::graphics::uint_4::get_yxw", "amp_short_vectors/Concurrency::graphics::uint_4::xw", "amp_short_vectors/Concurrency::graphics::uint_4::brga", "amp_short_vectors/Concurrency::graphics::uint_4::get_zw", "amp_short_vectors/Concurrency::graphics::uint_4::get_wzyx", "amp_short_vectors/Concurrency::graphics::uint_4::operator+=", "amp_short_vectors/Concurrency::graphics::uint_4::zw", "amp_short_vectors/Concurrency::graphics::uint_4::set_zy", "amp_short_vectors/Concurrency::graphics::uint_4::rgba", "amp_short_vectors/Concurrency::graphics::uint_4::grab", "amp_short_vectors/Concurrency::graphics::uint_4::xzwy", "amp_short_vectors/Concurrency::graphics::uint_4::get_ywzx", "amp_short_vectors/Concurrency::graphics::uint_4::set_xzwy", "amp_short_vectors/Concurrency::graphics::uint_4::set_wz", "amp_short_vectors/Concurrency::graphics::uint_4::ab", "amp_short_vectors/Concurrency::graphics::uint_4::set_zxy", "amp_short_vectors/Concurrency::graphics::uint_4::gabr", "amp_short_vectors/Concurrency::graphics::uint_4::agrb", "amp_short_vectors/Concurrency::graphics::uint_4::zxy", "amp_short_vectors/Concurrency::graphics::uint_4::br", "amp_short_vectors/Concurrency::graphics::uint_4::ragb", "amp_short_vectors/Concurrency::graphics::uint_4::rgb", "amp_short_vectors/Concurrency::graphics::uint_4::arb", "amp_short_vectors/Concurrency::graphics::uint_4::xyzw", "amp_short_vectors/Concurrency::graphics::uint_4::wzyx", "amp_short_vectors/Concurrency::graphics::uint_4::zxwy", "amp_short_vectors/Concurrency::graphics::uint_4::set_yzxw", "amp_short_vectors/Concurrency::graphics::uint_4::zwxy", "amp_short_vectors/Concurrency::graphics::uint_4::operator*=", "amp_short_vectors/Concurrency::graphics::uint_4::yzwx", "amp_short_vectors/Concurrency::graphics::uint_4::bg", "amp_short_vectors/Concurrency::graphics::uint_4::set_yz", "amp_short_vectors/Concurrency::graphics::uint_4::x", "amp_short_vectors/Concurrency::graphics::uint_4::set_z", "amp_short_vectors/Concurrency::graphics::uint_4::grba", "amp_short_vectors/Concurrency::graphics::uint_4::zwy", "amp_short_vectors/Concurrency::graphics::uint_4::get_yzwx", "amp_short_vectors/Concurrency::graphics::uint_4::xz", "amp_short_vectors/Concurrency::graphics::uint_4::set_wxyz", "amp_short_vectors/Concurrency::graphics::uint_4::b", "amp_short_vectors/Concurrency::graphics::uint_4::set_zx", "amp_short_vectors/Concurrency::graphics::uint_4::set_wyzx", "amp_short_vectors/Concurrency::graphics::uint_4::get_xyw", "amp_short_vectors/Concurrency::graphics::uint_4::get_ywz", "amp_short_vectors/Concurrency::graphics::uint_4::g", "amp_short_vectors/Concurrency::graphics::uint_4::get_zwxy", "amp_short_vectors/Concurrency::graphics::uint_4::yxzw", "amp_short_vectors/Concurrency::graphics::uint_4::set_ywx", "amp_short_vectors/Concurrency::graphics::uint_4::ar", "amp_short_vectors/Concurrency::graphics::uint_4::get_zyxw", "amp_short_vectors/Concurrency::graphics::uint_4::get_yxz", "amp_short_vectors/Concurrency::graphics::uint_4::set_xy", "amp_short_vectors/Concurrency::graphics::uint_4::get_y", "amp_short_vectors/Concurrency::graphics::uint_4::ga", "amp_short_vectors/Concurrency::graphics::uint_4::zyx", "amp_short_vectors/Concurrency::graphics::uint_4::get_zyx", "amp_short_vectors/Concurrency::graphics::uint_4::get_zxyw", "amp_short_vectors/Concurrency::graphics::uint_4::wy", "amp_short_vectors/Concurrency::graphics::uint_4::set_y", "amp_short_vectors/Concurrency::graphics::uint_4::bgr", "amp_short_vectors/Concurrency::graphics::uint_4::gbr", "amp_short_vectors/Concurrency::graphics::uint_4::wzxy", "amp_short_vectors/Concurrency::graphics::uint_4::set_wxz", "amp_short_vectors/Concurrency::graphics::uint_4::get_wxy", "amp_short_vectors/Concurrency::graphics::uint_4::set_zxyw", "amp_short_vectors/Concurrency::graphics::uint_4::bagr", "amp_short_vectors/Concurrency::graphics::uint_4::zxw", "amp_short_vectors/Concurrency::graphics::uint_4::operator/=", "amp_short_vectors/Concurrency::graphics::uint_4::rabg", "amp_short_vectors/Concurrency::graphics::uint_4::get_xwzy", "amp_short_vectors/Concurrency::graphics::uint_4::get_xzwy", "amp_short_vectors/Concurrency::graphics::uint_4::xywz", "amp_short_vectors/Concurrency::graphics::uint_4::get_ywxz", "amp_short_vectors/Concurrency::graphics::uint_4::get_z", "amp_short_vectors/Concurrency::graphics::uint_4::set_xyw", "amp_short_vectors/Concurrency::graphics::uint_4::get_wxzy", "amp_short_vectors/Concurrency::graphics::uint_4::get_yxzw", "amp_short_vectors/Concurrency::graphics::uint_4::z", "amp_short_vectors/Concurrency::graphics::uint_4::operator=", "amp_short_vectors/Concurrency::graphics::uint_4::wxyz", "amp_short_vectors/Concurrency::graphics::uint_4::set_xwzy", "amp_short_vectors/Concurrency::graphics::uint_4::set_yw", "amp_short_vectors/Concurrency::graphics::uint_4::a", "amp_short_vectors/Concurrency::graphics::uint_4::set_zwyx", "amp_short_vectors/Concurrency::graphics::uint_4::xy", "amp_short_vectors/Concurrency::graphics::uint_4::get_yzx", "amp_short_vectors/Concurrency::graphics::uint_4::rg", "amp_short_vectors/Concurrency::graphics::uint_4::rgab", "amp_short_vectors/Concurrency::graphics::uint_4::set_xwz", "amp_short_vectors/Concurrency::graphics::uint_4::set_zyxw", "amp_short_vectors/Concurrency::graphics::uint_4::gra", "amp_short_vectors/Concurrency::graphics::uint_4::rbg", "amp_short_vectors/Concurrency::graphics::uint_4::set_zwxy", "amp_short_vectors/Concurrency::graphics::uint_4::get_wzxy", "amp_short_vectors/Concurrency::graphics::uint_4::zyxw", "amp_short_vectors/Concurrency::graphics::uint_4::set_wzxy", "amp_short_vectors/Concurrency::graphics::uint_4::set_yxw", "amp_short_vectors/Concurrency::graphics::uint_4::yz", "amp_short_vectors/Concurrency::graphics::uint_4::zwx", "amp_short_vectors/Concurrency::graphics::uint_4::w", "amp_short_vectors/Concurrency::graphics::uint_4::get_xwyz", "amp_short_vectors/Concurrency::graphics::uint_4::rab", "amp_short_vectors/Concurrency::graphics::uint_4::set_wzy", "amp_short_vectors/Concurrency::graphics::uint_4::get_xwy", "amp_short_vectors/Concurrency::graphics::uint_4::get_zywx", "amp_short_vectors/Concurrency::graphics::uint_4::set_wx", "amp_short_vectors/Concurrency::graphics::uint_4::set_wxy", "amp_short_vectors/Concurrency::graphics::uint_4::get_ywx", "amp_short_vectors/Concurrency::graphics::uint_4::set_wyx", "amp_short_vectors/Concurrency::graphics::uint_4::bag", "amp_short_vectors/Concurrency::graphics::uint_4::zyw", "amp_short_vectors/Concurrency::graphics::uint_4::get_wx", "amp_short_vectors/Concurrency::graphics::uint_4::get_xyzw", "amp_short_vectors/Concurrency::graphics::uint_4::abg", "amp_short_vectors/Concurrency::graphics::uint_4::bra", "amp_short_vectors/Concurrency::graphics::uint_4::get_zx", "amp_short_vectors/Concurrency::graphics::uint_4::gab", "amp_short_vectors/Concurrency::graphics::uint_4::barg", "amp_short_vectors/Concurrency::graphics::uint_4::agbr", "amp_short_vectors/Concurrency::graphics::uint_4::yzxw", "amp_short_vectors/Concurrency::graphics::uint_4::set_xwyz", "amp_short_vectors/Concurrency::graphics::uint_4::get_zyw", "amp_short_vectors/Concurrency::graphics::uint_4::ag", "amp_short_vectors/Concurrency::graphics::uint_4::zxyw", "amp_short_vectors/Concurrency::graphics::uint_4::operator++", "amp_short_vectors/Concurrency::graphics::uint_4::wxy", "amp_short_vectors/Concurrency::graphics::uint_4::set_xyz", "amp_short_vectors/Concurrency::graphics::uint_4::grb", "amp_short_vectors/Concurrency::graphics::uint_4", "amp_short_vectors/Concurrency::graphics::uint_4::wyz", "amp_short_vectors/Concurrency::graphics::uint_4::gr", "amp_short_vectors/Concurrency::graphics::uint_4::get_zxw", "amp_short_vectors/Concurrency::graphics::uint_4::set_zwx", "amp_short_vectors/Concurrency::graphics::uint_4::ra", "amp_short_vectors/Concurrency::graphics::uint_4::bgar", "amp_short_vectors/Concurrency::graphics::uint_4::get_yz", "amp_short_vectors/Concurrency::graphics::uint_4::abrg", "amp_short_vectors/Concurrency::graphics::uint_4::zywx", "amp_short_vectors/Concurrency::graphics::uint_4::set_yxwz", "amp_short_vectors/Concurrency::graphics::uint_4::get_wzy", "amp_short_vectors/Concurrency::graphics::uint_4::set_zxw", "amp_short_vectors/Concurrency::graphics::uint_4::get_xzy", "amp_short_vectors/Concurrency::graphics::uint_4::agr", "amp_short_vectors/Concurrency::graphics::uint_4::set_wzyx", "amp_short_vectors/Concurrency::graphics::uint_4::r", "amp_short_vectors/Concurrency::graphics::uint_4::operator-=", "amp_short_vectors/Concurrency::graphics::uint_4::set_wxzy", "amp_short_vectors/Concurrency::graphics::uint_4::set_yxzw", "amp_short_vectors/Concurrency::graphics::uint_4::agb", "amp_short_vectors/Concurrency::graphics::uint_4::set_zyx", "amp_short_vectors/Concurrency::graphics::uint_4::get_zwyx", "amp_short_vectors/Concurrency::graphics::uint_4::get_yzw", "amp_short_vectors/Concurrency::graphics::uint_4::set_wy", "amp_short_vectors/Concurrency::graphics::uint_4::xwzy", "amp_short_vectors/Concurrency::graphics::uint_4::set_zyw", "amp_short_vectors/Concurrency::graphics::uint_4::wyx", "amp_short_vectors/Concurrency::graphics::uint_4::zx", "amp_short_vectors/Concurrency::graphics::uint_4::yx", "amp_short_vectors/Concurrency::graphics::uint_4::get_xyz", "amp_short_vectors/Concurrency::graphics::uint_4::get_wy", "amp_short_vectors/Concurrency::graphics::uint_4::get_xzw", "amp_short_vectors/Concurrency::graphics::uint_4::set_yzw", "amp_short_vectors/Concurrency::graphics::uint_4::get_wz", "amp_short_vectors/Concurrency::graphics::uint_4::xzy", "amp_short_vectors/Concurrency::graphics::uint_4::bar", "amp_short_vectors/Concurrency::graphics::uint_4::set_xzyw", "amp_short_vectors/Concurrency::graphics::uint_4::get_wyx", "amp_short_vectors/Concurrency::graphics::uint_4::wxz", "amp_short_vectors/Concurrency::graphics::uint_4::yzw", "amp_short_vectors/Concurrency::graphics::uint_4::get_xwz", "amp_short_vectors/Concurrency::graphics::uint_4::ywxz", "amp_short_vectors/Concurrency::graphics::uint_4::wyzx", "amp_short_vectors/Concurrency::graphics::uint_4::set_xz", "amp_short_vectors/Concurrency::graphics::uint_4::get_yxwz", "amp_short_vectors/Concurrency::graphics::uint_4::get_yx", "amp_short_vectors/Concurrency::graphics::uint_4::zwyx", "amp_short_vectors/Concurrency::graphics::uint_4::arg", "amp_short_vectors/Concurrency::graphics::uint_4::wzx", "amp_short_vectors/Concurrency::graphics::uint_4::rbga", "amp_short_vectors/Concurrency::graphics::uint_4::set_zwy", "amp_short_vectors/Concurrency::graphics::uint_4::get_xzyw", "amp_short_vectors/Concurrency::graphics::uint_4::get_xywz", "amp_short_vectors/Concurrency::graphics::uint_4::yxz", "amp_short_vectors/Concurrency::graphics::uint_4::rbag", "amp_short_vectors/Concurrency::graphics::uint_4::yzx", "amp_short_vectors/Concurrency::graphics::uint_4::set_zw", "amp_short_vectors/Concurrency::graphics::uint_4::wzy", "amp_short_vectors/Concurrency::graphics::uint_4::get_zxy", "amp_short_vectors/Concurrency::graphics::uint_4::get_zy", "amp_short_vectors/Concurrency::graphics::uint_4::abr", "amp_short_vectors/Concurrency::graphics::uint_4::gbra", "amp_short_vectors/Concurrency::graphics::uint_4::xzyw", "amp_short_vectors/Concurrency::graphics::uint_4::get_wxz", "amp_short_vectors/Concurrency::graphics::uint_4::xwy", "amp_short_vectors/Concurrency::graphics::uint_4::set_ywzx", "amp_short_vectors/Concurrency::graphics::uint_4::set_zywx", "amp_short_vectors/Concurrency::graphics::uint_4::wyxz", "amp_short_vectors/Concurrency::graphics::uint_4::set_x", "amp_short_vectors/Concurrency::graphics::uint_4::gb", "amp_short_vectors/Concurrency::graphics::uint_4::ba", "amp_short_vectors/Concurrency::graphics::uint_4::set_ywxz", "amp_short_vectors/Concurrency::graphics::uint_4::get_xy", "amp_short_vectors/Concurrency::graphics::uint_4::get_wzx", "amp_short_vectors/Concurrency::graphics::uint_4::bga", "amp_short_vectors/Concurrency::graphics::uint_4::get_x", "amp_short_vectors/Concurrency::graphics::uint_4::get_wyzx", "amp_short_vectors/Concurrency::graphics::uint_4::set_xwy", "amp_short_vectors/Concurrency::graphics::uint_4::set_xzy", "amp_short_vectors/Concurrency::graphics::uint_4::wxzy", "amp_short_vectors/Concurrency::graphics::uint_4::set_wzx", "amp_short_vectors/Concurrency::graphics::uint_4::set_ywz", "amp_short_vectors/Concurrency::graphics::uint_4::set_yx", "amp_short_vectors/Concurrency::graphics::uint_4::get_wyxz", "amp_short_vectors/Concurrency::graphics::uint_4::rga", "amp_short_vectors/Concurrency::graphics::uint_4::set_xw", "amp_short_vectors/Concurrency::graphics::uint_4::get_zwx", "amp_short_vectors/Concurrency::graphics::uint_4::get_w", "amp_short_vectors/Concurrency::graphics::uint_4::get_xw", "amp_short_vectors/Concurrency::graphics::uint_4::get_wxyz", "amp_short_vectors/Concurrency::graphics::uint_4::garb", "amp_short_vectors/Concurrency::graphics::uint_4::y", "amp_short_vectors/Concurrency::graphics::uint_4::get_xz", "amp_short_vectors/Concurrency::graphics::uint_4::yxw", "amp_short_vectors/Concurrency::graphics::uint_4::xzw", "amp_short_vectors/Concurrency::graphics::uint_4::set_xzw", "amp_short_vectors/Concurrency::graphics::uint_4::get_zxwy", "amp_short_vectors/Concurrency::graphics::uint_4::arbg", "amp_short_vectors/Concurrency::graphics::uint_4::ywzx", "amp_short_vectors/Concurrency::graphics::uint_4::zy", "amp_short_vectors/Concurrency::graphics::uint_4::brg", "amp_short_vectors/Concurrency::graphics::uint_4::gar", "amp_short_vectors/Concurrency::graphics::uint_4::get_yzxw", "amp_short_vectors/Concurrency::graphics::uint_4::bgra", "amp_short_vectors/Concurrency::graphics::uint_4::xwyz", "amp_short_vectors/Concurrency::graphics::uint_4::ywz", "amp_short_vectors/Concurrency::graphics::uint_4::yxwz", "amp_short_vectors/Concurrency::graphics::uint_4::set_zxwy", "amp_short_vectors/Concurrency::graphics::uint_4::wz", "amp_short_vectors/Concurrency::graphics::uint_4::set_yzwx", "amp_short_vectors/Concurrency::graphics::uint_4::get_zwy", "amp_short_vectors/Concurrency::graphics::uint_4::abgr", "amp_short_vectors/Concurrency::graphics::uint_4::brag", "amp_short_vectors/Concurrency::graphics::uint_4::set_w", "amp_short_vectors/Concurrency::graphics::uint_4::set_wyz", "amp_short_vectors/Concurrency::graphics::uint_4::gba", "amp_short_vectors/Concurrency::graphics::uint_4::rb", "amp_short_vectors/Concurrency::graphics::uint_4::gbar", "amp_short_vectors/Concurrency::graphics::uint_4::xyz", "amp_short_vectors/Concurrency::graphics::uint_4::yw", "amp_short_vectors/Concurrency::graphics::uint_4::operator-", "amp_short_vectors/Concurrency::graphics::uint_4::get_yw", "amp_short_vectors/Concurrency::graphics::uint_4::wx", "amp_short_vectors/Concurrency::graphics::uint_4::set_wyxz", "amp_short_vectors/Concurrency::graphics::uint_4::xwz", "amp_short_vectors/Concurrency::graphics::uint_4::operator--", "amp_short_vectors/Concurrency::graphics::uint_4::set_xyzw", "amp_short_vectors/Concurrency::graphics::uint_4::xyw", "amp_short_vectors/Concurrency::graphics::uint_4::get_wyz", "amp_short_vectors/Concurrency::graphics::uint_4::rag", "amp_short_vectors/Concurrency::graphics::uint_4::argb", "amp_short_vectors/Concurrency::graphics::uint_4::set_yxz", "amp_short_vectors/Concurrency::graphics::uint_4::set_xywz", "amp_short_vectors/Concurrency::graphics::uint_4::rba", "amp_short_vectors/Concurrency::graphics::uint_4::set_yzx"] -ms.assetid: 1cda9e2c-5970-4ced-ae54-d7ff3c6746f4 ---- -# uint_4 Class - -Represents a short vector of four unsigned integers. - -## Syntax - -```cpp -class uint_4; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[uint_4 Constructor](#uint_4__ctor) |Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|uint_4::get_w|| -|uint_4::get_wx|| -|uint_4::get_wxy|| -|uint_4::get_wxyz|| -|uint_4::get_wxz|| -|uint_4::get_wxzy|| -|uint_4::get_wy|| -|uint_4::get_wyx|| -|uint_4::get_wyxz|| -|uint_4::get_wyz|| -|uint_4::get_wyzx|| -|uint_4::get_wz|| -|uint_4::get_wzx|| -|uint_4::get_wzxy|| -|uint_4::get_wzy|| -|uint_4::get_wzyx|| -|uint_4::get_x|| -|uint_4::get_xw|| -|uint_4::get_xwy|| -|uint_4::get_xwyz|| -|uint_4::get_xwz|| -|uint_4::get_xwzy|| -|uint_4::get_xy|| -|uint_4::get_xyw|| -|uint_4::get_xywz|| -|uint_4::get_xyz|| -|uint_4::get_xyzw|| -|uint_4::get_xz|| -|uint_4::get_xzw|| -|uint_4::get_xzwy|| -|uint_4::get_xzy|| -|uint_4::get_xzyw|| -|uint_4::get_y|| -|uint_4::get_yw|| -|uint_4::get_ywx|| -|uint_4::get_ywxz|| -|uint_4::get_ywz|| -|uint_4::get_ywzx|| -|uint_4::get_yx|| -|uint_4::get_yxw|| -|uint_4::get_yxwz|| -|uint_4::get_yxz|| -|uint_4::get_yxzw|| -|uint_4::get_yz|| -|uint_4::get_yzw|| -|uint_4::get_yzwx|| -|uint_4::get_yzx|| -|uint_4::get_yzxw|| -|uint_4::get_z|| -|uint_4::get_zw|| -|uint_4::get_zwx|| -|uint_4::get_zwxy|| -|uint_4::get_zwy|| -|uint_4::get_zwyx|| -|uint_4::get_zx|| -|uint_4::get_zxw|| -|uint_4::get_zxwy|| -|uint_4::get_zxy|| -|uint_4::get_zxyw|| -|uint_4::get_zy|| -|uint_4::get_zyw|| -|uint_4::get_zywx|| -|uint_4::get_zyx|| -|uint_4::get_zyxw|| -|uint_4::ref_a|| -|uint_4::ref_b|| -|uint_4::ref_g|| -|uint_4::ref_r|| -|uint_4::ref_w|| -|uint_4::ref_x|| -|uint_4::ref_y|| -|uint_4::ref_z|| -|uint_4::set_w|| -|uint_4::set_wx|| -|uint_4::set_wxy|| -|uint_4::set_wxyz|| -|uint_4::set_wxz|| -|uint_4::set_wxzy|| -|uint_4::set_wy|| -|uint_4::set_wyx|| -|uint_4::set_wyxz|| -|uint_4::set_wyz|| -|uint_4::set_wyzx|| -|uint_4::set_wz|| -|uint_4::set_wzx|| -|uint_4::set_wzxy|| -|uint_4::set_wzy|| -|uint_4::set_wzyx|| -|uint_4::set_x|| -|uint_4::set_xw|| -|uint_4::set_xwy|| -|uint_4::set_xwyz|| -|uint_4::set_xwz|| -|uint_4::set_xwzy|| -|uint_4::set_xy|| -|uint_4::set_xyw|| -|uint_4::set_xywz|| -|uint_4::set_xyz|| -|uint_4::set_xyzw|| -|uint_4::set_xz|| -|uint_4::set_xzw|| -|uint_4::set_xzwy|| -|uint_4::set_xzy|| -|uint_4::set_xzyw|| -|uint_4::set_y|| -|uint_4::set_yw|| -|uint_4::set_ywx|| -|uint_4::set_ywxz|| -|uint_4::set_ywz|| -|uint_4::set_ywzx|| -|uint_4::set_yx|| -|uint_4::set_yxw|| -|uint_4::set_yxwz|| -|uint_4::set_yxz|| -|uint_4::set_yxzw|| -|uint_4::set_yz|| -|uint_4::set_yzw|| -|uint_4::set_yzwx|| -|uint_4::set_yzx|| -|uint_4::set_yzxw|| -|uint_4::set_z|| -|uint_4::set_zw|| -|uint_4::set_zwx|| -|uint_4::set_zwxy|| -|uint_4::set_zwy|| -|uint_4::set_zwyx|| -|uint_4::set_zx|| -|uint_4::set_zxw|| -|uint_4::set_zxwy|| -|uint_4::set_zxy|| -|uint_4::set_zxyw|| -|uint_4::set_zy|| -|uint_4::set_zyw|| -|uint_4::set_zywx|| -|uint_4::set_zyx|| -|uint_4::set_zyxw|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|uint_4::operator-|| -|uint_4::operator--|| -|uint_4::operator*=|| -|uint_4::operator/=|| -|uint_4::operator++|| -|uint_4::operator+=|| -|uint_4::operator=|| -|uint_4::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|uint_4::a|| -|uint_4::ab|| -|uint_4::abg|| -|uint_4::abgr|| -|uint_4::abr|| -|uint_4::abrg|| -|uint_4::ag|| -|uint_4::agb|| -|uint_4::agbr|| -|uint_4::agr|| -|uint_4::agrb|| -|uint_4::ar|| -|uint_4::arb|| -|uint_4::arbg|| -|uint_4::arg|| -|uint_4::argb|| -|uint_4::b|| -|uint_4::ba|| -|uint_4::bag|| -|uint_4::bagr|| -|uint_4::bar|| -|uint_4::barg|| -|uint_4::bg|| -|uint_4::bga|| -|uint_4::bgar|| -|uint_4::bgr|| -|uint_4::bgra|| -|uint_4::br|| -|uint_4::bra|| -|uint_4::brag|| -|uint_4::brg|| -|uint_4::brga|| -|uint_4::g|| -|uint_4::ga|| -|uint_4::gab|| -|uint_4::gabr|| -|uint_4::gar|| -|uint_4::garb|| -|uint_4::gb|| -|uint_4::gba|| -|uint_4::gbar|| -|uint_4::gbr|| -|uint_4::gbra|| -|uint_4::gr|| -|uint_4::gra|| -|uint_4::grab|| -|uint_4::grb|| -|uint_4::grba|| -|uint_4::r|| -|uint_4::ra|| -|uint_4::rab|| -|uint_4::rabg|| -|uint_4::rag|| -|uint_4::ragb|| -|uint_4::rb|| -|uint_4::rba|| -|uint_4::rbag|| -|uint_4::rbg|| -|uint_4::rbga|| -|uint_4::rg|| -|uint_4::rga|| -|uint_4::rgab|| -|uint_4::rgb|| -|uint_4::rgba|| -|uint_4::w|| -|uint_4::wx|| -|uint_4::wxy|| -|uint_4::wxyz|| -|uint_4::wxz|| -|uint_4::wxzy|| -|uint_4::wy|| -|uint_4::wyx|| -|uint_4::wyxz|| -|uint_4::wyz|| -|uint_4::wyzx|| -|uint_4::wz|| -|uint_4::wzx|| -|uint_4::wzxy|| -|uint_4::wzy|| -|uint_4::wzyx|| -|uint_4::x|| -|uint_4::xw|| -|uint_4::xwy|| -|uint_4::xwyz|| -|uint_4::xwz|| -|uint_4::xwzy|| -|uint_4::xy|| -|uint_4::xyw|| -|uint_4::xywz|| -|uint_4::xyz|| -|uint_4::xyzw|| -|uint_4::xz|| -|uint_4::xzw|| -|uint_4::xzwy|| -|uint_4::xzy|| -|uint_4::xzyw|| -|uint_4::y|| -|uint_4::yw|| -|uint_4::ywx|| -|uint_4::ywxz|| -|uint_4::ywz|| -|uint_4::ywzx|| -|uint_4::yx|| -|uint_4::yxw|| -|uint_4::yxwz|| -|uint_4::yxz|| -|uint_4::yxzw|| -|uint_4::yz|| -|uint_4::yzw|| -|uint_4::yzwx|| -|uint_4::yzx|| -|uint_4::yzxw|| -|uint_4::z|| -|uint_4::zw|| -|uint_4::zwx|| -|uint_4::zwxy|| -|uint_4::zwy|| -|uint_4::zwyx|| -|uint_4::zx|| -|uint_4::zxw|| -|uint_4::zxwy|| -|uint_4::zxy|| -|uint_4::zxyw|| -|uint_4::zy|| -|uint_4::zyw|| -|uint_4::zywx|| -|uint_4::zyx|| -|uint_4::zyxw|| - -## Inheritance Hierarchy - -`uint_4` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## uint_4 - -Default constructor, initializes all elements with 0. - -### Syntax - -```cpp -uint_4() restrict(amp,cpu); -uint_4( - unsigned int _V0, - unsigned int _V1, - unsigned int _V2, - unsigned int _V3 -) restrict(amp,cpu); -uint_4( - unsigned int _V -) restrict(amp,cpu); -uint_4( - const uint_4& _Other -) restrict(amp,cpu); -explicit inline uint_4( - const int_4& _Other -) restrict(amp,cpu); -explicit inline uint_4( - const float_4& _Other -) restrict(amp,cpu); -explicit inline uint_4( - const unorm_4& _Other -) restrict(amp,cpu); -explicit inline uint_4( - const norm_4& _Other -) restrict(amp,cpu); -explicit inline uint_4( - const double_4& _Other -) restrict(amp,cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V3*
-The value to initialize element 3. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -### Syntax - -```cpp -static const int size = 4; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/uninitialized-object-class.md b/docs/parallel/amp/reference/uninitialized-object-class.md deleted file mode 100644 index bfa77321403..00000000000 --- a/docs/parallel/amp/reference/uninitialized-object-class.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: "Learn more about: uninitialized_object Class" -title: "uninitialized_object Class" -ms.date: "03/27/2019" -f1_keywords: ["uninitialized_object", "AMPRT/uninitialized_object", "AMPRT/Concurrency::uninitialized_object"] -helpviewer_keywords: ["uninitialized_object class"] -ms.assetid: 6ae3c4e8-64a6-4511-a158-03be197b63af ---- -# uninitialized_object Class - -The exception that is thrown when an uninitialized object is used. - -## Syntax - -```cpp -class uninitialized_object : public runtime_exception; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[uninitialized_object Constructor](#uninitialized_object)|Initializes a new instance of the `uninitialized_object` class.| - -## Inheritance Hierarchy - -`exception` - -`runtime_exception` - -`uninitialized_object` - -## Requirements - -**Header:** amprt.h - -**Namespace:** Concurrency - -## uninitialized_object - -Constructs a new instance of the `uninitialized_object` exception. - -### Syntax - -```cpp -explicit uninitialized_object( - const char * _Message ) throw(); - -uninitialized_object() throw(); -``` - -### Parameters - -*_Message*
-A description of the error. - -### Return Value - -The `uninitialized_object` exception object. - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/unorm-2-class.md b/docs/parallel/amp/reference/unorm-2-class.md deleted file mode 100644 index 56ca540fa1a..00000000000 --- a/docs/parallel/amp/reference/unorm-2-class.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -description: "Learn more about: unorm_2 Class" -title: "unorm_2 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::unnorm_2::operator+=", "amp_short_vectors/Concurrency::graphics::unnorm_2::y", "amp_short_vectors/Concurrency::graphics::unnorm_2::set_y", "amp_short_vectors/Concurrency::graphics::unnorm_2::x", "amp_short_vectors/Concurrency::graphics::unnorm_2::get_yx", "amp_short_vectors/Concurrency::graphics::unnorm_2::operator--", "amp_short_vectors/Concurrency::graphics::unnorm_2::set_xy", "amp_short_vectors/Concurrency::graphics::unnorm_2::operator*=", "amp_short_vectors/Concurrency::graphics::unnorm_2::xy", "amp_short_vectors/Concurrency::graphics::unnorm_2::get_y", "amp_short_vectors/Concurrency::graphics::unnorm_2::operator=", "amp_short_vectors/Concurrency::graphics::unnorm_2::set_x", "amp_short_vectors/Concurrency::graphics::unnorm_2::rg", "amp_short_vectors/Concurrency::graphics::unorm_2", "amp_short_vectors/Concurrency::graphics::unnorm_2::operator-=", "amp_short_vectors/Concurrency::graphics::unnorm_2::operator/=", "amp_short_vectors/Concurrency::graphics::unnorm_2::get_xy", "amp_short_vectors/Concurrency::graphics::unnorm_2::set_yx", "amp_short_vectors/Concurrency::graphics::unnorm_2::yx", "amp_short_vectors/Concurrency::graphics::unnorm_2::gr", "amp_short_vectors/Concurrency::graphics::unnorm_2::r", "amp_short_vectors/Concurrency::graphics::unnorm_2::operator-", "amp_short_vectors/Concurrency::graphics::unnorm_2::get_x", "amp_short_vectors/Concurrency::graphics::unnorm_2::g", "amp_short_vectors/Concurrency::graphics::unnorm_2::operator++"] -ms.assetid: 62e88ea7-e29f-4f62-95ce-61a1f39f5e34 ---- -# unorm_2 Class - -Represents a short vector of two unsigned normal numbers. - -## Syntax - -```cpp -class unorm_2; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[unorm_2 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|unorm_2::get_x|| -|unorm_2::get_xy|| -|unorm_2::get_y|| -|unorm_2::get_yx|| -|unorm_2::ref_g|| -|unorm_2::ref_r|| -|unorm_2::ref_x|| -|unorm_2::ref_y|| -|unorm_2::set_x|| -|unorm_2::set_xy|| -|unorm_2::set_y|| -|unorm_2::set_yx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|unorm_2::operator--|| -|unorm_2::operator*=|| -|unorm_2::operator/=|| -|unorm_2::operator++|| -|unorm_2::operator+=|| -|unorm_2::operator=|| -|unorm_2::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|unorm_2::size Constant|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|unorm_2::g|| -|unorm_2::gr|| -|unorm_2::r|| -|unorm_2::rg|| -|unorm_2::x|| -|unorm_2::xy|| -|unorm_2::y|| -|unorm_2::yx|| - -## Inheritance Hierarchy - -`unorm_2` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## unorm_2 - -Default constructor, initializes all elements with 0. - -```cpp -unorm_2() restrict(amp, - cpu); - -unorm_2( - unorm _V0, - unorm _V1) restrict(amp, - cpu); - -unorm_2( - float _V0, - float _V1) restrict(amp, - cpu); - -unorm_2( - unorm _V) restrict(amp, - cpu); - -explicit unorm_2( - float _V) restrict(amp, - cpu); - -unorm_2( - const unorm_2& _Other) restrict(amp, - cpu); - -explicit inline unorm_2( - const uint_2& _Other) restrict(amp, - cpu); - -explicit inline unorm_2( - const int_2& _Other) restrict(amp, - cpu); - -explicit inline unorm_2( - const float_2& _Other) restrict(amp, - cpu); - -explicit inline unorm_2( - const norm_2& _Other) restrict(amp, - cpu); - -explicit inline unorm_2( - const double_2& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 2; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/unorm-3-class.md b/docs/parallel/amp/reference/unorm-3-class.md deleted file mode 100644 index d79203d802b..00000000000 --- a/docs/parallel/amp/reference/unorm-3-class.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -description: "Learn more about: unorm_3 Class" -title: "unorm_3 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::unorm_3::set_zy", "amp_short_vectors/Concurrency::graphics::unorm_3::zxy", "amp_short_vectors/Concurrency::graphics::unorm_3::set_zyx", "amp_short_vectors/Concurrency::graphics::unorm_3::operator-=", "amp_short_vectors/Concurrency::graphics::unorm_3::xzy", "amp_short_vectors/Concurrency::graphics::unorm_3::get_xzy", "amp_short_vectors/Concurrency::graphics::unorm_3::zyx", "amp_short_vectors/Concurrency::graphics::unorm_3::rgb", "amp_short_vectors/Concurrency::graphics::unorm_3::set_xz", "amp_short_vectors/Concurrency::graphics::unorm_3::set_yxz", "amp_short_vectors/Concurrency::graphics::unorm_3::set_yx", "amp_short_vectors/Concurrency::graphics::unorm_3::br", "amp_short_vectors/Concurrency::graphics::unorm_3::get_zy", "amp_short_vectors/Concurrency::graphics::unorm_3::set_zx", "amp_short_vectors/Concurrency::graphics::unorm_3::get_xyz", "amp_short_vectors/Concurrency::graphics::unorm_3::b", "amp_short_vectors/Concurrency::graphics::unorm_3::set_xyz", "amp_short_vectors/Concurrency::graphics::unorm_3", "amp_short_vectors/Concurrency::graphics::unorm_3::set_z", "amp_short_vectors/Concurrency::graphics::unorm_3::set_xy", "amp_short_vectors/Concurrency::graphics::unorm_3::get_zyx", "amp_short_vectors/Concurrency::graphics::unorm_3::get_xy", "amp_short_vectors/Concurrency::graphics::unorm_3::x", "amp_short_vectors/Concurrency::graphics::unorm_3::get_zxy", "amp_short_vectors/Concurrency::graphics::unorm_3::z", "amp_short_vectors/Concurrency::graphics::unorm_3::get_x", "amp_short_vectors/Concurrency::graphics::unorm_3::operator=", "amp_short_vectors/Concurrency::graphics::unorm_3::yxz", "amp_short_vectors/Concurrency::graphics::unorm_3::get_yx", "amp_short_vectors/Concurrency::graphics::unorm_3::gbr", "amp_short_vectors/Concurrency::graphics::unorm_3::get_yxz", "amp_short_vectors/Concurrency::graphics::unorm_3::operator--", "amp_short_vectors/Concurrency::graphics::unorm_3::operator/=", "amp_short_vectors/Concurrency::graphics::unorm_3::brg", "amp_short_vectors/Concurrency::graphics::unorm_3::gb", "amp_short_vectors/Concurrency::graphics::unorm_3::zy", "amp_short_vectors/Concurrency::graphics::unorm_3::set_xzy", "amp_short_vectors/Concurrency::graphics::unorm_3::get_yzx", "amp_short_vectors/Concurrency::graphics::unorm_3::rb", "amp_short_vectors/Concurrency::graphics::unorm_3::gr", "amp_short_vectors/Concurrency::graphics::unorm_3::zx", "amp_short_vectors/Concurrency::graphics::unorm_3::r", "amp_short_vectors/Concurrency::graphics::unorm_3::xyz", "amp_short_vectors/Concurrency::graphics::unorm_3::grb", "amp_short_vectors/Concurrency::graphics::unorm_3::bg", "amp_short_vectors/Concurrency::graphics::unorm_3::get_y", "amp_short_vectors/Concurrency::graphics::unorm_3::g", "amp_short_vectors/Concurrency::graphics::unorm_3::yz", "amp_short_vectors/Concurrency::graphics::unorm_3::yx", "amp_short_vectors/Concurrency::graphics::unorm_3::get_xz", "amp_short_vectors/Concurrency::graphics::unorm_3::set_zxy", "amp_short_vectors/Concurrency::graphics::unorm_3::get_z", "amp_short_vectors/Concurrency::graphics::unorm_3::bgr", "amp_short_vectors/Concurrency::graphics::unorm_3::set_x", "amp_short_vectors/Concurrency::graphics::unorm_3::operator-", "amp_short_vectors/Concurrency::graphics::unorm_3::y", "amp_short_vectors/Concurrency::graphics::unorm_3::set_yzx", "amp_short_vectors/Concurrency::graphics::unorm_3::get_zx", "amp_short_vectors/Concurrency::graphics::unorm_3::yzx", "amp_short_vectors/Concurrency::graphics::unorm_3::operator++", "amp_short_vectors/Concurrency::graphics::unorm_3::set_yz", "amp_short_vectors/Concurrency::graphics::unorm_3::operator+=", "amp_short_vectors/Concurrency::graphics::unorm_3::xz", "amp_short_vectors/Concurrency::graphics::unorm_3::rg", "amp_short_vectors/Concurrency::graphics::unorm_3::xy", "amp_short_vectors/Concurrency::graphics::unorm_3::operator*=", "amp_short_vectors/Concurrency::graphics::unorm_3::set_y", "amp_short_vectors/Concurrency::graphics::unorm_3::get_yz", "amp_short_vectors/Concurrency::graphics::unorm_3::rbg"] -ms.assetid: ea4e7a17-5256-464c-af28-8b01962564c0 ---- -# unorm_3 Class - -Represents a short vector of three unsigned normal numbers. - -## Syntax - -```cpp -class unorm_3; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[unorm_3 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|unorm_3::get_x|| -|unorm_3::get_xy|| -|unorm_3::get_xyz|| -|unorm_3::get_xz|| -|unorm_3::get_xzy|| -|unorm_3::get_y|| -|unorm_3::get_yx|| -|unorm_3::get_yxz|| -|unorm_3::get_yz|| -|unorm_3::get_yzx|| -|unorm_3::get_z|| -|unorm_3::get_zx|| -|unorm_3::get_zxy|| -|unorm_3::get_zy|| -|unorm_3::get_zyx|| -|Unorm_3::ref_b|| -|Unorm_3::ref_g|| -|Unorm_3::ref_r|| -|Unorm_3::ref_x|| -|Unorm_3::ref_y|| -|Unorm_3::ref_z|| -|unorm_3::set_x|| -|unorm_3::set_xy|| -|unorm_3::set_xyz|| -|unorm_3::set_xz|| -|unorm_3::set_xzy|| -|unorm_3::set_y|| -|unorm_3::set_yx|| -|unorm_3::set_yxz|| -|unorm_3::set_yz|| -|unorm_3::set_yzx|| -|unorm_3::set_z|| -|unorm_3::set_zx|| -|unorm_3::set_zxy|| -|unorm_3::set_zy|| -|unorm_3::set_zyx|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|unorm_3::operator--|| -|unorm_3::operator*=|| -|unorm_3::operator/=|| -|unorm_3::operator++|| -|unorm_3::operator+=|| -|unorm_3::operator=|| -|unorm_3::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#unorm_3__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|unorm_3::b|| -|unorm_3::bg|| -|unorm_3::bgr|| -|unorm_3::br|| -|unorm_3::brg|| -|unorm_3::g|| -|unorm_3::gb|| -|unorm_3::gbr|| -|unorm_3::gr|| -|unorm_3::grb|| -|unorm_3::r|| -|unorm_3::rb|| -|unorm_3::rbg|| -|unorm_3::rg|| -|unorm_3::rgb|| -|unorm_3::x|| -|unorm_3::xy|| -|unorm_3::xyz|| -|unorm_3::xz|| -|unorm_3::xzy|| -|unorm_3::y|| -|unorm_3::yx|| -|unorm_3::yxz|| -|unorm_3::yz|| -|unorm_3::yzx|| -|unorm_3::z|| -|unorm_3::zx|| -|unorm_3::zxy|| -|unorm_3::zy|| -|unorm_3::zyx|| - -## Inheritance Hierarchy - -`unorm_3` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## unorm_3 - -Default constructor, initializes all elements with 0. - -```cpp -unorm_3() restrict(amp, - cpu); - -unorm_3( - unorm _V0, - unorm _V1, - unorm _V2) restrict(amp, - cpu); - -unorm_3( - float _V0, - float _V1, - float _V2) restrict(amp, - cpu); - -unorm_3( - unorm _V) restrict(amp, - cpu); - -explicit unorm_3( - float _V) restrict(amp, - cpu); - -unorm_3( - const unorm_3& _Other) restrict(amp, - cpu); - -explicit inline unorm_3( - const uint_3& _Other) restrict(amp, - cpu); - -explicit inline unorm_3( - const int_3& _Other) restrict(amp, - cpu); - -explicit inline unorm_3( - const float_3& _Other) restrict(amp, - cpu); - -explicit inline unorm_3( - const norm_3& _Other) restrict(amp, - cpu); - -explicit inline unorm_3( - const double_3& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 3; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/unorm-4-class.md b/docs/parallel/amp/reference/unorm-4-class.md deleted file mode 100644 index 1726971da23..00000000000 --- a/docs/parallel/amp/reference/unorm-4-class.md +++ /dev/null @@ -1,418 +0,0 @@ ---- -description: "Learn more about: unorm_4 Class" -title: "unorm_4 Class" -ms.date: "11/04/2016" -f1_keywords: ["amp_short_vectors/Concurrency::graphics::unorm_4::set_yxzw", "amp_short_vectors/Concurrency::graphics::unorm_4::gbra", "amp_short_vectors/Concurrency::graphics::unorm_4::abg", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zx", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xzyw", "amp_short_vectors/Concurrency::graphics::unorm_4::brag", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zywx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xwy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_x", "amp_short_vectors/Concurrency::graphics::unorm_4::ra", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xyw", "amp_short_vectors/Concurrency::graphics::unorm_4::rg", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yxwz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xw", "amp_short_vectors/Concurrency::graphics::unorm_4::get_z", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wxyz", "amp_short_vectors/Concurrency::graphics::unorm_4::operator*=", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zyw", "amp_short_vectors/Concurrency::graphics::unorm_4::b", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wyzx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wyz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wyzx", "amp_short_vectors/Concurrency::graphics::unorm_4::ywx", "amp_short_vectors/Concurrency::graphics::unorm_4::ragb", "amp_short_vectors/Concurrency::graphics::unorm_4::yxzw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wzy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_y", "amp_short_vectors/Concurrency::graphics::unorm_4::rag", "amp_short_vectors/Concurrency::graphics::unorm_4::zwxy", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wyxz", "amp_short_vectors/Concurrency::graphics::unorm_4::gab", "amp_short_vectors/Concurrency::graphics::unorm_4::set_yzw", "amp_short_vectors/Concurrency::graphics::unorm_4::rgb", "amp_short_vectors/Concurrency::graphics::unorm_4::arbg", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wyx", "amp_short_vectors/Concurrency::graphics::unorm_4::y", "amp_short_vectors/Concurrency::graphics::unorm_4::wz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_yxwz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xw", "amp_short_vectors/Concurrency::graphics::unorm_4::bgra", "amp_short_vectors/Concurrency::graphics::unorm_4::grb", "amp_short_vectors/Concurrency::graphics::unorm_4::wzx", "amp_short_vectors/Concurrency::graphics::unorm_4::set_ywzx", "amp_short_vectors/Concurrency::graphics::unorm_4::yz", "amp_short_vectors/Concurrency::graphics::unorm_4::xywz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xzwy", "amp_short_vectors/Concurrency::graphics::unorm_4::rba", "amp_short_vectors/Concurrency::graphics::unorm_4::set_ywx", "amp_short_vectors/Concurrency::graphics::unorm_4::wzy", "amp_short_vectors/Concurrency::graphics::unorm_4::bg", "amp_short_vectors/Concurrency::graphics::unorm_4::agb", "amp_short_vectors/Concurrency::graphics::unorm_4::get_w", "amp_short_vectors/Concurrency::graphics::unorm_4::bag", "amp_short_vectors/Concurrency::graphics::unorm_4::bga", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wx", "amp_short_vectors/Concurrency::graphics::unorm_4::arb", "amp_short_vectors/Concurrency::graphics::unorm_4::get_ywz", "amp_short_vectors/Concurrency::graphics::unorm_4::a", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zxyw", "amp_short_vectors/Concurrency::graphics::unorm_4::operator/=", "amp_short_vectors/Concurrency::graphics::unorm_4::w", "amp_short_vectors/Concurrency::graphics::unorm_4::operator++", "amp_short_vectors/Concurrency::graphics::unorm_4::wyxz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yzx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zyx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xywz", "amp_short_vectors/Concurrency::graphics::unorm_4::xyzw", "amp_short_vectors/Concurrency::graphics::unorm_4::rbag", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wxy", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xwzy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wxzy", "amp_short_vectors/Concurrency::graphics::unorm_4::gabr", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xyzw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xyz", "amp_short_vectors/Concurrency::graphics::unorm_4::br", "amp_short_vectors/Concurrency::graphics::unorm_4::yw", "amp_short_vectors/Concurrency::graphics::unorm_4::zxyw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wxzy", "amp_short_vectors/Concurrency::graphics::unorm_4::argb", "amp_short_vectors/Concurrency::graphics::unorm_4::x", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wzxy", "amp_short_vectors/Concurrency::graphics::unorm_4::ab", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_yzwx", "amp_short_vectors/Concurrency::graphics::unorm_4::xyz", "amp_short_vectors/Concurrency::graphics::unorm_4::gbr", "amp_short_vectors/Concurrency::graphics::unorm_4::rab", "amp_short_vectors/Concurrency::graphics::unorm_4::set_yw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xy", "amp_short_vectors/Concurrency::graphics::unorm_4::operator--", "amp_short_vectors/Concurrency::graphics::unorm_4::gba", "amp_short_vectors/Concurrency::graphics::unorm_4::bra", "amp_short_vectors/Concurrency::graphics::unorm_4::garb", "amp_short_vectors/Concurrency::graphics::unorm_4::zwyx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_ywx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_ywzx", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xwy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_ywxz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zxwy", "amp_short_vectors/Concurrency::graphics::unorm_4::agr", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wzx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zxyw", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zy", "amp_short_vectors/Concurrency::graphics::unorm_4::set_yxz", "amp_short_vectors/Concurrency::graphics::unorm_4::zxy", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zxw", "amp_short_vectors/Concurrency::graphics::unorm_4::ga", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zyw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wxyz", "amp_short_vectors/Concurrency::graphics::unorm_4::wxy", "amp_short_vectors/Concurrency::graphics::unorm_4::wzxy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zwy", "amp_short_vectors/Concurrency::graphics::unorm_4::xwz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_yz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wzx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xzwy", "amp_short_vectors/Concurrency::graphics::unorm_4::ywxz", "amp_short_vectors/Concurrency::graphics::unorm_4::yx", "amp_short_vectors/Concurrency::graphics::unorm_4::xzy", "amp_short_vectors/Concurrency::graphics::unorm_4::zy", "amp_short_vectors/Concurrency::graphics::unorm_4::bgar", "amp_short_vectors/Concurrency::graphics::unorm_4::set_y", "amp_short_vectors/Concurrency::graphics::unorm_4::xw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xwyz", "amp_short_vectors/Concurrency::graphics::unorm_4::xzyw", "amp_short_vectors/Concurrency::graphics::unorm_4::ar", "amp_short_vectors/Concurrency::graphics::unorm_4::rgba", "amp_short_vectors/Concurrency::graphics::unorm_4::gra", "amp_short_vectors/Concurrency::graphics::unorm_4::ba", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zyx", "amp_short_vectors/Concurrency::graphics::unorm_4::operator=", "amp_short_vectors/Concurrency::graphics::unorm_4::set_x", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xzw", "amp_short_vectors/Concurrency::graphics::unorm_4::rga", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_z", "amp_short_vectors/Concurrency::graphics::unorm_4::yzx", "amp_short_vectors/Concurrency::graphics::unorm_4::set_yzx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zwx", "amp_short_vectors/Concurrency::graphics::unorm_4::xwzy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zwxy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yxz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xzy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xwyz", "amp_short_vectors/Concurrency::graphics::unorm_4::yzwx", "amp_short_vectors/Concurrency::graphics::unorm_4::bagr", "amp_short_vectors/Concurrency::graphics::unorm_4::yxwz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xyz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zyxw", "amp_short_vectors/Concurrency::graphics::unorm_4::bar", "amp_short_vectors/Concurrency::graphics::unorm_4::zyw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wxz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zxy", "amp_short_vectors/Concurrency::graphics::unorm_4::yzw", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wyxz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zwyx", "amp_short_vectors/Concurrency::graphics::unorm_4::wyzx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zwy", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wx", "amp_short_vectors/Concurrency::graphics::unorm_4::zyxw", "amp_short_vectors/Concurrency::graphics::unorm_4::rbga", "amp_short_vectors/Concurrency::graphics::unorm_4::rabg", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zwxy", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zxy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xwz", "amp_short_vectors/Concurrency::graphics::unorm_4::abr", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zwyx", "amp_short_vectors/Concurrency::graphics::unorm_4::set_yzxw", "amp_short_vectors/Concurrency::graphics::unorm_4::zywx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yzwx", "amp_short_vectors/Concurrency::graphics::unorm_4::zyx", "amp_short_vectors/Concurrency::graphics::unorm_4::g", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xwz", "amp_short_vectors/Concurrency::graphics::unorm_4::zwy", "amp_short_vectors/Concurrency::graphics::unorm_4::gbar", "amp_short_vectors/Concurrency::graphics::unorm_4::zx", "amp_short_vectors/Concurrency::graphics::unorm_4::xzwy", "amp_short_vectors/Concurrency::graphics::unorm_4::bgr", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xwzy", "amp_short_vectors/Concurrency::graphics::unorm_4::set_yx", "amp_short_vectors/Concurrency::graphics::unorm_4::set_w", "amp_short_vectors/Concurrency::graphics::unorm_4::set_yxw", "amp_short_vectors/Concurrency::graphics::unorm_4::wxzy", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zywx", "amp_short_vectors/Concurrency::graphics::unorm_4::agrb", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zxwy", "amp_short_vectors/Concurrency::graphics::unorm_4::zxw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xywz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yzw", "amp_short_vectors/Concurrency::graphics::unorm_4::ywzx", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wxy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yxzw", "amp_short_vectors/Concurrency::graphics::unorm_4::rgab", "amp_short_vectors/Concurrency::graphics::unorm_4::yxz", "amp_short_vectors/Concurrency::graphics::unorm_4::rbg", "amp_short_vectors/Concurrency::graphics::unorm_4::set_ywz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yzxw", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wy", "amp_short_vectors/Concurrency::graphics::unorm_4::zxwy", "amp_short_vectors/Concurrency::graphics::unorm_4::gr", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xzyw", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wzy", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xzw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zwx", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zy", "amp_short_vectors/Concurrency::graphics::unorm_4::zw", "amp_short_vectors/Concurrency::graphics::unorm_4::xz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zyxw", "amp_short_vectors/Concurrency::graphics::unorm_4::agbr", "amp_short_vectors/Concurrency::graphics::unorm_4::gb", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yxw", "amp_short_vectors/Concurrency::graphics::unorm_4::get_yz", "amp_short_vectors/Concurrency::graphics::unorm_4::operator+=", "amp_short_vectors/Concurrency::graphics::unorm_4::ag", "amp_short_vectors/Concurrency::graphics::unorm_4::grab", "amp_short_vectors/Concurrency::graphics::unorm_4::barg", "amp_short_vectors/Concurrency::graphics::unorm_4::r", "amp_short_vectors/Concurrency::graphics::unorm_4::wx", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wyx", "amp_short_vectors/Concurrency::graphics::unorm_4::abgr", "amp_short_vectors/Concurrency::graphics::unorm_4::yxw", "amp_short_vectors/Concurrency::graphics::unorm_4::z", "amp_short_vectors/Concurrency::graphics::unorm_4::grba", "amp_short_vectors/Concurrency::graphics::unorm_4::operator-=", "amp_short_vectors/Concurrency::graphics::unorm_4::gar", "amp_short_vectors/Concurrency::graphics::unorm_4::operator-", "amp_short_vectors/Concurrency::graphics::unorm_4::xyw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xyw", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wzxy", "amp_short_vectors/Concurrency::graphics::unorm_4::brg", "amp_short_vectors/Concurrency::graphics::unorm_4::wy", "amp_short_vectors/Concurrency::graphics::unorm_4::wxz", "amp_short_vectors/Concurrency::graphics::unorm_4::wxyz", "amp_short_vectors/Concurrency::graphics::unorm_4::wyz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wxz", "amp_short_vectors/Concurrency::graphics::unorm_4::get_xyzw", "amp_short_vectors/Concurrency::graphics::unorm_4::xzw", "amp_short_vectors/Concurrency::graphics::unorm_4::xwyz", "amp_short_vectors/Concurrency::graphics::unorm_4::zwx", "amp_short_vectors/Concurrency::graphics::unorm_4::xy", "amp_short_vectors/Concurrency::graphics::unorm_4::set_zx", "amp_short_vectors/Concurrency::graphics::unorm_4::brga", "amp_short_vectors/Concurrency::graphics::unorm_4::get_zxw", "amp_short_vectors/Concurrency::graphics::unorm_4", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wzyx", "amp_short_vectors/Concurrency::graphics::unorm_4::wzyx", "amp_short_vectors/Concurrency::graphics::unorm_4::yzxw", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wz", "amp_short_vectors/Concurrency::graphics::unorm_4::xwy", "amp_short_vectors/Concurrency::graphics::unorm_4::set_ywxz", "amp_short_vectors/Concurrency::graphics::unorm_4::set_xzy", "amp_short_vectors/Concurrency::graphics::unorm_4::arg", "amp_short_vectors/Concurrency::graphics::unorm_4::set_wyz", "amp_short_vectors/Concurrency::graphics::unorm_4::ywz", "amp_short_vectors/Concurrency::graphics::unorm_4::abrg", "amp_short_vectors/Concurrency::graphics::unorm_4::wyx", "amp_short_vectors/Concurrency::graphics::unorm_4::rb", "amp_short_vectors/Concurrency::graphics::unorm_4::get_wzyx"] -ms.assetid: dd216a9d-95f7-4978-8e78-6cb9c781a7e9 ---- -# unorm_4 Class - -Represents a short vector of four unsigned normal numbers. - -## Syntax - -```cpp -class unorm_4; -``` - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`value_type`|| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[unorm_4 Constructor](#ctor)|Overloaded. Default constructor, initializes all elements with 0.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|unorm_4::get_w|| -|unorm_4::get_wx|| -|unorm_4::get_wxy|| -|unorm_4::get_wxyz|| -|unorm_4::get_wxz|| -|unorm_4::get_wxzy|| -|unorm_4::get_wy|| -|unorm_4::get_wyx|| -|unorm_4::get_wyxz|| -|unorm_4::get_wyz|| -|unorm_4::get_wyzx|| -|unorm_4::get_wz|| -|unorm_4::get_wzx|| -|unorm_4::get_wzxy|| -|unorm_4::get_wzy|| -|unorm_4::get_wzyx|| -|unorm_4::get_x|| -|unorm_4::get_xw|| -|unorm_4::get_xwy|| -|unorm_4::get_xwyz|| -|unorm_4::get_xwz|| -|unorm_4::get_xwzy|| -|unorm_4::get_xy|| -|unorm_4::get_xyw|| -|unorm_4::get_xywz|| -|unorm_4::get_xyz|| -|unorm_4::get_xyzw|| -|unorm_4::get_xz|| -|unorm_4::get_xzw|| -|unorm_4::get_xzwy|| -|unorm_4::get_xzy|| -|unorm_4::get_xzyw|| -|unorm_4::get_y|| -|unorm_4::get_yw|| -|unorm_4::get_ywx|| -|unorm_4::get_ywxz|| -|unorm_4::get_ywz|| -|unorm_4::get_ywzx|| -|unorm_4::get_yx|| -|unorm_4::get_yxw|| -|unorm_4::get_yxwz|| -|unorm_4::get_yxz|| -|unorm_4::get_yxzw|| -|unorm_4::get_yz|| -|unorm_4::get_yzw|| -|unorm_4::get_yzwx|| -|unorm_4::get_yzx|| -|unorm_4::get_yzxw|| -|unorm_4::get_z|| -|unorm_4::get_zw|| -|unorm_4::get_zwx|| -|unorm_4::get_zwxy|| -|unorm_4::get_zwy|| -|unorm_4::get_zwyx|| -|unorm_4::get_zx|| -|unorm_4::get_zxw|| -|unorm_4::get_zxwy|| -|unorm_4::get_zxy|| -|unorm_4::get_zxyw|| -|unorm_4::get_zy|| -|unorm_4::get_zyw|| -|unorm_4::get_zywx|| -|unorm_4::get_zyx|| -|unorm_4::get_zyxw|| -|unorm_4::ref_a|| -|unorm_4::ref_b|| -|unorm_4::ref_g|| -|unorm_4::ref_r|| -|unorm_4::ref_w|| -|unorm_4::ref_x|| -|unorm_4::ref_y|| -|unorm_4::ref_z|| -|unorm_4::set_w|| -|unorm_4::set_wx|| -|unorm_4::set_wxy|| -|unorm_4::set_wxyz|| -|unorm_4::set_wxz|| -|unorm_4::set_wxzy|| -|unorm_4::set_wy|| -|unorm_4::set_wyx|| -|unorm_4::set_wyxz|| -|unorm_4::set_wyz|| -|unorm_4::set_wyzx|| -|unorm_4::set_wz|| -|unorm_4::set_wzx|| -|unorm_4::set_wzxy|| -|unorm_4::set_wzy|| -|unorm_4::set_wzyx|| -|unorm_4::set_x|| -|unorm_4::set_xw|| -|unorm_4::set_xwy|| -|unorm_4::set_xwyz|| -|unorm_4::set_xwz|| -|unorm_4::set_xwzy|| -|unorm_4::set_xy|| -|unorm_4::set_xyw|| -|unorm_4::set_xywz|| -|unorm_4::set_xyz|| -|unorm_4::set_xyzw|| -|unorm_4::set_xz|| -|unorm_4::set_xzw|| -|unorm_4::set_xzwy|| -|unorm_4::set_xzy|| -|unorm_4::set_xzyw|| -|unorm_4::set_y|| -|unorm_4::set_yw|| -|unorm_4::set_ywx|| -|unorm_4::set_ywxz|| -|unorm_4::set_ywz|| -|unorm_4::set_ywzx|| -|unorm_4::set_yx|| -|unorm_4::set_yxw|| -|unorm_4::set_yxwz|| -|unorm_4::set_yxz|| -|unorm_4::set_yxzw|| -|unorm_4::set_yz|| -|unorm_4::set_yzw|| -|unorm_4::set_yzwx|| -|unorm_4::set_yzx|| -|unorm_4::set_yzxw|| -|unorm_4::set_z|| -|unorm_4::set_zw|| -|unorm_4::set_zwx|| -|unorm_4::set_zwxy|| -|unorm_4::set_zwy|| -|unorm_4::set_zwyx|| -|unorm_4::set_zx|| -|unorm_4::set_zxw|| -|unorm_4::set_zxwy|| -|unorm_4::set_zxy|| -|unorm_4::set_zxyw|| -|unorm_4::set_zy|| -|unorm_4::set_zyw|| -|unorm_4::set_zywx|| -|unorm_4::set_zyx|| -|unorm_4::set_zyxw|| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|unorm_4::operator-|| -|unorm_4::operator--|| -|unorm_4::operator*=|| -|unorm_4::operator/=|| -|unorm_4::operator++|| -|unorm_4::operator+=|| -|unorm_4::operator=|| -|unorm_4::operator-=|| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[size Constant](#unorm_4__size)|| - -### Public Data Members - -|Name|Description| -|----------|-----------------| -|unorm_4::a|| -|unorm_4::ab|| -|unorm_4::abg|| -|unorm_4::abgr|| -|unorm_4::abr|| -|unorm_4::abrg|| -|unorm_4::ag|| -|unorm_4::agb|| -|unorm_4::agbr|| -|unorm_4::agr|| -|unorm_4::agrb|| -|unorm_4::ar|| -|unorm_4::arb|| -|unorm_4::arbg|| -|unorm_4::arg|| -|unorm_4::argb|| -|unorm_4::b|| -|unorm_4::ba|| -|unorm_4::bag|| -|unorm_4::bagr|| -|unorm_4::bar|| -|unorm_4::barg|| -|unorm_4::bg|| -|unorm_4::bga|| -|unorm_4::bgar|| -|unorm_4::bgr|| -|unorm_4::bgra|| -|unorm_4::br|| -|unorm_4::bra|| -|unorm_4::brag|| -|unorm_4::brg|| -|unorm_4::brga|| -|unorm_4::g|| -|unorm_4::ga|| -|unorm_4::gab|| -|unorm_4::gabr|| -|unorm_4::gar|| -|unorm_4::garb|| -|unorm_4::gb|| -|unorm_4::gba|| -|unorm_4::gbar|| -|unorm_4::gbr|| -|unorm_4::gbra|| -|unorm_4::gr|| -|unorm_4::gra|| -|unorm_4::grab|| -|unorm_4::grb|| -|unorm_4::grba|| -|unorm_4::r|| -|unorm_4::ra|| -|unorm_4::rab|| -|unorm_4::rabg|| -|unorm_4::rag|| -|unorm_4::ragb|| -|unorm_4::rb|| -|unorm_4::rba|| -|unorm_4::rbag|| -|unorm_4::rbg|| -|unorm_4::rbga|| -|unorm_4::rg|| -|unorm_4::rga|| -|unorm_4::rgab|| -|unorm_4::rgb|| -|unorm_4::rgba|| -|unorm_4::w|| -|unorm_4::wx|| -|unorm_4::wxy|| -|unorm_4::wxyz|| -|unorm_4::wxz|| -|unorm_4::wxzy|| -|unorm_4::wy|| -|unorm_4::wyx|| -|unorm_4::wyxz|| -|unorm_4::wyz|| -|unorm_4::wyzx|| -|unorm_4::wz|| -|unorm_4::wzx|| -|unorm_4::wzxy|| -|unorm_4::wzy|| -|unorm_4::wzyx|| -|unorm_4::x|| -|unorm_4::xw|| -|unorm_4::xwy|| -|unorm_4::xwyz|| -|unorm_4::xwz|| -|unorm_4::xwzy|| -|unorm_4::xy|| -|unorm_4::xyw|| -|unorm_4::xywz|| -|unorm_4::xyz|| -|unorm_4::xyzw|| -|unorm_4::xz|| -|unorm_4::xzw|| -|unorm_4::xzwy|| -|unorm_4::xzy|| -|unorm_4::xzyw|| -|unorm_4::y|| -|unorm_4::yw|| -|unorm_4::ywx|| -|unorm_4::ywxz|| -|unorm_4::ywz|| -|unorm_4::ywzx|| -|unorm_4::yx|| -|unorm_4::yxw|| -|unorm_4::yxwz|| -|unorm_4::yxz|| -|unorm_4::yxzw|| -|unorm_4::yz|| -|unorm_4::yzw|| -|unorm_4::yzwx|| -|unorm_4::yzx|| -|unorm_4::yzxw|| -|unorm_4::z|| -|unorm_4::zw|| -|unorm_4::zwx|| -|unorm_4::zwxy|| -|unorm_4::zwy|| -|unorm_4::zwyx|| -|unorm_4::zx|| -|unorm_4::zxw|| -|unorm_4::zxwy|| -|unorm_4::zxy|| -|unorm_4::zxyw|| -|unorm_4::zy|| -|unorm_4::zyw|| -|unorm_4::zywx|| -|unorm_4::zyx|| -|unorm_4::zyxw|| - -## Inheritance Hierarchy - -`unorm_4` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## unorm_4 - -Default constructor, initializes all elements with 0. - -```cpp -unorm_4() restrict(amp, - cpu); - -unorm_4( - unorm _V0, - unorm _V1, - unorm _V2, - unorm _V3) restrict(amp, - cpu); - -unorm_4( - float _V0, - float _V1, - float _V2, - float _V3) restrict(amp, - cpu); - -unorm_4( - unorm _V) restrict(amp, - cpu); - -explicit unorm_4( - float _V) restrict(amp, - cpu); - -unorm_4( - const unorm_4& _Other) restrict(amp, - cpu); - -explicit inline unorm_4( - const uint_4& _Other) restrict(amp, - cpu); - -explicit inline unorm_4( - const int_4& _Other) restrict(amp, - cpu); - -explicit inline unorm_4( - const float_4& _Other) restrict(amp, - cpu); - -explicit inline unorm_4( - const norm_4& _Other) restrict(amp, - cpu); - -explicit inline unorm_4( - const double_4& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V0*
-The value to initialize element 0. - -*_V1*
-The value to initialize element 1. - -*_V2*
-The value to initialize element 2. - -*_V3*
-The value to initialize element 3. - -*_V*
-The value for initialization. - -*_Other*
-The object used to initialize. - -## size - -```cpp -static const int size = 4; -``` - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/unorm-class.md b/docs/parallel/amp/reference/unorm-class.md deleted file mode 100644 index a59ea39f7c5..00000000000 --- a/docs/parallel/amp/reference/unorm-class.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -description: "Learn more about: unorm Class" -title: "unorm Class" -ms.date: "11/04/2016" -f1_keywords: ["unorm", "AMP_SHORT_VECTORS/unorm", "AMP_SHORT_VECTORS/Concurrency::graphics::unorm Constructor"] -ms.assetid: bc30bd20-6452-4d5f-9158-3b11c4c16ed2 ---- -# unorm Class - -Represent a unorm number. Each element is a floating point number in the range of [0.0f, 1.0f]. - -## Syntax - -```cpp -class unorm; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[unorm Constructor](#ctor)|Overloaded. Default constructor. Initialize to 0.0f.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|unorm::operator--|| -|unorm::operator float|Conversion operator. Convert the unorm number to a floating point value.| -|unorm::operator*=|| -|unorm::operator/=|| -|unorm::operator++|| -|unorm::operator+=|| -|unorm::operator=|| -|unorm::operator-=|| - -## Inheritance Hierarchy - -`unorm` - -## Requirements - -**Header:** amp_short_vectors.h - -**Namespace:** Concurrency::graphics - -## unorm - -Default constructor. Initialize to 0.0f. - -```cpp -unorm( - void) restrict(amp, - cpu); - -explicit unorm( - float _V) restrict(amp, - cpu); - -explicit unorm( - unsigned int _V) restrict(amp, - cpu); - -explicit unorm( - int _V) restrict(amp, - cpu); - -explicit unorm( - double _V) restrict(amp, - cpu); - -unorm( - const unorm& _Other) restrict(amp, - cpu); - -inline explicit unorm( - const norm& _Other) restrict(amp, - cpu); -``` - -### Parameters - -*_V*
-The value used to initialize. - -*_Other*
-The norm object used to initialize. - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/reference/unsupported-feature-class.md b/docs/parallel/amp/reference/unsupported-feature-class.md deleted file mode 100644 index 637c3551bbd..00000000000 --- a/docs/parallel/amp/reference/unsupported-feature-class.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: "Learn more about: unsupported_feature Class" -title: "unsupported_feature Class" -ms.date: "03/27/2019" -f1_keywords: ["unsupported_feature", "AMPRT/unsupported_feature", "AMPRT/Concurrency::unsupported_feature"] -helpviewer_keywords: ["unsupported_feature class"] -ms.assetid: 6b1ab917-df13-48c7-9648-7cb2465a0ff5 ---- -# unsupported_feature Class - -The exception that is thrown when an unsupported feature is used. - -## Syntax - -```cpp -class unsupported_feature : public runtime_exception; -``` - -## Members - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[unsupported_feature Constructor](#unsupported_feature)|Constructs a new instance of the `unsupported_feature` exception.| - -## Inheritance Hierarchy - -`exception` - -`runtime_exception` - -`unsupported_feature` - -## unsupported_feature - - Constructs a new instance of the `unsupported_feature` exception. - -### Syntax - -```cpp -explicit unsupported_feature( - const char * _Message ) throw(); - -unsupported_feature() throw(); -``` - -### Parameters - -*_Message*
-A description of the error. - -### Return Value - -The `unsupported_feature` object. - -## Requirements - -**Header:** amprt.h - -**Namespace:** Concurrency - -## See also - -[Concurrency Namespace (C++ AMP)](concurrency-namespace-cpp-amp.md) diff --git a/docs/parallel/amp/reference/writeonly-texture-view-class.md b/docs/parallel/amp/reference/writeonly-texture-view-class.md deleted file mode 100644 index cedd6714dc1..00000000000 --- a/docs/parallel/amp/reference/writeonly-texture-view-class.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -description: "Learn more about: writeonly_texture_view Class" -title: "writeonly_texture_view Class" -ms.date: "11/04/2016" -f1_keywords: ["writeonly_texture_view", "AMP_GRAPHICS/writeonly_texture_view", "AMP_GRAPHICS/Concurrency::graphics::writeonly_texture_view", "AMP_GRAPHICS/Concurrency::graphics::writeonly_texture_view::set", "AMP_GRAPHICS/Concurrency::graphics::rank Constant"] -ms.assetid: 8d117ad3-0a1c-41ae-b29c-7c95fdd4d04d ---- -# writeonly_texture_view Class - -Provides writeonly access to a texture. - -## Syntax - -```cpp -template < - typename value_type, - int _Rank -> -class writeonly_texture_view; - -template < - typename value_type, - int _Rank -> -class writeonly_texture_view : public details::_Texture_base; -``` - -### Parameters - -*value_type*
-The type of the elements in the texture. - -*_Rank*
-The rank of the texture. - -## Members - -### Public Typedefs - -|Name|Description| -|----------|-----------------| -|`scalar_type`|| -|`value_type`|The type of the elements in the texture.| - -### Public Constructors - -|Name|Description| -|----------|-----------------| -|[writeonly_texture_view Constructor](#ctor)|Initializes a new instance of the `writeonly_texture_view` class.| -|[~writeonly_texture_view Destructor](#ctor)|Destroys the `writeonly_texture_view` object.| - -### Public Methods - -|Name|Description| -|----------|-----------------| -|[set](#set)|Sets the value of the element at the specified index.| - -### Public Operators - -|Name|Description| -|----------|-----------------| -|[operator=](#operator_eq)|Copies the specified `writeonly_texture_view` object to this one.| - -### Public Constants - -|Name|Description| -|----------|-----------------| -|[rank Constant](#rank)|Gets the rank of the `writeonly_texture_view` object.| - -## Inheritance Hierarchy - -`_Texture_base` - -`writeonly_texture_view` - -## Requirements - -**Header:** amp_graphics.h - -**Namespace:** Concurrency::graphics - -## ~writeonly_texture_view - -Destroys the `writeonly_texture_view` object. - -```cpp -~writeonly_texture_view() restrict(amp,cpu); -``` - -## operator= - -Copies the specified `writeonly_texture_view` object to this one. - -```cpp -writeonly_texture_view& operator= ( - const writeonly_texture_view& _Other) restrict(amp,cpu); -``` - -### Parameters - -*_Other*
-`writeonly_texture_view` object to copy from. - -### Return Value - -A reference to this `writeonly_texture_view` object. - -## rank - -Gets the rank of the `writeonly_texture_view` object. - -```cpp -static const int rank = _Rank; -``` - -## set - -Sets the value of the element at the specified index. - -```cpp -void set( - const index<_Rank>& _Index, - const value_type& value) const restrict(amp); -``` - -### Parameters - -*_Index*
-The index of the element. - -*value*
-The new value of the element. - -## writeonly_texture_view - -Initializes a new instance of the `writeonly_texture_view` class. - -```cpp -writeonly_texture_view( - texture& _Src) restrict(amp); - -writeonly_texture_view( - const writeonly_texture_view& _Src) restrict(amp,cpu); -``` - -### Parameters - -*_Rank*
-The rank of the texture. - -*value_type*
-The type of the elements in the texture. - -*_Src*
-The texture that is used to create the `writeonly_texture_view`. - -## See also - -[Concurrency::graphics Namespace](concurrency-graphics-namespace.md) diff --git a/docs/parallel/amp/using-accelerator-and-accelerator-view-objects.md b/docs/parallel/amp/using-accelerator-and-accelerator-view-objects.md deleted file mode 100644 index 5546f803840..00000000000 --- a/docs/parallel/amp/using-accelerator-and-accelerator-view-objects.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -title: "Using accelerator and accelerator_view Objects" -description: "Learn more about: Using accelerator and accelerator_view Objects" -ms.date: "11/04/2016" -ms.topic: how-to ---- -# Using accelerator and accelerator_view Objects - -You can use the [accelerator](reference/accelerator-class.md) and [accelerator_view](reference/accelerator-view-class.md) classes to specify the device or emulator to run your C++ AMP code on. A system might have several devices or emulators that differ by amount of memory, shared memory support, debugging support, or double-precision support. C++ Accelerated Massive Parallelism (C++ AMP) provides APIs that you can use to examine the available accelerators, set one as the default, specify multiple accelerator_views for multiple calls to parallel_for_each, and perform special debugging tasks. - -> [!NOTE] -> C++ AMP headers are deprecated starting with Visual Studio 2022 version 17.0. -> Including any AMP headers will generate build errors. Define `_SILENCE_AMP_DEPRECATION_WARNINGS` before including any AMP headers to silence the warnings. - -## Using the Default Accelerator - -The C++ AMP runtime picks a default accelerator, unless you write code to pick a specific one. The runtime chooses the default accelerator as follows: - -1. If the app is running in debug mode, an accelerator that supports debugging. - -2. Otherwise, the accelerator that's specified by the `CPPAMP_DEFAULT_ACCELERATOR` environment variable, if it's set. - -3. Otherwise, a non-emulated device. - -4. Otherwise, the device that has the greatest amount of available memory. - -5. Otherwise, a device that's not attached to the display. - -Additionally, the runtime specifies an `access_type` of `access_type_auto` for the default accelerator. This means that the default accelerator uses shared memory if it's supported and if its performance characteristics (bandwidth and latency) are known to be the same as dedicated (non-shared) memory. - -You can determine the properties of the default accelerator by constructing the default accelerator and examining its properties. The following code example prints the path, amount of accelerator memory, shared memory support, double-precision support, and limited double-precision support of the default accelerator. - -```cpp -void default_properties() { - accelerator default_acc; - std::wcout << default_acc.device_path << "\n"; - std::wcout << default_acc.dedicated_memory << "\n"; - std::wcout << (accs[i].supports_cpu_shared_memory ? - "CPU shared memory: true" : "CPU shared memory: false") << "\n"; - std::wcout << (accs[i].supports_double_precision ? - "double precision: true" : "double precision: false") << "\n"; - std::wcout << (accs[i].supports_limited_double_precision ? - "limited double precision: true" : "limited double precision: false") << "\n"; -} -``` - -### CPPAMP_DEFAULT_ACCELERATOR Environment Variable - -You can set the `CPPAMP_DEFAULT_ACCELERATOR` environment variable to specify the `accelerator::device_path` of the default accelerator. The path is hardware-dependent. The following code uses the `accelerator::get_all` function to retrieve a list of the available accelerators and then displays the path and characteristics of each accelerator. - -```cpp -void list_all_accelerators() -{ - std::vector accs = accelerator::get_all(); - - for (int i = 0; i accs = accelerator::get_all(); - accelerator acc_chosen = accs[0]; - - for (int i = 0; i acc_chosen.dedicated_memory) { - acc_chosen = accs[i]; - } - } - - std::wcout << "The accelerator with the most memory is " - << acc_chosen.device_path << "\n" - << acc_chosen.dedicated_memory << ".\n"; -} -``` - -> [!NOTE] -> One of the accelerators that are returned by `accelerator::get_all` is the CPU accelerator. You cannot execute code on the CPU accelerator. To filter out the CPU accelerator, compare the value of the [device_path](reference/accelerator-class.md#device_path) property of the accelerator that's returned by `accelerator::get_all` with the value of the [accelerator::cpu_accelerator](reference/accelerator-class.md#cpu_accelerator). For more information, see the "Special Accelerators" section in this article. - -## Shared Memory - -Shared memory is memory that can be accessed by both the CPU and the accelerator. The use of shared memory eliminates or significantly reduces the overhead of copying data between the CPU and the accelerator. Although the memory is shared, it cannot be accessed concurrently by both the CPU and the accelerator, and doing so causes undefined behavior. The accelerator property [supports_cpu_shared_memory](reference/accelerator-class.md#supports_cpu_shared_memory) returns **`true`** if the accelerator supports shared memory, and the [default_cpu_access_type](reference/accelerator-class.md#default_cpu_access_type) property gets the default [access_type](reference/concurrency-namespace-enums-amp.md#access_type) for memory allocated on the `accelerator`—for example, **array**s associated with the `accelerator`, or `array_view` objects accessed on the `accelerator`. - -The C++ AMP runtime automatically chooses the best default `access_type` for each `accelerator`, but the performance characteristics (bandwidth and latency) of shared memory can be worse than those of dedicated (non-shared) accelerator memory when reading from the CPU, writing from the CPU, or both. If shared memory performs as well as dedicated memory for reading and writing from the CPU, the runtime defaults to `access_type_read_write`; otherwise, the runtime chooses a more conservative default `access_type`, and allows the app to override it if the memory access patterns of its computation kernels benefit from a different `access_type`. - -The following code example shows how to determine whether the default accelerator supports shared memory, and then overrides its default access type and creates an `accelerator_view` from it. - -```cpp -#include -#include - -using namespace Concurrency; - -int main() -{ - accelerator acc = accelerator(accelerator::default_accelerator); - - // Early out if the default accelerator doesn't support shared memory. - if (!acc.supports_cpu_shared_memory) - { - std::cout << "The default accelerator does not support shared memory" << std::endl; - return 1; - } - - // Override the default CPU access type. - acc.set_default_cpu_access_type(access_type_read_write); - - // Create an accelerator_view from the default accelerator. The - // accelerator_view reflects the default_cpu_access_type of the - // accelerator it's associated with. - accelerator_view acc_v = acc.default_view; -} -``` - -An `accelerator_view` always reflects the `default_cpu_access_type` of the `accelerator` it's associated with, and it provides no interface to override or change its `access_type`. - -## Changing the Default Accelerator - -You can change the default accelerator by calling the `accelerator::set_default` method. You can change the default accelerator only once per app execution and you must change it before any code is executed on the GPU. Any subsequent function calls to change the accelerator return **`false`**. If you want to use a different accelerator in a call to `parallel_for_each`, read the "Using Multiple Accelerators" section in this article. The following code example sets the default accelerator to one that is not emulated, is not connected to a display, and supports double-precision. - -```cpp -bool pick_accelerator() -{ - std::vector accs = accelerator::get_all(); - accelerator chosen_one; - - auto result = std::find_if(accs.begin(), accs.end(), - [] (const accelerator& acc) { - return !acc.is_emulated && - acc.supports_double_precision && - !acc.has_display; - }); - - if (result != accs.end()) { - chosen_one = *(result); - } - - std::wcout < [!NOTE] -> C++ AMP headers are deprecated starting with Visual Studio 2022 version 17.0. -> Including any AMP headers will generate build errors. Define `_SILENCE_AMP_DEPRECATION_WARNINGS` before including any AMP headers to silence the warnings. - -## Performance considerations - -If you're using Visual C++ component extensions C++/CX to create your Universal Windows Platform (UWP) app, we recommend that you use plain-old-data (POD) types together with contiguous storage—for example, `std::vector` or C-style arrays—for data that will be used with C++ AMP. This can help you achieve higher performance than by using non-POD types or Windows Runtime containers because no marshaling has to occur. - -In a C++ AMP kernel, to access data that's stored in this way, just wrap the `std::vector` or array storage in a `concurrency::array_view` and then use the array view in a `concurrency::parallel_for_each` loop: - -```cpp -// simple vector addition example -std::vector data0(1024, 1); -std::vector data1(1024, 2); -std::vector data_out(data0.size(), 0); - -concurrency::array_view av0(data0.size(), data0); -concurrency::array_view av1(data1.size(), data1); -concurrency::array_view av2(data_out.size(), data2); - -av2.discard_data(); - -concurrency::parallel_for_each(av0.extent, [=](concurrency::index<1> idx) restrict(amp) - { - av2[idx] = av0[idx] + av1[idx]; - }); -``` - -## Marshaling Windows Runtime types - -When you work with Windows Runtime APIs, you might want to use C++ AMP on data that's stored in a Windows Runtime container such as a `Platform::Array^` or in complex data types such as classes or structs that are declared by using the **ref** keyword or the **value** keyword. In these situations, you have to do some extra work to make the data available to C++ AMP. - -### Platform::Array\^, where T is a POD type - -When you encounter a `Platform::Array^` and T is a POD type, you can access its underlying storage just by using the `get` member function: - -```cpp -Platform::Array^ arr; // Assume that this was returned by a Windows Runtime API -concurrency::array_view av(arr->Length, &arr->get(0)); -``` - -If T is not a POD type, use the technique that's described in the following section to use the data with C++ AMP. - -### Windows Runtime types: ref classes and value classes - -C++ AMP doesn't support complex data types. This includes non-POD types and any types that are declared by using the **ref** keyword or the **value** keyword. If an unsupported type is used in a `restrict(amp)` context, a compile-time error is generated. - -When you encounter an unsupported type, you can copy interesting parts of its data into a `concurrency::array` object. In addition to making the data available for C++ AMP to consume, this manual-copy approach can also improve performance by maximizing data locality, and by ensuring that data that won't be used isn't copied to the accelerator. You can improve performance further by using a *staging array*, which is a special form of `concurrency::array` that provides a hint to the AMP runtime that the array should be optimized for frequent transfer between it and other arrays on the specified accelerator. - -```cpp -// pixel_color.h -ref class pixel_color sealed -{ -public: - pixel_color(Platform::String^ color_name, int red, int green, int blue) - { - name = color_name; - r = red; - g = green; - b = blue; - } - - property Platform::String^ name; - property int r; - property int g; - property int b; -}; - -// Some other file - -std::vector pixels (256); - -for (pixel_color ^pixel : pixels) -{ - pixels.push_back(ref new pixel_color("blue", 0, 0, 255)); -} - -// Create the accelerators -auto cpuAccelerator = concurrency::accelerator(concurrency::accelerator::cpu_accelerator); -auto devAccelerator = concurrency::accelerator(concurrency::accelerator::default_accelerator); - -// Create the staging arrays -concurrency::array red_vec(256, cpuAccelerator.default_view, devAccelerator.default_view); -concurrency::array blue_vec(256, cpuAccelerator.default_view, devAccelerator.default_view); - -// Extract data from the complex array of structs into staging arrays. -concurrency::parallel_for(0, 256, [&](int i) - { - red_vec[i] = pixels[i]->r; - blue_vec[i] = pixels[i]->b; - }); - -// Array views are still used to copy data to the accelerator -concurrency::array_view av_red(red_vec); -concurrency::array_view av_blue(blue_vec); - -// Change all pixels from blue to red. -concurrency::parallel_for_each(av_red.extent, [=](index<1> idx) restrict(amp) - { - av_red[idx] = 255; - av_blue[idx] = 0; - }); -``` - -## See also - -[Create your first UWP app using C++](/windows/uwp/get-started/create-a-basic-windows-10-app-in-cpp)
-[Creating Windows Runtime Components in C++](/windows/uwp/winrt-components/creating-windows-runtime-components-in-cpp) diff --git a/docs/parallel/amp/using-lambdas-function-objects-and-restricted-functions.md b/docs/parallel/amp/using-lambdas-function-objects-and-restricted-functions.md deleted file mode 100644 index dfe089c6702..00000000000 --- a/docs/parallel/amp/using-lambdas-function-objects-and-restricted-functions.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -description: "Learn more about: Using Lambdas, Function Objects, and Restricted Functions" -title: "Using Lambdas, Function Objects, and Restricted Functions" -ms.date: "11/04/2016" -ms.topic: concept-article ---- -# Using Lambdas, Function Objects, and Restricted Functions - -The C++ AMP code that you want to run on the accelerator is specified as an argument in a call to the [`parallel_for_each`](reference/concurrency-namespace-functions-amp.md#parallel_for_each) method. You can provide either a lambda expression or a function object (functor) as that argument. Additionally, the lambda expression or function object can call a C++ AMP-restricted function. This topic uses an array addition algorithm to demonstrate lambdas, function objects, and restricted functions. The following example shows the algorithm without C++ AMP code. Two 1-dimensional arrays of equal length are created. The corresponding integer elements are added and stored in a third 1-dimensional array. C++ AMP is not used. - -```cpp -void CpuMethod() { - - int aCPP[] = {1, 2, 3, 4, 5}; - int bCPP[] = {6, 7, 8, 9, 10}; - int sumCPP[5]; - - for (int idx = 0; idx <5; idx++) - { - sumCPP[idx] = aCPP[idx] + bCPP[idx]; - } - - for (int idx = 0; idx <5; idx++) - { - std::cout < a(5, aCPP); - - array_view b(5, bCPP); - - array_view sum(5, sumCPP); - - sum.discard_data(); - - parallel_for_each( - sum.extent, - [=](index<1> idx) restrict(amp) - { - sum[idx] = a[idx] + b[idx]; - }); - - for (int i = 0; i <5; i++) { - std::cout <& a, - const array_view& b, - const array_view& sum) - : a(a), b(b), sum(sum) - { - } - - void operator()(index<1> idx) restrict(amp) - { - sum[idx] = a[idx] + b[idx]; - } - -private: - array_view a; - array_view b; - array_view sum; -}; - -void AddArraysWithFunctionObject() { - int aCPP[] = {1, 2, 3, 4, 5}; - int bCPP[] = {6, 7, 8, 9, 10}; - int sumCPP[5]; - - array_view a(5, aCPP); - - array_view b(5, bCPP); - - array_view sum(5, sumCPP); - - sum.discard_data(); - - parallel_for_each( - sum.extent, - AdditionFunctionObject(a, b, sum)); - - for (int i = 0; i <5; i++) { - std::cout < idx, array_view sum, array_view a, array_view b) restrict(amp) -{ - sum[idx] = a[idx] + b[idx]; -} - -void AddArraysWithFunction() { - - int aCPP[] = {1, 2, 3, 4, 5}; - int bCPP[] = {6, 7, 8, 9, 10}; - int sumCPP[5]; - - array_view a(5, aCPP); - - array_view b(5, bCPP); - - array_view sum(5, sumCPP); - - sum.discard_data(); - - parallel_for_each( - sum.extent, - [=](index<1> idx) restrict(amp) - { - AddElementsWithRestrictedFunction(idx, sum, a, b); - }); - - for (int i = 0; i <5; i++) { - std::cout < -[Lambda Expression Syntax](../../cpp/lambda-expression-syntax.md)
-[Function Call](../../cpp/function-call-cpp.md)
-[Function Objects in the C++ Standard Library](../../standard-library/function-objects-in-the-stl.md)
-[restrict (C++ AMP)](../../cpp/restrict-cpp-amp.md) diff --git a/docs/parallel/amp/using-tiles.md b/docs/parallel/amp/using-tiles.md deleted file mode 100644 index e8b2840cdca..00000000000 --- a/docs/parallel/amp/using-tiles.md +++ /dev/null @@ -1,334 +0,0 @@ ---- -description: "Learn more about: Using Tiles" -title: "Using Tiles" -ms.date: "11/19/2018" -ms.topic: how-to ---- -# Using Tiles - -You can use tiling to maximize the acceleration of your app. Tiling divides threads into equal rectangular subsets or *tiles*. If you use an appropriate tile size and tiled algorithm, you can get even more acceleration from your C++ AMP code. The basic components of tiling are: - -- `tile_static` variables. The primary benefit of tiling is the performance gain from `tile_static` access. Access to data in `tile_static` memory can be significantly faster than access to data in the global space (`array` or `array_view` objects). An instance of a `tile_static` variable is created for each tile, and all threads in the tile have access to the variable. In a typical tiled algorithm, data is copied into `tile_static` memory once from global memory and then accessed many times from the `tile_static` memory. - -- [tile_barrier::wait Method](reference/tile-barrier-class.md#wait). A call to `tile_barrier::wait` suspends execution of the current thread until all of the threads in the same tile reach the call to `tile_barrier::wait`. You cannot guarantee the order that the threads will run in, only that no threads in the tile will execute past the call to `tile_barrier::wait` until all of the threads have reached the call. This means that by using the `tile_barrier::wait` method, you can perform tasks on a tile-by-tile basis rather than a thread-by-thread basis. A typical tiling algorithm has code to initialize the `tile_static` memory for the whole tile followed by a call to `tile_barrier::wait`. Code that follows `tile_barrier::wait` contains computations that require access to all the `tile_static` values. - -- Local and global indexing. You have access to the index of the thread relative to the entire `array_view` or `array` object and the index relative to the tile. Using the local index can make your code easier to read and debug. Typically, you use local indexing to access `tile_static` variables, and global indexing to access `array` and `array_view` variables. - -- [tiled_extent Class](../../parallel/amp/reference/tiled-extent-class.md) and [tiled_index Class](../../parallel/amp/reference/tiled-index-class.md). You use a `tiled_extent` object instead of an `extent` object in the `parallel_for_each` call. You use a `tiled_index` object instead of an `index` object in the `parallel_for_each` call. - -To take advantage of tiling, your algorithm must partition the compute domain into tiles and then copy the tile data into `tile_static` variables for faster access. - -## Example of Global, Tile, and Local Indices - -> [!NOTE] -> C++ AMP headers are deprecated starting with Visual Studio 2022 version 17.0. -> Including any AMP headers will generate build errors. Define `_SILENCE_AMP_DEPRECATION_WARNINGS` before including any AMP headers to silence the warnings. - -The following diagram represents an 8x9 matrix of data that is arranged in 2x3 tiles. - -![Diagram of an 8 by 9 matrix divided into 2 by 3 tiles.](../../parallel/amp/media/usingtilesmatrix.png) - -The following example displays the global, tile, and local indices of this tiled matrix. An `array_view` object is created by using elements of type `Description`. The `Description` holds the global, tile, and local indices of the element in the matrix. The code in the call to `parallel_for_each` sets the values of the global, tile, and local indices of each element. The output displays the values in the `Description` structures. - -```cpp -#include -#include -#include -#include -using namespace concurrency; - -const int ROWS = 8; -const int COLS = 9; - -// tileRow and tileColumn specify the tile that each thread is in. -// globalRow and globalColumn specify the location of the thread in the array_view. -// localRow and localColumn specify the location of the thread relative to the tile. -struct Description { - int value; - int tileRow; - int tileColumn; - int globalRow; - int globalColumn; - int localRow; - int localColumn; -}; - -// A helper function for formatting the output. -void SetConsoleColor(int color) { - int colorValue = (color == 0) 4 : 2; - SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), colorValue); -} - -// A helper function for formatting the output. -void SetConsoleSize(int height, int width) { - COORD coord; - - coord.X = width; - coord.Y = height; - SetConsoleScreenBufferSize(GetStdHandle(STD_OUTPUT_HANDLE), coord); - - SMALL_RECT* rect = new SMALL_RECT(); - rect->Left = 0; - rect->Top = 0; - rect->Right = width; - rect->Bottom = height; - SetConsoleWindowInfo(GetStdHandle(STD_OUTPUT_HANDLE), true, rect); -} - -// This method creates an 8x9 matrix of Description structures. -// In the call to parallel_for_each, the structure is updated -// with tile, global, and local indices. -void TilingDescription() { - // Create 72 (8x9) Description structures. - std::vector descs; - for (int i = 0; i < ROWS * COLS; i++) { - Description d = {i, 0, 0, 0, 0, 0, 0}; - descs.push_back(d); - } - - // Create an array_view from the Description structures. - extent<2> matrix(ROWS, COLS); - array_view descriptions(matrix, descs); - - // Update each Description with the tile, global, and local indices. - parallel_for_each(descriptions.extent.tile< 2, 3>(), - [=] (tiled_index< 2, 3> t_idx) restrict(amp) - { - descriptions[t_idx].globalRow = t_idx.global[0]; - descriptions[t_idx].globalColumn = t_idx.global[1]; - descriptions[t_idx].tileRow = t_idx.tile[0]; - descriptions[t_idx].tileColumn = t_idx.tile[1]; - descriptions[t_idx].localRow = t_idx.local[0]; - descriptions[t_idx].localColumn= t_idx.local[1]; - }); - - // Print out the Description structure for each element in the matrix. - // Tiles are displayed in red and green to distinguish them from each other. - SetConsoleSize(100, 150); - for (int row = 0; row < ROWS; row++) { - for (int column = 0; column < COLS; column++) { - SetConsoleColor((descriptions(row, column).tileRow + descriptions(row, column).tileColumn) % 2); - std::cout << "Value: " << std::setw(2) << descriptions(row, column).value << " "; - } - std::cout << "\n"; - - for (int column = 0; column < COLS; column++) { - SetConsoleColor((descriptions(row, column).tileRow + descriptions(row, column).tileColumn) % 2); - std::cout << "Tile: " << "(" << descriptions(row, column).tileRow << "," << descriptions(row, column).tileColumn << ") "; - } - std::cout << "\n"; - - for (int column = 0; column < COLS; column++) { - SetConsoleColor((descriptions(row, column).tileRow + descriptions(row, column).tileColumn) % 2); - std::cout << "Global: " << "(" << descriptions(row, column).globalRow << "," << descriptions(row, column).globalColumn << ") "; - } - std::cout << "\n"; - - for (int column = 0; column < COLS; column++) { - SetConsoleColor((descriptions(row, column).tileRow + descriptions(row, column).tileColumn) % 2); - std::cout << "Local: " << "(" << descriptions(row, column).localRow << "," << descriptions(row, column).localColumn << ") "; - } - std::cout << "\n"; - std::cout << "\n"; - } -} - -int main() { - TilingDescription(); - char wait; - std::cin >> wait; -} -``` - -The main work of the example is in the definition of the `array_view` object and the call to `parallel_for_each`. - -1. The vector of `Description` structures is copied into an 8x9 `array_view` object. - -2. The `parallel_for_each` method is called with a `tiled_extent` object as the compute domain. The `tiled_extent` object is created by calling the `extent::tile()` method of the `descriptions` variable. The type parameters of the call to `extent::tile()`, `<2,3>`, specify that 2x3 tiles are created. Thus, the 8x9 matrix is tiled into 12 tiles, four rows and three columns. - -3. The `parallel_for_each` method is called by using a `tiled_index<2,3>` object (`t_idx`) as the index. The type parameters of the index (`t_idx`) must match the type parameters of the compute domain (`descriptions.extent.tile< 2, 3>()`). - -4. When each thread is executed, the index `t_idx` returns information about which tile the thread is in (`tiled_index::tile` property) and the location of the thread within the tile (`tiled_index::local` property). - -## Tile Synchronization—tile_static and tile_barrier::wait - -The previous example illustrates the tile layout and indices, but is not in itself very useful. Tiling becomes useful when the tiles are integral to the algorithm and exploit `tile_static` variables. Because all threads in a tile have access to `tile_static` variables, calls to `tile_barrier::wait` are used to synchronize access to the `tile_static` variables. Although all of the threads in a tile have access to the `tile_static` variables, there is no guaranteed order of execution of threads in the tile. The following example shows how to use `tile_static` variables and the `tile_barrier::wait` method to calculate the average value of each tile. Here are the keys to understanding the example: - -1. The rawData is stored in an 8x8 matrix. - -2. The tile size is 2x2. This creates a 4x4 grid of tiles and the averages can be stored in a 4x4 matrix by using an `array` object. There are only a limited number of types that you can capture by reference in an AMP-restricted function. The `array` class is one of them. - -3. The matrix size and sample size are defined by using `#define` statements, because the type parameters to `array`, `array_view`, `extent`, and `tiled_index` must be constant values. You can also use `const int static` declarations. As an additional benefit, it is trivial to change the sample size to calculate the average over 4x4 tiles. - -4. A `tile_static` 2x2 array of float values is declared for each tile. Although the declaration is in the code path for every thread, only one array is created for each tile in the matrix. - -5. There is a line of code to copy the values in each tile to the `tile_static` array. For each thread, after the value is copied to the array, execution on the thread stops due to the call to `tile_barrier::wait`. - -6. When all of the threads in a tile have reached the barrier, the average can be calculated. Because the code executes for every thread, there is an `if` statement to only calculate the average on one thread. The average is stored in the averages variable. The barrier is essentially the construct that controls calculations by tile, much as you might use a **`for`** loop. - -7. The data in the `averages` variable, because it is an `array` object, must be copied back to the host. This example uses the vector conversion operator. - -8. In the complete example, you can change SAMPLESIZE to 4 and the code executes correctly without any other changes. - -```cpp -#include -#include -using namespace concurrency; - -#define SAMPLESIZE 2 -#define MATRIXSIZE 8 -void SamplingExample() { - - // Create data and array_view for the matrix. - std::vector rawData; - for (int i = 0; i < MATRIXSIZE * MATRIXSIZE; i++) { - rawData.push_back((float)i); - } - extent<2> dataExtent(MATRIXSIZE, MATRIXSIZE); - array_view matrix(dataExtent, rawData); - - // Create the array for the averages. - // There is one element in the output for each tile in the data. - std::vector outputData; - int outputSize = MATRIXSIZE / SAMPLESIZE; - for (int j = 0; j < outputSize * outputSize; j++) { - outputData.push_back((float)0); - } - extent<2> outputExtent(MATRIXSIZE / SAMPLESIZE, MATRIXSIZE / SAMPLESIZE); - array averages(outputExtent, outputData.begin(), outputData.end()); - - // Use tiles that are SAMPLESIZE x SAMPLESIZE. - // Find the average of the values in each tile. - // The only reference-type variable you can pass into the parallel_for_each call - // is a concurrency::array. - parallel_for_each(matrix.extent.tile(), - [=, &averages] (tiled_index t_idx) restrict(amp) - { - // Copy the values of the tile into a tile-sized array. - tile_static float tileValues[SAMPLESIZE][SAMPLESIZE]; - tileValues[t_idx.local[0]][t_idx.local[1]] = matrix[t_idx]; - - // Wait for the tile-sized array to load before you calculate the average. - t_idx.barrier.wait(); - - // If you remove the if statement, then the calculation executes for every - // thread in the tile, and makes the same assignment to averages each time. - if (t_idx.local[0] == 0 && t_idx.local[1] == 0) { - for (int trow = 0; trow < SAMPLESIZE; trow++) { - for (int tcol = 0; tcol < SAMPLESIZE; tcol++) { - averages(t_idx.tile[0],t_idx.tile[1]) += tileValues[trow][tcol]; - } - } - averages(t_idx.tile[0],t_idx.tile[1]) /= (float) (SAMPLESIZE * SAMPLESIZE); - } - }); - - // Print out the results. - // You cannot access the values in averages directly. You must copy them - // back to a CPU variable. - outputData = averages; - for (int row = 0; row < outputSize; row++) { - for (int col = 0; col < outputSize; col++) { - std::cout << outputData[row*outputSize + col] << " "; - } - std::cout << "\n"; - } - // Output for SAMPLESIZE = 2 is: - // 4.5 6.5 8.5 10.5 - // 20.5 22.5 24.5 26.5 - // 36.5 38.5 40.5 42.5 - // 52.5 54.5 56.5 58.5 - - // Output for SAMPLESIZE = 4 is: - // 13.5 17.5 - // 45.5 49.5 -} - -int main() { - SamplingExample(); -} -``` - -## Race Conditions - -It might be tempting to create a `tile_static` variable named `total` and increment that variable for each thread, like this: - -```cpp -// Do not do this. -tile_static float total; -total += matrix[t_idx]; -t_idx.barrier.wait(); - -averages(t_idx.tile[0],t_idx.tile[1]) /= (float) (SAMPLESIZE* SAMPLESIZE); -``` - -The first problem with this approach is that `tile_static` variables cannot have initializers. The second problem is that there is a race condition on the assignment to `total`, because all of the threads in the tile have access to the variable in no particular order. You could program an algorithm to only allow one thread to access the total at each barrier, as shown next. However, this solution is not extensible. - -```cpp -// Do not do this. -tile_static float total; -if (t_idx.local[0] == 0&& t_idx.local[1] == 0) { - total = matrix[t_idx]; -} -t_idx.barrier.wait(); - -if (t_idx.local[0] == 0&& t_idx.local[1] == 1) { - total += matrix[t_idx]; -} -t_idx.barrier.wait(); - -// etc. -``` - -## Memory Fences - -There are two kinds of memory accesses that must be synchronized—global memory access and `tile_static` memory access. A `concurrency::array` object allocates only global memory. A `concurrency::array_view` can reference global memory, `tile_static` memory, or both, depending on how it was constructed. There are two kinds of memory that must be synchronized: - -- global memory - -- `tile_static` - -A *memory fence* ensures that memory accesses are available to other threads in the thread tile, and that memory accesses are executed according to program order. To ensure this, compilers and processors do not reorder reads and writes across the fence. In C++ AMP, a memory fence is created by a call to one of these methods: - -- [tile_barrier::wait Method](reference/tile-barrier-class.md#wait): Creates a fence around both global and `tile_static` memory. - -- [tile_barrier::wait_with_all_memory_fence Method](reference/tile-barrier-class.md#wait_with_all_memory_fence): Creates a fence around both global and `tile_static` memory. - -- [tile_barrier::wait_with_global_memory_fence Method](reference/tile-barrier-class.md#wait_with_global_memory_fence): Creates a fence around only global memory. - -- [tile_barrier::wait_with_tile_static_memory_fence Method](reference/tile-barrier-class.md#wait_with_tile_static_memory_fence): Creates a fence around only `tile_static` memory. - -Calling the specific fence that you require can improve the performance of your app. The barrier type affects how the compiler and the hardware reorder statements. For example, if you use a global memory fence, it applies only to global memory accesses and therefore, the compiler and the hardware might reorder reads and writes to `tile_static` variables on the two sides of the fence. - -In the next example, the barrier synchronizes the writes to `tileValues`, a `tile_static` variable. In this example, `tile_barrier::wait_with_tile_static_memory_fence` is called instead of `tile_barrier::wait`. - -```cpp -// Using a tile_static memory fence. -parallel_for_each(matrix.extent.tile(), - [=, &averages] (tiled_index t_idx) restrict(amp) -{ - // Copy the values of the tile into a tile-sized array. - tile_static float tileValues[SAMPLESIZE][SAMPLESIZE]; - tileValues[t_idx.local[0]][t_idx.local[1]] = matrix[t_idx]; - - // Wait for the tile-sized array to load before calculating the average. - t_idx.barrier.wait_with_tile_static_memory_fence(); - - // If you remove the if statement, then the calculation executes - // for every thread in the tile, and makes the same assignment to - // averages each time. - if (t_idx.local[0] == 0&& t_idx.local[1] == 0) { - for (int trow = 0; trow -[tile_static Keyword](../../cpp/tile-static-keyword.md) diff --git a/docs/parallel/amp/walkthrough-debugging-a-cpp-amp-application.md b/docs/parallel/amp/walkthrough-debugging-a-cpp-amp-application.md deleted file mode 100644 index d9c3ddfd4e3..00000000000 --- a/docs/parallel/amp/walkthrough-debugging-a-cpp-amp-application.md +++ /dev/null @@ -1,405 +0,0 @@ ---- -description: "Learn more about: Walkthrough: Debugging a C++ AMP application" -title: "Walkthrough: Debugging a C++ AMP application" -ms.date: 10/27/2021 -helpviewer_keywords: ["debugging, C++ Accelerated Massive Parallelism", "C++ AMP, debugging", "C++ Accelerated Massive Parallelism, debugging", "debugging, C++ AMP"] ---- -# Walkthrough: Debugging a C++ AMP application - -This article demonstrates how to debug an application that uses C++ Accelerated Massive Parallelism (C++ AMP) to take advantage of the graphics processing unit (GPU). It uses a parallel-reduction program that sums up a large array of integers. This walkthrough illustrates the following tasks: - -- Launching the GPU debugger. -- Inspecting GPU threads in the GPU Threads window. -- Using the **Parallel Stacks** window to simultaneously observe the call stacks of multiple GPU threads. -- Using the **Parallel Watch** window to inspect values of a single expression across multiple threads at the same time. -- Flagging, freezing, thawing, and grouping GPU threads. -- Executing all the threads of a tile to a specific location in code. - -## Prerequisites - -Before you start this walkthrough: - -> [!NOTE] -> C++ AMP headers are deprecated starting with Visual Studio 2022 version 17.0. -> Including any AMP headers will generate build errors. Define `_SILENCE_AMP_DEPRECATION_WARNINGS` before including any AMP headers to silence the warnings. - -- Read [C++ AMP Overview](../../parallel/amp/cpp-amp-overview.md). -- Make sure that line numbers are displayed in the text editor. For more information, see [How to: Display line numbers in the editor](/visualstudio/ide/reference/how-to-display-line-numbers-in-the-editor). -- Make sure you're running at least Windows 8 or Windows Server 2012 to support debugging on the software emulator. - -[!INCLUDE[note_settings_general](../../mfc/includes/note_settings_general_md.md)] - -### To create the sample project - -The instructions for creating a project vary depending on which version of Visual Studio you're using. Make sure you have the correct documentation version selected above the table of contents on this page. - -::: moniker range=">=msvc-160" - -### To create the sample project in Visual Studio - -1. On the menu bar, choose **File** > **New** > **Project** to open the **Create a New Project** dialog box. - -1. At the top of the dialog, set **Language** to **C++**, set **Platform** to **Windows**, and set **Project type** to **Console**. - -1. From the filtered list of project types, choose **Console App** then choose **Next**. In the next page, enter `AMPMapReduce` in the **Name** box to specify a name for the project, and specify the project location if you want a different one. - - ![Screenshot showing the Create a new project dialog with the Console App template selected.](../../build/media/mathclient-project-name-2019.png) - -1. Choose the **Create** button to create the client project. - -::: moniker-end - -::: moniker range="<=msvc-150" - -### To create the sample project in Visual Studio 2017 or Visual Studio 2015 - -1. Start Visual Studio. - -1. On the menu bar, choose **File** > **New** > **Project**. - -1. Under **Installed** in the templates pane, choose **Visual C++**. - -1. Choose **Win32 Console Application**, type `AMPMapReduce` in the **Name** box, and then choose the **OK** button. - -1. Choose the **Next** button. - -1. Clear the **Precompiled header** check box, and then choose the **Finish** button. - -1. In **Solution Explorer**, delete *stdafx.h*, *targetver.h*, and *stdafx.cpp* from the project. - -::: moniker-end - -Next: - -1. Open AMPMapReduce.cpp and replace its content with the following code. - - ```cpp - // AMPMapReduce.cpp defines the entry point for the program. - // The program performs a parallel-sum reduction that computes the sum of an array of integers. - - #include - #include - #include - - const int BLOCK_DIM = 32; - - using namespace concurrency; - - void sum_kernel_tiled(tiled_index t_idx, array &A, int stride_size) restrict(amp) - { - tile_static int localA[BLOCK_DIM]; - - index<1> globalIdx = t_idx.global * stride_size; - index<1> localIdx = t_idx.local; - - localA[localIdx[0]] = A[globalIdx]; - - t_idx.barrier.wait(); - - // Aggregate all elements in one tile into the first element. - for (int i = BLOCK_DIM / 2; i > 0; i /= 2) - { - if (localIdx[0] < i) - { - - localA[localIdx[0]] += localA[localIdx[0] + i]; - } - - t_idx.barrier.wait(); - } - - if (localIdx[0] == 0) - { - A[globalIdx] = localA[0]; - } - } - - int size_after_padding(int n) - { - // The extent might have to be slightly bigger than num_stride to - // be evenly divisible by BLOCK_DIM. You can do this by padding with zeros. - // The calculation to do this is BLOCK_DIM * ceil(n / BLOCK_DIM) - return ((n - 1) / BLOCK_DIM + 1) * BLOCK_DIM; - } - - int reduction_sum_gpu_kernel(array input) - { - int len = input.extent[0]; - - //Tree-based reduction control that uses the CPU. - for (int stride_size = 1; stride_size < len; stride_size *= BLOCK_DIM) - { - // Number of useful values in the array, given the current - // stride size. - int num_strides = len / stride_size; - - extent<1> e(size_after_padding(num_strides)); - - // The sum kernel that uses the GPU. - parallel_for_each(extent<1>(e).tile(), [&input, stride_size] (tiled_index idx) restrict(amp) - { - sum_kernel_tiled(idx, input, stride_size); - }); - } - - array_view output = input.section(extent<1>(1)); - return output[0]; - } - - int cpu_sum(const std::vector &arr) { - int sum = 0; - for (size_t i = 0; i < arr.size(); i++) { - sum += arr[i]; - } - return sum; - } - - std::vector rand_vector(unsigned int size) { - srand(2011); - - std::vector vec(size); - for (size_t i = 0; i < size; i++) { - vec[i] = rand(); - } - return vec; - } - - array vector_to_array(const std::vector &vec) { - array arr(vec.size()); - copy(vec.begin(), vec.end(), arr); - return arr; - } - - int _tmain(int argc, _TCHAR* argv[]) - { - std::vector vec = rand_vector(10000); - array arr = vector_to_array(vec); - - int expected = cpu_sum(vec); - int actual = reduction_sum_gpu_kernel(arr); - - bool passed = (expected == actual); - if (!passed) { - printf("Actual (GPU): %d, Expected (CPU): %d", actual, expected); - } - printf("sum: %s\n", passed ? "Passed!" : "Failed!"); - - getchar(); - - return 0; - } - ``` - -1. On the menu bar, choose **File** > **Save All**. - -1. In **Solution Explorer**, open the shortcut menu for **AMPMapReduce**, and then choose **Properties**. - -1. In the **Property Pages** dialog box, under **Configuration Properties**, choose **C/C++** > **Precompiled Headers**. - -1. For the **Precompiled Header** property, select **Not Using Precompiled Headers**, and then choose the **OK** button. - -1. On the menu bar, choose **Build** > **Build Solution**. - -## Debugging the CPU Code - -In this procedure, you'll use the Local Windows Debugger to make sure that the CPU code in this application is correct. The segment of the CPU code in this application that is especially interesting is the **`for`** loop in the `reduction_sum_gpu_kernel` function. It controls the tree-based parallel reduction that is run on the GPU. - -### To debug the CPU code - -1. In **Solution Explorer**, open the shortcut menu for **AMPMapReduce**, and then choose **Properties**. - -2. In the **Property Pages** dialog box, under **Configuration Properties**, choose **Debugging**. Verify that **Local Windows Debugger** is selected in the **Debugger to launch** list. - -3. Return to the **Code Editor**. - -4. Set breakpoints on the lines of code shown in the following illustration (approximately lines 67 line 70). - - ![CPU breakpoints marked next to lines of code in the editor.](../../parallel/amp/media/campcpubreakpoints.png "CPU breakpoints")
- CPU breakpoints - -5. On the menu bar, choose **Debug** > **Start Debugging**. - -6. In the **Locals** window, observe the value for `stride_size` until the breakpoint at line 70 is reached. - -7. On the menu bar, choose **Debug** > **Stop Debugging**. - -## Debugging the GPU Code - -This section shows how to debug the GPU code, which is the code contained in the `sum_kernel_tiled` function. The GPU code computes the sum of integers for each "block" in parallel. - -### To debug the GPU code - -1. In **Solution Explorer**, open the shortcut menu for **AMPMapReduce**, and then choose **Properties**. - -2. In the **Property Pages** dialog box, under **Configuration Properties**, choose **Debugging**. - -3. In the **Debugger to launch** list, select **Local Windows Debugger**. - -4. In the **Debugger Type** list, verify that **Auto** is selected. - - **Auto** is the default value. In versions before Windows 10, **GPU Only** is the required value instead of **Auto**. - -5. Choose the **OK** button. - -6. Set a breakpoint at line 30, as shown in the following illustration. - - ![GPU breakpoints marked next to a line of code in the editor.](../../parallel/amp/media/campgpubreakpoints.png "GPU breakpoints")
- GPU breakpoint - -7. On the menu bar, choose **Debug** > **Start Debugging**. The breakpoints in the CPU code at lines 67 and 70 don't get executed during GPU debugging because those lines of code run on the CPU. - -### To use the GPU Threads window - -1. To open the **GPU Threads** window, on the menu bar, choose **Debug** > **Windows** > **GPU Threads**. - - You can inspect the state the GPU threads in the **GPU Threads** window that appears. - -2. Dock the **GPU Threads** window at the bottom of Visual Studio. Choose the **Expand Thread Switch** button to display the tile and thread text boxes. The **GPU Threads** window shows the total number of active and blocked GPU threads, as shown in the following illustration. - - ![GPU Threads window with 4 active threads.](../../parallel/amp/media/campc.png "GPU Threads window with 4 active threads")
- GPU Threads window - - 313 tiles get allocated for this computation. Each tile contains 32 threads. Because local GPU debugging occurs on a software emulator, there are four active GPU threads. The four threads execute the instructions simultaneously and then move on together to the next instruction. - - In the **GPU Threads** window, there are four GPU threads active and 28 GPU threads blocked at the [tile_barrier::wait](reference/tile-barrier-class.md#wait) statement defined at about line 21 (`t_idx.barrier.wait();`). All 32 GPU threads belong to the first tile, `tile[0]`. An arrow points to the row that includes the current thread. To switch to a different thread, use one of the following methods: - - - In the row for the thread to switch to in the **GPU Threads** window, open the shortcut menu and choose **Switch To Thread**. If the row represents more than one thread, you'll switch to the first thread according to the thread coordinates. - - - Enter the tile and thread values of the thread in the corresponding text boxes and then choose the **Switch Thread** button. - - The **Call Stack** window displays the call stack of the current GPU thread. - -### To use the Parallel Stacks window - -1. To open the **Parallel Stacks** window, on the menu bar, choose **Debug** > **Windows** > **Parallel Stacks**. - - You can use the **Parallel Stacks** window to simultaneously inspect the stack frames of multiple GPU threads. - -2. Dock the **Parallel Stacks** window at the bottom of Visual Studio. - -3. Make sure that **Threads** is selected in the list in the upper-left corner. In the following illustration, the **Parallel Stacks** window shows a call-stack focused view of the GPU threads that you saw in the **GPU Threads** window. - - ![Parallel Stacks window with 4 active threads.](../../parallel/amp/media/campd.png "Parallel Stacks window with 4 active threads")
- Parallel Stacks window - - 32 threads went from `_kernel_stub` to the lambda statement in the `parallel_for_each` function call and then to the `sum_kernel_tiled` function, where the parallel reduction occurs. 28 out of the 32 threads have progressed to the [`tile_barrier::wait`](reference/tile-barrier-class.md#wait) statement and remain blocked at line 22, while the other four threads remain active in the `sum_kernel_tiled` function at line 30. - - You can inspect the properties of a GPU thread. They're available in the **GPU Threads** window in the rich DataTip of the **Parallel Stacks** window. To see them, hover the pointer on the stack frame of `sum_kernel_tiled`. The following illustration shows the DataTip. - - ![DataTip for Parallel Stacks window.](../../parallel/amp/media/campe.png "DataTip for Parallel Stacks window")
- GPU thread DataTip - - For more information about the **Parallel Stacks** window, see [Using the Parallel Stacks Window](/visualstudio/debugger/using-the-parallel-stacks-window). - -### To use the Parallel Watch window - -1. To open the **Parallel Watch** window, on the menu bar, choose **Debug** > **Windows** > **Parallel Watch** > **Parallel Watch 1**. - - You can use the **Parallel Watch** window to inspect the values of an expression across multiple threads. - -2. Dock the **Parallel Watch 1** window to the bottom of Visual Studio. There are 32 rows in the table of the **Parallel Watch** window. Each corresponds to a GPU thread that appeared in both the GPU Threads window and the **Parallel Stacks** window. Now, you can enter expressions whose values you want to inspect across all 32 GPU threads. - -3. Select the **Add Watch** column header, enter `localIdx`, and then choose the **Enter** key. - -4. Select the **Add Watch** column header again, type `globalIdx`, and then choose the **Enter** key. - -5. Select the **Add Watch** column header again, type `localA[localIdx[0]]`, and then choose the **Enter** key. - - You can sort by a specified expression by selecting its corresponding column header. - - Select the **localA[localIdx[0]]** column header to sort the column. The following illustration shows the results of sorting by **localA[localIdx[0]]**. - - ![Parallel Watch window with sorted results.](../../parallel/amp/media/campf.png "Parallel Watch window with sorted results")
- Results of sort - - You can export the content in the **Parallel Watch** window to Excel by choosing the **Excel** button and then choosing **Open in Excel**. If you have Excel installed on your development computer, the button opens an Excel worksheet that contains the content. - -6. In the upper-right corner of the **Parallel Watch** window, there's a filter control that you can use to filter the content by using Boolean expressions. Enter `localA[localIdx[0]] > 20000` in the filter control text box and then choose the **Enter** key. - - The window now contains only threads on which the `localA[localIdx[0]]` value is greater than 20000. The content is still sorted by the `localA[localIdx[0]]` column, which is the sorting action you chose earlier. - -## Flagging GPU Threads - -You can mark specific GPU threads by flagging them in the **GPU Threads** window, the **Parallel Watch** window, or the DataTip in the **Parallel Stacks** window. If a row in the GPU Threads window contains more than one thread, flagging that row flags all threads contained in the row. - -### To flag GPU threads - -1. Select the **[Thread]** column header in the **Parallel Watch 1** window to sort by tile index and thread index. - -2. On the menu bar, choose **Debug** > **Continue**, which causes the four threads that were active to progress to the next barrier (defined at line 32 of AMPMapReduce.cpp). - -3. Choose the flag symbol on the left side of the row that contains the four threads that are now active. - - The following illustration shows the four active flagged threads in the **GPU Threads** window. - - ![GPU Threads window with flagged threads.](../../parallel/amp/media/campg.png "GPU Threads window with flagged threads")
- Active threads in the GPU Threads window - - The **Parallel Watch** window and the DataTip of the **Parallel Stacks** window both indicate the flagged threads. - -4. If you want to focus on the four threads that you flagged, you can choose to show only the flagged threads. It limits what you see in the **GPU Threads**, **Parallel Watch**, and **Parallel Stacks** windows. - - Choose the **Show Flagged Only** button on any of the windows or on the **Debug Location** toolbar. The following illustration shows the **Show Flagged Only** button on the **Debug Location** toolbar. - - ![Debug Location toolbar with Show Only Flagged icon.](../../parallel/amp/media/camph.png "Debug Location toolbar with Show Only Flagged icon")
- **Show Flagged Only** button - - Now the **GPU Threads**, **Parallel Watch**, and **Parallel Stacks** windows display only the flagged threads. - -## Freezing and Thawing GPU Threads - -You can freeze (suspend) and thaw (resume) GPU threads from either the **GPU Threads** window or the **Parallel Watch** window. You can freeze and thaw CPU threads the same way; for information, see [How to: Use the Threads Window](/visualstudio/debugger/how-to-use-the-threads-window). - -### To freeze and thaw GPU threads - -1. Choose the **Show Flagged Only** button to display all the threads. - -2. On the menu bar, choose **Debug** > **Continue**. - -3. Open the shortcut menu for the active row and then choose **Freeze**. - - The following illustration of the **GPU Threads** window shows that all four threads are frozen. - - ![GPU Threads windows showing frozen threads.](../../parallel/amp/media/campk.png "GPU Threads windows showing frozen threads")
- Frozen threads in the **GPU Threads** window - - Similarly, the **Parallel Watch** window shows that all four threads are frozen. - -4. On the menu bar, choose **Debug** > **Continue** to allow the next four GPU threads to progress past the barrier at line 22 and to reach the breakpoint at line 30. The **GPU Threads** window shows that the four previously frozen threads remain frozen and in the active state. - -5. On the menu bar, choose **Debug**, **Continue**. - -6. From the **Parallel Watch** window, you can also thaw individual or multiple GPU threads. - -### To group GPU threads - -1. On the shortcut menu for one of the threads in the **GPU Threads** window, choose **Group By**, **Address**. - - The threads in the **GPU Threads** window are grouped by address. The address corresponds to the instruction in disassembly where each group of threads is located. 24 threads are at line 22 where the [tile_barrier::wait Method](reference/tile-barrier-class.md#wait) is executed. 12 threads are at the instruction for the barrier at line 32. Four of these threads are flagged. Eight threads are at the breakpoint at line 30. Four of these threads are frozen. The following illustration shows the grouped threads in the **GPU Threads** window. - - ![GPU Threads window with threads grouped by Address.](../../parallel/amp/media/campl.png "GPU Threads window with threads grouped by Address")
- Grouped threads in the **GPU Threads** window - -2. You can also do the **Group By** operation by opening the shortcut menu for the **Parallel Watch** window's data grid. Select **Group By**, and then choose the menu item that corresponds to how you want to group the threads. - -## Running All Threads to a Specific Location in Code - -You run all the threads in a given tile to the line that contains the cursor by using **Run Current Tile To Cursor**. - -### To run all threads to the location marked by the cursor - -1. On the shortcut menu for the frozen threads, choose **Thaw**. - -2. In the **Code Editor**, put the cursor in line 30. - -3. On the shortcut menu for the **Code Editor**, choose **Run Current Tile To Cursor**. - - The 24 threads that were previously blocked at the barrier at line 21 have progressed to line 32. It's shown in the **GPU Threads** window. - -## See also - -[C++ AMP overview](../../parallel/amp/cpp-amp-overview.md)\ -[Debugging GPU code](/visualstudio/debugger/debugging-gpu-code)\ -[How to: Use the GPU Threads window](/visualstudio/debugger/how-to-use-the-gpu-threads-window)\ -[How to: Use the Parallel Watch window](/visualstudio/debugger/how-to-use-the-parallel-watch-window)\ -[Analyzing C++ AMP code with the Concurrency Visualizer](/archive/blogs/nativeconcurrency/analyzing-c-amp-code-with-the-concurrency-visualizer) diff --git a/docs/parallel/amp/walkthrough-matrix-multiplication.md b/docs/parallel/amp/walkthrough-matrix-multiplication.md deleted file mode 100644 index b3dbcffba19..00000000000 --- a/docs/parallel/amp/walkthrough-matrix-multiplication.md +++ /dev/null @@ -1,322 +0,0 @@ ---- -description: "Learn more about: Walkthrough: Matrix Multiplication" -title: "Walkthrough: Matrix Multiplication" -ms.date: 10/27/2021 ---- -# Walkthrough: Matrix Multiplication - -This step-by-step walkthrough demonstrates how to use C++ AMP to accelerate the execution of matrix multiplication. Two algorithms are presented, one without tiling and one with tiling. - -## Prerequisites - -Before you start: - -- Read [C++ AMP Overview](../../parallel/amp/cpp-amp-overview.md). -- Read [Using Tiles](../../parallel/amp/using-tiles.md). -- Make sure that you are running at least Windows 7, or Windows Server 2008 R2. - -> [!NOTE] -> C++ AMP headers are deprecated starting with Visual Studio 2022 version 17.0. -> Including any AMP headers will generate build errors. Define `_SILENCE_AMP_DEPRECATION_WARNINGS` before including any AMP headers to silence the warnings. - -### To create the project - -Instructions for creating a new project vary depending on which version of Visual Studio you have installed. To see the documentation for your preferred version of Visual Studio, use the **Version** selector control. It's found at the top of the table of contents on this page. - -::: moniker range=">=msvc-160" - -### To create the project in Visual Studio - -1. On the menu bar, choose **File** > **New** > **Project** to open the **Create a New Project** dialog box. - -1. At the top of the dialog, set **Language** to **C++**, set **Platform** to **Windows**, and set **Project type** to **Console**. - -1. From the filtered list of project types, choose **Empty Project** then choose **Next**. In the next page, enter *MatrixMultiply* in the **Name** box to specify a name for the project, and specify the project location if desired. - - ![Screenshot showing the Create a new project dialog with the Console App template selected.](../../build/media/mathclient-project-name-2019.png) - -1. Choose the **Create** button to create the client project. - -1. In **Solution Explorer**, open the shortcut menu for **Source Files**, and then choose **Add** > **New Item**. - -1. In the **Add New Item** dialog box, select **C++ File (.cpp)**, enter *MatrixMultiply.cpp* in the **Name** box, and then choose the **Add** button. - -::: moniker-end - -::: moniker range="<=msvc-150" - -### To create a project in Visual Studio 2017 or 2015 - -1. On the menu bar in Visual Studio, choose **File** > **New** > **Project**. - -1. Under **Installed** in the templates pane, select **Visual C++**. - -1. Select **Empty Project**, enter *MatrixMultiply* in the **Name** box, and then choose the **OK** button. - -1. Choose the **Next** button. - -1. In **Solution Explorer**, open the shortcut menu for **Source Files**, and then choose **Add** > **New Item**. - -1. In the **Add New Item** dialog box, select **C++ File (.cpp)**, enter *MatrixMultiply.cpp* in the **Name** box, and then choose the **Add** button. - -::: moniker-end - -## Multiplication without tiling - -In this section, consider the multiplication of two matrices, A and B, which are defined as follows: - -![Diagram showing 3 by 2 matrix A.](../../parallel/amp/media/campmatrixanontiled.png) - -![Diagram showing 2 by 3 matrix B.](../../parallel/amp/media/campmatrixbnontiled.png) - -A is a 3-by-2 matrix and B is a 2-by-3 matrix. The product of multiplying A by B is the following 3-by-3 matrix. The product is calculated by multiplying the rows of A by the columns of B element by element. - -![Diagram showing the result 3 by 3 product matrix.](../../parallel/amp/media/campmatrixproductnontiled.png) - -### To multiply without using C++ AMP - -1. Open MatrixMultiply.cpp and use the following code to replace the existing code. - - ```cpp - #include - - void MultiplyWithOutAMP() { - int aMatrix[3][2] = {{1, 4}, {2, 5}, {3, 6}}; - int bMatrix[2][3] = {{7, 8, 9}, {10, 11, 12}}; - int product[3][3] = {{0, 0, 0}, {0, 0, 0}, {0, 0, 0}}; - - for (int row = 0; row < 3; row++) { - for (int col = 0; col < 3; col++) { - // Multiply the row of A by the column of B to get the row, column of product. - for (int inner = 0; inner < 2; inner++) { - product[row][col] += aMatrix[row][inner] * bMatrix[inner][col]; - } - std::cout << product[row][col] << " "; - } - std::cout << "\n"; - } - } - - int main() { - MultiplyWithOutAMP(); - getchar(); - } - ``` - - The algorithm is a straightforward implementation of the definition of matrix multiplication. It does not use any parallel or threaded algorithms to reduce the computation time. - -1. On the menu bar, choose **File** > **Save All**. - -1. Choose the **F5** keyboard shortcut to start debugging and verify that the output is correct. - -1. Choose **Enter** to exit the application. - -### To multiply by using C++ AMP - -1. In MatrixMultiply.cpp, add the following code before the `main` method. - - ```cpp - void MultiplyWithAMP() { - int aMatrix[] = { 1, 4, 2, 5, 3, 6 }; - int bMatrix[] = { 7, 8, 9, 10, 11, 12 }; - int productMatrix[] = { 0, 0, 0, 0, 0, 0, 0, 0, 0 }; - - array_view a(3, 2, aMatrix); - - array_view b(2, 3, bMatrix); - - array_view product(3, 3, productMatrix); - - parallel_for_each(product.extent, - [=] (index<2> idx) restrict(amp) { - int row = idx[0]; - int col = idx[1]; - for (int inner = 0; inner <2; inner++) { - product[idx] += a(row, inner)* b(inner, col); - } - }); - - product.synchronize(); - - for (int row = 0; row <3; row++) { - for (int col = 0; col <3; col++) { - //std::cout << productMatrix[row*3 + col] << " "; - std::cout << product(row, col) << " "; - } - std::cout << "\n"; - } - } - ``` - - The AMP code resembles the non-AMP code. The call to `parallel_for_each` starts one thread for each element in `product.extent`, and replaces the **`for`** loops for row and column. The value of the cell at the row and column is available in `idx`. You can access the elements of an `array_view` object by using either the `[]` operator and an index variable, or the `()` operator and the row and column variables. The example demonstrates both methods. The `array_view::synchronize` method copies the values of the `product` variable back to the `productMatrix` variable. - -1. Add the following `include` and **`using`** statements at the top of MatrixMultiply.cpp. - - ```cpp - #include - using namespace concurrency; - ``` - -1. Modify the `main` method to call the `MultiplyWithAMP` method. - - ```cpp - int main() { - MultiplyWithOutAMP(); - MultiplyWithAMP(); - getchar(); - } - ``` - -1. Press the **Ctrl**+**F5** keyboard shortcut to start debugging and verify that the output is correct. - -1. Press the **Spacebar** to exit the application. - -## Multiplication with tiling - -Tiling is a technique in which you partition data into equal-sized subsets, which are known as tiles. Three things change when you use tiling. - -- You can create `tile_static` variables. Access to data in `tile_static` space can be many times faster than access to data in the global space. An instance of a `tile_static` variable is created for each tile, and all threads in the tile have access to the variable. The primary benefit of tiling is the performance gain due to `tile_static` access. - -- You can call the [tile_barrier::wait](reference/tile-barrier-class.md#wait) method to stop all of the threads in one tile at a specified line of code. You cannot guarantee the order that the threads will run in, only that all of the threads in one tile will stop at the call to `tile_barrier::wait` before they continue execution. - -- You have access to the index of the thread relative to the entire `array_view` object and the index relative to the tile. By using the local index, you can make your code easier to read and debug. - -To take advantage of tiling in matrix multiplication, the algorithm must partition the matrix into tiles and then copy the tile data into `tile_static` variables for faster access. In this example, the matrix is partitioned into submatrices of equal size. The product is found by multiplying the submatrices. The two matrices and their product in this example are: - -![Diagram showing 4 by 4 matrix A.](../../parallel/amp/media/campmatrixatiled.png) - -![Diagram showing 4 by 4 matrix B.](../../parallel/amp/media/campmatrixbtiled.png) - -![Diagram showing result 4 by 4 product matrix.](../../parallel/amp/media/campmatrixproducttiled.png) - -The matrices are partitioned into four 2x2 matrices, which are defined as follows: - -![Diagram showing 4 by 4 matrix A partitioned into 2 by 2 sub matrices.](../../parallel/amp/media/campmatrixapartitioned.png) - -![Diagram showing 4 by 4 matrix B partitioned into 2 by 2 sub matrices.](../../parallel/amp/media/campmatrixbpartitioned.png) - -The product of A and B can now be written and calculated as follows: - -![Diagram showing 4 by 4 matrix A B partitioned into 2 by 2 sub matrices.](../../parallel/amp/media/campmatrixproductpartitioned.png) - -Because matrices `a` through `h` are 2x2 matrices, all of the products and sums of them are also 2x2 matrices. It also follows that the product of A and B is a 4x4 matrix, as expected. To quickly check the algorithm, calculate the value of the element in the first row, first column in the product. In the example, that would be the value of the element in the first row and first column of `ae + bg`. You only have to calculate the first column, first row of `ae` and `bg` for each term. That value for `ae` is `(1 * 1) + (2 * 5) = 11`. The value for `bg` is `(3 * 1) + (4 * 5) = 23`. The final value is `11 + 23 = 34`, which is correct. - -To implement this algorithm, the code: - -- Uses a `tiled_extent` object instead of an `extent` object in the `parallel_for_each` call. - -- Uses a `tiled_index` object instead of an `index` object in the `parallel_for_each` call. - -- Creates `tile_static` variables to hold the submatrices. - -- Uses the `tile_barrier::wait` method to stop the threads for the calculation of the products of the submatrices. - -### To multiply by using AMP and tiling - -1. In MatrixMultiply.cpp, add the following code before the `main` method. - - ```cpp - void MultiplyWithTiling() { - // The tile size is 2. - static const int TS = 2; - - // The raw data. - int aMatrix[] = { 1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8 }; - int bMatrix[] = { 1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8 }; - int productMatrix[] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }; - - // Create the array_view objects. - array_view a(4, 4, aMatrix); - array_view b(4, 4, bMatrix); - array_view product(4, 4, productMatrix); - - // Call parallel_for_each by using 2x2 tiles. - parallel_for_each(product.extent.tile(), - [=] (tiled_index t_idx) restrict(amp) - { - // Get the location of the thread relative to the tile (row, col) - // and the entire array_view (rowGlobal, colGlobal). - int row = t_idx.local[0]; - int col = t_idx.local[1]; - int rowGlobal = t_idx.global[0]; - int colGlobal = t_idx.global[1]; - int sum = 0; - - // Given a 4x4 matrix and a 2x2 tile size, this loop executes twice for each thread. - // For the first tile and the first loop, it copies a into locA and e into locB. - // For the first tile and the second loop, it copies b into locA and g into locB. - for (int i = 0; i < 4; i += TS) { - tile_static int locA[TS][TS]; - tile_static int locB[TS][TS]; - locA[row][col] = a(rowGlobal, col + i); - locB[row][col] = b(row + i, colGlobal); - // The threads in the tile all wait here until locA and locB are filled. - t_idx.barrier.wait(); - - // Return the product for the thread. The sum is retained across - // both iterations of the loop, in effect adding the two products - // together, for example, a*e. - for (int k = 0; k < TS; k++) { - sum += locA[row][k] * locB[k][col]; - } - - // All threads must wait until the sums are calculated. If any threads - // moved ahead, the values in locA and locB would change. - t_idx.barrier.wait(); - // Now go on to the next iteration of the loop. - } - - // After both iterations of the loop, copy the sum to the product variable by using the global location. - product[t_idx.global] = sum; - }); - - // Copy the contents of product back to the productMatrix variable. - product.synchronize(); - - for (int row = 0; row <4; row++) { - for (int col = 0; col <4; col++) { - // The results are available from both the product and productMatrix variables. - //std::cout << productMatrix[row*3 + col] << " "; - std::cout << product(row, col) << " "; - } - std::cout << "\n"; - } - } - ``` - - This example is significantly different than the example without tiling. The code uses these conceptual steps: - 1. Copy the elements of tile[0,0] of `a` into `locA`. Copy the elements of tile[0,0] of `b` into `locB`. Notice that `product` is tiled, not `a` and `b`. Therefore, you use global indices to access `a, b`, and `product`. The call to `tile_barrier::wait` is essential. It stops all of the threads in the tile until both `locA` and `locB` are filled. - - 1. Multiply `locA` and `locB` and put the results in `product`. - - 1. Copy the elements of tile[0,1] of `a` into `locA`. Copy the elements of tile [1,0] of `b` into `locB`. - - 1. Multiply `locA` and `locB` and add them to the results that are already in `product`. - - 1. The multiplication of tile[0,0] is complete. - - 1. Repeat for the other four tiles. There is no indexing specifically for the tiles and the threads can execute in any order. As each thread executes, the `tile_static` variables are created for each tile appropriately and the call to `tile_barrier::wait` controls the program flow. - - 1. As you examine the algorithm closely, notice that each submatrix is loaded into a `tile_static` memory twice. That data transfer does take time. However, once the data is in `tile_static` memory, access to the data is much faster. Because calculating the products requires repeated access to the values in the submatrices, there is an overall performance gain. For each algorithm, experimentation is required to find the optimal algorithm and tile size. - - In the non-AMP and non-tile examples, each element of A and B is accessed four times from the global memory to calculate the product. In the tile example, each element is accessed twice from the global memory and four times from the `tile_static` memory. That is not a significant performance gain. However, if the A and B were 1024x1024 matrices and the tile size were 16, there would be a significant performance gain. In that case, each element would be copied into `tile_static` memory only 16 times and accessed from `tile_static` memory 1024 times. - -1. Modify the main method to call the `MultiplyWithTiling` method, as shown. - - ```cpp - int main() { - MultiplyWithOutAMP(); - MultiplyWithAMP(); - MultiplyWithTiling(); - getchar(); - } - ``` - -1. Press the **Ctrl**+**F5** keyboard shortcut to start debugging and verify that the output is correct. - -1. Press the **Space** bar to exit the application. - -## See also - -[C++ AMP (C++ Accelerated Massive Parallelism)](../../parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md)
-[Walkthrough: Debugging a C++ AMP Application](../../parallel/amp/walkthrough-debugging-a-cpp-amp-application.md) diff --git a/docs/parallel/concrt/cancellation-in-the-ppl.md b/docs/parallel/concrt/cancellation-in-the-ppl.md index 3d97190376d..66e4150037a 100644 --- a/docs/parallel/concrt/cancellation-in-the-ppl.md +++ b/docs/parallel/concrt/cancellation-in-the-ppl.md @@ -215,7 +215,7 @@ This example produces the following output. Caught 50 ``` -The following example uses a Boolean flag to coordinate cancellation in a `parallel_for` loop. Every task runs because this example does not use the `cancel` method or exception handling to cancel the overall set of tasks. Therefore, this technique can have more computational overhead than a cancelation mechanism. +The following example uses a Boolean flag to coordinate cancellation in a `parallel_for` loop. Every task runs because this example does not use the `cancel` method or exception handling to cancel the overall set of tasks. Therefore, this technique can have more computational overhead than a cancellation mechanism. [!code-cpp[concrt-task-tree#8](../../parallel/concrt/codesnippet/cpp/cancellation-in-the-ppl_14.cpp)] diff --git a/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_12.cpp b/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_12.cpp index 54a60e82783..93413d211ca 100644 --- a/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_12.cpp +++ b/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_12.cpp @@ -1,4 +1,4 @@ - // To enable cancelation, call parallel_for in a task group. + // To enable cancellation, call parallel_for in a task group. structured_task_group tg; task_group_status status = tg.run_and_wait([&] { diff --git a/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_14.cpp b/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_14.cpp index 501bef3171f..20dc01ea24a 100644 --- a/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_14.cpp +++ b/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_14.cpp @@ -1,4 +1,4 @@ - // Create a Boolean flag to coordinate cancelation. + // Create a Boolean flag to coordinate cancellation. bool canceled = false; parallel_for(0, 100, [&](int i) { diff --git a/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_6.cpp b/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_6.cpp index a2fd7307692..64bd96b60aa 100644 --- a/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_6.cpp +++ b/docs/parallel/concrt/codesnippet/CPP/cancellation-in-the-ppl_6.cpp @@ -23,7 +23,7 @@ for (int i = 0; i < 1000; ++i) { // To reduce overhead, occasionally check for - // cancelation. + // cancellation. if ((i%100) == 0) { if (tg2.is_canceling()) diff --git a/docs/parallel/concrt/codesnippet/CPP/how-to-create-a-task-that-completes-after-a-delay_1.cpp b/docs/parallel/concrt/codesnippet/CPP/how-to-create-a-task-that-completes-after-a-delay_1.cpp index 19ec97fbf8d..07d9a402d18 100644 --- a/docs/parallel/concrt/codesnippet/CPP/how-to-create-a-task-that-completes-after-a-delay_1.cpp +++ b/docs/parallel/concrt/codesnippet/CPP/how-to-create-a-task-that-completes-after-a-delay_1.cpp @@ -28,7 +28,7 @@ task complete_after(unsigned int timeout) }); } -// Cancels the provided task after the specifed delay, if the task +// Cancels the provided task after the specified delay, if the task // did not complete. template task cancel_after_timeout(task t, cancellation_token_source cts, unsigned int timeout) diff --git a/docs/parallel/concrt/codesnippet/CPP/how-to-create-a-task-that-completes-after-a-delay_3.cpp b/docs/parallel/concrt/codesnippet/CPP/how-to-create-a-task-that-completes-after-a-delay_3.cpp index 05fa30ae3d4..efdf43e9507 100644 --- a/docs/parallel/concrt/codesnippet/CPP/how-to-create-a-task-that-completes-after-a-delay_3.cpp +++ b/docs/parallel/concrt/codesnippet/CPP/how-to-create-a-task-that-completes-after-a-delay_3.cpp @@ -38,7 +38,7 @@ task complete_after(unsigned int timeout) }); } -// Cancels the provided task after the specifed delay, if the task +// Cancels the provided task after the specified delay, if the task // did not complete. template task cancel_after_timeout(task t, cancellation_token_source cts, unsigned int timeout) diff --git a/docs/parallel/concrt/reference/concurrency-namespace-constants1.md b/docs/parallel/concrt/reference/concurrency-namespace-constants1.md index 2cad1ace3d7..38f2288982e 100644 --- a/docs/parallel/concrt/reference/concurrency-namespace-constants1.md +++ b/docs/parallel/concrt/reference/concurrency-namespace-constants1.md @@ -1,38 +1,12 @@ --- -description: "Learn more about: concurrency namespace constants" title: "concurrency namespace constants" -ms.date: "11/04/2016" +description: "Learn more about: concurrency namespace constants" +ms.date: 11/04/2016 f1_keywords: ["concrt/concurrency::AgentEventGuid", "concrt/concurrency::COOPERATIVE_TIMEOUT_INFINITE", "concrt/concurrency::COOPERATIVE_WAIT_TIMEOUT", "concrt/concurrency::ConcRTEventGuid", "concrt/concurrency::ConcRT_ProviderGuid", "concrt/concurrency::INHERIT_THREAD_PRIORITY", "concrt/concurrency::LockEventGuid", "concrt/concurrency::PPLParallelForEventGuid", "concrt/concurrency::PPLParallelForeachEventGuid", "concrt/concurrency::ResourceManagerEventGuid", "concrt/concurrency::ScheduleGroupEventGuid", "concrt/concurrency::VirtualProcessorEventGuid"] -ms.assetid: 6f81fc4c-b10c-479e-8717-9c292360d5a0 --- # concurrency namespace constants -:::row::: - :::column span=""::: - [`AgentEventGuid`](#agenteventguid)\ - [`CONCRT_RM_VERSION_1`](#concrt_rm_version_1)\ - [`COOPERATIVE_TIMEOUT_INFINITE`](#cooperative_timeout_infinite)\ - [`COOPERATIVE_WAIT_TIMEOUT`](#cooperative_wait_timeout)\ - [`ChoreEventGuid`](#choreeventguid)\ - [`ConcRTEventGuid`](#concrteventguid) - :::column-end::: - :::column span=""::: - [`ConcRT_ProviderGuid`](#concrt_providerguid)\ - [`ContextEventGuid`](#contexteventguid)\ - [`INHERIT_THREAD_PRIORITY`](#inherit_thread_priority)\ - [`LockEventGuid`](#lockeventguid)\ - [`MaxExecutionResources`](#maxexecutionresources)\ - [`PPLParallelForEventGuid`](#pplparallelforeventguid) - :::column-end::: - :::column span=""::: - [`PPLParallelForeachEventGuid`](#pplparallelforeacheventguid)\ - [`PPLParallelInvokeEventGuid`](#pplparallelinvokeeventguid)\ - [`ResourceManagerEventGuid`](#resourcemanagereventguid)\ - [`ScheduleGroupEventGuid`](#schedulegroupeventguid)\ - [`SchedulerEventGuid`](#schedulereventguid)\ - [`VirtualProcessorEventGuid`](#virtualprocessoreventguid) - :::column-end::: -:::row-end::: +The following constants are defined in the `concurrency` namespace: ## AgentEventGuid diff --git a/docs/parallel/concrt/reference/concurrency-namespace-enums.md b/docs/parallel/concrt/reference/concurrency-namespace-enums.md index 6d6ed28540c..c3502ea9299 100644 --- a/docs/parallel/concrt/reference/concurrency-namespace-enums.md +++ b/docs/parallel/concrt/reference/concurrency-namespace-enums.md @@ -1,34 +1,12 @@ --- -description: "Learn more about: concurrency namespace enums" title: "concurrency namespace enums" -ms.date: "11/04/2016" +description: "Learn more about: concurrency namespace enums" +ms.date: 11/04/2016 f1_keywords: ["CONCRT/concurrency::Agents_EventType", "CONCRT/concurrency::Concrt_TraceFlags", "CONCRT/concurrency::CriticalRegionType", "CONCRT/concurrency::PolicyElementKey", "CONCRT/concurrency::SchedulerType", "CONCRT/concurrency::SwitchingProxyState", "CONCRT/concurrency::WinRTInitializationType", "CONCRT/concurrency::join_type", "CONCRT/concurrency::message_status Enumeration"] -ms.assetid: a40e3b2d-ad21-4229-9880-2cfa84f7ab8f --- # concurrency namespace enums -:::row::: - :::column span=""::: - [`agent_status`](#agent_status)\ - [`Agents_EventType`](#agents_eventtype)\ - [`ConcRT_EventType`](#concrt_eventtype)\ - [`Concrt_TraceFlags`](#concrt_traceflags)\ - [`CriticalRegionType`](#criticalregiontype) - :::column-end::: - :::column span=""::: - [`DynamicProgressFeedbackType`](#dynamicprogressfeedbacktype)\ - [`join_type`](#join_type)\ - [`message_status`](#message_status)\ - [`PolicyElementKey`](#policyelementkey)\ - [`SchedulerType`](#schedulertype) - :::column-end::: - :::column span=""::: - [`SchedulingProtocolType`](#schedulingprotocoltype)\ - [`SwitchingProxyState`](#switchingproxystate)\ - [`task_group_status`](#task_group_status)\ - [`WinRTInitializationType`](#winrtinitializationtype) - :::column-end::: -:::row-end::: +The following enumerations are available in the `concurrency` namespace: ## agent_status Enumeration diff --git a/docs/parallel/concrt/reference/concurrency-namespace-functions.md b/docs/parallel/concrt/reference/concurrency-namespace-functions.md index 76ea97d01de..03771f4a1aa 100644 --- a/docs/parallel/concrt/reference/concurrency-namespace-functions.md +++ b/docs/parallel/concrt/reference/concurrency-namespace-functions.md @@ -6,58 +6,7 @@ f1_keywords: ["concrt/concurrency::Alloc", "concrt/concurrency::DisableTracing", --- # concurrency namespace functions -:::row::: - :::column span=""::: - [`Alloc`](#alloc)\ - [`asend`](#asend)\ - [`cancel_current_task`](#cancel_current_task)\ - [`clear`](#clear)\ - [`create_async`](#create_async)\ - [`create_task`](#create_task)\ - [`CreateResourceManager`](#createresourcemanager)\ - [`DisableTracing`](#disabletracing)\ - [`EnableTracing`](#enabletracing)\ - [`Free`](#free)\ - [`get_ambient_scheduler`](#get_ambient_scheduler)\ - [`GetExecutionContextId`](#getexecutioncontextid)\ - [`GetOSVersion`](#getosversion)\ - [`GetProcessorCount`](#getprocessorcount)\ - [`GetProcessorNodeCount`](#getprocessornodecount) - :::column-end::: - :::column span=""::: - [`GetSchedulerId`](#getschedulerid)\ - [`internal_assign_iterators`](#internal_assign_iterators)\ - [`interruption_point`](#interruption_point)\ - [`is_current_task_group_canceling`](#is_current_task_group_canceling)\ - [`make_choice`](#make_choice)\ - [`make_greedy_join`](#make_greedy_join)\ - [`make_join`](#make_join)\ - [`make_task`](#make_task)\ - [`parallel_buffered_sort`](#parallel_buffered_sort)\ - [`parallel_for_each`](#parallel_for_each)\ - [`parallel_for`](#parallel_for)\ - [`parallel_invoke`](#parallel_invoke)\ - [`parallel_radixsort`](#parallel_radixsort)\ - [`parallel_reduce`](#parallel_reduce)\ - [`parallel_sort`](#parallel_sort) - :::column-end::: - :::column span=""::: - [`parallel_transform`](#parallel_transform)\ - [`receive`](#receive)\ - [`run_with_cancellation_token`](#run_with_cancellation_token)\ - [`send`](#send)\ - [`set_ambient_scheduler`](#set_ambient_scheduler)\ - [`set_task_execution_resources`](#set_task_execution_resources)\ - [`swap`](#swap)\ - [`task_from_exception`](#task_from_exception)\ - [`task_from_result`](#task_from_result)\ - [`Trace_agents_register_name`](#trace_agents_register_name)\ - [`try_receive`](#try_receive)\ - [`wait`](#wait)\ - [`when_all`](#when_all)\ - [`when_any`](#when_any) - :::column-end::: -:::row-end::: +The following functions are available in the `concurrency` namespace: ## Alloc diff --git a/docs/parallel/concrt/reference/concurrency-namespace-operators.md b/docs/parallel/concrt/reference/concurrency-namespace-operators.md index d3deea034e0..cb9e6005079 100644 --- a/docs/parallel/concrt/reference/concurrency-namespace-operators.md +++ b/docs/parallel/concrt/reference/concurrency-namespace-operators.md @@ -1,30 +1,12 @@ --- -description: "Learn more about: concurrency namespace Operators" title: "concurrency namespace Operators" -ms.date: "11/04/2016" +description: "Learn more about: concurrency namespace Operators" +ms.date: 11/04/2016 f1_keywords: ["concrt/concurrency::operator!=", "concrt/concurrency::operator&&"] -ms.assetid: 8e373f23-fc8e-49f7-82e6-ba0c57b822f8 --- # concurrency namespace Operators -:::row::: - :::column span=""::: - [`operator||`](#operator_lor)\ - [`operator&&`](#operator_amp_amp) - :::column-end::: - :::column span=""::: - [`operator==`](#operator_eq_eq)\ - [`operator!=`](#operator_neq) - :::column-end::: - :::column span=""::: - [`operator<`](#operator_lt)\ - [`operator<=`](#operator_lt_eq) - :::column-end::: - :::column span=""::: - [`operator>`](#operator_gt)\ - [`operator>=`](#operator_gt_eq) - :::column-end::: -:::row-end::: +The following operators are available in the `concurrency` namespace: ## `operator||` Operator diff --git a/docs/parallel/concrt/task-parallelism-concurrency-runtime.md b/docs/parallel/concrt/task-parallelism-concurrency-runtime.md index 23e2ad45736..d6ab7f02cc6 100644 --- a/docs/parallel/concrt/task-parallelism-concurrency-runtime.md +++ b/docs/parallel/concrt/task-parallelism-concurrency-runtime.md @@ -257,7 +257,7 @@ The runtime also provides an exception-handling model that enables you to throw Although we recommend that you use `task_group` or `parallel_invoke` instead of the `structured_task_group` class, there are cases where you want to use `structured_task_group`, for example, when you write a parallel algorithm that performs a variable number of tasks or requires support for cancellation. This section explains the differences between the `task_group` and `structured_task_group` classes. -The `task_group` class is thread-safe. Therefore you can add tasks to a `task_group` object from multiple threads and wait on or cancel a `task_group` object from multiple threads. The construction and destruction of a `structured_task_group` object must occur in the same lexical scope. In addition, all operations on a `structured_task_group` object must occur on the same thread. The exception to this rule is the [concurrency::structured_task_group::cancel](reference/structured-task-group-class.md#cancel) and [concurrency::structured_task_group::is_canceling](reference/structured-task-group-class.md#is_canceling) methods. A child task can call these methods to cancel the parent task group or check for cancelation at any time. +The `task_group` class is thread-safe. Therefore you can add tasks to a `task_group` object from multiple threads and wait on or cancel a `task_group` object from multiple threads. The construction and destruction of a `structured_task_group` object must occur in the same lexical scope. In addition, all operations on a `structured_task_group` object must occur on the same thread. The exception to this rule is the [concurrency::structured_task_group::cancel](reference/structured-task-group-class.md#cancel) and [concurrency::structured_task_group::is_canceling](reference/structured-task-group-class.md#is_canceling) methods. A child task can call these methods to cancel the parent task group or check for cancellation at any time. You can run additional tasks on a `task_group` object after you call the [concurrency::task_group::wait](reference/task-group-class.md#wait) or [concurrency::task_group::run_and_wait](reference/task-group-class.md#run_and_wait) method. Conversely, if you run additional tasks on a `structured_task_group` object after you call the [concurrency::structured_task_group::wait](reference/structured-task-group-class.md#wait) or [concurrency::structured_task_group::run_and_wait](reference/structured-task-group-class.md#run_and_wait) methods, then the behavior is undefined. diff --git a/docs/parallel/multithreading-with-cpp-and-mfc.md b/docs/parallel/multithreading-with-cpp-and-mfc.md index 7fc4d93386e..286a5155131 100644 --- a/docs/parallel/multithreading-with-cpp-and-mfc.md +++ b/docs/parallel/multithreading-with-cpp-and-mfc.md @@ -3,11 +3,13 @@ description: "Learn more about: Multithreading with C++ and MFC" title: "Multithreading with C++ and MFC" ms.date: "08/27/2018" helpviewer_keywords: ["MFC [C++], multithreading", "threading [C++], MFC", "worker threads [C++]", "synchronization classes [C++]", "synchronization [C++], multithreading", "threading [MFC], about threading", "CWinThread class, purpose of", "multithreading [C++], MFC", "threading [MFC]", "user interface threads [C++]"] -ms.assetid: 979605f8-3988-44b5-ac9c-b8cce7fcce14 ms.topic: concept-article --- # Multithreading with C++ and MFC +>[!NOTE] +> The Microsoft Foundation Classes (MFC) library continues to be supported. However, we're no longer adding features or updating the documentation. + The Microsoft Foundation Class (MFC) library provides support for multithreaded applications. This topic describes processes and threads and the MFC approach to multithreading. A process is an executing instance of an application. For example, when you double-click the Notepad icon, you start a process that runs Notepad. diff --git a/docs/parallel/parallel-programming-in-visual-cpp.md b/docs/parallel/parallel-programming-in-visual-cpp.md index 9a0a35d7c76..2aec9538eb0 100644 --- a/docs/parallel/parallel-programming-in-visual-cpp.md +++ b/docs/parallel/parallel-programming-in-visual-cpp.md @@ -1,8 +1,7 @@ --- description: "Learn more about: Parallel Programming in Visual C++" title: "Parallel Programming in Visual C++" -ms.date: "11/04/2016" -ms.assetid: f5c28ab6-a1d9-492f-b207-05e8aee73e96 +ms.date: 03/24/2026 ms.topic: "overview" ms.custom: intro-overview --- @@ -12,11 +11,23 @@ Visual C++ provides the following technologies to help you create multi-threaded ## Related Articles +::: moniker range="<=msvc-160" |Title|Description| |-----------|-----------------| |[Auto-Parallelization and Auto-Vectorization](auto-parallelization-and-auto-vectorization.md)|Compiler optimizations that speed up code.| |[Concurrency Runtime](concrt/concurrency-runtime.md)|Classes that simplify the writing of programs that use data parallelism or task parallelism.| -|[C++ AMP (C++ Accelerated Massive Parallelism)](amp/cpp-amp-cpp-accelerated-massive-parallelism.md)|Classes that enable the use of modern graphics processors for general purpose programming.| |[Multithreading Support for Older Code (Visual C++)](multithreading-support-for-older-code-visual-cpp.md)|Older technologies that may be useful in older applications. For new apps, use the Concurrency Runtime or C++ AMP.| |[OpenMP](openmp/openmp-in-visual-cpp.md)|The Microsoft implementation of the OpenMP API.| |[C++ in Visual Studio](../overview/visual-cpp-in-visual-studio.md)|This section of the documentation contains information about most of the features of Visual C++.| +|[C++ AMP (C++ Accelerated Massive Parallelism)](amp/cpp-amp-cpp-accelerated-massive-parallelism.md)|Classes that enable the use of modern graphics processors for general purpose programming.| +:::moniker-end +::: moniker range=">msvc-160" +|Title|Description| +|-----------|-----------------| +|[Auto-Parallelization and Auto-Vectorization](auto-parallelization-and-auto-vectorization.md)|Compiler optimizations that speed up code.| +|[Concurrency Runtime](concrt/concurrency-runtime.md)|Classes that simplify the writing of programs that use data parallelism or task parallelism.| +|[Multithreading Support for Older Code (Visual C++)](multithreading-support-for-older-code-visual-cpp.md)|Older technologies that may be useful in older applications. For new apps, use the Concurrency Runtime.| +|[OpenMP](openmp/openmp-in-visual-cpp.md)|The Microsoft implementation of the OpenMP API.| +|[C++ in Visual Studio](../overview/visual-cpp-in-visual-studio.md)|This section of the documentation contains information about most of the features of Visual C++.| +:::moniker-end + diff --git a/docs/parallel/toc.yml b/docs/parallel/toc.yml index d8a0ae92833..0543f1e5c49 100644 --- a/docs/parallel/toc.yml +++ b/docs/parallel/toc.yml @@ -1,659 +1,495 @@ -items: +items: - name: Parallel programming in MSVC href: ../parallel/parallel-programming-in-visual-cpp.md - name: Auto-parallelization and auto-vectorization href: ../parallel/auto-parallelization-and-auto-vectorization.md -- name: C++ Accelerated Massive Parallelism (AMP) - expanded: false - items: - - name: C++ AMP (C++ Accelerated Massive Parallelism) - href: ../parallel/amp/cpp-amp-cpp-accelerated-massive-parallelism.md - - name: C++ AMP overview - href: ../parallel/amp/cpp-amp-overview.md - - name: Using tiles - href: ../parallel/amp/using-tiles.md - - name: Using C++ AMP in UWP apps - href: ../parallel/amp/using-cpp-amp-in-windows-store-apps.md - - name: "Walkthrough: Matrix multiplication" - href: ../parallel/amp/walkthrough-matrix-multiplication.md - - name: "Walkthrough: Debugging a C++ AMP application" - href: ../parallel/amp/walkthrough-debugging-a-cpp-amp-application.md - - name: Using lambdas, function objects, and restricted functions - href: ../parallel/amp/using-lambdas-function-objects-and-restricted-functions.md - - name: Graphics (C++ AMP) - href: ../parallel/amp/graphics-cpp-amp.md - - name: Using accelerator and accelerator_view objects - href: ../parallel/amp/using-accelerator-and-accelerator-view-objects.md - - name: Reference (C++ AMP) - expanded: false - items: - - name: Reference (C++ AMP) - href: ../parallel/amp/reference/reference-cpp-amp.md - - name: Concurrency namespace (C++ AMP) - expanded: false - items: - - name: Concurrency namespace (C++ AMP) - href: ../parallel/amp/reference/concurrency-namespace-cpp-amp.md - - name: Concurrency namespace functions (AMP) - href: ../parallel/amp/reference/concurrency-namespace-functions-amp.md - - name: Concurrency namespace enums (AMP) - href: ../parallel/amp/reference/concurrency-namespace-enums-amp.md - - name: Concurrency namespace operators (AMP) - href: ../parallel/amp/reference/concurrency-namespace-operators-amp.md - - name: Concurrency namespace constants (AMP) - href: ../parallel/amp/reference/concurrency-namespace-constants-amp.md - - name: accelerator class - href: ../parallel/amp/reference/accelerator-class.md - - name: accelerator_view class - href: ../parallel/amp/reference/accelerator-view-class.md - - name: accelerator_view_removed class - href: ../parallel/amp/reference/accelerator-view-removed-class.md - - name: array class - href: ../parallel/amp/reference/array-class.md - - name: array_view class - href: ../parallel/amp/reference/array-view-class.md - - name: completion_future class - href: ../parallel/amp/reference/completion-future-class.md - - name: extent class (C++ AMP) - href: ../parallel/amp/reference/extent-class.md - - name: index class - href: ../parallel/amp/reference/index-class.md - - name: invalid_compute_domain class - href: ../parallel/amp/reference/invalid-compute-domain-class.md - - name: out_of_memory class - href: ../parallel/amp/reference/out-of-memory-class.md - - name: runtime_exception class - href: ../parallel/amp/reference/runtime-exception-class.md - - name: tile_barrier class - href: ../parallel/amp/reference/tile-barrier-class.md - - name: tiled_extent class - href: ../parallel/amp/reference/tiled-extent-class.md - - name: tiled_index class - href: ../parallel/amp/reference/tiled-index-class.md - - name: uninitialized_object class - href: ../parallel/amp/reference/uninitialized-object-class.md - - name: unsupported_feature class - href: ../parallel/amp/reference/unsupported-feature-class.md - - name: "Concurrency::direct3d Namespace" - expanded: false - items: - - name: "Concurrency::direct3d Namespace" - href: ../parallel/amp/reference/concurrency-direct3d-namespace.md - - name: "Concurrency::direct3d namespace functions (AMP)" - href: ../parallel/amp/reference/concurrency-direct3d-namespace-functions-amp.md - - name: adopt_d3d_access_lock_t Structure - href: ../parallel/amp/reference/adopt-d3d-access-lock-t-structure.md - - name: scoped_d3d_access_lock class - href: ../parallel/amp/reference/scoped-d3d-access-lock-class.md - - name: "Concurrency::fast_math Namespace" - expanded: false - items: - - name: "Concurrency::fast_math Namespace" - href: ../parallel/amp/reference/concurrency-fast-math-namespace.md - - name: "Concurrency::fast_math namespace functions" - href: ../parallel/amp/reference/concurrency-fast-math-namespace-functions.md - - name: "Concurrency::graphics Namespace" - expanded: false - items: - - name: "Concurrency::graphics Namespace" - href: ../parallel/amp/reference/concurrency-graphics-namespace.md - - name: "Concurrency::graphics::direct3d namespace" - expanded: false - items: - - name: "Concurrency::graphics::direct3d namespace" - href: ../parallel/amp/reference/concurrency-graphics-direct3d-namespace.md - - name: "Concurrency::graphics::direct3d namespace functions" - href: ../parallel/amp/reference/concurrency-graphics-direct3d-namespace-functions.md - - name: "Concurrency::graphics namespace functions" - href: ../parallel/amp/reference/concurrency-graphics-namespace-functions.md - - name: "Concurrency::graphics namespace enums" - href: ../parallel/amp/reference/concurrency-graphics-namespace-enums.md - - name: double_2 class - href: ../parallel/amp/reference/double-2-class.md - - name: double_3 class - href: ../parallel/amp/reference/double-3-class.md - - name: double_4 class - href: ../parallel/amp/reference/double-4-class.md - - name: float_2 class - href: ../parallel/amp/reference/float-2-class.md - - name: float_3 class - href: ../parallel/amp/reference/float-3-class.md - - name: float_4 class - href: ../parallel/amp/reference/float-4-class.md - - name: int_2 class - href: ../parallel/amp/reference/int-2-class.md - - name: int_3 class - href: ../parallel/amp/reference/int-3-class.md - - name: int_4 class - href: ../parallel/amp/reference/int-4-class.md - - name: norm class - href: ../parallel/amp/reference/norm-class.md - - name: norm_2 class - href: ../parallel/amp/reference/norm-2-class.md - - name: norm_3 class - href: ../parallel/amp/reference/norm-3-class.md - - name: norm_4 class - href: ../parallel/amp/reference/norm-4-class.md - - name: sampler class - href: ../parallel/amp/reference/sampler-class.md - - name: short_vector Structure - href: ../parallel/amp/reference/short-vector-structure.md - - name: short_vector_traits Structure - href: ../parallel/amp/reference/short-vector-traits-structure.md - - name: texture class - href: ../parallel/amp/reference/texture-class.md - - name: texture_view class - href: ../parallel/amp/reference/texture-view-class.md - - name: writeonly_texture_view class - href: ../parallel/amp/reference/writeonly-texture-view-class.md - - name: uint_2 class - href: ../parallel/amp/reference/uint-2-class.md - - name: uint_3 class - href: ../parallel/amp/reference/uint-3-class.md - - name: uint_4 class - href: ../parallel/amp/reference/uint-4-class.md - - name: unorm class - href: ../parallel/amp/reference/unorm-class.md - - name: unorm_2 class - href: ../parallel/amp/reference/unorm-2-class.md - - name: unorm_3 class - href: ../parallel/amp/reference/unorm-3-class.md - - name: unorm_4 class - href: ../parallel/amp/reference/unorm-4-class.md - - name: "Concurrency::precise_math namespace" - expanded: false - items: - - name: "Concurrency::precise_math namespace" - href: ../parallel/amp/reference/concurrency-precise-math-namespace.md - - name: "Concurrency::precise_math namespace functions" - href: ../parallel/amp/reference/concurrency-precise-math-namespace-functions.md - name: Concurrency Runtime (ConcRT) - expanded: false items: - - name: Concurrency Runtime - href: ../parallel/concrt/concurrency-runtime.md - - name: Overview of the Concurrency Runtime - href: ../parallel/concrt/overview-of-the-concurrency-runtime.md - - name: Exception handling in the Concurrency Runtime - href: ../parallel/concrt/exception-handling-in-the-concurrency-runtime.md - - name: Parallel diagnostic tools (Concurrency Runtime) - href: ../parallel/concrt/parallel-diagnostic-tools-concurrency-runtime.md - - name: Creating asynchronous operations in C++ for UWP apps - href: ../parallel/concrt/creating-asynchronous-operations-in-cpp-for-windows-store-apps.md + - name: Concurrency Runtime + href: ../parallel/concrt/concurrency-runtime.md + - name: Overview of the Concurrency Runtime + href: ../parallel/concrt/overview-of-the-concurrency-runtime.md + - name: Exception handling in the Concurrency Runtime + href: ../parallel/concrt/exception-handling-in-the-concurrency-runtime.md + - name: Parallel diagnostic tools (Concurrency Runtime) + href: ../parallel/concrt/parallel-diagnostic-tools-concurrency-runtime.md + - name: Creating asynchronous operations in C++ for UWP apps + href: ../parallel/concrt/creating-asynchronous-operations-in-cpp-for-windows-store-apps.md + - name: Comparing the Concurrency Runtime to other concurrency models + items: - name: Comparing the Concurrency Runtime to other concurrency models + href: ../parallel/concrt/comparing-the-concurrency-runtime-to-other-concurrency-models.md + - name: Migrating from OpenMP to the Concurrency Runtime + items: + - name: Migrating from OpenMP to the Concurrency Runtime + href: ../parallel/concrt/migrating-from-openmp-to-the-concurrency-runtime.md + - name: 'How to: Convert an OpenMP parallel for loop to use the Concurrency Runtime' + href: ../parallel/concrt/how-to-convert-an-openmp-parallel-for-loop-to-use-the-concurrency-runtime.md + - name: 'How to: Convert an OpenMP loop that uses cancellation to use the Concurrency Runtime' + href: ../parallel/concrt/convert-an-openmp-loop-that-uses-cancellation.md + - name: 'How to: Convert an OpenMP loop that uses exception handling to use the Concurrency Runtime' + href: ../parallel/concrt/convert-an-openmp-loop-that-uses-exception-handling.md + - name: 'How to: Convert an OpenMP loop that uses a reduction variable to use the Concurrency Runtime' + href: ../parallel/concrt/convert-an-openmp-loop-that-uses-a-reduction-variable.md expanded: false - items: - - name: Comparing the Concurrency Runtime to other concurrency models - href: ../parallel/concrt/comparing-the-concurrency-runtime-to-other-concurrency-models.md - - name: Migrating from OpenMP to the Concurrency Runtime - expanded: false - items: - - name: Migrating from OpenMP to the Concurrency Runtime - href: ../parallel/concrt/migrating-from-openmp-to-the-concurrency-runtime.md - - name: "How to: Convert an OpenMP parallel for loop to use the Concurrency Runtime" - href: ../parallel/concrt/how-to-convert-an-openmp-parallel-for-loop-to-use-the-concurrency-runtime.md - - name: "How to: Convert an OpenMP loop that uses cancellation to use the Concurrency Runtime" - href: ../parallel/concrt/convert-an-openmp-loop-that-uses-cancellation.md - - name: "How to: Convert an OpenMP loop that uses exception handling to use the Concurrency Runtime" - href: ../parallel/concrt/convert-an-openmp-loop-that-uses-exception-handling.md - - name: "How to: Convert an OpenMP loop that uses a reduction variable to use the Concurrency Runtime" - href: ../parallel/concrt/convert-an-openmp-loop-that-uses-a-reduction-variable.md + expanded: false + - name: Parallel Patterns Library (PPL) + items: - name: Parallel Patterns Library (PPL) + href: ../parallel/concrt/parallel-patterns-library-ppl.md + - name: Task parallelism (Concurrency Runtime) + items: + - name: Task parallelism (Concurrency Runtime) + href: ../parallel/concrt/task-parallelism-concurrency-runtime.md + - name: 'How to: Use parallel_invoke to write a parallel sort routine' + href: ../parallel/concrt/how-to-use-parallel-invoke-to-write-a-parallel-sort-routine.md + - name: 'How to: Use parallel_invoke to execute parallel operations' + href: ../parallel/concrt/how-to-use-parallel-invoke-to-execute-parallel-operations.md + - name: 'How to: Create a task that completes after a delay' + href: ../parallel/concrt/how-to-create-a-task-that-completes-after-a-delay.md expanded: false - items: - - name: Parallel Patterns Library (PPL) - href: ../parallel/concrt/parallel-patterns-library-ppl.md - - name: Task parallelism (Concurrency Runtime) - expanded: false - items: - - name: Task parallelism (Concurrency Runtime) - href: ../parallel/concrt/task-parallelism-concurrency-runtime.md - - name: "How to: Use parallel_invoke to write a parallel sort routine" - href: ../parallel/concrt/how-to-use-parallel-invoke-to-write-a-parallel-sort-routine.md - - name: "How to: Use parallel_invoke to execute parallel operations" - href: ../parallel/concrt/how-to-use-parallel-invoke-to-execute-parallel-operations.md - - name: "How to: Create a task that completes after a delay" - href: ../parallel/concrt/how-to-create-a-task-that-completes-after-a-delay.md - - name: Parallel algorithms - expanded: false - items: - - name: Parallel algorithms - href: ../parallel/concrt/parallel-algorithms.md - - name: "How to: Write a parallel_for loop" - href: ../parallel/concrt/how-to-write-a-parallel-for-loop.md - - name: "How to: Write a parallel_for_each loop" - href: ../parallel/concrt/how-to-write-a-parallel-for-each-loop.md - - name: "How to: Perform map and reduce operations in parallel" - href: ../parallel/concrt/how-to-perform-map-and-reduce-operations-in-parallel.md - - name: Parallel containers and objects - expanded: false - items: - - name: Parallel containers and objects - href: ../parallel/concrt/parallel-containers-and-objects.md - - name: "How to: Use parallel containers to increase efficiency" - href: ../parallel/concrt/how-to-use-parallel-containers-to-increase-efficiency.md - - name: "How to: Use combinable to improve performance" - href: ../parallel/concrt/how-to-use-combinable-to-improve-performance.md - - name: "How to: Use combinable to combine sets" - href: ../parallel/concrt/how-to-use-combinable-to-combine-sets.md - - name: Cancellation in the PPL - expanded: false - items: - - name: Cancellation in the PPL - href: ../parallel/concrt/cancellation-in-the-ppl.md - - name: "How to: Use cancellation to break from a parallel loop" - href: ../parallel/concrt/how-to-use-cancellation-to-break-from-a-parallel-loop.md - - name: "How to: Use exception handling to break from a parallel loop" - href: ../parallel/concrt/how-to-use-exception-handling-to-break-from-a-parallel-loop.md - - name: Asynchronous Agents Library + - name: Parallel algorithms + items: + - name: Parallel algorithms + href: ../parallel/concrt/parallel-algorithms.md + - name: 'How to: Write a parallel_for loop' + href: ../parallel/concrt/how-to-write-a-parallel-for-loop.md + - name: 'How to: Write a parallel_for_each loop' + href: ../parallel/concrt/how-to-write-a-parallel-for-each-loop.md + - name: 'How to: Perform map and reduce operations in parallel' + href: ../parallel/concrt/how-to-perform-map-and-reduce-operations-in-parallel.md expanded: false - items: - - name: Asynchronous Agents Library - href: ../parallel/concrt/asynchronous-agents-library.md - - name: Asynchronous agents - href: ../parallel/concrt/asynchronous-agents.md - - name: Asynchronous message blocks - href: ../parallel/concrt/asynchronous-message-blocks.md - - name: Message passing functions - href: ../parallel/concrt/message-passing-functions.md - - name: "How to: Implement various producer-consumer patterns" - href: ../parallel/concrt/how-to-implement-various-producer-consumer-patterns.md - - name: "How to: Provide work functions to the call and transformer classes" - href: ../parallel/concrt/how-to-provide-work-functions-to-the-call-and-transformer-classes.md - - name: "How to: Use transformer in a data pipeline" - href: ../parallel/concrt/how-to-use-transformer-in-a-data-pipeline.md - - name: "How to: Select among completed tasks" - href: ../parallel/concrt/how-to-select-among-completed-tasks.md - - name: "How to: Send a message at a regular interval" - href: ../parallel/concrt/how-to-send-a-message-at-a-regular-interval.md - - name: "How to: Use a message block filter" - href: ../parallel/concrt/how-to-use-a-message-block-filter.md - - name: Synchronization data structures + - name: Parallel containers and objects + items: + - name: Parallel containers and objects + href: ../parallel/concrt/parallel-containers-and-objects.md + - name: 'How to: Use parallel containers to increase efficiency' + href: ../parallel/concrt/how-to-use-parallel-containers-to-increase-efficiency.md + - name: 'How to: Use combinable to improve performance' + href: ../parallel/concrt/how-to-use-combinable-to-improve-performance.md + - name: 'How to: Use combinable to combine sets' + href: ../parallel/concrt/how-to-use-combinable-to-combine-sets.md + expanded: false + - name: Cancellation in the PPL + items: + - name: Cancellation in the PPL + href: ../parallel/concrt/cancellation-in-the-ppl.md + - name: 'How to: Use cancellation to break from a parallel loop' + href: ../parallel/concrt/how-to-use-cancellation-to-break-from-a-parallel-loop.md + - name: 'How to: Use exception handling to break from a parallel loop' + href: ../parallel/concrt/how-to-use-exception-handling-to-break-from-a-parallel-loop.md expanded: false - items: - - name: Synchronization data structures - href: ../parallel/concrt/synchronization-data-structures.md - - name: Comparing synchronization data structures to the Windows API - href: ../parallel/concrt/comparing-synchronization-data-structures-to-the-windows-api.md + expanded: false + - name: Asynchronous Agents Library + items: + - name: Asynchronous Agents Library + href: ../parallel/concrt/asynchronous-agents-library.md + - name: Asynchronous agents + href: ../parallel/concrt/asynchronous-agents.md + - name: Asynchronous message blocks + href: ../parallel/concrt/asynchronous-message-blocks.md + - name: Message passing functions + href: ../parallel/concrt/message-passing-functions.md + - name: 'How to: Implement various producer-consumer patterns' + href: ../parallel/concrt/how-to-implement-various-producer-consumer-patterns.md + - name: 'How to: Provide work functions to the call and transformer classes' + href: ../parallel/concrt/how-to-provide-work-functions-to-the-call-and-transformer-classes.md + - name: 'How to: Use transformer in a data pipeline' + href: ../parallel/concrt/how-to-use-transformer-in-a-data-pipeline.md + - name: 'How to: Select among completed tasks' + href: ../parallel/concrt/how-to-select-among-completed-tasks.md + - name: 'How to: Send a message at a regular interval' + href: ../parallel/concrt/how-to-send-a-message-at-a-regular-interval.md + - name: 'How to: Use a message block filter' + href: ../parallel/concrt/how-to-use-a-message-block-filter.md + expanded: false + - name: Synchronization data structures + items: + - name: Synchronization data structures + href: ../parallel/concrt/synchronization-data-structures.md + - name: Comparing synchronization data structures to the Windows API + href: ../parallel/concrt/comparing-synchronization-data-structures-to-the-windows-api.md + expanded: false + - name: Task scheduler (Concurrency Runtime) + items: - name: Task scheduler (Concurrency Runtime) + href: ../parallel/concrt/task-scheduler-concurrency-runtime.md + - name: Scheduler instances + items: + - name: Scheduler instances + href: ../parallel/concrt/scheduler-instances.md + - name: 'How to: Manage a scheduler instance' + href: ../parallel/concrt/how-to-manage-a-scheduler-instance.md expanded: false - items: - - name: Task scheduler (Concurrency Runtime) - href: ../parallel/concrt/task-scheduler-concurrency-runtime.md - - name: Scheduler instances - expanded: false - items: - - name: Scheduler instances - href: ../parallel/concrt/scheduler-instances.md - - name: "How to: Manage a scheduler instance" - href: ../parallel/concrt/how-to-manage-a-scheduler-instance.md - - name: Scheduler policies - expanded: false - items: - - name: Scheduler policies - href: ../parallel/concrt/scheduler-policies.md - - name: "How to: Specify specific scheduler policies" - href: ../parallel/concrt/how-to-specify-specific-scheduler-policies.md - - name: "How to: Create agents that use specific scheduler policies" - href: ../parallel/concrt/how-to-create-agents-that-use-specific-scheduler-policies.md - - name: Schedule groups - expanded: false - items: - - name: Schedule groups - href: ../parallel/concrt/schedule-groups.md - - name: "How to: Use schedule groups to influence order of execution" - href: ../parallel/concrt/how-to-use-schedule-groups-to-influence-order-of-execution.md - - name: Lightweight tasks - href: ../parallel/concrt/lightweight-tasks.md - - name: Contexts - expanded: false - items: - - name: Contexts - href: ../parallel/concrt/contexts.md - - name: "How to: Use the Context class to implement a cooperative semaphore" - href: ../parallel/concrt/how-to-use-the-context-class-to-implement-a-cooperative-semaphore.md - - name: "How to: Use oversubscription to offset latency" - href: ../parallel/concrt/how-to-use-oversubscription-to-offset-latency.md - - name: Memory management functions - expanded: false - items: - - name: Memory management functions - href: ../parallel/concrt/memory-management-functions.md - - name: "How to: Use Alloc and Free to improve memory performance" - href: ../parallel/concrt/how-to-use-alloc-and-free-to-improve-memory-performance.md - - name: Concurrency Runtime walkthroughs + - name: Scheduler policies + items: + - name: Scheduler policies + href: ../parallel/concrt/scheduler-policies.md + - name: 'How to: Specify specific scheduler policies' + href: ../parallel/concrt/how-to-specify-specific-scheduler-policies.md + - name: 'How to: Create agents that use specific scheduler policies' + href: ../parallel/concrt/how-to-create-agents-that-use-specific-scheduler-policies.md + expanded: false + - name: Schedule groups + items: + - name: Schedule groups + href: ../parallel/concrt/schedule-groups.md + - name: 'How to: Use schedule groups to influence order of execution' + href: ../parallel/concrt/how-to-use-schedule-groups-to-influence-order-of-execution.md + expanded: false + - name: Lightweight tasks + href: ../parallel/concrt/lightweight-tasks.md + - name: Contexts + items: + - name: Contexts + href: ../parallel/concrt/contexts.md + - name: 'How to: Use the Context class to implement a cooperative semaphore' + href: ../parallel/concrt/how-to-use-the-context-class-to-implement-a-cooperative-semaphore.md + - name: 'How to: Use oversubscription to offset latency' + href: ../parallel/concrt/how-to-use-oversubscription-to-offset-latency.md + expanded: false + - name: Memory management functions + items: + - name: Memory management functions + href: ../parallel/concrt/memory-management-functions.md + - name: 'How to: Use Alloc and Free to improve memory performance' + href: ../parallel/concrt/how-to-use-alloc-and-free-to-improve-memory-performance.md expanded: false - items: - - name: Concurrency Runtime walkthroughs - href: ../parallel/concrt/concurrency-runtime-walkthroughs.md - - name: "Walkthrough: Connecting using tasks and xml http requests" - href: ../parallel/concrt/walkthrough-connecting-using-tasks-and-xml-http-requests.md - - name: "Walkthrough: Creating an agent-based application" - href: ../parallel/concrt/walkthrough-creating-an-agent-based-application.md - - name: "Walkthrough: Creating a dataflow agent" - href: ../parallel/concrt/walkthrough-creating-a-dataflow-agent.md - - name: "Walkthrough: Creating an image-processing network" - href: ../parallel/concrt/walkthrough-creating-an-image-processing-network.md - - name: "Walkthrough: Implementing futures" - href: ../parallel/concrt/walkthrough-implementing-futures.md - - name: "Walkthrough: Using join to prevent deadlock" - href: ../parallel/concrt/walkthrough-using-join-to-prevent-deadlock.md - - name: "Walkthrough: Removing work from a user-interface thread" - href: ../parallel/concrt/walkthrough-removing-work-from-a-user-interface-thread.md - - name: "Walkthrough: Using the Concurrency Runtime in a COM-enabled application" - href: ../parallel/concrt/walkthrough-using-the-concurrency-runtime-in-a-com-enabled-application.md - - name: "Walkthrough: Adapting existing code to use lightweight tasks" - href: ../parallel/concrt/walkthrough-adapting-existing-code-to-use-lightweight-tasks.md - - name: "Walkthrough: Creating a custom message block" - href: ../parallel/concrt/walkthrough-creating-a-custom-message-block.md + expanded: false + - name: Concurrency Runtime walkthroughs + items: + - name: Concurrency Runtime walkthroughs + href: ../parallel/concrt/concurrency-runtime-walkthroughs.md + - name: 'Walkthrough: Connecting using tasks and xml http requests' + href: ../parallel/concrt/walkthrough-connecting-using-tasks-and-xml-http-requests.md + - name: 'Walkthrough: Creating an agent-based application' + href: ../parallel/concrt/walkthrough-creating-an-agent-based-application.md + - name: 'Walkthrough: Creating a dataflow agent' + href: ../parallel/concrt/walkthrough-creating-a-dataflow-agent.md + - name: 'Walkthrough: Creating an image-processing network' + href: ../parallel/concrt/walkthrough-creating-an-image-processing-network.md + - name: 'Walkthrough: Implementing futures' + href: ../parallel/concrt/walkthrough-implementing-futures.md + - name: 'Walkthrough: Using join to prevent deadlock' + href: ../parallel/concrt/walkthrough-using-join-to-prevent-deadlock.md + - name: 'Walkthrough: Removing work from a user-interface thread' + href: ../parallel/concrt/walkthrough-removing-work-from-a-user-interface-thread.md + - name: 'Walkthrough: Using the Concurrency Runtime in a COM-enabled application' + href: ../parallel/concrt/walkthrough-using-the-concurrency-runtime-in-a-com-enabled-application.md + - name: 'Walkthrough: Adapting existing code to use lightweight tasks' + href: ../parallel/concrt/walkthrough-adapting-existing-code-to-use-lightweight-tasks.md + - name: 'Walkthrough: Creating a custom message block' + href: ../parallel/concrt/walkthrough-creating-a-custom-message-block.md + expanded: false + - name: Concurrency Runtime best practices + items: - name: Concurrency Runtime best practices + href: ../parallel/concrt/concurrency-runtime-best-practices.md + - name: Best practices in the Parallel Patterns Library + href: ../parallel/concrt/best-practices-in-the-parallel-patterns-library.md + - name: Best practices in the Asynchronous Agents Library + href: ../parallel/concrt/best-practices-in-the-asynchronous-agents-library.md + - name: General best practices in the Concurrency Runtime + href: ../parallel/concrt/general-best-practices-in-the-concurrency-runtime.md + expanded: false + - name: Reference + items: + - name: Reference (Concurrency Runtime) + href: ../parallel/concrt/reference/reference-concurrency-runtime.md + - name: concurrency namespace + items: + - name: concurrency namespace + href: ../parallel/concrt/reference/concurrency-namespace.md + - name: concurrency namespace functions + href: ../parallel/concrt/reference/concurrency-namespace-functions.md + - name: concurrency namespace Operators + href: ../parallel/concrt/reference/concurrency-namespace-operators.md + - name: concurrency namespace constants1 + href: ../parallel/concrt/reference/concurrency-namespace-constants1.md + - name: concurrency namespace enums + href: ../parallel/concrt/reference/concurrency-namespace-enums.md + - name: affinity_partitioner class + href: ../parallel/concrt/reference/affinity-partitioner-class.md + - name: agent class + href: ../parallel/concrt/reference/agent-class.md + - name: auto_partitioner class + href: ../parallel/concrt/reference/auto-partitioner-class.md + - name: bad_target class + href: ../parallel/concrt/reference/bad-target-class.md + - name: call class + href: ../parallel/concrt/reference/call-class.md + - name: cancellation_token class + href: ../parallel/concrt/reference/cancellation-token-class.md + - name: cancellation_token_registration class + href: ../parallel/concrt/reference/cancellation-token-registration-class.md + - name: cancellation_token_source class + href: ../parallel/concrt/reference/cancellation-token-source-class.md + - name: choice class + href: ../parallel/concrt/reference/choice-class.md + - name: combinable class + href: ../parallel/concrt/reference/combinable-class.md + - name: concurrent_priority_queue class + href: ../parallel/concrt/reference/concurrent-priority-queue-class.md + - name: concurrent_queue class + href: ../parallel/concrt/reference/concurrent-queue-class.md + - name: concurrent_unordered_map class + href: ../parallel/concrt/reference/concurrent-unordered-map-class.md + - name: concurrent_unordered_multimap class + href: ../parallel/concrt/reference/concurrent-unordered-multimap-class.md + - name: concurrent_unordered_multiset class + href: ../parallel/concrt/reference/concurrent-unordered-multiset-class.md + - name: concurrent_unordered_set class + href: ../parallel/concrt/reference/concurrent-unordered-set-class.md + - name: concurrent_vector class + href: ../parallel/concrt/reference/concurrent-vector-class.md + - name: Context class + href: ../parallel/concrt/reference/context-class.md + - name: context_self_unblock class + href: ../parallel/concrt/reference/context-self-unblock-class.md + - name: context_unblock_unbalanced class + href: ../parallel/concrt/reference/context-unblock-unbalanced-class.md + - name: critical_section class + href: ../parallel/concrt/reference/critical-section-class.md + - name: CurrentScheduler class + href: ../parallel/concrt/reference/currentscheduler-class.md + - name: default_scheduler_exists class + href: ../parallel/concrt/reference/default-scheduler-exists-class.md + - name: DispatchState Structure + href: ../parallel/concrt/reference/dispatchstate-structure.md + - name: event class + href: ../parallel/concrt/reference/event-class.md + - name: IExecutionContext Structure + href: ../parallel/concrt/reference/iexecutioncontext-structure.md + - name: IExecutionResource Structure + href: ../parallel/concrt/reference/iexecutionresource-structure.md + - name: improper_lock class + href: ../parallel/concrt/reference/improper-lock-class.md + - name: improper_scheduler_attach class + href: ../parallel/concrt/reference/improper-scheduler-attach-class.md + - name: improper_scheduler_detach class + href: ../parallel/concrt/reference/improper-scheduler-detach-class.md + - name: improper_scheduler_reference class + href: ../parallel/concrt/reference/improper-scheduler-reference-class.md + - name: invalid_link_target class + href: ../parallel/concrt/reference/invalid-link-target-class.md + - name: invalid_multiple_scheduling class + href: ../parallel/concrt/reference/invalid-multiple-scheduling-class.md + - name: invalid_operation class + href: ../parallel/concrt/reference/invalid-operation-class.md + - name: invalid_oversubscribe_operation class + href: ../parallel/concrt/reference/invalid-oversubscribe-operation-class.md + - name: invalid_scheduler_policy_key class + href: ../parallel/concrt/reference/invalid-scheduler-policy-key-class.md + - name: invalid_scheduler_policy_thread_specification class + href: ../parallel/concrt/reference/invalid-scheduler-policy-thread-specification-class.md + - name: invalid_scheduler_policy_value class + href: ../parallel/concrt/reference/invalid-scheduler-policy-value-class.md + - name: IResourceManager Structure + href: ../parallel/concrt/reference/iresourcemanager-structure.md + - name: IScheduler Structure + href: ../parallel/concrt/reference/ischeduler-structure.md + - name: ISchedulerProxy Structure + href: ../parallel/concrt/reference/ischedulerproxy-structure.md + - name: ISource class + href: ../parallel/concrt/reference/isource-class.md + - name: ITarget class + href: ../parallel/concrt/reference/itarget-class.md + - name: IThreadProxy Structure + href: ../parallel/concrt/reference/ithreadproxy-structure.md + - name: ITopologyExecutionResource Structure + href: ../parallel/concrt/reference/itopologyexecutionresource-structure.md + - name: ITopologyNode Structure + href: ../parallel/concrt/reference/itopologynode-structure.md + - name: IUMSCompletionList Structure + href: ../parallel/concrt/reference/iumscompletionlist-structure.md + - name: IUMSScheduler Structure + href: ../parallel/concrt/reference/iumsscheduler-structure.md + - name: IUMSThreadProxy Structure + href: ../parallel/concrt/reference/iumsthreadproxy-structure.md + - name: IUMSUnblockNotification Structure + href: ../parallel/concrt/reference/iumsunblocknotification-structure.md + - name: IVirtualProcessorRoot Structure + href: ../parallel/concrt/reference/ivirtualprocessorroot-structure.md + - name: join class + href: ../parallel/concrt/reference/join-class.md + - name: location class + href: ../parallel/concrt/reference/location-class.md + - name: message class + href: ../parallel/concrt/reference/message-class.md + - name: message_not_found class + href: ../parallel/concrt/reference/message-not-found-class.md + - name: message_processor class + href: ../parallel/concrt/reference/message-processor-class.md + - name: missing_wait class + href: ../parallel/concrt/reference/missing-wait-class.md + - name: multi_link_registry class + href: ../parallel/concrt/reference/multi-link-registry-class.md + - name: multitype_join class + href: ../parallel/concrt/reference/multitype-join-class.md + - name: nested_scheduler_missing_detach class + href: ../parallel/concrt/reference/nested-scheduler-missing-detach-class.md + - name: network_link_registry class + href: ../parallel/concrt/reference/network-link-registry-class.md + - name: operation_timed_out class + href: ../parallel/concrt/reference/operation-timed-out-class.md + - name: ordered_message_processor class + href: ../parallel/concrt/reference/ordered-message-processor-class.md + - name: overwrite_buffer class + href: ../parallel/concrt/reference/overwrite-buffer-class.md + - name: progress_reporter class + href: ../parallel/concrt/reference/progress-reporter-class.md + - name: propagator_block class + href: ../parallel/concrt/reference/propagator-block-class.md + - name: reader_writer_lock class + href: ../parallel/concrt/reference/reader-writer-lock-class.md + - name: ScheduleGroup class + href: ../parallel/concrt/reference/schedulegroup-class.md + - name: Scheduler class + href: ../parallel/concrt/reference/scheduler-class.md + - name: scheduler_interface Structure + href: ../parallel/concrt/reference/scheduler-interface-structure.md + - name: scheduler_not_attached class + href: ../parallel/concrt/reference/scheduler-not-attached-class.md + - name: scheduler_ptr Structure (Concurrency Runtime) + href: ../parallel/concrt/reference/scheduler-ptr-structure-concurrency-runtime.md + - name: scheduler_resource_allocation_error class + href: ../parallel/concrt/reference/scheduler-resource-allocation-error-class.md + - name: scheduler_worker_creation_error class + href: ../parallel/concrt/reference/scheduler-worker-creation-error-class.md + - name: SchedulerPolicy class + href: ../parallel/concrt/reference/schedulerpolicy-class.md + - name: simple_partitioner class + href: ../parallel/concrt/reference/simple-partitioner-class.md + - name: single_assignment class + href: ../parallel/concrt/reference/single-assignment-class.md + - name: single_link_registry class + href: ../parallel/concrt/reference/single-link-registry-class.md + - name: source_block class + href: ../parallel/concrt/reference/source-block-class.md + - name: source_link_manager class + href: ../parallel/concrt/reference/source-link-manager-class.md + - name: static_partitioner class + href: ../parallel/concrt/reference/static-partitioner-class.md + - name: structured_task_group class + href: ../parallel/concrt/reference/structured-task-group-class.md + - name: target_block class + href: ../parallel/concrt/reference/target-block-class.md + - name: task class (Concurrency Runtime) + href: ../parallel/concrt/reference/task-class.md + - name: task_canceled class + href: ../parallel/concrt/reference/task-canceled-class.md + - name: task_completion_event class + href: ../parallel/concrt/reference/task-completion-event-class.md + - name: task_continuation_context class + href: ../parallel/concrt/reference/task-continuation-context-class.md + - name: task_group class + href: ../parallel/concrt/reference/task-group-class.md + - name: task_handle class + href: ../parallel/concrt/reference/task-handle-class.md + - name: task_options class (Concurrency Runtime) + href: ../parallel/concrt/reference/task-options-class-concurrency-runtime.md + - name: timer class + href: ../parallel/concrt/reference/timer-class.md + - name: transformer class + href: ../parallel/concrt/reference/transformer-class.md + - name: unbounded_buffer class + href: ../parallel/concrt/reference/unbounded-buffer-class.md + - name: unsupported_os class + href: ../parallel/concrt/reference/unsupported-os-class.md expanded: false - items: - - name: Concurrency Runtime best practices - href: ../parallel/concrt/concurrency-runtime-best-practices.md - - name: Best practices in the Parallel Patterns Library - href: ../parallel/concrt/best-practices-in-the-parallel-patterns-library.md - - name: Best practices in the Asynchronous Agents Library - href: ../parallel/concrt/best-practices-in-the-asynchronous-agents-library.md - - name: General best practices in the Concurrency Runtime - href: ../parallel/concrt/general-best-practices-in-the-concurrency-runtime.md - - name: Reference + - name: std namespace + items: + - name: std namespace + href: ../parallel/concrt/reference/std-namespace.md + - name: make_exception_ptr function + href: ../parallel/concrt/reference/make-exception-ptr-function.md expanded: false - items: - - name: Reference (Concurrency Runtime) - href: ../parallel/concrt/reference/reference-concurrency-runtime.md - - name: concurrency namespace - expanded: false - items: - - name: concurrency namespace - href: ../parallel/concrt/reference/concurrency-namespace.md - - name: concurrency namespace functions - href: ../parallel/concrt/reference/concurrency-namespace-functions.md - - name: concurrency namespace Operators - href: ../parallel/concrt/reference/concurrency-namespace-operators.md - - name: concurrency namespace constants1 - href: ../parallel/concrt/reference/concurrency-namespace-constants1.md - - name: concurrency namespace enums - href: ../parallel/concrt/reference/concurrency-namespace-enums.md - - name: affinity_partitioner class - href: ../parallel/concrt/reference/affinity-partitioner-class.md - - name: agent class - href: ../parallel/concrt/reference/agent-class.md - - name: auto_partitioner class - href: ../parallel/concrt/reference/auto-partitioner-class.md - - name: bad_target class - href: ../parallel/concrt/reference/bad-target-class.md - - name: call class - href: ../parallel/concrt/reference/call-class.md - - name: cancellation_token class - href: ../parallel/concrt/reference/cancellation-token-class.md - - name: cancellation_token_registration class - href: ../parallel/concrt/reference/cancellation-token-registration-class.md - - name: cancellation_token_source class - href: ../parallel/concrt/reference/cancellation-token-source-class.md - - name: choice class - href: ../parallel/concrt/reference/choice-class.md - - name: combinable class - href: ../parallel/concrt/reference/combinable-class.md - - name: concurrent_priority_queue class - href: ../parallel/concrt/reference/concurrent-priority-queue-class.md - - name: concurrent_queue class - href: ../parallel/concrt/reference/concurrent-queue-class.md - - name: concurrent_unordered_map class - href: ../parallel/concrt/reference/concurrent-unordered-map-class.md - - name: concurrent_unordered_multimap class - href: ../parallel/concrt/reference/concurrent-unordered-multimap-class.md - - name: concurrent_unordered_multiset class - href: ../parallel/concrt/reference/concurrent-unordered-multiset-class.md - - name: concurrent_unordered_set class - href: ../parallel/concrt/reference/concurrent-unordered-set-class.md - - name: concurrent_vector class - href: ../parallel/concrt/reference/concurrent-vector-class.md - - name: Context class - href: ../parallel/concrt/reference/context-class.md - - name: context_self_unblock class - href: ../parallel/concrt/reference/context-self-unblock-class.md - - name: context_unblock_unbalanced class - href: ../parallel/concrt/reference/context-unblock-unbalanced-class.md - - name: critical_section class - href: ../parallel/concrt/reference/critical-section-class.md - - name: CurrentScheduler class - href: ../parallel/concrt/reference/currentscheduler-class.md - - name: default_scheduler_exists class - href: ../parallel/concrt/reference/default-scheduler-exists-class.md - - name: DispatchState Structure - href: ../parallel/concrt/reference/dispatchstate-structure.md - - name: event class - href: ../parallel/concrt/reference/event-class.md - - name: IExecutionContext Structure - href: ../parallel/concrt/reference/iexecutioncontext-structure.md - - name: IExecutionResource Structure - href: ../parallel/concrt/reference/iexecutionresource-structure.md - - name: improper_lock class - href: ../parallel/concrt/reference/improper-lock-class.md - - name: improper_scheduler_attach class - href: ../parallel/concrt/reference/improper-scheduler-attach-class.md - - name: improper_scheduler_detach class - href: ../parallel/concrt/reference/improper-scheduler-detach-class.md - - name: improper_scheduler_reference class - href: ../parallel/concrt/reference/improper-scheduler-reference-class.md - - name: invalid_link_target class - href: ../parallel/concrt/reference/invalid-link-target-class.md - - name: invalid_multiple_scheduling class - href: ../parallel/concrt/reference/invalid-multiple-scheduling-class.md - - name: invalid_operation class - href: ../parallel/concrt/reference/invalid-operation-class.md - - name: invalid_oversubscribe_operation class - href: ../parallel/concrt/reference/invalid-oversubscribe-operation-class.md - - name: invalid_scheduler_policy_key class - href: ../parallel/concrt/reference/invalid-scheduler-policy-key-class.md - - name: invalid_scheduler_policy_thread_specification class - href: ../parallel/concrt/reference/invalid-scheduler-policy-thread-specification-class.md - - name: invalid_scheduler_policy_value class - href: ../parallel/concrt/reference/invalid-scheduler-policy-value-class.md - - name: IResourceManager Structure - href: ../parallel/concrt/reference/iresourcemanager-structure.md - - name: IScheduler Structure - href: ../parallel/concrt/reference/ischeduler-structure.md - - name: ISchedulerProxy Structure - href: ../parallel/concrt/reference/ischedulerproxy-structure.md - - name: ISource class - href: ../parallel/concrt/reference/isource-class.md - - name: ITarget class - href: ../parallel/concrt/reference/itarget-class.md - - name: IThreadProxy Structure - href: ../parallel/concrt/reference/ithreadproxy-structure.md - - name: ITopologyExecutionResource Structure - href: ../parallel/concrt/reference/itopologyexecutionresource-structure.md - - name: ITopologyNode Structure - href: ../parallel/concrt/reference/itopologynode-structure.md - - name: IUMSCompletionList Structure - href: ../parallel/concrt/reference/iumscompletionlist-structure.md - - name: IUMSScheduler Structure - href: ../parallel/concrt/reference/iumsscheduler-structure.md - - name: IUMSThreadProxy Structure - href: ../parallel/concrt/reference/iumsthreadproxy-structure.md - - name: IUMSUnblockNotification Structure - href: ../parallel/concrt/reference/iumsunblocknotification-structure.md - - name: IVirtualProcessorRoot Structure - href: ../parallel/concrt/reference/ivirtualprocessorroot-structure.md - - name: join class - href: ../parallel/concrt/reference/join-class.md - - name: location class - href: ../parallel/concrt/reference/location-class.md - - name: message class - href: ../parallel/concrt/reference/message-class.md - - name: message_not_found class - href: ../parallel/concrt/reference/message-not-found-class.md - - name: message_processor class - href: ../parallel/concrt/reference/message-processor-class.md - - name: missing_wait class - href: ../parallel/concrt/reference/missing-wait-class.md - - name: multi_link_registry class - href: ../parallel/concrt/reference/multi-link-registry-class.md - - name: multitype_join class - href: ../parallel/concrt/reference/multitype-join-class.md - - name: nested_scheduler_missing_detach class - href: ../parallel/concrt/reference/nested-scheduler-missing-detach-class.md - - name: network_link_registry class - href: ../parallel/concrt/reference/network-link-registry-class.md - - name: operation_timed_out class - href: ../parallel/concrt/reference/operation-timed-out-class.md - - name: ordered_message_processor class - href: ../parallel/concrt/reference/ordered-message-processor-class.md - - name: overwrite_buffer class - href: ../parallel/concrt/reference/overwrite-buffer-class.md - - name: progress_reporter class - href: ../parallel/concrt/reference/progress-reporter-class.md - - name: propagator_block class - href: ../parallel/concrt/reference/propagator-block-class.md - - name: reader_writer_lock class - href: ../parallel/concrt/reference/reader-writer-lock-class.md - - name: ScheduleGroup class - href: ../parallel/concrt/reference/schedulegroup-class.md - - name: Scheduler class - href: ../parallel/concrt/reference/scheduler-class.md - - name: scheduler_interface Structure - href: ../parallel/concrt/reference/scheduler-interface-structure.md - - name: scheduler_not_attached class - href: ../parallel/concrt/reference/scheduler-not-attached-class.md - - name: scheduler_ptr Structure (Concurrency Runtime) - href: ../parallel/concrt/reference/scheduler-ptr-structure-concurrency-runtime.md - - name: scheduler_resource_allocation_error class - href: ../parallel/concrt/reference/scheduler-resource-allocation-error-class.md - - name: scheduler_worker_creation_error class - href: ../parallel/concrt/reference/scheduler-worker-creation-error-class.md - - name: SchedulerPolicy class - href: ../parallel/concrt/reference/schedulerpolicy-class.md - - name: simple_partitioner class - href: ../parallel/concrt/reference/simple-partitioner-class.md - - name: single_assignment class - href: ../parallel/concrt/reference/single-assignment-class.md - - name: single_link_registry class - href: ../parallel/concrt/reference/single-link-registry-class.md - - name: source_block class - href: ../parallel/concrt/reference/source-block-class.md - - name: source_link_manager class - href: ../parallel/concrt/reference/source-link-manager-class.md - - name: static_partitioner class - href: ../parallel/concrt/reference/static-partitioner-class.md - - name: structured_task_group class - href: ../parallel/concrt/reference/structured-task-group-class.md - - name: target_block class - href: ../parallel/concrt/reference/target-block-class.md - - name: task class (Concurrency Runtime) - href: ../parallel/concrt/reference/task-class.md - - name: task_canceled class - href: ../parallel/concrt/reference/task-canceled-class.md - - name: task_completion_event class - href: ../parallel/concrt/reference/task-completion-event-class.md - - name: task_continuation_context class - href: ../parallel/concrt/reference/task-continuation-context-class.md - - name: task_group class - href: ../parallel/concrt/reference/task-group-class.md - - name: task_handle class - href: ../parallel/concrt/reference/task-handle-class.md - - name: task_options class (Concurrency Runtime) - href: ../parallel/concrt/reference/task-options-class-concurrency-runtime.md - - name: timer class - href: ../parallel/concrt/reference/timer-class.md - - name: transformer class - href: ../parallel/concrt/reference/transformer-class.md - - name: unbounded_buffer class - href: ../parallel/concrt/reference/unbounded-buffer-class.md - - name: unsupported_os class - href: ../parallel/concrt/reference/unsupported-os-class.md - - name: std namespace - expanded: false - items: - - name: std namespace - href: ../parallel/concrt/reference/std-namespace.md - - name: make_exception_ptr function - href: ../parallel/concrt/reference/make-exception-ptr-function.md - - name: stdx namespace - expanded: false - items: - - name: stdx namespace - href: ../parallel/concrt/reference/stdx-namespace.md - - name: declval function - href: ../parallel/concrt/reference/declval-function.md -- name: OpenMP + - name: stdx namespace + items: + - name: stdx namespace + href: ../parallel/concrt/reference/stdx-namespace.md + - name: declval function + href: ../parallel/concrt/reference/declval-function.md + expanded: false + expanded: false expanded: false +- name: OpenMP items: - - name: OpenMP in MSVC - href: ../parallel/openmp/openmp-in-visual-cpp.md - - name: SIMD Extension - href: ../parallel/openmp/openmp-simd.md + - name: OpenMP in MSVC + href: ../parallel/openmp/openmp-in-visual-cpp.md + - name: SIMD Extension + href: ../parallel/openmp/openmp-simd.md + - name: OpenMP C and C++ Application Program Interface + items: - name: OpenMP C and C++ Application Program Interface - expanded: false - items: - - name: OpenMP C and C++ Application Program Interface - href: ../parallel/openmp/openmp-c-and-cpp-application-program-interface.md - - name: Introduction - href: ../parallel/openmp/1-introduction.md - - name: Directives - href: ../parallel/openmp/2-directives.md - - name: Run-time library functions - href: ../parallel/openmp/3-run-time-library-functions.md - - name: Environment variables - href: ../parallel/openmp/4-environment-variables.md - - name: Appendices - items: - - name: Examples - href: ../parallel/openmp/a-examples.md - - name: Stubs for run-time library functions - href: ../parallel/openmp/b-stubs-for-run-time-library-functions.md - - name: OpenMP C and C++ grammar - href: ../parallel/openmp/c-openmp-c-and-cpp-grammar.md - - name: The schedule clause - href: ../parallel/openmp/d-using-the-schedule-clause.md - - name: Implementation-defined behaviors in OpenMP C/C++ - href: ../parallel/openmp/e-implementation-defined-behaviors-in-openmp-c-cpp.md - - name: New features and clarifications in version 2.0 - href: ../parallel/openmp/f-new-features-and-clarifications-in-version-2-0.md + href: ../parallel/openmp/openmp-c-and-cpp-application-program-interface.md + - name: Introduction + href: ../parallel/openmp/1-introduction.md + - name: Directives + href: ../parallel/openmp/2-directives.md + - name: Run-time library functions + href: ../parallel/openmp/3-run-time-library-functions.md + - name: Environment variables + href: ../parallel/openmp/4-environment-variables.md + - name: Appendices + items: + - name: Examples + href: ../parallel/openmp/a-examples.md + - name: Stubs for run-time library functions + href: ../parallel/openmp/b-stubs-for-run-time-library-functions.md + - name: OpenMP C and C++ grammar + href: ../parallel/openmp/c-openmp-c-and-cpp-grammar.md + - name: The schedule clause + href: ../parallel/openmp/d-using-the-schedule-clause.md + - name: Implementation-defined behaviors in OpenMP C/C++ + href: ../parallel/openmp/e-implementation-defined-behaviors-in-openmp-c-cpp.md + - name: New features and clarifications in version 2.0 + href: ../parallel/openmp/f-new-features-and-clarifications-in-version-2-0.md + expanded: false + - name: OpenMP library reference + items: - name: OpenMP library reference - expanded: false - items: - - name: OpenMP library reference - href: ../parallel/openmp/reference/openmp-library-reference.md - - name: Directives - href: ../parallel/openmp/reference/openmp-directives.md - - name: Clauses - href: ../parallel/openmp/reference/openmp-clauses.md - - name: Functions - href: ../parallel/openmp/reference/openmp-functions.md - - name: Environment variables - href: ../parallel/openmp/reference/openmp-environment-variables.md -- name: Multithreading support for older code (C++) + href: ../parallel/openmp/reference/openmp-library-reference.md + - name: Directives + href: ../parallel/openmp/reference/openmp-directives.md + - name: Clauses + href: ../parallel/openmp/reference/openmp-clauses.md + - name: Functions + href: ../parallel/openmp/reference/openmp-functions.md + - name: Environment variables + href: ../parallel/openmp/reference/openmp-environment-variables.md + expanded: false expanded: false - items: - - name: Multithreading support for older code (C++) - href: ../parallel/multithreading-support-for-older-code-visual-cpp.md +- name: Multithreading support for older code (C++) + items: + - name: Multithreading support for older code (C++) + href: ../parallel/multithreading-support-for-older-code-visual-cpp.md + - name: Multithreading with C and Win32 + items: - name: Multithreading with C and Win32 - expanded: false - items: - - name: Multithreading with C and Win32 - href: ../parallel/multithreading-with-c-and-win32.md - - name: Sample multithread C program - href: ../parallel/sample-multithread-c-program.md - - name: Thread local storage (TLS) - href: ../parallel/thread-local-storage-tls.md + href: ../parallel/multithreading-with-c-and-win32.md + - name: Sample multithread C program + href: ../parallel/sample-multithread-c-program.md + - name: Thread local storage (TLS) + href: ../parallel/thread-local-storage-tls.md + expanded: false + - name: Multithreading with C++ and MFC + items: - name: Multithreading with C++ and MFC - expanded: false - items: - - name: Multithreading with C++ and MFC - href: ../parallel/multithreading-with-cpp-and-mfc.md - - name: "Multithreading: Creating user-interface threads" - href: ../parallel/multithreading-creating-user-interface-threads.md - - name: "Multithreading: Creating worker threads" - href: ../parallel/multithreading-creating-worker-threads.md - - name: "Multithreading: When to use the synchronization classes" - href: ../parallel/multithreading-when-to-use-the-synchronization-classes.md - - name: "Multithreading: How to use the synchronization classes" - href: ../parallel/multithreading-how-to-use-the-synchronization-classes.md - - name: "Multithreading: Terminating threads" - href: ../parallel/multithreading-terminating-threads.md - - name: "Multithreading: Programming tips" - href: ../parallel/multithreading-programming-tips.md - - name: Multithreading and locales - href: ../parallel/multithreading-and-locales.md + href: ../parallel/multithreading-with-cpp-and-mfc.md + - name: 'Multithreading: Creating user-interface threads' + href: ../parallel/multithreading-creating-user-interface-threads.md + - name: 'Multithreading: Creating worker threads' + href: ../parallel/multithreading-creating-worker-threads.md + - name: 'Multithreading: When to use the synchronization classes' + href: ../parallel/multithreading-when-to-use-the-synchronization-classes.md + - name: 'Multithreading: How to use the synchronization classes' + href: ../parallel/multithreading-how-to-use-the-synchronization-classes.md + - name: 'Multithreading: Terminating threads' + href: ../parallel/multithreading-terminating-threads.md + - name: 'Multithreading: Programming tips' + href: ../parallel/multithreading-programming-tips.md + expanded: false + - name: Multithreading and locales + href: ../parallel/multithreading-and-locales.md + expanded: false diff --git a/docs/porting/binary-compat-2015-2017.md b/docs/porting/binary-compat-2015-2017.md index 86ad8957757..19797a108d1 100644 --- a/docs/porting/binary-compat-2015-2017.md +++ b/docs/porting/binary-compat-2015-2017.md @@ -1,31 +1,31 @@ --- -title: "C++ binary compatibility 2015-2022" -description: "Describes how binary compatibility works between compiled C++ files in Visual Studio 2015, 2017, 2019, and 2022. One Microsoft Visual C++ Redistributable package works for all three versions." -ms.date: 03/07/2024 +title: "C++ binary compatibility 2015-2026" +description: "Describes how binary compatibility works between compiled C++ files in Visual Studio 2015, 2017, 2019, 2022, and 2026. One Microsoft Visual C++ Redistributable package works for all these versions." +ms.date: 10/29/2025 helpviewer_keywords: ["binary compatibility, Visual C++"] --- # C++ binary compatibility between Visual Studio versions -The Microsoft C++ (MSVC) compiler toolsets in Visual Studio 2013 and earlier don't guarantee binary compatibility across major versions. You can't link object files, static libraries, dynamic libraries, and executables built by different versions of these toolsets. The ABIs, object formats, and runtime libraries are incompatible. +The Microsoft C++ (MSVC) Build Tools in Visual Studio 2013 and earlier don't guarantee binary compatibility across major versions. You can't link object files, static libraries, dynamic libraries, and executables built by different versions of these build tools. The ABIs, object formats, and runtime libraries are incompatible. -We've changed this behavior in Visual Studio 2015 and later versions. The runtime libraries and apps compiled by any of these versions of the compiler are binary-compatible. It's reflected in the C++ toolset major number, which starts with 14 for all versions since Visual Studio 2015. (The toolset version is v140 for Visual Studio 2015, v141 for 2017, v142 for 2019, and v143 for 2022). Say you have third-party libraries built by Visual Studio 2015. You can still use them in an application built by Visual Studio 2017, 2019, or 2022. There's no need to recompile with a matching toolset. The latest version of the Microsoft Visual C++ Redistributable package (the Redistributable) works for all of them. +We've changed this behavior in Visual Studio 2015 and later versions. The runtime libraries and apps compiled by any of these versions of the compiler are binary-compatible. It's reflected in the MSVC Build Tools major number, which starts with 14 for all versions since Visual Studio 2015. (The build tools version is v140 for Visual Studio 2015, v141 for 2017, v142 for 2019, and v143 for 2022). Say you have third-party libraries built by Visual Studio 2015. You can still use them in an application built by Visual Studio 2017, 2019, 2022, or 2026. There's no need to recompile with a matching version. The latest version of the Microsoft Visual C++ Redistributable package (the Redistributable) works for all of them. ## Restrictions on binary compatibility -There are three important restrictions on binary compatibility between the v140, v141, v142, and v143 toolsets and minor numbered version updates: +There are three important restrictions on binary compatibility between the v140, v141, v142, v143, and v145 build tools and minor numbered version updates: -- Binaries created with different versions of the v140, v141, v142, and v143 toolsets can be combined. The key rule is that the linker should only work with inputs built by a toolset that is the same version (or earlier) as itself. This applies to apps, import libraries, static libraries, and other files as described in [LINK input files](../build/reference/link-input-files.md). In some cases, an import library for an [implicitly linked](../build/linking-an-executable-to-a-dll.md#implicit-linking) DLL built by a later version of the toolset can be linked using an earlier version of the toolset--especially if the import library strictly uses `extern "C"` for the imports/exports. Here are some examples of what this all means: - - An app compiled with a 2017 toolset (v141, versions 15.0 to 15.9) can be linked to a static library compiled with Visual Studio 2022 version 17.8 (v143), but the linking must be done using a version 17.8 or later toolset. - - Apps and libraries built using VS 2015, 2017, 2019, or 2022 can be linked together, but the linking must be done using a version of the toolset that is as recent as, or more recent than, the most recent toolset used to build any of the binaries you pass to the linker. For example, given three binaries built with toolsets from VS 2015 version 14.3, VS 2017 version 15.9, and VS 2019 version 16.11, you can link them using any toolset version that is 16.11 or later. - - If a DLL is built with a newer toolset, the import library can sometimes be used with older toolsets if all of the exports follow the C language calling convention (`extern "C"`). However, the only officially supported case is consuming a newer windows SDK with an older toolset. -- The Redistributable your app uses has a similar binary-compatibility restriction. When you mix binaries built by different supported versions of the toolset, the Redistributable version must be at least as new as the latest toolset used by any app component. -- Static libraries or object files compiled using the [`/GL` (Whole program optimization)](../build/reference/gl-whole-program-optimization.md) compiler switch or linked using [`/LTCG` (Link-time code generation)](../build/reference/ltcg-link-time-code-generation.md) *aren't* binary-compatible across versions, including minor version updates. All object files and libraries compiled using **`/GL`** and **`/LTCG`** must use exactly the same toolset for the compile and the final link. For example, code built by using **`/GL`** in the Visual Studio 2019 version 16.7 toolset can't be linked to code built by using **`/GL`** in the Visual Studio 2019 version 16.8 toolset. The compiler emits [Fatal error C1047](../error-messages/compiler-errors-1/fatal-error-c1047.md). +- Binaries created with different versions of the v140, v141, v142, v143, and v145 build tools can be combined. The key rule is that the linker should only work with inputs built by build tools that are the same version (or earlier) as itself. This applies to apps, import libraries, static libraries, and other files as described in [LINK input files](../build/reference/link-input-files.md). In some cases, an import library for an [implicitly linked](../build/linking-an-executable-to-a-dll.md#implicit-linking) DLL built by a later version of the build tools can be linked using an earlier version of the build tools--especially if the import library strictly uses `extern "C"` for the imports/exports. Here are some examples of what this all means: + - An app compiled with the 2017 build tools (v141, versions 15.0 to 15.9) can be linked to a static library compiled with Visual Studio 2022 version 17.8 (v143), but the linking must be done using a version 17.8 or later build tools. + - Apps and libraries built using VS 2015, 2017, 2019, 2022, and 2026 can be linked together, but the linking must be done using a version of the build tools that is as recent as, or more recent than, the most recent build tools used to build any of the binaries you pass to the linker. For example, given three binaries built with build tools from VS 2015 version 14.3, VS 2017 version 15.9, and VS 2019 version 16.11, you can link them using any build tools version that is 16.11 or later. + - If a DLL is built with newer build tools, the import library can sometimes be used with older build tools if all of the exports follow the C language calling convention (`extern "C"`). However, the only officially supported case is consuming a newer windows SDK with older build tools. +- The Redistributable your app uses has a similar binary-compatibility restriction. When you mix binaries built by different supported versions of the build tools, the Redistributable version must be at least as new as the latest build tools used by any app component. +- Static libraries or object files compiled using the [`/GL` (Whole program optimization)](../build/reference/gl-whole-program-optimization.md) compiler switch or linked using [`/LTCG` (Link-time code generation)](../build/reference/ltcg-link-time-code-generation.md) *aren't* binary-compatible across versions, including minor version updates. All object files and libraries compiled using **`/GL`** and **`/LTCG`** must use exactly the same build tools for the compile and the final link. For example, code built by using **`/GL`** in the Visual Studio 2019 version 16.7 build tools can't be linked to code built by using **`/GL`** in the Visual Studio 2019 version 16.8 build tools. The compiler emits [Fatal error C1047](../error-messages/compiler-errors-1/fatal-error-c1047.md). ## Upgrade the Microsoft Visual C++ Redistributable from Visual Studio 2015 and later -We've kept the Microsoft Visual C++ Redistributable major version number the same for Visual Studio 2015, 2017, 2019, and 2022. That means only one instance of the Redistributable can be installed at a time. A newer version overwrites any older version that's already installed. For example, one app may install the Redistributable from Visual Studio 2015. Then, another app installs the Redistributable from Visual Studio 2022. The 2022 version overwrites the older version, but because they're binary-compatible, the earlier app still works fine. We make sure the latest version of the Redistributable has all the newest features, security updates, and bug fixes. That's why we always recommend you upgrade to the latest available version. +We've kept the Microsoft Visual C++ Redistributable major version number the same for Visual Studio 2015, 2017, 2019, 2022, and 2026. That means only one instance of the Redistributable can be installed at a time. A newer version overwrites any older version that's already installed. For example, one app may install the Redistributable from Visual Studio 2015. Then, another app installs the Redistributable from Visual Studio 2026. The 2026 version overwrites the older version, but because they're binary-compatible, the earlier app still works fine. We make sure the latest version of the Redistributable has all the newest features, security updates, and bug fixes. That's why we always recommend you upgrade to the latest available version. -Similarly, you can't install an older Redistributable when a newer version is already installed. The installer reports an error if you try. You'll see an error like this if you install the 2017 or 2019 Redistributable on a machine that already has the 2022 version: +Similarly, you can't install an older Redistributable when a newer version is already installed. The installer reports an error if you try. For example, you'll see an error like this if you install the 2022 Redistributable on a machine that already has the 2026 version: ```Output 0x80070666 - Another version of this product is already installed. Installation of this version cannot continue. To configure or remove the existing version of this product, use Add/Remove Programs on the Control Panel. diff --git a/docs/porting/build-system-changes.md b/docs/porting/build-system-changes.md index bcd58b4a3d7..afde5d89f65 100644 --- a/docs/porting/build-system-changes.md +++ b/docs/porting/build-system-changes.md @@ -7,7 +7,7 @@ ms.assetid: e564d95f-a6cc-4d97-b57e-1a71daf66f4a --- # VCBuild vs. MSBuild: Build system changes in Visual Studio 2010 -The MSBuild system for C++ projects was introduced in Visual Studio 2010. In Visual Studio 2008 and earlier releases, the VCBuild system was used. Certain file types and concepts that depended on VCBuild either do not exist or are represented differently in MSBuild. This document discusses the differences in the current build system. To convert a Visual Studio 2008 project to MSBuild, you must use Visual Studio 2010. After the project is converted, you should use the latest version of Visual Studio to upgrade to the current IDE and compiler toolset. For more information, including how to obtain Visual Studio 2010, see [Instructions for Visual Studio 2008](use-native-multi-targeting.md#instructions-for-visual-studio-2008). +The MSBuild system for C++ projects was introduced in Visual Studio 2010. In Visual Studio 2008 and earlier releases, the VCBuild system was used. Certain file types and concepts that depended on VCBuild either do not exist or are represented differently in MSBuild. This document discusses the differences in the current build system. To convert a Visual Studio 2008 project to MSBuild, you must use Visual Studio 2010. After the project is converted, you should use the latest version of Visual Studio to upgrade to the current IDE and build tools. For more information, including how to obtain Visual Studio 2010, see [Instructions for Visual Studio 2008](use-native-multi-targeting.md#instructions-for-visual-studio-2008). The following sections summarize the changes from VCBuild to MSBuild. If your VCBuild project has custom build rules or macros that aren't recognized by MSBuild, see [Visual Studio Projects - C++](../build/creating-and-managing-visual-cpp-projects.md) to learn how to translate those instructions to the MSBuild system. The initial conversion from VCBuild to MSBuild is just an intermediate step. It isn't necessary to get the project file completely correct or to get the program to compile without errors. You are only using Visual Studio 2010 to convert the project to MSBuild format so that you get the project working in the latest version of Visual Studio. diff --git a/docs/porting/copilot-app-modernization-cpp.md b/docs/porting/copilot-app-modernization-cpp.md new file mode 100644 index 00000000000..d6e23461baf --- /dev/null +++ b/docs/porting/copilot-app-modernization-cpp.md @@ -0,0 +1,100 @@ +--- +title: "Modernize your C++ project with GitHub Copilot modernization" +description: "Instructions on effectively using GitHub Copilot modernization in your C++ projects" +ms.date: 03/12/2026 +ms.topic: upgrade-and-migration-article +author: michaelbprice +ms.author: miprice +--- + +# Using GitHub Copilot modernization for C++ + +GitHub Copilot modernization for C++ helps you upgrade C++ projects to newer MSVC Build Tools versions. If necessary, Copilot will upgrade your project's settings to use the latest MSVC, and then conduct a thorough assessment of the impact of those changes after executing a build. It develops a plan on how to address each identified problem. Once you approve the plan, the agent completes a sequence of tasks and validates that any changes resolved the identified problems. If there remains work to be done, the agent continues iterating until the problems are resolved or you discontinue the conversation. + +> [!NOTE] +> GitHub Copilot modernization for C++ is currently in preview. + +## Requirements + +- Visual Studio 2026 version 18.3 or later +- A GitHub Copilot account +- A MSBuild-based codebase (`.sln`, `.vcxproj`) OR a CMake-based codebase + +## Enable GitHub Copilot modernization for C++ + +GitHub Copilot modernization for C++ is enabled by default. To disable or explicitly enable the feature, follow these steps. + +1. From Visual Studio, select **Tools > Options...** to open the **Options** window. +1. Navigate to **All Settings > GitHub > Copilot > C/C++**. +1. Select (to enable) or clear (to disable) the checkbox for **Enable GitHub Copilot modernization for C++ (preview)**. +1. Restart Visual Studio for the setting change to take effect. + +:::image type="content" source="media/enable-copilot-app-modernization-cpp.png" alt-text="Screenshot of Visual Studio Options dialog. GitHub > Copilot > C/C++ settings are visible. The modernization for C++ checkbox is enabled." lightbox="media/enable-copilot-app-modernization-cpp.png"::: + +## Upgrade your codebase by using GitHub Copilot modernization for C++ + +This section describes how to start the Modernize agent and the stages it goes through to upgrade your codebase. + +### Start the Modernize agent + +GitHub Copilot modernization is an agent that operates inside the GitHub Copilot Chat window. You can start the agent in any of the following ways: + +- **From the Solution Explorer context menu**: Right-click on the solution or a loaded project in the Solution Explorer, and choose **Modernize** from the context menu. This automatically launches a GitHub Copilot Chat window, activates the Modernize agent, and provides you with relevant prompts to choose from to get you started. + +:::image type="content" source="media/copilot-app-modernization-context-menu.png" alt-text="Screenshot of Visual Studio Solution Explorer showing a right-click context menu with Modernize selected to start the Copilot agent."::: + +- **From GitHub Copilot Chat**: Open the GitHub Copilot Chat Window by selecting **View > GitHub Copilot Chat**. After the GitHub Copilot Chat window opens, mention `@Modernize` in a prompt to activate the Modernize agent. For example, type this prompt: + + `Use @Modernize to update MSVC Build Tools.` + +#### For MSBuild-based codebases targeting an earlier version of MSVC Build Tools + +The first time that you load a `.vcxproj` project that targets an earlier version of the MSVC Build Tools, you see an option to [upgrade project settings to use a newer version of the MSVC Build Tools](/visualstudio/install/setup-assistant). If you retarget any of your projects to a new version of MSVC Build Tools and GitHub Copilot modernization for C++ is enabled, you receive an infobar in Visual Studio prompting you to use GitHub Copilot modernization for C++ to resolve any newly introduced build problems. Selecting **Run GitHub Copilot modernization for C++** launches the GitHub Copilot Chat window, activates the Modernize agent, and provides you with relevant prompts to choose from to get you started. + +### Start the upgrade + +Once the Modernize agent is active, you can instruct it via a prompt to upgrade your MSVC Build Tools, or select the already constructed prompt from the list shown in the window. If you launched the agent directly in the GitHub Copilot Chat window by mentioning `@Modernize` in your prompt, you probably don't need to provide more prompting. + +:::row::: +:::column::: + +**MSBuild Projects** + +:::column-end::: +:::column::: + +**CMake Projects** + +:::column-end::: +:::row-end::: +:::row::: +:::column::: + +:::image type="content" source="media/app-modernization-msbuild-ice-breaker.png" alt-text="Screenshot of GitHub Copilot Chat window. The dropdown is set to Modernize experience and Upgrade MSVC Build Tools to the latest version is highlighted."::: + +:::column-end::: +:::column::: + +:::image type="content" source="media/app-modernization-cmake-ice-breaker.png" alt-text="Screenshot of GitHub Copilot Chat window. The dropdown is set to Modernize experience and Resolve build issues by migrating to modern alternatives is highlighted."::: + +:::column-end::: +:::row-end::: + + +### Assessment stage + +The agent first assesses what kinds of problems show up after upgrading. If you didn't already upgrade the project, the agent guides you through that process before creating its assessment. After ensuring that your project is upgraded, the agent builds your codebase, analyzes the reported warnings and errors, and generates an `assessment.md` file that describes the problems that it found, their severity, and other useful information. This is your opportunity to tell the agent any other context that could help it make a plan. + +One of the things you might choose to do here is to tell the agent not to fix certain discovered problems, because you know that resolving them involves some strategic decisions or because they were preexisting warnings that you decided are acceptable for your project. You should carefully read through the plan, making sure to provide that extra context where it is needed. Once you approve the assessment, the agent moves on to creating a concrete plan on addressing the problems. + +### Planning stage + +Based on the approved assessment and any other context or instructions you provide, the agent creates a `plan.md` file that proposes a detailed plan for resolving each of the identified problems. If the agent produces a plan that doesn't match your organization's coding style or practices, you can provide that guidance to the agent and have it solve the problem differently. After you agree on the plan, the agent moves to the execution stage. + +### Execution stage + +Now that the agent has a plan, it breaks down the necessary tasks to execute the plan. You can define these tasks as finely as you want. The tasks can even include steps to work on a branch or to commit specific changes together in the same commit. After making any changes, the agent builds the project again to confirm that the problems are resolved. If the problems aren't resolved, the agent iterates with you until they're resolved to your satisfaction. + +### Post-upgrade validation + +When the agent finishes, run the changes through any testing infrastructure you have. Have a colleague review the changes in a pull request. Since this feature is currently in preview, you might receive an infobar to complete a product survey to let the product team know how the agent performed on your codebase. The product team looks forward to hearing how they can improve the agent to solve your problems and accelerate your upgrade and modernization efforts. \ No newline at end of file diff --git a/docs/porting/features-deprecated-in-visual-studio.md b/docs/porting/features-deprecated-in-visual-studio.md index 71383dbc034..21848bb9152 100644 --- a/docs/porting/features-deprecated-in-visual-studio.md +++ b/docs/porting/features-deprecated-in-visual-studio.md @@ -1,21 +1,61 @@ --- -description: "Learn more about: C++ features deprecated in Visual Studio" -title: "C++ features deprecated in Visual Studio" -ms.date: 04/07/2022 -helpviewer_keywords: ["Features deprecated in Visual Studio"] +description: "Learn more about: C++ features deprecated or removed from Visual Studio" +title: "C++ features deprecated or removed from Visual Studio" +ms.date: 05/11/2026 +helpviewer_keywords: ["Features deprecated or removed from Visual Studio"] --- -# C++ features deprecated in Visual Studio +# C++ features deprecated or removed from Visual Studio -This article is a non-exhaustive list of C++ features deprecated in Visual Studio 2019 and 2022. For information on breaking changes and conformance improvements for C++ in the latest version of Visual Studio, see [C++ conformance improvements in Visual Studio](../overview/cpp-conformance-improvements.md). +This article is a nonexhaustive list of C++ features deprecated or removed from Visual Studio 2019 and later. For information on breaking changes and conformance improvements for C++ in the latest version of Visual Studio, see [C++ conformance improvements in Visual Studio](../overview/cpp-conformance-improvements.md). -## Deprecated in Visual Studio 2019 +### Support for Windows XP development -- Support for Windows XP development +Visual Studio 2019 and later versions don't include current build tools support for creating code for Windows XP. Support for Windows XP development by using the v141_xp build tools that shipped in Visual Studio 2017 is still available as an optional component in the Visual Studio Installer. For information on how to install the v141_xp Windows XP platform toolset, see [Configuring programs for Windows XP](../build/configuring-programs-for-windows-xp.md). - Visual Studio 2019 and later versions don't include current toolset support for creating code for Windows XP. Support for Windows XP development by using the v141_xp toolset that shipped in Visual Studio 2017 is still available as an optional component in the Visual Studio Installer. For information on how to install the v141_xp Windows XP platform toolset, see [Configuring programs for Windows XP](../build/configuring-programs-for-windows-xp.md). +## Visual Studio 2026 (MSVC 14.51) -## Deprecated in Visual Studio 2022 +- The following experimental coroutine headers are now deprecated: ``, ``, and ``. Transition to standard C++20 coroutines using the `` header. -- Support for project upgrade from Visual C++ 6 - - Visual Studio 2022 and later versions don't support upgrades from Visual C++ 6 Workspace (*`.dsw`*) and Project (*`.dsp`*) files. Visual Studio no longer registers the *`.dsw`* and *`.dsp`* file extensions as Visual Studio file types. To upgrade a project with these extensions, first use Visual Studio 2019 to upgrade the project to modern Solution (*`.sln`*) and C++ Project (*`.vcxproj`*) files. Then use the current version of Visual Studio to upgrade the project again. +### Removed features + +The following long-deprecated non-Standard features are removed: + +- **TR1** including the `std::tr1` namespace, old `array::assign()`, and old `` engines and distributions. Deprecated since VS 2017 15.5 (December 2017). +- **`_ALLOW_RTCc_IN_STL`** macro removed. The Standard Template Library doesn't support the `/RTCc` compiler option, but `/RTCs` and `/RTCu`/`/RTC1` remain supported. +- **`` and ``**. Deprecated since VS 2015 (July 2015). +- **``**. Deprecated since VS 2019 16.3 (September 2019). +- **`stdext::checked_array_iterator` and `stdext::unchecked_array_iterator`**. Deprecated since VS 2022 17.8 (November 2023) for C++17 and later. +- **`basic_istream::ipfx()`/`isfx()` and `basic_ostream::opfx()`/`osfx()`**. Deprecated since VS 2022 17.9 (February 2024) for C++17 and later. +- **`locale::empty()`**. Deprecated since VS 2022 17.14 (May 2025). + +## Visual Studio 2022 + +### Support for project upgrade from Visual C++ 6 + +Visual Studio 2022 and later versions don't support upgrades from Visual C++ 6 Workspace (*`.dsw`*) and Project (*`.dsp`*) files. Visual Studio no longer registers the *`.dsw`* and *`.dsp`* file extensions as Visual Studio file types. To upgrade a project with these extensions, first use Visual Studio 2019 to upgrade the project to modern Solution (*`.sln`*) and C++ Project (*`.vcxproj`*) files. Then upgrade the project again using the current version of Visual Studio. + +## Visual Studio 2026 + +### Support for C++AMP, ARM32 toolchain, and `/DEBUG:FASTLINK` + +Visual Studio 2026 and later versions don't support C++AMP, the ARM32 toolchain, and /DEBUG:FASTLINK. If you're utilizing `/DEBUG:FASTLINK`, switch to [`/DEBUG:FULL`](/cpp/build/reference/debug-generate-debug-info) for improved debugging support. Developers needing to target ARM32 can continue using the Visual Studio 2022 v143 build tools as detailed in this [Microsoft blog post](https://devblogs.microsoft.com/cppblog/side-by-side-minor-version-msvc-toolsets-in-visual-studio-2019/). + +### Deprecation of `/await` + +The MSVC compiler switch `/await` is being deprecated and will be removed in a future release. This switch enabled an early draft implementation of C++ coroutines using the `` header. Developers should transition to standard C++ coroutines by using the `` header available in C++20 and later. For C++14/17 projects, use `/await:strict` (which isn't being deprecated) to access the standard `` header without enabling other C++20 features. + +### Support for Windows 7, 8, and 8.1 for Microsoft C++ Build Tools + +In Visual Studio 2026, the Microsoft C++ (MSVC) Build Tools raised the minimum supported operating system requirements. With this release, the Build Tools no longer target: + +- Windows 7 / Windows Server 2008 R2 +- Windows 8 / Windows Server 2012 +- Windows 8.1 / Windows Server 2012 R2 + +To build applications using the latest C++ tools, your target platform must be **Windows 10** or **Windows Server 2016** (or later). + +These changes allow for better performance, enhanced security, and alignment with the most recent Windows platform capabilities. + +### Support for Mobile development with C++ and Embedded and IoT tools + +Starting with Visual Studio 2026 (version 18.0), the **Mobile development with C++** workload for iOS and Android targeting in the Visual Studio installer and the **Embedded and IoT tools**--including RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import--are no longer supported and will be removed in a future update. However, the Android NDKs listed in the Mobile development with C++ workload continue to be supported. diff --git a/docs/porting/floating-point-migration-issues.md b/docs/porting/floating-point-migration-issues.md index c35a83ae9c3..6393e435c75 100644 --- a/docs/porting/floating-point-migration-issues.md +++ b/docs/porting/floating-point-migration-issues.md @@ -2,27 +2,26 @@ description: "Learn more about: Floating-point migration issues" title: "Floating-point migration issues" ms.date: "05/17/2017" -ms.assetid: 36a1b552-2f2b-4919-bc9d-c17f42434954 --- # Floating-point migration issues -Sometimes when you upgrade your projects to a newer version of Visual Studio, you may find that the results of certain floating-point operations have changed. This generally happens for one of two reasons: Code generation changes that take better advantage of the available processor, and bug fixes or changes to the algorithms used in math functions in the C runtime library (CRT). In general, the new results are correct to within the limits specified by the language standard. Read on to find out what's changed, and if it's important, how to get the same results your functions got before. +Sometimes when you upgrade your projects to a newer version of Visual Studio, you may notice changes in the results of certain floating-point operations. This generally happens for one of two reasons: Code generation changes that take better advantage of the available processor, and bug fixes or changes to the algorithms used in math functions in the C runtime library (CRT). In general, the new results are correct to within the limits specified by the language standard. Read on to find out what's changed, and if it's important, how to get the same results your functions got before. ## New math functions and Universal CRT changes -Most CRT math functions have been available in Visual Studio for years, but starting in Visual Studio 2013, all of the functions required by ISO C99 are included. These functions are implemented to balance performance with correctness. Because producing the correctly rounded result in every case may be prohibitively expensive, these functions are designed to efficiently produce a close approximation to the correctly rounded result. In most cases, the result produced is within +/-1 unit of least precision, or *ulp*, of the correctly rounded result, though there may be cases where there is greater inaccuracy. If you were using a different math library to get these functions before, implementation differences may be responsible for the change in your results. +Most CRT math functions have been available in Visual Studio for years, but starting in Visual Studio 2013, all of the functions required by ISO C99 are included. These functions are implemented to balance performance with correctness. Because producing the correctly rounded result in every case may be prohibitively expensive, these functions are designed to efficiently produce a close approximation to the correctly rounded result. In most cases, the result produced is within +/-1 unit of least precision, or *ulp*, of the correctly rounded result, though there may be cases where there's greater inaccuracy. If you used a different math library to obtain these functions earlier, implementation differences might explain the change in your results. -When the math functions were moved to the Universal CRT in Visual Studio 2015, some new algorithms were used, and several bugs in the implementation of the functions that were new in Visual Studio 2013 were fixed. These changes can lead to detectable differences in the results of floating-point calculations that use these functions. The functions that had bug issues were erf, exp2, remainder, remquo, scalbln, and scalbn, and their float and long double variants. Other changes in Visual Studio 2015 fixed issues in preserving floating point status word and exception state information in _clear87, _clearfp, fegetenv, fesetenv, and feholdexcept functions. +When the math functions were moved to the Universal CRT in Visual Studio 2015, some new algorithms were used, and several bugs in the implementation of the functions that were new in Visual Studio 2013 were fixed. These changes can lead to detectable differences in the results of floating-point calculations that use these functions. The functions that had bug issues were `erf`, `exp2`, `remainder`, `remquo`, `scalbln`, and `scalbn`, and their float and long double variants. Other changes in Visual Studio 2015 fixed issues in preserving floating point status word and exception state information in `_clear87`, `_clearfp`, `fegetenv`, `fesetenv`, and `feholdexcept` functions. ## Processor differences and compiler flags -Many of the floating point math library functions have different implementations for different CPU architectures. For example, the 32-bit x86 CRT may have a different implementation than the 64-bit x64 CRT. In addition, some of the functions may have multiple implementations for a given CPU architecture. The most efficient implementation is selected dynamically at run-time depending on the instruction sets supported by the CPU. For example, in the 32-bit x86 CRT, some functions have both an x87 implementation and an SSE2 implementation. When running on a CPU that supports SSE2, the faster SSE2 implementation is used. When running on a CPU that does not support SSE2, the slower x87 implementation is used. You may see this when migrating old code, because the default x86 compiler architecture option changed to [/arch:SSE2](../build/reference/arch-x86.md) in Visual Studio 2012. Because different implementations of the math library functions may use different CPU instructions and different algorithms to produce their results, the functions may produce different results on different platforms. In most cases, the results are within +/-1 ulp of the correctly rounded result, but the actual results may vary across CPUs. +Many of the floating point math library functions have different implementations for different CPU architectures. For example, the 32-bit x86 CRT may have a different implementation than the 64-bit x64 CRT. In addition, some of the functions may have multiple implementations for a given CPU architecture. The most efficient implementation is selected dynamically at run-time depending on the instruction sets supported by the CPU. For example, in the 32-bit x86 CRT, some functions have both an x87 implementation and an SSE2 implementation. When running on a CPU that supports SSE2, the faster SSE2 implementation is used. When running on a CPU that doesn't support SSE2, the slower x87 implementation is used. You may see this when migrating old code, because the default x86 compiler architecture option changed to [/arch:SSE2](../build/reference/arch-x86.md) in Visual Studio 2012. Because different implementations of the math library functions may use different CPU instructions and different algorithms to produce their results, the functions may produce different results on different platforms. In most cases, the results are within +/-1 ulp of the correctly rounded result, but the actual results may vary across CPUs. -Code-generation correctness improvements in different floating point modes in Visual Studio can also affect the results of floating-point operations when old code is compared to new code, even when using the same compiler flags. For example, the code generated by Visual Studio 2010 when [/fp:precise](../build/reference/fp-specify-floating-point-behavior.md) (the default) or `/fp:strict` was specified may not have propagated intermediate not-a-number (NaN) values through expressions correctly. Thus, some expressions that gave a numeric result in older compilers may now correctly produce a NaN result. You may also see differences because the code optimizations enabled for `/fp:fast` now take advantage of more processor features. These optimizations can use fewer instructions, but may impact the generated results because some previously visible intermediate operations have been removed. +Code-generation improvements in various floating-point modes can also alter floating-point results when comparing old code to new code, even with identical compiler flags. For example, the code generated by Visual Studio 2010 when [/fp:precise](../build/reference/fp-specify-floating-point-behavior.md) (the default) or `/fp:strict` was specified might not propagate intermediate not-a-number (NaN) values through expressions correctly. Thus, some expressions that gave a numeric result in older compilers may now correctly produce a NaN result. You may also see differences because the code optimizations enabled for `/fp:fast` now take advantage of more processor features. These optimizations can use fewer instructions, but may impact the generated results because some previously visible intermediate operations have been removed. ## How to get identical results -In most cases, the floating-point changes in the newest compilers and libraries result in faster or more correct behavior, or both. You may even see better processor power performance when SSE2 instructions replace x87 instructions. However, if you have code that must precisely replicate the floating point behavior of an older compiler, consider using Visual Studio native multi-targeting capabilities, and build the affected project with the older toolset. For more information, see [Use native multi-targeting in Visual Studio to build old projects](use-native-multi-targeting.md). +In most cases, the floating-point changes in the newest compilers and libraries result in faster or more correct behavior, or both. You may even see better processor power performance when SSE2 instructions replace x87 instructions. However, if you have code that must precisely replicate the floating point behavior of an older compiler, consider using Visual Studio native multi-targeting capabilities, and build the affected project with the older build tools. For more information, see [Use native multi-targeting in Visual Studio to build old projects](use-native-multi-targeting.md). ## See also diff --git a/docs/porting/ide-tools-for-upgrading-code.md b/docs/porting/ide-tools-for-upgrading-code.md index 13f9f48a5f4..f94f44ac1cb 100644 --- a/docs/porting/ide-tools-for-upgrading-code.md +++ b/docs/porting/ide-tools-for-upgrading-code.md @@ -1,14 +1,14 @@ --- title: "Visual Studio IDE tools for upgrading C++ code" description: "The C++ code editor and code analysis tools in Visual Studio help you to modernize your C++ code base." -ms.date: "11/13/2019" +ms.date: "11/06/2025" ms.topic: "concept-article" --- # Visual Studio IDE tools for upgrading C++ code Visual Studio helps you upgrade legacy C++ code with compiler options, code analysis warnings, and editor features such as Quick Fixes, Quick Info, and the enhanced scroll bar. The term "legacy code" refers to any of these categories: -- Code that was formerly allowed by the Microsoft C++ compiler (MSVC) but never conformed to the C++ standard. +- Code that was formerly allowed by the Microsoft C++ (MSVC) compiler but never conformed to the C++ standard. To upgrade older non-conforming MSVC code, turn on the [`/permissive-`](../build/reference/permissive-standards-conformance.md) compiler option. All instances of non-conforming usages are underlined with red squiggles in the code editor. The error messages in the **Error List** window include a recommendation for how to fix the error. Click on the error code to go to its help page in the documentation. If fixing all the errors at once is impractical, you can upgrade non-conforming code in stages by turning on the **`/permissive-`** option, fixing some errors, then turning the option off again. The code will compile with the new improvements, and you can go back and fix the remaining issues at a later time. See the [`/permissive-`](../build/reference/permissive-standards-conformance.md) page for examples of non-conforming MSVC code. @@ -22,19 +22,15 @@ Visual Studio helps you upgrade legacy C++ code with compiler options, code anal ## Open and convert a legacy project -If your legacy project is based on an older version of Visual Studio, you can open it in Visual Studio 2017 or Visual Studio 2019. Visual Studio automatically converts it to the current project schema with support for all the latest compiler and IDE features. +If your legacy projects are based on an older version of Visual Studio, you can still load them in a newer version and work on it there while maintaining backwards compatibility with the older version. When you are ready to permanently move to the new version of Visual Studio, you can retarget your projects. This will enable you to use the latest build tools and project features in the IDE, but you will no longer be able to load the retargeted projects in the older version of Visual Studio. -![Screenshot of the Upgrade a project dialog.](media/upgrade-dialog-v142.png "Upgrade a project") +To retarget projects to the Visual Studio 2026 format, you can use the setup assistant which appears the first time you open a solution containing older projects. You can also access it by right-clicking the solution in **Solution Explorer** and selecting **Retarget solution**. -For more information, see [Upgrade C++ projects from earlier versions of Visual Studio](upgrading-projects-from-earlier-versions-of-visual-cpp.md). - -## Search the code base +![Screenshot of the Visual Studio 2026 setup assistant showing a list of projects selected for retargeting to the latest MSVC Build Tools and v145 Platform Toolset.](media/vs-2026-setup-assistant.png "Upgrade projects") -Upgrading a code base often involves searching through multiple files. To search for anything in your code base, press **Ctrl+T** to bring up the **Go to All** search box. +The setup assistant then gives you the choice to either stay on the older version and install any missing build tools or Windows SDKs necessary to build, or retarget the projects to upgrade them. You can make retargeting selections for each project in the solution or select **Retarget all** > **Apply** to upgrade. -![Screenshot of the Go to all dialog.](media/go-to-all.png "Go to all") - -To narrow the search scope, type one of the 1-letter filters, followed by a space and then the thing you are looking for. +For more information, see [Upgrade C++ projects from earlier versions of Visual Studio](upgrading-projects-from-earlier-versions-of-visual-cpp.md). ## Error List diff --git a/docs/porting/introduction-to-visual-cpp-for-unix-users.md b/docs/porting/introduction-to-visual-cpp-for-unix-users.md index 4aa29e40e1a..e70d60b5806 100644 --- a/docs/porting/introduction-to-visual-cpp-for-unix-users.md +++ b/docs/porting/introduction-to-visual-cpp-for-unix-users.md @@ -3,13 +3,15 @@ description: "Learn more about: Introduction to Microsoft C++ for UNIX Users" title: "Introduction to Microsoft C++ for UNIX Users" ms.date: 06/22/2021 helpviewer_keywords: ["UNIX [C++]"] -ms.assetid: 36108b31-e7fa-49a8-a1f7-7077fcbec873 ms.topic: concept-article --- # Introduction to Microsoft C++ for UNIX Users This topic provides information for users of all flavors of UNIX who are new to Visual Studio and want to become productive with C++ either from the command line or by using Visual Studio. You can use Visual Studio with the Microsoft C++ compiler to target Windows. You can also use the Visual Studio IDE with GCC or Clang in UNIX environments such as remote Linux machines, MinGW-w64, and Windows Subsystem for Linux. To use C++ in Visual Studio, the **Desktop Development with C++** workload must be installed. Open the Visual Studio Installer to install the workload or add or remove optional components. Also install the **Linux Development with C++** workload if you'll be targeting a remote Linux machine. For Android or iOS development, install the **Mobile Development with C++** workload. +> [!IMPORTANT] +> Starting with Visual Studio 2026 (version 18.0), the Mobile development with C++ workload for iOS and Android, as well as the Embedded and IoT tools (RTOS Viewer, Serial Monitor, Peripheral Viewer, and ST Project Import), are no longer supported and will be removed in a future update. The Android NDKs included in the Mobile development with C++ workload remain supported. + ## Getting started on the command line You can use the Microsoft C++ compiler from the command line in a similar way that you would use a UNIX command-line environment. You compile from the command prompt by using the command-line C and C++ compiler (CL.EXE), linker (LINK.EXE), and other tools, including NMAKE.EXE, the Microsoft version of the UNIX make utility. diff --git a/docs/porting/media/app-modernization-cmake-ice-breaker.png b/docs/porting/media/app-modernization-cmake-ice-breaker.png new file mode 100644 index 00000000000..676e21dbbc5 Binary files /dev/null and b/docs/porting/media/app-modernization-cmake-ice-breaker.png differ diff --git a/docs/porting/media/app-modernization-msbuild-ice-breaker.png b/docs/porting/media/app-modernization-msbuild-ice-breaker.png new file mode 100644 index 00000000000..0820fec37c1 Binary files /dev/null and b/docs/porting/media/app-modernization-msbuild-ice-breaker.png differ diff --git a/docs/porting/media/copilot-app-modernization-context-menu.png b/docs/porting/media/copilot-app-modernization-context-menu.png new file mode 100644 index 00000000000..9b671eadc33 Binary files /dev/null and b/docs/porting/media/copilot-app-modernization-context-menu.png differ diff --git a/docs/porting/media/enable-copilot-app-modernization-cpp.png b/docs/porting/media/enable-copilot-app-modernization-cpp.png new file mode 100644 index 00000000000..2a9c9601913 Binary files /dev/null and b/docs/porting/media/enable-copilot-app-modernization-cpp.png differ diff --git a/docs/porting/media/upgrade-cpp.png b/docs/porting/media/upgrade-cpp.png new file mode 100644 index 00000000000..02870caa060 Binary files /dev/null and b/docs/porting/media/upgrade-cpp.png differ diff --git a/docs/porting/media/vs-2026-setup-assistant.png b/docs/porting/media/vs-2026-setup-assistant.png new file mode 100644 index 00000000000..85fe9817386 Binary files /dev/null and b/docs/porting/media/vs-2026-setup-assistant.png differ diff --git a/docs/porting/modifying-winver-and-win32-winnt.md b/docs/porting/modifying-winver-and-win32-winnt.md index 69ac9a1e52e..79fb1051490 100644 --- a/docs/porting/modifying-winver-and-win32-winnt.md +++ b/docs/porting/modifying-winver-and-win32-winnt.md @@ -8,7 +8,7 @@ ms.topic: how-to --- # Update WINVER and _WIN32_WINNT -When you use the Windows SDK, you can specify which versions of Windows your code can run on. The preprocessor macros **WINVER** and **_WIN32_WINNT** specify the minimum operating system version your code supports. Visual Studio and the Microsoft C++ compiler support targeting Windows 7 SP1 and later. Older toolsets include support for Windows XP SP2, Windows Server 2003 SP1, Vista, and Windows Server 2008. Windows 95, Windows 98, Windows ME, Windows NT, and Windows 2000 are unsupported. +When you use the Windows SDK, you can specify which versions of Windows your code can run on. The preprocessor macros **WINVER** and **_WIN32_WINNT** specify the minimum operating system version your code supports. Visual Studio and the Microsoft C++ compiler support targeting Windows 7 SP1 and later. Older build tools include support for Windows XP SP2, Windows Server 2003 SP1, Vista, and Windows Server 2008. Windows 95, Windows 98, Windows ME, Windows NT, and Windows 2000 are unsupported. When you upgrade an older project, you may need to update your **WINVER** or **_WIN32_WINNT** macros. If they're assigned values for an unsupported version of Windows, you may see compilation errors related to these macros. diff --git a/docs/porting/overview-of-potential-upgrade-issues-visual-cpp.md b/docs/porting/overview-of-potential-upgrade-issues-visual-cpp.md index fbae3e758a8..49014006de0 100644 --- a/docs/porting/overview-of-potential-upgrade-issues-visual-cpp.md +++ b/docs/porting/overview-of-potential-upgrade-issues-visual-cpp.md @@ -1,41 +1,41 @@ --- -description: "Learn more about: Overview of potential upgrade issues (Visual C++)" -title: "Overview of potential upgrade issues (Visual C++)" -ms.date: 10/22/2021 +description: "Learn more about: Overview of potential upgrade issues (Microsoft C++)" +title: "Overview of potential upgrade issues (Microsoft C++)" +ms.date: 10/29/2025 ms.assetid: 2c99a8cb-098f-4a9d-bf2c-b80fd06ace43 ms.topic: upgrade-and-migration-article --- -# Overview of potential upgrade issues (Visual C++) +# Overview of potential upgrade issues (Microsoft C++) -Over the years, the Microsoft C++ compiler has undergone many changes, along with changes in the C++ language itself, the C++ Standard Library, the C runtime (CRT), and other libraries such as MFC and ATL. As a result, when you upgrade an application from an earlier version of Visual Studio you might see compiler and linker errors and warnings in code that previously compiled cleanly. The older the original code base, the greater the potential for such errors. This overview summarizes the most common classes of issues you're likely to see, and provides links to more detailed information. +Over the years, the Microsoft C++ (MSVC) compiler has undergone many changes, along with changes in the C++ language itself, the C++ Standard Library (STL), the C runtime (CRT), and other libraries such as MFC and ATL. As a result, when you upgrade an application from an earlier version of Visual Studio you might see compiler and linker errors and warnings in code that previously compiled cleanly. The older the original code base, the greater the potential for such errors. This overview summarizes the most common classes of issues you're likely to see, and provides links to more detailed information. > [!NOTE] > In the past, we've recommended that upgrades that span several versions of Visual Studio should be performed incrementally one version at a time. We no longer recommend this approach. We've found that it's almost always simpler to upgrade to the most current version of Visual Studio no matter how old the code base. Questions or comments about the upgrade process can be sent to vcupgrade@microsoft.com. -## Library and toolset dependencies +## Library and build tools dependencies > [!NOTE] -> This section applies to applications and libraries built with Visual Studio 2013 and earlier. The toolsets used in Visual Studio 2015, Visual Studio 2017 and Visual Studio 2019 are binary compatible. For more information, see [C++ Binary Compatibility between Visual Studio versions](binary-compat-2015-2017.md). +> This section applies to applications and libraries built with Visual Studio 2013 and earlier. The build tools used in Visual Studio 2015, Visual Studio 2017 and Visual Studio 2019 are binary compatible. For more information, see [C++ Binary Compatibility between Visual Studio versions](binary-compat-2015-2017.md). When you upgrade an app from Visual Studio 2013 or before to a newer version, it's often both advisable and necessary to upgrade all libraries and DLLs the app links to. Either you must have access to the source code, or the library vendor must provide new binary files compiled with the same major version of the compiler. If one of these conditions is true, then you can skip this section, which deals with the details of binary compatibility. If neither is the case, then the libraries might not work in your upgraded app. The information in this section will help you understand whether you can continue with the upgrade. -### Toolset +### Build tools -The *`.obj`* and *`.lib`* file formats are well defined and rarely change. Sometimes additions are made to these file formats, but these additions generally don't affect the ability of newer toolsets to consume object files and libraries produced by older toolsets. The major exception is if you compile using [`/GL` (Whole Program Optimization)](../build/reference/gl-whole-program-optimization.md). If you compile using `/GL`, you can only link the resulting object file by using the same toolset that was used to produce it. So, if you produce an object file with `/GL` and use a Visual Studio 2017 (v141) compiler, you must link it using the Visual Studio 2017 (v141) linker. It's because the internal data structures within the object files aren't stable across major versions of the toolset. Newer toolsets don't understand the older data formats. +The *`.obj`* and *`.lib`* file formats are well defined and rarely change. Sometimes additions are made to these file formats, but these additions generally don't affect the ability of newer build tools to consume object files and libraries produced by older build tools. The major exception is if you compile using [`/GL` (Whole Program Optimization)](../build/reference/gl-whole-program-optimization.md). If you compile using `/GL`, you can only link the resulting object file by using the same build tools that were used to produce it. So, if you produce an object file with `/GL` and use a Visual Studio 2017 (v141) compiler, you must link it using the Visual Studio 2017 (v141) linker. It's because the internal data structures within the object files aren't stable across major versions of the build tools. Newer build tools don't understand the older data formats. -C++ doesn't have a stable application binary interface (ABI). But Visual Studio maintains a stable C++ ABI for all minor versions of a release. Visual Studio 2015 (v140), Visual Studio 2017 (v141), Visual Studio 2019 (v142), and Visual Studio 2022 (v143) toolsets vary only in their minor version. They all have the same major version number, which is 14. For more information, see [C++ Binary Compatibility between Visual Studio versions](binary-compat-2015-2017.md). +C++ doesn't have a stable application binary interface (ABI). But Visual Studio maintains a stable C++ ABI for all minor versions of a release. Visual Studio 2015 (v140), Visual Studio 2017 (v141), Visual Studio 2019 (v142), Visual Studio 2022 (v143), and Visual Studio 2026 (v145) build tools vary only in their minor version. They all have the same major version number, which is 14. For more information, see [C++ Binary Compatibility between Visual Studio versions](binary-compat-2015-2017.md). -If you have an object file that has external symbols with C++ linkage, that object file may not link correctly with object files produced by a different major version of the toolset. There are many possible outcomes: the link might fail entirely (for example, if name decoration changed). The link could succeed, but the app could fail at runtime (for example, if type layouts changed). Or your app might continue to work and nothing will go wrong. Also note, while the C++ ABI isn't stable, the C ABI and the subset of the C++ ABI required for COM are stable. +If you have an object file that has external symbols with C++ linkage, that object file may not link correctly with object files produced by a different major version of the build tools. There are many possible outcomes: the link might fail entirely (for example, if name decoration changed). The link could succeed, but the app could fail at runtime (for example, if type layouts changed). Or your app might continue to work and nothing will go wrong. Also note, while the C++ ABI isn't stable, the C ABI and the subset of the C++ ABI required for COM are stable. -If you link to an import library, any later version of the Visual Studio redistributable libraries that preserve ABI compatibility may be used at runtime. For example, if you compile and link your app by using the Visual Studio 2015 Update 3 toolset, you can use any later redistributable. That's because the 2015, 2017, 2019, and 2022 libraries have preserved backward binary compatibility. The reverse isn't true: You can't use a redistributable for an earlier version of the toolset than you used to build any component of your code. +If you link to an import library, any later version of the Visual Studio redistributable libraries that preserve ABI compatibility may be used at runtime. For example, if you compile and link your app by using the Visual Studio 2015 Update 3 build tools, you can use any later redistributable. That's because the 2015, 2017, 2019, 2022, and 2026 libraries have preserved backward binary compatibility. The reverse isn't true: You can't use a redistributable for an earlier version of the build tools than you used to build any component of your code. ### Libraries If you `#include` a particular version of the header files, you must link the resulting object file to the same version of the libraries. So, for example, if your source file includes the Visual Studio 2015 Update 3 ``, you must link with the Visual Studio 2015 Update 3 *`vcruntime`* library. Similarly, if your source file includes the Visual Studio 2017 version 15.5 ``, you must link with the Visual Studio 2017 version 15.5 Standard C++ library, *`msvcprt`*. Mixing-and-matching isn't supported. -For the C++ Standard Library, mixing-and-matching has been explicitly disallowed by use of `#pragma detect_mismatch` in the standard headers since Visual Studio 2010. If you try to link incompatible object files, or if you link with the wrong standard library, the link fails. +For the Microsoft C++ Standard Library (STL), mixing-and-matching has been explicitly disallowed by use of `#pragma detect_mismatch` in the standard headers since Visual Studio 2010. If you try to link incompatible object files, or if you link with the wrong standard library, the link fails. Older CRT version mixing-and-matching was never supported, but it often just worked because the API surface didn't change much over time. The Universal CRT broke backwards compatibility so that in the future we can maintain backwards compatibility. We have no plans to introduce new, versioned Universal CRT binaries in the future. Instead, the existing Universal CRT is now updated in-place. @@ -47,7 +47,7 @@ If you have a static library built by using an older version of the C Runtime he 1. If you can't (or don't want to) rebuild the static library, you may try linking with *`legacy_stdio_definitions.lib`*. If it satisfies the link-time dependencies of your static library, you'll want to thoroughly test the static library as it's used in the binary. Make sure it isn't adversely affected by any of the [behavioral changes that were made to the Universal CRT](visual-cpp-change-history-2003-2015.md#BK_CRT). -1. Perhaps your static library's dependencies aren't satisfied by *`legacy_stdio_definitions.lib`* or the library doesn't work with the Universal CRT because of behavior changes. In this case, we recommend you encapsulate your static library into a DLL that you link with the required version of the Microsoft C Runtime. For example, if the static library was built using Visual Studio 2013, build this DLL using the Visual Studio 2013 toolset and C++ libraries as well. By building the library into a DLL, you encapsulate the implementation detail that is its dependency on a particular version of the Microsoft C Runtime. Be careful the DLL interface doesn't leak details of which C Runtime it uses, for example, if it returns a `FILE*` across the DLL boundary, or a `malloc`-allocated pointer the caller must `free`. +1. Perhaps your static library's dependencies aren't satisfied by *`legacy_stdio_definitions.lib`* or the library doesn't work with the Universal CRT because of behavior changes. In this case, we recommend you encapsulate your static library into a DLL that you link with the required version of the Microsoft C Runtime. For example, if the static library was built using Visual Studio 2013, build this DLL using the Visual Studio 2013 build tools and C++ libraries as well. By building the library into a DLL, you encapsulate the implementation detail that is its dependency on a particular version of the Microsoft C Runtime. Be careful the DLL interface doesn't leak details of which C Runtime it uses, for example, if it returns a `FILE*` across the DLL boundary, or a `malloc`-allocated pointer the caller must `free`. Use of multiple CRTs in a single process isn't in and of itself problematic. (In fact, most processes load multiple CRT DLLs. For example, Windows operating system components depend on *`msvcrt.dll`*, and the CLR depends on its own private CRT.) Problems arise when you jumble state from different CRTs. For example, you shouldn't allocate memory using `msvcr110.dll!malloc` and attempt to deallocate that memory using `msvcr120.dll!free`, and you shouldn't attempt to open a FILE using `msvcr110!fopen` and attempt to read from that FILE using `msvcr120!fread`. As long as you don't jumble state from different CRTs, you can safely have multiple CRTs loaded in a single process. @@ -72,7 +72,7 @@ For unresolved symbols, you might need to fix up your project settings. - If the external is defined in a *`.lib`* file, have you specified the lib path in the project properties, and is the correct version of the *`.lib`* file located there? -- Are you attempting to link to a *`.lib`* file that was compiled with a different version of Visual Studio? If so, see the previous section on library and toolset dependencies. +- Are you attempting to link to a *`.lib`* file that was compiled with a different version of Visual Studio? If so, see the previous section on library and build tools dependencies. - Do the types of the arguments at the call site actually match an existing overload of the function? Verify the underlying types are what you expect, both for any typedefs in the function's signature and in the code that calls the function. @@ -155,7 +155,7 @@ Windows API documentation lists the minimum or maximum supported operating syste ### Windows version -When upgrading a program that uses the Windows API either directly or indirectly, you need to decide the minimum Windows version to support. In most cases, Windows 7 is a good choice. For more information, see [Header file problems](porting-guide-spy-increment.md#header_file_problems). The `WINVER` macro defines the oldest version of Windows that your program is designed to run on. If your MFC program sets `WINVER` to 0x0501 (Windows XP) you'll get a warning because MFC no longer supports XP, even if the compiler toolset itself has an XP mode. Compiler toolset support for Windows XP ended in Visual Studio 2017. +When upgrading a program that uses the Windows API either directly or indirectly, you need to decide the minimum Windows version to support. In most cases, Windows 7 is a good choice. For more information, see [Header file problems](porting-guide-spy-increment.md#header_file_problems). The `WINVER` macro defines the oldest version of Windows that your program is designed to run on. If your MFC program sets `WINVER` to 0x0501 (Windows XP) you'll get a warning because MFC no longer supports XP, even if the build tools have an XP mode. Build tools support for Windows XP ended in Visual Studio 2017, and support for Windows 7, 8.0 and 8.1 ended in Visual Studio 2026. For more information, see [Updating the target windows version](porting-guide-spy-increment.md#updating_winver) and [More outdated header files](porting-guide-spy-increment.md#outdated_header_files). @@ -171,15 +171,15 @@ This error can occur in MFC applications. It indicates an ordering issue between If your original code is compiled for 32-bit systems, you have the option of creating a 64-bit version instead of (or in addition to) a new 32-bit app. In general, you should get your program compiling in 32-bit mode first, and then attempt 64-bit. Compiling for 64-bit is straightforward, but in some cases it can reveal bugs that were hidden by 32-bit builds. -Also, you should be aware of possible compile-time and runtime issues relating to pointer size, time and size values, and size-specific format specifiers in `printf` and `scanf` functions. For more information, see [Configure Visual C++ for 64-bit, x64 targets](../build/configuring-programs-for-64-bit-visual-cpp.md) and [Common Visual C++ 64-bit migration issues](../build/common-visual-cpp-64-bit-migration-issues.md). For more migration tips, see [Programming guide for 64-bit Windows](/windows/win32/WinProg64/programming-guide-for-64-bit-windows). +Also, you should be aware of possible compile-time and runtime issues relating to pointer size, time and size values, and size-specific format specifiers in `printf` and `scanf` functions. For more information, see [Configure Microsoft C++ for 64-bit, x64 targets](../build/configuring-programs-for-64-bit-visual-cpp.md) and [Common Microsoft C++ 64-bit migration issues](../build/common-visual-cpp-64-bit-migration-issues.md). For more migration tips, see [Programming guide for 64-bit Windows](/windows/win32/WinProg64/programming-guide-for-64-bit-windows). ## Unicode vs MBCS/ASCII Before Unicode was standardized, many programs used the Multibyte Character Set (MBCS) to represent characters that weren't included in the ASCII character set. In older MFC projects, MBCS was the default setting. When you upgrade such a program, you'll see warnings that advise to use Unicode instead. If you decide the conversion to Unicode isn't worth the development cost, you may choose to disable or ignore the warning. To disable it for all projects in your solution, open **View** > **Property Manager**, select all projects for which you want to disable the warning, then right-click on the selected items and choose **Properties**. In the **Property Pages** dialog, select **Configuration Properties** > **C/C++** > **Advanced**. In the **Disable Specific Warnings** property, open the drop-down arrow, and then choose **Edit**. Enter 4996 into the text box. (Don't include the 'C' prefix.) Choose **OK** to save the property, then choose **OK** to save your changes. -For more information, see [Porting from MBCS to Unicode](porting-guide-spy-increment.md#porting_to_unicode). For general information about MBCS vs. Unicode, see [Text and Strings in Visual C++](../text/text-and-strings-in-visual-cpp.md) and [Internationalization](../c-runtime-library/internationalization.md) . +For more information, see [Porting from MBCS to Unicode](porting-guide-spy-increment.md#porting_to_unicode). For general information about MBCS vs. Unicode, see [Text and Strings in Microsoft C++](../text/text-and-strings-in-visual-cpp.md) and [Internationalization](../c-runtime-library/internationalization.md) . ## See also -[Upgrading projects from earlier versions of Visual C++](upgrading-projects-from-earlier-versions-of-visual-cpp.md)
+[Upgrading projects from earlier versions of Microsoft C++](upgrading-projects-from-earlier-versions-of-visual-cpp.md)
[C++ conformance improvements in Visual Studio](../overview/cpp-conformance-improvements.md) diff --git a/docs/porting/porting-third-party-libraries.md b/docs/porting/porting-third-party-libraries.md index 6a569a06924..d4dab9694be 100644 --- a/docs/porting/porting-third-party-libraries.md +++ b/docs/porting/porting-third-party-libraries.md @@ -1,25 +1,26 @@ --- description: "Learn more about: Porting third-party libraries" title: "Porting Third-Party Libraries" -ms.date: 10/22/2021 -helpviewer_keywords: ["3rd-party libraries", "vspkg"] +ms.date: 10/29/2025 +helpviewer_keywords: ["3rd-party libraries", "vcpkg"] ms.assetid: b055ed20-8a9e-45b2-ac2a-e3d94271c009 ms.topic: concept-article --- # Porting third-party libraries -When you upgrade a project from Visual Studio 2013 or earlier to the current version of Visual C++, you also have to upgrade any libraries that the project uses. The library and your project must be built by compatible versions and targets of the compiler toolset. If you don't have access to the library source code, and the library isn't available through vcpkg, then you must obtain an updated binary from the library vendor. For more information, see [Overview of potential upgrade issues](overview-of-potential-upgrade-issues-visual-cpp.md). +When you upgrade a project from Visual Studio 2013 or earlier to the current version of Microsoft C++ (MSVC) Build Tools, you also have to upgrade any libraries that the project uses. The library and your project must be built by compatible versions and targets of the build tools. If you don't have access to the library source code, and the library isn't available through vcpkg, then you must obtain an updated binary from the library vendor. For more information, see [Overview of potential upgrade issues](overview-of-potential-upgrade-issues-visual-cpp.md). When you upgrade an application from Visual Studio 2015 or later, it isn't necessary to upgrade dependencies because the code generated by those versions is binary-compatible. For more information, see [C++ binary compatibility between Visual Studio versions](binary-compat-2015-2017.md). ## Use vcpkg for open-source libraries -In the past, finding and upgrading third-party libraries was sometimes a non-trivial task. To make it easier to acquire and rebuild C++ third-party open-source libraries, the Visual C++ team has created a command-line tool called the **VC++ Packaging Tool** or **vcpkg**. Vcpkg has a searchable catalog of many popular C++ open-source libraries. You can install any library in the catalog directly from the vcpkg command line. When you install a library, Vcpkg creates a directory tree on your machine and adds the *`.h`* files, the *`.lib`* files, and binaries in this folder. You can use this folder in your compilation command line, or integrate it into Visual Studio 2015 or later by using the `vcpkg integrate install` command. After you integrate a library location, Visual Studio can find it and add it to any new project that you create. To use a library, just `#include` it. Visual Studio will automatically add the library path to your project settings and copy the DLL to your solution folder. For more information, see [vcpkg](/vcpkg/). +In the past, finding and upgrading third-party libraries was sometimes a non-trivial task. To make it easier to acquire and rebuild C++ third-party open-source libraries, the Microsoft C++ team has created a command-line tool called **[vcpkg](https://vcpkg.io)**. This tool has a searchable catalog (known as the curated registry) of many popular C/C++ open-source libraries. You can install any library in the catalog directly from the vcpkg command line. When you install a library, vcpkg creates a directory tree on your machine and adds the *`.h`* files, the *`.lib`* files, and binaries in this folder. You can use this folder in your compilation command line, or integrate it into Visual Studio 2015 or later by using the `vcpkg integrate install` command. After you integrate a library location, Visual Studio can find it and add it to any new project that you create. To use a library, just `#include` it. Visual Studio will automatically add the library path to your project settings and copy the DLL to your solution folder. For more information, see [vcpkg](/vcpkg/). You can either install [vcpkg from GitHub](https://github.com/microsoft/vcpkg/) or use the built-in version that ships with Visual Studio 2022 or later. To learn more about vcpkg, see the [vcpkg documentation](/vcpkg). ## Reporting issues -If your open-source library isn't found in the **vcpkg** catalog, you can open an issue on the [GitHub repo](https://github.com/Microsoft/vcpkg/issues). That's where the community and the Visual C++ team can see it and potentially create the port file for this library. +If your open-source library isn't found in the **vcpkg** curated registry, you can open an issue on the [GitHub repo](https://github.com/Microsoft/vcpkg/issues). That's where the community and the Microsoft C++ team can see it and potentially create the port file for this library. ## See also -[Visual C++ Porting and Upgrading Guide](visual-cpp-porting-and-upgrading-guide.md) +[Microsoft C++ Porting and Upgrading Guide](visual-cpp-porting-and-upgrading-guide.md) +[vcpkg Documentation](/vcpkg) diff --git a/docs/porting/porting-to-the-universal-windows-platform-cpp.md b/docs/porting/porting-to-the-universal-windows-platform-cpp.md index 742390cf472..83aeac60192 100644 --- a/docs/porting/porting-to-the-universal-windows-platform-cpp.md +++ b/docs/porting/porting-to-the-universal-windows-platform-cpp.md @@ -104,5 +104,5 @@ If you created a new UWP project using Visual Studio, you should not see this er ## See also -[Visual C++ Porting Guide](../porting/porting-to-the-universal-windows-platform-cpp.md)
+[Microsoft C++ Porting Guide](../porting/porting-to-the-universal-windows-platform-cpp.md)
[Develop apps for the Universal Windows Platform (UWP)](/visualstudio/cross-platform/develop-apps-for-the-universal-windows-platform-uwp) diff --git a/docs/porting/toc.yml b/docs/porting/toc.yml index 890de59b9b7..6f05b7a6724 100644 --- a/docs/porting/toc.yml +++ b/docs/porting/toc.yml @@ -9,6 +9,8 @@ items: href: ../porting/overview-of-potential-upgrade-issues-visual-cpp.md - name: Upgrade your code to the Universal CRT href: ../porting/upgrade-your-code-to-the-universal-crt.md + - name: Modernize your C++ project with GitHub Copilot modernization + href: ../porting/copilot-app-modernization-cpp.md - name: Update WINVER and _WIN32_WINNT href: ../porting/modifying-winver-and-win32-winnt.md - name: Fix your dependencies on library internals @@ -17,7 +19,7 @@ items: href: ../porting/floating-point-migration-issues.md - name: Use native multi-targeting in Visual Studio to build old projects href: ../porting/use-native-multi-targeting.md - - name: C++ features deprecated in Visual Studio 2019 + - name: C++ features deprecated in Visual Studio href: ../porting/features-deprecated-in-visual-studio.md - name: VCBuild vs. MSBuild href: ../porting/build-system-changes.md diff --git a/docs/porting/upgrade-your-code-to-the-universal-crt.md b/docs/porting/upgrade-your-code-to-the-universal-crt.md index 5c3ba784e29..bebc69a3fac 100644 --- a/docs/porting/upgrade-your-code-to-the-universal-crt.md +++ b/docs/porting/upgrade-your-code-to-the-universal-crt.md @@ -1,7 +1,7 @@ --- description: "Learn more about: Upgrade your code to the Universal CRT" title: "Upgrade your code to the Universal CRT" -ms.date: 06/28/2022 +ms.date: 10/29/2025 ms.assetid: eaf34c1b-da98-4058-a059-a10db693a5ce ms.topic: upgrade-and-migration-article --- @@ -9,7 +9,7 @@ ms.topic: upgrade-and-migration-article The Microsoft C Runtime Library (CRT) was refactored in Visual Studio 2015. The Standard C Library, POSIX extensions and Microsoft-specific functions, macros, and global variables were moved into a new library, the Universal C Runtime Library (Universal CRT or UCRT). The compiler-specific components of the CRT were moved into a new vcruntime library. -The UCRT is now a Windows component, and ships as part of Windows 10 and later. The UCRT supports a stable ABI based on C calling conventions, and it conforms closely to the ISO C99 standard, with only a few exceptions. It's no longer tied to a specific version of the compiler. You can use the UCRT on any version of Windows supported by Visual Studio 2015 or Visual Studio 2017. The benefit is that you no longer need to update your builds to target a new version of the CRT with every upgrade of Visual Studio. +The UCRT is now a Windows component, and ships as part of Windows 10 and later. The UCRT supports a stable ABI based on C calling conventions, and it conforms closely to the ISO C99 standard, with only a few exceptions. It's no longer tied to a specific version of the compiler. You can use the UCRT on any version of Windows supported by Visual Studio 2015 or later. The benefit is that you no longer need to update your builds to target a new version of the CRT with every upgrade of Visual Studio. This refactoring has changed the names or locations of many CRT header files, library files, and Redistributable files, and the deployment methods required for your code. Many functions and macros in the UCRT were also added or changed to improve standards conformance. To take advantage of these changes, you must update your existing code and project build systems. @@ -25,11 +25,13 @@ The retail and debug UCRT DLLs are found in separate locations. The retail DLLs ## Where to find the standard libraries and headers -The C and C++ compiler-specific runtime support library, `vcruntime`, contains the code required to support program startup and features such as exception handling and intrinsics. The library and its header files are still found in the version-specific Microsoft Visual Studio folder in your *Program Files* or *Program files (x86)* directory. +The C and C++ compiler-specific runtime support library, `vcruntime`, contains the code required to support program startup and features such as exception handling and intrinsics. The library and its header files are still found in the version-specific Microsoft Visual Studio folder in your *Program Files* or *Program Files (x86)* directory. -In Visual Studio 2017, 2019, and 2022, the header files are found under `Microsoft Visual Studio\[year]\[edition]\VC\Tools\MSVC\[lib-version]\include`. Here, `[year]` is the version of Visual Studio, `[edition]` is the edition or nickname for Visual Studio, and `[lib-version]` is the build version of the libraries. +In Visual Studio 2017-2022, the header files are found under `Microsoft Visual Studio\[year]\[edition]\VC\Tools\MSVC\[lib-version]\include`. Here, `[year]` is the version of Visual Studio, `[edition]` is the edition or nickname for Visual Studio, and `[lib-version]` is the build version of the libraries. -The link libraries are found under `Microsoft Visual Studio\[year]\[edition]\VC\Tools\MSVC\[lib-version]\lib\[architecture]`, where `[year]` is the version of Visual Studio, `[edition]` is the edition or nickname for Visual Studio, `[lib-version]` is the build version of the libraries, and `[architecture]` is the target processor architecture. Link libraries for OneCore and Store are also found in the libraries folder. +In Visual Studio 2026, the header files are found under `Microsoft Visual Studio\[version]\[channel]\VC\Tools\MSVC\[lib-version]\include`. Here, `[version]` is the major version number, `[channel]` is Insiders or Stable (depending on your Visual Studio build), and `[lib-version]` is the build version of the libraries. + +The link libraries are found under `Microsoft Visual Studio\[version]\[edition]\VC\Tools\MSVC\[lib-version]\lib\[architecture]`, where `[version]` is the year (Visual Studio 2017 - 2022) or major version number (Visual Studio 2026 or later), `[edition]` is the edition or nickname for Visual Studio, `[lib-version]` is the build version of the libraries, and `[architecture]` is the target processor architecture. Link libraries for OneCore and Store are also found in the libraries folder. The retail and debug versions of the static library are `libvcruntime.lib` and `libvcruntimed.lib`. The dynamic link retail and debug stub libraries are `vcruntime.lib` and `vcruntimed.lib`, respectively. @@ -39,18 +41,18 @@ When you update your Visual Studio C++ projects, if you have set the project's * Because the UCRT is now a Microsoft Windows operating system component, it's included as part of the operating system in Windows 10 and later. It's available through Windows Update for older operating systems, Windows Vista through Windows 8.1. A Redistributable version is available for Windows XP. As an operating system component, UCRT updates and servicing are managed by Windows Update independently of Visual Studio and Microsoft C++ compiler versions. Because the UCRT is a Windows component, for security and ease of updates, and a smaller image size, we strongly recommend you use the Redistributable package to do central deployment of the UCRT for your app. -You can use the UCRT on any version of Windows supported by Visual Studio 2015 or later. You can redistribute it using a `vcredist` package for supported versions of Windows before Windows 10. The `vcredist` packages include the UCRT components and automatically install them on Windows operating systems that don't have them installed by default. For more information, see [Redistributing Visual C++ Files](../windows/redistributing-visual-cpp-files.md). +You can use the UCRT on any version of Windows supported by Visual Studio 2015 or later. You can redistribute it using a `vcredist` package for supported versions of Windows before Windows 10. The `vcredist` packages include the UCRT components and automatically install them on Windows operating systems that don't have them installed by default. For more information, see [Redistributing Microsoft C++ Files](../windows/redistributing-visual-cpp-files.md). -App-local deployment of the UCRT is supported, though not recommended for both performance and security reasons. The DLLs for app-local deployment of the UCRT are included as part of the Windows SDK, under the *`redist`* subdirectory. The DLLs required include `ucrtbase.dll` and a set of **APISet forwarder** DLLs named `api-ms-win-[subset].dll`. The set of DLLs required on each operating system varies, so we recommended that you include all of the DLLs when you use app-local deployment. For more information and recommendations about app-local deployment, see [Deployment in Visual C++](../windows/deployment-in-visual-cpp.md). +App-local deployment of the UCRT is supported, though not recommended for both performance and security reasons. The DLLs for app-local deployment of the UCRT are included as part of the Windows SDK, under the *`redist`* subdirectory. The DLLs required include `ucrtbase.dll` and a set of **APISet forwarder** DLLs named `api-ms-win-[subset].dll`. The set of DLLs required on each operating system varies, so we recommended that you include all of the DLLs when you use app-local deployment. For more information and recommendations about app-local deployment, see [Deployment in Microsoft C++](../windows/deployment-in-visual-cpp.md). ## Changes to the Universal CRT functions and macros -Many functions were added or updated in the UCRT to improve ISO C99 conformance, and to address code quality and security issues. In some cases, this required breaking changes to the library. Your code that compiled cleanly when using an older version of the CRT may break when you compile it using the UCRT. If so, you must change your code to take advantage of UCRT updates and features. For a detailed listing of the breaking changes and updates to the CRT found in the Universal CRT, see the [C Runtime Library (CRT)](visual-cpp-change-history-2003-2015.md#BK_CRT) section of the Visual C++ change history. It includes a list of affected headers and functions that you can use to identify the changes needed in your code. +Many functions were added or updated in the UCRT to improve ISO C99 conformance, and to address code quality and security issues. In some cases, this required breaking changes to the library. Your code that compiled cleanly when using an older version of the CRT may break when you compile it using the UCRT. If so, you must change your code to take advantage of UCRT updates and features. For a detailed listing of the breaking changes and updates to the CRT found in the Universal CRT, see the [C Runtime Library (CRT)](visual-cpp-change-history-2003-2015.md#BK_CRT) section of the Microsoft C++ change history. It includes a list of affected headers and functions that you can use to identify the changes needed in your code. ## See also -[Visual C++ porting and upgrading guide](visual-cpp-porting-and-upgrading-guide.md)\ -[Overview of potential upgrade issues (Visual C++)](overview-of-potential-upgrade-issues-visual-cpp.md)\ -[Upgrading projects from earlier versions of Visual C++](upgrading-projects-from-earlier-versions-of-visual-cpp.md)\ +[Microsoft C++ porting and upgrading guide](visual-cpp-porting-and-upgrading-guide.md)\ +[Overview of potential upgrade issues (Microsoft C++)](overview-of-potential-upgrade-issues-visual-cpp.md)\ +[Upgrading projects from earlier versions of Microsoft C++](upgrading-projects-from-earlier-versions-of-visual-cpp.md)\ [Visual C++ change history 2003 - 2015](visual-cpp-change-history-2003-2015.md)\ [C++ conformance improvements in Visual Studio](../overview/cpp-conformance-improvements.md) diff --git a/docs/porting/upgrading-projects-from-earlier-versions-of-visual-cpp.md b/docs/porting/upgrading-projects-from-earlier-versions-of-visual-cpp.md index 76f6dce84d9..471d6105610 100644 --- a/docs/porting/upgrading-projects-from-earlier-versions-of-visual-cpp.md +++ b/docs/porting/upgrading-projects-from-earlier-versions-of-visual-cpp.md @@ -1,21 +1,21 @@ --- title: "Upgrade C++ projects from earlier versions of Visual Studio" description: "How to upgrade Microsoft C++ projects from older versions of Visual Studio." -ms.date: 04/07/2022 +ms.date: 11/05/2025 helpviewer_keywords: ["32-bit code porting", "upgrading Visual C++ applications, 32-bit code"] ms.assetid: 18cdacaa-4742-43db-9e4c-2d9e73d8cc84 ms.topic: upgrade-and-migration-article --- # Upgrade C++ projects from earlier versions of Visual Studio -To upgrade a project created in an earlier version of Visual Studio, just open the project in the latest version of Visual Studio. Visual Studio offers to upgrade the project to the current schema. +To upgrade a project created in an earlier version of Visual Studio, open the project in the latest version of Visual Studio. If you're still using an older version of Visual Studio side-by-side, you can choose not to upgrade your projects until you're ready to maintain compatibility with both versions. -If you choose **No**, the project doesn't get upgraded. For projects created in Visual Studio 2010 and later, you can still use the project in the newer version of Visual Studio. Just set your project properties to continue to target the older toolset. If you leave the older version of Visual Studio on your computer, its toolset is available in later versions. For example, if your project must continue to run on Windows XP, you can upgrade to Visual Studio 2019. You then specify the toolset as v141_xp or earlier in your project properties. For more information, see [Use native multi-targeting in Visual Studio to build old projects](use-native-multi-targeting.md). +In Visual Studio 2026, this experience is enhanced with a setup assistant. The setup assistant offers to install missing tools using the Visual Studio installer, and to stay on an older version or retarget your projects to the latest version. You can open the setup assistant in **Solution Explorer** by right-clicking your solution and selecting **Retarget solution**. -If you choose **Yes**, then the project gets upgraded in place. It can't be converted back to the earlier version. In upgrade scenarios, that's why it's good practice to make a backup copy of the existing project and solution files. +With the setup assistant open, choose an action for each target or select **Retarget all** to set all projects at once. Then select **Apply** to complete the upgrade in place. Once your projects are retargeted, they can't be converted back to the earlier version. It's good practice to make a backup copy of the existing project and solution files before upgrading them. > [!NOTE] -> Visual Studio 2022 has deprecated support for the upgrade of project types that have *`.dsw`* or *`.dsp`* extensions. You can use an earlier version of Visual Studio, such as Visual Studio 2019, to upgrade these projects, then upgrade them in Visual Studio 2022 to use the latest tools and features of Visual Studio. +> Visual Studio 2022 and later have deprecated support for the upgrade of project types that have *`.dsw`* or *`.dsp`* extensions. You can use an earlier version of Visual Studio, such as Visual Studio 2019, to upgrade these projects, then upgrade them again in Visual Studio 2022 or later to use the latest tools and features of Visual Studio. ## Upgrade reports @@ -37,7 +37,7 @@ When you upgrade a project, you get an upgrade report. The report is also saved - Runtime errors or unexpected results because of behavior changes. -- Errors that were introduced in the tools. If you find an issue, report it to the Visual C++ team through your normal support channels or by using the [Visual Studio C++ Developer Community](https://aka.ms/feedback/report?space=62) page. +- Errors that were introduced in the tools. If you find an issue, report it to the Microsoft C++ team through your normal support channels or by using the [Visual Studio C++ Developer Community](https://aka.ms/feedback/report?space=62) page. Some upgraded projects and solutions can be built successfully without modification. However, most projects will likely require changes to both project settings and your source code. There's no single correct way to go about fixing these issues, but we recommend using a phased approach. Before you start, review [Overview of potential upgrade issues](../porting/overview-of-potential-upgrade-issues-visual-cpp.md) for more information on many kinds of common errors. @@ -72,7 +72,7 @@ For hard-to-fix errors, you can search for solutions or post a question on [Micr ## See also -[What's New for Visual C++ in Visual Studio](../overview/what-s-new-for-visual-cpp-in-visual-studio.md)\ +[What's New for Microsoft C++ in Visual Studio](../overview/what-s-new-for-visual-cpp-in-visual-studio.md)\ [Visual C++ change history 2003 - 2015](../porting/visual-cpp-change-history-2003-2015.md)\ [Nonstandard Behavior](../cpp/nonstandard-behavior.md)\ [Port data applications](../data/data-access-programming-mfc-atl.md) diff --git a/docs/porting/use-native-multi-targeting.md b/docs/porting/use-native-multi-targeting.md index 280f53a6c89..6d57a353278 100644 --- a/docs/porting/use-native-multi-targeting.md +++ b/docs/porting/use-native-multi-targeting.md @@ -1,29 +1,33 @@ --- description: "Learn more about: Use native multi-targeting in Visual Studio to build old projects" title: "Use native multi-targeting in Visual Studio to build old projects" -ms.date: 02/22/2022 +ms.date: 10/29/2025 helpviewer_keywords: ["C++ native multi-targeting", "upgrading Visual C++ applications, retargeting"] ms.assetid: b115aabe-a9dc-4525-90d3-367d97ea20c9 --- # Use native multi-targeting in Visual Studio to build old projects -Normally, we recommend that you update your projects when you install the latest version of Visual Studio. The cost of updating your projects and code is often more than offset by the benefits of the new IDE, compiler, libraries, and tools. However, we know that you may not be able to update some projects. You may have binaries that are tied to older libraries or platforms that for maintenance reasons you can't upgrade. Your code may use non-standard language constructs that would break if you moved to a more recent compiler. Your code might rely on third-party libraries compiled for a specific version of Visual C++. Or you may produce libraries for others that must target a specific older version of Visual C++. +Normally, we recommend that you update your projects when you install the latest version of Visual Studio. The cost of updating your projects and code is often more than offset by the benefits of the new IDE, compiler, libraries, and tools. However, we know that you may not be able to update some projects. You may have binaries that are tied to older libraries or platforms that for maintenance reasons you can't upgrade. Your code may use non-standard language constructs that would break if you moved to a more recent compiler. Your code might rely on third-party libraries compiled for a specific version of Microsoft C++ (MSVC). Or you may produce libraries for others that must target a specific older version of MSVC. -Fortunately, you can use Visual Studio to build projects that target older compiler toolsets and libraries. If you still have the original tools installed, you don't have to upgrade a project from as far back as Visual Studio 2010 to take advantage of new features in the IDE: +Fortunately, you can use Visual Studio to build projects that target older build tools and libraries. If you still have the original tools installed, you don't have to upgrade a project from as far back as Visual Studio 2010 to take advantage of new features in the IDE: -- New C++ refactoring capabilities and editor experimental features +- New C++ refactoring capabilities and editor features - New Diagnostics tools debugger window and Error List window - Revamped breakpoints, exceptions window and new PerfTips - New code navigation and search tools -- New C++ Quick fixes and the Productivity Power Tools extensions. +- New C++ Quick fixes You can also target Visual Studio 2008 projects, but they can't be used unchanged. For details, see the **Instructions for Visual Studio 2008** section. -The latest versions of Visual Studio support native multi-targeting and round-tripping of projects. Native multi-targeting is the ability of the latest IDE to build using toolsets installed by previous versions of Visual Studio. Round-tripping is the ability of the latest IDE to load projects created by a previous IDE version without making any changes to the project. If you install the latest version of Visual Studio side-by-side with your existing version, you can use the new version of the IDE with the compiler and tools from the existing version to build your projects. Other members of your team can continue to use the projects in the older version of Visual Studio. +The latest versions of Visual Studio support native multi-targeting and round-tripping of projects. Native multi-targeting is the ability of the latest IDE to build using build tools installed by previous versions of Visual Studio. Round-tripping is the ability of the latest IDE to load projects created by a previous IDE version without making any changes to the project. If you install the latest version of Visual Studio side-by-side with your existing version, you can use the new version of the IDE with the compiler and tools from the existing version to build your projects. Other members of your team can continue to use the projects in the older version of Visual Studio. -When you use an older toolset, you can take advantage of many of the latest IDE features, but not the latest advances in the C++ compiler, libraries and build tools. For example, you won't be able to use the new language conformance improvements, new debugging and code analysis features, or get the faster build throughput of the latest toolset. There are also some IDE features that are incompatible with older toolsets. For example, type information may be missing in the Memory Profiler, and the refactoring operation **Convert to Raw string literals** generates C++11-conformant code that won't compile when you use Visual Studio 2012 or older toolsets. +When you use an older build tools version, you can take advantage of many of the latest IDE features, but not the latest advances in the C++ compiler, libraries and build tools. For example, you won't be able to use the new language conformance improvements, new debugging and code analysis features, or get the faster build throughput of the latest build tools. There are also some IDE features that are incompatible with older build tools. For example, type information may be missing in the Memory Profiler, and the refactoring operation **Convert to Raw string literals** generates C++11-conformant code that won't compile when you use Visual Studio 2012 or older build tools. -## How to use native multi-targeting in Visual Studio +## How to use native multi-targeting in Visual Studio 2026 + +Visual Studio 2026 includes a new **Setup assistant**. You can load an existing solution, and in **Solution Explorer** select **Retarget solution** to open the assistant. You can use the assistant to install missing C++ build tools (MSVC components and Windows SDKs) compatible with the projects you are loading, including tools originally shipped with older Visual Studio versions. This allows you to continue working with your existing projects without losing compatibility with your previous Visual Studio version. Later, when you are ready to fully upgrade, you can use the assistant to retarget these projects to the newest version of the IDE. + +## How to use native multi-targeting in Visual Studio 2010-2022 Once you have installed Visual Studio side-by-side with your older version, open your existing project in the new version of Visual Studio. When the project is loaded, Visual Studio asks you whether you want to upgrade it to use the latest C++ compiler and libraries. Since you want the project to keep the older compiler and libraries, choose the **Cancel** button. @@ -44,23 +48,23 @@ First, in addition to the current version of Visual Studio, you must install Vis Next, you must update your Visual Studio 2008 solution and projects to the current version of Visual Studio. We recommend you create a backup of your projects and solution files before the upgrade. To start the upgrade process, open the solution in the current version of Visual Studio. When you get the upgrade prompt, review the information presented, and then choose **OK** to start the upgrade. If the solution has more than one project, you must update each project. The wizard creates new *`.vcxproj`* project files side-by-side with the existing *`.vcproj`* files. As long as you also have a copy of the original *`.sln`* file, the upgrade has no other effect on your existing Visual Studio 2008 projects. > [!NOTE] -> The following steps apply to multi-targeting scenarios only. If you intend to permanently upgrade the project to a later toolset, then your next step is to save the project, open it in the latest version of Visual Studio, and address the build issues that appear there. +> The following steps apply to multi-targeting scenarios only. If you intend to permanently upgrade the project to a later build tools version, then your next step is to save the project, open it in the latest version of Visual Studio, and address the build issues that appear there. When the upgrade completes, if the log report has errors or warnings for any of your projects, review them carefully. The conversion from **VCBuild** to **MSBuild** can cause issues. Make sure you understand and implement any action items listed in the report. For more information on the upgrade log report and issues that may occur when converting **VCBuild** to **MSBuild**, see the [C++ Native Multi-Targeting](https://devblogs.microsoft.com/cppblog/c-native-multi-targeting/) blog post. -When the upgrade is complete and you've fixed any issues in the log file, your solution now targets the latest toolset. As the final step, change the properties for each project in the solution to use the Visual Studio 2008 toolset. With the solution loaded in the current version of Visual Studio, for each project in the solution, open the Project **Property Pages** dialog box: Right-click on the project in **Solution Explorer** and then select **Properties**. In the **Property Pages** dialog box, change the **Configuration** drop-down value to **All Configurations**. In **Configuration Properties**, select **General**, and then change **Platform Toolset** to **Visual Studio 2008 (v90)**. +When the upgrade is complete and you've fixed any issues in the log file, your solution now targets the latest build tools. As the final step, change the properties for each project in the solution to use the Visual Studio 2008 build tools. With the solution loaded in the current version of Visual Studio, for each project in the solution, open the Project **Property Pages** dialog box: Right-click on the project in **Solution Explorer** and then select **Properties**. In the **Property Pages** dialog box, change the **Configuration** drop-down value to **All Configurations**. In **Configuration Properties**, select **General**, and then change **Platform Toolset** to **Visual Studio 2008 (v90)**. After this change, the Visual Studio 2008 compiler and libraries are used to generate project binaries when you build the solution in the current version of Visual Studio. -## Install an older Visual Studio toolset +## Install older Visual Studio build tools -You may have an old Visual Studio C++ project that you can't or don't want to upgrade. To build it, you need the platform toolset version that matches your project. To get the toolset, you can install the free Visual Studio Community or Express edition of the version you need. Every version of Visual Studio from Visual Studio 2008 on can install the compiler, tools, and libraries you need to target that version from the current Visual Studio. Search the Microsoft Download Center to find and download a particular version of Visual Studio. Make sure you choose the C++ installation options during setup. After setup completes, run that version of Visual Studio to install any updates. Also check for any Windows Update changes that might be required. This update check process may need to be repeated more than once to get every update. +You may have an old Visual Studio C++ project that you can't or don't want to upgrade. To build it, you need the build tools version that matches your project. To get the build tools, you can install the free Visual Studio Community or Express edition of the version you need. Every version of Visual Studio from Visual Studio 2008 on can install the compiler, libraries, and other build tools you need to target that version from the current Visual Studio. Search the Microsoft Download Center to find and download a particular version of Visual Studio. Make sure you choose the C++ installation options during setup. After setup completes, run that version of Visual Studio to install any updates. Also check for any Windows Update changes that might be required. This update check process may need to be repeated more than once to get every update. For the currently available downloads, see [Download older Visual Studio software](https://visualstudio.microsoft.com/vs/older-downloads/). -When these products are installed, the **Platform Toolset** property drop-down in the **Property Pages** dialog box is automatically updated to show the available toolsets. You can now use the latest version of Visual Studio to build projects that use an older version of the toolset: no conversion or upgrade required. +When these products are installed, the **MSVC Build Tools Version** property drop-down in the **Property Pages** dialog box is automatically updated to show the available build tools versions. In some cases, there may also be new choices for the **Platform Toolset** property. You can now use the latest version of Visual Studio to build projects that use an older version of the build tools: no conversion or upgrade required. ## See also -[Upgrading projects from earlier versions of Visual C++](upgrading-projects-from-earlier-versions-of-visual-cpp.md)\ +[Upgrading projects from earlier versions of Microsoft C++](upgrading-projects-from-earlier-versions-of-visual-cpp.md)\ [C++ conformance improvements in Visual Studio](../overview/cpp-conformance-improvements.md) diff --git a/docs/porting/visual-cpp-porting-and-upgrading-guide.md b/docs/porting/visual-cpp-porting-and-upgrading-guide.md index a37ba527a58..64aa8a53e5e 100644 --- a/docs/porting/visual-cpp-porting-and-upgrading-guide.md +++ b/docs/porting/visual-cpp-porting-and-upgrading-guide.md @@ -1,60 +1,153 @@ --- title: "Microsoft C++ porting and upgrading guide" -description: "Upgrade Microsoft C++ code to the latest version of Visual Studio." -ms.date: 09/10/2020 -ms.assetid: f5fbcc3d-aa72-41a6-ad9a-a706af2166fb +description: "Your comprehensive hub for upgrading and modernizing Microsoft C++ code to the latest version of Visual Studio. Find tools, guides, success stories, and best practices." +ms.date: 11/06/2025 ms.topic: "overview" -ms.custom: intro-overview +ms.custom: intro-hub +author: tylermsft +ms.author: twhitney --- -# Microsoft C++ porting and upgrading guide - -This article provides a guide for upgrading Microsoft C++ code to the latest version of Visual Studio. For projects created in Visual Studio 2010 through 2017, just open the project in Visual Studio 2019. You can upgrade a Visual Studio 2008 or earlier project in two steps. Use Visual Studio 2010 to convert the project to MSBuild format first. Then open the project in Visual Studio 2019. For complete instructions, see [Upgrading C++ projects from earlier versions of Visual Studio](upgrading-projects-from-earlier-versions-of-visual-cpp.md). - -The toolsets in Visual Studio 2015, Visual Studio 2017, and Visual Studio 2019 are binary-compatible. Now you can upgrade to a more recent version of the compiler without having to upgrade your library dependencies. For more information, see [C++ binary compatibility between Visual Studio versions](binary-compat-2015-2017.md). - -When upgrading projects that use open-source libraries or are meant to run on multiple platforms, we recommended migrating to a CMake-based project. For more information, see [CMake projects in Visual Studio](../build/cmake-projects-in-visual-studio.md) - -## Reasons to upgrade C++ code - -If a legacy application is running satisfactorily, in a secure environment, and isn't under active development, there might not be much incentive to upgrade it. However, consider an upgrade in these cases: Your application requires ongoing maintenance. Or, you're doing new feature development, or making performance or security improvements. An upgrade brings these benefits: - -- The same code can run faster, because we've improved compiler optimizations. - -- Modern C++ features and programming practices eliminate many common causes of bugs, and produce code that's far easier to maintain than older C-style idioms. - -- Build times are faster, because of performance improvements in the compiler and linker. -- Better standards conformance. The [/permissive-](../build/reference/permissive-standards-conformance.md) compiler option helps you identify code that doesn't conform to the current C++ standard. The [new preprocessor](../preprocessor/preprocessor-experimental-overview.md) supports code conformance, too. - -- Better run-time security, including more secure [C Runtime library](../c-runtime-library/security-features-in-the-crt.md) features. And, compiler features such as [guard checking](../build/reference/guard-enable-guard-checks.md) and address sanitizers (new in Visual Studio 2019 version 16.4). - -## Multitargeting vs. upgrading - -Perhaps upgrading your code base to a new toolset isn't an option for you. You can still use the latest Visual Studio to build and edit projects that use older toolsets and libraries. In Visual Studio 2019, you can take advantage of features such as: - -- modern static analysis tools, including the C++ Core Guidelines checkers and Clang-Tidy, to help identify potential problems in your source code. - -- automatic formatting according to your choice of modern styles can help make legacy code much more readable. - -For more information, see [Use native multi-targeting in Visual Studio to build old projects](use-native-multi-targeting.md). - -## In this section +# Microsoft C++ porting and upgrading guide -| Title | Description | -|--|--| -| [Upgrading C++ projects from earlier versions of Visual Studio](upgrading-projects-from-earlier-versions-of-visual-cpp.md) | How to upgrade your code base to the latest version of Visual Studio and the compiler. | -| [IDE tools for upgrading C++ code](ide-tools-for-upgrading-code.md) | Useful IDE features that help in the upgrade process. | -| [C++ binary compatibility between Visual Studio versions](binary-compat-2015-2017.md) | Consume v140 and later libraries as-is from v140 and later projects. | -| [Use native multi-targeting in Visual Studio to build old projects](use-native-multi-targeting.md) | Use Visual Studio with older compilers and libraries. | -| [Visual C++ change history 2003 - 2015](visual-cpp-change-history-2003-2015.md) | A list of all the changes in the Microsoft C++ libraries and build tools from Visual Studio 2003 through 2015 that might require changes in your code. | -| [Visual C++ What's New 2003 through 2015](visual-cpp-what-s-new-2003-through-2015.md) | All the "what's new" information for Microsoft C++ from Visual Studio 2003 through Visual Studio 2015. | -| [Porting and Upgrading: Examples and Case Studies](porting-and-upgrading-examples-and-case-studies.md) | For this section, we ported and upgrades several samples and applications and discussed the experiences and results. These articles give you a sense of what's involved in the porting and upgrading process. Throughout the process, we discuss tips and tricks for upgrading and show how specific errors were fixed. | -| [Porting to the Universal Windows Platform](porting-to-the-universal-windows-platform-cpp.md) | Contains information about porting app code to Windows 10 and later | -| [Introduction to Visual C++ for UNIX Users](introduction-to-visual-cpp-for-unix-users.md) | Provides information for UNIX users who are new to Visual C++ and want to become productive with it. | -| [Running Linux programs on Windows](porting-from-unix-to-win32.md) | Discusses options for migrating UNIX applications to Windows. | +**Transform your legacy C++ applications with confidence.** Whether you're upgrading from Visual Studio 2008 or modernizing to take advantage of the latest C++ features, this comprehensive guide provides everything you need for a successful upgrade journey. + +:::row::: +:::column span=""::: +:::column-end::: +:::column span="2"::: +![C++ logo with an upward arrow and abstract code on a blue background suggesting improvements from upgrading.](media/upgrade-cpp.png) +:::column-end::: +:::column span=""::: +:::column-end::: +:::row-end::: + +:::row::: +:::column span="2"::: +## 🚀 Quick start + +**Most projects upgrade seamlessly:** For projects created in Visual Studio 2010-2017, simply open them in the latest Visual Studio. For Visual Studio 2008 or earlier projects, use our [two-step upgrade process](upgrading-projects-from-earlier-versions-of-visual-cpp.md). + +**Binary compatibility:** Visual Studio 2015, 2017, 2019, 2022, and 2026 build tools are binary-compatible, so you can upgrade without rebuilding library dependencies. [Learn more](binary-compat-2015-2017.md). + +**CMake projects:** For projects using open-source libraries or targeting multiple platforms, consider migrating to CMake. [Learn more](../build/cmake-projects-in-visual-studio.md). +:::column-end::: +:::column span="2"::: +## 💡 Why upgrade? + +- **🏃‍♂️ Better Performance:** Faster execution and build times +- **🔒 Enhanced Security:** Address sanitizers and security features +- **📐 Standards Compliance:** Modern C++ features and conformance +- **🛠️ Better Tools:** Advanced debugging and analysis capabilities +:::column-end::: +:::row-end::: + +## 🎯 Choose your upgrade path + +:::row::: +:::column::: +### 📋 Assess & plan +**Evaluate your current codebase and plan your strategy** + +- [🔍 Overview of potential upgrade issues](overview-of-potential-upgrade-issues-visual-cpp.md) +- [🔗 C++ binary compatibility between versions](binary-compat-2015-2017.md) +- [📜 Visual C++ change history 2003-2015](visual-cpp-change-history-2003-2015.md) +- [⚠️ Features deprecated in Visual Studio](features-deprecated-in-visual-studio.md) +- [🎯 Use native multi-targeting for old projects](use-native-multi-targeting.md) +:::column-end::: +:::column::: +### 🔧 Upgrade & modernize +**Step-by-step guides and tools for upgrading** + +- [⬆️ Upgrading C++ Projects to Visual Studio 2026](https://devblogs.microsoft.com/cppblog/upgrading-c-projects-to-visual-studio-2026/) +- [⬆️ Upgrade projects from earlier versions](upgrading-projects-from-earlier-versions-of-visual-cpp.md) +- [🤖 Upgrade with an AI agent (preview)](copilot-app-modernization-cpp.md) +- [🛠️ IDE tools for upgrading C++ code](ide-tools-for-upgrading-code.md) +- [🔄 Upgrade to Universal CRT](upgrade-your-code-to-the-universal-crt.md) +- [🔧 Update WINVER and _WIN32_WINNT](modifying-winver-and-win32-winnt.md) +- [🔗 Fix dependencies on library internals](fix-your-dependencies-on-library-internals.md) +- [📊 Floating-point migration issues](floating-point-migration-issues.md) +:::column-end::: +:::row-end::: + +:::row::: +:::column::: +### 🌐 Platform migration +**Move your applications to modern platforms** + +- [📱 Port to Universal Windows Platform](porting-to-the-universal-windows-platform-cpp.md) +- [🔗 Use existing C++ code in UWP apps](how-to-use-existing-cpp-code-in-a-universal-windows-platform-app.md) +- [🐧 Visual C++ for UNIX users](introduction-to-visual-cpp-for-unix-users.md) +- [🪟 Running Linux programs on Windows](porting-from-unix-to-win32.md) +- [📦 Port third-party libraries](porting-third-party-libraries.md) +:::column-end::: +:::column::: +### ✨ Success stories & examples +**Learn from real-world upgrade experiences** + +- [📖 Examples and case studies overview](porting-and-upgrading-examples-and-case-studies.md) +- [📝 Case study: MFC Scribble upgrade](porting-guide-mfc-scribble.md) +- [🕵️ Case study: COM Spy upgrade](porting-guide-com-spy.md) +- [🔍 Case study: Spy++ upgrade](porting-guide-spy-increment.md) +- [🏗️ VCBuild vs. MSBuild migration](build-system-changes.md) +:::column-end::: +:::row-end::: + +[📚 Read more case studies](porting-and-upgrading-examples-and-case-studies.md) + +## 🛠️ Upgrade benefits + +:::row::: +:::column span="2"::: +### Performance & optimization +- **Faster execution** with improved compiler optimizations +- **Reduced build times** through compiler and linker improvements +- **Better memory usage** with modern runtime optimizations +:::column-end::: +:::column span="2"::: +### Security & reliability +- **Enhanced security** with address sanitizers and [guard checking](../build/reference/guard-enable-guard-checks.md) +- **Secure runtime libraries** with improved [CRT security features](../c-runtime-library/security-features-in-the-crt.md)) +- **Better error detection** with static analysis tools +:::column-end::: +:::row-end::: + +:::row::: +:::column span="2"::: +### Developer experience +- **Modern IDE features** with IntelliSense improvements +- **Advanced debugging** with better visualizers and diagnostics +- **Code analysis** with Core Guidelines checkers and Clang-Tidy +:::column-end::: +:::column span="2"::: +### Standards & compatibility +- **Better C++ standards conformance** with [`/permissive-`](../build/reference/permissive-standards-conformance.md) mode +- **Modern preprocessor** for improved code conformance. [Learn more](../preprocessor/preprocessor-experimental-overview.md) +- **Cross-platform support** with CMake integration +:::column-end::: +:::row-end::: + +## 🤔 Multitargeting vs. upgrading + +**Not ready for a full upgrade?** You can still use the latest Visual Studio with older build tools and libraries: + +- ✅ **Modern static analysis tools** including C++ Core Guidelines checkers and Clang-Tidy +- ✅ **Automatic code formatting** to improve legacy code readability +- ✅ **Latest IDE features** while maintaining compatibility + +[Learn about native multi-targeting →](use-native-multi-targeting.md) + +## 🚀 Ready to start? + +1. **📊 Assess your current project** with our [upgrade issues overview](overview-of-potential-upgrade-issues-visual-cpp.md) +2. **🔄 Follow our step-by-step guide** to [upgrade from earlier versions](upgrading-projects-from-earlier-versions-of-visual-cpp.md) +3. **🛠️ Use our IDE tools** to [streamline the upgrade process](ide-tools-for-upgrading-code.md) +4. **📖 Learn from others** with our [real-world case studies](porting-and-upgrading-examples-and-case-studies.md) + +**Questions?** Join the conversation in [Microsoft Learn Q&A](/answers/topics/c%2B%2B.html) or check out the [C++ Team Blog](https://devblogs.microsoft.com/cppblog/) for the latest updates. ## See also -[C++ in Visual Studio](../overview/visual-cpp-in-visual-studio.md)
-[What's New for The C++ compiler in Visual Studio](../overview/what-s-new-for-visual-cpp-in-visual-studio.md)
-[C++ conformance improvements in Visual Studio](../overview/cpp-conformance-improvements.md)
+[C++ in Visual Studio](../overview/visual-cpp-in-visual-studio.md)\ +[What's new for the C++ compiler in Visual Studio](../overview/what-s-new-for-visual-cpp-in-visual-studio.md)\ +[C++ conformance improvements in Visual Studio](../overview/cpp-conformance-improvements.md) \ No newline at end of file diff --git a/docs/preprocessor/compiler-warnings-that-are-off-by-default.md b/docs/preprocessor/compiler-warnings-that-are-off-by-default.md index 96a31c29833..e09e8a00d50 100644 --- a/docs/preprocessor/compiler-warnings-that-are-off-by-default.md +++ b/docs/preprocessor/compiler-warnings-that-are-off-by-default.md @@ -101,6 +101,7 @@ The following warnings are turned off by default in Visual Studio 2015 and later | [C4686](../error-messages/compiler-warnings/compiler-warning-level-3-c4686.md) (level 3) | '*user-defined type*': possible change in behavior, change in UDT return calling convention | | [C4692](../error-messages/compiler-warnings/compiler-warning-level-1-c4692.md) (level 1) | '*function*': signature of non-private member contains assembly private native type '*native_type*' | | [C4710](../error-messages/compiler-warnings/compiler-warning-level-4-c4710.md) (level 4) | '*function*': function not inlined | +| [C4711](../error-messages/compiler-warnings/compiler-warning-level-1-c4711.md) (level 1) | function '*function*' selected for inline expansion | | [C4738](../error-messages/compiler-warnings/compiler-warning-level-3-c4738.md) (level 3) | storing 32-bit float result in memory, possible loss of performance | | [C4746](../error-messages/compiler-warnings/compiler-warning-c4746.md) | volatile access of '*expression*' is subject to /volatile:\ setting; consider using __iso_volatile_load/store intrinsic functions | | C4749 (level 4) | conditionally supported: offsetof applied to non-standard-layout type '*type*' | @@ -168,7 +169,7 @@ The following warnings are turned off by default in Visual Studio 2019 and later | C5220 (level 4) | '*member*': a non-static data member with a volatile qualified type no longer implies that
compiler generated copy/move constructors and copy/move assignment operators are not trivial 16.7 | | C5233 (level 4) | explicit lambda capture '*identifier*' is not used 16.10 | | [C5240 (level 4)](../error-messages/compiler-warnings/c5240.md) | '*attribute-name*': attribute is ignored in this syntactic position 16.10 | -| [C5243 (level 1)](../error-messages/compiler-warnings/c5247.md) | '*type-name*': using incomplete class '*class-name*' can cause potential one definition rule violation due to ABI limitation 16.10 | +| [C5243 (level 1)](../error-messages/compiler-warnings/c5243.md) | '*type-name*': using incomplete class '*class-name*' can cause potential one definition rule violation due to ABI limitation 16.10 | | C5245 (level 4) | '*function*': unreferenced function with internal linkage has been removed | | C5246 (level 1) | '*member*': the initialization of a subobject should be wrapped in braces 16.10 | | [C5247 (level 1)](../error-messages/compiler-warnings/c5247.md) | Section '*section-name*' is reserved for C++ dynamic initialization. Manually creating the section will interfere with C++ dynamic initialization and may lead to undefined behavior 16.11 | diff --git a/docs/preprocessor/hash-error-directive-c-cpp.md b/docs/preprocessor/hash-error-directive-c-cpp.md index 2a5ec7bfe95..f98fd41b1fd 100644 --- a/docs/preprocessor/hash-error-directive-c-cpp.md +++ b/docs/preprocessor/hash-error-directive-c-cpp.md @@ -4,11 +4,10 @@ title: "#error directive (C/C++)" ms.date: "08/29/2019" f1_keywords: ["#error"] helpviewer_keywords: ["#error directive", "preprocessor, directives", "error directive (#error directive)"] -ms.assetid: d550a802-ff19-4347-9597-688935d23b2b --- # #error directive (C/C++) -The **#error** directive emits a user-specified error message at compile time, and then terminates the compilation. +The `#error` directive emits a user-specified error message at compile time. Then it terminates the compilation. ## Syntax @@ -26,4 +25,5 @@ The error message that this directive emits includes the *token-string* paramete ## See also -[Preprocessor directives](../preprocessor/preprocessor-directives.md) +[Preprocessor directives](../preprocessor/preprocessor-directives.md)\ +[#warning directive](../preprocessor/hash-warning-directive-c-cpp.md) diff --git a/docs/preprocessor/hash-warning-directive-c-cpp.md b/docs/preprocessor/hash-warning-directive-c-cpp.md new file mode 100644 index 00000000000..83c36ab7418 --- /dev/null +++ b/docs/preprocessor/hash-warning-directive-c-cpp.md @@ -0,0 +1,33 @@ +--- +description: "Learn more about: #warning directive (C/C++)" +title: "#warning directive (C/C++)" +ms.date: 10/15/2025 +f1_keywords: ["#warning"] +helpviewer_keywords: ["#warning directive", "preprocessor, directives", "warning directive (#warning directive)"] +--- +# #warning directive (C/C++) + +The **#warning** directive emits a user-specified warning message at compile time. It doesn't stop compilation. This directive is available starting in C23 and C++23. + +## Syntax + +> **#warning** *token-string* + +## Remarks + +The warning message is the *token-string* parameter. The *token-string* parameter isn't subject to macro expansion and can be optionally enclosed in quotes. + +Use this directive to inform the developer of a nonfatal issue or to communicate other important information during compilation. + +The following example shows how to use the **#warning** directive: + +```cpp +#if defined(_LEGACY_FEATURE_FLAG) +#warning "_LEGACY_FEATURE is deprecated and should not be used." +#endif +``` + +## See also + +[Preprocessor directives](../preprocessor/preprocessor-directives.md)\ +[#error directive](../preprocessor/hash-error-directive-c-cpp.md) \ No newline at end of file diff --git a/docs/preprocessor/predefined-macros.md b/docs/preprocessor/predefined-macros.md index 501dfdd2bed..4c1b0170f87 100644 --- a/docs/preprocessor/predefined-macros.md +++ b/docs/preprocessor/predefined-macros.md @@ -2,9 +2,9 @@ title: "Predefined macros" description: "Lists and describes the Microsoft C++ compiler predefined preprocessor macros." ms.custom: "update_every_version" -ms.date: 06/18/2025 -f1_keywords: ["__ARM_ARCH", "_ATL_VER", "__ATOM__", "__AVX__", "__AVX2__", "__AVX512BW__", "__AVX512CD__", "__AVX512DQ__", "__AVX512F__", "__AVX512VL__", "_CHAR_UNSIGNED", "__CLR_VER", "_CONTROL_FLOW_GUARD", "__COUNTER__", "__cplusplus", "__cplusplus_cli", "__cplusplus_winrt", "_CPPRTTI", "_CPPUNWIND", "__DATE__", "_DEBUG", "_DLL", "__FILE__", "__FUNCDNAME__", "__FUNCSIG__", "__FUNCTION__", "_INTEGRAL_MAX_BITS", "_ISO_VOLATILE", "_KERNEL_MODE", "__LINE__", "_M_AMD64", "_M_ARM", "_M_ARM_ARMV7VE", "_M_ARM_FP", "_M_ARM64", "_M_CEE", "_M_CEE_PURE", "_M_CEE_SAFE", "_M_FP_EXCEPT", "_M_FP_FAST", "_M_FP_PRECISE", "_M_FP_STRICT", "_M_IX86", "_M_IX86_FP", "_M_X64", "_MANAGED", "_MFC_VER", "_MSC_BUILD", "_MSC_EXTENSIONS", "_MSC_FULL_VER", "_MSC_VER", "_MSVC_LANG", "__MSVC_RUNTIME_CHECKS", "_MT", "_NATIVE_WCHAR_T_DEFINED", "_NO_SIZED_DEALLOCATION", "_OPENMP", "_PREFAST_", "_RESUMABLE_FUNCTIONS_SUPPORTED", "_RTC_CONVERSION_CHECKS_ENABLED", "__SANITIZE_ADDRESS__", "__STDC__", "__STDC_HOSTED__", "__STDC_NO_ATOMICS__", "__STDC_NO_COMPLEX__", "__STDC_NO_THREADS__", "__STDC_NO_VLA__", "__STDC_VERSION__", "__STDCPP_DEFAULT_NEW_ALIGNMENT__", "__STDCPP_THREADS__", "__TIME__", "__TIMESTAMP__", "__VA_ARGS__", "_VC_NODEFAULTLIB", "_WCHAR_T_DEFINED", "_WIN32", "_WIN64", "_WINRT_DLL"] -helpviewer_keywords: ["__ARM_ARCH macro", "timestamps, preprocessor macro", "cl.exe compiler, version number", "version numbers, C/C++ compiler (cl.exe)", "macros, predefined C++", "preprocessor, macros", "predefined macros", "_ATL_VER macro", "__ATOM__ macro", "__AVX__ macro", "__AVX2__ macro", "__AVX512BW__ macro", "__AVX512CD__ macro", "__AVX512DQ__ macro", "__AVX512F__ macro", "__AVX512VL__ macro", "_CHAR_UNSIGNED macro", "__CLR_VER macro", "_CONTROL_FLOW_GUARD macro", "__COUNTER__ macro", "__cplusplus macro", "__cplusplus_cli macro", "__cplusplus_winrt macro", "_CPPRTTI macro", "_CPPUNWIND macro", "__DATE__ macro", "_DEBUG macro", "_DLL macro", "__FILE__ macro", "__FUNCDNAME__ macro", "__FUNCSIG__ macro", "__FUNCTION__ macro", "_INTEGRAL_MAX_BITS macro", "_ISO_VOLATILE macro", "_KERNEL_MODE macro", "__LINE__ macro", "_M_AMD64 macro", "_M_ARM macro", "_M_ARM_ARMV7VE macro", "_M_ARM_FP macro", "_M_ARM64 macro", "_M_ARM64EC macro", "_M_CEE macro", "_M_CEE_PURE macro", "_M_CEE_SAFE macro", "_M_FP_EXCEPT macro", "_M_FP_FAST macro", "_M_FP_PRECISE macro", "_M_FP_STRICT macro", "_M_IX86 macro", "_M_IX86_FP macro", "_M_X64 macro", "_MANAGED macro", "_MFC_VER macro", "_MSC_BUILD macro", "_MSC_EXTENSIONS macro", "_MSC_FULL_VER macro", "_MSC_VER macro", "_MSVC_LANG macro", "__MSVC_RUNTIME_CHECKS macro", "_MT macro", "_NATIVE_WCHAR_T_DEFINED macro", "_NO_SIZED_DEALLOCATION macro", "_OPENMP macro", "_PREFAST_ macro", "_RESUMABLE_FUNCTIONS_SUPPORTED macro", "_RTC_CONVERSION_CHECKS_ENABLED macro", "__SANITIZE_ADDRESS__ macro", "__STDC__ macro", "__STDC_HOSTED__ macro", "__STDC_NO_ATOMICS__ macro", "__STDC_NO_COMPLEX__ macro", "__STDC_NO_THREADS__ macro", "__STDC_NO_VLA__ macro", "__STDC_VERSION__ macro", "__STDCPP_DEFAULT_NEW_ALIGNMENT__", "__STDCPP_THREADS__ macro", "__TIME__ macro", "__TIMESTAMP__ macro", "__VA_ARGS__ macro", "_VC_NODEFAULTLIB macro", "_WCHAR_T_DEFINED macro", "_WIN32 macro", "_WIN64 macro", "_WINRT_DLL macro", "__func__ identifier"] +ms.date: 05/12/2026 +f1_keywords: ["__APX_F__", "__ARM_ARCH", "_ATL_VER", "__ATOM__", "__AVX__", "__AVX2__", "__AVX512BW__", "__AVX512CD__", "__AVX512DQ__", "__AVX512F__", "__AVX512VL__", "__CCMP__", "__CF__", "_CHAR_UNSIGNED", "__CLR_VER", "_CONTROL_FLOW_GUARD", "__COUNTER__", "__cplusplus", "__cplusplus_cli", "__cplusplus_winrt", "_CPPRTTI", "_CPPUNWIND", "__DATE__", "_DEBUG", "_DLL", "__EGPR__", "__FILE__", "__FUNCDNAME__", "__FUNCSIG__", "__FUNCTION__", "_INTEGRAL_MAX_BITS", "_ISO_VOLATILE", "_KERNEL_MODE", "__LINE__", "_M_AMD64", "_M_ARM", "_M_ARM_ARMV7VE", "_M_ARM_FP", "_M_ARM64", "_M_CEE", "_M_CEE_PURE", "_M_CEE_SAFE", "_M_FP_EXCEPT", "_M_FP_FAST", "_M_FP_PRECISE", "_M_FP_STRICT", "_M_IX86", "_M_IX86_FP", "_M_X64", "_MANAGED", "_MFC_VER", "_MSC_BUILD", "_MSC_EXTENSIONS", "_MSC_FULL_VER", "_MSC_VER", "_MSVC_LANG", "__MSVC_RUNTIME_CHECKS", "_MT", "_NATIVE_WCHAR_T_DEFINED", "__NDD__", "__NF__", "_NO_SIZED_DEALLOCATION", "_OPENMP", "__PPX__", "_PREFAST_", "__PUSH2POP2__", "_RESUMABLE_FUNCTIONS_SUPPORTED", "_RTC_CONVERSION_CHECKS_ENABLED", "__SANITIZE_ADDRESS__", "__STDC__", "__STDC_HOSTED__", "__STDC_NO_ATOMICS__", "__STDC_NO_COMPLEX__", "__STDC_NO_THREADS__", "__STDC_NO_VLA__", "__STDC_VERSION__", "__STDCPP_DEFAULT_NEW_ALIGNMENT__", "__STDCPP_THREADS__", "__TIME__", "__TIMESTAMP__", "__VA_ARGS__", "_VC_NODEFAULTLIB", "_WCHAR_T_DEFINED", "_WIN32", "_WIN64", "_WINRT_DLL", "__ZU__"] +helpviewer_keywords: ["__APX_F__ macro", "__ARM_ARCH macro", "_ATL_VER macro", "__ATOM__ macro", "__AVX__ macro", "__AVX2__ macro", "__AVX512BW__ macro", "__AVX512CD__ macro", "__AVX512DQ__ macro", "__AVX512F__ macro", "__AVX512VL__ macro", "__CCMP__ macro", "__CF__ macro", "_CHAR_UNSIGNED macro", "cl.exe compiler, version number", "__CLR_VER macro", "_CONTROL_FLOW_GUARD macro", "__COUNTER__ macro", "__cplusplus macro", "__cplusplus_cli macro", "__cplusplus_winrt macro", "_CPPRTTI macro", "_CPPUNWIND macro", "__DATE__ macro", "_DEBUG macro", "_DLL macro", "__EGPR__ macro", "__FILE__ macro", "__func__ identifier", "__FUNCDNAME__ macro", "__FUNCSIG__ macro", "__FUNCTION__ macro", "_INTEGRAL_MAX_BITS macro", "_ISO_VOLATILE macro", "_KERNEL_MODE macro", "__LINE__ macro", "_M_AMD64 macro", "_M_ARM macro", "_M_ARM_ARMV7VE macro", "_M_ARM_FP macro", "_M_ARM64 macro", "_M_ARM64EC macro", "_M_CEE macro", "_M_CEE_PURE macro", "_M_CEE_SAFE macro", "_M_FP_EXCEPT macro", "_M_FP_FAST macro", "_M_FP_PRECISE macro", "_M_FP_STRICT macro", "_M_IX86 macro", "_M_IX86_FP macro", "_M_X64 macro", "macros, predefined C++", "_MANAGED macro", "_MFC_VER macro", "_MSC_BUILD macro", "_MSC_EXTENSIONS macro", "_MSC_FULL_VER macro", "_MSC_VER macro", "_MSVC_LANG macro", "__MSVC_RUNTIME_CHECKS macro", "_MT macro", "_NATIVE_WCHAR_T_DEFINED macro", "__NDD__ macro", "__NF__ macro", "_NO_SIZED_DEALLOCATION macro", "_OPENMP macro", "__PPX__ macro", "predefined macros", "_PREFAST_ macro", "preprocessor, macros", "__PUSH2POP2__ macro", "_RESUMABLE_FUNCTIONS_SUPPORTED macro", "_RTC_CONVERSION_CHECKS_ENABLED macro", "__SANITIZE_ADDRESS__ macro", "__STDC__ macro", "__STDC_HOSTED__ macro", "__STDC_NO_ATOMICS__ macro", "__STDC_NO_COMPLEX__ macro", "__STDC_NO_THREADS__ macro", "__STDC_NO_VLA__ macro", "__STDC_VERSION__ macro", "__STDCPP_DEFAULT_NEW_ALIGNMENT__", "__STDCPP_THREADS__ macro", "__TIME__ macro", "__TIMESTAMP__ macro", "timestamps, preprocessor macro", "__VA_ARGS__ macro", "_VC_NODEFAULTLIB macro", "version numbers, C/C++ compiler (cl.exe)", "_WCHAR_T_DEFINED macro", "_WIN32 macro", "_WIN64 macro", "_WINRT_DLL macro", "__ZU__ macro"] ms.assetid: 1cc5f70a-a225-469c-aed0-fe766238e23f no-loc: [_ATL_VER, __ATOM__, __AVX__, __AVX2__, __AVX512BW__, __AVX512CD__, __AVX512DQ__, __AVX512F__, __AVX512VL__, _CHAR_UNSIGNED, __CLR_VER, _CONTROL_FLOW_GUARD, __COUNTER__, __cplusplus, __cplusplus_cli, __cplusplus_winrt, _CPPRTTI, _CPPUNWIND, __DATE__, _DEBUG, _DLL, __FILE__, __FUNCDNAME__, __FUNCSIG__, __FUNCTION__, _INTEGRAL_MAX_BITS, _ISO_VOLATILE, _KERNEL_MODE, __LINE__, _M_AMD64, _M_ARM, _M_ARM_ARMV7VE, _M_ARM_FP, _M_ARM64, _M_ARM64EC, _M_CEE, _M_CEE_PURE, _M_CEE_SAFE, _M_FP_EXCEPT, _M_FP_FAST, _M_FP_PRECISE, _M_FP_STRICT, _M_IX86, _M_IX86_FP, _M_X64, _MANAGED, _MFC_VER, _MSC_BUILD, _MSC_EXTENSIONS, _MSC_FULL_VER, _MSC_VER, _MSVC_LANG, __MSVC_RUNTIME_CHECKS, _MT, _NATIVE_WCHAR_T_DEFINED, _NO_SIZED_DEALLOCATION, _OPENMP, _PREFAST_, _RESUMABLE_FUNCTIONS_SUPPORTED, _RTC_CONVERSION_CHECKS_ENABLED, __SANITIZE_ADDRESS__, __STDC__, __STDC_HOSTED__, __STDC_NO_ATOMICS__, __STDC_NO_COMPLEX__, __STDC_NO_THREADS__, __STDC_NO_VLA__, __STDC_VERSION__, __STDCPP_DEFAULT_NEW_ALIGNMENT__, __STDCPP_THREADS__, __TIME__, __TIMESTAMP__, __VA_ARGS__, _VC_NODEFAULTLIB, _WCHAR_T_DEFINED, _WIN32, _WIN64, _WINRT_DLL, __func__] --- @@ -65,25 +65,31 @@ The compiler supports these predefined macros specified by the ISO C99, C11, C17 MSVC supports other predefined macros: +- `__APX_F__` Defined as 1 when the [`/feature:APX`](../build/reference/feature-x64.md) compiler option is set and the compiler target is x64. Otherwise, undefined. + - `__ARM_ARCH` Defined as an integer literal that represents the ARM architecture version. The value is defined as 8 for the Armv8-A architecture. For 8.1 and onwards, the value is scaled for minor versions, such as X.Y, by using the formula X * 100 + Y as defined by the ARM C language extension. For example, for Armv8.1, `__ARM_ARCH` is 8 * 100 + 1 or 801. To set the ARM architecture version, see [`/arch (ARM64)`](../build/reference/arch-arm64.md). This macro was introduced in Visual Studio 2022 version 17.10. - `__ATOM__` Defined as 1 when the [`/favor:ATOM`](../build/reference/favor-optimize-for-architecture-specifics.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. -- `__AVX__` Defined as 1 when the [`/arch:AVX`](../build/reference/arch-x86.md), [`/arch:AVX2`](../build/reference/arch-x86.md), [`/arch:AVX512`](../build/reference/arch-x86.md) or [`/arch:AVX10.1`](../build/reference/arch-x86.md) compiler options are set and the compiler target is x86 or x64. Otherwise, undefined. +- `__AVX__` Defined as 1 when the [`/arch:AVX`](../build/reference/arch-x86.md), [`/arch:AVX2`](../build/reference/arch-x86.md), [`/arch:AVX512`](../build/reference/arch-x86.md), [`/arch:AVX10.1`](../build/reference/arch-x86.md), or [`/arch:AVX10.2`](../build/reference/arch-x86.md) compiler options are set and the compiler target is x86 or x64. Otherwise, undefined. + +- `__AVX2__` Defined as 1 when the [`/arch:AVX2`](../build/reference/arch-x86.md), [`/arch:AVX512`](../build/reference/arch-x86.md), [`/arch:AVX10.1`](../build/reference/arch-x86.md), or [`/arch:AVX10.2`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. + +- `__AVX512BW__` Defined as 1 when the [`/arch:AVX512`](../build/reference/arch-x86.md), [`/arch:AVX10.1`](../build/reference/arch-x86.md), or [`/arch:AVX10.2`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. -- `__AVX2__` Defined as 1 when the [`/arch:AVX2`](../build/reference/arch-x86.md), [`/arch:AVX512`](../build/reference/arch-x86.md) or [`/arch:AVX10.1`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. +- `__AVX512CD__` Defined as 1 when the [`/arch:AVX512`](../build/reference/arch-x86.md), [`/arch:AVX10.1`](../build/reference/arch-x86.md), or [`/arch:AVX10.2`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. -- `__AVX512BW__` Defined as 1 when the [`/arch:AVX512`](../build/reference/arch-x86.md) or [`/arch:AVX10.1`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. +- `__AVX512DQ__` Defined as 1 when the [`/arch:AVX512`](../build/reference/arch-x86.md), [`/arch:AVX10.1`](../build/reference/arch-x86.md), or [`/arch:AVX10.2`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. -- `__AVX512CD__` Defined as 1 when the [`/arch:AVX512`](../build/reference/arch-x86.md) or [`/arch:AVX10.1`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. +- `__AVX512F__` Defined as 1 when the [`/arch:AVX512`](../build/reference/arch-x86.md), [`/arch:AVX10.1`](../build/reference/arch-x86.md), or [`/arch:AVX10.2`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. -- `__AVX512DQ__` Defined as 1 when the [`/arch:AVX512`](../build/reference/arch-x86.md) or [`/arch:AVX10.1`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. +- `__AVX512VL__` Defined as 1 when the [`/arch:AVX512`](../build/reference/arch-x86.md), [`/arch:AVX10.1`](../build/reference/arch-x86.md), or [`/arch:AVX10.2`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. -- `__AVX512F__` Defined as 1 when the [`/arch:AVX512`](../build/reference/arch-x86.md) or [`/arch:AVX10.1`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. +- `__AVX10_VER__` Defined as an integer that represents version of AVX10 when the [`/arch:AVX10.1`](../build/reference/arch-x86.md) or [`/arch:AVX10.2`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. -- `__AVX512VL__` Defined as 1 when the [`/arch:AVX512`](../build/reference/arch-x86.md) or [`/arch:AVX10.1`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. +- `__CCMP__` Defined as 1 when the [`/feature:APX`](../build/reference/feature-x64.md) compiler option is set and the compiler target is x64. Otherwise, undefined. -- `__AVX10_VER__` Defined as an integer that represents version of AVX10 when the [`/arch:AVX10.1`](../build/reference/arch-x86.md) compiler option is set and the compiler target is x86 or x64. Otherwise, undefined. +- `__CF__` Defined as 1 when the [`/feature:APX`](../build/reference/feature-x64.md) compiler option is set and the compiler target is x64. Otherwise, undefined. - `_CHAR_UNSIGNED` Defined as 1 if the default **`char`** type is unsigned. This value is defined when the [**`/J`** (Default char type is unsigned)](../build/reference/j-default-char-type-is-unsigned.md) compiler option is set. Otherwise, undefined. @@ -169,6 +175,8 @@ MSVC supports other predefined macros: - `_DLL` Defined as 1 when the [`/MD`](../build/reference/md-mt-ld-use-run-time-library.md) or [`/MDd`](../build/reference/md-mt-ld-use-run-time-library.md) (Multithreaded DLL) compiler option is set. Otherwise, undefined. +- `__EGPR__` Defined as 1 when the [`/feature:APX`](../build/reference/feature-x64.md) compiler option is set and the compiler target is x64. Otherwise, undefined. + - `__FUNCDNAME__` Defined as a string literal that contains the [decorated name](../build/reference/decorated-names.md) of the enclosing function. The macro is defined only within a function. The `__FUNCDNAME__` macro isn't expanded if you use the [`/EP`](../build/reference/ep-preprocess-to-stdout-without-hash-line-directives.md) or [`/P`](../build/reference/p-preprocess-to-a-file.md) compiler option. This example uses the `__FUNCDNAME__`, `__FUNCSIG__`, and `__FUNCTION__` macros to display function information. @@ -179,7 +187,7 @@ MSVC supports other predefined macros: - `__FUNCTION__` Defined as a string literal that contains the undecorated name of the enclosing function. The macro is defined only within a function. The `__FUNCTION__` macro isn't expanded if you use the [`/EP`](../build/reference/ep-preprocess-to-stdout-without-hash-line-directives.md) or [`/P`](../build/reference/p-preprocess-to-a-file.md) compiler option. For an example of usage, see the `__FUNCDNAME__` macro. -- `_INTEGRAL_MAX_BITS` Defined as the integer literal value 64, the maximum size (in bits) for a non-vector integral type. This macro is always defined. +- `_INTEGRAL_MAX_BITS` Defined as the integer literal value 64, the maximum size (in bits) for a nonvector integral type. This macro is always defined. ```cpp // integral_max_bits.cpp @@ -234,10 +242,8 @@ MSVC supports other predefined macros: - `_M_IX86_FP` Defined as an integer literal value that indicates the [`/arch`](../build/reference/arch-arm.md) compiler option that was set, or the default. This macro is always defined when the compilation target is an x86 processor. Otherwise, undefined. When defined, the value is: - 0 if the `/arch:IA32` compiler option was set. - - 1 if the `/arch:SSE` compiler option was set. - - - 2 if the `/arch:SSE2`, `/arch:AVX`, `/arch:AVX2`, `/arch:AVX512` or `/arch:AVX10.1` compiler option was set. This value is the default if an `/arch` compiler option wasn't specified. When `/arch:AVX` is specified, the macro `__AVX__` is also defined. When `/arch:AVX2` is specified, both `__AVX__` and `__AVX2__` are also defined. When `/arch:AVX512` is specified, `__AVX__`, `__AVX2__`, `__AVX512BW__`, `__AVX512CD__`, `__AVX512DQ__`, `__AVX512F__`, and `__AVX512VL__` are also defined. When `/arch:AVX10.1` is specified, `__AVX__`, `__AVX2__`, `__AVX512BW__`, `__AVX512CD__`, `__AVX512DQ__`, `__AVX512F__`, `__AVX512VL__` and `__AVX10_VER__` are also defined. + - 2 if the `/arch:SSE2`, `/arch:AVX`, `/arch:AVX2`, `/arch:AVX512`, `/arch:AVX10.1`, or `/arch:AVX10.2` compiler option was set. This value is the default if an `/arch` compiler option wasn't specified. When `/arch:AVX` is specified, the macro `__AVX__` is also defined. When `/arch:AVX2` is specified, both `__AVX__` and `__AVX2__` are also defined. When `/arch:AVX512` is specified, `__AVX__`, `__AVX2__`, `__AVX512BW__`, `__AVX512CD__`, `__AVX512DQ__`, `__AVX512F__`, and `__AVX512VL__` are also defined. When `/arch:AVX10.1` or `/arch:AVX10.2` is specified, `__AVX__`, `__AVX2__`, `__AVX512BW__`, `__AVX512CD__`, `__AVX512DQ__`, `__AVX512F__`, `__AVX512VL__` and `__AVX10_VER__` are also defined. - For more information, see [**`/arch`** (x86)](../build/reference/arch-x86.md). @@ -289,6 +295,10 @@ MSVC supports other predefined macros: - `_MT` Defined as 1 when [**`/MD`** or **`/MDd`** (Multithreaded DLL)](../build/reference/md-mt-ld-use-run-time-library.md) or [**`/MT`** or **`/MTd`** (Multithreaded)](../build/reference/md-mt-ld-use-run-time-library.md) is specified. Otherwise, undefined. +- `__NDD__` Defined as 1 when the [`/feature:APX`](../build/reference/feature-x64.md) compiler option is set and the compiler target is x64. Otherwise, undefined. + +- `__NF__` Defined as 1 when the [`/feature:APX`](../build/reference/feature-x64.md) compiler option is set and the compiler target is x64. Otherwise, undefined. + - `_NATIVE_WCHAR_T_DEFINED` Defined as 1 when the [`/Zc:wchar_t`](../build/reference/zc-wchar-t-wchar-t-is-native-type.md) compiler option is set. Otherwise, undefined. - `_OPENMP` Defined as integer literal 200203, if the [**`/openmp`** (Enable OpenMP 2.0 Support)](../build/reference/openmp-enable-openmp-2-0-support.md) compiler option is set. This value represents the date of the OpenMP specification implemented by MSVC. Otherwise, undefined. @@ -302,8 +312,12 @@ MSVC supports other predefined macros: } ``` +- `__PPX__` Defined as 1 when the [`/feature:APX`](../build/reference/feature-x64.md) compiler option is set and the compiler target is x64. Otherwise, undefined. + - `_PREFAST_` Defined as 1 when the [`/analyze`](../build/reference/analyze-code-analysis.md) compiler option is set. Otherwise, undefined. +- `__PUSH2POP2__` Defined as 1 when the [`/feature:APX`](../build/reference/feature-x64.md) compiler option is set and the compiler target is x64. Otherwise, undefined. + - `__SANITIZE_ADDRESS__` Available beginning with Visual Studio 2019 version 16.9. Defined as 1 when the [`/fsanitize=address`](../build/reference/fsanitize.md) compiler option is set. Otherwise, undefined. - `__TIMESTAMP__` Defined as a string literal that contains the date and time of the last modification of the current source file, in the abbreviated, constant length form returned by the CRT [`asctime`](../c-runtime-library/reference/asctime-wasctime.md) function, for example, `Fri 19 Aug 13:32:58 2016`. This macro is always defined. @@ -318,6 +332,8 @@ MSVC supports other predefined macros: - `_WINRT_DLL` Defined as 1 when compiled as C++ and both [**`/ZW`** (Windows Runtime Compilation)](../build/reference/zw-windows-runtime-compilation.md) and [**`/LD`** or **`/LDd`**](../build/reference/md-mt-ld-use-run-time-library.md) compiler options are set. Otherwise, undefined. +- `__ZU__` Defined as 1 when the [`/feature:APX`](../build/reference/feature-x64.md) compiler option is set and the compiler target is x64. Otherwise, undefined. + No preprocessor macros that identify the ATL or MFC library version are predefined by the compiler. ATL and MFC library headers define these version macros internally. They're undefined in preprocessor directives made before the required header is included. - `_ATL_VER` Defined in `` as an integer literal that encodes the ATL version number. diff --git a/docs/preprocessor/preprocessor-directives.md b/docs/preprocessor/preprocessor-directives.md index 38d13833a81..f3c11dd326f 100644 --- a/docs/preprocessor/preprocessor-directives.md +++ b/docs/preprocessor/preprocessor-directives.md @@ -1,13 +1,12 @@ --- description: "Learn more about: Preprocessor directives" title: "Preprocessor directives" -ms.date: "08/29/2019" +ms.date: 10/15/2025 helpviewer_keywords: ["directives, preprocessor", "preprocessor, directives"] -ms.assetid: e0fc4564-b6cf-4a36-bf51-6ccd7abd0a94 --- # Preprocessor directives -Preprocessor directives, such as `#define` and `#ifdef`, are typically used to make source programs easy to change and easy to compile in different execution environments. Directives in the source file tell the preprocessor to take specific actions. For example, the preprocessor can replace tokens in the text, insert the contents of other files into the source file, or suppress compilation of part of the file by removing sections of text. Preprocessor lines are recognized and carried out before macro expansion. Therefore, if a macro expands into something that looks like a preprocessor command, it isn't recognized by the preprocessor. +Preprocessor directives, such as `#define` and `#ifdef`, are used to make source programs easy to change and compile in different execution environments. Directives in the source file tell the preprocessor to take specific actions. For example, the preprocessor can replace tokens in the text, insert the contents of other files into the source file, or suppress compilation of part of the file by removing sections of text. Preprocessor directives are processed before macro expansion. Therefore, if a macro expands into something that looks like a preprocessor command, it isn't recognized by the preprocessor. Preprocessor statements use the same character set as source file statements, with the exception that escape sequences aren't supported. The character set used in preprocessor statements is the same as the execution character set. The preprocessor also recognizes negative character values. @@ -29,7 +28,8 @@ The preprocessor recognizes the following directives: :::column span=""::: [`#import`](../preprocessor/hash-import-directive-cpp.md)\ [`#include`](../preprocessor/hash-include-directive-c-cpp.md)\ - [`#line`](../preprocessor/hash-line-directive-c-cpp.md) + [`#line`](../preprocessor/hash-line-directive-c-cpp.md)\ + [`#warning`](../preprocessor/hash-warning-directive-c-cpp.md) :::column-end::: :::column span=""::: [`#pragma`](../preprocessor/pragma-directives-and-the-pragma-keyword.md)\ diff --git a/docs/preprocessor/toc.yml b/docs/preprocessor/toc.yml index 4535a25eb64..aa4066ec4e0 100644 --- a/docs/preprocessor/toc.yml +++ b/docs/preprocessor/toc.yml @@ -92,6 +92,8 @@ items: href: ../preprocessor/hash-undef-directive-c-cpp.md - name: "#using directive (C++/CLI)" href: ../preprocessor/hash-using-directive-cpp.md + - name: "#warning directive (C/C++)" + href: ../preprocessor/hash-warning-directive-c-cpp.md - name: Preprocessor operators expanded: false items: diff --git a/docs/preprocessor/warning.md b/docs/preprocessor/warning.md index 8d6d994f0ad..4a731996c3e 100644 --- a/docs/preprocessor/warning.md +++ b/docs/preprocessor/warning.md @@ -29,7 +29,8 @@ The following warning-specifier parameters are available. | `disable` | Don't issue the specified warning messages. The optional **`justification`** property is allowed. | | `error` | Report the specified warnings as errors. | | `once` | Display the specified message(s) only one time. | -| `suppress` | Pushes the current state of the pragma on the stack, disables the specified warning for the next line, and then pops the warning stack so that the pragma state is reset. The optional **`justification`** property is allowed. | +| `suppress` | Pushes the current state of the pragma on the stack, disables the specified warning for the next line, and then pops the warning stack so that the pragma state is reset. | +| `justification` | Optional string describing the reason for disabling or suppressing the warning. Introduced in Visual Studio 2022 version 17.14. | The following code statement illustrates that a *`warning-number-list`* parameter can contain multiple warning numbers, and that multiple *`warning-specifier`* parameters can be specified in the same pragma directive. @@ -43,8 +44,8 @@ However, when the **`justification`** field is present, only one warning number #pragma warning( disable : 4507, justification : "This warning is disabled" ) ``` -The **`justification`** fields allows you to explain why a warning is being disable or -suppressed. The **`justification`** field is only supported for the **`disable`** and **`suppress`** *`warning-specifier`*. This value will appear in the SARIF output when the `/analyze:log:includesuppressed` option is specified. Its value is a UTF-8 encoded narrow string literal. +Use the **`justification`** field to explain why a warning is being disabled or +suppressed. The **`justification`** field is only supported for the **`disable`** and **`suppress`** *`warning-specifier`*. The justification appears in the Static Analysis Results Interchange Format ([SARIF](https://sarif.info/)) output when the `/analyze:log:includesuppressed` option is specified. Its value is a UTF-8 encoded narrow string literal. To generate a SARIF file, use the `/analyze:log:format:sarif` compiler option. This directive is functionally equivalent to the following code: @@ -114,8 +115,16 @@ When you write header files, you can use `push` and `pop` to guarantee that warn #pragma warning( pop ) ``` +**Choosing between `#pragma warning` and `[[gsl::suppress]]`** + +Both `#pragma warning(suppress)` and `[[gsl::suppress]]` offer fine-grained control over warning suppression: +- `[[gsl::suppress]]` only suppresses warnings emitted by Microsoft C++ Code Analysis. Use it with the C++ Core Guidelines checks, which can be applied to a scope or a specific declaration. +- `#pragma warning(suppress)` can be used for any compiler warning. It’s useful when you need to suppress a warning in a specific code block without altering the code’s structure significantly. + +Whenever possible, use [`[[gsl::suppress]]`](../cpp/attributes.md#gslsuppresstag--justification-narrow-string-literal) for suppressing Microsoft C++ Code Analysis warnings. + For more information about compiler options that help you suppress warnings, see [`/FI`](../build/reference/fi-name-forced-include-file.md) and [`/w`](../build/reference/compiler-option-warning-level.md). ## See also -[Pragma directives and the `__pragma` and `_Pragma` keywords](./pragma-directives-and-the-pragma-keyword.md) +[Pragma directives and the `__pragma` and `_Pragma` keywords](pragma-directives-and-the-pragma-keyword.md) \ No newline at end of file diff --git a/docs/sanitizers/asan-building.md b/docs/sanitizers/asan-building.md index b04ac105607..a4fa4cd5814 100644 --- a/docs/sanitizers/asan-building.md +++ b/docs/sanitizers/asan-building.md @@ -1,30 +1,32 @@ --- -title: "AddressSanitizer language, build, and debugging reference" -description: "Technical description of building for the AddressSanitizer" +title: "MSVC AddressSanitizer language, build, and debugging reference" +description: "Technical description of building for the MSVC AddressSanitizer" ms.date: 02/05/2024 +ms.topic: overview f1_keywords: ["__SANITIZE_ADDRESS__", "ASAN_VCASAN_DEBUGGING"] -helpviewer_keywords: ["ASan reference", "AddressSanitizer reference", "Address Sanitizer reference"] +helpviewer_keywords: ["ASan reference", "MSVC AddressSanitizer reference", "MSVC Address Sanitizer reference"] --- -# AddressSanitizer language, build, and debugging reference +# MSVC AddressSanitizer language, build, and debugging reference -This article describes the AddressSanitizer language specification, compiler options, linker options, and the options that control Visual Studio debugger integration specific to the AddressSanitizer. +This article describes the MSVC AddressSanitizer language specification, compiler options, linker options, and the options that control Visual Studio debugger integration specific to the MSVC AddressSanitizer. -For more information on the AddressSanitizer runtime, see the [runtime reference](asan-runtime.md). It includes information on intercepted functions and how to hook custom allocators. For more information on saving crash dumps from AddressSanitizer failures, see the [crash dump reference](asan-offline-crash-dumps.md). +For more information on the MSVC AddressSanitizer runtime, see the [runtime reference](asan-runtime.md). It includes information on intercepted functions and how to hook custom allocators. For more information on saving crash dumps from MSVC AddressSanitizer failures, see the [crash dump reference](asan-offline-crash-dumps.md). ## Language specification ### `__SANITIZE_ADDRESS__` -The `__SANITIZE_ADDRESS__` preprocessor macro is defined as `1` when [`/fsanitize=address`](../build/reference/fsanitize.md) is set. This macro is useful for advanced users to conditionally specify source code for the presence of the AddressSanitizer runtime. +The `__SANITIZE_ADDRESS__` preprocessor macro is defined as `1` when [`/fsanitize=address`](../build/reference/fsanitize.md) is set. This macro is useful to conditionally specify source code for the presence of the MSVC AddressSanitizer runtime. ```cpp #include -int main() { +int main() +{ #ifdef __SANITIZE_ADDRESS__ - printf("Address sanitizer enabled"); + printf("MSVC AddressSanitizer enabled"); #else - printf("Address sanitizer not enabled"); + printf("MSVC AddressSanitizer not enabled"); #endif return 1; } @@ -35,19 +37,30 @@ int main() { The [`__declspec(no_sanitize_address)`](../cpp/no-sanitize-address.md) specifier can be used to selectively disable the sanitizer on functions, local variables, or global variables. This `__declspec` affects _compiler_ behavior, not _runtime_ behavior. ```cpp -__declspec(no_sanitize_address) -void test1() { +#ifdef __SANITIZE_ADDRESS__ +// no_sanitize_address is only defined when compiling with MSVC AddressSanitizer. +// Guard against this by checking if `__SANITIZE_ADDRESS__` is defined. +#define NO_SANITIZE_ADDRESS __declspec(no_sanitize_address) +#else +#define NO_SANITIZE_ADDRESS +#endif + +NO_SANITIZE_ADDRESS +void test1() +{ int x[100]; x[100] = 5; // ASan exception not caught } -void test2() { - __declspec(no_sanitize_address) int x[100]; +void test2() +{ + NO_SANITIZE_ADDRESS int x[100]; x[100] = 5; // ASan exception not caught } -__declspec(no_sanitize_address) int g[100]; -void test3() { +NO_SANITIZE_ADDRESS int g[100]; +void test3() +{ g[100] = 5; // ASan exception not caught } ``` @@ -56,11 +69,11 @@ void test3() { ### `/fsanitize=address` compiler option -The [**`/fsanitize=address`**](../build/reference/fsanitize.md) compiler option instruments memory references in your code to catch memory safety errors at runtime. The instrumentation hooks loads, stores, scopes, `alloca`, and CRT functions. It can detect hidden bugs such as out-of-bounds, use-after-free, use-after-scope, and so on. For a nonexhaustive list of errors detected at runtime, see [AddressSanitizer error examples](asan-error-examples.md). +The [**`/fsanitize=address`**](../build/reference/fsanitize.md) compiler option instruments memory references in your code to catch memory safety errors at runtime. The instrumentation hooks loads, stores, scopes, `alloca`, and CRT functions. It can detect hidden bugs such as out-of-bounds, use-after-free, use-after-scope, and so on. For a nonexhaustive list of errors detected at runtime, see [MSVC AddressSanitizer error examples](asan-error-examples.md). **`/fsanitize=address`** is compatible with all existing C++ or C optimization levels (for example, **`/Od`**, **`/O1`**, **`/O2`**, and **`/O2 /GL`**). The code produced with this option works with static and dynamic CRTs (for example, **`/MD`**, **`/MDd`**, **`/MT`**, and **`/MTd`**). This compiler option can be used to create an .EXE or .DLL targeting x86 or x64. Debug information is required for optimal formatting of call stacks. This compiler option isn't supported with profile guided optimization. -For examples of code that demonstrates several kinds of error detection, see [AddressSanitizer error examples](asan-error-examples.md). +For examples of code that demonstrates several kinds of error detection, see [MSVC AddressSanitizer error examples](asan-error-examples.md). ### `/fsanitize=fuzzer` compiler option (experimental) @@ -95,7 +108,7 @@ If you specify **`/NODEFAULTLIB`** and you don't specify one of these libraries, ### `/fsanitize-address-use-after-return` compiler option (experimental) -By default, the MSVC compiler (unlike Clang) doesn't generate code to allocate frames in the heap to catch use-after-return errors. To catch these errors using AddressSanitizer, you must: +By default, the MSVC compiler (unlike Clang) doesn't generate code to allocate frames in the heap to catch use-after-return errors. To catch these errors using MSVC AddressSanitizer, you must: 1. Compile using the [`/fsanitize-address-use-after-return`](../build/reference/fsanitize.md) option. 2. Before executing your program, run `set ASAN_OPTIONS=detect_stack_use_after_return=1` to set the runtime check option. @@ -120,13 +133,13 @@ Using **`/fsanitize-address-asan-compat-lib`** to link a newer compiler with an ### `/INFERASANLIBS[:NO]` linker option -The **`/fsanitize=address`** compiler option marks objects to specify which AddressSanitizer library to link into your executable. The libraries have names that begin with *`clang_rt.asan*`*. The [`/INFERASANLIBS`](../build/reference/inferasanlibs.md) linker option (on by default) links these libraries from their default locations automatically. Here are the libraries chosen and automatically linked in. +The **`/fsanitize=address`** compiler option marks objects to specify which MSVC AddressSanitizer library to link into your executable. The libraries have names that begin with *`clang_rt.asan*`*. The [`/INFERASANLIBS`](../build/reference/inferasanlibs.md) linker option (on by default) links these libraries from their default locations automatically. Here are the libraries chosen and automatically linked in. > [!NOTE] > In the following table, *`{arch}`* is either *`i386`* or *`x86_64`*. > These libraries use Clang conventions for architecture names. MSVC conventions are normally `x86` and `x64` rather than `i386` and `x86_64`. They refer to the same architectures. -| CRT option | AddressSanitizer runtime library (.lib) | Address runtime binary (.dll) +| CRT option | MSVC AddressSanitizer runtime library (.lib) | Address runtime binary (.dll) |--|--|--| | `/MT` or `/MTd` | *`clang_rt.asan_dynamic-{arch}.lib`*, *`/wholearchive:clang_rt.asan_static_runtime_thunk-{arch}.lib`* | *`clang_rt.asan_dynamic-{arch}.dll`* | `/MD` or `/MDd` | *`clang_rt.asan_dynamic-{arch}.lib`*, *`/wholearchive:clang_rt.asan_dynamic_runtime_thunk-{arch}.lib`* | *`clang_rt.asan_dynamic-{arch}.dll`* @@ -135,10 +148,9 @@ The linker option [`/INFERASANLIBS:NO`](../build/reference/inferasanlibs.md) pre **Previous Versions** -Prior to Visual Studio 17.7 Preview 3, statically linked (**`/MT`** or **`/MTd`**) builds didn't use a DLL dependency. Instead, the AddressSanitizer runtime was statically linked into the user's EXE. DLL projects would then load exports from the user's EXE to access ASan functionality. Also, dynamically linked projects (**`/MD`** or **`/MTd`**) used different libraries and DLLs depending on whether the project was configured for debug or release. For more information about these changes and their motivations, see [MSVC Address Sanitizer – One DLL for all Runtime Configurations](https://devblogs.microsoft.com/cppblog/msvc-address-sanitizer-one-dll-for-all-runtime-configurations/). +Prior to Visual Studio 17.7 Preview 3, statically linked (**`/MT`** or **`/MTd`**) builds didn't use a DLL dependency. Instead, the MSVC AddressSanitizer runtime was statically linked into the user's EXE. DLL projects would then load exports from the user's EXE to access ASan functionality. Also, dynamically linked projects (**`/MD`** or **`/MTd`**) used different libraries and DLLs depending on whether the project was configured for debug or release. For more information about these changes and their motivations, see [MSVC AddressSanitizer – One DLL for all Runtime Configurations](https://devblogs.microsoft.com/cppblog/msvc-address-sanitizer-one-dll-for-all-runtime-configurations/). - -| CRT runtime option | DLL or EXE | AddressSanitizer runtime libraries | +| CRT runtime option | DLL or EXE | MSVC AddressSanitizer runtime libraries | |--|--|--| | **`/MT`** | EXE | *`/wholearchive:clang_rt.asan-{arch}.lib`*, *`clang_rt.asan_cxx-{arch}.lib`* | | **`/MT`** | DLL | *`/wholearchive:clang_rt.asan_dll_thunk-{arch}.lib`* | @@ -151,7 +163,7 @@ Prior to Visual Studio 17.7 Preview 3, statically linked (**`/MT`** or **`/MTd`* ### `/fno-sanitize-address-vcasan-lib` compiler option -The **`/fsanitize=address`** option links in extra libraries for an improved Visual Studio debugging experience when an AddressSanitizer exception is thrown. These libraries are called **VCAsan**. The libraries enable Visual Studio to display AddressSanitizer errors on your source code. They also enable the executable to generate crash dumps when an AddressSanitizer error report is created. For more information, see [Visual Studio AddressSanitizer extended functionality library](asan-debugger-integration.md). +The **`/fsanitize=address`** option links in extra libraries for an improved Visual Studio debugging experience when an MSVC AddressSanitizer exception is thrown. These libraries are called **VCAsan**. The libraries enable Visual Studio to display MSVC AddressSanitizer errors on your source code. They also enable the executable to generate crash dumps when an MSVC AddressSanitizer error report is created. For more information, see [Visual Studio MSVC AddressSanitizer extended functionality library](asan-debugger-integration.md). The library chosen depends on the compiler options, and is automatically linked in. @@ -179,10 +191,10 @@ To enable this behavior, run the command `set ASAN_VCASAN_DEBUGGING=1` before yo ## See also -[AddressSanitizer overview](asan.md)\ -[AddressSanitizer known issues](asan-known-issues.md)\ -[AddressSanitizer runtime reference](asan-runtime.md)\ -[AddressSanitizer shadow bytes](asan-shadow-bytes.md)\ -[AddressSanitizer cloud or distributed testing](asan-offline-crash-dumps.md)\ -[AddressSanitizer debugger integration](asan-debugger-integration.md)\ -[AddressSanitizer error examples](asan-error-examples.md) +[MSVC AddressSanitizer overview](asan.md)\ +[MSVC AddressSanitizer known issues](asan-known-issues.md)\ +[MSVC AddressSanitizer runtime reference](asan-runtime.md)\ +[MSVC AddressSanitizer shadow bytes](asan-shadow-bytes.md)\ +[MSVC AddressSanitizer cloud or distributed testing](asan-offline-crash-dumps.md)\ +[MSVC AddressSanitizer debugger integration](asan-debugger-integration.md)\ +[MSVC AddressSanitizer error examples](asan-error-examples.md) diff --git a/docs/sanitizers/asan-continue-on-error.md b/docs/sanitizers/asan-continue-on-error.md index 9d820f863e8..f89ab731aea 100644 --- a/docs/sanitizers/asan-continue-on-error.md +++ b/docs/sanitizers/asan-continue-on-error.md @@ -1,18 +1,18 @@ --- -title: "Walkthrough: Use Address Sanitizer Continue On Error to find memory safety issues" -description: "Learn how to use Address Sanitizer continue on error to find memory safety errors in your app." +title: "Walkthrough: Use AddressSanitizer Continue On Error to find memory safety issues" +description: "Learn how to use AddressSanitizer continue on error to find memory safety errors in your app." ms.date: 07/31/2023 f1_keywords: ["AddressSanitizer", "Continue On Error"] helpviewer_keywords: ["ASan", "AddressSanitizer", "Address Sanitizer", "compiling for AddressSanitizer", "Continue On Error", "ASAN continue on error", "Address Sanitizer continue on error"] --- -# Walkthrough: Use Address Sanitizer Continue On Error to find memory safety issues +# Walkthrough: Use AddressSanitizer Continue On Error to find memory safety issues In this walkthrough, create checked builds that find and report memory safety errors. -Memory safety errors like out-of-bounds memory reads and writes, using memory after it has been freed, `NULL` pointer dereferences, and so on, are a top concern for C/C++ code. Address Sanitizer (ASAN) is a compiler and runtime technology that exposes these kinds of hard-to-find bugs, and does it with zero false positives. For an overview of ASAN, see [AddressSanitizer](asan.md). +Memory safety errors like out-of-bounds memory reads and writes, using memory after it has been freed, `NULL` pointer dereferences, and so on, are a top concern for C/C++ code. AddressSanitizer (ASAN) is a compiler and runtime technology that exposes these kinds of hard-to-find bugs, and does it with zero false positives. For an overview of ASAN, see [AddressSanitizer](asan.md). -Continue On Error (COE) is a new ASAN feature that automatically diagnoses and reports memory safety errors as your app runs. When your program exits, a summary of unique memory safety errors is output to `stdout`, `stderr`, or to a log file of your choice. When you create a standard C++ checked build with `-fsanitizer=address`, calls to allocators, deallocators such as `free`, `memcpy`, `memset`, and so on, are forwarded to the ASAN runtime. The ASAN runtime provides the same semantics for these functions, but monitors what happens with the memory. ASAN diagnoses and reports hidden memory safety errors, with zero false positives, as your app runs. +Continue On Error (COE) is a new ASAN feature that automatically diagnoses and reports memory safety errors as your app runs. When your program exits, a summary of unique memory safety errors is output to `stdout`, `stderr`, or to a log file of your choice. When you create a standard C++ checked build with `-fsanitize=address`, calls to allocators, deallocators such as `free`, `memcpy`, `memset`, and so on, are forwarded to the ASAN runtime. The ASAN runtime provides the same semantics for these functions, but monitors what happens with the memory. ASAN diagnoses and reports hidden memory safety errors, with zero false positives, as your app runs. A significant advantage of COE is that, unlike the previous ASAN behavior, your program doesn't stop running when the first memory error is found. Instead, ASAN notes the error, and your app continues to run. After your app exits, a summary of all the memory issues is output. @@ -44,21 +44,21 @@ Create the example: ```cpp #include #include - + void BadFunction(int *pointer) { free(pointer); free(pointer); // double-free! } - + int main(int argc, const char *argv[]) { int *pointer = static_cast(malloc(4)); BadFunction(pointer); - + // Normally we'd crash before this, but with COE we can see heap-use-after-free error as well printf("\n\n******* Pointer value: %d\n", *pointer); - + return 1; } ``` @@ -67,7 +67,7 @@ In the preceding code, `pointer` is freed twice. This is a contrived example, bu Create a build of the preceding code with COE turned on with the following steps: -1. Compile the code in the developer command prompt you opened earlier: `cl -fsanitize=address -Zi doublefree.cpp`. The `-fsanitize=address` switch turns on ASAN, and `-Zi` creates a separate PDB file that address sanitizer uses to display memory error location information. +1. Compile the code in the developer command prompt you opened earlier: `cl -fsanitize=address -Zi doublefree.cpp`. The `-fsanitize=address` switch turns on ASAN, and `-Zi` creates a separate PDB file that AddressSanitizer uses to display memory error location information. 1. Send ASAN output to `stdout` by setting the `ASAN_OPTIONS` environment variable in the developer command prompt as follows: `set ASAN_OPTIONS=continue_on_error=1` 1. Run the test code with: `doublefree.exe` @@ -181,24 +181,24 @@ Create the example: 1. In that directory, create a source file, for example, `coe.cpp`, and paste the following code: ```cpp - #include - + #include + char* func(char* buf, size_t sz) - { - char* local = (char*)malloc(sz); - for (auto ii = 0; ii <= sz; ii++) // bad loop exit test + { + char* local = (char*)malloc(sz); + for (auto ii = 0; ii <= sz; ii++) // bad loop exit test { - local[ii] = ~buf[ii]; // Two memory safety errors + local[ii] = ~buf[ii]; // Two memory safety errors } - - return local; - } - - char buffer[10] = {0,1,2,3,4,5,6,7,8,9}; - + + return local; + } + + char buffer[10] = {0,1,2,3,4,5,6,7,8,9}; + int main() - { - char* inverted_buf= func(buffer, 10); + { + char* inverted_buf= func(buffer, 10); } ``` @@ -213,7 +213,7 @@ Errors are only observable if the page following the allocation is unmapped, or Create a build of the preceding code with COE turned on: -1. Compile the code with `cl -fsanitize=address -Zi coe.cpp`. The `-fsanitize=address` switch turns on ASAN, and `-Zi` creates a separate PDB file that address sanitizer uses to display memory error location information. +1. Compile the code with `cl -fsanitize=address -Zi coe.cpp`. The `-fsanitize=address` switch turns on ASAN, and `-Zi` creates a separate PDB file that AddressSanitizer uses to display memory error location information. 1. Send ASAN output to `stdout` by setting the `ASAN_OPTIONS` environment variable in the developer command prompt as follows: `set ASAN_OPTIONS=continue_on_error=1` 1. Run the test code with: `coe.exe` @@ -263,7 +263,7 @@ File: C:\Users\xxx\Desktop\COE\coe.cpp Raw HitCnt: 1 On Reference: 1-byte-write-heap-buffer-overflow ``` -The default Address Sanitizer runtime behavior terminates the app after reporting the first error it finds. It doesn't allow the "bad" machine instruction to execute. The new Address Sanitizer runtime diagnoses and reports errors, but then executes subsequent instructions. +The default AddressSanitizer runtime behavior terminates the app after reporting the first error it finds. It doesn't allow the "bad" machine instruction to execute. The new AddressSanitizer runtime diagnoses and reports errors, but then executes subsequent instructions. COE tries to automatically return control back to the application after reporting each memory safety error. There are situations when it can't, such as when there's a memory access violation (AV) or a failed memory allocation. COE doesn't continue after access violations that the program's structured exception handling doesn't catch. If COE can't return execution to the app, a `CONTINUE CANCELLED - Deadly Signal. Shutting down.` message is output. @@ -339,7 +339,7 @@ int main() In `main()` a large number is passed to `foo_redundant`, which is ultimately passed to `_alloca()`, which causes `_alloca()` to fail. -This example outputs `pass` when compiled without ASAN (that is, no `-fsanitize=address` switch) but outputs `fail` when compiled with ASAN turned on (that is, with the `-fsanitize=address` switch). That's because without ASAN, the exception code matches `RET_STACK_EXCEPTION` so `cnt` is set to 1. It behaves differently when compiled with ASAN on because the thrown exception is an Address Sanitizer error instead: dynamic-stack-buffer-overflow. That means the code returns `RET_OTHER_EXCEPTION` instead of `RET_STACK_EXCEPTION` so `cnt` isn't set to 1. +This example outputs `pass` when compiled without ASAN (that is, no `-fsanitize=address` switch) but outputs `fail` when compiled with ASAN turned on (that is, with the `-fsanitize=address` switch). That's because without ASAN, the exception code matches `RET_STACK_EXCEPTION` so `cnt` is set to 1. It behaves differently when compiled with ASAN on because the thrown exception is an AddressSanitizer error instead: dynamic-stack-buffer-overflow. That means the code returns `RET_OTHER_EXCEPTION` instead of `RET_STACK_EXCEPTION` so `cnt` isn't set to 1. ## Other benefits diff --git a/docs/sanitizers/asan-flags.md b/docs/sanitizers/asan-flags.md index 63633fa5e46..5b526a8cf1b 100644 --- a/docs/sanitizers/asan-flags.md +++ b/docs/sanitizers/asan-flags.md @@ -1,6 +1,6 @@ --- title: "AddressSanitizer Runtime Options" -description: "List of runtime options for the Microsoft C/C++ Address Sanitizer" +description: "List of runtime options for the Microsoft C/C++ AddressSanitizer" ms.date: 8/08/2025 helpviewer_keywords: ["AddressSanitizer options", "AddressSanitizer flags", "Address sanitizer options", "Address sanitizer flags", "asan options", "asan flags", "sanitizer flags", "asan_options", "AddressSanitizerFlags", "SanitizerCommonFlags"] --- diff --git a/docs/sanitizers/asan-known-issues.md b/docs/sanitizers/asan-known-issues.md index b5d899dabc0..7d3b22a2e7a 100644 --- a/docs/sanitizers/asan-known-issues.md +++ b/docs/sanitizers/asan-known-issues.md @@ -1,7 +1,7 @@ --- title: "AddressSanitizer known issues and limitations" description: "Technical description of the AddressSanitizer for Microsoft C/C++ known issues." -ms.date: 5/21/2025 +ms.date: 11/19/2025 helpviewer_keywords: ["AddressSanitizer known issues"] --- @@ -77,7 +77,7 @@ The *`clang_rt.asan*.dll`* runtime files are installed next to the compilers in ## Custom property sheet support -The Visual Studio Property Manager window allows you to add custom *`.props`* files to your projects. Even though the **Enable Address Sanitizer** property (``) is shown, the build doesn't honor it. The build doesn't honor it because the custom *`.props`* files are included after *`Microsoft.cpp.props`*, which uses the `` value to set other properties. +The Visual Studio Property Manager window allows you to add custom *`.props`* files to your projects. Even though the **Enable AddressSanitizer** property (``) is shown, the build doesn't honor it. The build doesn't honor it because the custom *`.props`* files are included after *`Microsoft.cpp.props`*, which uses the `` value to set other properties. As a workaround, create a *`Directory.Build.props`* file in the root of your project to define the `` property. For more information, see [Customize C++ builds](/visualstudio/msbuild/customize-your-build#customize-c-builds). @@ -99,6 +99,12 @@ If all of the DLLs compiled with ASan are unloaded from the process before the p Please report any bugs to our [Developer Community](https://aka.ms/feedback/report?space=62). +## ASan 64-bit first chance exceptions + +On x64, MSVC ASan's [shadow bytes](./asan-shadow-bytes.md) region occupies several terabytes of virtual address space. ASan doesn't pre-commit this memory. Instead, it uses on-demand paging. When a shadow page is accessed for the first time, a first-chance page fault exception occurs and is handled by ASan, which commits the page. + +The Visual Studio debugger handles this gracefully, and doesn't show these traces. However, debuggers like WinDbgX may break on every exception by default. Disabling breaking on first-chance exceptions is recommended. For example, in WinDbgX, this corresponds to the [`sxd av`](/windows-hardware/drivers/debuggercmds/sx--sxd--sxe--sxi--sxn--sxr--sx---set-exceptions-) command. + ## See also [AddressSanitizer overview](asan.md)\ diff --git a/docs/sanitizers/asan-runtime.md b/docs/sanitizers/asan-runtime.md index 43b091af085..4ac0c904d8c 100644 --- a/docs/sanitizers/asan-runtime.md +++ b/docs/sanitizers/asan-runtime.md @@ -7,17 +7,17 @@ helpviewer_keywords: ["AddressSanitizer runtime", "Address Sanitizer runtime", " # AddressSanitizer runtime -The AddressSanitizer runtime library intercepts common memory allocation functions and operations to enable inspection of memory accesses. There are several different runtime libraries that support the various types of executables the compiler may generate. The compiler and linker automatically link the appropriate runtime libraries, as long as you pass the [`/fsanitize=address`](../build/reference/fsanitize.md) option at compile time. You can override the default behavior by using the **`/NODEFAULTLIB`** option at link time. For more information, see the section on [linking](./asan-building.md#linker) in the [AddressSanitizer language, build, and debugging reference](./asan-building.md). +The AddressSanitizer runtime library intercepts common memory allocation functions and operations to enable inspection of memory accesses. There are several different runtime libraries that support the various types of executables the compiler may generate. The compiler and linker automatically link the appropriate runtime libraries, as long as you pass the [`/fsanitize=address`](../build/reference/fsanitize.md) option at compile time. You can override the default behavior by using the **`/NODEFAULTLIB`** option at link time. For more information, see the section on [linking](asan-building.md#linker) in the [AddressSanitizer language, build, and debugging reference](asan-building.md). -When compiling with `cl /fsanitize=address`, the compiler generates instructions to manage and check [shadow bytes](./asan-shadow-bytes.md). Your program uses this instrumentation to check memory accesses on the stack, in the heap, or in the global scope. The compiler also produces metadata describing stack and global variables. This metadata enables the runtime to generate precise error diagnostics: function names, lines, and columns in your source code. Combined, the compiler checks and runtime libraries can precisely diagnose many types of [memory safety bugs](./asan-error-examples.md) if they're encountered at run-time. +When compiling with `cl /fsanitize=address`, the compiler generates instructions to manage and check [shadow bytes](asan-shadow-bytes.md). Your program uses this instrumentation to check memory accesses on the stack, in the heap, or in the global scope. The compiler also produces metadata describing stack and global variables. This metadata enables the runtime to generate precise error diagnostics: function names, lines, and columns in your source code. Combined, the compiler checks and runtime libraries can precisely diagnose many types of [memory safety bugs](asan-error-examples.md) if they're encountered at run-time. -The list of runtime libraries for linking to the AddressSanitizer runtime, as of Visual Studio 17.7 Preview 3, follows. For more information about the `/MT` (statically link the runtime) and `/MD` (dynamically link the redist at runtime) options, see [/MD, /MT, /LD (Use Run-Time Library)](../build/reference/md-mt-ld-use-run-time-library.md). +The list of runtime libraries for linking to the AddressSanitizer runtime, as of Visual Studio 17.7 Preview 3, follows. For more information about the `/MT` (statically link the runtime) and `/MD` (dynamically link the redist at runtime) options, see [`/MD`, `/MT`, `/LD` (Use Run-Time Library)](../build/reference/md-mt-ld-use-run-time-library.md). > [!NOTE] > In the following table, *`{arch}`* is either *`i386`* or *`x86_64`*. > These libraries use Clang conventions for architecture names. MSVC conventions are normally `x86` and `x64` rather than `i386` and `x86_64`, but they refer to the same architectures. -| CRT option | AddressSanitizer runtime library (.lib) | Address runtime binary (.dll) +| CRT option | AddressSanitizer runtime library (`.lib`) | Address runtime binary (`.dll`) |--|--|--| | `/MT` or `/MTd` | *`clang_rt.asan_dynamic-{arch}`*, *`clang_rt.asan_static_runtime_thunk-{arch}`* | *`clang_rt.asan_dynamic-{arch}`* | `/MD` or `/MDd` | *`clang_rt.asan_dynamic-{arch}`*, *`clang_rt.asan_dynamic_runtime_thunk-{arch}`* | *`clang_rt.asan_dynamic-{arch}`* @@ -31,7 +31,7 @@ The image shows three scenarios for linking the runtime library. The first is /M The following diagram shows how the ASan library is linked for various compiler options: :::image type="complex" source="media/asan-one-dll.png" alt-text="Diagram of how the ASan runtime dll is linked." -The image shows four scenarios for linking the ASan runtime library. The scenarios are for /MT (statically link the runtime), /MTd (statically link the debug runtime), /MD (dynamically link the redist at runtime), /MDd (dynamically link the debug redist at runtime). In all cases, my_exe.exe links and its associates my_dll.dll link to a single instance of clang-rt.asan-dynamix-x86_64.dll. +The image shows four scenarios for linking the ASan runtime library. The scenarios are for /MT (statically link the runtime), /MTd (statically link the debug runtime), /MD (dynamically link the redist at runtime), /MDd (dynamically link the debug redist at runtime). In all cases, my_exe.exe links and its associates my_dll.dll link to a single instance of clang_rt.asan_dynamic-x86_64.dll. :::image-end::: Even when statically linking, the ASan runtime DLL must be present at runtime--unlike other C Runtime components. @@ -40,7 +40,7 @@ Even when statically linking, the ASan runtime DLL must be present at runtime--u Before Visual Studio 17.7 Preview 3, statically linked (**`/MT`** or **`/MTd`**) builds didn't use a DLL dependency. Instead, the AddressSanitizer runtime was statically linked into the user's EXE. DLL projects would then load exports from the user's EXE to access ASan functionality. -Dynamically linked projects (**`/MD`** or **`/MDd`**) used different libraries and DLLs depending on whether the project was configured for debug or release. For more information about these changes and their motivations, see [MSVC Address Sanitizer – One DLL for all Runtime Configurations](https://devblogs.microsoft.com/cppblog/msvc-address-sanitizer-one-dll-for-all-runtime-configurations/). +Dynamically linked projects (**`/MD`** or **`/MDd`**) used different libraries and DLLs depending on whether the project was configured for debug or release. For more information about these changes and their motivations, see [MSVC AddressSanitizer – One DLL for all Runtime Configurations](https://devblogs.microsoft.com/cppblog/msvc-address-sanitizer-one-dll-for-all-runtime-configurations/). The following table describes the previous behavior of the AddressSanitizer runtime library linking, before Visual Studio 17.7 Preview 3: @@ -63,7 +63,7 @@ The image shows four scenarios for linking the ASan runtime library. The scenari The AddressSanitizer achieves function interception through many hotpatching techniques. These techniques are [best documented within the source code itself](https://github.com/llvm/llvm-project/blob/1a2eaebc09c6a200f93b8beb37130c8b8aab3934/compiler-rt/lib/interception/interception_win.cpp#L11). -The runtime libraries intercept many common memory management and memory manipulation functions. For a list, see [AddressSanitizer list of intercepted functions](#intercepted_functions). The allocation interceptors manage metadata and shadow bytes related to each allocation call. Every time a CRT function such as `malloc` or `delete` is called, the interceptors set specific values in the AddressSanitizer shadow-memory region to indicate whether those heap locations are currently accessible and what the bounds of the allocation are. These shadow bytes allow the compiler-generated checks of the [shadow bytes](./asan-shadow-bytes.md) to determine whether a load or store is valid. +The runtime libraries intercept many common memory management and memory manipulation functions. For a list, see [AddressSanitizer list of intercepted functions](#intercepted_functions). The allocation interceptors manage metadata and shadow bytes related to each allocation call. Every time a CRT function such as `malloc` or `delete` is called, the interceptors set specific values in the AddressSanitizer shadow-memory region to indicate whether those heap locations are currently accessible and what the bounds of the allocation are. These shadow bytes allow the compiler-generated checks of the [shadow bytes](asan-shadow-bytes.md) to determine whether a load or store is valid. Interception isn't guaranteed to succeed. If a function prologue is too short for a `jmp` to be written, interception can fail. If an interception failure occurs, the program throws a `debugbreak` and halts. If you attach a debugger, it makes the cause of the interception issue clear. If you have this problem, [report a bug](https://aka.ms/feedback/report?space=62). @@ -72,7 +72,7 @@ Interception isn't guaranteed to succeed. If a function prologue is too short fo ## Custom allocators and the AddressSanitizer runtime -The AddressSanitizer runtime provides interceptors for common allocator interfaces, `malloc`/`free`, `new`/`delete`, `HeapAlloc`/`HeapFree` (via `RtlAllocateHeap`/`RtlFreeHeap`). Many programs make use of custom allocators for one reason or another, an example would be any program using `dlmalloc` or a solution using the `std::allocator` interface and `VirtualAlloc()`. The compiler is unable to automatically add shadow-memory management calls to a custom allocator. It's the user's responsibility to use the [provided manual poisoning interface](#poisoning). This API enables these allocators to function properly with the existing AddressSanitizer runtime and [shadow byte](./asan-shadow-bytes.md) conventions. +The AddressSanitizer runtime provides interceptors for common allocator interfaces, `malloc`/`free`, `new`/`delete`, `HeapAlloc`/`HeapFree` (via `RtlAllocateHeap`/`RtlFreeHeap`). Many programs make use of custom allocators for one reason or another, an example would be any program using `dlmalloc` or a solution using the `std::allocator` interface and `VirtualAlloc()`. The compiler is unable to automatically add shadow-memory management calls to a custom allocator. It's the user's responsibility to use the [provided manual poisoning interface](#poisoning). This API enables these allocators to function properly with the existing AddressSanitizer runtime and [shadow byte](asan-shadow-bytes.md) conventions. ## Manual AddressSanitizer poisoning interface @@ -101,7 +101,8 @@ For an illustration of the alignment requirement and potential issues, see the p ## Runtime options -The MSVC AddressSanitizer is a regularly synced fork of the [Clang AddressSanitizer runtime](https://github.com/llvm/llvm-project). As a result, MSVC implicitly inherits many of Clang's ASan runtime options. A complete list of options that we actively maintain and test can be found [here](./asan-flags.md). If you discover options that don't function as expected, [report a bug](https://aka.ms/feedback/report?space=62). +MSVC AddressSanitizer is a regularly synced fork of the [Clang AddressSanitizer runtime](https://github.com/llvm/llvm-project). As a result, MSVC implicitly inherits many of Clang's ASan runtime options. A complete list of options that we actively maintain and test can be found [here](./asan-flags.md). If you discover options that don't function as expected, [report a bug](https://aka.ms/feedback/report?space=62). + ### Configure runtime options @@ -113,7 +114,7 @@ If the environment variable and the user function specify conflicting options, t Multiple options are specified by separating them with a colon (`:`). -The following example sets [`alloc_dealloc_mismatch`](./error-alloc-dealloc-mismatch.md) to one and `symbolize` to zero: +The following example sets [`alloc_dealloc_mismatch`](error-alloc-dealloc-mismatch.md) to one and `symbolize` to zero: ```cmd set ASAN_OPTIONS=alloc_dealloc_mismatch=1:symbolize=0 @@ -121,7 +122,7 @@ set ASAN_OPTIONS=alloc_dealloc_mismatch=1:symbolize=0 Or add the following function to your code: -```C++ +```cpp extern "C" const char* __asan_default_options() { return "alloc_dealloc_mismatch=1:symbolize=0"; @@ -130,8 +131,8 @@ extern "C" const char* __asan_default_options() ### Unsupported AddressSanitizer options -- detect_container_overflow -- unmap_shadow_on_exit +- `detect_container_overflow` +- `unmap_shadow_on_exit` > [!NOTE] > The AddressSanitizer runtime option `halt_on_error` doesn't function the way you might expect. In both the Clang and the MSVC runtime libraries, many error types are considered **non-continuable**, including most memory corruption errors. @@ -152,9 +153,10 @@ For more information, see the [Differences with Clang 12.0](asan.md#differences) - If set to `"ignore"`, the runtime doesn't attempt to correct any overwritten functions and proceeds with execution. - `windows_fast_fail_on_error` -Boolean (false by default), set to `true` to enable the process to terminate with a __fastfail(71) after printing the error report. ->[!NOTE] ->When abort_on_error value is set to true, on Windows the program terminates with an exit(3). In order to not change current behavior we decided to introduce this new option instead. If both abort_on_error and windows_fast_fail_on_error are true, the program will exit with the __fastfail. + Boolean (`false` by default), set to `true` to enable the process to terminate with a `__fastfail(71)` after printing the error report. + + > [!NOTE] + > When `abort_on_error` value is set to `true`, on Windows the program terminates with an `exit(3)`. In order to not change current behavior we decided to introduce this new option instead. If both `abort_on_error` and `windows_fast_fail_on_error` are `true`, the program will exit with the `__fastfail`. - `windows_hook_legacy_allocators` Boolean, set to `false` to disable interception of [`GlobalAlloc`](/windows/win32/api/winbase/nf-winbase-globalalloc) and [`LocalAlloc`](/windows/win32/api/winbase/nf-winbase-localalloc) allocators. @@ -217,7 +219,7 @@ The AddressSanitizer runtime hotpatches many functions to enable memory safety c - [`realloc`](../c-runtime-library/reference/realloc.md) - [`RtlAllocateHeap`](/windows-hardware/drivers/ddi/ntifs/nf-ntifs-rtlallocateheap) - [`RtlCreateHeap`](/windows-hardware/drivers/ddi/ntifs/nf-ntifs-rtlcreateheap) -- [`RtlDestroyHeap`](/windows-hardware/drivers/ddi/ntifs/nf-ntifs-rtlcreateheap) +- [`RtlDestroyHeap`](/windows-hardware/drivers/ddi/ntifs/nf-ntifs-rtldestroyheap) - [`RtlFreeHeap`](/windows-hardware/drivers/ddi/ntifs/nf-ntifs-rtlfreeheap) - [`RtlRaiseException`](/windows/win32/api/rtlsupportapi/nf-rtlsupportapi-rtlraiseexception) - `RtlReAllocateHeap` (undocumented) @@ -248,26 +250,26 @@ The interceptors listed here are only installed when an AddressSanitizer runtime `set ASAN_OPTIONS=windows_hook_legacy_allocators=false` - [`GlobalAlloc`](/windows/win32/api/winbase/nf-winbase-globalalloc) -- [`GlobalFree`](/windows/win32/api/winbase/nf-winbase-GlobalFree) -- [`GlobalHandle`](/windows/win32/api/winbase/nf-winbase-GlobalHandle) -- [`GlobalLock`](/windows/win32/api/winbase/nf-winbase-GlobalLock) -- [`GlobalReAlloc`](/windows/win32/api/winbase/nf-winbase-GlobalReAlloc) -- [`GlobalSize`](/windows/win32/api/winbase/nf-winbase-GlobalSize) -- [`GlobalUnlock`](/windows/win32/api/winbase/nf-winbase-GlobalUnlock) -- [`LocalAlloc`](/windows/win32/api/winbase/nf-winbase-LocalAlloc) -- [`LocalFree`](/windows/win32/api/winbase/nf-winbase-LocalFree) -- [`LocalHandle`](/windows/win32/api/winbase/nf-winbase-LocalHandle) -- [`LocalLock`](/windows/win32/api/winbase/nf-winbase-LocalLock) -- [`LocalReAlloc`](/windows/win32/api/winbase/nf-winbase-LocalReAlloc) -- [`LocalSize`](/windows/win32/api/winbase/nf-winbase-LocalSize) -- [`LocalUnlock`](/windows/win32/api/winbase/nf-winbase-LocalUnlock) +- [`GlobalFree`](/windows/win32/api/winbase/nf-winbase-globalfree) +- [`GlobalHandle`](/windows/win32/api/winbase/nf-winbase-globalhandle) +- [`GlobalLock`](/windows/win32/api/winbase/nf-winbase-globallock) +- [`GlobalReAlloc`](/windows/win32/api/winbase/nf-winbase-globalrealloc) +- [`GlobalSize`](/windows/win32/api/winbase/nf-winbase-globalsize) +- [`GlobalUnlock`](/windows/win32/api/winbase/nf-winbase-globalunlock) +- [`LocalAlloc`](/windows/win32/api/winbase/nf-winbase-localalloc) +- [`LocalFree`](/windows/win32/api/winbase/nf-winbase-localfree) +- [`LocalHandle`](/windows/win32/api/winbase/nf-winbase-localhandle) +- [`LocalLock`](/windows/win32/api/winbase/nf-winbase-locallock) +- [`LocalReAlloc`](/windows/win32/api/winbase/nf-winbase-localrealloc) +- [`LocalSize`](/windows/win32/api/winbase/nf-winbase-localsize) +- [`LocalUnlock`](/windows/win32/api/winbase/nf-winbase-localunlock) ## See also -[AddressSanitizer overview](./asan.md)\ -[AddressSanitizer known issues](./asan-known-issues.md)\ -[AddressSanitizer build and language reference](./asan-building.md)\ -[AddressSanitizer shadow bytes](./asan-shadow-bytes.md)\ -[AddressSanitizer cloud or distributed testing](./asan-offline-crash-dumps.md)\ -[AddressSanitizer debugger integration](./asan-debugger-integration.md)\ -[AddressSanitizer error examples](./asan-error-examples.md) +[AddressSanitizer overview](asan.md)\ +[AddressSanitizer known issues](asan-known-issues.md)\ +[AddressSanitizer build and language reference](asan-building.md)\ +[AddressSanitizer shadow bytes](asan-shadow-bytes.md)\ +[AddressSanitizer cloud or distributed testing](asan-offline-crash-dumps.md)\ +[AddressSanitizer debugger integration](asan-debugger-integration.md)\ +[AddressSanitizer error examples](asan-error-examples.md) diff --git a/docs/sanitizers/asan.md b/docs/sanitizers/asan.md index bd9fc7c88c5..63d7c1cb7f2 100644 --- a/docs/sanitizers/asan.md +++ b/docs/sanitizers/asan.md @@ -2,6 +2,7 @@ title: "AddressSanitizer" description: "Top-level description of the AddressSanitizer feature for Microsoft C/C++." ms.date: 09/06/2024 +ms.topic: overview f1_keywords: ["AddressSanitizer"] helpviewer_keywords: ["ASan", "AddressSanitizer", "Address Sanitizer", "compiling for AddressSanitizer"] --- @@ -157,7 +158,7 @@ To enable AddressSanitizer for a [CMake project created to target Windows](../bu 1. Choose the **Edit JSON** link in the editor. This selection switches the view to raw JSON. -1. Add the following snippet to the `"windows-base"` preset, inside `"configurePresets":` to turn on Address Sanitizer: +1. Add the following snippet to the `"windows-base"` preset, inside `"configurePresets":` to turn on AddressSanitizer: ```json "environment": { @@ -192,7 +193,7 @@ To enable AddressSanitizer for a [CMake project created to target Windows](../bu }, ``` -1. Address sanitizer doesn't work if edit-and-continue is specified (`/ZI`), which is enabled by default for new CMake projects. In `CMakeLists.txt`, comment out (prefix with `#`) the line that starts with `set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT"`. That line looks something like this, afterwards: +1. AddressSanitizer doesn't work if edit-and-continue is specified (`/ZI`), which is enabled by default for new CMake projects. In `CMakeLists.txt`, comment out (prefix with `#`) the line that starts with `set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT"`. That line looks something like this, afterwards: ```json # set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "$,$>,$<$:EditAndContinue>,$<$:ProgramDatabase>>") diff --git a/docs/sanitizers/error-memcpy-param-overlap.md b/docs/sanitizers/error-memcpy-param-overlap.md index 419cbeb8037..005bde29ac8 100644 --- a/docs/sanitizers/error-memcpy-param-overlap.md +++ b/docs/sanitizers/error-memcpy-param-overlap.md @@ -12,7 +12,7 @@ helpviewer_keywords: ["memcpy-param-overlap error", "AddressSanitizer error memc ## Remarks > [!NOTE] -> The `/Oi` flag is required to reliably detect `memcpy-param-overlap` errors. This flag tells the compiler to treat `memcpy` and other functions as intrinsics, which is necessary because some versions of the standard library implement them as such. Since ASan is a dynamic analysis tool, it can only detect errors with an observable runtime effect. Note that when `/O2` is also set, ASan may not be able to reliably detect `memcpy-param-overlap` errors because the intrinsic variant of these functions isn't guaranteed to be used. For more information, see [`/Oi` docs](../build/reference/oi-generate-intrinsic-functions.md). +> The `/Oi` flag is required to reliably detect `memcpy-param-overlap` errors. This flag tells the compiler to treat `memcpy` and other functions as intrinsics, which is necessary because some versions of the standard library implement them as such. Since ASan is a dynamic analysis tool, it can only detect errors with an observable runtime effect. Note that when `/O2` is also set, ASan may not be able to reliably detect `memcpy-param-overlap` errors because the intrinsic variant of these functions isn't guaranteed to be used. For more information, see [`/Oi` (Generate Intrinsic Functions)](../build/reference/oi-generate-intrinsic-functions.md). The CRT function [`memcpy`](../c-runtime-library/reference/memcpy-wmemcpy.md) **doesn't support** overlapping memory. The CRT provides an alternative to `memcpy` that does support overlapping memory: [`memmove`](../c-runtime-library/reference/memmove-wmemmove.md). diff --git a/docs/sanitizers/error-new-delete-type-mismatch.md b/docs/sanitizers/error-new-delete-type-mismatch.md index 708b39a76c6..daff0ec1c11 100644 --- a/docs/sanitizers/error-new-delete-type-mismatch.md +++ b/docs/sanitizers/error-new-delete-type-mismatch.md @@ -50,7 +50,7 @@ To fix the example, add: ```cpp struct Base { virtual ~Base() = default; -} +}; ``` To build and test this example, run these commands in a Visual Studio 2019 version 16.9 or later [developer command prompt](../build/building-on-the-command-line.md#developer_command_prompt_shortcuts): diff --git a/docs/sanitizers/error-stack-use-after-return.md b/docs/sanitizers/error-stack-use-after-return.md index f3ee909411e..6ddd807d4a8 100644 --- a/docs/sanitizers/error-stack-use-after-return.md +++ b/docs/sanitizers/error-stack-use-after-return.md @@ -1,13 +1,13 @@ --- title: "Error: stack-use-after-return" -description: "Learn about the stack-use-after-return Address Sanitizer error." +description: "Learn about the stack-use-after-return AddressSanitizer error." ms.date: 03/02/2021 f1_keywords: ["stack-use-after-return"] helpviewer_keywords: ["stack-use-after-return error", "AddressSanitizer error stack-use-after-return"] --- # Error: `stack-use-after-return` -> Address Sanitizer Error: Use of stack memory after return +> AddressSanitizer Error: Use of stack memory after return ## Remarks diff --git a/docs/security/security-best-practices-for-cpp.md b/docs/security/security-best-practices-for-cpp.md index 6cc6c47315c..83ffc267e8e 100644 --- a/docs/security/security-best-practices-for-cpp.md +++ b/docs/security/security-best-practices-for-cpp.md @@ -10,7 +10,7 @@ ms.topic: best-practice This article contains information about security tools and practices. Using them does not make applications immune from attack, but it makes successful attacks less likely. -## Visual C++ Security Features +## Microsoft C++ Security Features These security features are built into the Microsoft C++ compiler and linker: diff --git a/docs/standard-library/algorithm-functions.md b/docs/standard-library/algorithm-functions.md index b243d2c1ebb..65b150d64e8 100644 --- a/docs/standard-library/algorithm-functions.md +++ b/docs/standard-library/algorithm-functions.md @@ -595,7 +595,7 @@ An output iterator addressing the position that is one past the final element in The source range must be valid and there must be sufficient space at the destination to hold all the elements being copied. -The `copy_backward` algorithm imposes more stringent requirements than that the `copy` algorithm. Both its input and output iterators must be bidirectional. +The `copy_backward` algorithm imposes more stringent requirements than the `copy` algorithm. Both its input and output iterators must be bidirectional. The `copy_backward` and [`move_backward`](algorithm-functions.md#move_backward) algorithms are the only C++ Standard Library algorithms designating the output range with an iterator pointing to the end of the destination range. @@ -908,13 +908,13 @@ int main() vector::iterator::difference_type result; result = count(v1.begin(), v1.end(), 10); - cout << "The number of 10s in v2 is: " << result << "." << endl; + cout << "The number of 10s in v1 is: " << result << "." << endl; } ``` ```Output v1 = ( 10 20 10 40 10 ) -The number of 10s in v2 is: 3. +The number of 10s in v1 is: 3. ``` ## `count_if` @@ -2149,7 +2149,7 @@ public: { } - // The function call to process the next elment + // The function call to process the next element void operator( ) ( int elem ) { num++; // Increment the element count @@ -2292,7 +2292,7 @@ public: } }; -// Utility to display the contents of a vector +// Utility to display the contents of a vector template void print_vector(const std::vector &vec) { std::cout << "( "; @@ -2686,7 +2686,7 @@ int main() cout << *Iter3b << " "; cout << ")." << endl; - // To test for inclusion under an asscending order + // To test for inclusion under an ascending order // with the default binary predicate less( ) bool Result1; Result1 = includes ( v1a.begin( ), v1a.end( ), @@ -2892,7 +2892,7 @@ int main() // Applying a user defined (UD) binary predicate mod_lesser inplace_merge ( v3.begin( ), break3, v3.end( ), mod_lesser ); cout << "Merged inplace with binary predicate mod_lesser specified,\n " - << "vector v3mod = ( " ; ; + << "vector v3mod = ( " ; for ( Iter3 = v3.begin( ) ; Iter3 != v3.end( ) ; Iter3++ ) cout << *Iter3 << " "; cout << ")" << endl; @@ -4424,7 +4424,7 @@ int main() { merge ( v3a.begin( ), v3a.end( ), v3b.begin( ), v3b.end( ), v3.begin( ), mod_lesser ); cout << "Merged inplace with binary predicate mod_lesser specified,\n " - << "vector v3mod = ( " ; ; + << "vector v3mod = ( " ; for ( Iter3 = v3.begin( ) ; Iter3 != v3.end( ) ; Iter3++ ) cout << *Iter3 << " "; cout << ")." << endl; @@ -4949,13 +4949,14 @@ Use the dual-range overloads in C++14 code because the overloads that only take ```cpp template -pair> +pair mismatch( InputIterator1 first1, InputIterator1 last1, InputIterator2 first2 ); -template pair> +template +pair mismatch( InputIterator1 first1, InputIterator1 last1, @@ -4964,14 +4965,15 @@ mismatch( //C++14 template -pair> +pair mismatch( InputIterator1 first1, InputIterator1 last1, InputIterator2 first2, InputIterator2 last2 ); -template pair> +template +pair mismatch( InputIterator1 first1, InputIterator1 last1, @@ -5933,7 +5935,7 @@ int main() cout << *Iter1 << " "; cout << ")." << endl; - // Partition the range with predicate greater10 + // Partition the range with predicate greater5 partition ( v1.begin( ), v1.end( ), greater5 ); cout << "The partitioned set of elements in v1 is: ( " ; for ( Iter1 = v1.begin( ) ; Iter1 != v1.end( ) ; Iter1++ ) @@ -6660,7 +6662,7 @@ Vector v2 is a copy of v1 with the value 7 removed: ## `remove_copy_if` -Copies elements from a source range to a destination range, except for elements that satisfy a predicate. Elements are copied without disturbing the order of the remaining elements. Returns the end of a new destination range. +Copies elements from a source range to a destination range, except for elements that satisfy a predicate. Elements are copied without disturbing the order of the remaining elements. Returns the end of a new destination range. ```cpp template @@ -6694,7 +6696,7 @@ An input iterator addressing the position one past the final element in the rang An output iterator addressing the position of the first element in the destination range to which elements are being removed. *`pred`*\ -The unary predicate that must be satisfied is the value of an element is to be replaced. +The unary predicate that must be satisfied if the value of an element is to be replaced. ### Return value @@ -6751,7 +6753,7 @@ int main() new_end = remove_copy_if ( v1.begin( ), v1.end( ), v2.begin( ), greater6 ); - cout << "After the appliation of remove_copy_if to v1,\n " + cout << "After the application of remove_copy_if to v1,\n " << "vector v1 is left unchanged as ( " ; for ( Iter1 = v1.begin( ) ; Iter1 != v1.end( ) ; Iter1++ ) cout << *Iter1 << " "; @@ -6767,7 +6769,7 @@ int main() ```Output The original vector v1 is: ( 4 7 7 7 0 5 7 1 6 9 3 7 8 2 ). -After the appliation of remove_copy_if to v1, +After the application of remove_copy_if to v1, vector v1 is left unchanged as ( 4 7 7 7 0 5 7 1 6 9 3 7 8 2 ). Vector v2 is a copy of v1 with values greater than 6 removed: ( 4 0 5 1 6 3 2 ). @@ -6804,7 +6806,7 @@ A forward iterator pointing to the position of the first element in the range fr A forward iterator pointing to the position one past the final element in the range from which elements are being removed. *`pred`*\ -The unary predicate that must be satisfied is the value of an element is to be replaced. +The unary predicate that must be satisfied if the value of an element is to be replaced. ### Return value @@ -7148,7 +7150,7 @@ An input iterator pointing to the position one past the final element in the ran An output iterator pointing to the position of the first element in the destination range to which elements are being copied. *`pred`*\ -The unary predicate that must be satisfied is the value of an element is to be replaced. +The unary predicate that must be satisfied if the value of an element is to be replaced. *`value`*\ The new value being assigned to the elements whose old value satisfies the predicate. @@ -7277,7 +7279,7 @@ A forward iterator pointing to the position of the first element in the range fr An iterator pointing to the position one past the final element in the range from which elements are being replaced. *`pred`*\ -The unary predicate that must be satisfied is the value of an element is to be replaced. +The unary predicate that must be satisfied if the value of an element is to be replaced. *`value`*\ The new value being assigned to the elements whose old value satisfies the predicate. @@ -8269,7 +8271,7 @@ int main() cout << *Iter3b << " "; cout << ")." << endl; - // To combine into a difference in asscending + // To combine into a difference in ascending // order with the default binary predicate less( ) Result1 = set_difference ( v1a.begin( ), v1a.end( ), v1b.begin( ), v1b.end( ), v1.begin( ) ); @@ -8294,7 +8296,7 @@ int main() Result3 = set_difference ( v3a.begin( ), v3a.end( ), v3b.begin( ), v3b.end( ), v3.begin( ), mod_lesser ); cout << "Set_difference of source ranges with binary " - << "predicate mod_lesser specified,\n vector v3mod = ( " ; ; + << "predicate mod_lesser specified,\n vector v3mod = ( " ; for ( Iter3 = v3.begin( ) ; Iter3 != Result3 ; Iter3++ ) cout << *Iter3 << " "; cout << ")." << endl; @@ -8488,7 +8490,7 @@ int main() cout << *Iter3b << " "; cout << ")." << endl; - // To combine into an intersection in asscending order with the + // To combine into an intersection in ascending order with the // default binary predicate less( ) Result1 = set_intersection ( v1a.begin( ), v1a.end( ), v1b.begin( ), v1b.end( ), v1.begin( ) ); @@ -8513,7 +8515,7 @@ int main() Result3 = set_intersection ( v3a.begin( ), v3a.end( ), v3b.begin( ), v3b.end( ), v3.begin( ), mod_lesser ); cout << "Intersection of source ranges with binary predicate " - << "mod_lesser specified,\n vector v3mod = ( " ; ; + << "mod_lesser specified,\n vector v3mod = ( " ; for ( Iter3 = v3.begin( ) ; Iter3 != Result3 ; ++Iter3 ) cout << *Iter3 << " "; cout << ")." << endl; @@ -8736,7 +8738,7 @@ int main() Result3 = set_symmetric_difference ( v3a.begin( ), v3a.end( ), v3b.begin( ), v3b.end( ), v3.begin( ), mod_lesser ); cout << "Set_symmetric_difference of source ranges with binary " - << "predicate mod_lesser specified,\n vector v3mod = ( " ; ; + << "predicate mod_lesser specified,\n vector v3mod = ( " ; for ( Iter3 = v3.begin( ) ; Iter3 != Result3 ; Iter3++ ) cout << *Iter3 << " "; cout << ")." << endl; @@ -8959,7 +8961,7 @@ int main() Result3 = set_union ( v3a.begin( ), v3a.end( ), v3b.begin( ), v3b.end( ), v3.begin( ), mod_lesser ); cout << "Union of source ranges with binary predicate " - << "mod_lesser specified,\n vector v3mod = ( " ; ; + << "mod_lesser specified,\n vector v3mod = ( " ; for ( Iter3 = v3.begin( ) ; Iter3 != Result3 ; Iter3++ ) cout << *Iter3 << " "; cout << ")." << endl; @@ -9170,7 +9172,7 @@ Heaps have two properties: - Elements may be added or removed in logarithmic time. -After the application if this algorithm, the range it was applied to is no longer a heap. +After the application of this algorithm, the range it was applied to is no longer a heap. `sort_heap` isn't a stable sort because the relative order of equivalent elements isn't necessarily preserved. @@ -9585,7 +9587,7 @@ A forward iterator pointing to one past the final position of the second range w The ranges referenced must be valid; all pointers must be dereferenceable and within each sequence the last position is reachable from the first by incrementation. The second range has to be as large as the first range. -The complexity is linear with *last1* - *first1* swaps performed. If elements from containers of the same type are being swapped, them the `swap` member function from that container should be used, because the member function typically has constant complexity. +The complexity is linear with *last1* - *first1* swaps performed. If elements from containers of the same type are being swapped, then the `swap` member function from that container should be used, because the member function typically has constant complexity. ### Example @@ -9922,7 +9924,7 @@ int main() cout << *v1_Iter1 << " "; cout << ")." << endl; - // Remove consecutive duplicates under the binary prediate mod_equals + // Remove consecutive duplicates under the binary predicate mod_equals v1_NewEnd2 = unique ( v1.begin( ), v1_NewEnd1 , mod_equal ); cout << "Removing adjacent duplicates from vector v1 under the\n " @@ -10078,7 +10080,7 @@ int main() { for ( iv = 0 ; iv <= 7 ; iv++ ) v1.push_back( 10 ); - // Remove consecutive duplicates under the binary prediate mod_equals + // Remove consecutive duplicates under the binary predicate mod_equals v1_NewEnd2 = unique_copy ( v1.begin( ), v1.begin( ) + 14, v1.begin( ) + 14 , mod_equal ); diff --git a/docs/standard-library/allocators-functions.md b/docs/standard-library/allocators-functions.md index fafefa60342..47258c46189 100644 --- a/docs/standard-library/allocators-functions.md +++ b/docs/standard-library/allocators-functions.md @@ -7,21 +7,7 @@ helpviewer_keywords: ["std::ALLOCATOR_DECL [C++]", "std::CACHE_CHUNKLIST [C++]", --- # `` macros -:::row::: - :::column span=""::: - [`ALLOCATOR_DECL`](#allocator_decl)\ - [`CACHE_CHUNKLIST`](#cache_chunklist) - :::column-end::: - :::column span=""::: - [`CACHE_FREELIST`](#cache_freelist) - :::column-end::: - :::column span=""::: - [`CACHE_SUBALLOC`](#cache_suballoc) - :::column-end::: - :::column span=""::: - [`SYNC_DEFAULT`](#sync_default) - :::column-end::: -:::row-end::: +The `` header provides the following macros: ## ALLOCATOR_DECL diff --git a/docs/standard-library/array-functions.md b/docs/standard-library/array-functions.md index 60e9c8027c5..8ba4d4fcbca 100644 --- a/docs/standard-library/array-functions.md +++ b/docs/standard-library/array-functions.md @@ -1,40 +1,45 @@ --- title: " functions" description: "Learn more about: functions" -ms.date: 11/04/2016 -f1_keywords: ["array/std::array::get", "array/std::get", "array/std::swap"] -helpviewer_keywords: ["std::array [C++], get", "std::get [C++]", "std::swap [C++]"] +ms.date: 08/20/2025 +f1_keywords: ["array/std::array::get", "array/std::get", "array/std::swap", "array/std::to_array"] +helpviewer_keywords: ["std::array [C++], get", "std::get [C++]", "std::swap [C++]", "std::to_array [C++]"] --- # `` functions -The `` header includes two non-member functions, `get` and `swap`, that operate on **array** objects. +The `` header includes three non-member functions, `get`, `swap`, and `to_array` that operate on **array** objects. ## `get` Returns a reference to the specified element of the array. ```cpp -template -constexpr T& get(array& arr) noexcept; +template +constexpr Type& get(std::array& arr) noexcept; -template -constexpr const T& get(const array& arr) noexcept; +template +constexpr const Type& get(const std::array& arr) noexcept; -template -constexpr T&& get(array&& arr) noexcept; +template +constexpr Type&& get(std::array&& arr) noexcept; + +template +constexpr const Type&& get(const std::array&& arr) noexcept; ``` -### Parameters +### Template parameters *`Index`*\ The element offset. -*`T`*\ +*`Type`*\ The type of an element. -*`N`*\ +*`Size`*\ The number of elements in the array. +### Parameters + *`arr`*\ The array to select from. @@ -75,18 +80,20 @@ int main() A non-member template specialization of `std::swap` that swaps two **array** objects. ```cpp -template -void swap(array& left, array& right); +template +void swap(std::array& left, std::array& right); ``` -### Parameters +### Template parameters -*`Ty`*\ +*`Type`*\ The type of an element. -*`N`*\ +*`Size`*\ The size of the array. +### Parameters + *`left`*\ The first array to swap. @@ -143,6 +150,74 @@ int main() 0 1 2 3 ``` +## `to_array` + +Converts a built-in array to a `std::array` object. + +```cpp +// C++20 +template +constexpr std::array, Size> to_array(Type (&arr)[Size]); + +// C++20 +template +constexpr std::array, Size> to_array(Type (&&arr)[Size]); +``` + +### Template parameters + +*`Type`*\ +The type of an element. + +*`Size`*\ +The size of the input array. + +### Parameters + +*`arr`*\ +The input array used for conversion. + +### Example + +```cpp +// std_to_array.cpp +// Requires /std:c++20 or later + +#include +#include + +int main() +{ + int arr1[]{ 1, 2, 3 }; + std::array arr2 = std::to_array(arr1); + + std::cout << "std::to_array(arr1):\n"; + for (const auto& i : arr2) + { + std::cout << i << " "; + } + std::cout << std::endl; + + // The size is 7 as it includes the null terminator + std::array arr3 = std::to_array("string"); + + std::cout << "\nstd::to_array(\"string\"):\n"; + for (const auto& i : arr3) + { + std::cout << i << " "; + } + std::cout << std::endl; +} +``` + +```Output +std::to_array(arr1): +1 2 3 + +std::to_array("string"): +s t r i n g +``` + ## See also -[``](../standard-library/array.md) +[``](array.md) diff --git a/docs/standard-library/array.md b/docs/standard-library/array.md index 85273440ba3..331316ee9e2 100644 --- a/docs/standard-library/array.md +++ b/docs/standard-library/array.md @@ -1,7 +1,7 @@ --- -description: "Learn more about: " title: "" -ms.date: "11/04/2016" +description: "Learn more about: " +ms.date: 11/04/2016 f1_keywords: [""] helpviewer_keywords: ["array header"] --- @@ -45,6 +45,7 @@ Defines the container class template **array** and several supporting templates. |-|-| |[get](../standard-library/array-functions.md#get)|Get specified array element.| |[swap](../standard-library/array-functions.md#swap)|Exchanges the contents of one array with the contents of another array.| +| [`to_array`](array-functions.md#to_array) | Converts a built-in array to a `std::array` object. | ## See also diff --git a/docs/standard-library/basic-string-class.md b/docs/standard-library/basic-string-class.md index f0509418b5a..d91955cfbfc 100644 --- a/docs/standard-library/basic-string-class.md +++ b/docs/standard-library/basic-string-class.md @@ -1,5 +1,5 @@ --- -title: "basic_string Class" +title: "basic_string class" description: "API reference for the Standard C++ string class, `basic_string`." ms.date: 07/11/2023 f1_keywords: ["xstring/std::basic_string", "xstring/std::basic_string::allocator_type", "xstring/std::basic_string::const_iterator", "xstring/std::basic_string::const_pointer", "xstring/std::basic_string::const_reference", "xstring/std::basic_string::const_reverse_iterator", "xstring/std::basic_string::difference_type", "xstring/std::basic_string::iterator", "xstring/std::basic_string::npos", "xstring/std::basic_string::pointer", "xstring/std::basic_string::reference", "xstring/std::basic_string::reverse_iterator", "xstring/std::basic_string::size_type", "xstring/std::basic_string::traits_type", "xstring/std::basic_string::value_type", "xstring/std::basic_string::append", "xstring/std::basic_string::assign", "xstring/std::basic_string::at", "xstring/std::basic_string::back", "xstring/std::basic_string::begin", "xstring/std::basic_string::c_str", "xstring/std::basic_string::capacity", "xstring/std::basic_string::cbegin", "xstring/std::basic_string::cend", "xstring/std::basic_string::clear", "xstring/std::basic_string::compare", "xstring/std::basic_string::copy", "xstring/std::basic_string::crbegin", "xstring/std::basic_string::crend", "xstring/std::basic_string::_Copy_s", "xstring/std::basic_string::data", "xstring/std::basic_string::empty", "xstring/std::basic_string::end", "xstring/std::basic_string::erase", "xstring/std::basic_string::find", "xstring/std::basic_string::find_first_not_of", "xstring/std::basic_string::find_first_of", "xstring/std::basic_string::find_last_not_of", "xstring/std::basic_string::find_last_of", "xstring/std::basic_string::front", "xstring/std::basic_string::get_allocator", "xstring/std::basic_string::insert", "xstring/std::basic_string::length", "xstring/std::basic_string::max_size", "xstring/std::basic_string::pop_back", "xstring/std::basic_string::push_back", "xstring/std::basic_string::rbegin", "xstring/std::basic_string::rend", "xstring/std::basic_string::replace", "xstring/std::basic_string::reserve", "xstring/std::basic_string::resize", "xstring/std::basic_string::rfind", "xstring/std::basic_string::shrink_to_fit", "xstring/std::basic_string::size", "xstring/std::basic_string::substr", "xstring/std::basic_string::ends_with", "xstring/std::basic_string::starts_with", "xstring/std::basic_string::swap", 'xstring/std::literals::string_literals', 'std::literals::string_literals', 'string_literals', 'xstring/std::literals::string_literals::operator "s', 'std::literals::string_literals::operator s'] @@ -7,7 +7,7 @@ helpviewer_keywords: ["std::basic_string [C++]", "std::basic_string [C++], alloc ms.custom: devdivchpfy22 --- -# `basic_string` Class +# `basic_string` class The sequences controlled by an object of type `basic_string` are the Standard C++ string class and are referred to as strings, but they shouldn't be confused with the null-terminated C-style strings used throughout the C++ Standard Library. The Standard C++ string is a container that enables the use of strings as normal types, such as comparison and concatenation operations, iterators, C++ Standard Library algorithms, and copying and assigning with class allocator-managed memory. If you need to convert a Standard C++ string to a null-terminated C-style string, use the [`basic_string::c_str`](#c_str) member. @@ -18,13 +18,13 @@ template , class Allocator class basic_string; ``` -### Parameters +### Template parameters *`CharType`*\ -The data type of a single character to be stored in the string. The C++ Standard Library provides specializations of this class template, with the type definitions [`string`](../standard-library/string-typedefs.md#string) for elements of type `char`, [`wstring`](../standard-library/string-typedefs.md#wstring), for `wchar_t`, [`u16string`](../standard-library/string-typedefs.md#u16string) for `char16_t`, and [`u32string`](../standard-library/string-typedefs.md#u32string) for `char32_t`. +The data type of a single character to be stored in the string. The C++ Standard Library provides specializations of this class template, with the type definitions [`string`](string-typedefs.md#string) for elements of type `char`, [`wstring`](string-typedefs.md#wstring), for `wchar_t`, [`u16string`](string-typedefs.md#u16string) for `char16_t`, and [`u32string`](string-typedefs.md#u32string) for `char32_t`. *`Traits`*\ -Various important properties of the `CharType` elements in a basic_string specialization are described by the class `Traits`. The default value is `char_traits`<`CharType`>. +Various important properties of the `CharType` elements in a `basic_string` specialization are described by the class `Traits`. The default value is `char_traits`<`CharType`>. *`Allocator`*\ The type that represents the stored allocator object that encapsulates details about the string's allocation and deallocation of memory. The default value is `allocator`. @@ -117,22 +117,22 @@ The headers that define `basic_string` also define the following [user-defined l | Declaration | Description | |--|--| | `inline string operator"" s(const char* str, size_t len)` | Returns: `string(str, len)` | -| `inline string operator"" s(const wchar_t* str, size_t len)` | Returns: `wstring(str, len)` | +| `inline wstring operator"" s(const wchar_t* str, size_t len)` | Returns: `wstring(str, len)` | | `inline basic_string operator"" s(const char8_t* str, size_t len)` | Returns: `basic_string(str, len)` | | `inline u16string operator"" s(const char16_t* str, size_t len)` | Returns: `u16string(str, len)` | | `inline u32string operator"" s(const char32_t* str, size_t len)` | Returns: `u32string(str, len)` | ## Remarks -If a function is asked to generate a sequence longer than [`max_size`](#max_size) elements, the function reports a length error by throwing an object of type [`length_error`](../standard-library/length-error-class.md). +If a function is asked to generate a sequence longer than [`max_size`](#max_size) elements, the function reports a length error by throwing an object of type [`length_error`](length-error-class.md). References, pointers, and iterators that designate elements of the controlled sequence can become invalid after any call to a function that alters the controlled sequence, or after the first call to a non-`const` member function. ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## `basic_string::allocator_type` @@ -279,7 +279,7 @@ int main( ) // appending one string to another in two ways, // comparing append and operator [ ] string str1d ( "Hello " ), str2d ( "Wide " ), str3d ( "World " ); - cout << "The string str2d is: " << str2d << endl; + cout << "The string str2d is: " << str2d << endl; str1d.append ( str2d ); cout << "The appended string str1d is: " << str1d << "." << endl; @@ -316,7 +316,7 @@ Appending the 1st part of the C-string cstr1b to string str1 gives: Hello Out. The string str2c is: Wide World The appended string str1 is: Hello World. -The string str2d is: Wide +The string str2d is: Wide The appended string str1d is: Hello Wide . The doubly appended string str1 is: Hello Wide World . @@ -379,10 +379,10 @@ The source string whose characters are to be assigned to the target string. The character value to be assigned. *`first`*\ -An input iterator, const_pointer, or const_iterator addressing the first character in the range of the source string to be assigned to the target range. +An input iterator, `const_pointer`, or `const_iterator` addressing the first character in the range of the source string to be assigned to the target range. *`last`*\ -An input iterator, const_pointer, or const_iterator addressing the one beyond the last character in the range of the source string to be assigned to the target range. +An input iterator, `const_pointer`, or `const_iterator` addressing the one beyond the last character in the range of the source string to be assigned to the target range. *`off`*\ The position at which new characters will start to be assigned. @@ -417,7 +417,7 @@ int main( ) << str1a << "." << endl << endl; // The second member function assigning a specific - // number of the of characters a C-string to a string + // number of characters of a C-string to a string string str1b; const char *cstr1b = "Out There"; cout << "The C-string cstr1b is: " << cstr1b << endl; @@ -452,7 +452,7 @@ int main( ) // number of characters of a certain value to a string string str1e ( "Hello " ); str1e.assign ( 4 , '!' ); - cout << "The string str1 assigned with eclamations is: " + cout << "The string str1 assigned with exclamations is: " << str1e << endl << endl; // The sixth member function assigning the value from @@ -481,7 +481,7 @@ The string str1 newly assigned with string str2d is: Wide. The string str3d is: World. The string str1 reassigned with string str3d is: World. -The string str1 assigned with eclamations is: !!!! +The string str1 assigned with exclamations is: !!!! The string str2f is: Wide World The string str1 assigned a range of string str2f is: World. @@ -512,7 +512,7 @@ The first element of the string has an index of zero and the following elements The member [`operator[]`](#op_at) is faster than the member function `at` for providing read and write access to the elements of a string. -The member `operator[]` doesn't check whether the index passed as a parameter is valid but the member function `at` does and so should be used if the validity isn't certain. An invalid index, which is an index less that zero or greater than or equal to the size of the string, passed to the member function `at` throws an [`out_of_range` Class](../standard-library/out-of-range-class.md) exception. An invalid index passed to the `operator[]` results in undefined behavior, but the index equal to the length of the string is a valid index for const strings and the operator returns the null-character when passed this index. +The member `operator[]` doesn't check whether the index passed as a parameter is valid but the member function `at` does and so should be used if the validity isn't certain. An invalid index, which is an index less than zero or greater than or equal to the size of the string, passed to the member function `at` throws an [`out_of_range` Class](out-of-range-class.md) exception. An invalid index passed to the `operator[]` results in undefined behavior, but the index equal to the length of the string is a valid index for const strings and the operator returns the null-character when passed this index. The reference returned may be invalidated by string reallocations or modifications for the non-`const` strings. @@ -662,10 +662,10 @@ The index of a character in a string that is the first to be used to initialize The character value to be copied into the string being constructed. *`first`*\ -An input iterator, const_pointer, or const_iterator addressing the first element in the source range to be inserted. +An input iterator, `const_pointer`, or `const_iterator` addressing the first element in the source range to be inserted. *`last`*\ -An input iterator, const_pointer, or const_iterator addressing the position of the one beyond the last element in the source range to be inserted. +An input iterator, `const_pointer`, or `const_iterator` addressing the position of the one beyond the last element in the source range to be inserted. ### Return value @@ -1046,7 +1046,7 @@ int compare( int compare( size_type position_1, size_type number_1, - const value_type* ptr + const value_type* ptr, size_type number_2) const; ``` @@ -1079,7 +1079,7 @@ A negative value if the operand string is less than the parameter string; zero i ### Remarks -The `compare` member functions compare either all, or part, of the parameter and operand strings depending on which in used. +The `compare` member functions compare either all, or part, of the parameter and operand strings depending on which is used. The comparison is case-sensitive. @@ -1778,7 +1778,7 @@ int main( ) if ( str2.begin( ) == str2.end ( ) ) cout << "The string str2 is empty." << endl; else - cout << "The stringstr2 is not empty." << endl; + cout << "The string str2 is not empty." << endl; } ``` @@ -2447,7 +2447,7 @@ int main( ) << "position is: " << indexCh3b << endl << endl; else cout << "Elements of the substring '5G' were not " - << "found in str3\n after the first occurrrence." + << "found in str3\n after the first occurrence." << endl << endl; // The fourth member function searches a string @@ -3200,7 +3200,7 @@ The maximum number of characters a string could contain. ### Remarks -An exception of type [`length_error` Class](../standard-library/length-error-class.md) is thrown when an operation produces a string with a length greater than the maximum size. +An exception of type [`length_error` Class](length-error-class.md) is thrown when an operation produces a string with a length greater than the maximum size. ### Example @@ -3479,11 +3479,11 @@ The first element of the string has an index of zero, and the following elements `operator[]` is faster than the member function [`at`](#at) for providing read and write access to the elements of a string. -`operator[]` doesn't check whether the index passed as a parameter is valid, but the member function `at` does and so should be used in the validity isn't certain. An invalid index (an index less that zero or greater than or equal to the size of the string) passed to the member function `at` throws an [`out_of_range` Class](../standard-library/out-of-range-class.md) exception. An invalid index passed to `operator[]` results in undefined behavior, but the index equal to the length of the string is a valid index for const strings and the operator returns the null character when passed this index. +`operator[]` doesn't check whether the index passed as a parameter is valid, but the member function `at` does and so should be used if the validity isn't certain. An invalid index (an index less than zero or greater than or equal to the size of the string) passed to the member function `at` throws an [`out_of_range` Class](out-of-range-class.md) exception. An invalid index passed to `operator[]` results in undefined behavior, but the index equal to the length of the string is a valid index for const strings and the operator returns the null character when passed this index. The reference returned may be invalidated by string reallocations or modifications for the non-`const` strings. -When compiling with [`_ITERATOR_DEBUG_LEVEL`](../standard-library/iterator-debug-level.md) set to 1 or 2, a runtime error will occur if you attempt to access an element outside the bounds of the string. For more information, see [Checked Iterators](../standard-library/checked-iterators.md). +When compiling with [`_ITERATOR_DEBUG_LEVEL`](iterator-debug-level.md) set to 1 or 2, a runtime error will occur if you attempt to access an element outside the bounds of the string. For more information, see [Checked Iterators](checked-iterators.md). ### Example @@ -3690,7 +3690,7 @@ int main( ) if ( str2.rbegin( ) == str2.rend ( ) ) cout << "The string str2 is empty." << endl; else - cout << "The stringstr2 is not empty." << endl; + cout << "The string str2 is not empty." << endl; } ``` @@ -3788,7 +3788,7 @@ int main( ) if ( str2.rbegin( ) == str2.rend ( ) ) cout << "The string str2 is empty." << endl; else - cout << "The stringstr2 is not empty." << endl; + cout << "The string str2 is not empty." << endl; } ``` @@ -3908,10 +3908,10 @@ An iterator addressing the first character to be removed in the operand string. An iterator addressing the last character to be removed in the operand string. *`first`*\ -An iterator, const_pointer, or const_iterator addressing the first character to be copied in the parameter string. +An iterator, `const_pointer`, or `const_iterator` addressing the first character to be copied in the parameter string. *`last`*\ -An iterator, const_pointer, or const_iterator addressing the last character to be copied in the parameter string. +An iterator, `const_pointer`, or `const_iterator` addressing the last character to be copied in the parameter string. *`count`*\ The number of times *`char_value`* is copied into the operand string. @@ -4151,7 +4151,7 @@ int main( ) sizerStr1 = str1.size ( ); caprStr1 = str1.capacity ( ); - cout << "The string str1with augmented capacity is: " + cout << "The string str1 with augmented capacity is: " << str1 << endl; cout << "The current size of string str1 is: " << sizerStr1 << "." << endl; @@ -4180,7 +4180,7 @@ The original string str1 is: Hello world The current size of original string str1 is: 11. The capacity of original string str1 is: 15. -The string str1with augmented capacity is: Hello world +The string str1 with augmented capacity is: Hello world The current size of string str1 is: 11. The new capacity of string str1 is: 47. @@ -4805,7 +4805,7 @@ For type `string`, it's equivalent to `char_traits`. ### Example -See the example for [`copy`](../standard-library/char-traits-struct.md#copy) for an example of how to declare and use `traits_type`. +See the example for [`copy`](char-traits-struct.md#copy) for an example of how to declare and use `traits_type`. ## `basic_string::value_type` @@ -4847,5 +4847,5 @@ The character ch2 is: H. ## See also -[``](../standard-library/string.md)\ -[Thread safety in the C++ standard library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[``](string.md)\ +[Thread safety in the C++ standard library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/binary-function-struct.md b/docs/standard-library/binary-function-struct.md index 719614bb1a7..510df3fc07f 100644 --- a/docs/standard-library/binary-function-struct.md +++ b/docs/standard-library/binary-function-struct.md @@ -13,6 +13,7 @@ An empty base struct that defines types that may be inherited by derived classes ## Syntax ```cpp +template struct binary_function { typedef Arg1 first_argument_type; typedef Arg2 second_argument_type; diff --git a/docs/standard-library/bit.md b/docs/standard-library/bit.md index ed42bc8ac34..5f6ca69bb1f 100644 --- a/docs/standard-library/bit.md +++ b/docs/standard-library/bit.md @@ -1,7 +1,7 @@ --- title: "" description: "Functions to access, manipulate, and process individual bits and sequences of bits." -ms.date: "08/28/2020" +ms.date: 08/28/2020 f1_keywords: [""] helpviewer_keywords: ["bit header"] --- @@ -13,9 +13,9 @@ For example, there are functions to rotate bits, find the number of consecutive ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` [`/std:c++20`](../build/reference/std-specify-language-standard-version.md) or later is required. @@ -25,24 +25,24 @@ For example, there are functions to rotate bits, find the number of consecutive | Type | Description | |--------|----------| -| [endian](bit-enum.md) | Specifies the endianness of scalar types. | +| [`endian`](bit-enum.md) | Specifies the endianness of scalar types. | ### Functions | Function | Description | |-----|-----| -|[bit_cast](bit-functions.md#bit_cast) | Reinterpret the object representation from one type to another. | -|[bit_ceil](bit-functions.md#bit_ceil) | Find the smallest power of two greater than or equal to a value. | -|[bit_floor](bit-functions.md#bit_floor) | Find the largest integral power of two not greater than a value. | -|[bit_width](bit-functions.md#bit_width) | Find the smallest number of bits needed to represent a value. | -|[countl_zero](bit-functions.md#countl_zero) | Count the number of consecutive bits set to zero, starting from the most significant bit. | -|[countl_one](bit-functions.md#countl_one) | Count the number of consecutive bits set to one, starting from the most significant bit. | -|[countr_zero](bit-functions.md#countr_zero) | Count the number of consecutive bits set to zero, starting from the least significant bit. | -|[countr_one](bit-functions.md#countl_one) | Count the number of consecutive bits set to one, starting from the least significant bit. | -|[has_single_bit](bit-functions.md#has_single_bit) | Check if a value has only a single bit set to one. This is the same as testing whether a value is a power of two. | -|[popcount](bit-functions.md#popcount) | Count the number of bits set to one. | -|[rotl](bit-functions.md#rotl) | Compute the result of a bitwise left-rotation. | -|[rotr](bit-functions.md#rotr) | Compute the result of a bitwise right-rotation. | +|[`bit_cast`](bit-functions.md#bit_cast) | Reinterpret the object representation from one type to another. | +|[`bit_ceil`](bit-functions.md#bit_ceil) | Find the smallest power of two greater than or equal to a value. | +|[`bit_floor`](bit-functions.md#bit_floor) | Find the largest integral power of two not greater than a value. | +|[`bit_width`](bit-functions.md#bit_width) | Find the smallest number of bits needed to represent a value. | +|[`countl_zero`](bit-functions.md#countl_zero) | Count the number of consecutive bits set to zero, starting from the most significant bit. | +|[`countl_one`](bit-functions.md#countl_one) | Count the number of consecutive bits set to one, starting from the most significant bit. | +|[`countr_zero`](bit-functions.md#countr_zero) | Count the number of consecutive bits set to zero, starting from the least significant bit. | +|[`countr_one`](bit-functions.md#countr_one) | Count the number of consecutive bits set to one, starting from the least significant bit. | +|[`has_single_bit`](bit-functions.md#has_single_bit) | Check if a value has only a single bit set to one. This is the same as testing whether a value is a power of two. | +|[`popcount`](bit-functions.md#popcount) | Count the number of bits set to one. | +|[`rotl`](bit-functions.md#rotl) | Compute the result of a bitwise left-rotation. | +|[`rotr`](bit-functions.md#rotr) | Compute the result of a bitwise right-rotation. | ## See also diff --git a/docs/standard-library/chrono-functions.md b/docs/standard-library/chrono-functions.md index d8131672ac2..80bc5412963 100644 --- a/docs/standard-library/chrono-functions.md +++ b/docs/standard-library/chrono-functions.md @@ -347,7 +347,7 @@ If the parse fails, `is.setstate`(`ios_base::failbit`) is called and the output ```cpp // 1) day - C++20 -template> +template> basic_istream& from_stream( basic_istream& is, const charT* fmt, diff --git a/docs/standard-library/chrono.md b/docs/standard-library/chrono.md index 82bc6ae8243..f2fdb6b4b75 100644 --- a/docs/standard-library/chrono.md +++ b/docs/standard-library/chrono.md @@ -44,7 +44,7 @@ Using the time-zone facilities on older versions of Windows results in a runtime | [`month` class](month-class.md) | A month of a year. For example, July. | | [`month_day` class](month-day-class.md) | A specific day of a specific month. For example, July 30. | | [`month_day_last` class](month-day-last-class.md) | The last day of a month. | -| [`month_weekday` class](month-day-last-class.md) | The nth weekday of a specific month. | +| [`month_weekday` class](month-weekday-class.md) | The nth weekday of a specific month. | | [`month_weekday_last` class](month-weekday-last-class.md) | The nth weekday of a specific month. | | [`time_point` class](time-point-class.md) | A point in time. | | [`weekday` class](weekday-class.md) | A day of the week. | diff --git a/docs/standard-library/container-class-begin.md b/docs/standard-library/container-class-begin.md deleted file mode 100644 index 18f29cf3dc1..00000000000 --- a/docs/standard-library/container-class-begin.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -description: "Learn more about: Container Class::begin" -title: "Container Class::begin" -ms.date: "05/07/2019" -helpviewer_keywords: ["begin method"] -ms.assetid: 633708cb-17fe-488b-9fb1-1b5f2da0f46c ---- -# Container Class::begin - -> [!NOTE] -> This topic is in the Visual Studio C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Returns an iterator that points at the first element of the sequence (or just beyond the end of an empty sequence). - -## Syntax - -```cpp -const_iterator begin() const; - -iterator begin(); -``` - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-clear.md b/docs/standard-library/container-class-clear.md deleted file mode 100644 index ff6627e9ed9..00000000000 --- a/docs/standard-library/container-class-clear.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Learn more about: Container Class::clear" -title: "Container Class::clear" -ms.date: "11/04/2016" -helpviewer_keywords: ["clear method"] -ms.assetid: 725f2717-5dc2-428f-a19a-05f046aafb2b ---- -# Container Class::clear - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Calls [erase](../standard-library/container-class-erase.md)([begin](../standard-library/container-class-begin.md), [end](../standard-library/container-class-end.md)). - -## Syntax - -```cpp -void clear(); -``` - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-const-iterator.md b/docs/standard-library/container-class-const-iterator.md deleted file mode 100644 index b54276698fb..00000000000 --- a/docs/standard-library/container-class-const-iterator.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Learn more about: Container Class::const_iterator" -title: "Container Class::const_iterator" -ms.date: "11/04/2016" -helpviewer_keywords: ["const_iterator method"] -ms.assetid: e68c9e30-fc4c-4c2e-8724-06d1fe8b8ccb ---- -# Container Class::const_iterator - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Describes an object that can serve as a constant iterator for the controlled sequence. - -## Syntax - -```cpp -typedef T6 const_iterator; -``` - -## Remarks - -It is described here as a synonym for the unspecified type `T6`. - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-const-reference.md b/docs/standard-library/container-class-const-reference.md deleted file mode 100644 index 9c926215247..00000000000 --- a/docs/standard-library/container-class-const-reference.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Learn more about: Container Class::const_reference" -title: "Container Class::const_reference" -ms.date: "11/04/2016" -helpviewer_keywords: ["const_reference method"] -ms.assetid: 7a5cfddb-3abf-4c98-b4ad-bbe4da9a5c1b ---- -# Container Class::const_reference - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Describes an object that can serve as a constant reference to an element of the controlled sequence. - -## Syntax - -```cpp -typedef T3 const_reference; -``` - -## Remarks - -It is described here as a synonym for the unspecified type `T3` (typically `Alloc::const_reference`). - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-const-reverse-iterator.md b/docs/standard-library/container-class-const-reverse-iterator.md deleted file mode 100644 index 274c0dae9c9..00000000000 --- a/docs/standard-library/container-class-const-reverse-iterator.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Learn more about: Container Class::const_reverse_iterator" -title: "Container Class::const_reverse_iterator" -ms.date: "11/04/2016" -helpviewer_keywords: ["const_reverse_iterator method"] -ms.assetid: ceac84d5-a40f-4bbf-81e0-a96aa2bd8ee8 ---- -# Container Class::const_reverse_iterator - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Describes an object that can serve as a constant reverse iterator for the controlled sequence. - -## Syntax - -```cpp -typedef T8 const_reverse_iterator; -``` - -## Remarks - -It is described here as a synonym for the unspecified type `T8` (typically [reverse_iterator](../standard-library/container-class-reverse-iterator.md) <[const_iterator](../standard-library/container-class-const-iterator.md)`>`). - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-difference-type.md b/docs/standard-library/container-class-difference-type.md deleted file mode 100644 index 3a271d8bfd4..00000000000 --- a/docs/standard-library/container-class-difference-type.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Learn more about: Container Class::difference_type" -title: "Container Class::difference_type" -ms.date: "11/04/2016" -helpviewer_keywords: ["difference_type typedef"] -ms.assetid: fae52485-d424-484e-9856-13505cfe528c ---- -# Container Class::difference_type - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Describes an object that can represent the difference between the addresses of any two elements in the controlled sequence. - -## Syntax - -```cpp -typedef T1 difference_type; -``` - -## Remarks - -It is described here as a synonym for the unspecified type `T1` (typically `Alloc::difference_type`). - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-empty.md b/docs/standard-library/container-class-empty.md deleted file mode 100644 index f4064bbd769..00000000000 --- a/docs/standard-library/container-class-empty.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Learn more about: Container Class::empty" -title: "Container Class::empty" -ms.date: "11/04/2016" -helpviewer_keywords: ["empty method"] -ms.assetid: 2055418d-3c42-4d28-a7db-111586119ed9 ---- -# Container Class::empty - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Returns **`true`** for an empty controlled sequence. - -## Syntax - -```cpp -bool empty() const; -``` - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-end.md b/docs/standard-library/container-class-end.md deleted file mode 100644 index b5da84d78d4..00000000000 --- a/docs/standard-library/container-class-end.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -description: "Learn more about: Container Class::end" -title: "Container Class::end" -ms.date: "11/04/2016" -helpviewer_keywords: ["end method"] -ms.assetid: 6fa38a20-3798-4387-9c6e-20fc3e90d813 ---- -# Container Class::end - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Returns an iterator that points just beyond the end of the sequence. - -## Syntax - -```cpp -const_iterator end() const; - -iterator end(); -``` - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-erase.md b/docs/standard-library/container-class-erase.md deleted file mode 100644 index 2101b201e4d..00000000000 --- a/docs/standard-library/container-class-erase.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -description: "Learn more about: Container Class::erase" -title: "Container Class::erase" -ms.date: "11/04/2016" -helpviewer_keywords: ["erase method"] -ms.assetid: abc091c5-5a80-4bd8-93a8-a2d9bde2efec ---- -# Container Class::erase - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Erases an element. - -## Syntax - -```cpp -iterator erase( - iterator _Where); - -iterator erase( - iterator first, - iterator last); -``` - -## Remarks - -The first member function removes the element of the controlled sequence pointed to by *_Where*. The second member function removes the elements of the controlled sequence in the range [`first`, `last`). Both return an iterator that designates the first element remaining beyond any elements removed, or [end](../standard-library/container-class-end.md) if no such element exists. - -The member functions throw an exception only if a copy operation throws an exception. - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-iterator.md b/docs/standard-library/container-class-iterator.md deleted file mode 100644 index 1b778bdd2a4..00000000000 --- a/docs/standard-library/container-class-iterator.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Learn more about: Container Class::iterator" -title: "Container Class::iterator" -ms.date: "11/04/2016" -helpviewer_keywords: ["iterator method"] -ms.assetid: f9c49d1c-17cb-4b17-8e54-09e3ea41ca26 ---- -# Container Class::iterator - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Describes an object that can serve as an iterator for the controlled sequence. - -## Syntax - -```cpp -typedef T5 iterator; -``` - -## Remarks - -It is described here as a synonym for the unspecified type `T5`. An object of type `iterator` can be cast to an object of type [const_iterator](../standard-library/container-class-const-iterator.md). - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-max-size.md b/docs/standard-library/container-class-max-size.md deleted file mode 100644 index 7cf4e3fa353..00000000000 --- a/docs/standard-library/container-class-max-size.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Learn more about: Container Class::max_size" -title: "Container Class::max_size" -ms.date: "11/04/2016" -helpviewer_keywords: ["max_size method"] -ms.assetid: 56754753-9911-48fd-b463-ac06b2fa1aab ---- -# Container Class::max_size - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Returns the length of the longest sequence that the object can control, in constant time regardless of the length of the controlled sequence. - -## Syntax - -```cpp -size_type max_size() const; -``` - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-rbegin.md b/docs/standard-library/container-class-rbegin.md deleted file mode 100644 index b4fb7e06e48..00000000000 --- a/docs/standard-library/container-class-rbegin.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -description: "Learn more about: Container Class::rbegin" -title: "Container Class::rbegin" -ms.date: "11/04/2016" -helpviewer_keywords: ["rbegin method"] -ms.assetid: c1f0d60c-93aa-4313-81b9-04e3f9c796c2 ---- -# Container Class::rbegin - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Returns a reverse iterator that points just beyond the end of the controlled sequence, designating the beginning of the reverse sequence. - -## Syntax - -```cpp -const_reverse_iterator rbegin() const; - -reverse_iterator rbegin(); -``` - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-reference.md b/docs/standard-library/container-class-reference.md deleted file mode 100644 index d595948cd5b..00000000000 --- a/docs/standard-library/container-class-reference.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Learn more about: Container Class::reference" -title: "Container Class::reference" -ms.date: "11/04/2016" -helpviewer_keywords: ["reference method"] -ms.assetid: ab85a9fb-c628-4761-9a5f-a0231fad7690 ---- -# Container Class::reference - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Describes an object that can serve as a reference to an element of the controlled sequence. - -## Syntax - -```cpp -typedef T2 reference; -``` - -## Remarks - -It is described here as a synonym for the unspecified type `T2` (typically `Alloc::reference`). An object of type `reference` can be cast to an object of type [const_reference](../standard-library/container-class-const-reference.md). - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-rend.md b/docs/standard-library/container-class-rend.md deleted file mode 100644 index 82a170fc152..00000000000 --- a/docs/standard-library/container-class-rend.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -description: "Learn more about: Container Class::rend" -title: "Container Class::rend" -ms.date: "11/04/2016" -helpviewer_keywords: ["rend method"] -ms.assetid: 80f3dd04-dd2c-4b52-b0ed-d567ec5d186c ---- -# Container Class::rend - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -The member function returns a reverse iterator that points at the first element of the sequence (or just beyond the end of an empty sequence), designating the end of the reverse sequence. - -## Syntax - -```cpp -const_reverse_iterator rend() const; - -reverse_iterator rend(); -``` - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-reverse-iterator.md b/docs/standard-library/container-class-reverse-iterator.md deleted file mode 100644 index 73a36729007..00000000000 --- a/docs/standard-library/container-class-reverse-iterator.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Learn more about: Container Class::reverse_iterator" -title: "Container Class::reverse_iterator" -ms.date: "11/04/2016" -helpviewer_keywords: ["reverse_iterator method"] -ms.assetid: 1d190c41-56b1-462e-b564-793b2a883c26 ---- -# Container Class::reverse_iterator - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Describes an object that can serve as a reverse iterator for the controlled sequence. - -## Syntax - -```cpp -typedef T7 reverse_iterator; -``` - -## Remarks - -It is described here as a synonym for the unspecified type `T7` (typically `reverse_iterator` **\<**[iterator](../standard-library/container-class-iterator.md)**>**). - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-size-type.md b/docs/standard-library/container-class-size-type.md deleted file mode 100644 index 458b57a0582..00000000000 --- a/docs/standard-library/container-class-size-type.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Learn more about: Container Class::size_type" -title: "Container Class::size_type" -ms.date: "11/04/2016" -helpviewer_keywords: ["size_type typedef"] -ms.assetid: e02de8af-e175-45a2-b006-835814a40e68 ---- -# Container Class::size_type - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Describes an object that can represent the length of any controlled sequence. - -## Syntax - -```cpp -typedef T0 size_type; -``` - -## Remarks - -It is described here as a synonym for the unspecified type `T0` (typically `Alloc::size_type`). - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-size.md b/docs/standard-library/container-class-size.md deleted file mode 100644 index 07a0e4ea210..00000000000 --- a/docs/standard-library/container-class-size.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Learn more about: Container Class::size" -title: "Container Class::size" -ms.date: "11/04/2016" -helpviewer_keywords: ["size method"] -ms.assetid: 67073661-2699-4534-ad3b-31a906658dc5 ---- -# Container Class::size - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Returns the length of the controlled sequence, in constant time regardless of the length of the controlled sequence. - -## Syntax - -```cpp -size_type size() const; -``` - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-swap.md b/docs/standard-library/container-class-swap.md deleted file mode 100644 index 1e976af3713..00000000000 --- a/docs/standard-library/container-class-swap.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -description: "Learn more about: Container Class::swap" -title: "Container Class::swap" -ms.date: 06/10/2022 -helpviewer_keywords: ["swap method"] -ms.assetid: 898c219c-bc8e-4d14-a149-6240426c693f -ms.custom: devdivchpfy22 ---- - -# Container Class::swap - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Swaps the controlled sequences between `*this` and its argument. - -## Syntax - -```cpp -void swap(Container& right); -``` - -## Remarks - -If `*this.get_allocator == right.get_allocator`, it does a swap in constant time. Otherwise, it performs element assignments and constructor calls proportional to the number of elements in the two controlled sequences. - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/container-class-value-type.md b/docs/standard-library/container-class-value-type.md deleted file mode 100644 index 9ff7647669d..00000000000 --- a/docs/standard-library/container-class-value-type.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Learn more about: Container Class::value_type" -title: "Container Class::value_type" -ms.date: "11/04/2016" -helpviewer_keywords: ["value_type typedef"] -ms.assetid: e89d5a71-b48c-47fa-aa78-682243e6e97f ---- -# Container Class::value_type - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Acts a synonym for the template parameter *Ty*. - -## Syntax - -```cpp -typedef T4 value_type; -``` - -## Remarks - -It is described here as a synonym for the unspecified type `T4` (typically `Alloc::value_type`). - -## See also - -[Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/cpp-standard-library-header-files.md b/docs/standard-library/cpp-standard-library-header-files.md index a0eaf3e4630..969be33da60 100644 --- a/docs/standard-library/cpp-standard-library-header-files.md +++ b/docs/standard-library/cpp-standard-library-header-files.md @@ -1,7 +1,7 @@ --- title: "C++ standard library header files" description: "C++ standard library header files, categorized" -ms.date: 08/31/2020 +ms.date: 03/05/2026 helpviewer_keywords: ["header files, C++ Standard Library", "C++ Standard Library, header files"] --- # C++ standard library header files @@ -23,17 +23,18 @@ Header files for the C++ standard library and extensions, by category. | Ordered associative containers| [``](map.md), [``](set.md) | | Unordered associative containers | [``](unordered-map.md)11, [``](unordered-set.md)11 | | Container adaptors | [``](queue.md), [``](stack.md) | -| Container views | [``](span.md)20 | +| Container views | ``23, [``](span.md)20 | +| Diagnostics | ``23 | | [Errors and exception handling](../cpp/errors-and-exception-handling-modern-cpp.md) | [``](cassert.md), [``](exception.md), [``](stdexcept.md), [``](system-error.md)11 | -| General utilities | [``](any.md)17, [``](bit.md)20, [``](bitset.md), [``](cstdlib.md), [``](execution.md)17, [``](functional.md), [``](memory.md), [``](memory-resource.md)17, [``](optional.md)17, [``](ratio.md)11, [``](scoped-allocator.md)11, [``](tuple.md)11, [``](type-traits.md)11, [``](typeindex.md)11, [``](utility.md), [``](variant.md)17 | -| [I/O and formatting](../text/string-and-i-o-formatting-modern-cpp.md) | [``](cinttypes.md)11, [``](cstdio.md), [``](filesystem.md)17, [``](fstream.md), [``](iomanip.md), [``](ios.md), [``](iosfwd.md), [``](iostream.md), [``](istream.md), [``](ostream.md), [``](sstream.md), [``](streambuf.md), [``](strstream.md)c, ``20 | +| General utilities | [``](any.md)17, [``](bit.md)20, [``](bitset.md), [``](cstdlib.md), [``](execution.md)17, ``23, [``](functional.md), [``](memory.md), [``](memory-resource.md)17, [``](optional.md)17, [``](ratio.md)11, [``](scoped-allocator.md)11, [``](tuple.md)11, [``](type-traits.md)11, [``](typeindex.md)11, [``](utility.md), [``](variant.md)17 | +| [I/O and formatting](../text/string-and-i-o-formatting-modern-cpp.md) | [``](cinttypes.md)11, [``](cstdio.md), [``](filesystem.md)17, ``20, [``](fstream.md), [``](iomanip.md), [``](ios.md), [``](iosfwd.md), [``](iostream.md), [``](istream.md), [``](ostream.md), ``23, ``23, [``](sstream.md), [``](streambuf.md), [``](strstream.md)c, ``20 | | Iterators | [``](iterator.md) | -| Language support | [``](cfloat.md), [``](climits.md), [``](codecvt.md)11 a, ``20, ``20, ``20, [``](csetjmp.md), [``](csignal.md), [``](cstdarg.md), [``](cstddef.md), [``](cstdint.md)11, [``](cstdlib.md), [``](exception.md), [``](initializer-list.md)11, [``](limits.md), [``](new.md), [``](typeinfo.md), ``20 | +| Language support | [``](cfloat.md), [``](climits.md), [``](codecvt.md)11 a, ``20, ``20, [``](csetjmp.md), [``](csignal.md), [``](cstdarg.md), [``](cstddef.md), [``](cstdint.md)11, [``](cstdlib.md), [``](exception.md), [``](initializer-list.md)11, [``](limits.md), [``](new.md), ``20, ``23, [``](typeinfo.md), ``20 | | Localization | [``](clocale.md), [``](codecvt.md)11 a, [``](cvt-wbuffer.md), [``](cvt-wstring.md), [``](locale.md) | -| Math and numerics | [``](bit.md)20, [``](cfenv.md)11, [``](cmath.md), [``](complex.md), [``](cstdlib.md), [``](limits.md), [``](numeric.md), [``](random.md)11, [``](ratio.md)11, [``](valarray.md) | +| Math and numerics | [``](bit.md)20, [``](cfenv.md)11, [``](cmath.md), [``](complex.md), [``](cstdlib.md), [``](limits.md), ``20, [``](numeric.md), [``](random.md)11, [``](ratio.md)11, [``](valarray.md) | | [Memory management](../cpp/smart-pointers-modern-cpp.md) | [``](allocators-header.md), [``](memory.md), [``](memory-resource.md)17, [``](new.md), [``](scoped-allocator.md)11 | -| Multithreading | [``](atomic.md)11, [``](condition-variable.md)11, [``](future.md)11, [``](mutex.md)11, [``](shared-mutex.md)14, [``](thread.md)11 | -| Ranges | [``](ranges.md)20 | +| Multithreading | [``](atomic.md)11, ``20, [``](condition-variable.md)11, [``](future.md)11, ``20, [``](mutex.md)11, ``20, [``](shared-mutex.md)14, ``20, [``](thread.md)11 | +| Ranges | ``23, [``](ranges.md)20 | | Regular expressions | [``](regex.md)11 | | Strings and character data | [``](charconv.md)17, [``](cctype.md), [``](cstdlib.md), [``](cstring.md), [``](cuchar.md)11, [``](cwchar.md), [``](cwctype.md), [``](regex.md)11, [``](string.md), [``](string-view.md)17 | | Time | [``](chrono.md)11, [``](ctime.md) | @@ -41,9 +42,10 @@ Header files for the C++ standard library and extensions, by category. 11 Added in the C++11 standard.\ 14 Added in the C++14 standard.\ 17 Added in the C++17 standard.\ -20 Added in the draft C++20 standard.\ +20 Added in the C++20 standard.\ +23 Added in the C++23 standard.\ a Deprecated in the C++17 standard.\ -b Removed in the draft C++20 standard.\ +b Removed in the C++20 standard.\ c Deprecated in the C++98 standard. ::: moniker-end @@ -58,7 +60,7 @@ Header files for the C++ standard library and extensions, by category. |Sequence containers|[``](array.md), [``](deque.md), [``](forward-list.md), [``](list.md), [``](vector.md)| |Ordered associative containers| [``](map.md), [``](set.md)| |Unordered associative containers|[``](unordered-map.md), [``](unordered-set.md)| -|Adaptor containers|[``](queue.md), [``](stack.md)| +|Container adaptors|[``](queue.md), [``](stack.md)| |[Errors and exception handling](../cpp/errors-and-exception-handling-modern-cpp.md)|[``](exception.md), [``](stdexcept.md), [``](system-error.md)| |[I/O and formatting](../text/string-and-i-o-formatting-modern-cpp.md)|[``](filesystem.md), [``](fstream.md), [``](iomanip.md), [``](ios.md), [``](iosfwd.md), [``](iostream.md), [``](istream.md), [``](ostream.md), [``](sstream.md), [``](streambuf.md), [``](strstream.md)| |Iterators|[``](iterator.md)| diff --git a/docs/standard-library/domain-error-class.md b/docs/standard-library/domain-error-class.md index fe6bc72dfe1..c976e9d9d67 100644 --- a/docs/standard-library/domain-error-class.md +++ b/docs/standard-library/domain-error-class.md @@ -1,12 +1,11 @@ --- -description: "Learn more about: domain_error Class" -title: "domain_error Class" -ms.date: "09/09/2021" +title: "domain_error class" +description: "Learn more about: domain_error class" +ms.date: 09/09/2021 f1_keywords: ["stdexcept/std::domain_error"] helpviewer_keywords: ["domain_error class"] -ms.assetid: a1d8245d-61c2-4d1e-973f-073bd5dd5fa3 --- -# domain_error Class +# `domain_error` class The class serves as the base class for all exceptions thrown to report a domain error (as in mathematics, not networking). @@ -18,13 +17,12 @@ public: explicit domain_error(const string& message); explicit domain_error(const char *message); - }; ``` ## Remarks -The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](../standard-library/exception-class.md) and [`data`](../standard-library/basic-string-class.md#data). +The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](exception-class.md) and [`data`](basic-string-class.md#data). `domain_error` isn't thrown by any functions in the Microsoft implementation of the C++ Standard Library, but it might be thrown by third-party libraries or user code. @@ -51,19 +49,20 @@ int main() cerr << "Type: " << typeid(e).name() << endl; } } -/* Output: +``` + +```Output Caught: Your domain is in error! Type: class std::domain_error -*/ ``` ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## See also -[logic_error Class](../standard-library/logic-error-class.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[`logic_error` class](logic-error-class.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/gslice-array-class.md b/docs/standard-library/gslice-array-class.md index 727afddc3f6..22e90f11d0b 100644 --- a/docs/standard-library/gslice-array-class.md +++ b/docs/standard-library/gslice-array-class.md @@ -1,10 +1,9 @@ --- -description: "Learn more about: gslice_array class" title: "gslice_array class" +description: "Learn more about: gslice_array class" ms.date: 01/12/2022 f1_keywords: ["valarray/std::gslice_array"] helpviewer_keywords: ["gslice_array class"] -ms.assetid: ad1b4514-b14a-4baf-a293-d5a8e8674c75 --- # `gslice_array` class @@ -42,7 +41,7 @@ public: void operator>>=(const valarray& x) const; // The rest is private or implementation defined -} +}; ``` ## Remarks diff --git a/docs/standard-library/identity-structure.md b/docs/standard-library/identity-structure.md index bfb04dac3b2..252785219fc 100644 --- a/docs/standard-library/identity-structure.md +++ b/docs/standard-library/identity-structure.md @@ -1,31 +1,96 @@ --- description: "Learn more about: identity Structure" title: "identity Structure" -ms.date: "11/04/2016" +ms.date: 04/11/2026 f1_keywords: ["utility/std::identity"] helpviewer_keywords: ["identity class", "identity structure"] -ms.assetid: 990756fd-7969-4b39-ad7e-0878e8dac8fd +ai-usage: ai-assisted --- -# identity Structure +# `identity` Structure -A struct that provides a type definition as the template parameter. +`std::identity` (introduced in C++20) is a function object whose `operator()` returns its argument unchanged. -## Syntax +> [!NOTE] +> There's a Microsoft-specific `identity` structure from `` that is deprecated and isn't available in later versions of Visual Studio. For C++20 and later, use `std::identity` from [``](functional.md) instead, which is the standard-conforming equivalent described below. + +## `std::identity` (C++20) + +Many standard library APIs take a callable argument such as a projection or transformation function. If you need to pass a callable but don't want to change the data, pass `std::identity`. This is common in ranges algorithms. Many `` ranges overloads have a projection parameter that defaults to `std::identity{}`. + +### Syntax ```cpp -struct identity { - typedef Type type; - Type operator()(const Type& left) const; +struct identity +{ + template + _NODISCARD constexpr T&& operator()(T&& t) const noexcept; + using is_transparent = int; }; ``` -### Parameters +### Remarks + +The `is_transparent` member type is a tag that marks `std::identity` as a transparent function object. Its presence indicates that algorithms can perform comparisons or projections without needing to convert types to a common form first. This is useful for associative containers and algorithms that support heterogeneous lookup, allowing them to compare different types directly without constructing temporary objects. -*left*\ -The value to identify. +### Examples -## Remarks +```cpp +#include +#include +#include +#include +#include + +int main() +{ + std::vector v{3, 1, 4, 1, 5, 9, 2, 6}; -The class contains the public type definition `type`, which is the same as the template parameter Type. It is used in conjunction with template function [forward](../standard-library/utility-functions.md#forward) to ensure that a function parameter has the desired type. + // Ranges algorithms can apply a projection before comparison. + // But if you don't want to apply a projection, i.e. you don't want to modify the data + // before comparison, you can use std::identity to leave each element unchanged. + // Here, std::identity{} means "project each element as itself". + // So the comparator sees the original int values unchanged. + std::ranges::sort(v, std::less{}, std::identity{}); -For compatibility with older code, the class also defines the identity function `operator()` which returns its argument *left*. + // This call is equivalent because std::identity{} is the default projection. + // In both calls, elements are sorted directly; no field extraction or + // value transformation happens first. + std::ranges::sort(v); + + for (int n : v) + { + std::cout << n << ' '; + } + std::cout << '\n'; + // Output: 1 1 2 3 4 5 6 9 +} +``` + +This example searches a `std::vector` with a `std::string_view` key. Because `std::identity` has the `is_transparent` member, the algorithm knows to compare these types directly. This way the key doesn't get converted to a temporary `std::string` just to do the comparison. + +```cpp +#include +#include +#include +#include +#include +#include +#include + +int main() +{ + std::vector words{"apple", "banana", "cherry", "date"}; + std::string_view key = "cherry"; + + // `std::less<>` is transparent, so it can compare `std::string` and + // `std::string_view` directly. + // `std::identity` is also marked transparent (`is_transparent`), so the + // projection stays type-flexible instead of forcing one fixed type. + auto it = std::ranges::lower_bound(words, key, std::less<>{}, std::identity{}); + + if (it != words.end() && *it == key) + { + std::cout << "Found: " << *it << '\n'; + } +} +``` diff --git a/docs/standard-library/invalid-argument-class.md b/docs/standard-library/invalid-argument-class.md index 9a3babf927a..f2a22f505cb 100644 --- a/docs/standard-library/invalid-argument-class.md +++ b/docs/standard-library/invalid-argument-class.md @@ -1,12 +1,11 @@ --- -description: "Learn more about: invalid_argument Class" -title: "invalid_argument Class" -ms.date: "09/09/2021" +title: "invalid_argument class" +description: "Learn more about: invalid_argument class" +ms.date: 09/09/2021 f1_keywords: ["stdexcept/std::invalid_argument"] helpviewer_keywords: ["invalid_argument class"] -ms.assetid: af6c227d-ad7c-4e63-9dee-67af81d83506 --- -# invalid_argument Class +# `invalid_argument` class The class serves as the base class for all exceptions thrown to report an invalid argument. @@ -18,13 +17,12 @@ public: explicit invalid_argument(const string& message); explicit invalid_argument(const char *message); - }; ``` ## Remarks -The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](../standard-library/exception-class.md) and [`data`](../standard-library/basic-string-class.md#data). +The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](exception-class.md) and [`data`](basic-string-class.md#data). ## Example @@ -49,19 +47,20 @@ int main() cerr << "Type: " << typeid(e).name() << endl; } } -/* Output: +``` + +```Output Caught: invalid bitset char Type: class std::invalid_argument -*/ ``` ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## See also -[logic_error Class](../standard-library/logic-error-class.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[`logic_error` class](logic-error-class.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/iostreams-conventions.md b/docs/standard-library/iostreams-conventions.md index bfc1b389ddd..33f3588d273 100644 --- a/docs/standard-library/iostreams-conventions.md +++ b/docs/standard-library/iostreams-conventions.md @@ -1,33 +1,32 @@ --- -description: "Learn more about: iostreams Conventions" title: "iostreams Conventions" -ms.date: "11/04/2016" +description: "Learn more about: iostreams Conventions" +ms.date: 11/04/2016 helpviewer_keywords: ["iostream header", "C++ Standard Library, iostreams"] -ms.assetid: 9fe5ded0-37a1-48d1-9671-c81ffc4760ad --- # iostreams Conventions The iostreams headers support conversions between text and encoded forms, and input and output to external files: -[\](../standard-library/fstream.md)\ -[\](../standard-library/iomanip.md)\ -[\](../standard-library/ios.md)\ -[\](../standard-library/iosfwd.md)\ -[\](../standard-library/iostream.md)\ -[\](../standard-library/istream.md)\ -[\](../standard-library/ostream.md)\ -[\](../standard-library/sstream.md)\ -[\](../standard-library/streambuf.md)\ -[\](../standard-library/strstream.md) +[``](fstream.md)\ +[``](iomanip.md)\ +[``](ios.md)\ +[``](iosfwd.md)\ +[``](iostream.md)\ +[``](istream.md)\ +[``](ostream.md)\ +[``](sstream.md)\ +[``](streambuf.md)\ +[``](strstream.md) -The simplest use of iostreams requires only that you include the header [\](../standard-library/iostream.md). You can then extract values from [cin](../standard-library/iostream.md#cin) or [wcin](../standard-library/iostream.md#wcin) to read the standard input. The rules for doing so are outlined in the description of the class [basic_istream Class](../standard-library/basic-istream-class.md). You can also insert values to [cout](../standard-library/iostream.md#cout) or [wcout](../standard-library/iostream.md#wcout) to write the standard output. The rules for doing so are outlined in the description of the class [basic_ostream Class](../standard-library/basic-ostream-class.md). Format control common to both extractors and insertors is managed by the class [basic_ios Class](../standard-library/basic-ios-class.md). Manipulating this format information in the guise of extracting and inserting objects is the province of several manipulators. +The simplest use of iostreams requires only that you include the header [``](iostream.md). You can then extract values from [`cin`](iostream.md#cin) or [`wcin`](iostream.md#wcin) to read the standard input. The rules for doing so are outlined in the description of the [`basic_istream` class](basic-istream-class.md). You can also insert values to [`cout`](iostream.md#cout) or [`wcout`](iostream.md#wcout) to write the standard output. The rules for doing so are outlined in the description of the [`basic_ostream` class](basic-ostream-class.md). Format control common to both extractors and insertors is managed by the [`basic_ios` class](basic-ios-class.md). Manipulating this format information in the guise of extracting and inserting objects is the province of several manipulators. -You can perform the same iostreams operations on files that you open by name, using the classes declared in [\](../standard-library/fstream.md). To convert between iostreams and objects of class [basic_string Class](../standard-library/basic-string-class.md), use the classes declared in [\](../standard-library/sstream.md). To do the same with C strings, use the classes declared in [\](../standard-library/strstream.md). +You can perform the same iostreams operations on files that you open by name, using the classes declared in [``](fstream.md). To convert between iostreams and objects of [`basic_string` class](basic-string-class.md), use the classes declared in [``](sstream.md). To do the same with C strings, use the classes declared in [``](strstream.md). The remaining headers provide support services, typically of direct interest to only the most advanced users of the iostreams classes. ## See also -[C++ Standard Library Overview](../standard-library/cpp-standard-library-overview.md)\ -[iostream Programming](../standard-library/iostream-programming.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[C++ Standard Library Overview](cpp-standard-library-overview.md)\ +[`iostream` Programming](iostream-programming.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/istream-functions.md b/docs/standard-library/istream-functions.md index 8c6d33665e1..5b0e2c372b6 100644 --- a/docs/standard-library/istream-functions.md +++ b/docs/standard-library/istream-functions.md @@ -37,7 +37,8 @@ A stream. Skips white space in the stream. ```cpp -template class basic_istream& ws(basic_istream& _Istr); +template +basic_istream& ws(basic_istream& _Istr); ``` ### Parameters diff --git a/docs/standard-library/istreambuf-iterator-class.md b/docs/standard-library/istreambuf-iterator-class.md index 5cbf0e24d8d..13b7a13fc70 100644 --- a/docs/standard-library/istreambuf-iterator-class.md +++ b/docs/standard-library/istreambuf-iterator-class.md @@ -14,7 +14,7 @@ The class template istreambuf_iterator describes an input iterator object that e ## Syntax ```cpp -template > +template > class istreambuf_iterator : public iterator ``` diff --git a/docs/standard-library/length-error-class.md b/docs/standard-library/length-error-class.md index 7df63ed20bc..7230d8b628f 100644 --- a/docs/standard-library/length-error-class.md +++ b/docs/standard-library/length-error-class.md @@ -1,12 +1,11 @@ --- -description: "Learn more about: length_error Class" -title: "length_error Class" -ms.date: "09/09/2021" +title: "length_error class" +description: "Learn more about: length_error class" +ms.date: 09/09/2021 f1_keywords: ["stdexcept/std::length_error"] helpviewer_keywords: ["length_error class"] -ms.assetid: d53c46c5-4626-400d-bd76-bf3e1e0f64ae --- -# length_error Class +# `length_error` class The class serves as the base class for all exceptions thrown to report an attempt to generate an object too long to be specified. @@ -18,13 +17,12 @@ public: explicit length_error(const string& message); explicit length_error(const char *message); - }; ``` ## Remarks -The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](../standard-library/exception-class.md) and [`data`](../standard-library/basic-string-class.md#data). +The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](exception-class.md) and [`data`](basic-string-class.md#data). ## Example @@ -50,19 +48,20 @@ int main() cerr << "Type: " << typeid(e).name() << endl; } } -/* Output: +``` + +```Output Caught: vector too long Type: class std::length_error -*/ ``` ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## See also -[logic_error Class](../standard-library/logic-error-class.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[`logic_error` class](logic-error-class.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/locale-class.md b/docs/standard-library/locale-class.md index b627b01ac3b..96b2151a0f3 100644 --- a/docs/standard-library/locale-class.md +++ b/docs/standard-library/locale-class.md @@ -1,10 +1,9 @@ --- description: "Learn more about: locale Class" title: "locale Class" -ms.date: 06/15/2022 +ms.date: 11/13/2025 f1_keywords: ["xlocale/std::locale", "xlocale/std::locale::category", "xlocale/std::locale::combine", "xlocale/std::locale::name", "xlocale/std::locale::classic", "xlocale/std::locale::global", "xlocale/std::locale::operator( )", "xlocale/std::locale::facet", "xlocale/std::locale::id"] helpviewer_keywords: ["std::locale [C++]", "std::locale [C++], category", "std::locale [C++], combine", "std::locale [C++], name", "std::locale [C++], classic", "std::locale [C++], global", "std::locale [C++], facet", "std::locale [C++], id"] -ms.assetid: 7dd6d271-472d-4750-8fb5-ea8f55fbef62 ms.custom: devdivchpfy22 --- @@ -92,15 +91,16 @@ messages Some of these predefined facets are used by the `iostream` classes, to control the conversion of numeric values to and from text sequences. -An object of class locale also stores a locale name as an object of class [string](../standard-library/string-typedefs.md#string). Using an invalid locale name to construct a locale facet or a locale object throws an object of class [runtime_error](../standard-library/runtime-error-class.md). The stored locale name is `"*"` if the locale object can't be certain that a C-style locale corresponds exactly to the one represented by the object. Otherwise, you can establish a matching locale within the Standard C Library, for some locale object `locale_object`, by calling `setlocale(LC_ALL , locale_object.`[name](#name)`().c_str())`. - -In this implementation, you can also call the static member function: +An object of class `locale` also stores a locale name as an object of class [string](../standard-library/string-typedefs.md#string). Using an invalid locale name to construct a locale facet or a locale object throws an object of class [runtime_error](../standard-library/runtime-error-class.md). The stored locale name is `"*"` if the locale object can't be certain that a C-style locale corresponds exactly to the one represented by the object. Otherwise, you can establish a matching locale within the Standard C Library, for some locale object `locale_object`, by calling `setlocale(LC_ALL , locale_object.`[name](#name)`().c_str())`. ```cpp static locale empty(); ``` -to construct a locale object that has no facets. It's also a transparent locale. If the template functions [has_facet](../standard-library/locale-functions.md#has_facet) and [use_facet](../standard-library/locale-functions.md#use_facet) can't find the requested facet in a transparent locale, they consult first the global locale and then, if that is transparent, the classic locale. So, you can write: +> [!NOTE] +> `locale::empty()` was deprecated starting with Visual Studio 2022 17.14. It'll be removed starting with MSVC Build Tools 14.51. For more information, see [#5834](https://github.com/microsoft/STL/pull/5834). + +In this implementation, you can also call the static member function `empty()` to construct a locale object that has no facets. It's also a transparent locale. If the template functions [has_facet](../standard-library/locale-functions.md#has_facet) and [use_facet](../standard-library/locale-functions.md#use_facet) can't find the requested facet in a transparent locale, they consult first the global locale and then, if that is transparent, the classic locale. So, you can write: ```cpp cout.imbue(locale::empty()); diff --git a/docs/standard-library/logic-error-class.md b/docs/standard-library/logic-error-class.md index 63f9e82219b..6d096245bda 100644 --- a/docs/standard-library/logic-error-class.md +++ b/docs/standard-library/logic-error-class.md @@ -1,12 +1,11 @@ --- -description: "Learn more about: logic_error Class" -title: "logic_error Class" -ms.date: "09/09/2021" +title: "logic_error class" +description: "Learn more about: logic_error class" +ms.date: 09/09/2021 f1_keywords: ["stdexcept/std::logic_error"] helpviewer_keywords: ["logic_error class"] -ms.assetid: b290d73d-94e1-4288-af86-2bb5d71f677a --- -# logic_error Class +# `logic_error` class The class serves as the base class for all exceptions thrown to report errors presumably detectable before the program executes, such as violations of logical preconditions. @@ -18,13 +17,12 @@ public: explicit logic_error(const string& message); explicit logic_error(const char *message); - }; ``` ## Remarks -The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](../standard-library/exception-class.md) and [`data`](../standard-library/basic-string-class.md#data). +The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](exception-class.md) and [`data`](basic-string-class.md#data). ## Example @@ -49,19 +47,20 @@ int main() cerr << "Type: " << typeid(e).name() << endl; } } -/* Output: +``` + +```Output Caught: Does not compute! Type: class std::logic_error -*/ ``` ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## See also -[exception Class](../standard-library/exception-class.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[`exception` class](exception-class.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/new.md b/docs/standard-library/new.md index 79dfcd6b5b4..09baa6795b1 100644 --- a/docs/standard-library/new.md +++ b/docs/standard-library/new.md @@ -1,10 +1,9 @@ --- -description: "Learn more about: " title: "" -ms.date: "11/04/2016" +description: "Learn more about: " +ms.date: 11/04/2016 f1_keywords: [""] helpviewer_keywords: ["new header"] -ms.assetid: 218e2a15-34e8-4ef3-9122-1e90eccf8559 --- # `` @@ -33,7 +32,7 @@ Some of the functions declared in this header are replaceable. The implementatio |Name|Description| |-|-| |[new_handler](../standard-library/new-typedefs.md#new_handler)|A type that points to a function suitable for use as a new handler.| -|[hardware_constructive_interference_size](../standard-library/new-typedefs.md#hardware_destructive_interference_size)|| +|[hardware_constructive_interference_size](../standard-library/new-typedefs.md#hardware_constructive_interference_size)|| |[hardware_destructive_interference_size](../standard-library/new-typedefs.md#hardware_destructive_interference_size)|| ### Functions diff --git a/docs/standard-library/normal-distribution-class.md b/docs/standard-library/normal-distribution-class.md index db8ba64c3be..e9e4be15c45 100644 --- a/docs/standard-library/normal-distribution-class.md +++ b/docs/standard-library/normal-distribution-class.md @@ -83,7 +83,7 @@ using namespace std; void test(const double m, const double s, const int samples) { // uncomment to use a non-deterministic seed - // random_device gen; + // random_device rd; // mt19937 gen(rd()); mt19937 gen(1701); diff --git a/docs/standard-library/operator-equality-sample-container.md b/docs/standard-library/operator-equality-sample-container.md deleted file mode 100644 index 63715e0da1d..00000000000 --- a/docs/standard-library/operator-equality-sample-container.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Learn more about: operator== ()" -title: "operator== ()" -ms.date: "11/04/2016" -f1_keywords: ["std.==", "std::==", "operator==", "std.operator==", "std::operator==", "=="] -helpviewer_keywords: ["operator ==, containers", "operator==, containers", "== operator, with specific standard C++ objects"] -ms.assetid: d3d8754e-5157-4b8b-bf9c-da41856f5eed ---- -# `operator==` (``) - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Overloads `operator==` to compare two objects of class template [Container](../standard-library/sample-container-class.md). - -## Syntax - -```cpp -template -bool operator==( - const Container & left, - const Container & right); -``` - -## Return Value - -Returns `left.`[size](../standard-library/container-class-size.md) `== right.size && equal(left.`[begin](../standard-library/container-class-begin.md)`, left.`[end](../standard-library/container-class-end.md)`, right.begin)`. - -## See also - -[\](../standard-library/sample-container.md) diff --git a/docs/standard-library/operator-greater-or-equal.md b/docs/standard-library/operator-greater-or-equal.md deleted file mode 100644 index 13d31d815af..00000000000 --- a/docs/standard-library/operator-greater-or-equal.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Learn more about: operator>=" -title: "operator>=" -ms.date: "11/04/2016" -f1_keywords: ["operator>=", "std::>=", "std.operator>=", ">=", "std.>=", "std::operator>="] -helpviewer_keywords: [">= operator, comparing specific objects", "operator >=", "operator>="] -ms.assetid: 14fbebf5-8b75-4afa-a51b-3112d31c07cf ---- -# `operator>=` - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Overloads **operator>=** to compare two objects of class template [Container](../standard-library/sample-container-class.md). - -## Syntax - -```cpp -template -bool operator>=( - const Container & left, - const Container & right); -``` - -## Return Value - -Returns `!(left < right)`. - -## See also - -[\](../standard-library/sample-container.md) diff --git a/docs/standard-library/operator-greater-than-sample-container.md b/docs/standard-library/operator-greater-than-sample-container.md deleted file mode 100644 index a6bf41df1d3..00000000000 --- a/docs/standard-library/operator-greater-than-sample-container.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Learn more about: operator> ()" -title: "operator> ()" -ms.date: "11/04/2016" -f1_keywords: ["std::operator>", "operator>", "std::>", ">"] -helpviewer_keywords: ["> operator, comparing specific objects", "operator >"] -ms.assetid: 49bd417a-3305-4ffa-9884-39d3904ed87d ---- -# `operator>` (``) - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Overloads **operator>** to compare two objects of class template [Container](../standard-library/sample-container-class.md). - -## Syntax - -```cpp -template -bool operator*gt( - const Container & left, - const Container & right); -``` - -## Return Value - -Returns `right < left`. - -## See also - -[\](../standard-library/sample-container.md) diff --git a/docs/standard-library/operator-inequality.md b/docs/standard-library/operator-inequality.md deleted file mode 100644 index 1416a3f3cc3..00000000000 --- a/docs/standard-library/operator-inequality.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Learn more about: operator!=" -title: "operator!=" -ms.date: "11/04/2016" -f1_keywords: ["std::!=", "!=", "std::operator!=", "std.operator!=", "std.!=", "operator!="] -helpviewer_keywords: ["!= operator", "operator!=", "operator !="] -ms.assetid: ef2be7f0-1c94-4edc-b65c-731fddd519f4 ---- -# operator!= - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Overloads `operator!=` to compare two objects of class template [Container](../standard-library/sample-container-class.md). - -## Syntax - -```cpp -template -bool operator!=( - const Container & left, - const Container & right); -``` - -## Return Value - -Returns `!(left == right)`. - -## See also - -[\](../standard-library/sample-container.md) diff --git a/docs/standard-library/operator-less-or-equal-sample-container.md b/docs/standard-library/operator-less-or-equal-sample-container.md deleted file mode 100644 index db35e24ec91..00000000000 --- a/docs/standard-library/operator-less-or-equal-sample-container.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Learn more about: operator<= ()" -title: "operator<= ()" -ms.date: "11/04/2016" -f1_keywords: ["std::<=", "std.operator<=", "operator<=", "std.<=", "std::operator<=", "<="] -helpviewer_keywords: ["operator<=", "operator <=", "<= operator, with specific objects", "<= operator"] -ms.assetid: 338577dd-dc88-4a2b-9e12-0379c54fc8a2 ---- -# `operator<=` (``) - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Overloads **operator<=** to compare two objects of class template [Container](../standard-library/sample-container-class.md). - -## Syntax - -```cpp -template -bool operator<=( - const Container & left, - const Container & right); -``` - -## Return Value - -Returns `!(right < left)`. - -## See also - -[\](../standard-library/sample-container.md) diff --git a/docs/standard-library/operator-less-than-sample-container.md b/docs/standard-library/operator-less-than-sample-container.md deleted file mode 100644 index cab25748e00..00000000000 --- a/docs/standard-library/operator-less-than-sample-container.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -description: "Learn more about: operator< ()" -title: "operator< ()" -ms.date: "11/04/2016" -f1_keywords: ["std::operator<", "operator<", "std.<", "<", "std.operator<", "std::<"] -helpviewer_keywords: ["< operator, comparing specific objects", "operator<, valarrays", "< operator", "operator <, valarrays"] -ms.assetid: 31027dd6-53be-428b-b950-1dcb25393597 ---- -# `operator<` (``) - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Overloads **operator<** to compare two objects of class template [Container](../standard-library/sample-container-class.md). - -## Syntax - -```cpp -template -bool operator<( - const Container & left, - const Container & right); -``` - -## Return Value - -Returns `lexicographical_compare(left.begin, left.end, right.begin, right.end)`. - -## See also - -[\](../standard-library/sample-container.md)\ -[begin](../standard-library/container-class-begin.md)\ -[end](../standard-library/container-class-end.md) diff --git a/docs/standard-library/ostream-functions.md b/docs/standard-library/ostream-functions.md index e306c7f49e0..3721ebdd884 100644 --- a/docs/standard-library/ostream-functions.md +++ b/docs/standard-library/ostream-functions.md @@ -14,7 +14,7 @@ These are the global template functions defined in ``. For member funct Terminates a line and flushes the buffer. ```cpp -template class +template basic_ostream& endl( basic_ostream& Ostr); ``` @@ -61,7 +61,7 @@ testing Terminates a string. ```cpp -template class +template basic_ostream& ends( basic_ostream& Ostr); ``` @@ -110,7 +110,7 @@ ab c Flushes the buffer. ```cpp -template class +template basic_ostream& flush( basic_ostream& Ostr); ``` diff --git a/docs/standard-library/ostream-iterator-class.md b/docs/standard-library/ostream-iterator-class.md index d2fcea91de0..aff05930b8f 100644 --- a/docs/standard-library/ostream-iterator-class.md +++ b/docs/standard-library/ostream-iterator-class.md @@ -14,20 +14,20 @@ The class template ostream_iterator describes an output iterator object that wri ## Syntax ```cpp -template > +template > class ostream_iterator ``` ### Parameters -*Type*\ +*`Type`*\ The type of object to be inserted into the output stream. -*CharType*\ +*`CharType`*\ The type that represents the character type for the `ostream_iterator`. This argument is optional and the default value is **`char`**. -*Traits*\ -The type that represents the character type for the `ostream_iterator`. This argument is optional and the default value is `char_traits`\< *CharType>.* +*`Traits`*\ +The type that represents the character type for the `ostream_iterator`. This argument is optional and the default value is `char_traits`.* The ostream_iterator class must satisfy the requirements for an output iterator. Algorithms can be written directly to output streams using an `ostream_iterator`. @@ -35,31 +35,31 @@ The ostream_iterator class must satisfy the requirements for an output iterator. |Constructor|Description| |-|-| -|[ostream_iterator](#ostream_iterator)|Constructs an `ostream_iterator` that is initialized and delimited to write to the output stream.| +|[`ostream_iterator`](#ostream_iterator)|Constructs an `ostream_iterator` that is initialized and delimited to write to the output stream.| ### Typedefs |Type name|Description| |-|-| -|[char_type](#char_type)|A type that provides for the character type of the `ostream_iterator`.| -|[ostream_type](#ostream_type)|A type that provides for the stream type of the `ostream_iterator`.| -|[traits_type](#traits_type)|A type that provides for the character traits type of the `ostream_iterator`.| +|[`char_type`](#char_type)|A type that provides for the character type of the `ostream_iterator`.| +|[`ostream_type`](#ostream_type)|A type that provides for the stream type of the `ostream_iterator`.| +|[`traits_type`](#traits_type)|A type that provides for the character traits type of the `ostream_iterator`.| ### Operators |Operator|Description| |-|-| -|[operator*](#op_star)|Dereferencing operator used to implement the output iterator expression \* `i` = `x`.| -|[operator++](#op_add_add)|A nonfunctional increment operator that returns an `ostream_iterator` to the same object it addressed before the operation was called.| -|[operator=](#op_eq)|Assignment operator used to implement the output iterator expression \* `i` = `x` for writing to an output stream.| +|[`operator*`](#op_star)|Dereferencing operator used to implement the output iterator expression `*i = x`.| +|[`operator++`](#op_add_add)|A nonfunctional increment operator that returns an `ostream_iterator` to the same object it addressed before the operation was called.| +|[`operator=`](#op_eq)|Assignment operator used to implement the output iterator expression `*i = x` for writing to an output stream.| ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` -## ostream_iterator::char_type +## `ostream_iterator::char_type` A type that provides for the character type of the iterator. @@ -99,18 +99,19 @@ int main( ) *intOut = 20; *intOut = 30; } -/* Output: +``` + +```output The integers written to the output stream by intOut are: 10 20 30 -*/ ``` ## ostream_iterator::operator* -Dereferencing operator used to implement the output iterator expression \* *ii* = *x*. +Dereferencing operator used to implement the output iterator expression `*ii = x`. ```cpp ostream_iterator& operator*(); @@ -122,7 +123,7 @@ A reference to the `ostream_iterator`. ### Remarks -The requirements for an output iterator that the `ostream_iterator` must satisfy require only the expression \* *ii* = *t* be valid and says nothing about the **`operator`** or the `operator=` on their own. The member operator in this implementation returns **`*this`**. +The requirements for an output iterator that the `ostream_iterator` must satisfy require only the expression `*ii = t` be valid and says nothing about the **`operator`** or the `operator=` on their own. The member operator in this implementation returns `*this`. ### Example @@ -149,15 +150,15 @@ int main( ) *intOut = 20; *intOut = 30; } -/* Output: +``` +```output Elements written to output stream: 10 20 30 -*/ ``` -## ostream_iterator::operator++ +## `ostream_iterator::operator++` A nonfunctional increment operator that returns an `ostream_iterator` to the same object it addressed before the operation was called. @@ -172,7 +173,7 @@ A reference to the `ostream_iterator`. ### Remarks -These member operators both return **`*this`**. +These member operators both return `*this`. ### Example @@ -199,17 +200,18 @@ int main( ) *intOut = 20; *intOut = 30; } -/* Output: +``` + +```output Elements written to output stream: 10 20 30 -*/ ``` -## ostream_iterator::operator= +## `ostream_iterator::operator=` -Assignment operator used to implement the output_iterator expression \* `i` = `x` for writing to an output stream. +Assignment operator used to implement the output_iterator expression `*i = x` for writing to an output stream. ```cpp ostream_iterator& operator=(const Type& val); @@ -217,16 +219,16 @@ ostream_iterator& operator=(const Type& val); ### Parameters -*val*\ +*`val`*\ The value of the object of type `Type` to be inserted into the output stream. ### Return Value -The operator inserts *val* into the output stream associated with the object, followed by the delimiter specified in the [ostream_iterator constructor](#ostream_iterator) (if any), and then returns a reference to the `ostream_iterator`. +The operator inserts *`val`* into the output stream associated with the object, followed by the delimiter specified in the [`ostream_iterator constructor`](#ostream_iterator) (if any), and then returns a reference to the `ostream_iterator`. ### Remarks -The requirements for an output iterator that the `ostream_iterator` must satisfy require only the expression \* `ii` = `t` be valid and says nothing about the operator or the operator= on their own. This member operator returns **`*this`**. +The requirements for an output iterator that the `ostream_iterator` must satisfy require only the expression `*ii = t` be valid and says nothing about the operator or the operator= on their own. This member operator returns `*this`. ### Example @@ -253,21 +255,20 @@ int main( ) *intOut = 20; *intOut = 30; } -/* Output: +``` +```output Elements written to output stream: 10 20 30 -*/ ``` -## ostream_iterator::ostream_iterator +## `ostream_iterator::ostream_iterator` Constructs an `ostream_iterator` that is initialized and delimited to write to the output stream. ```cpp -ostream_iterator( - ostream_type& _Ostr); +ostream_iterator(ostream_type& _Ostr); ostream_iterator( ostream_type& _Ostr, @@ -276,17 +277,17 @@ ostream_iterator( ### Parameters -*_Ostr*\ -The output stream of type [ostream_iterator::ostream_type](#ostream_type) to be iterated over. +*`_Ostr`*\ +The output stream of type [`ostream_iterator::ostream_type`](#ostream_type) to be iterated over. -*_Delimiter*\ +*`_Delimiter`*\ The delimiter that is inserted into the output stream between values. ### Remarks The first constructor initializes the output stream pointer with `&_Ostr`. The delimiter string pointer designates an empty string. -The second constructor initializes the output stream pointer with `&_Ostr` and the delimiter string pointer with *_Delimiter*. +The second constructor initializes the output stream pointer with `&_Ostr` and the delimiter string pointer with *`_Delimiter`*. ### Example @@ -327,15 +328,16 @@ int main( ) ostream_iterator ( cout, " : " ) ); cout << endl; } -/* Output: +``` + +```ouput 10 20 Elements output without delimiter: 123456 Elements output with delimiter: 1 : 2 : 3 : 4 : 5 : 6 : -*/ ``` -## ostream_iterator::ostream_type +## `ostream_iterator::ostream_type` A type that provides for the stream type of the iterator. @@ -345,13 +347,13 @@ typedef basic_ostream ostream_type; ### Remarks -The type is a synonym for [basic_ostream](../standard-library/basic-ostream-class.md)< `CharType`, `Traits`>, a stream class of the iostream hierarchy that defines objects that can be used for writing. +The type is a synonym for [`basic_ostream`](../standard-library/basic-ostream-class.md)``, a stream class of the iostream hierarchy that defines objects that can be used for writing. ### Example -See [ostream_iterator](#ostream_iterator) for an example of how to declare and use `ostream_type`. +See [`ostream_iterator`](#ostream_iterator) for an example of how to declare and use `ostream_type`. -## ostream_iterator::traits_type +## `ostream_iterator::traits_type` A type that provides for the character traits type of the iterator. @@ -392,17 +394,18 @@ int main( ) *intOut = 10; *intOut = 100; } -/* Output: +``` + +```output The integers written to output stream by intOut are: 1 10 100 -*/ ``` ## See also -[\](../standard-library/iterator.md)\ +[``](../standard-library/iterator.md)\ [Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md)\ [C++ Standard Library Reference](../standard-library/cpp-standard-library-reference.md) diff --git a/docs/standard-library/ostreambuf-iterator-class.md b/docs/standard-library/ostreambuf-iterator-class.md index d6b21df15c7..dd59e727723 100644 --- a/docs/standard-library/ostreambuf-iterator-class.md +++ b/docs/standard-library/ostreambuf-iterator-class.md @@ -5,23 +5,23 @@ ms.date: 11/04/2016 f1_keywords: ["streambuf/std::ostreambuf_iterator", "iterator/std::ostreambuf_iterator::char_type", "iterator/std::ostreambuf_iterator::ostream_type", "iterator/std::ostreambuf_iterator::streambuf_type", "iterator/std::ostreambuf_iterator::traits_type", "iterator/std::ostreambuf_iterator::failed"] helpviewer_keywords: ["std::ostreambuf_iterator [C++]", "std::ostreambuf_iterator [C++], char_type", "std::ostreambuf_iterator [C++], ostream_type", "std::ostreambuf_iterator [C++], streambuf_type", "std::ostreambuf_iterator [C++], traits_type", "std::ostreambuf_iterator [C++], failed"] --- -# ostreambuf_iterator Class +# `ostreambuf_iterator` class -The class template ostreambuf_iterator describes an output iterator object that writes successive character elements onto the output stream with the extraction **operator>>**. The `ostreambuf_iterator`s differ from those of the [ostream_iterator Class](../standard-library/ostream-iterator-class.md) in having characters instead of a generic type at the type of object being inserted into the output stream. +The class template `ostreambuf_iterator` describes an output iterator object that writes successive character elements onto the output stream with the extraction `operator>>`. The `ostreambuf_iterator`s differ from those of the [`ostream_iterator` Class](../standard-library/ostream-iterator-class.md) in having characters instead of a generic type at the type of object being inserted into the output stream. ## Syntax ```cpp -template > +template > ``` ### Parameters -*CharType*\ +*`CharType`*\ The type that represents the character type for the ostreambuf_iterator. This argument is optional and the default value is **`char`**. -*Traits*\ -The type that represents the character type for the ostreambuf_iterator. This argument is optional and the default value is `char_traits`\< *CharType>.* +*`Traits`*\ +The type that represents the character type for the ostreambuf_iterator. This argument is optional and the default value is `char_traits`. ## Remarks @@ -31,38 +31,38 @@ The ostreambuf_iterator class must satisfy the requirements for an output iterat |Constructor|Description| |-|-| -|[ostreambuf_iterator](#ostreambuf_iterator_ostreambuf_iterator)|Constructs an `ostreambuf_iterator` that is initialized to write characters to the output stream.| +|[`ostreambuf_iterator`](#ostreambuf_iterator_ostreambuf_iterator)|Constructs an `ostreambuf_iterator` that is initialized to write characters to the output stream.| ### Typedefs |Type name|Description| |-|-| -|[char_type](#char_type)|A type that provides for the character type of the `ostreambuf_iterator`.| -|[ostream_type](#ostreambuf_iterator_ostream_type)|A type that provides for the stream type of the `ostream_iterator`.| -|[streambuf_type](#streambuf_type)|A type that provides for the stream type of the `ostreambuf_iterator`.| -|[traits_type](#traits_type)|A type that provides for the character traits type of the `ostream_iterator`.| +|[`char_type`](#char_type)|A type that provides for the character type of the `ostreambuf_iterator`.| +|[`ostream_type`](#ostreambuf_iterator_ostream_type)|A type that provides for the stream type of the `ostream_iterator`.| +|[`streambuf_type`](#streambuf_type)|A type that provides for the stream type of the `ostreambuf_iterator`.| +|[`traits_type`](#traits_type)|A type that provides for the character traits type of the `ostream_iterator`.| ### Member functions |Member function|Description| |-|-| -|[failed](#failed)|Tests for failure of an insertion into the output stream buffer.| +|[`failed`](#failed)|Tests for failure of an insertion into the output stream buffer.| ### Operators |Operator|Description| |-|-| -|[operator*](#op_star)|Dereferencing operator used to implement the output iterator expression \* `i` = `x`.| -|[operator++](#op_add_add)|A nonfunctional increment operator that returns an `ostreambuf_iterator` to the same object it addressed before the operation was called.| -|[operator=](#op_eq)|The operator inserts a character into the associated stream buffer.| +|[`operator*`](#op_star)|Dereferencing operator used to implement the output iterator expression `*i = x`.| +|[`operator++`](#op_add_add)|A nonfunctional increment operator that returns an `ostreambuf_iterator` to the same object it addressed before the operation was called.| +|[`operator=`](#op_eq)|The operator inserts a character into the associated stream buffer.| ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` -## ostreambuf_iterator::char_type +## `ostreambuf_iterator::char_type` A type that provides for the character type of the `ostreambuf_iterator`. @@ -106,13 +106,13 @@ int main( ) charOutBuf++; cout << "." << endl; } -/* Output: -The characters written to the output stream -by charOutBuf are: OUT. -*/ ``` -## ostreambuf_iterator::failed +```output +OUT. +``` + +## `ostreambuf_iterator::failed` Tests for failure of an insertion into the output stream buffer. @@ -126,7 +126,7 @@ bool failed() const throw(); ### Remarks -The member function returns **`true`** if, in any prior use of member `operator=`, the call to **subf**_-> `sputc` returned **eof**. +The member function returns **`true`** if any prior attempt to insert a character into the output stream buffer was unsuccessful. ### Example @@ -157,15 +157,16 @@ int main( ) else cout << "No insertions failed." << endl; } -/* Output: +``` + +```output abc are characters output individually. No insertions failed. -*/ ``` -## ostreambuf_iterator::operator\* +## `ostreambuf_iterator::operator*` -A nonfunctional dereferencing operator used to implement the output iterator expression \* *i* = *x*. +A nonfunctional dereferencing operator used to implement the output iterator expression `*i = x`. ```cpp ostreambuf_iterator& operator*(); @@ -177,7 +178,7 @@ The ostreambuf iterator object. ### Remarks -This operator functions only in the output iterator expression \* *i* = *x* to output characters to stream buffer. Applied to an ostreambuf iterator, it returns the iterator; **\*iter** returns **iter**, +This operator functions only in the output iterator expression `*i = x` to output characters to stream buffer. Applied to an `ostreambuf_iterator`, it returns the iterator; `*iter` returns `iter`. ### Example @@ -188,7 +189,7 @@ This operator functions only in the output iterator expression \* *i* = *x* to o #include #include -int main( ) +int main() { using namespace std; @@ -204,15 +205,16 @@ int main( ) *charOutBuf = 'U'; *charOutBuf = 'T'; } -/* Output: +``` + +```output Elements written to output stream: OUT -*/ ``` -## ostreambuf_iterator::operator++ +## `ostreambuf_iterator::operator++` -A nonfunctional increment operator that returns an ostream iterator to the same character it addressed before the operation was called. +A nonfunctional increment operator that returns an `ostreambuf_iterator` to the same character it addressed before the operation was called. ```cpp ostreambuf_iterator& operator++(); @@ -221,11 +223,11 @@ ostreambuf_iterator& operator++(int); ### Return Value -A reference to the character originally addressed or to an implementation-defined object that is convertible to `ostreambuf_iterator`\< **CharType**, **Traits**>. +A reference to the character originally addressed or to an implementation-defined object that is convertible to `ostreambuf_iterator< CharType, Traits>`. ### Remarks -The operator is used to implement the output iterator expression \* *i* = *x*. +The operator is used to implement the output iterator expression `*i = x`. ### Example @@ -252,13 +254,14 @@ int main( ) *charOutBuf = 'U'; *charOutBuf = 'T'; } -/* Output: +``` + +```output Elements written to output stream: OUT -*/ ``` -## ostreambuf_iterator::operator= +## `ostreambuf_iterator::operator=` The operator inserts a character into the associated stream buffer. @@ -268,7 +271,7 @@ ostreambuf_iterator& operator=(CharType _Char); ### Parameters -*_Char*\ +*`_Char`*\ The character to be inserted into the stream buffer. ### Return Value @@ -277,7 +280,7 @@ A reference to the character inserted into the stream buffer. ### Remarks -Assignment operator used to implement the output iterator expression \* *i* = *x* for writing to an output stream. +Assignment operator used to implement the output iterator expression `*i = x` for writing to an output stream. ### Example @@ -304,13 +307,14 @@ int main( ) *charOutBuf = 'U'; *charOutBuf = 'T'; } -/* Output: +``` + +```output Elements written to output stream: OUT -*/ ``` -## ostreambuf_iterator::ostreambuf_iterator +## `ostreambuf_iterator::ostreambuf_iterator` Constructs an `ostreambuf_iterator` that is initialized to write characters to the output stream. @@ -321,17 +325,17 @@ ostreambuf_iterator(ostream_type& Ostr) throw(); ### Parameters -*strbuf*\ +*`strbuf`*\ The output streambuf object used to initialize the output stream-buffer pointer. -*Ostr*\ +*`Ostr`*\ The output stream object used to initialize the output stream-buffer pointer. ### Remarks -The first constructor initializes the output stream-buffer pointer with *strbuf*. +The first constructor initializes the output stream-buffer pointer with *`strbuf`*. -The second constructor initializes the output stream-buffer pointer with `Ostr`. `rdbuf`. The stored pointer must not be a null pointer. +The second constructor initializes the output stream-buffer pointer with *`Ostr.rdbuf`. The stored pointer must not be a null pointer. ### Example @@ -342,7 +346,7 @@ The second constructor initializes the output stream-buffer pointer with `Ostr`. #include #include -int main( ) +int main() { using namespace std; @@ -360,13 +364,14 @@ int main( ) string str = "These characters are being written to the output stream.\n "; copy ( str.begin ( ), str. end ( ), strOut ); } -/* Output: +``` + +```output OUT are characters output individually. These characters are being written to the output stream. -*/ ``` -## ostreambuf_iterator::ostream_type +## `ostreambuf_iterator::ostream_type` A type that provides for the stream type of the `ostream_iterator`. @@ -376,13 +381,13 @@ typedef basicOstream ostream_type; ### Remarks -The type is a synonym for `basicOstream`\< **CharType**, **Traits**> +The type is a synonym for `basicOstream< CharType, Traits>` ### Example -See [ostreambuf_iterator](#ostreambuf_iterator_ostreambuf_iterator) for an example of how to declare and use `ostream_type`. +See [`ostreambuf_iterator`](#ostreambuf_iterator_ostreambuf_iterator) for an example of how to declare and use `ostream_type`. -## ostreambuf_iterator::streambuf_type +## `ostreambuf_iterator::streambuf_type` A type that provides for the stream type of the `ostreambuf_iterator`. @@ -392,13 +397,13 @@ typedef basic_streambuf streambuf_type; ### Remarks -The type is a synonym for `basic_streambuf`\< **CharType**, **Traits**>, a stream class for I/O buffers that becomes `streambuf` when specialized to character type **`char`**. +The type is a synonym for `basic_streambuf< CharType, Traits>`, a stream class for I/O buffers that becomes `streambuf` when specialized to character type **`char`**. ### Example -See [ostreambuf_iterator](#ostreambuf_iterator_ostreambuf_iterator) for an example of how to declare and use `streambuf_type`. +See [`ostreambuf_iterator`](#ostreambuf_iterator_ostreambuf_iterator) for an example of how to declare and use `streambuf_type`. -## ostreambuf_iterator::traits_type +## `ostreambuf_iterator::traits_type` A type that provides for the character traits type of the `ostream_iterator`. @@ -442,10 +447,11 @@ int main( ) charOutBuf++; cout << "." << endl; } -/* Output: +``` + +```output The characters written to the output stream by charOutBuf are: OUT. -*/ ``` ## See also diff --git a/docs/standard-library/out-of-range-class.md b/docs/standard-library/out-of-range-class.md index 0fb2d3cb673..cf5e79dfc81 100644 --- a/docs/standard-library/out-of-range-class.md +++ b/docs/standard-library/out-of-range-class.md @@ -1,12 +1,11 @@ --- -description: "Learn more about: out_of_range Class" -title: "out_of_range Class" -ms.date: "09/09/2021" +title: "out_of_range class" +description: "Learn more about: out_of_range class" +ms.date: 09/09/2021 f1_keywords: ["stdexcept/std::out_of_range"] helpviewer_keywords: ["out_of_range class"] -ms.assetid: d0e14dc0-065e-4666-9ac9-51e52223c503 --- -# out_of_range Class +# `out_of_range` class The class serves as the base class for all exceptions thrown to report an argument that is out of its valid range. @@ -18,13 +17,12 @@ public: explicit out_of_range(const string& message); explicit out_of_range(const char *message); - }; ``` ## Remarks -The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](../standard-library/exception-class.md) and [`data`](../standard-library/basic-string-class.md#data). +The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](exception-class.md) and [`data`](basic-string-class.md#data). ## Example @@ -52,19 +50,20 @@ int main() cerr << "Type: " << typeid(e).name() << endl; } } -/* Output: +``` + +```Output Caught: invalid string position Type: class std::out_of_range -*/ ``` ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## See also -[logic_error Class](../standard-library/logic-error-class.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[`logic_error` class](logic-error-class.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/overflow-error-class.md b/docs/standard-library/overflow-error-class.md index 0ba3c520d48..b4291d01a31 100644 --- a/docs/standard-library/overflow-error-class.md +++ b/docs/standard-library/overflow-error-class.md @@ -1,12 +1,11 @@ --- -description: "Learn more about: overflow_error Class" -title: "overflow_error Class" -ms.date: "09/09/2021" +title: "overflow_error class" +description: "Learn more about: overflow_error class" +ms.date: 09/09/2021 f1_keywords: ["stdexcept/std::overflow_error"] helpviewer_keywords: ["overflow_error class"] -ms.assetid: bae7128d-e36b-4a45-84f1-2f89da441d20 --- -# overflow_error Class +# `overflow_error` class The class serves as the base class for all exceptions thrown to report an arithmetic overflow. @@ -18,13 +17,12 @@ public: explicit overflow_error(const string& message); explicit overflow_error(const char *message); - }; ``` ## Remarks -The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](../standard-library/exception-class.md) and [`data`](../standard-library/basic-string-class.md#data). +The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](exception-class.md) and [`data`](basic-string-class.md#data). ## Example @@ -52,19 +50,20 @@ int main() cerr << "Type: " << typeid(e).name() << endl; } } -/* Output: +``` + +```Output Caught: bitset overflow Type: class std::overflow_error -*/ ``` ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## See also -[runtime_error Class](../standard-library/runtime-error-class.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[`runtime_error` class](runtime-error-class.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/path-class.md b/docs/standard-library/path-class.md index 6e5499a4672..8f7edbb9c17 100644 --- a/docs/standard-library/path-class.md +++ b/docs/standard-library/path-class.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: path Class" title: "path Class" +description: "Learn more about: path Class" ms.date: 06/17/2022 f1_keywords: ["filesystem/std::experimental::filesystem::path"] --- @@ -41,7 +41,7 @@ class path; |[`c_str`](#c_str)|Returns a pointer to the first character in `mypath`.| |[`clear`](#clear)|Executes `mypath.clear()`.| |[`compare`](#compare)|Returns comparison values.| -|[`concat`](#compare)|Appends the specified sequence to `mypath`, converted (but not inserting a separator) as needed.| +|[`concat`](#concat)|Appends the specified sequence to `mypath`, converted (but not inserting a separator) as needed.| |[`empty`](#empty)|Returns `mypath.empty()`.| |[`end`](#end)|Returns an end-of-sequence iterator of type `iterator`.| |[`extension`](#extension)|Returns the suffix of `filename()`.| diff --git a/docs/standard-library/priority-queue-class.md b/docs/standard-library/priority-queue-class.md index 8e22659fb47..54de3d14480 100644 --- a/docs/standard-library/priority-queue-class.md +++ b/docs/standard-library/priority-queue-class.md @@ -1,13 +1,13 @@ --- description: "Learn more about: priority_queue Class" title: "priority_queue Class" -ms.date: "11/04/2016" +ms.date: 01/18/2026 f1_keywords: ["queue/std::priority_queue::container_type", "queue/std::priority_queue::size_type", "queue/std::priority_queue::value_type", "queue/std::priority_queue::empty", "queue/std::priority_queue::pop", "queue/std::priority_queue::push", "queue/std::priority_queue::size", "queue/std::priority_queue::top"] helpviewer_keywords: ["std::priority_queue [C++], container_type", "std::priority_queue [C++], size_type", "std::priority_queue [C++], value_type", "std::priority_queue [C++], empty", "std::priority_queue [C++], pop", "std::priority_queue [C++], push", "std::priority_queue [C++], size", "std::priority_queue [C++], top"] --- -# `priority_queue` Class +# `priority_queue` class -A template container adaptor class that provides a restriction of functionality limiting access to the top element of some underlying container type, which is always the largest or of the highest priority. New elements can be added to the `priority_queue` and the top element of the `priority_queue` can be inspected or removed. +A container adaptor that maintains a collection of elements where the largest (or highest priority) element is always accessible at the top. You can add new elements and remove or examine the top element, but you can't directly access elements in the middle of the collection. ## Syntax @@ -19,31 +19,40 @@ class priority_queue ### Parameters *`Type`*\ -The element data type to be stored in the `priority_queue`. +The element data type to store in the `priority_queue`. *`Container`*\ -The type of the underlying container used to implement the `priority_queue`. +The type of the underlying container that stores the elements for the `priority_queue`. *`Compare`*\ -The type that provides a function object that can compare two element values as sort keys to determine their relative order in the `priority_queue`. This argument is optional and the binary predicate `less` is the default value. +The type that provides a function object that compares two element values as sort keys to determine their relative order in the `priority_queue`. This argument is optional. The binary predicate `less` is the default. ## Remarks -The elements of class `Type` stipulated in the first template parameter of a queue object are synonymous with [`value_type`](#value_type) and must match the type of element in the underlying container class `Container` stipulated by the second template parameter. The `Type` must be assignable, so that it's possible to copy objects of that type and to assign values to variables of that type. +Elements of class `Type` specified in the first template parameter of a `priority_queue` object are equivalent to [`value_type`](#value_type) and must match the element type in the underlying container class `Container` specified by the second template parameter. The `Type` must be assignable, which means you can copy objects of that type and assign values to variables of that type. -The `priority_queue` orders the sequence it controls by calling a stored function object of class `Traits`. In general, the elements need be merely less than comparable to establish this order: so that, given any two elements, it may be determined either that they're equivalent (in the sense that neither is less than the other) or that one is less than the other. This results in an ordering between the nonequivalent elements. On a more technical note, the comparison function is a binary predicate that induces a strict weak ordering in the standard mathematical sense. +The `priority_queue` uses a comparison function to determine which elements have higher priority. This comparison function is a function object of class `Traits`. To work with `priority_queue`, your elements only need to support comparison using the less-than operator (`<`) so that it can arrange the elements in order. -Suitable underlying container classes for `priority_queue` include [`deque` Class](../standard-library/deque-class.md) and the default [`vector` Class](../standard-library/vector-class.md) or any other sequence container that supports the operations of `front`, `push_back`, and `pop_back` and a random-access iterator. The underlying container class is encapsulated within the container adaptor, which exposes only the limited set of the sequence container member functions as a public interface. +You can change the underlying container type used by the `priority_queue`. You may want to do that for performance reasons. The default, `vector`, is usually best for cache locality because elements are stored in contiguous storage, and does fewer allocations as it grows. But perhaps you would consider `deque` if you have very large or unbounded queues and moving elements is expensive. For more information about suitable underlying container classes, see [container_type](#container_type). -Adding elements to and removing elements from a `priority_queue` both have logarithmic complexity. Accessing elements in a `priority_queue` has constant complexity. +Adding and removing elements from a `priority_queue` both have logarithmic complexity. Accessing elements in a `priority_queue` has constant complexity. -There are three types of container adaptors defined by the C++ Standard Library: `stack`, `queue`, and `priority_queue`. Each restricts the functionality of some underlying container class to provide a precisely controlled interface to a standard data structure. +The C++ Standard Library defines other container adaptors that you can use to store the elements in your `priority_queue`: `stack`, `queue`, and `priority_queue`: -- The [`stack` Class](../standard-library/stack-class.md) supports a last-in, first-out (LIFO) data structure. A good analogue to keep in mind would be a stack of plates. Elements (plates) may be inserted, inspected, or removed only from the top of the stack, which is the last element at the end of the base container. The restriction to accessing only the top element is the reason for using the `stack` class. +- The [`stack` Class](../standard-library/stack-class.md) supports a last-in, first-out (LIFO) data structure. Consider a stack of plates: you can insert, inspect, or remove elements (plates) only from the top of the stack, which is the last element at the end of the base container. +- The [`queue` Class](../standard-library/queue-class.md) supports a first-in, first-out (FIFO) data structure. Consider people in a line. You add elements (people) to the back of the line and remove them from the front of the line. Both the front and the back of a line can be inspected. +- The `priority_queue` class orders its elements so that the largest element is always at the top. It supports insertion of an element and the inspection and removal of the top element. -- The [`queue` Class](../standard-library/queue-class.md) supports a first-in, first-out (FIFO) data structure. A good analogue to keep in mind would be people lining up for a bank teller. Elements (people) may be added to the back of the line and are removed from the front of the line. Both the front and the back of a line may be inspected. The restriction to accessing only the front and back elements in this way is the reason for using the `queue` class. +## Examples -- The `priority_queue` class orders its elements so that the largest element is always at the top position. It supports insertion of an element and the inspection and removal of the top element. A good analogue to keep in mind would be people lining up where they're arranged by age, height, or some other criterion. +- [Check if the `priority_queue` is empty](#check-if-a-priority_queue-is-empty) +- [Pop elements and check queue size](#pop-elements-and-inspect-size) +- [Use custom containers and comparers](#construct-priority_queue-with-custom-containers-and-comparers) +- [Push elements and read the top](#push-elements-and-read-the-top) +- [Get the number of elements](#get-priority_queue-size) +- [Access the top element](#access-the-top-element) +- [Use the priority_queue value_type alias](#use-the-priority_queue-value_type-alias) +- [Use a user-defined data type](#use-a-user-defined-data-type-with-the-priority_queue) ### Constructors @@ -55,7 +64,7 @@ There are three types of container adaptors defined by the C++ Standard Library: |Type name|Description| |-|-| -|[`container_type`](#container_type)|A type that provides the base container to be adapted by a `priority_queue`.| +|[`container_type`](#container_type)|A type that provides the base container that the `priority_queue` adapts.| |[`size_type`](#size_type)|An unsigned integer type that can represent the number of elements in a `priority_queue`.| |[`value_type`](#value_type)|A type that represents the type of object stored as an element in a `priority_queue`.| @@ -85,13 +94,11 @@ typedef Container container_type; ### Remarks -The type is a synonym for the template parameter `Container`. The C++ Standard Library sequence container class `deque` and the default class `vector` meet the requirements to be used as the base container for a `priority_queue` object. User-defined types satisfying the requirements may also be used. +The type is a synonym for the template parameter `Container`. -For more information on `Container`, see the Remarks section of the [`priority_queue` Class](../standard-library/priority-queue-class.md) topic. +Suitable underlying container classes for `priority_queue` include [`deque` Class](../standard-library/deque-class.md), the default [`vector` Class](../standard-library/vector-class.md), or any other sequence container that supports the operations of `front`, `push_back`, and `pop_back` and a random-access iterator. The container adaptor encapsulates the underlying container class and exposes only a limited set of the sequence container member functions as a public interface. -### Example - -See the example for [`priority_queue`](#priority_queue) for an example of how to declare and use `container_type`. +For an example of how to declare and use `container_type`, see [Use custom containers and comparers](#construct-priority_queue-with-custom-containers-and-comparers) ## `priority_queue::empty` @@ -105,29 +112,28 @@ bool empty() const; **`true`** if the `priority_queue` is empty; **`false`** if the `priority_queue` is nonempty. -### Example +### Example: Check if the `priority_queue` is empty ```cpp -// pqueue_empty.cpp // compile with: /EHsc #include #include -int main( ) +int main() { using namespace std; // Declares priority_queues with default deque base container priority_queue q1, s2; - q1.push( 1 ); + q1.push(1); - if ( q1.empty( ) ) + if (q1.empty()) cout << "The priority_queue q1 is empty." << endl; else cout << "The priority_queue q1 is not empty." << endl; - if ( s2.empty( ) ) + if (s2.empty()) cout << "The priority_queue s2 is empty." << endl; else cout << "The priority_queue s2 is not empty." << endl; @@ -149,42 +155,38 @@ void pop(); ### Remarks -The `priority_queue` must be nonempty to apply the member function. The top of the `priority_queue` is always occupied by the largest element in the container. +The `priority_queue` must be nonempty to use this member function. The top of the `priority_queue` always holds the largest element in the container. -### Example +### Example: Pop elements and check size ```cpp -// pqueue_pop.cpp // compile with: /EHsc #include #include -int main( ) +int main() { using namespace std; priority_queue q1, s2; - q1.push( 10 ); - q1.push( 20 ); - q1.push( 30 ); + q1.push(10); + q1.push(20); + q1.push(30); priority_queue ::size_type i, iii; - i = q1.size( ); + i = q1.size(); cout << "The priority_queue length is " << i << "." << endl; - const int& ii = q1.top( ); - cout << "The element at the top of the priority_queue is " - << ii << "." << endl; + const int& ii = q1.top(); + cout << "The element at the top of the priority_queue is " << ii << "." << endl; - q1.pop( ); + q1.pop(); - iii = q1.size( ); - cout << "After a pop, the priority_queue length is " - << iii << "." << endl; + iii = q1.size(); + cout << "After a pop, the priority_queue length is " << iii << "." << endl; - const int& iv = q1.top( ); - cout << "After a pop, the element at the top of the " - << "priority_queue is " << iv << "." << endl; + const int& iv = q1.top(); + cout << "After a pop, the element at the top of the " << "priority_queue is " << iv << "." << endl; } ``` @@ -197,7 +199,7 @@ After a pop, the element at the top of the priority_queue is 20. ## `priority_queue::priority_queue` -Constructs a `priority_queue` that is empty or that is a copy of a range of a base container object or of another `priority_queue`. +Creates a `priority_queue` that is empty or that copies a range from a base container object or from another `priority_queue`. ```cpp priority_queue(); @@ -243,10 +245,9 @@ The fourth constructor specifies a copy of the `priority_queue right`. The last three constructors copy the range `[first, last)` of some container and use the values to initialize a `priority_queue` with increasing explicitness in specifying the type of comparison function of class `Traits` and `container_type`. -### Example +### Example: Use custom containers and comparers ```cpp -// pqueue_ctor.cpp // compile with: /EHsc #include #include @@ -254,101 +255,94 @@ The last three constructors copy the range `[first, last)` of some container and #include #include -int main( ) +int main() { using namespace std; - // The first member function declares priority_queue - // with a default vector base container + // Declares a priority_queue with a default vector base container priority_queue q1; cout << "q1 = ( "; - while ( !q1.empty( ) ) + while (!q1.empty()) { - cout << q1.top( ) << " "; - q1.pop( ); + cout << q1.top() << " "; + q1.pop(); } cout << ")" << endl; - // Explicitly declares a priority_queue with nondefault - // deque base container - priority_queue > q2; - q2.push( 5 ); - q2.push( 15 ); - q2.push( 10 ); + // Declares a priority_queue with nondefault deque base container + priority_queue > q2; + q2.push(5); + q2.push(15); + q2.push(10); cout << "q2 = ( "; - while ( !q2.empty( ) ) + while (!q2.empty()) { - cout << q2.top( ) << " "; - q2.pop( ); + cout << q2.top() << " "; + q2.pop(); } cout << ")" << endl; - - // This method of printing out the elements of a priority_queue - // removes the elements from the priority queue, leaving it empty - cout << "After printing, q2 has " << q2.size( ) << " elements." << endl; - - // The third member function declares a priority_queue - // with a vector base container and specifies that the comparison - // function greater is to be used for ordering elements - priority_queue , greater > q3; - q3.push( 2 ); - q3.push( 1 ); - q3.push( 3 ); + cout << "After printing, q2 has " << q2.size() << " elements." << endl; + + // Declares a priority_queue with a vector base container and specifies that + // the comparison function greater is to be used for ordering elements + priority_queue , greater> q3; + q3.push(2); + q3.push(1); + q3.push(3); cout << "q3 = ( "; - while ( !q3.empty( ) ) + + while (!q3.empty()) { - cout << q3.top( ) << " "; - q3.pop( ); + cout << q3.top() << " "; + q3.pop(); } cout << ")" << endl; - // The fourth member function declares a priority_queue and - // initializes it with elements copied from another container: - // first, inserting elements into q1, then copying q1 elements into q4 - q1.push( 100 ); - q1.push( 200 ); - priority_queue q4( q1 ); + // Declares a priority_queue and initializes it with elements copied from another + // container by first inserting elements into q1 and then copying q1 elements into q4 + q1.push(100); + q1.push(200); + priority_queue q4(q1); cout << "q4 = ( "; - while ( !q4.empty( ) ) + while (!q4.empty()) { - cout << q4.top( ) << " "; - q4.pop( ); + cout << q4.top() << " "; + q4.pop(); } cout << ")" << endl; // Creates an auxiliary vector object v5 to be used to initialize q5 vector v5; vector ::iterator v5_Iter; - v5.push_back( 10 ); - v5.push_back( 30 ); - v5.push_back( 20 ); + v5.push_back(10); + v5.push_back(30); + v5.push_back(20); cout << "v5 = ( " ; - for ( v5_Iter = v5.begin( ) ; v5_Iter != v5.end( ) ; v5_Iter++ ) + for (v5_Iter = v5.begin() ; v5_Iter != v5.end() ; v5_Iter++) + { cout << *v5_Iter << " "; + } cout << ")" << endl; - // The fifth member function declares and - // initializes a priority_queue q5 by copying the + // Declares and initializes a priority_queue q5 by copying the // range v5[ first, last) from vector v5 - priority_queue q5( v5.begin( ), v5.begin( ) + 2 ); + priority_queue q5(v5.begin(), v5.begin() + 2); cout << "q5 = ( "; - while ( !q5.empty( ) ) + while (!q5.empty()) { - cout << q5.top( ) << " "; - q5.pop( ); + cout << q5.top() << " "; + q5.pop(); } cout << ")" << endl; - // The sixth member function declares a priority_queue q6 - // with a comparison function greater and initializes q6 - // by copying the range v5[ first, last) from vector v5 - priority_queue , greater > - q6( v5.begin( ), v5.begin( ) + 2 ); + // Declares a priority_queue q6 with a comparison function greater and + // initializes q6 by copying the range v5[ first, last) from vector v5 + priority_queue , greater> q6(v5.begin(), v5.begin() + 2); cout << "q6 = ( "; - while ( !q6.empty( ) ) + while (!q6.empty()) { - cout << q6.top( ) << " "; - q6.pop( ); + cout << q6.top() << " "; + q6.pop(); } cout << ")" << endl; } @@ -365,36 +359,34 @@ void push(const Type& val); ### Parameters *`val`*\ -The element added to the top of the `priority_queue`. +The element to add to the top of the `priority_queue`. ### Remarks -The top of the `priority_queue` is the position occupied by the largest element in the container. +The top of the `priority_queue` contains the largest element in the container. -### Example +### Example: Push elements and read the top ```cpp -// pqueue_push.cpp // compile with: /EHsc #include #include -int main( ) +int main() { using namespace std; priority_queue q1; - q1.push( 10 ); - q1.push( 30 ); - q1.push( 20 ); + q1.push(10); + q1.push(30); + q1.push(20); priority_queue::size_type i; - i = q1.size( ); + i = q1.size(); cout << "The priority_queue length is " << i << "." << endl; - const int& ii = q1.top( ); - cout << "The element at the top of the priority_queue is " - << ii << "." << endl; + const int& ii = q1.top(); + cout << "The element at the top of the priority_queue is " << ii << "." << endl; } ``` @@ -415,26 +407,25 @@ size_type size() const; The current length of the `priority_queue`. -### Example +### Example: Get the number of elements in the `priority_queue` ```cpp -// pqueue_size.cpp // compile with: /EHsc #include #include -int main( ) +int main() { using namespace std; priority_queue q1, q2; priority_queue ::size_type i; - q1.push( 1 ); - i = q1.size( ); + q1.push(1); + i = q1.size(); cout << "The priority_queue length is " << i << "." << endl; - q1.push( 2 ); - i = q1.size( ); + q1.push(2); + i = q1.size(); cout << "The priority_queue length is now " << i << "." << endl; } ``` @@ -446,7 +437,7 @@ The priority_queue length is now 2. ## `priority_queue::size_type` -An unsigned integer type that can represent the number of elements in a `priority_queue`. +An unsigned integer type that represents the number of elements in a `priority_queue`. ```cpp typedef typename Container::size_type size_type; @@ -454,11 +445,11 @@ typedef typename Container::size_type size_type; ### Remarks -The type is a synonym for the `size_type` of the base container adapted by the `priority_queue`. +This type is a synonym for the `size_type` of the base container that the `priority_queue` adapts. -### Example +### Example: Access the top element -See the example for [`size`](#size) for an example of how to declare and use `size_type`. +For an example of how to declare and use `size_type`, see [Get the number of elements](#get-priority_queue-size) ## `priority_queue::top` @@ -474,32 +465,30 @@ A reference to the largest element, as determined by the `Traits` function, obje ### Remarks -The `priority_queue` must be nonempty to apply the member function. +The `priority_queue` must be nonempty to use this member function. -### Example +### Example: Get the top element of the `priority_queue` ```cpp -// pqueue_top.cpp // compile with: /EHsc #include #include -int main( ) +int main() { using namespace std; priority_queue q1; - q1.push( 10 ); - q1.push( 30 ); - q1.push( 20 ); + q1.push(10); + q1.push(30); + q1.push(20); priority_queue::size_type i; - i = q1.size( ); + i = q1.size(); cout << "The priority_queue length is " << i << "." << endl; - const int& ii = q1.top( ); - cout << "The element at the top of the priority_queue is " - << ii << "." << endl; + const int& ii = q1.top(); + cout << "The element at the top of the priority_queue is " << ii << "." << endl; } ``` @@ -518,17 +507,16 @@ typedef typename Container::value_type value_type; ### Remarks -The type is a synonym for the `value_type` of the base container adapted by the `priority_queue`. +This type is a synonym for the `value_type` of the base container that the `priority_queue` adapts. -### Example +### Example: Use the priority_queue value_type alias ```cpp -// pqueue_value_type.cpp // compile with: /EHsc #include #include -int main( ) +int main() { using namespace std; @@ -539,9 +527,8 @@ int main( ) cout << "The value_type is AnInt = " << AnInt << endl; priority_queue q1; - q1.push( AnInt ); - cout << "The element at the top of the priority_queue is " - << q1.top( ) << "." << endl; + q1.push(AnInt); + cout << "The element at the top of the priority_queue is " << q1.top() << "." << endl; } ``` @@ -550,6 +537,73 @@ The value_type is AnInt = 69 The element at the top of the priority_queue is 69. ``` +## Example: Use a user-defined data type + +To use `priority_queue` with user-defined type elements, you must provide a way to compare the elements. You can either define `operator<` for your type or provide a custom comparison function object. + +The following example demonstrates a `priority_queue` that stores `Task` objects, ordered by priority level. Tasks with higher priority values are at the top of the queue. + +```cpp +// compile with: /EHsc +#include +#include +#include + +struct Task +{ + int priority; + std::string name; + + // Define operator< for priority_queue ordering + // Returns true if this task has LOWER priority than other + // (priority_queue puts the "largest" element at the top) + bool operator<(const Task& other) const + { + return priority < other.priority; + } +}; + +int main() +{ + std::priority_queue tasks; + + tasks.push({3, "Low priority task"}); + tasks.push({10, "High priority task"}); + tasks.push({5, "Medium priority task"}); + + std::cout << "Processing tasks by priority:\n"; + while (!tasks.empty()) + { + const Task& t = tasks.top(); + std::cout << " Priority " << t.priority << ": " << t.name << "\n"; + tasks.pop(); + } +} +``` + +```Output +Processing tasks by priority: + Priority 10: High priority task + Priority 5: Medium priority task + Priority 3: Low priority task +``` + +### Remarks + +If you want different ordering (for example, lower values first), provide a custom comparator: + +```cpp +struct ComparePriority +{ + bool operator()(const Task& a, const Task& b) + { + return a.priority > b.priority; // Lower priority value means higher priority + } +}; + +std::priority_queue, ComparePriority> minQueue; +``` + ## See also [Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md)\ diff --git a/docs/standard-library/range-concepts.md b/docs/standard-library/range-concepts.md index a00aec4ef20..dc21a897949 100644 --- a/docs/standard-library/range-concepts.md +++ b/docs/standard-library/range-concepts.md @@ -1,6 +1,6 @@ --- -description: "Learn more about range concepts." title: " concepts" +description: "Learn more about range concepts." ms.date: 12/16/2022 f1_keywords: ["ranges/std::ranges::range", "ranges/std::ranges::bidirectional_range", "ranges/std::ranges::borrowed_range", "ranges/std::ranges::common_range", "ranges/std::ranges::contiguous_range", "ranges/std::ranges::forward_range", "ranges/std::ranges::input_range", "ranges/std::ranges::output_range", "ranges/std::ranges::random_access_range", "ranges/std::ranges::simple_view", "ranges/std::ranges::sized_range", "ranges/std::ranges::view", "ranges/std::ranges::viewable_range"] helpviewer_keywords: ["std::ranges [C++], ranges::range", "std::ranges [C++], ranges::bidirectional_range", "std::ranges [C++], ranges::borrowed_range", "std::ranges [C++], ranges::common_range", "std::ranges [C++], ranges::contiguous_range", "std::ranges [C++], ranges::forward_range", "std::ranges [C++], ranges::input_range", "std::ranges [C++], ranges::output_range", "std::ranges [C++], ranges::random_access_range", "std::ranges [C++], ranges::simple_view", "std::ranges [C++], ranges::sized_range", "std::ranges [C++], ranges::view", "std::ranges [C++], ranges::viewable_range"] @@ -43,7 +43,7 @@ int main() DivideEmUp dividerOfInts; std::cout << dividerOfInts.Divide(6, 3); // outputs 2 // The following line will not compile because the template can't be instantiated - // with char* because char* can be divided + // with char* because char* can't be divided DivideEmUp dividerOfCharPtrs; // compiler error: cannot deduce template arguments } ``` @@ -163,7 +163,7 @@ The type to test to see if it's a `contiguous_range`. ### Remarks -A `contiguous_range` can be accessed by pointer arithmetic because the elements are laid out sequentially in memory and are the same size. This kind of range supports [`continguous_iterator`](iterator-concepts.md#contiguous_iterator), which is the most flexible of all the iterators. +A `contiguous_range` can be accessed by pointer arithmetic because the elements are laid out sequentially in memory and are the same size. This kind of range supports [`contiguous_iterator`](iterator-concepts.md#contiguous_iterator), which is the most flexible of all the iterators. Some examples of a `contiguous_range` are `std::array`, `std::vector`, and `std::string`. @@ -270,7 +270,7 @@ bidirectional_range && random_access_iterator>; ### Parameters *`T`*\ -The type to test to see if it's a `sized_range`. +The type to test to see if it's a `random_access_range`. ### Remarks diff --git a/docs/standard-library/range-error-class.md b/docs/standard-library/range-error-class.md index a8b6485bcf3..35559c39d45 100644 --- a/docs/standard-library/range-error-class.md +++ b/docs/standard-library/range-error-class.md @@ -1,12 +1,11 @@ --- -description: "Learn more about: range_error Class" -title: "range_error Class" -ms.date: "09/09/2021" +title: "range_error class" +description: "Learn more about: range_error class" +ms.date: 09/09/2021 f1_keywords: ["stdexcept/std::range_error"] helpviewer_keywords: ["range_error class"] -ms.assetid: 8afb3e88-fc49-4213-b096-ed63d7aea37c --- -# range_error Class +# `range_error` class The class serves as the base class for all exceptions thrown to report a range error (as in mathematics, not iterators). @@ -22,7 +21,7 @@ public: ## Remarks -The value returned by [what](../standard-library/exception-class.md) is a copy of `message.data()`. For more information, see [basic_string::data](../standard-library/basic-string-class.md#data). +The value returned by [`what`](exception-class.md) is a copy of `message.data()`. For more information, see [`basic_string::data`](basic-string-class.md#data). ## Example @@ -47,19 +46,20 @@ int main() cerr << "Type: " << typeid(e).name() << endl; } } -/* Output: +``` + +```Output Caught: The range is in error! Type: class std::range_error -*/ ``` ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## See also -[runtime_error Class](../standard-library/runtime-error-class.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[`runtime_error` class](runtime-error-class.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/rank-class.md b/docs/standard-library/rank-class.md index 7812e4b0417..f1c39092e5d 100644 --- a/docs/standard-library/rank-class.md +++ b/docs/standard-library/rank-class.md @@ -1,41 +1,41 @@ --- -description: "Learn more about: rank Class" -title: "rank Class" -ms.date: "11/04/2016" +title: "rank class" +description: "Learn more about: rank class" +ms.date: 08/28/2025 f1_keywords: ["type_traits/std::rank"] helpviewer_keywords: ["rank class", "rank"] -ms.assetid: bc9f1b8f-800f-46ca-b6f4-d8579ed5406a --- -# rank Class +# `rank` class Gets number of array dimensions. ## Syntax ```cpp -template +template struct rank; ``` -### Parameters +### Template parameters -*Ty*\ +*`Type`*\ The type to query. ## Remarks -The type query holds the value of the number of dimensions of the array type *Ty*, or 0 if *Ty* is not an array type. +The type query holds the value of the number of dimensions of the array type *`Type`*, or 0 if *`Type`* is not an array type. ## Example ```cpp // std__type_traits__rank.cpp // compile with: /EHsc + #include #include int main() - { +{ std::cout << "rank == " << std::rank::value << std::endl; std::cout << "rank == " @@ -43,23 +43,32 @@ int main() std::cout << "rank == " << std::rank::value << std::endl; - return (0); - } + int single_dim_array[]{ 1, 2, 3 }; + int double_dim_array[2][1]{ { 4 }, { 5 } }; + + std::cout << "\nrank == " + << std::rank::value << std::endl; + std::cout << "rank == " + << std::rank::value << std::endl; +} ``` ```Output rank == 0 rank == 1 rank == 2 + +rank == 1 +rank == 2 ``` ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## See also -[](../standard-library/type-traits.md)\ -[extent Class](../standard-library/extent-class.md) +[``](type-traits.md)\ +[`extent` class](extent-class.md) diff --git a/docs/standard-library/ratio.md b/docs/standard-library/ratio.md index 05922b7ff4b..1df9000050b 100644 --- a/docs/standard-library/ratio.md +++ b/docs/standard-library/ratio.md @@ -1,9 +1,8 @@ --- -description: "Learn more about: " title: "" -ms.date: "11/04/2016" +description: "Learn more about: " +ms.date: 11/04/2016 f1_keywords: ["", "ratio/std::mega", "ratio/std::peta", "ratio/std::ratio_greater", "ratio/std::micro", "ratio/std::ratio_add", "ratio/std::ratio_not_equal", "ratio/std::hecto", "ratio/std::nano", "ratio/std::ratio_less_equal", "ratio/std::ratio_less", "ratio/std::centi", "ratio/std::ratio_greater_equal", "ratio/std::ratio_subtract", "ratio/std::atto", "ratio/std::tera", "ratio/std::milli", "ratio/std::ratio_multiply", "ratio/std::kilo", "ratio/std::ratio_divide", "ratio/std::giga", "ratio/std::pico", "ratio/std::femto", "ratio/std::ratio_equal", "ratio/std::ratio", "ratio/std::exa", "ratio/std::deci", "ratio/std::deca"] -ms.assetid: 8543e912-2d84-45ea-b3c0-bd7bfacee405 --- # `` @@ -24,7 +23,7 @@ struct ratio // holds the ratio of Numerator to Denominator static constexpr std::intmax_t num; static constexpr std::intmax_t den; typedef ratio type; -} +}; ``` The template `ratio` defines the static constants `num` and `den` such that `num` / `den` == Numerator / Denominator and `num` and `den` have no common factors. `num` / `den` is the value that is represented by the class template. Therefore, `type` designates the instantiation `ratio`. diff --git a/docs/standard-library/regular-expressions-cpp.md b/docs/standard-library/regular-expressions-cpp.md index 8b4505025ce..4704305fde6 100644 --- a/docs/standard-library/regular-expressions-cpp.md +++ b/docs/standard-library/regular-expressions-cpp.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: Regular Expressions (C++)" title: "Regular Expressions (C++)" +description: "Learn more about: Regular Expressions (C++)" ms.date: 07/15/2021 helpviewer_keywords: ["regular expressions [C++]"] no-loc: [ECMAScript, basic, extended, awk, grep, egrep] @@ -12,7 +12,7 @@ The C++ standard library supports multiple regular expression grammars. This top ## Regular expression grammar -The regular expression grammar to use is by specified by the use of one of the `std::regex_constants::syntax_option_type` enumeration values. These regular expression grammars are defined in `std::regex_constants`: +The regular expression grammar to use is specified by the use of one of the `std::regex_constants::syntax_option_type` enumeration values. These regular expression grammars are defined in `std::regex_constants`: - ECMAScript: This is closest to the grammar used by JavaScript and the .NET languages. - basic: The POSIX basic regular expressions or BRE. @@ -56,7 +56,7 @@ An element can be one of the following: - An *anchor*. Anchor `^` matches the beginning of the target sequence. Anchor `$` matches the end of the target sequence. -A *capture group* of the form (*subexpression*), or \\(*subexpression*\\) in basic and grep, which matches the sequence of characters in the target sequence that is matched by the pattern between the delimiters. +- A *capture group* of the form (*subexpression*), or \\(*subexpression*\\) in basic and grep, which matches the sequence of characters in the target sequence that is matched by the pattern between the delimiters. - An *identity escape* of the form `\k`, which matches the character `k` in the target sequence. @@ -92,7 +92,7 @@ In ECMAScript, an element can also be one of the following: - A *control escape sequence* of the form `\ck`. Matches the control character that is named by the character `k`. -- A *word boundary assert* of the form`\b`. Matches when the current position in the target sequence is immediately after a *word boundary*. +- A *word boundary assert* of the form `\b`. Matches when the current position in the target sequence is immediately after a *word boundary*. - A *negative word boundary assert* of the form `\B`. Matches when the current position in the target sequence isn't immediately after a *word boundary*. diff --git a/docs/standard-library/runtime-error-class.md b/docs/standard-library/runtime-error-class.md index e71e28e5ddf..9ae07afd607 100644 --- a/docs/standard-library/runtime-error-class.md +++ b/docs/standard-library/runtime-error-class.md @@ -1,12 +1,11 @@ --- -description: "Learn more about: runtime_error Class" -title: "runtime_error Class" -ms.date: "09/09/2021" +title: "runtime_error class" +description: "Learn more about: runtime_error class" +ms.date: 09/09/2021 f1_keywords: ["stdexcept/std::runtime_error"] helpviewer_keywords: ["runtime_error class"] -ms.assetid: 4d0227bf-847b-45a2-a320-2351ebf98368 --- -# runtime_error Class +# `runtime_error` class The class serves as the base class for all exceptions thrown to report errors presumably detectable only when the program executes. @@ -18,13 +17,12 @@ public: explicit runtime_error(const string& message); explicit runtime_error(const char *message); - }; ``` ## Remarks -The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](../standard-library/exception-class.md) and [`data`](../standard-library/basic-string-class.md#data). +The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](exception-class.md) and [`data`](basic-string-class.md#data). ## Example @@ -49,19 +47,20 @@ int main() cerr << "Type: " << typeid(e).name() << endl; } } -/* Output: +``` + +```Output Caught: bad locale name Type: class std::runtime_error -*/ ``` ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## See also -[exception Class](../standard-library/exception-class.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[`exception` class](exception-class.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/sample-container-class.md b/docs/standard-library/sample-container-class.md deleted file mode 100644 index a55cb14fa1a..00000000000 --- a/docs/standard-library/sample-container-class.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: "Learn more about: Sample Container Class" -title: "Sample Container Class" -ms.date: "11/04/2016" -helpviewer_keywords: ["container classes [C++]"] -ms.assetid: 5b1451f2-c708-45da-bbf0-9e42fd687a1a ---- -# Sample Container Class - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Describes an object that controls a varying-length sequence of elements, typically of type `Ty`. The sequence is stored in different ways, depending on the actual container. - -A container constructor or member function may find occasion to call the constructor **Ty**(**const Ty&**) or the function **Ty::operator=**(**const Ty&**). If such a call throws an exception, the container object is obliged to maintain its integrity, and to rethrow any exception it catches. You can safely swap, assign to, erase, or destroy a container object after it throws one of these exceptions. In general, however, you cannot otherwise predict the state of the sequence controlled by the container object. - -A few additional caveats: - -- If the expression `~Ty` throws an exception, the resulting state of the container object is undefined. - -- If the container stores an allocator object *al*, and *al* throws an exception other than as a result of a call to `al.allocate`, the resulting state of the container object is undefined. - -- If the container stores a function object *comp*, to determine how to order the controlled sequence, and *comp* throws an exception of any kind, the resulting state of the container object is undefined. - -The container classes defined by C++ Standard Library satisfy several additional requirements, as described in the following paragraphs. - -Container class template [list](../standard-library/list-class.md) provides deterministic, and useful, behavior even in the presence of the exceptions described above. For example, if an exception is thrown during the insertion of one or more elements, the container is left unaltered and the exception is rethrown. - -For *all* the container classes defined by C++ Standard Library, if an exception is thrown during calls to the following member functions, `insert`, `push_back`, or `push_front`, the container is left unaltered and the exception is rethrown. - -For *all* the container classes defined by C++ Standard Library, no exception is thrown during calls to the following member functions: `pop_back`, `pop_front`. - -The member function [erase](../standard-library/container-class-erase.md) throws an exception only if a copy operation (assignment or copy construction) throws an exception. - -Moreover, no exception is thrown while copying an iterator returned by a member function. - -The member function [swap](../standard-library/container-class-swap.md) makes additional promises for *all* container classes defined by C++ Standard Library: - -- The member function throws an exception only if the container stores an allocator object al, and `al` throws an exception when copied. - -- References, pointers, and iterators that designate elements of the controlled sequences being swapped remain valid. - -An object of a container class defined by C++ Standard Library allocates and frees storage for the sequence it controls through a stored object of type `Alloc`, which is typically a template parameter. Such an allocator object must have the same external interface as an object of class `allocator`. In particular, `Alloc` must be the same type as `Alloc::rebind::other` - -For *all* container classes defined by C++ Standard Library, the member function `Alloc get_allocator const;` returns a copy of the stored allocator object. Note that the stored allocator object is *not* copied when the container object is assigned. All constructors initialize the value stored in `allocator`, to `Alloc` if the constructor contains no allocator parameter. - -According to the C++ Standard, a container class defined by the C++ Standard Library can assume that: - -- All objects of class `Alloc` compare equal. - -- Type `Alloc::const_pointer` is the same as `const Ty *`. - -- Type `Alloc::const_reference` is the same as `const Ty&`. - -- Type `Alloc::pointer` is the same as `Ty *`. - -- Type `Alloc::reference` is the same as `Ty&`. - -In this implementation, however, containers do not make such simplifying assumptions. Thus, they work properly with allocator objects that are more ambitious: - -- All objects of class `Alloc` does not need to compare equal. (You can maintain multiple pools of storage.) - -- Type `Alloc::const_pointer` does not need to be the same as `const Ty *`. (A const pointer can be a class.) - -- Type `Alloc::pointer` does not need to be the same as `Ty *`. (A pointer can be a class.) - -## Requirements - -**Header**: \ - -## See also - -[\](../standard-library/sample-container.md) diff --git a/docs/standard-library/sample-container-classes.md b/docs/standard-library/sample-container-classes.md deleted file mode 100644 index 4208b28a6f6..00000000000 --- a/docs/standard-library/sample-container-classes.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -description: "Learn more about: Classes" -title: " Classes" -ms.date: "11/04/2016" -ms.assetid: ac63ed42-5ae5-4008-99fb-89e045bf98af ---- -# `` Classes - -For more information about the classes in \, see [\](../standard-library/sample-container.md). diff --git a/docs/standard-library/sample-container-member-functions.md b/docs/standard-library/sample-container-member-functions.md deleted file mode 100644 index 8385eee0068..00000000000 --- a/docs/standard-library/sample-container-member-functions.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -description: "Learn more about: Sample Container Member Functions" -title: "Sample Container Member Functions" -ms.date: "11/04/2016" -ms.assetid: fbd88c16-57e6-435d-ad70-7a195c0103ab ---- -# Sample Container Member Functions - -For more information about the member functions in the sample container class, see [Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/sample-container-members.md b/docs/standard-library/sample-container-members.md deleted file mode 100644 index 18b77c70c3a..00000000000 --- a/docs/standard-library/sample-container-members.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -description: "Learn more about: Sample Container Members" -title: "Sample Container Members" -ms.date: "11/04/2016" -helpviewer_keywords: ["container classes"] -ms.assetid: dc5a1998-a31b-4adf-b888-8abe5b87a4e0 ---- -# Sample Container Members - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -## Reference - -## Typedefs - -|Name|Description| -|-|-| -|[const_iterator](../standard-library/container-class-const-iterator.md)|Describes an object that can serve as a constant iterator for the controlled sequence.| -|[const_reference](../standard-library/container-class-const-reference.md)|Describes an object that can serve as a constant reference to an element of the controlled sequence.| -|[const_reverse_iterator](../standard-library/container-class-const-reverse-iterator.md)|Describes an object that can serve as a constant reverse iterator for the controlled sequence.| -|[difference_type](../standard-library/container-class-difference-type.md)|Describes an object that can represent the difference between the addresses of any two elements in the controlled sequence.| -|[iterator](../standard-library/container-class-iterator.md)|Describes an object that can serve as an iterator for the controlled sequence.| -|[reference](../standard-library/container-class-reference.md)|Describes an object that can serve as a reference to an element of the controlled sequence.| -|[reverse_iterator](../standard-library/container-class-reverse-iterator.md)|Describes an object that can serve as a reverse iterator for the controlled sequence.| -|[size_type](../standard-library/container-class-size-type.md)|Describes an object that can represent the length of any controlled sequence.| -|[value_type](../standard-library/container-class-value-type.md)|Acts a synonym for the template parameter `Ty`.| - -## Member Functions - -|Name|Description| -|-|-| -|[begin](../standard-library/container-class-begin.md)|Returns an iterator that points at the first element of the sequence (or just beyond the end of an empty sequence).| -|[clear](../standard-library/container-class-clear.md)|Calls [erase](../standard-library/container-class-erase.md)( [begin](../standard-library/container-class-begin.md), [end](../standard-library/container-class-end.md)).| -|[empty](../standard-library/container-class-empty.md)|Returns **`true`** for an empty controlled sequence.| -|[end](../standard-library/container-class-end.md)|Returns an iterator that points just beyond the end of the sequence.| -|[erase](../standard-library/container-class-erase.md)|Erases an element.| -|[max_size](../standard-library/container-class-max-size.md)|Returns the length of the longest sequence that the object can control, in constant time regardless of the length of the controlled sequence.| -|[rbegin](../standard-library/container-class-rbegin.md)|Returns a reverse iterator that points just beyond the end of the controlled sequence, designating the beginning of the reverse sequence.| -|[rend](../standard-library/container-class-rend.md)|The member function returns a reverse iterator that points at the first element of the sequence (or just beyond the end of an empty sequence), designating the end of the reverse sequence.| -|[size](../standard-library/container-class-size.md)|Returns the length of the controlled sequence, in constant time regardless of the length of the controlled sequence.| -|[swap](../standard-library/container-class-swap.md) diff --git a/docs/standard-library/sample-container-operators.md b/docs/standard-library/sample-container-operators.md deleted file mode 100644 index e5f5f0aa9f4..00000000000 --- a/docs/standard-library/sample-container-operators.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -description: "Learn more about: Operators" -title: " Operators" -ms.date: "11/04/2016" -ms.assetid: 6cd28cdc-8318-4941-a06c-2c32758383fd ---- -# `` Operators - -For more information about the operators in \, see [\](../standard-library/sample-container.md). diff --git a/docs/standard-library/sample-container-specialized-template-functions.md b/docs/standard-library/sample-container-specialized-template-functions.md deleted file mode 100644 index eda14ad7267..00000000000 --- a/docs/standard-library/sample-container-specialized-template-functions.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -description: "Learn more about: Specialized Template Functions" -title: " Specialized Template Functions" -ms.date: "11/04/2016" -ms.assetid: 853d4b30-167a-471b-8325-86a868943568 ---- -# `` Specialized Template Functions - -For more information about the specialized template functions in \, see [\](../standard-library/sample-container.md). diff --git a/docs/standard-library/sample-container-typedefs.md b/docs/standard-library/sample-container-typedefs.md deleted file mode 100644 index 8122280f8aa..00000000000 --- a/docs/standard-library/sample-container-typedefs.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -description: "Learn more about: Sample Container Typedefs" -title: "Sample Container Typedefs" -ms.date: "11/04/2016" -ms.assetid: 9fc02c4c-d835-4266-a391-f12b40ba43fa ---- -# Sample Container Typedefs - -For more information about the typedefs in the sample container class, see [Sample Container Class](../standard-library/sample-container-class.md) diff --git a/docs/standard-library/sample-container.md b/docs/standard-library/sample-container.md deleted file mode 100644 index 667dcef38dc..00000000000 --- a/docs/standard-library/sample-container.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -description: "Learn more about: " -title: "" -ms.date: "11/04/2016" -helpviewer_keywords: ["headers, C++ sample container", "sample container", "container headers"] -ms.assetid: 4ab3dcf9-49c3-4e49-b5d6-1ec573e2aee4 ---- -# `` - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Shows you the structure of the container headers in the C++ Standard Library. - -## Syntax - -```cpp -#include // Nonfunctional header -``` diff --git a/docs/standard-library/scoped-lock-class.md b/docs/standard-library/scoped-lock-class.md index 1cb8e0504b8..58e64719100 100644 --- a/docs/standard-library/scoped-lock-class.md +++ b/docs/standard-library/scoped-lock-class.md @@ -1,21 +1,128 @@ --- -description: "Learn more about: scoped_lock Class" title: "scoped_lock Class" -ms.date: "11/04/2016" +description: "Learn more about: scoped_lock Class" +ms.date: 04/10/2026 f1_keywords: ["mutex/std::scoped_lock"] +ai-usage: ai-generated --- # scoped_lock Class +The `scoped_lock` class acquires one or more mutexes on construction and releases them on destruction. When multiple mutexes are provided, a deadlock-avoidance algorithm (equivalent to `std::lock`) is used to prevent deadlocks. Introduced in C++17. + ## Syntax ```cpp + +// Single mutex type version +template +class _NODISCARD_LOCK scoped_lock<_Mutex> { +public: + using mutex_type = _Mutex; + + explicit scoped_lock(_Mutex& _Mtx) : _MyMutex(_Mtx) { // construct and lock + _MyMutex.lock(); + } + + explicit scoped_lock(adopt_lock_t, _Mutex& _Mtx) noexcept + : _MyMutex(_Mtx) {} // construct but don't lock + + ~scoped_lock() noexcept { + _MyMutex.unlock(); + } + + scoped_lock(const scoped_lock&) = delete; // prevent creating a new scoped_lock by copying an existing one + scoped_lock& operator=(const scoped_lock&) = delete; // prevent assigning one scoped_lock to another +}; + +// multiple mutex types version template class scoped_lock { - using mutex_type = Mutex; // If MutexTypes... consists of the single type Mutex explicit scoped_lock(MutexTypes&... m); explicit scoped_lock(MutexTypes&... m, adopt_lock_t); ~scoped_lock(); - scoped_lock(const scoped_lock&) = delete; - scoped_lock& operator=(const scoped_lock&) = delete; + scoped_lock(const scoped_lock&) = delete; // prevent creating a new scoped_lock by copying an existing one + scoped_lock& operator=(const scoped_lock&) = delete; // prevent assigning one scoped_lock to another +}; +``` + +## Remarks + +`adopt_lock_t` is a tag type that indicates the `scoped_lock` constructor should assume ownership of mutexes that are already locked by the calling thread. This allows you to create a `scoped_lock` object without locking the mutexes again, which can be useful in certain scenarios where you have already acquired the locks and want to manage their lifetime with a `scoped_lock`. + +The `scoped_lock` class manages locking and unlocking of one or more mutexes throughout a scope. When you create a `scoped_lock` object, it acquires ownership of the mutexes passed to it. When the `scoped_lock` object is destroyed (for example, when it goes out of scope), the mutexes are released. This ensures that mutexes are always properly released, even if an exception is thrown. + +If you need to lock only a single mutex, consider using [`lock_guard`](lock-guard-class.md) or [`unique_lock`](unique-lock-class.md). Use `scoped_lock` when you need to lock multiple mutexes simultaneously without risk of deadlock. + +The `scoped_lock` class isn't copyable. + +If only one mutex type is passed to `scoped_lock`, the `scoped_lock` provides a type alias named `mutex_type` that refers to that one mutex type. However, if you create a `scoped_lock` with two or more mutex types, the `mutex_type` alias does not exist because `mutex_type` only makes sense when there is a single underlying mutex type. With multiple mutexes, there isn’t one mutex type to expose. + +### Constructors + +| Constructor | Description | +|---|---| +| `scoped_lock(MutexTypes&... m)` | Constructs a `scoped_lock` object and locks all the supplied mutexes. If multiple mutexes are supplied, they're locked using a deadlock-avoidance algorithm. | +| `scoped_lock(MutexTypes&... m, adopt_lock_t)` | Constructs a `scoped_lock` object and adopts ownership of the supplied mutexes, which must already be locked by the calling thread. | + +### Destructor + +| Destructor | Description | +|---|---| +| `~scoped_lock()` | Destroys the `scoped_lock` object and releases all owned mutexes. | + +## Example + +```cpp +#include +#include +#include +#include + +std::mutex mutex1; +std::mutex mutex2; +int shared_data1 = 0; +int shared_data2 = 0; + +void update_both(int iterations) +{ + for (int i = 0; i < iterations; ++i) + { + // Lock both mutexes simultaneously without risk of deadlock + std::scoped_lock lock(mutex1, mutex2); + ++shared_data1; + ++shared_data2; + } +} + +int main() +{ + std::vector threads; + for (int i = 0; i < 4; ++i) + { + threads.emplace_back(update_both, 1000); + } + + for (auto& t : threads) + { + t.join(); + } + + std::cout << "shared_data1: " << shared_data1 << '\n'; + std::cout << "shared_data2: " << shared_data2 << '\n'; + // Output: + // shared_data1: 4000 + // shared_data2: 4000 } ``` + +## Requirements + +**Header:** `` + +**Namespace:** `std` + +## See also + +[`lock_guard` class](lock-guard-class.md)\ +[`unique_lock` class](unique-lock-class.md)\ +[``](mutex.md) diff --git a/docs/standard-library/set-class.md b/docs/standard-library/set-class.md index a311d618735..3fb4d1f5de9 100644 --- a/docs/standard-library/set-class.md +++ b/docs/standard-library/set-class.md @@ -1080,71 +1080,58 @@ An iterator that refers to the location of an element with a specified key, or t ### Remarks -The member function returns an iterator that refers to an element in the set whose key is equivalent to the argument *key* under a binary predicate that induces an ordering based on a less than comparability relation. +The member function returns an iterator that points to the element in the set that has a key equal to the argument *key*. If no such element exists, the function returns `end()`. The comparison uses a binary predicate based on a less-than ordering relation. -If the return value of `find` is assigned to a `const_iterator`, the set object can't be modified. If the return value of `find` is assigned to an `iterator`, the set object can be modified +If the return value of `find` is assigned to a `const_iterator`, the set object can't be modified. If the return value of `find` is assigned to an `iterator`, the set object can be modified. -### Example +### Example of set::find() ```cpp // compile with: /EHsc /W4 /MTd #include #include -#include -#include - -using namespace std; - -template void print_elem(const T& t) { - cout << "(" << t << ") "; -} -template void print_collection(const T& t) { - cout << t.size() << " elements: "; - - for (const auto& p : t) { - print_elem(p); - } - cout << endl; -} - -template void findit(const C& c, T val) { - cout << "Trying find() on value " << val << endl; - auto result = c.find(val); - if (result != c.end()) { - cout << "Element found: "; print_elem(*result); cout << endl; - } else { - cout << "Element not found." << endl; - } -} +using namespace std; // std c++ libs implemented in std -int main() +void main() { - set s1({ 40, 45 }); - cout << "The starting set s1 is: " << endl; - print_collection(s1); - - vector v; - v.push_back(43); - v.push_back(41); - v.push_back(46); - v.push_back(42); - v.push_back(44); - v.push_back(44); // attempt a duplicate - - cout << "Inserting the following vector data into s1: " << endl; - print_collection(v); - - s1.insert(v.begin(), v.end()); - - cout << "The modified set s1 is: " << endl; - print_collection(s1); - cout << endl; - findit(s1, 45); - findit(s1, 6); + set, allocator> s1{5, 8, 12}; + + // find() returns an iterator that points to the first element + // that has the same key as the value passed to the find function. + // If no such element exists, the iterator equals end(). + + set, allocator>::iterator it; + + // Is 8 in the set? + it = s1.find(8); + if (it != s1.end()) + { + cout << "Found 8" << endl; + } + else + { + cout << "Didn't find 8" << endl; + } + + // Is 6 in the set? + it = s1.find(6); + if (it != s1.end()) + { + cout << "Found 6" << endl; + } + else + { + cout << "Didn't find 6" << endl; + } } ``` +```output +Found 8 +Didn't find 6 +``` + ## `get_allocator` Returns a copy of the allocator object used to construct the set. diff --git a/docs/standard-library/slice-array-class.md b/docs/standard-library/slice-array-class.md index 6bcfaec534d..f8520ffb2b5 100644 --- a/docs/standard-library/slice-array-class.md +++ b/docs/standard-library/slice-array-class.md @@ -1,10 +1,9 @@ --- -description: "Learn more about: slice_array class" title: "slice_array class" +description: "Learn more about: slice_array class" ms.date: 01/12/2022 f1_keywords: ["valarray/std::slice_array"] helpviewer_keywords: ["slice_array class"] -ms.assetid: a182d5f7-f35c-4e76-86f2-b5ac64ddc846 --- # `slice_array` class @@ -30,7 +29,7 @@ public: void operator<<=(const valarray& x) const; void operator>>=(const valarray& x) const; // The rest is private or implementation defined -} +}; ``` ## Remarks diff --git a/docs/standard-library/stack-class.md b/docs/standard-library/stack-class.md index 12a610f22ee..8a30a18989f 100644 --- a/docs/standard-library/stack-class.md +++ b/docs/standard-library/stack-class.md @@ -377,7 +377,7 @@ int main( ) stack s1; s1.push( 1 ); - s1.push( 2 ); + s1.push( 3 ); int& i = s1.top( ); const int& ii = s1.top( ); @@ -385,13 +385,13 @@ int main( ) cout << "The top integer of the stack s1 is " << i << "." << endl; i--; - cout << "The next integer down is "<< ii << "." << endl; + cout << "The updated top integer is " << ii << "." << endl; } ``` ```Output -The top integer of the stack s1 is 2. -The next integer down is 1. +The top integer of the stack s1 is 3. +The updated top integer is 2. ``` ## `value_type` diff --git a/docs/standard-library/stdexcept.md b/docs/standard-library/stdexcept.md index 6ad13bbc2dd..ac7cf23aeb6 100644 --- a/docs/standard-library/stdexcept.md +++ b/docs/standard-library/stdexcept.md @@ -1,46 +1,40 @@ --- -description: "Learn more about: " title: "" -ms.date: "11/04/2016" +description: "Learn more about: " +ms.date: 11/04/2016 f1_keywords: [""] helpviewer_keywords: ["stdexcept header"] -ms.assetid: 495c10b1-1e60-4514-9f8f-7fda11a2f522 --- # `` -Defines several standard classes used for reporting exceptions. The classes form a derivation hierarchy all derived from class [exception](../standard-library/exception-class.md) and include two general types of exceptions: logical errors and run-time errors. The logical errors are caused programmer mistakes. They derive from the base class logic_error and include: +Defines several standard classes used for reporting exceptions. The classes form a derivation hierarchy all derived from class [`exception`](exception-class.md) and include two general types of exceptions: logical errors and run-time errors. The logical errors are caused by programmer mistakes. They derive from the base class `logic_error` and include: - `domain_error` - - `invalid_argument` - - `length_error` - - `out_of_range` -The run-time errors occur because of mistakes in either the library functions or in the run-time system. They derive from the base class runtime_error and include: +The run-time errors occur because of mistakes in either the library functions or in the run-time system. They derive from the base class `runtime_error` and include: - `overflow_error` - - `range_error` - - `underflow_error` ### Classes |Class|Description| |-|-| -|[domain_error Class](../standard-library/domain-error-class.md)|The class serves as the base class for all exceptions thrown to report a domain error.| -|[invalid_argument Class](../standard-library/invalid-argument-class.md)|The class serves as the base class for all exceptions thrown to report an invalid argument.| -|[length_error Class](../standard-library/length-error-class.md)|The class serves as the base class for all exceptions thrown to report an attempt to generate an object too long to be specified.| -|[logic_error Class](../standard-library/logic-error-class.md)|The class serves as the base class for all exceptions thrown to report errors presumably detectable before the program executes, such as violations of logical preconditions.| -|[out_of_range Class](../standard-library/out-of-range-class.md)|The class serves as the base class for all exceptions thrown to report an argument that is out of its valid range.| -|[overflow_error Class](../standard-library/overflow-error-class.md)|The class serves as the base class for all exceptions thrown to report an arithmetic overflow.| -|[range_error Class](../standard-library/range-error-class.md)|The class serves as the base class for all exceptions thrown to report a range error.| -|[runtime_error Class](../standard-library/runtime-error-class.md)|The class serves as the base class for all exceptions thrown to report errors presumably detectable only when the program executes.| -|[underflow_error Class](../standard-library/underflow-error-class.md)|The class serves as the base class for all exceptions thrown to report an arithmetic underflow.| +|[`domain_error` class](domain-error-class.md)|The class serves as the base class for all exceptions thrown to report a domain error.| +|[`invalid_argument` class](invalid-argument-class.md)|The class serves as the base class for all exceptions thrown to report an invalid argument.| +|[`length_error` class](length-error-class.md)|The class serves as the base class for all exceptions thrown to report an attempt to generate an object too long to be specified.| +|[`logic_error` class](logic-error-class.md)|The class serves as the base class for all exceptions thrown to report errors presumably detectable before the program executes, such as violations of logical preconditions.| +|[`out_of_range` class](out-of-range-class.md)|The class serves as the base class for all exceptions thrown to report an argument that is out of its valid range.| +|[`overflow_error` class](overflow-error-class.md)|The class serves as the base class for all exceptions thrown to report an arithmetic overflow.| +|[`range_error` class](range-error-class.md)|The class serves as the base class for all exceptions thrown to report a range error.| +|[`runtime_error` class](runtime-error-class.md)|The class serves as the base class for all exceptions thrown to report errors presumably detectable only when the program executes.| +|[`underflow_error` class](underflow-error-class.md)|The class serves as the base class for all exceptions thrown to report an arithmetic underflow.| ## See also -[Header Files Reference](../standard-library/cpp-standard-library-header-files.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[Header Files Reference](cpp-standard-library-header-files.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/stl-containers.md b/docs/standard-library/stl-containers.md index 0b8ce549317..be656d73146 100644 --- a/docs/standard-library/stl-containers.md +++ b/docs/standard-library/stl-containers.md @@ -163,5 +163,4 @@ In C++14 and later, you can compare dissimilar containers and/or dissimilar elem ## See also [Parallel Containers](../parallel/concrt/parallel-containers-and-objects.md)\ -[``](../standard-library/sample-container.md)\ [Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/swap-sample-container.md b/docs/standard-library/swap-sample-container.md deleted file mode 100644 index b90bffdd488..00000000000 --- a/docs/standard-library/swap-sample-container.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Learn more about: swap ()" -title: "swap ()" -ms.date: "11/04/2016" -f1_keywords: ["std.swap", "std::swap", "swap"] -helpviewer_keywords: ["swap function"] -ms.assetid: d8dd6436-fb97-46ed-bec5-052cfd710462 ---- -# `swap` (``) - -> [!NOTE] -> This topic is in the Microsoft C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md). - -Executes `left.`[swap](../standard-library/container-class-swap.md)`(right)`. - -## Syntax - -```cpp -template -void swap( - Container & left, - Container & right); -``` - -## See also - -[\](../standard-library/sample-container.md) diff --git a/docs/standard-library/system-error.md b/docs/standard-library/system-error.md index 0d12bfef30e..8a633804bff 100644 --- a/docs/standard-library/system-error.md +++ b/docs/standard-library/system-error.md @@ -1,20 +1,19 @@ --- -description: "Learn more about: " title: "" -ms.date: "03/15/2019" +description: "Learn more about: " +ms.date: 03/15/2019 f1_keywords: [""] helpviewer_keywords: ["system_error header"] -ms.assetid: 5e046c6e-48d9-4740-8c8a-05f3727c1215 --- # `` -Include the header \ to define the exception class `system_error` and related templates for processing low-level system errors. +Include the header `` to define the exception class `system_error` and related templates for processing low-level system errors. ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## Members @@ -22,45 +21,45 @@ Include the header \ to define the exception class `system_error` |Name|Description| |-|-| -|[generic_category](../standard-library/system-error-functions.md#generic_category)|Represents the category for generic errors.| -|[is_error_code_enum_v](../standard-library/system-error-functions.md#is_error_code_enum_v)|| -|[is_error_condition_enum_v](../standard-library/system-error-functions.md#is_error_condition_enum_v)|| -|[system_category](../standard-library/system-error-functions.md#system_category)|Represents the category for errors caused by low-level system overflows.| +|[`generic_category`](system-error-functions.md#generic_category)|Represents the category for generic errors.| +|[`is_error_code_enum_v`](system-error-functions.md#is_error_code_enum_v)|A helper variable template for the [`is_error_code_enum`](is-error-code-enum-class.md) value.| +|[`is_error_condition_enum_v`](system-error-functions.md#is_error_condition_enum_v)|A helper variable template for the [`is_error_condition_enum`](is-error-condition-enum-class.md) value.| +|[`system_category`](system-error-functions.md#system_category)|Represents the category for operating system errors.| ### Functions |Name|Description| |-|-| -|[make_error_code](../standard-library/system-error-functions.md#make_error_code)|Creates an `error_code` object.| -|[make_error_condition](../standard-library/system-error-functions.md#make_error_condition)|Creates an `error_condition` object.| +|[`make_error_code`](system-error-functions.md#make_error_code)|Creates an [`error_code`](error-code-class.md) object.| +|[`make_error_condition`](system-error-functions.md#make_error_condition)|Creates an [`error_condition`](error-condition-class.md) object.| ### Operators |Name|Description| |-|-| -|[operator==](../standard-library/system-error-operators.md#op_eq_eq)|Tests if the object on the left side of the operator is equal to the object on the right side.| -|[operator!=](../standard-library/system-error-operators.md#op_neq)|Tests if the object on the left side of the operator is not equal to the object on the right side.| -|[operator<](../standard-library/system-error-operators.md#op_lt)|Tests if an object is less than the object passed in for comparison.| -|[operator<<](../standard-library/system-error-operators.md#op_ostream)|| +|[`operator==`](system-error-operators.md#op_eq_eq)|Tests if the object on the left side of the operator is equal to the object on the right side.| +|[`operator!=`](system-error-operators.md#op_neq)|Tests if the object on the left side of the operator is not equal to the object on the right side.| +|[`operator<`](system-error-operators.md#op_lt)|Tests if an object is less than the object passed in for comparison.| +|[`operator<<`](system-error-operators.md#op_ostream)|Inserts an [`error_code`](error-code-class.md) object into the output stream.| ### Enums |Name|Description| |-|-| -|[errc](../standard-library/system-error-enums.md#errc)|Provides symbolic names for all the error-code macros defined by POSIX in ``.| +|[`errc`](system-error-enums.md#errc)|Provides symbolic names for all the error-code macros defined by POSIX in ``.| ### Classes and Structs |Name|Description| |-|-| -|[error_category](../standard-library/error-category-class.md)|Represents the abstract, common base for objects that describes a category of error codes.| -|[error_code](../standard-library/error-code-class.md)|Represents low-level system errors that are implementation-specific.| -|[error_condition](../standard-library/error-condition-class.md)|Represents user-defined error codes.| -|[hash](../standard-library/hash-structure.md#system_error)|| -|[is_error_code_enum](../standard-library/is-error-code-enum-class.md)|Represents a type predicate that tests for the [error_code Class](../standard-library/error-code-class.md) enumeration.| -|[is_error_condition_enum](../standard-library/is-error-condition-enum-class.md)|Represents a type predicate that tests for the [error_condition Class](../standard-library/error-condition-class.md) enumeration.| -|[system_error](../standard-library/system-error-class.md)|Represents the base class for all exceptions thrown to report a low-level system overflow.| +|[`error_category`](error-category-class.md)|Represents the abstract, common base for objects that describes a category of error codes.| +|[`error_code`](error-code-class.md)|Represents low-level system errors that are implementation-specific.| +|[`error_condition`](error-condition-class.md)|Represents user-defined error codes.| +|[`hash`](hash-structure.md#system_error)|Template specializations of [`std::hash`](hash-class.md) for [`error_code`](error-code-class.md) and [`error_condition`](error-condition-class.md).| +|[`is_error_code_enum`](is-error-code-enum-class.md)|Represents a type predicate that tests for the [`error_code`](error-code-class.md) enumeration.| +|[`is_error_condition_enum`](is-error-condition-enum-class.md)|Represents a type predicate that tests for the [`error_condition`](error-condition-class.md) enumeration.| +|[`system_error`](system-error-class.md)|Represents the base class for all exceptions thrown to report a low-level system error.| ## See also -[Header Files Reference](../standard-library/cpp-standard-library-header-files.md) +[Header Files Reference](cpp-standard-library-header-files.md) diff --git a/docs/standard-library/thread-functions.md b/docs/standard-library/thread-functions.md index eea1f7215e9..ed86df6516b 100644 --- a/docs/standard-library/thread-functions.md +++ b/docs/standard-library/thread-functions.md @@ -1,65 +1,80 @@ --- -description: "Learn more about: functions" title: " functions" -ms.date: "11/04/2016" +description: "Learn more about: functions" +ms.date: 11/04/2016 f1_keywords: ["thread/std::get_id", "thread/std::sleep_for", "thread/std::sleep_until", "thread/std::swap", "thread/std::yield"] -ms.assetid: bb1aa1ef-fe3f-4e2c-8b6e-e22dbf2f5a19 helpviewer_keywords: ["std::get_id [C++]", "std::sleep_for [C++]", "std::sleep_until [C++]", "std::swap [C++]", "std::yield [C++]"] --- # `` functions -## get_id +The `` header provides the following functions: + +## `get_id` Uniquely identifies the current thread of execution. ```cpp -thread::id this_thread::get_id() noexcept; +thread::id get_id() noexcept; ``` ### Return Value -An object of type [thread::id](../standard-library/thread-class.md) that uniquely identifies the current thread of execution. +An object of type [`thread::id`](thread-class.md#id_class) that uniquely identifies the current thread of execution. + +### Example + +```cpp +#include +#include + +int main() +{ + std::thread::id current_thread_id = std::this_thread::get_id(); + std::cout << "Current thread id: " << current_thread_id; +} +``` -## sleep_for +```Output +Current thread id: 16196 +``` + +## `sleep_for` Blocks the calling thread. ```cpp -template -inline void sleep_for(const chrono::duration& Rel_time); +template +void sleep_for(const chrono::duration& Rel_time); ``` ### Parameters -*Rel_time*\ -A [duration](../standard-library/duration-class.md) object that specifies a time interval. +*`Rel_time`*\ +A [`duration`](duration-class.md) object that specifies a time interval. ### Remarks -The function blocks the calling thread for at least the time that's specified by *Rel_time*. This function does not throw any exceptions. +The function blocks the calling thread for at least the time that's specified by *`Rel_time`*. This function does not throw any exceptions. -## sleep_until +## `sleep_until` Blocks the calling thread at least until the specified time. ```cpp template void sleep_until(const chrono::time_point& Abs_time); - -void sleep_until(const xtime *Abs_time); ``` ### Parameters -*Abs_time*\ +*`Abs_time`*\ Represents a point in time. ### Remarks This function does not throw any exceptions. -## swap +## `swap` Swaps the states of two `thread` objects. @@ -69,17 +84,17 @@ void swap(thread& Left, thread& Right) noexcept; ### Parameters -*Left*\ +*`Left`*\ The left `thread` object. -*Right*\ +*`Right`*\ The right `thread` object. ### Remarks The function calls `Left.swap(Right)`. -## yield +## `yield` Signals the operating system to run other threads, even if the current thread would ordinarily continue to run. @@ -89,4 +104,4 @@ inline void yield() noexcept; ## See also -[\](../standard-library/thread.md) +[``](thread.md) diff --git a/docs/standard-library/toc.yml b/docs/standard-library/toc.yml index e34f783a1a7..bfb970bf6fa 100644 --- a/docs/standard-library/toc.yml +++ b/docs/standard-library/toc.yml @@ -149,7 +149,7 @@ items: href: chrono-operators.md - name: literals href: chrono-literals.md - - name: ambiguous_local_time + - name: ambiguous_local_time class href: ambiguous-local-time.md - name: choose enum href: choose-enum.md @@ -173,7 +173,7 @@ items: href: high-resolution-clock-struct.md - name: is_clock struct href: is-clock-struct.md - - name: last_spec + - name: last_spec struct href: last-spec-struct.md - name: leap_second class href: leap-second-class.md @@ -193,7 +193,7 @@ items: href: month-weekday-class.md - name: month_weekday_last class href: month-weekday-last-class.md - - name: nonexistent_local_time + - name: nonexistent_local_time class href: nonexistent-local-time.md - name: steady_clock struct href: steady-clock-struct.md @@ -219,7 +219,7 @@ items: href: utc-clock-class.md - name: weekday class href: weekday-class.md - - name: weekday_indexed + - name: weekday_indexed class href: weekdayindexed-class.md - name: weekday_last class href: weekdaylast-class.md @@ -256,11 +256,11 @@ items: href: codecvt.md - name: enums href: codecvt-enums.md - - name: codecvt_utf8 + - name: codecvt_utf8 class href: codecvt-utf8-class.md - - name: codecvt_utf8_utf16 + - name: codecvt_utf8_utf16 class href: codecvt-utf8-utf16-class.md - - name: codecvt_utf16 + - name: codecvt_utf16 class href: codecvt-utf16-class.md - name: expanded: false @@ -980,7 +980,7 @@ items: href: transform-view-class.md - name: values_view class href: values-view-class.md - - name: view_interface + - name: view_interface class href: view-interface.md - name: alias templates href: ranges-alias-templates.md @@ -1524,6 +1524,8 @@ items: href: using-cpp-library-headers.md - name: C++ Library conventions href: cpp-library-conventions.md + - name: C++ Standard Library containers + href: stl-containers.md - name: C++ program startup and termination href: cpp-program-startup-and-termination.md - name: "Safe libraries: C++ Standard Library" @@ -1552,100 +1554,6 @@ items: href: thread-safety-in-the-cpp-standard-library.md - name: stdext namespace href: stdext-namespace.md -- name: C++ Standard Library containers - expanded: false - items: - - name: C++ Standard Library containers - href: stl-containers.md - - name: - expanded: false - items: - - name: - href: sample-container.md - - name: operators - expanded: false - items: - - name: operators - href: sample-container-operators.md - - name: operator!= - href: operator-inequality.md - - name: operator== () - href: operator-equality-sample-container.md - - name: operator< () - href: operator-less-than-sample-container.md - - name: operator<= () - href: operator-less-or-equal-sample-container.md - - name: operator> () - href: operator-greater-than-sample-container.md - - name: operator>= - href: operator-greater-or-equal.md - - name: specialized template functions - expanded: false - items: - - name: specialized template functions - href: sample-container-specialized-template-functions.md - - name: swap () - href: swap-sample-container.md - - name: classes - expanded: false - items: - - name: classes - href: sample-container-classes.md - - name: Sample container class - expanded: false - items: - - name: Sample container class - href: sample-container-class.md - - name: Sample container members - href: sample-container-members.md - - name: Sample container typedefs - expanded: false - items: - - name: Sample container typedefs - href: sample-container-typedefs.md - - name: "Container class::const_iterator" - href: container-class-const-iterator.md - - name: "Container class::const_reference" - href: container-class-const-reference.md - - name: "Container class::const_reverse_iterator" - href: container-class-const-reverse-iterator.md - - name: "Container class::difference_type" - href: container-class-difference-type.md - - name: "Container class::iterator" - href: container-class-iterator.md - - name: "Container class::reference" - href: container-class-reference.md - - name: "Container class::reverse_iterator" - href: container-class-reverse-iterator.md - - name: "Container class::size_type" - href: container-class-size-type.md - - name: "Container class::value_type" - href: container-class-value-type.md - - name: Sample container member functions - expanded: false - items: - - name: Sample container member functions - href: sample-container-member-functions.md - - name: "Container class::begin" - href: container-class-begin.md - - name: "Container class::clear" - href: container-class-clear.md - - name: "Container class::empty" - href: container-class-empty.md - - name: "Container class::end" - href: container-class-end.md - - name: "Container class::erase" - href: container-class-erase.md - - name: "Container class::max_size" - href: container-class-max-size.md - - name: "Container class::rbegin" - href: container-class-rbegin.md - - name: "Container class::rend" - href: container-class-rend.md - - name: "Container class::size" - href: container-class-size.md - - name: "Container class::swap" - href: container-class-swap.md - name: Iterators href: iterators.md - name: Algorithms diff --git a/docs/standard-library/underflow-error-class.md b/docs/standard-library/underflow-error-class.md index eee569a3f7b..3b1d405babc 100644 --- a/docs/standard-library/underflow-error-class.md +++ b/docs/standard-library/underflow-error-class.md @@ -1,12 +1,11 @@ --- -description: "Learn more about: underflow_error Class" -title: "underflow_error Class" -ms.date: "09/09/2021" +title: "underflow_error class" +description: "Learn more about: underflow_error class" +ms.date: 09/09/2021 f1_keywords: ["stdexcept/std::underflow_error"] helpviewer_keywords: ["underflow_error class"] -ms.assetid: d632f1f9-9c6c-4954-b96b-03041bfab22d --- -# underflow_error Class +# `underflow_error` class The class serves as the base class for all exceptions thrown to report an arithmetic underflow. @@ -18,13 +17,12 @@ public: explicit underflow_error(const string& message); explicit underflow_error(const char *message); - }; ``` ## Remarks -The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](../standard-library/exception-class.md) and [`data`](../standard-library/basic-string-class.md#data). +The value returned by `what()` is a copy of `message.data()`. For more information, see [`what`](exception-class.md) and [`data`](basic-string-class.md#data). `underflow_error` isn't thrown by any functions in the Microsoft implementation of the C++ Standard Library, but it might be thrown by third-party libraries or user code. @@ -51,19 +49,20 @@ int main() cerr << "Type: " << typeid(e).name() << endl; } } -/* Output: +``` + +```Output Caught: The number's a bit small, captain! Type: class std::underflow_error -*/ ``` ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## See also -[runtime_error Class](../standard-library/runtime-error-class.md)\ -[Thread Safety in the C++ Standard Library](../standard-library/thread-safety-in-the-cpp-standard-library.md) +[`runtime_error` class](runtime-error-class.md)\ +[Thread Safety in the C++ Standard Library](thread-safety-in-the-cpp-standard-library.md) diff --git a/docs/standard-library/using-insertion-operators-and-controlling-format.md b/docs/standard-library/using-insertion-operators-and-controlling-format.md index e61172bb4dd..359347be9f4 100644 --- a/docs/standard-library/using-insertion-operators-and-controlling-format.md +++ b/docs/standard-library/using-insertion-operators-and-controlling-format.md @@ -1,6 +1,6 @@ --- -description: "Learn more about: Using Insertion Operators and Controlling Format" title: "Using Insertion Operators and Controlling Format" +description: "Learn more about: Using Insertion Operators and Controlling Format" ms.date: 10/07/2021 helpviewer_keywords: ["insertion operators"] --- @@ -165,7 +165,7 @@ Stan 4358.2 If you change the `ios::fixed` flag to `ios::scientific`, the program prints this: -```cpp +```Output Zoot 1.2e+00 Jimmy 3.5e+01 Al 6.5e+02 diff --git a/docs/standard-library/variant.md b/docs/standard-library/variant.md index a61bd4e8bba..04f6018d139 100644 --- a/docs/standard-library/variant.md +++ b/docs/standard-library/variant.md @@ -11,9 +11,9 @@ A variant object holds and manages a value. If the variant holds a value, that v ## Requirements -**Header:** \ +**Header:** `` -**Namespace:** std +**Namespace:** `std` ## Members @@ -21,46 +21,46 @@ A variant object holds and manages a value. If the variant holds a value, that v |Name|Description| |-|-| -|[operator==](../standard-library/forward-list-operators.md#op_eq_eq)|Tests if the variant object on the left side of the operator is equal to the variant object on the right side.| -|[operator!=](../standard-library/forward-list-operators.md#op_neq)|Tests if the variant object on the left side of the operator is not equal to the variant object on the right side.| -|[operator<](../standard-library/forward-list-operators.md#op_lt)|Tests if the variant object on the left side of the operator is less than the variant object on the right side.| -|[operator<=](../standard-library/forward-list-operators.md#op_lt_eq)|Tests if the variant object on the left side of the operator is less than or equal to the variant object on the right side.| -|[operator>](../standard-library/forward-list-operators.md#op_gt)|Tests if the variant object on the left side of the operator is greater than the variant object on the right side.| -|[operator>=](../standard-library/forward-list-operators.md#op_gt_eq)|Tests if the variant object on the left side of the operator is greater than or equal to the variant object on the right side.| +|[`operator==`](variant-operators.md#op_eq_eq)|Tests if the variant object on the left side of the operator is equal to the variant object on the right side.| +|[`operator!=`](variant-operators.md#op_neq)|Tests if the variant object on the left side of the operator is not equal to the variant object on the right side.| +|[`operator<`](variant-operators.md#op_lt)|Tests if the variant object on the left side of the operator is less than the variant object on the right side.| +|[`operator<=`](variant-operators.md#op_lt_eq)|Tests if the variant object on the left side of the operator is less than or equal to the variant object on the right side.| +|[`operator>`](variant-operators.md#op_gt)|Tests if the variant object on the left side of the operator is greater than the variant object on the right side.| +|[`operator>=`](variant-operators.md#op_gt_eq)|Tests if the variant object on the left side of the operator is greater than or equal to the variant object on the right side.| ### Functions |Name|Description| |-|-| -|[get](../standard-library/variant-functions.md#get)|Gets the variant of an object.| -|[get_if](../standard-library/variant-functions.md#get_if)|Gets the variant of an object if it exists.| -|[holds_alternative](../standard-library/variant-functions.md#holds_alternative)|Return **`true`** if a variant exists.| -|[swap](../standard-library/variant-functions.md#swap)|Swaps a **variant**.| -|[visit](../standard-library/variant-functions.md#visit)|Moves to the next **variant**.| +|[`get`](variant-functions.md#get)|Gets the variant of an object.| +|[`get_if`](variant-functions.md#get_if)|Gets the variant of an object if it exists.| +|[`holds_alternative`](variant-functions.md#holds_alternative)|Return **`true`** if a variant exists.| +|[`swap`](variant-functions.md#swap)|Swaps a **variant**.| +|[`visit`](variant-functions.md#visit)|Moves to the next **variant**.| ### Classes |Name|Description| |-|-| -|[bad_variant_access](../standard-library/bad-variant-access-class.md)|Objects thrown to report invalid accesses to the value of a variant object.| -|[variant](../standard-library/variant.md)|An object to either hold a value of one of its alternative types, or no value.| +|[`bad_variant_access`](bad-variant-access-class.md)|Objects thrown to report invalid accesses to the value of a variant object.| +|[`variant`](variant-class.md)|An object to either hold a value of one of its alternative types, or no value.| ### Structs |Name|Description| |-|-| -|[hash](../standard-library/hash-structure.md)|| -|[monostate](../standard-library/monostate-structure.md)|An alternative type for a variant to make the variant type default constructible.| -|[uses_allocator](../standard-library/uses-allocator-structure.md)|| -|[variant_alternative](../standard-library/variant-alternative-structure.md)|Assists the variant objects.| -|[variant_size](../standard-library/variant-size-structure.md)|Assists the variant objects.| +|[`hash`](hash-structure.md)|| +|[`monostate`](monostate-structure.md)|An alternative type for a variant to make the variant type default constructible.| +|[`uses_allocator`](uses-allocator-structure.md)|| +|[`variant_alternative`](variant-alternative-structure.md)|Assists the variant objects.| +|[`variant_size`](variant-size-structure.md)|Assists the variant objects.| ### Objects |Name|Description| |-|-| -|[variant_npos](../standard-library/variant-functions.md#variant_npos)|| +|[`variant_npos`](variant-functions.md#variant_npos)|| ## See also -[Header Files Reference](../standard-library/cpp-standard-library-header-files.md) +[Header Files Reference](cpp-standard-library-header-files.md) diff --git a/docs/standard-library/zoned-time-class.md b/docs/standard-library/zoned-time-class.md index 3fbc4f7dcc1..c5b82df46cf 100644 --- a/docs/standard-library/zoned-time-class.md +++ b/docs/standard-library/zoned-time-class.md @@ -33,7 +33,7 @@ A `zoned_time` always refers to a valid time zone and represents a point in time |[`get_time_zone`](#get_time_zone) | Gets the [time_zone](time-zone-class.md) stored in this `zoned_time`. | |[`operator=`](#op_=)| Assign the value of another `zoned_time`, or another `zoned_time`'s `local_time` or `sys_time`, to this `zoned_time`.| |[`operator local_time`](#op_local_time)| Combines the `zoned_time`'s time zone with the stored time point to produce the local time in that time zone.| -|[`operator sys_time`](#op_local_time)| Gets the time stored in this `zoned_time` without applying the time zone. | +|[`operator sys_time`](#op_sys_time)| Gets the time stored in this `zoned_time` without applying the time zone. | ## Non-members diff --git a/docs/windows/clickonce-deployment-for-visual-cpp-applications.md b/docs/windows/clickonce-deployment-for-visual-cpp-applications.md index 07698cb3de3..1824562d2ab 100644 --- a/docs/windows/clickonce-deployment-for-visual-cpp-applications.md +++ b/docs/windows/clickonce-deployment-for-visual-cpp-applications.md @@ -1,19 +1,19 @@ --- -description: "Learn more about: ClickOnce Deployment for Visual C++ Applications" -title: "ClickOnce Deployment for Visual C++ Applications" +description: "Learn more about: ClickOnce Deployment for Microsoft C++ Applications" +title: "ClickOnce Deployment for Microsoft C++ Applications" ms.date: "11/04/2016" helpviewer_keywords: ["deploying applications [C++], ClickOnce", "application deployment [C++], ClickOnce", "ClickOnce deployment [C++], C++ applications"] --- -# ClickOnce Deployment for Visual C++ Applications +# ClickOnce Deployment for Microsoft C++ Applications Visual Studio provides two different technologies for deploying Windows applications: ClickOnce deployment or [Windows Installer](/windows/win32/Msi/windows-installer-portal) deployment. ## ClickOnce Deployment in C++ > [!NOTE] -> ClickOnce does not support deployment of native C++ applications. However, you can use ClickOnce to deploy a Visual C++ application if it is a dependency of a Visual C# or VB.NET project. For example, if you have a Visual C# project that depends on a Visual C++ project, you can publish the application (including its dependencies) using ClickOnce deployment from the Visual C# development environment. If you have a Visual Basic .NET project that depends on a Visual C++ project, you can publish the application (including its dependencies) using ClickOnce deployment from the Visual Basic .NET development environment. +> ClickOnce does not support deployment of native C++ applications. However, you can use ClickOnce to deploy a Microsoft C++ application if it is a dependency of a C# or VB.NET project. For example, if you have a C# project that depends on a C++ project, you can publish the application (including its dependencies) using ClickOnce deployment from the C# development environment. If you have a Visual Basic .NET project that depends on a C++ project, you can publish the application (including its dependencies) using ClickOnce deployment from the Visual Basic .NET development environment. -To deploy a Visual C++ application using ClickOnce, you first have to build a [ClickOnce Application Manifest](/visualstudio/deployment/clickonce-application-manifest) and a [ClickOnce Deployment Manifest](/visualstudio/deployment/clickonce-deployment-manifest) using the [Mage.exe (Manifest Generation and Editing Tool)](/dotnet/framework/tools/mage-exe-manifest-generation-and-editing-tool) or its graphical user interface version (for information, see [MageUI.exe (Manifest Generation and Editing Tool, Graphical Client)](/dotnet/framework/tools/mageui-exe-manifest-generation-and-editing-tool-graphical-client)). +To deploy a C++ application using ClickOnce, you first have to build a [ClickOnce Application Manifest](/visualstudio/deployment/clickonce-application-manifest) and a [ClickOnce Deployment Manifest](/visualstudio/deployment/clickonce-deployment-manifest) using the [Mage.exe (Manifest Generation and Editing Tool)](/dotnet/framework/tools/mage-exe-manifest-generation-and-editing-tool) or its graphical user interface version (for information, see [MageUI.exe (Manifest Generation and Editing Tool, Graphical Client)](/dotnet/framework/tools/mageui-exe-manifest-generation-and-editing-tool-graphical-client)). You first use Mage.exe to build the application manifest; the resulting file will have the extension .manifest. You then use Mage.exe to build the deployment manifest; the resulting file will have the extension `.application`. You then sign the manifests. @@ -21,7 +21,7 @@ The application manifest must specify the target processor (**x86**, **x64**, or Also, the name of the application and deployment manifests must be different from the name of the C++ application. This avoids conflict between the application manifest created by Mage.exe and the external manifest that is part of the C++ application. -Your deployment needs to install any Visual C++ libraries on which your application depends. To determine the dependencies for a particular application, you can use depends.exe or the `DUMPBIN` utility with the `/DEPENDENTS` option. For more information on dependencies, see [Understanding the Dependencies of a Visual C++ Application](understanding-the-dependencies-of-a-visual-cpp-application.md). You might need to run VCRedist.exe; this utility installs Visual C++ libraries on the target computer. +Your deployment needs to install any C++ libraries on which your application depends. To determine the dependencies for a particular application, you can use depends.exe or the `DUMPBIN` utility with the `/DEPENDENTS` option. For more information on dependencies, see [Understanding the Dependencies of a Microsoft C++ Application](understanding-the-dependencies-of-a-visual-cpp-application.md). You might need to run VCRedist.exe; this utility installs C++ libraries on the target computer. You may also need to build a bootstrapper (prerequisites installer) for your application to deploy prerequisite components; for information on the bootstrapper, see [Creating Bootstrapper Packages](/visualstudio/deployment/creating-bootstrapper-packages). diff --git a/docs/windows/deploying-native-desktop-applications-visual-cpp.md b/docs/windows/deploying-native-desktop-applications-visual-cpp.md index 883406e495d..f36fc557a67 100644 --- a/docs/windows/deploying-native-desktop-applications-visual-cpp.md +++ b/docs/windows/deploying-native-desktop-applications-visual-cpp.md @@ -1,31 +1,31 @@ --- -description: "Learn more about: Deploying Native Desktop Applications (Visual C++)" -title: "Deploying Native Desktop Applications (Visual C++)" +description: "Learn more about: Deploying Native Desktop Applications (Microsoft C++)" +title: "Deploying Native Desktop Applications (Microsoft C++)" ms.date: "05/11/2018" helpviewer_keywords: ["deploying applications [C++]", "application deployment [C++]", "Visual C++, application deployment", "application deployment [C++], about application deployment", "deploying applications [C++], about deploying applications", "distributing applications [C++]"] ms.assetid: 37f1691e-d67c-41e4-926e-528a237a9bac ms.topic: "overview" ms.custom: intro-deployment --- -# Deploying Native Desktop Applications (Visual C++) +# Deploying Native Desktop Applications (Microsoft C++) Deployment is the process by which you distribute a finished application or component to be installed on other computers. Deployment planning starts when an application is created on a developer's computer. Deployment ends when the application is installed and ready to run on a user's computer. Visual Studio provides different technologies for deploying Windows applications. These include ClickOnce deployment and Windows Installer deployment. -- ClickOnce can be used to deploy C++ applications that target the common language runtime (CLR)—mixed, pure, and verifiable assemblies. Although you can use Windows Installer to deploy a managed application, we recommend that you use ClickOnce because it takes advantage of .NET Framework security features such as manifest signing. ClickOnce does not support deployment of native C++ applications. For more information, see [ClickOnce Deployment for Visual C++ Applications](clickonce-deployment-for-visual-cpp-applications.md). +- ClickOnce can be used to deploy C++ applications that target the common language runtime (CLR)—mixed, pure, and verifiable assemblies. Although you can use Windows Installer to deploy a managed application, we recommend that you use ClickOnce because it takes advantage of .NET Framework security features such as manifest signing. ClickOnce does not support deployment of native C++ applications. For more information, see [ClickOnce Deployment for Microsoft C++ Applications](clickonce-deployment-for-visual-cpp-applications.md). - Windows Installer technology can be used to deploy either native C++ applications or C++ applications that target the CLR. -The articles in this section of the documentation discuss how to ensure that a native Visual C++ application runs on any computer that provides a supported target platform, which files you must include in an installation package, and the recommended ways to redistribute the components that your application depends on. +The articles in this section of the documentation discuss how to ensure that a native Microsoft C++ application runs on any computer that provides a supported target platform, which files you must include in an installation package, and the recommended ways to redistribute the components that your application depends on. ## In This Section -- [Deployment in Visual C++](deployment-in-visual-cpp.md) +- [Deployment in Microsoft C++](deployment-in-visual-cpp.md) - [Deployment Concepts](deployment-concepts.md) -- [Understanding the Dependencies of a Visual C++ Application](understanding-the-dependencies-of-a-visual-cpp-application.md) +- [Understanding the Dependencies of a Microsoft C++ Application](understanding-the-dependencies-of-a-visual-cpp-application.md) - [Determining Which DLLs to Redistribute](determining-which-dlls-to-redistribute.md) @@ -33,13 +33,13 @@ The articles in this section of the documentation discuss how to ensure that a n - [Universal CRT deployment](universal-crt-deployment.md). -- [Redistributing Visual C++ Files](redistributing-visual-cpp-files.md) +- [Redistributing Microsoft C++ Files](redistributing-visual-cpp-files.md) - [Deployment Examples](deployment-examples.md) - [Redistributing Web Client Applications](redistributing-web-client-applications.md) -- [ClickOnce Deployment for Visual C++ Applications](clickonce-deployment-for-visual-cpp-applications.md) +- [ClickOnce Deployment for Microsoft C++ Applications](clickonce-deployment-for-visual-cpp-applications.md) - [Running a C++ /clr Application on a Previous Runtime Version](running-a-cpp-clr-application-on-a-previous-runtime-version.md) diff --git a/docs/windows/deploying-visual-cpp-application-by-using-the-vcpp-redistributable-package.md b/docs/windows/deploying-visual-cpp-application-by-using-the-vcpp-redistributable-package.md index 3ce20bfe3fb..2489c12d56f 100644 --- a/docs/windows/deploying-visual-cpp-application-by-using-the-vcpp-redistributable-package.md +++ b/docs/windows/deploying-visual-cpp-application-by-using-the-vcpp-redistributable-package.md @@ -1,6 +1,6 @@ --- -title: "Deploy a Visual C++ App by Using the Redistributable" -description: "Learn how to deploy a Visual C++ application by using the Visual C++ Redistributable package." +title: "Deploy a Microsoft C++ App by Using the Redistributable" +description: "Learn how to deploy a Microsoft C++ application by using the Visual C++ Redistributable package." ms.date: 03/20/2025 ms.topic: tutorial helpviewer_keywords: ["walkthrough, deploying a Visual C++ application by using the redistributable package"] diff --git a/docs/windows/deployment-concepts.md b/docs/windows/deployment-concepts.md index 762b7034ca3..7d74341b303 100644 --- a/docs/windows/deployment-concepts.md +++ b/docs/windows/deployment-concepts.md @@ -19,11 +19,11 @@ You package your application by adding a Setup project to your solution; when bu ## Library Dependencies -When a C/C++ application is built using functionality provided by the Visual C++ libraries, it becomes dependent on the presence of those libraries at runtime. In order for the application to run, it must link, either statically or dynamically, to the necessary Visual C++ libraries. If an application dynamically links to a Visual C++ library, then when it runs that library must be present so it can be loaded. On the other hand, if the application statically links to a Visual C++ library, then it does not need the corresponding DLLs to be present on the user's computer. Static linking, however, has some negative effects, such as the increasing the size of the application files, and making maintenance potentially more difficult. For more information, see [Advantages of using DLLs](../build/dlls-in-visual-cpp.md#advantages-of-using-dlls). +When a C/C++ application is built using functionality provided by the Microsoft C++ libraries, it becomes dependent on the presence of those libraries at runtime. In order for the application to run, it must link, either statically or dynamically, to the necessary Microsoft C++ libraries. If an application dynamically links to a Microsoft C++ library, then when it runs that library must be present so it can be loaded. On the other hand, if the application statically links to a Microsoft C++ library, then it does not need the corresponding DLLs to be present on the user's computer. Static linking, however, has some negative effects, such as the increasing the size of the application files, and making maintenance potentially more difficult. For more information, see [Advantages of using DLLs](../build/dlls-in-visual-cpp.md#advantages-of-using-dlls). ## Packaging and Redistributing -Visual C++ libraries are packaged as DLLs, and all necessary libraries for C/C++ applications are installed by Visual Studio on the developer's computer. However, when deploying your application to your users, it is not feasible in most cases to require them to install Visual Studio in order to run your application. It is important to be able to redistribute just the parts of Visual C++ that are required by your application to run correctly. +Microsoft C++ libraries are packaged as DLLs, and all necessary libraries for C/C++ applications are installed by Visual Studio on the developer's computer. However, when deploying your application to your users, it is not feasible in most cases to require them to install Visual Studio in order to run your application. It is important to be able to redistribute just the parts of Microsoft C++ that are required by your application to run correctly. For more information about packaging and redistributing, see the following topics: @@ -42,4 +42,4 @@ For deployment examples and suggestions about troubleshooting, see: ## See also - [Deploying Desktop Applications](deploying-native-desktop-applications-visual-cpp.md) -- [Understanding the Dependencies of a Visual C++ Application](understanding-the-dependencies-of-a-visual-cpp-application.md) +- [Understanding the Dependencies of a Microsoft C++ Application](understanding-the-dependencies-of-a-visual-cpp-application.md) diff --git a/docs/windows/deployment-in-visual-cpp.md b/docs/windows/deployment-in-visual-cpp.md index a343c802a5b..5c39eaabb60 100644 --- a/docs/windows/deployment-in-visual-cpp.md +++ b/docs/windows/deployment-in-visual-cpp.md @@ -1,14 +1,14 @@ --- -description: "Learn more about: Deployment in Visual C++" -title: "Deployment in Visual C++" +description: "Learn more about: Deployment in Microsoft C++" +title: "Deployment in Microsoft C++" ms.date: 06/28/2022 helpviewer_keywords: ["deploying applications [C++]", "application deployment [C++]"] ms.assetid: d4b4ffc0-d2bd-4e4a-84a6-62f1c26f6a09 ms.custom: intro-deployment --- -# Deployment in Visual C++ +# Deployment in Microsoft C++ -Installation of your application on a computer other than your development computer is known as *deployment*. When you deploy a Visual C++ application to another computer, you must install both the application and any library files it depends on. Visual Studio enables three ways to deploy the Visual C++ libraries together with your application: *central deployment*, *local deployment*, and *static linking*. Central deployment puts the library files under the Windows directory, where all applications can access them automatically. Local deployment puts the library files in the same directory as your application. You must redeploy any locally deployed libraries yourself to update them. Static linking binds the library code into your application. You have to recompile and redeploy your application to take advantage of any updates to the libraries when you use static linking. +Installation of your application on a computer other than your development computer is known as *deployment*. When you deploy a Microsoft C++ application to another computer, you must install both the application and any library files it depends on. Visual Studio enables three ways to deploy the Microsoft C++ libraries together with your application: *central deployment*, *local deployment*, and *static linking*. Central deployment puts the library files under the Windows directory, where all applications can access them automatically. Local deployment puts the library files in the same directory as your application. You must redeploy any locally deployed libraries yourself to update them. Static linking binds the library code into your application. You have to recompile and redeploy your application to take advantage of any updates to the libraries when you use static linking. In Visual Studio 2015, the Microsoft C Runtime library was refactored into version-specific local library components, and a new Universal C Runtime library that is now part of Windows. For details on deployment of the Universal CRT, see [Universal CRT deployment](universal-crt-deployment.md). @@ -16,15 +16,15 @@ In Visual Studio 2015, the Microsoft C Runtime library was refactored into versi In central deployment, library DLL files are installed in the *`Windows\System32`* directory, or for 32-bit library files on x64 systems, the *`Windows\SysWow64`* directory. Centrally deployed library files are available to other applications. -To centrally deploy Visual C++ libraries, you can use one of these two sources for the files to install: +To centrally deploy Microsoft C++ libraries, you can use one of these two sources for the files to install: - *Redistributable package* files. These files are stand-alone command-line executables that contain all the Visual C++ Redistributable libraries in compressed form. The latest Redistributable packages are available from [Microsoft Visual C++ Redistributable Latest Supported Downloads](latest-supported-vc-redist.md). When you use the Redistributable packages for central deployment, Windows Update can service the libraries independently. - *Redistributable merge modules* (*`.msm`* files), which you can include in your application's Windows Installer (*`.msi`*) file. This method is deprecated because libraries deployed this way can't be updated automatically by Windows Update. For more information, see [Redistributing by using merge modules](redistributing-components-by-using-merge-modules.md). -A Redistributable package file installs all of the Visual C++ libraries for a particular system architecture. For example, if your application is built for x64, you can use the *`vcredist_x64.exe`* package to install all the Visual C++ libraries your application uses. You can program your application installer to run the package as a prerequisite before you install your application. +A Redistributable package file installs all of the Microsoft C++ libraries for a particular system architecture. For example, if your application is built for x64, you can use the *`vcredist_x64.exe`* package to install all the Microsoft C++ libraries your application uses. You can program your application installer to run the package as a prerequisite before you install your application. -Central deployment by using a Redistributable package enables Windows Update to automatically update the Visual C++ libraries. For continued security and functionality, we recommend that you use the library DLLs in your application instead of static libraries, and use Redistributable packages and central deployment instead of local deployment. +Central deployment by using a Redistributable package enables Windows Update to automatically update the Microsoft C++ libraries. For continued security and functionality, we recommend that you use the library DLLs in your application instead of static libraries, and use Redistributable packages and central deployment instead of local deployment. ## Local deployment @@ -32,15 +32,15 @@ In local deployment, library files are installed in your application folder toge Expansions to a library may be spread across multiple extra DLLs, known as *dot libraries*. For example, some functionality in the standard library released in Visual Studio 2017 version 15.6 was added into *`msvcp140_1.dll`*, to preserve the ABI compatibility of *`msvcp140.dll`*. If you use Visual Studio 2017 version 15.6 (toolset 14.13) or later, you may need to locally deploy both these dot libraries and the main library. These separate dot libraries will eventually be added to the base library, when the ABI changes. -Because Microsoft can't automatically update locally deployed Visual C++ libraries, we don't recommend local deployment of these libraries. If you decide to use local deployment of the Redistributable libraries, we recommend that you implement your own method of automatically updating the locally deployed libraries. +Because Microsoft can't automatically update locally deployed Microsoft C++ libraries, we don't recommend local deployment of these libraries. If you decide to use local deployment of the Redistributable libraries, we recommend that you implement your own method of automatically updating the locally deployed libraries. ## Static linking -In addition to dynamically linked libraries, Visual Studio supplies most of its libraries as static libraries. You can statically link a static library to your application, that is, link the library object code directly into the application. Static linking creates a single binary without a DLL dependency, so that you don't have to deploy the Visual C++ library files separately. However, we don't recommend this approach because statically linked libraries can't be updated in place. To update a linked library when you use static linking, you have to recompile and redeploy your application. +In addition to dynamically linked libraries, Visual Studio supplies most of its libraries as static libraries. You can statically link a static library to your application, that is, link the library object code directly into the application. Static linking creates a single binary without a DLL dependency, so that you don't have to deploy the Microsoft C++ library files separately. However, we don't recommend this approach because statically linked libraries can't be updated in place. To update a linked library when you use static linking, you have to recompile and redeploy your application. ## Troubleshooting deployment issues -The load order of Visual C++ libraries is system-dependent. To diagnose loader issues, use *`depends.exe`* or *`where.exe`*. For more information, see [Dynamic-link library search order (Windows)](/windows/win32/Dlls/dynamic-link-library-search-order). +The load order of Microsoft C++ libraries is system-dependent. To diagnose loader issues, use *`depends.exe`* or *`where.exe`*. For more information, see [Dynamic-link library search order (Windows)](/windows/win32/Dlls/dynamic-link-library-search-order). ## See also diff --git a/docs/windows/latest-supported-vc-redist.md b/docs/windows/latest-supported-vc-redist.md index 9217788e655..9e2e4b234e0 100644 --- a/docs/windows/latest-supported-vc-redist.md +++ b/docs/windows/latest-supported-vc-redist.md @@ -1,7 +1,7 @@ --- -title: "Latest supported Visual C++ Redistributable downloads" -description: "This article provides download links for the latest Visual C++ Redistributable packages." -ms.date: 09/23/2025 +title: Latest Supported Visual C++ Redistributable Downloads +description: This article provides download links for the latest Visual C++ Redistributable packages. +ms.date: 12/03/2025 helpviewer_keywords: [ "redist", @@ -20,53 +20,73 @@ ms.author: msaleh > [!NOTE] > Are you here to download Visual Studio? Go to [Visual Studio downloads](https://visualstudio.microsoft.com/downloads/). -This topic is for developers who need to install the Visual C++ runtime libraries with their app. If you're an end user trying to fix an app by updating the Visual C++ runtime libraries, contact the app vendor for instructions. +This article is for developers who need to install the Visual C++ Runtime libraries with their app. If you're trying to fix an app by updating the Visual C++ Runtime libraries, contact the app vendor for instructions. -To find the download you need, choose your version of Visual Studio from the table below. Each link takes you to the appropriate download section. +To find the download you need, choose your version of Visual Studio from the following table. Each link takes you to the appropriate download section. -| Visual Studio version | Section | +| Version | Section | |--|--| -| Latest supported (2015–2022) | [Latest supported Redistributable version](#latest-supported-redistributable-version) | +| Latest supported v14 (for Visual Studio 2017–2026) | [Latest supported Redistributable version](#latest-supported-redistributable-version) | +| Visual Studio 2015 | [Visual Studio 2015 (VC++ 14.0)](#visual-studio-2015-vc-140-no-longer-supported) | | Visual Studio 2013 | [Visual Studio 2013 (VC++ 12.0)](#visual-studio-2013-vc-120-no-longer-supported) | | Visual Studio 2012 | [Visual Studio 2012 (VC++ 11.0)](#visual-studio-2012-vc-110-update-4-no-longer-supported) | | Visual Studio 2010 | [Visual Studio 2010 (VC++ 10.0)](#visual-studio-2010-vc-100-sp1-no-longer-supported) | | Visual Studio 2008 | [Visual Studio 2008 (VC++ 9.0)](#visual-studio-2008-vc-90-sp1-no-longer-supported) | | Visual Studio 2005 | [Visual Studio 2005 (VC++ 8.0)](#visual-studio-2005-vc-80-sp1-no-longer-supported) | -Redistribution is permitted only for licensed Visual Studio users, as described in the [Visual Studio license terms](https://visualstudio.microsoft.com/license-terms/). For details on redistributing Visual C++ files, see [Redistributing Visual C++ Files](redistributing-visual-cpp-files.md). +> [!TIP] +> Are you having issues installing the Visual C++ Redistributable? Refer to the [Troubleshooting Guide](troubleshoot-vc-redistributable-installation-issues.md). -A Visual C++ Redistributable installs Microsoft C and C++ (MSVC) runtime libraries. Many applications built using Microsoft C and C++ tools require these libraries. If your app is built using those libraries, a Microsoft Visual C++ Redistributable package at least as recent as the MSVC build toolset used to build your app must be installed on the target system along with the app. The Redistributable package architecture must match your app's target architecture (you can't install an ARM redistributable on an x86 system, or an x64 redistributable on an x86 system, for example). We recommend you use the latest Redistributable available for your version of Visual Studio, with some exceptions noted in this article. +Redistribution is permitted only for licensed Visual Studio users, as described in the [Visual Studio license terms](https://visualstudio.microsoft.com/license-terms/). For details on redistributing Visual C++ files, see [Redistribute Visual C++ files](redistributing-visual-cpp-files.md). -## Visual Studio 2015-2022 +A Visual C++ Redistributable installs Microsoft C and C++ Runtime libraries. Many applications built by using Microsoft Visual C++ (MSVC) Build Tools require these libraries. If your app is built by using those libraries, a Microsoft Visual C++ Redistributable package at least as recent as the build tools used to build your app must be installed on the target system along with the app. -This table lists the latest supported English (en-US) Microsoft Visual C++ Redistributable packages for Visual Studio 2015, 2017, 2019, and 2022. The latest supported version has the most recently implemented C++ features, security, reliability, and performance improvements. It also includes the latest C++ standard language and library standards conformance updates. We recommend that you install this version for all applications created using Visual Studio 2015, 2017, 2019, or 2022. +The redistributable package architecture must match your app's target architecture. (You can't install an ARM64 Redistributable on an x86 system or an x64 Redistributable on an x86 system, for example.) We recommend that you use the latest Redistributable available for your version of Visual Studio. -Unlike older versions of Visual Studio that have infrequent redist updates, the version number isn't listed in the following table for Visual Studio 2015-2022 because the redist is updated frequently. To find the version number of the latest redist, download the redist you're interested in using one of the following links. Then, look at its properties using Windows File Explorer. In the **Details** pane, the **File version** contains the version of the redist. +## Visual C++ v14 Redistributable + +The following table lists the latest supported Microsoft Visual C++ v14 Redistributable packages. The latest supported version has the most recently implemented C++ features, security, reliability, and performance improvements. It also includes the latest C++ standard language and library standards conformance updates. We recommend that you install this version for all applications created by using MSVC Build Tools available in Visual Studio 2017, 2019, 2022, or 2026. + +Unlike older versions of Visual Studio that have infrequent redistributable updates, the version number isn't listed in the following table for the Visual C++ v14 Redistributable because it's updated frequently. To find the version number of the latest redistributable, download the one you're interested in by using one of the following links. Then, look at its properties by using Windows File Explorer. On the **Details** pane, **File version** contains the version of the redistributable. ### Latest supported redistributable version | Architecture | Link | Notes | |--|--|--| -| ARM64 | [https://aka.ms/vs/17/release/vc_redist.arm64.exe](https://aka.ms/vs/17/release/vc_redist.arm64.exe) | Permalink for latest supported ARM64 version | -| X86 | [https://aka.ms/vs/17/release/vc_redist.x86.exe](https://aka.ms/vs/17/release/vc_redist.x86.exe) | Permalink for latest supported x86 version | -| X64 | [https://aka.ms/vs/17/release/vc_redist.x64.exe](https://aka.ms/vs/17/release/vc_redist.x64.exe) | Permalink for latest supported x64 version. The X64 Redistributable package contains both ARM64 and X64 binaries. This package makes it easy to install required Visual C++ ARM64 binaries when the X64 Redistributable is installed on an ARM64 device. | +| ARM64 | [https://aka.ms/vc14/vc_redist.arm64.exe](https://aka.ms/vc14/vc_redist.arm64.exe) | Permalink for latest supported ARM64 version. | +| X86 | [https://aka.ms/vc14/vc_redist.x86.exe](https://aka.ms/vc14/vc_redist.x86.exe) | Permalink for latest supported x86 version. | +| X64 | [https://aka.ms/vc14/vc_redist.x64.exe](https://aka.ms/vc14/vc_redist.x64.exe) | Permalink for latest supported x64 version. The X64 Redistributable package contains both ARM64 and X64 binaries. This package makes it easy to install required Visual C++ ARM64 binaries when the X64 Redistributable is installed on an ARM64 device. | -Download other versions, including long term servicing release channel (LTSC) versions, from [my.visualstudio.com](https://my.visualstudio.com/). +Download other versions, including long-term servicing channel (LTSC) versions, from [Welcome to Dev Essentials](https://my.visualstudio.com/). ### Notes -- The Visual C++ Redistributable for Visual Studio 2015-2022 doesn't have separate packages for different languages. It contains EULAs for all supported languages. -- Some of the downloads that are mentioned in this article are currently available on [my.visualstudio.com](https://my.visualstudio.com/). Log in using a Visual Studio Subscription account so that you can access the download links. If you're asked for credentials, use your existing Visual Studio subscription account. Or, create a free account by choosing the **No account? Create one!** link. -- Visual Studio versions since Visual Studio 2015 share the same Redistributable files. For example, any apps built by the Visual Studio 2015, 2017, 2019, or 2022 toolsets can use the latest Microsoft Visual C++ Redistributable. However, the version of the Microsoft Visual C++ Redistributable installed on the machine must be the same or higher than the version of the Visual C++ toolset used to create your application. For more information about which version of the Redistributable to install, see [Determining which DLLs to redistribute](determining-which-dlls-to-redistribute.md). For more information about binary compatibility, see [C++ binary compatibility between Visual Studio versions](../porting/binary-compat-2015-2017.md). -- **Windows XP Support**: Microsoft ended support for Windows XP on April 8, 2014. Current versions of the Visual C++ Redistributable for Visual Studio 2015-2022 only support Windows 7, 8.1, 10, and 11. The last version of the Visual C++ Redistributable that works on Windows XP shipped in Visual Studio 2019 version 16.7 (file versions starting with **14.27**). The Redistributable is available in the [my.visualstudio.com Downloads](https://my.visualstudio.com/Downloads/) section as **Visual C++ Redistributable for Visual Studio 2019 (version 16.7)**. Use the Search box to find this version. To download the files, select the platform and language you need, and then choose the **Download** button. +- Some of the downloads that are mentioned in this article are currently available on [Welcome to Dev Essentials](https://my.visualstudio.com/). Sign in by using a Visual Studio subscription account so that you can access the download links. If you're asked for credentials, use your existing Visual Studio subscription account. Or to create a free account. select [No account? Create one!](https://my.visualstudio.com/). +- The Visual C++ v14 Redistributable doesn't have separate packages for different languages. License terms for different languages are available at [Microsoft Software License Terms](https://aka.ms/VCRedistLicense). +- Visual Studio 2017 and later share the same redistributable files. Any apps built by MSVC Build Tools v14.* available in Visual Studio 2017, 2019, 2022, or 2026 can use the latest Visual C++ v14 Redistributable. + + The version of the Redistributable installed on the machine must be the same or later than the version of the MSVC Build Tools used to create your application. For more information about which version of the redistributable to install, see [Determine which dynamic-link libraries (DLLs) to redistribute](determining-which-dlls-to-redistribute.md). For more information about binary compatibility, see [C++ binary compatibility between Visual Studio versions](../porting/binary-compat-2015-2017.md). +- The latest version of the Visual C++ v14 Redistributable included with Visual Studio 2026 supports only the following operating systems: + * Windows 10 and 11 + * Windows Server 2016, 2019, 2022, and 2025 +- Support for Visual Studio 2015 ended on October 15, 2025. Because support for the Visual C++ Redistributable is connected to the version of Visual Studio in which it first ships, support for Visual C++ 2015 Redistributable (version 14.0.24212) also ended October 15, 2025. For the latest available version, see the [Visual Studio 2015 (Visual C++ 14.0)](#visual-studio-2015-vc-140-no-longer-supported) section.
+ + When Visual Studio 2015 support ended, the v14 Runtime was binary compatible with applications built by using the Visual Studio 2015 MSVC Build Tools. Because Visual Studio 2015 is no longer supported, we recommend that you update your projects to use a supported MSVC Build Tools version and the latest v14 Runtime, the Visual C++ Redistributable for 2017, and later, and perform an in-place upgrade to the Visual C++ 2015 Redistributable (14.0.24212.0). Redistributables for 2013 and earlier remain installed side by side. + - The Visual C++ Redistributable supports several command-line options. For more information, see [Command-line options for the Redistributable packages](./redistributing-visual-cpp-files.md#command-line-options-for-the-redistributable-packages). ## Unsupported legacy versions +### Visual Studio 2015 (VC++ 14.0) (no longer supported) + +To download the latest available version of Visual C++ Redistributable for Visual Studio 2015, see the [Welcome to Dev Essentials](https://my.visualstudio.com/) page. On the **Downloads** tab, search for **Visual C++ Redistributable for Visual Studio 2015**. + +The latest version of Visual C++ Redistributable for Visual Studio 2015 is `14.0.24212.0` and is available for ARM64, X86, and X64 architectures. + ### Visual Studio 2013 (VC++ 12.0) (no longer supported) These links download the latest available en-US Microsoft Visual C++ Redistributable packages for Visual Studio 2013. -You can download other versions and languages from [Update for Visual C++ 2013 Redistributable Package](https://support.microsoft.com/topic/update-for-visual-c-2013-redistributable-package-d8ccd6a5-4e26-c290-517b-8da6cfdf4f10) or from [my.visualstudio.com](https://my.visualstudio.com/). +You can download other versions and languages from [Update for Visual C++ 2013 Redistributable package](https://support.microsoft.com/topic/update-for-visual-c-2013-redistributable-package-d8ccd6a5-4e26-c290-517b-8da6cfdf4f10) or from the [Welcome to Dev Essentials](https://my.visualstudio.com/) page. | Architecture | Version | Link | | ------------ | :----------: | ------------------------------------------------------: | @@ -75,15 +95,15 @@ You can download other versions and languages from [Update for Visual C++ 2013 R ### Other 2013 versions -- [Multibyte MFC Library for Visual Studio 2013](https://my.visualstudio.com/Downloads?pid=1430). This MFC add-on for Visual Studio 2013 contains the multibyte character set (MBCS) version of the Microsoft Foundation Class (MFC) Library. -- [Visual C++ 2013 Runtime for Sideloaded Windows 8.1 apps](https://download.microsoft.com/download/5/f/0/5f0f8404-9329-44a9-8176-ed6f7f746f25/vclibs_redist_packages.zip). For more information, see [C++ Runtime for Sideloaded Windows 8.1 apps](https://devblogs.microsoft.com/cppblog/c-runtime-for-sideloaded-windows-8-1-apps/) on the C++ Team Blog. +- [Multibyte Microsoft Foundation Class (MFC) Library for Visual Studio 2013](https://my.visualstudio.com/Downloads?pid=1430). This MFC add-on for Visual Studio 2013 contains the multibyte character set (MBCS) version of the MFC Library. +- [Visual C++ 2013 Runtime for sideloaded Windows 8.1 apps](https://download.microsoft.com/download/5/f/0/5f0f8404-9329-44a9-8176-ed6f7f746f25/vclibs_redist_packages.zip). For more information, see [C++ Runtime for sideloaded Windows 8.1 apps](https://devblogs.microsoft.com/cppblog/c-runtime-for-sideloaded-windows-8-1-apps/) on the C++ Team Blog. ### Visual Studio 2012 (VC++ 11.0) Update 4 (no longer supported) > [!NOTE] -> Visual Studio 2012 [reached end of extended support on Jan 10, 2023](/lifecycle/products/visual-studio-2012) +> Visual Studio 2012 [reached the end of extended support on January 10, 2023](/lifecycle/products/visual-studio-2012). -These links download the latest available en-US Microsoft Visual C++ Redistributable packages for Visual Studio 2012 Update 4. You can download other versions and languages from [Microsoft Visual C++ Redistributable Packages for Visual Studio 2012 Update 4](https://www.microsoft.com/download/details.aspx?id=30679) or from [my.visualstudio.com](https://my.visualstudio.com/Downloads?pid=1452). +These links download the latest available en-US Microsoft Visual C++ Redistributable packages for Visual Studio 2012 Update 4. You can download other versions and languages from [Microsoft Visual C++ Redistributable packages for Visual Studio 2012 Update 4](https://www.microsoft.com/download/details.aspx?id=30679) or from the [Visual Studio Subscriptions](https://my.visualstudio.com/Downloads?pid=1452) website. | Architecture | Version | Link | |--|:-:|-:| @@ -93,55 +113,51 @@ These links download the latest available en-US Microsoft Visual C++ Redistribut ### Visual Studio 2010 (VC++ 10.0) SP1 (no longer supported) > [!NOTE] -> Visual Studio 2010 Service Pack 1 [reached end of extended support on July 14, 2020](/lifecycle/products/visual-studio-2010) +> Visual Studio 2010 Service Pack 1 [reached the end of extended support on July 14, 2020](/lifecycle/products/visual-studio-2010). | Architecture | Version | Link | |--|:-:|-:| | X86 | 10.0.40219.325 | [vcredist_x86.exe](https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x86.exe) | | X64 | 10.0.40219.325 | [vcredist_x64.exe](https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x64.exe) | -Download Redistributable files for other languages and architectures from: - -- [Microsoft Visual C++ 2010 SP1 Redistributable Package MFC Security Update](https://www.microsoft.com/download/details.aspx?id=26999) +Download redistributable files for other languages and architectures from [Microsoft Visual C++ 2010 SP1 Redistributable package MFC Security Update](https://www.microsoft.com/download/details.aspx?id=26999). ### Visual Studio 2008 (VC++ 9.0) SP1 (no longer supported) > [!NOTE] -> Visual Studio 2008 Service Pack 1 [reached end of extended support on April 10, 2018](/lifecycle/products/visual-studio-2008) +> Visual Studio 2008 Service Pack 1 [reached the end of extended support on April 10, 2018](/lifecycle/products/visual-studio-2008). | Architecture | Version | Link | |--|:-:|-:| | X86 | 9.0.30729.5677 | [vcredist_x86.exe](https://download.microsoft.com/download/5/D/8/5D8C65CB-C849-4025-8E95-C3966CAFD8AE/vcredist_x86.exe) | | X64 | 9.0.30729.5677 | [vcredist_x64.exe](https://download.microsoft.com/download/5/D/8/5D8C65CB-C849-4025-8E95-C3966CAFD8AE/vcredist_x64.exe) | -Download Redistributable files for other languages and architectures from: - -- [Microsoft Visual C++ 2008 Service Pack 1 Redistributable Package MFC Security Update](https://www.microsoft.com/download/details.aspx?id=26368) +Download redistributable files for other languages and architectures from [Microsoft Visual C++ 2008 Service Pack 1 Redistributable package MFC Security Update](https://www.microsoft.com/download/details.aspx?id=26368). ### Visual Studio 2005 (VC++ 8.0) SP1 (no longer supported) > [!NOTE] -> Visual Studio 2005 [reached end of extended support on April 12, 2016](/lifecycle/products/microsoft-visual-studio-2005) +> Visual Studio 2005 [reached the end of extended support on April 12, 2016](/lifecycle/products/microsoft-visual-studio-2005). -- Redistributable files for X86, X64, and IA64 architectures are available from [Microsoft Visual C++ 2005 Service Pack 1 Redistributable Package MFC Security Update](https://www.microsoft.com/download/details.aspx?id=26347). +Redistributable files for X86, X64, and IA64 architectures are available from [Microsoft Visual C++ 2005 Service Pack 1 Redistributable package MFC Security Update](https://www.microsoft.com/download/details.aspx?id=26347). -## See also +## Related content - [C++ binary compatibility between Visual Studio versions](../porting/binary-compat-2015-2017.md) -- [How to audit Visual C++ Runtime version usage](redist-version-auditing.md) -- [Lifecycle FAQ - Visual C++ Redistributable and runtime libraries](/lifecycle/faq/visual-c-faq) +- [Audit Visual C++ Runtime version usage](redist-version-auditing.md) +- [Lifecycle FAQ: Visual C++ Redistributable and Runtime libraries](/lifecycle/faq/visual-c-faq) +- [Troubleshoot Visual C++ Redistributable installation issues](troubleshoot-vc-redistributable-installation-issues.md) -**Release notes** +### Release notes -- [Visual Studio 2022 release notes](/visualstudio/releases/2022/release-notes) -- [What's new for C++ in Visual Studio](../overview//what-s-new-for-visual-cpp-in-visual-studio.md) +- [What's new for C++ in Visual Studio](../overview/what-s-new-for-visual-cpp-in-visual-studio.md) +- [Visual Studio 2026 release notes](/visualstudio/releases/2026/release-notes) - [Visual C++ What's New 2003 through 2015](../porting/visual-cpp-what-s-new-2003-through-2015.md) -- [MSVC Backend Updates since Visual Studio 2022 version 17.3](https://devblogs.microsoft.com/cppblog/msvc-backend-updates-since-visual-studio-2022-version-17-3/) - [Standard Template Library (STL) changelog](https://github.com/microsoft/STL/wiki/Changelog) - [A year of C++ improvements](https://devblogs.microsoft.com/cppblog/a-year-of-cpp-improvements-in-visual-studio-vs-code-and-vcpkg) - [Microsoft Visual C++ compiler versioning](../overview/compiler-versions.md) -**C++ conformance notes** +### C++ conformance notes - [C++ conformance improvements in Visual Studio](../overview/cpp-conformance-improvements.md) - [C++ conformance improvements in Visual Studio 2019](../overview/cpp-conformance-improvements-2019.md) diff --git a/docs/windows/redist-version-auditing.md b/docs/windows/redist-version-auditing.md index a2cc229117a..410b12d1ee3 100644 --- a/docs/windows/redist-version-auditing.md +++ b/docs/windows/redist-version-auditing.md @@ -1,6 +1,6 @@ --- -title: "How to audit Visual C++ Runtime version usage" -description: "A detailed guide for auditing Visual C++ Runtime file usage." +title: Audit Visual C++ Runtime Version Usage +description: A detailed guide for auditing Visual C++ Runtime file usage. ms.date: 1/27/2025 helpviewer_keywords: [ @@ -12,26 +12,26 @@ ms.author: msaleh ms.topic: how-to --- -# How to audit Visual C++ Runtime version usage +# Audit Visual C++ Runtime version usage -The Microsoft Visual C++ Redistributable and the Visual Studio C++ Runtime (collectively, "VC Runtime") are critical components of many applications. Across your network, machines may still be running applications that install and use an out-of-support version of the VC Runtime. You can use NTFS file auditing to identify such usage as a step towards replacing those applications with ones that use a supported version of the VC Runtime. This guide walks you through setting up NTFS file auditing, provides troubleshooting tips, and highlights the benefits of regular audits. +Microsoft Visual C++ Redistributable and Visual Studio C++ Runtime (collectively, "VC Runtime") are critical components of many applications. Across your network, machines might still be running applications that install and use an out-of-support version of the VC Runtime. You can use NTFS file auditing to identify such usage as a step toward replacing those applications with ones that use a supported version of the VC Runtime. This article walks you through setting up NTFS file auditing, provides troubleshooting tips, and highlights the benefits of regular audits. For more information about the versions of VC Runtime that are no longer supported, see [Microsoft Visual C++ Redistributable latest supported downloads](latest-supported-vc-redist.md). ## Enable NTFS file auditing to determine VC Runtime usage -This guide provides the steps to manually enable NTFS file auditing and review audit events to determine which applications are calling the unsupported versions of the VC Runtime. Because there are several files that can be used by an application, this guide also shows how to use PowerShell's [`Get-Acl`](/powershell/module/microsoft.powershell.security/get-acl) and [`Set-Acl`](/powershell/module/microsoft.powershell.security/set-acl) cmdlets to update auditing permissions. For more information about how to configure audit policies for a file, see [Apply a basic audit policy on a file or folder](/previous-versions/windows/it-pro/windows-10/security/threat-protection/auditing/apply-a-basic-audit-policy-on-a-file-or-folder). +This article provides the steps to manually enable NTFS file auditing and review audit events to determine which applications are calling the unsupported versions of the VC Runtime. Because there are several files that an application can use, this article also shows how to use the PowerShell [`Get-Acl`](/powershell/module/microsoft.powershell.security/get-acl) and [`Set-Acl`](/powershell/module/microsoft.powershell.security/set-acl) cmdlets to update auditing permissions. For more information about how to configure audit policies for a file, see [Apply a basic audit policy on a file or folder](/previous-versions/windows/it-pro/windows-10/security/threat-protection/auditing/apply-a-basic-audit-policy-on-a-file-or-folder). ### Manually enable object access auditing on the system -Object access must be enabled before you enable file level auditing: +Object access must be enabled before you enable file-level auditing: -1. Open the **Local Group Policy Editor** by pressing `Windows` + `R` to open the **Run** dialog. Then type `gpedit.msc` and press **Enter**. -1. Navigate to **Computer Configuration** > **Windows Settings** > **Security Settings** > **Advanced Audit Policy Configuration** > **System Audit Policies** > **Object Access**. +1. Select **Windows**+**R** to open the **Run** dialog. Then enter `gpedit.msc` and select **Enter** to open **Local Group Policy Editor**. +1. Go to **Computer Configuration** > **Windows Settings** > **Security Settings** > **Advanced Audit Policy Configuration** > **System Audit Policies** > **Object Access**. 1. Double-click **Audit File System**. In the **Audit File System Properties** dialog, select **Configure the following audit events** > **Success** > **OK**. -1. Close the **Local Group Policy Editor**. +1. Close **Local Group Policy Editor**. -Alternatively, you may use `auditpol.exe` to enable object access: +Alternatively, you can use `auditpol.exe` to enable object access: 1. List the current settings from the command line with `AuditPol.exe /get /category:"Object Access"`. 1. Enable object access with `AuditPol.exe /set /category:"Object Access" /subcategory:"File System" /success:enable`. @@ -42,30 +42,30 @@ To monitor which process accesses a VC Runtime file, enable auditing on the VC R 1. Right-click the file that you want to audit, select **Properties**, and then select the **Security** tab. For more information about finding installed VC Runtime files, see [VC Runtime installed locations](#vcruntime_install_location). 1. Select **Advanced**. -1. In the **Advanced Security Settings** dialog box, select the **Auditing** tab and then select **Continue**. -1. To add a new auditing rule, select **Add**. In the **Auditing Entry** dialog, select a principal, then type the name of the user or group you want to add such as **(Everyone)**, and then select **OK**. -1. In **Type**, select ensure that **Success** is selected. +1. In the **Advanced Security Settings** dialog, select the **Auditing** tab and then select **Continue**. +1. To add a new auditing rule, select **Add**. In the **Auditing Entry** dialog, select a principal, and then enter the name of the user or group that you want to add, such as **(Everyone)**. Then select **OK**. +1. In **Type**, ensure that **Success** is selected. 1. Select **Show advance permissions** > **Clear all** > **Traverse folder / execute file** > **OK**. -1. There should now be a new row in the **Auditing** entries matching what you have selected. Select **OK**. -1. In the **Properties** Dialog, select **OK**. +1. Observe that a new row in the **Auditing** entries matches what you selected. Select **OK**. +1. In the **Properties** dialog, select **OK**. The audit rule is now enabled for the file. ### Manually review audit logs -NTFS file auditing generates ["Event 4663: An attempt was made to access an object"](/previous-versions/windows/it-pro/windows-10/security/threat-protection/auditing/event-4663) for each file that includes the audit permission and is accessed by a process. +NTFS file auditing generates [Event 4663: An attempt was made to access an object](/previous-versions/windows/it-pro/windows-10/security/threat-protection/auditing/event-4663) for each file that includes the audit permission and is accessed by a process. -1. Open the **Event Viewer** by pressing `Windows` + `R` to open the **Run** dialog. Then type `eventvwr.msc`, and press **Enter**. -1. Navigate to the **Security** logs in the **Event Viewer** by expanding **Windows Logs** > **Security**. The results pane lists security events. -1. Find the audit events by choosing **Filter Current Log...** in the **Actions** pane. Narrow down the events to **Event ID 4663 (Audit Success for the File System Category)** by entering **4663 into the Includes/Excludes Event IDs** text box. +1. Select **Windows**+**R** to open the **Run** dialog. Then enter `eventvwr.msc` and select **Enter** to open **Event Viewer**. +1. Go to the **Security** logs in the **Event Viewer** by expanding **Windows Logs** > **Security**. The results pane lists security events. +1. Find the audit events by choosing **Filter Current Log...** in the **Actions** pane. To narrow down the events to **Event ID 4663 (Audit Success for the File System Category)**, enter **4663** in the **Includes/Excludes Event IDs** text box. -For an example of a File Access Auditing Event 4663, see ["4663(S): An attempt was made to access an object."](/previous-versions/windows/it-pro/windows-10/security/threat-protection/auditing/event-4663) +For a File Access Auditing Event 4663 example, see [4663(S): An attempt was made to access an object](/previous-versions/windows/it-pro/windows-10/security/threat-protection/auditing/event-4663). ### Use PowerShell to audit VC Runtime usage -As an overview, updating File Auditing Permissions with PowerShell follows these steps: +To update file auditing permissions with PowerShell, follow these steps: -1. Define the [file system audit rule](/dotnet/api/system.security.accesscontrol.filesystemauditrule.-ctor) to apply to the file(s). +1. Define the [file system audit rule](/dotnet/api/system.security.accesscontrol.filesystemauditrule.-ctor) to apply to the files. 1. Obtain a file's security descriptor with [`Get-Acl`](/powershell/module/microsoft.powershell.security/get-acl). 1. [Apply the audit rule](/dotnet/api/system.security.accesscontrol.filesystemsecurity.setaccessrule) to the security descriptor. 1. Apply the updated security descriptor on the original file with [`Set-Acl`](/powershell/module/microsoft.powershell.security/set-acl). @@ -122,7 +122,7 @@ ForEach-Object { ### PowerShell: View file audit events -PowerShell provides `Get-WinEvent` to get event records for various event logs as shown in the following PowerShell code that lists all of the Auditing Event 4663 records over the past 24 hours: +PowerShell provides `Get-WinEvent` to get event records for various event logs, as shown in the following PowerShell code that lists all of the File Access Auditing Event 4663 records over the past 24 hours: ```powershell function Get-AuditEntries { @@ -171,17 +171,17 @@ ResourceAttributes : S:AI ### Next steps after auditing VC Runtime usage -After you have determined which processes are using the VC Runtime files, or which applications have installed the VC Redistributable, uninstall those applications or upgrade them to newer versions that don't depend on unsupported VC Runtimes. +After you determine which processes use the VC Runtime files, or which applications installed the Visual C++ Redistributable, uninstall those applications or upgrade them to newer versions that don't depend on unsupported VC Runtimes. -Some Microsoft applications require legacy versions of the VC Runtime. For details, see [Visual C++ Redistributable and runtime libraries FAQ | Microsoft Learn](/lifecycle/faq/visual-c-faq). +Some Microsoft applications require legacy versions of the VC Runtime. For more information, see the [Visual C++ Redistributable and Runtime libraries FAQ](/lifecycle/faq/visual-c-faq). ## VC Runtime installation locations -Here is where each version of the VC Runtime is installed: +The following table lists where each version of the VC Runtime is installed. -| **Visual Studio Version**| **Installed Location(s)**| +| Visual Studio version| Installed locations| | ------------- | ------------- | | Visual Studio 2013 (VC++ 12.0) | `%SystemRoot%\\System32, %SystemRoot%\\SysWOW64` | | Visual Studio 2012 (VC++ 11.0) | `%SystemRoot%\\System32, %SystemRoot%\\SysWOW64` | @@ -189,9 +189,9 @@ Here is where each version of the VC Runtime is installed: | Visual Studio 2008 (VC++ 9.0) | `%SystemRoot%\\WinSxS\\Fusion` | | Visual Studio 2005 (VC++ 8.0) | `%SystemRoot%\\WinSxS\\Fusion` | -## See also +## Related content -[Redistributing Visual C++ Files](redistributing-visual-cpp-files.md)\ -[The latest supported Visual C++ downloads](latest-supported-vc-redist.md)\ -[Lifecycle FAQ - Visual C++ Redistributable and runtime libraries](/lifecycle/faq/visual-c-faq)\ -[C++ binary compatibility between Visual Studio versions](../porting/binary-compat-2015-2017.md) +- [Redistribute Visual C++ files](redistributing-visual-cpp-files.md) +- [The latest supported Visual C++ downloads](latest-supported-vc-redist.md) +- [Lifecycle FAQ: Visual C++ Redistributable and Runtime libraries](/lifecycle/faq/visual-c-faq) +- [C++ binary compatibility between Visual Studio versions](../porting/binary-compat-2015-2017.md) diff --git a/docs/windows/redistributing-an-atl-application.md b/docs/windows/redistributing-an-atl-application.md index 84bb01ef68b..4159e2fc0b1 100644 --- a/docs/windows/redistributing-an-atl-application.md +++ b/docs/windows/redistributing-an-atl-application.md @@ -1,39 +1,40 @@ --- -description: "Learn more about: Redistributing an ATL application" -title: "Redistributing an ATL application" +title: Redistribute an ATL Application +description: Learn more about how to redistribute an ATL application. ms.date: "11/04/2016" helpviewer_keywords: ["ATL, redistributing", "redistributing ATL", "redistributing OLE DB templates", "OLE DB templates, redistributing"] ms.assetid: 9a696b22-2345-43ec-826b-be7cb8cfd676 ms.topic: concept-article --- -# Redistributing an ATL application +# Redistribute an ATL application -Starting in Visual Studio 2012, Active Template Library (ATL) is a header-only library. ATL projects do not have a Dynamic Link to ATL option. No redistributable ATL library is required. +Beginning with Visual Studio 2012, Active Template Library (ATL) is a header-only library. ATL projects don't have a dynamic link to an ATL option. No redistributable ATL library is required. -If you redistribute an ATL executable application, you must register the .exe file (and any controls inside it) by issuing the following command: +If you redistribute an ATL executable application, you must register the `.exe` file (and any controls inside it). Use the following command: ``` filename /regserver ``` -where `filename` is the name of the executable file. +The name of the executable file is `filename`. -In Visual Studio 2010, an ATL project can be built for a MinDependency or a MinSize configuration. A MinDependency configuration is what you get when you set the **Use of ATL** property to **Static Link to ATL** on the **General** property page and set the **Runtime Library** property to **Multi-threaded (/MT)** on the **Code Generation** property page (C/C++ folder). +In Visual Studio 2010, you can build an ATL project for a `MinDependency` or a `MinSize` configuration: -A MinSize configuration is what you get when you set the **Use of ATL** property to **Dynamic Link to ATL** on the **General** property page, or set the **Runtime Library** property to **Multi-threaded DLL (/MD)** on the **Code Generation** property page (C/C++ folder). +- To get a `MinDependency` configuration, on the **General** property page, set the **Use of ATL** property to **Static Link to ATL**. On the **Code Generation** property page (C/C++ folder), set the **Runtime Library** property to **Multi-threaded (/MT)**. +- To get a `MinSize` configuration, on the **General** property page, set the **Use of ATL** property to **Dynamic Link to ATL**. Or on the **Code Generation** property page (C/C++ folder), set the **Runtime Library** property to **Multi-threaded DLL (/MD)**. -MinSize makes the output file as small as possible but requires that ATL100.dll and Msvcr100.dll (if you selected the **Multi-threaded DLL (/MD)** option) are on the target computer. ATL100.dll should be registered on the target computer to ensure that all ATL functionality is present. ATL100.dll contains ANSI and Unicode exports. +`MinSize` makes the output file as small as possible but requires that `ATL100.dll` and `Msvcr100.dll` (if you selected the **Multi-threaded DLL (/MD)** option) are on the target computer. Register `ATL100.dll` on the target computer to ensure that all ATL functionality is present. `ATL100.dll` contains ANSI and Unicode exports. -If you build your ATL or OLE DB Templates project for a MinDependency target, you do not need to install and register ATL100.dll on the target computer, although you might get a larger program image. +If you build your ATL or OLE DB templates project for a `MinDependency` target, you don't need to install and register `ATL100.dll` on the target computer, although you might get a larger program image. -If you redistribute an ATL executable application, you must register the .exe file (and any controls inside it) by issuing the following command: +If you redistribute an ATL executable application, you must register the `.exe` file (and any controls inside it). Use the following command: ``` filename /regserver ``` -where `filename` is the name of the executable file. +The name of the executable file is `filename`. -## See also +## Related content -[Redistributing Visual C++ Files](redistributing-visual-cpp-files.md) +- [Redistribute Visual C++ files](redistributing-visual-cpp-files.md) diff --git a/docs/windows/redistributing-components-by-using-merge-modules.md b/docs/windows/redistributing-components-by-using-merge-modules.md index ac04fbfd8d6..4bd201dad02 100644 --- a/docs/windows/redistributing-components-by-using-merge-modules.md +++ b/docs/windows/redistributing-components-by-using-merge-modules.md @@ -1,41 +1,47 @@ --- -description: "Learn more about: Redistributing Components By Using Merge Modules" -title: "Redistributing Components By Using Merge Modules" +title: Redistribute Components by Using Merge Modules +description: Learn more about how to redistribute components by using merge modules. ms.date: 06/08/2022 helpviewer_keywords: ["merge modules, using", "redistributing applications, using merge modules"] ms.assetid: 93b84211-bf9b-4a78-9f22-474ac2ef7840 ms.topic: concept-article --- -# Redistributing components by using merge modules +# Redistribute components by using merge modules > [!IMPORTANT] -> In Visual Studio 2019 and later, merge modules for Visual C++ Redistributable files are deprecated. We don't recommend you use them for application deployment. Redistributables installed using Merge modules can't be updated by Windows Update because the detection mechanism depends on knowing details of the installing package. The Visual C++ Redistributable packages are known for each release, but packages that use MSMs are user generated. Microsoft can't know the details of user-generated packages. Instead, we recommend you use central deployment of the Visual C++ Redistributable package. Central deployment installs the Redistributable files in the Windows *`%SYSTEMROOT%\system32\`* folder for use by all applications and users. Central deployment by a Redistributable package makes it possible for Microsoft to service runtime library files independently. And, an uninstall of your app can't break other applications that also use central deployment. When you use a Redistributable package for central deployment, you aren't responsible for tracking and updating the runtime libraries as part of your application maintenance: The Microsoft Update service updates these libraries for you. Otherwise, an update to the runtime library files requires you to update and redeploy your *`.msi`* installer. Your app could be vulnerable to bugs or security issues until you do. +> In Visual Studio 2019 and later, merge modules for Visual C++ Redistributable files are deprecated. We don't recommend that you use them for application deployment. Windows Update can't update redistributable files installed by using merge modules because the detection mechanism depends on knowing details of the installing package. +> +> The Visual C++ Redistributable packages are known for each release, but packages that use merge modules are user generated. Microsoft can't know the details of user-generated packages. Instead, we recommend that you use central deployment of the Visual C++ Redistributable package. Central deployment installs the redistributable files in the Windows `%SYSTEMROOT%\system32\` folder for use by all applications and users. Central deployment by a redistributable package makes it possible for Microsoft to service runtime library files independently. An uninstall of your app can't break other applications that also use central deployment. +> +> When you use a redistributable package for central deployment, you aren't responsible for tracking and updating the runtime libraries as part of your application maintenance. The Microsoft Update service updates these libraries for you. Otherwise, an update to the runtime library files requires you to update and redeploy your `.msi` installer. Your app could be vulnerable to bugs or security issues until you do. -Visual Studio includes [merge modules](/windows/win32/Msi/about-merge-modules) (*`.msm`* files) for each Visual C++ component that's licensed for redistribution with an application. There are separate versions of the merge modules for each target platform. When a merge module is compiled into a Windows Installer setup file, it enables the deployment of Visual C++ Redistributable files to that specific platform. You can't include merge modules for different versions of the same DLL in one installer. In your installer setup file, specify that the merge modules are prerequisites for your application. +Visual Studio includes [merge modules](/windows/win32/Msi/about-merge-modules) (`.msm` files) for each Visual C++ component that's licensed for redistribution with an application. There are separate versions of the merge modules for each target platform. When a merge module is compiled into a Windows Installer setup file, it enables the deployment of Visual C++ Redistributable files to that specific platform. You can't include merge modules for different versions of the same dynamic-link library (DLL) in one installer. In your installer setup file, specify that the merge modules are prerequisites for your application. -You can use merge modules for either [central deployment](deployment-in-visual-cpp.md#central-deployment) or [local deployment](deployment-in-visual-cpp.md#local-deployment). Users can't install centrally deployed files unless they have administrator rights. Local deployment may allow a non-administrator to install and run your app, but at the cost of independent serviceability. +You can use merge modules for either [central deployment](deployment-in-visual-cpp.md#central-deployment) or [local deployment](deployment-in-visual-cpp.md#local-deployment). Users can't install centrally deployed files unless they have administrator rights. Local deployment might allow a nonadministrator to install and run your app, but at the cost of independent serviceability. The installation service reports an error if you attempt central deployment of older merge modules over newer existing libraries. You should write your installer setup to handle this failure gracefully and not display an error message. Your code can still deploy and run successfully despite this failure. For more information, see [C++ binary compatibility between Visual Studio versions](../porting/binary-compat-2015-2017.md). -If you deploy your code only as an *`.msi`* installer, we recommend you don't include the merge modules in the installer. Instead, report a failure to the user when the required Redistributable libraries aren't found. In the failure dialog, include instructions on how to find and install the latest Redistributable package. For more information and links to Redistributable packages, see [The latest supported Visual C++ downloads](latest-supported-vc-redist.md). +If you deploy your code only as an `.msi` installer, we recommend that you don't include the merge modules in the installer. Instead, report a failure to the user when the required redistributable libraries aren't found. In the failure dialog, include instructions on how to find and install the latest redistributable package. For more information and links to redistributable packages, see [the latest supported Visual C++ downloads](latest-supported-vc-redist.md). -The latest Redistributable packages and merge modules are compatible with code built using Visual Studio 2015 and later. Code built by versions of Visual Studio before 2015 require a separate Redistributable package. +The latest redistributable packages and merge modules are compatible with code built by using Visual Studio 2015 and later. Code built by versions of Visual Studio before 2015 require a separate redistributable package. ## When to use merge modules -Merge modules are only appropriate in limited circumstances: +Merge modules are appropriate only in limited circumstances: -- You can't install or require a separate Redistributable package for policy reasons, -- Your code requires a specific, bug-compatible version of the libraries, -- Your code only targets one platform, and you don't have dependencies on more than one version of the DLLs, -- You intend to service your deployed code regularly, so the libraries remain up to date. +- You can't install or require a separate redistributable package for policy reasons. +- Your code requires a specific, bug-compatible version of the libraries. +- Your code targets only one platform, and you don't have dependencies on more than one version of the DLLs. +- You intend to service your deployed code regularly so that the libraries remain up to date. When you use merge modules, you must track and regularly service your application with library updates. Otherwise, you eventually force your clients to choose between running your code or remaining secure. ## Where to find merge module files -In Visual Studio 2022 and 2019, merge module files are part of an optional installable component named **C++ \ Redistributable MSMs** in the Visual Studio Installer. The merge modules are installed by default as part of a C++ install in Visual Studio 2017 and Visual Studio 2015. When installed in Visual Studio 2022, you'll find the Visual C++ Redistributable merge modules in *`%VCINSTALLDIR%Redist\MSVC\v143\MergeModules`*. In the latest version of Visual Studio 2019, the merge modules are in *`%VCINSTALLDIR%Redist\MSVC\v142\MergeModules`*. In both Visual Studio 2019 and Visual Studio 2017, they're also found in *`%VCToolsRedistDir%MergeModules`*. In Visual Studio 2015, they're found in *`Program Files [(x86)]\Common Files\Merge Modules`*. For more information and a link to a list of Redistributable merge modules, see [Redistributing Visual C++ files](redistributing-visual-cpp-files.md). +In Visual Studio 2022 and 2019, merge module files are part of an optional installable component named **C++ \ Redistributable MSM** in the Visual Studio Installer. The merge modules are installed by default as part of a C++ installation in Visual Studio 2017 and Visual Studio 2015. When the merge modules are installed in Visual Studio 2022, you can find the Visual C++ Redistributable merge modules in `%VCINSTALLDIR%Redist\MSVC\v143\MergeModules`. -## See also +In the latest version of Visual Studio 2019, the merge modules are in `%VCINSTALLDIR%Redist\MSVC\v142\MergeModules`. In both Visual Studio 2019 and Visual Studio 2017, they're also found in `%VCToolsRedistDir%MergeModules`. In Visual Studio 2015, they're found in `Program Files [(x86)]\Common Files\Merge Modules`. For more information and a link to a list of redistributable merge modules, see [Redistribute Visual C++ files](redistributing-visual-cpp-files.md). -[Redistributing Visual C++ files](redistributing-visual-cpp-files.md) +## Related content + +- [Redistribute Visual C++ files](redistributing-visual-cpp-files.md) diff --git a/docs/windows/redistributing-the-mfc-library.md b/docs/windows/redistributing-the-mfc-library.md index c01f4c38d38..2584fad3b84 100644 --- a/docs/windows/redistributing-the-mfc-library.md +++ b/docs/windows/redistributing-the-mfc-library.md @@ -1,44 +1,49 @@ --- -description: "Learn more about: Redistributing the MFC Library" -title: "Redistributing the MFC Library" +title: Redistribute the MFC Library +description: Learn more about how to redistribute the MFC Library. ms.date: "11/04/2016" helpviewer_keywords: ["MFC, redistributing", "redistributing MFC library"] ms.assetid: 72714ce1-385e-4c1c-afa5-96b03e873866 ms.topic: concept-article --- -# Redistributing the MFC Library -If you dynamically link your application to the MFC library, you must redistribute the matching MFC DLL. For example, if your MFC app is built by using the version of MFC that ships with Visual Studio 2015, you must redistribute mfc140.dll or mfc140u.dll, depending on whether your app is compiled for narrow characters or Unicode support. +# Redistribute the MFC Library + +If you dynamically link your application to the Microsoft Foundation Class (MFC) Library, you must redistribute the matching MFC dynamic-link library (DLL). For example, if your MFC app is built by using the version of MFC that ships with Visual Studio 2015, you must redistribute `mfc140.dll` or `mfc140u.dll`, depending on whether your app is compiled for narrow characters or Unicode support. > [!NOTE] -> The mfc140.dll files were omitted from the redistributable files directory in Visual Studio 2015 RTM. You can use the versions installed by Visual Studio 2015 in the Windows\system32 and Windows\syswow64 directories instead. +> The `mfc140.dll` files were omitted from the redistributable files directory in Visual Studio 2015 RTM. You can use the versions installed by Visual Studio 2015 in the `Windows\system32 and Windows\syswow64` directories instead. + +Because all MFC DLLs use the shared version of the Microsoft C Runtime (CRT) library, you might also need to redistribute the CRT. The version of MFC that ships with Visual Studio 2015 uses the Universal CRT library, which is distributed as part of Windows 10 and Windows 11. To run an MFC application built by using Visual Studio 2015 on earlier versions of Windows, you must redistribute the Universal CRT. + +For information on how to redistribute the Universal CRT as an operating system component or by using local deployment, see [Introducing the Universal CRT](https://devblogs.microsoft.com/cppblog/introducing-the-universal-crt/). To download the Universal CRT for central deployment on supported versions of Windows, see [Windows 10 Universal CRT](https://www.microsoft.com/download/details.aspx?id=48234). -Because all MFC DLLs use the shared version of the C runtime library (CRT), You may also need to redistribute the CRT. The version of MFC that ships with Visual Studio 2015 uses the universal CRT library, which is distributed as part of Windows 10 and Windows 11. To run an MFC application built by using Visual Studio 2015 on earlier versions of Windows, you must redistribute the Universal CRT. For information on how to redistribute the universal CRT as an operating system component or by using local deployment, see [Introducing the Universal CRT](https://devblogs.microsoft.com/cppblog/introducing-the-universal-crt/). To download the universal CRT for central deployment on supported versions of Windows, see [Windows 10 Universal C Runtime](https://www.microsoft.com/download/details.aspx?id=48234). Redistributable architecture-specific versions of ucrtbase.dll for local deployment are found in the Windows SDK. By default, Visual Studio installs these in C:\Program Files (x86)\Windows Kits\10\Redist\ucrt\DLLs\ in an architecture-specific sub-directory. +You can find redistributable architecture-specific versions of `ucrtbase.dll` for local deployment in the Windows SDK. By default, Visual Studio installs these versions in `C:\Program Files (x86)\Windows Kits\10\Redist\ucrt\DLLs\` in an architecture-specific subdirectory. -If your app is built by using an earlier version of the MFC library, you must redistribute the matching CRT DLL from the redistributable files directory. For example, if your MFC application is built by using the Visual Studio 2013 (vc120) toolset, you must redistribute the msvcr120.dll. You also have to redistribute the matching mfc``u.dll or mfc``.dll. +If your app is built by using an earlier version of the MFC Library, you must redistribute the matching CRT DLL from the redistributable files directory. For example, if your MFC application is built by using the Visual Studio 2013 (vc120) toolset, you must redistribute the `msvcr120.dll`. You also have to redistribute the matching `mfcu.dll` or `mfc.dll`. -If you statically link your application to MFC (that is, if you specify **Use MFC in a Static Library** on the **General** tab in the **Property Pages** dialog box), you do not have to redistribute an MFC DLL. However, although static linking may work for testing and internal deployment of applications, we recommend that you do not use it to redistribute MFC. For more information about the recommended strategies for deploying Visual C++ libraries, see [Choosing a Deployment Method](choosing-a-deployment-method.md). +If you statically link your application to MFC (in the **Property Pages** dialog, on the **General** tab, select **Use MFC in a Static Library**), you don't have to redistribute an MFC DLL. Although static linking might work for testing and internal deployment of applications, we recommend that you don't use it to redistribute MFC. For more information about the recommended strategies for deploying Visual C++ libraries, see [Choose a deployment method](choosing-a-deployment-method.md). -If your application uses the MFC classes that implement the WebBrowser control (for example, [CHtmlView Class](../mfc/reference/chtmlview-class.md) or [CHtmlEditView Class](../mfc/reference/chtmleditview-class.md)), we recommend that you also install the most current version of Microsoft Internet Explorer so that the target computer will have the most current common control files. (At a minimum, Internet Explorer 4.0 is required.) Information about how to install Internet Explorer components is available in "Article 185375: How To Create a Single EXE Install of Internet Explorer" on the Microsoft Support website. +If your application uses the MFC classes that implement the WebBrowser control (for example, [CHtmlView class](../mfc/reference/chtmlview-class.md) or [CHtmlEditView class](../mfc/reference/chtmleditview-class.md)), we recommend that you also install the most current version of Internet Explorer so that the target computer has the most current common control files. (At a minimum, Internet Explorer 4.0 is required.) Information about how to install Internet Explorer components is available in [Article 185375: How to Create a Single EXE Install of Internet Explorer](https://helparchive.huntertur.net/document/95742). -If your application uses the MFC database classes (for example, [CRecordset Class](../mfc/reference/crecordset-class.md) and [CRecordView Class](../mfc/reference/crecordview-class.md)), you must redistribute ODBC and any ODBC drivers that your application uses. +If your application uses the MFC database classes (for example, [CRecordset class](../mfc/reference/crecordset-class.md) and [CRecordView class](../mfc/reference/crecordview-class.md)), you must redistribute Open Database Connectivity (ODBC) and any ODBC drivers that your application uses. -If your MFC application uses Windows Forms controls, you must redistribute mfcmifc80.dll with your application. This DLL is a strong-name-signed .NET assembly that can be redistributed with an application in its application local folder or by deploying it to the Global Assembly Cache (GAC) by using the [Gacutil.exe (Global Assembly Cache Tool)](/dotnet/framework/tools/gacutil-exe-gac-tool). +If your MFC application uses Windows Forms controls, you must redistribute `mfcmifc80.dll` with your application. This DLL is a strong-name-signed .NET assembly. You can redistribute it with an application in its application local folder. You can also deploy it to the Global Assembly Cache (GAC) by using the [Gacutil.exe (Global Assembly Cache Tool)](/dotnet/framework/tools/gacutil-exe-gac-tool). -If you redistribute an MFC DLL, make sure to redistribute the retail version and not the debug version. Debug versions of the DLLs are not redistributable. The names of debug versions of the MFC DLLs end with a "d", for example, Mfc140d.dll. +If you redistribute an MFC DLL, make sure to redistribute the retail version and not the debug version. Debug versions of the DLLs aren't redistributable. The names of debug versions of the MFC DLLs end with a "d"; for example, `Mfc140d.dll`. -You can redistribute MFC by using either VCRedist_*architecture*.exe, merge modules that are installed with Visual Studio, or by deploying the MFC DLL to the same folder as your application. For more information about how to redistribute MFC, see [Redistributing Visual C++ Files](redistributing-visual-cpp-files.md). +You can redistribute MFC by using either `VCRedist_*architecture*.exe` or merge modules that are installed with Visual Studio. You can also deploy the MFC DLL to the same folder as your application. For more information about how to redistribute MFC, see [Redistribute Visual C++ files](redistributing-visual-cpp-files.md). -## Installation of Localized MFC Components +## Installation of localized MFC components -If you decide to localize your application by installing an MFC localization DLL, you must use the redistributable merge files (.msm). For example, if you want to localize your application on an x86 computer, you must merge Microsoft_VC``_MFCLOC_x86.msm into the installation package for an x86 computer. +If you decide to localize your application by installing an MFC localization DLL, you must use the redistributable merge files (`.msm`). For example, if you want to localize your application on an x86 computer, you must merge `Microsoft_VC_MFCLOC_x86.msm` into the installation package for an x86 computer. -The redistributable .msm files contain the DLLs that are used for localization. There is one DLL for each supported language. The installation process installs these DLLs in the %windir%\system32\ folder on the target computer. +The redistributable `.msm` files contain the DLLs that are used for localization. There's one DLL for each supported language. The installation process installs these DLLs in the `%windir%\system32\` folder on the target computer. -For more information about how to localize MFC applications, see [TN057: Localization of MFC Components](../mfc/tn057-localization-of-mfc-components.md). +For more information about how to localize MFC applications, see [TN057: Localization of MFC components](../mfc/tn057-localization-of-mfc-components.md). -You can redistribute MFC localization DLLs by deploying the MFC DLL in your application local folder. For more information about how to redistribute Visual C++ libraries, see [Redistributing Visual C++ Files](redistributing-visual-cpp-files.md). +You can redistribute MFC localization DLLs by deploying the MFC DLL in your application local folder. For more information about how to redistribute Visual C++ libraries, see [Redistribute Visual C++ files](redistributing-visual-cpp-files.md). -## See also +## Related content -[Redistributing Visual C++ Files](redistributing-visual-cpp-files.md) +- [Redistribute Visual C++ files](redistributing-visual-cpp-files.md) diff --git a/docs/windows/redistributing-visual-cpp-activex-controls.md b/docs/windows/redistributing-visual-cpp-activex-controls.md index f28244442a2..f28e3df2398 100644 --- a/docs/windows/redistributing-visual-cpp-activex-controls.md +++ b/docs/windows/redistributing-visual-cpp-activex-controls.md @@ -1,38 +1,36 @@ --- -description: "Learn more about: Redistributing Visual C++ ActiveX Controls" -title: "Redistributing Visual C++ ActiveX Controls" +title: Redistribute Visual C++ ActiveX Controls +description: Learn more about how to redistribute Visual C++ ActiveX controls. ms.date: "11/04/2016" helpviewer_keywords: ["controls [C++], redistributing", "controls [C++], distributing"] ms.assetid: eefbb7e4-d28c-4c35-98bf-d9540cfaae83 ms.topic: concept-article --- -# Redistributing Visual C++ ActiveX Controls +# Redistribute Visual C++ ActiveX controls -Visual C++ 6.0 supplies ActiveX controls you can use in applications that you then redistribute. These controls are no longer included in Visual C++. Per the licensing agreements for Visual C++ 6.0, you can redistribute these controls with applications developed in Visual C++. +Visual C++ 6.0 supplies ActiveX controls that you can use in applications that you then redistribute. These controls are no longer included in Visual C++. According to the licensing agreements for Visual C++ 6.0, you can redistribute these controls with applications developed in Visual C++. > [!NOTE] > Visual C++ 6.0 is no longer supported by Microsoft. -For a list of the redistributable Visual C++ 6.0 ActiveX controls, see Common\Redist\Redist.txt on Disc 1 of the Visual C++ 6.0 product CD. +For a list of the redistributable Visual C++ 6.0 ActiveX controls, see `Common\Redist\Redist.txt` on Disc 1 of the Visual C++ 6.0 product CD. -When distributing applications, you must install and register the `.ocx` for the ActiveX control (using Regsvr32.exe). In addition, you should make sure the target computer has current versions of the following system files (an asterisk indicates the file needs to be registered): +When you distribute applications, you must install and register the `.ocx` for the ActiveX control (by using `Regsvr32.exe`). The target computer also must have current versions of the following system files. (An asterisk indicates that the file must be registered.) -- Asycfilt.dll +- `Asycfilt.dll` +- `Comcat.dll`\* +- `Oleaut32.dll`\* +- `Olepro32.dll`\* +- `Stdole2.tlb` -- Comcat.dll \* +If these dynamic-link libraries (DLLs) aren't available on the target system, you must get them updated by using the prescribed mechanism for updating the corresponding operating system. -- Oleaut32.dll \* +When you use an ActiveX control that connects to a database, you also need to replicate the data source name on the target computer. You can do this task programmatically with functions such as `ConfigDSN`. -- Olepro32.dll \* +Some redistributable ActiveX controls have more dependencies. For each `.ocx` file in the Os\System folder on the Visual C++ 6.0 product CD, there's also a `.dep` file. For each `.ocx` file that you want to redistribute, look for one or more USES entries in the corresponding `.dep` file. -- Stdole2.tlb +If a file is listed, you must ensure that the file is on the target computer. Any DLLs directly supporting an `.ocx` file must be registered. (For `Regsvr32.exe` to succeed, the target computer must first contain all the DLLs that the control statically loads.) Also, if a DLL that's listed as a dependency also has a `.dep` file in the Os\System folder on the Visual C++ 6.0 CD, you must also investigate that `.dep` file for USES entries. -If these DLLs are not available on the target system, you need to get them updated using the prescribed mechanism for updating the corresponding operating system. +## Related content -When using an ActiveX control that connects to a database, you also need to replicate the data source name on the target computer. You can do this programmatically with functions such as `ConfigDSN`. - -Some redistributable ActiveX controls have additional dependencies. For each `.ocx` file in the Os\System folder on the Visual C++ 6.0 product CD, there is also a `.dep` file. For each `.ocx` file that you want to redistribute, look for one or more USES entries in the corresponding `.dep` file. If a file is listed, you must ensure that the file is on the target computer. Any DLLs directly supporting an `.ocx` file need to be registered. (For Regsvr32.exe to succeed, the target computer must first contain all of the DLLs the control statically loads.) Furthermore, if a DLL that is listed as a dependency also has a `.dep` file in the Os\System folder on the Visual C++ 6.0 CD, you must also investigate that `.dep` file for USES entries. - -## See also - -[Redistributing Visual C++ Files](redistributing-visual-cpp-files.md) +- [Redistribute Visual C++ files](redistributing-visual-cpp-files.md) diff --git a/docs/windows/redistributing-visual-cpp-files.md b/docs/windows/redistributing-visual-cpp-files.md index f96f06bd799..15d2a671fca 100644 --- a/docs/windows/redistributing-visual-cpp-files.md +++ b/docs/windows/redistributing-visual-cpp-files.md @@ -1,66 +1,82 @@ --- -title: "Redistributing Visual C++ Files" -description: "Visual Studio includes Redistributable libraries and components you can deploy with your app." -ms.date: 01/15/2025 +title: Redistribute Visual C++ Files +description: Learn about Visual Studio Redistributable libraries and components that you can deploy with your app. +ms.date: 04/13/2026 helpviewer_keywords: ["application deployment [C++], file redistributing", "redistributing applications [C++]", "deploying applications [C++], file redistributing", "file redistribution [C++]", "redistributing applications [C++], about redistributing applications"] ms.topic: concept-article --- -# Redistributing Visual C++ Files +# Redistribute Visual C++ files > [!NOTE] -> Are you here because you're looking for a download of one of the Visual C++ Runtime files? Go to the [Latest supported Visual C++ Redistributable downloads](latest-supported-vc-redist.md) page. +> Are you here because you're looking for a download of one of the Visual C++ Runtime files? Go to the [latest supported Visual C++ Redistributable downloads](latest-supported-vc-redist.md) page. ## Redistributable files and licensing -Distribution of the Visual C++ Runtime Redistributable package, merge modules, and individual binaries is limited to licensed Visual Studio users and is subject to such License Terms. +Distribution of the Visual C++ Runtime Redistributable package, merge modules, and individual binaries is limited to licensed Visual Studio users and is subject to Microsoft Software License Terms. -When you deploy an application, you must also deploy the files that are required to support it. If any of these files are provided by Microsoft, check whether you're permitted to redistribute them. You'll find a link to the Visual Studio license terms in the IDE. Use the License terms link in the About Microsoft Visual Studio dialog box. Or, download the relevant EULAs and licenses from the Visual Studio [License Directory](https://visualstudio.microsoft.com/license-terms/). +When you deploy an application, you must also deploy the files that are required to support it. If Microsoft provides any of these files, check whether you're permitted to redistribute them. You can find a link to the Visual Studio license terms in the IDE. In the **About Microsoft Visual Studio** dialog, select the **License Terms** link. You can also download the relevant Microsoft Software License Terms and licenses from the Visual Studio [License Directory](https://visualstudio.microsoft.com/license-terms/). ::: moniker range="msvc-170" -To view the "REDIST list" that's referenced in the "Distributable Code" section of the Visual Studio 2022 Microsoft Software License Terms, see [Distributable code files for Microsoft Visual Studio 2022](/visualstudio/releases/2022/redistribution#-distributable-code-files-for-visual-studio-2022) +To view the "REDIST list" that's referenced in the "Distributable Code" section of the Visual Studio 2022 Microsoft Software License Terms, see [Distributable code files for Microsoft Visual Studio 2022](/visualstudio/releases/2022/redistribution#-distributable-code-files-for-visual-studio-2022). ::: moniker-end ::: moniker range="msvc-160" -To view the "REDIST list" that's referenced in the "Distributable Code" section of the Visual Studio 2019 Microsoft Software License Terms, see [Distributable Code Files for Microsoft Visual Studio 2019](/visualstudio/releases/2019/redistribution#-distributable-code-files-for-visual-studio-2019) +To view the "REDIST list" that's referenced in the "Distributable Code" section of the Visual Studio 2019 Microsoft Software License Terms, see [Distributable code files for Microsoft Visual Studio 2019](/visualstudio/releases/2019/redistribution#-distributable-code-files-for-visual-studio-2019). ::: moniker-end ::: moniker range="msvc-150" -To view the "REDIST list" that's referenced in the "Distributable Code" section of the Visual Studio 2017 Microsoft Software License Terms, see [Distributable Code Files for Microsoft Visual Studio 2017](/visualstudio/productinfo/2017-redistribution-vs#-distributable-code-files-for-visual-studio-2017). +To view the "REDIST list" that's referenced in the "Distributable Code" section of the Visual Studio 2017 Microsoft Software License Terms, see [Distributable code files for Microsoft Visual Studio 2017](/visualstudio/productinfo/2017-redistribution-vs#-distributable-code-files-for-visual-studio-2017). ::: moniker-end ::: moniker range="msvc-140" -To view the "REDIST list" that's referenced in the "Distributable Code" section of the Visual Studio 2015 Microsoft Software License Terms, see [Distributable Code Files for Microsoft Visual Studio 2015](/visualstudio/productinfo/2015-redistribution-vs#-distributable-code-files-for-visual-studio-2015). +To view the "REDIST list" that's referenced in the "Distributable Code" section of the Visual Studio 2015 Microsoft Software License Terms, see [Distributable code files for Microsoft Visual Studio 2015](/visualstudio/productinfo/2015-redistribution-vs#-distributable-code-files-for-visual-studio-2015). ::: moniker-end -For more information about redistributable files, see [Determining which DLLs to redistribute](determining-which-dlls-to-redistribute.md) and [Deployment examples](deployment-examples.md). +For more information about redistributable files, see [Determine which dynamic-link libraries (DLLs) to redistribute](determining-which-dlls-to-redistribute.md) and [Deployment examples](deployment-examples.md). ## Locate the redistributable files -To deploy redistributable files, you can use the redistributable packages installed by Visual Studio. In versions of Visual Studio since 2017, these files are named *`vc_redist.arm64.exe`*, *`vc_redist.x64.exe`*, and *`vc_redist.x86.exe`*. In Visual Studio 2015, 2017, and 2019, they're also available under the names *`vcredist_x86.exe`*, *`vcredist_x64.exe`*, and (2015 only) *`vcredist_arm.exe`*. +To deploy redistributable files, you can use the redistributable packages installed by Visual Studio. In versions of Visual Studio since 2017, these files are named `vc_redist.arm64.exe`, `vc_redist.x64.exe`, and `vc_redist.x86.exe`. In Visual Studio 2015, 2017, and 2019, they're also available under the names `vcredist_x86.exe`, `vcredist_x64.exe`, and (2015 only) `vcredist_arm.exe`. -The easiest way to locate the redistributable files is by using environment variables set in a developer command prompt. In Visual Studio 2022, the redistributable files are in the *`%VCINSTALLDIR%Redist\MSVC\v143`* folder. In the latest version of Visual Studio 2019, you'll find the redistributable files in the *`%VCINSTALLDIR%Redist\MSVC\v142`* folder. In both Visual Studio 2017 and Visual Studio 2019, they're also found in *`%VCToolsRedistDir%`*. In Visual Studio 2015, these files can be found in *`%VCINSTALLDIR%redist\`*, where *``* is the locale of the redistributable packages. +The easiest way to locate the redistributable files is by using environment variables set in a developer command prompt. In Visual Studio 2022, the redistributable files are in the `%VCINSTALLDIR%Redist\MSVC\v143` folder. In the latest version of Visual Studio 2019, you can find the redistributable files in the `%VCINSTALLDIR%Redist\MSVC\v142` folder. In both Visual Studio 2017 and Visual Studio 2019, the files are also found in `%VCToolsRedistDir%`. In Visual Studio 2015, you can find these files in `%VCINSTALLDIR%redist\`, where `` is the locale of the redistributable packages. -In Visual Studio 2022 and 2019, merge module files are part of an optional installable component named **C++ \ Redistributable MSMs** in the Visual Studio Installer. The merge modules are installed by default as part of a C++ install in Visual Studio 2017 and Visual Studio 2015. When installed in Visual Studio 2022, you'll find the redistributable merge modules in *`%VCINSTALLDIR%Redist\MSVC\v143\MergeModules`*. In the latest version of Visual Studio 2019, the redistributable merge modules are in *`%VCINSTALLDIR%Redist\MSVC\v142\MergeModules`*. In both Visual Studio 2019 and Visual Studio 2017, they're also found in *`%VCToolsRedistDir%MergeModules`*. In Visual Studio 2015, they're found in *`Program Files [(x86)]\Common Files\Merge Modules`*. +In Visual Studio 2022 and 2019, merge module files are part of an optional installable component named *Visual C++ \ Redistributable merge modules* in the Visual Studio Installer. The merge modules are installed by default as part of a C++ install in Visual Studio 2017 and Visual Studio 2015. When they're installed in Visual Studio 2022, you can find the redistributable merge modules in `%VCINSTALLDIR%Redist\MSVC\v143\MergeModules`. + +In the latest version of Visual Studio 2019, the redistributable merge modules are found in `%VCINSTALLDIR%Redist\MSVC\v142\MergeModules`. In both Visual Studio 2019 and Visual Studio 2017, they're also found in `%VCToolsRedistDir%MergeModules`. In Visual Studio 2015, they're found in `Program Files [(x86)]\Common Files\Merge Modules`. ## Install the redistributable packages -The Visual C++ Redistributable Packages install and register all Visual C++ libraries. If you use one, run it as a prerequisite on the target system before you install your application. We recommend that you use these packages for your deployments because they enable automatic updating of the Visual C++ libraries. For an example about how to use these packages, see [Walkthrough: Deploying a Visual C++ Application By Using the Visual C++ Redistributable Package](deploying-visual-cpp-application-by-using-the-vcpp-redistributable-package.md). +The Visual C++ Redistributable packages install and register all Visual C++ libraries. If you use one, run it as a prerequisite on the target system before you install your application. We recommend that you use these packages for your deployments because they enable automatic updating of the Visual C++ libraries. For an example that shows how to use these packages, see [Walkthrough: Deploy a Visual C++ application by using the Visual C++ Redistributable package](deploying-visual-cpp-application-by-using-the-vcpp-redistributable-package.md). + +Each Visual C++ Redistributable package checks for the existence of a more recent version on the machine. If a more recent version is found, the package isn't installed. In Visual Studio 2015 or later, redistributable packages display an error message stating that setup failed. If a package uses the `/quiet` flag to run, no error message appears. In either case, the Microsoft installer logs the error, and an error result is returned to the caller. + +In Visual Studio 2015 and later, you can avoid this error by checking the registry to find out if a more recent version is installed. The current installed version number is stored in the `HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\VisualStudio\14.0\VC\Runtimes\{x86|x64|arm64}` key. + +The version number is 14.0 for Visual Studio 2015, 2017, 2019, and 2022 because the latest Redistributable is binary compatible with previous versions back to 2015. The key is `arm64`, `x86`, or `x64` depending on the installed `vcredist` versions for the platform. (You need to check under the `Wow6432Node` subkey only if you use Regedit to view the version of the installed x86 package on an x64 platform.) + +The version number is stored in the `REG_SZ` string value `Version` and also in the set of `Major`, `Minor`, `Bld`, and `Rbld` `REG_DWORD` values. To avoid an error at installation time, you must skip installation of the redistributable package if the currently installed version is more recent. + +### Command-line options for the redistributable packages -Each Visual C++ Redistributable package checks for the existence of a more recent version on the machine. If a more recent version is found, the package won't get installed. In Visual Studio 2015 or later, Redistributable packages display an error message stating that setup failed. If a package is run by using the **`/quiet`** flag, no error message is displayed. In either case, an error is logged by the Microsoft installer, and an error result is returned to the caller. In Visual Studio 2015 and later, you can avoid this error by checking the registry to find out if a more recent version is installed. The current installed version number is stored in the **`HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\VisualStudio\14.0\VC\Runtimes\{x86|x64|arm64}`** key. The version number is 14.0 for Visual Studio 2015, 2017, 2019, and 2022 because the latest Redistributable is binary compatible with previous versions back to 2015. The key is `arm64`, `x86`, or `x64` depending on the installed vcredist versions for the platform. (You need to check under the `Wow6432Node` subkey only if you're using Regedit to view the version of the installed x86 package on an x64 platform.) The version number is stored in the `REG_SZ` string value **`Version`** and also in the set of **`Major`**, **`Minor`**, **`Bld`**, and **`Rbld`** `REG_DWORD` values. To avoid an error at install time, you must skip installation of the Redistributable package if the currently installed version is more recent. +The Visual C++ Redistributable supports several command-line options. The `/?`, `/h`, or `/help` options display a dialog that lists the available options. You can specify `/install` to install, `/repair` to repair, or `/uninstall` to uninstall the Redistributable. The `/layout` option copies the complete contents of the Redistributable in the current directory. -### Command-line options for the Redistributable packages +By default, the Redistributable installs its contents and prompts the user for information and whether to restart after installation. You can modify this behavior with the following options: +- `/passive`: shows a progress bar as the Redistributable installs but doesn't otherwise require user interaction. +- `/quiet`: doesn't display a user interface or require any user interaction. Use `/quiet` for fully unattended installations. +- `/norestart`: suppresses any attempts to restart. By default, a log file is created in `%TEMP%`. +- `/log filename.txt` to log to a specific file. -The Visual C++ Redistributable supports several command-line options. The `/?`, `/h`, or `/help` options display a pop-up dialog that lists the available options. You may specify `/install` to install, `/repair` to repair, or `/uninstall` to uninstall the Redistributable. The `/layout` option copies the complete contents of the Redistributable in the current directory. By default, the Redistributable installs its contents and prompts the user for information and whether to restart after installation. You can specify the `/passive` option, which displays progress, but doesn't otherwise require user interaction. You can also specify a `/quiet` option, which doesn't display any UI or require any user interaction. The `/norestart` option suppresses any attempts to restart. By default, a log file is created in *`%TEMP%`*. You can use `/log filename.txt` to log to a specific file. +If you aren't running from an elevated command prompt, you'll need to respond to a User Account Control prompt to allow the installer to run with administrative privileges. -This example command installs the x64 Redistributable. It shows installation progress, but doesn't require user interaction or a restart: +This example command installs the x64 Redistributable. It shows installation progress but doesn't require user interaction aside from a restart: ```cmd vc_redist.x64.exe /install /passive /norestart @@ -69,39 +85,28 @@ vc_redist.x64.exe /install /passive /norestart ## Install the redistributable merge modules > [!IMPORTANT] -> Merge modules (*`.msm`* files) for Visual C++ Redistributable files are deprecated. We don't recommend you use them for application deployment. Instead, we recommend central deployment of the Visual C++ Redistributable package. Central deployment by a Redistributable package makes it possible for Microsoft to service runtime library files independently. And, an uninstall of your app can't affect other applications that also use central deployment. When you use a Redistributable package for central deployment, you aren't responsible for tracking and maintaining the runtime libraries. Otherwise, an update to the runtime library files requires you to update and redeploy your *`.msi`* installer. Your app could be vulnerable to bugs or security issues until you do. +> Merge modules (`.msm` files) for Visual C++ Redistributable files are deprecated. We don't recommend that you use them for application deployment. Instead, we recommend central deployment of the Visual C++ Redistributable package. Central deployment by a redistributable package makes it possible for Microsoft to service runtime library files independently. An uninstall of your app can't affect other applications that also use central deployment. +> +> When you use a redistributable package for central deployment, you aren't responsible for tracking and maintaining the runtime libraries. Otherwise, an update to the runtime library files requires you to update and redeploy your *`.msi`* installer. Your app could be vulnerable to bugs or security issues until you do. -Redistributable merge modules must be included in the Windows Installer package (or similar installation package) that you use to deploy your application. For more information, see [Redistributing by using merge modules](redistributing-components-by-using-merge-modules.md). For an example see [Walkthrough: Deploying a Visual C++ application by using a setup project](walkthrough-deploying-a-visual-cpp-application-by-using-a-setup-project.md). +Redistributable merge modules must be included in the Windows Installer package (or similar installation package) that you use to deploy your application. For more information, see [Redistribute by using merge modules](redistributing-components-by-using-merge-modules.md). For an example, see [Walkthrough: Deploy a Visual C++ application by using a setup project](walkthrough-deploying-a-visual-cpp-application-by-using-a-setup-project.md). ## Install individual redistributable files -It's also possible to directly install the Redistributable DLLs in the *application local folder*. The application local folder is the folder that contains your executable application file. For servicing reasons, we don't recommend you use this installation location. - -## Potential run-time errors - -If Windows can't find one of the Redistributable library DLLs required by your application, it may display a message similar to: "This application has failed to start because *library*.dll was not found. Reinstalling the application may fix this problem." - -To resolve this kind of error, make sure your application installer builds correctly. Verify that the Redistributable libraries get deployed correctly on the target system. For more information, see [Understanding the Dependencies of a Visual C++ Application](understanding-the-dependencies-of-a-visual-cpp-application.md). - -## Related articles - -[Redistributing by using merge modules](redistributing-components-by-using-merge-modules.md)\ -Describes how to use Visual C++ Redistributable merge modules to install the Visual C++ runtime libraries as shared DLLs in the *`%windir%\system32\`* folder. - -[Redistributing Visual C++ ActiveX Controls](redistributing-visual-cpp-activex-controls.md)\ -Describes how to redistribute an application that uses ActiveX Controls. +It's also possible to directly install the Redistributable DLLs in the *application local folder*. The application local folder is the folder that contains your executable application file. For servicing reasons, we don't recommend that you use this installation location. -[Redistributing the MFC Library](redistributing-the-mfc-library.md)\ -Describes how to redistribute an application that uses MFC. +## Potential runtime errors -[Redistributing an ATL application](redistributing-an-atl-application.md)\ -Describes how to redistribute an application that uses ATL. In Visual Studio 2012 and later, no ATL library is required. +If Windows can't find one of the Redistributable DLLs required by your application, it might display a message similar to this one: "This application has failed to start because *library*.dll was not found. Reinstalling the application may fix this problem." -[Deployment Examples](deployment-examples.md)\ -Links to examples that demonstrate how to deploy Visual C++ applications. +To resolve this kind of error, make sure that your application installer builds correctly. Verify that the redistributable libraries get deployed correctly on the target system. For more information, see [Understand the dependencies of a Visual C++ application](understanding-the-dependencies-of-a-visual-cpp-application.md). -[Deploying Desktop Applications](deploying-native-desktop-applications-visual-cpp.md)\ -Introduces Visual C++ deployment concepts and technologies. +## Related content -[Latest supported Visual C++ Redistributable downloads](latest-supported-vc-redist.md)\ -Links to the latest supported Visual C++ Redistributable downloads. \ No newline at end of file +- [Redistribute by using merge modules](redistributing-components-by-using-merge-modules.md) describes how to use Visual C++ Redistributable merge modules to install the Visual C++ Runtime libraries as shared DLLs in the `%windir%\system32\` folder. +- [Redistribute Visual C++ ActiveX controls](redistributing-visual-cpp-activex-controls.md) describes how to redistribute an application that uses ActiveX controls. +- [Redistribute the Microsoft Foundation Class (MFC) Library](redistributing-the-mfc-library.md) describes how to redistribute an application that uses MFC. +- [Redistribute an Active Template Library (ATL) application](redistributing-an-atl-application.md) describes how to redistribute an application that uses an ATL. In Visual Studio 2012 and later, no ATL library is required. +- [Deployment examples](deployment-examples.md) links to examples that demonstrate how to deploy Visual C++ applications. +- [Deploy desktop applications](deploying-native-desktop-applications-visual-cpp.md) introduces Visual C++ deployment concepts and technologies. +- [Latest supported Visual C++ Redistributable downloads](latest-supported-vc-redist.md) links to the latest supported Visual C++ Redistributable downloads. diff --git a/docs/windows/toc.yml b/docs/windows/toc.yml index a8a74ff2d76..7afc39d94e9 100644 --- a/docs/windows/toc.yml +++ b/docs/windows/toc.yml @@ -120,11 +120,11 @@ items: items: - name: Deploy native desktop applications href: ../windows/deploying-native-desktop-applications-visual-cpp.md - - name: Deployment in Visual C++ + - name: Deployment in Microsoft C++ href: ../windows/deployment-in-visual-cpp.md - name: Deployment Concepts href: ../windows/deployment-concepts.md - - name: Understand the dependencies of a Visual C++ application + - name: Understand the dependencies of a Microsoft C++ application href: ../windows/understanding-the-dependencies-of-a-visual-cpp-application.md - name: Determine which DLLs to redistribute href: ../windows/determining-which-dlls-to-redistribute.md @@ -132,7 +132,7 @@ items: href: ../windows/choosing-a-deployment-method.md - name: Universal CRT deployment href: ../windows/universal-crt-deployment.md - - name: Redistribute Visual C++ Files + - name: Redistribute Microsoft C++ Files expanded: false items: - name: Redistribute Visual C++ Files @@ -149,22 +149,24 @@ items: href: ../windows/latest-supported-vc-redist.md - name: How to audit Visual C++ Runtime version usage href: ../windows/redist-version-auditing.md + - name: Troubleshoot Visual C++ Redistributable installation issues + href: ../windows/troubleshoot-vc-redistributable-installation-issues.md - name: Deployment examples expanded: false items: - name: Deployment examples href: ../windows/deployment-examples.md - - name: "Walkthrough: Deploy a Visual C++ application by using a setup project" + - name: "Walkthrough: Deploy a Microsoft C++ application by using a setup project" href: ../windows/walkthrough-deploying-a-visual-cpp-application-by-using-a-setup-project.md - - name: "Walkthrough: Deploy a Visual C++ application to an application-local folder" + - name: "Walkthrough: Deploy a Microsoft C++ application to an application-local folder" href: ../windows/walkthrough-deploying-a-visual-cpp-application-to-an-application-local-folder.md - - name: "Walkthrough: Deploy a Visual C++ application by using the Visual C++ Redistributable package" + - name: "Walkthrough: Deploy a Microsoft C++ application by using the Visual C++ Redistributable package" href: ../windows/deploying-visual-cpp-application-by-using-the-vcpp-redistributable-package.md - name: Prepare a test machine to run a debug executable href: ../windows/preparing-a-test-machine-to-run-a-debug-executable.md - name: Redistribute web client applications href: ../windows/redistributing-web-client-applications.md - - name: ClickOnce deployment for Visual C++ applications + - name: ClickOnce deployment for Microsoft C++ applications href: ../windows/clickonce-deployment-for-visual-cpp-applications.md - name: Run a C++ -clr application on a previous runtime version href: ../windows/running-a-cpp-clr-application-on-a-previous-runtime-version.md diff --git a/docs/windows/troubleshoot-vc-redistributable-installation-issues.md b/docs/windows/troubleshoot-vc-redistributable-installation-issues.md new file mode 100644 index 00000000000..77102136786 --- /dev/null +++ b/docs/windows/troubleshoot-vc-redistributable-installation-issues.md @@ -0,0 +1,264 @@ +--- +title: Troubleshoot Visual C++ Redistributable Installation Problems +description: This article provides steps to help you diagnose and resolve problems when you install the Visual C++ Redistributable. +author: vicroms +ms.author: viromer +ms.date: 02/12/2026 +ms.topic: troubleshooting-general +helpviewer_keywords: [ "redist", "vcredist", "Visual [C++] redistributable", "VC Redist" ] +--- +# Troubleshoot Visual C++ Redistributable installation problems + +This article is for users who experience problems when they install Visual C++ Runtime components by using the Visual Studio Installer or the Visual C++ Redistributable (VC Redist) installer. + +If you experience any problems, make sure that you're installing the [latest version of the Visual C++ Redistributable](latest-supported-vc-redist.md). + +## Collect failure logs + +The first step to diagnose a problem with the Visual C++ Redistributable installer is to collect its failure logs. + +1. Download the [Microsoft Visual Studio and .NET Log Collection Tool](). +1. Run `Collect.exe`. +1. Extract the contents of `%TEMP%/vscollect.zip`. + +After you extract `vscollect.zip`, the VC Redist logs are located inside the `Temp` folder. The relevant log files are prefixed with the pattern `dd_vcredist__yyyyMMddHHmmss`. + +Search the VC Redist logs for terms like "Error," "Failed," or "System Error," and consult the [Common errors at a glance](#common-errors-at-a-glance) section to identify the problem. + +### Other log locations + +The VC Redist installer is often run as a prerequisite of other products. In such cases, you might find the installation log in a different path. + +For example, [Configuration Manager](/intune/configmgr/core/understand/introduction) upgrades VC Redist as part of its own upgrade process by running `vcredist_x64.exe` with the `/l` option that overrides the default log location. + +In such cases, you can find the path to the logs by reading that product's own logs. + +#### Example: Configuration Manager logs + +`\Logs\cmupdate.log` + +```log +10-31-2025 17:40:06.421 CONFIGURATION_MANAGER_UPDATE 67368 (0x10728) [Visual C++ 2015-2022 Redistributable (x64)] with older version 14.28.29914 is installed. it needs to upgraded. +10-31-2025 17:40:06.421 CONFIGURATION_MANAGER_UPDATE 67368 (0x10728) INFO: Start install Visual C redistributable ("C:\Program Files\Microsoft Configuration Manager\CMUStaging\AA928926-5C76-4DE0-B51F-0FE4D365DFE2\SMSSETUP\BIN\X64\vcredist_x64.exe" /q /norestart /l "C:\Program Files\Microsoft Configuration Manager\Logs\VCRedist64Install.log"). +10-31-2025 17:40:14.553 CONFIGURATION_MANAGER_UPDATE 67368 (0x10728) ERROR: Failed to install Visual C redistributable. Return code: 1603. +10-31-2025 17:40:14.553 CONFIGURATION_MANAGER_UPDATE 67368 (0x10728) ERROR: 64-bit VC Redist installation ("C:\Program Files\Microsoft Configuration Manager\CMUStaging\AA928926-5C76-4DE0-B51F-0FE4D365DFE2\SMSSETUP\BIN\X64\vcredist_x64.exe") failed. Please check log file [C:\Program Files\Microsoft Configuration Manager\Logs\VCRedist64Install.log]. +10-31-2025 17:40:14.554 CONFIGURATION_MANAGER_UPDATE 67368 (0x10728) Failed to install vc redist. Please manually install it from C:\Program Files\Microsoft Configuration Manager\CMUStaging\AA928926-5C76-4DE0-B51F-0FE4D365DFE2\SMSSETUP\BIN\X64 +``` + +## General troubleshooting steps when using the Visual C++ Redistributable installer + +This section describes general troubleshooting methods that you can try to resolve problems with the VC Redist installer. + +### Disable antivirus software temporarily + +Antivirus software often blocks installation of VC Redist components. + +1. Turn off Windows Defender real-time protection. +1. Disable any corporate endpoint protection temporarily (such as Symantec or McAfee). +1. Retry the installation. +1. Reenable any disabled protection software. + +> [!WARNING] +> Reenable any disabled protection software after you finish these steps. + +### Run the Visual C++ Redistributable installer as administrator + +File-access failures are heavily correlated with insufficient permissions. + +1. Right-click the VC Redist installer and select **Run as Administrator**. +1. Retry the installation. + +### Check for Windows updates + +On rare occasions, outdated system components can cause installation problems. + +1. Go to Windows Update and install all pending updates. +1. Reboot your PC. +1. Retry the installation. + +## General troubleshooting steps when using Visual Studio Installer + +### Manually install Visual C++ Redistributable + +> [!NOTE] +> The Visual Studio Installer might prompt for a restart when VC Redist is installed separately. + +1. Download the [latest VC Redist installer](latest-supported-vc-redist.md). +1. Run the VC Redist installer. +1. Retry the Visual Studio Installer. + +If the manual installation fails, follow the [general troubleshooting steps for the standalone VC Redist installer](#general-troubleshooting-steps-when-using-the-visual-c-redistributable-installer). + +### Clear the Visual Studio Installer cache + +1. Open `%ProgramData%\Microsoft\VisualStudio\Packages`. +1. Delete all the files inside the folder to force the Visual Studio Installer to regenerate them. +1. Retry the Visual Studio Installer. + +### Repair the Visual Studio Installer + +1. Open the **Settings** app. +1. Enter **Installed Apps** in the search bar at the top of the window. +1. Search for **Visual Studio Installer**. +1. Select the ellipsis (**...**), and then select **Modify**. +1. Select the **Repair** option to repair the Visual Studio Installer. +1. Retry the Visual Studio installation. + +### Delete the Visual Studio Installer folder + +> [!WARNING] +> This method requires that you have the Visual Studio Installer Setup downloaded (`VisualStudioSetup.exe`). You can download the Visual Studio Installer Setup from . + +This method helps if the installer metadata is corrupted. Deleting the installer folder forces the Visual Studio Installer to regenerate it. + +1. Download `VisualStudioSetup.exe` from the [Welcome to Dev Essentials](https://my.visualstudio.com) page. +1. Delete the folder `C:\Program Files (x86)\Microsoft Visual Studio\Installer`. You might be prompted to run this operation as an administrator. +1. Run `VisualStudioSetup.exe`. + +## Common problems + +### Common errors at a glance + +* [Generic installation failure (return code 1603)](#generic-installation-failure) +* [Access denied (return code 5)](#access-denied) +* [File is locked (return code 32)](#file-is-locked) +* [Corrupt or invalid installer package (return code 1620)](#corrupt-or-invalid-installer-package) +* [Older version can't be removed (return code 1714)](#older-version-cant-be-removed) + +### Generic installation failure + +Return code 1603 indicates a generic installation failure produced by the Windows Installer during the installation of the Visual C++ Runtime components. + +Because many factors can produce a 1603 code, the code by itself doesn't provide enough information to diagnose the cause of the problem. Often, the log files produced by the VC Redist installer contain relevant information that might lead to a solution or workaround. + +The [Common problems](#common-problems) section describes examples of how to diagnose common installation errors and steps that might resolve them. +If your problem isn't found here, follow the instructions to [report a problem in the Visual C++ Redistributable installer](#report-a-visual-c-redistributable-installation-problem). + +### Access denied + +Installation fails with error code 5. This error code typically indicates a permissions problem. Specifically, the problem is access denied. + +#### Steps to resolve + +1. Disable antivirus, group policies, and firewalls temporarily. +1. Run the VC Redist installer. +1. Reenable any disabled protection software. + +If the installation fails, try to run the VC Redist installer as an administrator. + +### File is locked + +Installation fails with error code 32. Files in use by another process, interference from antivirus software, group policies, or corrupted files are common causes. + +#### Steps to resolve + +1. Close any running software in your PC. +1. Try the methods in the [General troubleshooting steps when using Visual Studio Installer](#general-troubleshooting-steps-when-using-the-visual-c-redistributable-installer) section. + +If the installation fails, try to restart your PC to release any locked files. + +### Corrupt or invalid installer package + +Installation fails with error code 1620. This error code indicates that a Windows Installer package (MSI) couldn't be opened. The problem is likely because of corruption or invalid files. + +The presence of these error messages indicates a corrupted cache. + +- **Error code 1620**: Indicates that the Windows Installer package couldn't be opened. +- **Error code 0x80091007**: Indicates that several payloads failed verification because of hash mismatches. +- **Error code 0x80070654**: Occurs when an MSI package fails to run. + +#### Steps to resolve + +Try the steps in the [General troubleshooting steps when using Visual Studio Installer](#general-troubleshooting-steps-when-using-visual-studio-installer). + +### Older version can't be removed + +Installation fails with the error code 1714. This error code indicates a corrupted Windows Installer cache that results in failure to remove a previous version of VC Redist. + +The presence of these error messages indicates a corrupted cache. + +In `dd_vcredist__.log`: + +```log +Error 0x80070003: Failed to get size of pseudo bundle: C:\ProgramData\Package Cache\{43d1ce82-6f55-4860-a938-20e5deb28b98}\VC_redist.x64.exe +Error 0x80070003: Failed to initialize package from related bundle id: {43d1ce82-6f55-4860-a938-20e5deb28b98} +``` + +In `dd_vcredist___vcRuntimeMinimum_.log`: + +```log +SOURCEMGMT: Trying source C:\ProgramData\Package Cache\{455DF12C-7D43-4EFF-AE2F-43C8AF2817A3}v14.28.29914\packages\vcRuntimeMinimum_amd64\. +Note: 1: 2203 2: C:\ProgramData\Package Cache\{455DF12C-7D43-4EFF-AE2F-43C8AF2817A3}v14.28.29914\packages\vcRuntimeMinimum_amd64\vc_runtimeMinimum_x64.msi 3: -2147287037 +SOURCEMGMT: Source is invalid due to missing/inaccessible package. +``` + +```log +Note: 1: 1714 2: Microsoft Visual C++ 2022 X64 Minimum Runtime - 14.40.33816 3: 1612 +CustomAction returned actual error code 1612 (note this may not be 100% accurate if translation happened inside sandbox) +Product: Microsoft Visual C++ 2022 X64 Minimum Runtime - 14.40.33816 -- Error 1714. The older version of Microsoft Visual C++ 2022 X64 Minimum Runtime - 14.40.33816 cannot be removed. Contact your technical support group. System Error 1612. + +Error 1714. The older version of Microsoft Visual C++ 2022 X64 Minimum Runtime - 14.40.33816 cannot be removed. Contact your technical support group. System Error 1612. +``` + +In `VSSetupEvents.txt`: + +```log +Error 1714. The older version of Microsoft Visual C++ 2022 X64 Minimum Runtime - 14.40.33816 cannot be removed. Contact your technical support group. System Error 1612.] [(NULL)] [(NULL)] [(NULL)] [(NULL)] [(NULL)] [] +``` + +#### Steps to resolve + +From the log files, make a note of the VC Redist version causing the problem. Two methods are available to resolve the problem: + +- **Method 1:** Use the Windows Installer. + + 1. Try using the Windows Installer to manually remove the old VC Redist version. If prompted, let the Windows Installer Troubleshooter attempt to fix the problem. + 1. Retry the installation. + +- **Method 2:** Manually remove the old version. + + 1. Download the VC Redist installer for the old version. Follow the [steps to download an old version of the VC Redist installer](#old-vcredist-versions). + 1. Run the installer to uninstall the old VC Redist. + 1. Retry the installation. + +## Download old versions of the Visual C++ Redistributable installer + +> [!WARNING] +> Never install a Visual C++ Redistributable installer that wasn't downloaded from a Microsoft site. Never install a Visual C++ Redistributable installer that Microsoft didn't sign. + +Download the VC Redist installer from the [Welcome to Dev Essentials](https://my.visualstudio.com/Downloads) page. Search for Visual C++ Redistributable on the downloads page. + +For the latest supported VC Redist version for each version of Visual Studio, see [Microsoft Redistributable Visual C++ latest supported downloads](/cpp/windows/latest-supported-vc-redist). + +The following table lists links for older or legacy versions. + +| Version range | Download link template | Example | +|----------------|---------------------------------------------------------------|----------------------------------------------------------------| +| 14.50 or later | `https://aka.ms/vs/18/release//VC_redist..exe` | | +| 14.30 to 14.44 | `https://aka.ms/vs/17/release//VC_redist..exe` | | +| 14.20 to 14.29 | `https://aka.ms/vs/16/release//VC_redist..exe` | | +| 14.10 to 14.19 | `https://aka.ms/vs/15/release//VC_redist..exe` | | + +You might be able to find installers for older versions through a Bing search. Only download VC Redist installers from a Microsoft site. Only install packages signed by Microsoft. + +## Report a Visual C++ Redistributable installation problem + +The list of [common problems](#common-problems) was collected from feedback reported to Microsoft through the [Developer Community](). + +If you encounter a problem not found in that section, or if the steps in this troubleshooting guide don't resolve your problem, use the [Report a Problem]() form to create a new feedback item. + +Your report must include the following information about your environment: + +- The version of VC Redist you're trying to install. +- If you're upgrading, the version of previously installed VC Redist installations. +- If you're installing through the Visual Studio Installer, the version of the Visual Studio Installer. +- The logs collected when you follow the steps in the [Collect failure logs](#collect-failure-logs) section. + +Feedback without this information, especially without logs, is nonactionable and might be closed if more information isn't submitted promptly. + +## Related content + +- [Latest supported Visual C++ Redistributable downloads](latest-supported-vc-redist.md) +- [C++ binary compatibility between Visual Studio versions](../porting/binary-compat-2015-2017.md) +- [Audit Visual C++ Runtime version usage](redist-version-auditing.md) +- [Lifecycle FAQ: Visual C++ Redistributable and Runtime libraries](/lifecycle/faq/visual-c-faq) diff --git a/docs/windows/understanding-the-dependencies-of-a-visual-cpp-application.md b/docs/windows/understanding-the-dependencies-of-a-visual-cpp-application.md index 935808c0d43..8217b0db85b 100644 --- a/docs/windows/understanding-the-dependencies-of-a-visual-cpp-application.md +++ b/docs/windows/understanding-the-dependencies-of-a-visual-cpp-application.md @@ -1,14 +1,14 @@ --- -description: "Learn more about: Understanding the Dependencies of a Visual C++ Application" -title: "Understanding the Dependencies of a Visual C++ Application" +description: "Learn more about: Understanding the Dependencies of a Microsoft C++ Application" +title: "Understanding the Dependencies of a Microsoft C++ Application" ms.date: "11/04/2016" helpviewer_keywords: ["application deployment [C++], dependencies", "Dependency Walker", "dependencies [C++], application deployment and", "deploying applications [C++], dependencies", "DUMPBIN utility", "DLLs [C++], dependencies", "depends.exe", "libraries [C++], application deployment issues"] ms.assetid: 62a44c95-c389-4c5f-82fd-07d7ef09dbf9 ms.topic: concept-article --- -# Understanding the Dependencies of a Visual C++ Application +# Understanding the Dependencies of a Microsoft C++ Application -To determine which Visual C++ libraries an application depends on, you can view the project properties. (In Solution Explorer, right-click on the project and choose **Properties** to open the **Property Pages** dialog box.) On Windows 8 and earlier, you can also use the Dependency Walker (depends.exe), which gives a more comprehensive picture of the dependencies. For more recent versions of Windows the [lucasg/Dependencies](https://github.com/lucasg/Dependencies) tool provides similar functionality (this is a third-party tool not guaranteed by Microsoft.) +To determine which Microsoft C++ libraries an application depends on, you can view the project properties. (In Solution Explorer, right-click on the project and choose **Properties** to open the **Property Pages** dialog box.) On Windows 8 and earlier, you can also use the Dependency Walker (depends.exe), which gives a more comprehensive picture of the dependencies. For more recent versions of Windows the [lucasg/Dependencies](https://github.com/lucasg/Dependencies) tool provides similar functionality (this is a third-party tool not guaranteed by Microsoft.) In the **Property Pages** dialog box, you can examine various pages under **Configuration Properties** to understand the dependencies. For example, if your project uses the MFC libraries and you choose **Use of MFC**, **Use MFC in a Shared DLL** on the **Configuration Properties**, **General** page, your application at run time depends on MFC DLLs such as mfc\.dll. If your application doesn't use MFC, it might depend on the CRT library if you choose a **Runtime Library** value of **Multi-threaded Debug DLL (/MDd)** or **Multi-threaded DLL (/MD)** on the **Configuration Properties**, **C/C++**, **Code Generation** page. @@ -16,7 +16,7 @@ By using depends.exe, you can examine a list of DLLs that are linked to the appl When you use depends.exe, be aware that a DLL might have a dependency on another DLL or on a specific version of a DLL. You can use depends.exe on either the development computer or on a target computer. On the development computer, depends.exe reports the DLLs that are required to support an application. If you have trouble getting an application to run on a target computer, you can copy depends.exe to it and then open the application in the tool so that you can determine whether any required DLLs are missing or incorrect. -When you know which DLLs your application depends on, you can determine the ones that you have to redistribute with your application when you deploy it to another computer. In most cases, you don't have to redistribute system DLLs, but you may have to redistribute DLLs for Visual C++ libraries. For more information, see [Determining Which DLLs to Redistribute](determining-which-dlls-to-redistribute.md). +When you know which DLLs your application depends on, you can determine the ones that you have to redistribute with your application when you deploy it to another computer. In most cases, you don't have to redistribute system DLLs, but you may have to redistribute DLLs for Microsoft C++ libraries. For more information, see [Determining Which DLLs to Redistribute](determining-which-dlls-to-redistribute.md). ## See also diff --git a/docs/windows/walkthrough-deploying-a-visual-cpp-application-by-using-a-setup-project.md b/docs/windows/walkthrough-deploying-a-visual-cpp-application-by-using-a-setup-project.md index 5b2af3d9365..93ddba07afd 100644 --- a/docs/windows/walkthrough-deploying-a-visual-cpp-application-by-using-a-setup-project.md +++ b/docs/windows/walkthrough-deploying-a-visual-cpp-application-by-using-a-setup-project.md @@ -1,12 +1,12 @@ --- -description: "Learn more about: Walkthrough: Deploy a Visual C++ application by using a setup project" -title: "Deploy a Visual C++ application by using a setup project" +description: "Learn more about: Walkthrough: Deploy a Microsoft C++ application by using a setup project" +title: "Deploy a Microsoft C++ application by using a setup project" ms.date: 06/28/2022 -helpviewer_keywords: ["deployment for Visual C++"] +helpviewer_keywords: ["deployment for Microsoft C++"] ms.custom: intro-deployment ms.topic: install-set-up-deploy --- -# Walkthrough: Deploy a Visual C++ application by using a setup project +# Walkthrough: Deploy a Microsoft C++ application by using a setup project In this walkthrough, you'll create a sample app in Visual Studio, then create a setup project to deploy your app to another computer. @@ -22,7 +22,7 @@ You need the following components to complete this walkthrough: - The Microsoft Visual Studio Installer Projects extension. The extension is free for Visual Studio developers and adds the functionality of the setup and deployment project templates to Visual Studio. -- To test your deployment, another computer that doesn't have the Visual C++ libraries installed. +- To test your deployment, another computer that doesn't have the Microsoft C++ libraries installed. ### To install C++ and MFC in Visual Studio 2022 @@ -62,7 +62,7 @@ If you have Visual Studio installed, but you don't have the C++ or MFC component - The Microsoft Visual Studio Installer Projects extension. The extension is free for Visual Studio developers and adds the functionality of the setup and deployment project templates to Visual Studio. -- To test your deployment, another computer that doesn't have the Visual C++ libraries installed. +- To test your deployment, another computer that doesn't have the Microsoft C++ libraries installed. ### To install C++ and MFC in Visual Studio 2019 @@ -330,7 +330,7 @@ The setup project lets you specify where the components of your app are installe ## Test your deployment -To test your deployment, copy the deployment files to a second computer that doesn't have the Visual C++ libraries installed. Run the setup program. If your app loads and runs normally, and you don't get a runtime error about missing libraries or components, then your deployment is successful. +To test your deployment, copy the deployment files to a second computer that doesn't have the Microsoft C++ libraries installed. Run the setup program. If your app loads and runs normally, and you don't get a runtime error about missing libraries or components, then your deployment is successful. For application testing, you can create a deployment setup program that installs a debug version of your app, along with debug libraries, on machines you control. Debug apps and debug libraries aren't licensed for redistribution, and can't be deployed to customer machines. For more information, see [Preparing a test machine to run a debug executable](../windows/preparing-a-test-machine-to-run-a-debug-executable.md). diff --git a/docs/windows/walkthrough-deploying-a-visual-cpp-application-to-an-application-local-folder.md b/docs/windows/walkthrough-deploying-a-visual-cpp-application-to-an-application-local-folder.md index 3a419091272..c87fa954be4 100644 --- a/docs/windows/walkthrough-deploying-a-visual-cpp-application-to-an-application-local-folder.md +++ b/docs/windows/walkthrough-deploying-a-visual-cpp-application-to-an-application-local-folder.md @@ -1,35 +1,35 @@ --- -description: "Learn more about: Walkthrough: Deploying a Visual C++ Application to an Application-local Folder" -title: "Deploy a Visual C++ Application to an App-local Folder" +description: "Learn more about: Walkthrough: Deploying a Microsoft C++ Application to an Application-local Folder" +title: "Deploy a Microsoft C++ Application to an App-local Folder" ms.date: "04/23/2019" -helpviewer_keywords: ["deploying Visual C++ applications"] +helpviewer_keywords: ["deploying Microsoft C++ applications"] ms.assetid: 47a81c47-9dbe-47c6-96cc-fbb2fda5e6ad ms.custom: intro-deployment ms.topic: install-set-up-deploy --- -# Walkthrough: Deploying a Visual C++ Application to an Application-local Folder +# Walkthrough: Deploying a Microsoft C++ Application to an Application-local Folder -Describes how to deploy a Visual C++ application by copying files to its folder. +Describes how to deploy a Microsoft C++ application by copying files to its folder. ## Prerequisites - A computer that has Visual Studio installed. -- Another computer that doesn't have the Visual C++ libraries. +- Another computer that doesn't have the Microsoft C++ libraries. ### To deploy an application to an application-local folder -1. Create and build an MFC application by following the steps in [Walkthrough: Deploying a Visual C++ Application By Using a Setup Project](walkthrough-deploying-a-visual-cpp-application-by-using-a-setup-project.md). +1. Create and build an MFC application by following the steps in [Walkthrough: Deploying a Microsoft C++ Application By Using a Setup Project](walkthrough-deploying-a-visual-cpp-application-by-using-a-setup-project.md). 1. Copy the appropriate MFC and C Run-Time (CRT) library files from the Visual Studio installation directory in the \\VC\\redist\\*version* folder, and then paste them in the \Release\ folder of your MFC project. For more information about other files that you might have to copy, see [Determining Which DLLs to Redistribute](determining-which-dlls-to-redistribute.md). -1. Run the MFC application on a second computer that doesn't have the Visual C++ libraries. +1. Run the MFC application on a second computer that doesn't have the Microsoft C++ libraries. 1. Copy the contents of the \Release\ folder and paste them in the application folder on the second computer. 1. Run the application on the second computer. - The application runs successfully because the Visual C++ libraries are available in the application-local folder. + The application runs successfully because the Microsoft C++ libraries are available in the application-local folder. ## See also