ReadFmtUserTypeStg

Returns the clipboard format and user type previously saved with the WriteFmtUserTypeStg function.

HRESULT ReadFmtUserTypeStg(

IStorage * pStg,	//Points to storage object for which the values are to be retreived
CLIPFORMAT * pcf,	//Points to location for returning the clipboard format
LPWSTR * lplpszUserType	//Points to location for returning the user type string
);

Parameters
pStg

Points to the storage object from which the information is to be read.

pcf

Points to the location where the clipboard format is to be returned. It can be NULL, indicating the format is of no interest to the caller.

lplpszUserType

Points to the location where the user type string is to be returned. It can be NULL, indicating the user type is of no interest to the caller.

Return Values
S_OK

Indicates the requested information was read successfully.

E_OUTOFMEMORY

Indicates the information could not be retrieved due to a lack of memory.
E_FAIL

Indicates the WriteFmtUserTypeStg function was never called on the object.

See also the IStream::Read method for other error return values.

Comments
This function returns the clipboard format and the user type string from the specified storage object. The WriteClassStg function must have been called before calling the ReadFmtUserTypeStg function.