Skip to content

Commit dc199a0

Browse files
committed
Update documentation in Get-SqlDscStartupParameter to clarify parameter descriptions and outputs
1 parent c147f52 commit dc199a0

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

source/Public/Get-SqlDscStartupParameter.ps1

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,24 @@
66
Get current startup parameters on a Database Engine instance.
77
88
.PARAMETER ServiceObject
9-
Specifies the Service object to return the trace flags from.
9+
Specifies the Service object to return the startup parameters from.
1010
1111
.PARAMETER ServerName
12-
Specifies the server name to return the trace flags from.
12+
Specifies the server name to return the startup parameters from.
1313
1414
.PARAMETER InstanceName
15-
Specifies the instance name to return the trace flags for.
15+
Specifies the instance name to return the startup parameters for.
16+
17+
.INPUTS
18+
Microsoft.SqlServer.Management.Smo.Wmi.Service
19+
20+
A service object representing the Database Engine service.
21+
22+
.OUTPUTS
23+
StartupParameters
24+
25+
Returns a StartupParameters object containing the startup parameters
26+
for the specified Database Engine instance.
1627
1728
.EXAMPLE
1829
Get-SqlDscStartupParameter
@@ -39,9 +50,6 @@
3950
4051
Get the startup parameters from the Database Engine instance 'SQL2022' on
4152
the server where the command in run.
42-
43-
.OUTPUTS
44-
`[StartupParameters]`
4553
#>
4654
function Get-SqlDscStartupParameter
4755
{
@@ -50,7 +58,7 @@ function Get-SqlDscStartupParameter
5058
[CmdletBinding(DefaultParameterSetName = 'ByServerName')]
5159
param
5260
(
53-
[Parameter(ParameterSetName = 'ByServiceObject', Mandatory = $true)]
61+
[Parameter(ParameterSetName = 'ByServiceObject', Mandatory = $true, ValueFromPipeline = $true)]
5462
[Microsoft.SqlServer.Management.Smo.Wmi.Service]
5563
$ServiceObject,
5664

0 commit comments

Comments
 (0)