Customized Modes APIs

This group describes the APIs related to Customized modes. More...

Functions
int	ADL2_Display_CustomizedMode_Add (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLCustomMode customMode)
	Function to add a customized mode. More...
int	ADL2_Display_CustomizedMode_Delete (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int iIndex)
	Function to delete a customized mode. More...
int	ADL2_Display_CustomizedMode_Validate (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLCustomMode customMode, int *lpValid)
	Function to validate a customized mode. More...
int	ADL2_Display_CustomizedModeList_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, ADLCustomMode *lpCustomModeList, int iBuffSize)
	Function to retrieve the customized mode list. More...
int	ADL2_Display_CustomizedModeListNum_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDisplayIndex, int *lpListNum)
	Function to retrieve the number of customized modes. More...
int	ADL_Display_CustomizedMode_Add (int iAdapterIndex, int iDisplayIndex, ADLCustomMode customMode)
	Function to add a customized mode. More...
int	ADL_Display_CustomizedMode_Delete (int iAdapterIndex, int iDisplayIndex, int iIndex)
	Function to delete a customized mode. More...
int	ADL_Display_CustomizedMode_Validate (int iAdapterIndex, int iDisplayIndex, ADLCustomMode customMode, int *lpValid)
	Function to validate a customized mode. More...
int	ADL_Display_CustomizedModeList_Get (int iAdapterIndex, int iDisplayIndex, ADLCustomMode *lpCustomModeList, int iBuffSize)
	Function to retrieve the customized mode list. More...
int	ADL_Display_CustomizedModeListNum_Get (int iAdapterIndex, int iDisplayIndex, int *lpListNum)
	Function to retrieve the number of customized modes. More...

Detailed Description

This group describes the APIs related to Customized modes.

Function Documentation

ADL2_Display_CustomizedMode_Add()

int ADL2_Display_CustomizedMode_Add	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		ADLCustomMode	customMode
	)

Function to add a customized mode.

This function adds a custom mode to the customized mode list.

Supported Platforms:

Linux and 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]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]	customMode	The custom mode to be added to the list.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

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_Display_CustomizedMode_Delete()

int ADL2_Display_CustomizedMode_Delete	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int	iIndex
	)

Function to delete a customized mode.

This function deletes a custom mode from the customized mode list.

Supported Platforms:

Linux and 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]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]	iIndex	The index value of the mode to be deleted.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

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_Display_CustomizedMode_Validate()

int ADL2_Display_CustomizedMode_Validate	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		ADLCustomMode	customMode,
		int *	lpValid
	)

Function to validate a customized mode.

This function validates a custom mode from the customized mode list.

Supported Platforms:

Linux and 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]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]	customMode	The custom mode to be validated.
[out]	lpValid	The pointer to the retrieved validation bit.

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_Display_CustomizedModeList_Get()

int ADL2_Display_CustomizedModeList_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		ADLCustomMode *	lpCustomModeList,
		int	iBuffSize
	)

Function to retrieve the customized mode list.

This function retrieves the customized mode list for a specified display.

Supported Platforms:

Linux and 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]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpCustomModeList	The pointer to the list of the returned ADLCustomMode structures. The user should allocate the memory: Number of modes * sizeof ( ADLCustomMode )
[in]	iBuffSize	The size of the lpCustomModelist buffer.

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_Display_CustomizedModeListNum_Get()

int ADL2_Display_CustomizedModeListNum_Get	(	ADL_CONTEXT_HANDLE	context,
		int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpListNum
	)

Function to retrieve the number of customized modes.

This function retrieves the number of customized modes for a specified display.

Supported Platforms:

Linux and 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]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpListNum	The pointer to the number of available modes.

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.

ADL_Display_CustomizedMode_Add()

int ADL_Display_CustomizedMode_Add	(	int	iAdapterIndex,
		int	iDisplayIndex,
		ADLCustomMode	customMode
	)

Function to add a customized mode.

This function adds a custom mode to the customized mode list.

Supported Platforms:

Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]	customMode	The custom mode to be added to the list.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

ADL_Display_CustomizedMode_Delete()

int ADL_Display_CustomizedMode_Delete	(	int	iAdapterIndex,
		int	iDisplayIndex,
		int	iIndex
	)

Function to delete a customized mode.

This function deletes a custom mode from the customized mode list.

Supported Platforms:

Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]	iIndex	The index value of the mode to be deleted.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

Remarks

Call ADL_Flush_Driver_Data() after to persist settings on reboot.

ADL_Display_CustomizedMode_Validate()

int ADL_Display_CustomizedMode_Validate	(	int	iAdapterIndex,
		int	iDisplayIndex,
		ADLCustomMode	customMode,
		int *	lpValid
	)

Function to validate a customized mode.

This function validates a custom mode from the customized mode list.

Supported Platforms:

Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in]	customMode	The custom mode to be validated.
[out]	lpValid	The pointer to the retrieved validation bit.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

ADL_Display_CustomizedModeList_Get()

int ADL_Display_CustomizedModeList_Get	(	int	iAdapterIndex,
		int	iDisplayIndex,
		ADLCustomMode *	lpCustomModeList,
		int	iBuffSize
	)

Function to retrieve the customized mode list.

This function retrieves the customized mode list for a specified display.

Supported Platforms:

Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpCustomModeList	The pointer to the list of the returned ADLCustomMode structures. The user should allocate the memory: Number of modes * sizeof ( ADLCustomMode )
[in]	iBuffSize	The size of the lpCustomModelist buffer.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

ADL_Display_CustomizedModeListNum_Get()

int ADL_Display_CustomizedModeListNum_Get	(	int	iAdapterIndex,
		int	iDisplayIndex,
		int *	lpListNum
	)

Function to retrieve the number of customized modes.

This function retrieves the number of customized modes for a specified display.

Supported Platforms:

Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters

[in]	iAdapterIndex	The ADL index handle of the desired adapter.
[in]	iDisplayIndex	The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out]	lpListNum	The pointer to the number of available modes.

Returns

If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes