cRpcEmpCharacterOptional
Company code.
FUNCTIONUnder review
RpcSetEnv
RpcSetEnv([cRpcEmp],[cRpcFil],[cEnvUser],[cEnvPass],[cEnvMod],[cFunName],[aTables],[lShowFinal],[lAbend],[lOpenSX],[lConnect]) -> lRetOpens an automatic environment with company, branch and identity.
Overview
Returns .T. on successful preparation and .F. on failure, without replacing exception handling. TDN prohibits reopening/closing menu-owned environments and warns about Schedule and REST with PrepareIn. Since 12.1.2510, framework-prepared REST/SOAP may raise an exception. cEnvPass supports an authentication token only from LIB 20251117 under the cited contract, not an arbitrary external token. The GitHub sample embeds a credential and does not close the environment in that subset; those patterns were not carried over. (Sources: refs. 1–2.)
Syntax
RpcSetEnv([cRpcEmp],[cRpcFil],[cEnvUser],[cEnvPass],[cEnvMod],[cFunName],[aTables],[lShowFinal],[lAbend],[lOpenSX],[lConnect]) -> lRetParameters
cRpcFilCharacterOptional
Branch code.
cEnvUserCharacterOptional
Authorized user provided outside source.
cEnvPassCharacterOptional
Password or token only under the supported LIB contract; never log.
cEnvModCharacterOptional
Module; documented default FAT.
cFunNameCharacterOptional
Routine/audit identifier; default RPC.
aTablesArrayOptional
Aliases to open; default {}.
lShowFinalLogicalOptional
Controls lMsFinalAuto; default .F.
lAbendLogicalOptional
License-failure message; default .T.
lOpenSXLogicalOptional
SX opening/first branch when absent; default .T.
lConnectLogicalOptional
Database connection; default .T.
Return value
Opening Boolean; exceptions remain possible.
Commented example
#Include "Protheus.ch"
User Function Ed637()
// Uninvoked block; context and secret belong to the authorized caller.
Local bOpen := {|cCompany,cBranch,cUser,cSecret,cModule| ;
RpcSetEnv(cCompany,cBranch,cUser,cSecret,cModule)}
ConOut(ValType(bOpen))
Return NilExpected result
Creates block B. No authentication, environment opening or secret logging occurs. Under review: editorial example neither compiled nor run in Protheus. Check includes, release, RDD and context before testing.
- Only close an environment your routine opened and owns, using RpcClearEnv. Test licensing, permissions and failure paths.
- Under review: editorial example neither compiled nor run in Protheus. Check includes, release, RDD and context before testing.
Comments
There are no approved comments yet.
Sign in with Google or Microsoft to comment.