The GetHostDescription function retrieves the Host Description field stored in the currently loaded license.

Syntax

HRESULT GetHostDescription ( BSTR * HostDescription );

Parameters

HostDescription  

[OUT] Wide character string which will return with the host description stored in the currently loaded license.

Remarks

The GetHostDescription function retrieves the Host Description field stored in the currently loaded license. If the host description is not set, the string will return empty.

This field is a dynamically allocated string and has no declared maximum length. The theoretical maximum length of this string value is 2GB (two gigabytes). In practice this means that the maximum length of this string is limited only by the amount of memory available to your application.

Return Value

As with all COM function calls they return an HRESULT. HRESULT is a data type that is a 32-bit error or warning code. Check your compilers documentation for information on interpreting the HRESULT value.

Function Information

Exposed By Interface:	"ISSCProtector"
Exposed In COM Server Binaries:	"SSCProt.dll" and "SSCProtD.dll"