Syntax | LONG TSPI_phoneSetButtonInfo(dwRequestID, hdPhone, dwButtonLampID, lpButtonInfo) This function sets information about the specified button on the specified phone. |
Parameters | DRV_REQUESTID dwRequestID Specifies the identifier of the asynchronous request. The Service Provider returns this value if the function completes asynchronously. |
HDRVPHONE hdPhone Specifies the Service Provider's opaque handle to the phone for which button info is to be set. | |
DWORD dwButtonLampID Specifies a button on the phone device. | |
LPPHONEBUTTONINFO const lpButtonInfo Specifies a far pointer to a variable sized structure of type PHONEBUTTONINFO. This data structure describes the mode, the function, and provides additional descriptive text corresponding to the button. | |
Return Value | Returns zero if the function is successful, the (positive) dwRequestID value if the function will be completed asynchronously, or a negative error number if an error has occurred. Possible error returns are: |
PHONEERR_INVALPHONEHANDLE The specified device handle is invalid. | |
PHONEERR_INVALBUTTONLAMPID The specified button/lamp ID is invalid. | |
PHONEERR_INVALPOINTER The specified pointer parameter is invalid. | |
PHONEERR_OPERATIONUNAVAIL The specified operation is not available. | |
Comments | This function sets the meaning and associated descriptive text of a phone's buttons. |
See Also | Functions: TSPI_phoneGetButtonInfo Data Types: PHONEBUTTONINFO, PHONECAPS |