Fork for the GitHub

Embed: (wiki syntax)

« Back to documentation index

LibEmail_Public_Functions

LibEmail_Public_Functions
[LibNFC_FORUMNFC_libraries]

This file is used to manage Email (stored or loaded in tag) More...

Functions

uint16_t NDEF_ReadEmail (sRecordInfo_t *pRecordStruct, sEmailInfo *pEmailStruct)
 This function read NDEF and retrieve Eamil information if any.
uint16_t NDEF_WriteEmail (sEmailInfo *pEmailStruct, I2C *mi2cChannel)
 This function write the NDEF file with the Email data given in the structure.
void NDEF_PrepareEmailMessage (sEmailInfo *pEmailStruct, uint8_t *pNDEFMessage, uint16_t *size)
 This function write the NDEF file with the Email data given in the structure.
void NDEF_closeEmail (sEmailInfo *pEmailStruct)
 This function close a NDEF Email buffer freeing associated memory.
uint16_t NDEF_WriteText (char *text, I2C *mi2cChannel)
 This function write the text in the TAG.
uint16_t NDEF_ReadText (sRecordInfo_t *pRecordStruct, NDEF_Text_info_t *pText)
 This function the Text information in a record if any.

Detailed Description

This file is used to manage Email (stored or loaded in tag)


Function Documentation

void NDEF_closeEmail ( sEmailInfo *  pEmailStruct )

This function close a NDEF Email buffer freeing associated memory.

Parameters:
pEmailStruct: pointer on structure that contain the Email information.

Definition at line 416 of file lib_NDEF_Email.cpp.

void NDEF_PrepareEmailMessage ( sEmailInfo *  pEmailStruct,
uint8_t *  pNDEFMessage,
uint16_t *  size 
)

This function write the NDEF file with the Email data given in the structure.

Parameters:
pEmailStruct: pointer on structure that contain the Email information.
pNDEFMessage: pointer on the NDEF message.
size: to store the size of the NDEF message generated.

Definition at line 271 of file lib_NDEF_Email.cpp.

uint16_t NDEF_ReadEmail ( sRecordInfo_t *  pRecordStruct,
sEmailInfo *  pEmailStruct 
)

This function read NDEF and retrieve Eamil information if any.

Parameters:
pRecordStruct: Pointer on the record structure.
pEmailStruct: pointer on the structure to fill .
Return values:
NDEF_OK: Email information from NDEF have been retrieved.
NDEF_ERROR: not able to read NDEF in tag.

Definition at line 204 of file lib_NDEF_Email.cpp.

uint16_t NDEF_ReadText ( sRecordInfo_t *  pRecordStruct,
NDEF_Text_info_t pText 
)

This function the Text information in a record if any.

Parameters:
pRecordStructPointer on a NDEF record structure.
pTextA pointer on a text information structure, used to return the text & its metadata.
Return values:
NDEF_OKText information has been retrieved.
NDEF_ERRORThe record is not a Text record.
NDEF_ERROR_MEMORY_INTERNALLanguage code or Text length is too big for the buffers.

Definition at line 121 of file lib_NDEF_Text.cpp.

uint16_t NDEF_WriteEmail ( sEmailInfo *  pEmailStruct,
I2C *  mi2cChannel 
)

This function write the NDEF file with the Email data given in the structure.

Parameters:
pEmailStruct: pointer on structure that contain the Email information.
Return values:
NDEF_OK: the function is successful.
NDEF_ERROR: not able to store NDEF in tag.
NDEF_ERROR_MEMORY_INTERNAL: Cannot write to tag.
NDEF_ERROR_NOT_FORMATED: CCFile data not supported or not present.
NDEF_ERROR_MEMORY_TAG: Size not compatible with memory.
NDEF_ERROR_LOCKED: Tag locked, cannot be write.

Definition at line 254 of file lib_NDEF_Email.cpp.

uint16_t NDEF_WriteText ( char *  text,
I2C *  mi2cChannel 
)

This function write the text in the TAG.

Parameters:
text: text to write.
Return values:
NDEF_OK: NDEF file data written in the tag.
NDEF_ERROR: not able to store NDEF in tag.
NDEF_ERROR_MEMORY_INTERNAL: Cannot write to tag.
NDEF_ERROR_NOT_FORMATED: CCFile data not supported or not present.
NDEF_ERROR_MEMORY_TAG: Size not compatible with memory.
NDEF_ERROR_LOCKED: Tag locked, cannot be write.

Definition at line 70 of file lib_NDEF_Text.cpp.