|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Telephony Security and Configuration Constants
This section describes the constants used with the telephony security and configuration service sets of the telephony API.
Authentication State Constants
The authentication state constants describe the current authentication state of the mobile unit connection.
Telephony Security and Configuration Functions
This section describes the data structures used with the telephony security and configuration service sets portion of the telephony API.
|
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioParamP | A pointer to a TelCfgGetPhoneNumberType structure that is filled in with the dial telephone number. |
<-> 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 errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
Points to the TelCfgGetPhoneNumberType structure passed to this function in the ioParamP parameter. |
functionId |
kTelCfgGetPhoneNumberMessage |
The connected dial telephone number is stored into the value field of the TelCfgGetPhoneNumberType structure referenced by ioParamP. If the value field buffer is too small to contain the complete telephone number, the string is truncated (and ends with the null terminator character) and this function returns the telErrBufferSize error. The size field of the structure is always updated to contain the actual size of the complete telephone number.
Before using this function, you should verify that it is available by calling the TelIsCfgServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelCfgSetSmsCenter, TelSmsSendMessage
Retrieve the SMS service center dial telephone number.
Err TelCfgGetSmsCenter(UInt16 iRefnum, TelAppID iAppId, TelCfgGetSmsCenterType* ioParamP, UInt16* ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioParamP | A pointer to a TelCfgGetSmsCenterType structure that is filled in with the dial telephone number. |
<-> 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 errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
Points to the TelCfgGetSmsCenterType structure passed to this function in the ioParamP parameter. |
functionId |
kTelCfgGetSmsCenterMessage |
The service center dial telephone number is stored into the value field of the TelCfgGetSmsCenterType structure referenced by ioParamP. If the value field buffer is too small to contain the complete telephone number, the string is truncated (and ends with the null terminator character) and this function returns the telErrBufferSize error. The size field of the structure is always updated to contain the actual size of the complete telephone number.
Before using this function, you should verify that it is available by calling the TelIsCfgServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelCfgSetSmsCenter, TelSmsSendMessage
Set the SMS service center dial telephone number.
Err TelCfgSetSmsCenter(UInt16 iRefnum, TelAppID iAppId, const Char* iDialNumberP, UInt16* ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iDialNumberP | A pointer to the null-terminated dial telephone number string for the SMS service center. |
<-> 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 errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
Before using this function, you should verify that it is available by calling the TelIsCfgServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelCfgGetSmsCenter, TelSmsSendMessage
Change the value of an authentication code. Note that you can only use this function with GSM networks.
Err TelStyChangeAuthenticationCode(UInt16 iRefnum, TelAppID iAppId, TelStyChangeAuthenticationType* iParamP, UInt16* ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iParamP | A pointer to a TelStyChangeAuthenticationType structure that contains the old and new authentication code values. |
<-> 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 errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
Points to the TelStyChangeAuthenticationType structure passed to this function in the iParamP parameter. |
functionId |
kTelStyChangeAuthenticationCodeMessage |
Before using this function, you should verify that it is available by calling the TelIsStyServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Enter the authentication code for which the phone is currently waiting. Note that you can only use this function with GSM networks.
Err TelStyEnterAuthenticationCode(UInt16 iRefnum, TelAppID iAppId, const Char* iCodeP, UInt16* ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iCodeP | A pointer to the null-terminated authentication code string to send to the phone. |
<-> 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 errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
Before using this function, you should verify that it is available by calling the TelIsStyServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelStyChangeAuthenticationCode, TelStyGetAuthenticationState
Returns the current state of user authentication.
Err TelStyGetAuthenticationState(UInt16 iRefnum, TelAppID iAppId, UInt8* oStateP, UInt16* ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<- oStateP | A pointer to an unsigned byte value. Upon return, this is the authentication state, which is one of the Authentication State Constants. |
<-> 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 errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
Before using this function, you should verify that it is available by calling the TelIsStyServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
|