[#BloombergLP-bdls-FilesystemUtil-isSymbolicLink-01]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdls.adoc[bdls]::xref:BloombergLP/bdls/FilesystemUtil.adoc[FilesystemUtil]::isSymbolicLink
:relfileprefix: ../../../
:mrdocs:

Return `true` if a symbolic link currently exists at `path`.

== Synopsis

Declared in `<bdls_filesystemutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
bool
isSymbolicLink(char const* path);
----

== Description

Return `true` if there currently exists a symbolic link at the specified `path`, and `false` otherwise. Windows directory junctions are treated as directory symbolic links. The parameterized `STRING_TYPE` must be one of `bsl::string`, `std::string`, `std::pmr::string` (if supported), `bsl::string_view`, or `bslstl::StringRef`.

== Return Value

`true` if `path` is a symbolic link, and `false` otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *path*
| filesystem path to test
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#