SECXMLArchive::Read
Looks for an element with the specified tag name under the current Parent Element in the XML DOM and reads the data into the out parameter.
Defined in: xmlarch.h
Syntax
Read(LPCTSTR tagName, BYTE& by, BOOL bAssertOnFailure = FALSE)Read(LPCTSTR tagName, WORD& w, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR tagName, DWORD& dw, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR tagName, LONG& l, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR tagName, float& f, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR tagName, double& d, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR tagName, int& i, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR tagName, short& w, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR tagName, char& ch, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR tagName, unsigned& u, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR tagName, LPTSTR& lpBuff, UINT& nLen, BOOL bAssertOnFailure = FALSE, BOOL bTruncateOnOverflow = FALSE)
Read(LPCTSTR tagName, void*& lpBuf, UINT& nBuffLen, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR contextTagName, IXMLSerialize* pFormatter, BOOL bAssertOnFailure = FALSE)
Read(LPCTSTR tagName, CString& string, BOOL bAssertOnFailure = FALSE)
Return Value
TRUE if tag found, FALSE otherwise.
Parameters
tagName
Specifies the tag name of the element to be retrieved.
by
A reference where the result is stored.
w
A reference where the result is stored.
dw
A reference where the result is stored.
l
A reference where the result is stored.
f
A reference where the result is stored.
d
A reference where the result is stored.
n
A reference where the result is stored.
sh
A reference where the result is stored.
ch
A reference where the result is stored.
u
A reference where the result is stored.
str
A reference where the result is stored.
nLen
Specifies the size of the buffer.
lpBuff
A reference where the result is stored.
nBuffLen
Specifies the size of the buffer. If the size is not big enough, nLef is updated with the necessary size and the function returns TRUE with no update to lpBuff.
str
A reference where the result is stored.
pFormatter
A reference to a formatter which has XMLSerialize overriden and whose Read calls are executed in the context of the newly loaded element.
bTruncateOnOverflow
Specifies whether the retrieved string should be limited to the size specified. If FALSE and if the supplied buffer is not big enough, it is deleted and a new buffer created with the necessary size and str is bound to that buffer.
type
Type specifies whether to store it as string value (NODE_TEXT) the default or NODE_CDATA_SECTION
bAssertOnFailure
Flag indicated whether function should ASSERT if tag not found.
See Also
