diff --git a/R/blpAuthenticate.R b/R/blpAuthenticate.R index 57e4e4a..fbc01d5 100644 --- a/R/blpAuthenticate.R +++ b/R/blpAuthenticate.R @@ -27,9 +27,15 @@ ##' @param con A connection object as created by a \code{blpConnect} ##' call, and retrieved via the internal function ##' \code{defaultConnection}. -##' @return Not sure. May just be the side effect of having the -##' session authenticated. +##' @return The returned object should be passed to subsequent data +##' calls via bdp(), bds(), etc. ##' @author Whit Armstrong and Dirk Eddelbuettel +##' @examples +##' \dontrun{ +##' blpConnect(host=blpHost, port=blpPort) +##' blpid <- blpAuthenticate(uuid=blpUUID, ip=blpIP_address) +##' bdp("IBM US Equity", "NAME", identity=blpid) +##' } blpAuthenticate <- function(uuid, host="localhost", ip.address, con=defaultConnection()) { if (missing(ip.address)) { diff --git a/R/blpConnect.R b/R/blpConnect.R index 7df932e..559eee4 100644 --- a/R/blpConnect.R +++ b/R/blpConnect.R @@ -45,6 +45,8 @@ ##' environment. This effectively frees users from having to ##' explicitly create such an object. ##' @author Whit Armstrong and Dirk Eddelbuettel +##' @seealso Many SAPI and bPipe connections require authentication +##' via \code{blpAuthenticate} after \code{blpConnect}. ##' @examples ##' \dontrun{ ##' con <- blpConnect() # adjust as needed