Application Profiles APIs


Functions

int ADL2_ApplicationProfiles_System_Reload (ADL_CONTEXT_HANDLE context)
 Function to Reload System appprofiles.
int ADL_ApplicationProfiles_System_Reload ()
 Function to Reload System appprofiles.
int ADL2_ApplicationProfiles_User_Load (ADL_CONTEXT_HANDLE context)
 Function to Load User appprofiles.
int ADL_ApplicationProfiles_User_Load ()
 Function to Load User appprofiles.
int ADL2_ApplicationProfiles_User_Unload (ADL_CONTEXT_HANDLE context)
 Function to Unload User appprofiles.
int ADL_ApplicationProfiles_User_Unload ()
 Function to Unload User appprofiles.
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.
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.
int ADL2_ApplicationProfiles_HitLists_Get (ADL_CONTEXT_HANDLE context, int iListType, int *lpNumApps, ADLApplicationData **lppAppList)
 Function to retrieve the recent application list from registry.
int ADL_ApplicationProfiles_HitLists_Get (int iListType, int *lpNumApps, ADLApplicationData **lppAppList)
 Function to retrieve the recent application list from registry.
int ADL2_ApplicationProfiles_HitListsX3_Get (ADL_CONTEXT_HANDLE context, int iListType, int *lpNumApps, ADLApplicationDataX3 **lppAppList)
 Function to retrieve the recent application list from registry.
int ADL2_ApplicationProfiles_HitListsX2_Get (ADL_CONTEXT_HANDLE context, int iListType, int *lpNumApps, ADLApplicationDataX2 **lppAppList)
 Function to retrieve the recent application list from registry.
int ADL_ApplicationProfiles_HitListsX2_Get (int iListType, int *lpNumApps, ADLApplicationDataX2 **lppAppList)
 Function to retrieve the recent application list from registry.

Detailed Description

This group outlines all Application Profiles APIs.

Function Documentation

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 (XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client'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.

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 (XP, Vista 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

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 (XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client'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.

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 (XP, Vista 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

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 (XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client'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.

int ADL_ApplicationProfiles_User_Unload (  ) 

Function to Unload User appprofiles.

This function Unloads User appprofiles by unloading user profile.

Supported Platforms:
Windows (XP, Vista 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

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 (XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] FileName Specifies the application file name
[in] Path Specifies the application file path
[in] Version Specifies the application version
[in] AppProfileArea Specifies the area the profile works on (like 'PX', 'D3D', etc. )
[out] lppProfile The 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.

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 (XP, Vista and above); 32bit and 64bit
Parameters:
[in] FileName Specifies the application file name
[in] Path Specifies the application file path
[in] Version Specifies the application version
[in] AppProfileArea Specifies the area the profile works on (like 'PX', 'D3D', etc. )
[out] lppProfile The 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.

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 (XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iListType Specifies the type of the list to retrieve, defined in ApplicationListType
[out] lpNumApps The pointer to the number of applications in the list.
[out] lppAppList The 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.

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 (XP, Vista and above); 32bit and 64bit
Parameters:
[in] iListType Specifies the type of the list to retrieve, defined in ApplicationListType
[out] lpNumApps The pointer to the number of applications in the list.
[out] lppAppList The 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.

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 (XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iListType Specifies the type of the list to retrieve, defined in ApplicationListType
[out] lpNumApps The pointer to the number of applications in the list.
[out] lppAppList The 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.

Examples:
PowerXPress/PowerXPress.cpp.

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 (XP, Vista and above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iListType Specifies the type of the list to retrieve, defined in ApplicationListType
[out] lpNumApps The pointer to the number of applications in the list.
[out] lppAppList The 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.

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 (XP, Vista and above); 32bit and 64bit
Parameters:
[in] iListType Specifies the type of the list to retrieve, defined in ApplicationListType
[out] lpNumApps The pointer to the number of applications in the list.
[out] lppAppList The 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.


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