describe the variadic template args now used, fill in missing parts - #145
Merged
Colin Robertson (colin-home) merged 4 commits intoDec 11, 2017
Conversation
This page was documenting the pre-Variadic template arg version of this function, was missing several important things so I've updated it
| `RuntimeClass` | ||
|
|
||
| `RuntimeClass` | ||
| This is an implementaiton detail. |
| A combination of one or more [RuntimeClassType](../windows/runtimeclasstype-enumeration.md) enumeration values. The `__WRL_CONFIGURATION_LEGACY__` macro can be defined to change the default value of classFlags for all runtime classes in the project. If defined, RuntimeClass instances are non-agile dy default. When not defined, RuntimeClass instances are agile by default. To avoid ambiguity always specify the RuntimeClassType::FtmBase or RuntimeClassType::InhibitFtmBase. | ||
| Optional paramater. A combination of one or more [RuntimeClassType](../windows/runtimeclasstype-enumeration.md) enumeration values. The `__WRL_CONFIGURATION_LEGACY__` macro can be defined to change the default value of classFlags for all runtime classes in the project. If defined, RuntimeClass instances are non-agile dy default. When not defined, RuntimeClass instances are agile by default. To avoid ambiguity always specify the RuntimeClassType::FtmBase or RuntimeClassType::InhibitFtmBase. Note, if InhibitFtmBase and FtmBase are both used the object will be agile. | ||
|
|
||
| `...TInterfaces` |
Contributor
There was a problem hiding this comment.
You can also put an Implements here (rather than an interface). Maybe somebody who knows more can fill in the details.
Contributor
Author
There was a problem hiding this comment.
I'll leave that for later.
| Optional paramater. A combination of one or more [RuntimeClassType](../windows/runtimeclasstype-enumeration.md) enumeration values. The `__WRL_CONFIGURATION_LEGACY__` macro can be defined to change the default value of classFlags for all runtime classes in the project. If defined, RuntimeClass instances are non-agile dy default. When not defined, RuntimeClass instances are agile by default. To avoid ambiguity always specify the RuntimeClassType::FtmBase or RuntimeClassType::InhibitFtmBase. Note, if InhibitFtmBase and FtmBase are both used the object will be agile. | ||
|
|
||
| `...TInterfaces` | ||
| The list of interfaces the object implements beyond IUnknown, IInspectable or other interfaces controled by [RuntimeClassType](../windows/runtimeclasstype-enumeration.md). |
Contributor
There was a problem hiding this comment.
TYPO: controlled.
| ## Members | ||
|
|
||
| `RuntimeClassInitialize` | ||
| A function that is called when MakeAndInitialize() is used to construct the object that contains initialization code that can return an HRESULT to indicate failure (S_OK otherwise). |
Contributor
There was a problem hiding this comment.
Confusing grammar. (Antecedent of "that" is ambiguous.) Suggest
A function which initializes the object if the
MakeAndInitializetemplate function is used to construct the object. It returnsS_OKif the object was successfully initialized, or a COM error code if initialization failed. The COM error code is propagated as the return value ofMakeAndInitialize. Note that theRuntimeClassInitializemethod is not called if theMaketemplate function is used to construct the object.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This page was documenting the pre-Variadic template arg version of this function, was missing several important things so I've updated it. Raymond Chen (@oldnewthing) please check my work.