Método IKnownFolderManager::GetFolderByName (shobjidl_core.h)

Obtiene un objeto que representa una carpeta conocida identificada por su nombre canónico. El objeto permite consultar determinadas propiedades de carpeta, obtener la ruta de acceso actual de la carpeta, redirigir la carpeta a otra ubicación y obtener la ruta de acceso de la carpeta como ITEMIDLIST.

Sintaxis

HRESULT GetFolderByName(
  [in]  LPCWSTR      pszCanonicalName,
  [out] IKnownFolder **ppkf
);

Parámetros

[in] pszCanonicalName

Tipo: LPCWSTR

Puntero al nombre canónico no localizado de la carpeta conocida, almacenada como una cadena Unicode terminada en null. Si esta carpeta es una carpeta común o por usuario , este valor también se usa como nombre de valor de la configuración del Registro "Carpetas de Shell de usuario". Este valor se recupera a través del miembro pszName de la estructura KNOWNFOLDER_DEFINITION de la carpeta.

[out] ppkf

Tipo: IKnownFolder**

Cuando este método vuelve, contiene la dirección de un puntero al objeto IKnownFolder que representa la carpeta conocida.

Valor devuelto

Tipo: HRESULT

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Cuándo usar

Requisitos

Consulte también

IKnownFolderManager

Ejemplo de carpetas conocidas