ReadFmtUserTypeStg

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

WINOLEAPI ReadFmtUserTypeStg(
  IStorage * pStg,  //Pointer to storage object holding the values
  CLIPFORMAT * pcf, //Pointer to return the clipboard format
  LPWSTR * lplpszUserType
                    //Address of output variable that receives a 
                    // pointer to the requested user type string
);
 

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 user type string. The caller can specify NULL for this parameter indicating 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 Values

This function supports the standard return values E_FAIL, E_INVALIDARG, and E_OUTOFMEMORY, as well as 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

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.

QuickInfo

  Windows NT: Use version 3.1 or later.
  Windows: Use Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in ole2.h.
  Import Library: Included as a resource in ole32.dll.

See Also

CoTaskMemFree, WriteFmtUserTypeStg