ReadFmtUserTypeStg function
The ReadFmtUserTypeStg function returns the clipboard format and user type previously saved with the WriteFmtUserTypeStg function.
Syntax
WINOLEAPI ReadFmtUserTypeStg( _In_ IStorage *pStg, _Out_ CLIPFORMAT *pcf, _Out_ LPWSTR *lplpszUserType );
Parameters
- pStg [in]
-
Pointer to the IStorage interface on the storage object from which the information is to be read.
- pcf [out]
-
Pointer to where the clipboard format is to be written on return. It can be NULL, indicating the format is of no interest to the caller.
- lplpszUserType [out]
-
Address of LPWSTR pointer variable that receives a pointer to the null-terminated Unicode user-type string. The caller can specify NULL for this parameter, which indicates that the user type is of no interest. This function allocates memory for the string. The caller is responsible for freeing the memory with CoTaskMemFree.
Return value
This function supports the standard return values E_FAIL, E_INVALIDARG, and E_OUTOFMEMORY, in addition to the following:
- S_OK
-
The requested information was read successfully.
This function also returns any of the error values returned by the ISequentialStream::Read method.
Remarks
ReadFmtUserTypeStg 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.
Requirements
|
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also