< Back
Test-CFileShare
Post
NAME Test-CFileShare
SYNOPSIS
Tests if a file/SMB share exists on the local computer.
SYNTAX
Test-CFileShare [-Name] <String> [<CommonParameters>]
DESCRIPTION
The `Test-CFileShare` function uses WMI to check if a file share exists on the local computer. If the share
exists, `Test-CFileShare` returns `$true`. Otherwise, it returns `$false`.
`Test-CFileShare` was added in Carbon 2.0.
PARAMETERS
-Name <String>
The name of a specific share to check.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Test-CFileShare -Name 'CarbonShare'
Demonstrates how to test of a file share exists.
RELATED LINKS
Get-CFileShare
Get-CFileSharePermission
Install-CFileShare
Uninstall-CFileShare
SYNOPSIS
Tests if a file/SMB share exists on the local computer.
SYNTAX
Test-CFileShare [-Name] <String> [<CommonParameters>]
DESCRIPTION
The `Test-CFileShare` function uses WMI to check if a file share exists on the local computer. If the share
exists, `Test-CFileShare` returns `$true`. Otherwise, it returns `$false`.
`Test-CFileShare` was added in Carbon 2.0.
PARAMETERS
-Name <String>
The name of a specific share to check.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Test-CFileShare -Name 'CarbonShare'
Demonstrates how to test of a file share exists.
RELATED LINKS
Get-CFileShare
Get-CFileSharePermission
Install-CFileShare
Uninstall-CFileShare