SERVICE_DESCRIPTION

SERVICE_DESCRIPTION

The SERVICE_DESCRIPTION structure represents a service description.

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

Members

lpDescription

Pointer to a null-terminated string that specifies the description of the service. If this value 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.

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.

Requirements

Client	Requires Windows XP or Windows 2000 Professional.
Server	Requires Windows Server 2003 or Windows 2000 Server.
Header	Declared in Winsvc.h; include Windows.h.
Unicode	Implemented as SERVICE_DESCRIPTIONW (Unicode) and SERVICE_DESCRIPTIONA (ANSI).