Export (0) Print
Expand All

SERVICE_DESCRIPTION structure

Contains a service description.

Syntax


typedef struct _SERVICE_DESCRIPTION {
  LPTSTR lpDescription;
} SERVICE_DESCRIPTION, *LPSERVICE_DESCRIPTION;

Members

lpDescription

The description of the service. If this member is NULL, the description remains unchanged. If this value is an empty string (""), the current description is deleted.

The service description must not exceed the size of a registry value of type REG_SZ.

This member can specify a localized string using the following format:

@[path\]dllname,-strID

The string with identifier strID is loaded from dllname; the path is optional. For more information, see RegLoadMUIString.

Windows Server 2003 and Windows XP:  Localized strings are not supported until Windows Vista.

Remarks

A description of NULL indicates no service description exists. The service description is NULL when the service is created.

The description is simply a comment that explains the purpose of the service. For example, for the DHCP service, you could use the description "Provides internet addresses for computer on your network."

You can set the description using the ChangeServiceConfig2 function. You can retrieve the description using the QueryServiceConfig2 function. The description is also displayed by the Services snap-in.

Examples

For an example, see Changing a Service's Configuration or Querying a Service's Configuration.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Winsvc.h (include Windows.h)

Unicode and ANSI names

SERVICE_DESCRIPTIONW (Unicode) and SERVICE_DESCRIPTIONA (ANSI)

See also

ChangeServiceConfig2
QueryServiceConfig2

 

 

Community Additions

ADD
Show:
© 2015 Microsoft