FileDrmIsDRM

4/8/2010

This function enables an application to determine quickly if an object is FDRM-protected. An application can then display an indication that the content is FDRM-protected.

Syntax

HRESULT FileDrmIsDRM (
  LPCTSTR pszFile,
  PBOOL pfDRM
);

Parameters

  • pszFile
    [in] The fully qualified path to the file being checked, including the file extension.
  • pfDRM
    [out] A pointer to a BOOL variable that is set to TRUE if the object pointed to by the file is FDRM-protected; set to FALSE otherwise.

Return Values:

The function may return any HRESULT. Any errors that occur are returned as the HRESULT created by calling HRESULT_FROM_WIN32 with the value returned from GetLastError(). Applications should use the SUCCEEDED and FAILED macros to check the results. The following table shows additional HRESULT values that may be returned.

Value Description

S_FDRM_NOPROVIDER

Success, but no FDRM provider was found. The value pointed to by pfDRM is FALSE.

S_FDRM_NOTDRMOBJECT

Success, but the object pointed to is not a FDRM object. The value pointed to by pfDRM is FALSE.

Requirements

Header fdrm.h
Library aygshell.lib
Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later

See Also

Reference

FDRM API Reference
FDRM Functions