ITelevisionServices::get_ClipboardFormat

[This is preliminary documentation and subject to change.]

The get_ClipboardFormat method returns the registration identifier of the clipboard format for show references.

HRESULT get_ClipboardFormat(
  long * plRetVal  // out
);
 

Parameters

plRetVal

Pointer to a long value that identifies the registered clipboard format for show references.

Return Values

Returns an HRESULT indicating success or failure. If the method succeeds, it returns S_OK. Otherwise, it returns an error code. For specific error codes, see the Winerror.h header file. To locate more information about Winerror.h, see Further Information on Television Services for the Client.

Remarks

The registration identifier is the value returned by the Win32 RegisterClipboardFormat function when the show reference format is entered in the registry.

QuickInfo

  Windows NT: Unsupported.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in tssadmin.odl.
  Import Library: Included as a resource in tssadmin.dll.
  Unicode: Yes.

See Also

ITelevisionServices::get_ClipboardFormatName