PBORCA_SccGetConnectProperties
Description
Returns the SCC connection properties associated with a PowerBuilder
workspace.
Syntax
|
1 2 3 |
INT PBORCA_SccGetConnectProperties ( HPBORCA hORCASession, LPTSTR pWorkspaceFile, PBORCA_SCC *pConfig ); |
|
Argument |
Description |
|---|---|
|
hORCASession |
Handle to previously established ORCA |
|
pWorkspaceFile |
Fully qualified or relative file name of the |
|
*pConfig |
Pointer to a preallocated structure typically |
Return value
INT. Typical return codes are:
|
Return code |
Description |
|---|---|
|
0 PBORCA_OK |
Operation successful |
|
-3 PBORCA_OBJNOTFOUND |
Could not find workspace file |
Usage
This method simplifies the SCC connection process. Property values
returned from the workspace you include as an argument in the
PBORCA_SccGetConnectProperties call are stored in a preallocated
structure, PBORCA_SCC. These properties allow a successful connection to a
given SCC provider and project, but you can override any of these
properties.
The PBORCA_SCC structure is defined as follows:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
typedef struct pborca_scc { HWND hWnd; TCHAR szProviderName [PBORCA_SCC_NAME_LEN + 1]; LONG *plCapabilities; TCHAR szUserID [PBORCA_SCC_USER_LEN + 1]; TCHAR szProject [PBORCA_SCC_PATH_LEN + 1]; TCHAR szLocalProjPath [PBORCA_SCC_PATH_LEN + 1]; TCHAR szAuxPath [PBORCA_SCC_PATH_LEN + 1]; TCHAR szLogFile [PBORCA_SCC_PATH_LEN + 1]; LPTEXTOUTPROC pMsgHandler; LONG *pCommentLen; LONG lAppend; LPVOID pCommBlk; } PBORCA_SCC; |
The variables in the PBORCA_SCC structure are described in the
following table:
|
Member |
Description |
|---|---|
|
hWnd |
Parent window handle whose value is typically |
|
szProviderName |
Name of the SCC provider. |
|
*plCapabilities |
Pointer to value returned by PBORCA_SccConnect. Used |
|
szUserID |
User ID for the source control |
|
szProject |
Name of the source control project. |
|
szLocalProjPath |
Local root directory for the project. |
|
szAuxPath |
The Auxiliary Project Path has different meaning for |
|
szLogFile |
Name of the log file for the SCC |
|
pMsgHandler |
Callback function for SCC messages. |
|
*pCommentLen |
Pointer to value returned by PBORCA_SccConnect. |
|
lAppend |
Determines whether to append to (lAppend=1) or |
|
pCommBlk |
Reserved for internal use. |
The property values added to the PBORCA_SCC structure after calling
the PBORCA_SccGetConnectProperties function are szProviderName, szUserID,
szProject, szLocalProjPath, szAuxPath, szLogFile, and lAppend. If you
manually add these values to the PBORCA_SCC structure, you do not need to
call the PBORCA_SccGetConnectProperties to connect to source
control.
See also