Skip to content

Latest commit

 

History

History
165 lines (117 loc) · 5.52 KB

nf-rpcdce-rpcstringbindingcomposew.md

File metadata and controls

165 lines (117 loc) · 5.52 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:rpcdce.RpcStringBindingComposeW
RpcStringBindingComposeW function (rpcdce.h)
The RpcStringBindingComposeW (Unicode) function (rpcdce.h) creates a string binding handle.
RpcStringBindingCompose
RpcStringBindingCompose function [RPC]
RpcStringBindingComposeW
_rpc_rpcstringbindingcompose
rpc.rpcstringbindingcompose
rpcdce/RpcStringBindingCompose
rpcdce/RpcStringBindingComposeW
rpc\rpcstringbindingcompose.htm
Rpc
3f972fc9-67ca-4aa7-a0a0-204a8d90e928
08/15/2022
RpcStringBindingCompose, RpcStringBindingCompose function [RPC], RpcStringBindingComposeA, RpcStringBindingComposeW, _rpc_rpcstringbindingcompose, rpc.rpcstringbindingcompose, rpcdce/RpcStringBindingCompose, rpcdce/RpcStringBindingComposeA, rpcdce/RpcStringBindingComposeW
rpcdce.h
Rpc.h
Windows
Windows 2000 Professional [desktop apps \| UWP apps]
Windows 2000 Server [desktop apps \| UWP apps]
RpcStringBindingComposeW (Unicode) and RpcStringBindingComposeA (ANSI)
Rpcrt4.lib
Rpcrt4.dll
Windows
19H1
RpcStringBindingComposeW
rpcdce/RpcStringBindingComposeW
c++
APIRef
kbSyntax
DllExport
Rpcrt4.dll
RpcStringBindingCompose
RpcStringBindingComposeA
RpcStringBindingComposeW

RpcStringBindingComposeW function

-description

The RpcStringBindingCompose function creates a string binding handle.

-parameters

-param ObjUuid

Pointer to a null-terminated string representation of an object UUID. For example, the string 6B29FC40-CA47-1067-B31D-00DD010662DA represents a valid UUID.

-param ProtSeq

Pointer to a null-terminated string representation of a protocol sequence. See Note.

-param NetworkAddr

Pointer to a null-terminated string representation of a network address. The network-address format is associated with the protocol sequence. See Note.

-param Endpoint

Pointer to a null-terminated string representation of an endpoint. The endpoint format and content are associated with the protocol sequence. For example, the endpoint associated with the protocol sequence ncacn_np is a pipe name in the format \pipe\pipename. See Note.

-param Options

Pointer to a null-terminated string representation of network options. The option string is associated with the protocol sequence. See Note.

-param StringBinding

Returns a pointer to a pointer to a null-terminated string representation of a binding handle.

Specify a NULL value to prevent RpcStringBindingCompose from returning the StringBinding parameter. In this case, the application does not call RpcStringFree. See Note.

Note  For more information, see String Binding.
 

-returns

Value Meaning
RPC_S_OK
The call succeeded.
RPC_S_INVALID_STRING_UUID
The string representation of the UUID is not valid.
 
Note  For a list of valid error codes, see RPC Return Values.
 

-remarks

An application calls RpcStringBindingCompose routine to combine an object UUID, a protocol sequence, a network address, an endpoint and other network options into a string representation of a binding handle.

The RPC run-time library allocates memory for the string returned in the StringBinding parameter. The application is responsible for calling RpcStringFree to deallocate that memory.

Specify a null parameter value or provide an empty string (\0) for each input string that has no data.

Literal backslash characters within C-language strings must be quoted. The actual C string for the server name for the ncacn_np protocol sequence appears as \\servername, and the actual C string for a pipe name appears as \pipe\pipename.

Note

The rpcdce.h header defines RpcStringBindingCompose as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

-see-also

RpcBindingFromStringBinding

RpcBindingToStringBinding

RpcStringBindingParse

RpcStringFree