Write the key in this component to the provided buffer.
Note, that the pcBytesWritten parameter can be set to NULL if the caller is not interested in the number of bytes written into the buffer. However, this parameter is also used to return the bytes required to copy the key into when pBuffer is set to NULL.
- Parameters
-
pBuffer | [ in ] Block of memory to write the key into, when NULL the required size of this buffer is returned in pcBytesWritten |
cBuffer | [ in ] Size (in bytes) of the memory block pointed to by pBuffer. |
pcBytesWritten | [ out ] Returns the number of bytes written into pBuffer representing the key. This parameter cannot be NULL when pBuffer is also NULL. |
- Returns
Success | P6R::eOk | |
Failure | P6R::eNotInitialized | Object is in an incorrect state. |
P6R::eInvalidArg | pBuffer and pcBytesWritten cannot both be NULL. |
P6R::eFailAndException | Writting to the buffer failed. |
P6R::eTooSmall | pBuffer is too small to copy the key into. |