description | title | ms.date | ms.topic | f1_keywords | helpviewer_keywords | author | ms.author | manager | ms.subservice | ||
---|---|---|---|---|---|---|---|---|---|---|---|
This function retrieves a variety of user-specific options. |
SccGetUserOption Function |
11/04/2016 |
reference |
|
|
maiak |
maiak |
mijacobs |
extensibility-integration |
This function retrieves a variety of user-specific options.
SCCRTN SccGetUserOption(
LPVOID pContext,
LONG nOption,
LPLONG lpVal
);
pContext
[in] The source control plug-in context pointer.
nOption
[in] Option to retrieve (see Remarks for possible options).
lpVal
[out] Value associated with option.
The source control plug-in implementation of this function is expected to return one of the following values:
Value | Description |
---|---|
SCC_OK | Option was retrieved successfully. |
SCC_E_OPNOTSUPPORTED | Option is not supported. |
SCC_E_NONSPECIFICERROR | An unspecified error occurred. |
The following options are supported by this command:
User Option | Description |
---|---|
SCC_USEROPT_CHECKOUT_LOCALVER |
Determines whether the user wants to check out local version of files. lpVal is assigned SCC_USEROPT_COLV_YES (user wants to check out local files) or SCC_USEROPT_COLV_NO . |