Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 6.62 KB

LINKTOSOURCE.md

File metadata and controls

87 lines (63 loc) · 6.62 KB
Raw

How to link your project against source

You might want to link against the XSAPI source if you want to debug an issue, or understand where an error code is coming from.

If you are using Visual Studio 2017, the steps are the same but use 141 instead of 140 for all project paths and project names below.

Jump to the guide that matches the platform and API type you are using:

How to link against the XSAPI C++ UWP source

  • If your project references the pre-built NuGet package, you need to remove the reference. In Visual Studio 2015, right click on project and choose "Manage NuGet Packages...", and if Microsoft.Xbox.Live.SDK.Cpp.UWP is installed, click "Uninstall" and click "OK" and wait until its removed.
  • In Visual Studio, choose "File->Add->Existing Project..." in Visual Studio to add the following two projects to your application's solution. The vcxproj files will be located in the folder you extracted the source to.
  \Build\Microsoft.Xbox.Services.140.UWP.Cpp\Microsoft.Xbox.Services.140.UWP.Cpp.vcxproj
  \External\cpprestsdk\Release\src\build\vs14.uwp\cpprestsdk140.uwp.static.vcxproj
  • Add the source projects as a reference by choosing Project->References... and select "Add Reference". Under "Solution->Projects", check the entries for both projects above then click OK.
  • Add the props file to your project by clicking "View->Other Windows->Property Manager", right clicking on your project, selecting "Add Existing Property Sheet", then finally selecting the xsapi.staticlib.props file in the SDK sourch root.
  • Add the services.h file to your app source by right clicking on the project Add->Existing Item and choosing the {SDK source root}\Include\xsapi\services.h file
  • Rebuild your Visual Studio solution

How to link against the XSAPI C++ XDK source

  • If your project references the pre-built DLL the comes with the XDK, you need to remove the reference

    • For Visual Studio 2012: Choose “Project->References...” in Visual Studio. If Xbox Services API is listed as a reference, select it and click “Remove Reference”. Click “OK” and save the project file.
    • For Visual Studio 2015: Choose “Project->Add References…” in Visual Studio. If Xbox Services API is checked, uncheck it. Click “OK” and save the project file.

  • In Visual Studio, choose "File->Add->Existing Project..." in Visual Studio to add the following two projects to your application's solution. The vcxproj files will be located in the folder you extracted the source to.

    • For Visual Studio 2015:
  \Build\Microsoft.Xbox.Services.140.XDK.Cpp\Microsoft.Xbox.Services.140.XDK.Cpp.vcxproj
  \External\cpprestsdk\Release\src\build\vs14.xbox\casablanca140.Xbox.vcxproj
  • For Visual Studio 2012:
  \Build\Microsoft.Xbox.Services.110.XDK.Cpp\Microsoft.Xbox.Services.110.XDK.Cpp.vcxproj
  \External\cpprestsdk\Release\src\build\vs11.xbox\casablanca110.Xbox.vcxproj
  • Add the source projects as a reference by choosing Project->References... and select "Add Reference". Under "Solution->Projects", check the entries for both projects above then click OK.
  • Add the props file to your project by clicking "View->Other Windows->Property Manager", right clicking on your project, selecting "Add Existing Property Sheet", then finally selecting the xsapi.staticlib.props file in the SDK sourch root.
  • Add the services.h file to your app source by right clicking on the project Add->Existing Item and choosing the {SDK source root}\Include\xsapi\services.h file
  • Rebuild your Visual Studio solution

How to link against the XSAPI WinRT UWP source

  • If your project references the pre-built NuGet package, you need to remove the reference In Visual Studio 2015, right click on project and choose "Manage NuGet Packages...", and if Microsoft.Xbox.Live.SDK.WinRT.UWP is installed, click "Uninstall" and click "OK" and wait until its removed.
  • In Visual Studio, choose "File->Add->Existing Project..." in Visual Studio to add the following two projects to your application's solution. The vcxproj files will be located in the folder you extracted the source to.
\Build\Microsoft.Xbox.Services.140.UWP.WinRT\Microsoft.Xbox.Services.140.UWP.WinRT.vcxproj
\External\cpprestsdk\Release\src\build\vs14.uwp\cpprestsdk140.uwp.vcxproj
  • Add the source projects as a reference by choosing Project->References... and select "Add Reference". Under "Solution->Projects", check the entries for both projects above then click OK.
  • Ensure that the "Output Folder" of both the application project and the projects above are the same. This setting can be found in Visual Studio project Properties->Configuration Properties->General->Output Directory.
  • Rebuild your Visual Studio solution

How to link against the XSAPI WinRT XDK source

  • If your project references the pre-built DLL the comes with the XDK, you need to remove the reference

    • For Visual Studio 2012: Choose “Project->References...” in Visual Studio. If Xbox Services API is listed as a reference, select it and click “Remove Reference”. Click “OK” and save the project file.
    • For Visual Studio 2015: Choose “Project->Add References…” in Visual Studio. If Xbox Services API is checked, uncheck it. Click “OK” and save the project file.

  • In Visual Studio, choose "File->Add->Existing Project..." in Visual Studio to add the following two projects to your application's solution. The vcxproj files will be located in the folder you extracted the source to.

\Build\Microsoft.Xbox.Services.110.XDK.WinRT\Microsoft.Xbox.Services.110.XDK.WinRT.vcxproj
\External\cpprestsdk\Release\src\build\vs11.xbox\casablanca110.Xbox.vcxproj
  • In Visual Studio add the references:
    • For Visual Studio 2012: Choose “Project->References...” and select “Add Reference” in Visual Studio. Under Solution->Projects, chceck the entries for both projects above and click OK.
    • For Visual Studio 2015: Choose “Project->Add References…” in Visual Studio. Under Projects, check the entries for both projects above and click OK.
  • Ensure that the "Output Folder" of both the application project and the Xbox Services Project are the same. This setting can be found in Visual Studio project Properties->Configuration Properties->General->Output Directory.
  • Rebuild your Visual Studio solution