SERVICE_DESCRIPTION

[This is preliminary documentation and subject to change.]

The SERVICE_DESCRIPTION structure represents a service description.

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

Members

lpDescription

Pointer to a description of the service. The string is limited to 1024 bytes. If this value is NULL, the description remains unchanged. If this value is an empty string (""), the current description is deleted.

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. 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.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in winsvc.h.
  Unicode: Defined as Unicode and ANSI structures.

See Also

Services Overview, Service Structures, ChangeServiceConfig2, QueryServiceConfig2