userenv.h header
This header is used by multiple technologies. For more information, see:
userenv.h contains the following programming interfaces:
Functions
| CreateAppContainerProfile Creates a per-user, per-app profile for an AppContainer. |
| CreateEnvironmentBlock Retrieves the environment variables for the specified user. This block can then be passed to the CreateProcessAsUser function. |
| CreateProfile Creates a new user profile. |
| DeleteAppContainerProfile Deletes the specified per-user, per-app profile. |
| DeleteProfileA Deletes the user profile and all user-related settings from the specified computer. The caller must have administrative privileges to delete a user's profile. (ANSI) |
| DeleteProfileW Deletes the user profile and all user-related settings from the specified computer. The caller must have administrative privileges to delete a user's profile. (Unicode) |
| DeriveAppContainerSidFromAppContainerName Gets the SID of the specified profile. |
| DeriveRestrictedAppContainerSidFromAppContainerSidAndRestrictedName DeriveRestrictedAppContainerSidFromAppContainerSidAndRestrictedName is reserved for future use. |
| DestroyEnvironmentBlock Frees environment variables created by the CreateEnvironmentBlock function. |
| EnterCriticalPolicySection The EnterCriticalPolicySection function pauses the application of policy to allow applications to safely read policy settings. |
| ExpandEnvironmentStringsForUserA Expands the source string by using the environment block established for the specified user. (ANSI) |
| ExpandEnvironmentStringsForUserW Expands the source string by using the environment block established for the specified user. (Unicode) |
| FreeGPOListA The FreeGPOList function frees the specified list of GPOs. (ANSI) |
| FreeGPOListW The FreeGPOList function frees the specified list of GPOs. (Unicode) |
| GetAllUsersProfileDirectoryA Retrieves the path to the root of the directory that contains program data shared by all users. (ANSI) |
| GetAllUsersProfileDirectoryW Retrieves the path to the root of the directory that contains program data shared by all users. (Unicode) |
| GetAppContainerFolderPath Gets the path of the local app data folder for the specified app container. |
| GetAppContainerRegistryLocation Gets the location of the registry storage associated with an app container. |
| GetAppliedGPOListA The GetAppliedGPOList function retrieves the list of GPOs applied for the specified user or computer. (ANSI) |
| GetAppliedGPOListW The GetAppliedGPOList function retrieves the list of GPOs applied for the specified user or computer. (Unicode) |
| GetDefaultUserProfileDirectoryA Retrieves the path to the root of the default user's profile. (ANSI) |
| GetDefaultUserProfileDirectoryW Retrieves the path to the root of the default user's profile. (Unicode) |
| GetGPOListA The GetGPOList function retrieves the list of GPOs for the specified user or computer. (ANSI) |
| GetGPOListW The GetGPOList function retrieves the list of GPOs for the specified user or computer. (Unicode) |
| GetProfilesDirectoryA Retrieves the path to the root directory where user profiles are stored. (ANSI) |
| GetProfilesDirectoryW Retrieves the path to the root directory where user profiles are stored. (Unicode) |
| GetProfileType Retrieves the type of profile loaded for the current user. |
| GetUserProfileDirectoryA Retrieves the path to the root directory of the specified user's profile. (ANSI) |
| GetUserProfileDirectoryW Retrieves the path to the root directory of the specified user's profile. (Unicode) |
| LeaveCriticalPolicySection The LeaveCriticalPolicySection function resumes the background application of policy. This function closes the handle to the policy section. |
| LoadUserProfileA Loads the specified user's profile. The profile can be a local user profile or a roaming user profile. (ANSI) |
| LoadUserProfileW Loads the specified user's profile. The profile can be a local user profile or a roaming user profile. (Unicode) |
| ProcessGroupPolicyCompleted The ProcessGroupPolicyCompleted function notifies the system that the specified extension has finished applying policy. |
| ProcessGroupPolicyCompletedEx The ProcessGroupPolicyCompletedEx function notifies the system that the specified policy extension has finished applying policy. The function also reports the status of Resultant Set of Policy (RSoP) logging. |
| RefreshPolicy The RefreshPolicy function causes policy to be applied immediately on the client computer. |
| RefreshPolicyEx The RefreshPolicyEx function causes policy to be applied immediately on the computer. The extended function allows you to specify the type of policy refresh to apply. |
| RegisterGPNotification The RegisterGPNotification function enables an application to receive notification when there is a change in policy. When a policy change occurs, the specified event object is set to the signaled state. |
| RsopAccessCheckByType The RSoPAccessCheckByType function determines whether a security descriptor grants a specified set of access rights to the client identified by an RSOPTOKEN. |
| RsopFileAccessCheck The RSoPFileAccessCheck function determines whether a file's security descriptor grants a specified set of file access rights to the client identified by an RSOPTOKEN. |
| RsopResetPolicySettingStatus The RSoPResetPolicySettingStatus function unlinks the RSOP_PolicySettingStatus instance from its RSOP_PolicySetting instance. |
| RsopSetPolicySettingStatus The RSoPSetPolicySettingStatus function creates an instance of RSOP_PolicySettingStatus and an instance of RSOP_PolicySettingLink. The function links (associates) RSOP_PolicySettingStatus to its RSOP_PolicySetting instance. |
| UnloadUserProfile Unloads a user's profile that was loaded by the LoadUserProfile function. The caller must have administrative privileges on the computer. For more information, see the Remarks section of the LoadUserProfile function. |
| UnregisterGPNotification The UnregisterGPNotification function unregisters the specified policy-notification handle from receiving policy change notifications. |
Callback functions
| PFNGENERATEGROUPPOLICY The GenerateGroupPolicy callback function is an application-defined callback function that each policy extension must export when generating RSoP data in the planning mode. |
| PFNPROCESSGROUPPOLICY The ProcessGroupPolicy function is an application-defined callback function used when applying policy. |
| PFNPROCESSGROUPPOLICYEX The ProcessGroupPolicyEx function is an application-defined callback function used when applying policy. |
| PFNSTATUSMESSAGECALLBACK The StatusMessageCallback function is an application-defined callback function used to display status messages when applying policy. |
Structures
| GROUP_POLICY_OBJECTA The GROUP_POLICY_OBJECT structure provides information about a GPO in a GPO list. (ANSI) |
| GROUP_POLICY_OBJECTW The GROUP_POLICY_OBJECT structure provides information about a GPO in a GPO list. (Unicode) |
| POLICYSETTINGSTATUSINFO The POLICYSETTINGSTATUSINFO structure provides information about a policy-setting event. |
| RSOP_TARGET The RSOP_TARGET structure contains computer and user information required by the GenerateGroupPolicy function. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for