IAddrBook::GetSearchPath
S’applique à : Outlook 2013 | Outlook 2016
Retourne une liste ordonnée d’identificateurs d’entrée des conteneurs à inclure dans le processus de résolution de noms initié par la méthode IAddrBook ::ResolveName .
HRESULT GetSearchPath(
ULONG ulFlags,
LPSRowSet FAR * lppSearchPath
);
Paramètres
ulFlags
[in] Masque de bits d’indicateurs qui contrôle le type des chaînes retournées dans le chemin de recherche. L’indicateur suivant peut être défini :
MAPI_UNICODE
Les chaînes retournées sont au format Unicode. Si l’indicateur MAPI_UNICODE n’est pas défini, les chaînes sont au format ANSI.
lppSearchPath
[out] Pointeur vers un pointeur vers une liste ordonnée d’identificateurs d’entrée de conteneur. GetSearchPath stocke la liste ordonnée dans une structure SRowSet . S’il n’y a aucun conteneur dans la hiérarchie du carnet d’adresses, zéro est retourné dans la structure SRowSet .
Valeur renvoyée
S_OK
Le chemin de recherche a été récupéré avec succès.
Remarques
Les clients et les fournisseurs de services appellent la méthode GetSearchPath pour obtenir le chemin de recherche utilisé pour résoudre les noms avec la méthode ResolveName . En règle générale, les clients appellent la méthode IAddrBook ::SetSearchPath pour établir un chemin de recherche de conteneur dans le profil avant d’appeler GetSearchPath pour le récupérer. Toutefois, l’appel de SetSearchPath est facultatif.
Si SetSearchPath n’a jamais été appelé, GetSearchPath génère un chemin en parcourant les tables de hiérarchie du carnet d’adresses. Le chemin de recherche par défaut établi par GetSearchPath se compose des conteneurs suivants dans l’ordre suivant :
Le premier conteneur avec l’autorisation de lecture/écriture, généralement le carnet d’adresses personnel (PAB).
Chaque conteneur dont la propriété PR_DISPLAY_TYPE (PidTagDisplayType) est définie sur DT_GLOBAL. Ce paramètre indique que le conteneur contient les destinataires.
Conteneur désigné comme conteneur par défaut, s’il n’y a aucun conteneur dont l’indicateur DT_GLOBAL est défini dans leur propriété PR_DISPLAY_TYPE et que le conteneur par défaut diffère du premier conteneur avec l’autorisation de lecture/écriture.
Si SetSearchPath a été appelé, GetSearchPath génère un chemin à l’aide des conteneurs de carnet d’adresses qui ont été stockés dans le profil. GetSearchPath valide ce chemin avant de le renvoyer à l’appelant.
Après le premier appel à SetSearchPath, les appels suivants à SetSearchPath doivent être utilisés pour modifier le chemin de recherche retourné par GetSearchPath. En d’autres termes, le client ou le fournisseur appelant ne reçoit pas le chemin de recherche par défaut après le premier appel à SetSearchPath.