Collapse all Symbian^3 Application Developer Library

TBTPinCodeEntryNotifierParams Class Reference

class TBTPinCodeEntryNotifierParams : public TBTNotifierParams2

Simple secure pairing aware "PIN Code Entry" request parameters. This class packages the parameters passed to a PIN code entry notifier.

Inherits from

TBTPinCodeEntryNotifierParams
- TBTNotifierParams2

Public Member Functions
	TBTPinCodeEntryNotifierParams (const TBTDevAddr &, const TDesC &, TUint , TBool , TBool , TUint )
	TBTPinCodeEntryNotifierParams ()
IMPORT_C TBool	LocallyInitiated ()
IMPORT_C TUint	PinCodeMinLength ()
IMPORT_C TUint	RecommendedPinCodeMinLength ()
IMPORT_C TBool	StrongPinCodeRequired ()

Inherited Functions
	TBTNotifierParams2::DeviceAddress()const
	TBTNotifierParams2::DeviceName()const
	TBTNotifierParams2::TBTNotifierParams2()
	TBTNotifierParams2::TBTNotifierParams2(const TBTDevAddr &,const TDesC &)

Private Attributes
TBool	iLocallyInitiated
TUint32	iPadding1
TUint	iPinCodeMinLength
TUint32	iRecommendedPinCodeMinLength
TBool	iStrongPinCodeRequired

Constructor & Destructor Documentation

TBTPinCodeEntryNotifierParams(const TBTDevAddr &, const TDesC &, TUint, TBool, TBool, TUint)

IMPORT_C	TBTPinCodeEntryNotifierParams	(	const TBTDevAddr &	aDevAddr,
			const TDesC &	aDeviceName,
			TUint	aPinCodeMinLength,
			TBool	aLocallyInitiated,
			TBool	aStrongPinCodeRequired,
			TUint	aRecommendedPinCodeMinLength
		)

Parameters

const TBTDevAddr & aDevAddr
const TDesC & aDeviceName
TUint aPinCodeMinLength
TBool aLocallyInitiated
TBool aStrongPinCodeRequired
TUint aRecommendedPinCodeMinLength

TBTPinCodeEntryNotifierParams()

IMPORT_C

TBTPinCodeEntryNotifierParams

(

)

Default constructor. Required to allow the class to be packaged with the TPckg family of classes.

Member Functions Documentation

LocallyInitiated()

IMPORT_C TBool

LocallyInitiated

(

)

const

Accessor for indicating whether the PIN code entry process was initiated by a local request, or whether it was trigger by the remote device.

PinCodeMinLength()

IMPORT_C TUint

PinCodeMinLength

(

)

const

Accessor for the minimum PIN code length that should be enter into this notifier.

RecommendedPinCodeMinLength()

IMPORT_C TUint

RecommendedPinCodeMinLength

(

)

const

Accessor for the recommended minimum PIN code length that should be entered into this notifier. This is based on the length of the PIN code used in the previous pairing operation (if available), and is always greater than or equal to the required minimum PIN code length (as given by PinCodeMinLength() ). If the recommended minimum PIN code length is used, then the strength of the link key used in the previous pairing operation is at least maintained.

StrongPinCodeRequired()

IMPORT_C TBool

StrongPinCodeRequired

(

)

const

Accessor for determining if a strong PIN code is required. It should be used by a notifier to ensure that a suitably strong PIN code is entered by the user.