Skip to main content
WSCSetApplicationCategory function

Note  Layered Service Providers are deprecated. Starting with Windows 8 and Windows Server 2012, use Windows Filtering Platform.

The WSCSetApplicationCategory function sets the permitted layered service provider (LSP) categories associated with an application.

Syntax


int WSPAPI WSCSetApplicationCategory(
  _In_   LPCWSTR Path,
  _In_   DWORD PathLength,
  _In_   LPCWSTR Extra,
  _In_   DWORD ExtraLength,
  _In_   DWORD PermittedLspCategories,
  _Out_  DWORD *pPrevPermLspCat,
  _Out_  LPINT lpErrno
);

Parameters

Path [in]

A pointer to a Unicode string that contains the load path to the executable image for the application. This string observes the usual rules for path resolution and can contain embedded environment strings (such as %SystemRoot%).

PathLength [in]

The length, in characters, of the Path parameter. This length does not include the terminating NULL.

Extra [in]

A pointer to a Unicode string which represents the command line arguments used when starting the application specified in the Path parameter. The Extra parameter is used to distinguish between multiple, distinct instances of an application when launched with a consistent command line. This is to support different application categorizations for different instances of Svchost.exe or Rundll32.exe. If only the Path parameter is required and no command line arguments are needed to further distinguish between instances of an application, then the Extra parameter should be set to NULL.

ExtraLength [in]

The length, in characters, of the Extra parameter. This length does not include the terminating NULL.

PermittedLspCategories [in]

A DWORD value of the LSP categories which are permitted for all instances of this application. The application is identified by the combination of the values of the Path and Extra parameters.

pPrevPermLspCat [out]

A pointer to receive the previous set of permitted LSP categories which were permitted for all instances of this application. This parameter is optional can be NULL.

lpErrno [out]

A pointer to the error code if the function fails.

Return value

If no error occurs, WSCSetApplicationCategory returns ERROR_SUCCESS (zero). Otherwise, it returns SOCKET_ERROR, and a specific error code is returned in the lpErrno parameter.

Error codeMeaning
WSAEFAULT

One or more of the arguments is not in a valid part of the user address space.

WSAEINVAL

One or more of the arguments are invalid.

WSANO_RECOVERY

A nonrecoverable error occurred. This error is returned under several conditions including the following: the user lacks the administrative privileges required to access the Winsock registry, or a failure occurred when opening a Winsock catalog entry or an application ID entry.

 

Remarks

WSCSetApplicationCategory is used to set the LSP category flags associated with an application instance. Applications can determine which LSP behaviors are acceptable within the application's context. Therefore, through specifying permitted LSP categories, an application can permit only those layered service providers which implement acceptable behaviors to be loaded.

The Extra parameter is required when the command line is used to distinguish between different instances of an application or service hosted within the same executable. Each instance can have different application categorization needs. Svchost.exe and Rundll32.exe are two examples where the command line is required to differentiate between different process instances. For SvcHost.exe, the -k <svcinstance> switch defines the process instance. For services, using the Service Name is not sufficient, because the Winsock Catalog is global to a given process, and a process may host several services.

If the WSCSetApplicationCategory function is called on the same application (the same fullpath, EXE name, and parameters) multiple times, then the categories are ORed together. For example if you categorized "c:\foo.exe -param" with LSP_SYSTEM and then called the WSCSetApplicationCategory function again with LSP_REDIRECTOR, the resulting entry for htis application contains LSP_SYSTEM | LSP_REDIRECTOR. This behavior is designed to support a single executable file that hosts multiple applications in a single EXE (the Windows system services svchost.exe, for example).

Window sockets determine an application's identity and retrieves the permitted LSP categories during the first call to WSAStartup. This will be the set of permitted LSP categories for the duration of the application instance. Subsequent changes to the permitted LSP categories for a given application identity will not be picked up until the next instance of the application. The permitted LSP categories is not mutable during the lifetime of the application instance.

Winsock 2 accommodates layered protocols. A layered protocol is one that implements only higher level communications functions, while relying on an underlying transport stack for the actual exchange of data with a remote endpoint. An example of a layered protocol or layered service provider would be a security layer that adds protocol to the connection establishment process in order to perform authentication and to establish a mutually agreed upon encryption scheme. Such a security protocol would generally require the services of an underlying reliable transport protocol such as TCP or SPX. The term base protocol refers to a protocol such as TCP or SPX which is capable of performing data communications with a remote endpoint. The term layered protocol is used to describe a protocol that cannot stand alone.

During LSP initialization, the LSP must provide pointers to a number of Winsock SPI functions. These functions will be called during normal processing by the layer directly above the LSP (either another LSP or Ws2_32.dll). An LSP that implements an installable file system (IFS) can selectively choose to provide pointers to functions which are implemented by itself, or pass back the pointers provided by the layer directly below the LSP. Non-IFS LSPs, because they provide their own handles, must implement all of the Winsock SPI functions. This is because each SPI will require the LSP to map all of the socket handles it created to the socket handle of the lower provider (either another LSP or the base protocol). However, all LSPs perform their specific work by doing extra processing on only a subset of the Winsock SPI functions.

It is possible to define LSP categories based upon the subset of SPI functions an LSP implements and the nature of the extra processing performed for each of those functions. By classifying LSPs, as well as classifying applications which use Winsock sockets, it becomes possible to selectively determine if an LSP should be involved in a given process at runtime.

On Windows Vista and later, an LSP can be classified based on how it interacts with Windows Sockets calls and data. An LSP category is an identifiable group of behaviors on a subset of Winsock SPI functions. For example, an HTTP content filter would be categorized as a data inspector (the LSP_INSPECTOR category). The LSP_INSPECTOR category will inspect (but not alter) parameters to data transfer SPI functions. An application can query for the category of an LSP and choose to not load the LSP based on the LSP category and the application's set of permitted LSP categories.

The following table lists categories into which an LSP can be classified.

LSP CategoryDescription
LSP_CRYPTO_COMPRESSThe LSP is a cryptography or data compression provider.
LSP_FIREWALLThe LSP is a firewall provider.
LSP_LOCAL_CACHEThe LSP is a local cache provider.
LSP_INBOUND_MODIFYThe LSP modifies inbound data.
LSP_INSPECTORThe LSP inspects or filters data.
LSP_OUTBOUND_MODIFYThe LSP modifies outbound data.
LSP_PROXYThe LSP acts as a proxy and redirects packets.
LSP_REDIRECTORThe LSP is a network redirector.
LSP_SYSTEMThe LSP is acceptable for use in services and system processes.

 

An LSP may belong to more than one category. For example, a firewall/security LSP could belong to both the inspector (LSP_INSPECTOR) and firewall (LSP_FIREWALL) categories.

If an LSP does not have a category set, it is considered to be in the All Other category. This LSP category will not be loaded in services or system processes (for example, lsass, winlogon, and many svchost processes).

The WSCSetApplicationCategory function can only be called by a user logged on as a member of the Administrators group. If WSCSetApplicationCategory is called by a user that is not a member of the Administrators group, the function call will fail and WSANO_RECOVERY is returned in the lpErrno parameter. This function can also fail because of user account control (UAC). If an application that contains this function is executed by a user logged on as a member of the Administrators group other than the built-in Administrator, this call will fail unless the application has been marked in the manifest file with a requestedExecutionLevel set to requireAdministrator. If the application on Windows Vista or Windows Server 2008 lacks this manifest file, a user logged on as a member of the Administrators group other than the built-in Administrator must then be executing the application in an enhanced shell as the built-in Administrator (RunAs administrator) for this function to succeed.

Any file installation or service provider-specific configuration must be performed by the caller.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Ws2spi.h

Library

Ws2_32.lib

DLL

Ws2_32.dll

See also

Categorizing Layered Service Providers and Applications
WSAStartup
WSCGetApplicationCategory
WSCGetProviderInfo
WSCGetProviderInfo32
WSCSetProviderInfo
WSCSetProviderInfo32