[#BloombergLP-bdls-OsUtil-getOsInfo-03]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdls.adoc[bdls]::xref:BloombergLP/bdls/OsUtil.adoc[OsUtil]::getOsInfo
:relfileprefix: ../../../
:mrdocs:

Load operating system name, version, and patch into the output strings.

== Synopsis

Declared in `<bdls_osutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
getOsInfo(
    xref:bsl/string.adoc[bsl::string]* osName,
    xref:bsl/string.adoc[bsl::string]* osVersion,
    xref:bsl/string.adoc[bsl::string]* osPatch);
----

== Description

Load the operating system name, version name and patch name into the specified `osName`, `osVersion` and `osPatch` respectively. Return 0 on success and a non‐zero value otherwise. The loaded values may represent an emulation provided for the current process (see "manifest‐based behavior" in Windows programming documentation for an example) and therefore are not suitable for determining supported features or the real environment/version. If you need to determine the presence of certain features please consult the documentation of the operating systems you need to support.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *osName*
| receives the operating system name
| *osVersion*
| receives the operating system version
| *osPatch*
| receives the operating system patch level
|===


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