INameSpaceTreeControlFolderCapabilities::GetFolderCapabilities method

Gets a folder's capability to be filtered through the System.IsPinnedToNameSpaceTree property key value and change notification registration status.

Syntax


HRESULT GetFolderCapabilities(
  [in]  NSTCFOLDERCAPABILITIES nfcMask,
  [out] NSTCFOLDERCAPABILITIES *pnstcfc
);

Parameters

nfcMask [in]

Type: NSTCFOLDERCAPABILITIES

The capabilities for which this method should retrieve values. Specify one or both of the following:

NSTCFC_PINNEDITEMFILTERING (0x00000001)

0x00000001. The System.IsPinnedToNameSpaceTree property exists on this folder and filtering based on that property value is supported.

NSTCFC_DELAY_REGISTER_NOTIFY (0x00000002)

0x00000002. Registration for change notifications is delayed until the folder is expanded in the navigation pane.

pnstcfc [out]

Type: NSTCFOLDERCAPABILITIES*

Pointer to a value that, when this method returns successfully, receives the capabilities requested in nfcMask. Except in the case of NSTCFC_NONE, bit values in positions not specifically requested in nfcMask do not necessarily reflect the capabilities and should not be used.

NSTCFC_NONE (0x00000000)

0x00000000. The System.IsPinnedToNameSpaceTree property does not exist on this folder. Filtering is not supported.

NSTCFC_PINNEDITEMFILTERING (0x00000001)

0x00000001. The System.IsPinnedToNameSpaceTree property exists on this folder and filtering based on that property value is supported.

NSTCFC_DELAY_REGISTER_NOTIFY (0x00000002)

0x00000002. Registration for change notifications is delayed until the folder is expanded in the navigation pane.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Shobjidl.h

IDL

Shobjidl.idl

 

 

Show: