Recent changes to keywords-out

keywords-out modified by Will Pittenger

Will Pittenger — Thu, 20 Feb 2014 19:13:35 -0000

--- v4
+++ v5
@@ -9,5 +9,5 @@

 ~~~~
 :::text
-\out\ /VariableName/
+(\ref\ | \out\ | \byvalue\) /identifier/
 ~~~~

keywords-out modified by Will Pittenger

Will Pittenger — Thu, 20 Feb 2014 19:13:04 -0000

--- v3
+++ v4
@@ -1,4 +1,4 @@
-The **out** and **[ref](keywords-ref)** keywords do pretty much the same thing: Tell the compiler than a type must be passed by reference.  There are difference though.  The **[ref](keywords-ref)** keyword always adds a reference layer so that even if the type already is a reference type, it gets an extra layer of reference.  The **out** keyword will only add a reference layer if the type defaults to a by-value type.  Furthermore, **out** can only be used on **[var](keywords-var)** parameters that aren't declared as **[readonly](keywords-readonly)**.  Finally, **out** tells the compiler the procedure the **out** parameter is being passed to will initialize the variable.  This allows the procedure to return an extra value.  Please note that **out** can't be directly combined with **[byvalue](keywords-byvalue)** or **[ref](keywords-ref)**.  For that, you need a **[typealias](keywords-typealias)** as described in [Type aliases].  If a formal parameter was declared with **[out](keywords-out)**, the corresponding actual parameter must be preceded with **out**.
+The **out** and **[ref](keywords-ref)** keywords do pretty much the same thing: Tell the compiler than a type must be passed by reference.  There are difference though.  The **[ref](keywords-ref)** keyword always adds a reference layer so that even if the type already is a reference type, it gets an extra layer of reference.  The **out** keyword will only add a reference layer if the type defaults to a by-value type.  Furthermore, **out** can only be used on **[var](keywords-var)** parameters that aren't declared as **[readonly](keywords-readonly)**.  Finally, **out** tells the compiler the procedure the **out** parameter is being passed to will initialize the variable.  This allows the procedure to return an extra value.  Please note that **out** can't be directly combined with **[byvalue](keywords-byvalue)** or **[ref](keywords-ref)**.  For that, you need a **[typealias](keywords-typealias)** as described in [Type aliases].  If a formal parameter was declared with **out**, the corresponding actual parameter must be preceded with **out**.

 ~~~~
 :::text

keywords-out modified by Will Pittenger

Will Pittenger — Thu, 20 Feb 2014 19:12:41 -0000

--- v2
+++ v3
@@ -1,8 +1,13 @@
-The **out** and **[ref](keywords-ref)** keywords do pretty much the same thing: Tell the compiler than a type must be passed by reference.  There are difference though.  The **[ref](keywords-ref)** keyword always adds a reference layer so that even if the type already is a reference type, it gets an extra layer of reference.  The **out** keyword will only add a reference layer if the type defaults to a by-value type.  Furthermore, **out** can only be used on **[var](keywords-var)** parameters that aren't declared as **[readonly](keywords-readonly)**.  Finally, **out** tells the compiler the procedure the **out** parameter is being passed to will initialize the variable.  This allows the procedure to return an extra value.  Please note that **out** can't be directly combined with **[byvalue](keywords-byvalue)** or **[ref](keywords-ref)**.  For that, you need a **[typealias](keywords-typealias)** as described in [Type aliases].
+The **out** and **[ref](keywords-ref)** keywords do pretty much the same thing: Tell the compiler than a type must be passed by reference.  There are difference though.  The **[ref](keywords-ref)** keyword always adds a reference layer so that even if the type already is a reference type, it gets an extra layer of reference.  The **out** keyword will only add a reference layer if the type defaults to a by-value type.  Furthermore, **out** can only be used on **[var](keywords-var)** parameters that aren't declared as **[readonly](keywords-readonly)**.  Finally, **out** tells the compiler the procedure the **out** parameter is being passed to will initialize the variable.  This allows the procedure to return an extra value.  Please note that **out** can't be directly combined with **[byvalue](keywords-byvalue)** or **[ref](keywords-ref)**.  For that, you need a **[typealias](keywords-typealias)** as described in [Type aliases].  If a formal parameter was declared with **[out](keywords-out)**, the corresponding actual parameter must be preceded with **out**.

 ~~~~
 :::text
 /StartOfDeclarationSequenceForProcedure/ \var\ \out\ /identifier/ /EndOfDeclarationSequenceForProcedure/
 ~~~~

-For more on what can be in a declaration sequence, see [Declaration sequences](Appendices-Terms-Declaration sequences).
+For more on what can be in a declaration sequence, see [Declaration sequences](Appendices-Terms-Declaration sequences).  The following sample shows how to use **out** for an actual parameter.
+
+~~~~
+:::text
+\out\ /VariableName/
+~~~~

keywords-out modified by Will Pittenger

Will Pittenger — Thu, 20 Feb 2014 18:06:32 -0000

--- v1
+++ v2
@@ -1,6 +1,7 @@
 The **out** and **[ref](keywords-ref)** keywords do pretty much the same thing: Tell the compiler than a type must be passed by reference.  There are difference though.  The **[ref](keywords-ref)** keyword always adds a reference layer so that even if the type already is a reference type, it gets an extra layer of reference.  The **out** keyword will only add a reference layer if the type defaults to a by-value type.  Furthermore, **out** can only be used on **[var](keywords-var)** parameters that aren't declared as **[readonly](keywords-readonly)**.  Finally, **out** tells the compiler the procedure the **out** parameter is being passed to will initialize the variable.  This allows the procedure to return an extra value.  Please note that **out** can't be directly combined with **[byvalue](keywords-byvalue)** or **[ref](keywords-ref)**.  For that, you need a **[typealias](keywords-typealias)** as described in [Type aliases].

 ~~~~
+:::text
 /StartOfDeclarationSequenceForProcedure/ \var\ \out\ /identifier/ /EndOfDeclarationSequenceForProcedure/
 ~~~~

keywords-out modified by Will Pittenger

Will Pittenger — Thu, 20 Feb 2014 18:03:05 -0000

The out and ref keywords do pretty much the same thing: Tell the compiler than a type must be passed by reference. There are difference though. The ref keyword always adds a reference layer so that even if the type already is a reference type, it gets an extra layer of reference. The out keyword will only add a reference layer if the type defaults to a by-value type. Furthermore, out can only be used on var parameters that aren't declared as readonly. Finally, out tells the compiler the procedure the out parameter is being passed to will initialize the variable. This allows the procedure to return an extra value. Please note that out can't be directly combined with byvalue or ref. For that, you need a typealias as described in [Type aliases].

/StartOfDeclarationSequenceForProcedure/ \var\ \out\ /identifier/ /EndOfDeclarationSequenceForProcedure/

For more on what can be in a declaration sequence, see Declaration sequences.