ADL (AMD Display Library) Public APIs  Version 17.1
Functions
Application Profiles APIs

This group outlines all Application Profiles APIs. More...

Functions

int ADL2_ApplicationProfiles_AppInterception_Set (ADL_CONTEXT_HANDLE context, int iAppType, unsigned int iProcId, int iEnabled)
 
int ADL2_ApplicationProfiles_AppInterceptionList_Set (ADL_CONTEXT_HANDLE context, int iAppType, int iNumberOfApps, ADLAppInterceptionInfo *lpAppInfo)
 
int ADL2_ApplicationProfiles_Applications_Get (ADL_CONTEXT_HANDLE context, const wchar_t *driverArea, int *numApps, ADLApplicationRecord **adlApplications)
 
int ADL2_ApplicationProfiles_AppStartStop_Resume (ADL_CONTEXT_HANDLE context, int iAppType, unsigned int ProcessId)
 
int ADL2_ApplicationProfiles_AppStartStopInfo_Get (ADL_CONTEXT_HANDLE context, int iAppType, ADLAppInterceptionInfo *lpAppInfo)
 
int ADL2_ApplicationProfiles_ConvertToCompact (ADL_CONTEXT_HANDLE context, CUSTOMISATIONS *pCustomisation, BINFILE *outCompact, int *outSize)
 
int ADL2_ApplicationProfiles_DriverAreaPrivacy_Get (ADL_CONTEXT_HANDLE context, const wchar_t *DriverArea, PRIVACYTYPES *outDriverAreaPrivacy)
 
int ADL2_ApplicationProfiles_GetCustomization (ADL_CONTEXT_HANDLE context, ADL_AP_DATABASE Databaseln, CUSTOMISATIONS *pCustomizationOut)
 
int ADL2_ApplicationProfiles_HitLists_Get (ADL_CONTEXT_HANDLE context, int iListType, int *lpNumApps, ADLApplicationData **lppAppList)
 Function to retrieve the recent application list from registry. More...
 
int ADL2_ApplicationProfiles_HitListsX2_Get (ADL_CONTEXT_HANDLE context, int iListType, int *lpNumApps, ADLApplicationDataX2 **lppAppList)
 Function to retrieve the recent application list from registry. More...
 
int ADL2_ApplicationProfiles_HitListsX3_Get (ADL_CONTEXT_HANDLE context, int iListType, int *lpNumApps, ADLApplicationDataX3 **lppAppList)
 Function to retrieve the recent application list from registry. More...
 
int ADL2_ApplicationProfiles_Profile_Create (ADL_CONTEXT_HANDLE context, const wchar_t *driverArea, const wchar_t *profileName, int numProperties, const ADLPropertyRecordCreate *propertyRecords)
 
int ADL2_ApplicationProfiles_Profile_Exist (ADL_CONTEXT_HANDLE context, const wchar_t *DriverArea, const wchar_t *ProfileName, BOOL *outExists)
 
int ADL2_ApplicationProfiles_Profile_Remove (ADL_CONTEXT_HANDLE context, const wchar_t *driverArea, const wchar_t *profileName)
 
int ADL2_ApplicationProfiles_ProfileApplication_Assign (ADL_CONTEXT_HANDLE context, const wchar_t *FileName, const wchar_t *Path, const wchar_t *Version, const wchar_t *DriverArea, const wchar_t *ProfileName)
 
int ADL2_ApplicationProfiles_ProfileApplicationX2_Assign (ADL_CONTEXT_HANDLE context, const wchar_t *FileName, const wchar_t *Path, const wchar_t *Version, const wchar_t *Title, const wchar_t *DriverArea, const wchar_t *ProfileName)
 
int ADL2_ApplicationProfiles_ProfileOfAnApplication_InMemorySearch (ADL_CONTEXT_HANDLE context, const wchar_t *fileName, const wchar_t *path, const wchar_t *version, const wchar_t *appProfileArea, ADLApplicationProfile **lppProfile)
 
int ADL2_ApplicationProfiles_ProfileOfAnApplication_Search (ADL_CONTEXT_HANDLE context, const char *FileName, const char *Path, const char *Version, const char *AppProfileArea, ADLApplicationProfile **lppProfile)
 Function to retrieve the profile of an application defined in driver. More...
 
int ADL2_ApplicationProfiles_ProfileOfAnApplicationX2_Search (ADL_CONTEXT_HANDLE context, const wchar_t *FileName, const wchar_t *Path, const wchar_t *Version, const wchar_t *AppProfileArea, ADLApplicationProfile **lppProfile)
 
int ADL2_ApplicationProfiles_PropertyType_Get (ADL_CONTEXT_HANDLE context, const wchar_t *DriverArea, const wchar_t *PropertyName, DATATYPES *outType)
 
int ADL2_ApplicationProfiles_Release_Get (ADL_CONTEXT_HANDLE context, wchar_t **strRelease)
 
int ADL2_ApplicationProfiles_RemoveApplication (ADL_CONTEXT_HANDLE context, const wchar_t *FileName, const wchar_t *Path, const wchar_t *Version, const wchar_t *DriverArea)
 
int ADL2_ApplicationProfiles_System_Reload (ADL_CONTEXT_HANDLE context)
 Function to Reload System appprofiles. More...
 
int ADL2_ApplicationProfiles_User_Load (ADL_CONTEXT_HANDLE context)
 Function to Load User appprofiles. More...
 
int ADL2_ApplicationProfiles_User_Unload (ADL_CONTEXT_HANDLE context)
 Function to Unload User appprofiles. More...
 
int ADL2_ApplicationProfilesX2_AppInterceptionList_Set (ADL_CONTEXT_HANDLE context, int iAppType, int iNumberOfApps, ADLAppInterceptionInfoX2 *lpAppInfo)
 
int ADL_ApplicationProfiles_Applications_Get (const wchar_t *driverArea, int *numApps, ADLApplicationRecord **adlApplications)
 
int ADL_ApplicationProfiles_ConvertToCompact (CUSTOMISATIONS *pCustomisation, BINFILE *outCompact, int *outSize)
 
int ADL_ApplicationProfiles_DriverAreaPrivacy_Get (const wchar_t *DriverArea, PRIVACYTYPES *outDriverAreaPrivacy)
 
int ADL_ApplicationProfiles_GetCustomization (ADL_AP_DATABASE Databaseln, CUSTOMISATIONS *pCustomizationOut)
 
int ADL_ApplicationProfiles_HitLists_Get (int iListType, int *lpNumApps, ADLApplicationData **lppAppList)
 Function to retrieve the recent application list from registry. More...
 
int ADL_ApplicationProfiles_HitListsX2_Get (int iListType, int *lpNumApps, ADLApplicationDataX2 **lppAppList)
 Function to retrieve the recent application list from registry. More...
 
int ADL_ApplicationProfiles_Profile_Create (const wchar_t *driverArea, const wchar_t *profileName, int numProperties, const ADLPropertyRecordCreate *propertyRecords)
 
int ADL_ApplicationProfiles_Profile_Exist (const wchar_t *DriverArea, const wchar_t *ProfileName, BOOL *outExists)
 
int ADL_ApplicationProfiles_Profile_Remove (const wchar_t *driverArea, const wchar_t *profileName)
 
int ADL_ApplicationProfiles_ProfileApplication_Assign (const wchar_t *FileName, const wchar_t *Path, const wchar_t *Version, const wchar_t *DriverArea, const wchar_t *ProfileName)
 
int ADL_ApplicationProfiles_ProfileApplicationX2_Assign (const wchar_t *FileName, const wchar_t *Path, const wchar_t *Version, const wchar_t *Title, const wchar_t *DriverArea, const wchar_t *ProfileName)
 
int ADL_ApplicationProfiles_ProfileOfAnApplication_InMemorySearch (const wchar_t *fileName, const wchar_t *path, const wchar_t *version, const wchar_t *appProfileArea, ADLApplicationProfile **lppProfile)
 
int ADL_ApplicationProfiles_ProfileOfAnApplication_Search (const char *FileName, const char *Path, const char *Version, const char *AppProfileArea, ADLApplicationProfile **lppProfile)
 Function to retrieve the profile of an application defined in driver. More...
 
int ADL_ApplicationProfiles_ProfileOfAnApplicationX2_Search (const wchar_t *FileName, const wchar_t *Path, const wchar_t *Version, const wchar_t *AppProfileArea, ADLApplicationProfile **lppProfile)
 
int ADL_ApplicationProfiles_PropertyType_Get (const wchar_t *DriverArea, const wchar_t *PropertyName, DATATYPES *outType)
 
int ADL_ApplicationProfiles_Release_Get (wchar_t **strRelease)
 
int ADL_ApplicationProfiles_RemoveApplication (const wchar_t *FileName, const wchar_t *Path, const wchar_t *Version, const wchar_t *DriverArea)
 
int ADL_ApplicationProfiles_System_Reload ()
 Function to Reload System appprofiles. More...
 
int ADL_ApplicationProfiles_User_Load ()
 Function to Load User appprofiles. More...
 
int ADL_ApplicationProfiles_User_Unload ()
 Function to Unload User appprofiles. More...
 
int GetAMDAdapterIndex (LPADLContext myContext)
 

Detailed Description

This group outlines all Application Profiles APIs.

Function Documentation

◆ ADL2_ApplicationProfiles_AppInterception_Set()

int ADL2_ApplicationProfiles_AppInterception_Set ( ADL_CONTEXT_HANDLE  context,
int  iAppType,
unsigned int  iProcId,
int  iEnabled 
)
Function to enable/disable application profile KMD interception

The API allows an user mode process to enable/disable KMD app profile interception

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAppTypeSpecify 1 for games
[in]iProcIdThe process id of the u ser mode process. KMD will stop interception if this process terminates for any reason.
[in]iEnabled1 - Enable, 0 - Disable the interception
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_ApplicationProfiles_AppInterceptionList_Set()

int ADL2_ApplicationProfiles_AppInterceptionList_Set ( ADL_CONTEXT_HANDLE  context,
int  iAppType,
int  iNumberOfApps,
ADLAppInterceptionInfo lpAppInfo 
)
Function to set the list of application that KMD needs to intercept

Sets the list of application that KMD needs to intercept

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAppTypeSpecify 1 for games
[in]iNumberOfAppsNumber of apps in the list
[in]lpAppInfoArray of App info in the list
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_ApplicationProfiles_Applications_Get()

int ADL2_ApplicationProfiles_Applications_Get ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  driverArea,
int *  numApps,
ADLApplicationRecord **  adlApplications 
)
Function to return list of applications declared in given driver area

This function builds and returns list of applications that exist in the given area of System, OEM and User blobs. User blob has precedence over OEM blob, OEM blob has precedence over System blob.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]driverAreaSpecifies driver area
[out]numAppsReturns number of application record in given driver area
[out]adlApplicationsReturns the pointer to application records
[in]allowDuplicationIf it's false and duplicated records of application exist (e.g. in System and User blob), then only one recored is returned, otherwise, return all same records from all blobs
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API builds and returns list of applications that exist in the given area of System, OEM and User blobs. User blob has precedence over OEM blob, OEM blob has precedence over System blob. *** This function CANNOT be used outside of AMD because the return parameter contains structure from internal "shared_escape.h"
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_AppStartStop_Resume()

int ADL2_ApplicationProfiles_AppStartStop_Resume ( ADL_CONTEXT_HANDLE  context,
int  iAppType,
unsigned int  ProcessId 
)
Function to resume a KMD suspended process

The API allows an user mode process to instruct KMD to resume a process that it has suspended

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAppTypeSpecify 1 for games
[in]ProcessIdThe id of the process that is to be resumed
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_ApplicationProfiles_AppStartStopInfo_Get()

int ADL2_ApplicationProfiles_AppStartStopInfo_Get ( ADL_CONTEXT_HANDLE  context,
int  iAppType,
ADLAppInterceptionInfo lpAppInfo 
)
Function to retrieve information about the recent App Start/Stop event

The API allows an user mode process to retrieve information about the recent App Start/Stop event

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in,out]lpAppInfoOne ADLAppInterceptionInfo strucuture. For input, specify the app state (APP_PROC_CREATION or APP_PROC_TERMINATE). ADL will fill in other information for output.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Function to retrieve information about the recent App Start/Stop event

The API allows an user mode process to retrieve information about the recent App Start/Stop event

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in,out]lpAppInfoOne ADLAppInterceptionInfo strucuture. ADL will fill in other information for output.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_ApplicationProfiles_ConvertToCompact()

int ADL2_ApplicationProfiles_ConvertToCompact ( ADL_CONTEXT_HANDLE  context,
CUSTOMISATIONS pCustomisation,
BINFILE outCompact,
int *  outSize 
)
Function to convert C style structures into Compact style for writing a blob file

This function converts C style structures into Compact style for writing a blob file

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]pCustomisationSpecifies pointer to Customization of database
[out]outCompactThe pointer to compact structure.
[out]outSizeThe size of compact structure
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API converts C style structures into Compact style for writing a blob file
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_DriverAreaPrivacy_Get()

int ADL2_ApplicationProfiles_DriverAreaPrivacy_Get ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  DriverArea,
PRIVACYTYPES outDriverAreaPrivacy 
)
Function to retrieve privacy type for the specified area

This function retrieves privacy type for the specified area

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]DriverAreaSpecifies driver area
[out]outDriverAreaPrivacyThe pointer to privacy for the specified area/
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API retrieves privacy type for the specified area
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_GetCustomization()

int ADL2_ApplicationProfiles_GetCustomization ( ADL_CONTEXT_HANDLE  context,
ADL_AP_DATABASE  Databaseln,
CUSTOMISATIONS pCustomizationOut 
)
Function to retrieve the pointer to Customization structure of the specified blob file

This function retrieves the pointer to Customization structure of the specified blob file.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]DatabaselnSpecifies the type of blob file
[out]pCustomizationOutThe pointer to Customization structure of the specified blob file
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API retrieves the pointer to Customization structure of the specified blob file
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_HitLists_Get()

int ADL2_ApplicationProfiles_HitLists_Get ( ADL_CONTEXT_HANDLE  context,
int  iListType,
int *  lpNumApps,
ADLApplicationData **  lppAppList 
)

Function to retrieve the recent application list from registry.

This function retrieves the recent application list from registry. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppAppList. Caller is responsible to de-allocate the memory.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iListTypeSpecifies the type of the list to retrieve, defined in ApplicationListType
[out]lpNumAppsThe pointer to the number of applications in the list.
[out]lppAppListThe pointer to the pointer to the retrieved application list from registry. Set it to NULL prior to call this API.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_HitListsX2_Get()

int ADL2_ApplicationProfiles_HitListsX2_Get ( ADL_CONTEXT_HANDLE  context,
int  iListType,
int *  lpNumApps,
ADLApplicationDataX2 **  lppAppList 
)

Function to retrieve the recent application list from registry.

This function retrieves the recent application list from registry. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppAppList. Caller is responsible to de-allocate the memory.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iListTypeSpecifies the type of the list to retrieve, defined in ApplicationListType
[out]lpNumAppsThe pointer to the number of applications in the list.
[out]lppAppListThe pointer to the pointer to the retrieved application list from registry. Set it to NULL prior to call this API.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_HitListsX3_Get()

int ADL2_ApplicationProfiles_HitListsX3_Get ( ADL_CONTEXT_HANDLE  context,
int  iListType,
int *  lpNumApps,
ADLApplicationDataX3 **  lppAppList 
)

Function to retrieve the recent application list from registry.

This function retrieves the recent application list from registry. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppAppList. Caller is responsible to de-allocate the memory.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iListTypeSpecifies the type of the list to retrieve, defined in ApplicationListType
[out]lpNumAppsThe pointer to the number of applications in the list.
[out]lppAppListThe pointer to the pointer to the retrieved application list from registry including process id. Set it to NULL prior to call this API.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_Profile_Create()

int ADL2_ApplicationProfiles_Profile_Create ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  driverArea,
const wchar_t *  profileName,
int  numProperties,
const ADLPropertyRecordCreate propertyRecords 
)
Function to create new application profile.

This function creates new application based on driver area, profile name and property records.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]driverAreaSpecifies driver area where profile declares
[in]profileNameSpecifies the name of profile to be created
[in]numPropertiesSpecifies the number of properties in the profile to be created
[in]propertyRecordsThe pointer to property records in the profile to be created
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API add a profile to the specified Area
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_Profile_Exist()

int ADL2_ApplicationProfiles_Profile_Exist ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  DriverArea,
const wchar_t *  ProfileName,
BOOL *  outExists 
)
Function to check if the specified profile exist or not in system blob.

This function checks if the specified profile exist or not in system blob.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]DriverAreaSpecifies driver area
[in]ProfileNameSpecifies the name of profile
[out]outExistsIndicates if the specified profile exists or not
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API checks if the specified profile exist or not in system blob.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_Profile_Remove()

int ADL2_ApplicationProfiles_Profile_Remove ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  driverArea,
const wchar_t *  profileName 
)
Function to remove the specified profile from the User blb.

This function removes the specified profile from the User blb.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]driverAreaSpecifies driver area where profile delcares
[in]profileNameSpecifies the name of profile to be removed
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API removes the specified profile from the User blb.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_ProfileApplication_Assign()

int ADL2_ApplicationProfiles_ProfileApplication_Assign ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  FileName,
const wchar_t *  Path,
const wchar_t *  Version,
const wchar_t *  DriverArea,
const wchar_t *  ProfileName 
)
Function to assign a profile in a new or existing application record.

This function assigns a profile in a new or existing application record.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]FileNameSpecifies the name of file
[in]PathSpecifies the path where file locates
[in]VersionSpecifies version
[in]DriverAreaSpecifies driver area where Profile exists
[in]ProfileNameSpecifies Profile to use
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API assigns a profile in a new or existing application record. If area exists, then override use record, otherwise, create a new use record
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_ProfileApplicationX2_Assign()

int ADL2_ApplicationProfiles_ProfileApplicationX2_Assign ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  FileName,
const wchar_t *  Path,
const wchar_t *  Version,
const wchar_t *  Title,
const wchar_t *  DriverArea,
const wchar_t *  ProfileName 
)
Function to assign a profile in a new or existing application record.

This function assigns a profile in a new or existing application record.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]FileNameSpecifies the name of file
[in]PathSpecifies the path where file locates
[in]VersionSpecifies version
[in]TitleSpecifies title
[in]DriverAreaSpecifies driver area where Profile exists
[in]ProfileNameSpecifies Profile to use
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API assigns a profile in a new or existing application record. If area exists, then override use record, otherwise, create a new use record
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_ProfileOfAnApplication_InMemorySearch()

int ADL2_ApplicationProfiles_ProfileOfAnApplication_InMemorySearch ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  fileName,
const wchar_t *  path,
const wchar_t *  version,
const wchar_t *  appProfileArea,
ADLApplicationProfile **  lppProfile 
)
Function to retrieve the profile of an application defined in driver.

This function provides capabilities which are identical to existing ADL_ApplicationProfiles_ProfileOfAnApplication_Search. Distinct of existing
This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppProfile. Caller is responsible to de-allocate the memory.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]fileNameSpecifies the name of file
[in]pathSpecifies the path where file locates
[in]versionSpecifies version
[in]appProfileAreaSpecifies driver area where Profile exists
[out]lppProfileThe pointer to the profile. Will be used to return profiles used by specific application record in the given driver area.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API removes the specified application record. rNote. OtNote that this function will ONLY reside in private portion of ADL for internal debug only, never exposed to public.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_ProfileOfAnApplication_Search()

int ADL2_ApplicationProfiles_ProfileOfAnApplication_Search ( ADL_CONTEXT_HANDLE  context,
const char *  FileName,
const char *  Path,
const char *  Version,
const char *  AppProfileArea,
ADLApplicationProfile **  lppProfile 
)

Function to retrieve the profile of an application defined in driver.

This function retrieves the profile information of an application. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppProfile. Caller is responsible to de-allocate the memory.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]FileNameSpecifies the application file name
[in]PathSpecifies the application file path
[in]VersionSpecifies the application version
[in]AppProfileAreaSpecifies the area the profile works on (like 'PX', 'D3D', etc. )
[out]lppProfileThe pointer to the pointer to the retrieved application profile. Set it to NULL prior to call this API.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API will be replaced with a new API that supports unicode. This API uses the memory allocation callback function provided by the user.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_ProfileOfAnApplicationX2_Search()

int ADL2_ApplicationProfiles_ProfileOfAnApplicationX2_Search ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  FileName,
const wchar_t *  Path,
const wchar_t *  Version,
const wchar_t *  AppProfileArea,
ADLApplicationProfile **  lppProfile 
)
Function to retrieve the profile of an application defined in driver.

This function retrieves the profile information of an application. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppProfile. Caller is responsible to de-allocate the memory.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]FileNameSpecifies the application file name
[in]PathSpecifies the application file path
[in]VersionSpecifies the application version
[in]AppProfileAreaSpecifies the area the profile works on (like 'PX', 'D3D', etc. )
[out]lppProfileThe pointer to the pointer to the retrieved application profile. Set it to NULL prior to call this API.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_PropertyType_Get()

int ADL2_ApplicationProfiles_PropertyType_Get ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  DriverArea,
const wchar_t *  PropertyName,
DATATYPES outType 
)
Function to retrieve data type for the specified property.

This function retrieves data type for the specified property.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]DriverAreaSpecifies driver area where Property belong to
[in]PropertyNameSpecifies name of property
[out]outTypeThe data type of property
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API retrieves data type for the specified property.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_Release_Get()

int ADL2_ApplicationProfiles_Release_Get ( ADL_CONTEXT_HANDLE  context,
wchar_t **  strRelease 
)
Function to return release of installed system application profile blob file.

This function returns release of installed system application profile blob file.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[out]strReleaseThe pointer to the stRelease.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API returns release of installed system application profile blob file.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_RemoveApplication()

int ADL2_ApplicationProfiles_RemoveApplication ( ADL_CONTEXT_HANDLE  context,
const wchar_t *  FileName,
const wchar_t *  Path,
const wchar_t *  Version,
const wchar_t *  DriverArea 
)
Function to remove the specified application record

This function removes the specified application record.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]FileNameSpecifies the name of file
[in]PathSpecifies the path where file locates
[in]VersionSpecifies version
[in]DriverAreaSpecifies driver area where Profile exists
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API removes the specified application record.
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_System_Reload()

int ADL2_ApplicationProfiles_System_Reload ( ADL_CONTEXT_HANDLE  context)

Function to Reload System appprofiles.

This function Reloads System appprofiles by reloading system profile and loading user profile.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_User_Load()

int ADL2_ApplicationProfiles_User_Load ( ADL_CONTEXT_HANDLE  context)

Function to Load User appprofiles.

This function Loads User appprofiles by loadding system profile and user profile.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfiles_User_Unload()

int ADL2_ApplicationProfiles_User_Unload ( ADL_CONTEXT_HANDLE  context)

Function to Unload User appprofiles.

This function Unloads User appprofiles by unloading user profile.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

◆ ADL2_ApplicationProfilesX2_AppInterceptionList_Set()

int ADL2_ApplicationProfilesX2_AppInterceptionList_Set ( ADL_CONTEXT_HANDLE  context,
int  iAppType,
int  iNumberOfApps,
ADLAppInterceptionInfoX2 lpAppInfo 
)
Second Version of function to set the application properties provided to KMD along with possible interception requirements

Sets the list of application that KMD might need to intercept, have choice to ask KMD to WaitToResume on app load or not

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iAppTypeSpecify 1 for games
[in]iNumberOfAppsNumber of apps in the list
[in]lpAppInfoArray of App info in the list
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_ApplicationProfiles_Applications_Get()

int ADL_ApplicationProfiles_Applications_Get ( const wchar_t *  driverArea,
int *  numApps,
ADLApplicationRecord **  adlApplications 
)
Function to return list of applications declared in given driver area

This function builds and returns list of applications that exist in the given area of System, OEM and User blobs. User blob has precedence over OEM blob, OEM blob has precedence over System blob.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]driverAreaSpecifies driver area
[out]numAppsReturns number of application record in given driver area
[out]adlApplicationsReturns the pointer to application records
[in]allowDuplicationIf it's false and duplicated records of application exist (e.g. in System and User blob), then only one recored is returned, otherwise, return all same records from all blobs
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API builds and returns list of applications that exist in the given area of System, OEM and User blobs. User blob has precedence over OEM blob, OEM blob has precedence over System blob. *** This function CANNOT be used outside of AMD because the return parameter contains structure from internal "shared_escape.h"

◆ ADL_ApplicationProfiles_ConvertToCompact()

int ADL_ApplicationProfiles_ConvertToCompact ( CUSTOMISATIONS pCustomisation,
BINFILE outCompact,
int *  outSize 
)
Function to convert C style structures into Compact style for writing a blob file

This function converts C style structures into Compact style for writing a blob file

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]pCustomisationSpecifies pointer to Customization of database
[out]outCompactThe pointer to compact structure.
[out]outSizeThe size of compact structure
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API converts C style structures into Compact style for writing a blob file

◆ ADL_ApplicationProfiles_DriverAreaPrivacy_Get()

int ADL_ApplicationProfiles_DriverAreaPrivacy_Get ( const wchar_t *  DriverArea,
PRIVACYTYPES outDriverAreaPrivacy 
)
Function to retrieve privacy type for the specified area

This function retrieves privacy type for the specified area

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]DriverAreaSpecifies driver area
[out]outDriverAreaPrivacyThe pointer to privacy for the specified area/
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API retrieves privacy type for the specified area

◆ ADL_ApplicationProfiles_GetCustomization()

int ADL_ApplicationProfiles_GetCustomization ( ADL_AP_DATABASE  Databaseln,
CUSTOMISATIONS pCustomizationOut 
)
Function to retrieve the pointer to Customization structure of the specified blob file

This function retrieves the pointer to Customization structure of the specified blob file.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]DatabaselnSpecifies the type of blob file
[out]pCustomizationOutThe pointer to Customization structure of the specified blob file
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API retrieves the pointer to Customization structure of the specified blob file

◆ ADL_ApplicationProfiles_HitLists_Get()

int ADL_ApplicationProfiles_HitLists_Get ( int  iListType,
int *  lpNumApps,
ADLApplicationData **  lppAppList 
)

Function to retrieve the recent application list from registry.

This function retrieves the recent application list from registry. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppAppList. Caller is responsible to de-allocate the memory.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iListTypeSpecifies the type of the list to retrieve, defined in ApplicationListType
[out]lpNumAppsThe pointer to the number of applications in the list.
[out]lppAppListThe pointer to the pointer to the retrieved application list from registry. Set it to NULL prior to call this API.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.

◆ ADL_ApplicationProfiles_HitListsX2_Get()

int ADL_ApplicationProfiles_HitListsX2_Get ( int  iListType,
int *  lpNumApps,
ADLApplicationDataX2 **  lppAppList 
)

Function to retrieve the recent application list from registry.

This function retrieves the recent application list from registry. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppAppList. Caller is responsible to de-allocate the memory.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]iListTypeSpecifies the type of the list to retrieve, defined in ApplicationListType
[out]lpNumAppsThe pointer to the number of applications in the list.
[out]lppAppListThe pointer to the pointer to the retrieved application list from registry. Set it to NULL prior to call this API.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.

◆ ADL_ApplicationProfiles_Profile_Create()

int ADL_ApplicationProfiles_Profile_Create ( const wchar_t *  driverArea,
const wchar_t *  profileName,
int  numProperties,
const ADLPropertyRecordCreate propertyRecords 
)
Function to create new application profile.

This function creates new application based on driver area, profile name and property records.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]driverAreaSpecifies driver area where profile declares
[in]profileNameSpecifies the name of profile to be created
[in]numPropertiesSpecifies the number of properties in the profile to be created
[in]propertyRecordsThe pointer to property records in the profile to be created
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API add a profile to the specified Area

◆ ADL_ApplicationProfiles_Profile_Exist()

int ADL_ApplicationProfiles_Profile_Exist ( const wchar_t *  DriverArea,
const wchar_t *  ProfileName,
BOOL *  outExists 
)
Function to check if the specified profile exist or not in system blob.

This function checks if the specified profile exist or not in system blob.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]DriverAreaSpecifies driver area
[in]ProfileNameSpecifies the name of profile
[out]outExistsIndicates if the specified profile exists or not
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API checks if the specified profile exist or not in system blob.

◆ ADL_ApplicationProfiles_Profile_Remove()

int ADL_ApplicationProfiles_Profile_Remove ( const wchar_t *  driverArea,
const wchar_t *  profileName 
)
Function to remove the specified profile from the User blb.

This function removes the specified profile from the User blb.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]driverAreaSpecifies driver area where profile delcares
[in]profileNameSpecifies the name of profile to be removed
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API removes the specified profile from the User blb.

◆ ADL_ApplicationProfiles_ProfileApplication_Assign()

int ADL_ApplicationProfiles_ProfileApplication_Assign ( const wchar_t *  FileName,
const wchar_t *  Path,
const wchar_t *  Version,
const wchar_t *  DriverArea,
const wchar_t *  ProfileName 
)
Function to assign a profile in a new or existing application record.

This function assigns a profile in a new or existing application record.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]FileNameSpecifies the name of file
[in]PathSpecifies the path where file locates
[in]VersionSpecifies version
[in]DriverAreaSpecifies driver area where Profile exists
[in]ProfileNameSpecifies Profile to use
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API assigns a profile in a new or existing application record. If area exists, then override use record, otherwise, create a new use record

◆ ADL_ApplicationProfiles_ProfileApplicationX2_Assign()

int ADL_ApplicationProfiles_ProfileApplicationX2_Assign ( const wchar_t *  FileName,
const wchar_t *  Path,
const wchar_t *  Version,
const wchar_t *  Title,
const wchar_t *  DriverArea,
const wchar_t *  ProfileName 
)
Function to assign a profile in a new or existing application record.

This function assigns a profile in a new or existing application record.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]FileNameSpecifies the name of file
[in]PathSpecifies the path where file locates
[in]VersionSpecifies version
[in]TitleSpecifies title
[in]DriverAreaSpecifies driver area where Profile exists
[in]ProfileNameSpecifies Profile to use
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API assigns a profile in a new or existing application record. If area exists, then override use record, otherwise, create a new use record

◆ ADL_ApplicationProfiles_ProfileOfAnApplication_InMemorySearch()

int ADL_ApplicationProfiles_ProfileOfAnApplication_InMemorySearch ( const wchar_t *  fileName,
const wchar_t *  path,
const wchar_t *  version,
const wchar_t *  appProfileArea,
ADLApplicationProfile **  lppProfile 
)
This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppProfile. Caller is responsible to de-allocate the memory.
Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]fileNameSpecifies the name of file
[in]pathSpecifies the path where file locates
[in]versionSpecifies version
[in]appProfileAreaSpecifies driver area where Profile exists
[out]lppProfileThe pointer to the profile. Will be used to return profiles used by specific application record in the given driver area.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API removes the specified application record. rNote. OtNote that this function will ONLY reside in private portion of ADL for internal debug only, never exposed to public.

◆ ADL_ApplicationProfiles_ProfileOfAnApplication_Search()

int ADL_ApplicationProfiles_ProfileOfAnApplication_Search ( const char *  FileName,
const char *  Path,
const char *  Version,
const char *  AppProfileArea,
ADLApplicationProfile **  lppProfile 
)

Function to retrieve the profile of an application defined in driver.

This function retrieves the profile information of an application. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppProfile. Caller is responsible to de-allocate the memory.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]FileNameSpecifies the application file name
[in]PathSpecifies the application file path
[in]VersionSpecifies the application version
[in]AppProfileAreaSpecifies the area the profile works on (like 'PX', 'D3D', etc. )
[out]lppProfileThe pointer to the pointer to the retrieved application profile. Set it to NULL prior to call this API.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API will be replaced with a new API that supports unicode. This API uses the memory allocation callback function provided by the user.

◆ ADL_ApplicationProfiles_ProfileOfAnApplicationX2_Search()

int ADL_ApplicationProfiles_ProfileOfAnApplicationX2_Search ( const wchar_t *  FileName,
const wchar_t *  Path,
const wchar_t *  Version,
const wchar_t *  AppProfileArea,
ADLApplicationProfile **  lppProfile 
)
Function to retrieve the profile of an application defined in driver.

This function retrieves the profile information of an application. This API uses the Caller's Memory Allocation Callback Function to allocate memory pointed by lppProfile. Caller is responsible to de-allocate the memory.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]FileNameSpecifies the application file name
[in]PathSpecifies the application file path
[in]VersionSpecifies the application version
[in]AppProfileAreaSpecifies the area the profile works on (like 'PX', 'D3D', etc. )
[out]lppProfileThe pointer to the pointer to the retrieved application profile. Set it to NULL prior to call this API.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API uses the memory allocation callback function provided by the user.

◆ ADL_ApplicationProfiles_PropertyType_Get()

int ADL_ApplicationProfiles_PropertyType_Get ( const wchar_t *  DriverArea,
const wchar_t *  PropertyName,
DATATYPES outType 
)
Function to retrieve data type for the specified property.

This function retrieves data type for the specified property.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]DriverAreaSpecifies driver area where Property belong to
[in]PropertyNameSpecifies name of property
[out]outTypeThe data type of property
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API retrieves data type for the specified property.

◆ ADL_ApplicationProfiles_Release_Get()

int ADL_ApplicationProfiles_Release_Get ( wchar_t **  strRelease)
Function to return release of installed system application profile blob file.

This function returns release of installed system application profile blob file.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[out]strReleaseThe pointer to the stRelease.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API returns release of installed system application profile blob file.

◆ ADL_ApplicationProfiles_RemoveApplication()

int ADL_ApplicationProfiles_RemoveApplication ( const wchar_t *  FileName,
const wchar_t *  Path,
const wchar_t *  Version,
const wchar_t *  DriverArea 
)
Function to remove the specified application record

This function removes the specified application record.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]FileNameSpecifies the name of file
[in]PathSpecifies the path where file locates
[in]VersionSpecifies version
[in]DriverAreaSpecifies driver area where Profile exists
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks
This API removes the specified application record.

◆ ADL_ApplicationProfiles_System_Reload()

int ADL_ApplicationProfiles_System_Reload ( )

Function to Reload System appprofiles.

This function Reloads System appprofiles by reloading system profile and loading user profile.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_ApplicationProfiles_User_Load()

int ADL_ApplicationProfiles_User_Load ( )

Function to Load User appprofiles.

This function Loads User appprofiles by loadding system profile and user profile.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_ApplicationProfiles_User_Unload()

int ADL_ApplicationProfiles_User_Unload ( )

Function to Unload User appprofiles.

This function Unloads User appprofiles by unloading user profile.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ GetAMDAdapterIndex()

int GetAMDAdapterIndex ( LPADLContext  myContext)

Copyright © 2009-2020 Advanced Micro Devices, Inc. All rights reserved.