Security Service
[Telephony Mgr]

Detailed Description

This service groups the Telephony security functions.


Data Structures

struct  _AlpTelStyFacilities
struct  _AlpTelStyFacility

Defines

#define ALP_TEL_IS_STY_CHANGE_FACILITY_PASSWORD_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_STY_CHANGE_FACILITY_PASSWORD_MESSAGE)
#define ALP_TEL_IS_STY_ENTER_AUTHENTICATION_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_STY_ENTER_AUTHENTICATION_MESSAGE)
#define ALP_TEL_IS_STY_GET_AUTHENTICATION_STATUS_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_STY_GET_AUTHENTICATION_STATUS_MESSAGE)
#define ALP_TEL_IS_STY_GET_FACILITIES_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_STY_GET_FACILITIES_MESSAGE)
#define ALP_TEL_IS_STY_GET_FACILITY_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_STY_GET_FACILITY_MESSAGE)
#define ALP_TEL_IS_STY_LOCK_FACILITY_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_STY_LOCK_FACILITY_MESSAGE)
#define ALP_TEL_IS_STY_UNLOCK_FACILITY_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_STY_UNLOCK_FACILITY_MESSAGE)
#define ALP_TEL_STY_AUTH_CALL_BARRING   21
 This password is require when using Call Barring facility. This type of authentication should never be asked by modem, it's only send within user request.
#define ALP_TEL_STY_AUTH_CORPORATE_PIN   14
 Mobile is waiting corporate personalisation password to be given.
#define ALP_TEL_STY_AUTH_CORPORATE_PUK   15
 Mobile is waiting corporate personalisation unblocking password to be given.
#define ALP_TEL_STY_AUTH_EMERGENCY_ONLY   18
 Emergency only - Connection has been opened to dial emergency service (Output information in notification only).
#define ALP_TEL_STY_AUTH_NETWORK_PIN   8
 Mobile is waiting network personalisation password to be given.
#define ALP_TEL_STY_AUTH_NETWORK_PUK   9
 Mobile is waiting network personalisation unblocking password to be given.
#define ALP_TEL_STY_AUTH_NETWORK_SUBSET_PIN   10
 Mobile is waiting network subset personalisation password to be given.
#define ALP_TEL_STY_AUTH_NETWORK_SUBSET_PUK   11
 Mobile is waiting network subset personalisation unblocking password to be given.
#define ALP_TEL_STY_AUTH_NO_SIM   16
 No SIM inserted (Output information in notification only).
#define ALP_TEL_STY_AUTH_PHONE_TO_FIRST_SIM_PIN   4
 Mobile is waiting phone-to-very first SIM card password to be given.
#define ALP_TEL_STY_AUTH_PHONE_TO_FIRST_SIM_PUK   5
 Mobile is waiting phone-to-very first SIM card unblocking password to be given.
#define ALP_TEL_STY_AUTH_PHONE_TO_SIM_PIN   3
 Mobile is waiting phone-to-SIM card password to be given.
#define ALP_TEL_STY_AUTH_PROVIDER_PIN   12
 Mobile is waiting service provider personalisation password to be given.
#define ALP_TEL_STY_AUTH_PROVIDER_PUK   13
 Mobile is waiting service provider personalisation unblocking password to be given.
#define ALP_TEL_STY_AUTH_READY   0
 Mobile is not pending for any password.
#define ALP_TEL_STY_AUTH_SIM_DEACTIVATED   17
 The SIM has been deactivated (Output information in notification only).
#define ALP_TEL_STY_AUTH_SIM_NETWORK_PIN_DEACTIVATED   20
 The NETWORK PIN has been deactivated (Output information in notification only).
#define ALP_TEL_STY_AUTH_SIM_PIN   1
 Mobile is waiting SIM PIN to be given.
#define ALP_TEL_STY_AUTH_SIM_PIN_2   6
 Mobile is waiting SIM PIN2 to be given.
#define ALP_TEL_STY_AUTH_SIM_PIN_2_DEACTIVATED   19
 The SIM PIN 2 has been deactivated (Output information in notification only).
#define ALP_TEL_STY_AUTH_SIM_PUK   2
 Mobile is waiting SIM PUK to be given.
#define ALP_TEL_STY_AUTH_SIM_PUK_2   7
 Mobile is waiting SIM PUK2 to be given.
#define ALP_TEL_STY_CHANGE_FACILITY_PASSWORD_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0006)
#define ALP_TEL_STY_ENTER_AUTHENTICATION_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0001)
#define ALP_TEL_STY_FACILITY_STATUS_ACTIVE   1
#define ALP_TEL_STY_FACILITY_STATUS_NOT_ACTIVE   0
#define ALP_TEL_STY_FACILITY_TYPE_ALL_BAR   0x4142
 AB: All barring services.
#define ALP_TEL_STY_FACILITY_TYPE_ALL_IN   0x4149
 AI: Bar all incoming calls.
#define ALP_TEL_STY_FACILITY_TYPE_ALL_IN_BAR   0x4143
 AC: All incoming barring services.
#define ALP_TEL_STY_FACILITY_TYPE_ALL_OUT   0x414F
 AO: Bar all outgoing calls.
#define ALP_TEL_STY_FACILITY_TYPE_ALL_OUT_BAR   0x4147
 AG: All outgoing barring services.
#define ALP_TEL_STY_FACILITY_TYPE_CONTROL   0x4353
 CS: Lock CONTROL surface.
#define ALP_TEL_STY_FACILITY_TYPE_CORP_PERSO   0x5043
 PC: Corporate personnalisation.
#define ALP_TEL_STY_FACILITY_TYPE_FIRST_SIM   0x5046
 PF: First Sim entered.
#define ALP_TEL_STY_FACILITY_TYPE_IN_NOT_ANY   0x4E41
 NA: Bar incoming calls from numbers not stored to any memory.
#define ALP_TEL_STY_FACILITY_TYPE_IN_NOT_ME   0x4E4D
 NM: Bar incoming calls from numbers not stored to ME memory.
#define ALP_TEL_STY_FACILITY_TYPE_IN_NOT_SIM   0x4E53
 NS: Bar incoming calls from numbers not stored to SIM memory.
#define ALP_TEL_STY_FACILITY_TYPE_IN_NOT_TA   0x4E54
 NT: Bar incoming calls from numbers not stored to TA memory.
#define ALP_TEL_STY_FACILITY_TYPE_IN_ROAMING   0x4952
 IR: Bar incoming calls when roaming outside the home country.
#define ALP_TEL_STY_FACILITY_TYPE_NET_PERSO   0x504E
 PN: Network personnalisation.
#define ALP_TEL_STY_FACILITY_TYPE_NET_SUB_PERSO   0x5055
 PU: Network subset personnalisation.
#define ALP_TEL_STY_FACILITY_TYPE_OUT_INT   0x4F49
 OI: Bar outgoing international calls.
#define ALP_TEL_STY_FACILITY_TYPE_OUT_INT_EX_HOME   0x4F58
 OX: Bar outgoing international calls except home country.
#define ALP_TEL_STY_FACILITY_TYPE_PHONE_LOCK   0x4D45
 ME: Phone lock feature.
#define ALP_TEL_STY_FACILITY_TYPE_PHONE_SIM   0x5053
 PS: Lock phone to sim card, ask password when other SIM than current is inserted.
#define ALP_TEL_STY_FACILITY_TYPE_SER_PRO_PERSO   0x5050
 PP: Service provider personnalisation.
#define ALP_TEL_STY_FACILITY_TYPE_SIM   0x5343
 SC: SIM PIN 1.
#define ALP_TEL_STY_FACILITY_TYPE_SIM_FIX_DIAL   0x4644
 FD: SIM fixed dialling memory.
#define ALP_TEL_STY_FACILITY_TYPE_SIM_PIN_2   0x5032
 P2: SIM PIN 2.
#define ALP_TEL_STY_GET_AUTHENTICATION_STATUS_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0000)
#define ALP_TEL_STY_GET_FACILITIES_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0002)
#define ALP_TEL_STY_GET_FACILITY_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0003)
#define ALP_TEL_STY_LOCK_FACILITY_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0004)
#define ALP_TEL_STY_MESSAGES_COUNT   ((ALP_TEL_STY_CHANGE_FACILITY_PASSWORD_MESSAGE & ALP_TEL_MESSAGE_MASK) + 1)
 Total count of security service messages.
#define ALP_TEL_STY_PASSWORD_MAX_SIZE   8
#define ALP_TEL_STY_UNLOCK_FACILITY_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0005)

Typedefs

typedef _AlpTelStyFacilities AlpTelStyFacilities
typedef _AlpTelStyFacility AlpTelStyFacility

Functions

alp_status_t alp_tel_sty_change_facility_password (AlpTelApplicationId iAppId, uint16_t iFacilityType, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_sty_enter_authentication (AlpTelApplicationId iAppId, uint16_t iAuthenticationType, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_sty_get_authentication_status (AlpTelApplicationId iAppId, uint8_t *oAuthenticationP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_sty_get_facilities (AlpTelApplicationId iAppId, AlpTelStyFacilities *ioFacilitiesP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_sty_get_facility (AlpTelApplicationId iAppId, AlpTelStyFacility *ioFacilityP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_sty_lock_facility (AlpTelApplicationId iAppId, AlpTelStyFacility *iFacilityP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_sty_unlock_facility (AlpTelApplicationId iAppId, AlpTelStyFacility *iFacilityP, AlpTelTransId *ioTransIdP)

Define Documentation

#define ALP_TEL_IS_STY_CHANGE_FACILITY_PASSWORD_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_STY_CHANGE_FACILITY_PASSWORD_MESSAGE)
 

#define ALP_TEL_IS_STY_ENTER_AUTHENTICATION_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_STY_ENTER_AUTHENTICATION_MESSAGE)
 

#define ALP_TEL_IS_STY_GET_AUTHENTICATION_STATUS_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_STY_GET_AUTHENTICATION_STATUS_MESSAGE)
 

#define ALP_TEL_IS_STY_GET_FACILITIES_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_STY_GET_FACILITIES_MESSAGE)
 

#define ALP_TEL_IS_STY_GET_FACILITY_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_STY_GET_FACILITY_MESSAGE)
 

#define ALP_TEL_IS_STY_LOCK_FACILITY_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_STY_LOCK_FACILITY_MESSAGE)
 

#define ALP_TEL_IS_STY_UNLOCK_FACILITY_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_STY_UNLOCK_FACILITY_MESSAGE)
 

#define ALP_TEL_STY_AUTH_CALL_BARRING   21
 

This password is require when using Call Barring facility. This type of authentication should never be asked by modem, it's only send within user request.

#define ALP_TEL_STY_AUTH_CORPORATE_PIN   14
 

Mobile is waiting corporate personalisation password to be given.

#define ALP_TEL_STY_AUTH_CORPORATE_PUK   15
 

Mobile is waiting corporate personalisation unblocking password to be given.

#define ALP_TEL_STY_AUTH_EMERGENCY_ONLY   18
 

Emergency only - Connection has been opened to dial emergency service (Output information in notification only).

#define ALP_TEL_STY_AUTH_NETWORK_PIN   8
 

Mobile is waiting network personalisation password to be given.

#define ALP_TEL_STY_AUTH_NETWORK_PUK   9
 

Mobile is waiting network personalisation unblocking password to be given.

#define ALP_TEL_STY_AUTH_NETWORK_SUBSET_PIN   10
 

Mobile is waiting network subset personalisation password to be given.

#define ALP_TEL_STY_AUTH_NETWORK_SUBSET_PUK   11
 

Mobile is waiting network subset personalisation unblocking password to be given.

#define ALP_TEL_STY_AUTH_NO_SIM   16
 

No SIM inserted (Output information in notification only).

#define ALP_TEL_STY_AUTH_PHONE_TO_FIRST_SIM_PIN   4
 

Mobile is waiting phone-to-very first SIM card password to be given.

#define ALP_TEL_STY_AUTH_PHONE_TO_FIRST_SIM_PUK   5
 

Mobile is waiting phone-to-very first SIM card unblocking password to be given.

#define ALP_TEL_STY_AUTH_PHONE_TO_SIM_PIN   3
 

Mobile is waiting phone-to-SIM card password to be given.

#define ALP_TEL_STY_AUTH_PROVIDER_PIN   12
 

Mobile is waiting service provider personalisation password to be given.

#define ALP_TEL_STY_AUTH_PROVIDER_PUK   13
 

Mobile is waiting service provider personalisation unblocking password to be given.

#define ALP_TEL_STY_AUTH_READY   0
 

Mobile is not pending for any password.

#define ALP_TEL_STY_AUTH_SIM_DEACTIVATED   17
 

The SIM has been deactivated (Output information in notification only).

#define ALP_TEL_STY_AUTH_SIM_NETWORK_PIN_DEACTIVATED   20
 

The NETWORK PIN has been deactivated (Output information in notification only).

#define ALP_TEL_STY_AUTH_SIM_PIN   1
 

Mobile is waiting SIM PIN to be given.

#define ALP_TEL_STY_AUTH_SIM_PIN_2   6
 

Mobile is waiting SIM PIN2 to be given.

#define ALP_TEL_STY_AUTH_SIM_PIN_2_DEACTIVATED   19
 

The SIM PIN 2 has been deactivated (Output information in notification only).

#define ALP_TEL_STY_AUTH_SIM_PUK   2
 

Mobile is waiting SIM PUK to be given.

#define ALP_TEL_STY_AUTH_SIM_PUK_2   7
 

Mobile is waiting SIM PUK2 to be given.

#define ALP_TEL_STY_CHANGE_FACILITY_PASSWORD_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0006)
 

#define ALP_TEL_STY_ENTER_AUTHENTICATION_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0001)
 

#define ALP_TEL_STY_FACILITY_STATUS_ACTIVE   1
 

#define ALP_TEL_STY_FACILITY_STATUS_NOT_ACTIVE   0
 

#define ALP_TEL_STY_FACILITY_TYPE_ALL_BAR   0x4142
 

AB: All barring services.

#define ALP_TEL_STY_FACILITY_TYPE_ALL_IN   0x4149
 

AI: Bar all incoming calls.

#define ALP_TEL_STY_FACILITY_TYPE_ALL_IN_BAR   0x4143
 

AC: All incoming barring services.

#define ALP_TEL_STY_FACILITY_TYPE_ALL_OUT   0x414F
 

AO: Bar all outgoing calls.

#define ALP_TEL_STY_FACILITY_TYPE_ALL_OUT_BAR   0x4147
 

AG: All outgoing barring services.

#define ALP_TEL_STY_FACILITY_TYPE_CONTROL   0x4353
 

CS: Lock CONTROL surface.

#define ALP_TEL_STY_FACILITY_TYPE_CORP_PERSO   0x5043
 

PC: Corporate personnalisation.

#define ALP_TEL_STY_FACILITY_TYPE_FIRST_SIM   0x5046
 

PF: First Sim entered.

#define ALP_TEL_STY_FACILITY_TYPE_IN_NOT_ANY   0x4E41
 

NA: Bar incoming calls from numbers not stored to any memory.

#define ALP_TEL_STY_FACILITY_TYPE_IN_NOT_ME   0x4E4D
 

NM: Bar incoming calls from numbers not stored to ME memory.

#define ALP_TEL_STY_FACILITY_TYPE_IN_NOT_SIM   0x4E53
 

NS: Bar incoming calls from numbers not stored to SIM memory.

#define ALP_TEL_STY_FACILITY_TYPE_IN_NOT_TA   0x4E54
 

NT: Bar incoming calls from numbers not stored to TA memory.

#define ALP_TEL_STY_FACILITY_TYPE_IN_ROAMING   0x4952
 

IR: Bar incoming calls when roaming outside the home country.

#define ALP_TEL_STY_FACILITY_TYPE_NET_PERSO   0x504E
 

PN: Network personnalisation.

#define ALP_TEL_STY_FACILITY_TYPE_NET_SUB_PERSO   0x5055
 

PU: Network subset personnalisation.

#define ALP_TEL_STY_FACILITY_TYPE_OUT_INT   0x4F49
 

OI: Bar outgoing international calls.

#define ALP_TEL_STY_FACILITY_TYPE_OUT_INT_EX_HOME   0x4F58
 

OX: Bar outgoing international calls except home country.

#define ALP_TEL_STY_FACILITY_TYPE_PHONE_LOCK   0x4D45
 

ME: Phone lock feature.

#define ALP_TEL_STY_FACILITY_TYPE_PHONE_SIM   0x5053
 

PS: Lock phone to sim card, ask password when other SIM than current is inserted.

#define ALP_TEL_STY_FACILITY_TYPE_SER_PRO_PERSO   0x5050
 

PP: Service provider personnalisation.

#define ALP_TEL_STY_FACILITY_TYPE_SIM   0x5343
 

SC: SIM PIN 1.

#define ALP_TEL_STY_FACILITY_TYPE_SIM_FIX_DIAL   0x4644
 

FD: SIM fixed dialling memory.

#define ALP_TEL_STY_FACILITY_TYPE_SIM_PIN_2   0x5032
 

P2: SIM PIN 2.

#define ALP_TEL_STY_GET_AUTHENTICATION_STATUS_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0000)
 

#define ALP_TEL_STY_GET_FACILITIES_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0002)
 

#define ALP_TEL_STY_GET_FACILITY_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0003)
 

#define ALP_TEL_STY_LOCK_FACILITY_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0004)
 

#define ALP_TEL_STY_MESSAGES_COUNT   ((ALP_TEL_STY_CHANGE_FACILITY_PASSWORD_MESSAGE & ALP_TEL_MESSAGE_MASK) + 1)
 

Total count of security service messages.

#define ALP_TEL_STY_PASSWORD_MAX_SIZE   8
 

#define ALP_TEL_STY_UNLOCK_FACILITY_MESSAGE   ((ALP_TEL_STY_SERVICE_ID << 8) | 0x0005)
 

Typedef Documentation

typedef struct _AlpTelStyFacilities AlpTelStyFacilities
 

typedef struct _AlpTelStyFacility AlpTelStyFacility
 

Function Documentation

alp_status_t alp_tel_sty_change_facility_password (  AlpTelApplicationId  iAppId,
uint16_t  iFacilityType,
AlpTelTransId *  ioTransIdP
) 
 

Changes the password of a facility.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iFacilityType The type of facility whose password is being changed.
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The facility password has been changed successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_sty_enter_authentication (  AlpTelApplicationId  iAppId,
uint16_t  iAuthenticationType,
AlpTelTransId *  ioTransIdP
) 
 

Displays a user interface to let the user enter the password that the phone is currently waiting for.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iAuthenticationType The type of authentication that the phone is waiting for.
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The passord has been set successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_sty_get_authentication_status (  AlpTelApplicationId  iAppId,
uint8_t *  oAuthenticationP,
AlpTelTransId *  ioTransIdP
) 
 

Gets the type of authentication password, if any, that the phone is waiting for before it can be operated.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[out] oAuthenticationP Pointer to the authentication type needed, which is one of the constants ALP_TEL_STY_AUTH_XXX
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The authentication status has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_sty_get_facilities (  AlpTelApplicationId  iAppId,
AlpTelStyFacilities *  ioFacilitiesP,
AlpTelTransId *  ioTransIdP
) 
 

Gets a list of facility types supported by the phone, or the count of them.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] ioFacilitiesP Pointer to a TelStyFacilitiesType structure. Upon return, the idP field contains the list of facilities supported. On input, if you set the idP field to NULL and count to 0, then this function returns only the count of facilities in count, and ALP_STATUS_OK. No other facility information is returned.
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The list of facility has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_sty_get_facility (  AlpTelApplicationId  iAppId,
AlpTelStyFacility *  ioFacilityP,
AlpTelTransId *  ioTransIdP
) 
 

Gets the status of a facility.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] ioFacilityP Pointer to a TelStyFacilityType structure. On input, the 'type' field must contain one of the constants ALP_TEL_STY_FACILITY_TYPE_XXX Upon return, the 'status' field contains the status of the facility, which is one of ALP_TEL_STY_FACILITY_STATUS_XXX.
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The facility has been retrieved successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_sty_lock_facility (  AlpTelApplicationId  iAppId,
AlpTelStyFacility *  iFacilityP,
AlpTelTransId *  ioTransIdP
) 
 

Locks a facility.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iFacilityP Pointer to a AlpTelStyFacility structure. The 'type' field must contain one of the constants ALP_TEL_STY_FACILITY_TYPE_XXX.
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The facility has been lock successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_sty_unlock_facility (  AlpTelApplicationId  iAppId,
AlpTelStyFacility *  iFacilityP,
AlpTelTransId *  ioTransIdP
) 
 

Unlocks a facility.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in] iFacilityP Pointer to a AlpTelStyFacility structure. The 'type' field must contain one of the constants ALP_TEL_STY_FACILITY_TYPE_XXX.
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The facility has been unlock successfuly.
Since:
ALP iSDK 1.0

Generated on Wed Jul 30 07:06:43 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.