GetEventName (Compact 2013)

3/26/2014

This function returns an event name with a radio identifier.

Syntax

bool GetEventName(
    const TCHAR* const ptsEventName,
    const TCHAR* const ptsRadioIdentifier,
    TCHAR* const ptsNameWithIdentifier,
    const size_t stBufferLength
);

Parameters

  • [in] ptsEventName
    [in] Pointer to the event name.
  • [in] ptsRadioIdentifier
    [in] Pointer to the radio identifier.
  • [in,out] ptsNameWithIdentifier
    [in] Pointer to the storage area that the output will be placed into.

    [out] Pointer to the event name.

  • [in] stBufferLength
    [in] Size of the buffer allocated for ptsNameWithIdentifier.

Return Value

The following table shows the possible return values.

Value

Description

TRUE

The event name was successfully created. ptsNameWithIdentifier is valid.

FALSE

The event name was not created. ptsNameWithIdentifier is not valid.

Example

bool    bResult;
#define RILDRIVERPRESENT_EVENT TEXT("RILDrv_Present") 
TCHAR   ptsRadioIdentifier    [ MAXLENGTH_RADIO_IDENTIFIER ] = TEXT("RADIO2");
TCHAR   ptsNameWithIdentifier [ MAX_PATH ];

bResult = GetEventName( 
    RILDRIVERPRESENT_EVENT // "RILDrv_Present"       ptsEventName
  , ptsRadioIdentifier     // "RADIO2"               ptsRadioIdentifier
  , ptsNameWithIdentifier  // ptsNameWithIdentifier
  , MAX_PATH               // stBufferLength
    );

// ptsNameWithIdentifier now contains: "RILDrv_PresentRADIO2"

Remarks

This function is synchronous. An asynchronous result callback is not returned.

This function is for use in dual mode.

Requirements

Header

toolbox.h

Library

Ril.lib

See Also

Reference

RIL Functions
RIL Registry Settings